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 #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/suspend.h>
25 #include <linux/errno.h>
26 #include <linux/sched.h> /* request_irq() */
27 #include <linux/module.h>
28 #include <linux/platform_device.h>
29 #include <net/cfg80211.h>
32 #include <brcm_hw_ids.h>
33 #include <brcmu_utils.h>
34 #include <brcmu_wifi.h>
35 #include "sdio_host.h"
39 #define SDIO_VENDOR_ID_BROADCOM 0x02d0
41 #define DMA_ALIGN_MASK 0x03
43 #define SDIO_DEVICE_ID_BROADCOM_43241 0x4324
44 #define SDIO_DEVICE_ID_BROADCOM_4329 0x4329
45 #define SDIO_DEVICE_ID_BROADCOM_4330 0x4330
46 #define SDIO_DEVICE_ID_BROADCOM_4334 0x4334
48 #define SDIO_FUNC1_BLOCKSIZE 64
49 #define SDIO_FUNC2_BLOCKSIZE 512
51 /* devices we support, null terminated */
52 static const struct sdio_device_id brcmf_sdmmc_ids[] = {
53 {SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM, SDIO_DEVICE_ID_BROADCOM_43241)},
54 {SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM, SDIO_DEVICE_ID_BROADCOM_4329)},
55 {SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM, SDIO_DEVICE_ID_BROADCOM_4330)},
56 {SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM, SDIO_DEVICE_ID_BROADCOM_4334)},
57 { /* end: all zeroes */ },
59 MODULE_DEVICE_TABLE(sdio, brcmf_sdmmc_ids);
61 #ifdef CONFIG_BRCMFMAC_SDIO_OOB
62 static struct list_head oobirq_lh;
63 struct brcmf_sdio_oobirq {
66 struct list_head list;
68 #endif /* CONFIG_BRCMFMAC_SDIO_OOB */
71 brcmf_pm_resume_error(struct brcmf_sdio_dev *sdiodev)
74 #ifdef CONFIG_PM_SLEEP
75 is_err = atomic_read(&sdiodev->suspend);
81 brcmf_pm_resume_wait(struct brcmf_sdio_dev *sdiodev, wait_queue_head_t *wq)
83 #ifdef CONFIG_PM_SLEEP
85 while (atomic_read(&sdiodev->suspend) && retry++ != 30)
86 wait_event_timeout(*wq, false, HZ/100);
90 static inline int brcmf_sdioh_f0_write_byte(struct brcmf_sdio_dev *sdiodev,
91 uint regaddr, u8 *byte)
93 struct sdio_func *sdfunc = sdiodev->func[0];
97 * Can only directly write to some F0 registers.
98 * Handle F2 enable/disable and Abort command
101 if (regaddr == SDIO_CCCR_IOEx) {
102 sdfunc = sdiodev->func[2];
104 if (*byte & SDIO_FUNC_ENABLE_2) {
105 /* Enable Function 2 */
106 err_ret = sdio_enable_func(sdfunc);
108 brcmf_err("enable F2 failed:%d\n",
111 /* Disable Function 2 */
112 err_ret = sdio_disable_func(sdfunc);
114 brcmf_err("Disable F2 failed:%d\n",
118 } else if ((regaddr == SDIO_CCCR_ABORT) ||
119 (regaddr == SDIO_CCCR_IENx)) {
120 sdfunc = kmemdup(sdiodev->func[0], sizeof(struct sdio_func),
125 sdio_writeb(sdfunc, *byte, regaddr, &err_ret);
127 } else if (regaddr < 0xF0) {
128 brcmf_err("F0 Wr:0x%02x: write disallowed\n", regaddr);
131 sdio_f0_writeb(sdfunc, *byte, regaddr, &err_ret);
137 int brcmf_sdioh_request_byte(struct brcmf_sdio_dev *sdiodev, uint rw, uint func,
138 uint regaddr, u8 *byte)
142 brcmf_dbg(INFO, "rw=%d, func=%d, addr=0x%05x\n", rw, func, regaddr);
144 brcmf_pm_resume_wait(sdiodev, &sdiodev->request_byte_wait);
145 if (brcmf_pm_resume_error(sdiodev))
148 if (rw && func == 0) {
149 /* handle F0 separately */
150 err_ret = brcmf_sdioh_f0_write_byte(sdiodev, regaddr, byte);
152 if (rw) /* CMD52 Write */
153 sdio_writeb(sdiodev->func[func], *byte, regaddr,
155 else if (func == 0) {
156 *byte = sdio_f0_readb(sdiodev->func[func], regaddr,
159 *byte = sdio_readb(sdiodev->func[func], regaddr,
165 brcmf_err("Failed to %s byte F%d:@0x%05x=%02x, Err: %d\n",
166 rw ? "write" : "read", func, regaddr, *byte, err_ret);
171 int brcmf_sdioh_request_word(struct brcmf_sdio_dev *sdiodev,
172 uint rw, uint func, uint addr, u32 *word,
178 brcmf_err("Only CMD52 allowed to F0\n");
182 brcmf_dbg(INFO, "rw=%d, func=%d, addr=0x%05x, nbytes=%d\n",
183 rw, func, addr, nbytes);
185 brcmf_pm_resume_wait(sdiodev, &sdiodev->request_word_wait);
186 if (brcmf_pm_resume_error(sdiodev))
189 if (rw) { /* CMD52 Write */
191 sdio_writel(sdiodev->func[func], *word, addr,
193 else if (nbytes == 2)
194 sdio_writew(sdiodev->func[func], (*word & 0xFFFF),
197 brcmf_err("Invalid nbytes: %d\n", nbytes);
198 } else { /* CMD52 Read */
200 *word = sdio_readl(sdiodev->func[func], addr, &err_ret);
201 else if (nbytes == 2)
202 *word = sdio_readw(sdiodev->func[func], addr,
205 brcmf_err("Invalid nbytes: %d\n", nbytes);
209 brcmf_err("Failed to %s word, Err: 0x%08x\n",
210 rw ? "write" : "read", err_ret);
215 /* precondition: host controller is claimed */
217 brcmf_sdioh_request_data(struct brcmf_sdio_dev *sdiodev, uint write, bool fifo,
218 uint func, uint addr, struct sk_buff *pkt, uint pktlen)
222 if ((write) && (!fifo)) {
223 err_ret = sdio_memcpy_toio(sdiodev->func[func], addr,
224 ((u8 *) (pkt->data)), pktlen);
226 err_ret = sdio_memcpy_toio(sdiodev->func[func], addr,
227 ((u8 *) (pkt->data)), pktlen);
229 err_ret = sdio_readsb(sdiodev->func[func],
230 ((u8 *) (pkt->data)), addr, pktlen);
232 err_ret = sdio_memcpy_fromio(sdiodev->func[func],
233 ((u8 *) (pkt->data)),
241 * This function takes a queue of packets. The packets on the queue
242 * are assumed to be properly aligned by the caller.
245 brcmf_sdioh_request_chain(struct brcmf_sdio_dev *sdiodev, uint fix_inc,
246 uint write, uint func, uint addr,
247 struct sk_buff_head *pktq)
249 bool fifo = (fix_inc == SDIOH_DATA_FIX);
255 brcmf_dbg(TRACE, "Enter\n");
257 brcmf_pm_resume_wait(sdiodev, &sdiodev->request_chain_wait);
258 if (brcmf_pm_resume_error(sdiodev))
261 skb_queue_walk(pktq, pkt) {
262 uint pkt_len = pkt->len;
264 pkt_len &= 0xFFFFFFFC;
266 err_ret = brcmf_sdioh_request_data(sdiodev, write, fifo, func,
269 brcmf_err("%s FAILED %p[%d], addr=0x%05x, pkt_len=%d, ERR=0x%08x\n",
270 write ? "TX" : "RX", pkt, SGCount, addr,
273 brcmf_dbg(TRACE, "%s xfr'd %p[%d], addr=0x%05x, len=%d\n",
274 write ? "TX" : "RX", pkt, SGCount, addr,
283 brcmf_dbg(TRACE, "Exit\n");
288 * This function takes a single DMA-able packet.
290 int brcmf_sdioh_request_buffer(struct brcmf_sdio_dev *sdiodev,
291 uint fix_inc, uint write, uint func, uint addr,
296 bool fifo = (fix_inc == SDIOH_DATA_FIX);
298 brcmf_dbg(TRACE, "Enter\n");
304 brcmf_pm_resume_wait(sdiodev, &sdiodev->request_buffer_wait);
305 if (brcmf_pm_resume_error(sdiodev))
311 status = brcmf_sdioh_request_data(sdiodev, write, fifo, func,
314 brcmf_err("%s FAILED %p, addr=0x%05x, pkt_len=%d, ERR=0x%08x\n",
315 write ? "TX" : "RX", pkt, addr, pkt_len, status);
317 brcmf_dbg(TRACE, "%s xfr'd %p, addr=0x%05x, len=%d\n",
318 write ? "TX" : "RX", pkt, addr, pkt_len);
324 static int brcmf_sdioh_get_cisaddr(struct brcmf_sdio_dev *sdiodev, u32 regaddr)
326 /* read 24 bits and return valid 17 bit addr */
328 u32 scratch, regdata;
330 u8 *ptr = (u8 *)&scratch_le;
332 for (i = 0; i < 3; i++) {
333 regdata = brcmf_sdio_regrl(sdiodev, regaddr, &ret);
335 brcmf_err("Can't read!\n");
337 *ptr++ = (u8) regdata;
341 /* Only the lower 17-bits are valid */
342 scratch = le32_to_cpu(scratch_le);
343 scratch &= 0x0001FFFF;
347 static int brcmf_sdioh_enablefuncs(struct brcmf_sdio_dev *sdiodev)
353 brcmf_dbg(TRACE, "\n");
355 /* Get the Card's common CIS address */
356 sdiodev->func_cis_ptr[0] = brcmf_sdioh_get_cisaddr(sdiodev,
358 brcmf_dbg(INFO, "Card's Common CIS Ptr = 0x%x\n",
359 sdiodev->func_cis_ptr[0]);
361 /* Get the Card's function CIS (for each function) */
362 for (fbraddr = SDIO_FBR_BASE(1), func = 1;
363 func <= sdiodev->num_funcs; func++, fbraddr += SDIOD_FBR_SIZE) {
364 sdiodev->func_cis_ptr[func] =
365 brcmf_sdioh_get_cisaddr(sdiodev, SDIO_FBR_CIS + fbraddr);
366 brcmf_dbg(INFO, "Function %d CIS Ptr = 0x%x\n",
367 func, sdiodev->func_cis_ptr[func]);
370 /* Enable Function 1 */
371 err_ret = sdio_enable_func(sdiodev->func[1]);
373 brcmf_err("Failed to enable F1 Err: 0x%08x\n", err_ret);
379 * Public entry points & extern's
381 int brcmf_sdioh_attach(struct brcmf_sdio_dev *sdiodev)
385 brcmf_dbg(TRACE, "\n");
387 sdiodev->num_funcs = 2;
389 sdio_claim_host(sdiodev->func[1]);
391 err_ret = sdio_set_block_size(sdiodev->func[1], SDIO_FUNC1_BLOCKSIZE);
393 brcmf_err("Failed to set F1 blocksize\n");
397 err_ret = sdio_set_block_size(sdiodev->func[2], SDIO_FUNC2_BLOCKSIZE);
399 brcmf_err("Failed to set F2 blocksize\n");
403 brcmf_sdioh_enablefuncs(sdiodev);
406 sdio_release_host(sdiodev->func[1]);
407 brcmf_dbg(TRACE, "Done\n");
411 void brcmf_sdioh_detach(struct brcmf_sdio_dev *sdiodev)
413 brcmf_dbg(TRACE, "\n");
415 /* Disable Function 2 */
416 sdio_claim_host(sdiodev->func[2]);
417 sdio_disable_func(sdiodev->func[2]);
418 sdio_release_host(sdiodev->func[2]);
420 /* Disable Function 1 */
421 sdio_claim_host(sdiodev->func[1]);
422 sdio_disable_func(sdiodev->func[1]);
423 sdio_release_host(sdiodev->func[1]);
427 #ifdef CONFIG_BRCMFMAC_SDIO_OOB
428 static int brcmf_sdio_getintrcfg(struct brcmf_sdio_dev *sdiodev)
430 struct brcmf_sdio_oobirq *oobirq_entry;
432 if (list_empty(&oobirq_lh)) {
433 brcmf_err("no valid oob irq resource\n");
437 oobirq_entry = list_first_entry(&oobirq_lh, struct brcmf_sdio_oobirq,
440 sdiodev->irq = oobirq_entry->irq;
441 sdiodev->irq_flags = oobirq_entry->flags;
442 list_del(&oobirq_entry->list);
448 static inline int brcmf_sdio_getintrcfg(struct brcmf_sdio_dev *sdiodev)
452 #endif /* CONFIG_BRCMFMAC_SDIO_OOB */
454 static int brcmf_ops_sdio_probe(struct sdio_func *func,
455 const struct sdio_device_id *id)
458 struct brcmf_sdio_dev *sdiodev;
459 struct brcmf_bus *bus_if;
461 brcmf_dbg(TRACE, "Enter\n");
462 brcmf_dbg(TRACE, "Class=%x\n", func->class);
463 brcmf_dbg(TRACE, "sdio vendor ID: 0x%04x\n", func->vendor);
464 brcmf_dbg(TRACE, "sdio device ID: 0x%04x\n", func->device);
465 brcmf_dbg(TRACE, "Function#: %d\n", func->num);
467 /* Consume func num 1 but dont do anything with it. */
471 /* Ignore anything but func 2 */
475 bus_if = kzalloc(sizeof(struct brcmf_bus), GFP_KERNEL);
478 sdiodev = kzalloc(sizeof(struct brcmf_sdio_dev), GFP_KERNEL);
484 sdiodev->func[0] = func->card->sdio_func[0];
485 sdiodev->func[1] = func->card->sdio_func[0];
486 sdiodev->func[2] = func;
488 sdiodev->bus_if = bus_if;
489 bus_if->bus_priv.sdio = sdiodev;
490 bus_if->align = BRCMF_SDALIGN;
491 dev_set_drvdata(&func->dev, bus_if);
492 dev_set_drvdata(&sdiodev->func[1]->dev, bus_if);
493 sdiodev->dev = &sdiodev->func[1]->dev;
495 atomic_set(&sdiodev->suspend, false);
496 init_waitqueue_head(&sdiodev->request_byte_wait);
497 init_waitqueue_head(&sdiodev->request_word_wait);
498 init_waitqueue_head(&sdiodev->request_chain_wait);
499 init_waitqueue_head(&sdiodev->request_buffer_wait);
500 err = brcmf_sdio_getintrcfg(sdiodev);
504 brcmf_dbg(TRACE, "F2 found, calling brcmf_sdio_probe...\n");
505 err = brcmf_sdio_probe(sdiodev);
507 brcmf_err("F2 error, probe failed %d...\n", err);
510 brcmf_dbg(TRACE, "F2 init completed...\n");
514 dev_set_drvdata(&func->dev, NULL);
515 dev_set_drvdata(&sdiodev->func[1]->dev, NULL);
521 static void brcmf_ops_sdio_remove(struct sdio_func *func)
523 struct brcmf_bus *bus_if;
524 struct brcmf_sdio_dev *sdiodev;
526 brcmf_dbg(TRACE, "Enter\n");
527 brcmf_dbg(TRACE, "sdio vendor ID: 0x%04x\n", func->vendor);
528 brcmf_dbg(TRACE, "sdio device ID: 0x%04x\n", func->device);
529 brcmf_dbg(TRACE, "Function: %d\n", func->num);
531 if (func->num != 1 && func->num != 2)
534 bus_if = dev_get_drvdata(&func->dev);
536 sdiodev = bus_if->bus_priv.sdio;
537 brcmf_sdio_remove(sdiodev);
539 dev_set_drvdata(&sdiodev->func[1]->dev, NULL);
540 dev_set_drvdata(&sdiodev->func[2]->dev, NULL);
546 brcmf_dbg(TRACE, "Exit\n");
549 #ifdef CONFIG_PM_SLEEP
550 static int brcmf_sdio_suspend(struct device *dev)
552 mmc_pm_flag_t sdio_flags;
553 struct brcmf_bus *bus_if = dev_get_drvdata(dev);
554 struct brcmf_sdio_dev *sdiodev = bus_if->bus_priv.sdio;
557 brcmf_dbg(TRACE, "\n");
559 atomic_set(&sdiodev->suspend, true);
561 sdio_flags = sdio_get_host_pm_caps(sdiodev->func[1]);
562 if (!(sdio_flags & MMC_PM_KEEP_POWER)) {
563 brcmf_err("Host can't keep power while suspended\n");
567 ret = sdio_set_host_pm_flags(sdiodev->func[1], MMC_PM_KEEP_POWER);
569 brcmf_err("Failed to set pm_flags\n");
573 brcmf_sdio_wdtmr_enable(sdiodev, false);
578 static int brcmf_sdio_resume(struct device *dev)
580 struct brcmf_bus *bus_if = dev_get_drvdata(dev);
581 struct brcmf_sdio_dev *sdiodev = bus_if->bus_priv.sdio;
583 brcmf_sdio_wdtmr_enable(sdiodev, true);
584 atomic_set(&sdiodev->suspend, false);
588 static const struct dev_pm_ops brcmf_sdio_pm_ops = {
589 .suspend = brcmf_sdio_suspend,
590 .resume = brcmf_sdio_resume,
592 #endif /* CONFIG_PM_SLEEP */
594 static struct sdio_driver brcmf_sdmmc_driver = {
595 .probe = brcmf_ops_sdio_probe,
596 .remove = brcmf_ops_sdio_remove,
598 .id_table = brcmf_sdmmc_ids,
599 #ifdef CONFIG_PM_SLEEP
601 .pm = &brcmf_sdio_pm_ops,
603 #endif /* CONFIG_PM_SLEEP */
606 #ifdef CONFIG_BRCMFMAC_SDIO_OOB
607 static int brcmf_sdio_pd_probe(struct platform_device *pdev)
609 struct resource *res;
610 struct brcmf_sdio_oobirq *oobirq_entry;
613 INIT_LIST_HEAD(&oobirq_lh);
616 res = platform_get_resource(pdev, IORESOURCE_IRQ, i);
620 oobirq_entry = kzalloc(sizeof(struct brcmf_sdio_oobirq),
624 oobirq_entry->irq = res->start;
625 oobirq_entry->flags = res->flags & IRQF_TRIGGER_MASK;
626 list_add_tail(&oobirq_entry->list, &oobirq_lh);
631 ret = sdio_register_driver(&brcmf_sdmmc_driver);
634 brcmf_err("sdio_register_driver failed: %d\n", ret);
639 static struct platform_driver brcmf_sdio_pd = {
640 .probe = brcmf_sdio_pd_probe,
642 .name = "brcmf_sdio_pd"
646 void brcmf_sdio_exit(void)
648 brcmf_dbg(TRACE, "Enter\n");
650 sdio_unregister_driver(&brcmf_sdmmc_driver);
652 platform_driver_unregister(&brcmf_sdio_pd);
655 void brcmf_sdio_init(void)
659 brcmf_dbg(TRACE, "Enter\n");
661 ret = platform_driver_register(&brcmf_sdio_pd);
664 brcmf_err("platform_driver_register failed: %d\n", ret);
667 void brcmf_sdio_exit(void)
669 brcmf_dbg(TRACE, "Enter\n");
671 sdio_unregister_driver(&brcmf_sdmmc_driver);
674 void brcmf_sdio_init(void)
678 brcmf_dbg(TRACE, "Enter\n");
680 ret = sdio_register_driver(&brcmf_sdmmc_driver);
683 brcmf_err("sdio_register_driver failed: %d\n", ret);
685 #endif /* CONFIG_BRCMFMAC_SDIO_OOB */