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