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 /* ****************** BCMSDH Interface Functions *************************** */
18 #include <linux/types.h>
19 #include <linux/netdevice.h>
22 #include <bcmendian.h>
28 #include <bcmsdh.h> /* BRCM API for SDIO
29 clients (such as wl, dhd) */
30 #include <bcmsdbus.h> /* common SDIO/controller interface */
31 #include <sbsdio.h> /* BRCM sdio device core */
33 #include <sdio.h> /* sdio spec */
35 #define SDIOH_API_ACCESS_RETRY_LIMIT 2
36 const uint bcmsdh_msglevel = BCMSDH_ERROR_VAL;
39 bool init_success; /* underlying driver successfully attached */
40 void *sdioh; /* handler for sdioh */
41 u32 vendevid; /* Target Vendor and Device ID on SD bus */
43 bool regfail; /* Save status of last
44 reg_read/reg_write call */
45 u32 sbwad; /* Save backplane window address */
47 /* local copy of bcm sd handler */
48 bcmsdh_info_t *l_bcmsdh;
50 #if defined(OOB_INTR_ONLY) && defined(HW_OOB)
51 extern int sdioh_enable_hw_oob_intr(void *sdioh, bool enable);
53 void bcmsdh_enable_hw_oob_intr(bcmsdh_info_t *sdh, bool enable)
55 sdioh_enable_hw_oob_intr(sdh->sdioh, enable);
59 bcmsdh_info_t *bcmsdh_attach(struct osl_info *osh, void *cfghdl,
60 void **regsva, uint irq)
62 bcmsdh_info_t *bcmsdh;
64 bcmsdh = kzalloc(sizeof(bcmsdh_info_t), GFP_ATOMIC);
66 BCMSDH_ERROR(("bcmsdh_attach: out of memory"));
70 /* save the handler locally */
73 bcmsdh->sdioh = sdioh_attach(osh, cfghdl, irq);
75 bcmsdh_detach(osh, bcmsdh);
80 bcmsdh->init_success = true;
82 *regsva = (u32 *) SI_ENUM_BASE;
84 /* Report the BAR, to fix if needed */
85 bcmsdh->sbwad = SI_ENUM_BASE;
89 int bcmsdh_detach(struct osl_info *osh, void *sdh)
91 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
95 sdioh_detach(osh, bcmsdh->sdioh);
106 bcmsdh_iovar_op(void *sdh, const char *name,
107 void *params, int plen, void *arg, int len, bool set)
109 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
110 return sdioh_iovar_op(bcmsdh->sdioh, name, params, plen, arg, len, set);
113 bool bcmsdh_intr_query(void *sdh)
115 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
120 status = sdioh_interrupt_query(bcmsdh->sdioh, &on);
121 if (SDIOH_API_SUCCESS(status))
127 int bcmsdh_intr_enable(void *sdh)
129 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
133 status = sdioh_interrupt_set(bcmsdh->sdioh, true);
134 return SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR;
137 int bcmsdh_intr_disable(void *sdh)
139 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
143 status = sdioh_interrupt_set(bcmsdh->sdioh, false);
144 return SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR;
147 int bcmsdh_intr_reg(void *sdh, bcmsdh_cb_fn_t fn, void *argh)
149 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
153 status = sdioh_interrupt_register(bcmsdh->sdioh, fn, argh);
154 return SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR;
157 int bcmsdh_intr_dereg(void *sdh)
159 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
163 status = sdioh_interrupt_deregister(bcmsdh->sdioh);
164 return SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR;
167 #if defined(DHD_DEBUG)
168 bool bcmsdh_intr_pending(void *sdh)
170 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
173 return sdioh_interrupt_pending(bcmsdh->sdioh);
177 int bcmsdh_devremove_reg(void *sdh, bcmsdh_cb_fn_t fn, void *argh)
181 /* don't support yet */
182 return BCME_UNSUPPORTED;
185 u8 bcmsdh_cfg_read(void *sdh, uint fnc_num, u32 addr, int *err)
187 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
189 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
197 ASSERT(bcmsdh->init_success);
199 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
201 if (retry) /* wait for 1 ms till bus get settled down */
205 sdioh_cfg_read(bcmsdh->sdioh, fnc_num, addr,
207 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
208 } while (!SDIOH_API_SUCCESS(status)
209 && (retry++ < SDIOH_API_ACCESS_RETRY_LIMIT));
212 *err = (SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR);
214 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, u8data = 0x%x\n",
215 __func__, fnc_num, addr, data));
221 bcmsdh_cfg_write(void *sdh, uint fnc_num, u32 addr, u8 data, int *err)
223 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
225 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
232 ASSERT(bcmsdh->init_success);
234 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
236 if (retry) /* wait for 1 ms till bus get settled down */
240 sdioh_cfg_write(bcmsdh->sdioh, fnc_num, addr,
242 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
243 } while (!SDIOH_API_SUCCESS(status)
244 && (retry++ < SDIOH_API_ACCESS_RETRY_LIMIT));
247 *err = SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR;
249 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, u8data = 0x%x\n",
250 __func__, fnc_num, addr, data));
253 u32 bcmsdh_cfg_read_word(void *sdh, uint fnc_num, u32 addr, int *err)
255 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
262 ASSERT(bcmsdh->init_success);
265 sdioh_request_word(bcmsdh->sdioh, SDIOH_CMD_TYPE_NORMAL, SDIOH_READ,
266 fnc_num, addr, &data, 4);
269 *err = (SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR);
271 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, u32data = 0x%x\n",
272 __func__, fnc_num, addr, data));
278 bcmsdh_cfg_write_word(void *sdh, uint fnc_num, u32 addr, u32 data,
281 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
287 ASSERT(bcmsdh->init_success);
290 sdioh_request_word(bcmsdh->sdioh, SDIOH_CMD_TYPE_NORMAL,
291 SDIOH_WRITE, fnc_num, addr, &data, 4);
294 *err = (SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR);
296 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, u32data = 0x%x\n",
297 __func__, fnc_num, addr, data));
300 int bcmsdh_cis_read(void *sdh, uint func, u8 * cis, uint length)
302 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
305 u8 *tmp_buf, *tmp_ptr;
307 bool ascii = func & ~0xf;
313 ASSERT(bcmsdh->init_success);
315 ASSERT(length <= SBSDIO_CIS_SIZE_LIMIT);
317 status = sdioh_cis_read(bcmsdh->sdioh, func, cis, length);
320 /* Move binary bits to tmp and format them
321 into the provided buffer. */
322 tmp_buf = kmalloc(length, GFP_ATOMIC);
323 if (tmp_buf == NULL) {
324 BCMSDH_ERROR(("%s: out of memory\n", __func__));
327 bcopy(cis, tmp_buf, length);
328 for (tmp_ptr = tmp_buf, ptr = cis; ptr < (cis + length - 4);
330 ptr += sprintf((char *)ptr, "%.2x ", *tmp_ptr & 0xff);
331 if ((((tmp_ptr - tmp_buf) + 1) & 0xf) == 0)
332 ptr += sprintf((char *)ptr, "\n");
337 return SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR;
340 static int bcmsdhsdio_set_sbaddr_window(void *sdh, u32 address)
343 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
344 bcmsdh_cfg_write(bcmsdh, SDIO_FUNC_1, SBSDIO_FUNC1_SBADDRLOW,
345 (address >> 8) & SBSDIO_SBADDRLOW_MASK, &err);
347 bcmsdh_cfg_write(bcmsdh, SDIO_FUNC_1, SBSDIO_FUNC1_SBADDRMID,
348 (address >> 16) & SBSDIO_SBADDRMID_MASK, &err);
350 bcmsdh_cfg_write(bcmsdh, SDIO_FUNC_1, SBSDIO_FUNC1_SBADDRHIGH,
351 (address >> 24) & SBSDIO_SBADDRHIGH_MASK,
357 u32 bcmsdh_reg_read(void *sdh, u32 addr, uint size)
359 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
362 uint bar0 = addr & ~SBSDIO_SB_OFT_ADDR_MASK;
364 BCMSDH_INFO(("%s:fun = 1, addr = 0x%x, ", __func__, addr));
369 ASSERT(bcmsdh->init_success);
371 if (bar0 != bcmsdh->sbwad) {
372 if (bcmsdhsdio_set_sbaddr_window(bcmsdh, bar0))
375 bcmsdh->sbwad = bar0;
378 addr &= SBSDIO_SB_OFT_ADDR_MASK;
380 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
382 status = sdioh_request_word(bcmsdh->sdioh, SDIOH_CMD_TYPE_NORMAL,
383 SDIOH_READ, SDIO_FUNC_1, addr, &word, size);
385 bcmsdh->regfail = !(SDIOH_API_SUCCESS(status));
387 BCMSDH_INFO(("u32data = 0x%x\n", word));
389 /* if ok, return appropriately masked word */
390 if (SDIOH_API_SUCCESS(status)) {
395 return word & 0xffff;
399 bcmsdh->regfail = true;
404 /* otherwise, bad sdio access or invalid size */
405 BCMSDH_ERROR(("%s: error reading addr 0x%04x size %d\n", __func__,
410 u32 bcmsdh_reg_write(void *sdh, u32 addr, uint size, u32 data)
412 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
414 uint bar0 = addr & ~SBSDIO_SB_OFT_ADDR_MASK;
417 BCMSDH_INFO(("%s:fun = 1, addr = 0x%x, uint%ddata = 0x%x\n",
418 __func__, addr, size * 8, data));
423 ASSERT(bcmsdh->init_success);
425 if (bar0 != bcmsdh->sbwad) {
426 err = bcmsdhsdio_set_sbaddr_window(bcmsdh, bar0);
430 bcmsdh->sbwad = bar0;
433 addr &= SBSDIO_SB_OFT_ADDR_MASK;
435 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
437 sdioh_request_word(bcmsdh->sdioh, SDIOH_CMD_TYPE_NORMAL,
438 SDIOH_WRITE, SDIO_FUNC_1, addr, &data, size);
439 bcmsdh->regfail = !(SDIOH_API_SUCCESS(status));
441 if (SDIOH_API_SUCCESS(status))
444 BCMSDH_ERROR(("%s: error writing 0x%08x to addr 0x%04x size %d\n",
445 __func__, data, addr, size));
449 bool bcmsdh_regfail(void *sdh)
451 return ((bcmsdh_info_t *) sdh)->regfail;
455 bcmsdh_recv_buf(void *sdh, u32 addr, uint fn, uint flags,
456 u8 *buf, uint nbytes, struct sk_buff *pkt,
457 bcmsdh_cmplt_fn_t complete, void *handle)
459 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
463 uint bar0 = addr & ~SBSDIO_SB_OFT_ADDR_MASK;
467 ASSERT(bcmsdh->init_success);
469 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, size = %d\n",
470 __func__, fn, addr, nbytes));
472 /* Async not implemented yet */
473 ASSERT(!(flags & SDIO_REQ_ASYNC));
474 if (flags & SDIO_REQ_ASYNC)
475 return BCME_UNSUPPORTED;
477 if (bar0 != bcmsdh->sbwad) {
478 err = bcmsdhsdio_set_sbaddr_window(bcmsdh, bar0);
482 bcmsdh->sbwad = bar0;
485 addr &= SBSDIO_SB_OFT_ADDR_MASK;
487 incr_fix = (flags & SDIO_REQ_FIXED) ? SDIOH_DATA_FIX : SDIOH_DATA_INC;
488 width = (flags & SDIO_REQ_4BYTE) ? 4 : 2;
490 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
492 status = sdioh_request_buffer(bcmsdh->sdioh, SDIOH_DATA_PIO, incr_fix,
493 SDIOH_READ, fn, addr, width, nbytes, buf,
496 return SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR;
500 bcmsdh_send_buf(void *sdh, u32 addr, uint fn, uint flags,
501 u8 *buf, uint nbytes, void *pkt,
502 bcmsdh_cmplt_fn_t complete, void *handle)
504 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
508 uint bar0 = addr & ~SBSDIO_SB_OFT_ADDR_MASK;
512 ASSERT(bcmsdh->init_success);
514 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, size = %d\n",
515 __func__, fn, addr, nbytes));
517 /* Async not implemented yet */
518 ASSERT(!(flags & SDIO_REQ_ASYNC));
519 if (flags & SDIO_REQ_ASYNC)
520 return BCME_UNSUPPORTED;
522 if (bar0 != bcmsdh->sbwad) {
523 err = bcmsdhsdio_set_sbaddr_window(bcmsdh, bar0);
527 bcmsdh->sbwad = bar0;
530 addr &= SBSDIO_SB_OFT_ADDR_MASK;
532 incr_fix = (flags & SDIO_REQ_FIXED) ? SDIOH_DATA_FIX : SDIOH_DATA_INC;
533 width = (flags & SDIO_REQ_4BYTE) ? 4 : 2;
535 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
537 status = sdioh_request_buffer(bcmsdh->sdioh, SDIOH_DATA_PIO, incr_fix,
538 SDIOH_WRITE, fn, addr, width, nbytes, buf,
541 return SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR;
544 int bcmsdh_rwdata(void *sdh, uint rw, u32 addr, u8 *buf, uint nbytes)
546 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
550 ASSERT(bcmsdh->init_success);
551 ASSERT((addr & SBSDIO_SBWINDOW_MASK) == 0);
553 addr &= SBSDIO_SB_OFT_ADDR_MASK;
554 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
557 sdioh_request_buffer(bcmsdh->sdioh, SDIOH_DATA_PIO, SDIOH_DATA_INC,
558 (rw ? SDIOH_WRITE : SDIOH_READ), SDIO_FUNC_1,
559 addr, 4, nbytes, buf, NULL);
561 return SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR;
564 int bcmsdh_abort(void *sdh, uint fn)
566 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
568 return sdioh_abort(bcmsdh->sdioh, fn);
571 int bcmsdh_start(void *sdh, int stage)
573 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
575 return sdioh_start(bcmsdh->sdioh, stage);
578 int bcmsdh_stop(void *sdh)
580 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
582 return sdioh_stop(bcmsdh->sdioh);
585 int bcmsdh_query_device(void *sdh)
587 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
588 bcmsdh->vendevid = (VENDOR_BROADCOM << 16) | 0;
589 return bcmsdh->vendevid;
592 uint bcmsdh_query_iofnum(void *sdh)
594 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
599 return sdioh_query_iofnum(bcmsdh->sdioh);
602 int bcmsdh_reset(bcmsdh_info_t *sdh)
604 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
606 return sdioh_sdio_reset(bcmsdh->sdioh);
609 void *bcmsdh_get_sdioh(bcmsdh_info_t *sdh)
615 /* Function to pass device-status bits to DHD. */
616 u32 bcmsdh_get_dstatus(void *sdh)
621 u32 bcmsdh_cur_sbwad(void *sdh)
623 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
628 return bcmsdh->sbwad;
631 void bcmsdh_chipinfo(void *sdh, u32 chip, u32 chiprev)