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