/* * SDIO host client driver interface of Broadcom HNBU * export functions to client drivers * abstract OS and BUS specific details of SDIO * * Copyright (C) 1999-2015, Broadcom Corporation * * Unless you and Broadcom execute a separate written software license * agreement governing use of this software, this software is licensed to you * under the terms of the GNU General Public License version 2 (the "GPL"), * available at http://www.broadcom.com/licenses/GPLv2.php, with the * following added to such license: * * As a special exception, the copyright holders of this software give you * permission to link this software with independent modules, and to copy and * distribute the resulting executable under terms of your choice, provided that * you also meet, for each linked independent module, the terms and conditions of * the license of that module. An independent module is a module which is not * derived from this software. The special exception does not apply to any * modifications of the software. * * Notwithstanding the above, under no circumstances may you combine this * software in any way with any other Broadcom software provided under a license * other than the GPL, without Broadcom's express prior written consent. * * $Id: bcmsdh.h 450676 2014-01-22 22:45:13Z $ */ /** * @file bcmsdh.h */ #ifndef _bcmsdh_h_ #define _bcmsdh_h_ #define BCMSDH_ERROR_VAL 0x0001 /* Error */ #define BCMSDH_INFO_VAL 0x0002 /* Info */ extern const uint bcmsdh_msglevel; #define BCMSDH_ERROR(x) #define BCMSDH_INFO(x) #if defined(BCMSDIO) && (defined(BCMSDIOH_STD) || defined(BCMSDIOH_BCM) || \ defined(BCMSDIOH_SPI)) #define BCMSDH_ADAPTER #endif /* BCMSDIO && (BCMSDIOH_STD || BCMSDIOH_BCM || BCMSDIOH_SPI) */ /* forward declarations */ typedef struct bcmsdh_info bcmsdh_info_t; typedef void (*bcmsdh_cb_fn_t)(void *); extern bcmsdh_info_t *bcmsdh_attach(osl_t *osh, void *sdioh, ulong *regsva); /** * BCMSDH API context */ struct bcmsdh_info { bool init_success; /* underlying driver successfully attached */ void *sdioh; /* handler for sdioh */ uint32 vendevid; /* Target Vendor and Device ID on SD bus */ osl_t *osh; bool regfail; /* Save status of last reg_read/reg_write call */ uint32 sbwad; /* Save backplane window address */ void *os_cxt; /* Pointer to per-OS private data */ }; /* Detach - freeup resources allocated in attach */ extern int bcmsdh_detach(osl_t *osh, void *sdh); /* Query if SD device interrupts are enabled */ extern bool bcmsdh_intr_query(void *sdh); /* Enable/disable SD interrupt */ extern int bcmsdh_intr_enable(void *sdh); extern int bcmsdh_intr_disable(void *sdh); /* Register/deregister device interrupt handler. */ extern int bcmsdh_intr_reg(void *sdh, bcmsdh_cb_fn_t fn, void *argh); extern int bcmsdh_intr_dereg(void *sdh); /* Enable/disable SD card interrupt forward */ extern void bcmsdh_intr_forward(void *sdh, bool pass); #if defined(DHD_DEBUG) /* Query pending interrupt status from the host controller */ extern bool bcmsdh_intr_pending(void *sdh); #endif /* Register a callback to be called if and when bcmsdh detects * device removal. No-op in the case of non-removable/hardwired devices. */ extern int bcmsdh_devremove_reg(void *sdh, bcmsdh_cb_fn_t fn, void *argh); /* Access SDIO address space (e.g. CCCR) using CMD52 (single-byte interface). * fn: function number * addr: unmodified SDIO-space address * data: data byte to write * err: pointer to error code (or NULL) */ extern uint8 bcmsdh_cfg_read(void *sdh, uint func, uint32 addr, int *err); extern void bcmsdh_cfg_write(void *sdh, uint func, uint32 addr, uint8 data, int *err); /* Read/Write 4bytes from/to cfg space */ extern uint32 bcmsdh_cfg_read_word(void *sdh, uint fnc_num, uint32 addr, int *err); extern void bcmsdh_cfg_write_word(void *sdh, uint fnc_num, uint32 addr, uint32 data, int *err); /* Read CIS content for specified function. * fn: function whose CIS is being requested (0 is common CIS) * cis: pointer to memory location to place results * length: number of bytes to read * Internally, this routine uses the values from the cis base regs (0x9-0xB) * to form an SDIO-space address to read the data from. */ extern int bcmsdh_cis_read(void *sdh, uint func, uint8 *cis, uint length); /* Synchronous access to device (client) core registers via CMD53 to F1. * addr: backplane address (i.e. >= regsva from attach) * size: register width in bytes (2 or 4) * data: data for register write */ extern uint32 bcmsdh_reg_read(void *sdh, uint32 addr, uint size); extern uint32 bcmsdh_reg_write(void *sdh, uint32 addr, uint size, uint32 data); /* set sb address window */ extern int bcmsdhsdio_set_sbaddr_window(void *sdh, uint32 address, bool force_set); /* Indicate if last reg read/write failed */ extern bool bcmsdh_regfail(void *sdh); /* Buffer transfer to/from device (client) core via cmd53. * fn: function number * addr: backplane address (i.e. >= regsva from attach) * flags: backplane width, address increment, sync/async * buf: pointer to memory data buffer * nbytes: number of bytes to transfer to/from buf * pkt: pointer to packet associated with buf (if any) * complete: callback function for command completion (async only) * handle: handle for completion callback (first arg in callback) * Returns 0 or error code. * NOTE: Async operation is not currently supported. */ typedef void (*bcmsdh_cmplt_fn_t)(void *handle, int status, bool sync_waiting); extern int bcmsdh_send_buf(void *sdh, uint32 addr, uint fn, uint flags, uint8 *buf, uint nbytes, void *pkt, bcmsdh_cmplt_fn_t complete_fn, void *handle); extern int bcmsdh_recv_buf(void *sdh, uint32 addr, uint fn, uint flags, uint8 *buf, uint nbytes, void *pkt, bcmsdh_cmplt_fn_t complete_fn, void *handle); extern void bcmsdh_glom_post(void *sdh, uint8 *frame, void *pkt, uint len); extern void bcmsdh_glom_clear(void *sdh); extern uint bcmsdh_set_mode(void *sdh, uint mode); extern bool bcmsdh_glom_enabled(void); /* Flags bits */ #define SDIO_REQ_4BYTE 0x1 /* Four-byte target (backplane) width (vs. two-byte) */ #define SDIO_REQ_FIXED 0x2 /* Fixed address (FIFO) (vs. incrementing address) */ #define SDIO_REQ_ASYNC 0x4 /* Async request (vs. sync request) */ #define SDIO_BYTE_MODE 0x8 /* Byte mode request(non-block mode) */ /* Pending (non-error) return code */ #define BCME_PENDING 1 /* Read/write to memory block (F1, no FIFO) via CMD53 (sync only). * rw: read or write (0/1) * addr: direct SDIO address * buf: pointer to memory data buffer * nbytes: number of bytes to transfer to/from buf * Returns 0 or error code. */ extern int bcmsdh_rwdata(void *sdh, uint rw, uint32 addr, uint8 *buf, uint nbytes); /* Issue an abort to the specified function */ extern int bcmsdh_abort(void *sdh, uint fn); /* Start SDIO Host Controller communication */ extern int bcmsdh_start(void *sdh, int stage); /* Stop SDIO Host Controller communication */ extern int bcmsdh_stop(void *sdh); /* Wait system lock free */ extern int bcmsdh_waitlockfree(void *sdh); /* Returns the "Device ID" of target device on the SDIO bus. */ extern int bcmsdh_query_device(void *sdh); /* Returns the number of IO functions reported by the device */ extern uint bcmsdh_query_iofnum(void *sdh); /* Miscellaneous knob tweaker. */ extern int bcmsdh_iovar_op(void *sdh, const char *name, void *params, int plen, void *arg, int len, bool set); /* Reset and reinitialize the device */ extern int bcmsdh_reset(bcmsdh_info_t *sdh); /* helper functions */ /* callback functions */ typedef struct { /* probe the device */ void *(*probe)(uint16 vend_id, uint16 dev_id, uint16 bus, uint16 slot, uint16 func, uint bustype, void * regsva, osl_t * osh, void * param); /* remove the device */ void (*remove)(void *context); /* can we suspend now */ int (*suspend)(void *context); /* resume from suspend */ int (*resume)(void *context); } bcmsdh_driver_t; /* platform specific/high level functions */ extern int bcmsdh_register(bcmsdh_driver_t *driver); extern void bcmsdh_unregister(void); extern bool bcmsdh_chipmatch(uint16 vendor, uint16 device); extern void bcmsdh_device_remove(void * sdh); extern int bcmsdh_reg_sdio_notify(void* semaphore); extern void bcmsdh_unreg_sdio_notify(void); #if defined(OOB_INTR_ONLY) extern int bcmsdh_oob_intr_register(bcmsdh_info_t *bcmsdh, bcmsdh_cb_fn_t oob_irq_handler, void* oob_irq_handler_context); extern void bcmsdh_oob_intr_unregister(bcmsdh_info_t *sdh); extern void bcmsdh_oob_intr_set(bcmsdh_info_t *sdh, bool enable); #endif extern void bcmsdh_dev_pm_stay_awake(bcmsdh_info_t *sdh); extern void bcmsdh_dev_relax(bcmsdh_info_t *sdh); extern bool bcmsdh_dev_pm_enabled(bcmsdh_info_t *sdh); int bcmsdh_suspend(bcmsdh_info_t *bcmsdh); int bcmsdh_resume(bcmsdh_info_t *bcmsdh); /* Function to pass device-status bits to DHD. */ extern uint32 bcmsdh_get_dstatus(void *sdh); /* Function to return current window addr */ extern uint32 bcmsdh_cur_sbwad(void *sdh); /* Function to pass chipid and rev to lower layers for controlling pr's */ extern void bcmsdh_chipinfo(void *sdh, uint32 chip, uint32 chiprev); extern int bcmsdh_sleep(void *sdh, bool enab); /* GPIO support */ extern int bcmsdh_gpio_init(void *sd); extern bool bcmsdh_gpioin(void *sd, uint32 gpio); extern int bcmsdh_gpioouten(void *sd, uint32 gpio); extern int bcmsdh_gpioout(void *sd, uint32 gpio, bool enab); #endif /* _bcmsdh_h_ */