2 * BCMSDH interface glue
3 * implement bcmsdh API for SDIOH driver
5 * Copyright (C) 1999-2010, 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.35.2.1.4.8.6.13 2010/04/06 03:26:57 Exp $
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 /* Defines number of access retries to configuration registers */
44 #define SDIOH_API_ACCESS_RETRY_LIMIT 2
46 const uint bcmsdh_msglevel = BCMSDH_ERROR_VAL;
51 bool init_success; /* underlying driver successfully attached */
52 void *sdioh; /* handler for sdioh */
53 uint32 vendevid; /* Target Vendor and Device ID on SD bus */
55 bool regfail; /* Save status of last reg_read/reg_write call */
56 uint32 sbwad; /* Save backplane window address */
58 /* local copy of bcm sd handler */
59 bcmsdh_info_t * l_bcmsdh = NULL;
61 #if defined(OOB_INTR_ONLY) && defined(HW_OOB)
63 sdioh_enable_hw_oob_intr(void *sdioh, bool enable);
66 bcmsdh_enable_hw_oob_intr(bcmsdh_info_t *sdh, bool enable)
68 sdioh_enable_hw_oob_intr(sdh->sdioh, enable);
73 bcmsdh_attach(osl_t *osh, void *cfghdl, void **regsva, uint irq)
75 bcmsdh_info_t *bcmsdh;
77 if ((bcmsdh = (bcmsdh_info_t *)MALLOC(osh, sizeof(bcmsdh_info_t))) == NULL) {
78 BCMSDH_ERROR(("bcmsdh_attach: out of memory, malloced %d bytes\n", MALLOCED(osh)));
81 bzero((char *)bcmsdh, sizeof(bcmsdh_info_t));
83 /* save the handler locally */
86 if (!(bcmsdh->sdioh = sdioh_attach(osh, cfghdl, irq))) {
87 bcmsdh_detach(osh, bcmsdh);
92 bcmsdh->init_success = TRUE;
94 *regsva = (uint32 *)SI_ENUM_BASE;
96 /* Report the BAR, to fix if needed */
97 bcmsdh->sbwad = SI_ENUM_BASE;
102 bcmsdh_detach(osl_t *osh, void *sdh)
104 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
106 if (bcmsdh != NULL) {
108 sdioh_detach(osh, bcmsdh->sdioh);
109 bcmsdh->sdioh = NULL;
111 MFREE(osh, bcmsdh, sizeof(bcmsdh_info_t));
119 bcmsdh_iovar_op(void *sdh, const char *name,
120 void *params, int plen, void *arg, int len, bool set)
122 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
123 return sdioh_iovar_op(bcmsdh->sdioh, name, params, plen, arg, len, set);
127 bcmsdh_intr_query(void *sdh)
129 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
134 status = sdioh_interrupt_query(bcmsdh->sdioh, &on);
135 if (SDIOH_API_SUCCESS(status))
142 bcmsdh_intr_enable(void *sdh)
144 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
148 status = sdioh_interrupt_set(bcmsdh->sdioh, TRUE);
149 return (SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR);
153 bcmsdh_intr_disable(void *sdh)
155 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
159 status = sdioh_interrupt_set(bcmsdh->sdioh, FALSE);
160 return (SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR);
164 bcmsdh_intr_reg(void *sdh, bcmsdh_cb_fn_t fn, void *argh)
166 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
170 status = sdioh_interrupt_register(bcmsdh->sdioh, fn, argh);
171 return (SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR);
175 bcmsdh_intr_dereg(void *sdh)
177 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
181 status = sdioh_interrupt_deregister(bcmsdh->sdioh);
182 return (SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR);
185 #if defined(DHD_DEBUG)
187 bcmsdh_intr_pending(void *sdh)
189 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
192 return sdioh_interrupt_pending(bcmsdh->sdioh);
198 bcmsdh_devremove_reg(void *sdh, bcmsdh_cb_fn_t fn, void *argh)
202 /* don't support yet */
203 return BCME_UNSUPPORTED;
207 bcmsdh_cfg_read(void *sdh, uint fnc_num, uint32 addr, int *err)
209 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
211 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
219 ASSERT(bcmsdh->init_success);
221 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
223 if (retry) /* wait for 1 ms till bus get settled down */
226 status = sdioh_cfg_read(bcmsdh->sdioh, fnc_num, addr, (uint8 *)&data);
227 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
228 } while (!SDIOH_API_SUCCESS(status) && (retry++ < SDIOH_API_ACCESS_RETRY_LIMIT));
231 *err = (SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR);
233 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, uint8data = 0x%x\n", __FUNCTION__,
234 fnc_num, addr, data));
240 bcmsdh_cfg_write(void *sdh, uint fnc_num, uint32 addr, uint8 data, int *err)
242 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
244 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
251 ASSERT(bcmsdh->init_success);
253 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
255 if (retry) /* wait for 1 ms till bus get settled down */
258 status = sdioh_cfg_write(bcmsdh->sdioh, fnc_num, addr, (uint8 *)&data);
259 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
260 } while (!SDIOH_API_SUCCESS(status) && (retry++ < SDIOH_API_ACCESS_RETRY_LIMIT));
263 *err = SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR;
265 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, uint8data = 0x%x\n", __FUNCTION__,
266 fnc_num, addr, data));
270 bcmsdh_cfg_read_word(void *sdh, uint fnc_num, uint32 addr, int *err)
272 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
279 ASSERT(bcmsdh->init_success);
281 status = sdioh_request_word(bcmsdh->sdioh, SDIOH_CMD_TYPE_NORMAL, SDIOH_READ, fnc_num,
285 *err = (SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR);
287 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, uint32data = 0x%x\n", __FUNCTION__,
288 fnc_num, addr, data));
294 bcmsdh_cfg_write_word(void *sdh, uint fnc_num, uint32 addr, uint32 data, int *err)
296 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
302 ASSERT(bcmsdh->init_success);
304 status = sdioh_request_word(bcmsdh->sdioh, SDIOH_CMD_TYPE_NORMAL, SDIOH_WRITE, fnc_num,
308 *err = (SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR);
310 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, uint32data = 0x%x\n", __FUNCTION__, fnc_num,
316 bcmsdh_cis_read(void *sdh, uint func, uint8 *cis, uint length)
318 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
321 uint8 *tmp_buf, *tmp_ptr;
323 bool ascii = func & ~0xf;
329 ASSERT(bcmsdh->init_success);
331 ASSERT(length <= SBSDIO_CIS_SIZE_LIMIT);
333 status = sdioh_cis_read(bcmsdh->sdioh, func, cis, length);
336 /* Move binary bits to tmp and format them into the provided buffer. */
337 if ((tmp_buf = (uint8 *)MALLOC(bcmsdh->osh, length)) == NULL) {
338 BCMSDH_ERROR(("%s: out of memory\n", __FUNCTION__));
341 bcopy(cis, tmp_buf, length);
342 for (tmp_ptr = tmp_buf, ptr = cis; ptr < (cis + length - 4); tmp_ptr++) {
343 ptr += sprintf((char*)ptr, "%.2x ", *tmp_ptr & 0xff);
344 if ((((tmp_ptr - tmp_buf) + 1) & 0xf) == 0)
345 ptr += sprintf((char *)ptr, "\n");
347 MFREE(bcmsdh->osh, tmp_buf, length);
350 return (SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR);
355 bcmsdhsdio_set_sbaddr_window(void *sdh, uint32 address)
358 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
359 bcmsdh_cfg_write(bcmsdh, SDIO_FUNC_1, SBSDIO_FUNC1_SBADDRLOW,
360 (address >> 8) & SBSDIO_SBADDRLOW_MASK, &err);
362 bcmsdh_cfg_write(bcmsdh, SDIO_FUNC_1, SBSDIO_FUNC1_SBADDRMID,
363 (address >> 16) & SBSDIO_SBADDRMID_MASK, &err);
365 bcmsdh_cfg_write(bcmsdh, SDIO_FUNC_1, SBSDIO_FUNC1_SBADDRHIGH,
366 (address >> 24) & SBSDIO_SBADDRHIGH_MASK, &err);
373 bcmsdh_reg_read(void *sdh, uint32 addr, uint size)
375 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
378 uint bar0 = addr & ~SBSDIO_SB_OFT_ADDR_MASK;
380 BCMSDH_INFO(("%s:fun = 1, addr = 0x%x, ", __FUNCTION__, addr));
385 ASSERT(bcmsdh->init_success);
387 if (bar0 != bcmsdh->sbwad) {
388 if (bcmsdhsdio_set_sbaddr_window(bcmsdh, bar0))
391 bcmsdh->sbwad = bar0;
394 addr &= SBSDIO_SB_OFT_ADDR_MASK;
396 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
398 status = sdioh_request_word(bcmsdh->sdioh, SDIOH_CMD_TYPE_NORMAL,
399 SDIOH_READ, SDIO_FUNC_1, addr, &word, size);
401 bcmsdh->regfail = !(SDIOH_API_SUCCESS(status));
403 BCMSDH_INFO(("uint32data = 0x%x\n", word));
405 /* if ok, return appropriately masked word */
406 if (SDIOH_API_SUCCESS(status)) {
409 return (word & 0xff);
411 return (word & 0xffff);
415 bcmsdh->regfail = TRUE;
420 /* otherwise, bad sdio access or invalid size */
421 BCMSDH_ERROR(("%s: error reading addr 0x%04x size %d\n", __FUNCTION__, addr, size));
426 bcmsdh_reg_write(void *sdh, uint32 addr, uint size, uint32 data)
428 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
430 uint bar0 = addr & ~SBSDIO_SB_OFT_ADDR_MASK;
433 BCMSDH_INFO(("%s:fun = 1, addr = 0x%x, uint%ddata = 0x%x\n",
434 __FUNCTION__, addr, size*8, data));
439 ASSERT(bcmsdh->init_success);
441 if (bar0 != bcmsdh->sbwad) {
442 if ((err = bcmsdhsdio_set_sbaddr_window(bcmsdh, bar0)))
445 bcmsdh->sbwad = bar0;
448 addr &= SBSDIO_SB_OFT_ADDR_MASK;
450 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
451 status = sdioh_request_word(bcmsdh->sdioh, SDIOH_CMD_TYPE_NORMAL, SDIOH_WRITE, SDIO_FUNC_1,
453 bcmsdh->regfail = !(SDIOH_API_SUCCESS(status));
455 if (SDIOH_API_SUCCESS(status))
458 BCMSDH_ERROR(("%s: error writing 0x%08x to addr 0x%04x size %d\n",
459 __FUNCTION__, data, addr, size));
464 bcmsdh_regfail(void *sdh)
466 return ((bcmsdh_info_t *)sdh)->regfail;
470 bcmsdh_recv_buf(void *sdh, uint32 addr, uint fn, uint flags,
471 uint8 *buf, uint nbytes, void *pkt,
472 bcmsdh_cmplt_fn_t complete, void *handle)
474 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
478 uint bar0 = addr & ~SBSDIO_SB_OFT_ADDR_MASK;
482 ASSERT(bcmsdh->init_success);
484 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, size = %d\n",
485 __FUNCTION__, fn, addr, nbytes));
487 /* Async not implemented yet */
488 ASSERT(!(flags & SDIO_REQ_ASYNC));
489 if (flags & SDIO_REQ_ASYNC)
490 return BCME_UNSUPPORTED;
492 if (bar0 != bcmsdh->sbwad) {
493 if ((err = bcmsdhsdio_set_sbaddr_window(bcmsdh, bar0)))
496 bcmsdh->sbwad = bar0;
499 addr &= SBSDIO_SB_OFT_ADDR_MASK;
501 incr_fix = (flags & SDIO_REQ_FIXED) ? SDIOH_DATA_FIX : SDIOH_DATA_INC;
502 width = (flags & SDIO_REQ_4BYTE) ? 4 : 2;
504 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
506 status = sdioh_request_buffer(bcmsdh->sdioh, SDIOH_DATA_PIO, incr_fix,
507 SDIOH_READ, fn, addr, width, nbytes, buf, pkt);
509 return (SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR);
513 bcmsdh_send_buf(void *sdh, uint32 addr, uint fn, uint flags,
514 uint8 *buf, uint nbytes, void *pkt,
515 bcmsdh_cmplt_fn_t complete, void *handle)
517 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
521 uint bar0 = addr & ~SBSDIO_SB_OFT_ADDR_MASK;
525 ASSERT(bcmsdh->init_success);
527 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, size = %d\n",
528 __FUNCTION__, fn, addr, nbytes));
530 /* Async not implemented yet */
531 ASSERT(!(flags & SDIO_REQ_ASYNC));
532 if (flags & SDIO_REQ_ASYNC)
533 return BCME_UNSUPPORTED;
535 if (bar0 != bcmsdh->sbwad) {
536 if ((err = bcmsdhsdio_set_sbaddr_window(bcmsdh, bar0)))
539 bcmsdh->sbwad = bar0;
542 addr &= SBSDIO_SB_OFT_ADDR_MASK;
544 incr_fix = (flags & SDIO_REQ_FIXED) ? SDIOH_DATA_FIX : SDIOH_DATA_INC;
545 width = (flags & SDIO_REQ_4BYTE) ? 4 : 2;
547 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
549 status = sdioh_request_buffer(bcmsdh->sdioh, SDIOH_DATA_PIO, incr_fix,
550 SDIOH_WRITE, fn, addr, width, nbytes, buf, pkt);
552 return (SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR);
556 bcmsdh_rwdata(void *sdh, uint rw, uint32 addr, uint8 *buf, uint nbytes)
558 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
562 ASSERT(bcmsdh->init_success);
563 ASSERT((addr & SBSDIO_SBWINDOW_MASK) == 0);
565 addr &= SBSDIO_SB_OFT_ADDR_MASK;
566 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
568 status = sdioh_request_buffer(bcmsdh->sdioh, SDIOH_DATA_PIO, SDIOH_DATA_INC,
569 (rw ? SDIOH_WRITE : SDIOH_READ), SDIO_FUNC_1,
570 addr, 4, nbytes, buf, NULL);
572 return (SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR);
576 bcmsdh_abort(void *sdh, uint fn)
578 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
580 return sdioh_abort(bcmsdh->sdioh, fn);
584 bcmsdh_start(void *sdh, int stage)
586 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
588 return sdioh_start(bcmsdh->sdioh, stage);
592 bcmsdh_stop(void *sdh)
594 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
596 return sdioh_stop(bcmsdh->sdioh);
601 bcmsdh_query_device(void *sdh)
603 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
604 bcmsdh->vendevid = (VENDOR_BROADCOM << 16) | 0;
605 return (bcmsdh->vendevid);
609 bcmsdh_query_iofnum(void *sdh)
611 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
616 return (sdioh_query_iofnum(bcmsdh->sdioh));
620 bcmsdh_reset(bcmsdh_info_t *sdh)
622 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
624 return sdioh_sdio_reset(bcmsdh->sdioh);
627 void *bcmsdh_get_sdioh(bcmsdh_info_t *sdh)
633 /* Function to pass device-status bits to DHD. */
635 bcmsdh_get_dstatus(void *sdh)
640 bcmsdh_cur_sbwad(void *sdh)
642 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
647 return (bcmsdh->sbwad);
651 bcmsdh_chipinfo(void *sdh, uint32 chip, uint32 chiprev)