1 /* 2 * SDIO host client driver interface of Broadcom HNBU 3 * export functions to client drivers 4 * abstract OS and BUS specific details of SDIO 5 * 6 * Portions of this code are copyright (c) 2021 Cypress Semiconductor Corporation 7 * 8 * Copyright (C) 1999-2017, Broadcom Corporation 9 * 10 * Unless you and Broadcom execute a separate written software license 11 * agreement governing use of this software, this software is licensed to you 12 * under the terms of the GNU General Public License version 2 (the "GPL"), 13 * available at http://www.broadcom.com/licenses/GPLv2.php, with the 14 * following added to such license: 15 * 16 * As a special exception, the copyright holders of this software give you 17 * permission to link this software with independent modules, and to copy and 18 * distribute the resulting executable under terms of your choice, provided that 19 * you also meet, for each linked independent module, the terms and conditions of 20 * the license of that module. An independent module is a module which is not 21 * derived from this software. The special exception does not apply to any 22 * modifications of the software. 23 * 24 * Notwithstanding the above, under no circumstances may you combine this 25 * software in any way with any other Broadcom software provided under a license 26 * other than the GPL, without Broadcom's express prior written consent. 27 * 28 * 29 * <<Broadcom-WL-IPTag/Open:>> 30 * 31 * $Id: bcmsdh.h 690946 2017-03-20 05:24:19Z $ 32 */ 33 34 /** 35 * @file bcmsdh.h 36 */ 37 38 #ifndef _bcmsdh_h_ 39 #define _bcmsdh_h_ 40 41 #define BCMSDH_ERROR_VAL 0x0001 /* Error */ 42 #define BCMSDH_INFO_VAL 0x0002 /* Info */ 43 extern const uint bcmsdh_msglevel; 44 45 #define BCMSDH_ERROR(x) 46 #define BCMSDH_INFO(x) 47 48 #if defined(BCMSDIO) && (defined(BCMSDIOH_STD) || defined(BCMSDIOH_BCM) || \ 49 defined(BCMSDIOH_SPI)) 50 #define BCMSDH_ADAPTER 51 #endif /* BCMSDIO && (BCMSDIOH_STD || BCMSDIOH_BCM || BCMSDIOH_SPI) */ 52 53 /* forward declarations */ 54 typedef struct bcmsdh_info bcmsdh_info_t; 55 typedef void (*bcmsdh_cb_fn_t)(void *); 56 57 #if defined(BT_OVER_SDIO) 58 typedef enum { 59 NO_HANG_STATE = 0, 60 HANG_START_STATE = 1, 61 HANG_RECOVERY_STATE = 2 62 } dhd_hang_state_t; 63 #endif // endif 64 65 extern bcmsdh_info_t *bcmsdh_attach(osl_t *osh, void *sdioh, ulong *regsva); 66 /** 67 * BCMSDH API context 68 */ 69 struct bcmsdh_info 70 { 71 bool init_success; /* underlying driver successfully attached */ 72 void *sdioh; /* handler for sdioh */ 73 uint32 vendevid; /* Target Vendor and Device ID on SD bus */ 74 osl_t *osh; 75 bool regfail; /* Save status of last reg_read/reg_write call */ 76 uint32 sbwad; /* Save backplane window address */ 77 void *os_cxt; /* Pointer to per-OS private data */ 78 bool force_sbwad_calc; /* forces calculation of sbwad instead of using cached value */ 79 #ifdef DHD_WAKE_STATUS 80 unsigned int total_wake_count; 81 int pkt_wake; 82 #endif /* DHD_WAKE_STATUS */ 83 }; 84 85 /* Detach - freeup resources allocated in attach */ 86 extern int bcmsdh_detach(osl_t *osh, void *sdh); 87 88 /* Query if SD device interrupts are enabled */ 89 extern bool bcmsdh_intr_query(void *sdh); 90 91 /* Enable/disable SD interrupt */ 92 extern int bcmsdh_intr_enable(void *sdh); 93 extern int bcmsdh_intr_disable(void *sdh); 94 95 /* Register/deregister device interrupt handler. */ 96 extern int bcmsdh_intr_reg(void *sdh, bcmsdh_cb_fn_t fn, void *argh); 97 extern int bcmsdh_intr_dereg(void *sdh); 98 /* Enable/disable SD card interrupt forward */ 99 extern void bcmsdh_intr_forward(void *sdh, bool pass); 100 101 #if defined(DHD_DEBUG) 102 /* Query pending interrupt status from the host controller */ 103 extern bool bcmsdh_intr_pending(void *sdh); 104 #endif // endif 105 106 /* Register a callback to be called if and when bcmsdh detects 107 * device removal. No-op in the case of non-removable/hardwired devices. 108 */ 109 extern int bcmsdh_devremove_reg(void *sdh, bcmsdh_cb_fn_t fn, void *argh); 110 111 /* Access SDIO address space (e.g. CCCR) using CMD52 (single-byte interface). 112 * fn: function number 113 * addr: unmodified SDIO-space address 114 * data: data byte to write 115 * err: pointer to error code (or NULL) 116 */ 117 extern uint8 bcmsdh_cfg_read(void *sdh, uint func, uint32 addr, int *err); 118 extern void bcmsdh_cfg_write(void *sdh, uint func, uint32 addr, uint8 data, int *err); 119 120 /* Read/Write 4bytes from/to cfg space */ 121 extern uint32 bcmsdh_cfg_read_word(void *sdh, uint fnc_num, uint32 addr, int *err); 122 extern void bcmsdh_cfg_write_word(void *sdh, uint fnc_num, uint32 addr, uint32 data, int *err); 123 124 /* Read CIS content for specified function. 125 * fn: function whose CIS is being requested (0 is common CIS) 126 * cis: pointer to memory location to place results 127 * length: number of bytes to read 128 * Internally, this routine uses the values from the cis base regs (0x9-0xB) 129 * to form an SDIO-space address to read the data from. 130 */ 131 extern int bcmsdh_cis_read(void *sdh, uint func, uint8 *cis, uint length); 132 133 /* Synchronous access to device (client) core registers via CMD53 to F1. 134 * addr: backplane address (i.e. >= regsva from attach) 135 * size: register width in bytes (2 or 4) 136 * data: data for register write 137 */ 138 extern uint32 bcmsdh_reg_read(void *sdh, uintptr addr, uint size); 139 extern uint32 bcmsdh_reg_write(void *sdh, uintptr addr, uint size, uint32 data); 140 141 /* set sb address window */ 142 extern int bcmsdhsdio_set_sbaddr_window(void *sdh, uint32 address, bool force_set); 143 144 /* Indicate if last reg read/write failed */ 145 extern bool bcmsdh_regfail(void *sdh); 146 147 /* Buffer transfer to/from device (client) core via cmd53. 148 * fn: function number 149 * addr: backplane address (i.e. >= regsva from attach) 150 * flags: backplane width, address increment, sync/async 151 * buf: pointer to memory data buffer 152 * nbytes: number of bytes to transfer to/from buf 153 * pkt: pointer to packet associated with buf (if any) 154 * complete: callback function for command completion (async only) 155 * handle: handle for completion callback (first arg in callback) 156 * Returns 0 or error code. 157 * NOTE: Async operation is not currently supported. 158 */ 159 typedef void (*bcmsdh_cmplt_fn_t)(void *handle, int status, bool sync_waiting); 160 extern int bcmsdh_send_buf(void *sdh, uint32 addr, uint fn, uint flags, 161 uint8 *buf, uint nbytes, void *pkt, 162 bcmsdh_cmplt_fn_t complete_fn, void *handle); 163 extern int bcmsdh_recv_buf(void *sdh, uint32 addr, uint fn, uint flags, 164 uint8 *buf, uint nbytes, void *pkt, 165 bcmsdh_cmplt_fn_t complete_fn, void *handle); 166 167 extern void bcmsdh_glom_post(void *sdh, uint8 *frame, void *pkt, uint len); 168 extern void bcmsdh_glom_clear(void *sdh); 169 extern uint bcmsdh_set_mode(void *sdh, uint mode); 170 extern bool bcmsdh_glom_enabled(void); 171 /* Flags bits */ 172 #define SDIO_REQ_4BYTE 0x1 /* Four-byte target (backplane) width (vs. two-byte) */ 173 #define SDIO_REQ_FIXED 0x2 /* Fixed address (FIFO) (vs. incrementing address) */ 174 #define SDIO_REQ_ASYNC 0x4 /* Async request (vs. sync request) */ 175 #define SDIO_BYTE_MODE 0x8 /* Byte mode request(non-block mode) */ 176 177 /* Pending (non-error) return code */ 178 #define BCME_PENDING 1 179 180 /* Read/write to memory block (F1, no FIFO) via CMD53 (sync only). 181 * rw: read or write (0/1) 182 * addr: direct SDIO address 183 * buf: pointer to memory data buffer 184 * nbytes: number of bytes to transfer to/from buf 185 * Returns 0 or error code. 186 */ 187 extern int bcmsdh_rwdata(void *sdh, uint rw, uint32 addr, uint8 *buf, uint nbytes); 188 189 /* Issue an abort to the specified function */ 190 extern int bcmsdh_abort(void *sdh, uint fn); 191 192 /* Start SDIO Host Controller communication */ 193 extern int bcmsdh_start(void *sdh, int stage); 194 195 /* Stop SDIO Host Controller communication */ 196 extern int bcmsdh_stop(void *sdh); 197 198 /* Wait system lock free */ 199 extern int bcmsdh_waitlockfree(void *sdh); 200 201 /* Returns the "Device ID" of target device on the SDIO bus. */ 202 extern int bcmsdh_query_device(void *sdh); 203 204 /* Returns the number of IO functions reported by the device */ 205 extern uint bcmsdh_query_iofnum(void *sdh); 206 207 /* Miscellaneous knob tweaker. */ 208 extern int bcmsdh_iovar_op(void *sdh, const char *name, 209 void *params, uint plen, void *arg, uint len, bool set); 210 211 /* Reset and reinitialize the device */ 212 extern int bcmsdh_reset(bcmsdh_info_t *sdh); 213 214 /* helper functions */ 215 216 /* callback functions */ 217 typedef struct { 218 /* probe the device */ 219 void *(*probe)(uint16 vend_id, uint16 dev_id, uint16 bus, uint16 slot, 220 uint16 func, uint bustype, void * regsva, osl_t * osh, 221 void * param); 222 /* remove the device */ 223 void (*remove)(void *context); 224 /* can we suspend now */ 225 int (*suspend)(void *context); 226 /* resume from suspend */ 227 int (*resume)(void *context); 228 } bcmsdh_driver_t; 229 230 /* platform specific/high level functions */ 231 extern int bcmsdh_register(bcmsdh_driver_t *driver); 232 extern void bcmsdh_unregister(void); 233 extern bool bcmsdh_chipmatch(uint16 vendor, uint16 device); 234 extern void bcmsdh_device_remove(void * sdh); 235 236 extern int bcmsdh_reg_sdio_notify(void* semaphore); 237 extern void bcmsdh_unreg_sdio_notify(void); 238 239 #if defined(OOB_INTR_ONLY) || defined(BCMSPI_ANDROID) 240 extern int bcmsdh_oob_intr_register(bcmsdh_info_t *bcmsdh, bcmsdh_cb_fn_t oob_irq_handler, 241 void* oob_irq_handler_context); 242 extern void bcmsdh_oob_intr_unregister(bcmsdh_info_t *sdh); 243 extern void bcmsdh_oob_intr_set(bcmsdh_info_t *sdh, bool enable); 244 #endif /* defined(OOB_INTR_ONLY) || defined(BCMSPI_ANDROID) */ 245 extern void bcmsdh_dev_pm_stay_awake(bcmsdh_info_t *sdh); 246 extern void bcmsdh_dev_relax(bcmsdh_info_t *sdh); 247 extern bool bcmsdh_dev_pm_enabled(bcmsdh_info_t *sdh); 248 249 int bcmsdh_suspend(bcmsdh_info_t *bcmsdh); 250 int bcmsdh_resume(bcmsdh_info_t *bcmsdh); 251 252 /* Function to pass device-status bits to DHD. */ 253 extern uint32 bcmsdh_get_dstatus(void *sdh); 254 255 /* Function to return current window addr */ 256 extern uint32 bcmsdh_cur_sbwad(void *sdh); 257 258 /* function to force sbwad calculation instead of using cached value */ 259 extern void bcmsdh_force_sbwad_calc(void *sdh, bool force); 260 261 /* Function to pass chipid and rev to lower layers for controlling pr's */ 262 extern void bcmsdh_chipinfo(void *sdh, uint32 chip, uint32 chiprev); 263 264 #ifdef BCMSPI 265 extern void bcmsdh_dwordmode(void *sdh, bool set); 266 #endif /* BCMSPI */ 267 268 extern int bcmsdh_sleep(void *sdh, bool enab); 269 270 /* GPIO support */ 271 extern int bcmsdh_gpio_init(void *sd); 272 extern bool bcmsdh_gpioin(void *sd, uint32 gpio); 273 extern int bcmsdh_gpioouten(void *sd, uint32 gpio); 274 extern int bcmsdh_gpioout(void *sd, uint32 gpio, bool enab); 275 276 #ifdef DHD_WAKE_STATUS 277 extern int bcmsdh_get_total_wake(bcmsdh_info_t *bcmsdh); 278 extern int bcmsdh_set_get_wake(bcmsdh_info_t *bcmsdh, int flag); 279 #endif /* DHD_WAKE_STATUS */ 280 281 #endif /* _bcmsdh_h_ */ 282