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