1/* 2 * 'Standard' SDIO HOST CONTROLLER driver 3 * 4 * Copyright (C) 1999-2012, Broadcom Corporation 5 * 6 * Unless you and Broadcom execute a separate written software license 7 * agreement governing use of this software, this software is licensed to you 8 * under the terms of the GNU General Public License version 2 (the "GPL"), 9 * available at http://www.broadcom.com/licenses/GPLv2.php, with the 10 * following added to such license: 11 * 12 * As a special exception, the copyright holders of this software give you 13 * permission to link this software with independent modules, and to copy and 14 * distribute the resulting executable under terms of your choice, provided that 15 * you also meet, for each linked independent module, the terms and conditions of 16 * the license of that module. An independent module is a module which is not 17 * derived from this software. The special exception does not apply to any 18 * modifications of the software. 19 * 20 * Notwithstanding the above, under no circumstances may you combine this 21 * software in any way with any other Broadcom software provided under a license 22 * other than the GPL, without Broadcom's express prior written consent. 23 * 24 * $Id: bcmsdstd.h 347614 2012-07-27 10:24:51Z $ 25 */ 26#ifndef _BCM_SD_STD_H 27#define _BCM_SD_STD_H 28 29/* global msglevel for debug messages - bitvals come from sdiovar.h */ 30#define sd_err(x) do { if (sd_msglevel & SDH_ERROR_VAL) printf x; } while (0) 31#define sd_trace(x) 32#define sd_info(x) 33#define sd_debug(x) 34#define sd_data(x) 35#define sd_ctrl(x) 36#define sd_dma(x) 37 38#define sd_sync_dma(sd, read, nbytes) 39#define sd_init_dma(sd) 40#define sd_ack_intr(sd) 41#define sd_wakeup(sd); 42/* Allocate/init/free per-OS private data */ 43extern int sdstd_osinit(sdioh_info_t *sd); 44extern void sdstd_osfree(sdioh_info_t *sd); 45 46#define sd_log(x) 47 48#define SDIOH_ASSERT(exp) \ 49 do { if (!(exp)) \ 50 printf("!!!ASSERT fail: file %s lines %d", __FILE__, __LINE__); \ 51 } while (0) 52 53#define BLOCK_SIZE_4318 64 54#define BLOCK_SIZE_4328 512 55 56/* internal return code */ 57#define SUCCESS 0 58#define ERROR 1 59 60/* private bus modes */ 61#define SDIOH_MODE_SPI 0 62#define SDIOH_MODE_SD1 1 63#define SDIOH_MODE_SD4 2 64 65#define MAX_SLOTS 6 /* For PCI: Only 6 BAR entries => 6 slots */ 66#define SDIOH_REG_WINSZ 0x100 /* Number of registers in Standard Host Controller */ 67 68#define SDIOH_TYPE_ARASAN_HDK 1 69#define SDIOH_TYPE_BCM27XX 2 70#define SDIOH_TYPE_TI_PCIXX21 4 /* TI PCIxx21 Standard Host Controller */ 71#define SDIOH_TYPE_RICOH_R5C822 5 /* Ricoh Co Ltd R5C822 SD/SDIO/MMC/MS/MSPro Host Adapter */ 72#define SDIOH_TYPE_JMICRON 6 /* JMicron Standard SDIO Host Controller */ 73 74/* For linux, allow yielding for dongle */ 75#define BCMSDYIELD 76 77/* Expected card status value for CMD7 */ 78#define SDIOH_CMD7_EXP_STATUS 0x00001E00 79 80#define RETRIES_LARGE 100000 81#define sdstd_os_yield(sd) do {} while (0) 82#define RETRIES_SMALL 100 83 84 85#define USE_BLOCKMODE 0x2 /* Block mode can be single block or multi */ 86#define USE_MULTIBLOCK 0x4 87 88#define USE_FIFO 0x8 /* Fifo vs non-fifo */ 89 90#define CLIENT_INTR 0x100 /* Get rid of this! */ 91 92#define HC_INTR_RETUNING 0x1000 93 94 95#ifdef BCMSDIOH_TXGLOM 96/* Setting the MAX limit to 10 */ 97#define SDIOH_MAXGLOM_SIZE 10 98 99typedef struct glom_buf { 100 uint32 count; /* Total number of pkts queued */ 101 void *dma_buf_arr[SDIOH_MAXGLOM_SIZE]; /* Frame address */ 102 ulong dma_phys_arr[SDIOH_MAXGLOM_SIZE]; /* DMA_MAPed address of frames */ 103 uint16 nbytes[SDIOH_MAXGLOM_SIZE]; /* Size of each frame */ 104} glom_buf_t; 105#endif 106 107struct sdioh_info { 108 uint cfg_bar; /* pci cfg address for bar */ 109 uint32 caps; /* cached value of capabilities reg */ 110 uint32 curr_caps; /* max current capabilities reg */ 111 112 osl_t *osh; /* osh handler */ 113 volatile char *mem_space; /* pci device memory va */ 114 uint lockcount; /* nest count of sdstd_lock() calls */ 115 bool client_intr_enabled; /* interrupt connnected flag */ 116 bool intr_handler_valid; /* client driver interrupt handler valid */ 117 sdioh_cb_fn_t intr_handler; /* registered interrupt handler */ 118 void *intr_handler_arg; /* argument to call interrupt handler */ 119 bool initialized; /* card initialized */ 120 uint target_dev; /* Target device ID */ 121 uint16 intmask; /* Current active interrupts */ 122 void *sdos_info; /* Pointer to per-OS private data */ 123 124 uint32 controller_type; /* Host controller type */ 125 uint8 version; /* Host Controller Spec Compliance Version */ 126 uint irq; /* Client irq */ 127 int intrcount; /* Client interrupts */ 128 int local_intrcount; /* Controller interrupts */ 129 bool host_init_done; /* Controller initted */ 130 bool card_init_done; /* Client SDIO interface initted */ 131 bool polled_mode; /* polling for command completion */ 132 133 bool sd_blockmode; /* sd_blockmode == FALSE => 64 Byte Cmd 53s. */ 134 /* Must be on for sd_multiblock to be effective */ 135 bool use_client_ints; /* If this is false, make sure to restore */ 136 /* polling hack in wl_linux.c:wl_timer() */ 137 int adapter_slot; /* Maybe dealing with multiple slots/controllers */ 138 int sd_mode; /* SD1/SD4/SPI */ 139 int client_block_size[SDIOD_MAX_IOFUNCS]; /* Blocksize */ 140 uint32 data_xfer_count; /* Current transfer */ 141 uint16 card_rca; /* Current Address */ 142 int8 sd_dma_mode; /* DMA Mode (PIO, SDMA, ... ADMA2) on CMD53 */ 143 uint8 num_funcs; /* Supported funcs on client */ 144 uint32 com_cis_ptr; 145 uint32 func_cis_ptr[SDIOD_MAX_IOFUNCS]; 146 void *dma_buf; /* DMA Buffer virtual address */ 147 ulong dma_phys; /* DMA Buffer physical address */ 148 void *adma2_dscr_buf; /* ADMA2 Descriptor Buffer virtual address */ 149 ulong adma2_dscr_phys; /* ADMA2 Descriptor Buffer physical address */ 150 151 /* adjustments needed to make the dma align properly */ 152 void *dma_start_buf; 153 ulong dma_start_phys; 154 uint alloced_dma_size; 155 void *adma2_dscr_start_buf; 156 ulong adma2_dscr_start_phys; 157 uint alloced_adma2_dscr_size; 158 159 int r_cnt; /* rx count */ 160 int t_cnt; /* tx_count */ 161 bool got_hcint; /* local interrupt flag */ 162 uint16 last_intrstatus; /* to cache intrstatus */ 163 int host_UHSISupported; /* whether UHSI is supported for HC. */ 164 int card_UHSI_voltage_Supported; /* whether UHSI is supported for 165 * Card in terms of Voltage [1.8 or 3.3]. 166 */ 167 int global_UHSI_Supp; /* type of UHSI support in both host and card. 168 * HOST_SDR_UNSUPP: capabilities not supported/matched 169 * HOST_SDR_12_25: SDR12 and SDR25 supported 170 * HOST_SDR_50_104_DDR: one of SDR50/SDR104 or DDR50 supptd 171 */ 172 volatile int sd3_dat_state; /* data transfer state used for retuning check */ 173 volatile int sd3_tun_state; /* tuning state used for retuning check */ 174 bool sd3_tuning_reqd; /* tuning requirement parameter */ 175 uint32 caps3; /* cached value of 32 MSbits capabilities reg (SDIO 3.0) */ 176#ifdef BCMSDIOH_TXGLOM 177 glom_buf_t glom_info; /* pkt information used for glomming */ 178 uint txglom_mode; /* Txglom mode: 0 - copy, 1 - multi-descriptor */ 179#endif 180}; 181 182#define DMA_MODE_NONE 0 183#define DMA_MODE_SDMA 1 184#define DMA_MODE_ADMA1 2 185#define DMA_MODE_ADMA2 3 186#define DMA_MODE_ADMA2_64 4 187#define DMA_MODE_AUTO -1 188 189#define USE_DMA(sd) ((bool)((sd->sd_dma_mode > 0) ? TRUE : FALSE)) 190 191/* States for Tuning and corr data */ 192#define TUNING_IDLE 0 193#define TUNING_START 1 194#define TUNING_START_AFTER_DAT 2 195#define TUNING_ONGOING 3 196 197#define DATA_TRANSFER_IDLE 0 198#define DATA_TRANSFER_ONGOING 1 199 200#define CHECK_TUNING_PRE_DATA 1 201#define CHECK_TUNING_POST_DATA 2 202 203/************************************************************ 204 * Internal interfaces: per-port references into bcmsdstd.c 205 */ 206 207/* Global message bits */ 208extern uint sd_msglevel; 209 210/* OS-independent interrupt handler */ 211extern bool check_client_intr(sdioh_info_t *sd); 212 213/* Core interrupt enable/disable of device interrupts */ 214extern void sdstd_devintr_on(sdioh_info_t *sd); 215extern void sdstd_devintr_off(sdioh_info_t *sd); 216 217/* Enable/disable interrupts for local controller events */ 218extern void sdstd_intrs_on(sdioh_info_t *sd, uint16 norm, uint16 err); 219extern void sdstd_intrs_off(sdioh_info_t *sd, uint16 norm, uint16 err); 220 221/* Wait for specified interrupt and error bits to be set */ 222extern void sdstd_spinbits(sdioh_info_t *sd, uint16 norm, uint16 err); 223 224 225/************************************************************** 226 * Internal interfaces: bcmsdstd.c references to per-port code 227 */ 228 229/* Register mapping routines */ 230extern uint32 *sdstd_reg_map(osl_t *osh, int32 addr, int size); 231extern void sdstd_reg_unmap(osl_t *osh, int32 addr, int size); 232 233/* Interrupt (de)registration routines */ 234extern int sdstd_register_irq(sdioh_info_t *sd, uint irq); 235extern void sdstd_free_irq(uint irq, sdioh_info_t *sd); 236 237/* OS-specific interrupt wrappers (atomic interrupt enable/disable) */ 238extern void sdstd_lock(sdioh_info_t *sd); 239extern void sdstd_unlock(sdioh_info_t *sd); 240extern void sdstd_waitlockfree(sdioh_info_t *sd); 241 242/* OS-specific wait-for-interrupt-or-status */ 243extern int sdstd_waitbits(sdioh_info_t *sd, uint16 norm, uint16 err, bool yield, uint16 *bits); 244 245/* used by bcmsdstd_linux [implemented in sdstd] */ 246extern void sdstd_3_enable_retuning_int(sdioh_info_t *sd); 247extern void sdstd_3_disable_retuning_int(sdioh_info_t *sd); 248extern bool sdstd_3_is_retuning_int_set(sdioh_info_t *sd); 249extern void sdstd_3_check_and_do_tuning(sdioh_info_t *sd, int tuning_param); 250extern bool sdstd_3_check_and_set_retuning(sdioh_info_t *sd); 251extern int sdstd_3_get_tune_state(sdioh_info_t *sd); 252extern int sdstd_3_get_data_state(sdioh_info_t *sd); 253extern void sdstd_3_set_tune_state(sdioh_info_t *sd, int state); 254extern void sdstd_3_set_data_state(sdioh_info_t *sd, int state); 255extern uint8 sdstd_3_get_tuning_exp(sdioh_info_t *sd); 256extern uint32 sdstd_3_get_uhsi_clkmode(sdioh_info_t *sd); 257extern int sdstd_3_clk_tuning(sdioh_info_t *sd, uint32 sd3ClkMode); 258 259/* used by sdstd [implemented in bcmsdstd_linux/ndis] */ 260extern void sdstd_3_start_tuning(sdioh_info_t *sd); 261extern void sdstd_3_osinit_tuning(sdioh_info_t *sd); 262extern void sdstd_3_osclean_tuning(sdioh_info_t *sd); 263 264#endif /* _BCM_SD_STD_H */ 265