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.
16 /* ****************** SDIO CARD Interface Functions **************************/
18 #include <linux/types.h>
19 #include <linux/netdevice.h>
20 #include <linux/export.h>
21 #include <linux/pci.h>
22 #include <linux/pci_ids.h>
23 #include <linux/sched.h>
24 #include <linux/completion.h>
25 #include <linux/mmc/sdio.h>
26 #include <linux/mmc/sdio_func.h>
27 #include <linux/mmc/card.h>
28 #include <linux/platform_data/brcmfmac-sdio.h>
31 #include <brcm_hw_ids.h>
32 #include <brcmu_utils.h>
33 #include <brcmu_wifi.h>
37 #include "sdio_host.h"
39 #define SDIOH_API_ACCESS_RETRY_LIMIT 2
42 static irqreturn_t brcmf_sdio_oob_irqhandler(int irq, void *dev_id)
44 struct brcmf_bus *bus_if = dev_get_drvdata(dev_id);
45 struct brcmf_sdio_dev *sdiodev = bus_if->bus_priv.sdio;
47 brcmf_dbg(INTR, "OOB intr triggered\n");
49 /* out-of-band interrupt is level-triggered which won't
50 * be cleared until dpc
52 if (sdiodev->irq_en) {
53 disable_irq_nosync(irq);
54 sdiodev->irq_en = false;
57 brcmf_sdbrcm_isr(sdiodev->bus);
62 static void brcmf_sdio_ib_irqhandler(struct sdio_func *func)
64 struct brcmf_bus *bus_if = dev_get_drvdata(&func->dev);
65 struct brcmf_sdio_dev *sdiodev = bus_if->bus_priv.sdio;
67 brcmf_dbg(INTR, "IB intr triggered\n");
69 brcmf_sdbrcm_isr(sdiodev->bus);
72 /* dummy handler for SDIO function 2 interrupt */
73 static void brcmf_sdio_dummy_irqhandler(struct sdio_func *func)
77 int brcmf_sdio_intr_register(struct brcmf_sdio_dev *sdiodev)
83 if ((sdiodev->pdata) && (sdiodev->pdata->oob_irq_supported)) {
84 brcmf_dbg(SDIO, "Enter, register OOB IRQ %d\n",
85 sdiodev->pdata->oob_irq_nr);
86 ret = request_irq(sdiodev->pdata->oob_irq_nr,
87 brcmf_sdio_oob_irqhandler,
88 sdiodev->pdata->oob_irq_flags,
90 &sdiodev->func[1]->dev);
92 brcmf_err("request_irq failed %d\n", ret);
95 sdiodev->oob_irq_requested = true;
96 spin_lock_init(&sdiodev->irq_en_lock);
97 spin_lock_irqsave(&sdiodev->irq_en_lock, flags);
98 sdiodev->irq_en = true;
99 spin_unlock_irqrestore(&sdiodev->irq_en_lock, flags);
101 ret = enable_irq_wake(sdiodev->pdata->oob_irq_nr);
103 brcmf_err("enable_irq_wake failed %d\n", ret);
106 sdiodev->irq_wake = true;
108 sdio_claim_host(sdiodev->func[1]);
110 /* must configure SDIO_CCCR_IENx to enable irq */
111 data = brcmf_sdio_regrb(sdiodev, SDIO_CCCR_IENx, &ret);
112 data |= 1 << SDIO_FUNC_1 | 1 << SDIO_FUNC_2 | 1;
113 brcmf_sdio_regwb(sdiodev, SDIO_CCCR_IENx, data, &ret);
115 /* redirect, configure and enable io for interrupt signal */
116 data = SDIO_SEPINT_MASK | SDIO_SEPINT_OE;
117 if (sdiodev->pdata->oob_irq_flags & IRQF_TRIGGER_HIGH)
118 data |= SDIO_SEPINT_ACT_HI;
119 brcmf_sdio_regwb(sdiodev, SDIO_CCCR_BRCM_SEPINT, data, &ret);
121 sdio_release_host(sdiodev->func[1]);
123 brcmf_dbg(SDIO, "Entering\n");
124 sdio_claim_host(sdiodev->func[1]);
125 sdio_claim_irq(sdiodev->func[1], brcmf_sdio_ib_irqhandler);
126 sdio_claim_irq(sdiodev->func[2], brcmf_sdio_dummy_irqhandler);
127 sdio_release_host(sdiodev->func[1]);
133 int brcmf_sdio_intr_unregister(struct brcmf_sdio_dev *sdiodev)
135 brcmf_dbg(SDIO, "Entering\n");
137 if ((sdiodev->pdata) && (sdiodev->pdata->oob_irq_supported)) {
138 sdio_claim_host(sdiodev->func[1]);
139 brcmf_sdio_regwb(sdiodev, SDIO_CCCR_BRCM_SEPINT, 0, NULL);
140 brcmf_sdio_regwb(sdiodev, SDIO_CCCR_IENx, 0, NULL);
141 sdio_release_host(sdiodev->func[1]);
143 if (sdiodev->oob_irq_requested) {
144 sdiodev->oob_irq_requested = false;
145 if (sdiodev->irq_wake) {
146 disable_irq_wake(sdiodev->pdata->oob_irq_nr);
147 sdiodev->irq_wake = false;
149 free_irq(sdiodev->pdata->oob_irq_nr,
150 &sdiodev->func[1]->dev);
151 sdiodev->irq_en = false;
154 sdio_claim_host(sdiodev->func[1]);
155 sdio_release_irq(sdiodev->func[2]);
156 sdio_release_irq(sdiodev->func[1]);
157 sdio_release_host(sdiodev->func[1]);
164 brcmf_sdcard_set_sbaddr_window(struct brcmf_sdio_dev *sdiodev, u32 address)
170 addr[0] = (address >> 8) & SBSDIO_SBADDRLOW_MASK;
171 addr[1] = (address >> 16) & SBSDIO_SBADDRMID_MASK;
172 addr[2] = (address >> 24) & SBSDIO_SBADDRHIGH_MASK;
174 for (i = 0; i < 3; i++) {
178 usleep_range(1000, 2000);
179 err = brcmf_sdioh_request_byte(sdiodev, SDIOH_WRITE,
180 SDIO_FUNC_1, SBSDIO_FUNC1_SBADDRLOW + i,
182 } while (err != 0 && retry++ < SDIOH_API_ACCESS_RETRY_LIMIT);
185 brcmf_err("failed at addr:0x%0x\n",
186 SBSDIO_FUNC1_SBADDRLOW + i);
195 brcmf_sdio_regrw_helper(struct brcmf_sdio_dev *sdiodev, u32 addr,
196 void *data, bool write)
198 u8 func_num, reg_size;
204 * figure out how to read the register based on address range
205 * 0x00 ~ 0x7FF: function 0 CCCR and FBR
206 * 0x10000 ~ 0x1FFFF: function 1 miscellaneous registers
207 * The rest: function 1 silicon backplane core registers
209 if ((addr & ~REG_F0_REG_MASK) == 0) {
210 func_num = SDIO_FUNC_0;
212 } else if ((addr & ~REG_F1_MISC_MASK) == 0) {
213 func_num = SDIO_FUNC_1;
216 func_num = SDIO_FUNC_1;
219 /* Set the window for SB core register */
220 bar = addr & ~SBSDIO_SB_OFT_ADDR_MASK;
221 if (bar != sdiodev->sbwad) {
222 ret = brcmf_sdcard_set_sbaddr_window(sdiodev, bar);
224 memset(data, 0xFF, reg_size);
227 sdiodev->sbwad = bar;
229 addr &= SBSDIO_SB_OFT_ADDR_MASK;
230 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
235 memset(data, 0, reg_size);
236 if (retry) /* wait for 1 ms till bus get settled down */
237 usleep_range(1000, 2000);
239 ret = brcmf_sdioh_request_byte(sdiodev, write,
240 func_num, addr, data);
242 ret = brcmf_sdioh_request_word(sdiodev, write,
243 func_num, addr, data, 4);
244 } while (ret != 0 && retry++ < SDIOH_API_ACCESS_RETRY_LIMIT);
247 brcmf_err("failed with %d\n", ret);
252 u8 brcmf_sdio_regrb(struct brcmf_sdio_dev *sdiodev, u32 addr, int *ret)
257 brcmf_dbg(SDIO, "addr:0x%08x\n", addr);
258 retval = brcmf_sdio_regrw_helper(sdiodev, addr, &data, false);
259 brcmf_dbg(SDIO, "data:0x%02x\n", data);
267 u32 brcmf_sdio_regrl(struct brcmf_sdio_dev *sdiodev, u32 addr, int *ret)
272 brcmf_dbg(SDIO, "addr:0x%08x\n", addr);
273 retval = brcmf_sdio_regrw_helper(sdiodev, addr, &data, false);
274 brcmf_dbg(SDIO, "data:0x%08x\n", data);
282 void brcmf_sdio_regwb(struct brcmf_sdio_dev *sdiodev, u32 addr,
287 brcmf_dbg(SDIO, "addr:0x%08x, data:0x%02x\n", addr, data);
288 retval = brcmf_sdio_regrw_helper(sdiodev, addr, &data, true);
294 void brcmf_sdio_regwl(struct brcmf_sdio_dev *sdiodev, u32 addr,
299 brcmf_dbg(SDIO, "addr:0x%08x, data:0x%08x\n", addr, data);
300 retval = brcmf_sdio_regrw_helper(sdiodev, addr, &data, true);
306 static int brcmf_sdcard_recv_prepare(struct brcmf_sdio_dev *sdiodev, uint fn,
307 uint flags, uint width, u32 *addr)
309 uint bar0 = *addr & ~SBSDIO_SB_OFT_ADDR_MASK;
312 /* Async not implemented yet */
313 if (flags & SDIO_REQ_ASYNC)
316 if (bar0 != sdiodev->sbwad) {
317 err = brcmf_sdcard_set_sbaddr_window(sdiodev, bar0);
321 sdiodev->sbwad = bar0;
324 *addr &= SBSDIO_SB_OFT_ADDR_MASK;
327 *addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
333 brcmf_sdcard_recv_buf(struct brcmf_sdio_dev *sdiodev, u32 addr, uint fn,
334 uint flags, u8 *buf, uint nbytes)
336 struct sk_buff *mypkt;
339 mypkt = brcmu_pkt_buf_get_skb(nbytes);
341 brcmf_err("brcmu_pkt_buf_get_skb failed: len %d\n",
346 err = brcmf_sdcard_recv_pkt(sdiodev, addr, fn, flags, mypkt);
348 memcpy(buf, mypkt->data, nbytes);
350 brcmu_pkt_buf_free_skb(mypkt);
355 brcmf_sdcard_recv_pkt(struct brcmf_sdio_dev *sdiodev, u32 addr, uint fn,
356 uint flags, struct sk_buff *pkt)
362 brcmf_dbg(SDIO, "fun = %d, addr = 0x%x, size = %d\n",
365 width = (flags & SDIO_REQ_4BYTE) ? 4 : 2;
366 err = brcmf_sdcard_recv_prepare(sdiodev, fn, flags, width, &addr);
370 incr_fix = (flags & SDIO_REQ_FIXED) ? SDIOH_DATA_FIX : SDIOH_DATA_INC;
371 err = brcmf_sdioh_request_buffer(sdiodev, incr_fix, SDIOH_READ,
378 int brcmf_sdcard_recv_chain(struct brcmf_sdio_dev *sdiodev, u32 addr, uint fn,
379 uint flags, struct sk_buff_head *pktq)
385 brcmf_dbg(SDIO, "fun = %d, addr = 0x%x, size = %d\n",
386 fn, addr, pktq->qlen);
388 width = (flags & SDIO_REQ_4BYTE) ? 4 : 2;
389 err = brcmf_sdcard_recv_prepare(sdiodev, fn, flags, width, &addr);
393 incr_fix = (flags & SDIO_REQ_FIXED) ? SDIOH_DATA_FIX : SDIOH_DATA_INC;
394 err = brcmf_sdioh_request_chain(sdiodev, incr_fix, SDIOH_READ, fn, addr,
402 brcmf_sdcard_send_buf(struct brcmf_sdio_dev *sdiodev, u32 addr, uint fn,
403 uint flags, u8 *buf, uint nbytes)
405 struct sk_buff *mypkt;
408 mypkt = brcmu_pkt_buf_get_skb(nbytes);
410 brcmf_err("brcmu_pkt_buf_get_skb failed: len %d\n",
415 memcpy(mypkt->data, buf, nbytes);
416 err = brcmf_sdcard_send_pkt(sdiodev, addr, fn, flags, mypkt);
418 brcmu_pkt_buf_free_skb(mypkt);
424 brcmf_sdcard_send_pkt(struct brcmf_sdio_dev *sdiodev, u32 addr, uint fn,
425 uint flags, struct sk_buff *pkt)
429 uint bar0 = addr & ~SBSDIO_SB_OFT_ADDR_MASK;
432 brcmf_dbg(SDIO, "fun = %d, addr = 0x%x, size = %d\n",
435 /* Async not implemented yet */
436 if (flags & SDIO_REQ_ASYNC)
439 if (bar0 != sdiodev->sbwad) {
440 err = brcmf_sdcard_set_sbaddr_window(sdiodev, bar0);
444 sdiodev->sbwad = bar0;
447 addr &= SBSDIO_SB_OFT_ADDR_MASK;
449 incr_fix = (flags & SDIO_REQ_FIXED) ? SDIOH_DATA_FIX : SDIOH_DATA_INC;
450 width = (flags & SDIO_REQ_4BYTE) ? 4 : 2;
452 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
454 err = brcmf_sdioh_request_buffer(sdiodev, incr_fix, SDIOH_WRITE, fn,
462 brcmf_sdio_ramrw(struct brcmf_sdio_dev *sdiodev, bool write, u32 address,
470 dsize = min_t(uint, SBSDIO_SB_OFT_ADDR_LIMIT, size);
471 pkt = dev_alloc_skb(dsize);
473 brcmf_err("dev_alloc_skb failed: len %d\n", dsize);
478 /* Determine initial transfer parameters */
479 sdaddr = address & SBSDIO_SB_OFT_ADDR_MASK;
480 if ((sdaddr + size) & SBSDIO_SBWINDOW_MASK)
481 dsize = (SBSDIO_SB_OFT_ADDR_LIMIT - sdaddr);
485 sdio_claim_host(sdiodev->func[1]);
487 /* Do the transfer(s) */
489 /* Set the backplane window to include the start address */
490 bcmerror = brcmf_sdcard_set_sbaddr_window(sdiodev, address);
494 brcmf_dbg(SDIO, "%s %d bytes at offset 0x%08x in window 0x%08x\n",
495 write ? "write" : "read", dsize,
496 sdaddr, address & SBSDIO_SBWINDOW_MASK);
498 sdaddr &= SBSDIO_SB_OFT_ADDR_MASK;
499 sdaddr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
503 memcpy(pkt->data, data, dsize);
504 bcmerror = brcmf_sdioh_request_buffer(sdiodev, SDIOH_DATA_INC,
508 brcmf_err("membytes transfer failed\n");
512 memcpy(data, pkt->data, dsize);
513 skb_trim(pkt, dsize);
515 /* Adjust for next transfer (if any) */
521 dsize = min_t(uint, SBSDIO_SB_OFT_ADDR_LIMIT, size);
527 /* Return the window to backplane enumeration space for core access */
528 if (brcmf_sdcard_set_sbaddr_window(sdiodev, sdiodev->sbwad))
529 brcmf_err("FAILED to set window back to 0x%x\n",
532 sdio_release_host(sdiodev->func[1]);
537 int brcmf_sdcard_abort(struct brcmf_sdio_dev *sdiodev, uint fn)
539 char t_func = (char)fn;
540 brcmf_dbg(SDIO, "Enter\n");
542 /* issue abort cmd52 command through F0 */
543 brcmf_sdioh_request_byte(sdiodev, SDIOH_WRITE, SDIO_FUNC_0,
544 SDIO_CCCR_ABORT, &t_func);
546 brcmf_dbg(SDIO, "Exit\n");
550 int brcmf_sdio_probe(struct brcmf_sdio_dev *sdiodev)
555 ret = brcmf_sdioh_attach(sdiodev);
561 /* try to attach to the target device */
562 sdiodev->bus = brcmf_sdbrcm_probe(regs, sdiodev);
564 brcmf_err("device attach failed\n");
571 brcmf_sdio_remove(sdiodev);
575 EXPORT_SYMBOL(brcmf_sdio_probe);
577 int brcmf_sdio_remove(struct brcmf_sdio_dev *sdiodev)
579 sdiodev->bus_if->state = BRCMF_BUS_DOWN;
582 brcmf_sdbrcm_disconnect(sdiodev->bus);
586 brcmf_sdioh_detach(sdiodev);
592 EXPORT_SYMBOL(brcmf_sdio_remove);
594 void brcmf_sdio_wdtmr_enable(struct brcmf_sdio_dev *sdiodev, bool enable)
597 brcmf_sdbrcm_wd_timer(sdiodev->bus, BRCMF_WD_POLL_MS);
599 brcmf_sdbrcm_wd_timer(sdiodev->bus, 0);