1 /* 2 * Definitions for API from sdio common code (bcmsdh) to individual 3 * host controller drivers. 4 * 5 * Copyright (C) 2020, Broadcom. 6 * 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: 12 * 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. 20 * 21 * 22 * <<Broadcom-WL-IPTag/Dual:>> 23 */ 24 25 #ifndef _sdio_api_h_ 26 #define _sdio_api_h_ 27 28 #if defined (BT_OVER_SDIO) 29 #include <linux/mmc/sdio_func.h> 30 #endif /* defined (BT_OVER_SDIO) */ 31 32 /* 33 * The following were: 34 * incorrectly in bcmsdio.h 35 * incorrectly named using SDIOH which indicates BRCM SDIO FPGA host controller 36 */ 37 38 #define SDIOH_API_RC_SUCCESS (0x00) 39 #define SDIOH_API_RC_FAIL (0x01) 40 #define SDIOH_API_SUCCESS(status) (status == 0) 41 42 #define SDIOH_READ 0 /* Read request */ 43 #define SDIOH_WRITE 1 /* Write request */ 44 45 #define SDIOH_DATA_FIX 0 /* Fixed addressing */ 46 #define SDIOH_DATA_INC 1 /* Incremental addressing */ 47 48 #define SDIOH_CMD_TYPE_NORMAL 0 /* Normal command */ 49 #define SDIOH_CMD_TYPE_APPEND 1 /* Append command */ 50 #define SDIOH_CMD_TYPE_CUTTHRU 2 /* Cut-through command */ 51 52 #define SDIOH_DATA_PIO 0 /* PIO mode */ 53 #define SDIOH_DATA_DMA 1 /* DMA mode */ 54 55 /* Max number of glommed pkts */ 56 #ifdef CUSTOM_MAX_TXGLOM_SIZE 57 #define SDPCM_MAXGLOM_SIZE CUSTOM_MAX_TXGLOM_SIZE 58 #else 59 #define SDPCM_MAXGLOM_SIZE 36 60 #endif /* CUSTOM_MAX_TXGLOM_SIZE */ 61 62 #define SDPCM_TXGLOM_CPY 0 /* SDIO 2.0 should use copy mode */ 63 #define SDPCM_TXGLOM_MDESC 1 /* SDIO 3.0 should use multi-desc mode */ 64 65 #ifdef CUSTOM_DEF_TXGLOM_SIZE 66 #define SDPCM_DEFGLOM_SIZE CUSTOM_DEF_TXGLOM_SIZE 67 #else 68 #define SDPCM_DEFGLOM_SIZE SDPCM_MAXGLOM_SIZE 69 #endif /* CUSTOM_DEF_TXGLOM_SIZE */ 70 71 #if SDPCM_DEFGLOM_SIZE > SDPCM_MAXGLOM_SIZE 72 #warning "SDPCM_DEFGLOM_SIZE cannot be higher than SDPCM_MAXGLOM_SIZE!!" 73 #undef SDPCM_DEFGLOM_SIZE 74 #define SDPCM_DEFGLOM_SIZE SDPCM_MAXGLOM_SIZE 75 #endif 76 77 #ifdef PKT_STATICS 78 typedef struct pkt_statics { 79 uint16 event_count; 80 uint32 event_size; 81 uint16 ctrl_count; 82 uint32 ctrl_size; 83 uint32 data_count; 84 uint32 data_size; 85 uint32 glom_cnt[SDPCM_MAXGLOM_SIZE]; 86 uint16 glom_max; 87 uint16 glom_count; 88 uint32 glom_size; 89 uint16 test_count; 90 uint32 test_size; 91 uint32 glom_cnt_us[SDPCM_MAXGLOM_SIZE]; 92 } pkt_statics_t; 93 #endif 94 95 typedef int SDIOH_API_RC; 96 97 /* SDio Host structure */ 98 typedef struct sdioh_info sdioh_info_t; 99 100 /* callback function, taking one arg */ 101 typedef void (*sdioh_cb_fn_t)(void *); 102 #if defined (BT_OVER_SDIO) 103 extern 104 void sdioh_sdmmc_card_enable_func_f3(sdioh_info_t *sd, struct sdio_func *func); 105 #endif /* defined (BT_OVER_SDIO) */ 106 107 extern SDIOH_API_RC sdioh_interrupt_register(sdioh_info_t *si, sdioh_cb_fn_t fn, void *argh); 108 extern SDIOH_API_RC sdioh_interrupt_deregister(sdioh_info_t *si); 109 110 /* query whether SD interrupt is enabled or not */ 111 extern SDIOH_API_RC sdioh_interrupt_query(sdioh_info_t *si, bool *onoff); 112 113 /* enable or disable SD interrupt */ 114 extern SDIOH_API_RC sdioh_interrupt_set(sdioh_info_t *si, bool enable_disable); 115 116 #if defined(DHD_DEBUG) || defined(BCMDBG) 117 extern bool sdioh_interrupt_pending(sdioh_info_t *si); 118 #endif 119 120 /* read or write one byte using cmd52 */ 121 extern SDIOH_API_RC sdioh_request_byte(sdioh_info_t *si, uint rw, uint fnc, uint addr, uint8 *byte); 122 123 /* read or write 2/4 bytes using cmd53 */ 124 extern SDIOH_API_RC sdioh_request_word(sdioh_info_t *si, uint cmd_type, uint rw, uint fnc, 125 uint addr, uint32 *word, uint nbyte); 126 127 /* read or write any buffer using cmd53 */ 128 extern SDIOH_API_RC sdioh_request_buffer(sdioh_info_t *si, uint pio_dma, uint fix_inc, 129 uint rw, uint fnc_num, uint32 addr, uint regwidth, uint32 buflen, uint8 *buffer, 130 void *pkt); 131 132 /* get cis data */ 133 extern SDIOH_API_RC sdioh_cis_read(sdioh_info_t *si, uint fuc, uint8 *cis, uint32 length); 134 extern SDIOH_API_RC sdioh_cisaddr_read(sdioh_info_t *sd, uint func, uint8 *cisd, uint32 offset); 135 136 extern SDIOH_API_RC sdioh_cfg_read(sdioh_info_t *si, uint fuc, uint32 addr, uint8 *data); 137 extern SDIOH_API_RC sdioh_cfg_write(sdioh_info_t *si, uint fuc, uint32 addr, uint8 *data); 138 139 /* query number of io functions */ 140 extern uint sdioh_query_iofnum(sdioh_info_t *si); 141 142 /* handle iovars */ 143 extern int sdioh_iovar_op(sdioh_info_t *si, const char *name, 144 void *params, int plen, void *arg, uint len, bool set); 145 146 /* Issue abort to the specified function and clear controller as needed */ 147 extern int sdioh_abort(sdioh_info_t *si, uint fnc); 148 149 /* Start and Stop SDIO without re-enumerating the SD card. */ 150 extern int sdioh_start(sdioh_info_t *si, int stage); 151 extern int sdioh_stop(sdioh_info_t *si); 152 153 /* Wait system lock free */ 154 extern int sdioh_waitlockfree(sdioh_info_t *si); 155 156 /* Reset and re-initialize the device */ 157 extern int sdioh_sdio_reset(sdioh_info_t *si); 158 159 #ifdef BCMSPI 160 /* Function to pass gSPI specific device-status bits to dhd. */ 161 extern uint32 sdioh_get_dstatus(sdioh_info_t *si); 162 163 /* chipid and chiprev info for lower layers to control sw WAR's for hw bugs. */ 164 extern void sdioh_chipinfo(sdioh_info_t *si, uint32 chip, uint32 chiprev); 165 extern void sdioh_dwordmode(sdioh_info_t *si, bool set); 166 #endif /* BCMSPI */ 167 168 #if defined(BCMSDIOH_STD) 169 /* 170 * Only STD host supports cmd14 sleep. 171 * Using define instead of empty stubs for other hosts for now. 172 */ 173 #define SDIOH_SLEEP_ENABLED 174 #endif 175 extern SDIOH_API_RC sdioh_sleep(sdioh_info_t *si, bool enab); 176 177 /* GPIO support */ 178 extern SDIOH_API_RC sdioh_gpio_init(sdioh_info_t *sd); 179 extern bool sdioh_gpioin(sdioh_info_t *sd, uint32 gpio); 180 extern SDIOH_API_RC sdioh_gpioouten(sdioh_info_t *sd, uint32 gpio); 181 extern SDIOH_API_RC sdioh_gpioout(sdioh_info_t *sd, uint32 gpio, bool enab); 182 extern uint sdioh_set_mode(sdioh_info_t *sd, uint mode); 183 #ifdef PKT_STATICS 184 extern uint32 sdioh_get_spend_time(sdioh_info_t *sd); 185 #endif 186 187 #endif /* _sdio_api_h_ */ 188