1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * NXP Wireless LAN device driver: SDIO specific definitions 4 * 5 * Copyright 2011-2020 NXP 6 */ 7 8 #ifndef _MWIFIEX_SDIO_H 9 #define _MWIFIEX_SDIO_H 10 11 12 #include <linux/completion.h> 13 #include <linux/mmc/sdio.h> 14 #include <linux/mmc/sdio_ids.h> 15 #include <linux/mmc/sdio_func.h> 16 #include <linux/mmc/card.h> 17 #include <linux/mmc/host.h> 18 19 #include "main.h" 20 21 #define SD8786_DEFAULT_FW_NAME "mrvl/sd8786_uapsta.bin" 22 #define SD8787_DEFAULT_FW_NAME "mrvl/sd8787_uapsta.bin" 23 #define SD8797_DEFAULT_FW_NAME "mrvl/sd8797_uapsta.bin" 24 #define SD8897_DEFAULT_FW_NAME "mrvl/sd8897_uapsta.bin" 25 #define SD8887_DEFAULT_FW_NAME "mrvl/sd8887_uapsta.bin" 26 #define SD8801_DEFAULT_FW_NAME "mrvl/sd8801_uapsta.bin" 27 #define SD8977_DEFAULT_FW_NAME "mrvl/sdsd8977_combo_v2.bin" 28 #define SD8978_SDIOUART_FW_NAME "mrvl/sdiouartiw416_combo_v0.bin" 29 #define SD8987_DEFAULT_FW_NAME "mrvl/sd8987_uapsta.bin" 30 #define SD8997_DEFAULT_FW_NAME "mrvl/sdsd8997_combo_v4.bin" 31 #define SD8997_SDIOUART_FW_NAME "mrvl/sdiouart8997_combo_v4.bin" 32 33 #define BLOCK_MODE 1 34 #define BYTE_MODE 0 35 36 #define MWIFIEX_SDIO_IO_PORT_MASK 0xfffff 37 38 #define MWIFIEX_SDIO_BYTE_MODE_MASK 0x80000000 39 40 #define MWIFIEX_MAX_FUNC2_REG_NUM 13 41 #define MWIFIEX_SDIO_SCRATCH_SIZE 10 42 43 #define SDIO_MPA_ADDR_BASE 0x1000 44 #define CTRL_PORT 0 45 #define CTRL_PORT_MASK 0x0001 46 47 #define CMD_PORT_UPLD_INT_MASK (0x1U<<6) 48 #define CMD_PORT_DNLD_INT_MASK (0x1U<<7) 49 #define HOST_TERM_CMD53 (0x1U << 2) 50 #define REG_PORT 0 51 #define MEM_PORT 0x10000 52 53 #define CMD53_NEW_MODE (0x1U << 0) 54 #define CMD_PORT_RD_LEN_EN (0x1U << 2) 55 #define CMD_PORT_AUTO_EN (0x1U << 0) 56 #define CMD_PORT_SLCT 0x8000 57 #define UP_LD_CMD_PORT_HOST_INT_STATUS (0x40U) 58 #define DN_LD_CMD_PORT_HOST_INT_STATUS (0x80U) 59 60 #define MWIFIEX_MP_AGGR_BUF_SIZE_16K (16384) 61 #define MWIFIEX_MP_AGGR_BUF_SIZE_32K (32768) 62 /* we leave one block of 256 bytes for DMA alignment*/ 63 #define MWIFIEX_MP_AGGR_BUF_SIZE_MAX (65280) 64 65 /* Misc. Config Register : Auto Re-enable interrupts */ 66 #define AUTO_RE_ENABLE_INT BIT(4) 67 68 /* Host Control Registers : Configuration */ 69 #define CONFIGURATION_REG 0x00 70 /* Host Control Registers : Host power up */ 71 #define HOST_POWER_UP (0x1U << 1) 72 73 /* Host Control Registers : Upload host interrupt mask */ 74 #define UP_LD_HOST_INT_MASK (0x1U) 75 /* Host Control Registers : Download host interrupt mask */ 76 #define DN_LD_HOST_INT_MASK (0x2U) 77 78 /* Host Control Registers : Upload host interrupt status */ 79 #define UP_LD_HOST_INT_STATUS (0x1U) 80 /* Host Control Registers : Download host interrupt status */ 81 #define DN_LD_HOST_INT_STATUS (0x2U) 82 83 /* Host Control Registers : Host interrupt status */ 84 #define CARD_INT_STATUS_REG 0x28 85 86 /* Card Control Registers : Card I/O ready */ 87 #define CARD_IO_READY (0x1U << 3) 88 /* Card Control Registers : Download card ready */ 89 #define DN_LD_CARD_RDY (0x1U << 0) 90 91 /* Max retry number of CMD53 write */ 92 #define MAX_WRITE_IOMEM_RETRY 2 93 94 /* SDIO Tx aggregation in progress ? */ 95 #define MP_TX_AGGR_IN_PROGRESS(a) (a->mpa_tx.pkt_cnt > 0) 96 97 /* SDIO Tx aggregation buffer room for next packet ? */ 98 #define MP_TX_AGGR_BUF_HAS_ROOM(a, len) ((a->mpa_tx.buf_len+len) \ 99 <= a->mpa_tx.buf_size) 100 101 /* Copy current packet (SDIO Tx aggregation buffer) to SDIO buffer */ 102 #define MP_TX_AGGR_BUF_PUT(a, payload, pkt_len, port) do { \ 103 memmove(&a->mpa_tx.buf[a->mpa_tx.buf_len], \ 104 payload, pkt_len); \ 105 a->mpa_tx.buf_len += pkt_len; \ 106 if (!a->mpa_tx.pkt_cnt) \ 107 a->mpa_tx.start_port = port; \ 108 if (a->mpa_tx.start_port <= port) \ 109 a->mpa_tx.ports |= (1<<(a->mpa_tx.pkt_cnt)); \ 110 else \ 111 a->mpa_tx.ports |= (1<<(a->mpa_tx.pkt_cnt+1+ \ 112 (a->max_ports - \ 113 a->mp_end_port))); \ 114 a->mpa_tx.pkt_cnt++; \ 115 } while (0) 116 117 /* SDIO Tx aggregation limit ? */ 118 #define MP_TX_AGGR_PKT_LIMIT_REACHED(a) \ 119 (a->mpa_tx.pkt_cnt == a->mpa_tx.pkt_aggr_limit) 120 121 /* Reset SDIO Tx aggregation buffer parameters */ 122 #define MP_TX_AGGR_BUF_RESET(a) do { \ 123 a->mpa_tx.pkt_cnt = 0; \ 124 a->mpa_tx.buf_len = 0; \ 125 a->mpa_tx.ports = 0; \ 126 a->mpa_tx.start_port = 0; \ 127 } while (0) 128 129 /* SDIO Rx aggregation limit ? */ 130 #define MP_RX_AGGR_PKT_LIMIT_REACHED(a) \ 131 (a->mpa_rx.pkt_cnt == a->mpa_rx.pkt_aggr_limit) 132 133 /* SDIO Rx aggregation in progress ? */ 134 #define MP_RX_AGGR_IN_PROGRESS(a) (a->mpa_rx.pkt_cnt > 0) 135 136 /* SDIO Rx aggregation buffer room for next packet ? */ 137 #define MP_RX_AGGR_BUF_HAS_ROOM(a, rx_len) \ 138 ((a->mpa_rx.buf_len+rx_len) <= a->mpa_rx.buf_size) 139 140 /* Reset SDIO Rx aggregation buffer parameters */ 141 #define MP_RX_AGGR_BUF_RESET(a) do { \ 142 a->mpa_rx.pkt_cnt = 0; \ 143 a->mpa_rx.buf_len = 0; \ 144 a->mpa_rx.ports = 0; \ 145 a->mpa_rx.start_port = 0; \ 146 } while (0) 147 148 /* data structure for SDIO MPA TX */ 149 struct mwifiex_sdio_mpa_tx { 150 /* multiport tx aggregation buffer pointer */ 151 u8 *buf; 152 u32 buf_len; 153 u32 pkt_cnt; 154 u32 ports; 155 u16 start_port; 156 u8 enabled; 157 u32 buf_size; 158 u32 pkt_aggr_limit; 159 }; 160 161 struct mwifiex_sdio_mpa_rx { 162 u8 *buf; 163 u32 buf_len; 164 u32 pkt_cnt; 165 u32 ports; 166 u16 start_port; 167 168 struct sk_buff **skb_arr; 169 u32 *len_arr; 170 171 u8 enabled; 172 u32 buf_size; 173 u32 pkt_aggr_limit; 174 }; 175 176 int mwifiex_bus_register(void); 177 void mwifiex_bus_unregister(void); 178 179 struct mwifiex_sdio_card_reg { 180 u8 start_rd_port; 181 u8 start_wr_port; 182 u8 base_0_reg; 183 u8 base_1_reg; 184 u8 poll_reg; 185 u8 host_int_enable; 186 u8 host_int_rsr_reg; 187 u8 host_int_status_reg; 188 u8 host_int_mask_reg; 189 u8 host_strap_reg; 190 u8 host_strap_mask; 191 u8 host_strap_value; 192 u8 status_reg_0; 193 u8 status_reg_1; 194 u8 sdio_int_mask; 195 u32 data_port_mask; 196 u8 io_port_0_reg; 197 u8 io_port_1_reg; 198 u8 io_port_2_reg; 199 u8 max_mp_regs; 200 u8 rd_bitmap_l; 201 u8 rd_bitmap_u; 202 u8 rd_bitmap_1l; 203 u8 rd_bitmap_1u; 204 u8 wr_bitmap_l; 205 u8 wr_bitmap_u; 206 u8 wr_bitmap_1l; 207 u8 wr_bitmap_1u; 208 u8 rd_len_p0_l; 209 u8 rd_len_p0_u; 210 u8 card_misc_cfg_reg; 211 u8 card_cfg_2_1_reg; 212 u8 cmd_rd_len_0; 213 u8 cmd_rd_len_1; 214 u8 cmd_rd_len_2; 215 u8 cmd_rd_len_3; 216 u8 cmd_cfg_0; 217 u8 cmd_cfg_1; 218 u8 cmd_cfg_2; 219 u8 cmd_cfg_3; 220 u8 fw_dump_host_ready; 221 u8 fw_dump_ctrl; 222 u8 fw_dump_start; 223 u8 fw_dump_end; 224 u8 func1_dump_reg_start; 225 u8 func1_dump_reg_end; 226 u8 func1_scratch_reg; 227 u8 func1_spec_reg_num; 228 u8 func1_spec_reg_table[MWIFIEX_MAX_FUNC2_REG_NUM]; 229 }; 230 231 struct sdio_mmc_card { 232 struct sdio_func *func; 233 struct mwifiex_adapter *adapter; 234 235 struct completion fw_done; 236 const char *firmware; 237 const char *firmware_sdiouart; 238 const struct mwifiex_sdio_card_reg *reg; 239 u8 max_ports; 240 u8 mp_agg_pkt_limit; 241 u16 tx_buf_size; 242 u32 mp_tx_agg_buf_size; 243 u32 mp_rx_agg_buf_size; 244 245 u32 mp_rd_bitmap; 246 u32 mp_wr_bitmap; 247 248 u16 mp_end_port; 249 u32 mp_data_port_mask; 250 251 u8 curr_rd_port; 252 u8 curr_wr_port; 253 254 u8 *mp_regs; 255 bool supports_sdio_new_mode; 256 bool has_control_mask; 257 bool can_dump_fw; 258 bool fw_dump_enh; 259 bool can_auto_tdls; 260 bool can_ext_scan; 261 262 struct mwifiex_sdio_mpa_tx mpa_tx; 263 struct mwifiex_sdio_mpa_rx mpa_rx; 264 265 struct work_struct work; 266 unsigned long work_flags; 267 }; 268 269 struct mwifiex_sdio_device { 270 const char *firmware; 271 const char *firmware_sdiouart; 272 const struct mwifiex_sdio_card_reg *reg; 273 u8 max_ports; 274 u8 mp_agg_pkt_limit; 275 u16 tx_buf_size; 276 u32 mp_tx_agg_buf_size; 277 u32 mp_rx_agg_buf_size; 278 bool supports_sdio_new_mode; 279 bool has_control_mask; 280 bool can_dump_fw; 281 bool fw_dump_enh; 282 bool can_auto_tdls; 283 bool can_ext_scan; 284 }; 285 286 /* 287 * .cmdrsp_complete handler 288 */ 289 static inline int mwifiex_sdio_cmdrsp_complete(struct mwifiex_adapter *adapter, 290 struct sk_buff *skb) 291 { 292 dev_kfree_skb_any(skb); 293 return 0; 294 } 295 296 /* 297 * .event_complete handler 298 */ 299 static inline int mwifiex_sdio_event_complete(struct mwifiex_adapter *adapter, 300 struct sk_buff *skb) 301 { 302 dev_kfree_skb_any(skb); 303 return 0; 304 } 305 306 static inline bool 307 mp_rx_aggr_port_limit_reached(struct sdio_mmc_card *card) 308 { 309 u8 tmp; 310 311 if (card->curr_rd_port < card->mpa_rx.start_port) { 312 if (card->supports_sdio_new_mode) 313 tmp = card->mp_end_port >> 1; 314 else 315 tmp = card->mp_agg_pkt_limit; 316 317 if (((card->max_ports - card->mpa_rx.start_port) + 318 card->curr_rd_port) >= tmp) 319 return true; 320 } 321 322 if (!card->supports_sdio_new_mode) 323 return false; 324 325 if ((card->curr_rd_port - card->mpa_rx.start_port) >= 326 (card->mp_end_port >> 1)) 327 return true; 328 329 return false; 330 } 331 332 static inline bool 333 mp_tx_aggr_port_limit_reached(struct sdio_mmc_card *card) 334 { 335 u16 tmp; 336 337 if (card->curr_wr_port < card->mpa_tx.start_port) { 338 if (card->supports_sdio_new_mode) 339 tmp = card->mp_end_port >> 1; 340 else 341 tmp = card->mp_agg_pkt_limit; 342 343 if (((card->max_ports - card->mpa_tx.start_port) + 344 card->curr_wr_port) >= tmp) 345 return true; 346 } 347 348 if (!card->supports_sdio_new_mode) 349 return false; 350 351 if ((card->curr_wr_port - card->mpa_tx.start_port) >= 352 (card->mp_end_port >> 1)) 353 return true; 354 355 return false; 356 } 357 358 /* Prepare to copy current packet from card to SDIO Rx aggregation buffer */ 359 static inline void mp_rx_aggr_setup(struct sdio_mmc_card *card, 360 u16 rx_len, u8 port) 361 { 362 card->mpa_rx.buf_len += rx_len; 363 364 if (!card->mpa_rx.pkt_cnt) 365 card->mpa_rx.start_port = port; 366 367 if (card->supports_sdio_new_mode) { 368 card->mpa_rx.ports |= (1 << port); 369 } else { 370 if (card->mpa_rx.start_port <= port) 371 card->mpa_rx.ports |= 1 << (card->mpa_rx.pkt_cnt); 372 else 373 card->mpa_rx.ports |= 1 << (card->mpa_rx.pkt_cnt + 1); 374 } 375 card->mpa_rx.skb_arr[card->mpa_rx.pkt_cnt] = NULL; 376 card->mpa_rx.len_arr[card->mpa_rx.pkt_cnt] = rx_len; 377 card->mpa_rx.pkt_cnt++; 378 } 379 #endif /* _MWIFIEX_SDIO_H */ 380