drivers/bluetooth/btmrvl_sdio.c

   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
  28 #include <net/bluetooth/bluetooth.h>
  29 #include <net/bluetooth/hci_core.h>
  30
  31 #include "btmrvl_drv.h"
  32 #include "btmrvl_sdio.h"
  33
  34 #define VERSION "1.0"
  35
  36 /* The btmrvl_sdio_remove() callback function is called
  37  * when user removes this module from kernel space or ejects
  38  * the card from the slot. The driver handles these 2 cases
  39  * differently.
  40  * If the user is removing the module, a MODULE_SHUTDOWN_REQ
  41  * command is sent to firmware and interrupt will be disabled.
  42  * If the card is removed, there is no need to send command
  43  * or disable interrupt.
  44  *
  45  * The variable 'user_rmmod' is used to distinguish these two
  46  * scenarios. This flag is initialized as FALSE in case the card
  47  * is removed, and will be set to TRUE for module removal when
  48  * module_exit function is called.
  49  */
  50 static u8 user_rmmod;
  51 static u8 sdio_ireg;
  52
  53 static const struct btmrvl_sdio_card_reg btmrvl_reg_8688 = {
  54         .cfg = 0x03,
  55         .host_int_mask = 0x04,
  56         .host_intstatus = 0x05,
  57         .card_status = 0x20,
  58         .sq_read_base_addr_a0 = 0x10,
  59         .sq_read_base_addr_a1 = 0x11,
  60         .card_fw_status0 = 0x40,
  61         .card_fw_status1 = 0x41,
  62         .card_rx_len = 0x42,
  63         .card_rx_unit = 0x43,
  64         .io_port_0 = 0x00,
  65         .io_port_1 = 0x01,
  66         .io_port_2 = 0x02,
  67 };
  68 static const struct btmrvl_sdio_card_reg btmrvl_reg_87xx = {
  69         .cfg = 0x00,
  70         .host_int_mask = 0x02,
  71         .host_intstatus = 0x03,
  72         .card_status = 0x30,
  73         .sq_read_base_addr_a0 = 0x40,
  74         .sq_read_base_addr_a1 = 0x41,
  75         .card_revision = 0x5c,
  76         .card_fw_status0 = 0x60,
  77         .card_fw_status1 = 0x61,
  78         .card_rx_len = 0x62,
  79         .card_rx_unit = 0x63,
  80         .io_port_0 = 0x78,
  81         .io_port_1 = 0x79,
  82         .io_port_2 = 0x7a,
  83 };
  84
  85 static const struct btmrvl_sdio_device btmrvl_sdio_sd8688 = {
  86         .helper         = "sd8688_helper.bin",
  87         .firmware       = "sd8688.bin",
  88         .reg            = &btmrvl_reg_8688,
  89         .sd_blksz_fw_dl = 64,
  90 };
  91
  92 static const struct btmrvl_sdio_device btmrvl_sdio_sd8787 = {
  93         .helper         = NULL,
  94         .firmware       = "mrvl/sd8787_uapsta.bin",
  95         .reg            = &btmrvl_reg_87xx,
  96         .sd_blksz_fw_dl = 256,
  97 };
  98
  99 static const struct btmrvl_sdio_device btmrvl_sdio_sd8797 = {
 100         .helper         = NULL,
 101         .firmware       = "mrvl/sd8797_uapsta.bin",
 102         .reg            = &btmrvl_reg_87xx,
 103         .sd_blksz_fw_dl = 256,
 104 };
 105
 106 static const struct sdio_device_id btmrvl_sdio_ids[] = {
 107         /* Marvell SD8688 Bluetooth device */
 108         { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL, 0x9105),
 109                         .driver_data = (unsigned long) &btmrvl_sdio_sd8688 },
 110         /* Marvell SD8787 Bluetooth device */
 111         { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL, 0x911A),
 112                         .driver_data = (unsigned long) &btmrvl_sdio_sd8787 },
 113         /* Marvell SD8797 Bluetooth device */
 114         { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL, 0x912A),
 115                         .driver_data = (unsigned long) &btmrvl_sdio_sd8797 },
 116
 117         { }     /* Terminating entry */
 118 };
 119
 120 MODULE_DEVICE_TABLE(sdio, btmrvl_sdio_ids);
 121
 122 static int btmrvl_sdio_get_rx_unit(struct btmrvl_sdio_card *card)
 123 {
 124         u8 reg;
 125         int ret;
 126
 127         reg = sdio_readb(card->func, card->reg->card_rx_unit, &ret);
 128         if (!ret)
 129                 card->rx_unit = reg;
 130
 131         return ret;
 132 }
 133
 134 static int btmrvl_sdio_read_fw_status(struct btmrvl_sdio_card *card, u16 *dat)
 135 {
 136         u8 fws0, fws1;
 137         int ret;
 138
 139         *dat = 0;
 140
 141         fws0 = sdio_readb(card->func, card->reg->card_fw_status0, &ret);
 142         if (ret)
 143                 return -EIO;
 144
 145         fws1 = sdio_readb(card->func, card->reg->card_fw_status1, &ret);
 146         if (ret)
 147                 return -EIO;
 148
 149         *dat = (((u16) fws1) << 8) | fws0;
 150
 151         return 0;
 152 }
 153
 154 static int btmrvl_sdio_read_rx_len(struct btmrvl_sdio_card *card, u16 *dat)
 155 {
 156         u8 reg;
 157         int ret;
 158
 159         reg = sdio_readb(card->func, card->reg->card_rx_len, &ret);
 160         if (!ret)
 161                 *dat = (u16) reg << card->rx_unit;
 162
 163         return ret;
 164 }
 165
 166 static int btmrvl_sdio_enable_host_int_mask(struct btmrvl_sdio_card *card,
 167                                                                 u8 mask)
 168 {
 169         int ret;
 170
 171         sdio_writeb(card->func, mask, card->reg->host_int_mask, &ret);
 172         if (ret) {
 173                 BT_ERR("Unable to enable the host interrupt!");
 174                 ret = -EIO;
 175         }
 176
 177         return ret;
 178 }
 179
 180 static int btmrvl_sdio_disable_host_int_mask(struct btmrvl_sdio_card *card,
 181                                                                 u8 mask)
 182 {
 183         u8 host_int_mask;
 184         int ret;
 185
 186         host_int_mask = sdio_readb(card->func, card->reg->host_int_mask, &ret);
 187         if (ret)
 188                 return -EIO;
 189
 190         host_int_mask &= ~mask;
 191
 192         sdio_writeb(card->func, host_int_mask, card->reg->host_int_mask, &ret);
 193         if (ret < 0) {
 194                 BT_ERR("Unable to disable the host interrupt!");
 195                 return -EIO;
 196         }
 197
 198         return 0;
 199 }
 200
 201 static int btmrvl_sdio_poll_card_status(struct btmrvl_sdio_card *card, u8 bits)
 202 {
 203         unsigned int tries;
 204         u8 status;
 205         int ret;
 206
 207         for (tries = 0; tries < MAX_POLL_TRIES * 1000; tries++) {
 208                 status = sdio_readb(card->func, card->reg->card_status, &ret);
 209                 if (ret)
 210                         goto failed;
 211                 if ((status & bits) == bits)
 212                         return ret;
 213
 214                 udelay(1);
 215         }
 216
 217         ret = -ETIMEDOUT;
 218
 219 failed:
 220         BT_ERR("FAILED! ret=%d", ret);
 221
 222         return ret;
 223 }
 224
 225 static int btmrvl_sdio_verify_fw_download(struct btmrvl_sdio_card *card,
 226                                                                 int pollnum)
 227 {
 228         int ret = -ETIMEDOUT;
 229         u16 firmwarestat;
 230         unsigned int tries;
 231
 232          /* Wait for firmware to become ready */
 233         for (tries = 0; tries < pollnum; tries++) {
 234                 if (btmrvl_sdio_read_fw_status(card, &firmwarestat) < 0)
 235                         continue;
 236
 237                 if (firmwarestat == FIRMWARE_READY) {
 238                         ret = 0;
 239                         break;
 240                 } else {
 241                         msleep(10);
 242                 }
 243         }
 244
 245         return ret;
 246 }
 247
 248 static int btmrvl_sdio_download_helper(struct btmrvl_sdio_card *card)
 249 {
 250         const struct firmware *fw_helper = NULL;
 251         const u8 *helper = NULL;
 252         int ret;
 253         void *tmphlprbuf = NULL;
 254         int tmphlprbufsz, hlprblknow, helperlen;
 255         u8 *helperbuf;
 256         u32 tx_len;
 257
 258         ret = request_firmware(&fw_helper, card->helper,
 259                                                 &card->func->dev);
 260         if ((ret < 0) || !fw_helper) {
 261                 BT_ERR("request_firmware(helper) failed, error code = %d",
 262                                                                         ret);
 263                 ret = -ENOENT;
 264                 goto done;
 265         }
 266
 267         helper = fw_helper->data;
 268         helperlen = fw_helper->size;
 269
 270         BT_DBG("Downloading helper image (%d bytes), block size %d bytes",
 271                                                 helperlen, SDIO_BLOCK_SIZE);
 272
 273         tmphlprbufsz = ALIGN_SZ(BTM_UPLD_SIZE, BTSDIO_DMA_ALIGN);
 274
 275         tmphlprbuf = kzalloc(tmphlprbufsz, GFP_KERNEL);
 276         if (!tmphlprbuf) {
 277                 BT_ERR("Unable to allocate buffer for helper."
 278                         " Terminating download");
 279                 ret = -ENOMEM;
 280                 goto done;
 281         }
 282
 283         helperbuf = (u8 *) ALIGN_ADDR(tmphlprbuf, BTSDIO_DMA_ALIGN);
 284
 285         /* Perform helper data transfer */
 286         tx_len = (FIRMWARE_TRANSFER_NBLOCK * SDIO_BLOCK_SIZE)
 287                         - SDIO_HEADER_LEN;
 288         hlprblknow = 0;
 289
 290         do {
 291                 ret = btmrvl_sdio_poll_card_status(card,
 292                                             CARD_IO_READY | DN_LD_CARD_RDY);
 293                 if (ret < 0) {
 294                         BT_ERR("Helper download poll status timeout @ %d",
 295                                 hlprblknow);
 296                         goto done;
 297                 }
 298
 299                 /* Check if there is more data? */
 300                 if (hlprblknow >= helperlen)
 301                         break;
 302
 303                 if (helperlen - hlprblknow < tx_len)
 304                         tx_len = helperlen - hlprblknow;
 305
 306                 /* Little-endian */
 307                 helperbuf[0] = ((tx_len & 0x000000ff) >> 0);
 308                 helperbuf[1] = ((tx_len & 0x0000ff00) >> 8);
 309                 helperbuf[2] = ((tx_len & 0x00ff0000) >> 16);
 310                 helperbuf[3] = ((tx_len & 0xff000000) >> 24);
 311
 312                 memcpy(&helperbuf[SDIO_HEADER_LEN], &helper[hlprblknow],
 313                                 tx_len);
 314
 315                 /* Now send the data */
 316                 ret = sdio_writesb(card->func, card->ioport, helperbuf,
 317                                 FIRMWARE_TRANSFER_NBLOCK * SDIO_BLOCK_SIZE);
 318                 if (ret < 0) {
 319                         BT_ERR("IO error during helper download @ %d",
 320                                 hlprblknow);
 321                         goto done;
 322                 }
 323
 324                 hlprblknow += tx_len;
 325         } while (true);
 326
 327         BT_DBG("Transferring helper image EOF block");
 328
 329         memset(helperbuf, 0x0, SDIO_BLOCK_SIZE);
 330
 331         ret = sdio_writesb(card->func, card->ioport, helperbuf,
 332                                                         SDIO_BLOCK_SIZE);
 333         if (ret < 0) {
 334                 BT_ERR("IO error in writing helper image EOF block");
 335                 goto done;
 336         }
 337
 338         ret = 0;
 339
 340 done:
 341         kfree(tmphlprbuf);
 342         release_firmware(fw_helper);
 343         return ret;
 344 }
 345
 346 static int btmrvl_sdio_download_fw_w_helper(struct btmrvl_sdio_card *card)
 347 {
 348         const struct firmware *fw_firmware = NULL;
 349         const u8 *firmware = NULL;
 350         int firmwarelen, tmpfwbufsz, ret;
 351         unsigned int tries, offset;
 352         u8 base0, base1;
 353         void *tmpfwbuf = NULL;
 354         u8 *fwbuf;
 355         u16 len, blksz_dl = card->sd_blksz_fw_dl;
 356         int txlen = 0, tx_blocks = 0, count = 0;
 357
 358         ret = request_firmware(&fw_firmware, card->firmware,
 359                                                         &card->func->dev);
 360         if ((ret < 0) || !fw_firmware) {
 361                 BT_ERR("request_firmware(firmware) failed, error code = %d",
 362                                                                         ret);
 363                 ret = -ENOENT;
 364                 goto done;
 365         }
 366
 367         firmware = fw_firmware->data;
 368         firmwarelen = fw_firmware->size;
 369
 370         BT_DBG("Downloading FW image (%d bytes)", firmwarelen);
 371
 372         tmpfwbufsz = ALIGN_SZ(BTM_UPLD_SIZE, BTSDIO_DMA_ALIGN);
 373         tmpfwbuf = kzalloc(tmpfwbufsz, GFP_KERNEL);
 374         if (!tmpfwbuf) {
 375                 BT_ERR("Unable to allocate buffer for firmware."
 376                        " Terminating download");
 377                 ret = -ENOMEM;
 378                 goto done;
 379         }
 380
 381         /* Ensure aligned firmware buffer */
 382         fwbuf = (u8 *) ALIGN_ADDR(tmpfwbuf, BTSDIO_DMA_ALIGN);
 383
 384         /* Perform firmware data transfer */
 385         offset = 0;
 386         do {
 387                 ret = btmrvl_sdio_poll_card_status(card,
 388                                         CARD_IO_READY | DN_LD_CARD_RDY);
 389                 if (ret < 0) {
 390                         BT_ERR("FW download with helper poll status"
 391                                                 " timeout @ %d", offset);
 392                         goto done;
 393                 }
 394
 395                 /* Check if there is more data ? */
 396                 if (offset >= firmwarelen)
 397                         break;
 398
 399                 for (tries = 0; tries < MAX_POLL_TRIES; tries++) {
 400                         base0 = sdio_readb(card->func,
 401                                         card->reg->sq_read_base_addr_a0, &ret);
 402                         if (ret) {
 403                                 BT_ERR("BASE0 register read failed:"
 404                                         " base0 = 0x%04X(%d)."
 405                                         " Terminating download",
 406                                         base0, base0);
 407                                 ret = -EIO;
 408                                 goto done;
 409                         }
 410                         base1 = sdio_readb(card->func,
 411                                         card->reg->sq_read_base_addr_a1, &ret);
 412                         if (ret) {
 413                                 BT_ERR("BASE1 register read failed:"
 414                                         " base1 = 0x%04X(%d)."
 415                                         " Terminating download",
 416                                         base1, base1);
 417                                 ret = -EIO;
 418                                 goto done;
 419                         }
 420
 421                         len = (((u16) base1) << 8) | base0;
 422                         if (len)
 423                                 break;
 424
 425                         udelay(10);
 426                 }
 427
 428                 if (!len)
 429                         break;
 430                 else if (len > BTM_UPLD_SIZE) {
 431                         BT_ERR("FW download failure @%d, invalid length %d",
 432                                                                 offset, len);
 433                         ret = -EINVAL;
 434                         goto done;
 435                 }
 436
 437                 txlen = len;
 438
 439                 if (len & BIT(0)) {
 440                         count++;
 441                         if (count > MAX_WRITE_IOMEM_RETRY) {
 442                                 BT_ERR("FW download failure @%d, "
 443                                         "over max retry count", offset);
 444                                 ret = -EIO;
 445                                 goto done;
 446                         }
 447                         BT_ERR("FW CRC error indicated by the helper: "
 448                                 "len = 0x%04X, txlen = %d", len, txlen);
 449                         len &= ~BIT(0);
 450                         /* Set txlen to 0 so as to resend from same offset */
 451                         txlen = 0;
 452                 } else {
 453                         count = 0;
 454
 455                         /* Last block ? */
 456                         if (firmwarelen - offset < txlen)
 457                                 txlen = firmwarelen - offset;
 458
 459                         tx_blocks = (txlen + blksz_dl - 1) / blksz_dl;
 460
 461                         memcpy(fwbuf, &firmware[offset], txlen);
 462                 }
 463
 464                 ret = sdio_writesb(card->func, card->ioport, fwbuf,
 465                                                 tx_blocks * blksz_dl);
 466
 467                 if (ret < 0) {
 468                         BT_ERR("FW download, writesb(%d) failed @%d",
 469                                                         count, offset);
 470                         sdio_writeb(card->func, HOST_CMD53_FIN,
 471                                                 card->reg->cfg, &ret);
 472                         if (ret)
 473                                 BT_ERR("writeb failed (CFG)");
 474                 }
 475
 476                 offset += txlen;
 477         } while (true);
 478
 479         BT_DBG("FW download over, size %d bytes", offset);
 480
 481         ret = 0;
 482
 483 done:
 484         kfree(tmpfwbuf);
 485         release_firmware(fw_firmware);
 486         return ret;
 487 }
 488
 489 static int btmrvl_sdio_card_to_host(struct btmrvl_private *priv)
 490 {
 491         u16 buf_len = 0;
 492         int ret, buf_block_len, blksz;
 493         struct sk_buff *skb = NULL;
 494         u32 type;
 495         u8 *payload = NULL;
 496         struct hci_dev *hdev = priv->btmrvl_dev.hcidev;
 497         struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
 498
 499         if (!card || !card->func) {
 500                 BT_ERR("card or function is NULL!");
 501                 ret = -EINVAL;
 502                 goto exit;
 503         }
 504
 505         /* Read the length of data to be transferred */
 506         ret = btmrvl_sdio_read_rx_len(card, &buf_len);
 507         if (ret < 0) {
 508                 BT_ERR("read rx_len failed");
 509                 ret = -EIO;
 510                 goto exit;
 511         }
 512
 513         blksz = SDIO_BLOCK_SIZE;
 514         buf_block_len = (buf_len + blksz - 1) / blksz;
 515
 516         if (buf_len <= SDIO_HEADER_LEN
 517                         || (buf_block_len * blksz) > ALLOC_BUF_SIZE) {
 518                 BT_ERR("invalid packet length: %d", buf_len);
 519                 ret = -EINVAL;
 520                 goto exit;
 521         }
 522
 523         /* Allocate buffer */
 524         skb = bt_skb_alloc(buf_block_len * blksz + BTSDIO_DMA_ALIGN,
 525                                                                 GFP_ATOMIC);
 526         if (skb == NULL) {
 527                 BT_ERR("No free skb");
 528                 goto exit;
 529         }
 530
 531         if ((unsigned long) skb->data & (BTSDIO_DMA_ALIGN - 1)) {
 532                 skb_put(skb, (unsigned long) skb->data &
 533                                         (BTSDIO_DMA_ALIGN - 1));
 534                 skb_pull(skb, (unsigned long) skb->data &
 535                                         (BTSDIO_DMA_ALIGN - 1));
 536         }
 537
 538         payload = skb->data;
 539
 540         ret = sdio_readsb(card->func, payload, card->ioport,
 541                           buf_block_len * blksz);
 542         if (ret < 0) {
 543                 BT_ERR("readsb failed: %d", ret);
 544                 ret = -EIO;
 545                 goto exit;
 546         }
 547
 548         /* This is SDIO specific header length: byte[2][1][0], type: byte[3]
 549          * (HCI_COMMAND = 1, ACL_DATA = 2, SCO_DATA = 3, 0xFE = Vendor)
 550          */
 551
 552         buf_len = payload[0];
 553         buf_len |= (u16) payload[1] << 8;
 554         type = payload[3];
 555
 556         switch (type) {
 557         case HCI_ACLDATA_PKT:
 558         case HCI_SCODATA_PKT:
 559         case HCI_EVENT_PKT:
 560                 bt_cb(skb)->pkt_type = type;
 561                 skb->dev = (void *)hdev;
 562                 skb_put(skb, buf_len);
 563                 skb_pull(skb, SDIO_HEADER_LEN);
 564
 565                 if (type == HCI_EVENT_PKT) {
 566                         if (btmrvl_check_evtpkt(priv, skb))
 567                                 hci_recv_frame(skb);
 568                 } else
 569                         hci_recv_frame(skb);
 570
 571                 hdev->stat.byte_rx += buf_len;
 572                 break;
 573
 574         case MRVL_VENDOR_PKT:
 575                 bt_cb(skb)->pkt_type = HCI_VENDOR_PKT;
 576                 skb->dev = (void *)hdev;
 577                 skb_put(skb, buf_len);
 578                 skb_pull(skb, SDIO_HEADER_LEN);
 579
 580                 if (btmrvl_process_event(priv, skb))
 581                         hci_recv_frame(skb);
 582
 583                 hdev->stat.byte_rx += buf_len;
 584                 break;
 585
 586         default:
 587                 BT_ERR("Unknown packet type:%d", type);
 588                 print_hex_dump_bytes("", DUMP_PREFIX_OFFSET, payload,
 589                                                 blksz * buf_block_len);
 590
 591                 kfree_skb(skb);
 592                 skb = NULL;
 593                 break;
 594         }
 595
 596 exit:
 597         if (ret) {
 598                 hdev->stat.err_rx++;
 599                 if (skb)
 600                         kfree_skb(skb);
 601         }
 602
 603         return ret;
 604 }
 605
 606 static int btmrvl_sdio_process_int_status(struct btmrvl_private *priv)
 607 {
 608         ulong flags;
 609         u8 ireg;
 610         struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
 611
 612         spin_lock_irqsave(&priv->driver_lock, flags);
 613         ireg = sdio_ireg;
 614         sdio_ireg = 0;
 615         spin_unlock_irqrestore(&priv->driver_lock, flags);
 616
 617         sdio_claim_host(card->func);
 618         if (ireg & DN_LD_HOST_INT_STATUS) {
 619                 if (priv->btmrvl_dev.tx_dnld_rdy)
 620                         BT_DBG("tx_done already received: "
 621                                 " int_status=0x%x", ireg);
 622                 else
 623                         priv->btmrvl_dev.tx_dnld_rdy = true;
 624         }
 625
 626         if (ireg & UP_LD_HOST_INT_STATUS)
 627                 btmrvl_sdio_card_to_host(priv);
 628
 629         sdio_release_host(card->func);
 630
 631         return 0;
 632 }
 633
 634 static void btmrvl_sdio_interrupt(struct sdio_func *func)
 635 {
 636         struct btmrvl_private *priv;
 637         struct btmrvl_sdio_card *card;
 638         ulong flags;
 639         u8 ireg = 0;
 640         int ret;
 641
 642         card = sdio_get_drvdata(func);
 643         if (!card || !card->priv) {
 644                 BT_ERR("sbi_interrupt(%p) card or priv is "
 645                                 "NULL, card=%p\n", func, card);
 646                 return;
 647         }
 648
 649         priv = card->priv;
 650
 651         ireg = sdio_readb(card->func, card->reg->host_intstatus, &ret);
 652         if (ret) {
 653                 BT_ERR("sdio_readb: read int status register failed");
 654                 return;
 655         }
 656
 657         if (ireg != 0) {
 658                 /*
 659                  * DN_LD_HOST_INT_STATUS and/or UP_LD_HOST_INT_STATUS
 660                  * Clear the interrupt status register and re-enable the
 661                  * interrupt.
 662                  */
 663                 BT_DBG("ireg = 0x%x", ireg);
 664
 665                 sdio_writeb(card->func, ~(ireg) & (DN_LD_HOST_INT_STATUS |
 666                                         UP_LD_HOST_INT_STATUS),
 667                                 card->reg->host_intstatus, &ret);
 668                 if (ret) {
 669                         BT_ERR("sdio_writeb: clear int status register failed");
 670                         return;
 671                 }
 672         }
 673
 674         spin_lock_irqsave(&priv->driver_lock, flags);
 675         sdio_ireg |= ireg;
 676         spin_unlock_irqrestore(&priv->driver_lock, flags);
 677
 678         btmrvl_interrupt(priv);
 679 }
 680
 681 static int btmrvl_sdio_register_dev(struct btmrvl_sdio_card *card)
 682 {
 683         struct sdio_func *func;
 684         u8 reg;
 685         int ret = 0;
 686
 687         if (!card || !card->func) {
 688                 BT_ERR("Error: card or function is NULL!");
 689                 ret = -EINVAL;
 690                 goto failed;
 691         }
 692
 693         func = card->func;
 694
 695         sdio_claim_host(func);
 696
 697         ret = sdio_enable_func(func);
 698         if (ret) {
 699                 BT_ERR("sdio_enable_func() failed: ret=%d", ret);
 700                 ret = -EIO;
 701                 goto release_host;
 702         }
 703
 704         ret = sdio_claim_irq(func, btmrvl_sdio_interrupt);
 705         if (ret) {
 706                 BT_ERR("sdio_claim_irq failed: ret=%d", ret);
 707                 ret = -EIO;
 708                 goto disable_func;
 709         }
 710
 711         ret = sdio_set_block_size(card->func, SDIO_BLOCK_SIZE);
 712         if (ret) {
 713                 BT_ERR("cannot set SDIO block size");
 714                 ret = -EIO;
 715                 goto release_irq;
 716         }
 717
 718         reg = sdio_readb(func, card->reg->io_port_0, &ret);
 719         if (ret < 0) {
 720                 ret = -EIO;
 721                 goto release_irq;
 722         }
 723
 724         card->ioport = reg;
 725
 726         reg = sdio_readb(func, card->reg->io_port_1, &ret);
 727         if (ret < 0) {
 728                 ret = -EIO;
 729                 goto release_irq;
 730         }
 731
 732         card->ioport |= (reg << 8);
 733
 734         reg = sdio_readb(func, card->reg->io_port_2, &ret);
 735         if (ret < 0) {
 736                 ret = -EIO;
 737                 goto release_irq;
 738         }
 739
 740         card->ioport |= (reg << 16);
 741
 742         BT_DBG("SDIO FUNC%d IO port: 0x%x", func->num, card->ioport);
 743
 744         sdio_set_drvdata(func, card);
 745
 746         sdio_release_host(func);
 747
 748         return 0;
 749
 750 release_irq:
 751         sdio_release_irq(func);
 752
 753 disable_func:
 754         sdio_disable_func(func);
 755
 756 release_host:
 757         sdio_release_host(func);
 758
 759 failed:
 760         return ret;
 761 }
 762
 763 static int btmrvl_sdio_unregister_dev(struct btmrvl_sdio_card *card)
 764 {
 765         if (card && card->func) {
 766                 sdio_claim_host(card->func);
 767                 sdio_release_irq(card->func);
 768                 sdio_disable_func(card->func);
 769                 sdio_release_host(card->func);
 770                 sdio_set_drvdata(card->func, NULL);
 771         }
 772
 773         return 0;
 774 }
 775
 776 static int btmrvl_sdio_enable_host_int(struct btmrvl_sdio_card *card)
 777 {
 778         int ret;
 779
 780         if (!card || !card->func)
 781                 return -EINVAL;
 782
 783         sdio_claim_host(card->func);
 784
 785         ret = btmrvl_sdio_enable_host_int_mask(card, HIM_ENABLE);
 786
 787         btmrvl_sdio_get_rx_unit(card);
 788
 789         sdio_release_host(card->func);
 790
 791         return ret;
 792 }
 793
 794 static int btmrvl_sdio_disable_host_int(struct btmrvl_sdio_card *card)
 795 {
 796         int ret;
 797
 798         if (!card || !card->func)
 799                 return -EINVAL;
 800
 801         sdio_claim_host(card->func);
 802
 803         ret = btmrvl_sdio_disable_host_int_mask(card, HIM_DISABLE);
 804
 805         sdio_release_host(card->func);
 806
 807         return ret;
 808 }
 809
 810 static int btmrvl_sdio_host_to_card(struct btmrvl_private *priv,
 811                                 u8 *payload, u16 nb)
 812 {
 813         struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
 814         int ret = 0;
 815         int buf_block_len;
 816         int blksz;
 817         int i = 0;
 818         u8 *buf = NULL;
 819         void *tmpbuf = NULL;
 820         int tmpbufsz;
 821
 822         if (!card || !card->func) {
 823                 BT_ERR("card or function is NULL!");
 824                 return -EINVAL;
 825         }
 826
 827         buf = payload;
 828         if ((unsigned long) payload & (BTSDIO_DMA_ALIGN - 1)) {
 829                 tmpbufsz = ALIGN_SZ(nb, BTSDIO_DMA_ALIGN);
 830                 tmpbuf = kzalloc(tmpbufsz, GFP_KERNEL);
 831                 if (!tmpbuf)
 832                         return -ENOMEM;
 833                 buf = (u8 *) ALIGN_ADDR(tmpbuf, BTSDIO_DMA_ALIGN);
 834                 memcpy(buf, payload, nb);
 835         }
 836
 837         blksz = SDIO_BLOCK_SIZE;
 838         buf_block_len = (nb + blksz - 1) / blksz;
 839
 840         sdio_claim_host(card->func);
 841
 842         do {
 843                 /* Transfer data to card */
 844                 ret = sdio_writesb(card->func, card->ioport, buf,
 845                                    buf_block_len * blksz);
 846                 if (ret < 0) {
 847                         i++;
 848                         BT_ERR("i=%d writesb failed: %d", i, ret);
 849                         print_hex_dump_bytes("", DUMP_PREFIX_OFFSET,
 850                                                 payload, nb);
 851                         ret = -EIO;
 852                         if (i > MAX_WRITE_IOMEM_RETRY)
 853                                 goto exit;
 854                 }
 855         } while (ret);
 856
 857         priv->btmrvl_dev.tx_dnld_rdy = false;
 858
 859 exit:
 860         sdio_release_host(card->func);
 861         kfree(tmpbuf);
 862
 863         return ret;
 864 }
 865
 866 static int btmrvl_sdio_download_fw(struct btmrvl_sdio_card *card)
 867 {
 868         int ret = 0;
 869         u8 fws0;
 870         int pollnum = MAX_POLL_TRIES;
 871
 872         if (!card || !card->func) {
 873                 BT_ERR("card or function is NULL!");
 874                 return -EINVAL;
 875         }
 876         sdio_claim_host(card->func);
 877
 878         if (!btmrvl_sdio_verify_fw_download(card, 1)) {
 879                 BT_DBG("Firmware already downloaded!");
 880                 goto done;
 881         }
 882
 883         /* Check if other function driver is downloading the firmware */
 884         fws0 = sdio_readb(card->func, card->reg->card_fw_status0, &ret);
 885         if (ret) {
 886                 BT_ERR("Failed to read FW downloading status!");
 887                 ret = -EIO;
 888                 goto done;
 889         }
 890         if (fws0) {
 891                 BT_DBG("BT not the winner (%#x). Skip FW downloading", fws0);
 892
 893                 /* Give other function more time to download the firmware */
 894                 pollnum *= 10;
 895         } else {
 896                 if (card->helper) {
 897                         ret = btmrvl_sdio_download_helper(card);
 898                         if (ret) {
 899                                 BT_ERR("Failed to download helper!");
 900                                 ret = -EIO;
 901                                 goto done;
 902                         }
 903                 }
 904
 905                 if (btmrvl_sdio_download_fw_w_helper(card)) {
 906                         BT_ERR("Failed to download firmware!");
 907                         ret = -EIO;
 908                         goto done;
 909                 }
 910         }
 911
 912         if (btmrvl_sdio_verify_fw_download(card, pollnum)) {
 913                 BT_ERR("FW failed to be active in time!");
 914                 ret = -ETIMEDOUT;
 915                 goto done;
 916         }
 917
 918 done:
 919         sdio_release_host(card->func);
 920
 921         return ret;
 922 }
 923
 924 static int btmrvl_sdio_wakeup_fw(struct btmrvl_private *priv)
 925 {
 926         struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
 927         int ret = 0;
 928
 929         if (!card || !card->func) {
 930                 BT_ERR("card or function is NULL!");
 931                 return -EINVAL;
 932         }
 933
 934         sdio_claim_host(card->func);
 935
 936         sdio_writeb(card->func, HOST_POWER_UP, card->reg->cfg, &ret);
 937
 938         sdio_release_host(card->func);
 939
 940         BT_DBG("wake up firmware");
 941
 942         return ret;
 943 }
 944
 945 static int btmrvl_sdio_probe(struct sdio_func *func,
 946                                         const struct sdio_device_id *id)
 947 {
 948         int ret = 0;
 949         struct btmrvl_private *priv = NULL;
 950         struct btmrvl_sdio_card *card = NULL;
 951
 952         BT_INFO("vendor=0x%x, device=0x%x, class=%d, fn=%d",
 953                         id->vendor, id->device, id->class, func->num);
 954
 955         card = kzalloc(sizeof(*card), GFP_KERNEL);
 956         if (!card) {
 957                 ret = -ENOMEM;
 958                 goto done;
 959         }
 960
 961         card->func = func;
 962
 963         if (id->driver_data) {
 964                 struct btmrvl_sdio_device *data = (void *) id->driver_data;
 965                 card->helper = data->helper;
 966                 card->firmware = data->firmware;
 967                 card->reg = data->reg;
 968                 card->sd_blksz_fw_dl = data->sd_blksz_fw_dl;
 969         }
 970
 971         if (btmrvl_sdio_register_dev(card) < 0) {
 972                 BT_ERR("Failed to register BT device!");
 973                 ret = -ENODEV;
 974                 goto free_card;
 975         }
 976
 977         /* Disable the interrupts on the card */
 978         btmrvl_sdio_disable_host_int(card);
 979
 980         if (btmrvl_sdio_download_fw(card)) {
 981                 BT_ERR("Downloading firmware failed!");
 982                 ret = -ENODEV;
 983                 goto unreg_dev;
 984         }
 985
 986         msleep(100);
 987
 988         btmrvl_sdio_enable_host_int(card);
 989
 990         priv = btmrvl_add_card(card);
 991         if (!priv) {
 992                 BT_ERR("Initializing card failed!");
 993                 ret = -ENODEV;
 994                 goto disable_host_int;
 995         }
 996
 997         card->priv = priv;
 998
 999         /* Initialize the interface specific function pointers */
1000         priv->hw_host_to_card = btmrvl_sdio_host_to_card;
1001         priv->hw_wakeup_firmware = btmrvl_sdio_wakeup_fw;
1002         priv->hw_process_int_status = btmrvl_sdio_process_int_status;
1003
1004         if (btmrvl_register_hdev(priv)) {
1005                 BT_ERR("Register hdev failed!");
1006                 ret = -ENODEV;
1007                 goto disable_host_int;
1008         }
1009
1010         priv->btmrvl_dev.psmode = 1;
1011         btmrvl_enable_ps(priv);
1012
1013         priv->btmrvl_dev.gpio_gap = 0xffff;
1014         btmrvl_send_hscfg_cmd(priv);
1015
1016         return 0;
1017
1018 disable_host_int:
1019         btmrvl_sdio_disable_host_int(card);
1020 unreg_dev:
1021         btmrvl_sdio_unregister_dev(card);
1022 free_card:
1023         kfree(card);
1024 done:
1025         return ret;
1026 }
1027
1028 static void btmrvl_sdio_remove(struct sdio_func *func)
1029 {
1030         struct btmrvl_sdio_card *card;
1031
1032         if (func) {
1033                 card = sdio_get_drvdata(func);
1034                 if (card) {
1035                         /* Send SHUTDOWN command & disable interrupt
1036                          * if user removes the module.
1037                          */
1038                         if (user_rmmod) {
1039                                 btmrvl_send_module_cfg_cmd(card->priv,
1040                                                         MODULE_SHUTDOWN_REQ);
1041                                 btmrvl_sdio_disable_host_int(card);
1042                         }
1043                         BT_DBG("unregester dev");
1044                         btmrvl_sdio_unregister_dev(card);
1045                         btmrvl_remove_card(card->priv);
1046                         kfree(card);
1047                 }
1048         }
1049 }
1050
1051 static int btmrvl_sdio_suspend(struct device *dev)
1052 {
1053         struct sdio_func *func = dev_to_sdio_func(dev);
1054         struct btmrvl_sdio_card *card;
1055         struct btmrvl_private *priv;
1056         mmc_pm_flag_t pm_flags;
1057         struct hci_dev *hcidev;
1058
1059         if (func) {
1060                 pm_flags = sdio_get_host_pm_caps(func);
1061                 BT_DBG("%s: suspend: PM flags = 0x%x", sdio_func_id(func),
1062                        pm_flags);
1063                 if (!(pm_flags & MMC_PM_KEEP_POWER)) {
1064                         BT_ERR("%s: cannot remain alive while suspended",
1065                                sdio_func_id(func));
1066                         return -ENOSYS;
1067                 }
1068                 card = sdio_get_drvdata(func);
1069                 if (!card || !card->priv) {
1070                         BT_ERR("card or priv structure is not valid");
1071                         return 0;
1072                 }
1073         } else {
1074                 BT_ERR("sdio_func is not specified");
1075                 return 0;
1076         }
1077
1078         priv = card->priv;
1079
1080         if (priv->adapter->hs_state != HS_ACTIVATED) {
1081                 if (btmrvl_enable_hs(priv)) {
1082                         BT_ERR("HS not actived, suspend failed!");
1083                         return -EBUSY;
1084                 }
1085         }
1086         hcidev = priv->btmrvl_dev.hcidev;
1087         BT_DBG("%s: SDIO suspend", hcidev->name);
1088         hci_suspend_dev(hcidev);
1089         skb_queue_purge(&priv->adapter->tx_queue);
1090
1091         priv->adapter->is_suspended = true;
1092
1093         /* We will keep the power when hs enabled successfully */
1094         if (priv->adapter->hs_state == HS_ACTIVATED) {
1095                 BT_DBG("suspend with MMC_PM_KEEP_POWER");
1096                 return sdio_set_host_pm_flags(func, MMC_PM_KEEP_POWER);
1097         } else {
1098                 BT_DBG("suspend without MMC_PM_KEEP_POWER");
1099                 return 0;
1100         }
1101 }
1102
1103 static int btmrvl_sdio_resume(struct device *dev)
1104 {
1105         struct sdio_func *func = dev_to_sdio_func(dev);
1106         struct btmrvl_sdio_card *card;
1107         struct btmrvl_private *priv;
1108         mmc_pm_flag_t pm_flags;
1109         struct hci_dev *hcidev;
1110
1111         if (func) {
1112                 pm_flags = sdio_get_host_pm_caps(func);
1113                 BT_DBG("%s: resume: PM flags = 0x%x", sdio_func_id(func),
1114                        pm_flags);
1115                 card = sdio_get_drvdata(func);
1116                 if (!card || !card->priv) {
1117                         BT_ERR("card or priv structure is not valid");
1118                         return 0;
1119                 }
1120         } else {
1121                 BT_ERR("sdio_func is not specified");
1122                 return 0;
1123         }
1124         priv = card->priv;
1125
1126         if (!priv->adapter->is_suspended) {
1127                 BT_DBG("device already resumed");
1128                 return 0;
1129         }
1130
1131         priv->adapter->is_suspended = false;
1132         hcidev = priv->btmrvl_dev.hcidev;
1133         BT_DBG("%s: SDIO resume", hcidev->name);
1134         hci_resume_dev(hcidev);
1135         priv->hw_wakeup_firmware(priv);
1136         priv->adapter->hs_state = HS_DEACTIVATED;
1137         BT_DBG("%s: HS DEACTIVATED in resume!", hcidev->name);
1138
1139         return 0;
1140 }
1141
1142 static const struct dev_pm_ops btmrvl_sdio_pm_ops = {
1143         .suspend        = btmrvl_sdio_suspend,
1144         .resume         = btmrvl_sdio_resume,
1145 };
1146
1147 static struct sdio_driver bt_mrvl_sdio = {
1148         .name           = "btmrvl_sdio",
1149         .id_table       = btmrvl_sdio_ids,
1150         .probe          = btmrvl_sdio_probe,
1151         .remove         = btmrvl_sdio_remove,
1152         .drv = {
1153                 .owner = THIS_MODULE,
1154                 .pm = &btmrvl_sdio_pm_ops,
1155         }
1156 };
1157
1158 static int __init btmrvl_sdio_init_module(void)
1159 {
1160         if (sdio_register_driver(&bt_mrvl_sdio) != 0) {
1161                 BT_ERR("SDIO Driver Registration Failed");
1162                 return -ENODEV;
1163         }
1164
1165         /* Clear the flag in case user removes the card. */
1166         user_rmmod = 0;
1167
1168         return 0;
1169 }
1170
1171 static void __exit btmrvl_sdio_exit_module(void)
1172 {
1173         /* Set the flag as user is removing this module. */
1174         user_rmmod = 1;
1175
1176         sdio_unregister_driver(&bt_mrvl_sdio);
1177 }
1178
1179 module_init(btmrvl_sdio_init_module);
1180 module_exit(btmrvl_sdio_exit_module);
1181
1182 MODULE_AUTHOR("Marvell International Ltd.");
1183 MODULE_DESCRIPTION("Marvell BT-over-SDIO driver ver " VERSION);
1184 MODULE_VERSION(VERSION);
1185 MODULE_LICENSE("GPL v2");
1186 MODULE_FIRMWARE("sd8688_helper.bin");
1187 MODULE_FIRMWARE("sd8688.bin");
1188 MODULE_FIRMWARE("mrvl/sd8787_uapsta.bin");
1189 MODULE_FIRMWARE("mrvl/sd8797_uapsta.bin");