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 *************************** */
20 #include <bcmendian.h>
26 #include <bcmsdh.h> /* BRCM API for SDIO
27 clients (such as wl, dhd) */
28 #include <bcmsdbus.h> /* common SDIO/controller interface */
29 #include <sbsdio.h> /* BRCM sdio device core */
31 #include <sdio.h> /* sdio spec */
33 #define SDIOH_API_ACCESS_RETRY_LIMIT 2
34 const uint bcmsdh_msglevel = BCMSDH_ERROR_VAL;
37 bool init_success; /* underlying driver successfully attached */
38 void *sdioh; /* handler for sdioh */
39 uint32 vendevid; /* Target Vendor and Device ID on SD bus */
41 bool regfail; /* Save status of last
42 reg_read/reg_write call */
43 uint32 sbwad; /* Save backplane window address */
45 /* local copy of bcm sd handler */
46 bcmsdh_info_t *l_bcmsdh = NULL;
48 #if defined(OOB_INTR_ONLY) && defined(HW_OOB)
49 extern int sdioh_enable_hw_oob_intr(void *sdioh, bool enable);
51 void bcmsdh_enable_hw_oob_intr(bcmsdh_info_t *sdh, bool enable)
53 sdioh_enable_hw_oob_intr(sdh->sdioh, enable);
57 bcmsdh_info_t *bcmsdh_attach(osl_t *osh, void *cfghdl, void **regsva, uint irq)
59 bcmsdh_info_t *bcmsdh;
61 bcmsdh = (bcmsdh_info_t *) MALLOC(osh, sizeof(bcmsdh_info_t));
63 BCMSDH_ERROR(("bcmsdh_attach: out of memory, "
64 "malloced %d bytes\n", MALLOCED(osh)));
67 bzero((char *)bcmsdh, sizeof(bcmsdh_info_t));
69 /* save the handler locally */
72 bcmsdh->sdioh = sdioh_attach(osh, cfghdl, irq);
74 bcmsdh_detach(osh, bcmsdh);
79 bcmsdh->init_success = TRUE;
81 *regsva = (uint32 *) SI_ENUM_BASE;
83 /* Report the BAR, to fix if needed */
84 bcmsdh->sbwad = SI_ENUM_BASE;
88 int bcmsdh_detach(osl_t *osh, void *sdh)
90 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
94 sdioh_detach(osh, bcmsdh->sdioh);
97 MFREE(osh, bcmsdh, sizeof(bcmsdh_info_t));
105 bcmsdh_iovar_op(void *sdh, const char *name,
106 void *params, int plen, void *arg, int len, bool set)
108 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
109 return sdioh_iovar_op(bcmsdh->sdioh, name, params, plen, arg, len, set);
112 bool bcmsdh_intr_query(void *sdh)
114 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
119 status = sdioh_interrupt_query(bcmsdh->sdioh, &on);
120 if (SDIOH_API_SUCCESS(status))
126 int bcmsdh_intr_enable(void *sdh)
128 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
132 status = sdioh_interrupt_set(bcmsdh->sdioh, TRUE);
133 return SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR;
136 int bcmsdh_intr_disable(void *sdh)
138 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
142 status = sdioh_interrupt_set(bcmsdh->sdioh, FALSE);
143 return SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR;
146 int bcmsdh_intr_reg(void *sdh, bcmsdh_cb_fn_t fn, void *argh)
148 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
152 status = sdioh_interrupt_register(bcmsdh->sdioh, fn, argh);
153 return SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR;
156 int bcmsdh_intr_dereg(void *sdh)
158 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
162 status = sdioh_interrupt_deregister(bcmsdh->sdioh);
163 return SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR;
166 #if defined(DHD_DEBUG)
167 bool bcmsdh_intr_pending(void *sdh)
169 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
172 return sdioh_interrupt_pending(bcmsdh->sdioh);
176 int bcmsdh_devremove_reg(void *sdh, bcmsdh_cb_fn_t fn, void *argh)
180 /* don't support yet */
181 return BCME_UNSUPPORTED;
184 u8 bcmsdh_cfg_read(void *sdh, uint fnc_num, uint32 addr, int *err)
186 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
188 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
196 ASSERT(bcmsdh->init_success);
198 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
200 if (retry) /* wait for 1 ms till bus get settled down */
204 sdioh_cfg_read(bcmsdh->sdioh, fnc_num, addr,
206 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
207 } while (!SDIOH_API_SUCCESS(status)
208 && (retry++ < SDIOH_API_ACCESS_RETRY_LIMIT));
211 *err = (SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR);
213 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, u8data = 0x%x\n",
214 __func__, fnc_num, addr, data));
220 bcmsdh_cfg_write(void *sdh, uint fnc_num, uint32 addr, u8 data, int *err)
222 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
224 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
231 ASSERT(bcmsdh->init_success);
233 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
235 if (retry) /* wait for 1 ms till bus get settled down */
239 sdioh_cfg_write(bcmsdh->sdioh, fnc_num, addr,
241 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
242 } while (!SDIOH_API_SUCCESS(status)
243 && (retry++ < SDIOH_API_ACCESS_RETRY_LIMIT));
246 *err = SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR;
248 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, u8data = 0x%x\n",
249 __func__, fnc_num, addr, data));
252 uint32 bcmsdh_cfg_read_word(void *sdh, uint fnc_num, uint32 addr, int *err)
254 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
261 ASSERT(bcmsdh->init_success);
264 sdioh_request_word(bcmsdh->sdioh, SDIOH_CMD_TYPE_NORMAL, SDIOH_READ,
265 fnc_num, addr, &data, 4);
268 *err = (SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR);
270 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, uint32data = 0x%x\n",
271 __func__, fnc_num, addr, data));
277 bcmsdh_cfg_write_word(void *sdh, uint fnc_num, uint32 addr, uint32 data,
280 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
286 ASSERT(bcmsdh->init_success);
289 sdioh_request_word(bcmsdh->sdioh, SDIOH_CMD_TYPE_NORMAL,
290 SDIOH_WRITE, fnc_num, addr, &data, 4);
293 *err = (SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR);
295 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, uint32data = 0x%x\n",
296 __func__, fnc_num, addr, data));
299 int bcmsdh_cis_read(void *sdh, uint func, u8 * cis, uint length)
301 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
304 u8 *tmp_buf, *tmp_ptr;
306 bool ascii = func & ~0xf;
312 ASSERT(bcmsdh->init_success);
314 ASSERT(length <= SBSDIO_CIS_SIZE_LIMIT);
316 status = sdioh_cis_read(bcmsdh->sdioh, func, cis, length);
319 /* Move binary bits to tmp and format them
320 into the provided buffer. */
321 tmp_buf = (u8 *) MALLOC(bcmsdh->osh, length);
322 if (tmp_buf == NULL) {
323 BCMSDH_ERROR(("%s: out of memory\n", __func__));
326 bcopy(cis, tmp_buf, length);
327 for (tmp_ptr = tmp_buf, ptr = cis; ptr < (cis + length - 4);
329 ptr += sprintf((char *)ptr, "%.2x ", *tmp_ptr & 0xff);
330 if ((((tmp_ptr - tmp_buf) + 1) & 0xf) == 0)
331 ptr += sprintf((char *)ptr, "\n");
333 MFREE(bcmsdh->osh, tmp_buf, length);
336 return SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR;
339 static int bcmsdhsdio_set_sbaddr_window(void *sdh, uint32 address)
342 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
343 bcmsdh_cfg_write(bcmsdh, SDIO_FUNC_1, SBSDIO_FUNC1_SBADDRLOW,
344 (address >> 8) & SBSDIO_SBADDRLOW_MASK, &err);
346 bcmsdh_cfg_write(bcmsdh, SDIO_FUNC_1, SBSDIO_FUNC1_SBADDRMID,
347 (address >> 16) & SBSDIO_SBADDRMID_MASK, &err);
349 bcmsdh_cfg_write(bcmsdh, SDIO_FUNC_1, SBSDIO_FUNC1_SBADDRHIGH,
350 (address >> 24) & SBSDIO_SBADDRHIGH_MASK,
356 uint32 bcmsdh_reg_read(void *sdh, uint32 addr, uint size)
358 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
361 uint bar0 = addr & ~SBSDIO_SB_OFT_ADDR_MASK;
363 BCMSDH_INFO(("%s:fun = 1, addr = 0x%x, ", __func__, addr));
368 ASSERT(bcmsdh->init_success);
370 if (bar0 != bcmsdh->sbwad) {
371 if (bcmsdhsdio_set_sbaddr_window(bcmsdh, bar0))
374 bcmsdh->sbwad = bar0;
377 addr &= SBSDIO_SB_OFT_ADDR_MASK;
379 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
381 status = sdioh_request_word(bcmsdh->sdioh, SDIOH_CMD_TYPE_NORMAL,
382 SDIOH_READ, SDIO_FUNC_1, addr, &word, size);
384 bcmsdh->regfail = !(SDIOH_API_SUCCESS(status));
386 BCMSDH_INFO(("uint32data = 0x%x\n", word));
388 /* if ok, return appropriately masked word */
389 if (SDIOH_API_SUCCESS(status)) {
394 return word & 0xffff;
398 bcmsdh->regfail = TRUE;
403 /* otherwise, bad sdio access or invalid size */
404 BCMSDH_ERROR(("%s: error reading addr 0x%04x size %d\n", __func__,
409 uint32 bcmsdh_reg_write(void *sdh, uint32 addr, uint size, uint32 data)
411 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
413 uint bar0 = addr & ~SBSDIO_SB_OFT_ADDR_MASK;
416 BCMSDH_INFO(("%s:fun = 1, addr = 0x%x, uint%ddata = 0x%x\n",
417 __func__, addr, size * 8, data));
422 ASSERT(bcmsdh->init_success);
424 if (bar0 != bcmsdh->sbwad) {
425 err = bcmsdhsdio_set_sbaddr_window(bcmsdh, bar0);
429 bcmsdh->sbwad = bar0;
432 addr &= SBSDIO_SB_OFT_ADDR_MASK;
434 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
436 sdioh_request_word(bcmsdh->sdioh, SDIOH_CMD_TYPE_NORMAL,
437 SDIOH_WRITE, SDIO_FUNC_1, addr, &data, size);
438 bcmsdh->regfail = !(SDIOH_API_SUCCESS(status));
440 if (SDIOH_API_SUCCESS(status))
443 BCMSDH_ERROR(("%s: error writing 0x%08x to addr 0x%04x size %d\n",
444 __func__, data, addr, size));
448 bool bcmsdh_regfail(void *sdh)
450 return ((bcmsdh_info_t *) sdh)->regfail;
454 bcmsdh_recv_buf(void *sdh, uint32 addr, uint fn, uint flags,
455 u8 *buf, uint nbytes, void *pkt,
456 bcmsdh_cmplt_fn_t complete, void *handle)
458 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
462 uint bar0 = addr & ~SBSDIO_SB_OFT_ADDR_MASK;
466 ASSERT(bcmsdh->init_success);
468 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, size = %d\n",
469 __func__, fn, addr, nbytes));
471 /* Async not implemented yet */
472 ASSERT(!(flags & SDIO_REQ_ASYNC));
473 if (flags & SDIO_REQ_ASYNC)
474 return BCME_UNSUPPORTED;
476 if (bar0 != bcmsdh->sbwad) {
477 err = bcmsdhsdio_set_sbaddr_window(bcmsdh, bar0);
481 bcmsdh->sbwad = bar0;
484 addr &= SBSDIO_SB_OFT_ADDR_MASK;
486 incr_fix = (flags & SDIO_REQ_FIXED) ? SDIOH_DATA_FIX : SDIOH_DATA_INC;
487 width = (flags & SDIO_REQ_4BYTE) ? 4 : 2;
489 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
491 status = sdioh_request_buffer(bcmsdh->sdioh, SDIOH_DATA_PIO, incr_fix,
492 SDIOH_READ, fn, addr, width, nbytes, buf,
495 return SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR;
499 bcmsdh_send_buf(void *sdh, uint32 addr, uint fn, uint flags,
500 u8 *buf, uint nbytes, void *pkt,
501 bcmsdh_cmplt_fn_t complete, void *handle)
503 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
507 uint bar0 = addr & ~SBSDIO_SB_OFT_ADDR_MASK;
511 ASSERT(bcmsdh->init_success);
513 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, size = %d\n",
514 __func__, fn, addr, nbytes));
516 /* Async not implemented yet */
517 ASSERT(!(flags & SDIO_REQ_ASYNC));
518 if (flags & SDIO_REQ_ASYNC)
519 return BCME_UNSUPPORTED;
521 if (bar0 != bcmsdh->sbwad) {
522 err = bcmsdhsdio_set_sbaddr_window(bcmsdh, bar0);
526 bcmsdh->sbwad = bar0;
529 addr &= SBSDIO_SB_OFT_ADDR_MASK;
531 incr_fix = (flags & SDIO_REQ_FIXED) ? SDIOH_DATA_FIX : SDIOH_DATA_INC;
532 width = (flags & SDIO_REQ_4BYTE) ? 4 : 2;
534 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
536 status = sdioh_request_buffer(bcmsdh->sdioh, SDIOH_DATA_PIO, incr_fix,
537 SDIOH_WRITE, fn, addr, width, nbytes, buf,
540 return SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR;
543 int bcmsdh_rwdata(void *sdh, uint rw, uint32 addr, u8 *buf, uint nbytes)
545 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
549 ASSERT(bcmsdh->init_success);
550 ASSERT((addr & SBSDIO_SBWINDOW_MASK) == 0);
552 addr &= SBSDIO_SB_OFT_ADDR_MASK;
553 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
556 sdioh_request_buffer(bcmsdh->sdioh, SDIOH_DATA_PIO, SDIOH_DATA_INC,
557 (rw ? SDIOH_WRITE : SDIOH_READ), SDIO_FUNC_1,
558 addr, 4, nbytes, buf, NULL);
560 return SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR;
563 int bcmsdh_abort(void *sdh, uint fn)
565 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
567 return sdioh_abort(bcmsdh->sdioh, fn);
570 int bcmsdh_start(void *sdh, int stage)
572 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
574 return sdioh_start(bcmsdh->sdioh, stage);
577 int bcmsdh_stop(void *sdh)
579 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
581 return sdioh_stop(bcmsdh->sdioh);
584 int bcmsdh_query_device(void *sdh)
586 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
587 bcmsdh->vendevid = (VENDOR_BROADCOM << 16) | 0;
588 return bcmsdh->vendevid;
591 uint bcmsdh_query_iofnum(void *sdh)
593 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
598 return sdioh_query_iofnum(bcmsdh->sdioh);
601 int bcmsdh_reset(bcmsdh_info_t *sdh)
603 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
605 return sdioh_sdio_reset(bcmsdh->sdioh);
608 void *bcmsdh_get_sdioh(bcmsdh_info_t *sdh)
614 /* Function to pass device-status bits to DHD. */
615 uint32 bcmsdh_get_dstatus(void *sdh)
620 uint32 bcmsdh_cur_sbwad(void *sdh)
622 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
627 return bcmsdh->sbwad;
630 void bcmsdh_chipinfo(void *sdh, uint32 chip, uint32 chiprev)