1// SPDX-License-Identifier: GPL-2.0
2/* Copyright(c) 2020 Pensando Systems, Inc */
3
4#include <linux/kernel.h>
5#include <linux/types.h>
6#include <linux/errno.h>
7#include <linux/firmware.h>
8
9#include "ionic.h"
10#include "ionic_dev.h"
11#include "ionic_lif.h"
12#include "ionic_devlink.h"
13
14/* The worst case wait for the install activity is about 25 minutes when
15 * installing a new CPLD, which is very seldom.  Normal is about 30-35
16 * seconds.  Since the driver can't tell if a CPLD update will happen we
17 * set the timeout for the ugly case.
18 */
19#define IONIC_FW_INSTALL_TIMEOUT	(25 * 60)
20#define IONIC_FW_SELECT_TIMEOUT		30
21
22/* Number of periodic log updates during fw file download */
23#define IONIC_FW_INTERVAL_FRACTION	32
24
25static void ionic_dev_cmd_firmware_download(struct ionic_dev *idev, u64 addr,
26					    u32 offset, u32 length)
27{
28	union ionic_dev_cmd cmd = {
29		.fw_download.opcode = IONIC_CMD_FW_DOWNLOAD,
30		.fw_download.offset = cpu_to_le32(offset),
31		.fw_download.addr = cpu_to_le64(addr),
32		.fw_download.length = cpu_to_le32(length),
33	};
34
35	ionic_dev_cmd_go(idev, &cmd);
36}
37
38static void ionic_dev_cmd_firmware_install(struct ionic_dev *idev)
39{
40	union ionic_dev_cmd cmd = {
41		.fw_control.opcode = IONIC_CMD_FW_CONTROL,
42		.fw_control.oper = IONIC_FW_INSTALL_ASYNC
43	};
44
45	ionic_dev_cmd_go(idev, &cmd);
46}
47
48static void ionic_dev_cmd_firmware_activate(struct ionic_dev *idev, u8 slot)
49{
50	union ionic_dev_cmd cmd = {
51		.fw_control.opcode = IONIC_CMD_FW_CONTROL,
52		.fw_control.oper = IONIC_FW_ACTIVATE_ASYNC,
53		.fw_control.slot = slot
54	};
55
56	ionic_dev_cmd_go(idev, &cmd);
57}
58
59static int ionic_fw_status_long_wait(struct ionic *ionic,
60				     const char *label,
61				     unsigned long timeout,
62				     u8 fw_cmd,
63				     struct netlink_ext_ack *extack)
64{
65	union ionic_dev_cmd cmd = {
66		.fw_control.opcode = IONIC_CMD_FW_CONTROL,
67		.fw_control.oper = fw_cmd,
68	};
69	unsigned long start_time;
70	unsigned long end_time;
71	int err;
72
73	start_time = jiffies;
74	end_time = start_time + (timeout * HZ);
75	do {
76		mutex_lock(&ionic->dev_cmd_lock);
77		ionic_dev_cmd_go(&ionic->idev, &cmd);
78		err = ionic_dev_cmd_wait(ionic, DEVCMD_TIMEOUT);
79		mutex_unlock(&ionic->dev_cmd_lock);
80
81		msleep(20);
82	} while (time_before(jiffies, end_time) && (err == -EAGAIN || err == -ETIMEDOUT));
83
84	if (err == -EAGAIN || err == -ETIMEDOUT) {
85		NL_SET_ERR_MSG_MOD(extack, "Firmware wait timed out");
86		dev_err(ionic->dev, "DEV_CMD firmware wait %s timed out\n", label);
87	} else if (err) {
88		NL_SET_ERR_MSG_MOD(extack, "Firmware wait failed");
89	}
90
91	return err;
92}
93
94int ionic_firmware_update(struct ionic_lif *lif, const char *fw_name,
95			  struct netlink_ext_ack *extack)
96{
97	struct ionic_dev *idev = &lif->ionic->idev;
98	struct net_device *netdev = lif->netdev;
99	struct ionic *ionic = lif->ionic;
100	union ionic_dev_cmd_comp comp;
101	u32 buf_sz, copy_sz, offset;
102	const struct firmware *fw;
103	struct devlink *dl;
104	int next_interval;
105	int err = 0;
106	u8 fw_slot;
107
108	netdev_info(netdev, "Installing firmware %s\n", fw_name);
109
110	dl = priv_to_devlink(ionic);
111	devlink_flash_update_begin_notify(dl);
112	devlink_flash_update_status_notify(dl, "Preparing to flash", NULL, 0, 0);
113
114	err = request_firmware(&fw, fw_name, ionic->dev);
115	if (err) {
116		NL_SET_ERR_MSG_MOD(extack, "Unable to find firmware file");
117		goto err_out;
118	}
119
120	buf_sz = sizeof(idev->dev_cmd_regs->data);
121
122	netdev_dbg(netdev,
123		   "downloading firmware - size %d part_sz %d nparts %lu\n",
124		   (int)fw->size, buf_sz, DIV_ROUND_UP(fw->size, buf_sz));
125
126	offset = 0;
127	next_interval = 0;
128	while (offset < fw->size) {
129		if (offset >= next_interval) {
130			devlink_flash_update_status_notify(dl, "Downloading", NULL,
131							   offset, fw->size);
132			next_interval = offset + (fw->size / IONIC_FW_INTERVAL_FRACTION);
133		}
134
135		copy_sz = min_t(unsigned int, buf_sz, fw->size - offset);
136		mutex_lock(&ionic->dev_cmd_lock);
137		memcpy_toio(&idev->dev_cmd_regs->data, fw->data + offset, copy_sz);
138		ionic_dev_cmd_firmware_download(idev,
139						offsetof(union ionic_dev_cmd_regs, data),
140						offset, copy_sz);
141		err = ionic_dev_cmd_wait(ionic, DEVCMD_TIMEOUT);
142		mutex_unlock(&ionic->dev_cmd_lock);
143		if (err) {
144			netdev_err(netdev,
145				   "download failed offset 0x%x addr 0x%lx len 0x%x\n",
146				   offset, offsetof(union ionic_dev_cmd_regs, data),
147				   copy_sz);
148			NL_SET_ERR_MSG_MOD(extack, "Segment download failed");
149			goto err_out;
150		}
151		offset += copy_sz;
152	}
153	devlink_flash_update_status_notify(dl, "Downloading", NULL,
154					   fw->size, fw->size);
155
156	devlink_flash_update_timeout_notify(dl, "Installing", NULL,
157					    IONIC_FW_INSTALL_TIMEOUT);
158
159	mutex_lock(&ionic->dev_cmd_lock);
160	ionic_dev_cmd_firmware_install(idev);
161	err = ionic_dev_cmd_wait(ionic, DEVCMD_TIMEOUT);
162	ionic_dev_cmd_comp(idev, (union ionic_dev_cmd_comp *)&comp);
163	fw_slot = comp.fw_control.slot;
164	mutex_unlock(&ionic->dev_cmd_lock);
165	if (err) {
166		NL_SET_ERR_MSG_MOD(extack, "Failed to start firmware install");
167		goto err_out;
168	}
169
170	err = ionic_fw_status_long_wait(ionic, "Installing",
171					IONIC_FW_INSTALL_TIMEOUT,
172					IONIC_FW_INSTALL_STATUS,
173					extack);
174	if (err)
175		goto err_out;
176
177	devlink_flash_update_timeout_notify(dl, "Selecting", NULL,
178					    IONIC_FW_SELECT_TIMEOUT);
179
180	mutex_lock(&ionic->dev_cmd_lock);
181	ionic_dev_cmd_firmware_activate(idev, fw_slot);
182	err = ionic_dev_cmd_wait(ionic, DEVCMD_TIMEOUT);
183	mutex_unlock(&ionic->dev_cmd_lock);
184	if (err) {
185		NL_SET_ERR_MSG_MOD(extack, "Failed to start firmware select");
186		goto err_out;
187	}
188
189	err = ionic_fw_status_long_wait(ionic, "Selecting",
190					IONIC_FW_SELECT_TIMEOUT,
191					IONIC_FW_ACTIVATE_STATUS,
192					extack);
193	if (err)
194		goto err_out;
195
196	netdev_info(netdev, "Firmware update completed\n");
197
198err_out:
199	if (err)
200		devlink_flash_update_status_notify(dl, "Flash failed", NULL, 0, 0);
201	else
202		devlink_flash_update_status_notify(dl, "Flash done", NULL, 0, 0);
203	release_firmware(fw);
204	devlink_flash_update_end_notify(dl);
205	return err;
206}
207