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