2 * Marvell NFC driver: Firmware downloader
4 * Copyright (C) 2015, Marvell International Ltd.
6 * This software file (the "File") is distributed by Marvell International
7 * Ltd. under the terms of the GNU General Public License Version 2, June 1991
8 * (the "License"). You may use, redistribute and/or modify this File in
9 * accordance with the terms and conditions of the License, a copy of which
10 * is available on the worldwide web at
11 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
13 * THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE
14 * IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
15 * ARE EXPRESSLY DISCLAIMED. The License provides additional details about
16 * this warranty disclaimer.
19 #include <linux/module.h>
20 #include <asm/unaligned.h>
21 #include <linux/firmware.h>
22 #include <linux/nfc.h>
23 #include <net/nfc/nci.h>
24 #include <net/nfc/nci_core.h>
27 #define FW_DNLD_TIMEOUT 15000
29 #define NCI_OP_PROPRIETARY_BOOT_CMD nci_opcode_pack(NCI_GID_PROPRIETARY, \
32 /* FW download states */
46 SUBSTATE_WAIT_COMMAND = 0,
47 SUBSTATE_WAIT_ACK_CREDIT,
48 SUBSTATE_WAIT_NACK_CREDIT,
49 SUBSTATE_WAIT_DATA_CREDIT,
53 ** Patterns for responses
56 static const uint8_t nci_pattern_core_reset_ntf[] = {
57 0x60, 0x00, 0x02, 0xA0, 0x01
60 static const uint8_t nci_pattern_core_init_rsp[] = {
64 static const uint8_t nci_pattern_core_set_config_rsp[] = {
65 0x40, 0x02, 0x02, 0x00, 0x00
68 static const uint8_t nci_pattern_core_conn_create_rsp[] = {
69 0x40, 0x04, 0x04, 0x00
72 static const uint8_t nci_pattern_core_conn_close_rsp[] = {
73 0x40, 0x05, 0x01, 0x00
76 static const uint8_t nci_pattern_core_conn_credits_ntf[] = {
77 0x60, 0x06, 0x03, 0x01, NCI_CORE_LC_CONNID_PROP_FW_DL, 0x01
80 static const uint8_t nci_pattern_proprietary_boot_rsp[] = {
81 0x4F, 0x3A, 0x01, 0x00
84 static struct sk_buff *alloc_lc_skb(struct nfcmrvl_private *priv, uint8_t plen)
87 struct nci_data_hdr *hdr;
89 skb = nci_skb_alloc(priv->ndev, (NCI_DATA_HDR_SIZE + plen), GFP_KERNEL);
91 pr_err("no memory for data\n");
95 hdr = skb_put(skb, NCI_DATA_HDR_SIZE);
96 hdr->conn_id = NCI_CORE_LC_CONNID_PROP_FW_DL;
100 nci_mt_set((__u8 *)hdr, NCI_MT_DATA_PKT);
101 nci_pbf_set((__u8 *)hdr, NCI_PBF_LAST);
106 static void fw_dnld_over(struct nfcmrvl_private *priv, u32 error)
108 if (priv->fw_dnld.fw) {
109 release_firmware(priv->fw_dnld.fw);
110 priv->fw_dnld.fw = NULL;
111 priv->fw_dnld.header = NULL;
112 priv->fw_dnld.binary_config = NULL;
115 atomic_set(&priv->ndev->cmd_cnt, 0);
117 if (timer_pending(&priv->ndev->cmd_timer))
118 del_timer_sync(&priv->ndev->cmd_timer);
120 if (timer_pending(&priv->fw_dnld.timer))
121 del_timer_sync(&priv->fw_dnld.timer);
123 nfc_info(priv->dev, "FW loading over (%d)]\n", error);
126 /* failed, halt the chip to avoid power consumption */
127 nfcmrvl_chip_halt(priv);
130 nfc_fw_download_done(priv->ndev->nfc_dev, priv->fw_dnld.name, error);
133 static void fw_dnld_timeout(struct timer_list *t)
135 struct nfcmrvl_private *priv = from_timer(priv, t, fw_dnld.timer);
137 nfc_err(priv->dev, "FW loading timeout");
138 priv->fw_dnld.state = STATE_RESET;
139 fw_dnld_over(priv, -ETIMEDOUT);
142 static int process_state_reset(struct nfcmrvl_private *priv,
145 if (sizeof(nci_pattern_core_reset_ntf) != skb->len ||
146 memcmp(skb->data, nci_pattern_core_reset_ntf,
147 sizeof(nci_pattern_core_reset_ntf)))
150 nfc_info(priv->dev, "BootROM reset, start fw download\n");
152 /* Start FW download state machine */
153 priv->fw_dnld.state = STATE_INIT;
154 nci_send_cmd(priv->ndev, NCI_OP_CORE_INIT_CMD, 0, NULL);
159 static int process_state_init(struct nfcmrvl_private *priv, struct sk_buff *skb)
161 struct nci_core_set_config_cmd cmd;
163 if (sizeof(nci_pattern_core_init_rsp) >= skb->len ||
164 memcmp(skb->data, nci_pattern_core_init_rsp,
165 sizeof(nci_pattern_core_init_rsp)))
169 cmd.param.id = NFCMRVL_PROP_REF_CLOCK;
171 memcpy(cmd.param.val, &priv->fw_dnld.header->ref_clock, 4);
173 nci_send_cmd(priv->ndev, NCI_OP_CORE_SET_CONFIG_CMD, 3 + cmd.param.len,
176 priv->fw_dnld.state = STATE_SET_REF_CLOCK;
180 static void create_lc(struct nfcmrvl_private *priv)
182 uint8_t param[2] = { NCI_CORE_LC_PROP_FW_DL, 0x0 };
184 priv->fw_dnld.state = STATE_OPEN_LC;
185 nci_send_cmd(priv->ndev, NCI_OP_CORE_CONN_CREATE_CMD, 2, param);
188 static int process_state_set_ref_clock(struct nfcmrvl_private *priv,
191 struct nci_core_set_config_cmd cmd;
193 if (sizeof(nci_pattern_core_set_config_rsp) != skb->len ||
194 memcmp(skb->data, nci_pattern_core_set_config_rsp, skb->len))
198 cmd.param.id = NFCMRVL_PROP_SET_HI_CONFIG;
201 case NFCMRVL_PHY_UART:
203 memcpy(cmd.param.val,
204 &priv->fw_dnld.binary_config->uart.baudrate,
207 priv->fw_dnld.binary_config->uart.flow_control;
209 case NFCMRVL_PHY_I2C:
211 memcpy(cmd.param.val,
212 &priv->fw_dnld.binary_config->i2c.clk,
214 cmd.param.val[4] = 0;
216 case NFCMRVL_PHY_SPI:
218 memcpy(cmd.param.val,
219 &priv->fw_dnld.binary_config->spi.clk,
221 cmd.param.val[4] = 0;
228 priv->fw_dnld.state = STATE_SET_HI_CONFIG;
229 nci_send_cmd(priv->ndev, NCI_OP_CORE_SET_CONFIG_CMD, 3 + cmd.param.len,
234 static int process_state_set_hi_config(struct nfcmrvl_private *priv,
237 if (sizeof(nci_pattern_core_set_config_rsp) != skb->len ||
238 memcmp(skb->data, nci_pattern_core_set_config_rsp, skb->len))
245 static int process_state_open_lc(struct nfcmrvl_private *priv,
248 if (sizeof(nci_pattern_core_conn_create_rsp) >= skb->len ||
249 memcmp(skb->data, nci_pattern_core_conn_create_rsp,
250 sizeof(nci_pattern_core_conn_create_rsp)))
253 priv->fw_dnld.state = STATE_FW_DNLD;
254 priv->fw_dnld.substate = SUBSTATE_WAIT_COMMAND;
255 priv->fw_dnld.offset = priv->fw_dnld.binary_config->offset;
259 static int process_state_fw_dnld(struct nfcmrvl_private *priv,
264 struct sk_buff *out_skb;
266 switch (priv->fw_dnld.substate) {
267 case SUBSTATE_WAIT_COMMAND:
271 * B3 : Helper command (0xA5)
272 * B4..5: le16 data size
273 * B6..7: le16 data size complement (~)
279 if (skb->data[0] != HELPER_CMD_PACKET_FORMAT || skb->len != 5) {
280 nfc_err(priv->dev, "bad command");
284 len = get_unaligned_le16(skb->data);
286 comp_len = get_unaligned_le16(skb->data);
287 memcpy(&comp_len, skb->data, 2);
289 if (((~len) & 0xFFFF) != comp_len) {
290 nfc_err(priv->dev, "bad len complement: %x %x %x",
291 len, comp_len, (~len & 0xFFFF));
292 out_skb = alloc_lc_skb(priv, 1);
295 skb_put_u8(out_skb, 0xBF);
296 nci_send_frame(priv->ndev, out_skb);
297 priv->fw_dnld.substate = SUBSTATE_WAIT_NACK_CREDIT;
300 priv->fw_dnld.chunk_len = len;
301 out_skb = alloc_lc_skb(priv, 1);
304 skb_put_u8(out_skb, HELPER_ACK_PACKET_FORMAT);
305 nci_send_frame(priv->ndev, out_skb);
306 priv->fw_dnld.substate = SUBSTATE_WAIT_ACK_CREDIT;
309 case SUBSTATE_WAIT_ACK_CREDIT:
310 if (sizeof(nci_pattern_core_conn_credits_ntf) != skb->len ||
311 memcmp(nci_pattern_core_conn_credits_ntf, skb->data,
313 nfc_err(priv->dev, "bad packet: waiting for credit");
316 if (priv->fw_dnld.chunk_len == 0) {
317 /* FW Loading is done */
318 uint8_t conn_id = NCI_CORE_LC_CONNID_PROP_FW_DL;
320 priv->fw_dnld.state = STATE_CLOSE_LC;
321 nci_send_cmd(priv->ndev, NCI_OP_CORE_CONN_CLOSE_CMD,
324 out_skb = alloc_lc_skb(priv, priv->fw_dnld.chunk_len);
327 skb_put_data(out_skb,
328 ((uint8_t *)priv->fw_dnld.fw->data) + priv->fw_dnld.offset,
329 priv->fw_dnld.chunk_len);
330 nci_send_frame(priv->ndev, out_skb);
331 priv->fw_dnld.substate = SUBSTATE_WAIT_DATA_CREDIT;
335 case SUBSTATE_WAIT_DATA_CREDIT:
336 if (sizeof(nci_pattern_core_conn_credits_ntf) != skb->len ||
337 memcmp(nci_pattern_core_conn_credits_ntf, skb->data,
339 nfc_err(priv->dev, "bad packet: waiting for credit");
342 priv->fw_dnld.offset += priv->fw_dnld.chunk_len;
343 priv->fw_dnld.chunk_len = 0;
344 priv->fw_dnld.substate = SUBSTATE_WAIT_COMMAND;
347 case SUBSTATE_WAIT_NACK_CREDIT:
348 if (sizeof(nci_pattern_core_conn_credits_ntf) != skb->len ||
349 memcmp(nci_pattern_core_conn_credits_ntf, skb->data,
351 nfc_err(priv->dev, "bad packet: waiting for credit");
354 priv->fw_dnld.substate = SUBSTATE_WAIT_COMMAND;
360 static int process_state_close_lc(struct nfcmrvl_private *priv,
363 if (sizeof(nci_pattern_core_conn_close_rsp) != skb->len ||
364 memcmp(skb->data, nci_pattern_core_conn_close_rsp, skb->len))
367 priv->fw_dnld.state = STATE_BOOT;
368 nci_send_cmd(priv->ndev, NCI_OP_PROPRIETARY_BOOT_CMD, 0, NULL);
372 static int process_state_boot(struct nfcmrvl_private *priv, struct sk_buff *skb)
374 if (sizeof(nci_pattern_proprietary_boot_rsp) != skb->len ||
375 memcmp(skb->data, nci_pattern_proprietary_boot_rsp, skb->len))
379 * Update HI config to use the right configuration for the next
382 priv->if_ops->nci_update_config(priv,
383 &priv->fw_dnld.binary_config->config);
385 if (priv->fw_dnld.binary_config == &priv->fw_dnld.header->helper) {
387 * This is the case where an helper was needed and we have
388 * uploaded it. Now we have to wait the next RESET NTF to start
391 priv->fw_dnld.state = STATE_RESET;
392 priv->fw_dnld.binary_config = &priv->fw_dnld.header->firmware;
393 nfc_info(priv->dev, "FW loading: helper loaded");
395 nfc_info(priv->dev, "FW loading: firmware loaded");
396 fw_dnld_over(priv, 0);
401 static void fw_dnld_rx_work(struct work_struct *work)
405 struct nfcmrvl_fw_dnld *fw_dnld = container_of(work,
406 struct nfcmrvl_fw_dnld,
408 struct nfcmrvl_private *priv = container_of(fw_dnld,
409 struct nfcmrvl_private,
412 while ((skb = skb_dequeue(&fw_dnld->rx_q))) {
413 nfc_send_to_raw_sock(priv->ndev->nfc_dev, skb,
414 RAW_PAYLOAD_NCI, NFC_DIRECTION_RX);
415 switch (fw_dnld->state) {
417 ret = process_state_reset(priv, skb);
420 ret = process_state_init(priv, skb);
422 case STATE_SET_REF_CLOCK:
423 ret = process_state_set_ref_clock(priv, skb);
425 case STATE_SET_HI_CONFIG:
426 ret = process_state_set_hi_config(priv, skb);
429 ret = process_state_open_lc(priv, skb);
432 ret = process_state_fw_dnld(priv, skb);
435 ret = process_state_close_lc(priv, skb);
438 ret = process_state_boot(priv, skb);
447 nfc_err(priv->dev, "FW loading error");
448 fw_dnld_over(priv, ret);
454 int nfcmrvl_fw_dnld_init(struct nfcmrvl_private *priv)
458 INIT_WORK(&priv->fw_dnld.rx_work, fw_dnld_rx_work);
459 snprintf(name, sizeof(name), "%s_nfcmrvl_fw_dnld_rx_wq",
460 dev_name(&priv->ndev->nfc_dev->dev));
461 priv->fw_dnld.rx_wq = create_singlethread_workqueue(name);
462 if (!priv->fw_dnld.rx_wq)
464 skb_queue_head_init(&priv->fw_dnld.rx_q);
468 void nfcmrvl_fw_dnld_deinit(struct nfcmrvl_private *priv)
470 destroy_workqueue(priv->fw_dnld.rx_wq);
473 void nfcmrvl_fw_dnld_recv_frame(struct nfcmrvl_private *priv,
476 /* Discard command timer */
477 if (timer_pending(&priv->ndev->cmd_timer))
478 del_timer_sync(&priv->ndev->cmd_timer);
480 /* Allow next command */
481 atomic_set(&priv->ndev->cmd_cnt, 1);
483 /* Queue and trigger rx work */
484 skb_queue_tail(&priv->fw_dnld.rx_q, skb);
485 queue_work(priv->fw_dnld.rx_wq, &priv->fw_dnld.rx_work);
488 void nfcmrvl_fw_dnld_abort(struct nfcmrvl_private *priv)
490 fw_dnld_over(priv, -EHOSTDOWN);
493 int nfcmrvl_fw_dnld_start(struct nci_dev *ndev, const char *firmware_name)
495 struct nfcmrvl_private *priv = nci_get_drvdata(ndev);
496 struct nfcmrvl_fw_dnld *fw_dnld = &priv->fw_dnld;
499 if (!priv->support_fw_dnld)
502 if (!firmware_name || !firmware_name[0])
505 strcpy(fw_dnld->name, firmware_name);
508 * Retrieve FW binary file and parse it to initialize FW download
512 /* Retrieve FW binary */
513 res = request_firmware(&fw_dnld->fw, firmware_name,
514 &ndev->nfc_dev->dev);
516 nfc_err(priv->dev, "failed to retrieve FW %s", firmware_name);
520 fw_dnld->header = (const struct nfcmrvl_fw *) priv->fw_dnld.fw->data;
522 if (fw_dnld->header->magic != NFCMRVL_FW_MAGIC ||
523 fw_dnld->header->phy != priv->phy) {
524 nfc_err(priv->dev, "bad firmware binary %s magic=0x%x phy=%d",
525 firmware_name, fw_dnld->header->magic,
526 fw_dnld->header->phy);
527 release_firmware(fw_dnld->fw);
528 fw_dnld->header = NULL;
532 if (fw_dnld->header->helper.offset != 0) {
533 nfc_info(priv->dev, "loading helper");
534 fw_dnld->binary_config = &fw_dnld->header->helper;
536 nfc_info(priv->dev, "loading firmware");
537 fw_dnld->binary_config = &fw_dnld->header->firmware;
540 /* Configure a timer for timeout */
541 timer_setup(&priv->fw_dnld.timer, fw_dnld_timeout, 0);
542 mod_timer(&priv->fw_dnld.timer,
543 jiffies + msecs_to_jiffies(FW_DNLD_TIMEOUT));
545 /* Ronfigure HI to be sure that it is the bootrom values */
546 priv->if_ops->nci_update_config(priv,
547 &fw_dnld->header->bootrom.config);
549 /* Allow first command */
550 atomic_set(&priv->ndev->cmd_cnt, 1);
552 /* First, reset the chip */
553 priv->fw_dnld.state = STATE_RESET;
554 nfcmrvl_chip_reset(priv);
556 /* Now wait for CORE_RESET_NTF or timeout */