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>
21 #include <bcmendian.h>
27 #include <bcmsdh.h> /* BRCM API for SDIO
28 clients (such as wl, dhd) */
29 #include <bcmsdbus.h> /* common SDIO/controller interface */
30 #include <sbsdio.h> /* BRCM sdio device core */
32 #include <sdio.h> /* sdio spec */
34 #define SDIOH_API_ACCESS_RETRY_LIMIT 2
35 const uint bcmsdh_msglevel = BCMSDH_ERROR_VAL;
38 bool init_success; /* underlying driver successfully attached */
39 void *sdioh; /* handler for sdioh */
40 u32 vendevid; /* Target Vendor and Device ID on SD bus */
42 bool regfail; /* Save status of last
43 reg_read/reg_write call */
44 u32 sbwad; /* Save backplane window address */
46 /* local copy of bcm sd handler */
47 bcmsdh_info_t *l_bcmsdh;
49 #if defined(OOB_INTR_ONLY) && defined(HW_OOB)
50 extern int sdioh_enable_hw_oob_intr(void *sdioh, bool enable);
52 void bcmsdh_enable_hw_oob_intr(bcmsdh_info_t *sdh, bool enable)
54 sdioh_enable_hw_oob_intr(sdh->sdioh, enable);
58 bcmsdh_info_t *bcmsdh_attach(osl_t *osh, void *cfghdl, void **regsva, uint irq)
60 bcmsdh_info_t *bcmsdh;
62 bcmsdh = kzalloc(sizeof(bcmsdh_info_t), GFP_ATOMIC);
64 BCMSDH_ERROR(("bcmsdh_attach: out of memory"));
68 /* save the handler locally */
71 bcmsdh->sdioh = sdioh_attach(osh, cfghdl, irq);
73 bcmsdh_detach(osh, bcmsdh);
78 bcmsdh->init_success = true;
80 *regsva = (u32 *) SI_ENUM_BASE;
82 /* Report the BAR, to fix if needed */
83 bcmsdh->sbwad = SI_ENUM_BASE;
87 int bcmsdh_detach(osl_t *osh, void *sdh)
89 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
93 sdioh_detach(osh, bcmsdh->sdioh);
104 bcmsdh_iovar_op(void *sdh, const char *name,
105 void *params, int plen, void *arg, int len, bool set)
107 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
108 return sdioh_iovar_op(bcmsdh->sdioh, name, params, plen, arg, len, set);
111 bool bcmsdh_intr_query(void *sdh)
113 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
118 status = sdioh_interrupt_query(bcmsdh->sdioh, &on);
119 if (SDIOH_API_SUCCESS(status))
125 int bcmsdh_intr_enable(void *sdh)
127 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
131 status = sdioh_interrupt_set(bcmsdh->sdioh, true);
132 return SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR;
135 int bcmsdh_intr_disable(void *sdh)
137 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
141 status = sdioh_interrupt_set(bcmsdh->sdioh, false);
142 return SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR;
145 int bcmsdh_intr_reg(void *sdh, bcmsdh_cb_fn_t fn, void *argh)
147 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
151 status = sdioh_interrupt_register(bcmsdh->sdioh, fn, argh);
152 return SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR;
155 int bcmsdh_intr_dereg(void *sdh)
157 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
161 status = sdioh_interrupt_deregister(bcmsdh->sdioh);
162 return SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR;
165 #if defined(DHD_DEBUG)
166 bool bcmsdh_intr_pending(void *sdh)
168 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
171 return sdioh_interrupt_pending(bcmsdh->sdioh);
175 int bcmsdh_devremove_reg(void *sdh, bcmsdh_cb_fn_t fn, void *argh)
179 /* don't support yet */
180 return BCME_UNSUPPORTED;
183 u8 bcmsdh_cfg_read(void *sdh, uint fnc_num, u32 addr, int *err)
185 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
187 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
195 ASSERT(bcmsdh->init_success);
197 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
199 if (retry) /* wait for 1 ms till bus get settled down */
203 sdioh_cfg_read(bcmsdh->sdioh, fnc_num, addr,
205 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
206 } while (!SDIOH_API_SUCCESS(status)
207 && (retry++ < SDIOH_API_ACCESS_RETRY_LIMIT));
210 *err = (SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR);
212 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, u8data = 0x%x\n",
213 __func__, fnc_num, addr, data));
219 bcmsdh_cfg_write(void *sdh, uint fnc_num, u32 addr, u8 data, int *err)
221 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
223 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
230 ASSERT(bcmsdh->init_success);
232 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
234 if (retry) /* wait for 1 ms till bus get settled down */
238 sdioh_cfg_write(bcmsdh->sdioh, fnc_num, addr,
240 #ifdef SDIOH_API_ACCESS_RETRY_LIMIT
241 } while (!SDIOH_API_SUCCESS(status)
242 && (retry++ < SDIOH_API_ACCESS_RETRY_LIMIT));
245 *err = SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR;
247 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, u8data = 0x%x\n",
248 __func__, fnc_num, addr, data));
251 u32 bcmsdh_cfg_read_word(void *sdh, uint fnc_num, u32 addr, int *err)
253 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
260 ASSERT(bcmsdh->init_success);
263 sdioh_request_word(bcmsdh->sdioh, SDIOH_CMD_TYPE_NORMAL, SDIOH_READ,
264 fnc_num, addr, &data, 4);
267 *err = (SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR);
269 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, u32data = 0x%x\n",
270 __func__, fnc_num, addr, data));
276 bcmsdh_cfg_write_word(void *sdh, uint fnc_num, u32 addr, u32 data,
279 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
285 ASSERT(bcmsdh->init_success);
288 sdioh_request_word(bcmsdh->sdioh, SDIOH_CMD_TYPE_NORMAL,
289 SDIOH_WRITE, fnc_num, addr, &data, 4);
292 *err = (SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR);
294 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, u32data = 0x%x\n",
295 __func__, fnc_num, addr, data));
298 int bcmsdh_cis_read(void *sdh, uint func, u8 * cis, uint length)
300 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
303 u8 *tmp_buf, *tmp_ptr;
305 bool ascii = func & ~0xf;
311 ASSERT(bcmsdh->init_success);
313 ASSERT(length <= SBSDIO_CIS_SIZE_LIMIT);
315 status = sdioh_cis_read(bcmsdh->sdioh, func, cis, length);
318 /* Move binary bits to tmp and format them
319 into the provided buffer. */
320 tmp_buf = kmalloc(length, GFP_ATOMIC);
321 if (tmp_buf == NULL) {
322 BCMSDH_ERROR(("%s: out of memory\n", __func__));
325 bcopy(cis, tmp_buf, length);
326 for (tmp_ptr = tmp_buf, ptr = cis; ptr < (cis + length - 4);
328 ptr += sprintf((char *)ptr, "%.2x ", *tmp_ptr & 0xff);
329 if ((((tmp_ptr - tmp_buf) + 1) & 0xf) == 0)
330 ptr += sprintf((char *)ptr, "\n");
335 return SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR;
338 static int bcmsdhsdio_set_sbaddr_window(void *sdh, u32 address)
341 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
342 bcmsdh_cfg_write(bcmsdh, SDIO_FUNC_1, SBSDIO_FUNC1_SBADDRLOW,
343 (address >> 8) & SBSDIO_SBADDRLOW_MASK, &err);
345 bcmsdh_cfg_write(bcmsdh, SDIO_FUNC_1, SBSDIO_FUNC1_SBADDRMID,
346 (address >> 16) & SBSDIO_SBADDRMID_MASK, &err);
348 bcmsdh_cfg_write(bcmsdh, SDIO_FUNC_1, SBSDIO_FUNC1_SBADDRHIGH,
349 (address >> 24) & SBSDIO_SBADDRHIGH_MASK,
355 u32 bcmsdh_reg_read(void *sdh, u32 addr, uint size)
357 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
360 uint bar0 = addr & ~SBSDIO_SB_OFT_ADDR_MASK;
362 BCMSDH_INFO(("%s:fun = 1, addr = 0x%x, ", __func__, addr));
367 ASSERT(bcmsdh->init_success);
369 if (bar0 != bcmsdh->sbwad) {
370 if (bcmsdhsdio_set_sbaddr_window(bcmsdh, bar0))
373 bcmsdh->sbwad = bar0;
376 addr &= SBSDIO_SB_OFT_ADDR_MASK;
378 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
380 status = sdioh_request_word(bcmsdh->sdioh, SDIOH_CMD_TYPE_NORMAL,
381 SDIOH_READ, SDIO_FUNC_1, addr, &word, size);
383 bcmsdh->regfail = !(SDIOH_API_SUCCESS(status));
385 BCMSDH_INFO(("u32data = 0x%x\n", word));
387 /* if ok, return appropriately masked word */
388 if (SDIOH_API_SUCCESS(status)) {
393 return word & 0xffff;
397 bcmsdh->regfail = true;
402 /* otherwise, bad sdio access or invalid size */
403 BCMSDH_ERROR(("%s: error reading addr 0x%04x size %d\n", __func__,
408 u32 bcmsdh_reg_write(void *sdh, u32 addr, uint size, u32 data)
410 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
412 uint bar0 = addr & ~SBSDIO_SB_OFT_ADDR_MASK;
415 BCMSDH_INFO(("%s:fun = 1, addr = 0x%x, uint%ddata = 0x%x\n",
416 __func__, addr, size * 8, data));
421 ASSERT(bcmsdh->init_success);
423 if (bar0 != bcmsdh->sbwad) {
424 err = bcmsdhsdio_set_sbaddr_window(bcmsdh, bar0);
428 bcmsdh->sbwad = bar0;
431 addr &= SBSDIO_SB_OFT_ADDR_MASK;
433 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
435 sdioh_request_word(bcmsdh->sdioh, SDIOH_CMD_TYPE_NORMAL,
436 SDIOH_WRITE, SDIO_FUNC_1, addr, &data, size);
437 bcmsdh->regfail = !(SDIOH_API_SUCCESS(status));
439 if (SDIOH_API_SUCCESS(status))
442 BCMSDH_ERROR(("%s: error writing 0x%08x to addr 0x%04x size %d\n",
443 __func__, data, addr, size));
447 bool bcmsdh_regfail(void *sdh)
449 return ((bcmsdh_info_t *) sdh)->regfail;
453 bcmsdh_recv_buf(void *sdh, u32 addr, uint fn, uint flags,
454 u8 *buf, uint nbytes, void *pkt,
455 bcmsdh_cmplt_fn_t complete, void *handle)
457 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
461 uint bar0 = addr & ~SBSDIO_SB_OFT_ADDR_MASK;
465 ASSERT(bcmsdh->init_success);
467 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, size = %d\n",
468 __func__, fn, addr, nbytes));
470 /* Async not implemented yet */
471 ASSERT(!(flags & SDIO_REQ_ASYNC));
472 if (flags & SDIO_REQ_ASYNC)
473 return BCME_UNSUPPORTED;
475 if (bar0 != bcmsdh->sbwad) {
476 err = bcmsdhsdio_set_sbaddr_window(bcmsdh, bar0);
480 bcmsdh->sbwad = bar0;
483 addr &= SBSDIO_SB_OFT_ADDR_MASK;
485 incr_fix = (flags & SDIO_REQ_FIXED) ? SDIOH_DATA_FIX : SDIOH_DATA_INC;
486 width = (flags & SDIO_REQ_4BYTE) ? 4 : 2;
488 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
490 status = sdioh_request_buffer(bcmsdh->sdioh, SDIOH_DATA_PIO, incr_fix,
491 SDIOH_READ, fn, addr, width, nbytes, buf,
494 return SDIOH_API_SUCCESS(status) ? 0 : BCME_SDIO_ERROR;
498 bcmsdh_send_buf(void *sdh, u32 addr, uint fn, uint flags,
499 u8 *buf, uint nbytes, void *pkt,
500 bcmsdh_cmplt_fn_t complete, void *handle)
502 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
506 uint bar0 = addr & ~SBSDIO_SB_OFT_ADDR_MASK;
510 ASSERT(bcmsdh->init_success);
512 BCMSDH_INFO(("%s:fun = %d, addr = 0x%x, size = %d\n",
513 __func__, fn, addr, nbytes));
515 /* Async not implemented yet */
516 ASSERT(!(flags & SDIO_REQ_ASYNC));
517 if (flags & SDIO_REQ_ASYNC)
518 return BCME_UNSUPPORTED;
520 if (bar0 != bcmsdh->sbwad) {
521 err = bcmsdhsdio_set_sbaddr_window(bcmsdh, bar0);
525 bcmsdh->sbwad = bar0;
528 addr &= SBSDIO_SB_OFT_ADDR_MASK;
530 incr_fix = (flags & SDIO_REQ_FIXED) ? SDIOH_DATA_FIX : SDIOH_DATA_INC;
531 width = (flags & SDIO_REQ_4BYTE) ? 4 : 2;
533 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
535 status = sdioh_request_buffer(bcmsdh->sdioh, SDIOH_DATA_PIO, incr_fix,
536 SDIOH_WRITE, fn, addr, width, nbytes, buf,
539 return SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR;
542 int bcmsdh_rwdata(void *sdh, uint rw, u32 addr, u8 *buf, uint nbytes)
544 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
548 ASSERT(bcmsdh->init_success);
549 ASSERT((addr & SBSDIO_SBWINDOW_MASK) == 0);
551 addr &= SBSDIO_SB_OFT_ADDR_MASK;
552 addr |= SBSDIO_SB_ACCESS_2_4B_FLAG;
555 sdioh_request_buffer(bcmsdh->sdioh, SDIOH_DATA_PIO, SDIOH_DATA_INC,
556 (rw ? SDIOH_WRITE : SDIOH_READ), SDIO_FUNC_1,
557 addr, 4, nbytes, buf, NULL);
559 return SDIOH_API_SUCCESS(status) ? 0 : BCME_ERROR;
562 int bcmsdh_abort(void *sdh, uint fn)
564 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
566 return sdioh_abort(bcmsdh->sdioh, fn);
569 int bcmsdh_start(void *sdh, int stage)
571 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
573 return sdioh_start(bcmsdh->sdioh, stage);
576 int bcmsdh_stop(void *sdh)
578 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
580 return sdioh_stop(bcmsdh->sdioh);
583 int bcmsdh_query_device(void *sdh)
585 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
586 bcmsdh->vendevid = (VENDOR_BROADCOM << 16) | 0;
587 return bcmsdh->vendevid;
590 uint bcmsdh_query_iofnum(void *sdh)
592 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
597 return sdioh_query_iofnum(bcmsdh->sdioh);
600 int bcmsdh_reset(bcmsdh_info_t *sdh)
602 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
604 return sdioh_sdio_reset(bcmsdh->sdioh);
607 void *bcmsdh_get_sdioh(bcmsdh_info_t *sdh)
613 /* Function to pass device-status bits to DHD. */
614 u32 bcmsdh_get_dstatus(void *sdh)
619 u32 bcmsdh_cur_sbwad(void *sdh)
621 bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *) sdh;
626 return bcmsdh->sbwad;
629 void bcmsdh_chipinfo(void *sdh, u32 chip, u32 chiprev)