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_4329 0x4329
46 #define SDIO_DEVICE_ID_BROADCOM_4330 0x4330
47 #define SDIO_DEVICE_ID_BROADCOM_4334 0x4334
49 #define SDIO_FUNC1_BLOCKSIZE 64
50 #define SDIO_FUNC2_BLOCKSIZE 512
52 /* devices we support, null terminated */
53 static const struct sdio_device_id brcmf_sdmmc_ids[] = {
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 sdio_claim_host(sdfunc);
105 if (*byte & SDIO_FUNC_ENABLE_2) {
106 /* Enable Function 2 */
107 err_ret = sdio_enable_func(sdfunc);
110 "enable F2 failed:%d\n",
113 /* Disable Function 2 */
114 err_ret = sdio_disable_func(sdfunc);
117 "Disable F2 failed:%d\n",
120 sdio_release_host(sdfunc);
122 } else if ((regaddr == SDIO_CCCR_ABORT) ||
123 (regaddr == SDIO_CCCR_IENx)) {
124 sdfunc = kmemdup(sdiodev->func[0], sizeof(struct sdio_func),
129 sdio_claim_host(sdfunc);
130 sdio_writeb(sdfunc, *byte, regaddr, &err_ret);
131 sdio_release_host(sdfunc);
133 } else if (regaddr < 0xF0) {
134 brcmf_dbg(ERROR, "F0 Wr:0x%02x: write disallowed\n", regaddr);
137 sdio_claim_host(sdfunc);
138 sdio_f0_writeb(sdfunc, *byte, regaddr, &err_ret);
139 sdio_release_host(sdfunc);
145 int brcmf_sdioh_request_byte(struct brcmf_sdio_dev *sdiodev, uint rw, uint func,
146 uint regaddr, u8 *byte)
150 brcmf_dbg(INFO, "rw=%d, func=%d, addr=0x%05x\n", rw, func, regaddr);
152 brcmf_pm_resume_wait(sdiodev, &sdiodev->request_byte_wait);
153 if (brcmf_pm_resume_error(sdiodev))
156 if (rw && func == 0) {
157 /* handle F0 separately */
158 err_ret = brcmf_sdioh_f0_write_byte(sdiodev, regaddr, byte);
160 sdio_claim_host(sdiodev->func[func]);
161 if (rw) /* CMD52 Write */
162 sdio_writeb(sdiodev->func[func], *byte, regaddr,
164 else if (func == 0) {
165 *byte = sdio_f0_readb(sdiodev->func[func], regaddr,
168 *byte = sdio_readb(sdiodev->func[func], regaddr,
171 sdio_release_host(sdiodev->func[func]);
175 brcmf_dbg(ERROR, "Failed to %s byte F%d:@0x%05x=%02x, Err: %d\n",
176 rw ? "write" : "read", func, regaddr, *byte, err_ret);
181 int brcmf_sdioh_request_word(struct brcmf_sdio_dev *sdiodev,
182 uint rw, uint func, uint addr, u32 *word,
188 brcmf_dbg(ERROR, "Only CMD52 allowed to F0\n");
192 brcmf_dbg(INFO, "rw=%d, func=%d, addr=0x%05x, nbytes=%d\n",
193 rw, func, addr, nbytes);
195 brcmf_pm_resume_wait(sdiodev, &sdiodev->request_word_wait);
196 if (brcmf_pm_resume_error(sdiodev))
198 /* Claim host controller */
199 sdio_claim_host(sdiodev->func[func]);
201 if (rw) { /* CMD52 Write */
203 sdio_writel(sdiodev->func[func], *word, addr,
205 else if (nbytes == 2)
206 sdio_writew(sdiodev->func[func], (*word & 0xFFFF),
209 brcmf_dbg(ERROR, "Invalid nbytes: %d\n", nbytes);
210 } else { /* CMD52 Read */
212 *word = sdio_readl(sdiodev->func[func], addr, &err_ret);
213 else if (nbytes == 2)
214 *word = sdio_readw(sdiodev->func[func], addr,
217 brcmf_dbg(ERROR, "Invalid nbytes: %d\n", nbytes);
220 /* Release host controller */
221 sdio_release_host(sdiodev->func[func]);
224 brcmf_dbg(ERROR, "Failed to %s word, Err: 0x%08x\n",
225 rw ? "write" : "read", err_ret);
230 /* precondition: host controller is claimed */
232 brcmf_sdioh_request_data(struct brcmf_sdio_dev *sdiodev, uint write, bool fifo,
233 uint func, uint addr, struct sk_buff *pkt, uint pktlen)
237 if ((write) && (!fifo)) {
238 err_ret = sdio_memcpy_toio(sdiodev->func[func], addr,
239 ((u8 *) (pkt->data)), pktlen);
241 err_ret = sdio_memcpy_toio(sdiodev->func[func], addr,
242 ((u8 *) (pkt->data)), pktlen);
244 err_ret = sdio_readsb(sdiodev->func[func],
245 ((u8 *) (pkt->data)), addr, pktlen);
247 err_ret = sdio_memcpy_fromio(sdiodev->func[func],
248 ((u8 *) (pkt->data)),
256 * This function takes a queue of packets. The packets on the queue
257 * are assumed to be properly aligned by the caller.
260 brcmf_sdioh_request_chain(struct brcmf_sdio_dev *sdiodev, uint fix_inc,
261 uint write, uint func, uint addr,
262 struct sk_buff_head *pktq)
264 bool fifo = (fix_inc == SDIOH_DATA_FIX);
270 brcmf_dbg(TRACE, "Enter\n");
272 brcmf_pm_resume_wait(sdiodev, &sdiodev->request_chain_wait);
273 if (brcmf_pm_resume_error(sdiodev))
276 /* Claim host controller */
277 sdio_claim_host(sdiodev->func[func]);
279 skb_queue_walk(pktq, pkt) {
280 uint pkt_len = pkt->len;
282 pkt_len &= 0xFFFFFFFC;
284 err_ret = brcmf_sdioh_request_data(sdiodev, write, fifo, func,
287 brcmf_dbg(ERROR, "%s FAILED %p[%d], addr=0x%05x, pkt_len=%d, ERR=0x%08x\n",
288 write ? "TX" : "RX", pkt, SGCount, addr,
291 brcmf_dbg(TRACE, "%s xfr'd %p[%d], addr=0x%05x, len=%d\n",
292 write ? "TX" : "RX", pkt, SGCount, addr,
301 /* Release host controller */
302 sdio_release_host(sdiodev->func[func]);
304 brcmf_dbg(TRACE, "Exit\n");
309 * This function takes a single DMA-able packet.
311 int brcmf_sdioh_request_buffer(struct brcmf_sdio_dev *sdiodev,
312 uint fix_inc, uint write, uint func, uint addr,
317 bool fifo = (fix_inc == SDIOH_DATA_FIX);
319 brcmf_dbg(TRACE, "Enter\n");
325 brcmf_pm_resume_wait(sdiodev, &sdiodev->request_buffer_wait);
326 if (brcmf_pm_resume_error(sdiodev))
329 /* Claim host controller */
330 sdio_claim_host(sdiodev->func[func]);
335 status = brcmf_sdioh_request_data(sdiodev, write, fifo, func,
338 brcmf_dbg(ERROR, "%s FAILED %p, addr=0x%05x, pkt_len=%d, ERR=0x%08x\n",
339 write ? "TX" : "RX", pkt, addr, pkt_len, status);
341 brcmf_dbg(TRACE, "%s xfr'd %p, addr=0x%05x, len=%d\n",
342 write ? "TX" : "RX", pkt, addr, pkt_len);
345 /* Release host controller */
346 sdio_release_host(sdiodev->func[func]);
351 static int brcmf_sdioh_get_cisaddr(struct brcmf_sdio_dev *sdiodev, u32 regaddr)
353 /* read 24 bits and return valid 17 bit addr */
355 u32 scratch, regdata;
357 u8 *ptr = (u8 *)&scratch_le;
359 for (i = 0; i < 3; i++) {
360 regdata = brcmf_sdio_regrl(sdiodev, regaddr, &ret);
362 brcmf_dbg(ERROR, "Can't read!\n");
364 *ptr++ = (u8) regdata;
368 /* Only the lower 17-bits are valid */
369 scratch = le32_to_cpu(scratch_le);
370 scratch &= 0x0001FFFF;
374 static int brcmf_sdioh_enablefuncs(struct brcmf_sdio_dev *sdiodev)
380 brcmf_dbg(TRACE, "\n");
382 /* Get the Card's common CIS address */
383 sdiodev->func_cis_ptr[0] = brcmf_sdioh_get_cisaddr(sdiodev,
385 brcmf_dbg(INFO, "Card's Common CIS Ptr = 0x%x\n",
386 sdiodev->func_cis_ptr[0]);
388 /* Get the Card's function CIS (for each function) */
389 for (fbraddr = SDIO_FBR_BASE(1), func = 1;
390 func <= sdiodev->num_funcs; func++, fbraddr += SDIOD_FBR_SIZE) {
391 sdiodev->func_cis_ptr[func] =
392 brcmf_sdioh_get_cisaddr(sdiodev, SDIO_FBR_CIS + fbraddr);
393 brcmf_dbg(INFO, "Function %d CIS Ptr = 0x%x\n",
394 func, sdiodev->func_cis_ptr[func]);
397 /* Enable Function 1 */
398 sdio_claim_host(sdiodev->func[1]);
399 err_ret = sdio_enable_func(sdiodev->func[1]);
400 sdio_release_host(sdiodev->func[1]);
402 brcmf_dbg(ERROR, "Failed to enable F1 Err: 0x%08x\n", err_ret);
408 * Public entry points & extern's
410 int brcmf_sdioh_attach(struct brcmf_sdio_dev *sdiodev)
414 brcmf_dbg(TRACE, "\n");
416 sdiodev->num_funcs = 2;
418 sdio_claim_host(sdiodev->func[1]);
419 err_ret = sdio_set_block_size(sdiodev->func[1], SDIO_FUNC1_BLOCKSIZE);
420 sdio_release_host(sdiodev->func[1]);
422 brcmf_dbg(ERROR, "Failed to set F1 blocksize\n");
426 sdio_claim_host(sdiodev->func[2]);
427 err_ret = sdio_set_block_size(sdiodev->func[2], SDIO_FUNC2_BLOCKSIZE);
428 sdio_release_host(sdiodev->func[2]);
430 brcmf_dbg(ERROR, "Failed to set F2 blocksize\n");
434 brcmf_sdioh_enablefuncs(sdiodev);
437 brcmf_dbg(TRACE, "Done\n");
441 void brcmf_sdioh_detach(struct brcmf_sdio_dev *sdiodev)
443 brcmf_dbg(TRACE, "\n");
445 /* Disable Function 2 */
446 sdio_claim_host(sdiodev->func[2]);
447 sdio_disable_func(sdiodev->func[2]);
448 sdio_release_host(sdiodev->func[2]);
450 /* Disable Function 1 */
451 sdio_claim_host(sdiodev->func[1]);
452 sdio_disable_func(sdiodev->func[1]);
453 sdio_release_host(sdiodev->func[1]);
457 #ifdef CONFIG_BRCMFMAC_SDIO_OOB
458 static int brcmf_sdio_getintrcfg(struct brcmf_sdio_dev *sdiodev)
460 struct brcmf_sdio_oobirq *oobirq_entry;
462 if (list_empty(&oobirq_lh)) {
463 brcmf_dbg(ERROR, "no valid oob irq resource\n");
467 oobirq_entry = list_first_entry(&oobirq_lh, struct brcmf_sdio_oobirq,
470 sdiodev->irq = oobirq_entry->irq;
471 sdiodev->irq_flags = oobirq_entry->flags;
472 list_del(&oobirq_entry->list);
478 static inline int brcmf_sdio_getintrcfg(struct brcmf_sdio_dev *sdiodev)
482 #endif /* CONFIG_BRCMFMAC_SDIO_OOB */
484 static int brcmf_ops_sdio_probe(struct sdio_func *func,
485 const struct sdio_device_id *id)
488 struct brcmf_sdio_dev *sdiodev;
489 struct brcmf_bus *bus_if;
491 brcmf_dbg(TRACE, "Enter\n");
492 brcmf_dbg(TRACE, "func->class=%x\n", func->class);
493 brcmf_dbg(TRACE, "sdio_vendor: 0x%04x\n", func->vendor);
494 brcmf_dbg(TRACE, "sdio_device: 0x%04x\n", func->device);
495 brcmf_dbg(TRACE, "Function#: 0x%04x\n", func->num);
497 if (func->num == 1) {
498 if (dev_get_drvdata(&func->card->dev)) {
499 brcmf_dbg(ERROR, "card private drvdata occupied\n");
502 bus_if = kzalloc(sizeof(struct brcmf_bus), GFP_KERNEL);
505 sdiodev = kzalloc(sizeof(struct brcmf_sdio_dev), GFP_KERNEL);
510 sdiodev->func[0] = func;
511 sdiodev->func[1] = func;
512 sdiodev->bus_if = bus_if;
513 bus_if->bus_priv.sdio = sdiodev;
514 bus_if->type = SDIO_BUS;
515 bus_if->align = BRCMF_SDALIGN;
516 dev_set_drvdata(&func->card->dev, sdiodev);
518 atomic_set(&sdiodev->suspend, false);
519 init_waitqueue_head(&sdiodev->request_byte_wait);
520 init_waitqueue_head(&sdiodev->request_word_wait);
521 init_waitqueue_head(&sdiodev->request_chain_wait);
522 init_waitqueue_head(&sdiodev->request_buffer_wait);
525 if (func->num == 2) {
526 sdiodev = dev_get_drvdata(&func->card->dev);
527 if ((!sdiodev) || (sdiodev->func[1]->card != func->card))
530 ret = brcmf_sdio_getintrcfg(sdiodev);
533 sdiodev->func[2] = func;
535 bus_if = sdiodev->bus_if;
536 sdiodev->dev = &func->dev;
537 dev_set_drvdata(&func->dev, bus_if);
539 brcmf_dbg(TRACE, "F2 found, calling brcmf_sdio_probe...\n");
540 ret = brcmf_sdio_probe(sdiodev);
546 static void brcmf_ops_sdio_remove(struct sdio_func *func)
548 struct brcmf_bus *bus_if;
549 struct brcmf_sdio_dev *sdiodev;
550 brcmf_dbg(TRACE, "Enter\n");
551 brcmf_dbg(INFO, "func->class=%x\n", func->class);
552 brcmf_dbg(INFO, "sdio_vendor: 0x%04x\n", func->vendor);
553 brcmf_dbg(INFO, "sdio_device: 0x%04x\n", func->device);
554 brcmf_dbg(INFO, "Function#: 0x%04x\n", func->num);
556 if (func->num == 2) {
557 bus_if = dev_get_drvdata(&func->dev);
558 sdiodev = bus_if->bus_priv.sdio;
559 brcmf_dbg(TRACE, "F2 found, calling brcmf_sdio_remove...\n");
560 brcmf_sdio_remove(sdiodev);
561 dev_set_drvdata(&func->card->dev, NULL);
562 dev_set_drvdata(&func->dev, NULL);
568 #ifdef CONFIG_PM_SLEEP
569 static int brcmf_sdio_suspend(struct device *dev)
571 mmc_pm_flag_t sdio_flags;
572 struct sdio_func *func = dev_to_sdio_func(dev);
573 struct brcmf_sdio_dev *sdiodev = dev_get_drvdata(&func->card->dev);
576 brcmf_dbg(TRACE, "\n");
578 atomic_set(&sdiodev->suspend, true);
580 sdio_flags = sdio_get_host_pm_caps(sdiodev->func[1]);
581 if (!(sdio_flags & MMC_PM_KEEP_POWER)) {
582 brcmf_dbg(ERROR, "Host can't keep power while suspended\n");
586 ret = sdio_set_host_pm_flags(sdiodev->func[1], MMC_PM_KEEP_POWER);
588 brcmf_dbg(ERROR, "Failed to set pm_flags\n");
592 brcmf_sdio_wdtmr_enable(sdiodev, false);
597 static int brcmf_sdio_resume(struct device *dev)
599 struct sdio_func *func = dev_to_sdio_func(dev);
600 struct brcmf_sdio_dev *sdiodev = dev_get_drvdata(&func->card->dev);
602 brcmf_sdio_wdtmr_enable(sdiodev, true);
603 atomic_set(&sdiodev->suspend, false);
607 static const struct dev_pm_ops brcmf_sdio_pm_ops = {
608 .suspend = brcmf_sdio_suspend,
609 .resume = brcmf_sdio_resume,
611 #endif /* CONFIG_PM_SLEEP */
613 static struct sdio_driver brcmf_sdmmc_driver = {
614 .probe = brcmf_ops_sdio_probe,
615 .remove = brcmf_ops_sdio_remove,
617 .id_table = brcmf_sdmmc_ids,
618 #ifdef CONFIG_PM_SLEEP
620 .pm = &brcmf_sdio_pm_ops,
622 #endif /* CONFIG_PM_SLEEP */
625 #ifdef CONFIG_BRCMFMAC_SDIO_OOB
626 static int brcmf_sdio_pd_probe(struct platform_device *pdev)
628 struct resource *res;
629 struct brcmf_sdio_oobirq *oobirq_entry;
632 INIT_LIST_HEAD(&oobirq_lh);
635 res = platform_get_resource(pdev, IORESOURCE_IRQ, i);
639 oobirq_entry = kzalloc(sizeof(struct brcmf_sdio_oobirq),
643 oobirq_entry->irq = res->start;
644 oobirq_entry->flags = res->flags & IRQF_TRIGGER_MASK;
645 list_add_tail(&oobirq_entry->list, &oobirq_lh);
650 ret = sdio_register_driver(&brcmf_sdmmc_driver);
653 brcmf_dbg(ERROR, "sdio_register_driver failed: %d\n", ret);
658 static struct platform_driver brcmf_sdio_pd = {
659 .probe = brcmf_sdio_pd_probe,
661 .name = "brcmf_sdio_pd"
665 void brcmf_sdio_exit(void)
667 brcmf_dbg(TRACE, "Enter\n");
669 sdio_unregister_driver(&brcmf_sdmmc_driver);
671 platform_driver_unregister(&brcmf_sdio_pd);
674 void brcmf_sdio_init(void)
678 brcmf_dbg(TRACE, "Enter\n");
680 ret = platform_driver_register(&brcmf_sdio_pd);
683 brcmf_dbg(ERROR, "platform_driver_register failed: %d\n", ret);
686 void brcmf_sdio_exit(void)
688 brcmf_dbg(TRACE, "Enter\n");
690 sdio_unregister_driver(&brcmf_sdmmc_driver);
693 void brcmf_sdio_init(void)
697 brcmf_dbg(TRACE, "Enter\n");
699 ret = sdio_register_driver(&brcmf_sdmmc_driver);
702 brcmf_dbg(ERROR, "sdio_register_driver failed: %d\n", ret);
704 #endif /* CONFIG_BRCMFMAC_SDIO_OOB */