drivers/net/wireless/rsi/rsi_main.h

   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 #include <net/rsi_91x.h>
  24
  25 struct rsi_sta {
  26         struct ieee80211_sta *sta;
  27         s16 sta_id;
  28         u16 seq_start[IEEE80211_NUM_TIDS];
  29         bool start_tx_aggr[IEEE80211_NUM_TIDS];
  30 };
  31
  32 struct rsi_hw;
  33
  34 #include "rsi_ps.h"
  35
  36 #define ERR_ZONE                        BIT(0)  /* For Error Msgs             */
  37 #define INFO_ZONE                       BIT(1)  /* For General Status Msgs    */
  38 #define INIT_ZONE                       BIT(2)  /* For Driver Init Seq Msgs   */
  39 #define MGMT_TX_ZONE                    BIT(3)  /* For TX Mgmt Path Msgs      */
  40 #define MGMT_RX_ZONE                    BIT(4)  /* For RX Mgmt Path Msgs      */
  41 #define DATA_TX_ZONE                    BIT(5)  /* For TX Data Path Msgs      */
  42 #define DATA_RX_ZONE                    BIT(6)  /* For RX Data Path Msgs      */
  43 #define FSM_ZONE                        BIT(7)  /* For State Machine Msgs     */
  44 #define ISR_ZONE                        BIT(8)  /* For Interrupt Msgs         */
  45
  46 enum RSI_FSM_STATES {
  47         FSM_FW_NOT_LOADED,
  48         FSM_CARD_NOT_READY,
  49         FSM_COMMON_DEV_PARAMS_SENT,
  50         FSM_BOOT_PARAMS_SENT,
  51         FSM_EEPROM_READ_MAC_ADDR,
  52         FSM_EEPROM_READ_RF_TYPE,
  53         FSM_RESET_MAC_SENT,
  54         FSM_RADIO_CAPS_SENT,
  55         FSM_BB_RF_PROG_SENT,
  56         FSM_MAC_INIT_DONE,
  57
  58         NUM_FSM_STATES
  59 };
  60
  61 extern u32 rsi_zone_enabled;
  62 extern __printf(2, 3) void rsi_dbg(u32 zone, const char *fmt, ...);
  63
  64 #define RSI_MAX_BANDS                   2
  65 #define RSI_MAX_VIFS                    3
  66 #define NUM_EDCA_QUEUES                 4
  67 #define IEEE80211_ADDR_LEN              6
  68 #define FRAME_DESC_SZ                   16
  69 #define MIN_802_11_HDR_LEN              24
  70 #define RSI_DEF_KEEPALIVE               90
  71 #define RSI_WOW_KEEPALIVE                5
  72 #define RSI_BCN_MISS_THRESHOLD           24
  73
  74 #define DATA_QUEUE_WATER_MARK           400
  75 #define MIN_DATA_QUEUE_WATER_MARK       300
  76 #define MULTICAST_WATER_MARK            200
  77 #define MAC_80211_HDR_FRAME_CONTROL     0
  78 #define WME_NUM_AC                      4
  79 #define NUM_SOFT_QUEUES                 6
  80 #define MAX_HW_QUEUES                   12
  81 #define INVALID_QUEUE                   0xff
  82 #define MAX_CONTINUOUS_VO_PKTS          8
  83 #define MAX_CONTINUOUS_VI_PKTS          4
  84
  85 /* Hardware queue info */
  86 #define BROADCAST_HW_Q                  9
  87 #define MGMT_HW_Q                       10
  88 #define BEACON_HW_Q                     11
  89
  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 /* WoWLAN flags */
 112 #define RSI_WOW_ENABLED                 BIT(0)
 113 #define RSI_WOW_NO_CONNECTION           BIT(1)
 114
 115 #define RSI_DEV_9113            1
 116 #define RSI_MAX_RX_PKTS         64
 117
 118 struct version_info {
 119         u16 major;
 120         u16 minor;
 121         u8 release_num;
 122         u8 patch_num;
 123         union {
 124                 struct {
 125                         u8 fw_ver[8];
 126                 } info;
 127         } ver;
 128 } __packed;
 129
 130 struct skb_info {
 131         s8 rssi;
 132         u32 flags;
 133         u16 channel;
 134         s8 tid;
 135         s8 sta_id;
 136         u8 internal_hdr_size;
 137         struct ieee80211_vif *vif;
 138         u8 vap_id;
 139         bool have_key;
 140 };
 141
 142 enum edca_queue {
 143         BK_Q,
 144         BE_Q,
 145         VI_Q,
 146         VO_Q,
 147         MGMT_SOFT_Q,
 148         MGMT_BEACON_Q
 149 };
 150
 151 struct security_info {
 152         u32 ptk_cipher;
 153         u32 gtk_cipher;
 154 };
 155
 156 struct wmm_qinfo {
 157         s32 weight;
 158         s32 wme_params;
 159         s32 pkt_contended;
 160         s32 txop;
 161 };
 162
 163 struct transmit_q_stats {
 164         u32 total_tx_pkt_send[NUM_EDCA_QUEUES + 2];
 165         u32 total_tx_pkt_freed[NUM_EDCA_QUEUES + 2];
 166 };
 167
 168 struct vif_priv {
 169         bool is_ht;
 170         bool sgi;
 171         u16 seq_start;
 172         int vap_id;
 173 };
 174
 175 struct rsi_event {
 176         atomic_t event_condition;
 177         wait_queue_head_t event_queue;
 178 };
 179
 180 struct rsi_thread {
 181         void (*thread_function)(void *);
 182         struct completion completion;
 183         struct task_struct *task;
 184         struct rsi_event event;
 185         atomic_t thread_done;
 186 };
 187
 188 struct cqm_info {
 189         s8 last_cqm_event_rssi;
 190         int rssi_thold;
 191         u32 rssi_hyst;
 192 };
 193
 194 enum rsi_dfs_regions {
 195         RSI_REGION_FCC = 0,
 196         RSI_REGION_ETSI,
 197         RSI_REGION_TELEC,
 198         RSI_REGION_WORLD
 199 };
 200
 201 struct rsi_rate_config {
 202         u32 configured_mask;    /* configured by mac80211 bits 0-11=legacy 12+ mcs */
 203         u16 fixed_hw_rate;
 204         bool fixed_enabled;
 205 };
 206
 207 struct rsi_common {
 208         struct rsi_hw *priv;
 209         struct vif_priv vif_info[RSI_MAX_VIFS];
 210
 211         void *coex_cb;
 212         bool mgmt_q_block;
 213         struct version_info lmac_ver;
 214
 215         struct rsi_thread tx_thread;
 216         struct sk_buff_head tx_queue[NUM_EDCA_QUEUES + 2];
 217         struct completion wlan_init_completion;
 218         /* Mutex declaration */
 219         struct mutex mutex;
 220         /* Mutex used for tx thread */
 221         struct mutex tx_lock;
 222         /* Mutex used for rx thread */
 223         struct mutex rx_lock;
 224         u8 endpoint;
 225
 226         /* Channel/band related */
 227         u8 band;
 228         u8 num_supp_bands;
 229         u8 channel_width;
 230
 231         u16 rts_threshold;
 232         u32 bitrate_mask[RSI_MAX_BANDS];
 233         struct rsi_rate_config rate_config[RSI_MAX_BANDS];
 234
 235         u8 rf_reset;
 236         struct transmit_q_stats tx_stats;
 237         struct security_info secinfo;
 238         struct wmm_qinfo tx_qinfo[NUM_EDCA_QUEUES];
 239         struct ieee80211_tx_queue_params edca_params[NUM_EDCA_QUEUES];
 240         u8 mac_addr[IEEE80211_ADDR_LEN];
 241
 242         /* state related */
 243         u32 fsm_state;
 244         bool init_done;
 245         u8 bb_rf_prog_count;
 246         bool iface_down;
 247
 248         /* Generic */
 249         u8 channel;
 250         u8 *rx_data_pkt;
 251         u8 mac_id;
 252         u8 radio_id;
 253         u16 rate_pwr[20];
 254
 255         /* WMM algo related */
 256         u8 selected_qnum;
 257         u32 pkt_cnt;
 258         u8 min_weight;
 259
 260         /* bgscan related */
 261         struct cqm_info cqm_info;
 262
 263         bool hw_data_qs_blocked;
 264         u8 driver_mode;
 265         u8 coex_mode;
 266         u16 oper_mode;
 267         u8 lp_ps_handshake_mode;
 268         u8 ulp_ps_handshake_mode;
 269         u8 uapsd_bitmap;
 270         u8 rf_power_val;
 271         u8 wlan_rf_power_mode;
 272         u8 obm_ant_sel_val;
 273         int tx_power;
 274         u8 ant_in_use;
 275         /* Mutex used for writing packet to bus */
 276         struct mutex tx_bus_mutex;
 277         bool hibernate_resume;
 278         bool reinit_hw;
 279         u8 wow_flags;
 280         u16 beacon_interval;
 281         u8 dtim_cnt;
 282
 283         /* AP mode parameters */
 284         u8 beacon_enabled;
 285         u16 beacon_cnt;
 286         struct rsi_sta stations[RSI_MAX_ASSOC_STAS + 1];
 287         int num_stations;
 288         int max_stations;
 289         struct ieee80211_key_conf *key;
 290
 291         /* Wi-Fi direct mode related */
 292         bool p2p_enabled;
 293         struct timer_list roc_timer;
 294         struct ieee80211_vif *roc_vif;
 295
 296         bool eapol4_confirm;
 297         bool bt_defer_attach;
 298         void *bt_adapter;
 299 };
 300
 301 struct eepromrw_info {
 302         u32 offset;
 303         u32 length;
 304         u8  write;
 305         u16 eeprom_erase;
 306         u8 data[480];
 307 };
 308
 309 struct eeprom_read {
 310         u16 length;
 311         u16 off_set;
 312 };
 313
 314 struct rsi_hw {
 315         struct rsi_common *priv;
 316         u8 device_model;
 317         struct ieee80211_hw *hw;
 318         struct ieee80211_vif *vifs[RSI_MAX_VIFS];
 319         struct ieee80211_tx_queue_params edca_params[NUM_EDCA_QUEUES];
 320         struct ieee80211_supported_band sbands[NUM_NL80211_BANDS];
 321
 322         struct device *device;
 323         u8 sc_nvifs;
 324
 325         enum rsi_host_intf rsi_host_intf;
 326         u16 block_size;
 327         enum ps_state ps_state;
 328         struct rsi_ps_info ps_info;
 329         spinlock_t ps_lock; /*To protect power save config*/
 330         u32 usb_buffer_status_reg;
 331 #ifdef CONFIG_RSI_DEBUGFS
 332         struct rsi_debugfs *dfsentry;
 333         u8 num_debugfs_entries;
 334 #endif
 335         char *fw_file_name;
 336         struct timer_list bl_cmd_timer;
 337         bool blcmd_timer_expired;
 338         u32 flash_capacity;
 339         struct eepromrw_info eeprom;
 340         u32 interrupt_status;
 341         u8 dfs_region;
 342         char country[2];
 343         void *rsi_dev;
 344         struct rsi_host_intf_ops *host_intf_ops;
 345         int (*check_hw_queue_status)(struct rsi_hw *adapter, u8 q_num);
 346         int (*determine_event_timeout)(struct rsi_hw *adapter);
 347 };
 348
 349 void rsi_print_version(struct rsi_common *common);
 350
 351 struct rsi_host_intf_ops {
 352         int (*read_pkt)(struct rsi_hw *adapter, u8 *pkt, u32 len);
 353         int (*write_pkt)(struct rsi_hw *adapter, u8 *pkt, u32 len);
 354         int (*master_access_msword)(struct rsi_hw *adapter, u16 ms_word);
 355         int (*read_reg_multiple)(struct rsi_hw *adapter, u32 addr,
 356                                  u8 *data, u16 count);
 357         int (*write_reg_multiple)(struct rsi_hw *adapter, u32 addr,
 358                                   u8 *data, u16 count);
 359         int (*master_reg_read)(struct rsi_hw *adapter, u32 addr,
 360                                u32 *read_buf, u16 size);
 361         int (*master_reg_write)(struct rsi_hw *adapter,
 362                                 unsigned long addr, unsigned long data,
 363                                 u16 size);
 364         int (*load_data_master_write)(struct rsi_hw *adapter, u32 addr,
 365                                       u32 instructions_size, u16 block_size,
 366                                       u8 *fw);
 367         int (*reinit_device)(struct rsi_hw *adapter);
 368 };
 369
 370 enum rsi_host_intf rsi_get_host_intf(void *priv);
 371 void rsi_set_bt_context(void *priv, void *bt_context);
 372 void rsi_attach_bt(struct rsi_common *common);
 373
 374 #endif