2 * BCMSDH interface glue
3 * implement bcmsdh API for SDIOH driver
5 * Copyright (C) 1999-2016, 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.
26 * <<Broadcom-WL-IPTag/Open:>>
28 * $Id: bcmsdh.c 514727 2014-11-12 03:02:48Z $
35 /* ****************** BCMSDH Interface Functions *************************** */
39 #include <bcmendian.h>
45 #include <bcmsdh.h> /* BRCM API for SDIO clients (such as wl, dhd) */
46 #include <bcmsdbus.h> /* common SDIO/controller interface */
47 #include <sbsdio.h> /* SDIO device core hardware definitions. */
48 #include <sdio.h> /* SDIO Device and Protocol Specs */
50 #define SDIOH_API_ACCESS_RETRY_LIMIT 2
51 const uint bcmsdh_msglevel = BCMSDH_ERROR_VAL;
53 /* local copy of bcm sd handler */
54 bcmsdh_info_t * l_bcmsdh = NULL;
57 #if defined(OOB_INTR_ONLY) && defined(HW_OOB) || defined(FORCE_WOWLAN)
59 sdioh_enable_hw_oob_intr(void *sdioh, bool enable);
62 bcmsdh_enable_hw_oob_intr(bcmsdh_info_t *sdh, bool enable)
64 sdioh_enable_hw_oob_intr(sdh->sdioh, enable);
68 /* Attach BCMSDH layer to SDIO Host Controller Driver
70 * @param osh OSL Handle.
71 * @param cfghdl Configuration Handle.
72 * @param regsva Virtual address of controller registers.
73 * @param irq Interrupt number of SDIO controller.
75 * @return bcmsdh_info_t Handle to BCMSDH context.
78 bcmsdh_attach(osl_t *osh, void *sdioh, ulong *regsva)
80 bcmsdh_info_t *bcmsdh;
82 if ((bcmsdh = (bcmsdh_info_t *)MALLOC(osh, sizeof(bcmsdh_info_t))) == NULL) {
83 BCMSDH_ERROR(("bcmsdh_attach: out of memory, malloced %d bytes\n", MALLOCED(osh)));
86 bzero((char *)bcmsdh, sizeof(bcmsdh_info_t));
87 bcmsdh->sdioh = sdioh;
89 bcmsdh->init_success = TRUE;
90 *regsva = SI_ENUM_BASE;
92 /* Report the BAR, to fix if needed */
93 bcmsdh->sbwad = SI_ENUM_BASE;
95 /* save the handler locally */
102 bcmsdh_detach(osl_t *osh, void *sdh)
104 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
106 if (bcmsdh != NULL) {
107 MFREE(osh, bcmsdh, sizeof(bcmsdh_info_t));
116 bcmsdh_iovar_op(void *sdh, const char *name,
117 void *params, int plen, void *arg, int len, bool set)
119 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
120 return sdioh_iovar_op(bcmsdh->sdioh, name, params, plen, arg, len, set);
124 bcmsdh_intr_query(void *sdh)
126 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
131 status = sdioh_interrupt_query(bcmsdh->sdioh, &on);
132 if (SDIOH_API_SUCCESS(status))
139 bcmsdh_intr_enable(void *sdh)
141 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
145 status = sdioh_interrupt_set(bcmsdh->sdioh, TRUE);
146 return (SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR);
150 bcmsdh_intr_disable(void *sdh)
152 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
156 status = sdioh_interrupt_set(bcmsdh->sdioh, FALSE);
157 return (SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR);
161 bcmsdh_intr_reg(void *sdh, bcmsdh_cb_fn_t fn, void *argh)
163 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
167 status = sdioh_interrupt_register(bcmsdh->sdioh, fn, argh);
168 return (SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR);
172 bcmsdh_intr_dereg(void *sdh)
174 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
178 status = sdioh_interrupt_deregister(bcmsdh->sdioh);
179 return (SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR);
182 #if defined(DHD_DEBUG)
184 bcmsdh_intr_pending(void *sdh)
186 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
189 return sdioh_interrupt_pending(bcmsdh->sdioh);
195 bcmsdh_devremove_reg(void *sdh, bcmsdh_cb_fn_t fn, void *argh)
199 /* don't support yet */
200 return BCME_UNSUPPORTED;
204 * Read from SDIO Configuration Space
205 * @param sdh SDIO Host context.
206 * @param func_num Function number to read from.
207 * @param addr Address to read from.
208 * @param err Error return.
209 * @return value read from SDIO configuration space.
212 bcmsdh_cfg_read(void *sdh, uint fnc_num, uint32 addr, int *err)
214 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
216 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
224 ASSERT(bcmsdh->init_success);
226 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
228 if (retry) /* wait for 1 ms till bus get settled down */
231 status = sdioh_cfg_read(bcmsdh->sdioh, fnc_num, addr, (uint8 *)&data);
232 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
233 } while (!SDIOH_API_SUCCESS(status) && (retry++ < SDIOH_API_ACCESS_RETRY_LIMIT));
236 *err = (SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR);
238 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, uint8data = 0x%x\n", __FUNCTION__,
239 fnc_num, addr, data));
245 bcmsdh_cfg_write(void *sdh, uint fnc_num, uint32 addr, uint8 data, int *err)
247 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
249 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
256 ASSERT(bcmsdh->init_success);
258 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
260 if (retry) /* wait for 1 ms till bus get settled down */
263 status = sdioh_cfg_write(bcmsdh->sdioh, fnc_num, addr, (uint8 *)&data);
264 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
265 } while (!SDIOH_API_SUCCESS(status) && (retry++ < SDIOH_API_ACCESS_RETRY_LIMIT));
268 *err = SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR;
270 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, uint8data = 0x%x\n", __FUNCTION__,
271 fnc_num, addr, data));
275 bcmsdh_cfg_read_word(void *sdh, uint fnc_num, uint32 addr, int *err)
277 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
284 ASSERT(bcmsdh->init_success);
286 status = sdioh_request_word(bcmsdh->sdioh, SDIOH_CMD_TYPE_NORMAL, SDIOH_READ, fnc_num,
290 *err = (SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR);
292 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, uint32data = 0x%x\n", __FUNCTION__,
293 fnc_num, addr, data));
299 bcmsdh_cfg_write_word(void *sdh, uint fnc_num, uint32 addr, uint32 data, int *err)
301 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
307 ASSERT(bcmsdh->init_success);
309 status = sdioh_request_word(bcmsdh->sdioh, SDIOH_CMD_TYPE_NORMAL, SDIOH_WRITE, fnc_num,
313 *err = (SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR);
315 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, uint32data = 0x%x\n", __FUNCTION__, fnc_num,
321 bcmsdh_cis_read(void *sdh, uint func, uint8 *cis, uint length)
323 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
326 uint8 *tmp_buf, *tmp_ptr;
328 bool ascii = func & ~0xf;
334 ASSERT(bcmsdh->init_success);
336 ASSERT(length <= SBSDIO_CIS_SIZE_LIMIT);
338 status = sdioh_cis_read(bcmsdh->sdioh, func, cis, length);
341 /* Move binary bits to tmp and format them into the provided buffer. */
342 if ((tmp_buf = (uint8 *)MALLOC(bcmsdh->osh, length)) == NULL) {
343 BCMSDH_ERROR(("%s: out of memory\n", __FUNCTION__));
346 bcopy(cis, tmp_buf, length);
347 for (tmp_ptr = tmp_buf, ptr = cis; ptr < (cis + length - 4); tmp_ptr++) {
348 ptr += snprintf((char*)ptr, (cis + length - ptr - 4),
349 "%.2x ", *tmp_ptr & 0xff);
350 if ((((tmp_ptr - tmp_buf) + 1) & 0xf) == 0)
351 ptr += snprintf((char *)ptr, (cis + length - ptr -4), "\n");
353 MFREE(bcmsdh->osh, tmp_buf, length);
356 return (SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR);
361 bcmsdhsdio_set_sbaddr_window(void *sdh, uint32 address, bool force_set)
364 uint bar0 = address & ~SBSDIO_SB_OFT_ADDR_MASK;
365 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
367 if (bar0 != bcmsdh->sbwad || force_set) {
368 bcmsdh_cfg_write(bcmsdh, SDIO_FUNC_1, SBSDIO_FUNC1_SBADDRLOW,
369 (address >> 8) & SBSDIO_SBADDRLOW_MASK, &err);
371 bcmsdh_cfg_write(bcmsdh, SDIO_FUNC_1, SBSDIO_FUNC1_SBADDRMID,
372 (address >> 16) & SBSDIO_SBADDRMID_MASK, &err);
374 bcmsdh_cfg_write(bcmsdh, SDIO_FUNC_1, SBSDIO_FUNC1_SBADDRHIGH,
375 (address >> 24) & SBSDIO_SBADDRHIGH_MASK, &err);
378 bcmsdh->sbwad = bar0;
380 /* invalidate cached window var */
389 bcmsdh_reg_read(void *sdh, uint32 addr, uint size)
391 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
395 BCMSDH_INFO(("%s:fun = 1, addr = 0x%x, ", __FUNCTION__, addr));
400 ASSERT(bcmsdh->init_success);
402 if (bcmsdhsdio_set_sbaddr_window(bcmsdh, addr, FALSE)) {
403 bcmsdh->regfail = TRUE; // terence 20130621: prevent dhd_dpc in dead lock
407 addr &= SBSDIO_SB_OFT_ADDR_MASK;
409 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
411 status = sdioh_request_word(bcmsdh->sdioh, SDIOH_CMD_TYPE_NORMAL,
412 SDIOH_READ, SDIO_FUNC_1, addr, &word, size);
414 bcmsdh->regfail = !(SDIOH_API_SUCCESS(status));
416 BCMSDH_INFO(("uint32data = 0x%x\n", word));
418 /* if ok, return appropriately masked word */
419 if (SDIOH_API_SUCCESS(status)) {
422 return (word & 0xff);
424 return (word & 0xffff);
428 bcmsdh->regfail = TRUE;
433 /* otherwise, bad sdio access or invalid size */
434 BCMSDH_ERROR(("%s: error reading addr 0x%04x size %d\n", __FUNCTION__, addr, size));
439 bcmsdh_reg_write(void *sdh, uint32 addr, uint size, uint32 data)
441 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
445 BCMSDH_INFO(("%s:fun = 1, addr = 0x%x, uint%ddata = 0x%x\n",
446 __FUNCTION__, addr, size*8, data));
451 ASSERT(bcmsdh->init_success);
453 if ((err = bcmsdhsdio_set_sbaddr_window(bcmsdh, addr, FALSE))) {
454 bcmsdh->regfail = TRUE; // terence 20130621:
458 addr &= SBSDIO_SB_OFT_ADDR_MASK;
460 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
461 status = sdioh_request_word(bcmsdh->sdioh, SDIOH_CMD_TYPE_NORMAL, SDIOH_WRITE, SDIO_FUNC_1,
463 bcmsdh->regfail = !(SDIOH_API_SUCCESS(status));
465 if (SDIOH_API_SUCCESS(status))
468 BCMSDH_ERROR(("%s: error writing 0x%08x to addr 0x%04x size %d\n",
469 __FUNCTION__, data, addr, size));
474 bcmsdh_regfail(void *sdh)
476 return ((bcmsdh_info_t *)sdh)->regfail;
480 bcmsdh_recv_buf(void *sdh, uint32 addr, uint fn, uint flags,
481 uint8 *buf, uint nbytes, void *pkt,
482 bcmsdh_cmplt_fn_t complete_fn, void *handle)
484 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
491 ASSERT(bcmsdh->init_success);
493 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, size = %d\n",
494 __FUNCTION__, fn, addr, nbytes));
496 /* Async not implemented yet */
497 ASSERT(!(flags & SDIO_REQ_ASYNC));
498 if (flags & SDIO_REQ_ASYNC)
499 return BCME_UNSUPPORTED;
501 if ((err = bcmsdhsdio_set_sbaddr_window(bcmsdh, addr, FALSE)))
504 addr &= SBSDIO_SB_OFT_ADDR_MASK;
506 incr_fix = (flags & SDIO_REQ_FIXED) ? SDIOH_DATA_FIX : SDIOH_DATA_INC;
507 width = (flags & SDIO_REQ_4BYTE) ? 4 : 2;
509 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
511 status = sdioh_request_buffer(bcmsdh->sdioh, SDIOH_DATA_PIO, incr_fix,
512 SDIOH_READ, fn, addr, width, nbytes, buf, pkt);
514 return (SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR);
518 bcmsdh_send_buf(void *sdh, uint32 addr, uint fn, uint flags,
519 uint8 *buf, uint nbytes, void *pkt,
520 bcmsdh_cmplt_fn_t complete_fn, void *handle)
522 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
529 ASSERT(bcmsdh->init_success);
531 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, size = %d\n",
532 __FUNCTION__, fn, addr, nbytes));
534 /* Async not implemented yet */
535 ASSERT(!(flags & SDIO_REQ_ASYNC));
536 if (flags & SDIO_REQ_ASYNC)
537 return BCME_UNSUPPORTED;
539 if ((err = bcmsdhsdio_set_sbaddr_window(bcmsdh, addr, FALSE)))
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);
600 bcmsdh_waitlockfree(void *sdh)
602 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
604 return sdioh_waitlockfree(bcmsdh->sdioh);
609 bcmsdh_query_device(void *sdh)
611 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
612 bcmsdh->vendevid = (VENDOR_BROADCOM << 16) | 0;
613 return (bcmsdh->vendevid);
617 bcmsdh_query_iofnum(void *sdh)
619 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
624 return (sdioh_query_iofnum(bcmsdh->sdioh));
628 bcmsdh_reset(bcmsdh_info_t *sdh)
630 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
632 return sdioh_sdio_reset(bcmsdh->sdioh);
635 void *bcmsdh_get_sdioh(bcmsdh_info_t *sdh)
641 /* Function to pass device-status bits to DHD. */
643 bcmsdh_get_dstatus(void *sdh)
648 bcmsdh_cur_sbwad(void *sdh)
650 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
655 return (bcmsdh->sbwad);
659 bcmsdh_chipinfo(void *sdh, uint32 chip, uint32 chiprev)
666 bcmsdh_sleep(void *sdh, bool enab)
668 #ifdef SDIOH_SLEEP_ENABLED
669 bcmsdh_info_t *p = (bcmsdh_info_t *)sdh;
670 sdioh_info_t *sd = (sdioh_info_t *)(p->sdioh);
672 return sdioh_sleep(sd, enab);
674 return BCME_UNSUPPORTED;
679 bcmsdh_gpio_init(void *sdh)
681 bcmsdh_info_t *p = (bcmsdh_info_t *)sdh;
682 sdioh_info_t *sd = (sdioh_info_t *)(p->sdioh);
684 return sdioh_gpio_init(sd);
688 bcmsdh_gpioin(void *sdh, uint32 gpio)
690 bcmsdh_info_t *p = (bcmsdh_info_t *)sdh;
691 sdioh_info_t *sd = (sdioh_info_t *)(p->sdioh);
693 return sdioh_gpioin(sd, gpio);
697 bcmsdh_gpioouten(void *sdh, uint32 gpio)
699 bcmsdh_info_t *p = (bcmsdh_info_t *)sdh;
700 sdioh_info_t *sd = (sdioh_info_t *)(p->sdioh);
702 return sdioh_gpioouten(sd, gpio);
706 bcmsdh_gpioout(void *sdh, uint32 gpio, bool enab)
708 bcmsdh_info_t *p = (bcmsdh_info_t *)sdh;
709 sdioh_info_t *sd = (sdioh_info_t *)(p->sdioh);
711 return sdioh_gpioout(sd, gpio, enab);
715 bcmsdh_set_mode(void *sdh, uint mode)
717 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
718 return (sdioh_set_mode(bcmsdh->sdioh, mode));
721 #if defined(SWTXGLOM)
723 bcmsdh_send_swtxglom_buf(void *sdh, uint32 addr, uint fn, uint flags,
724 uint8 *buf, uint nbytes, void *pkt,
725 bcmsdh_cmplt_fn_t complete_fn, void *handle)
727 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
734 ASSERT(bcmsdh->init_success);
736 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, size = %d\n",
737 __FUNCTION__, fn, addr, nbytes));
739 /* Async not implemented yet */
740 ASSERT(!(flags & SDIO_REQ_ASYNC));
741 if (flags & SDIO_REQ_ASYNC)
742 return BCME_UNSUPPORTED;
744 if ((err = bcmsdhsdio_set_sbaddr_window(bcmsdh, addr, FALSE)))
747 addr &= SBSDIO_SB_OFT_ADDR_MASK;
749 incr_fix = (flags & SDIO_REQ_FIXED) ? SDIOH_DATA_FIX : SDIOH_DATA_INC;
750 width = (flags & SDIO_REQ_4BYTE) ? 4 : 2;
752 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
754 status = sdioh_request_swtxglom_buffer(bcmsdh->sdioh, SDIOH_DATA_PIO, incr_fix,
755 SDIOH_WRITE, fn, addr, width, nbytes, buf, pkt);
757 return (SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR);
761 bcmsdh_glom_post(void *sdh, uint8 *frame, void *pkt, uint len)
763 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
764 sdioh_glom_post(bcmsdh->sdioh, frame, pkt, len);
768 bcmsdh_glom_clear(void *sdh)
770 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)sdh;
771 sdioh_glom_clear(bcmsdh->sdioh);
773 #endif /* SWTXGLOM */