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                 } else {
 113                         err_ret = -ENOENT;
 114                 }
 115         } else if ((regaddr == SDIO_CCCR_ABORT) ||
 116                    (regaddr == SDIO_CCCR_IENx)) {
 117                 sdfunc = kmemdup(sdiodev->func[0], sizeof(struct sdio_func),
 118                                  GFP_KERNEL);
 119                 if (!sdfunc)
 120                         return -ENOMEM;
 121                 sdfunc->num = 0;
 122                 sdio_writeb(sdfunc, *byte, regaddr, &err_ret);
 123                 kfree(sdfunc);
 124         } else if (regaddr < 0xF0) {
 125                 brcmf_err("F0 Wr:0x%02x: write disallowed\n", regaddr);
 126                 err_ret = -EPERM;
 127         } else {
 128                 sdio_f0_writeb(sdfunc, *byte, regaddr, &err_ret);
 129         }
 130
 131         return err_ret;
 132 }
 133
 134 int brcmf_sdioh_request_byte(struct brcmf_sdio_dev *sdiodev, uint rw, uint func,
 135                              uint regaddr, u8 *byte)
 136 {
 137         int err_ret;
 138
 139         brcmf_dbg(SDIO, "rw=%d, func=%d, addr=0x%05x\n", rw, func, regaddr);
 140
 141         brcmf_pm_resume_wait(sdiodev, &sdiodev->request_byte_wait);
 142         if (brcmf_pm_resume_error(sdiodev))
 143                 return -EIO;
 144
 145         if (rw && func == 0) {
 146                 /* handle F0 separately */
 147                 err_ret = brcmf_sdioh_f0_write_byte(sdiodev, regaddr, byte);
 148         } else {
 149                 if (rw) /* CMD52 Write */
 150                         sdio_writeb(sdiodev->func[func], *byte, regaddr,
 151                                     &err_ret);
 152                 else if (func == 0) {
 153                         *byte = sdio_f0_readb(sdiodev->func[func], regaddr,
 154                                               &err_ret);
 155                 } else {
 156                         *byte = sdio_readb(sdiodev->func[func], regaddr,
 157                                            &err_ret);
 158                 }
 159         }
 160
 161         if (err_ret) {
 162                 /*
 163                  * SleepCSR register access can fail when
 164                  * waking up the device so reduce this noise
 165                  * in the logs.
 166                  */
 167                 if (regaddr != SBSDIO_FUNC1_SLEEPCSR)
 168                         brcmf_err("Failed to %s byte F%d:@0x%05x=%02x, Err: %d\n",
 169                                   rw ? "write" : "read", func, regaddr, *byte,
 170                                   err_ret);
 171                 else
 172                         brcmf_dbg(SDIO, "Failed to %s byte F%d:@0x%05x=%02x, Err: %d\n",
 173                                   rw ? "write" : "read", func, regaddr, *byte,
 174                                   err_ret);
 175         }
 176         return err_ret;
 177 }
 178
 179 int brcmf_sdioh_request_word(struct brcmf_sdio_dev *sdiodev,
 180                              uint rw, uint func, uint addr, u32 *word,
 181                              uint nbytes)
 182 {
 183         int err_ret = -EIO;
 184
 185         if (func == 0) {
 186                 brcmf_err("Only CMD52 allowed to F0\n");
 187                 return -EINVAL;
 188         }
 189
 190         brcmf_dbg(SDIO, "rw=%d, func=%d, addr=0x%05x, nbytes=%d\n",
 191                   rw, func, addr, nbytes);
 192
 193         brcmf_pm_resume_wait(sdiodev, &sdiodev->request_word_wait);
 194         if (brcmf_pm_resume_error(sdiodev))
 195                 return -EIO;
 196
 197         if (rw) {               /* CMD52 Write */
 198                 if (nbytes == 4)
 199                         sdio_writel(sdiodev->func[func], *word, addr,
 200                                     &err_ret);
 201                 else if (nbytes == 2)
 202                         sdio_writew(sdiodev->func[func], (*word & 0xFFFF),
 203                                     addr, &err_ret);
 204                 else
 205                         brcmf_err("Invalid nbytes: %d\n", nbytes);
 206         } else {                /* CMD52 Read */
 207                 if (nbytes == 4)
 208                         *word = sdio_readl(sdiodev->func[func], addr, &err_ret);
 209                 else if (nbytes == 2)
 210                         *word = sdio_readw(sdiodev->func[func], addr,
 211                                            &err_ret) & 0xFFFF;
 212                 else
 213                         brcmf_err("Invalid nbytes: %d\n", nbytes);
 214         }
 215
 216         if (err_ret)
 217                 brcmf_err("Failed to %s word, Err: 0x%08x\n",
 218                           rw ? "write" : "read", err_ret);
 219
 220         return err_ret;
 221 }
 222
 223 static int brcmf_sdioh_get_cisaddr(struct brcmf_sdio_dev *sdiodev, u32 regaddr)
 224 {
 225         /* read 24 bits and return valid 17 bit addr */
 226         int i, ret;
 227         u32 scratch, regdata;
 228         __le32 scratch_le;
 229         u8 *ptr = (u8 *)&scratch_le;
 230
 231         for (i = 0; i < 3; i++) {
 232                 regdata = brcmf_sdio_regrl(sdiodev, regaddr, &ret);
 233                 if (ret != 0)
 234                         brcmf_err("Can't read!\n");
 235
 236                 *ptr++ = (u8) regdata;
 237                 regaddr++;
 238         }
 239
 240         /* Only the lower 17-bits are valid */
 241         scratch = le32_to_cpu(scratch_le);
 242         scratch &= 0x0001FFFF;
 243         return scratch;
 244 }
 245
 246 static int brcmf_sdioh_enablefuncs(struct brcmf_sdio_dev *sdiodev)
 247 {
 248         int err_ret;
 249         u32 fbraddr;
 250         u8 func;
 251
 252         brcmf_dbg(SDIO, "\n");
 253
 254         /* Get the Card's common CIS address */
 255         sdiodev->func_cis_ptr[0] = brcmf_sdioh_get_cisaddr(sdiodev,
 256                                                            SDIO_CCCR_CIS);
 257         brcmf_dbg(SDIO, "Card's Common CIS Ptr = 0x%x\n",
 258                   sdiodev->func_cis_ptr[0]);
 259
 260         /* Get the Card's function CIS (for each function) */
 261         for (fbraddr = SDIO_FBR_BASE(1), func = 1;
 262              func <= sdiodev->num_funcs; func++, fbraddr += SDIOD_FBR_SIZE) {
 263                 sdiodev->func_cis_ptr[func] =
 264                     brcmf_sdioh_get_cisaddr(sdiodev, SDIO_FBR_CIS + fbraddr);
 265                 brcmf_dbg(SDIO, "Function %d CIS Ptr = 0x%x\n",
 266                           func, sdiodev->func_cis_ptr[func]);
 267         }
 268
 269         /* Enable Function 1 */
 270         err_ret = sdio_enable_func(sdiodev->func[1]);
 271         if (err_ret)
 272                 brcmf_err("Failed to enable F1 Err: 0x%08x\n", err_ret);
 273
 274         return false;
 275 }
 276
 277 /*
 278  *      Public entry points & extern's
 279  */
 280 int brcmf_sdioh_attach(struct brcmf_sdio_dev *sdiodev)
 281 {
 282         int err_ret = 0;
 283         struct mmc_host *host;
 284         struct sdio_func *func;
 285         uint max_blocks;
 286
 287         brcmf_dbg(SDIO, "\n");
 288
 289         sdiodev->num_funcs = 2;
 290
 291         sdio_claim_host(sdiodev->func[1]);
 292
 293         err_ret = sdio_set_block_size(sdiodev->func[1], SDIO_FUNC1_BLOCKSIZE);
 294         if (err_ret) {
 295                 brcmf_err("Failed to set F1 blocksize\n");
 296                 goto out;
 297         }
 298
 299         err_ret = sdio_set_block_size(sdiodev->func[2], SDIO_FUNC2_BLOCKSIZE);
 300         if (err_ret) {
 301                 brcmf_err("Failed to set F2 blocksize\n");
 302                 goto out;
 303         }
 304
 305         brcmf_sdioh_enablefuncs(sdiodev);
 306
 307         /*
 308          * determine host related variables after brcmf_sdio_probe()
 309          * as func->cur_blksize is properly set and F2 init has been
 310          * completed successfully.
 311          */
 312         func = sdiodev->func[2];
 313         host = func->card->host;
 314         sdiodev->sg_support = host->max_segs > 1;
 315         max_blocks = min_t(uint, host->max_blk_count, 511u);
 316         sdiodev->max_request_size = min_t(uint, host->max_req_size,
 317                                           max_blocks * func->cur_blksize);
 318         sdiodev->max_segment_count = min_t(uint, host->max_segs,
 319                                            SG_MAX_SINGLE_ALLOC);
 320         sdiodev->max_segment_size = host->max_seg_size;
 321 out:
 322         sdio_release_host(sdiodev->func[1]);
 323         brcmf_dbg(SDIO, "Done\n");
 324         return err_ret;
 325 }
 326
 327 void brcmf_sdioh_detach(struct brcmf_sdio_dev *sdiodev)
 328 {
 329         brcmf_dbg(SDIO, "\n");
 330
 331         /* Disable Function 2 */
 332         sdio_claim_host(sdiodev->func[2]);
 333         sdio_disable_func(sdiodev->func[2]);
 334         sdio_release_host(sdiodev->func[2]);
 335
 336         /* Disable Function 1 */
 337         sdio_claim_host(sdiodev->func[1]);
 338         sdio_disable_func(sdiodev->func[1]);
 339         sdio_release_host(sdiodev->func[1]);
 340
 341 }
 342
 343 static int brcmf_ops_sdio_probe(struct sdio_func *func,
 344                                 const struct sdio_device_id *id)
 345 {
 346         int err;
 347         struct brcmf_sdio_dev *sdiodev;
 348         struct brcmf_bus *bus_if;
 349
 350         brcmf_dbg(SDIO, "Enter\n");
 351         brcmf_dbg(SDIO, "Class=%x\n", func->class);
 352         brcmf_dbg(SDIO, "sdio vendor ID: 0x%04x\n", func->vendor);
 353         brcmf_dbg(SDIO, "sdio device ID: 0x%04x\n", func->device);
 354         brcmf_dbg(SDIO, "Function#: %d\n", func->num);
 355
 356         /* Consume func num 1 but dont do anything with it. */
 357         if (func->num == 1)
 358                 return 0;
 359
 360         /* Ignore anything but func 2 */
 361         if (func->num != 2)
 362                 return -ENODEV;
 363
 364         bus_if = kzalloc(sizeof(struct brcmf_bus), GFP_KERNEL);
 365         if (!bus_if)
 366                 return -ENOMEM;
 367         sdiodev = kzalloc(sizeof(struct brcmf_sdio_dev), GFP_KERNEL);
 368         if (!sdiodev) {
 369                 kfree(bus_if);
 370                 return -ENOMEM;
 371         }
 372
 373         sdiodev->func[0] = func->card->sdio_func[0];
 374         sdiodev->func[1] = func->card->sdio_func[0];
 375         sdiodev->func[2] = func;
 376
 377         sdiodev->bus_if = bus_if;
 378         bus_if->bus_priv.sdio = sdiodev;
 379         dev_set_drvdata(&func->dev, bus_if);
 380         dev_set_drvdata(&sdiodev->func[1]->dev, bus_if);
 381         sdiodev->dev = &sdiodev->func[1]->dev;
 382         sdiodev->pdata = brcmfmac_sdio_pdata;
 383
 384         atomic_set(&sdiodev->suspend, false);
 385         init_waitqueue_head(&sdiodev->request_byte_wait);
 386         init_waitqueue_head(&sdiodev->request_word_wait);
 387         init_waitqueue_head(&sdiodev->request_buffer_wait);
 388
 389         brcmf_dbg(SDIO, "F2 found, calling brcmf_sdio_probe...\n");
 390         err = brcmf_sdio_probe(sdiodev);
 391         if (err) {
 392                 brcmf_err("F2 error, probe failed %d...\n", err);
 393                 goto fail;
 394         }
 395
 396         brcmf_dbg(SDIO, "F2 init completed...\n");
 397         return 0;
 398
 399 fail:
 400         dev_set_drvdata(&func->dev, NULL);
 401         dev_set_drvdata(&sdiodev->func[1]->dev, NULL);
 402         kfree(sdiodev);
 403         kfree(bus_if);
 404         return err;
 405 }
 406
 407 static void brcmf_ops_sdio_remove(struct sdio_func *func)
 408 {
 409         struct brcmf_bus *bus_if;
 410         struct brcmf_sdio_dev *sdiodev;
 411
 412         brcmf_dbg(SDIO, "Enter\n");
 413         brcmf_dbg(SDIO, "sdio vendor ID: 0x%04x\n", func->vendor);
 414         brcmf_dbg(SDIO, "sdio device ID: 0x%04x\n", func->device);
 415         brcmf_dbg(SDIO, "Function: %d\n", func->num);
 416
 417         if (func->num != 1 && func->num != 2)
 418                 return;
 419
 420         bus_if = dev_get_drvdata(&func->dev);
 421         if (bus_if) {
 422                 sdiodev = bus_if->bus_priv.sdio;
 423                 brcmf_sdio_remove(sdiodev);
 424
 425                 dev_set_drvdata(&sdiodev->func[1]->dev, NULL);
 426                 dev_set_drvdata(&sdiodev->func[2]->dev, NULL);
 427
 428                 kfree(bus_if);
 429                 kfree(sdiodev);
 430         }
 431
 432         brcmf_dbg(SDIO, "Exit\n");
 433 }
 434
 435 #ifdef CONFIG_PM_SLEEP
 436 static int brcmf_sdio_suspend(struct device *dev)
 437 {
 438         mmc_pm_flag_t sdio_flags;
 439         struct brcmf_bus *bus_if = dev_get_drvdata(dev);
 440         struct brcmf_sdio_dev *sdiodev = bus_if->bus_priv.sdio;
 441         int ret = 0;
 442
 443         brcmf_dbg(SDIO, "\n");
 444
 445         atomic_set(&sdiodev->suspend, true);
 446
 447         sdio_flags = sdio_get_host_pm_caps(sdiodev->func[1]);
 448         if (!(sdio_flags & MMC_PM_KEEP_POWER)) {
 449                 brcmf_err("Host can't keep power while suspended\n");
 450                 return -EINVAL;
 451         }
 452
 453         ret = sdio_set_host_pm_flags(sdiodev->func[1], MMC_PM_KEEP_POWER);
 454         if (ret) {
 455                 brcmf_err("Failed to set pm_flags\n");
 456                 return ret;
 457         }
 458
 459         brcmf_sdio_wdtmr_enable(sdiodev, false);
 460
 461         return ret;
 462 }
 463
 464 static int brcmf_sdio_resume(struct device *dev)
 465 {
 466         struct brcmf_bus *bus_if = dev_get_drvdata(dev);
 467         struct brcmf_sdio_dev *sdiodev = bus_if->bus_priv.sdio;
 468
 469         brcmf_sdio_wdtmr_enable(sdiodev, true);
 470         atomic_set(&sdiodev->suspend, false);
 471         return 0;
 472 }
 473
 474 static const struct dev_pm_ops brcmf_sdio_pm_ops = {
 475         .suspend        = brcmf_sdio_suspend,
 476         .resume         = brcmf_sdio_resume,
 477 };
 478 #endif  /* CONFIG_PM_SLEEP */
 479
 480 static struct sdio_driver brcmf_sdmmc_driver = {
 481         .probe = brcmf_ops_sdio_probe,
 482         .remove = brcmf_ops_sdio_remove,
 483         .name = BRCMFMAC_SDIO_PDATA_NAME,
 484         .id_table = brcmf_sdmmc_ids,
 485 #ifdef CONFIG_PM_SLEEP
 486         .drv = {
 487                 .pm = &brcmf_sdio_pm_ops,
 488         },
 489 #endif  /* CONFIG_PM_SLEEP */
 490 };
 491
 492 static int brcmf_sdio_pd_probe(struct platform_device *pdev)
 493 {
 494         brcmf_dbg(SDIO, "Enter\n");
 495
 496         brcmfmac_sdio_pdata = dev_get_platdata(&pdev->dev);
 497
 498         if (brcmfmac_sdio_pdata->power_on)
 499                 brcmfmac_sdio_pdata->power_on();
 500
 501         return 0;
 502 }
 503
 504 static int brcmf_sdio_pd_remove(struct platform_device *pdev)
 505 {
 506         brcmf_dbg(SDIO, "Enter\n");
 507
 508         if (brcmfmac_sdio_pdata->power_off)
 509                 brcmfmac_sdio_pdata->power_off();
 510
 511         sdio_unregister_driver(&brcmf_sdmmc_driver);
 512
 513         return 0;
 514 }
 515
 516 static struct platform_driver brcmf_sdio_pd = {
 517         .remove         = brcmf_sdio_pd_remove,
 518         .driver         = {
 519                 .name   = BRCMFMAC_SDIO_PDATA_NAME,
 520                 .owner  = THIS_MODULE,
 521         }
 522 };
 523
 524 void brcmf_sdio_register(void)
 525 {
 526         int ret;
 527
 528         ret = sdio_register_driver(&brcmf_sdmmc_driver);
 529         if (ret)
 530                 brcmf_err("sdio_register_driver failed: %d\n", ret);
 531 }
 532
 533 void brcmf_sdio_exit(void)
 534 {
 535         brcmf_dbg(SDIO, "Enter\n");
 536
 537         if (brcmfmac_sdio_pdata)
 538                 platform_driver_unregister(&brcmf_sdio_pd);
 539         else
 540                 sdio_unregister_driver(&brcmf_sdmmc_driver);
 541 }
 542
 543 void __init brcmf_sdio_init(void)
 544 {
 545         int ret;
 546
 547         brcmf_dbg(SDIO, "Enter\n");
 548
 549         ret = platform_driver_probe(&brcmf_sdio_pd, brcmf_sdio_pd_probe);
 550         if (ret == -ENODEV)
 551                 brcmf_dbg(SDIO, "No platform data available.\n");
 552 }