2 * Marvell BT-over-SDIO driver: SDIO interface related functions.
4 * Copyright (C) 2009, 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 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.
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.
21 #include <linux/firmware.h>
22 #include <linux/slab.h>
24 #include <linux/mmc/sdio_ids.h>
25 #include <linux/mmc/sdio_func.h>
27 #include <net/bluetooth/bluetooth.h>
28 #include <net/bluetooth/hci_core.h>
30 #include "btmrvl_drv.h"
31 #include "btmrvl_sdio.h"
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
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.
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.
52 static const struct btmrvl_sdio_device btmrvl_sdio_sd6888 = {
53 .helper = "sd8688_helper.bin",
54 .firmware = "sd8688.bin",
57 static const struct sdio_device_id btmrvl_sdio_ids[] = {
58 /* Marvell SD8688 Bluetooth device */
59 { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL, 0x9105),
60 .driver_data = (unsigned long) &btmrvl_sdio_sd6888 },
62 { } /* Terminating entry */
65 MODULE_DEVICE_TABLE(sdio, btmrvl_sdio_ids);
67 static int btmrvl_sdio_get_rx_unit(struct btmrvl_sdio_card *card)
72 reg = sdio_readb(card->func, CARD_RX_UNIT_REG, &ret);
79 static int btmrvl_sdio_read_fw_status(struct btmrvl_sdio_card *card, u16 *dat)
86 fws0 = sdio_readb(card->func, CARD_FW_STATUS0_REG, &ret);
90 fws1 = sdio_readb(card->func, CARD_FW_STATUS1_REG, &ret);
94 *dat = (((u16) fws1) << 8) | fws0;
99 static int btmrvl_sdio_read_rx_len(struct btmrvl_sdio_card *card, u16 *dat)
104 reg = sdio_readb(card->func, CARD_RX_LEN_REG, &ret);
106 *dat = (u16) reg << card->rx_unit;
111 static int btmrvl_sdio_enable_host_int_mask(struct btmrvl_sdio_card *card,
116 sdio_writeb(card->func, mask, HOST_INT_MASK_REG, &ret);
118 BT_ERR("Unable to enable the host interrupt!");
125 static int btmrvl_sdio_disable_host_int_mask(struct btmrvl_sdio_card *card,
131 host_int_mask = sdio_readb(card->func, HOST_INT_MASK_REG, &ret);
135 host_int_mask &= ~mask;
137 sdio_writeb(card->func, host_int_mask, HOST_INT_MASK_REG, &ret);
139 BT_ERR("Unable to disable the host interrupt!");
146 static int btmrvl_sdio_poll_card_status(struct btmrvl_sdio_card *card, u8 bits)
152 for (tries = 0; tries < MAX_POLL_TRIES * 1000; tries++) {
153 status = sdio_readb(card->func, CARD_STATUS_REG, &ret);
156 if ((status & bits) == bits)
165 BT_ERR("FAILED! ret=%d", ret);
170 static int btmrvl_sdio_verify_fw_download(struct btmrvl_sdio_card *card,
173 int ret = -ETIMEDOUT;
177 /* Wait for firmware to become ready */
178 for (tries = 0; tries < pollnum; tries++) {
179 if (btmrvl_sdio_read_fw_status(card, &firmwarestat) < 0)
182 if (firmwarestat == FIRMWARE_READY) {
193 static int btmrvl_sdio_download_helper(struct btmrvl_sdio_card *card)
195 const struct firmware *fw_helper = NULL;
196 const u8 *helper = NULL;
198 void *tmphlprbuf = NULL;
199 int tmphlprbufsz, hlprblknow, helperlen;
203 ret = request_firmware(&fw_helper, card->helper,
205 if ((ret < 0) || !fw_helper) {
206 BT_ERR("request_firmware(helper) failed, error code = %d",
212 helper = fw_helper->data;
213 helperlen = fw_helper->size;
215 BT_DBG("Downloading helper image (%d bytes), block size %d bytes",
216 helperlen, SDIO_BLOCK_SIZE);
218 tmphlprbufsz = ALIGN_SZ(BTM_UPLD_SIZE, BTSDIO_DMA_ALIGN);
220 tmphlprbuf = kmalloc(tmphlprbufsz, GFP_KERNEL);
222 BT_ERR("Unable to allocate buffer for helper."
223 " Terminating download");
228 memset(tmphlprbuf, 0, tmphlprbufsz);
230 helperbuf = (u8 *) ALIGN_ADDR(tmphlprbuf, BTSDIO_DMA_ALIGN);
232 /* Perform helper data transfer */
233 tx_len = (FIRMWARE_TRANSFER_NBLOCK * SDIO_BLOCK_SIZE)
238 ret = btmrvl_sdio_poll_card_status(card,
239 CARD_IO_READY | DN_LD_CARD_RDY);
241 BT_ERR("Helper download poll status timeout @ %d",
246 /* Check if there is more data? */
247 if (hlprblknow >= helperlen)
250 if (helperlen - hlprblknow < tx_len)
251 tx_len = helperlen - hlprblknow;
254 helperbuf[0] = ((tx_len & 0x000000ff) >> 0);
255 helperbuf[1] = ((tx_len & 0x0000ff00) >> 8);
256 helperbuf[2] = ((tx_len & 0x00ff0000) >> 16);
257 helperbuf[3] = ((tx_len & 0xff000000) >> 24);
259 memcpy(&helperbuf[SDIO_HEADER_LEN], &helper[hlprblknow],
262 /* Now send the data */
263 ret = sdio_writesb(card->func, card->ioport, helperbuf,
264 FIRMWARE_TRANSFER_NBLOCK * SDIO_BLOCK_SIZE);
266 BT_ERR("IO error during helper download @ %d",
271 hlprblknow += tx_len;
274 BT_DBG("Transferring helper image EOF block");
276 memset(helperbuf, 0x0, SDIO_BLOCK_SIZE);
278 ret = sdio_writesb(card->func, card->ioport, helperbuf,
281 BT_ERR("IO error in writing helper image EOF block");
290 release_firmware(fw_helper);
295 static int btmrvl_sdio_download_fw_w_helper(struct btmrvl_sdio_card *card)
297 const struct firmware *fw_firmware = NULL;
298 const u8 *firmware = NULL;
299 int firmwarelen, tmpfwbufsz, ret;
300 unsigned int tries, offset;
302 void *tmpfwbuf = NULL;
305 int txlen = 0, tx_blocks = 0, count = 0;
307 ret = request_firmware(&fw_firmware, card->firmware,
309 if ((ret < 0) || !fw_firmware) {
310 BT_ERR("request_firmware(firmware) failed, error code = %d",
316 firmware = fw_firmware->data;
317 firmwarelen = fw_firmware->size;
319 BT_DBG("Downloading FW image (%d bytes)", firmwarelen);
321 tmpfwbufsz = ALIGN_SZ(BTM_UPLD_SIZE, BTSDIO_DMA_ALIGN);
322 tmpfwbuf = kmalloc(tmpfwbufsz, GFP_KERNEL);
324 BT_ERR("Unable to allocate buffer for firmware."
325 " Terminating download");
330 memset(tmpfwbuf, 0, tmpfwbufsz);
332 /* Ensure aligned firmware buffer */
333 fwbuf = (u8 *) ALIGN_ADDR(tmpfwbuf, BTSDIO_DMA_ALIGN);
335 /* Perform firmware data transfer */
338 ret = btmrvl_sdio_poll_card_status(card,
339 CARD_IO_READY | DN_LD_CARD_RDY);
341 BT_ERR("FW download with helper poll status"
342 " timeout @ %d", offset);
346 /* Check if there is more data ? */
347 if (offset >= firmwarelen)
350 for (tries = 0; tries < MAX_POLL_TRIES; tries++) {
351 base0 = sdio_readb(card->func,
352 SQ_READ_BASE_ADDRESS_A0_REG, &ret);
354 BT_ERR("BASE0 register read failed:"
355 " base0 = 0x%04X(%d)."
356 " Terminating download",
361 base1 = sdio_readb(card->func,
362 SQ_READ_BASE_ADDRESS_A1_REG, &ret);
364 BT_ERR("BASE1 register read failed:"
365 " base1 = 0x%04X(%d)."
366 " Terminating download",
372 len = (((u16) base1) << 8) | base0;
381 else if (len > BTM_UPLD_SIZE) {
382 BT_ERR("FW download failure @%d, invalid length %d",
392 if (count > MAX_WRITE_IOMEM_RETRY) {
393 BT_ERR("FW download failure @%d, "
394 "over max retry count", offset);
398 BT_ERR("FW CRC error indicated by the helper: "
399 "len = 0x%04X, txlen = %d", len, txlen);
401 /* Set txlen to 0 so as to resend from same offset */
407 if (firmwarelen - offset < txlen)
408 txlen = firmwarelen - offset;
411 (txlen + SDIO_BLOCK_SIZE - 1) / SDIO_BLOCK_SIZE;
413 memcpy(fwbuf, &firmware[offset], txlen);
416 ret = sdio_writesb(card->func, card->ioport, fwbuf,
417 tx_blocks * SDIO_BLOCK_SIZE);
420 BT_ERR("FW download, writesb(%d) failed @%d",
422 sdio_writeb(card->func, HOST_CMD53_FIN, CONFIG_REG,
425 BT_ERR("writeb failed (CFG)");
431 BT_DBG("FW download over, size %d bytes", offset);
439 release_firmware(fw_firmware);
444 static int btmrvl_sdio_card_to_host(struct btmrvl_private *priv)
447 int ret, buf_block_len, blksz;
448 struct sk_buff *skb = NULL;
451 struct hci_dev *hdev = priv->btmrvl_dev.hcidev;
452 struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
454 if (!card || !card->func) {
455 BT_ERR("card or function is NULL!");
460 /* Read the length of data to be transferred */
461 ret = btmrvl_sdio_read_rx_len(card, &buf_len);
463 BT_ERR("read rx_len failed");
468 blksz = SDIO_BLOCK_SIZE;
469 buf_block_len = (buf_len + blksz - 1) / blksz;
471 if (buf_len <= SDIO_HEADER_LEN
472 || (buf_block_len * blksz) > ALLOC_BUF_SIZE) {
473 BT_ERR("invalid packet length: %d", buf_len);
478 /* Allocate buffer */
479 skb = bt_skb_alloc(buf_block_len * blksz + BTSDIO_DMA_ALIGN,
482 BT_ERR("No free skb");
486 if ((unsigned long) skb->data & (BTSDIO_DMA_ALIGN - 1)) {
487 skb_put(skb, (unsigned long) skb->data &
488 (BTSDIO_DMA_ALIGN - 1));
489 skb_pull(skb, (unsigned long) skb->data &
490 (BTSDIO_DMA_ALIGN - 1));
495 ret = sdio_readsb(card->func, payload, card->ioport,
496 buf_block_len * blksz);
498 BT_ERR("readsb failed: %d", ret);
503 /* This is SDIO specific header length: byte[2][1][0], type: byte[3]
504 * (HCI_COMMAND = 1, ACL_DATA = 2, SCO_DATA = 3, 0xFE = Vendor)
507 buf_len = payload[0];
508 buf_len |= (u16) payload[1] << 8;
512 case HCI_ACLDATA_PKT:
513 case HCI_SCODATA_PKT:
515 bt_cb(skb)->pkt_type = type;
516 skb->dev = (void *)hdev;
517 skb_put(skb, buf_len);
518 skb_pull(skb, SDIO_HEADER_LEN);
520 if (type == HCI_EVENT_PKT)
521 btmrvl_check_evtpkt(priv, skb);
524 hdev->stat.byte_rx += buf_len;
527 case MRVL_VENDOR_PKT:
528 bt_cb(skb)->pkt_type = HCI_VENDOR_PKT;
529 skb->dev = (void *)hdev;
530 skb_put(skb, buf_len);
531 skb_pull(skb, SDIO_HEADER_LEN);
533 if (btmrvl_process_event(priv, skb))
536 hdev->stat.byte_rx += buf_len;
540 BT_ERR("Unknown packet type:%d", type);
541 print_hex_dump_bytes("", DUMP_PREFIX_OFFSET, payload,
542 blksz * buf_block_len);
559 static int btmrvl_sdio_process_int_status(struct btmrvl_private *priv)
563 struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
565 spin_lock_irqsave(&priv->driver_lock, flags);
568 spin_unlock_irqrestore(&priv->driver_lock, flags);
570 sdio_claim_host(card->func);
571 if (ireg & DN_LD_HOST_INT_STATUS) {
572 if (priv->btmrvl_dev.tx_dnld_rdy)
573 BT_DBG("tx_done already received: "
574 " int_status=0x%x", ireg);
576 priv->btmrvl_dev.tx_dnld_rdy = true;
579 if (ireg & UP_LD_HOST_INT_STATUS)
580 btmrvl_sdio_card_to_host(priv);
582 sdio_release_host(card->func);
587 static void btmrvl_sdio_interrupt(struct sdio_func *func)
589 struct btmrvl_private *priv;
590 struct btmrvl_sdio_card *card;
595 card = sdio_get_drvdata(func);
596 if (!card || !card->priv) {
597 BT_ERR("sbi_interrupt(%p) card or priv is "
598 "NULL, card=%p\n", func, card);
604 ireg = sdio_readb(card->func, HOST_INTSTATUS_REG, &ret);
606 BT_ERR("sdio_readb: read int status register failed");
612 * DN_LD_HOST_INT_STATUS and/or UP_LD_HOST_INT_STATUS
613 * Clear the interrupt status register and re-enable the
616 BT_DBG("ireg = 0x%x", ireg);
618 sdio_writeb(card->func, ~(ireg) & (DN_LD_HOST_INT_STATUS |
619 UP_LD_HOST_INT_STATUS),
620 HOST_INTSTATUS_REG, &ret);
622 BT_ERR("sdio_writeb: clear int status register failed");
627 spin_lock_irqsave(&priv->driver_lock, flags);
629 spin_unlock_irqrestore(&priv->driver_lock, flags);
631 btmrvl_interrupt(priv);
634 static int btmrvl_sdio_register_dev(struct btmrvl_sdio_card *card)
636 struct sdio_func *func;
640 if (!card || !card->func) {
641 BT_ERR("Error: card or function is NULL!");
648 sdio_claim_host(func);
650 ret = sdio_enable_func(func);
652 BT_ERR("sdio_enable_func() failed: ret=%d", ret);
657 ret = sdio_claim_irq(func, btmrvl_sdio_interrupt);
659 BT_ERR("sdio_claim_irq failed: ret=%d", ret);
664 ret = sdio_set_block_size(card->func, SDIO_BLOCK_SIZE);
666 BT_ERR("cannot set SDIO block size");
671 reg = sdio_readb(func, IO_PORT_0_REG, &ret);
679 reg = sdio_readb(func, IO_PORT_1_REG, &ret);
685 card->ioport |= (reg << 8);
687 reg = sdio_readb(func, IO_PORT_2_REG, &ret);
693 card->ioport |= (reg << 16);
695 BT_DBG("SDIO FUNC%d IO port: 0x%x", func->num, card->ioport);
697 sdio_set_drvdata(func, card);
699 sdio_release_host(func);
704 sdio_release_irq(func);
707 sdio_disable_func(func);
710 sdio_release_host(func);
716 static int btmrvl_sdio_unregister_dev(struct btmrvl_sdio_card *card)
718 if (card && card->func) {
719 sdio_claim_host(card->func);
720 sdio_release_irq(card->func);
721 sdio_disable_func(card->func);
722 sdio_release_host(card->func);
723 sdio_set_drvdata(card->func, NULL);
729 static int btmrvl_sdio_enable_host_int(struct btmrvl_sdio_card *card)
733 if (!card || !card->func)
736 sdio_claim_host(card->func);
738 ret = btmrvl_sdio_enable_host_int_mask(card, HIM_ENABLE);
740 btmrvl_sdio_get_rx_unit(card);
742 sdio_release_host(card->func);
747 static int btmrvl_sdio_disable_host_int(struct btmrvl_sdio_card *card)
751 if (!card || !card->func)
754 sdio_claim_host(card->func);
756 ret = btmrvl_sdio_disable_host_int_mask(card, HIM_DISABLE);
758 sdio_release_host(card->func);
763 static int btmrvl_sdio_host_to_card(struct btmrvl_private *priv,
766 struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
775 if (!card || !card->func) {
776 BT_ERR("card or function is NULL!");
781 if ((unsigned long) payload & (BTSDIO_DMA_ALIGN - 1)) {
782 tmpbufsz = ALIGN_SZ(nb, BTSDIO_DMA_ALIGN);
783 tmpbuf = kzalloc(tmpbufsz, GFP_KERNEL);
786 buf = (u8 *) ALIGN_ADDR(tmpbuf, BTSDIO_DMA_ALIGN);
787 memcpy(buf, payload, nb);
790 blksz = SDIO_BLOCK_SIZE;
791 buf_block_len = (nb + blksz - 1) / blksz;
793 sdio_claim_host(card->func);
796 /* Transfer data to card */
797 ret = sdio_writesb(card->func, card->ioport, buf,
798 buf_block_len * blksz);
801 BT_ERR("i=%d writesb failed: %d", i, ret);
802 print_hex_dump_bytes("", DUMP_PREFIX_OFFSET,
805 if (i > MAX_WRITE_IOMEM_RETRY)
810 priv->btmrvl_dev.tx_dnld_rdy = false;
813 sdio_release_host(card->func);
819 static int btmrvl_sdio_download_fw(struct btmrvl_sdio_card *card)
823 if (!card || !card->func) {
824 BT_ERR("card or function is NULL!");
827 sdio_claim_host(card->func);
829 if (!btmrvl_sdio_verify_fw_download(card, 1)) {
830 BT_DBG("Firmware already downloaded!");
834 ret = btmrvl_sdio_download_helper(card);
836 BT_ERR("Failed to download helper!");
841 if (btmrvl_sdio_download_fw_w_helper(card)) {
842 BT_ERR("Failed to download firmware!");
847 if (btmrvl_sdio_verify_fw_download(card, MAX_POLL_TRIES)) {
848 BT_ERR("FW failed to be active in time!");
854 sdio_release_host(card->func);
859 static int btmrvl_sdio_wakeup_fw(struct btmrvl_private *priv)
861 struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
864 if (!card || !card->func) {
865 BT_ERR("card or function is NULL!");
869 sdio_claim_host(card->func);
871 sdio_writeb(card->func, HOST_POWER_UP, CONFIG_REG, &ret);
873 sdio_release_host(card->func);
875 BT_DBG("wake up firmware");
880 static int btmrvl_sdio_probe(struct sdio_func *func,
881 const struct sdio_device_id *id)
884 struct btmrvl_private *priv = NULL;
885 struct btmrvl_sdio_card *card = NULL;
887 BT_INFO("vendor=0x%x, device=0x%x, class=%d, fn=%d",
888 id->vendor, id->device, id->class, func->num);
890 card = kzalloc(sizeof(*card), GFP_KERNEL);
898 if (id->driver_data) {
899 struct btmrvl_sdio_device *data = (void *) id->driver_data;
900 card->helper = data->helper;
901 card->firmware = data->firmware;
904 if (btmrvl_sdio_register_dev(card) < 0) {
905 BT_ERR("Failed to register BT device!");
910 /* Disable the interrupts on the card */
911 btmrvl_sdio_disable_host_int(card);
913 if (btmrvl_sdio_download_fw(card)) {
914 BT_ERR("Downloading firmware failed!");
921 btmrvl_sdio_enable_host_int(card);
923 priv = btmrvl_add_card(card);
925 BT_ERR("Initializing card failed!");
927 goto disable_host_int;
932 /* Initialize the interface specific function pointers */
933 priv->hw_host_to_card = btmrvl_sdio_host_to_card;
934 priv->hw_wakeup_firmware = btmrvl_sdio_wakeup_fw;
935 priv->hw_process_int_status = btmrvl_sdio_process_int_status;
937 if (btmrvl_register_hdev(priv)) {
938 BT_ERR("Register hdev failed!");
940 goto disable_host_int;
943 priv->btmrvl_dev.psmode = 1;
944 btmrvl_enable_ps(priv);
949 btmrvl_sdio_disable_host_int(card);
951 btmrvl_sdio_unregister_dev(card);
958 static void btmrvl_sdio_remove(struct sdio_func *func)
960 struct btmrvl_sdio_card *card;
963 card = sdio_get_drvdata(func);
965 /* Send SHUTDOWN command & disable interrupt
966 * if user removes the module.
969 btmrvl_send_module_cfg_cmd(card->priv,
970 MODULE_SHUTDOWN_REQ);
971 btmrvl_sdio_disable_host_int(card);
973 BT_DBG("unregester dev");
974 btmrvl_sdio_unregister_dev(card);
975 btmrvl_remove_card(card->priv);
981 static struct sdio_driver bt_mrvl_sdio = {
982 .name = "btmrvl_sdio",
983 .id_table = btmrvl_sdio_ids,
984 .probe = btmrvl_sdio_probe,
985 .remove = btmrvl_sdio_remove,
988 static int __init btmrvl_sdio_init_module(void)
990 if (sdio_register_driver(&bt_mrvl_sdio) != 0) {
991 BT_ERR("SDIO Driver Registration Failed");
995 /* Clear the flag in case user removes the card. */
1001 static void __exit btmrvl_sdio_exit_module(void)
1003 /* Set the flag as user is removing this module. */
1006 sdio_unregister_driver(&bt_mrvl_sdio);
1009 module_init(btmrvl_sdio_init_module);
1010 module_exit(btmrvl_sdio_exit_module);
1012 MODULE_AUTHOR("Marvell International Ltd.");
1013 MODULE_DESCRIPTION("Marvell BT-over-SDIO driver ver " VERSION);
1014 MODULE_VERSION(VERSION);
1015 MODULE_LICENSE("GPL v2");
1016 MODULE_FIRMWARE("sd8688_helper.bin");
1017 MODULE_FIRMWARE("sd8688.bin");