drivers/net/wireless/brcm80211/brcmfmac/bcmsdh_sdmmc.c

   1 /*
   2  * Copyright (c) 2010 Broadcom Corporation
   3  *
   4  * Permission to use, copy, modify, and/or distribute this software for any
   5  * purpose with or without fee is hereby granted, provided that the above
   6  * copyright notice and this permission notice appear in all copies.
   7  *
   8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
  11  * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
  13  * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  14  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15  */
  16
  17 #include <linux/types.h>
  18 #include <linux/netdevice.h>
  19 #include <linux/mmc/sdio.h>
  20 #include <linux/mmc/core.h>
  21 #include <linux/mmc/sdio_func.h>
  22 #include <linux/mmc/sdio_ids.h>
  23 #include <linux/mmc/card.h>
  24 #include <linux/mmc/host.h>
  25 #include <linux/suspend.h>
  26 #include <linux/errno.h>
  27 #include <linux/sched.h>        /* request_irq() */
  28 #include <linux/module.h>
  29 #include <linux/platform_device.h>
  30 #include <linux/platform_data/brcmfmac-sdio.h>
  31 #include <net/cfg80211.h>
  32
  33 #include <defs.h>
  34 #include <brcm_hw_ids.h>
  35 #include <brcmu_utils.h>
  36 #include <brcmu_wifi.h>
  37 #include "sdio_host.h"
  38 #include "sdio_chip.h"
  39 #include "dhd_dbg.h"
  40 #include "dhd_bus.h"
  41
  42 #define SDIO_VENDOR_ID_BROADCOM         0x02d0
  43
  44 #define DMA_ALIGN_MASK  0x03
  45
  46 #define SDIO_FUNC1_BLOCKSIZE            64
  47 #define SDIO_FUNC2_BLOCKSIZE            512
  48
  49 /* devices we support, null terminated */
  50 static const struct sdio_device_id brcmf_sdmmc_ids[] = {
  51         {SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM, SDIO_DEVICE_ID_BROADCOM_43143)},
  52         {SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM, SDIO_DEVICE_ID_BROADCOM_43241)},
  53         {SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM, SDIO_DEVICE_ID_BROADCOM_4329)},
  54         {SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM, SDIO_DEVICE_ID_BROADCOM_4330)},
  55         {SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM, SDIO_DEVICE_ID_BROADCOM_4334)},
  56         {SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM,
  57                      SDIO_DEVICE_ID_BROADCOM_4335_4339)},
  58         { /* end: all zeroes */ },
  59 };
  60 MODULE_DEVICE_TABLE(sdio, brcmf_sdmmc_ids);
  61
  62 static struct brcmfmac_sdio_platform_data *brcmfmac_sdio_pdata;
  63
  64
  65 bool
  66 brcmf_pm_resume_error(struct brcmf_sdio_dev *sdiodev)
  67 {
  68         bool is_err = false;
  69 #ifdef CONFIG_PM_SLEEP
  70         is_err = atomic_read(&sdiodev->suspend);
  71 #endif
  72         return is_err;
  73 }
  74
  75 void
  76 brcmf_pm_resume_wait(struct brcmf_sdio_dev *sdiodev, wait_queue_head_t *wq)
  77 {
  78 #ifdef CONFIG_PM_SLEEP
  79         int retry = 0;
  80         while (atomic_read(&sdiodev->suspend) && retry++ != 30)
  81                 wait_event_timeout(*wq, false, HZ/100);
  82 #endif
  83 }
  84
  85 static inline int brcmf_sdioh_f0_write_byte(struct brcmf_sdio_dev *sdiodev,
  86                                             uint regaddr, u8 *byte)
  87 {
  88         struct sdio_func *sdfunc = sdiodev->func[0];
  89         int err_ret;
  90
  91         /*
  92          * Can only directly write to some F0 registers.
  93          * Handle F2 enable/disable and Abort command
  94          * as a special case.
  95          */
  96         if (regaddr == SDIO_CCCR_IOEx) {
  97                 sdfunc = sdiodev->func[2];
  98                 if (sdfunc) {
  99                         if (*byte & SDIO_FUNC_ENABLE_2) {
 100                                 /* Enable Function 2 */
 101                                 err_ret = sdio_enable_func(sdfunc);
 102                                 if (err_ret)
 103                                         brcmf_err("enable F2 failed:%d\n",
 104                                                   err_ret);
 105                         } else {
 106                                 /* Disable Function 2 */
 107                                 err_ret = sdio_disable_func(sdfunc);
 108                                 if (err_ret)
 109                                         brcmf_err("Disable F2 failed:%d\n",
 110                                                   err_ret);
 111                         }
 112                 }
 113         } else if ((regaddr == SDIO_CCCR_ABORT) ||
 114                    (regaddr == SDIO_CCCR_IENx)) {
 115                 sdfunc = kmemdup(sdiodev->func[0], sizeof(struct sdio_func),
 116                                  GFP_KERNEL);
 117                 if (!sdfunc)
 118                         return -ENOMEM;
 119                 sdfunc->num = 0;
 120                 sdio_writeb(sdfunc, *byte, regaddr, &err_ret);
 121                 kfree(sdfunc);
 122         } else if (regaddr < 0xF0) {
 123                 brcmf_err("F0 Wr:0x%02x: write disallowed\n", regaddr);
 124                 err_ret = -EPERM;
 125         } else {
 126                 sdio_f0_writeb(sdfunc, *byte, regaddr, &err_ret);
 127         }
 128
 129         return err_ret;
 130 }
 131
 132 int brcmf_sdioh_request_byte(struct brcmf_sdio_dev *sdiodev, uint rw, uint func,
 133                              uint regaddr, u8 *byte)
 134 {
 135         int err_ret;
 136
 137         brcmf_dbg(SDIO, "rw=%d, func=%d, addr=0x%05x\n", rw, func, regaddr);
 138
 139         brcmf_pm_resume_wait(sdiodev, &sdiodev->request_byte_wait);
 140         if (brcmf_pm_resume_error(sdiodev))
 141                 return -EIO;
 142
 143         if (rw && func == 0) {
 144                 /* handle F0 separately */
 145                 err_ret = brcmf_sdioh_f0_write_byte(sdiodev, regaddr, byte);
 146         } else {
 147                 if (rw) /* CMD52 Write */
 148                         sdio_writeb(sdiodev->func[func], *byte, regaddr,
 149                                     &err_ret);
 150                 else if (func == 0) {
 151                         *byte = sdio_f0_readb(sdiodev->func[func], regaddr,
 152                                               &err_ret);
 153                 } else {
 154                         *byte = sdio_readb(sdiodev->func[func], regaddr,
 155                                            &err_ret);
 156                 }
 157         }
 158
 159         if (err_ret) {
 160                 /*
 161                  * SleepCSR register access can fail when
 162                  * waking up the device so reduce this noise
 163                  * in the logs.
 164                  */
 165                 if (regaddr != SBSDIO_FUNC1_SLEEPCSR)
 166                         brcmf_err("Failed to %s byte F%d:@0x%05x=%02x, Err: %d\n",
 167                                   rw ? "write" : "read", func, regaddr, *byte,
 168                                   err_ret);
 169                 else
 170                         brcmf_dbg(SDIO, "Failed to %s byte F%d:@0x%05x=%02x, Err: %d\n",
 171                                   rw ? "write" : "read", func, regaddr, *byte,
 172                                   err_ret);
 173         }
 174         return err_ret;
 175 }
 176
 177 int brcmf_sdioh_request_word(struct brcmf_sdio_dev *sdiodev,
 178                              uint rw, uint func, uint addr, u32 *word,
 179                              uint nbytes)
 180 {
 181         int err_ret = -EIO;
 182
 183         if (func == 0) {
 184                 brcmf_err("Only CMD52 allowed to F0\n");
 185                 return -EINVAL;
 186         }
 187
 188         brcmf_dbg(SDIO, "rw=%d, func=%d, addr=0x%05x, nbytes=%d\n",
 189                   rw, func, addr, nbytes);
 190
 191         brcmf_pm_resume_wait(sdiodev, &sdiodev->request_word_wait);
 192         if (brcmf_pm_resume_error(sdiodev))
 193                 return -EIO;
 194
 195         if (rw) {               /* CMD52 Write */
 196                 if (nbytes == 4)
 197                         sdio_writel(sdiodev->func[func], *word, addr,
 198                                     &err_ret);
 199                 else if (nbytes == 2)
 200                         sdio_writew(sdiodev->func[func], (*word & 0xFFFF),
 201                                     addr, &err_ret);
 202                 else
 203                         brcmf_err("Invalid nbytes: %d\n", nbytes);
 204         } else {                /* CMD52 Read */
 205                 if (nbytes == 4)
 206                         *word = sdio_readl(sdiodev->func[func], addr, &err_ret);
 207                 else if (nbytes == 2)
 208                         *word = sdio_readw(sdiodev->func[func], addr,
 209                                            &err_ret) & 0xFFFF;
 210                 else
 211                         brcmf_err("Invalid nbytes: %d\n", nbytes);
 212         }
 213
 214         if (err_ret)
 215                 brcmf_err("Failed to %s word, Err: 0x%08x\n",
 216                           rw ? "write" : "read", err_ret);
 217
 218         return err_ret;
 219 }
 220
 221 static int brcmf_sdioh_get_cisaddr(struct brcmf_sdio_dev *sdiodev, u32 regaddr)
 222 {
 223         /* read 24 bits and return valid 17 bit addr */
 224         int i, ret;
 225         u32 scratch, regdata;
 226         __le32 scratch_le;
 227         u8 *ptr = (u8 *)&scratch_le;
 228
 229         for (i = 0; i < 3; i++) {
 230                 regdata = brcmf_sdio_regrl(sdiodev, regaddr, &ret);
 231                 if (ret != 0)
 232                         brcmf_err("Can't read!\n");
 233
 234                 *ptr++ = (u8) regdata;
 235                 regaddr++;
 236         }
 237
 238         /* Only the lower 17-bits are valid */
 239         scratch = le32_to_cpu(scratch_le);
 240         scratch &= 0x0001FFFF;
 241         return scratch;
 242 }
 243
 244 static int brcmf_sdioh_enablefuncs(struct brcmf_sdio_dev *sdiodev)
 245 {
 246         int err_ret;
 247         u32 fbraddr;
 248         u8 func;
 249
 250         brcmf_dbg(SDIO, "\n");
 251
 252         /* Get the Card's common CIS address */
 253         sdiodev->func_cis_ptr[0] = brcmf_sdioh_get_cisaddr(sdiodev,
 254                                                            SDIO_CCCR_CIS);
 255         brcmf_dbg(SDIO, "Card's Common CIS Ptr = 0x%x\n",
 256                   sdiodev->func_cis_ptr[0]);
 257
 258         /* Get the Card's function CIS (for each function) */
 259         for (fbraddr = SDIO_FBR_BASE(1), func = 1;
 260              func <= sdiodev->num_funcs; func++, fbraddr += SDIOD_FBR_SIZE) {
 261                 sdiodev->func_cis_ptr[func] =
 262                     brcmf_sdioh_get_cisaddr(sdiodev, SDIO_FBR_CIS + fbraddr);
 263                 brcmf_dbg(SDIO, "Function %d CIS Ptr = 0x%x\n",
 264                           func, sdiodev->func_cis_ptr[func]);
 265         }
 266
 267         /* Enable Function 1 */
 268         err_ret = sdio_enable_func(sdiodev->func[1]);
 269         if (err_ret)
 270                 brcmf_err("Failed to enable F1 Err: 0x%08x\n", err_ret);
 271
 272         return false;
 273 }
 274
 275 /*
 276  *      Public entry points & extern's
 277  */
 278 int brcmf_sdioh_attach(struct brcmf_sdio_dev *sdiodev)
 279 {
 280         int err_ret = 0;
 281
 282         brcmf_dbg(SDIO, "\n");
 283
 284         sdiodev->num_funcs = 2;
 285
 286         sdio_claim_host(sdiodev->func[1]);
 287
 288         err_ret = sdio_set_block_size(sdiodev->func[1], SDIO_FUNC1_BLOCKSIZE);
 289         if (err_ret) {
 290                 brcmf_err("Failed to set F1 blocksize\n");
 291                 goto out;
 292         }
 293
 294         err_ret = sdio_set_block_size(sdiodev->func[2], SDIO_FUNC2_BLOCKSIZE);
 295         if (err_ret) {
 296                 brcmf_err("Failed to set F2 blocksize\n");
 297                 goto out;
 298         }
 299
 300         brcmf_sdioh_enablefuncs(sdiodev);
 301
 302 out:
 303         sdio_release_host(sdiodev->func[1]);
 304         brcmf_dbg(SDIO, "Done\n");
 305         return err_ret;
 306 }
 307
 308 void brcmf_sdioh_detach(struct brcmf_sdio_dev *sdiodev)
 309 {
 310         brcmf_dbg(SDIO, "\n");
 311
 312         /* Disable Function 2 */
 313         sdio_claim_host(sdiodev->func[2]);
 314         sdio_disable_func(sdiodev->func[2]);
 315         sdio_release_host(sdiodev->func[2]);
 316
 317         /* Disable Function 1 */
 318         sdio_claim_host(sdiodev->func[1]);
 319         sdio_disable_func(sdiodev->func[1]);
 320         sdio_release_host(sdiodev->func[1]);
 321
 322 }
 323
 324 static int brcmf_ops_sdio_probe(struct sdio_func *func,
 325                                 const struct sdio_device_id *id)
 326 {
 327         int err;
 328         struct brcmf_sdio_dev *sdiodev;
 329         struct brcmf_bus *bus_if;
 330         struct mmc_host *host;
 331         uint max_blocks;
 332
 333         brcmf_dbg(SDIO, "Enter\n");
 334         brcmf_dbg(SDIO, "Class=%x\n", func->class);
 335         brcmf_dbg(SDIO, "sdio vendor ID: 0x%04x\n", func->vendor);
 336         brcmf_dbg(SDIO, "sdio device ID: 0x%04x\n", func->device);
 337         brcmf_dbg(SDIO, "Function#: %d\n", func->num);
 338
 339         /* Consume func num 1 but dont do anything with it. */
 340         if (func->num == 1)
 341                 return 0;
 342
 343         /* Ignore anything but func 2 */
 344         if (func->num != 2)
 345                 return -ENODEV;
 346
 347         bus_if = kzalloc(sizeof(struct brcmf_bus), GFP_KERNEL);
 348         if (!bus_if)
 349                 return -ENOMEM;
 350         sdiodev = kzalloc(sizeof(struct brcmf_sdio_dev), GFP_KERNEL);
 351         if (!sdiodev) {
 352                 kfree(bus_if);
 353                 return -ENOMEM;
 354         }
 355
 356         sdiodev->func[0] = func->card->sdio_func[0];
 357         sdiodev->func[1] = func->card->sdio_func[0];
 358         sdiodev->func[2] = func;
 359
 360         sdiodev->bus_if = bus_if;
 361         bus_if->bus_priv.sdio = sdiodev;
 362         dev_set_drvdata(&func->dev, bus_if);
 363         dev_set_drvdata(&sdiodev->func[1]->dev, bus_if);
 364         sdiodev->dev = &sdiodev->func[1]->dev;
 365         sdiodev->pdata = brcmfmac_sdio_pdata;
 366
 367         atomic_set(&sdiodev->suspend, false);
 368         init_waitqueue_head(&sdiodev->request_byte_wait);
 369         init_waitqueue_head(&sdiodev->request_word_wait);
 370         init_waitqueue_head(&sdiodev->request_buffer_wait);
 371
 372         brcmf_dbg(SDIO, "F2 found, calling brcmf_sdio_probe...\n");
 373         err = brcmf_sdio_probe(sdiodev);
 374         if (err) {
 375                 brcmf_err("F2 error, probe failed %d...\n", err);
 376                 goto fail;
 377         }
 378
 379         /*
 380          * determine host related variables after brcmf_sdio_probe()
 381          * as func->cur_blksize is properly set and F2 init has been
 382          * completed successfully.
 383          */
 384         host = func->card->host;
 385         sdiodev->sg_support = host->max_segs > 1;
 386         max_blocks = min_t(uint, host->max_blk_count, 511u);
 387         sdiodev->max_request_size = min_t(uint, host->max_req_size,
 388                                           max_blocks * func->cur_blksize);
 389         sdiodev->max_segment_count = min_t(uint, host->max_segs,
 390                                            SG_MAX_SINGLE_ALLOC);
 391         sdiodev->max_segment_size = host->max_seg_size;
 392         brcmf_dbg(SDIO, "F2 init completed...\n");
 393         return 0;
 394
 395 fail:
 396         dev_set_drvdata(&func->dev, NULL);
 397         dev_set_drvdata(&sdiodev->func[1]->dev, NULL);
 398         kfree(sdiodev);
 399         kfree(bus_if);
 400         return err;
 401 }
 402
 403 static void brcmf_ops_sdio_remove(struct sdio_func *func)
 404 {
 405         struct brcmf_bus *bus_if;
 406         struct brcmf_sdio_dev *sdiodev;
 407
 408         brcmf_dbg(SDIO, "Enter\n");
 409         brcmf_dbg(SDIO, "sdio vendor ID: 0x%04x\n", func->vendor);
 410         brcmf_dbg(SDIO, "sdio device ID: 0x%04x\n", func->device);
 411         brcmf_dbg(SDIO, "Function: %d\n", func->num);
 412
 413         if (func->num != 1 && func->num != 2)
 414                 return;
 415
 416         bus_if = dev_get_drvdata(&func->dev);
 417         if (bus_if) {
 418                 sdiodev = bus_if->bus_priv.sdio;
 419                 brcmf_sdio_remove(sdiodev);
 420
 421                 dev_set_drvdata(&sdiodev->func[1]->dev, NULL);
 422                 dev_set_drvdata(&sdiodev->func[2]->dev, NULL);
 423
 424                 kfree(bus_if);
 425                 kfree(sdiodev);
 426         }
 427
 428         brcmf_dbg(SDIO, "Exit\n");
 429 }
 430
 431 #ifdef CONFIG_PM_SLEEP
 432 static int brcmf_sdio_suspend(struct device *dev)
 433 {
 434         mmc_pm_flag_t sdio_flags;
 435         struct brcmf_bus *bus_if = dev_get_drvdata(dev);
 436         struct brcmf_sdio_dev *sdiodev = bus_if->bus_priv.sdio;
 437         int ret = 0;
 438
 439         brcmf_dbg(SDIO, "\n");
 440
 441         atomic_set(&sdiodev->suspend, true);
 442
 443         sdio_flags = sdio_get_host_pm_caps(sdiodev->func[1]);
 444         if (!(sdio_flags & MMC_PM_KEEP_POWER)) {
 445                 brcmf_err("Host can't keep power while suspended\n");
 446                 return -EINVAL;
 447         }
 448
 449         ret = sdio_set_host_pm_flags(sdiodev->func[1], MMC_PM_KEEP_POWER);
 450         if (ret) {
 451                 brcmf_err("Failed to set pm_flags\n");
 452                 return ret;
 453         }
 454
 455         brcmf_sdio_wdtmr_enable(sdiodev, false);
 456
 457         return ret;
 458 }
 459
 460 static int brcmf_sdio_resume(struct device *dev)
 461 {
 462         struct brcmf_bus *bus_if = dev_get_drvdata(dev);
 463         struct brcmf_sdio_dev *sdiodev = bus_if->bus_priv.sdio;
 464
 465         brcmf_sdio_wdtmr_enable(sdiodev, true);
 466         atomic_set(&sdiodev->suspend, false);
 467         return 0;
 468 }
 469
 470 static const struct dev_pm_ops brcmf_sdio_pm_ops = {
 471         .suspend        = brcmf_sdio_suspend,
 472         .resume         = brcmf_sdio_resume,
 473 };
 474 #endif  /* CONFIG_PM_SLEEP */
 475
 476 static struct sdio_driver brcmf_sdmmc_driver = {
 477         .probe = brcmf_ops_sdio_probe,
 478         .remove = brcmf_ops_sdio_remove,
 479         .name = BRCMFMAC_SDIO_PDATA_NAME,
 480         .id_table = brcmf_sdmmc_ids,
 481 #ifdef CONFIG_PM_SLEEP
 482         .drv = {
 483                 .pm = &brcmf_sdio_pm_ops,
 484         },
 485 #endif  /* CONFIG_PM_SLEEP */
 486 };
 487
 488 static int brcmf_sdio_pd_probe(struct platform_device *pdev)
 489 {
 490         brcmf_dbg(SDIO, "Enter\n");
 491
 492         brcmfmac_sdio_pdata = dev_get_platdata(&pdev->dev);
 493
 494         if (brcmfmac_sdio_pdata->power_on)
 495                 brcmfmac_sdio_pdata->power_on();
 496
 497         return 0;
 498 }
 499
 500 static int brcmf_sdio_pd_remove(struct platform_device *pdev)
 501 {
 502         brcmf_dbg(SDIO, "Enter\n");
 503
 504         if (brcmfmac_sdio_pdata->power_off)
 505                 brcmfmac_sdio_pdata->power_off();
 506
 507         sdio_unregister_driver(&brcmf_sdmmc_driver);
 508
 509         return 0;
 510 }
 511
 512 static struct platform_driver brcmf_sdio_pd = {
 513         .remove         = brcmf_sdio_pd_remove,
 514         .driver         = {
 515                 .name   = BRCMFMAC_SDIO_PDATA_NAME,
 516                 .owner  = THIS_MODULE,
 517         }
 518 };
 519
 520 void brcmf_sdio_register(void)
 521 {
 522         int ret;
 523
 524         ret = sdio_register_driver(&brcmf_sdmmc_driver);
 525         if (ret)
 526                 brcmf_err("sdio_register_driver failed: %d\n", ret);
 527 }
 528
 529 void brcmf_sdio_exit(void)
 530 {
 531         brcmf_dbg(SDIO, "Enter\n");
 532
 533         if (brcmfmac_sdio_pdata)
 534                 platform_driver_unregister(&brcmf_sdio_pd);
 535         else
 536                 sdio_unregister_driver(&brcmf_sdmmc_driver);
 537 }
 538
 539 void __init brcmf_sdio_init(void)
 540 {
 541         int ret;
 542
 543         brcmf_dbg(SDIO, "Enter\n");
 544
 545         ret = platform_driver_probe(&brcmf_sdio_pd, brcmf_sdio_pd_probe);
 546         if (ret == -ENODEV)
 547                 brcmf_dbg(SDIO, "No platform data available.\n");
 548 }