libertas: Add auto deep sleep support for SD8385/SD8686/SD8688
[linux-2.6.git] / 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
14 #include "defs.h"
15 #include "hostcmd.h"
16
17 extern const struct ethtool_ops lbs_ethtool_ops;
18
19 #define MAX_BSSID_PER_CHANNEL           16
20
21 #define NR_TX_QUEUE                     3
22
23 /* For the extended Scan */
24 #define MAX_EXTENDED_SCAN_BSSID_LIST    MAX_BSSID_PER_CHANNEL * \
25                                                 MRVDRV_MAX_CHANNEL_SIZE + 1
26
27 #define MAX_REGION_CHANNEL_NUM  2
28
29 /** Chan-freq-TxPower mapping table*/
30 struct chan_freq_power {
31         /** channel Number              */
32         u16 channel;
33         /** frequency of this channel   */
34         u32 freq;
35         /** Max allowed Tx power level  */
36         u16 maxtxpower;
37         /** TRUE:channel unsupported;  FLASE:supported*/
38         u8 unsupported;
39 };
40
41 /** region-band mapping table*/
42 struct region_channel {
43         /** TRUE if this entry is valid              */
44         u8 valid;
45         /** region code for US, Japan ...            */
46         u8 region;
47         /** band B/G/A, used for BAND_CONFIG cmd             */
48         u8 band;
49         /** Actual No. of elements in the array below */
50         u8 nrcfp;
51         /** chan-freq-txpower mapping table*/
52         struct chan_freq_power *CFP;
53 };
54
55 struct lbs_802_11_security {
56         u8 WPAenabled;
57         u8 WPA2enabled;
58         u8 wep_enabled;
59         u8 auth_mode;
60         u32 key_mgmt;
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 mesh_fw_ver;
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 *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         /** Deep sleep flag */
133         int is_deep_sleep;
134         /** Auto deep sleep enabled flag */
135         int is_auto_deep_sleep_enabled;
136         /** Device wakeup required flag */
137         int wakeup_dev_required;
138         /** Auto deep sleep flag*/
139         int is_activity_detected;
140         /** Auto deep sleep timeout (in miliseconds) */
141         int auto_deep_sleep_timeout;
142
143         /** Deep sleep wait queue */
144         wait_queue_head_t       ds_awake_q;
145
146         /* Download sent:
147            bit0 1/0=data_sent/data_tx_done,
148            bit1 1/0=cmd_sent/cmd_tx_done,
149            all other bits reserved 0 */
150         u8 dnld_sent;
151
152         /** thread to service interrupts */
153         struct task_struct *main_thread;
154         wait_queue_head_t waitq;
155         struct workqueue_struct *work_thread;
156
157         struct work_struct mcast_work;
158
159         /** Scanning */
160         struct delayed_work scan_work;
161         struct delayed_work assoc_work;
162         struct work_struct sync_channel;
163         /* remember which channel was scanned last, != 0 if currently scanning */
164         int scan_channel;
165         u8 scan_ssid[IW_ESSID_MAX_SIZE + 1];
166         u8 scan_ssid_len;
167
168         /** Hardware access */
169         int (*hw_host_to_card) (struct lbs_private *priv, u8 type, u8 *payload, u16 nb);
170         void (*reset_card) (struct lbs_private *priv);
171         int (*enter_deep_sleep) (struct lbs_private *priv);
172         int (*exit_deep_sleep) (struct lbs_private *priv);
173         int (*reset_deep_sleep_wakeup) (struct lbs_private *priv);
174
175         /* Wake On LAN */
176         uint32_t wol_criteria;
177         uint8_t wol_gpio;
178         uint8_t wol_gap;
179
180         /** Wlan adapter data structure*/
181         /** STATUS variables */
182         u32 fwrelease;
183         u32 fwcapinfo;
184
185         struct mutex lock;
186
187         /* TX packet ready to be sent... */
188         int tx_pending_len;             /* -1 while building packet */
189
190         u8 tx_pending_buf[LBS_UPLD_SIZE];
191         /* protected by hard_start_xmit serialization */
192
193         /** command-related variables */
194         u16 seqnum;
195
196         struct cmd_ctrl_node *cmd_array;
197         /** Current command */
198         struct cmd_ctrl_node *cur_cmd;
199         int cur_cmd_retcode;
200         /** command Queues */
201         /** Free command buffers */
202         struct list_head cmdfreeq;
203         /** Pending command buffers */
204         struct list_head cmdpendingq;
205
206         wait_queue_head_t cmd_pending;
207
208         /* Command responses sent from the hardware to the driver */
209         u8 resp_idx;
210         u8 resp_buf[2][LBS_UPLD_SIZE];
211         u32 resp_len[2];
212
213         /* Events sent from hardware to driver */
214         struct kfifo *event_fifo;
215
216         /* nickname */
217         u8 nodename[16];
218
219         /** spin locks */
220         spinlock_t driver_lock;
221
222         /** Timers */
223         struct timer_list command_timer;
224         struct timer_list auto_deepsleep_timer;
225         int nr_retries;
226         int cmd_timed_out;
227
228         /** current ssid/bssid related parameters*/
229         struct current_bss_params curbssparams;
230
231         uint16_t mesh_tlv;
232         u8 mesh_ssid[IW_ESSID_MAX_SIZE + 1];
233         u8 mesh_ssid_len;
234
235         /* IW_MODE_* */
236         u8 mode;
237
238         /* Scan results list */
239         struct list_head network_list;
240         struct list_head network_free_list;
241         struct bss_descriptor *networks;
242
243         u16 beacon_period;
244         u8 beacon_enable;
245         u8 adhoccreate;
246
247         /** capability Info used in Association, start, join */
248         u16 capability;
249
250         /** MAC address information */
251         u8 current_addr[ETH_ALEN];
252         u8 multicastlist[MRVDRV_MAX_MULTICAST_LIST_SIZE][ETH_ALEN];
253         u32 nr_of_multicastmacaddr;
254
255         /** 802.11 statistics */
256 //      struct cmd_DS_802_11_GET_STAT wlan802_11Stat;
257
258         uint16_t enablehwauto;
259         uint16_t ratebitmap;
260
261         u8 txretrycount;
262
263         /** Tx-related variables (for single packet tx) */
264         struct sk_buff *currenttxskb;
265
266         /** NIC Operation characteristics */
267         u16 mac_control;
268         u32 connect_status;
269         u32 mesh_connect_status;
270         u16 regioncode;
271         s16 txpower_cur;
272         s16 txpower_min;
273         s16 txpower_max;
274
275         /** POWER MANAGEMENT AND PnP SUPPORT */
276         u8 surpriseremoved;
277
278         u16 psmode;             /* Wlan802_11PowermodeCAM=disable
279                                    Wlan802_11PowermodeMAX_PSP=enable */
280         u32 psstate;
281         u8 needtowakeup;
282
283         struct assoc_request * pending_assoc_req;
284         struct assoc_request * in_progress_assoc_req;
285
286         /** Encryption parameter */
287         struct lbs_802_11_security secinfo;
288
289         /** WEP keys */
290         struct enc_key wep_keys[4];
291         u16 wep_tx_keyidx;
292
293         /** WPA keys */
294         struct enc_key wpa_mcast_key;
295         struct enc_key wpa_unicast_key;
296
297 /*
298  * In theory, the IE is limited to the IE length, 255,
299  * but in practice 64 bytes are enough.
300  */
301 #define MAX_WPA_IE_LEN 64
302
303         /** WPA Information Elements*/
304         u8 wpa_ie[MAX_WPA_IE_LEN];
305         u8 wpa_ie_len;
306
307         /** Requested Signal Strength*/
308         u16 SNR[MAX_TYPE_B][MAX_TYPE_AVG];
309         u16 NF[MAX_TYPE_B][MAX_TYPE_AVG];
310         u8 RSSI[MAX_TYPE_B][MAX_TYPE_AVG];
311         u8 rawSNR[DEFAULT_DATA_AVG_FACTOR];
312         u8 rawNF[DEFAULT_DATA_AVG_FACTOR];
313         u16 nextSNRNF;
314         u16 numSNRNF;
315
316         u8 radio_on;
317
318         /** data rate stuff */
319         u8 cur_rate;
320
321         /** RF calibration data */
322
323 #define MAX_REGION_CHANNEL_NUM  2
324         /** region channel data */
325         struct region_channel region_channel[MAX_REGION_CHANNEL_NUM];
326
327         struct region_channel universal_channel[MAX_REGION_CHANNEL_NUM];
328
329         /** 11D and Domain Regulatory Data */
330         struct lbs_802_11d_domain_reg domainreg;
331         struct parsed_region_chan_11d parsed_region_chan;
332
333         /** FSM variable for 11d support */
334         u32 enable11d;
335
336         /**     MISCELLANEOUS */
337         struct lbs_offset_value offsetvalue;
338
339         u32 monitormode;
340         u8 fw_ready;
341 };
342
343 extern struct cmd_confirm_sleep confirm_sleep;
344
345 /**
346  *  @brief Structure used to store information for each beacon/probe response
347  */
348 struct bss_descriptor {
349         u8 bssid[ETH_ALEN];
350
351         u8 ssid[IW_ESSID_MAX_SIZE + 1];
352         u8 ssid_len;
353
354         u16 capability;
355         u32 rssi;
356         u32 channel;
357         u16 beaconperiod;
358         __le16 atimwindow;
359
360         /* IW_MODE_AUTO, IW_MODE_ADHOC, IW_MODE_INFRA */
361         u8 mode;
362
363         /* zero-terminated array of supported data rates */
364         u8 rates[MAX_RATES + 1];
365
366         unsigned long last_scanned;
367
368         union ieee_phy_param_set phy;
369         union ieee_ss_param_set ss;
370
371         struct ieee_ie_country_info_full_set countryinfo;
372
373         u8 wpa_ie[MAX_WPA_IE_LEN];
374         size_t wpa_ie_len;
375         u8 rsn_ie[MAX_WPA_IE_LEN];
376         size_t rsn_ie_len;
377
378         u8 mesh;
379
380         struct list_head list;
381 };
382
383 /** Association request
384  *
385  * Encapsulates all the options that describe a specific assocation request
386  * or configuration of the wireless card's radio, mode, and security settings.
387  */
388 struct assoc_request {
389 #define ASSOC_FLAG_SSID                 1
390 #define ASSOC_FLAG_CHANNEL              2
391 #define ASSOC_FLAG_BAND                 3
392 #define ASSOC_FLAG_MODE                 4
393 #define ASSOC_FLAG_BSSID                5
394 #define ASSOC_FLAG_WEP_KEYS             6
395 #define ASSOC_FLAG_WEP_TX_KEYIDX        7
396 #define ASSOC_FLAG_WPA_MCAST_KEY        8
397 #define ASSOC_FLAG_WPA_UCAST_KEY        9
398 #define ASSOC_FLAG_SECINFO              10
399 #define ASSOC_FLAG_WPA_IE               11
400         unsigned long flags;
401
402         u8 ssid[IW_ESSID_MAX_SIZE + 1];
403         u8 ssid_len;
404         u8 channel;
405         u8 band;
406         u8 mode;
407         u8 bssid[ETH_ALEN] __attribute__ ((aligned (2)));
408
409         /** WEP keys */
410         struct enc_key wep_keys[4];
411         u16 wep_tx_keyidx;
412
413         /** WPA keys */
414         struct enc_key wpa_mcast_key;
415         struct enc_key wpa_unicast_key;
416
417         struct lbs_802_11_security secinfo;
418
419         /** WPA Information Elements*/
420         u8 wpa_ie[MAX_WPA_IE_LEN];
421         u8 wpa_ie_len;
422
423         /* BSS to associate with for infrastructure of Ad-Hoc join */
424         struct bss_descriptor bss;
425 };
426
427 #endif