1 /** 2 * Copyright (c) 2014 Redpine Signals Inc. 3 * 4 * Permission to use, copy, modify, and/or distribute this software for any 5 * purpose with or without fee is hereby granted, provided that the above 6 * copyright notice and this permission notice appear in all copies. 7 * 8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 15 */ 16 17 #ifndef __RSI_MAIN_H__ 18 #define __RSI_MAIN_H__ 19 20 #include <linux/string.h> 21 #include <linux/skbuff.h> 22 #include <net/mac80211.h> 23 24 struct rsi_sta { 25 struct ieee80211_sta *sta; 26 s16 sta_id; 27 u16 seq_start[IEEE80211_NUM_TIDS]; 28 bool start_tx_aggr[IEEE80211_NUM_TIDS]; 29 }; 30 31 struct rsi_hw; 32 33 #include "rsi_ps.h" 34 35 #define ERR_ZONE BIT(0) /* For Error Msgs */ 36 #define INFO_ZONE BIT(1) /* For General Status Msgs */ 37 #define INIT_ZONE BIT(2) /* For Driver Init Seq Msgs */ 38 #define MGMT_TX_ZONE BIT(3) /* For TX Mgmt Path Msgs */ 39 #define MGMT_RX_ZONE BIT(4) /* For RX Mgmt Path Msgs */ 40 #define DATA_TX_ZONE BIT(5) /* For TX Data Path Msgs */ 41 #define DATA_RX_ZONE BIT(6) /* For RX Data Path Msgs */ 42 #define FSM_ZONE BIT(7) /* For State Machine Msgs */ 43 #define ISR_ZONE BIT(8) /* For Interrupt Msgs */ 44 45 enum RSI_FSM_STATES { 46 FSM_FW_NOT_LOADED, 47 FSM_CARD_NOT_READY, 48 FSM_COMMON_DEV_PARAMS_SENT, 49 FSM_BOOT_PARAMS_SENT, 50 FSM_EEPROM_READ_MAC_ADDR, 51 FSM_EEPROM_READ_RF_TYPE, 52 FSM_RESET_MAC_SENT, 53 FSM_RADIO_CAPS_SENT, 54 FSM_BB_RF_PROG_SENT, 55 FSM_MAC_INIT_DONE, 56 57 NUM_FSM_STATES 58 }; 59 60 extern u32 rsi_zone_enabled; 61 extern __printf(2, 3) void rsi_dbg(u32 zone, const char *fmt, ...); 62 63 #define RSI_MAX_VIFS 3 64 #define NUM_EDCA_QUEUES 4 65 #define IEEE80211_ADDR_LEN 6 66 #define FRAME_DESC_SZ 16 67 #define MIN_802_11_HDR_LEN 24 68 #define RSI_DEF_KEEPALIVE 90 69 70 #define DATA_QUEUE_WATER_MARK 400 71 #define MIN_DATA_QUEUE_WATER_MARK 300 72 #define MULTICAST_WATER_MARK 200 73 #define MAC_80211_HDR_FRAME_CONTROL 0 74 #define WME_NUM_AC 4 75 #define NUM_SOFT_QUEUES 6 76 #define MAX_HW_QUEUES 12 77 #define INVALID_QUEUE 0xff 78 #define MAX_CONTINUOUS_VO_PKTS 8 79 #define MAX_CONTINUOUS_VI_PKTS 4 80 81 /* Hardware queue info */ 82 #define BROADCAST_HW_Q 9 83 #define MGMT_HW_Q 10 84 #define BEACON_HW_Q 11 85 86 /* Queue information */ 87 #define RSI_COEX_Q 0x0 88 #define RSI_WIFI_MGMT_Q 0x4 89 #define RSI_WIFI_DATA_Q 0x5 90 #define IEEE80211_MGMT_FRAME 0x00 91 #define IEEE80211_CTL_FRAME 0x04 92 93 #define RSI_MAX_ASSOC_STAS 32 94 #define IEEE80211_QOS_TID 0x0f 95 #define IEEE80211_NONQOS_TID 16 96 97 #define MAX_DEBUGFS_ENTRIES 4 98 99 #define TID_TO_WME_AC(_tid) ( \ 100 ((_tid) == 0 || (_tid) == 3) ? BE_Q : \ 101 ((_tid) < 3) ? BK_Q : \ 102 ((_tid) < 6) ? VI_Q : \ 103 VO_Q) 104 105 #define WME_AC(_q) ( \ 106 ((_q) == BK_Q) ? IEEE80211_AC_BK : \ 107 ((_q) == BE_Q) ? IEEE80211_AC_BE : \ 108 ((_q) == VI_Q) ? IEEE80211_AC_VI : \ 109 IEEE80211_AC_VO) 110 111 #define RSI_DEV_9113 1 112 113 struct version_info { 114 u16 major; 115 u16 minor; 116 u8 release_num; 117 u8 patch_num; 118 union { 119 struct { 120 u8 fw_ver[8]; 121 } info; 122 } ver; 123 } __packed; 124 125 struct skb_info { 126 s8 rssi; 127 u32 flags; 128 u16 channel; 129 s8 tid; 130 s8 sta_id; 131 u8 internal_hdr_size; 132 struct ieee80211_vif *vif; 133 u8 vap_id; 134 }; 135 136 enum edca_queue { 137 BK_Q, 138 BE_Q, 139 VI_Q, 140 VO_Q, 141 MGMT_SOFT_Q, 142 MGMT_BEACON_Q 143 }; 144 145 struct security_info { 146 bool security_enable; 147 u32 ptk_cipher; 148 u32 gtk_cipher; 149 }; 150 151 struct wmm_qinfo { 152 s32 weight; 153 s32 wme_params; 154 s32 pkt_contended; 155 s32 txop; 156 }; 157 158 struct transmit_q_stats { 159 u32 total_tx_pkt_send[NUM_EDCA_QUEUES + 2]; 160 u32 total_tx_pkt_freed[NUM_EDCA_QUEUES + 2]; 161 }; 162 163 struct vif_priv { 164 bool is_ht; 165 bool sgi; 166 u16 seq_start; 167 int vap_id; 168 }; 169 170 struct rsi_event { 171 atomic_t event_condition; 172 wait_queue_head_t event_queue; 173 }; 174 175 struct rsi_thread { 176 void (*thread_function)(void *); 177 struct completion completion; 178 struct task_struct *task; 179 struct rsi_event event; 180 atomic_t thread_done; 181 }; 182 183 struct cqm_info { 184 s8 last_cqm_event_rssi; 185 int rssi_thold; 186 u32 rssi_hyst; 187 }; 188 189 struct xtended_desc { 190 u8 confirm_frame_type; 191 u8 retry_cnt; 192 u16 reserved; 193 }; 194 195 enum rsi_dfs_regions { 196 RSI_REGION_FCC = 0, 197 RSI_REGION_ETSI, 198 RSI_REGION_TELEC, 199 RSI_REGION_WORLD 200 }; 201 202 struct rsi_common { 203 struct rsi_hw *priv; 204 struct vif_priv vif_info[RSI_MAX_VIFS]; 205 206 bool mgmt_q_block; 207 struct version_info lmac_ver; 208 209 struct rsi_thread tx_thread; 210 struct sk_buff_head tx_queue[NUM_EDCA_QUEUES + 2]; 211 /* Mutex declaration */ 212 struct mutex mutex; 213 /* Mutex used for tx thread */ 214 struct mutex tx_lock; 215 /* Mutex used for rx thread */ 216 struct mutex rx_lock; 217 u8 endpoint; 218 219 /* Channel/band related */ 220 u8 band; 221 u8 num_supp_bands; 222 u8 channel_width; 223 224 u16 rts_threshold; 225 u16 bitrate_mask[2]; 226 u32 fixedrate_mask[2]; 227 228 u8 rf_reset; 229 struct transmit_q_stats tx_stats; 230 struct security_info secinfo; 231 struct wmm_qinfo tx_qinfo[NUM_EDCA_QUEUES]; 232 struct ieee80211_tx_queue_params edca_params[NUM_EDCA_QUEUES]; 233 u8 mac_addr[IEEE80211_ADDR_LEN]; 234 235 /* state related */ 236 u32 fsm_state; 237 bool init_done; 238 u8 bb_rf_prog_count; 239 bool iface_down; 240 241 /* Generic */ 242 u8 channel; 243 u8 *rx_data_pkt; 244 u8 mac_id; 245 u8 radio_id; 246 u16 rate_pwr[20]; 247 u16 min_rate; 248 249 /* WMM algo related */ 250 u8 selected_qnum; 251 u32 pkt_cnt; 252 u8 min_weight; 253 254 /* bgscan related */ 255 struct cqm_info cqm_info; 256 257 bool hw_data_qs_blocked; 258 u8 driver_mode; 259 u8 coex_mode; 260 u16 oper_mode; 261 u8 lp_ps_handshake_mode; 262 u8 ulp_ps_handshake_mode; 263 u8 uapsd_bitmap; 264 u8 rf_power_val; 265 u8 wlan_rf_power_mode; 266 u8 obm_ant_sel_val; 267 int tx_power; 268 u8 ant_in_use; 269 270 u16 beacon_interval; 271 u8 dtim_cnt; 272 273 /* AP mode parameters */ 274 u8 beacon_enabled; 275 u16 beacon_cnt; 276 struct rsi_sta stations[RSI_MAX_ASSOC_STAS + 1]; 277 int num_stations; 278 int max_stations; 279 struct ieee80211_key_conf *key; 280 281 /* Wi-Fi direct mode related */ 282 bool p2p_enabled; 283 struct timer_list roc_timer; 284 struct ieee80211_vif *roc_vif; 285 }; 286 287 enum host_intf { 288 RSI_HOST_INTF_SDIO = 0, 289 RSI_HOST_INTF_USB 290 }; 291 292 struct eepromrw_info { 293 u32 offset; 294 u32 length; 295 u8 write; 296 u16 eeprom_erase; 297 u8 data[480]; 298 }; 299 300 struct eeprom_read { 301 u16 length; 302 u16 off_set; 303 }; 304 305 struct rsi_hw { 306 struct rsi_common *priv; 307 u8 device_model; 308 struct ieee80211_hw *hw; 309 struct ieee80211_vif *vifs[RSI_MAX_VIFS]; 310 struct ieee80211_tx_queue_params edca_params[NUM_EDCA_QUEUES]; 311 struct ieee80211_supported_band sbands[NUM_NL80211_BANDS]; 312 313 struct device *device; 314 u8 sc_nvifs; 315 316 enum host_intf rsi_host_intf; 317 u16 block_size; 318 enum ps_state ps_state; 319 struct rsi_ps_info ps_info; 320 spinlock_t ps_lock; /*To protect power save config*/ 321 u32 usb_buffer_status_reg; 322 #ifdef CONFIG_RSI_DEBUGFS 323 struct rsi_debugfs *dfsentry; 324 u8 num_debugfs_entries; 325 #endif 326 char *fw_file_name; 327 struct timer_list bl_cmd_timer; 328 bool blcmd_timer_expired; 329 u32 flash_capacity; 330 struct eepromrw_info eeprom; 331 u32 interrupt_status; 332 u8 dfs_region; 333 char country[2]; 334 void *rsi_dev; 335 struct rsi_host_intf_ops *host_intf_ops; 336 int (*check_hw_queue_status)(struct rsi_hw *adapter, u8 q_num); 337 int (*rx_urb_submit)(struct rsi_hw *adapter); 338 int (*determine_event_timeout)(struct rsi_hw *adapter); 339 }; 340 341 void rsi_print_version(struct rsi_common *common); 342 343 struct rsi_host_intf_ops { 344 int (*read_pkt)(struct rsi_hw *adapter, u8 *pkt, u32 len); 345 int (*write_pkt)(struct rsi_hw *adapter, u8 *pkt, u32 len); 346 int (*master_access_msword)(struct rsi_hw *adapter, u16 ms_word); 347 int (*read_reg_multiple)(struct rsi_hw *adapter, u32 addr, 348 u8 *data, u16 count); 349 int (*write_reg_multiple)(struct rsi_hw *adapter, u32 addr, 350 u8 *data, u16 count); 351 int (*master_reg_read)(struct rsi_hw *adapter, u32 addr, 352 u32 *read_buf, u16 size); 353 int (*master_reg_write)(struct rsi_hw *adapter, 354 unsigned long addr, unsigned long data, 355 u16 size); 356 int (*load_data_master_write)(struct rsi_hw *adapter, u32 addr, 357 u32 instructions_size, u16 block_size, 358 u8 *fw); 359 }; 360 #endif 361