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)
70 reg = sdio_readb(card->func, CARD_RX_UNIT_REG, &ret);
77 static int btmrvl_sdio_read_fw_status(struct btmrvl_sdio_card *card, u16 *dat)
84 fws0 = sdio_readb(card->func, CARD_FW_STATUS0_REG, &ret);
87 fws1 = sdio_readb(card->func, CARD_FW_STATUS1_REG, &ret);
92 *dat = (((u16) fws1) << 8) | fws0;
97 static int btmrvl_sdio_read_rx_len(struct btmrvl_sdio_card *card, u16 *dat)
102 reg = sdio_readb(card->func, CARD_RX_LEN_REG, &ret);
104 *dat = (u16) reg << card->rx_unit;
109 static int btmrvl_sdio_enable_host_int_mask(struct btmrvl_sdio_card *card,
114 sdio_writeb(card->func, mask, HOST_INT_MASK_REG, &ret);
116 BT_ERR("Unable to enable the host interrupt!");
123 static int btmrvl_sdio_disable_host_int_mask(struct btmrvl_sdio_card *card,
129 host_int_mask = sdio_readb(card->func, HOST_INT_MASK_REG, &ret);
133 host_int_mask &= ~mask;
135 sdio_writeb(card->func, host_int_mask, HOST_INT_MASK_REG, &ret);
137 BT_ERR("Unable to disable the host interrupt!");
144 static int btmrvl_sdio_poll_card_status(struct btmrvl_sdio_card *card, u8 bits)
150 for (tries = 0; tries < MAX_POLL_TRIES * 1000; tries++) {
151 status = sdio_readb(card->func, CARD_STATUS_REG, &ret);
154 if ((status & bits) == bits)
163 BT_ERR("FAILED! ret=%d", ret);
168 static int btmrvl_sdio_verify_fw_download(struct btmrvl_sdio_card *card,
171 int ret = -ETIMEDOUT;
175 /* Wait for firmware to become ready */
176 for (tries = 0; tries < pollnum; tries++) {
177 if (btmrvl_sdio_read_fw_status(card, &firmwarestat) < 0)
180 if (firmwarestat == FIRMWARE_READY) {
191 static int btmrvl_sdio_download_helper(struct btmrvl_sdio_card *card)
193 const struct firmware *fw_helper = NULL;
194 const u8 *helper = NULL;
196 void *tmphlprbuf = NULL;
197 int tmphlprbufsz, hlprblknow, helperlen;
201 ret = request_firmware(&fw_helper, card->helper,
203 if ((ret < 0) || !fw_helper) {
204 BT_ERR("request_firmware(helper) failed, error code = %d",
210 helper = fw_helper->data;
211 helperlen = fw_helper->size;
213 BT_DBG("Downloading helper image (%d bytes), block size %d bytes",
214 helperlen, SDIO_BLOCK_SIZE);
216 tmphlprbufsz = ALIGN_SZ(BTM_UPLD_SIZE, BTSDIO_DMA_ALIGN);
218 tmphlprbuf = kmalloc(tmphlprbufsz, GFP_KERNEL);
220 BT_ERR("Unable to allocate buffer for helper."
221 " Terminating download");
226 memset(tmphlprbuf, 0, tmphlprbufsz);
228 helperbuf = (u8 *) ALIGN_ADDR(tmphlprbuf, BTSDIO_DMA_ALIGN);
230 /* Perform helper data transfer */
231 tx_len = (FIRMWARE_TRANSFER_NBLOCK * SDIO_BLOCK_SIZE)
236 ret = btmrvl_sdio_poll_card_status(card,
237 CARD_IO_READY | DN_LD_CARD_RDY);
239 BT_ERR("Helper download poll status timeout @ %d",
244 /* Check if there is more data? */
245 if (hlprblknow >= helperlen)
248 if (helperlen - hlprblknow < tx_len)
249 tx_len = helperlen - hlprblknow;
252 helperbuf[0] = ((tx_len & 0x000000ff) >> 0);
253 helperbuf[1] = ((tx_len & 0x0000ff00) >> 8);
254 helperbuf[2] = ((tx_len & 0x00ff0000) >> 16);
255 helperbuf[3] = ((tx_len & 0xff000000) >> 24);
257 memcpy(&helperbuf[SDIO_HEADER_LEN], &helper[hlprblknow],
260 /* Now send the data */
261 ret = sdio_writesb(card->func, card->ioport, helperbuf,
262 FIRMWARE_TRANSFER_NBLOCK * SDIO_BLOCK_SIZE);
264 BT_ERR("IO error during helper download @ %d",
269 hlprblknow += tx_len;
272 BT_DBG("Transferring helper image EOF block");
274 memset(helperbuf, 0x0, SDIO_BLOCK_SIZE);
276 ret = sdio_writesb(card->func, card->ioport, helperbuf,
279 BT_ERR("IO error in writing helper image EOF block");
288 release_firmware(fw_helper);
293 static int btmrvl_sdio_download_fw_w_helper(struct btmrvl_sdio_card *card)
295 const struct firmware *fw_firmware = NULL;
296 const u8 *firmware = NULL;
297 int firmwarelen, tmpfwbufsz, ret;
298 unsigned int tries, offset;
300 void *tmpfwbuf = NULL;
303 int txlen = 0, tx_blocks = 0, count = 0;
305 ret = request_firmware(&fw_firmware, card->firmware,
307 if ((ret < 0) || !fw_firmware) {
308 BT_ERR("request_firmware(firmware) failed, error code = %d",
314 firmware = fw_firmware->data;
315 firmwarelen = fw_firmware->size;
317 BT_DBG("Downloading FW image (%d bytes)", firmwarelen);
319 tmpfwbufsz = ALIGN_SZ(BTM_UPLD_SIZE, BTSDIO_DMA_ALIGN);
320 tmpfwbuf = kmalloc(tmpfwbufsz, GFP_KERNEL);
322 BT_ERR("Unable to allocate buffer for firmware."
323 " Terminating download");
328 memset(tmpfwbuf, 0, tmpfwbufsz);
330 /* Ensure aligned firmware buffer */
331 fwbuf = (u8 *) ALIGN_ADDR(tmpfwbuf, BTSDIO_DMA_ALIGN);
333 /* Perform firmware data transfer */
336 ret = btmrvl_sdio_poll_card_status(card,
337 CARD_IO_READY | DN_LD_CARD_RDY);
339 BT_ERR("FW download with helper poll status"
340 " timeout @ %d", offset);
344 /* Check if there is more data ? */
345 if (offset >= firmwarelen)
348 for (tries = 0; tries < MAX_POLL_TRIES; tries++) {
349 base0 = sdio_readb(card->func,
350 SQ_READ_BASE_ADDRESS_A0_REG, &ret);
352 BT_ERR("BASE0 register read failed:"
353 " base0 = 0x%04X(%d)."
354 " Terminating download",
359 base1 = sdio_readb(card->func,
360 SQ_READ_BASE_ADDRESS_A1_REG, &ret);
362 BT_ERR("BASE1 register read failed:"
363 " base1 = 0x%04X(%d)."
364 " Terminating download",
370 len = (((u16) base1) << 8) | base0;
379 else if (len > BTM_UPLD_SIZE) {
380 BT_ERR("FW download failure @%d, invalid length %d",
390 if (count > MAX_WRITE_IOMEM_RETRY) {
391 BT_ERR("FW download failure @%d, "
392 "over max retry count", offset);
396 BT_ERR("FW CRC error indicated by the helper: "
397 "len = 0x%04X, txlen = %d", len, txlen);
399 /* Set txlen to 0 so as to resend from same offset */
405 if (firmwarelen - offset < txlen)
406 txlen = firmwarelen - offset;
409 (txlen + SDIO_BLOCK_SIZE - 1) / SDIO_BLOCK_SIZE;
411 memcpy(fwbuf, &firmware[offset], txlen);
414 ret = sdio_writesb(card->func, card->ioport, fwbuf,
415 tx_blocks * SDIO_BLOCK_SIZE);
418 BT_ERR("FW download, writesb(%d) failed @%d",
420 sdio_writeb(card->func, HOST_CMD53_FIN, CONFIG_REG,
423 BT_ERR("writeb failed (CFG)");
429 BT_DBG("FW download over, size %d bytes", offset);
437 release_firmware(fw_firmware);
442 static int btmrvl_sdio_card_to_host(struct btmrvl_private *priv)
445 int ret, buf_block_len, blksz;
446 struct sk_buff *skb = NULL;
449 struct hci_dev *hdev = priv->btmrvl_dev.hcidev;
450 struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
452 if (!card || !card->func) {
453 BT_ERR("card or function is NULL!");
458 /* Read the length of data to be transferred */
459 ret = btmrvl_sdio_read_rx_len(card, &buf_len);
461 BT_ERR("read rx_len failed");
466 blksz = SDIO_BLOCK_SIZE;
467 buf_block_len = (buf_len + blksz - 1) / blksz;
469 if (buf_len <= SDIO_HEADER_LEN
470 || (buf_block_len * blksz) > ALLOC_BUF_SIZE) {
471 BT_ERR("invalid packet length: %d", buf_len);
476 /* Allocate buffer */
477 skb = bt_skb_alloc(buf_block_len * blksz + BTSDIO_DMA_ALIGN,
480 BT_ERR("No free skb");
484 if ((u32) skb->data & (BTSDIO_DMA_ALIGN - 1)) {
485 skb_put(skb, (u32) skb->data & (BTSDIO_DMA_ALIGN - 1));
486 skb_pull(skb, (u32) skb->data & (BTSDIO_DMA_ALIGN - 1));
491 ret = sdio_readsb(card->func, payload, card->ioport,
492 buf_block_len * blksz);
494 BT_ERR("readsb failed: %d", ret);
499 /* This is SDIO specific header length: byte[2][1][0], type: byte[3]
500 * (HCI_COMMAND = 1, ACL_DATA = 2, SCO_DATA = 3, 0xFE = Vendor)
503 buf_len = payload[0];
504 buf_len |= (u16) payload[1] << 8;
508 case HCI_ACLDATA_PKT:
509 case HCI_SCODATA_PKT:
511 bt_cb(skb)->pkt_type = type;
512 skb->dev = (void *)hdev;
513 skb_put(skb, buf_len);
514 skb_pull(skb, SDIO_HEADER_LEN);
516 if (type == HCI_EVENT_PKT)
517 btmrvl_check_evtpkt(priv, skb);
520 hdev->stat.byte_rx += buf_len;
523 case MRVL_VENDOR_PKT:
524 bt_cb(skb)->pkt_type = HCI_VENDOR_PKT;
525 skb->dev = (void *)hdev;
526 skb_put(skb, buf_len);
527 skb_pull(skb, SDIO_HEADER_LEN);
529 if (btmrvl_process_event(priv, skb))
532 hdev->stat.byte_rx += buf_len;
536 BT_ERR("Unknow packet type:%d", type);
537 print_hex_dump_bytes("", DUMP_PREFIX_OFFSET, payload,
538 blksz * buf_block_len);
555 static int btmrvl_sdio_get_int_status(struct btmrvl_private *priv, u8 * ireg)
559 struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
563 sdio_ireg = sdio_readb(card->func, HOST_INTSTATUS_REG, &ret);
565 BT_ERR("sdio_readb: read int status register failed");
570 if (sdio_ireg != 0) {
572 * DN_LD_HOST_INT_STATUS and/or UP_LD_HOST_INT_STATUS
573 * Clear the interrupt status register and re-enable the
576 BT_DBG("sdio_ireg = 0x%x", sdio_ireg);
578 sdio_writeb(card->func, ~(sdio_ireg) & (DN_LD_HOST_INT_STATUS |
579 UP_LD_HOST_INT_STATUS),
580 HOST_INTSTATUS_REG, &ret);
582 BT_ERR("sdio_writeb: clear int status register "
589 if (sdio_ireg & DN_LD_HOST_INT_STATUS) {
590 if (priv->btmrvl_dev.tx_dnld_rdy)
591 BT_DBG("tx_done already received: "
592 " int_status=0x%x", sdio_ireg);
594 priv->btmrvl_dev.tx_dnld_rdy = true;
597 if (sdio_ireg & UP_LD_HOST_INT_STATUS)
598 btmrvl_sdio_card_to_host(priv);
608 static void btmrvl_sdio_interrupt(struct sdio_func *func)
610 struct btmrvl_private *priv;
611 struct hci_dev *hcidev;
612 struct btmrvl_sdio_card *card;
615 card = sdio_get_drvdata(func);
616 if (card && card->priv) {
618 hcidev = priv->btmrvl_dev.hcidev;
620 if (btmrvl_sdio_get_int_status(priv, &ireg))
621 BT_ERR("reading HOST_INT_STATUS_REG failed");
623 BT_DBG("HOST_INT_STATUS_REG %#x", ireg);
625 btmrvl_interrupt(priv);
629 static int btmrvl_sdio_register_dev(struct btmrvl_sdio_card *card)
631 struct sdio_func *func;
635 if (!card || !card->func) {
636 BT_ERR("Error: card or function is NULL!");
643 sdio_claim_host(func);
645 ret = sdio_enable_func(func);
647 BT_ERR("sdio_enable_func() failed: ret=%d", ret);
652 ret = sdio_claim_irq(func, btmrvl_sdio_interrupt);
654 BT_ERR("sdio_claim_irq failed: ret=%d", ret);
659 ret = sdio_set_block_size(card->func, SDIO_BLOCK_SIZE);
661 BT_ERR("cannot set SDIO block size");
666 reg = sdio_readb(func, IO_PORT_0_REG, &ret);
674 reg = sdio_readb(func, IO_PORT_1_REG, &ret);
680 card->ioport |= (reg << 8);
682 reg = sdio_readb(func, IO_PORT_2_REG, &ret);
688 card->ioport |= (reg << 16);
690 BT_DBG("SDIO FUNC%d IO port: 0x%x", func->num, card->ioport);
692 sdio_set_drvdata(func, card);
694 sdio_release_host(func);
699 sdio_release_irq(func);
702 sdio_disable_func(func);
705 sdio_release_host(func);
711 static int btmrvl_sdio_unregister_dev(struct btmrvl_sdio_card *card)
713 if (card && card->func) {
714 sdio_claim_host(card->func);
715 sdio_release_irq(card->func);
716 sdio_disable_func(card->func);
717 sdio_release_host(card->func);
718 sdio_set_drvdata(card->func, NULL);
724 static int btmrvl_sdio_enable_host_int(struct btmrvl_sdio_card *card)
728 if (!card || !card->func)
731 sdio_claim_host(card->func);
733 ret = btmrvl_sdio_enable_host_int_mask(card, HIM_ENABLE);
735 btmrvl_sdio_get_rx_unit(card);
737 sdio_release_host(card->func);
742 static int btmrvl_sdio_disable_host_int(struct btmrvl_sdio_card *card)
746 if (!card || !card->func)
749 sdio_claim_host(card->func);
751 ret = btmrvl_sdio_disable_host_int_mask(card, HIM_DISABLE);
753 sdio_release_host(card->func);
758 static int btmrvl_sdio_host_to_card(struct btmrvl_private *priv,
761 struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
770 if (!card || !card->func) {
771 BT_ERR("card or function is NULL!");
776 if ((u32) payload & (BTSDIO_DMA_ALIGN - 1)) {
777 tmpbufsz = ALIGN_SZ(nb, BTSDIO_DMA_ALIGN);
778 tmpbuf = kmalloc(tmpbufsz, GFP_KERNEL);
779 memset(tmpbuf, 0, tmpbufsz);
780 buf = (u8 *) ALIGN_ADDR(tmpbuf, BTSDIO_DMA_ALIGN);
781 memcpy(buf, payload, nb);
784 blksz = SDIO_BLOCK_SIZE;
785 buf_block_len = (nb + blksz - 1) / blksz;
787 sdio_claim_host(card->func);
790 /* Transfer data to card */
791 ret = sdio_writesb(card->func, card->ioport, buf,
792 buf_block_len * blksz);
795 BT_ERR("i=%d writesb failed: %d", i, ret);
796 print_hex_dump_bytes("", DUMP_PREFIX_OFFSET,
799 if (i > MAX_WRITE_IOMEM_RETRY)
804 priv->btmrvl_dev.tx_dnld_rdy = false;
807 sdio_release_host(card->func);
812 static int btmrvl_sdio_download_fw(struct btmrvl_sdio_card *card)
816 if (!card || !card->func) {
817 BT_ERR("card or function is NULL!");
820 sdio_claim_host(card->func);
822 if (!btmrvl_sdio_verify_fw_download(card, 1)) {
823 BT_DBG("Firmware already downloaded!");
827 ret = btmrvl_sdio_download_helper(card);
829 BT_ERR("Failed to download helper!");
834 if (btmrvl_sdio_download_fw_w_helper(card)) {
835 BT_ERR("Failed to download firmware!");
840 if (btmrvl_sdio_verify_fw_download(card, MAX_POLL_TRIES)) {
841 BT_ERR("FW failed to be active in time!");
847 sdio_release_host(card->func);
852 static int btmrvl_sdio_wakeup_fw(struct btmrvl_private *priv)
854 struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
857 if (!card || !card->func) {
858 BT_ERR("card or function is NULL!");
862 sdio_claim_host(card->func);
864 sdio_writeb(card->func, HOST_POWER_UP, CONFIG_REG, &ret);
866 sdio_release_host(card->func);
868 BT_DBG("wake up firmware");
873 static int btmrvl_sdio_probe(struct sdio_func *func,
874 const struct sdio_device_id *id)
877 struct btmrvl_private *priv = NULL;
878 struct btmrvl_sdio_card *card = NULL;
880 BT_INFO("vendor=0x%x, device=0x%x, class=%d, fn=%d",
881 id->vendor, id->device, id->class, func->num);
883 card = kzalloc(sizeof(*card), GFP_KERNEL);
891 if (id->driver_data) {
892 struct btmrvl_sdio_device *data = (void *) id->driver_data;
893 card->helper = data->helper;
894 card->firmware = data->firmware;
897 if (btmrvl_sdio_register_dev(card) < 0) {
898 BT_ERR("Failed to register BT device!");
903 /* Disable the interrupts on the card */
904 btmrvl_sdio_disable_host_int(card);
906 if (btmrvl_sdio_download_fw(card)) {
907 BT_ERR("Downloading firmware failed!");
914 btmrvl_sdio_enable_host_int(card);
916 priv = btmrvl_add_card(card);
918 BT_ERR("Initializing card failed!");
920 goto disable_host_int;
925 /* Initialize the interface specific function pointers */
926 priv->hw_host_to_card = btmrvl_sdio_host_to_card;
927 priv->hw_wakeup_firmware = btmrvl_sdio_wakeup_fw;
929 btmrvl_send_module_cfg_cmd(priv, MODULE_BRINGUP_REQ);
934 btmrvl_sdio_disable_host_int(card);
936 btmrvl_sdio_unregister_dev(card);
943 static void btmrvl_sdio_remove(struct sdio_func *func)
945 struct btmrvl_sdio_card *card;
948 card = sdio_get_drvdata(func);
950 /* Send SHUTDOWN command & disable interrupt
951 * if user removes the module.
954 btmrvl_send_module_cfg_cmd(card->priv,
955 MODULE_SHUTDOWN_REQ);
956 btmrvl_sdio_disable_host_int(card);
958 BT_DBG("unregester dev");
959 btmrvl_sdio_unregister_dev(card);
960 btmrvl_remove_card(card->priv);
966 static struct sdio_driver bt_mrvl_sdio = {
967 .name = "btmrvl_sdio",
968 .id_table = btmrvl_sdio_ids,
969 .probe = btmrvl_sdio_probe,
970 .remove = btmrvl_sdio_remove,
973 static int btmrvl_sdio_init_module(void)
975 if (sdio_register_driver(&bt_mrvl_sdio) != 0) {
976 BT_ERR("SDIO Driver Registration Failed");
980 /* Clear the flag in case user removes the card. */
986 static void btmrvl_sdio_exit_module(void)
988 /* Set the flag as user is removing this module. */
991 sdio_unregister_driver(&bt_mrvl_sdio);
994 module_init(btmrvl_sdio_init_module);
995 module_exit(btmrvl_sdio_exit_module);
997 MODULE_AUTHOR("Marvell International Ltd.");
998 MODULE_DESCRIPTION("Marvell BT-over-SDIO driver ver " VERSION);
999 MODULE_VERSION(VERSION);
1000 MODULE_LICENSE("GPL v2");