package/libertas/src/dev.h

   1 /**
   2   * This file contains definitions and data structures specific
   3   * to Marvell 802.11 NIC. It contains the Device Information
   4   * structure struct lbs_private..
   5   */
   6 #ifndef _LBS_DEV_H_
   7 #define _LBS_DEV_H_
   8
   9 #include <linux/netdevice.h>
  10 #include <linux/wireless.h>
  11 #include <linux/ethtool.h>
  12 #include <linux/debugfs.h>
  13 #include <net/ieee80211.h>
  14
  15 #include "defs.h"
  16 #include "hostcmd.h"
  17
  18 extern struct ethtool_ops lbs_ethtool_ops;
  19
  20 #define MAX_BSSID_PER_CHANNEL           16
  21
  22 #define NR_TX_QUEUE                     3
  23
  24 /* For the extended Scan */
  25 #define MAX_EXTENDED_SCAN_BSSID_LIST    MAX_BSSID_PER_CHANNEL * \
  26                                                 MRVDRV_MAX_CHANNEL_SIZE + 1
  27
  28 #define MAX_REGION_CHANNEL_NUM  2
  29
  30 /** Chan-freq-TxPower mapping table*/
  31 struct chan_freq_power {
  32         /** channel Number              */
  33         u16 channel;
  34         /** frequency of this channel   */
  35         u32 freq;
  36         /** Max allowed Tx power level  */
  37         u16 maxtxpower;
  38         /** TRUE:channel unsupported;  FLASE:supported*/
  39         u8 unsupported;
  40 };
  41
  42 /** region-band mapping table*/
  43 struct region_channel {
  44         /** TRUE if this entry is valid              */
  45         u8 valid;
  46         /** region code for US, Japan ...            */
  47         u8 region;
  48         /** band B/G/A, used for BAND_CONFIG cmd             */
  49         u8 band;
  50         /** Actual No. of elements in the array below */
  51         u8 nrcfp;
  52         /** chan-freq-txpower mapping table*/
  53         struct chan_freq_power *CFP;
  54 };
  55
  56 struct lbs_802_11_security {
  57         u8 WPAenabled;
  58         u8 WPA2enabled;
  59         u8 wep_enabled;
  60         u8 auth_mode;
  61 };
  62
  63 /** Current Basic Service Set State Structure */
  64 struct current_bss_params {
  65         /** bssid */
  66         u8 bssid[ETH_ALEN];
  67         /** ssid */
  68         u8 ssid[IW_ESSID_MAX_SIZE + 1];
  69         u8 ssid_len;
  70
  71         /** band */
  72         u8 band;
  73         /** channel */
  74         u8 channel;
  75         /** zero-terminated array of supported data rates */
  76         u8 rates[MAX_RATES + 1];
  77 };
  78
  79 /** sleep_params */
  80 struct sleep_params {
  81         uint16_t sp_error;
  82         uint16_t sp_offset;
  83         uint16_t sp_stabletime;
  84         uint8_t  sp_calcontrol;
  85         uint8_t  sp_extsleepclk;
  86         uint16_t sp_reserved;
  87 };
  88
  89 /* Mesh statistics */
  90 struct lbs_mesh_stats {
  91         u32     fwd_bcast_cnt;          /* Fwd: Broadcast counter */
  92         u32     fwd_unicast_cnt;        /* Fwd: Unicast counter */
  93         u32     fwd_drop_ttl;           /* Fwd: TTL zero */
  94         u32     fwd_drop_rbt;           /* Fwd: Recently Broadcasted */
  95         u32     fwd_drop_noroute;       /* Fwd: No route to Destination */
  96         u32     fwd_drop_nobuf;         /* Fwd: Run out of internal buffers */
  97         u32     drop_blind;             /* Rx:  Dropped by blinding table */
  98         u32     tx_failed_cnt;          /* Tx:  Failed transmissions */
  99 };
 100
 101 /** Private structure for the MV device */
 102 struct lbs_private {
 103         int mesh_open;
 104         int infra_open;
 105         int mesh_autostart_enabled;
 106
 107         char name[DEV_NAME_LEN];
 108
 109         void *card;
 110         struct net_device *dev;
 111
 112         struct net_device_stats stats;
 113         struct net_device *mesh_dev; /* Virtual device */
 114         struct net_device *rtap_net_dev;
 115
 116         struct iw_statistics wstats;
 117         struct lbs_mesh_stats mstats;
 118         struct dentry *debugfs_dir;
 119         struct dentry *debugfs_debug;
 120         struct dentry *debugfs_files[6];
 121
 122         struct dentry *events_dir;
 123         struct dentry *debugfs_events_files[6];
 124
 125         struct dentry *regs_dir;
 126         struct dentry *debugfs_regs_files[6];
 127
 128         u32 mac_offset;
 129         u32 bbp_offset;
 130         u32 rf_offset;
 131
 132         /* Download sent:
 133            bit0 1/0=data_sent/data_tx_done,
 134            bit1 1/0=cmd_sent/cmd_tx_done,
 135            all other bits reserved 0 */
 136         u8 dnld_sent;
 137
 138         /** thread to service interrupts */
 139         struct task_struct *main_thread;
 140         wait_queue_head_t waitq;
 141         struct workqueue_struct *work_thread;
 142
 143         /** Scanning */
 144         struct delayed_work scan_work;
 145         struct delayed_work assoc_work;
 146         struct work_struct sync_channel;
 147         /* remember which channel was scanned last, != 0 if currently scanning */
 148         int scan_channel;
 149         u8 scan_ssid[IW_ESSID_MAX_SIZE + 1];
 150         u8 scan_ssid_len;
 151
 152         /** Hardware access */
 153         int (*hw_host_to_card) (struct lbs_private *priv, u8 type, u8 *payload, u16 nb);
 154
 155         /* Wake On LAN */
 156         uint32_t wol_criteria;
 157         uint8_t wol_gpio;
 158         uint8_t wol_gap;
 159
 160         /** Wlan adapter data structure*/
 161         /** STATUS variables */
 162         u32 fwrelease;
 163         u32 fwcapinfo;
 164
 165         struct mutex lock;
 166
 167         /* TX packet ready to be sent... */
 168         int tx_pending_len;             /* -1 while building packet */
 169
 170         u8 tx_pending_buf[LBS_UPLD_SIZE];
 171         /* protected by hard_start_xmit serialization */
 172
 173         /** command-related variables */
 174         u16 seqnum;
 175
 176         struct cmd_ctrl_node *cmd_array;
 177         /** Current command */
 178         struct cmd_ctrl_node *cur_cmd;
 179         int cur_cmd_retcode;
 180         /** command Queues */
 181         /** Free command buffers */
 182         struct list_head cmdfreeq;
 183         /** Pending command buffers */
 184         struct list_head cmdpendingq;
 185
 186         wait_queue_head_t cmd_pending;
 187
 188         /* Command responses sent from the hardware to the driver */
 189         u8 resp_idx;
 190         u8 resp_buf[2][LBS_UPLD_SIZE];
 191         u32 resp_len[2];
 192
 193         /* Events sent from hardware to driver */
 194         struct kfifo *event_fifo;
 195
 196         /* nickname */
 197         u8 nodename[16];
 198
 199         /** spin locks */
 200         spinlock_t driver_lock;
 201
 202         /** Timers */
 203         struct timer_list command_timer;
 204         int nr_retries;
 205         int cmd_timed_out;
 206
 207         /** current ssid/bssid related parameters*/
 208         struct current_bss_params curbssparams;
 209
 210         uint16_t mesh_tlv;
 211         u8 mesh_ssid[IW_ESSID_MAX_SIZE + 1];
 212         u8 mesh_ssid_len;
 213
 214         /* IW_MODE_* */
 215         u8 mode;
 216
 217         /* Scan results list */
 218         struct list_head network_list;
 219         struct list_head network_free_list;
 220         struct bss_descriptor *networks;
 221
 222         u16 beacon_period;
 223         u8 beacon_enable;
 224         u8 adhoccreate;
 225
 226         /** capability Info used in Association, start, join */
 227         u16 capability;
 228
 229         /** MAC address information */
 230         u8 current_addr[ETH_ALEN];
 231         u8 multicastlist[MRVDRV_MAX_MULTICAST_LIST_SIZE][ETH_ALEN];
 232         u32 nr_of_multicastmacaddr;
 233
 234         /** 802.11 statistics */
 235 //      struct cmd_DS_802_11_GET_STAT wlan802_11Stat;
 236
 237         u16 enablehwauto;
 238         u16 ratebitmap;
 239
 240         u32 fragthsd;
 241         u32 rtsthsd;
 242
 243         u8 txretrycount;
 244
 245         /** Tx-related variables (for single packet tx) */
 246         struct sk_buff *currenttxskb;
 247
 248         /** NIC Operation characteristics */
 249         u16 mac_control;
 250         u32 connect_status;
 251         u32 mesh_connect_status;
 252         u16 regioncode;
 253         u16 txpowerlevel;
 254
 255         /** POWER MANAGEMENT AND PnP SUPPORT */
 256         u8 surpriseremoved;
 257
 258         u16 psmode;             /* Wlan802_11PowermodeCAM=disable
 259                                    Wlan802_11PowermodeMAX_PSP=enable */
 260         u32 psstate;
 261         char ps_supported;
 262         u8 needtowakeup;
 263
 264         struct assoc_request * pending_assoc_req;
 265         struct assoc_request * in_progress_assoc_req;
 266
 267         /** Encryption parameter */
 268         struct lbs_802_11_security secinfo;
 269
 270         /** WEP keys */
 271         struct enc_key wep_keys[4];
 272         u16 wep_tx_keyidx;
 273
 274         /** WPA keys */
 275         struct enc_key wpa_mcast_key;
 276         struct enc_key wpa_unicast_key;
 277
 278         /** WPA Information Elements*/
 279         u8 wpa_ie[MAX_WPA_IE_LEN];
 280         u8 wpa_ie_len;
 281
 282         /** Requested Signal Strength*/
 283         u16 SNR[MAX_TYPE_B][MAX_TYPE_AVG];
 284         u16 NF[MAX_TYPE_B][MAX_TYPE_AVG];
 285         u8 RSSI[MAX_TYPE_B][MAX_TYPE_AVG];
 286         u8 rawSNR[DEFAULT_DATA_AVG_FACTOR];
 287         u8 rawNF[DEFAULT_DATA_AVG_FACTOR];
 288         u16 nextSNRNF;
 289         u16 numSNRNF;
 290
 291         u8 radioon;
 292         u32 preamble;
 293
 294         /** data rate stuff */
 295         u8 cur_rate;
 296         u8 auto_rate;
 297
 298         /** RF calibration data */
 299
 300 #define MAX_REGION_CHANNEL_NUM  2
 301         /** region channel data */
 302         struct region_channel region_channel[MAX_REGION_CHANNEL_NUM];
 303
 304         struct region_channel universal_channel[MAX_REGION_CHANNEL_NUM];
 305
 306         /** 11D and Domain Regulatory Data */
 307         struct lbs_802_11d_domain_reg domainreg;
 308         struct parsed_region_chan_11d parsed_region_chan;
 309
 310         /** FSM variable for 11d support */
 311         u32 enable11d;
 312
 313         /**     MISCELLANEOUS */
 314         struct lbs_offset_value offsetvalue;
 315
 316         u32 monitormode;
 317         u8 fw_ready;
 318 };
 319
 320 extern struct cmd_confirm_sleep confirm_sleep;
 321
 322 /**
 323  *  @brief Structure used to store information for each beacon/probe response
 324  */
 325 struct bss_descriptor {
 326         u8 bssid[ETH_ALEN];
 327
 328         u8 ssid[IW_ESSID_MAX_SIZE + 1];
 329         u8 ssid_len;
 330
 331         u16 capability;
 332         u32 rssi;
 333         u32 channel;
 334         u16 beaconperiod;
 335         u32 atimwindow;
 336
 337         /* IW_MODE_AUTO, IW_MODE_ADHOC, IW_MODE_INFRA */
 338         u8 mode;
 339
 340         /* zero-terminated array of supported data rates */
 341         u8 rates[MAX_RATES + 1];
 342
 343         unsigned long last_scanned;
 344
 345         union ieeetypes_phyparamset phyparamset;
 346         union IEEEtypes_ssparamset ssparamset;
 347
 348         struct ieeetypes_countryinfofullset countryinfo;
 349
 350         u8 wpa_ie[MAX_WPA_IE_LEN];
 351         size_t wpa_ie_len;
 352         u8 rsn_ie[MAX_WPA_IE_LEN];
 353         size_t rsn_ie_len;
 354
 355         u8 mesh;
 356
 357         struct list_head list;
 358 };
 359
 360 /** Association request
 361  *
 362  * Encapsulates all the options that describe a specific assocation request
 363  * or configuration of the wireless card's radio, mode, and security settings.
 364  */
 365 struct assoc_request {
 366 #define ASSOC_FLAG_SSID                 1
 367 #define ASSOC_FLAG_CHANNEL              2
 368 #define ASSOC_FLAG_BAND                 3
 369 #define ASSOC_FLAG_MODE                 4
 370 #define ASSOC_FLAG_BSSID                5
 371 #define ASSOC_FLAG_WEP_KEYS             6
 372 #define ASSOC_FLAG_WEP_TX_KEYIDX        7
 373 #define ASSOC_FLAG_WPA_MCAST_KEY        8
 374 #define ASSOC_FLAG_WPA_UCAST_KEY        9
 375 #define ASSOC_FLAG_SECINFO              10
 376 #define ASSOC_FLAG_WPA_IE               11
 377         unsigned long flags;
 378
 379         u8 ssid[IW_ESSID_MAX_SIZE + 1];
 380         u8 ssid_len;
 381         u8 channel;
 382         u8 band;
 383         u8 mode;
 384         u8 bssid[ETH_ALEN] __attribute__ ((aligned (2)));
 385
 386         /** WEP keys */
 387         struct enc_key wep_keys[4];
 388         u16 wep_tx_keyidx;
 389
 390         /** WPA keys */
 391         struct enc_key wpa_mcast_key;
 392         struct enc_key wpa_unicast_key;
 393
 394         struct lbs_802_11_security secinfo;
 395
 396         /** WPA Information Elements*/
 397         u8 wpa_ie[MAX_WPA_IE_LEN];
 398         u8 wpa_ie_len;
 399
 400         /* BSS to associate with for infrastructure of Ad-Hoc join */
 401         struct bss_descriptor bss;
 402 };
 403
 404 #endif