2 * BCMSDH interface glue
3 * implement bcmsdh API for SDIOH driver
5 * Copyright (C) 1999-2011, Broadcom Corporation
7 * Unless you and Broadcom execute a separate written software license
8 * agreement governing use of this software, this software is licensed to you
9 * under the terms of the GNU General Public License version 2 (the "GPL"),
10 * available at http://www.broadcom.com/licenses/GPLv2.php, with the
11 * following added to such license:
13 * As a special exception, the copyright holders of this software give you
14 * permission to link this software with independent modules, and to copy and
15 * distribute the resulting executable under terms of your choice, provided that
16 * you also meet, for each linked independent module, the terms and conditions of
17 * the license of that module. An independent module is a module which is not
18 * derived from this software. The special exception does not apply to any
19 * modifications of the software.
21 * Notwithstanding the above, under no circumstances may you combine this
22 * software in any way with any other Broadcom software provided under a license
23 * other than the GPL, without Broadcom's express prior written consent.
25 * $Id: bcmsdh.c,v 1.57.6.4 2010-12-23 01:13:15 $
27 /* ****************** BCMSDH Interface Functions *************************** */
31 #include <bcmendian.h>
37 #include <bcmsdh.h> /* BRCM API for SDIO clients (such as wl, dhd) */
38 #include <bcmsdbus.h> /* common SDIO/controller interface */
39 #include <sbsdio.h> /* BRCM sdio device core */
41 #include <sdio.h> /* sdio spec */
43 #define SDIOH_API_ACCESS_RETRY_LIMIT 2
44 const uint bcmsdh_msglevel = BCMSDH_ERROR_VAL;
49 bool init_success; /* underlying driver successfully attached */
50 void *sdioh; /* handler for sdioh */
51 uint32 vendevid; /* Target Vendor and Device ID on SD bus */
53 bool regfail; /* Save status of last reg_read/reg_write call */
54 uint32 sbwad; /* Save backplane window address */
56 /* local copy of bcm sd handler */
57 bcmsdh_info_t * l_bcmsdh = NULL;
59 #if defined(OOB_INTR_ONLY) && defined(HW_OOB)
61 sdioh_enable_hw_oob_intr(void *sdioh, bool enable);
64 bcmsdh_enable_hw_oob_intr(bcmsdh_info_t *sdh, bool enable)
66 sdioh_enable_hw_oob_intr(sdh->sdioh, enable);
71 bcmsdh_attach(osl_t *osh, void *cfghdl, void **regsva, uint irq)
73 bcmsdh_info_t *bcmsdh;
75 if ((bcmsdh = (bcmsdh_info_t *)MALLOC(osh, sizeof(bcmsdh_info_t))) == NULL) {
76 BCMSDH_ERROR(("bcmsdh_attach: out of memory, malloced %d bytes\n", MALLOCED(osh)));
79 bzero((char *)bcmsdh, sizeof(bcmsdh_info_t));
81 /* save the handler locally */
84 if (!(bcmsdh->sdioh = sdioh_attach(osh, cfghdl, irq))) {
85 bcmsdh_detach(osh, bcmsdh);
90 bcmsdh->init_success = TRUE;
92 *regsva = (uint32 *)SI_ENUM_BASE;
94 /* Report the BAR, to fix if needed */
95 bcmsdh->sbwad = SI_ENUM_BASE;
100 bcmsdh_detach(osl_t *osh, void *sdh)
102 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
104 if (bcmsdh != NULL) {
106 sdioh_detach(osh, bcmsdh->sdioh);
107 bcmsdh->sdioh = NULL;
109 MFREE(osh, bcmsdh, sizeof(bcmsdh_info_t));
117 bcmsdh_iovar_op(void *sdh, const char *name,
118 void *params, int plen, void *arg, int len, bool set)
120 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
121 return sdioh_iovar_op(bcmsdh->sdioh, name, params, plen, arg, len, set);
125 bcmsdh_intr_query(void *sdh)
127 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
132 status = sdioh_interrupt_query(bcmsdh->sdioh, &on);
133 if (SDIOH_API_SUCCESS(status))
140 bcmsdh_intr_enable(void *sdh)
142 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
146 status = sdioh_interrupt_set(bcmsdh->sdioh, TRUE);
147 return (SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR);
151 bcmsdh_intr_disable(void *sdh)
153 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
157 status = sdioh_interrupt_set(bcmsdh->sdioh, FALSE);
158 return (SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR);
162 bcmsdh_intr_reg(void *sdh, bcmsdh_cb_fn_t fn, void *argh)
164 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
168 status = sdioh_interrupt_register(bcmsdh->sdioh, fn, argh);
169 return (SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR);
173 bcmsdh_intr_dereg(void *sdh)
175 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
179 status = sdioh_interrupt_deregister(bcmsdh->sdioh);
180 return (SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR);
183 #if defined(DHD_DEBUG)
185 bcmsdh_intr_pending(void *sdh)
187 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
190 return sdioh_interrupt_pending(bcmsdh->sdioh);
196 bcmsdh_devremove_reg(void *sdh, bcmsdh_cb_fn_t fn, void *argh)
200 /* don't support yet */
201 return BCME_UNSUPPORTED;
205 bcmsdh_cfg_read(void *sdh, uint fnc_num, uint32 addr, int *err)
207 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
209 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
217 ASSERT(bcmsdh->init_success);
219 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
221 if (retry) /* wait for 1 ms till bus get settled down */
224 status = sdioh_cfg_read(bcmsdh->sdioh, fnc_num, addr, (uint8 *)&data);
225 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
226 } while (!SDIOH_API_SUCCESS(status) && (retry++ < SDIOH_API_ACCESS_RETRY_LIMIT));
229 *err = (SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR);
231 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, uint8data = 0x%x\n", __FUNCTION__,
232 fnc_num, addr, data));
238 bcmsdh_cfg_write(void *sdh, uint fnc_num, uint32 addr, uint8 data, int *err)
240 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
242 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
249 ASSERT(bcmsdh->init_success);
251 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
253 if (retry) /* wait for 1 ms till bus get settled down */
256 status = sdioh_cfg_write(bcmsdh->sdioh, fnc_num, addr, (uint8 *)&data);
257 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
258 } while (!SDIOH_API_SUCCESS(status) && (retry++ < SDIOH_API_ACCESS_RETRY_LIMIT));
261 *err = SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR;
263 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, uint8data = 0x%x\n", __FUNCTION__,
264 fnc_num, addr, data));
268 bcmsdh_cfg_read_word(void *sdh, uint fnc_num, uint32 addr, int *err)
270 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
277 ASSERT(bcmsdh->init_success);
279 status = sdioh_request_word(bcmsdh->sdioh, SDIOH_CMD_TYPE_NORMAL, SDIOH_READ, fnc_num,
283 *err = (SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR);
285 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, uint32data = 0x%x\n", __FUNCTION__,
286 fnc_num, addr, data));
292 bcmsdh_cfg_write_word(void *sdh, uint fnc_num, uint32 addr, uint32 data, int *err)
294 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
300 ASSERT(bcmsdh->init_success);
302 status = sdioh_request_word(bcmsdh->sdioh, SDIOH_CMD_TYPE_NORMAL, SDIOH_WRITE, fnc_num,
306 *err = (SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR);
308 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, uint32data = 0x%x\n", __FUNCTION__, fnc_num,
314 bcmsdh_cis_read(void *sdh, uint func, uint8 *cis, uint length)
316 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
319 uint8 *tmp_buf, *tmp_ptr;
321 bool ascii = func & ~0xf;
327 ASSERT(bcmsdh->init_success);
329 ASSERT(length <= SBSDIO_CIS_SIZE_LIMIT);
331 status = sdioh_cis_read(bcmsdh->sdioh, func, cis, length);
334 /* Move binary bits to tmp and format them into the provided buffer. */
335 if ((tmp_buf = (uint8 *)MALLOC(bcmsdh->osh, length)) == NULL) {
336 BCMSDH_ERROR(("%s: out of memory\n", __FUNCTION__));
339 bcopy(cis, tmp_buf, length);
340 for (tmp_ptr = tmp_buf, ptr = cis; ptr < (cis + length - 4); tmp_ptr++) {
341 ptr += sprintf((char*)ptr, "%.2x ", *tmp_ptr & 0xff);
342 if ((((tmp_ptr - tmp_buf) + 1) & 0xf) == 0)
343 ptr += sprintf((char *)ptr, "\n");
345 MFREE(bcmsdh->osh, tmp_buf, length);
348 return (SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR);
353 bcmsdhsdio_set_sbaddr_window(void *sdh, uint32 address)
356 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
357 bcmsdh_cfg_write(bcmsdh, SDIO_FUNC_1, SBSDIO_FUNC1_SBADDRLOW,
358 (address >> 8) & SBSDIO_SBADDRLOW_MASK, &err);
360 bcmsdh_cfg_write(bcmsdh, SDIO_FUNC_1, SBSDIO_FUNC1_SBADDRMID,
361 (address >> 16) & SBSDIO_SBADDRMID_MASK, &err);
363 bcmsdh_cfg_write(bcmsdh, SDIO_FUNC_1, SBSDIO_FUNC1_SBADDRHIGH,
364 (address >> 24) & SBSDIO_SBADDRHIGH_MASK, &err);
371 bcmsdh_reg_read(void *sdh, uint32 addr, uint size)
373 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
376 uint bar0 = addr & ~SBSDIO_SB_OFT_ADDR_MASK;
378 BCMSDH_INFO(("%s:fun = 1, addr = 0x%x, ", __FUNCTION__, addr));
383 ASSERT(bcmsdh->init_success);
385 if (bar0 != bcmsdh->sbwad) {
386 if (bcmsdhsdio_set_sbaddr_window(bcmsdh, bar0))
389 bcmsdh->sbwad = bar0;
392 addr &= SBSDIO_SB_OFT_ADDR_MASK;
394 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
396 status = sdioh_request_word(bcmsdh->sdioh, SDIOH_CMD_TYPE_NORMAL,
397 SDIOH_READ, SDIO_FUNC_1, addr, &word, size);
399 bcmsdh->regfail = !(SDIOH_API_SUCCESS(status));
401 BCMSDH_INFO(("uint32data = 0x%x\n", word));
403 /* if ok, return appropriately masked word */
404 if (SDIOH_API_SUCCESS(status)) {
407 return (word & 0xff);
409 return (word & 0xffff);
413 bcmsdh->regfail = TRUE;
418 /* otherwise, bad sdio access or invalid size */
419 BCMSDH_ERROR(("%s: error reading addr 0x%04x size %d\n", __FUNCTION__, addr, size));
424 bcmsdh_reg_write(void *sdh, uint32 addr, uint size, uint32 data)
426 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
428 uint bar0 = addr & ~SBSDIO_SB_OFT_ADDR_MASK;
431 BCMSDH_INFO(("%s:fun = 1, addr = 0x%x, uint%ddata = 0x%x\n",
432 __FUNCTION__, addr, size*8, data));
437 ASSERT(bcmsdh->init_success);
439 if (bar0 != bcmsdh->sbwad) {
440 if ((err = bcmsdhsdio_set_sbaddr_window(bcmsdh, bar0)))
443 bcmsdh->sbwad = bar0;
446 addr &= SBSDIO_SB_OFT_ADDR_MASK;
448 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
449 status = sdioh_request_word(bcmsdh->sdioh, SDIOH_CMD_TYPE_NORMAL, SDIOH_WRITE, SDIO_FUNC_1,
451 bcmsdh->regfail = !(SDIOH_API_SUCCESS(status));
453 if (SDIOH_API_SUCCESS(status))
456 BCMSDH_ERROR(("%s: error writing 0x%08x to addr 0x%04x size %d\n",
457 __FUNCTION__, data, addr, size));
462 bcmsdh_regfail(void *sdh)
464 return ((bcmsdh_info_t *)sdh)->regfail;
468 bcmsdh_recv_buf(void *sdh, uint32 addr, uint fn, uint flags,
469 uint8 *buf, uint nbytes, void *pkt,
470 bcmsdh_cmplt_fn_t complete, void *handle)
472 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
476 uint bar0 = addr & ~SBSDIO_SB_OFT_ADDR_MASK;
480 ASSERT(bcmsdh->init_success);
482 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, size = %d\n",
483 __FUNCTION__, fn, addr, nbytes));
485 /* Async not implemented yet */
486 ASSERT(!(flags & SDIO_REQ_ASYNC));
487 if (flags & SDIO_REQ_ASYNC)
488 return BCME_UNSUPPORTED;
490 if (bar0 != bcmsdh->sbwad) {
491 if ((err = bcmsdhsdio_set_sbaddr_window(bcmsdh, bar0)))
494 bcmsdh->sbwad = bar0;
497 addr &= SBSDIO_SB_OFT_ADDR_MASK;
499 incr_fix = (flags & SDIO_REQ_FIXED) ? SDIOH_DATA_FIX : SDIOH_DATA_INC;
500 width = (flags & SDIO_REQ_4BYTE) ? 4 : 2;
502 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
504 status = sdioh_request_buffer(bcmsdh->sdioh, SDIOH_DATA_PIO, incr_fix,
505 SDIOH_READ, fn, addr, width, nbytes, buf, pkt);
507 return (SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR);
511 bcmsdh_send_buf(void *sdh, uint32 addr, uint fn, uint flags,
512 uint8 *buf, uint nbytes, void *pkt,
513 bcmsdh_cmplt_fn_t complete, void *handle)
515 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
519 uint bar0 = addr & ~SBSDIO_SB_OFT_ADDR_MASK;
523 ASSERT(bcmsdh->init_success);
525 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, size = %d\n",
526 __FUNCTION__, fn, addr, nbytes));
528 /* Async not implemented yet */
529 ASSERT(!(flags & SDIO_REQ_ASYNC));
530 if (flags & SDIO_REQ_ASYNC)
531 return BCME_UNSUPPORTED;
533 if (bar0 != bcmsdh->sbwad) {
534 if ((err = bcmsdhsdio_set_sbaddr_window(bcmsdh, bar0)))
537 bcmsdh->sbwad = bar0;
540 addr &= SBSDIO_SB_OFT_ADDR_MASK;
542 incr_fix = (flags & SDIO_REQ_FIXED) ? SDIOH_DATA_FIX : SDIOH_DATA_INC;
543 width = (flags & SDIO_REQ_4BYTE) ? 4 : 2;
545 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
547 status = sdioh_request_buffer(bcmsdh->sdioh, SDIOH_DATA_PIO, incr_fix,
548 SDIOH_WRITE, fn, addr, width, nbytes, buf, pkt);
550 return (SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR);
554 bcmsdh_rwdata(void *sdh, uint rw, uint32 addr, uint8 *buf, uint nbytes)
556 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
560 ASSERT(bcmsdh->init_success);
561 ASSERT((addr & SBSDIO_SBWINDOW_MASK) == 0);
563 addr &= SBSDIO_SB_OFT_ADDR_MASK;
564 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
566 status = sdioh_request_buffer(bcmsdh->sdioh, SDIOH_DATA_PIO, SDIOH_DATA_INC,
567 (rw ? SDIOH_WRITE : SDIOH_READ), SDIO_FUNC_1,
568 addr, 4, nbytes, buf, NULL);
570 return (SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR);
574 bcmsdh_abort(void *sdh, uint fn)
576 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
578 return sdioh_abort(bcmsdh->sdioh, fn);
582 bcmsdh_start(void *sdh, int stage)
584 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
586 return sdioh_start(bcmsdh->sdioh, stage);
590 bcmsdh_stop(void *sdh)
592 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
594 return sdioh_stop(bcmsdh->sdioh);
598 bcmsdh_waitlockfree(void *sdh)
600 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
604 return sdioh_waitlockfree(bcmsdh->sdioh);
608 #ifdef BCMSPI /* 4329 gSPI won't have CIS reads. */
610 bcmsdh_query_device(void *sdh)
612 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
614 bcmsdh->vendevid = (VENDOR_BROADCOM << 16) | BCM4321_D11N2G_ID;
616 return (bcmsdh->vendevid);
620 bcmsdh_query_device(void *sdh)
622 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
623 bcmsdh->vendevid = (VENDOR_BROADCOM << 16) | 0;
624 return (bcmsdh->vendevid);
626 #endif /* else BCMSPI */
629 bcmsdh_query_iofnum(void *sdh)
631 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
636 return (sdioh_query_iofnum(bcmsdh->sdioh));
640 bcmsdh_reset(bcmsdh_info_t *sdh)
642 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
644 return sdioh_sdio_reset(bcmsdh->sdioh);
647 void *bcmsdh_get_sdioh(bcmsdh_info_t *sdh)
653 /* Function to pass device-status bits to DHD. */
655 bcmsdh_get_dstatus(void *sdh)
658 bcmsdh_info_t *p = (bcmsdh_info_t *)sdh;
659 sdioh_info_t *sd = (sdioh_info_t *)(p->sdioh);
660 return sdioh_get_dstatus(sd);
666 bcmsdh_cur_sbwad(void *sdh)
668 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
673 return (bcmsdh->sbwad);
677 bcmsdh_chipinfo(void *sdh, uint32 chip, uint32 chiprev)
680 bcmsdh_info_t *p = (bcmsdh_info_t *)sdh;
681 sdioh_info_t *sd = (sdioh_info_t *)(p->sdioh);
682 sdioh_chipinfo(sd, chip, chiprev);
690 bcmsdh_dwordmode(void *sdh, bool set)
692 bcmsdh_info_t *p = (bcmsdh_info_t *)sdh;
693 sdioh_info_t *sd = (sdioh_info_t *)(p->sdioh);
694 sdioh_dwordmode(sd, set);