Loading...
1/**
2 * Marvell BT-over-SDIO driver: SDIO interface related functions.
3 *
4 * Copyright (C) 2009, Marvell International Ltd.
5 *
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 by writing to the Free Software Foundation, Inc.,
11 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or on the
12 * worldwide web at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
13 *
14 *
15 * THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
17 * ARE EXPRESSLY DISCLAIMED. The License provides additional details about
18 * this warranty disclaimer.
19 **/
20
21#include <linux/firmware.h>
22#include <linux/slab.h>
23
24#include <linux/mmc/sdio_ids.h>
25#include <linux/mmc/sdio_func.h>
26
27#include <net/bluetooth/bluetooth.h>
28#include <net/bluetooth/hci_core.h>
29
30#include "btmrvl_drv.h"
31#include "btmrvl_sdio.h"
32
33#define VERSION "1.0"
34
35/* The btmrvl_sdio_remove() callback function is called
36 * when user removes this module from kernel space or ejects
37 * the card from the slot. The driver handles these 2 cases
38 * differently.
39 * If the user is removing the module, a MODULE_SHUTDOWN_REQ
40 * command is sent to firmware and interrupt will be disabled.
41 * If the card is removed, there is no need to send command
42 * or disable interrupt.
43 *
44 * The variable 'user_rmmod' is used to distinguish these two
45 * scenarios. This flag is initialized as FALSE in case the card
46 * is removed, and will be set to TRUE for module removal when
47 * module_exit function is called.
48 */
49static u8 user_rmmod;
50static u8 sdio_ireg;
51
52static const struct btmrvl_sdio_card_reg btmrvl_reg_8688 = {
53 .cfg = 0x03,
54 .host_int_mask = 0x04,
55 .host_intstatus = 0x05,
56 .card_status = 0x20,
57 .sq_read_base_addr_a0 = 0x10,
58 .sq_read_base_addr_a1 = 0x11,
59 .card_fw_status0 = 0x40,
60 .card_fw_status1 = 0x41,
61 .card_rx_len = 0x42,
62 .card_rx_unit = 0x43,
63 .io_port_0 = 0x00,
64 .io_port_1 = 0x01,
65 .io_port_2 = 0x02,
66};
67static const struct btmrvl_sdio_card_reg btmrvl_reg_8787 = {
68 .cfg = 0x00,
69 .host_int_mask = 0x02,
70 .host_intstatus = 0x03,
71 .card_status = 0x30,
72 .sq_read_base_addr_a0 = 0x40,
73 .sq_read_base_addr_a1 = 0x41,
74 .card_revision = 0x5c,
75 .card_fw_status0 = 0x60,
76 .card_fw_status1 = 0x61,
77 .card_rx_len = 0x62,
78 .card_rx_unit = 0x63,
79 .io_port_0 = 0x78,
80 .io_port_1 = 0x79,
81 .io_port_2 = 0x7a,
82};
83
84static const struct btmrvl_sdio_device btmrvl_sdio_sd6888 = {
85 .helper = "sd8688_helper.bin",
86 .firmware = "sd8688.bin",
87 .reg = &btmrvl_reg_8688,
88 .sd_blksz_fw_dl = 64,
89};
90
91static const struct btmrvl_sdio_device btmrvl_sdio_sd8787 = {
92 .helper = NULL,
93 .firmware = "mrvl/sd8787_uapsta.bin",
94 .reg = &btmrvl_reg_8787,
95 .sd_blksz_fw_dl = 256,
96};
97
98static const struct sdio_device_id btmrvl_sdio_ids[] = {
99 /* Marvell SD8688 Bluetooth device */
100 { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL, 0x9105),
101 .driver_data = (unsigned long) &btmrvl_sdio_sd6888 },
102 /* Marvell SD8787 Bluetooth device */
103 { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL, 0x911A),
104 .driver_data = (unsigned long) &btmrvl_sdio_sd8787 },
105
106 { } /* Terminating entry */
107};
108
109MODULE_DEVICE_TABLE(sdio, btmrvl_sdio_ids);
110
111static int btmrvl_sdio_get_rx_unit(struct btmrvl_sdio_card *card)
112{
113 u8 reg;
114 int ret;
115
116 reg = sdio_readb(card->func, card->reg->card_rx_unit, &ret);
117 if (!ret)
118 card->rx_unit = reg;
119
120 return ret;
121}
122
123static int btmrvl_sdio_read_fw_status(struct btmrvl_sdio_card *card, u16 *dat)
124{
125 u8 fws0, fws1;
126 int ret;
127
128 *dat = 0;
129
130 fws0 = sdio_readb(card->func, card->reg->card_fw_status0, &ret);
131 if (ret)
132 return -EIO;
133
134 fws1 = sdio_readb(card->func, card->reg->card_fw_status1, &ret);
135 if (ret)
136 return -EIO;
137
138 *dat = (((u16) fws1) << 8) | fws0;
139
140 return 0;
141}
142
143static int btmrvl_sdio_read_rx_len(struct btmrvl_sdio_card *card, u16 *dat)
144{
145 u8 reg;
146 int ret;
147
148 reg = sdio_readb(card->func, card->reg->card_rx_len, &ret);
149 if (!ret)
150 *dat = (u16) reg << card->rx_unit;
151
152 return ret;
153}
154
155static int btmrvl_sdio_enable_host_int_mask(struct btmrvl_sdio_card *card,
156 u8 mask)
157{
158 int ret;
159
160 sdio_writeb(card->func, mask, card->reg->host_int_mask, &ret);
161 if (ret) {
162 BT_ERR("Unable to enable the host interrupt!");
163 ret = -EIO;
164 }
165
166 return ret;
167}
168
169static int btmrvl_sdio_disable_host_int_mask(struct btmrvl_sdio_card *card,
170 u8 mask)
171{
172 u8 host_int_mask;
173 int ret;
174
175 host_int_mask = sdio_readb(card->func, card->reg->host_int_mask, &ret);
176 if (ret)
177 return -EIO;
178
179 host_int_mask &= ~mask;
180
181 sdio_writeb(card->func, host_int_mask, card->reg->host_int_mask, &ret);
182 if (ret < 0) {
183 BT_ERR("Unable to disable the host interrupt!");
184 return -EIO;
185 }
186
187 return 0;
188}
189
190static int btmrvl_sdio_poll_card_status(struct btmrvl_sdio_card *card, u8 bits)
191{
192 unsigned int tries;
193 u8 status;
194 int ret;
195
196 for (tries = 0; tries < MAX_POLL_TRIES * 1000; tries++) {
197 status = sdio_readb(card->func, card->reg->card_status, &ret);
198 if (ret)
199 goto failed;
200 if ((status & bits) == bits)
201 return ret;
202
203 udelay(1);
204 }
205
206 ret = -ETIMEDOUT;
207
208failed:
209 BT_ERR("FAILED! ret=%d", ret);
210
211 return ret;
212}
213
214static int btmrvl_sdio_verify_fw_download(struct btmrvl_sdio_card *card,
215 int pollnum)
216{
217 int ret = -ETIMEDOUT;
218 u16 firmwarestat;
219 unsigned int tries;
220
221 /* Wait for firmware to become ready */
222 for (tries = 0; tries < pollnum; tries++) {
223 if (btmrvl_sdio_read_fw_status(card, &firmwarestat) < 0)
224 continue;
225
226 if (firmwarestat == FIRMWARE_READY) {
227 ret = 0;
228 break;
229 } else {
230 msleep(10);
231 }
232 }
233
234 return ret;
235}
236
237static int btmrvl_sdio_download_helper(struct btmrvl_sdio_card *card)
238{
239 const struct firmware *fw_helper = NULL;
240 const u8 *helper = NULL;
241 int ret;
242 void *tmphlprbuf = NULL;
243 int tmphlprbufsz, hlprblknow, helperlen;
244 u8 *helperbuf;
245 u32 tx_len;
246
247 ret = request_firmware(&fw_helper, card->helper,
248 &card->func->dev);
249 if ((ret < 0) || !fw_helper) {
250 BT_ERR("request_firmware(helper) failed, error code = %d",
251 ret);
252 ret = -ENOENT;
253 goto done;
254 }
255
256 helper = fw_helper->data;
257 helperlen = fw_helper->size;
258
259 BT_DBG("Downloading helper image (%d bytes), block size %d bytes",
260 helperlen, SDIO_BLOCK_SIZE);
261
262 tmphlprbufsz = ALIGN_SZ(BTM_UPLD_SIZE, BTSDIO_DMA_ALIGN);
263
264 tmphlprbuf = kzalloc(tmphlprbufsz, GFP_KERNEL);
265 if (!tmphlprbuf) {
266 BT_ERR("Unable to allocate buffer for helper."
267 " Terminating download");
268 ret = -ENOMEM;
269 goto done;
270 }
271
272 helperbuf = (u8 *) ALIGN_ADDR(tmphlprbuf, BTSDIO_DMA_ALIGN);
273
274 /* Perform helper data transfer */
275 tx_len = (FIRMWARE_TRANSFER_NBLOCK * SDIO_BLOCK_SIZE)
276 - SDIO_HEADER_LEN;
277 hlprblknow = 0;
278
279 do {
280 ret = btmrvl_sdio_poll_card_status(card,
281 CARD_IO_READY | DN_LD_CARD_RDY);
282 if (ret < 0) {
283 BT_ERR("Helper download poll status timeout @ %d",
284 hlprblknow);
285 goto done;
286 }
287
288 /* Check if there is more data? */
289 if (hlprblknow >= helperlen)
290 break;
291
292 if (helperlen - hlprblknow < tx_len)
293 tx_len = helperlen - hlprblknow;
294
295 /* Little-endian */
296 helperbuf[0] = ((tx_len & 0x000000ff) >> 0);
297 helperbuf[1] = ((tx_len & 0x0000ff00) >> 8);
298 helperbuf[2] = ((tx_len & 0x00ff0000) >> 16);
299 helperbuf[3] = ((tx_len & 0xff000000) >> 24);
300
301 memcpy(&helperbuf[SDIO_HEADER_LEN], &helper[hlprblknow],
302 tx_len);
303
304 /* Now send the data */
305 ret = sdio_writesb(card->func, card->ioport, helperbuf,
306 FIRMWARE_TRANSFER_NBLOCK * SDIO_BLOCK_SIZE);
307 if (ret < 0) {
308 BT_ERR("IO error during helper download @ %d",
309 hlprblknow);
310 goto done;
311 }
312
313 hlprblknow += tx_len;
314 } while (true);
315
316 BT_DBG("Transferring helper image EOF block");
317
318 memset(helperbuf, 0x0, SDIO_BLOCK_SIZE);
319
320 ret = sdio_writesb(card->func, card->ioport, helperbuf,
321 SDIO_BLOCK_SIZE);
322 if (ret < 0) {
323 BT_ERR("IO error in writing helper image EOF block");
324 goto done;
325 }
326
327 ret = 0;
328
329done:
330 kfree(tmphlprbuf);
331 if (fw_helper)
332 release_firmware(fw_helper);
333
334 return ret;
335}
336
337static int btmrvl_sdio_download_fw_w_helper(struct btmrvl_sdio_card *card)
338{
339 const struct firmware *fw_firmware = NULL;
340 const u8 *firmware = NULL;
341 int firmwarelen, tmpfwbufsz, ret;
342 unsigned int tries, offset;
343 u8 base0, base1;
344 void *tmpfwbuf = NULL;
345 u8 *fwbuf;
346 u16 len, blksz_dl = card->sd_blksz_fw_dl;
347 int txlen = 0, tx_blocks = 0, count = 0;
348
349 ret = request_firmware(&fw_firmware, card->firmware,
350 &card->func->dev);
351 if ((ret < 0) || !fw_firmware) {
352 BT_ERR("request_firmware(firmware) failed, error code = %d",
353 ret);
354 ret = -ENOENT;
355 goto done;
356 }
357
358 firmware = fw_firmware->data;
359 firmwarelen = fw_firmware->size;
360
361 BT_DBG("Downloading FW image (%d bytes)", firmwarelen);
362
363 tmpfwbufsz = ALIGN_SZ(BTM_UPLD_SIZE, BTSDIO_DMA_ALIGN);
364 tmpfwbuf = kzalloc(tmpfwbufsz, GFP_KERNEL);
365 if (!tmpfwbuf) {
366 BT_ERR("Unable to allocate buffer for firmware."
367 " Terminating download");
368 ret = -ENOMEM;
369 goto done;
370 }
371
372 /* Ensure aligned firmware buffer */
373 fwbuf = (u8 *) ALIGN_ADDR(tmpfwbuf, BTSDIO_DMA_ALIGN);
374
375 /* Perform firmware data transfer */
376 offset = 0;
377 do {
378 ret = btmrvl_sdio_poll_card_status(card,
379 CARD_IO_READY | DN_LD_CARD_RDY);
380 if (ret < 0) {
381 BT_ERR("FW download with helper poll status"
382 " timeout @ %d", offset);
383 goto done;
384 }
385
386 /* Check if there is more data ? */
387 if (offset >= firmwarelen)
388 break;
389
390 for (tries = 0; tries < MAX_POLL_TRIES; tries++) {
391 base0 = sdio_readb(card->func,
392 card->reg->sq_read_base_addr_a0, &ret);
393 if (ret) {
394 BT_ERR("BASE0 register read failed:"
395 " base0 = 0x%04X(%d)."
396 " Terminating download",
397 base0, base0);
398 ret = -EIO;
399 goto done;
400 }
401 base1 = sdio_readb(card->func,
402 card->reg->sq_read_base_addr_a1, &ret);
403 if (ret) {
404 BT_ERR("BASE1 register read failed:"
405 " base1 = 0x%04X(%d)."
406 " Terminating download",
407 base1, base1);
408 ret = -EIO;
409 goto done;
410 }
411
412 len = (((u16) base1) << 8) | base0;
413 if (len)
414 break;
415
416 udelay(10);
417 }
418
419 if (!len)
420 break;
421 else if (len > BTM_UPLD_SIZE) {
422 BT_ERR("FW download failure @%d, invalid length %d",
423 offset, len);
424 ret = -EINVAL;
425 goto done;
426 }
427
428 txlen = len;
429
430 if (len & BIT(0)) {
431 count++;
432 if (count > MAX_WRITE_IOMEM_RETRY) {
433 BT_ERR("FW download failure @%d, "
434 "over max retry count", offset);
435 ret = -EIO;
436 goto done;
437 }
438 BT_ERR("FW CRC error indicated by the helper: "
439 "len = 0x%04X, txlen = %d", len, txlen);
440 len &= ~BIT(0);
441 /* Set txlen to 0 so as to resend from same offset */
442 txlen = 0;
443 } else {
444 count = 0;
445
446 /* Last block ? */
447 if (firmwarelen - offset < txlen)
448 txlen = firmwarelen - offset;
449
450 tx_blocks = (txlen + blksz_dl - 1) / blksz_dl;
451
452 memcpy(fwbuf, &firmware[offset], txlen);
453 }
454
455 ret = sdio_writesb(card->func, card->ioport, fwbuf,
456 tx_blocks * blksz_dl);
457
458 if (ret < 0) {
459 BT_ERR("FW download, writesb(%d) failed @%d",
460 count, offset);
461 sdio_writeb(card->func, HOST_CMD53_FIN,
462 card->reg->cfg, &ret);
463 if (ret)
464 BT_ERR("writeb failed (CFG)");
465 }
466
467 offset += txlen;
468 } while (true);
469
470 BT_DBG("FW download over, size %d bytes", offset);
471
472 ret = 0;
473
474done:
475 kfree(tmpfwbuf);
476
477 if (fw_firmware)
478 release_firmware(fw_firmware);
479
480 return ret;
481}
482
483static int btmrvl_sdio_card_to_host(struct btmrvl_private *priv)
484{
485 u16 buf_len = 0;
486 int ret, buf_block_len, blksz;
487 struct sk_buff *skb = NULL;
488 u32 type;
489 u8 *payload = NULL;
490 struct hci_dev *hdev = priv->btmrvl_dev.hcidev;
491 struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
492
493 if (!card || !card->func) {
494 BT_ERR("card or function is NULL!");
495 ret = -EINVAL;
496 goto exit;
497 }
498
499 /* Read the length of data to be transferred */
500 ret = btmrvl_sdio_read_rx_len(card, &buf_len);
501 if (ret < 0) {
502 BT_ERR("read rx_len failed");
503 ret = -EIO;
504 goto exit;
505 }
506
507 blksz = SDIO_BLOCK_SIZE;
508 buf_block_len = (buf_len + blksz - 1) / blksz;
509
510 if (buf_len <= SDIO_HEADER_LEN
511 || (buf_block_len * blksz) > ALLOC_BUF_SIZE) {
512 BT_ERR("invalid packet length: %d", buf_len);
513 ret = -EINVAL;
514 goto exit;
515 }
516
517 /* Allocate buffer */
518 skb = bt_skb_alloc(buf_block_len * blksz + BTSDIO_DMA_ALIGN,
519 GFP_ATOMIC);
520 if (skb == NULL) {
521 BT_ERR("No free skb");
522 goto exit;
523 }
524
525 if ((unsigned long) skb->data & (BTSDIO_DMA_ALIGN - 1)) {
526 skb_put(skb, (unsigned long) skb->data &
527 (BTSDIO_DMA_ALIGN - 1));
528 skb_pull(skb, (unsigned long) skb->data &
529 (BTSDIO_DMA_ALIGN - 1));
530 }
531
532 payload = skb->data;
533
534 ret = sdio_readsb(card->func, payload, card->ioport,
535 buf_block_len * blksz);
536 if (ret < 0) {
537 BT_ERR("readsb failed: %d", ret);
538 ret = -EIO;
539 goto exit;
540 }
541
542 /* This is SDIO specific header length: byte[2][1][0], type: byte[3]
543 * (HCI_COMMAND = 1, ACL_DATA = 2, SCO_DATA = 3, 0xFE = Vendor)
544 */
545
546 buf_len = payload[0];
547 buf_len |= (u16) payload[1] << 8;
548 type = payload[3];
549
550 switch (type) {
551 case HCI_ACLDATA_PKT:
552 case HCI_SCODATA_PKT:
553 case HCI_EVENT_PKT:
554 bt_cb(skb)->pkt_type = type;
555 skb->dev = (void *)hdev;
556 skb_put(skb, buf_len);
557 skb_pull(skb, SDIO_HEADER_LEN);
558
559 if (type == HCI_EVENT_PKT)
560 btmrvl_check_evtpkt(priv, skb);
561
562 hci_recv_frame(skb);
563 hdev->stat.byte_rx += buf_len;
564 break;
565
566 case MRVL_VENDOR_PKT:
567 bt_cb(skb)->pkt_type = HCI_VENDOR_PKT;
568 skb->dev = (void *)hdev;
569 skb_put(skb, buf_len);
570 skb_pull(skb, SDIO_HEADER_LEN);
571
572 if (btmrvl_process_event(priv, skb))
573 hci_recv_frame(skb);
574
575 hdev->stat.byte_rx += buf_len;
576 break;
577
578 default:
579 BT_ERR("Unknown packet type:%d", type);
580 print_hex_dump_bytes("", DUMP_PREFIX_OFFSET, payload,
581 blksz * buf_block_len);
582
583 kfree_skb(skb);
584 skb = NULL;
585 break;
586 }
587
588exit:
589 if (ret) {
590 hdev->stat.err_rx++;
591 if (skb)
592 kfree_skb(skb);
593 }
594
595 return ret;
596}
597
598static int btmrvl_sdio_process_int_status(struct btmrvl_private *priv)
599{
600 ulong flags;
601 u8 ireg;
602 struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
603
604 spin_lock_irqsave(&priv->driver_lock, flags);
605 ireg = sdio_ireg;
606 sdio_ireg = 0;
607 spin_unlock_irqrestore(&priv->driver_lock, flags);
608
609 sdio_claim_host(card->func);
610 if (ireg & DN_LD_HOST_INT_STATUS) {
611 if (priv->btmrvl_dev.tx_dnld_rdy)
612 BT_DBG("tx_done already received: "
613 " int_status=0x%x", ireg);
614 else
615 priv->btmrvl_dev.tx_dnld_rdy = true;
616 }
617
618 if (ireg & UP_LD_HOST_INT_STATUS)
619 btmrvl_sdio_card_to_host(priv);
620
621 sdio_release_host(card->func);
622
623 return 0;
624}
625
626static void btmrvl_sdio_interrupt(struct sdio_func *func)
627{
628 struct btmrvl_private *priv;
629 struct btmrvl_sdio_card *card;
630 ulong flags;
631 u8 ireg = 0;
632 int ret;
633
634 card = sdio_get_drvdata(func);
635 if (!card || !card->priv) {
636 BT_ERR("sbi_interrupt(%p) card or priv is "
637 "NULL, card=%p\n", func, card);
638 return;
639 }
640
641 priv = card->priv;
642
643 ireg = sdio_readb(card->func, card->reg->host_intstatus, &ret);
644 if (ret) {
645 BT_ERR("sdio_readb: read int status register failed");
646 return;
647 }
648
649 if (ireg != 0) {
650 /*
651 * DN_LD_HOST_INT_STATUS and/or UP_LD_HOST_INT_STATUS
652 * Clear the interrupt status register and re-enable the
653 * interrupt.
654 */
655 BT_DBG("ireg = 0x%x", ireg);
656
657 sdio_writeb(card->func, ~(ireg) & (DN_LD_HOST_INT_STATUS |
658 UP_LD_HOST_INT_STATUS),
659 card->reg->host_intstatus, &ret);
660 if (ret) {
661 BT_ERR("sdio_writeb: clear int status register failed");
662 return;
663 }
664 }
665
666 spin_lock_irqsave(&priv->driver_lock, flags);
667 sdio_ireg |= ireg;
668 spin_unlock_irqrestore(&priv->driver_lock, flags);
669
670 btmrvl_interrupt(priv);
671}
672
673static int btmrvl_sdio_register_dev(struct btmrvl_sdio_card *card)
674{
675 struct sdio_func *func;
676 u8 reg;
677 int ret = 0;
678
679 if (!card || !card->func) {
680 BT_ERR("Error: card or function is NULL!");
681 ret = -EINVAL;
682 goto failed;
683 }
684
685 func = card->func;
686
687 sdio_claim_host(func);
688
689 ret = sdio_enable_func(func);
690 if (ret) {
691 BT_ERR("sdio_enable_func() failed: ret=%d", ret);
692 ret = -EIO;
693 goto release_host;
694 }
695
696 ret = sdio_claim_irq(func, btmrvl_sdio_interrupt);
697 if (ret) {
698 BT_ERR("sdio_claim_irq failed: ret=%d", ret);
699 ret = -EIO;
700 goto disable_func;
701 }
702
703 ret = sdio_set_block_size(card->func, SDIO_BLOCK_SIZE);
704 if (ret) {
705 BT_ERR("cannot set SDIO block size");
706 ret = -EIO;
707 goto release_irq;
708 }
709
710 reg = sdio_readb(func, card->reg->io_port_0, &ret);
711 if (ret < 0) {
712 ret = -EIO;
713 goto release_irq;
714 }
715
716 card->ioport = reg;
717
718 reg = sdio_readb(func, card->reg->io_port_1, &ret);
719 if (ret < 0) {
720 ret = -EIO;
721 goto release_irq;
722 }
723
724 card->ioport |= (reg << 8);
725
726 reg = sdio_readb(func, card->reg->io_port_2, &ret);
727 if (ret < 0) {
728 ret = -EIO;
729 goto release_irq;
730 }
731
732 card->ioport |= (reg << 16);
733
734 BT_DBG("SDIO FUNC%d IO port: 0x%x", func->num, card->ioport);
735
736 sdio_set_drvdata(func, card);
737
738 sdio_release_host(func);
739
740 return 0;
741
742release_irq:
743 sdio_release_irq(func);
744
745disable_func:
746 sdio_disable_func(func);
747
748release_host:
749 sdio_release_host(func);
750
751failed:
752 return ret;
753}
754
755static int btmrvl_sdio_unregister_dev(struct btmrvl_sdio_card *card)
756{
757 if (card && card->func) {
758 sdio_claim_host(card->func);
759 sdio_release_irq(card->func);
760 sdio_disable_func(card->func);
761 sdio_release_host(card->func);
762 sdio_set_drvdata(card->func, NULL);
763 }
764
765 return 0;
766}
767
768static int btmrvl_sdio_enable_host_int(struct btmrvl_sdio_card *card)
769{
770 int ret;
771
772 if (!card || !card->func)
773 return -EINVAL;
774
775 sdio_claim_host(card->func);
776
777 ret = btmrvl_sdio_enable_host_int_mask(card, HIM_ENABLE);
778
779 btmrvl_sdio_get_rx_unit(card);
780
781 sdio_release_host(card->func);
782
783 return ret;
784}
785
786static int btmrvl_sdio_disable_host_int(struct btmrvl_sdio_card *card)
787{
788 int ret;
789
790 if (!card || !card->func)
791 return -EINVAL;
792
793 sdio_claim_host(card->func);
794
795 ret = btmrvl_sdio_disable_host_int_mask(card, HIM_DISABLE);
796
797 sdio_release_host(card->func);
798
799 return ret;
800}
801
802static int btmrvl_sdio_host_to_card(struct btmrvl_private *priv,
803 u8 *payload, u16 nb)
804{
805 struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
806 int ret = 0;
807 int buf_block_len;
808 int blksz;
809 int i = 0;
810 u8 *buf = NULL;
811 void *tmpbuf = NULL;
812 int tmpbufsz;
813
814 if (!card || !card->func) {
815 BT_ERR("card or function is NULL!");
816 return -EINVAL;
817 }
818
819 buf = payload;
820 if ((unsigned long) payload & (BTSDIO_DMA_ALIGN - 1)) {
821 tmpbufsz = ALIGN_SZ(nb, BTSDIO_DMA_ALIGN);
822 tmpbuf = kzalloc(tmpbufsz, GFP_KERNEL);
823 if (!tmpbuf)
824 return -ENOMEM;
825 buf = (u8 *) ALIGN_ADDR(tmpbuf, BTSDIO_DMA_ALIGN);
826 memcpy(buf, payload, nb);
827 }
828
829 blksz = SDIO_BLOCK_SIZE;
830 buf_block_len = (nb + blksz - 1) / blksz;
831
832 sdio_claim_host(card->func);
833
834 do {
835 /* Transfer data to card */
836 ret = sdio_writesb(card->func, card->ioport, buf,
837 buf_block_len * blksz);
838 if (ret < 0) {
839 i++;
840 BT_ERR("i=%d writesb failed: %d", i, ret);
841 print_hex_dump_bytes("", DUMP_PREFIX_OFFSET,
842 payload, nb);
843 ret = -EIO;
844 if (i > MAX_WRITE_IOMEM_RETRY)
845 goto exit;
846 }
847 } while (ret);
848
849 priv->btmrvl_dev.tx_dnld_rdy = false;
850
851exit:
852 sdio_release_host(card->func);
853 kfree(tmpbuf);
854
855 return ret;
856}
857
858static int btmrvl_sdio_download_fw(struct btmrvl_sdio_card *card)
859{
860 int ret = 0;
861 u8 fws0;
862 int pollnum = MAX_POLL_TRIES;
863
864 if (!card || !card->func) {
865 BT_ERR("card or function is NULL!");
866 return -EINVAL;
867 }
868 sdio_claim_host(card->func);
869
870 if (!btmrvl_sdio_verify_fw_download(card, 1)) {
871 BT_DBG("Firmware already downloaded!");
872 goto done;
873 }
874
875 /* Check if other function driver is downloading the firmware */
876 fws0 = sdio_readb(card->func, card->reg->card_fw_status0, &ret);
877 if (ret) {
878 BT_ERR("Failed to read FW downloading status!");
879 ret = -EIO;
880 goto done;
881 }
882 if (fws0) {
883 BT_DBG("BT not the winner (%#x). Skip FW downloading", fws0);
884
885 /* Give other function more time to download the firmware */
886 pollnum *= 10;
887 } else {
888 if (card->helper) {
889 ret = btmrvl_sdio_download_helper(card);
890 if (ret) {
891 BT_ERR("Failed to download helper!");
892 ret = -EIO;
893 goto done;
894 }
895 }
896
897 if (btmrvl_sdio_download_fw_w_helper(card)) {
898 BT_ERR("Failed to download firmware!");
899 ret = -EIO;
900 goto done;
901 }
902 }
903
904 if (btmrvl_sdio_verify_fw_download(card, pollnum)) {
905 BT_ERR("FW failed to be active in time!");
906 ret = -ETIMEDOUT;
907 goto done;
908 }
909
910done:
911 sdio_release_host(card->func);
912
913 return ret;
914}
915
916static int btmrvl_sdio_wakeup_fw(struct btmrvl_private *priv)
917{
918 struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
919 int ret = 0;
920
921 if (!card || !card->func) {
922 BT_ERR("card or function is NULL!");
923 return -EINVAL;
924 }
925
926 sdio_claim_host(card->func);
927
928 sdio_writeb(card->func, HOST_POWER_UP, card->reg->cfg, &ret);
929
930 sdio_release_host(card->func);
931
932 BT_DBG("wake up firmware");
933
934 return ret;
935}
936
937static int btmrvl_sdio_probe(struct sdio_func *func,
938 const struct sdio_device_id *id)
939{
940 int ret = 0;
941 struct btmrvl_private *priv = NULL;
942 struct btmrvl_sdio_card *card = NULL;
943
944 BT_INFO("vendor=0x%x, device=0x%x, class=%d, fn=%d",
945 id->vendor, id->device, id->class, func->num);
946
947 card = kzalloc(sizeof(*card), GFP_KERNEL);
948 if (!card) {
949 ret = -ENOMEM;
950 goto done;
951 }
952
953 card->func = func;
954
955 if (id->driver_data) {
956 struct btmrvl_sdio_device *data = (void *) id->driver_data;
957 card->helper = data->helper;
958 card->firmware = data->firmware;
959 card->reg = data->reg;
960 card->sd_blksz_fw_dl = data->sd_blksz_fw_dl;
961 }
962
963 if (btmrvl_sdio_register_dev(card) < 0) {
964 BT_ERR("Failed to register BT device!");
965 ret = -ENODEV;
966 goto free_card;
967 }
968
969 /* Disable the interrupts on the card */
970 btmrvl_sdio_disable_host_int(card);
971
972 if (btmrvl_sdio_download_fw(card)) {
973 BT_ERR("Downloading firmware failed!");
974 ret = -ENODEV;
975 goto unreg_dev;
976 }
977
978 msleep(100);
979
980 btmrvl_sdio_enable_host_int(card);
981
982 priv = btmrvl_add_card(card);
983 if (!priv) {
984 BT_ERR("Initializing card failed!");
985 ret = -ENODEV;
986 goto disable_host_int;
987 }
988
989 card->priv = priv;
990
991 /* Initialize the interface specific function pointers */
992 priv->hw_host_to_card = btmrvl_sdio_host_to_card;
993 priv->hw_wakeup_firmware = btmrvl_sdio_wakeup_fw;
994 priv->hw_process_int_status = btmrvl_sdio_process_int_status;
995
996 if (btmrvl_register_hdev(priv)) {
997 BT_ERR("Register hdev failed!");
998 ret = -ENODEV;
999 goto disable_host_int;
1000 }
1001
1002 priv->btmrvl_dev.psmode = 1;
1003 btmrvl_enable_ps(priv);
1004
1005 return 0;
1006
1007disable_host_int:
1008 btmrvl_sdio_disable_host_int(card);
1009unreg_dev:
1010 btmrvl_sdio_unregister_dev(card);
1011free_card:
1012 kfree(card);
1013done:
1014 return ret;
1015}
1016
1017static void btmrvl_sdio_remove(struct sdio_func *func)
1018{
1019 struct btmrvl_sdio_card *card;
1020
1021 if (func) {
1022 card = sdio_get_drvdata(func);
1023 if (card) {
1024 /* Send SHUTDOWN command & disable interrupt
1025 * if user removes the module.
1026 */
1027 if (user_rmmod) {
1028 btmrvl_send_module_cfg_cmd(card->priv,
1029 MODULE_SHUTDOWN_REQ);
1030 btmrvl_sdio_disable_host_int(card);
1031 }
1032 BT_DBG("unregester dev");
1033 btmrvl_sdio_unregister_dev(card);
1034 btmrvl_remove_card(card->priv);
1035 kfree(card);
1036 }
1037 }
1038}
1039
1040static struct sdio_driver bt_mrvl_sdio = {
1041 .name = "btmrvl_sdio",
1042 .id_table = btmrvl_sdio_ids,
1043 .probe = btmrvl_sdio_probe,
1044 .remove = btmrvl_sdio_remove,
1045};
1046
1047static int __init btmrvl_sdio_init_module(void)
1048{
1049 if (sdio_register_driver(&bt_mrvl_sdio) != 0) {
1050 BT_ERR("SDIO Driver Registration Failed");
1051 return -ENODEV;
1052 }
1053
1054 /* Clear the flag in case user removes the card. */
1055 user_rmmod = 0;
1056
1057 return 0;
1058}
1059
1060static void __exit btmrvl_sdio_exit_module(void)
1061{
1062 /* Set the flag as user is removing this module. */
1063 user_rmmod = 1;
1064
1065 sdio_unregister_driver(&bt_mrvl_sdio);
1066}
1067
1068module_init(btmrvl_sdio_init_module);
1069module_exit(btmrvl_sdio_exit_module);
1070
1071MODULE_AUTHOR("Marvell International Ltd.");
1072MODULE_DESCRIPTION("Marvell BT-over-SDIO driver ver " VERSION);
1073MODULE_VERSION(VERSION);
1074MODULE_LICENSE("GPL v2");
1075MODULE_FIRMWARE("sd8688_helper.bin");
1076MODULE_FIRMWARE("sd8688.bin");
1077MODULE_FIRMWARE("mrvl/sd8787_uapsta.bin");
1/**
2 * Marvell BT-over-SDIO driver: SDIO interface related functions.
3 *
4 * Copyright (C) 2009, Marvell International Ltd.
5 *
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 by writing to the Free Software Foundation, Inc.,
11 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or on the
12 * worldwide web at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
13 *
14 *
15 * THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
17 * ARE EXPRESSLY DISCLAIMED. The License provides additional details about
18 * this warranty disclaimer.
19 **/
20
21#include <linux/firmware.h>
22#include <linux/slab.h>
23
24#include <linux/mmc/sdio_ids.h>
25#include <linux/mmc/sdio_func.h>
26#include <linux/module.h>
27#include <linux/devcoredump.h>
28
29#include <net/bluetooth/bluetooth.h>
30#include <net/bluetooth/hci_core.h>
31
32#include "btmrvl_drv.h"
33#include "btmrvl_sdio.h"
34
35#define VERSION "1.0"
36
37static struct memory_type_mapping mem_type_mapping_tbl[] = {
38 {"ITCM", NULL, 0, 0xF0},
39 {"DTCM", NULL, 0, 0xF1},
40 {"SQRAM", NULL, 0, 0xF2},
41 {"APU", NULL, 0, 0xF3},
42 {"CIU", NULL, 0, 0xF4},
43 {"ICU", NULL, 0, 0xF5},
44 {"MAC", NULL, 0, 0xF6},
45 {"EXT7", NULL, 0, 0xF7},
46 {"EXT8", NULL, 0, 0xF8},
47 {"EXT9", NULL, 0, 0xF9},
48 {"EXT10", NULL, 0, 0xFA},
49 {"EXT11", NULL, 0, 0xFB},
50 {"EXT12", NULL, 0, 0xFC},
51 {"EXT13", NULL, 0, 0xFD},
52 {"EXTLAST", NULL, 0, 0xFE},
53};
54
55/* The btmrvl_sdio_remove() callback function is called
56 * when user removes this module from kernel space or ejects
57 * the card from the slot. The driver handles these 2 cases
58 * differently.
59 * If the user is removing the module, a MODULE_SHUTDOWN_REQ
60 * command is sent to firmware and interrupt will be disabled.
61 * If the card is removed, there is no need to send command
62 * or disable interrupt.
63 *
64 * The variable 'user_rmmod' is used to distinguish these two
65 * scenarios. This flag is initialized as FALSE in case the card
66 * is removed, and will be set to TRUE for module removal when
67 * module_exit function is called.
68 */
69static u8 user_rmmod;
70static u8 sdio_ireg;
71
72static const struct btmrvl_sdio_card_reg btmrvl_reg_8688 = {
73 .cfg = 0x03,
74 .host_int_mask = 0x04,
75 .host_intstatus = 0x05,
76 .card_status = 0x20,
77 .sq_read_base_addr_a0 = 0x10,
78 .sq_read_base_addr_a1 = 0x11,
79 .card_fw_status0 = 0x40,
80 .card_fw_status1 = 0x41,
81 .card_rx_len = 0x42,
82 .card_rx_unit = 0x43,
83 .io_port_0 = 0x00,
84 .io_port_1 = 0x01,
85 .io_port_2 = 0x02,
86 .int_read_to_clear = false,
87};
88static const struct btmrvl_sdio_card_reg btmrvl_reg_87xx = {
89 .cfg = 0x00,
90 .host_int_mask = 0x02,
91 .host_intstatus = 0x03,
92 .card_status = 0x30,
93 .sq_read_base_addr_a0 = 0x40,
94 .sq_read_base_addr_a1 = 0x41,
95 .card_revision = 0x5c,
96 .card_fw_status0 = 0x60,
97 .card_fw_status1 = 0x61,
98 .card_rx_len = 0x62,
99 .card_rx_unit = 0x63,
100 .io_port_0 = 0x78,
101 .io_port_1 = 0x79,
102 .io_port_2 = 0x7a,
103 .int_read_to_clear = false,
104};
105
106static const struct btmrvl_sdio_card_reg btmrvl_reg_8887 = {
107 .cfg = 0x00,
108 .host_int_mask = 0x08,
109 .host_intstatus = 0x0C,
110 .card_status = 0x5C,
111 .sq_read_base_addr_a0 = 0x6C,
112 .sq_read_base_addr_a1 = 0x6D,
113 .card_revision = 0xC8,
114 .card_fw_status0 = 0x88,
115 .card_fw_status1 = 0x89,
116 .card_rx_len = 0x8A,
117 .card_rx_unit = 0x8B,
118 .io_port_0 = 0xE4,
119 .io_port_1 = 0xE5,
120 .io_port_2 = 0xE6,
121 .int_read_to_clear = true,
122 .host_int_rsr = 0x04,
123 .card_misc_cfg = 0xD8,
124};
125
126static const struct btmrvl_sdio_card_reg btmrvl_reg_8897 = {
127 .cfg = 0x00,
128 .host_int_mask = 0x02,
129 .host_intstatus = 0x03,
130 .card_status = 0x50,
131 .sq_read_base_addr_a0 = 0x60,
132 .sq_read_base_addr_a1 = 0x61,
133 .card_revision = 0xbc,
134 .card_fw_status0 = 0xc0,
135 .card_fw_status1 = 0xc1,
136 .card_rx_len = 0xc2,
137 .card_rx_unit = 0xc3,
138 .io_port_0 = 0xd8,
139 .io_port_1 = 0xd9,
140 .io_port_2 = 0xda,
141 .int_read_to_clear = true,
142 .host_int_rsr = 0x01,
143 .card_misc_cfg = 0xcc,
144 .fw_dump_ctrl = 0xe2,
145 .fw_dump_start = 0xe3,
146 .fw_dump_end = 0xea,
147};
148
149static const struct btmrvl_sdio_card_reg btmrvl_reg_8997 = {
150 .cfg = 0x00,
151 .host_int_mask = 0x08,
152 .host_intstatus = 0x0c,
153 .card_status = 0x5c,
154 .sq_read_base_addr_a0 = 0xf8,
155 .sq_read_base_addr_a1 = 0xf9,
156 .card_revision = 0xc8,
157 .card_fw_status0 = 0xe8,
158 .card_fw_status1 = 0xe9,
159 .card_rx_len = 0xea,
160 .card_rx_unit = 0xeb,
161 .io_port_0 = 0xe4,
162 .io_port_1 = 0xe5,
163 .io_port_2 = 0xe6,
164 .int_read_to_clear = true,
165 .host_int_rsr = 0x04,
166 .card_misc_cfg = 0xD8,
167 .fw_dump_ctrl = 0xf0,
168 .fw_dump_start = 0xf1,
169 .fw_dump_end = 0xf8,
170};
171
172static const struct btmrvl_sdio_device btmrvl_sdio_sd8688 = {
173 .helper = "mrvl/sd8688_helper.bin",
174 .firmware = "mrvl/sd8688.bin",
175 .reg = &btmrvl_reg_8688,
176 .support_pscan_win_report = false,
177 .sd_blksz_fw_dl = 64,
178 .supports_fw_dump = false,
179};
180
181static const struct btmrvl_sdio_device btmrvl_sdio_sd8787 = {
182 .helper = NULL,
183 .firmware = "mrvl/sd8787_uapsta.bin",
184 .reg = &btmrvl_reg_87xx,
185 .support_pscan_win_report = false,
186 .sd_blksz_fw_dl = 256,
187 .supports_fw_dump = false,
188};
189
190static const struct btmrvl_sdio_device btmrvl_sdio_sd8797 = {
191 .helper = NULL,
192 .firmware = "mrvl/sd8797_uapsta.bin",
193 .reg = &btmrvl_reg_87xx,
194 .support_pscan_win_report = false,
195 .sd_blksz_fw_dl = 256,
196 .supports_fw_dump = false,
197};
198
199static const struct btmrvl_sdio_device btmrvl_sdio_sd8887 = {
200 .helper = NULL,
201 .firmware = "mrvl/sd8887_uapsta.bin",
202 .reg = &btmrvl_reg_8887,
203 .support_pscan_win_report = true,
204 .sd_blksz_fw_dl = 256,
205 .supports_fw_dump = false,
206};
207
208static const struct btmrvl_sdio_device btmrvl_sdio_sd8897 = {
209 .helper = NULL,
210 .firmware = "mrvl/sd8897_uapsta.bin",
211 .reg = &btmrvl_reg_8897,
212 .support_pscan_win_report = true,
213 .sd_blksz_fw_dl = 256,
214 .supports_fw_dump = true,
215};
216
217static const struct btmrvl_sdio_device btmrvl_sdio_sd8997 = {
218 .helper = NULL,
219 .firmware = "mrvl/sd8997_uapsta.bin",
220 .reg = &btmrvl_reg_8997,
221 .support_pscan_win_report = true,
222 .sd_blksz_fw_dl = 256,
223 .supports_fw_dump = true,
224};
225
226static const struct sdio_device_id btmrvl_sdio_ids[] = {
227 /* Marvell SD8688 Bluetooth device */
228 { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL, 0x9105),
229 .driver_data = (unsigned long)&btmrvl_sdio_sd8688 },
230 /* Marvell SD8787 Bluetooth device */
231 { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL, 0x911A),
232 .driver_data = (unsigned long)&btmrvl_sdio_sd8787 },
233 /* Marvell SD8787 Bluetooth AMP device */
234 { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL, 0x911B),
235 .driver_data = (unsigned long)&btmrvl_sdio_sd8787 },
236 /* Marvell SD8797 Bluetooth device */
237 { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL, 0x912A),
238 .driver_data = (unsigned long)&btmrvl_sdio_sd8797 },
239 /* Marvell SD8887 Bluetooth device */
240 { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL, 0x9136),
241 .driver_data = (unsigned long)&btmrvl_sdio_sd8887 },
242 /* Marvell SD8897 Bluetooth device */
243 { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL, 0x912E),
244 .driver_data = (unsigned long)&btmrvl_sdio_sd8897 },
245 /* Marvell SD8997 Bluetooth device */
246 { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL, 0x9142),
247 .driver_data = (unsigned long)&btmrvl_sdio_sd8997 },
248
249 { } /* Terminating entry */
250};
251
252MODULE_DEVICE_TABLE(sdio, btmrvl_sdio_ids);
253
254static int btmrvl_sdio_get_rx_unit(struct btmrvl_sdio_card *card)
255{
256 u8 reg;
257 int ret;
258
259 reg = sdio_readb(card->func, card->reg->card_rx_unit, &ret);
260 if (!ret)
261 card->rx_unit = reg;
262
263 return ret;
264}
265
266static int btmrvl_sdio_read_fw_status(struct btmrvl_sdio_card *card, u16 *dat)
267{
268 u8 fws0, fws1;
269 int ret;
270
271 *dat = 0;
272
273 fws0 = sdio_readb(card->func, card->reg->card_fw_status0, &ret);
274 if (ret)
275 return -EIO;
276
277 fws1 = sdio_readb(card->func, card->reg->card_fw_status1, &ret);
278 if (ret)
279 return -EIO;
280
281 *dat = (((u16) fws1) << 8) | fws0;
282
283 return 0;
284}
285
286static int btmrvl_sdio_read_rx_len(struct btmrvl_sdio_card *card, u16 *dat)
287{
288 u8 reg;
289 int ret;
290
291 reg = sdio_readb(card->func, card->reg->card_rx_len, &ret);
292 if (!ret)
293 *dat = (u16) reg << card->rx_unit;
294
295 return ret;
296}
297
298static int btmrvl_sdio_enable_host_int_mask(struct btmrvl_sdio_card *card,
299 u8 mask)
300{
301 int ret;
302
303 sdio_writeb(card->func, mask, card->reg->host_int_mask, &ret);
304 if (ret) {
305 BT_ERR("Unable to enable the host interrupt!");
306 ret = -EIO;
307 }
308
309 return ret;
310}
311
312static int btmrvl_sdio_disable_host_int_mask(struct btmrvl_sdio_card *card,
313 u8 mask)
314{
315 u8 host_int_mask;
316 int ret;
317
318 host_int_mask = sdio_readb(card->func, card->reg->host_int_mask, &ret);
319 if (ret)
320 return -EIO;
321
322 host_int_mask &= ~mask;
323
324 sdio_writeb(card->func, host_int_mask, card->reg->host_int_mask, &ret);
325 if (ret < 0) {
326 BT_ERR("Unable to disable the host interrupt!");
327 return -EIO;
328 }
329
330 return 0;
331}
332
333static int btmrvl_sdio_poll_card_status(struct btmrvl_sdio_card *card, u8 bits)
334{
335 unsigned int tries;
336 u8 status;
337 int ret;
338
339 for (tries = 0; tries < MAX_POLL_TRIES * 1000; tries++) {
340 status = sdio_readb(card->func, card->reg->card_status, &ret);
341 if (ret)
342 goto failed;
343 if ((status & bits) == bits)
344 return ret;
345
346 udelay(1);
347 }
348
349 ret = -ETIMEDOUT;
350
351failed:
352 BT_ERR("FAILED! ret=%d", ret);
353
354 return ret;
355}
356
357static int btmrvl_sdio_verify_fw_download(struct btmrvl_sdio_card *card,
358 int pollnum)
359{
360 u16 firmwarestat;
361 int tries, ret;
362
363 /* Wait for firmware to become ready */
364 for (tries = 0; tries < pollnum; tries++) {
365 sdio_claim_host(card->func);
366 ret = btmrvl_sdio_read_fw_status(card, &firmwarestat);
367 sdio_release_host(card->func);
368 if (ret < 0)
369 continue;
370
371 if (firmwarestat == FIRMWARE_READY)
372 return 0;
373
374 msleep(100);
375 }
376
377 return -ETIMEDOUT;
378}
379
380static int btmrvl_sdio_download_helper(struct btmrvl_sdio_card *card)
381{
382 const struct firmware *fw_helper = NULL;
383 const u8 *helper = NULL;
384 int ret;
385 void *tmphlprbuf = NULL;
386 int tmphlprbufsz, hlprblknow, helperlen;
387 u8 *helperbuf;
388 u32 tx_len;
389
390 ret = request_firmware(&fw_helper, card->helper,
391 &card->func->dev);
392 if ((ret < 0) || !fw_helper) {
393 BT_ERR("request_firmware(helper) failed, error code = %d",
394 ret);
395 ret = -ENOENT;
396 goto done;
397 }
398
399 helper = fw_helper->data;
400 helperlen = fw_helper->size;
401
402 BT_DBG("Downloading helper image (%d bytes), block size %d bytes",
403 helperlen, SDIO_BLOCK_SIZE);
404
405 tmphlprbufsz = ALIGN_SZ(BTM_UPLD_SIZE, BTSDIO_DMA_ALIGN);
406
407 tmphlprbuf = kzalloc(tmphlprbufsz, GFP_KERNEL);
408 if (!tmphlprbuf) {
409 BT_ERR("Unable to allocate buffer for helper."
410 " Terminating download");
411 ret = -ENOMEM;
412 goto done;
413 }
414
415 helperbuf = (u8 *) ALIGN_ADDR(tmphlprbuf, BTSDIO_DMA_ALIGN);
416
417 /* Perform helper data transfer */
418 tx_len = (FIRMWARE_TRANSFER_NBLOCK * SDIO_BLOCK_SIZE)
419 - SDIO_HEADER_LEN;
420 hlprblknow = 0;
421
422 do {
423 ret = btmrvl_sdio_poll_card_status(card,
424 CARD_IO_READY | DN_LD_CARD_RDY);
425 if (ret < 0) {
426 BT_ERR("Helper download poll status timeout @ %d",
427 hlprblknow);
428 goto done;
429 }
430
431 /* Check if there is more data? */
432 if (hlprblknow >= helperlen)
433 break;
434
435 if (helperlen - hlprblknow < tx_len)
436 tx_len = helperlen - hlprblknow;
437
438 /* Little-endian */
439 helperbuf[0] = ((tx_len & 0x000000ff) >> 0);
440 helperbuf[1] = ((tx_len & 0x0000ff00) >> 8);
441 helperbuf[2] = ((tx_len & 0x00ff0000) >> 16);
442 helperbuf[3] = ((tx_len & 0xff000000) >> 24);
443
444 memcpy(&helperbuf[SDIO_HEADER_LEN], &helper[hlprblknow],
445 tx_len);
446
447 /* Now send the data */
448 ret = sdio_writesb(card->func, card->ioport, helperbuf,
449 FIRMWARE_TRANSFER_NBLOCK * SDIO_BLOCK_SIZE);
450 if (ret < 0) {
451 BT_ERR("IO error during helper download @ %d",
452 hlprblknow);
453 goto done;
454 }
455
456 hlprblknow += tx_len;
457 } while (true);
458
459 BT_DBG("Transferring helper image EOF block");
460
461 memset(helperbuf, 0x0, SDIO_BLOCK_SIZE);
462
463 ret = sdio_writesb(card->func, card->ioport, helperbuf,
464 SDIO_BLOCK_SIZE);
465 if (ret < 0) {
466 BT_ERR("IO error in writing helper image EOF block");
467 goto done;
468 }
469
470 ret = 0;
471
472done:
473 kfree(tmphlprbuf);
474 release_firmware(fw_helper);
475 return ret;
476}
477
478static int btmrvl_sdio_download_fw_w_helper(struct btmrvl_sdio_card *card)
479{
480 const struct firmware *fw_firmware = NULL;
481 const u8 *firmware = NULL;
482 int firmwarelen, tmpfwbufsz, ret;
483 unsigned int tries, offset;
484 u8 base0, base1;
485 void *tmpfwbuf = NULL;
486 u8 *fwbuf;
487 u16 len, blksz_dl = card->sd_blksz_fw_dl;
488 int txlen = 0, tx_blocks = 0, count = 0;
489
490 ret = request_firmware(&fw_firmware, card->firmware,
491 &card->func->dev);
492 if ((ret < 0) || !fw_firmware) {
493 BT_ERR("request_firmware(firmware) failed, error code = %d",
494 ret);
495 ret = -ENOENT;
496 goto done;
497 }
498
499 firmware = fw_firmware->data;
500 firmwarelen = fw_firmware->size;
501
502 BT_DBG("Downloading FW image (%d bytes)", firmwarelen);
503
504 tmpfwbufsz = ALIGN_SZ(BTM_UPLD_SIZE, BTSDIO_DMA_ALIGN);
505 tmpfwbuf = kzalloc(tmpfwbufsz, GFP_KERNEL);
506 if (!tmpfwbuf) {
507 BT_ERR("Unable to allocate buffer for firmware."
508 " Terminating download");
509 ret = -ENOMEM;
510 goto done;
511 }
512
513 /* Ensure aligned firmware buffer */
514 fwbuf = (u8 *) ALIGN_ADDR(tmpfwbuf, BTSDIO_DMA_ALIGN);
515
516 /* Perform firmware data transfer */
517 offset = 0;
518 do {
519 ret = btmrvl_sdio_poll_card_status(card,
520 CARD_IO_READY | DN_LD_CARD_RDY);
521 if (ret < 0) {
522 BT_ERR("FW download with helper poll status"
523 " timeout @ %d", offset);
524 goto done;
525 }
526
527 /* Check if there is more data ? */
528 if (offset >= firmwarelen)
529 break;
530
531 for (tries = 0; tries < MAX_POLL_TRIES; tries++) {
532 base0 = sdio_readb(card->func,
533 card->reg->sq_read_base_addr_a0, &ret);
534 if (ret) {
535 BT_ERR("BASE0 register read failed:"
536 " base0 = 0x%04X(%d)."
537 " Terminating download",
538 base0, base0);
539 ret = -EIO;
540 goto done;
541 }
542 base1 = sdio_readb(card->func,
543 card->reg->sq_read_base_addr_a1, &ret);
544 if (ret) {
545 BT_ERR("BASE1 register read failed:"
546 " base1 = 0x%04X(%d)."
547 " Terminating download",
548 base1, base1);
549 ret = -EIO;
550 goto done;
551 }
552
553 len = (((u16) base1) << 8) | base0;
554 if (len)
555 break;
556
557 udelay(10);
558 }
559
560 if (!len)
561 break;
562 else if (len > BTM_UPLD_SIZE) {
563 BT_ERR("FW download failure @%d, invalid length %d",
564 offset, len);
565 ret = -EINVAL;
566 goto done;
567 }
568
569 txlen = len;
570
571 if (len & BIT(0)) {
572 count++;
573 if (count > MAX_WRITE_IOMEM_RETRY) {
574 BT_ERR("FW download failure @%d, "
575 "over max retry count", offset);
576 ret = -EIO;
577 goto done;
578 }
579 BT_ERR("FW CRC error indicated by the helper: "
580 "len = 0x%04X, txlen = %d", len, txlen);
581 len &= ~BIT(0);
582 /* Set txlen to 0 so as to resend from same offset */
583 txlen = 0;
584 } else {
585 count = 0;
586
587 /* Last block ? */
588 if (firmwarelen - offset < txlen)
589 txlen = firmwarelen - offset;
590
591 tx_blocks = DIV_ROUND_UP(txlen, blksz_dl);
592
593 memcpy(fwbuf, &firmware[offset], txlen);
594 }
595
596 ret = sdio_writesb(card->func, card->ioport, fwbuf,
597 tx_blocks * blksz_dl);
598
599 if (ret < 0) {
600 BT_ERR("FW download, writesb(%d) failed @%d",
601 count, offset);
602 sdio_writeb(card->func, HOST_CMD53_FIN,
603 card->reg->cfg, &ret);
604 if (ret)
605 BT_ERR("writeb failed (CFG)");
606 }
607
608 offset += txlen;
609 } while (true);
610
611 BT_INFO("FW download over, size %d bytes", offset);
612
613 ret = 0;
614
615done:
616 kfree(tmpfwbuf);
617 release_firmware(fw_firmware);
618 return ret;
619}
620
621static int btmrvl_sdio_card_to_host(struct btmrvl_private *priv)
622{
623 u16 buf_len = 0;
624 int ret, num_blocks, blksz;
625 struct sk_buff *skb = NULL;
626 u32 type;
627 u8 *payload = NULL;
628 struct hci_dev *hdev = priv->btmrvl_dev.hcidev;
629 struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
630
631 if (!card || !card->func) {
632 BT_ERR("card or function is NULL!");
633 ret = -EINVAL;
634 goto exit;
635 }
636
637 /* Read the length of data to be transferred */
638 ret = btmrvl_sdio_read_rx_len(card, &buf_len);
639 if (ret < 0) {
640 BT_ERR("read rx_len failed");
641 ret = -EIO;
642 goto exit;
643 }
644
645 blksz = SDIO_BLOCK_SIZE;
646 num_blocks = DIV_ROUND_UP(buf_len, blksz);
647
648 if (buf_len <= SDIO_HEADER_LEN
649 || (num_blocks * blksz) > ALLOC_BUF_SIZE) {
650 BT_ERR("invalid packet length: %d", buf_len);
651 ret = -EINVAL;
652 goto exit;
653 }
654
655 /* Allocate buffer */
656 skb = bt_skb_alloc(num_blocks * blksz + BTSDIO_DMA_ALIGN, GFP_ATOMIC);
657 if (!skb) {
658 BT_ERR("No free skb");
659 ret = -ENOMEM;
660 goto exit;
661 }
662
663 if ((unsigned long) skb->data & (BTSDIO_DMA_ALIGN - 1)) {
664 skb_put(skb, (unsigned long) skb->data &
665 (BTSDIO_DMA_ALIGN - 1));
666 skb_pull(skb, (unsigned long) skb->data &
667 (BTSDIO_DMA_ALIGN - 1));
668 }
669
670 payload = skb->data;
671
672 ret = sdio_readsb(card->func, payload, card->ioport,
673 num_blocks * blksz);
674 if (ret < 0) {
675 BT_ERR("readsb failed: %d", ret);
676 ret = -EIO;
677 goto exit;
678 }
679
680 /* This is SDIO specific header length: byte[2][1][0], type: byte[3]
681 * (HCI_COMMAND = 1, ACL_DATA = 2, SCO_DATA = 3, 0xFE = Vendor)
682 */
683
684 buf_len = payload[0];
685 buf_len |= payload[1] << 8;
686 buf_len |= payload[2] << 16;
687
688 if (buf_len > blksz * num_blocks) {
689 BT_ERR("Skip incorrect packet: hdrlen %d buffer %d",
690 buf_len, blksz * num_blocks);
691 ret = -EIO;
692 goto exit;
693 }
694
695 type = payload[3];
696
697 switch (type) {
698 case HCI_ACLDATA_PKT:
699 case HCI_SCODATA_PKT:
700 case HCI_EVENT_PKT:
701 hci_skb_pkt_type(skb) = type;
702 skb_put(skb, buf_len);
703 skb_pull(skb, SDIO_HEADER_LEN);
704
705 if (type == HCI_EVENT_PKT) {
706 if (btmrvl_check_evtpkt(priv, skb))
707 hci_recv_frame(hdev, skb);
708 } else {
709 hci_recv_frame(hdev, skb);
710 }
711
712 hdev->stat.byte_rx += buf_len;
713 break;
714
715 case MRVL_VENDOR_PKT:
716 hci_skb_pkt_type(skb) = HCI_VENDOR_PKT;
717 skb_put(skb, buf_len);
718 skb_pull(skb, SDIO_HEADER_LEN);
719
720 if (btmrvl_process_event(priv, skb))
721 hci_recv_frame(hdev, skb);
722
723 hdev->stat.byte_rx += buf_len;
724 break;
725
726 default:
727 BT_ERR("Unknown packet type:%d", type);
728 BT_ERR("hex: %*ph", blksz * num_blocks, payload);
729
730 kfree_skb(skb);
731 skb = NULL;
732 break;
733 }
734
735exit:
736 if (ret) {
737 hdev->stat.err_rx++;
738 kfree_skb(skb);
739 }
740
741 return ret;
742}
743
744static int btmrvl_sdio_process_int_status(struct btmrvl_private *priv)
745{
746 ulong flags;
747 u8 ireg;
748 struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
749
750 spin_lock_irqsave(&priv->driver_lock, flags);
751 ireg = sdio_ireg;
752 sdio_ireg = 0;
753 spin_unlock_irqrestore(&priv->driver_lock, flags);
754
755 sdio_claim_host(card->func);
756 if (ireg & DN_LD_HOST_INT_STATUS) {
757 if (priv->btmrvl_dev.tx_dnld_rdy)
758 BT_DBG("tx_done already received: "
759 " int_status=0x%x", ireg);
760 else
761 priv->btmrvl_dev.tx_dnld_rdy = true;
762 }
763
764 if (ireg & UP_LD_HOST_INT_STATUS)
765 btmrvl_sdio_card_to_host(priv);
766
767 sdio_release_host(card->func);
768
769 return 0;
770}
771
772static int btmrvl_sdio_read_to_clear(struct btmrvl_sdio_card *card, u8 *ireg)
773{
774 struct btmrvl_adapter *adapter = card->priv->adapter;
775 int ret;
776
777 ret = sdio_readsb(card->func, adapter->hw_regs, 0, SDIO_BLOCK_SIZE);
778 if (ret) {
779 BT_ERR("sdio_readsb: read int hw_regs failed: %d", ret);
780 return ret;
781 }
782
783 *ireg = adapter->hw_regs[card->reg->host_intstatus];
784 BT_DBG("hw_regs[%#x]=%#x", card->reg->host_intstatus, *ireg);
785
786 return 0;
787}
788
789static int btmrvl_sdio_write_to_clear(struct btmrvl_sdio_card *card, u8 *ireg)
790{
791 int ret;
792
793 *ireg = sdio_readb(card->func, card->reg->host_intstatus, &ret);
794 if (ret) {
795 BT_ERR("sdio_readb: read int status failed: %d", ret);
796 return ret;
797 }
798
799 if (*ireg) {
800 /*
801 * DN_LD_HOST_INT_STATUS and/or UP_LD_HOST_INT_STATUS
802 * Clear the interrupt status register and re-enable the
803 * interrupt.
804 */
805 BT_DBG("int_status = 0x%x", *ireg);
806
807 sdio_writeb(card->func, ~(*ireg) & (DN_LD_HOST_INT_STATUS |
808 UP_LD_HOST_INT_STATUS),
809 card->reg->host_intstatus, &ret);
810 if (ret) {
811 BT_ERR("sdio_writeb: clear int status failed: %d", ret);
812 return ret;
813 }
814 }
815
816 return 0;
817}
818
819static void btmrvl_sdio_interrupt(struct sdio_func *func)
820{
821 struct btmrvl_private *priv;
822 struct btmrvl_sdio_card *card;
823 ulong flags;
824 u8 ireg = 0;
825 int ret;
826
827 card = sdio_get_drvdata(func);
828 if (!card || !card->priv) {
829 BT_ERR("sbi_interrupt(%p) card or priv is NULL, card=%p",
830 func, card);
831 return;
832 }
833
834 priv = card->priv;
835
836 if (priv->surprise_removed)
837 return;
838
839 if (card->reg->int_read_to_clear)
840 ret = btmrvl_sdio_read_to_clear(card, &ireg);
841 else
842 ret = btmrvl_sdio_write_to_clear(card, &ireg);
843
844 if (ret)
845 return;
846
847 spin_lock_irqsave(&priv->driver_lock, flags);
848 sdio_ireg |= ireg;
849 spin_unlock_irqrestore(&priv->driver_lock, flags);
850
851 btmrvl_interrupt(priv);
852}
853
854static int btmrvl_sdio_register_dev(struct btmrvl_sdio_card *card)
855{
856 struct sdio_func *func;
857 u8 reg;
858 int ret = 0;
859
860 if (!card || !card->func) {
861 BT_ERR("Error: card or function is NULL!");
862 ret = -EINVAL;
863 goto failed;
864 }
865
866 func = card->func;
867
868 sdio_claim_host(func);
869
870 ret = sdio_enable_func(func);
871 if (ret) {
872 BT_ERR("sdio_enable_func() failed: ret=%d", ret);
873 ret = -EIO;
874 goto release_host;
875 }
876
877 ret = sdio_claim_irq(func, btmrvl_sdio_interrupt);
878 if (ret) {
879 BT_ERR("sdio_claim_irq failed: ret=%d", ret);
880 ret = -EIO;
881 goto disable_func;
882 }
883
884 ret = sdio_set_block_size(card->func, SDIO_BLOCK_SIZE);
885 if (ret) {
886 BT_ERR("cannot set SDIO block size");
887 ret = -EIO;
888 goto release_irq;
889 }
890
891 reg = sdio_readb(func, card->reg->io_port_0, &ret);
892 if (ret < 0) {
893 ret = -EIO;
894 goto release_irq;
895 }
896
897 card->ioport = reg;
898
899 reg = sdio_readb(func, card->reg->io_port_1, &ret);
900 if (ret < 0) {
901 ret = -EIO;
902 goto release_irq;
903 }
904
905 card->ioport |= (reg << 8);
906
907 reg = sdio_readb(func, card->reg->io_port_2, &ret);
908 if (ret < 0) {
909 ret = -EIO;
910 goto release_irq;
911 }
912
913 card->ioport |= (reg << 16);
914
915 BT_DBG("SDIO FUNC%d IO port: 0x%x", func->num, card->ioport);
916
917 if (card->reg->int_read_to_clear) {
918 reg = sdio_readb(func, card->reg->host_int_rsr, &ret);
919 if (ret < 0) {
920 ret = -EIO;
921 goto release_irq;
922 }
923 sdio_writeb(func, reg | 0x3f, card->reg->host_int_rsr, &ret);
924 if (ret < 0) {
925 ret = -EIO;
926 goto release_irq;
927 }
928
929 reg = sdio_readb(func, card->reg->card_misc_cfg, &ret);
930 if (ret < 0) {
931 ret = -EIO;
932 goto release_irq;
933 }
934 sdio_writeb(func, reg | 0x10, card->reg->card_misc_cfg, &ret);
935 if (ret < 0) {
936 ret = -EIO;
937 goto release_irq;
938 }
939 }
940
941 sdio_set_drvdata(func, card);
942
943 sdio_release_host(func);
944
945 return 0;
946
947release_irq:
948 sdio_release_irq(func);
949
950disable_func:
951 sdio_disable_func(func);
952
953release_host:
954 sdio_release_host(func);
955
956failed:
957 return ret;
958}
959
960static int btmrvl_sdio_unregister_dev(struct btmrvl_sdio_card *card)
961{
962 if (card && card->func) {
963 sdio_claim_host(card->func);
964 sdio_release_irq(card->func);
965 sdio_disable_func(card->func);
966 sdio_release_host(card->func);
967 sdio_set_drvdata(card->func, NULL);
968 }
969
970 return 0;
971}
972
973static int btmrvl_sdio_enable_host_int(struct btmrvl_sdio_card *card)
974{
975 int ret;
976
977 if (!card || !card->func)
978 return -EINVAL;
979
980 sdio_claim_host(card->func);
981
982 ret = btmrvl_sdio_enable_host_int_mask(card, HIM_ENABLE);
983
984 btmrvl_sdio_get_rx_unit(card);
985
986 sdio_release_host(card->func);
987
988 return ret;
989}
990
991static int btmrvl_sdio_disable_host_int(struct btmrvl_sdio_card *card)
992{
993 int ret;
994
995 if (!card || !card->func)
996 return -EINVAL;
997
998 sdio_claim_host(card->func);
999
1000 ret = btmrvl_sdio_disable_host_int_mask(card, HIM_DISABLE);
1001
1002 sdio_release_host(card->func);
1003
1004 return ret;
1005}
1006
1007static int btmrvl_sdio_host_to_card(struct btmrvl_private *priv,
1008 u8 *payload, u16 nb)
1009{
1010 struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
1011 int ret = 0;
1012 int buf_block_len;
1013 int blksz;
1014 int i = 0;
1015 u8 *buf = NULL;
1016 void *tmpbuf = NULL;
1017 int tmpbufsz;
1018
1019 if (!card || !card->func) {
1020 BT_ERR("card or function is NULL!");
1021 return -EINVAL;
1022 }
1023
1024 buf = payload;
1025 if ((unsigned long) payload & (BTSDIO_DMA_ALIGN - 1)) {
1026 tmpbufsz = ALIGN_SZ(nb, BTSDIO_DMA_ALIGN);
1027 tmpbuf = kzalloc(tmpbufsz, GFP_KERNEL);
1028 if (!tmpbuf)
1029 return -ENOMEM;
1030 buf = (u8 *) ALIGN_ADDR(tmpbuf, BTSDIO_DMA_ALIGN);
1031 memcpy(buf, payload, nb);
1032 }
1033
1034 blksz = SDIO_BLOCK_SIZE;
1035 buf_block_len = DIV_ROUND_UP(nb, blksz);
1036
1037 sdio_claim_host(card->func);
1038
1039 do {
1040 /* Transfer data to card */
1041 ret = sdio_writesb(card->func, card->ioport, buf,
1042 buf_block_len * blksz);
1043 if (ret < 0) {
1044 i++;
1045 BT_ERR("i=%d writesb failed: %d", i, ret);
1046 BT_ERR("hex: %*ph", nb, payload);
1047 ret = -EIO;
1048 if (i > MAX_WRITE_IOMEM_RETRY)
1049 goto exit;
1050 }
1051 } while (ret);
1052
1053 priv->btmrvl_dev.tx_dnld_rdy = false;
1054
1055exit:
1056 sdio_release_host(card->func);
1057 kfree(tmpbuf);
1058
1059 return ret;
1060}
1061
1062static int btmrvl_sdio_download_fw(struct btmrvl_sdio_card *card)
1063{
1064 int ret;
1065 u8 fws0;
1066 int pollnum = MAX_POLL_TRIES;
1067
1068 if (!card || !card->func) {
1069 BT_ERR("card or function is NULL!");
1070 return -EINVAL;
1071 }
1072
1073 if (!btmrvl_sdio_verify_fw_download(card, 1)) {
1074 BT_DBG("Firmware already downloaded!");
1075 return 0;
1076 }
1077
1078 sdio_claim_host(card->func);
1079
1080 /* Check if other function driver is downloading the firmware */
1081 fws0 = sdio_readb(card->func, card->reg->card_fw_status0, &ret);
1082 if (ret) {
1083 BT_ERR("Failed to read FW downloading status!");
1084 ret = -EIO;
1085 goto done;
1086 }
1087 if (fws0) {
1088 BT_DBG("BT not the winner (%#x). Skip FW downloading", fws0);
1089
1090 /* Give other function more time to download the firmware */
1091 pollnum *= 10;
1092 } else {
1093 if (card->helper) {
1094 ret = btmrvl_sdio_download_helper(card);
1095 if (ret) {
1096 BT_ERR("Failed to download helper!");
1097 ret = -EIO;
1098 goto done;
1099 }
1100 }
1101
1102 if (btmrvl_sdio_download_fw_w_helper(card)) {
1103 BT_ERR("Failed to download firmware!");
1104 ret = -EIO;
1105 goto done;
1106 }
1107 }
1108
1109 /*
1110 * winner or not, with this test the FW synchronizes when the
1111 * module can continue its initialization
1112 */
1113 if (btmrvl_sdio_verify_fw_download(card, pollnum)) {
1114 BT_ERR("FW failed to be active in time!");
1115 ret = -ETIMEDOUT;
1116 goto done;
1117 }
1118
1119 sdio_release_host(card->func);
1120
1121 return 0;
1122
1123done:
1124 sdio_release_host(card->func);
1125 return ret;
1126}
1127
1128static int btmrvl_sdio_wakeup_fw(struct btmrvl_private *priv)
1129{
1130 struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
1131 int ret = 0;
1132
1133 if (!card || !card->func) {
1134 BT_ERR("card or function is NULL!");
1135 return -EINVAL;
1136 }
1137
1138 sdio_claim_host(card->func);
1139
1140 sdio_writeb(card->func, HOST_POWER_UP, card->reg->cfg, &ret);
1141
1142 sdio_release_host(card->func);
1143
1144 BT_DBG("wake up firmware");
1145
1146 return ret;
1147}
1148
1149static void btmrvl_sdio_dump_regs(struct btmrvl_private *priv)
1150{
1151 struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
1152 int ret = 0;
1153 unsigned int reg, reg_start, reg_end;
1154 char buf[256], *ptr;
1155 u8 loop, func, data;
1156 int MAX_LOOP = 2;
1157
1158 btmrvl_sdio_wakeup_fw(priv);
1159 sdio_claim_host(card->func);
1160
1161 for (loop = 0; loop < MAX_LOOP; loop++) {
1162 memset(buf, 0, sizeof(buf));
1163 ptr = buf;
1164
1165 if (loop == 0) {
1166 /* Read the registers of SDIO function0 */
1167 func = loop;
1168 reg_start = 0;
1169 reg_end = 9;
1170 } else {
1171 func = 2;
1172 reg_start = 0;
1173 reg_end = 0x09;
1174 }
1175
1176 ptr += sprintf(ptr, "SDIO Func%d (%#x-%#x): ",
1177 func, reg_start, reg_end);
1178 for (reg = reg_start; reg <= reg_end; reg++) {
1179 if (func == 0)
1180 data = sdio_f0_readb(card->func, reg, &ret);
1181 else
1182 data = sdio_readb(card->func, reg, &ret);
1183
1184 if (!ret) {
1185 ptr += sprintf(ptr, "%02x ", data);
1186 } else {
1187 ptr += sprintf(ptr, "ERR");
1188 break;
1189 }
1190 }
1191
1192 BT_INFO("%s", buf);
1193 }
1194
1195 sdio_release_host(card->func);
1196}
1197
1198/* This function read/write firmware */
1199static enum
1200rdwr_status btmrvl_sdio_rdwr_firmware(struct btmrvl_private *priv,
1201 u8 doneflag)
1202{
1203 struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
1204 int ret, tries;
1205 u8 ctrl_data = 0;
1206
1207 sdio_writeb(card->func, FW_DUMP_HOST_READY, card->reg->fw_dump_ctrl,
1208 &ret);
1209
1210 if (ret) {
1211 BT_ERR("SDIO write err");
1212 return RDWR_STATUS_FAILURE;
1213 }
1214
1215 for (tries = 0; tries < MAX_POLL_TRIES; tries++) {
1216 ctrl_data = sdio_readb(card->func, card->reg->fw_dump_ctrl,
1217 &ret);
1218
1219 if (ret) {
1220 BT_ERR("SDIO read err");
1221 return RDWR_STATUS_FAILURE;
1222 }
1223
1224 if (ctrl_data == FW_DUMP_DONE)
1225 break;
1226 if (doneflag && ctrl_data == doneflag)
1227 return RDWR_STATUS_DONE;
1228 if (ctrl_data != FW_DUMP_HOST_READY) {
1229 BT_INFO("The ctrl reg was changed, re-try again!");
1230 sdio_writeb(card->func, FW_DUMP_HOST_READY,
1231 card->reg->fw_dump_ctrl, &ret);
1232 if (ret) {
1233 BT_ERR("SDIO write err");
1234 return RDWR_STATUS_FAILURE;
1235 }
1236 }
1237 usleep_range(100, 200);
1238 }
1239
1240 if (ctrl_data == FW_DUMP_HOST_READY) {
1241 BT_ERR("Fail to pull ctrl_data");
1242 return RDWR_STATUS_FAILURE;
1243 }
1244
1245 return RDWR_STATUS_SUCCESS;
1246}
1247
1248/* This function dump sdio register and memory data */
1249static void btmrvl_sdio_dump_firmware(struct btmrvl_private *priv)
1250{
1251 struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
1252 int ret = 0;
1253 unsigned int reg, reg_start, reg_end;
1254 enum rdwr_status stat;
1255 u8 *dbg_ptr, *end_ptr, *fw_dump_data, *fw_dump_ptr;
1256 u8 dump_num = 0, idx, i, read_reg, doneflag = 0;
1257 u32 memory_size, fw_dump_len = 0;
1258
1259 /* dump sdio register first */
1260 btmrvl_sdio_dump_regs(priv);
1261
1262 if (!card->supports_fw_dump) {
1263 BT_ERR("Firmware dump not supported for this card!");
1264 return;
1265 }
1266
1267 for (idx = 0; idx < ARRAY_SIZE(mem_type_mapping_tbl); idx++) {
1268 struct memory_type_mapping *entry = &mem_type_mapping_tbl[idx];
1269
1270 if (entry->mem_ptr) {
1271 vfree(entry->mem_ptr);
1272 entry->mem_ptr = NULL;
1273 }
1274 entry->mem_size = 0;
1275 }
1276
1277 btmrvl_sdio_wakeup_fw(priv);
1278 sdio_claim_host(card->func);
1279
1280 BT_INFO("== btmrvl firmware dump start ==");
1281
1282 stat = btmrvl_sdio_rdwr_firmware(priv, doneflag);
1283 if (stat == RDWR_STATUS_FAILURE)
1284 goto done;
1285
1286 reg = card->reg->fw_dump_start;
1287 /* Read the number of the memories which will dump */
1288 dump_num = sdio_readb(card->func, reg, &ret);
1289
1290 if (ret) {
1291 BT_ERR("SDIO read memory length err");
1292 goto done;
1293 }
1294
1295 /* Read the length of every memory which will dump */
1296 for (idx = 0; idx < dump_num; idx++) {
1297 struct memory_type_mapping *entry = &mem_type_mapping_tbl[idx];
1298
1299 stat = btmrvl_sdio_rdwr_firmware(priv, doneflag);
1300 if (stat == RDWR_STATUS_FAILURE)
1301 goto done;
1302
1303 memory_size = 0;
1304 reg = card->reg->fw_dump_start;
1305 for (i = 0; i < 4; i++) {
1306 read_reg = sdio_readb(card->func, reg, &ret);
1307 if (ret) {
1308 BT_ERR("SDIO read err");
1309 goto done;
1310 }
1311 memory_size |= (read_reg << i*8);
1312 reg++;
1313 }
1314
1315 if (memory_size == 0) {
1316 BT_INFO("Firmware dump finished!");
1317 sdio_writeb(card->func, FW_DUMP_READ_DONE,
1318 card->reg->fw_dump_ctrl, &ret);
1319 if (ret) {
1320 BT_ERR("SDIO Write MEMDUMP_FINISH ERR");
1321 goto done;
1322 }
1323 break;
1324 }
1325
1326 BT_INFO("%s_SIZE=0x%x", entry->mem_name, memory_size);
1327 entry->mem_ptr = vzalloc(memory_size + 1);
1328 entry->mem_size = memory_size;
1329 if (!entry->mem_ptr) {
1330 BT_ERR("Vzalloc %s failed", entry->mem_name);
1331 goto done;
1332 }
1333
1334 fw_dump_len += (strlen("========Start dump ") +
1335 strlen(entry->mem_name) +
1336 strlen("========\n") +
1337 (memory_size + 1) +
1338 strlen("\n========End dump========\n"));
1339
1340 dbg_ptr = entry->mem_ptr;
1341 end_ptr = dbg_ptr + memory_size;
1342
1343 doneflag = entry->done_flag;
1344 BT_INFO("Start %s output, please wait...",
1345 entry->mem_name);
1346
1347 do {
1348 stat = btmrvl_sdio_rdwr_firmware(priv, doneflag);
1349 if (stat == RDWR_STATUS_FAILURE)
1350 goto done;
1351
1352 reg_start = card->reg->fw_dump_start;
1353 reg_end = card->reg->fw_dump_end;
1354 for (reg = reg_start; reg <= reg_end; reg++) {
1355 *dbg_ptr = sdio_readb(card->func, reg, &ret);
1356 if (ret) {
1357 BT_ERR("SDIO read err");
1358 goto done;
1359 }
1360 if (dbg_ptr < end_ptr)
1361 dbg_ptr++;
1362 else
1363 BT_ERR("Allocated buffer not enough");
1364 }
1365
1366 if (stat != RDWR_STATUS_DONE) {
1367 continue;
1368 } else {
1369 BT_INFO("%s done: size=0x%tx",
1370 entry->mem_name,
1371 dbg_ptr - entry->mem_ptr);
1372 break;
1373 }
1374 } while (1);
1375 }
1376
1377 BT_INFO("== btmrvl firmware dump end ==");
1378
1379done:
1380 sdio_release_host(card->func);
1381
1382 if (fw_dump_len == 0)
1383 return;
1384
1385 fw_dump_data = vzalloc(fw_dump_len+1);
1386 if (!fw_dump_data) {
1387 BT_ERR("Vzalloc fw_dump_data fail!");
1388 return;
1389 }
1390 fw_dump_ptr = fw_dump_data;
1391
1392 /* Dump all the memory data into single file, a userspace script will
1393 be used to split all the memory data to multiple files*/
1394 BT_INFO("== btmrvl firmware dump to /sys/class/devcoredump start");
1395 for (idx = 0; idx < dump_num; idx++) {
1396 struct memory_type_mapping *entry = &mem_type_mapping_tbl[idx];
1397
1398 if (entry->mem_ptr) {
1399 strcpy(fw_dump_ptr, "========Start dump ");
1400 fw_dump_ptr += strlen("========Start dump ");
1401
1402 strcpy(fw_dump_ptr, entry->mem_name);
1403 fw_dump_ptr += strlen(entry->mem_name);
1404
1405 strcpy(fw_dump_ptr, "========\n");
1406 fw_dump_ptr += strlen("========\n");
1407
1408 memcpy(fw_dump_ptr, entry->mem_ptr, entry->mem_size);
1409 fw_dump_ptr += entry->mem_size;
1410
1411 strcpy(fw_dump_ptr, "\n========End dump========\n");
1412 fw_dump_ptr += strlen("\n========End dump========\n");
1413
1414 vfree(mem_type_mapping_tbl[idx].mem_ptr);
1415 mem_type_mapping_tbl[idx].mem_ptr = NULL;
1416 }
1417 }
1418
1419 /* fw_dump_data will be free in device coredump release function
1420 after 5 min*/
1421 dev_coredumpv(&card->func->dev, fw_dump_data, fw_dump_len, GFP_KERNEL);
1422 BT_INFO("== btmrvl firmware dump to /sys/class/devcoredump end");
1423}
1424
1425static int btmrvl_sdio_probe(struct sdio_func *func,
1426 const struct sdio_device_id *id)
1427{
1428 int ret = 0;
1429 struct btmrvl_private *priv = NULL;
1430 struct btmrvl_sdio_card *card = NULL;
1431
1432 BT_INFO("vendor=0x%x, device=0x%x, class=%d, fn=%d",
1433 id->vendor, id->device, id->class, func->num);
1434
1435 card = devm_kzalloc(&func->dev, sizeof(*card), GFP_KERNEL);
1436 if (!card)
1437 return -ENOMEM;
1438
1439 card->func = func;
1440
1441 if (id->driver_data) {
1442 struct btmrvl_sdio_device *data = (void *) id->driver_data;
1443 card->helper = data->helper;
1444 card->firmware = data->firmware;
1445 card->reg = data->reg;
1446 card->sd_blksz_fw_dl = data->sd_blksz_fw_dl;
1447 card->support_pscan_win_report = data->support_pscan_win_report;
1448 card->supports_fw_dump = data->supports_fw_dump;
1449 }
1450
1451 if (btmrvl_sdio_register_dev(card) < 0) {
1452 BT_ERR("Failed to register BT device!");
1453 return -ENODEV;
1454 }
1455
1456 /* Disable the interrupts on the card */
1457 btmrvl_sdio_disable_host_int(card);
1458
1459 if (btmrvl_sdio_download_fw(card)) {
1460 BT_ERR("Downloading firmware failed!");
1461 ret = -ENODEV;
1462 goto unreg_dev;
1463 }
1464
1465 btmrvl_sdio_enable_host_int(card);
1466
1467 priv = btmrvl_add_card(card);
1468 if (!priv) {
1469 BT_ERR("Initializing card failed!");
1470 ret = -ENODEV;
1471 goto disable_host_int;
1472 }
1473
1474 card->priv = priv;
1475
1476 /* Initialize the interface specific function pointers */
1477 priv->hw_host_to_card = btmrvl_sdio_host_to_card;
1478 priv->hw_wakeup_firmware = btmrvl_sdio_wakeup_fw;
1479 priv->hw_process_int_status = btmrvl_sdio_process_int_status;
1480 priv->firmware_dump = btmrvl_sdio_dump_firmware;
1481
1482 if (btmrvl_register_hdev(priv)) {
1483 BT_ERR("Register hdev failed!");
1484 ret = -ENODEV;
1485 goto disable_host_int;
1486 }
1487
1488 return 0;
1489
1490disable_host_int:
1491 btmrvl_sdio_disable_host_int(card);
1492unreg_dev:
1493 btmrvl_sdio_unregister_dev(card);
1494 return ret;
1495}
1496
1497static void btmrvl_sdio_remove(struct sdio_func *func)
1498{
1499 struct btmrvl_sdio_card *card;
1500
1501 if (func) {
1502 card = sdio_get_drvdata(func);
1503 if (card) {
1504 /* Send SHUTDOWN command & disable interrupt
1505 * if user removes the module.
1506 */
1507 if (user_rmmod) {
1508 btmrvl_send_module_cfg_cmd(card->priv,
1509 MODULE_SHUTDOWN_REQ);
1510 btmrvl_sdio_disable_host_int(card);
1511 }
1512 BT_DBG("unregester dev");
1513 card->priv->surprise_removed = true;
1514 btmrvl_sdio_unregister_dev(card);
1515 btmrvl_remove_card(card->priv);
1516 }
1517 }
1518}
1519
1520static int btmrvl_sdio_suspend(struct device *dev)
1521{
1522 struct sdio_func *func = dev_to_sdio_func(dev);
1523 struct btmrvl_sdio_card *card;
1524 struct btmrvl_private *priv;
1525 mmc_pm_flag_t pm_flags;
1526 struct hci_dev *hcidev;
1527
1528 if (func) {
1529 pm_flags = sdio_get_host_pm_caps(func);
1530 BT_DBG("%s: suspend: PM flags = 0x%x", sdio_func_id(func),
1531 pm_flags);
1532 if (!(pm_flags & MMC_PM_KEEP_POWER)) {
1533 BT_ERR("%s: cannot remain alive while suspended",
1534 sdio_func_id(func));
1535 return -ENOSYS;
1536 }
1537 card = sdio_get_drvdata(func);
1538 if (!card || !card->priv) {
1539 BT_ERR("card or priv structure is not valid");
1540 return 0;
1541 }
1542 } else {
1543 BT_ERR("sdio_func is not specified");
1544 return 0;
1545 }
1546
1547 priv = card->priv;
1548 priv->adapter->is_suspending = true;
1549 hcidev = priv->btmrvl_dev.hcidev;
1550 BT_DBG("%s: SDIO suspend", hcidev->name);
1551 hci_suspend_dev(hcidev);
1552
1553 if (priv->adapter->hs_state != HS_ACTIVATED) {
1554 if (btmrvl_enable_hs(priv)) {
1555 BT_ERR("HS not actived, suspend failed!");
1556 return -EBUSY;
1557 }
1558 }
1559
1560 priv->adapter->is_suspending = false;
1561 priv->adapter->is_suspended = true;
1562
1563 /* We will keep the power when hs enabled successfully */
1564 if (priv->adapter->hs_state == HS_ACTIVATED) {
1565 BT_DBG("suspend with MMC_PM_KEEP_POWER");
1566 return sdio_set_host_pm_flags(func, MMC_PM_KEEP_POWER);
1567 } else {
1568 BT_DBG("suspend without MMC_PM_KEEP_POWER");
1569 return 0;
1570 }
1571}
1572
1573static int btmrvl_sdio_resume(struct device *dev)
1574{
1575 struct sdio_func *func = dev_to_sdio_func(dev);
1576 struct btmrvl_sdio_card *card;
1577 struct btmrvl_private *priv;
1578 mmc_pm_flag_t pm_flags;
1579 struct hci_dev *hcidev;
1580
1581 if (func) {
1582 pm_flags = sdio_get_host_pm_caps(func);
1583 BT_DBG("%s: resume: PM flags = 0x%x", sdio_func_id(func),
1584 pm_flags);
1585 card = sdio_get_drvdata(func);
1586 if (!card || !card->priv) {
1587 BT_ERR("card or priv structure is not valid");
1588 return 0;
1589 }
1590 } else {
1591 BT_ERR("sdio_func is not specified");
1592 return 0;
1593 }
1594 priv = card->priv;
1595
1596 if (!priv->adapter->is_suspended) {
1597 BT_DBG("device already resumed");
1598 return 0;
1599 }
1600
1601 priv->hw_wakeup_firmware(priv);
1602 priv->adapter->hs_state = HS_DEACTIVATED;
1603 hcidev = priv->btmrvl_dev.hcidev;
1604 BT_DBG("%s: HS DEACTIVATED in resume!", hcidev->name);
1605 priv->adapter->is_suspended = false;
1606 BT_DBG("%s: SDIO resume", hcidev->name);
1607 hci_resume_dev(hcidev);
1608
1609 return 0;
1610}
1611
1612static const struct dev_pm_ops btmrvl_sdio_pm_ops = {
1613 .suspend = btmrvl_sdio_suspend,
1614 .resume = btmrvl_sdio_resume,
1615};
1616
1617static struct sdio_driver bt_mrvl_sdio = {
1618 .name = "btmrvl_sdio",
1619 .id_table = btmrvl_sdio_ids,
1620 .probe = btmrvl_sdio_probe,
1621 .remove = btmrvl_sdio_remove,
1622 .drv = {
1623 .owner = THIS_MODULE,
1624 .pm = &btmrvl_sdio_pm_ops,
1625 }
1626};
1627
1628static int __init btmrvl_sdio_init_module(void)
1629{
1630 if (sdio_register_driver(&bt_mrvl_sdio) != 0) {
1631 BT_ERR("SDIO Driver Registration Failed");
1632 return -ENODEV;
1633 }
1634
1635 /* Clear the flag in case user removes the card. */
1636 user_rmmod = 0;
1637
1638 return 0;
1639}
1640
1641static void __exit btmrvl_sdio_exit_module(void)
1642{
1643 /* Set the flag as user is removing this module. */
1644 user_rmmod = 1;
1645
1646 sdio_unregister_driver(&bt_mrvl_sdio);
1647}
1648
1649module_init(btmrvl_sdio_init_module);
1650module_exit(btmrvl_sdio_exit_module);
1651
1652MODULE_AUTHOR("Marvell International Ltd.");
1653MODULE_DESCRIPTION("Marvell BT-over-SDIO driver ver " VERSION);
1654MODULE_VERSION(VERSION);
1655MODULE_LICENSE("GPL v2");
1656MODULE_FIRMWARE("mrvl/sd8688_helper.bin");
1657MODULE_FIRMWARE("mrvl/sd8688.bin");
1658MODULE_FIRMWARE("mrvl/sd8787_uapsta.bin");
1659MODULE_FIRMWARE("mrvl/sd8797_uapsta.bin");
1660MODULE_FIRMWARE("mrvl/sd8887_uapsta.bin");
1661MODULE_FIRMWARE("mrvl/sd8897_uapsta.bin");
1662MODULE_FIRMWARE("mrvl/sd8997_uapsta.bin");