2 * Copyright (c) 2010 Broadcom Corporation
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.
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.
17 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
19 #include <linux/types.h>
20 #include <linux/netdevice.h>
21 #include <linux/mmc/sdio.h>
22 #include <linux/mmc/core.h>
23 #include <linux/mmc/sdio_func.h>
24 #include <linux/mmc/sdio_ids.h>
25 #include <linux/mmc/card.h>
26 #include <linux/suspend.h>
27 #include <linux/errno.h>
28 #include <linux/sched.h> /* request_irq() */
29 #include <linux/module.h>
30 #include <linux/platform_device.h>
31 #include <net/cfg80211.h>
34 #include <brcm_hw_ids.h>
35 #include <brcmu_utils.h>
36 #include <brcmu_wifi.h>
37 #include "sdio_host.h"
41 #define SDIO_VENDOR_ID_BROADCOM 0x02d0
43 #define DMA_ALIGN_MASK 0x03
45 #define SDIO_DEVICE_ID_BROADCOM_43241 0x4324
46 #define SDIO_DEVICE_ID_BROADCOM_4329 0x4329
47 #define SDIO_DEVICE_ID_BROADCOM_4330 0x4330
48 #define SDIO_DEVICE_ID_BROADCOM_4334 0x4334
50 #define SDIO_FUNC1_BLOCKSIZE 64
51 #define SDIO_FUNC2_BLOCKSIZE 512
53 /* devices we support, null terminated */
54 static const struct sdio_device_id brcmf_sdmmc_ids[] = {
55 {SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM, SDIO_DEVICE_ID_BROADCOM_43241)},
56 {SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM, SDIO_DEVICE_ID_BROADCOM_4329)},
57 {SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM, SDIO_DEVICE_ID_BROADCOM_4330)},
58 {SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM, SDIO_DEVICE_ID_BROADCOM_4334)},
59 { /* end: all zeroes */ },
61 MODULE_DEVICE_TABLE(sdio, brcmf_sdmmc_ids);
63 #ifdef CONFIG_BRCMFMAC_SDIO_OOB
64 static struct list_head oobirq_lh;
65 struct brcmf_sdio_oobirq {
68 struct list_head list;
70 #endif /* CONFIG_BRCMFMAC_SDIO_OOB */
73 brcmf_pm_resume_error(struct brcmf_sdio_dev *sdiodev)
76 #ifdef CONFIG_PM_SLEEP
77 is_err = atomic_read(&sdiodev->suspend);
83 brcmf_pm_resume_wait(struct brcmf_sdio_dev *sdiodev, wait_queue_head_t *wq)
85 #ifdef CONFIG_PM_SLEEP
87 while (atomic_read(&sdiodev->suspend) && retry++ != 30)
88 wait_event_timeout(*wq, false, HZ/100);
92 static inline int brcmf_sdioh_f0_write_byte(struct brcmf_sdio_dev *sdiodev,
93 uint regaddr, u8 *byte)
95 struct sdio_func *sdfunc = sdiodev->func[0];
99 * Can only directly write to some F0 registers.
100 * Handle F2 enable/disable and Abort command
103 if (regaddr == SDIO_CCCR_IOEx) {
104 sdfunc = sdiodev->func[2];
106 if (*byte & SDIO_FUNC_ENABLE_2) {
107 /* Enable Function 2 */
108 err_ret = sdio_enable_func(sdfunc);
110 brcmf_err("enable F2 failed:%d\n",
113 /* Disable Function 2 */
114 err_ret = sdio_disable_func(sdfunc);
116 brcmf_err("Disable F2 failed:%d\n",
120 } else if ((regaddr == SDIO_CCCR_ABORT) ||
121 (regaddr == SDIO_CCCR_IENx)) {
122 sdfunc = kmemdup(sdiodev->func[0], sizeof(struct sdio_func),
127 sdio_writeb(sdfunc, *byte, regaddr, &err_ret);
129 } else if (regaddr < 0xF0) {
130 brcmf_err("F0 Wr:0x%02x: write disallowed\n", regaddr);
133 sdio_f0_writeb(sdfunc, *byte, regaddr, &err_ret);
139 int brcmf_sdioh_request_byte(struct brcmf_sdio_dev *sdiodev, uint rw, uint func,
140 uint regaddr, u8 *byte)
144 brcmf_dbg(INFO, "rw=%d, func=%d, addr=0x%05x\n", rw, func, regaddr);
146 brcmf_pm_resume_wait(sdiodev, &sdiodev->request_byte_wait);
147 if (brcmf_pm_resume_error(sdiodev))
150 if (rw && func == 0) {
151 /* handle F0 separately */
152 err_ret = brcmf_sdioh_f0_write_byte(sdiodev, regaddr, byte);
154 if (rw) /* CMD52 Write */
155 sdio_writeb(sdiodev->func[func], *byte, regaddr,
157 else if (func == 0) {
158 *byte = sdio_f0_readb(sdiodev->func[func], regaddr,
161 *byte = sdio_readb(sdiodev->func[func], regaddr,
167 brcmf_err("Failed to %s byte F%d:@0x%05x=%02x, Err: %d\n",
168 rw ? "write" : "read", func, regaddr, *byte, err_ret);
173 int brcmf_sdioh_request_word(struct brcmf_sdio_dev *sdiodev,
174 uint rw, uint func, uint addr, u32 *word,
180 brcmf_err("Only CMD52 allowed to F0\n");
184 brcmf_dbg(INFO, "rw=%d, func=%d, addr=0x%05x, nbytes=%d\n",
185 rw, func, addr, nbytes);
187 brcmf_pm_resume_wait(sdiodev, &sdiodev->request_word_wait);
188 if (brcmf_pm_resume_error(sdiodev))
191 if (rw) { /* CMD52 Write */
193 sdio_writel(sdiodev->func[func], *word, addr,
195 else if (nbytes == 2)
196 sdio_writew(sdiodev->func[func], (*word & 0xFFFF),
199 brcmf_err("Invalid nbytes: %d\n", nbytes);
200 } else { /* CMD52 Read */
202 *word = sdio_readl(sdiodev->func[func], addr, &err_ret);
203 else if (nbytes == 2)
204 *word = sdio_readw(sdiodev->func[func], addr,
207 brcmf_err("Invalid nbytes: %d\n", nbytes);
211 brcmf_err("Failed to %s word, Err: 0x%08x\n",
212 rw ? "write" : "read", err_ret);
217 /* precondition: host controller is claimed */
219 brcmf_sdioh_request_data(struct brcmf_sdio_dev *sdiodev, uint write, bool fifo,
220 uint func, uint addr, struct sk_buff *pkt, uint pktlen)
224 if ((write) && (!fifo)) {
225 err_ret = sdio_memcpy_toio(sdiodev->func[func], addr,
226 ((u8 *) (pkt->data)), pktlen);
228 err_ret = sdio_memcpy_toio(sdiodev->func[func], addr,
229 ((u8 *) (pkt->data)), pktlen);
231 err_ret = sdio_readsb(sdiodev->func[func],
232 ((u8 *) (pkt->data)), addr, pktlen);
234 err_ret = sdio_memcpy_fromio(sdiodev->func[func],
235 ((u8 *) (pkt->data)),
243 * This function takes a queue of packets. The packets on the queue
244 * are assumed to be properly aligned by the caller.
247 brcmf_sdioh_request_chain(struct brcmf_sdio_dev *sdiodev, uint fix_inc,
248 uint write, uint func, uint addr,
249 struct sk_buff_head *pktq)
251 bool fifo = (fix_inc == SDIOH_DATA_FIX);
257 brcmf_dbg(TRACE, "Enter\n");
259 brcmf_pm_resume_wait(sdiodev, &sdiodev->request_chain_wait);
260 if (brcmf_pm_resume_error(sdiodev))
263 skb_queue_walk(pktq, pkt) {
264 uint pkt_len = pkt->len;
266 pkt_len &= 0xFFFFFFFC;
268 err_ret = brcmf_sdioh_request_data(sdiodev, write, fifo, func,
271 brcmf_err("%s FAILED %p[%d], addr=0x%05x, pkt_len=%d, ERR=0x%08x\n",
272 write ? "TX" : "RX", pkt, SGCount, addr,
275 brcmf_dbg(TRACE, "%s xfr'd %p[%d], addr=0x%05x, len=%d\n",
276 write ? "TX" : "RX", pkt, SGCount, addr,
285 brcmf_dbg(TRACE, "Exit\n");
290 * This function takes a single DMA-able packet.
292 int brcmf_sdioh_request_buffer(struct brcmf_sdio_dev *sdiodev,
293 uint fix_inc, uint write, uint func, uint addr,
298 bool fifo = (fix_inc == SDIOH_DATA_FIX);
300 brcmf_dbg(TRACE, "Enter\n");
306 brcmf_pm_resume_wait(sdiodev, &sdiodev->request_buffer_wait);
307 if (brcmf_pm_resume_error(sdiodev))
313 status = brcmf_sdioh_request_data(sdiodev, write, fifo, func,
316 brcmf_err("%s FAILED %p, addr=0x%05x, pkt_len=%d, ERR=0x%08x\n",
317 write ? "TX" : "RX", pkt, addr, pkt_len, status);
319 brcmf_dbg(TRACE, "%s xfr'd %p, addr=0x%05x, len=%d\n",
320 write ? "TX" : "RX", pkt, addr, pkt_len);
326 static int brcmf_sdioh_get_cisaddr(struct brcmf_sdio_dev *sdiodev, u32 regaddr)
328 /* read 24 bits and return valid 17 bit addr */
330 u32 scratch, regdata;
332 u8 *ptr = (u8 *)&scratch_le;
334 for (i = 0; i < 3; i++) {
335 regdata = brcmf_sdio_regrl(sdiodev, regaddr, &ret);
337 brcmf_err("Can't read!\n");
339 *ptr++ = (u8) regdata;
343 /* Only the lower 17-bits are valid */
344 scratch = le32_to_cpu(scratch_le);
345 scratch &= 0x0001FFFF;
349 static int brcmf_sdioh_enablefuncs(struct brcmf_sdio_dev *sdiodev)
355 brcmf_dbg(TRACE, "\n");
357 /* Get the Card's common CIS address */
358 sdiodev->func_cis_ptr[0] = brcmf_sdioh_get_cisaddr(sdiodev,
360 brcmf_dbg(INFO, "Card's Common CIS Ptr = 0x%x\n",
361 sdiodev->func_cis_ptr[0]);
363 /* Get the Card's function CIS (for each function) */
364 for (fbraddr = SDIO_FBR_BASE(1), func = 1;
365 func <= sdiodev->num_funcs; func++, fbraddr += SDIOD_FBR_SIZE) {
366 sdiodev->func_cis_ptr[func] =
367 brcmf_sdioh_get_cisaddr(sdiodev, SDIO_FBR_CIS + fbraddr);
368 brcmf_dbg(INFO, "Function %d CIS Ptr = 0x%x\n",
369 func, sdiodev->func_cis_ptr[func]);
372 /* Enable Function 1 */
373 err_ret = sdio_enable_func(sdiodev->func[1]);
375 brcmf_err("Failed to enable F1 Err: 0x%08x\n", err_ret);
381 * Public entry points & extern's
383 int brcmf_sdioh_attach(struct brcmf_sdio_dev *sdiodev)
387 brcmf_dbg(TRACE, "\n");
389 sdiodev->num_funcs = 2;
391 sdio_claim_host(sdiodev->func[1]);
393 err_ret = sdio_set_block_size(sdiodev->func[1], SDIO_FUNC1_BLOCKSIZE);
395 brcmf_err("Failed to set F1 blocksize\n");
399 err_ret = sdio_set_block_size(sdiodev->func[2], SDIO_FUNC2_BLOCKSIZE);
401 brcmf_err("Failed to set F2 blocksize\n");
405 brcmf_sdioh_enablefuncs(sdiodev);
408 sdio_release_host(sdiodev->func[1]);
409 brcmf_dbg(TRACE, "Done\n");
413 void brcmf_sdioh_detach(struct brcmf_sdio_dev *sdiodev)
415 brcmf_dbg(TRACE, "\n");
417 /* Disable Function 2 */
418 sdio_claim_host(sdiodev->func[2]);
419 sdio_disable_func(sdiodev->func[2]);
420 sdio_release_host(sdiodev->func[2]);
422 /* Disable Function 1 */
423 sdio_claim_host(sdiodev->func[1]);
424 sdio_disable_func(sdiodev->func[1]);
425 sdio_release_host(sdiodev->func[1]);
429 #ifdef CONFIG_BRCMFMAC_SDIO_OOB
430 static int brcmf_sdio_getintrcfg(struct brcmf_sdio_dev *sdiodev)
432 struct brcmf_sdio_oobirq *oobirq_entry;
434 if (list_empty(&oobirq_lh)) {
435 brcmf_err("no valid oob irq resource\n");
439 oobirq_entry = list_first_entry(&oobirq_lh, struct brcmf_sdio_oobirq,
442 sdiodev->irq = oobirq_entry->irq;
443 sdiodev->irq_flags = oobirq_entry->flags;
444 list_del(&oobirq_entry->list);
450 static inline int brcmf_sdio_getintrcfg(struct brcmf_sdio_dev *sdiodev)
454 #endif /* CONFIG_BRCMFMAC_SDIO_OOB */
456 static int brcmf_ops_sdio_probe(struct sdio_func *func,
457 const struct sdio_device_id *id)
460 struct brcmf_sdio_dev *sdiodev;
461 struct brcmf_bus *bus_if;
463 brcmf_dbg(TRACE, "Enter\n");
464 brcmf_dbg(TRACE, "Class=%x\n", func->class);
465 brcmf_dbg(TRACE, "sdio vendor ID: 0x%04x\n", func->vendor);
466 brcmf_dbg(TRACE, "sdio device ID: 0x%04x\n", func->device);
467 brcmf_dbg(TRACE, "Function#: %d\n", func->num);
469 /* Consume func num 1 but dont do anything with it. */
473 /* Ignore anything but func 2 */
477 bus_if = kzalloc(sizeof(struct brcmf_bus), GFP_KERNEL);
480 sdiodev = kzalloc(sizeof(struct brcmf_sdio_dev), GFP_KERNEL);
486 sdiodev->func[0] = func->card->sdio_func[0];
487 sdiodev->func[1] = func->card->sdio_func[0];
488 sdiodev->func[2] = func;
490 sdiodev->bus_if = bus_if;
491 bus_if->bus_priv.sdio = sdiodev;
492 bus_if->align = BRCMF_SDALIGN;
493 dev_set_drvdata(&func->dev, bus_if);
494 dev_set_drvdata(&sdiodev->func[1]->dev, bus_if);
495 sdiodev->dev = &sdiodev->func[1]->dev;
497 atomic_set(&sdiodev->suspend, false);
498 init_waitqueue_head(&sdiodev->request_byte_wait);
499 init_waitqueue_head(&sdiodev->request_word_wait);
500 init_waitqueue_head(&sdiodev->request_chain_wait);
501 init_waitqueue_head(&sdiodev->request_buffer_wait);
502 err = brcmf_sdio_getintrcfg(sdiodev);
506 brcmf_dbg(TRACE, "F2 found, calling brcmf_sdio_probe...\n");
507 err = brcmf_sdio_probe(sdiodev);
509 brcmf_err("F2 error, probe failed %d...\n", err);
512 brcmf_dbg(TRACE, "F2 init completed...\n");
516 dev_set_drvdata(&func->dev, NULL);
517 dev_set_drvdata(&sdiodev->func[1]->dev, NULL);
523 static void brcmf_ops_sdio_remove(struct sdio_func *func)
525 struct brcmf_bus *bus_if;
526 struct brcmf_sdio_dev *sdiodev;
528 brcmf_dbg(TRACE, "Enter\n");
529 brcmf_dbg(TRACE, "sdio vendor ID: 0x%04x\n", func->vendor);
530 brcmf_dbg(TRACE, "sdio device ID: 0x%04x\n", func->device);
531 brcmf_dbg(TRACE, "Function: %d\n", func->num);
533 if (func->num != 1 && func->num != 2)
536 bus_if = dev_get_drvdata(&func->dev);
538 sdiodev = bus_if->bus_priv.sdio;
539 brcmf_sdio_remove(sdiodev);
541 dev_set_drvdata(&sdiodev->func[1]->dev, NULL);
542 dev_set_drvdata(&sdiodev->func[2]->dev, NULL);
548 brcmf_dbg(TRACE, "Exit\n");
551 #ifdef CONFIG_PM_SLEEP
552 static int brcmf_sdio_suspend(struct device *dev)
554 mmc_pm_flag_t sdio_flags;
555 struct brcmf_bus *bus_if = dev_get_drvdata(dev);
556 struct brcmf_sdio_dev *sdiodev = bus_if->bus_priv.sdio;
559 brcmf_dbg(TRACE, "\n");
561 atomic_set(&sdiodev->suspend, true);
563 sdio_flags = sdio_get_host_pm_caps(sdiodev->func[1]);
564 if (!(sdio_flags & MMC_PM_KEEP_POWER)) {
565 brcmf_err("Host can't keep power while suspended\n");
569 ret = sdio_set_host_pm_flags(sdiodev->func[1], MMC_PM_KEEP_POWER);
571 brcmf_err("Failed to set pm_flags\n");
575 brcmf_sdio_wdtmr_enable(sdiodev, false);
580 static int brcmf_sdio_resume(struct device *dev)
582 struct brcmf_bus *bus_if = dev_get_drvdata(dev);
583 struct brcmf_sdio_dev *sdiodev = bus_if->bus_priv.sdio;
585 brcmf_sdio_wdtmr_enable(sdiodev, true);
586 atomic_set(&sdiodev->suspend, false);
590 static const struct dev_pm_ops brcmf_sdio_pm_ops = {
591 .suspend = brcmf_sdio_suspend,
592 .resume = brcmf_sdio_resume,
594 #endif /* CONFIG_PM_SLEEP */
596 static struct sdio_driver brcmf_sdmmc_driver = {
597 .probe = brcmf_ops_sdio_probe,
598 .remove = brcmf_ops_sdio_remove,
600 .id_table = brcmf_sdmmc_ids,
601 #ifdef CONFIG_PM_SLEEP
603 .pm = &brcmf_sdio_pm_ops,
605 #endif /* CONFIG_PM_SLEEP */
608 #ifdef CONFIG_BRCMFMAC_SDIO_OOB
609 static int brcmf_sdio_pd_probe(struct platform_device *pdev)
611 struct resource *res;
612 struct brcmf_sdio_oobirq *oobirq_entry;
615 INIT_LIST_HEAD(&oobirq_lh);
618 res = platform_get_resource(pdev, IORESOURCE_IRQ, i);
622 oobirq_entry = kzalloc(sizeof(struct brcmf_sdio_oobirq),
626 oobirq_entry->irq = res->start;
627 oobirq_entry->flags = res->flags & IRQF_TRIGGER_MASK;
628 list_add_tail(&oobirq_entry->list, &oobirq_lh);
633 ret = sdio_register_driver(&brcmf_sdmmc_driver);
636 brcmf_err("sdio_register_driver failed: %d\n", ret);
641 static struct platform_driver brcmf_sdio_pd = {
642 .probe = brcmf_sdio_pd_probe,
644 .name = "brcmf_sdio_pd"
648 void brcmf_sdio_exit(void)
650 brcmf_dbg(TRACE, "Enter\n");
652 sdio_unregister_driver(&brcmf_sdmmc_driver);
654 platform_driver_unregister(&brcmf_sdio_pd);
657 void brcmf_sdio_init(void)
661 brcmf_dbg(TRACE, "Enter\n");
663 ret = platform_driver_register(&brcmf_sdio_pd);
666 brcmf_err("platform_driver_register failed: %d\n", ret);
669 void brcmf_sdio_exit(void)
671 brcmf_dbg(TRACE, "Enter\n");
673 sdio_unregister_driver(&brcmf_sdmmc_driver);
676 void brcmf_sdio_init(void)
680 brcmf_dbg(TRACE, "Enter\n");
682 ret = sdio_register_driver(&brcmf_sdmmc_driver);
685 brcmf_err("sdio_register_driver failed: %d\n", ret);
687 #endif /* CONFIG_BRCMFMAC_SDIO_OOB */