1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * Definitions for API from sdio common code (bcmsdh) to individual 4 * host controller drivers. 5 * 6 * Copyright (C) 1999-2019, Broadcom. 7 * 8 * Unless you and Broadcom execute a separate written software license 9 * agreement governing use of this software, this software is licensed to you 10 * under the terms of the GNU General Public License version 2 (the "GPL"), 11 * available at http://www.broadcom.com/licenses/GPLv2.php, with the 12 * following added to such license: 13 * 14 * As a special exception, the copyright holders of this software give you 15 * permission to link this software with independent modules, and to copy and 16 * distribute the resulting executable under terms of your choice, provided that 17 * you also meet, for each linked independent module, the terms and conditions of 18 * the license of that module. An independent module is a module which is not 19 * derived from this software. The special exception does not apply to any 20 * modifications of the software. 21 * 22 * Notwithstanding the above, under no circumstances may you combine this 23 * software in any way with any other Broadcom software provided under a license 24 * other than the GPL, without Broadcom's express prior written consent. 25 * 26 * 27 * <<Broadcom-WL-IPTag/Open:>> 28 * 29 * $Id: bcmsdbus.h 689948 2017-03-14 05:21:03Z $ 30 */ 31 32 #ifndef _sdio_api_h_ 33 #define _sdio_api_h_ 34 35 #if defined(BT_OVER_SDIO) 36 #include <linux/mmc/sdio_func.h> 37 #endif /* defined (BT_OVER_SDIO) */ 38 39 #define SDIOH_API_RC_SUCCESS (0x00) 40 #define SDIOH_API_RC_FAIL (0x01) 41 #define SDIOH_API_SUCCESS(status) (status == 0) 42 43 #define SDIOH_READ 0 /* Read request */ 44 #define SDIOH_WRITE 1 /* Write request */ 45 46 #define SDIOH_DATA_FIX 0 /* Fixed addressing */ 47 #define SDIOH_DATA_INC 1 /* Incremental addressing */ 48 49 #define SDIOH_CMD_TYPE_NORMAL 0 /* Normal command */ 50 #define SDIOH_CMD_TYPE_APPEND 1 /* Append command */ 51 #define SDIOH_CMD_TYPE_CUTTHRU 2 /* Cut-through command */ 52 53 #define SDIOH_DATA_PIO 0 /* PIO mode */ 54 #define SDIOH_DATA_DMA 1 /* DMA mode */ 55 56 /* Max number of glommed pkts */ 57 #ifdef CUSTOM_MAX_TXGLOM_SIZE 58 #define SDPCM_MAXGLOM_SIZE CUSTOM_MAX_TXGLOM_SIZE 59 #else 60 #define SDPCM_MAXGLOM_SIZE 36 61 #endif /* CUSTOM_MAX_TXGLOM_SIZE */ 62 63 #define SDPCM_TXGLOM_CPY 0 /* SDIO 2.0 should use copy mode */ 64 #define SDPCM_TXGLOM_MDESC 1 /* SDIO 3.0 should use multi-desc mode */ 65 66 #ifdef CUSTOM_DEF_TXGLOM_SIZE 67 #define SDPCM_DEFGLOM_SIZE CUSTOM_DEF_TXGLOM_SIZE 68 #else 69 #define SDPCM_DEFGLOM_SIZE SDPCM_MAXGLOM_SIZE 70 #endif /* CUSTOM_DEF_TXGLOM_SIZE */ 71 72 #if SDPCM_DEFGLOM_SIZE > SDPCM_MAXGLOM_SIZE 73 #warning "SDPCM_DEFGLOM_SIZE cannot be higher than SDPCM_MAXGLOM_SIZE!!" 74 #undef SDPCM_DEFGLOM_SIZE 75 #define SDPCM_DEFGLOM_SIZE SDPCM_MAXGLOM_SIZE 76 #endif // endif 77 78 #ifdef PKT_STATICS 79 typedef struct pkt_statics { 80 uint16 event_count; 81 uint32 event_size; 82 uint16 ctrl_count; 83 uint32 ctrl_size; 84 uint32 data_count; 85 uint32 data_size; 86 uint32 glom_cnt[SDPCM_MAXGLOM_SIZE]; 87 uint16 glom_max; 88 uint16 glom_count; 89 uint32 glom_size; 90 uint16 test_count; 91 uint32 test_size; 92 uint32 glom_cnt_us[SDPCM_MAXGLOM_SIZE]; 93 } pkt_statics_t; 94 #endif 95 96 typedef int SDIOH_API_RC; 97 98 /* SDio Host structure */ 99 typedef struct sdioh_info sdioh_info_t; 100 101 /* callback function, taking one arg */ 102 typedef void (*sdioh_cb_fn_t)(void *); 103 #if defined(BT_OVER_SDIO) 104 extern 105 void sdioh_sdmmc_card_enable_func_f3(sdioh_info_t *sd, struct sdio_func *func); 106 #endif /* defined (BT_OVER_SDIO) */ 107 108 extern SDIOH_API_RC sdioh_interrupt_register(sdioh_info_t *si, sdioh_cb_fn_t fn, void *argh); 109 extern SDIOH_API_RC sdioh_interrupt_deregister(sdioh_info_t *si); 110 111 /* query whether SD interrupt is enabled or not */ 112 extern SDIOH_API_RC sdioh_interrupt_query(sdioh_info_t *si, bool *onoff); 113 114 /* enable or disable SD interrupt */ 115 extern SDIOH_API_RC sdioh_interrupt_set(sdioh_info_t *si, bool enable_disable); 116 117 #if defined(DHD_DEBUG) 118 extern bool sdioh_interrupt_pending(sdioh_info_t *si); 119 #endif // endif 120 121 /* read or write one byte using cmd52 */ 122 extern SDIOH_API_RC sdioh_request_byte(sdioh_info_t *si, uint rw, uint fnc, uint addr, uint8 *byte); 123 124 /* read or write 2/4 bytes using cmd53 */ 125 extern SDIOH_API_RC sdioh_request_word(sdioh_info_t *si, uint cmd_type, uint rw, uint fnc, 126 uint addr, uint32 *word, uint nbyte); 127 128 /* read or write any buffer using cmd53 */ 129 extern SDIOH_API_RC sdioh_request_buffer(sdioh_info_t *si, uint pio_dma, uint fix_inc, 130 uint rw, uint fnc_num, uint32 addr, uint regwidth, uint32 buflen, uint8 *buffer, 131 void *pkt); 132 133 /* get cis data */ 134 extern SDIOH_API_RC sdioh_cis_read(sdioh_info_t *si, uint fuc, uint8 *cis, uint32 length); 135 extern SDIOH_API_RC sdioh_cisaddr_read(sdioh_info_t *sd, uint func, uint8 *cisd, uint32 offset); 136 137 extern SDIOH_API_RC sdioh_cfg_read(sdioh_info_t *si, uint fuc, uint32 addr, uint8 *data); 138 extern SDIOH_API_RC sdioh_cfg_write(sdioh_info_t *si, uint fuc, uint32 addr, uint8 *data); 139 140 /* query number of io functions */ 141 extern uint sdioh_query_iofnum(sdioh_info_t *si); 142 143 /* handle iovars */ 144 extern int sdioh_iovar_op(sdioh_info_t *si, const char *name, 145 void *params, int plen, void *arg, int len, bool set); 146 147 /* Issue abort to the specified function and clear controller as needed */ 148 extern int sdioh_abort(sdioh_info_t *si, uint fnc); 149 150 /* Start and Stop SDIO without re-enumerating the SD card. */ 151 extern int sdioh_start(sdioh_info_t *si, int stage); 152 extern int sdioh_stop(sdioh_info_t *si); 153 154 /* Wait system lock free */ 155 extern int sdioh_waitlockfree(sdioh_info_t *si); 156 157 /* Reset and re-initialize the device */ 158 extern int sdioh_sdio_reset(sdioh_info_t *si); 159 160 #ifdef BCMSPI 161 /* Function to pass gSPI specific device-status bits to dhd. */ 162 extern uint32 sdioh_get_dstatus(sdioh_info_t *si); 163 164 /* chipid and chiprev info for lower layers to control sw WAR's for hw bugs. */ 165 extern void sdioh_chipinfo(sdioh_info_t *si, uint32 chip, uint32 chiprev); 166 extern void sdioh_dwordmode(sdioh_info_t *si, bool set); 167 #endif /* BCMSPI */ 168 169 #if defined(BCMSDIOH_STD) 170 #define SDIOH_SLEEP_ENABLED 171 #endif // endif 172 extern SDIOH_API_RC sdioh_sleep(sdioh_info_t *si, bool enab); 173 174 /* GPIO support */ 175 extern SDIOH_API_RC sdioh_gpio_init(sdioh_info_t *sd); 176 extern bool sdioh_gpioin(sdioh_info_t *sd, uint32 gpio); 177 extern SDIOH_API_RC sdioh_gpioouten(sdioh_info_t *sd, uint32 gpio); 178 extern SDIOH_API_RC sdioh_gpioout(sdioh_info_t *sd, uint32 gpio, bool enab); 179 extern uint sdioh_set_mode(sdioh_info_t *sd, uint mode); 180 #ifdef PKT_STATICS 181 extern uint32 sdioh_get_spend_time(sdioh_info_t *sd); 182 #endif 183 184 #endif /* _sdio_api_h_ */ 185