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>
23 #include <linux/mmc/sdio_ids.h>
24 #include <linux/mmc/sdio_func.h>
26 #include <net/bluetooth/bluetooth.h>
27 #include <net/bluetooth/hci_core.h>
29 #include "btmrvl_drv.h"
30 #include "btmrvl_sdio.h"
34 /* The btmrvl_sdio_remove() callback function is called
35 * when user removes this module from kernel space or ejects
36 * the card from the slot. The driver handles these 2 cases
38 * If the user is removing the module, a MODULE_SHUTDOWN_REQ
39 * command is sent to firmware and interrupt will be disabled.
40 * If the card is removed, there is no need to send command
41 * or disable interrupt.
43 * The variable 'user_rmmod' is used to distinguish these two
44 * scenarios. This flag is initialized as FALSE in case the card
45 * is removed, and will be set to TRUE for module removal when
46 * module_exit function is called.
50 static const struct btmrvl_sdio_device btmrvl_sdio_sd6888 = {
51 .helper = "sd8688_helper.bin",
52 .firmware = "sd8688.bin",
55 static const struct sdio_device_id btmrvl_sdio_ids[] = {
56 /* Marvell SD8688 Bluetooth device */
57 { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL, 0x9105),
58 .driver_data = (unsigned long) &btmrvl_sdio_sd6888 },
60 { } /* Terminating entry */
63 MODULE_DEVICE_TABLE(sdio, btmrvl_sdio_ids);
65 static int btmrvl_sdio_get_rx_unit(struct btmrvl_sdio_card *card)
72 reg = sdio_readb(card->func, CARD_RX_UNIT_REG, &ret);
81 static int btmrvl_sdio_read_fw_status(struct btmrvl_sdio_card *card, u16 *dat)
90 fws0 = sdio_readb(card->func, CARD_FW_STATUS0_REG, &ret);
93 fws1 = sdio_readb(card->func, CARD_FW_STATUS1_REG, &ret);
100 *dat = (((u16) fws1) << 8) | fws0;
107 static int btmrvl_sdio_read_rx_len(struct btmrvl_sdio_card *card, u16 *dat)
114 reg = sdio_readb(card->func, CARD_RX_LEN_REG, &ret);
116 *dat = (u16) reg << card->rx_unit;
123 static int btmrvl_sdio_enable_host_int_mask(struct btmrvl_sdio_card *card,
130 sdio_writeb(card->func, mask, HOST_INT_MASK_REG, &ret);
132 BT_ERR("Unable to enable the host interrupt!");
141 static int btmrvl_sdio_disable_host_int_mask(struct btmrvl_sdio_card *card,
149 host_int_mask = sdio_readb(card->func, HOST_INT_MASK_REG, &ret);
155 host_int_mask &= ~mask;
157 sdio_writeb(card->func, host_int_mask, HOST_INT_MASK_REG, &ret);
159 BT_ERR("Unable to disable the host interrupt!");
172 static int btmrvl_sdio_poll_card_status(struct btmrvl_sdio_card *card, u8 bits)
180 for (tries = 0; tries < MAX_POLL_TRIES * 1000; tries++) {
181 status = sdio_readb(card->func, CARD_STATUS_REG, &ret);
184 if ((status & bits) == bits)
193 BT_ERR("FAILED! ret=%d", ret);
201 static int btmrvl_sdio_verify_fw_download(struct btmrvl_sdio_card *card,
204 int ret = -ETIMEDOUT;
210 /* Wait for firmware to become ready */
211 for (tries = 0; tries < pollnum; tries++) {
212 if (btmrvl_sdio_read_fw_status(card, &firmwarestat) < 0)
215 if (firmwarestat == FIRMWARE_READY) {
228 static int btmrvl_sdio_download_helper(struct btmrvl_sdio_card *card)
230 const struct firmware *fw_helper = NULL;
231 const u8 *helper = NULL;
233 void *tmphlprbuf = NULL;
234 int tmphlprbufsz, hlprblknow, helperlen;
240 ret = request_firmware(&fw_helper, card->helper,
242 if ((ret < 0) || !fw_helper) {
243 BT_ERR("request_firmware(helper) failed, error code = %d",
249 helper = fw_helper->data;
250 helperlen = fw_helper->size;
252 BT_DBG("Downloading helper image (%d bytes), block size %d bytes",
253 helperlen, SDIO_BLOCK_SIZE);
255 tmphlprbufsz = ALIGN_SZ(BTM_UPLD_SIZE, BTSDIO_DMA_ALIGN);
257 tmphlprbuf = kmalloc(tmphlprbufsz, GFP_KERNEL);
259 BT_ERR("Unable to allocate buffer for helper."
260 " Terminating download");
265 memset(tmphlprbuf, 0, tmphlprbufsz);
267 helperbuf = (u8 *) ALIGN_ADDR(tmphlprbuf, BTSDIO_DMA_ALIGN);
269 /* Perform helper data transfer */
270 tx_len = (FIRMWARE_TRANSFER_NBLOCK * SDIO_BLOCK_SIZE)
275 ret = btmrvl_sdio_poll_card_status(card,
276 CARD_IO_READY | DN_LD_CARD_RDY);
278 BT_ERR("Helper download poll status timeout @ %d",
283 /* Check if there is more data? */
284 if (hlprblknow >= helperlen)
287 if (helperlen - hlprblknow < tx_len)
288 tx_len = helperlen - hlprblknow;
291 helperbuf[0] = ((tx_len & 0x000000ff) >> 0);
292 helperbuf[1] = ((tx_len & 0x0000ff00) >> 8);
293 helperbuf[2] = ((tx_len & 0x00ff0000) >> 16);
294 helperbuf[3] = ((tx_len & 0xff000000) >> 24);
296 memcpy(&helperbuf[SDIO_HEADER_LEN], &helper[hlprblknow],
299 /* Now send the data */
300 ret = sdio_writesb(card->func, card->ioport, helperbuf,
301 FIRMWARE_TRANSFER_NBLOCK * SDIO_BLOCK_SIZE);
303 BT_ERR("IO error during helper download @ %d",
308 hlprblknow += tx_len;
311 BT_DBG("Transferring helper image EOF block");
313 memset(helperbuf, 0x0, SDIO_BLOCK_SIZE);
315 ret = sdio_writesb(card->func, card->ioport, helperbuf,
318 BT_ERR("IO error in writing helper image EOF block");
327 release_firmware(fw_helper);
334 static int btmrvl_sdio_download_fw_w_helper(struct btmrvl_sdio_card *card)
336 const struct firmware *fw_firmware = NULL;
337 const u8 *firmware = NULL;
338 int firmwarelen, tmpfwbufsz, ret;
339 unsigned int tries, offset;
341 void *tmpfwbuf = NULL;
344 int txlen = 0, tx_blocks = 0, count = 0;
348 ret = request_firmware(&fw_firmware, card->firmware,
350 if ((ret < 0) || !fw_firmware) {
351 BT_ERR("request_firmware(firmware) failed, error code = %d",
357 firmware = fw_firmware->data;
358 firmwarelen = fw_firmware->size;
360 BT_DBG("Downloading FW image (%d bytes)", firmwarelen);
362 tmpfwbufsz = ALIGN_SZ(BTM_UPLD_SIZE, BTSDIO_DMA_ALIGN);
363 tmpfwbuf = kmalloc(tmpfwbufsz, GFP_KERNEL);
365 BT_ERR("Unable to allocate buffer for firmware."
366 " Terminating download");
371 memset(tmpfwbuf, 0, tmpfwbufsz);
373 /* Ensure aligned firmware buffer */
374 fwbuf = (u8 *) ALIGN_ADDR(tmpfwbuf, BTSDIO_DMA_ALIGN);
376 /* Perform firmware data transfer */
379 ret = btmrvl_sdio_poll_card_status(card,
380 CARD_IO_READY | DN_LD_CARD_RDY);
382 BT_ERR("FW download with helper poll status"
383 " timeout @ %d", offset);
387 /* Check if there is more data ? */
388 if (offset >= firmwarelen)
391 for (tries = 0; tries < MAX_POLL_TRIES; tries++) {
392 base0 = sdio_readb(card->func,
393 SQ_READ_BASE_ADDRESS_A0_REG, &ret);
395 BT_ERR("BASE0 register read failed:"
396 " base0 = 0x%04X(%d)."
397 " Terminating download",
402 base1 = sdio_readb(card->func,
403 SQ_READ_BASE_ADDRESS_A1_REG, &ret);
405 BT_ERR("BASE1 register read failed:"
406 " base1 = 0x%04X(%d)."
407 " Terminating download",
413 len = (((u16) base1) << 8) | base0;
422 else if (len > BTM_UPLD_SIZE) {
423 BT_ERR("FW download failure @%d, invalid length %d",
433 if (count > MAX_WRITE_IOMEM_RETRY) {
434 BT_ERR("FW download failure @%d, "
435 "over max retry count", offset);
439 BT_ERR("FW CRC error indicated by the helper: "
440 "len = 0x%04X, txlen = %d", len, txlen);
442 /* Set txlen to 0 so as to resend from same offset */
448 if (firmwarelen - offset < txlen)
449 txlen = firmwarelen - offset;
452 (txlen + SDIO_BLOCK_SIZE - 1) / SDIO_BLOCK_SIZE;
454 memcpy(fwbuf, &firmware[offset], txlen);
457 ret = sdio_writesb(card->func, card->ioport, fwbuf,
458 tx_blocks * SDIO_BLOCK_SIZE);
461 BT_ERR("FW download, writesb(%d) failed @%d",
463 sdio_writeb(card->func, HOST_CMD53_FIN, CONFIG_REG,
466 BT_ERR("writeb failed (CFG)");
472 BT_DBG("FW download over, size %d bytes", offset);
480 release_firmware(fw_firmware);
487 static int btmrvl_sdio_card_to_host(struct btmrvl_private *priv)
490 int ret, buf_block_len, blksz;
491 struct sk_buff *skb = NULL;
494 struct hci_dev *hdev = priv->btmrvl_dev.hcidev;
495 struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
499 if (!card || !card->func) {
500 BT_ERR("card or function is NULL!");
505 /* Read the length of data to be transferred */
506 ret = btmrvl_sdio_read_rx_len(card, &buf_len);
508 BT_ERR("read rx_len failed");
513 blksz = SDIO_BLOCK_SIZE;
514 buf_block_len = (buf_len + blksz - 1) / blksz;
516 if (buf_len <= SDIO_HEADER_LEN
517 || (buf_block_len * blksz) > ALLOC_BUF_SIZE) {
518 BT_ERR("invalid packet length: %d", buf_len);
523 /* Allocate buffer */
524 skb = bt_skb_alloc(buf_block_len * blksz + BTSDIO_DMA_ALIGN,
527 BT_ERR("No free skb");
531 if ((u32) skb->data & (BTSDIO_DMA_ALIGN - 1)) {
532 skb_put(skb, (u32) skb->data & (BTSDIO_DMA_ALIGN - 1));
533 skb_pull(skb, (u32) skb->data & (BTSDIO_DMA_ALIGN - 1));
538 ret = sdio_readsb(card->func, payload, card->ioport,
539 buf_block_len * blksz);
541 BT_ERR("readsb failed: %d", ret);
546 /* This is SDIO specific header length: byte[2][1][0], type: byte[3]
547 * (HCI_COMMAND = 1, ACL_DATA = 2, SCO_DATA = 3, 0xFE = Vendor)
550 buf_len = payload[0];
551 buf_len |= (u16) payload[1] << 8;
555 case HCI_ACLDATA_PKT:
556 case HCI_SCODATA_PKT:
558 bt_cb(skb)->pkt_type = type;
559 skb->dev = (void *)hdev;
560 skb_put(skb, buf_len);
561 skb_pull(skb, SDIO_HEADER_LEN);
563 if (type == HCI_EVENT_PKT)
564 btmrvl_check_evtpkt(priv, skb);
567 hdev->stat.byte_rx += buf_len;
570 case MRVL_VENDOR_PKT:
571 bt_cb(skb)->pkt_type = HCI_VENDOR_PKT;
572 skb->dev = (void *)hdev;
573 skb_put(skb, buf_len);
574 skb_pull(skb, SDIO_HEADER_LEN);
576 if (btmrvl_process_event(priv, skb))
579 hdev->stat.byte_rx += buf_len;
583 BT_ERR("Unknow packet type:%d", type);
584 print_hex_dump_bytes("", DUMP_PREFIX_OFFSET, payload,
585 blksz * buf_block_len);
604 static int btmrvl_sdio_get_int_status(struct btmrvl_private *priv, u8 * ireg)
608 struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
614 sdio_ireg = sdio_readb(card->func, HOST_INTSTATUS_REG, &ret);
616 BT_ERR("sdio_readb: read int status register failed");
621 if (sdio_ireg != 0) {
623 * DN_LD_HOST_INT_STATUS and/or UP_LD_HOST_INT_STATUS
624 * Clear the interrupt status register and re-enable the
627 BT_DBG("sdio_ireg = 0x%x", sdio_ireg);
629 sdio_writeb(card->func, ~(sdio_ireg) & (DN_LD_HOST_INT_STATUS |
630 UP_LD_HOST_INT_STATUS),
631 HOST_INTSTATUS_REG, &ret);
633 BT_ERR("sdio_writeb: clear int status register "
640 if (sdio_ireg & DN_LD_HOST_INT_STATUS) {
641 if (priv->btmrvl_dev.tx_dnld_rdy)
642 BT_DBG("tx_done already received: "
643 " int_status=0x%x", sdio_ireg);
645 priv->btmrvl_dev.tx_dnld_rdy = true;
648 if (sdio_ireg & UP_LD_HOST_INT_STATUS)
649 btmrvl_sdio_card_to_host(priv);
661 static void btmrvl_sdio_interrupt(struct sdio_func *func)
663 struct btmrvl_private *priv;
664 struct hci_dev *hcidev;
665 struct btmrvl_sdio_card *card;
670 card = sdio_get_drvdata(func);
671 if (card && card->priv) {
673 hcidev = priv->btmrvl_dev.hcidev;
675 if (btmrvl_sdio_get_int_status(priv, &ireg))
676 BT_ERR("reading HOST_INT_STATUS_REG failed");
678 BT_DBG("HOST_INT_STATUS_REG %#x", ireg);
680 btmrvl_interrupt(priv);
686 static int btmrvl_sdio_register_dev(struct btmrvl_sdio_card *card)
688 struct sdio_func *func;
694 if (!card || !card->func) {
695 BT_ERR("Error: card or function is NULL!");
702 sdio_claim_host(func);
704 ret = sdio_enable_func(func);
706 BT_ERR("sdio_enable_func() failed: ret=%d", ret);
711 ret = sdio_claim_irq(func, btmrvl_sdio_interrupt);
713 BT_ERR("sdio_claim_irq failed: ret=%d", ret);
718 ret = sdio_set_block_size(card->func, SDIO_BLOCK_SIZE);
720 BT_ERR("cannot set SDIO block size");
725 reg = sdio_readb(func, IO_PORT_0_REG, &ret);
733 reg = sdio_readb(func, IO_PORT_1_REG, &ret);
739 card->ioport |= (reg << 8);
741 reg = sdio_readb(func, IO_PORT_2_REG, &ret);
747 card->ioport |= (reg << 16);
749 BT_DBG("SDIO FUNC%d IO port: 0x%x", func->num, card->ioport);
751 sdio_set_drvdata(func, card);
753 sdio_release_host(func);
759 sdio_release_irq(func);
762 sdio_disable_func(func);
765 sdio_release_host(func);
772 static int btmrvl_sdio_unregister_dev(struct btmrvl_sdio_card *card)
776 if (card && card->func) {
777 sdio_claim_host(card->func);
778 sdio_release_irq(card->func);
779 sdio_disable_func(card->func);
780 sdio_release_host(card->func);
781 sdio_set_drvdata(card->func, NULL);
789 static int btmrvl_sdio_enable_host_int(struct btmrvl_sdio_card *card)
795 if (!card || !card->func) {
800 sdio_claim_host(card->func);
802 ret = btmrvl_sdio_enable_host_int_mask(card, HIM_ENABLE);
804 btmrvl_sdio_get_rx_unit(card);
806 sdio_release_host(card->func);
813 static int btmrvl_sdio_disable_host_int(struct btmrvl_sdio_card *card)
819 if (!card || !card->func) {
824 sdio_claim_host(card->func);
826 ret = btmrvl_sdio_disable_host_int_mask(card, HIM_DISABLE);
828 sdio_release_host(card->func);
835 static int btmrvl_sdio_host_to_card(struct btmrvl_private *priv,
838 struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
849 if (!card || !card->func) {
850 BT_ERR("card or function is NULL!");
856 if ((u32) payload & (BTSDIO_DMA_ALIGN - 1)) {
857 tmpbufsz = ALIGN_SZ(nb, BTSDIO_DMA_ALIGN);
858 tmpbuf = kmalloc(tmpbufsz, GFP_KERNEL);
859 memset(tmpbuf, 0, tmpbufsz);
860 buf = (u8 *) ALIGN_ADDR(tmpbuf, BTSDIO_DMA_ALIGN);
861 memcpy(buf, payload, nb);
864 blksz = SDIO_BLOCK_SIZE;
865 buf_block_len = (nb + blksz - 1) / blksz;
867 sdio_claim_host(card->func);
870 /* Transfer data to card */
871 ret = sdio_writesb(card->func, card->ioport, buf,
872 buf_block_len * blksz);
875 BT_ERR("i=%d writesb failed: %d", i, ret);
876 print_hex_dump_bytes("", DUMP_PREFIX_OFFSET,
879 if (i > MAX_WRITE_IOMEM_RETRY)
884 priv->btmrvl_dev.tx_dnld_rdy = false;
887 sdio_release_host(card->func);
894 static int btmrvl_sdio_download_fw(struct btmrvl_sdio_card *card)
900 if (!card || !card->func) {
901 BT_ERR("card or function is NULL!");
905 sdio_claim_host(card->func);
907 if (!btmrvl_sdio_verify_fw_download(card, 1)) {
908 BT_DBG("Firmware already downloaded!");
912 ret = btmrvl_sdio_download_helper(card);
914 BT_ERR("Failed to download helper!");
919 if (btmrvl_sdio_download_fw_w_helper(card)) {
920 BT_ERR("Failed to download firmware!");
925 if (btmrvl_sdio_verify_fw_download(card, MAX_POLL_TRIES)) {
926 BT_ERR("FW failed to be active in time!");
932 sdio_release_host(card->func);
939 static int btmrvl_sdio_wakeup_fw(struct btmrvl_private *priv)
941 struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
946 if (!card || !card->func) {
947 BT_ERR("card or function is NULL!");
952 sdio_claim_host(card->func);
954 sdio_writeb(card->func, HOST_POWER_UP, CONFIG_REG, &ret);
956 sdio_release_host(card->func);
958 BT_DBG("wake up firmware");
965 static int btmrvl_sdio_probe(struct sdio_func *func,
966 const struct sdio_device_id *id)
969 struct btmrvl_private *priv = NULL;
970 struct btmrvl_sdio_card *card = NULL;
974 BT_INFO("vendor=0x%x, device=0x%x, class=%d, fn=%d",
975 id->vendor, id->device, id->class, func->num);
977 card = kzalloc(sizeof(*card), GFP_KERNEL);
985 if (id->driver_data) {
986 struct btmrvl_sdio_device *data = (void *) id->driver_data;
987 card->helper = data->helper;
988 card->firmware = data->firmware;
991 if (btmrvl_sdio_register_dev(card) < 0) {
992 BT_ERR("Failed to register BT device!");
997 /* Disable the interrupts on the card */
998 btmrvl_sdio_disable_host_int(card);
1000 if (btmrvl_sdio_download_fw(card)) {
1001 BT_ERR("Downloading firmware failed!");
1008 btmrvl_sdio_enable_host_int(card);
1010 priv = btmrvl_add_card(card);
1012 BT_ERR("Initializing card failed!");
1014 goto disable_host_int;
1019 /* Initialize the interface specific function pointers */
1020 priv->hw_host_to_card = btmrvl_sdio_host_to_card;
1021 priv->hw_wakeup_firmware = btmrvl_sdio_wakeup_fw;
1023 strncpy(priv->btmrvl_dev.name, "btmrvl_sdio0",
1024 sizeof(priv->btmrvl_dev.name));
1026 btmrvl_send_module_cfg_cmd(priv, MODULE_BRINGUP_REQ);
1033 btmrvl_sdio_disable_host_int(card);
1035 btmrvl_sdio_unregister_dev(card);
1044 static void btmrvl_sdio_remove(struct sdio_func *func)
1046 struct btmrvl_sdio_card *card;
1051 card = sdio_get_drvdata(func);
1053 /* Send SHUTDOWN command & disable interrupt
1054 * if user removes the module.
1057 btmrvl_send_module_cfg_cmd(card->priv,
1058 MODULE_SHUTDOWN_REQ);
1059 btmrvl_sdio_disable_host_int(card);
1061 BT_DBG("unregester dev");
1062 btmrvl_sdio_unregister_dev(card);
1063 btmrvl_remove_card(card->priv);
1071 static struct sdio_driver bt_mrvl_sdio = {
1072 .name = "btmrvl_sdio",
1073 .id_table = btmrvl_sdio_ids,
1074 .probe = btmrvl_sdio_probe,
1075 .remove = btmrvl_sdio_remove,
1078 static int btmrvl_sdio_init_module(void)
1082 if (sdio_register_driver(&bt_mrvl_sdio) != 0) {
1083 BT_ERR("SDIO Driver Registration Failed");
1088 /* Clear the flag in case user removes the card. */
1096 static void btmrvl_sdio_exit_module(void)
1100 /* Set the flag as user is removing this module. */
1103 sdio_unregister_driver(&bt_mrvl_sdio);
1108 module_init(btmrvl_sdio_init_module);
1109 module_exit(btmrvl_sdio_exit_module);
1111 MODULE_AUTHOR("Marvell International Ltd.");
1112 MODULE_DESCRIPTION("Marvell BT-over-SDIO driver ver " VERSION);
1113 MODULE_VERSION(VERSION);
1114 MODULE_LICENSE("GPL v2");