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 <net/cfg80211.h>
33 #include <brcm_hw_ids.h>
34 #include <brcmu_utils.h>
35 #include <brcmu_wifi.h>
36 #include "sdio_host.h"
40 #define SDIO_VENDOR_ID_BROADCOM 0x02d0
42 #define DMA_ALIGN_MASK 0x03
44 #define SDIO_DEVICE_ID_BROADCOM_4329 0x4329
45 #define SDIO_DEVICE_ID_BROADCOM_4330 0x4330
47 #define SDIO_FUNC1_BLOCKSIZE 64
48 #define SDIO_FUNC2_BLOCKSIZE 512
50 /* devices we support, null terminated */
51 static const struct sdio_device_id brcmf_sdmmc_ids[] = {
52 {SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM, SDIO_DEVICE_ID_BROADCOM_4329)},
53 {SDIO_DEVICE(SDIO_VENDOR_ID_BROADCOM, SDIO_DEVICE_ID_BROADCOM_4330)},
54 { /* end: all zeroes */ },
56 MODULE_DEVICE_TABLE(sdio, brcmf_sdmmc_ids);
59 brcmf_pm_resume_error(struct brcmf_sdio_dev *sdiodev)
62 #ifdef CONFIG_PM_SLEEP
63 is_err = atomic_read(&sdiodev->suspend);
69 brcmf_pm_resume_wait(struct brcmf_sdio_dev *sdiodev, wait_queue_head_t *wq)
71 #ifdef CONFIG_PM_SLEEP
73 while (atomic_read(&sdiodev->suspend) && retry++ != 30)
74 wait_event_timeout(*wq, false, HZ/100);
78 static inline int brcmf_sdioh_f0_write_byte(struct brcmf_sdio_dev *sdiodev,
79 uint regaddr, u8 *byte)
81 struct sdio_func *sdfunc = sdiodev->func[0];
85 * Can only directly write to some F0 registers.
86 * Handle F2 enable/disable and Abort command
89 if (regaddr == SDIO_CCCR_IOEx) {
90 sdfunc = sdiodev->func[2];
92 sdio_claim_host(sdfunc);
93 if (*byte & SDIO_FUNC_ENABLE_2) {
94 /* Enable Function 2 */
95 err_ret = sdio_enable_func(sdfunc);
98 "enable F2 failed:%d\n",
101 /* Disable Function 2 */
102 err_ret = sdio_disable_func(sdfunc);
105 "Disable F2 failed:%d\n",
108 sdio_release_host(sdfunc);
110 } else if (regaddr == SDIO_CCCR_ABORT) {
111 sdio_claim_host(sdfunc);
112 sdio_writeb(sdfunc, *byte, regaddr, &err_ret);
113 sdio_release_host(sdfunc);
114 } else if (regaddr < 0xF0) {
115 brcmf_dbg(ERROR, "F0 Wr:0x%02x: write disallowed\n", regaddr);
118 sdio_claim_host(sdfunc);
119 sdio_f0_writeb(sdfunc, *byte, regaddr, &err_ret);
120 sdio_release_host(sdfunc);
126 int brcmf_sdioh_request_byte(struct brcmf_sdio_dev *sdiodev, uint rw, uint func,
127 uint regaddr, u8 *byte)
131 brcmf_dbg(INFO, "rw=%d, func=%d, addr=0x%05x\n", rw, func, regaddr);
133 brcmf_pm_resume_wait(sdiodev, &sdiodev->request_byte_wait);
134 if (brcmf_pm_resume_error(sdiodev))
137 if (rw && func == 0) {
138 /* handle F0 separately */
139 err_ret = brcmf_sdioh_f0_write_byte(sdiodev, regaddr, byte);
141 sdio_claim_host(sdiodev->func[func]);
142 if (rw) /* CMD52 Write */
143 sdio_writeb(sdiodev->func[func], *byte, regaddr,
145 else if (func == 0) {
146 *byte = sdio_f0_readb(sdiodev->func[func], regaddr,
149 *byte = sdio_readb(sdiodev->func[func], regaddr,
152 sdio_release_host(sdiodev->func[func]);
156 brcmf_dbg(ERROR, "Failed to %s byte F%d:@0x%05x=%02x, Err: %d\n",
157 rw ? "write" : "read", func, regaddr, *byte, err_ret);
162 int brcmf_sdioh_request_word(struct brcmf_sdio_dev *sdiodev,
163 uint rw, uint func, uint addr, u32 *word,
169 brcmf_dbg(ERROR, "Only CMD52 allowed to F0\n");
173 brcmf_dbg(INFO, "rw=%d, func=%d, addr=0x%05x, nbytes=%d\n",
174 rw, func, addr, nbytes);
176 brcmf_pm_resume_wait(sdiodev, &sdiodev->request_word_wait);
177 if (brcmf_pm_resume_error(sdiodev))
179 /* Claim host controller */
180 sdio_claim_host(sdiodev->func[func]);
182 if (rw) { /* CMD52 Write */
184 sdio_writel(sdiodev->func[func], *word, addr,
186 else if (nbytes == 2)
187 sdio_writew(sdiodev->func[func], (*word & 0xFFFF),
190 brcmf_dbg(ERROR, "Invalid nbytes: %d\n", nbytes);
191 } else { /* CMD52 Read */
193 *word = sdio_readl(sdiodev->func[func], addr, &err_ret);
194 else if (nbytes == 2)
195 *word = sdio_readw(sdiodev->func[func], addr,
198 brcmf_dbg(ERROR, "Invalid nbytes: %d\n", nbytes);
201 /* Release host controller */
202 sdio_release_host(sdiodev->func[func]);
205 brcmf_dbg(ERROR, "Failed to %s word, Err: 0x%08x\n",
206 rw ? "write" : "read", err_ret);
211 /* precondition: host controller is claimed */
213 brcmf_sdioh_request_data(struct brcmf_sdio_dev *sdiodev, uint write, bool fifo,
214 uint func, uint addr, struct sk_buff *pkt, uint pktlen)
218 if ((write) && (!fifo)) {
219 err_ret = sdio_memcpy_toio(sdiodev->func[func], addr,
220 ((u8 *) (pkt->data)), pktlen);
222 err_ret = sdio_memcpy_toio(sdiodev->func[func], addr,
223 ((u8 *) (pkt->data)), pktlen);
225 err_ret = sdio_readsb(sdiodev->func[func],
226 ((u8 *) (pkt->data)), addr, pktlen);
228 err_ret = sdio_memcpy_fromio(sdiodev->func[func],
229 ((u8 *) (pkt->data)),
237 * This function takes a queue of packets. The packets on the queue
238 * are assumed to be properly aligned by the caller.
241 brcmf_sdioh_request_chain(struct brcmf_sdio_dev *sdiodev, uint fix_inc,
242 uint write, uint func, uint addr,
243 struct sk_buff_head *pktq)
245 bool fifo = (fix_inc == SDIOH_DATA_FIX);
251 brcmf_dbg(TRACE, "Enter\n");
253 brcmf_pm_resume_wait(sdiodev, &sdiodev->request_chain_wait);
254 if (brcmf_pm_resume_error(sdiodev))
257 /* Claim host controller */
258 sdio_claim_host(sdiodev->func[func]);
260 skb_queue_walk(pktq, pkt) {
261 uint pkt_len = pkt->len;
263 pkt_len &= 0xFFFFFFFC;
265 err_ret = brcmf_sdioh_request_data(sdiodev, write, fifo, func,
268 brcmf_dbg(ERROR, "%s FAILED %p[%d], addr=0x%05x, pkt_len=%d, ERR=0x%08x\n",
269 write ? "TX" : "RX", pkt, SGCount, addr,
272 brcmf_dbg(TRACE, "%s xfr'd %p[%d], addr=0x%05x, len=%d\n",
273 write ? "TX" : "RX", pkt, SGCount, addr,
282 /* Release host controller */
283 sdio_release_host(sdiodev->func[func]);
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))
310 /* Claim host controller */
311 sdio_claim_host(sdiodev->func[func]);
316 status = brcmf_sdioh_request_data(sdiodev, write, fifo, func,
319 brcmf_dbg(ERROR, "%s FAILED %p, addr=0x%05x, pkt_len=%d, ERR=0x%08x\n",
320 write ? "TX" : "RX", pkt, addr, pkt_len, status);
322 brcmf_dbg(TRACE, "%s xfr'd %p, addr=0x%05x, len=%d\n",
323 write ? "TX" : "RX", pkt, addr, pkt_len);
326 /* Release host controller */
327 sdio_release_host(sdiodev->func[func]);
332 /* Read client card reg */
334 brcmf_sdioh_card_regread(struct brcmf_sdio_dev *sdiodev, int func, u32 regaddr,
335 int regsize, u32 *data)
338 if ((func == 0) || (regsize == 1)) {
341 brcmf_sdioh_request_byte(sdiodev, SDIOH_READ, func, regaddr,
345 brcmf_dbg(DATA, "byte read data=0x%02x\n", *data);
347 brcmf_sdioh_request_word(sdiodev, SDIOH_READ, func, regaddr,
352 brcmf_dbg(DATA, "word read data=0x%08x\n", *data);
358 static int brcmf_sdioh_get_cisaddr(struct brcmf_sdio_dev *sdiodev, u32 regaddr)
360 /* read 24 bits and return valid 17 bit addr */
362 u32 scratch, regdata;
364 u8 *ptr = (u8 *)&scratch_le;
366 for (i = 0; i < 3; i++) {
367 if ((brcmf_sdioh_card_regread(sdiodev, 0, regaddr, 1,
368 ®data)) != SUCCESS)
369 brcmf_dbg(ERROR, "Can't read!\n");
371 *ptr++ = (u8) regdata;
375 /* Only the lower 17-bits are valid */
376 scratch = le32_to_cpu(scratch_le);
377 scratch &= 0x0001FFFF;
381 static int brcmf_sdioh_enablefuncs(struct brcmf_sdio_dev *sdiodev)
387 brcmf_dbg(TRACE, "\n");
389 /* Get the Card's common CIS address */
390 sdiodev->func_cis_ptr[0] = brcmf_sdioh_get_cisaddr(sdiodev,
392 brcmf_dbg(INFO, "Card's Common CIS Ptr = 0x%x\n",
393 sdiodev->func_cis_ptr[0]);
395 /* Get the Card's function CIS (for each function) */
396 for (fbraddr = SDIO_FBR_BASE(1), func = 1;
397 func <= sdiodev->num_funcs; func++, fbraddr += SDIOD_FBR_SIZE) {
398 sdiodev->func_cis_ptr[func] =
399 brcmf_sdioh_get_cisaddr(sdiodev, SDIO_FBR_CIS + fbraddr);
400 brcmf_dbg(INFO, "Function %d CIS Ptr = 0x%x\n",
401 func, sdiodev->func_cis_ptr[func]);
404 /* Enable Function 1 */
405 sdio_claim_host(sdiodev->func[1]);
406 err_ret = sdio_enable_func(sdiodev->func[1]);
407 sdio_release_host(sdiodev->func[1]);
409 brcmf_dbg(ERROR, "Failed to enable F1 Err: 0x%08x\n", err_ret);
415 * Public entry points & extern's
417 int brcmf_sdioh_attach(struct brcmf_sdio_dev *sdiodev)
421 brcmf_dbg(TRACE, "\n");
423 sdiodev->num_funcs = 2;
425 sdio_claim_host(sdiodev->func[1]);
426 err_ret = sdio_set_block_size(sdiodev->func[1], SDIO_FUNC1_BLOCKSIZE);
427 sdio_release_host(sdiodev->func[1]);
429 brcmf_dbg(ERROR, "Failed to set F1 blocksize\n");
433 sdio_claim_host(sdiodev->func[2]);
434 err_ret = sdio_set_block_size(sdiodev->func[2], SDIO_FUNC2_BLOCKSIZE);
435 sdio_release_host(sdiodev->func[2]);
437 brcmf_dbg(ERROR, "Failed to set F2 blocksize\n");
441 brcmf_sdioh_enablefuncs(sdiodev);
444 brcmf_dbg(TRACE, "Done\n");
448 void brcmf_sdioh_detach(struct brcmf_sdio_dev *sdiodev)
450 brcmf_dbg(TRACE, "\n");
452 /* Disable Function 2 */
453 sdio_claim_host(sdiodev->func[2]);
454 sdio_disable_func(sdiodev->func[2]);
455 sdio_release_host(sdiodev->func[2]);
457 /* Disable Function 1 */
458 sdio_claim_host(sdiodev->func[1]);
459 sdio_disable_func(sdiodev->func[1]);
460 sdio_release_host(sdiodev->func[1]);
464 static int brcmf_ops_sdio_probe(struct sdio_func *func,
465 const struct sdio_device_id *id)
468 struct brcmf_sdio_dev *sdiodev;
469 struct brcmf_bus *bus_if;
470 brcmf_dbg(TRACE, "Enter\n");
471 brcmf_dbg(TRACE, "func->class=%x\n", func->class);
472 brcmf_dbg(TRACE, "sdio_vendor: 0x%04x\n", func->vendor);
473 brcmf_dbg(TRACE, "sdio_device: 0x%04x\n", func->device);
474 brcmf_dbg(TRACE, "Function#: 0x%04x\n", func->num);
476 if (func->num == 1) {
477 if (dev_get_drvdata(&func->card->dev)) {
478 brcmf_dbg(ERROR, "card private drvdata occupied\n");
481 bus_if = kzalloc(sizeof(struct brcmf_bus), GFP_KERNEL);
484 sdiodev = kzalloc(sizeof(struct brcmf_sdio_dev), GFP_KERNEL);
489 sdiodev->func[0] = func->card->sdio_func[0];
490 sdiodev->func[1] = func;
491 sdiodev->bus_if = bus_if;
492 bus_if->bus_priv.sdio = sdiodev;
493 bus_if->type = SDIO_BUS;
494 bus_if->align = BRCMF_SDALIGN;
495 dev_set_drvdata(&func->card->dev, sdiodev);
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);
504 if (func->num == 2) {
505 sdiodev = dev_get_drvdata(&func->card->dev);
506 if ((!sdiodev) || (sdiodev->func[1]->card != func->card))
508 sdiodev->func[2] = func;
510 bus_if = sdiodev->bus_if;
511 sdiodev->dev = &func->dev;
512 dev_set_drvdata(&func->dev, bus_if);
514 brcmf_dbg(TRACE, "F2 found, calling brcmf_sdio_probe...\n");
515 ret = brcmf_sdio_probe(sdiodev);
521 static void brcmf_ops_sdio_remove(struct sdio_func *func)
523 struct brcmf_bus *bus_if;
524 struct brcmf_sdio_dev *sdiodev;
525 brcmf_dbg(TRACE, "Enter\n");
526 brcmf_dbg(INFO, "func->class=%x\n", func->class);
527 brcmf_dbg(INFO, "sdio_vendor: 0x%04x\n", func->vendor);
528 brcmf_dbg(INFO, "sdio_device: 0x%04x\n", func->device);
529 brcmf_dbg(INFO, "Function#: 0x%04x\n", func->num);
531 if (func->num == 2) {
532 bus_if = dev_get_drvdata(&func->dev);
533 sdiodev = bus_if->bus_priv.sdio;
534 brcmf_dbg(TRACE, "F2 found, calling brcmf_sdio_remove...\n");
535 brcmf_sdio_remove(sdiodev);
536 dev_set_drvdata(&func->card->dev, NULL);
537 dev_set_drvdata(&func->dev, NULL);
543 #ifdef CONFIG_PM_SLEEP
544 static int brcmf_sdio_suspend(struct device *dev)
546 mmc_pm_flag_t sdio_flags;
547 struct sdio_func *func = dev_to_sdio_func(dev);
548 struct brcmf_sdio_dev *sdiodev = dev_get_drvdata(&func->card->dev);
551 brcmf_dbg(TRACE, "\n");
553 atomic_set(&sdiodev->suspend, true);
555 sdio_flags = sdio_get_host_pm_caps(sdiodev->func[1]);
556 if (!(sdio_flags & MMC_PM_KEEP_POWER)) {
557 brcmf_dbg(ERROR, "Host can't keep power while suspended\n");
561 ret = sdio_set_host_pm_flags(sdiodev->func[1], MMC_PM_KEEP_POWER);
563 brcmf_dbg(ERROR, "Failed to set pm_flags\n");
567 brcmf_sdio_wdtmr_enable(sdiodev, false);
572 static int brcmf_sdio_resume(struct device *dev)
574 struct sdio_func *func = dev_to_sdio_func(dev);
575 struct brcmf_sdio_dev *sdiodev = dev_get_drvdata(&func->card->dev);
577 brcmf_sdio_wdtmr_enable(sdiodev, true);
578 atomic_set(&sdiodev->suspend, false);
582 static const struct dev_pm_ops brcmf_sdio_pm_ops = {
583 .suspend = brcmf_sdio_suspend,
584 .resume = brcmf_sdio_resume,
586 #endif /* CONFIG_PM_SLEEP */
588 static struct sdio_driver brcmf_sdmmc_driver = {
589 .probe = brcmf_ops_sdio_probe,
590 .remove = brcmf_ops_sdio_remove,
592 .id_table = brcmf_sdmmc_ids,
593 #ifdef CONFIG_PM_SLEEP
595 .pm = &brcmf_sdio_pm_ops,
597 #endif /* CONFIG_PM_SLEEP */
600 void brcmf_sdio_exit(void)
602 brcmf_dbg(TRACE, "Enter\n");
604 sdio_unregister_driver(&brcmf_sdmmc_driver);
607 void brcmf_sdio_init(void)
611 brcmf_dbg(TRACE, "Enter\n");
613 ret = sdio_register_driver(&brcmf_sdmmc_driver);
616 brcmf_dbg(ERROR, "sdio_register_driver failed: %d\n", ret);