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
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_4329
)},
54 {SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM
, SDIO_DEVICE_ID_BROADCOM_4330
)},
55 { /* end: all zeroes */ },
57 MODULE_DEVICE_TABLE(sdio
, brcmf_sdmmc_ids
);
59 #ifdef CONFIG_BRCMFMAC_SDIO_OOB
60 static struct list_head oobirq_lh
;
61 struct brcmf_sdio_oobirq
{
64 struct list_head list
;
66 #endif /* CONFIG_BRCMFMAC_SDIO_OOB */
69 brcmf_pm_resume_error(struct brcmf_sdio_dev
*sdiodev
)
72 #ifdef CONFIG_PM_SLEEP
73 is_err
= atomic_read(&sdiodev
->suspend
);
79 brcmf_pm_resume_wait(struct brcmf_sdio_dev
*sdiodev
, wait_queue_head_t
*wq
)
81 #ifdef CONFIG_PM_SLEEP
83 while (atomic_read(&sdiodev
->suspend
) && retry
++ != 30)
84 wait_event_timeout(*wq
, false, HZ
/100);
88 static inline int brcmf_sdioh_f0_write_byte(struct brcmf_sdio_dev
*sdiodev
,
89 uint regaddr
, u8
*byte
)
91 struct sdio_func
*sdfunc
= sdiodev
->func
[0];
95 * Can only directly write to some F0 registers.
96 * Handle F2 enable/disable and Abort command
99 if (regaddr
== SDIO_CCCR_IOEx
) {
100 sdfunc
= sdiodev
->func
[2];
102 sdio_claim_host(sdfunc
);
103 if (*byte
& SDIO_FUNC_ENABLE_2
) {
104 /* Enable Function 2 */
105 err_ret
= sdio_enable_func(sdfunc
);
108 "enable F2 failed:%d\n",
111 /* Disable Function 2 */
112 err_ret
= sdio_disable_func(sdfunc
);
115 "Disable F2 failed:%d\n",
118 sdio_release_host(sdfunc
);
120 } else if ((regaddr
== SDIO_CCCR_ABORT
) ||
121 (regaddr
== SDIO_CCCR_IENx
)) {
122 sdfunc
= kmemdup(sdiodev
->func
[0], sizeof(struct sdio_func
),
127 sdio_claim_host(sdfunc
);
128 sdio_writeb(sdfunc
, *byte
, regaddr
, &err_ret
);
129 sdio_release_host(sdfunc
);
131 } else if (regaddr
< 0xF0) {
132 brcmf_dbg(ERROR
, "F0 Wr:0x%02x: write disallowed\n", regaddr
);
135 sdio_claim_host(sdfunc
);
136 sdio_f0_writeb(sdfunc
, *byte
, regaddr
, &err_ret
);
137 sdio_release_host(sdfunc
);
143 int brcmf_sdioh_request_byte(struct brcmf_sdio_dev
*sdiodev
, uint rw
, uint func
,
144 uint regaddr
, u8
*byte
)
148 brcmf_dbg(INFO
, "rw=%d, func=%d, addr=0x%05x\n", rw
, func
, regaddr
);
150 brcmf_pm_resume_wait(sdiodev
, &sdiodev
->request_byte_wait
);
151 if (brcmf_pm_resume_error(sdiodev
))
154 if (rw
&& func
== 0) {
155 /* handle F0 separately */
156 err_ret
= brcmf_sdioh_f0_write_byte(sdiodev
, regaddr
, byte
);
158 sdio_claim_host(sdiodev
->func
[func
]);
159 if (rw
) /* CMD52 Write */
160 sdio_writeb(sdiodev
->func
[func
], *byte
, regaddr
,
162 else if (func
== 0) {
163 *byte
= sdio_f0_readb(sdiodev
->func
[func
], regaddr
,
166 *byte
= sdio_readb(sdiodev
->func
[func
], regaddr
,
169 sdio_release_host(sdiodev
->func
[func
]);
173 brcmf_dbg(ERROR
, "Failed to %s byte F%d:@0x%05x=%02x, Err: %d\n",
174 rw
? "write" : "read", func
, regaddr
, *byte
, err_ret
);
179 int brcmf_sdioh_request_word(struct brcmf_sdio_dev
*sdiodev
,
180 uint rw
, uint func
, uint addr
, u32
*word
,
186 brcmf_dbg(ERROR
, "Only CMD52 allowed to F0\n");
190 brcmf_dbg(INFO
, "rw=%d, func=%d, addr=0x%05x, nbytes=%d\n",
191 rw
, func
, addr
, nbytes
);
193 brcmf_pm_resume_wait(sdiodev
, &sdiodev
->request_word_wait
);
194 if (brcmf_pm_resume_error(sdiodev
))
196 /* Claim host controller */
197 sdio_claim_host(sdiodev
->func
[func
]);
199 if (rw
) { /* CMD52 Write */
201 sdio_writel(sdiodev
->func
[func
], *word
, addr
,
203 else if (nbytes
== 2)
204 sdio_writew(sdiodev
->func
[func
], (*word
& 0xFFFF),
207 brcmf_dbg(ERROR
, "Invalid nbytes: %d\n", nbytes
);
208 } else { /* CMD52 Read */
210 *word
= sdio_readl(sdiodev
->func
[func
], addr
, &err_ret
);
211 else if (nbytes
== 2)
212 *word
= sdio_readw(sdiodev
->func
[func
], addr
,
215 brcmf_dbg(ERROR
, "Invalid nbytes: %d\n", nbytes
);
218 /* Release host controller */
219 sdio_release_host(sdiodev
->func
[func
]);
222 brcmf_dbg(ERROR
, "Failed to %s word, Err: 0x%08x\n",
223 rw
? "write" : "read", err_ret
);
228 /* precondition: host controller is claimed */
230 brcmf_sdioh_request_data(struct brcmf_sdio_dev
*sdiodev
, uint write
, bool fifo
,
231 uint func
, uint addr
, struct sk_buff
*pkt
, uint pktlen
)
235 if ((write
) && (!fifo
)) {
236 err_ret
= sdio_memcpy_toio(sdiodev
->func
[func
], addr
,
237 ((u8
*) (pkt
->data
)), pktlen
);
239 err_ret
= sdio_memcpy_toio(sdiodev
->func
[func
], addr
,
240 ((u8
*) (pkt
->data
)), pktlen
);
242 err_ret
= sdio_readsb(sdiodev
->func
[func
],
243 ((u8
*) (pkt
->data
)), addr
, pktlen
);
245 err_ret
= sdio_memcpy_fromio(sdiodev
->func
[func
],
246 ((u8
*) (pkt
->data
)),
254 * This function takes a queue of packets. The packets on the queue
255 * are assumed to be properly aligned by the caller.
258 brcmf_sdioh_request_chain(struct brcmf_sdio_dev
*sdiodev
, uint fix_inc
,
259 uint write
, uint func
, uint addr
,
260 struct sk_buff_head
*pktq
)
262 bool fifo
= (fix_inc
== SDIOH_DATA_FIX
);
268 brcmf_dbg(TRACE
, "Enter\n");
270 brcmf_pm_resume_wait(sdiodev
, &sdiodev
->request_chain_wait
);
271 if (brcmf_pm_resume_error(sdiodev
))
274 /* Claim host controller */
275 sdio_claim_host(sdiodev
->func
[func
]);
277 skb_queue_walk(pktq
, pkt
) {
278 uint pkt_len
= pkt
->len
;
280 pkt_len
&= 0xFFFFFFFC;
282 err_ret
= brcmf_sdioh_request_data(sdiodev
, write
, fifo
, func
,
285 brcmf_dbg(ERROR
, "%s FAILED %p[%d], addr=0x%05x, pkt_len=%d, ERR=0x%08x\n",
286 write
? "TX" : "RX", pkt
, SGCount
, addr
,
289 brcmf_dbg(TRACE
, "%s xfr'd %p[%d], addr=0x%05x, len=%d\n",
290 write
? "TX" : "RX", pkt
, SGCount
, addr
,
299 /* Release host controller */
300 sdio_release_host(sdiodev
->func
[func
]);
302 brcmf_dbg(TRACE
, "Exit\n");
307 * This function takes a single DMA-able packet.
309 int brcmf_sdioh_request_buffer(struct brcmf_sdio_dev
*sdiodev
,
310 uint fix_inc
, uint write
, uint func
, uint addr
,
315 bool fifo
= (fix_inc
== SDIOH_DATA_FIX
);
317 brcmf_dbg(TRACE
, "Enter\n");
323 brcmf_pm_resume_wait(sdiodev
, &sdiodev
->request_buffer_wait
);
324 if (brcmf_pm_resume_error(sdiodev
))
327 /* Claim host controller */
328 sdio_claim_host(sdiodev
->func
[func
]);
333 status
= brcmf_sdioh_request_data(sdiodev
, write
, fifo
, func
,
336 brcmf_dbg(ERROR
, "%s FAILED %p, addr=0x%05x, pkt_len=%d, ERR=0x%08x\n",
337 write
? "TX" : "RX", pkt
, addr
, pkt_len
, status
);
339 brcmf_dbg(TRACE
, "%s xfr'd %p, addr=0x%05x, len=%d\n",
340 write
? "TX" : "RX", pkt
, addr
, pkt_len
);
343 /* Release host controller */
344 sdio_release_host(sdiodev
->func
[func
]);
349 /* Read client card reg */
351 brcmf_sdioh_card_regread(struct brcmf_sdio_dev
*sdiodev
, int func
, u32 regaddr
,
352 int regsize
, u32
*data
)
355 if ((func
== 0) || (regsize
== 1)) {
358 brcmf_sdioh_request_byte(sdiodev
, SDIOH_READ
, func
, regaddr
,
362 brcmf_dbg(DATA
, "byte read data=0x%02x\n", *data
);
364 brcmf_sdioh_request_word(sdiodev
, SDIOH_READ
, func
, regaddr
,
369 brcmf_dbg(DATA
, "word read data=0x%08x\n", *data
);
375 static int brcmf_sdioh_get_cisaddr(struct brcmf_sdio_dev
*sdiodev
, u32 regaddr
)
377 /* read 24 bits and return valid 17 bit addr */
379 u32 scratch
, regdata
;
381 u8
*ptr
= (u8
*)&scratch_le
;
383 for (i
= 0; i
< 3; i
++) {
384 if ((brcmf_sdioh_card_regread(sdiodev
, 0, regaddr
, 1,
385 ®data
)) != SUCCESS
)
386 brcmf_dbg(ERROR
, "Can't read!\n");
388 *ptr
++ = (u8
) regdata
;
392 /* Only the lower 17-bits are valid */
393 scratch
= le32_to_cpu(scratch_le
);
394 scratch
&= 0x0001FFFF;
398 static int brcmf_sdioh_enablefuncs(struct brcmf_sdio_dev
*sdiodev
)
404 brcmf_dbg(TRACE
, "\n");
406 /* Get the Card's common CIS address */
407 sdiodev
->func_cis_ptr
[0] = brcmf_sdioh_get_cisaddr(sdiodev
,
409 brcmf_dbg(INFO
, "Card's Common CIS Ptr = 0x%x\n",
410 sdiodev
->func_cis_ptr
[0]);
412 /* Get the Card's function CIS (for each function) */
413 for (fbraddr
= SDIO_FBR_BASE(1), func
= 1;
414 func
<= sdiodev
->num_funcs
; func
++, fbraddr
+= SDIOD_FBR_SIZE
) {
415 sdiodev
->func_cis_ptr
[func
] =
416 brcmf_sdioh_get_cisaddr(sdiodev
, SDIO_FBR_CIS
+ fbraddr
);
417 brcmf_dbg(INFO
, "Function %d CIS Ptr = 0x%x\n",
418 func
, sdiodev
->func_cis_ptr
[func
]);
421 /* Enable Function 1 */
422 sdio_claim_host(sdiodev
->func
[1]);
423 err_ret
= sdio_enable_func(sdiodev
->func
[1]);
424 sdio_release_host(sdiodev
->func
[1]);
426 brcmf_dbg(ERROR
, "Failed to enable F1 Err: 0x%08x\n", err_ret
);
432 * Public entry points & extern's
434 int brcmf_sdioh_attach(struct brcmf_sdio_dev
*sdiodev
)
438 brcmf_dbg(TRACE
, "\n");
440 sdiodev
->num_funcs
= 2;
442 sdio_claim_host(sdiodev
->func
[1]);
443 err_ret
= sdio_set_block_size(sdiodev
->func
[1], SDIO_FUNC1_BLOCKSIZE
);
444 sdio_release_host(sdiodev
->func
[1]);
446 brcmf_dbg(ERROR
, "Failed to set F1 blocksize\n");
450 sdio_claim_host(sdiodev
->func
[2]);
451 err_ret
= sdio_set_block_size(sdiodev
->func
[2], SDIO_FUNC2_BLOCKSIZE
);
452 sdio_release_host(sdiodev
->func
[2]);
454 brcmf_dbg(ERROR
, "Failed to set F2 blocksize\n");
458 brcmf_sdioh_enablefuncs(sdiodev
);
461 brcmf_dbg(TRACE
, "Done\n");
465 void brcmf_sdioh_detach(struct brcmf_sdio_dev
*sdiodev
)
467 brcmf_dbg(TRACE
, "\n");
469 /* Disable Function 2 */
470 sdio_claim_host(sdiodev
->func
[2]);
471 sdio_disable_func(sdiodev
->func
[2]);
472 sdio_release_host(sdiodev
->func
[2]);
474 /* Disable Function 1 */
475 sdio_claim_host(sdiodev
->func
[1]);
476 sdio_disable_func(sdiodev
->func
[1]);
477 sdio_release_host(sdiodev
->func
[1]);
481 #ifdef CONFIG_BRCMFMAC_SDIO_OOB
482 static int brcmf_sdio_getintrcfg(struct brcmf_sdio_dev
*sdiodev
)
484 struct brcmf_sdio_oobirq
*oobirq_entry
;
486 if (list_empty(&oobirq_lh
)) {
487 brcmf_dbg(ERROR
, "no valid oob irq resource\n");
491 oobirq_entry
= list_first_entry(&oobirq_lh
, struct brcmf_sdio_oobirq
,
494 sdiodev
->irq
= oobirq_entry
->irq
;
495 sdiodev
->irq_flags
= oobirq_entry
->flags
;
496 list_del(&oobirq_entry
->list
);
502 static inline int brcmf_sdio_getintrcfg(struct brcmf_sdio_dev
*sdiodev
)
506 #endif /* CONFIG_BRCMFMAC_SDIO_OOB */
508 static int brcmf_ops_sdio_probe(struct sdio_func
*func
,
509 const struct sdio_device_id
*id
)
512 struct brcmf_sdio_dev
*sdiodev
;
513 struct brcmf_bus
*bus_if
;
515 brcmf_dbg(TRACE
, "Enter\n");
516 brcmf_dbg(TRACE
, "func->class=%x\n", func
->class);
517 brcmf_dbg(TRACE
, "sdio_vendor: 0x%04x\n", func
->vendor
);
518 brcmf_dbg(TRACE
, "sdio_device: 0x%04x\n", func
->device
);
519 brcmf_dbg(TRACE
, "Function#: 0x%04x\n", func
->num
);
521 if (func
->num
== 1) {
522 if (dev_get_drvdata(&func
->card
->dev
)) {
523 brcmf_dbg(ERROR
, "card private drvdata occupied\n");
526 bus_if
= kzalloc(sizeof(struct brcmf_bus
), GFP_KERNEL
);
529 sdiodev
= kzalloc(sizeof(struct brcmf_sdio_dev
), GFP_KERNEL
);
534 sdiodev
->func
[0] = func
;
535 sdiodev
->func
[1] = func
;
536 sdiodev
->bus_if
= bus_if
;
537 bus_if
->bus_priv
.sdio
= sdiodev
;
538 bus_if
->type
= SDIO_BUS
;
539 bus_if
->align
= BRCMF_SDALIGN
;
540 dev_set_drvdata(&func
->card
->dev
, sdiodev
);
542 atomic_set(&sdiodev
->suspend
, false);
543 init_waitqueue_head(&sdiodev
->request_byte_wait
);
544 init_waitqueue_head(&sdiodev
->request_word_wait
);
545 init_waitqueue_head(&sdiodev
->request_chain_wait
);
546 init_waitqueue_head(&sdiodev
->request_buffer_wait
);
549 if (func
->num
== 2) {
550 sdiodev
= dev_get_drvdata(&func
->card
->dev
);
551 if ((!sdiodev
) || (sdiodev
->func
[1]->card
!= func
->card
))
554 ret
= brcmf_sdio_getintrcfg(sdiodev
);
557 sdiodev
->func
[2] = func
;
559 bus_if
= sdiodev
->bus_if
;
560 sdiodev
->dev
= &func
->dev
;
561 dev_set_drvdata(&func
->dev
, bus_if
);
563 brcmf_dbg(TRACE
, "F2 found, calling brcmf_sdio_probe...\n");
564 ret
= brcmf_sdio_probe(sdiodev
);
570 static void brcmf_ops_sdio_remove(struct sdio_func
*func
)
572 struct brcmf_bus
*bus_if
;
573 struct brcmf_sdio_dev
*sdiodev
;
574 brcmf_dbg(TRACE
, "Enter\n");
575 brcmf_dbg(INFO
, "func->class=%x\n", func
->class);
576 brcmf_dbg(INFO
, "sdio_vendor: 0x%04x\n", func
->vendor
);
577 brcmf_dbg(INFO
, "sdio_device: 0x%04x\n", func
->device
);
578 brcmf_dbg(INFO
, "Function#: 0x%04x\n", func
->num
);
580 if (func
->num
== 2) {
581 bus_if
= dev_get_drvdata(&func
->dev
);
582 sdiodev
= bus_if
->bus_priv
.sdio
;
583 brcmf_dbg(TRACE
, "F2 found, calling brcmf_sdio_remove...\n");
584 brcmf_sdio_remove(sdiodev
);
585 dev_set_drvdata(&func
->card
->dev
, NULL
);
586 dev_set_drvdata(&func
->dev
, NULL
);
592 #ifdef CONFIG_PM_SLEEP
593 static int brcmf_sdio_suspend(struct device
*dev
)
595 mmc_pm_flag_t sdio_flags
;
596 struct sdio_func
*func
= dev_to_sdio_func(dev
);
597 struct brcmf_sdio_dev
*sdiodev
= dev_get_drvdata(&func
->card
->dev
);
600 brcmf_dbg(TRACE
, "\n");
602 atomic_set(&sdiodev
->suspend
, true);
604 sdio_flags
= sdio_get_host_pm_caps(sdiodev
->func
[1]);
605 if (!(sdio_flags
& MMC_PM_KEEP_POWER
)) {
606 brcmf_dbg(ERROR
, "Host can't keep power while suspended\n");
610 ret
= sdio_set_host_pm_flags(sdiodev
->func
[1], MMC_PM_KEEP_POWER
);
612 brcmf_dbg(ERROR
, "Failed to set pm_flags\n");
616 brcmf_sdio_wdtmr_enable(sdiodev
, false);
621 static int brcmf_sdio_resume(struct device
*dev
)
623 struct sdio_func
*func
= dev_to_sdio_func(dev
);
624 struct brcmf_sdio_dev
*sdiodev
= dev_get_drvdata(&func
->card
->dev
);
626 brcmf_sdio_wdtmr_enable(sdiodev
, true);
627 atomic_set(&sdiodev
->suspend
, false);
631 static const struct dev_pm_ops brcmf_sdio_pm_ops
= {
632 .suspend
= brcmf_sdio_suspend
,
633 .resume
= brcmf_sdio_resume
,
635 #endif /* CONFIG_PM_SLEEP */
637 static struct sdio_driver brcmf_sdmmc_driver
= {
638 .probe
= brcmf_ops_sdio_probe
,
639 .remove
= brcmf_ops_sdio_remove
,
641 .id_table
= brcmf_sdmmc_ids
,
642 #ifdef CONFIG_PM_SLEEP
644 .pm
= &brcmf_sdio_pm_ops
,
646 #endif /* CONFIG_PM_SLEEP */
649 #ifdef CONFIG_BRCMFMAC_SDIO_OOB
650 static int brcmf_sdio_pd_probe(struct platform_device
*pdev
)
652 struct resource
*res
;
653 struct brcmf_sdio_oobirq
*oobirq_entry
;
656 INIT_LIST_HEAD(&oobirq_lh
);
659 res
= platform_get_resource(pdev
, IORESOURCE_IRQ
, i
);
663 oobirq_entry
= kzalloc(sizeof(struct brcmf_sdio_oobirq
),
665 oobirq_entry
->irq
= res
->start
;
666 oobirq_entry
->flags
= res
->flags
& IRQF_TRIGGER_MASK
;
667 list_add_tail(&oobirq_entry
->list
, &oobirq_lh
);
672 ret
= sdio_register_driver(&brcmf_sdmmc_driver
);
675 brcmf_dbg(ERROR
, "sdio_register_driver failed: %d\n", ret
);
680 static struct platform_driver brcmf_sdio_pd
= {
681 .probe
= brcmf_sdio_pd_probe
,
683 .name
= "brcmf_sdio_pd"
687 void brcmf_sdio_exit(void)
689 brcmf_dbg(TRACE
, "Enter\n");
691 sdio_unregister_driver(&brcmf_sdmmc_driver
);
693 platform_driver_unregister(&brcmf_sdio_pd
);
696 void brcmf_sdio_init(void)
700 brcmf_dbg(TRACE
, "Enter\n");
702 ret
= platform_driver_register(&brcmf_sdio_pd
);
705 brcmf_dbg(ERROR
, "platform_driver_register failed: %d\n", ret
);
708 void brcmf_sdio_exit(void)
710 brcmf_dbg(TRACE
, "Enter\n");
712 sdio_unregister_driver(&brcmf_sdmmc_driver
);
715 void brcmf_sdio_init(void)
719 brcmf_dbg(TRACE
, "Enter\n");
721 ret
= sdio_register_driver(&brcmf_sdmmc_driver
);
724 brcmf_dbg(ERROR
, "sdio_register_driver failed: %d\n", ret
);
726 #endif /* CONFIG_BRCMFMAC_SDIO_OOB */