49f31ec2646b6a7043f5a2bdf96fbae58b35888f
[linux-2.6-block.git] / drivers / staging / rtl8192e / rtllib.h
1 /*
2  * Merged with mainline rtllib.h in Aug 2004.  Original ieee802_11
3  * remains copyright by the original authors
4  *
5  * Portions of the merged code are based on Host AP (software wireless
6  * LAN access point) driver for Intersil Prism2/2.5/3.
7  *
8  * Copyright (c) 2001-2002, SSH Communications Security Corp and Jouni Malinen
9  * <jkmaline@cc.hut.fi>
10  * Copyright (c) 2002-2003, Jouni Malinen <jkmaline@cc.hut.fi>
11  *
12  * Adaption to a generic IEEE 802.11 stack by James Ketrenos
13  * <jketreno@linux.intel.com>
14  * Copyright (c) 2004, Intel Corporation
15  *
16  * Modified for Realtek's wi-fi cards by Andrea Merello
17  * <andrea.merello@gmail.com>
18  *
19  * This program is free software; you can redistribute it and/or modify
20  * it under the terms of the GNU General Public License version 2 as
21  * published by the Free Software Foundation. See README and COPYING for
22  * more details.
23  */
24 #ifndef RTLLIB_H
25 #define RTLLIB_H
26 #include <linux/if_ether.h> /* ETH_ALEN */
27 #include <linux/kernel.h>   /* ARRAY_SIZE */
28 #include <linux/module.h>
29 #include <linux/interrupt.h>
30 #include <linux/jiffies.h>
31 #include <linux/timer.h>
32 #include <linux/sched.h>
33 #include <linux/semaphore.h>
34
35 #include <linux/delay.h>
36 #include <linux/wireless.h>
37
38 #include "rtllib_debug.h"
39 #include "rtl819x_HT.h"
40 #include "rtl819x_BA.h"
41 #include "rtl819x_TS.h"
42
43 #include <linux/netdevice.h>
44 #include <linux/if_arp.h> /* ARPHRD_ETHER */
45 #include <net/lib80211.h>
46
47 #define MAX_PRECMD_CNT 16
48 #define MAX_RFDEPENDCMD_CNT 16
49 #define MAX_POSTCMD_CNT 16
50
51 #ifndef WIRELESS_SPY
52 #define WIRELESS_SPY
53 #endif
54 #include <net/iw_handler.h>
55
56 #ifndef IW_MODE_MONITOR
57 #define IW_MODE_MONITOR 6
58 #endif
59
60 #ifndef IWEVCUSTOM
61 #define IWEVCUSTOM 0x8c02
62 #endif
63
64 #ifndef IW_CUSTOM_MAX
65 /* Max number of char in custom event - use multiple of them if needed */
66 #define IW_CUSTOM_MAX   256     /* In bytes */
67 #endif
68
69 #define skb_tail_pointer_rsl(skb) skb_tail_pointer(skb)
70
71 #define queue_delayed_work_rsl(x, y, z) queue_delayed_work(x, y, z)
72 #define INIT_DELAYED_WORK_RSL(x, y, z) INIT_DELAYED_WORK(x, y)
73
74 #define queue_work_rsl(x, y) queue_work(x, y)
75 #define INIT_WORK_RSL(x, y, z) INIT_WORK(x, y)
76
77 #define container_of_work_rsl(x, y, z) container_of(x, y, z)
78 #define container_of_dwork_rsl(x, y, z)                         \
79         container_of(container_of(x, struct delayed_work, work), y, z)
80
81 #define iwe_stream_add_event_rsl(info, start, stop, iwe, len)   \
82         iwe_stream_add_event(info, start, stop, iwe, len)
83
84 #define iwe_stream_add_point_rsl(info, start, stop, iwe, p)     \
85         iwe_stream_add_point(info, start, stop, iwe, p)
86
87 #define usb_alloc_urb_rsl(x, y) usb_alloc_urb(x, y)
88 #define usb_submit_urb_rsl(x, y) usb_submit_urb(x, y)
89
90 static inline void *netdev_priv_rsl(struct net_device *dev)
91 {
92         return netdev_priv(dev);
93 }
94
95 #define KEY_TYPE_NA             0x0
96 #define KEY_TYPE_WEP40          0x1
97 #define KEY_TYPE_TKIP           0x2
98 #define KEY_TYPE_CCMP           0x4
99 #define KEY_TYPE_WEP104         0x5
100 /* added for rtl819x tx procedure */
101 #define MAX_QUEUE_SIZE          0x10
102
103 #define BK_QUEUE                               0
104 #define BE_QUEUE                               1
105 #define VI_QUEUE                               2
106 #define VO_QUEUE                               3
107 #define HCCA_QUEUE                           4
108 #define TXCMD_QUEUE                         5
109 #define MGNT_QUEUE                           6
110 #define HIGH_QUEUE                           7
111 #define BEACON_QUEUE                       8
112
113 #define LOW_QUEUE                             BE_QUEUE
114 #define NORMAL_QUEUE                       MGNT_QUEUE
115
116 #ifndef IW_MODE_MESH
117 #define IW_MODE_MESH                    7
118 #endif
119 #define AMSDU_SUBHEADER_LEN 14
120 #define SWRF_TIMEOUT                            50
121
122 #define IE_CISCO_FLAG_POSITION          0x08
123 #define SUPPORT_CKIP_MIC                        0x08
124 #define SUPPORT_CKIP_PK                 0x10
125 #define RT_RF_OFF_LEVL_ASPM                     BIT0
126 #define RT_RF_OFF_LEVL_CLK_REQ          BIT1
127 #define RT_RF_OFF_LEVL_PCI_D3                   BIT2
128 #define RT_RF_OFF_LEVL_HALT_NIC         BIT3
129 #define RT_RF_OFF_LEVL_FREE_FW          BIT4
130 #define RT_RF_OFF_LEVL_FW_32K           BIT5
131 #define RT_RF_PS_LEVEL_ALWAYS_ASPM      BIT6
132 #define RT_RF_LPS_DISALBE_2R                    BIT30
133 #define RT_RF_LPS_LEVEL_ASPM                    BIT31
134 #define RT_IN_PS_LEVEL(pPSC, _PS_FLAG)          \
135         ((pPSC->CurPsLevel & _PS_FLAG) ? true : false)
136 #define RT_CLEAR_PS_LEVEL(pPSC, _PS_FLAG)       \
137         (pPSC->CurPsLevel &= (~(_PS_FLAG)))
138 #define RT_SET_PS_LEVEL(pPSC, _PS_FLAG) (pPSC->CurPsLevel |= _PS_FLAG)
139
140 /* defined for skb cb field */
141 /* At most 28 byte */
142 struct cb_desc {
143         /* Tx Desc Related flags (8-9) */
144         u8 bLastIniPkt:1;
145         u8 bCmdOrInit:1;
146         u8 bFirstSeg:1;
147         u8 bLastSeg:1;
148         u8 bEncrypt:1;
149         u8 bTxDisableRateFallBack:1;
150         u8 bTxUseDriverAssingedRate:1;
151         u8 bHwSec:1;
152
153         u8 nStuckCount;
154
155         /* Tx Firmware Related flags (10-11)*/
156         u8 bCTSEnable:1;
157         u8 bRTSEnable:1;
158         u8 bUseShortGI:1;
159         u8 bUseShortPreamble:1;
160         u8 bTxEnableFwCalcDur:1;
161         u8 bAMPDUEnable:1;
162         u8 bRTSSTBC:1;
163         u8 RTSSC:1;
164
165         u8 bRTSBW:1;
166         u8 bPacketBW:1;
167         u8 bRTSUseShortPreamble:1;
168         u8 bRTSUseShortGI:1;
169         u8 bMulticast:1;
170         u8 bBroadcast:1;
171         u8 drv_agg_enable:1;
172         u8 reserved2:1;
173
174         /* Tx Desc related element(12-19) */
175         u8 rata_index;
176         u8 queue_index;
177         u16 txbuf_size;
178         u8 RATRIndex;
179         u8 bAMSDU:1;
180         u8 bFromAggrQ:1;
181         u8 reserved6:6;
182         u8 macId;
183         u8 priority;
184
185         /* Tx firmware related element(20-27) */
186         u8 data_rate;
187         u8 rts_rate;
188         u8 ampdu_factor;
189         u8 ampdu_density;
190         u8 DrvAggrNum;
191         u8 bdhcp;
192         u16 pkt_size;
193         u8 bIsSpecialDataFrame;
194
195         u8 bBTTxPacket;
196         u8 bIsBTProbRsp;
197 };
198
199 enum sw_chnl_cmd_id {
200         CmdID_End,
201         CmdID_SetTxPowerLevel,
202         CmdID_BBRegWrite10,
203         CmdID_WritePortUlong,
204         CmdID_WritePortUshort,
205         CmdID_WritePortUchar,
206         CmdID_RF_WriteReg,
207 };
208
209 struct sw_chnl_cmd {
210         enum sw_chnl_cmd_id CmdID;
211         u32                     Para1;
212         u32                     Para2;
213         u32                     msDelay;
214 } __packed;
215
216 /*--------------------------Define -------------------------------------------*/
217 #define MGN_1M            0x02
218 #define MGN_2M            0x04
219 #define MGN_5_5M                0x0b
220 #define MGN_11M          0x16
221
222 #define MGN_6M            0x0c
223 #define MGN_9M            0x12
224 #define MGN_12M          0x18
225 #define MGN_18M          0x24
226 #define MGN_24M          0x30
227 #define MGN_36M          0x48
228 #define MGN_48M          0x60
229 #define MGN_54M          0x6c
230
231 #define MGN_MCS0                0x80
232 #define MGN_MCS1                0x81
233 #define MGN_MCS2                0x82
234 #define MGN_MCS3                0x83
235 #define MGN_MCS4                0x84
236 #define MGN_MCS5                0x85
237 #define MGN_MCS6                0x86
238 #define MGN_MCS7                0x87
239 #define MGN_MCS8                0x88
240 #define MGN_MCS9                0x89
241 #define MGN_MCS10              0x8a
242 #define MGN_MCS11              0x8b
243 #define MGN_MCS12              0x8c
244 #define MGN_MCS13              0x8d
245 #define MGN_MCS14              0x8e
246 #define MGN_MCS15              0x8f
247 #define MGN_MCS0_SG                     0x90
248 #define MGN_MCS1_SG                     0x91
249 #define MGN_MCS2_SG                     0x92
250 #define MGN_MCS3_SG                     0x93
251 #define MGN_MCS4_SG                     0x94
252 #define MGN_MCS5_SG                     0x95
253 #define MGN_MCS6_SG                     0x96
254 #define MGN_MCS7_SG                     0x97
255 #define MGN_MCS8_SG                     0x98
256 #define MGN_MCS9_SG                     0x99
257 #define MGN_MCS10_SG            0x9a
258 #define MGN_MCS11_SG            0x9b
259 #define MGN_MCS12_SG            0x9c
260 #define MGN_MCS13_SG            0x9d
261 #define MGN_MCS14_SG            0x9e
262 #define MGN_MCS15_SG            0x9f
263
264 enum hw_variables {
265         HW_VAR_ETHER_ADDR,
266         HW_VAR_MULTICAST_REG,
267         HW_VAR_BASIC_RATE,
268         HW_VAR_BSSID,
269         HW_VAR_MEDIA_STATUS,
270         HW_VAR_SECURITY_CONF,
271         HW_VAR_BEACON_INTERVAL,
272         HW_VAR_ATIM_WINDOW,
273         HW_VAR_LISTEN_INTERVAL,
274         HW_VAR_CS_COUNTER,
275         HW_VAR_DEFAULTKEY0,
276         HW_VAR_DEFAULTKEY1,
277         HW_VAR_DEFAULTKEY2,
278         HW_VAR_DEFAULTKEY3,
279         HW_VAR_SIFS,
280         HW_VAR_DIFS,
281         HW_VAR_EIFS,
282         HW_VAR_SLOT_TIME,
283         HW_VAR_ACK_PREAMBLE,
284         HW_VAR_CW_CONFIG,
285         HW_VAR_CW_VALUES,
286         HW_VAR_RATE_FALLBACK_CONTROL,
287         HW_VAR_CONTENTION_WINDOW,
288         HW_VAR_RETRY_COUNT,
289         HW_VAR_TR_SWITCH,
290         HW_VAR_COMMAND,
291         HW_VAR_WPA_CONFIG,
292         HW_VAR_AMPDU_MIN_SPACE,
293         HW_VAR_SHORTGI_DENSITY,
294         HW_VAR_AMPDU_FACTOR,
295         HW_VAR_MCS_RATE_AVAILABLE,
296         HW_VAR_AC_PARAM,
297         HW_VAR_ACM_CTRL,
298         HW_VAR_DIS_Req_Qsize,
299         HW_VAR_CCX_CHNL_LOAD,
300         HW_VAR_CCX_NOISE_HISTOGRAM,
301         HW_VAR_CCX_CLM_NHM,
302         HW_VAR_TxOPLimit,
303         HW_VAR_TURBO_MODE,
304         HW_VAR_RF_STATE,
305         HW_VAR_RF_OFF_BY_HW,
306         HW_VAR_BUS_SPEED,
307         HW_VAR_SET_DEV_POWER,
308
309         HW_VAR_RCR,
310         HW_VAR_RATR_0,
311         HW_VAR_RRSR,
312         HW_VAR_CPU_RST,
313         HW_VAR_CECHK_BSSID,
314         HW_VAR_LBK_MODE,
315         HW_VAR_AES_11N_FIX,
316         HW_VAR_USB_RX_AGGR,
317         HW_VAR_USER_CONTROL_TURBO_MODE,
318         HW_VAR_RETRY_LIMIT,
319         HW_VAR_INIT_TX_RATE,
320         HW_VAR_TX_RATE_REG,
321         HW_VAR_EFUSE_USAGE,
322         HW_VAR_EFUSE_BYTES,
323         HW_VAR_AUTOLOAD_STATUS,
324         HW_VAR_RF_2R_DISABLE,
325         HW_VAR_SET_RPWM,
326         HW_VAR_H2C_FW_PWRMODE,
327         HW_VAR_H2C_FW_JOINBSSRPT,
328         HW_VAR_1X1_RECV_COMBINE,
329         HW_VAR_STOP_SEND_BEACON,
330         HW_VAR_TSF_TIMER,
331         HW_VAR_IO_CMD,
332
333         HW_VAR_RF_RECOVERY,
334         HW_VAR_H2C_FW_UPDATE_GTK,
335         HW_VAR_WF_MASK,
336         HW_VAR_WF_CRC,
337         HW_VAR_WF_IS_MAC_ADDR,
338         HW_VAR_H2C_FW_OFFLOAD,
339         HW_VAR_RESET_WFCRC,
340
341         HW_VAR_HANDLE_FW_C2H,
342         HW_VAR_DL_FW_RSVD_PAGE,
343         HW_VAR_AID,
344         HW_VAR_HW_SEQ_ENABLE,
345         HW_VAR_CORRECT_TSF,
346         HW_VAR_BCN_VALID,
347         HW_VAR_FWLPS_RF_ON,
348         HW_VAR_DUAL_TSF_RST,
349         HW_VAR_SWITCH_EPHY_WoWLAN,
350         HW_VAR_INT_MIGRATION,
351         HW_VAR_INT_AC,
352         HW_VAR_RF_TIMING,
353 };
354
355 enum rt_op_mode {
356         RT_OP_MODE_AP,
357         RT_OP_MODE_INFRASTRUCTURE,
358         RT_OP_MODE_IBSS,
359         RT_OP_MODE_NO_LINK,
360 };
361
362
363 #define aSifsTime                                               \
364          (((priv->rtllib->current_network.mode == IEEE_A)       \
365         || (priv->rtllib->current_network.mode == IEEE_N_24G)   \
366         || (priv->rtllib->current_network.mode == IEEE_N_5G)) ? 16 : 10)
367
368 #define MGMT_QUEUE_NUM 5
369
370 #define IEEE_CMD_SET_WPA_PARAM                  1
371 #define IEEE_CMD_SET_WPA_IE                     2
372 #define IEEE_CMD_SET_ENCRYPTION                 3
373 #define IEEE_CMD_MLME                           4
374
375 #define IEEE_PARAM_WPA_ENABLED                  1
376 #define IEEE_PARAM_TKIP_COUNTERMEASURES         2
377 #define IEEE_PARAM_DROP_UNENCRYPTED             3
378 #define IEEE_PARAM_PRIVACY_INVOKED              4
379 #define IEEE_PARAM_AUTH_ALGS                    5
380 #define IEEE_PARAM_IEEE_802_1X                  6
381 #define IEEE_PARAM_WPAX_SELECT                  7
382
383 #define IEEE_MLME_STA_DEAUTH                    1
384 #define IEEE_MLME_STA_DISASSOC                  2
385
386
387 #define IEEE_CRYPT_ERR_UNKNOWN_ALG              2
388 #define IEEE_CRYPT_ERR_CRYPT_INIT_FAILED        4
389 #define IEEE_CRYPT_ERR_KEY_SET_FAILED           5
390 #define IEEE_CRYPT_ERR_CARD_CONF_FAILED         7
391 #define IEEE_CRYPT_ALG_NAME_LEN                 16
392
393 #define MAX_IE_LEN  0xff
394
395 struct ieee_param {
396         u32 cmd;
397         u8 sta_addr[ETH_ALEN];
398         union {
399                 struct {
400                         u8 name;
401                         u32 value;
402                 } wpa_param;
403                 struct {
404                         u32 len;
405                         u8 reserved[32];
406                         u8 data[0];
407                 } wpa_ie;
408                 struct {
409                         int command;
410                         int reason_code;
411                 } mlme;
412                 struct {
413                         u8 alg[IEEE_CRYPT_ALG_NAME_LEN];
414                         u8 set_tx;
415                         u32 err;
416                         u8 idx;
417                         u8 seq[8]; /* sequence counter (set: RX, get: TX) */
418                         u16 key_len;
419                         u8 key[0];
420                 } crypt;
421         } u;
422 };
423
424 #define msleep_interruptible_rsl  msleep_interruptible
425
426 /* Maximum size for the MA-UNITDATA primitive, 802.11 standard section
427  * 6.2.1.1.2.
428  *
429  * The figure in section 7.1.2 suggests a body size of up to 2312
430  * bytes is allowed, which is a bit confusing, I suspect this
431  * represents the 2304 bytes of real data, plus a possible 8 bytes of
432  * WEP IV and ICV. (this interpretation suggested by Ramiro Barreiro)
433  */
434 #define RTLLIB_1ADDR_LEN 10
435 #define RTLLIB_2ADDR_LEN 16
436 #define RTLLIB_3ADDR_LEN 24
437 #define RTLLIB_4ADDR_LEN 30
438 #define RTLLIB_FCS_LEN    4
439
440 #define RTLLIB_SKBBUFFER_SIZE 2500
441
442 #define MIN_FRAG_THRESHOLD     256U
443 #define MAX_FRAG_THRESHOLD     2346U
444
445 /* Frame control field constants */
446 #define RTLLIB_FCTL_FTYPE               0x000c
447 #define RTLLIB_FCTL_STYPE               0x00f0
448 #define RTLLIB_FCTL_FRAMETYPE   0x00fc
449 #define RTLLIB_FCTL_TODS                0x0100
450 #define RTLLIB_FCTL_FROMDS              0x0200
451 #define RTLLIB_FCTL_DSTODS              0x0300
452 #define RTLLIB_FCTL_MOREFRAGS   0x0400
453 #define RTLLIB_FCTL_RETRY               0x0800
454 #define RTLLIB_FCTL_PM          0x1000
455 #define RTLLIB_FCTL_MOREDATA            0x2000
456 #define RTLLIB_FCTL_WEP         0x4000
457 #define RTLLIB_FCTL_ORDER               0x8000
458
459 #define RTLLIB_FTYPE_MGMT               0x0000
460 #define RTLLIB_FTYPE_CTL                0x0004
461 #define RTLLIB_FTYPE_DATA               0x0008
462
463 /* management */
464 #define RTLLIB_STYPE_ASSOC_REQ  0x0000
465 #define RTLLIB_STYPE_ASSOC_RESP         0x0010
466 #define RTLLIB_STYPE_REASSOC_REQ        0x0020
467 #define RTLLIB_STYPE_REASSOC_RESP       0x0030
468 #define RTLLIB_STYPE_PROBE_REQ  0x0040
469 #define RTLLIB_STYPE_PROBE_RESP 0x0050
470 #define RTLLIB_STYPE_BEACON             0x0080
471 #define RTLLIB_STYPE_ATIM               0x0090
472 #define RTLLIB_STYPE_DISASSOC   0x00A0
473 #define RTLLIB_STYPE_AUTH               0x00B0
474 #define RTLLIB_STYPE_DEAUTH             0x00C0
475 #define RTLLIB_STYPE_MANAGE_ACT 0x00D0
476
477 /* control */
478 #define RTLLIB_STYPE_PSPOLL             0x00A0
479 #define RTLLIB_STYPE_RTS                0x00B0
480 #define RTLLIB_STYPE_CTS                0x00C0
481 #define RTLLIB_STYPE_ACK                0x00D0
482
483 /* data */
484 #define RTLLIB_STYPE_DATA               0x0000
485 #define RTLLIB_STYPE_DATA_CFACK 0x0010
486 #define RTLLIB_STYPE_DATA_CFPOLL        0x0020
487 #define RTLLIB_STYPE_DATA_CFACKPOLL     0x0030
488 #define RTLLIB_STYPE_NULLFUNC   0x0040
489 #define RTLLIB_STYPE_QOS_DATA   0x0080
490 #define RTLLIB_STYPE_QOS_NULL   0x00C0
491
492 #define RTLLIB_SCTL_FRAG                0x000F
493 #define RTLLIB_SCTL_SEQ         0xFFF0
494
495 /* QOS control */
496 #define RTLLIB_QCTL_TID       0x000F
497
498 #define FC_QOS_BIT                                      BIT7
499 #define IsDataFrame(pdu)        (((pdu[0] & 0x0C) == 0x08) ? true : false)
500 #define IsLegacyDataFrame(pdu)  (IsDataFrame(pdu) && (!(pdu[0]&FC_QOS_BIT)))
501 #define IsQoSDataFrame(pframe)                  \
502         ((*(u16 *)pframe&(RTLLIB_STYPE_QOS_DATA|RTLLIB_FTYPE_DATA)) ==  \
503         (RTLLIB_STYPE_QOS_DATA|RTLLIB_FTYPE_DATA))
504 #define Frame_Order(pframe)     (*(u16 *)pframe&RTLLIB_FCTL_ORDER)
505 #define SN_LESS(a, b)           (((a-b)&0x800) != 0)
506 #define SN_EQUAL(a, b)  (a == b)
507 #define MAX_DEV_ADDR_SIZE 8
508
509 enum act_category {
510         ACT_CAT_QOS = 1,
511         ACT_CAT_DLS = 2,
512         ACT_CAT_BA  = 3,
513         ACT_CAT_HT  = 7,
514         ACT_CAT_WMM = 17,
515 };
516
517 enum ba_action {
518         ACT_ADDBAREQ = 0,
519         ACT_ADDBARSP = 1,
520         ACT_DELBA    = 2,
521 };
522
523 enum init_gain_op_type {
524         IG_Backup = 0,
525         IG_Restore,
526         IG_Max
527 };
528
529 enum led_ctl_mode {
530         LED_CTL_POWER_ON = 1,
531         LED_CTL_LINK = 2,
532         LED_CTL_NO_LINK = 3,
533         LED_CTL_TX = 4,
534         LED_CTL_RX = 5,
535         LED_CTL_SITE_SURVEY = 6,
536         LED_CTL_POWER_OFF = 7,
537         LED_CTL_START_TO_LINK = 8,
538 };
539
540 enum rt_rf_type_def {
541         RF_1T2R = 0,
542         RF_2T4R,
543 };
544
545 enum wireless_mode {
546         WIRELESS_MODE_UNKNOWN = 0x00,
547         WIRELESS_MODE_A = 0x01,
548         WIRELESS_MODE_B = 0x02,
549         WIRELESS_MODE_G = 0x04,
550         WIRELESS_MODE_AUTO = 0x08,
551         WIRELESS_MODE_N_24G = 0x10,
552         WIRELESS_MODE_N_5G = 0x20
553 };
554
555 #ifndef ETH_P_PAE
556 #define ETH_P_PAE 0x888E /* Port Access Entity (IEEE 802.1X) */
557 #define ETH_P_IP        0x0800          /* Internet Protocol packet     */
558 #define ETH_P_ARP       0x0806          /* Address Resolution packet    */
559 #endif /* ETH_P_PAE */
560
561 #ifndef ETH_P_80211_RAW
562 #define ETH_P_80211_RAW (ETH_P_ECONET + 1)
563 #endif
564
565 /* IEEE 802.11 defines */
566
567 #define P80211_OUI_LEN 3
568
569 struct rtllib_snap_hdr {
570
571         u8    dsap;   /* always 0xAA */
572         u8    ssap;   /* always 0xAA */
573         u8    ctrl;   /* always 0x03 */
574         u8    oui[P80211_OUI_LEN];    /* organizational universal id */
575
576 } __packed;
577
578 enum _REG_PREAMBLE_MODE {
579         PREAMBLE_LONG = 1,
580         PREAMBLE_AUTO = 2,
581         PREAMBLE_SHORT = 3,
582 };
583
584 #define SNAP_SIZE sizeof(struct rtllib_snap_hdr)
585
586 #define WLAN_FC_GET_TYPE(fc) ((fc) & RTLLIB_FCTL_FTYPE)
587 #define WLAN_FC_GET_STYPE(fc) ((fc) & RTLLIB_FCTL_STYPE)
588 #define WLAN_FC_MORE_DATA(fc) ((fc) & RTLLIB_FCTL_MOREDATA)
589
590 #define WLAN_FC_GET_FRAMETYPE(fc) ((fc) & RTLLIB_FCTL_FRAMETYPE)
591 #define WLAN_GET_SEQ_FRAG(seq) ((seq) & RTLLIB_SCTL_FRAG)
592 #define WLAN_GET_SEQ_SEQ(seq)  (((seq) & RTLLIB_SCTL_SEQ) >> 4)
593
594 /* Authentication algorithms */
595 #define WLAN_AUTH_OPEN 0
596 #define WLAN_AUTH_SHARED_KEY 1
597 #define WLAN_AUTH_LEAP 128
598
599 #define WLAN_CAPABILITY_ESS (1<<0)
600 #define WLAN_CAPABILITY_IBSS (1<<1)
601 #define WLAN_CAPABILITY_PRIVACY (1<<4)
602 #define WLAN_CAPABILITY_SHORT_PREAMBLE (1<<5)
603 #define WLAN_CAPABILITY_SHORT_SLOT_TIME (1<<10)
604
605 #define RTLLIB_STATMASK_SIGNAL (1<<0)
606 #define RTLLIB_STATMASK_RSSI (1<<1)
607 #define RTLLIB_STATMASK_NOISE (1<<2)
608 #define RTLLIB_STATMASK_WEMASK 0x7
609
610 #define RTLLIB_CCK_MODULATION    (1<<0)
611 #define RTLLIB_OFDM_MODULATION   (1<<1)
612
613 #define RTLLIB_24GHZ_BAND     (1<<0)
614 #define RTLLIB_52GHZ_BAND     (1<<1)
615
616 #define RTLLIB_CCK_RATE_LEN             4
617 #define RTLLIB_CCK_RATE_1MB                     0x02
618 #define RTLLIB_CCK_RATE_2MB                     0x04
619 #define RTLLIB_CCK_RATE_5MB                     0x0B
620 #define RTLLIB_CCK_RATE_11MB                    0x16
621 #define RTLLIB_OFDM_RATE_LEN            8
622 #define RTLLIB_OFDM_RATE_6MB                    0x0C
623 #define RTLLIB_OFDM_RATE_9MB                    0x12
624 #define RTLLIB_OFDM_RATE_12MB           0x18
625 #define RTLLIB_OFDM_RATE_18MB           0x24
626 #define RTLLIB_OFDM_RATE_24MB           0x30
627 #define RTLLIB_OFDM_RATE_36MB           0x48
628 #define RTLLIB_OFDM_RATE_48MB           0x60
629 #define RTLLIB_OFDM_RATE_54MB           0x6C
630 #define RTLLIB_BASIC_RATE_MASK          0x80
631
632 /* this is stolen and modified from the madwifi driver*/
633 #define RTLLIB_FC0_TYPE_MASK            0x0c
634 #define RTLLIB_FC0_TYPE_DATA            0x08
635 #define RTLLIB_FC0_SUBTYPE_MASK 0xB0
636 #define RTLLIB_FC0_SUBTYPE_QOS  0x80
637
638 #define RTLLIB_QOS_HAS_SEQ(fc) \
639         (((fc) & (RTLLIB_FC0_TYPE_MASK | RTLLIB_FC0_SUBTYPE_MASK)) == \
640          (RTLLIB_FC0_TYPE_DATA | RTLLIB_FC0_SUBTYPE_QOS))
641
642 /* this is stolen from ipw2200 driver */
643 #define IEEE_IBSS_MAC_HASH_SIZE 31
644 struct ieee_ibss_seq {
645         u8 mac[ETH_ALEN];
646         u16 seq_num[17];
647         u16 frag_num[17];
648         unsigned long packet_time[17];
649         struct list_head list;
650 };
651
652 /* NOTE: This data is for statistical purposes; not all hardware provides this
653  *       information for frames received.  Not setting these will not cause
654  *       any adverse affects. */
655 struct rtllib_rx_stats {
656         u64 mac_time;
657         s8  rssi;
658         u8  signal;
659         u8  noise;
660         u16 rate; /* in 100 kbps */
661         u8  received_channel;
662         u8  control;
663         u8  mask;
664         u8  freq;
665         u16 len;
666         u64 tsf;
667         u32 beacon_time;
668         u8  nic_type;
669         u16 Length;
670         u8  SignalQuality;
671         s32 RecvSignalPower;
672         s8  RxPower;
673         u8  SignalStrength;
674         u16 bHwError:1;
675         u16 bCRC:1;
676         u16 bICV:1;
677         u16 bShortPreamble:1;
678         u16 Antenna:1;
679         u16 Decrypted:1;
680         u16 Wakeup:1;
681         u16 Reserved0:1;
682         u8  AGC;
683         u32 TimeStampLow;
684         u32 TimeStampHigh;
685         bool bShift;
686         bool bIsQosData;
687
688         u8    RxDrvInfoSize;
689         u8    RxBufShift;
690         bool  bIsAMPDU;
691         bool  bFirstMPDU;
692         bool  bContainHTC;
693         bool  RxIs40MHzPacket;
694         u32   RxPWDBAll;
695         u8    RxMIMOSignalStrength[4];
696         s8    RxMIMOSignalQuality[2];
697         bool  bPacketMatchBSSID;
698         bool  bIsCCK;
699         bool  bPacketToSelf;
700         u16    packetlength;
701         u16    fraglength;
702         u16    fragoffset;
703         u16    ntotalfrag;
704         bool   bPacketBeacon;
705         bool   bToSelfBA;
706         u16    Seq_Num;
707 };
708
709 /* IEEE 802.11 requires that STA supports concurrent reception of at least
710  * three fragmented frames. This define can be increased to support more
711  * concurrent frames, but it should be noted that each entry can consume about
712  * 2 kB of RAM and increasing cache size will slow down frame reassembly.
713  */
714 #define RTLLIB_FRAG_CACHE_LEN 4
715
716 struct rtllib_frag_entry {
717         unsigned long first_frag_time;
718         unsigned int seq;
719         unsigned int last_frag;
720         struct sk_buff *skb;
721         u8 src_addr[ETH_ALEN];
722         u8 dst_addr[ETH_ALEN];
723 };
724
725 struct rtllib_stats {
726         unsigned int tx_unicast_frames;
727         unsigned int tx_multicast_frames;
728         unsigned int tx_fragments;
729         unsigned int tx_unicast_octets;
730         unsigned int tx_multicast_octets;
731         unsigned int tx_deferred_transmissions;
732         unsigned int tx_single_retry_frames;
733         unsigned int tx_multiple_retry_frames;
734         unsigned int tx_retry_limit_exceeded;
735         unsigned int tx_discards;
736         unsigned int rx_unicast_frames;
737         unsigned int rx_multicast_frames;
738         unsigned int rx_fragments;
739         unsigned int rx_unicast_octets;
740         unsigned int rx_multicast_octets;
741         unsigned int rx_fcs_errors;
742         unsigned int rx_discards_no_buffer;
743         unsigned int tx_discards_wrong_sa;
744         unsigned int rx_discards_undecryptable;
745         unsigned int rx_message_in_msg_fragments;
746         unsigned int rx_message_in_bad_msg_fragments;
747 };
748
749 struct rtllib_device;
750
751 #define SEC_KEY_1        (1<<0)
752 #define SEC_KEY_2        (1<<1)
753 #define SEC_KEY_3        (1<<2)
754 #define SEC_KEY_4        (1<<3)
755 #define SEC_ACTIVE_KEY    (1<<4)
756 #define SEC_AUTH_MODE     (1<<5)
757 #define SEC_UNICAST_GROUP (1<<6)
758 #define SEC_LEVEL        (1<<7)
759 #define SEC_ENABLED       (1<<8)
760 #define SEC_ENCRYPT       (1<<9)
761
762 #define SEC_LEVEL_0      0 /* None */
763 #define SEC_LEVEL_1      1 /* WEP 40 and 104 bit */
764 #define SEC_LEVEL_2      2 /* Level 1 + TKIP */
765 #define SEC_LEVEL_2_CKIP 3 /* Level 1 + CKIP */
766 #define SEC_LEVEL_3      4 /* Level 2 + CCMP */
767
768 #define SEC_ALG_NONE            0
769 #define SEC_ALG_WEP             1
770 #define SEC_ALG_TKIP            2
771 #define SEC_ALG_CCMP            4
772
773 #define WEP_KEY_LEN             13
774 #define SCM_KEY_LEN             32
775 #define SCM_TEMPORAL_KEY_LENGTH 16
776
777 struct rtllib_security {
778         u16 active_key:2,
779             enabled:1,
780             auth_mode:2,
781             auth_algo:4,
782             unicast_uses_group:1,
783             encrypt:1;
784         u8 key_sizes[NUM_WEP_KEYS];
785         u8 keys[NUM_WEP_KEYS][SCM_KEY_LEN];
786         u8 level;
787         u16 flags;
788 } __packed;
789
790
791 /* 802.11 data frame from AP
792  *       ,-------------------------------------------------------------------.
793  * Bytes |  2   |  2   |    6    |    6    |    6    |  2   | 0..2312 |   4  |
794  *       |------|------|---------|---------|---------|------|---------|------|
795  * Desc. | ctrl | dura |  DA/RA  |   TA    |    SA   | Sequ |  frame  |  fcs |
796  *       |      | tion | (BSSID) |         |         | ence |  data   |      |
797  *       `-------------------------------------------------------------------'
798  * Total: 28-2340 bytes
799  */
800
801 /* Management Frame Information Element Types */
802 enum rtllib_mfie {
803         MFIE_TYPE_SSID = 0,
804         MFIE_TYPE_RATES = 1,
805         MFIE_TYPE_FH_SET = 2,
806         MFIE_TYPE_DS_SET = 3,
807         MFIE_TYPE_CF_SET = 4,
808         MFIE_TYPE_TIM = 5,
809         MFIE_TYPE_IBSS_SET = 6,
810         MFIE_TYPE_COUNTRY = 7,
811         MFIE_TYPE_HOP_PARAMS = 8,
812         MFIE_TYPE_HOP_TABLE = 9,
813         MFIE_TYPE_REQUEST = 10,
814         MFIE_TYPE_CHALLENGE = 16,
815         MFIE_TYPE_POWER_CONSTRAINT = 32,
816         MFIE_TYPE_POWER_CAPABILITY = 33,
817         MFIE_TYPE_TPC_REQUEST = 34,
818         MFIE_TYPE_TPC_REPORT = 35,
819         MFIE_TYPE_SUPP_CHANNELS = 36,
820         MFIE_TYPE_CSA = 37,
821         MFIE_TYPE_MEASURE_REQUEST = 38,
822         MFIE_TYPE_MEASURE_REPORT = 39,
823         MFIE_TYPE_QUIET = 40,
824         MFIE_TYPE_IBSS_DFS = 41,
825         MFIE_TYPE_ERP = 42,
826         MFIE_TYPE_HT_CAP = 45,
827         MFIE_TYPE_RSN = 48,
828         MFIE_TYPE_RATES_EX = 50,
829         MFIE_TYPE_HT_INFO = 61,
830         MFIE_TYPE_AIRONET = 133,
831         MFIE_TYPE_GENERIC = 221,
832         MFIE_TYPE_QOS_PARAMETER = 222,
833 };
834
835 /* Minimal header; can be used for passing 802.11 frames with sufficient
836  * information to determine what type of underlying data type is actually
837  * stored in the data.
838  */
839 struct rtllib_pspoll_hdr {
840         __le16 frame_ctl;
841         __le16 aid;
842         u8 bssid[ETH_ALEN];
843         u8 ta[ETH_ALEN];
844 } __packed;
845
846 struct rtllib_hdr {
847         __le16 frame_ctl;
848         __le16 duration_id;
849         u8 payload[0];
850 } __packed;
851
852 struct rtllib_hdr_1addr {
853         __le16 frame_ctl;
854         __le16 duration_id;
855         u8 addr1[ETH_ALEN];
856         u8 payload[0];
857 } __packed;
858
859 struct rtllib_hdr_2addr {
860         __le16 frame_ctl;
861         __le16 duration_id;
862         u8 addr1[ETH_ALEN];
863         u8 addr2[ETH_ALEN];
864         u8 payload[0];
865 } __packed;
866
867 struct rtllib_hdr_3addr {
868         __le16 frame_ctl;
869         __le16 duration_id;
870         u8 addr1[ETH_ALEN];
871         u8 addr2[ETH_ALEN];
872         u8 addr3[ETH_ALEN];
873         __le16 seq_ctl;
874         u8 payload[0];
875 } __packed;
876
877 struct rtllib_hdr_4addr {
878         __le16 frame_ctl;
879         __le16 duration_id;
880         u8 addr1[ETH_ALEN];
881         u8 addr2[ETH_ALEN];
882         u8 addr3[ETH_ALEN];
883         __le16 seq_ctl;
884         u8 addr4[ETH_ALEN];
885         u8 payload[0];
886 } __packed;
887
888 struct rtllib_hdr_3addrqos {
889         __le16 frame_ctl;
890         __le16 duration_id;
891         u8 addr1[ETH_ALEN];
892         u8 addr2[ETH_ALEN];
893         u8 addr3[ETH_ALEN];
894         __le16 seq_ctl;
895         __le16 qos_ctl;
896         u8 payload[0];
897 } __packed;
898
899 struct rtllib_hdr_4addrqos {
900         __le16 frame_ctl;
901         __le16 duration_id;
902         u8 addr1[ETH_ALEN];
903         u8 addr2[ETH_ALEN];
904         u8 addr3[ETH_ALEN];
905         __le16 seq_ctl;
906         u8 addr4[ETH_ALEN];
907         __le16 qos_ctl;
908         u8 payload[0];
909 } __packed;
910
911 struct rtllib_info_element {
912         u8 id;
913         u8 len;
914         u8 data[0];
915 } __packed;
916
917 struct rtllib_authentication {
918         struct rtllib_hdr_3addr header;
919         __le16 algorithm;
920         __le16 transaction;
921         __le16 status;
922         /*challenge*/
923         struct rtllib_info_element info_element[0];
924 } __packed;
925
926 struct rtllib_disauth {
927         struct rtllib_hdr_3addr header;
928         __le16 reason;
929 } __packed;
930
931 struct rtllib_disassoc {
932         struct rtllib_hdr_3addr header;
933         __le16 reason;
934 } __packed;
935
936 struct rtllib_probe_request {
937         struct rtllib_hdr_3addr header;
938         /* SSID, supported rates */
939         struct rtllib_info_element info_element[0];
940 } __packed;
941
942 struct rtllib_probe_response {
943         struct rtllib_hdr_3addr header;
944         u32 time_stamp[2];
945         __le16 beacon_interval;
946         __le16 capability;
947         /* SSID, supported rates, FH params, DS params,
948          * CF params, IBSS params, TIM (if beacon), RSN
949          */
950         struct rtllib_info_element info_element[0];
951 } __packed;
952
953 /* Alias beacon for probe_response */
954 #define rtllib_beacon rtllib_probe_response
955
956 struct rtllib_assoc_request_frame {
957         struct rtllib_hdr_3addr header;
958         __le16 capability;
959         __le16 listen_interval;
960         /* SSID, supported rates, RSN */
961         struct rtllib_info_element info_element[0];
962 } __packed;
963
964 struct rtllib_assoc_response_frame {
965         struct rtllib_hdr_3addr header;
966         __le16 capability;
967         __le16 status;
968         __le16 aid;
969         struct rtllib_info_element info_element[0]; /* supported rates */
970 } __packed;
971
972 struct rtllib_txb {
973         u8 nr_frags;
974         u8 encrypted;
975         u8 queue_index;
976         u8 rts_included;
977         u16 reserved;
978         __le16 frag_size;
979         __le16 payload_size;
980         struct sk_buff *fragments[0];
981 };
982
983 #define MAX_SUBFRAME_COUNT                64
984 struct rtllib_rxb {
985         u8 nr_subframes;
986         struct sk_buff *subframes[MAX_SUBFRAME_COUNT];
987         u8 dst[ETH_ALEN];
988         u8 src[ETH_ALEN];
989 } __packed;
990
991 union frameqos {
992         u16 shortdata;
993         u8  chardata[2];
994         struct {
995                 u16 tid:4;
996                 u16 eosp:1;
997                 u16 ack_policy:2;
998                 u16 reserved:1;
999                 u16 txop:8;
1000         } field;
1001 };
1002
1003 /* MAX_RATES_LENGTH needs to be 12.  The spec says 8, and many APs
1004  * only use 8, and then use extended rates for the remaining supported
1005  * rates.  Other APs, however, stick all of their supported rates on the
1006  * main rates information element...
1007  */
1008 #define MAX_RATES_LENGTH                  ((u8)12)
1009 #define MAX_RATES_EX_LENGTH            ((u8)16)
1010 #define MAX_NETWORK_COUNT                 96
1011
1012 #define MAX_CHANNEL_NUMBER               161
1013 #define RTLLIB_SOFTMAC_SCAN_TIME           100
1014 #define RTLLIB_SOFTMAC_ASSOC_RETRY_TIME (HZ * 2)
1015
1016 #define MAX_WPA_IE_LEN 64
1017 #define MAX_WZC_IE_LEN 256
1018
1019 #define NETWORK_EMPTY_ESSID (1<<0)
1020 #define NETWORK_HAS_OFDM    (1<<1)
1021 #define NETWORK_HAS_CCK     (1<<2)
1022
1023 /* QoS structure */
1024 #define NETWORK_HAS_QOS_PARAMETERS      (1<<3)
1025 #define NETWORK_HAS_QOS_INFORMATION     (1<<4)
1026 #define NETWORK_HAS_QOS_MASK        (NETWORK_HAS_QOS_PARAMETERS | \
1027                                          NETWORK_HAS_QOS_INFORMATION)
1028 /* 802.11h */
1029 #define NETWORK_HAS_ERP_VALUE      (1<<10)
1030
1031 #define QOS_QUEUE_NUM              4
1032 #define QOS_OUI_LEN                  3
1033 #define QOS_OUI_TYPE                2
1034 #define QOS_ELEMENT_ID            221
1035 #define QOS_OUI_INFO_SUB_TYPE      0
1036 #define QOS_OUI_PARAM_SUB_TYPE    1
1037 #define QOS_VERSION_1              1
1038
1039 struct rtllib_qos_information_element {
1040         u8 elementID;
1041         u8 length;
1042         u8 qui[QOS_OUI_LEN];
1043         u8 qui_type;
1044         u8 qui_subtype;
1045         u8 version;
1046         u8 ac_info;
1047 } __packed;
1048
1049 struct rtllib_qos_ac_parameter {
1050         u8 aci_aifsn;
1051         u8 ecw_min_max;
1052         __le16 tx_op_limit;
1053 } __packed;
1054
1055 struct rtllib_qos_parameter_info {
1056         struct rtllib_qos_information_element info_element;
1057         u8 reserved;
1058         struct rtllib_qos_ac_parameter ac_params_record[QOS_QUEUE_NUM];
1059 } __packed;
1060
1061 struct rtllib_qos_parameters {
1062         __le16 cw_min[QOS_QUEUE_NUM];
1063         __le16 cw_max[QOS_QUEUE_NUM];
1064         u8 aifs[QOS_QUEUE_NUM];
1065         u8 flag[QOS_QUEUE_NUM];
1066         __le16 tx_op_limit[QOS_QUEUE_NUM];
1067 } __packed;
1068
1069 struct rtllib_qos_data {
1070         struct rtllib_qos_parameters parameters;
1071         unsigned int wmm_acm;
1072         int active;
1073         int supported;
1074         u8 param_count;
1075         u8 old_param_count;
1076 };
1077
1078 struct rtllib_tim_parameters {
1079         u8 tim_count;
1080         u8 tim_period;
1081 } __packed;
1082
1083 struct rtllib_wmm_ac_param {
1084         u8 ac_aci_acm_aifsn;
1085         u8 ac_ecwmin_ecwmax;
1086         u16 ac_txop_limit;
1087 };
1088
1089 enum eap_type {
1090         EAP_PACKET = 0,
1091         EAPOL_START,
1092         EAPOL_LOGOFF,
1093         EAPOL_KEY,
1094         EAPOL_ENCAP_ASF_ALERT
1095 };
1096
1097 static const char * const eap_types[] = {
1098         [EAP_PACKET]            = "EAP-Packet",
1099         [EAPOL_START]           = "EAPOL-Start",
1100         [EAPOL_LOGOFF]          = "EAPOL-Logoff",
1101         [EAPOL_KEY]             = "EAPOL-Key",
1102         [EAPOL_ENCAP_ASF_ALERT] = "EAPOL-Encap-ASF-Alert"
1103 };
1104
1105 static inline const char *eap_get_type(int type)
1106 {
1107         return ((u32)type >= ARRAY_SIZE(eap_types)) ? "Unknown" :
1108                  eap_types[type];
1109 }
1110 static inline u8 Frame_QoSTID(u8 *buf)
1111 {
1112         struct rtllib_hdr_3addr *hdr;
1113         u16 fc;
1114
1115         hdr = (struct rtllib_hdr_3addr *)buf;
1116         fc = le16_to_cpu(hdr->frame_ctl);
1117         return (u8)((union frameqos *)(buf + (((fc & RTLLIB_FCTL_TODS) &&
1118                     (fc & RTLLIB_FCTL_FROMDS)) ? 30 : 24)))->field.tid;
1119 }
1120
1121
1122 struct eapol {
1123         u8 snap[6];
1124         u16 ethertype;
1125         u8 version;
1126         u8 type;
1127         u16 length;
1128 } __packed;
1129
1130 struct rtllib_softmac_stats {
1131         unsigned int rx_ass_ok;
1132         unsigned int rx_ass_err;
1133         unsigned int rx_probe_rq;
1134         unsigned int tx_probe_rs;
1135         unsigned int tx_beacons;
1136         unsigned int rx_auth_rq;
1137         unsigned int rx_auth_rs_ok;
1138         unsigned int rx_auth_rs_err;
1139         unsigned int tx_auth_rq;
1140         unsigned int no_auth_rs;
1141         unsigned int no_ass_rs;
1142         unsigned int tx_ass_rq;
1143         unsigned int rx_ass_rq;
1144         unsigned int tx_probe_rq;
1145         unsigned int reassoc;
1146         unsigned int swtxstop;
1147         unsigned int swtxawake;
1148         unsigned char CurrentShowTxate;
1149         unsigned char last_packet_rate;
1150         unsigned int txretrycount;
1151 };
1152
1153 /* These are the data types that can make up management packets
1154  *
1155  * u16 auth_algorithm;
1156  * u16 auth_sequence;
1157  * u16 beacon_interval;
1158  * u16 capability;
1159  * u8 current_ap[ETH_ALEN];
1160  * u16 listen_interval;
1161  * struct {
1162  *   u16 association_id:14, reserved:2;
1163  * } __packed;
1164  * u32 time_stamp[2];
1165  * u16 reason;
1166  * u16 status;
1167  */
1168
1169 #define RTLLIB_DEFAULT_TX_ESSID "Penguin"
1170 #define RTLLIB_DEFAULT_BASIC_RATE 2
1171
1172 enum {WMM_all_frame, WMM_two_frame, WMM_four_frame, WMM_six_frame};
1173 #define MAX_SP_Len  (WMM_all_frame << 4)
1174 #define RTLLIB_QOS_TID 0x0f
1175 #define QOS_CTL_NOTCONTAIN_ACK (0x01 << 5)
1176
1177 #define RTLLIB_DTIM_MBCAST 4
1178 #define RTLLIB_DTIM_UCAST 2
1179 #define RTLLIB_DTIM_VALID 1
1180 #define RTLLIB_DTIM_INVALID 0
1181
1182 #define RTLLIB_PS_DISABLED 0
1183 #define RTLLIB_PS_UNICAST RTLLIB_DTIM_UCAST
1184 #define RTLLIB_PS_MBCAST RTLLIB_DTIM_MBCAST
1185
1186 #define WME_AC_BK   0x00
1187 #define WME_AC_BE   0x01
1188 #define WME_AC_VI   0x02
1189 #define WME_AC_VO   0x03
1190 #define WME_ACI_MASK 0x03
1191 #define WME_AIFSN_MASK 0x03
1192 #define WME_AC_PRAM_LEN 16
1193
1194 #define MAX_RECEIVE_BUFFER_SIZE 9100
1195
1196 #define UP2AC(up) (                \
1197         ((up) < 1) ? WME_AC_BE : \
1198         ((up) < 3) ? WME_AC_BK : \
1199         ((up) < 4) ? WME_AC_BE : \
1200         ((up) < 6) ? WME_AC_VI : \
1201         WME_AC_VO)
1202
1203 #define ETHER_ADDR_LEN          6       /* length of an Ethernet address */
1204 #define ETHERNET_HEADER_SIZE    14      /* length of two Ethernet address
1205                                          * plus ether type*/
1206
1207 struct  ether_header {
1208         u8 ether_dhost[ETHER_ADDR_LEN];
1209         u8 ether_shost[ETHER_ADDR_LEN];
1210         u16 ether_type;
1211 } __packed;
1212
1213 enum erp_t {
1214         ERP_NonERPpresent       = 0x01,
1215         ERP_UseProtection       = 0x02,
1216         ERP_BarkerPreambleMode = 0x04,
1217 };
1218
1219 struct rtllib_network {
1220         /* These entries are used to identify a unique network */
1221         u8 bssid[ETH_ALEN];
1222         u8 channel;
1223         /* Ensure null-terminated for any debug msgs */
1224         u8 ssid[IW_ESSID_MAX_SIZE + 1];
1225         u8 ssid_len;
1226         u8 hidden_ssid[IW_ESSID_MAX_SIZE + 1];
1227         u8 hidden_ssid_len;
1228         struct rtllib_qos_data qos_data;
1229
1230         bool    bWithAironetIE;
1231         bool    bCkipSupported;
1232         bool    bCcxRmEnable;
1233         u16     CcxRmState[2];
1234         bool    bMBssidValid;
1235         u8      MBssidMask;
1236         u8      MBssid[ETH_ALEN];
1237         bool    bWithCcxVerNum;
1238         u8      BssCcxVerNumber;
1239         /* These are network statistics */
1240         struct rtllib_rx_stats stats;
1241         u16 capability;
1242         u8  rates[MAX_RATES_LENGTH];
1243         u8  rates_len;
1244         u8  rates_ex[MAX_RATES_EX_LENGTH];
1245         u8  rates_ex_len;
1246         unsigned long last_scanned;
1247         u8  mode;
1248         u32 flags;
1249         u32 time_stamp[2];
1250         u16 beacon_interval;
1251         u16 listen_interval;
1252         u16 atim_window;
1253         u8  erp_value;
1254         u8  wpa_ie[MAX_WPA_IE_LEN];
1255         size_t wpa_ie_len;
1256         u8  rsn_ie[MAX_WPA_IE_LEN];
1257         size_t rsn_ie_len;
1258         u8  wzc_ie[MAX_WZC_IE_LEN];
1259         size_t wzc_ie_len;
1260
1261         struct rtllib_tim_parameters tim;
1262         u8  dtim_period;
1263         u8  dtim_data;
1264         u64 last_dtim_sta_time;
1265
1266         u8 wmm_info;
1267         struct rtllib_wmm_ac_param wmm_param[4];
1268         u8 Turbo_Enable;
1269         u16 CountryIeLen;
1270         u8 CountryIeBuf[MAX_IE_LEN];
1271         struct bss_ht bssht;
1272         bool broadcom_cap_exist;
1273         bool realtek_cap_exit;
1274         bool marvell_cap_exist;
1275         bool ralink_cap_exist;
1276         bool atheros_cap_exist;
1277         bool cisco_cap_exist;
1278         bool airgo_cap_exist;
1279         bool unknown_cap_exist;
1280         bool    berp_info_valid;
1281         bool buseprotection;
1282         u8 SignalStrength;
1283         u8 RSSI;
1284         struct list_head list;
1285 };
1286
1287 enum rtllib_state {
1288
1289         /* the card is not linked at all */
1290         RTLLIB_NOLINK = 0,
1291
1292         /* RTLLIB_ASSOCIATING* are for BSS client mode
1293          * the driver shall not perform RX filtering unless
1294          * the state is LINKED.
1295          * The driver shall just check for the state LINKED and
1296          * defaults to NOLINK for ALL the other states (including
1297          * LINKED_SCANNING)
1298          */
1299
1300         /* the association procedure will start (wq scheduling)*/
1301         RTLLIB_ASSOCIATING,
1302         RTLLIB_ASSOCIATING_RETRY,
1303
1304         /* the association procedure is sending AUTH request*/
1305         RTLLIB_ASSOCIATING_AUTHENTICATING,
1306
1307         /* the association procedure has successfully authenticated
1308          * and is sending association request
1309          */
1310         RTLLIB_ASSOCIATING_AUTHENTICATED,
1311
1312         /* the link is ok. the card associated to a BSS or linked
1313          * to a ibss cell or acting as an AP and creating the bss
1314          */
1315         RTLLIB_LINKED,
1316
1317         /* same as LINKED, but the driver shall apply RX filter
1318          * rules as we are in NO_LINK mode. As the card is still
1319          * logically linked, but it is doing a syncro site survey
1320          * then it will be back to LINKED state.
1321          */
1322         RTLLIB_LINKED_SCANNING,
1323 };
1324
1325 #define DEFAULT_MAX_SCAN_AGE (15 * HZ)
1326 #define DEFAULT_FTS 2346
1327
1328 #define CFG_RTLLIB_RESERVE_FCS (1<<0)
1329 #define CFG_RTLLIB_COMPUTE_FCS (1<<1)
1330
1331 struct tx_pending {
1332         int frag;
1333         struct rtllib_txb *txb;
1334 };
1335
1336 struct bandwidth_autoswitch {
1337         long threshold_20Mhzto40Mhz;
1338         long    threshold_40Mhzto20Mhz;
1339         bool bforced_tx20Mhz;
1340         bool bautoswitch_enable;
1341 };
1342
1343
1344
1345 #define REORDER_WIN_SIZE        128
1346 #define REORDER_ENTRY_NUM       128
1347 struct rx_reorder_entry {
1348         struct list_head        List;
1349         u16                     SeqNum;
1350         struct rtllib_rxb *prxb;
1351 };
1352 enum fsync_state {
1353         Default_Fsync,
1354         HW_Fsync,
1355         SW_Fsync
1356 };
1357
1358 enum rt_ps_mode {
1359         eActive,
1360         eMaxPs,
1361         eFastPs,
1362         eAutoPs,
1363 };
1364
1365 enum ips_callback_function {
1366         IPS_CALLBACK_NONE = 0,
1367         IPS_CALLBACK_MGNT_LINK_REQUEST = 1,
1368         IPS_CALLBACK_JOIN_REQUEST = 2,
1369 };
1370
1371 enum rt_rf_power_state {
1372         eRfOn,
1373         eRfSleep,
1374         eRfOff
1375 };
1376
1377 struct rt_pwr_save_ctrl {
1378
1379         bool                            bInactivePs;
1380         bool                            bIPSModeBackup;
1381         bool                            bSwRfProcessing;
1382         enum rt_rf_power_state eInactivePowerState;
1383         enum ips_callback_function ReturnPoint;
1384
1385         bool                            bLeisurePs;
1386         u8                              LpsIdleCount;
1387         u8                              RegMaxLPSAwakeIntvl;
1388         u8                              LPSAwakeIntvl;
1389
1390         u32                             CurPsLevel;
1391         u32                             RegRfPsLevel;
1392
1393         bool                            bFwCtrlLPS;
1394
1395 };
1396
1397 #define RT_RF_CHANGE_SOURCE u32
1398
1399 #define RF_CHANGE_BY_SW BIT31
1400 #define RF_CHANGE_BY_HW BIT30
1401 #define RF_CHANGE_BY_PS BIT29
1402 #define RF_CHANGE_BY_IPS BIT28
1403 #define RF_CHANGE_BY_INIT       0
1404
1405 enum country_code_type {
1406         COUNTRY_CODE_FCC = 0,
1407         COUNTRY_CODE_IC = 1,
1408         COUNTRY_CODE_ETSI = 2,
1409         COUNTRY_CODE_SPAIN = 3,
1410         COUNTRY_CODE_FRANCE = 4,
1411         COUNTRY_CODE_MKK = 5,
1412         COUNTRY_CODE_MKK1 = 6,
1413         COUNTRY_CODE_ISRAEL = 7,
1414         COUNTRY_CODE_TELEC = 8,
1415         COUNTRY_CODE_MIC = 9,
1416         COUNTRY_CODE_GLOBAL_DOMAIN = 10,
1417         COUNTRY_CODE_WORLD_WIDE_13 = 11,
1418         COUNTRY_CODE_TELEC_NETGEAR = 12,
1419         COUNTRY_CODE_MAX
1420 };
1421
1422 enum scan_op_backup_opt {
1423         SCAN_OPT_BACKUP = 0,
1424         SCAN_OPT_RESTORE,
1425         SCAN_OPT_MAX
1426 };
1427
1428 enum fw_cmd_io_type {
1429         FW_CMD_DIG_ENABLE = 0,
1430         FW_CMD_DIG_DISABLE = 1,
1431         FW_CMD_DIG_HALT = 2,
1432         FW_CMD_DIG_RESUME = 3,
1433         FW_CMD_HIGH_PWR_ENABLE = 4,
1434         FW_CMD_HIGH_PWR_DISABLE = 5,
1435         FW_CMD_RA_RESET = 6,
1436         FW_CMD_RA_ACTIVE = 7,
1437         FW_CMD_RA_REFRESH_N = 8,
1438         FW_CMD_RA_REFRESH_BG = 9,
1439         FW_CMD_RA_INIT = 10,
1440         FW_CMD_IQK_ENABLE = 11,
1441         FW_CMD_TXPWR_TRACK_ENABLE = 12,
1442         FW_CMD_TXPWR_TRACK_DISABLE = 13,
1443         FW_CMD_TXPWR_TRACK_THERMAL = 14,
1444         FW_CMD_PAUSE_DM_BY_SCAN = 15,
1445         FW_CMD_RESUME_DM_BY_SCAN = 16,
1446         FW_CMD_RA_REFRESH_N_COMB = 17,
1447         FW_CMD_RA_REFRESH_BG_COMB = 18,
1448         FW_CMD_ANTENNA_SW_ENABLE = 19,
1449         FW_CMD_ANTENNA_SW_DISABLE = 20,
1450         FW_CMD_TX_FEEDBACK_CCX_ENABLE = 21,
1451         FW_CMD_LPS_ENTER = 22,
1452         FW_CMD_LPS_LEAVE = 23,
1453 };
1454
1455 #define RT_MAX_LD_SLOT_NUM      10
1456 struct rt_link_detect {
1457
1458         u32                             NumRecvBcnInPeriod;
1459         u32                             NumRecvDataInPeriod;
1460
1461         u32                             RxBcnNum[RT_MAX_LD_SLOT_NUM];
1462         u32                             RxDataNum[RT_MAX_LD_SLOT_NUM];
1463         u16                             SlotNum;
1464         u16                             SlotIndex;
1465
1466         u32                             NumTxOkInPeriod;
1467         u32                             NumRxOkInPeriod;
1468         u32                             NumRxUnicastOkInPeriod;
1469         bool                            bBusyTraffic;
1470         bool                            bHigherBusyTraffic;
1471         bool                            bHigherBusyRxTraffic;
1472 };
1473
1474 struct sw_cam_table {
1475
1476         u8                              macaddr[ETH_ALEN];
1477         bool                            bused;
1478         u8                              key_buf[16];
1479         u16                             key_type;
1480         u8                              useDK;
1481         u8                              key_index;
1482
1483 };
1484 #define   TOTAL_CAM_ENTRY                               32
1485 struct rate_adaptive {
1486         u8                              rate_adaptive_disabled;
1487         u8                              ratr_state;
1488         u16                             reserve;
1489
1490         u32                             high_rssi_thresh_for_ra;
1491         u32                             high2low_rssi_thresh_for_ra;
1492         u8                              low2high_rssi_thresh_for_ra40M;
1493         u32                             low_rssi_thresh_for_ra40M;
1494         u8                              low2high_rssi_thresh_for_ra20M;
1495         u32                             low_rssi_thresh_for_ra20M;
1496         u32                             upper_rssi_threshold_ratr;
1497         u32                             middle_rssi_threshold_ratr;
1498         u32                             low_rssi_threshold_ratr;
1499         u32                             low_rssi_threshold_ratr_40M;
1500         u32                             low_rssi_threshold_ratr_20M;
1501         u8                              ping_rssi_enable;
1502         u32                             ping_rssi_ratr;
1503         u32                             ping_rssi_thresh_for_ra;
1504         u32                             last_ratr;
1505         u8                              PreRATRState;
1506
1507 };
1508
1509 #define NUM_PMKID_CACHE         16
1510 struct rt_pmkid_list {
1511         u8 Bssid[ETH_ALEN];
1512         u8 PMKID[16];
1513         u8 SsidBuf[33];
1514         u8 bUsed;
1515 };
1516
1517 struct rt_intel_promisc_mode {
1518         bool bPromiscuousOn;
1519         bool bFilterSourceStationFrame;
1520 };
1521
1522
1523 /*************** DRIVER STATUS   *****/
1524 #define STATUS_SCANNING                 0
1525 /*************** DRIVER STATUS   *****/
1526
1527 enum {
1528         LPS_IS_WAKE = 0,
1529         LPS_IS_SLEEP = 1,
1530         LPS_WAIT_NULL_DATA_SEND = 2,
1531 };
1532
1533 struct rtllib_device {
1534         struct pci_dev *pdev;
1535         struct net_device *dev;
1536         struct rtllib_security sec;
1537
1538         bool disable_mgnt_queue;
1539
1540         unsigned long status;
1541         short hwscan_ch_bk;
1542         u8 hwscan_sem_up;
1543         u8      CntAfterLink;
1544
1545         enum rt_op_mode OpMode;
1546
1547         /* The last AssocReq/Resp IEs */
1548         u8 *assocreq_ies, *assocresp_ies;
1549         size_t assocreq_ies_len, assocresp_ies_len;
1550
1551         bool    bForcedBgMode;
1552         u8 RF_Type;
1553
1554         u8 hwsec_active;
1555         bool is_silent_reset;
1556         bool is_roaming;
1557         bool ieee_up;
1558         bool cannot_notify;
1559         bool bSupportRemoteWakeUp;
1560         enum rt_ps_mode dot11PowerSaveMode;
1561         bool actscanning;
1562         bool FirstIe_InScan;
1563         bool be_scan_inprogress;
1564         bool beinretry;
1565         enum rt_rf_power_state eRFPowerState;
1566         RT_RF_CHANGE_SOURCE     RfOffReason;
1567         bool is_set_key;
1568         bool wx_set_enc;
1569         struct rt_hi_throughput *pHTInfo;
1570         spinlock_t bw_spinlock;
1571
1572         spinlock_t reorder_spinlock;
1573         u8      Regdot11HTOperationalRateSet[16];
1574         u8      Regdot11TxHTOperationalRateSet[16];
1575         u8      dot11HTOperationalRateSet[16];
1576         u8      RegHTSuppRateSet[16];
1577         u8      HTCurrentOperaRate;
1578         u8      HTHighestOperaRate;
1579         u8      MinSpaceCfg;
1580         u8      MaxMssDensity;
1581         u8      bTxDisableRateFallBack;
1582         u8      bTxUseDriverAssingedRate;
1583         u8      bTxEnableFwCalcDur;
1584         atomic_t        atm_chnlop;
1585         atomic_t        atm_swbw;
1586
1587         struct list_head                Tx_TS_Admit_List;
1588         struct list_head                Tx_TS_Pending_List;
1589         struct list_head                Tx_TS_Unused_List;
1590         struct tx_ts_record TxTsRecord[TOTAL_TS_NUM];
1591         struct list_head                Rx_TS_Admit_List;
1592         struct list_head                Rx_TS_Pending_List;
1593         struct list_head                Rx_TS_Unused_List;
1594         struct rx_ts_record RxTsRecord[TOTAL_TS_NUM];
1595         struct rx_reorder_entry RxReorderEntry[128];
1596         struct list_head                RxReorder_Unused_List;
1597
1598
1599         /* Bookkeeping structures */
1600         struct net_device_stats stats;
1601         struct rtllib_stats ieee_stats;
1602         struct rtllib_softmac_stats softmac_stats;
1603
1604         /* Probe / Beacon management */
1605         struct list_head network_free_list;
1606         struct list_head network_list;
1607         struct rtllib_network *networks;
1608         int scans;
1609         int scan_age;
1610
1611         int iw_mode; /* operating mode (IW_MODE_*) */
1612         bool bNetPromiscuousMode;
1613         struct rt_intel_promisc_mode IntelPromiscuousModeInfo;
1614
1615         spinlock_t lock;
1616         spinlock_t wpax_suitlist_lock;
1617
1618         int tx_headroom; /* Set to size of any additional room needed at front
1619                           * of allocated Tx SKBs
1620                           */
1621         u32 config;
1622
1623         /* WEP and other encryption related settings at the device level */
1624         int open_wep; /* Set to 1 to allow unencrypted frames */
1625         int auth_mode;
1626         int reset_on_keychange; /* Set to 1 if the HW needs to be reset on
1627                                  * WEP key changes
1628                                  */
1629
1630         /* If the host performs {en,de}cryption, then set to 1 */
1631         int host_encrypt;
1632         int host_decrypt;
1633
1634         int ieee802_1x; /* is IEEE 802.1X used */
1635
1636         /* WPA data */
1637         bool bHalfNMode;
1638         bool bHalfWirelessN24GMode;
1639         int wpa_enabled;
1640         int drop_unencrypted;
1641         int tkip_countermeasures;
1642         int privacy_invoked;
1643         size_t wpa_ie_len;
1644         u8 *wpa_ie;
1645         size_t wps_ie_len;
1646         u8 *wps_ie;
1647         u8 ap_mac_addr[ETH_ALEN];
1648         u16 pairwise_key_type;
1649         u16 group_key_type;
1650
1651         struct lib80211_crypt_info crypt_info;
1652
1653         struct sw_cam_table swcamtable[TOTAL_CAM_ENTRY];
1654
1655         struct rt_pmkid_list PMKIDList[NUM_PMKID_CACHE];
1656
1657         /* Fragmentation structures */
1658         struct rtllib_frag_entry frag_cache[17][RTLLIB_FRAG_CACHE_LEN];
1659         unsigned int frag_next_idx[17];
1660         u16 fts; /* Fragmentation Threshold */
1661 #define DEFAULT_RTS_THRESHOLD 2346U
1662 #define MIN_RTS_THRESHOLD 1
1663 #define MAX_RTS_THRESHOLD 2346U
1664         u16 rts; /* RTS threshold */
1665
1666         /* Association info */
1667         u8 bssid[ETH_ALEN];
1668
1669         /* This stores infos for the current network.
1670          * Either the network we are associated in INFRASTRUCTURE
1671          * or the network that we are creating in MASTER mode.
1672          * ad-hoc is a mixture ;-).
1673          * Note that in infrastructure mode, even when not associated,
1674          * fields bssid and essid may be valid (if wpa_set and essid_set
1675          * are true) as thy carry the value set by the user via iwconfig
1676          */
1677         struct rtllib_network current_network;
1678
1679         enum rtllib_state state;
1680
1681         int short_slot;
1682         int mode;       /* A, B, G */
1683         int modulation; /* CCK, OFDM */
1684         int freq_band;  /* 2.4Ghz, 5.2Ghz, Mixed */
1685
1686         /* used for forcing the ibss workqueue to terminate
1687          * without wait for the syncro scan to terminate
1688          */
1689         short sync_scan_hurryup;
1690         u16 scan_watch_dog;
1691
1692         /* map of allowed channels. 0 is dummy */
1693         void *pDot11dInfo;
1694         bool bGlobalDomain;
1695         u8 active_channel_map[MAX_CHANNEL_NUMBER+1];
1696
1697         u8   IbssStartChnl;
1698         u8   ibss_maxjoin_chal;
1699
1700         int rate;       /* current rate */
1701         int basic_rate;
1702
1703         short active_scan;
1704
1705         /* this contains flags for selectively enable softmac support */
1706         u16 softmac_features;
1707
1708         /* if the sequence control field is not filled by HW */
1709         u16 seq_ctrl[5];
1710
1711         /* association procedure transaction sequence number */
1712         u16 associate_seq;
1713
1714         /* AID for RTXed association responses */
1715         u16 assoc_id;
1716
1717         /* power save mode related*/
1718         u8 ack_tx_to_ieee;
1719         short ps;
1720         short sta_sleep;
1721         int ps_timeout;
1722         int ps_period;
1723         struct tasklet_struct ps_task;
1724         u64 ps_time;
1725         bool polling;
1726
1727         short raw_tx;
1728         /* used if IEEE_SOFTMAC_TX_QUEUE is set */
1729         short queue_stop;
1730         short scanning_continue;
1731         short proto_started;
1732         short proto_stoppping;
1733
1734         struct semaphore wx_sem;
1735         struct semaphore scan_sem;
1736         struct semaphore ips_sem;
1737
1738         spinlock_t mgmt_tx_lock;
1739         spinlock_t beacon_lock;
1740
1741         short beacon_txing;
1742
1743         short wap_set;
1744         short ssid_set;
1745
1746         /* set on initialization */
1747         unsigned int wmm_acm;
1748
1749         /* for discarding duplicated packets in IBSS */
1750         struct list_head ibss_mac_hash[IEEE_IBSS_MAC_HASH_SIZE];
1751
1752         /* for discarding duplicated packets in BSS */
1753         u16 last_rxseq_num[17]; /* rx seq previous per-tid */
1754         u16 last_rxfrag_num[17];/* tx frag previous per-tid */
1755         unsigned long last_packet_time[17];
1756
1757         /* for PS mode */
1758         unsigned long last_rx_ps_time;
1759         bool                    bAwakePktSent;
1760         u8                      LPSDelayCnt;
1761
1762         /* used if IEEE_SOFTMAC_SINGLE_QUEUE is set */
1763         struct sk_buff *mgmt_queue_ring[MGMT_QUEUE_NUM];
1764         int mgmt_queue_head;
1765         int mgmt_queue_tail;
1766         u8 AsocRetryCount;
1767         struct sk_buff_head skb_waitQ[MAX_QUEUE_SIZE];
1768         struct sk_buff_head  skb_aggQ[MAX_QUEUE_SIZE];
1769         u32     sta_edca_param[4];
1770         bool aggregation;
1771         bool enable_rx_imm_BA;
1772
1773         bool    bdynamic_txpower_enable;
1774
1775         bool bCTSToSelfEnable;
1776         u8      CTSToSelfTH;
1777
1778         u32     fsync_time_interval;
1779         u32     fsync_rate_bitmap;
1780         u8      fsync_rssi_threshold;
1781         bool    bfsync_enable;
1782
1783         u8      fsync_multiple_timeinterval;
1784         u32     fsync_firstdiff_ratethreshold;
1785         u32     fsync_seconddiff_ratethreshold;
1786         enum fsync_state fsync_state;
1787         bool            bis_any_nonbepkts;
1788         struct bandwidth_autoswitch bandwidth_auto_switch;
1789         bool FwRWRF;
1790
1791         struct rt_link_detect LinkDetectInfo;
1792         bool bIsAggregateFrame;
1793         struct rt_pwr_save_ctrl PowerSaveControl;
1794
1795         /* used if IEEE_SOFTMAC_TX_QUEUE is set */
1796         struct tx_pending tx_pending;
1797
1798         /* used if IEEE_SOFTMAC_ASSOCIATE is set */
1799         struct timer_list associate_timer;
1800
1801         /* used if IEEE_SOFTMAC_BEACONS is set */
1802         struct timer_list beacon_timer;
1803         u8 need_sw_enc;
1804         struct work_struct associate_complete_wq;
1805         struct work_struct ips_leave_wq;
1806         struct delayed_work associate_procedure_wq;
1807         struct delayed_work softmac_scan_wq;
1808         struct delayed_work softmac_hint11d_wq;
1809         struct delayed_work associate_retry_wq;
1810         struct delayed_work start_ibss_wq;
1811         struct delayed_work hw_wakeup_wq;
1812         struct delayed_work hw_sleep_wq;
1813         struct delayed_work link_change_wq;
1814         struct work_struct wx_sync_scan_wq;
1815
1816         struct workqueue_struct *wq;
1817         union {
1818                 struct rtllib_rxb *RfdArray[REORDER_WIN_SIZE];
1819                 struct rtllib_rxb *stats_IndicateArray[REORDER_WIN_SIZE];
1820                 struct rtllib_rxb *prxbIndicateArray[REORDER_WIN_SIZE];
1821                 struct {
1822                         struct sw_chnl_cmd PreCommonCmd[MAX_PRECMD_CNT];
1823                         struct sw_chnl_cmd PostCommonCmd[MAX_POSTCMD_CNT];
1824                         struct sw_chnl_cmd RfDependCmd[MAX_RFDEPENDCMD_CNT];
1825                 };
1826         };
1827
1828         /* Callback functions */
1829         void (*set_security)(struct net_device *dev,
1830                              struct rtllib_security *sec);
1831
1832         /* Used to TX data frame by using txb structs.
1833          * this is not used if in the softmac_features
1834          * is set the flag IEEE_SOFTMAC_TX_QUEUE
1835          */
1836         int (*hard_start_xmit)(struct rtllib_txb *txb,
1837                                struct net_device *dev);
1838
1839         int (*reset_port)(struct net_device *dev);
1840
1841         /* Softmac-generated frames (management) are TXed via this
1842          * callback if the flag IEEE_SOFTMAC_SINGLE_QUEUE is
1843          * not set. As some cards may have different HW queues that
1844          * one might want to use for data and management frames
1845          * the option to have two callbacks might be useful.
1846          * This function can't sleep.
1847          */
1848         int (*softmac_hard_start_xmit)(struct sk_buff *skb,
1849                                struct net_device *dev);
1850
1851         /* used instead of hard_start_xmit (not softmac_hard_start_xmit)
1852          * if the IEEE_SOFTMAC_TX_QUEUE feature is used to TX data
1853          * frames. If the option IEEE_SOFTMAC_SINGLE_QUEUE is also set
1854          * then also management frames are sent via this callback.
1855          * This function can't sleep.
1856          */
1857         void (*softmac_data_hard_start_xmit)(struct sk_buff *skb,
1858                                struct net_device *dev, int rate);
1859
1860         /* stops the HW queue for DATA frames. Useful to avoid
1861          * waste time to TX data frame when we are reassociating
1862          * This function can sleep.
1863          */
1864         void (*data_hard_stop)(struct net_device *dev);
1865
1866         /* OK this is complementing to data_poll_hard_stop */
1867         void (*data_hard_resume)(struct net_device *dev);
1868
1869         /* ask to the driver to retune the radio.
1870          * This function can sleep. the driver should ensure
1871          * the radio has been switched before return.
1872          */
1873         void (*set_chan)(struct net_device *dev, short ch);
1874
1875         void (*rtllib_start_hw_scan)(struct net_device *dev);
1876         void (*rtllib_stop_hw_scan)(struct net_device *dev);
1877
1878         /* indicate the driver that the link state is changed
1879          * for example it may indicate the card is associated now.
1880          * Driver might be interested in this to apply RX filter
1881          * rules or simply light the LINK led
1882          */
1883         void (*link_change)(struct net_device *dev);
1884
1885         /* these two function indicates to the HW when to start
1886          * and stop to send beacons. This is used when the
1887          * IEEE_SOFTMAC_BEACONS is not set. For now the
1888          * stop_send_bacons is NOT guaranteed to be called only
1889          * after start_send_beacons.
1890          */
1891         void (*start_send_beacons)(struct net_device *dev);
1892         void (*stop_send_beacons)(struct net_device *dev);
1893
1894         /* power save mode related */
1895         void (*sta_wake_up)(struct net_device *dev);
1896         void (*enter_sleep_state)(struct net_device *dev, u64 time);
1897         short (*ps_is_queue_empty)(struct net_device *dev);
1898         int (*handle_beacon)(struct net_device *dev,
1899                              struct rtllib_beacon *beacon,
1900                              struct rtllib_network *network);
1901         int (*handle_assoc_response)(struct net_device *dev,
1902                                      struct rtllib_assoc_response_frame *resp,
1903                                      struct rtllib_network *network);
1904
1905
1906         /* check whether Tx hw resource available */
1907         short (*check_nic_enough_desc)(struct net_device *dev, int queue_index);
1908         void (*SetBWModeHandler)(struct net_device *dev,
1909                                  enum ht_channel_width Bandwidth,
1910                                  enum ht_extchnl_offset Offset);
1911         bool (*GetNmodeSupportBySecCfg)(struct net_device *dev);
1912         void (*SetWirelessMode)(struct net_device *dev, u8 wireless_mode);
1913         bool (*GetHalfNmodeSupportByAPsHandler)(struct net_device *dev);
1914         u8   (*rtllib_ap_sec_type)(struct rtllib_device *ieee);
1915         void (*InitialGainHandler)(struct net_device *dev, u8 Operation);
1916         bool (*SetFwCmdHandler)(struct net_device *dev,
1917                                 enum fw_cmd_io_type FwCmdIO);
1918         void (*UpdateBeaconInterruptHandler)(struct net_device *dev,
1919                                              bool start);
1920         void (*ScanOperationBackupHandler)(struct net_device *dev,
1921                                            u8 Operation);
1922         void (*LedControlHandler)(struct net_device *dev,
1923                                   enum led_ctl_mode LedAction);
1924         void (*SetHwRegHandler)(struct net_device *dev, u8 variable, u8 *val);
1925
1926         void (*AllowAllDestAddrHandler)(struct net_device *dev,
1927                                         bool bAllowAllDA, bool WriteIntoReg);
1928
1929         void (*rtllib_ips_leave_wq)(struct net_device *dev);
1930         void (*rtllib_ips_leave)(struct net_device *dev);
1931         void (*LeisurePSLeave)(struct net_device *dev);
1932         void (*rtllib_rfkill_poll)(struct net_device *dev);
1933
1934         /* This must be the last item so that it points to the data
1935          * allocated beyond this structure by alloc_rtllib
1936          */
1937         u8 priv[0];
1938 };
1939
1940 #define IEEE_A      (1<<0)
1941 #define IEEE_B      (1<<1)
1942 #define IEEE_G      (1<<2)
1943 #define IEEE_N_24G                (1<<4)
1944 #define IEEE_N_5G                 (1<<5)
1945 #define IEEE_MODE_MASK    (IEEE_A|IEEE_B|IEEE_G)
1946
1947 /* Generate a 802.11 header */
1948
1949 /* Uses the channel change callback directly
1950  * instead of [start/stop] scan callbacks
1951  */
1952 #define IEEE_SOFTMAC_SCAN (1<<2)
1953
1954 /* Perform authentication and association handshake */
1955 #define IEEE_SOFTMAC_ASSOCIATE (1<<3)
1956
1957 /* Generate probe requests */
1958 #define IEEE_SOFTMAC_PROBERQ (1<<4)
1959
1960 /* Generate response to probe requests */
1961 #define IEEE_SOFTMAC_PROBERS (1<<5)
1962
1963 /* The ieee802.11 stack will manage the netif queue
1964  * wake/stop for the driver, taking care of 802.11
1965  * fragmentation. See softmac.c for details.
1966  */
1967 #define IEEE_SOFTMAC_TX_QUEUE (1<<7)
1968
1969 /* Uses only the softmac_data_hard_start_xmit
1970  * even for TX management frames.
1971  */
1972 #define IEEE_SOFTMAC_SINGLE_QUEUE (1<<8)
1973
1974 /* Generate beacons.  The stack will enqueue beacons
1975  * to the card
1976  */
1977 #define IEEE_SOFTMAC_BEACONS (1<<6)
1978
1979
1980 static inline void *rtllib_priv(struct net_device *dev)
1981 {
1982         return ((struct rtllib_device *)netdev_priv(dev))->priv;
1983 }
1984
1985 static inline int rtllib_is_empty_essid(const char *essid, int essid_len)
1986 {
1987         /* Single white space is for Linksys APs */
1988         if (essid_len == 1 && essid[0] == ' ')
1989                 return 1;
1990
1991         /* Otherwise, if the entire essid is 0, we assume it is hidden */
1992         while (essid_len) {
1993                 essid_len--;
1994                 if (essid[essid_len] != '\0')
1995                         return 0;
1996         }
1997
1998         return 1;
1999 }
2000
2001 static inline int rtllib_get_hdrlen(u16 fc)
2002 {
2003         int hdrlen = RTLLIB_3ADDR_LEN;
2004
2005         switch (WLAN_FC_GET_TYPE(fc)) {
2006         case RTLLIB_FTYPE_DATA:
2007                 if ((fc & RTLLIB_FCTL_FROMDS) && (fc & RTLLIB_FCTL_TODS))
2008                         hdrlen = RTLLIB_4ADDR_LEN; /* Addr4 */
2009                 if (RTLLIB_QOS_HAS_SEQ(fc))
2010                         hdrlen += 2; /* QOS ctrl*/
2011                 break;
2012         case RTLLIB_FTYPE_CTL:
2013                 switch (WLAN_FC_GET_STYPE(fc)) {
2014                 case RTLLIB_STYPE_CTS:
2015                 case RTLLIB_STYPE_ACK:
2016                         hdrlen = RTLLIB_1ADDR_LEN;
2017                         break;
2018                 default:
2019                         hdrlen = RTLLIB_2ADDR_LEN;
2020                         break;
2021                 }
2022                 break;
2023         }
2024
2025         return hdrlen;
2026 }
2027
2028 static inline u8 *rtllib_get_payload(struct rtllib_hdr *hdr)
2029 {
2030         switch (rtllib_get_hdrlen(le16_to_cpu(hdr->frame_ctl))) {
2031         case RTLLIB_1ADDR_LEN:
2032                 return ((struct rtllib_hdr_1addr *)hdr)->payload;
2033         case RTLLIB_2ADDR_LEN:
2034                 return ((struct rtllib_hdr_2addr *)hdr)->payload;
2035         case RTLLIB_3ADDR_LEN:
2036                 return ((struct rtllib_hdr_3addr *)hdr)->payload;
2037         case RTLLIB_4ADDR_LEN:
2038                 return ((struct rtllib_hdr_4addr *)hdr)->payload;
2039         }
2040         return NULL;
2041 }
2042
2043 static inline int rtllib_is_ofdm_rate(u8 rate)
2044 {
2045         switch (rate & ~RTLLIB_BASIC_RATE_MASK) {
2046         case RTLLIB_OFDM_RATE_6MB:
2047         case RTLLIB_OFDM_RATE_9MB:
2048         case RTLLIB_OFDM_RATE_12MB:
2049         case RTLLIB_OFDM_RATE_18MB:
2050         case RTLLIB_OFDM_RATE_24MB:
2051         case RTLLIB_OFDM_RATE_36MB:
2052         case RTLLIB_OFDM_RATE_48MB:
2053         case RTLLIB_OFDM_RATE_54MB:
2054                 return 1;
2055         }
2056         return 0;
2057 }
2058
2059 static inline int rtllib_is_cck_rate(u8 rate)
2060 {
2061         switch (rate & ~RTLLIB_BASIC_RATE_MASK) {
2062         case RTLLIB_CCK_RATE_1MB:
2063         case RTLLIB_CCK_RATE_2MB:
2064         case RTLLIB_CCK_RATE_5MB:
2065         case RTLLIB_CCK_RATE_11MB:
2066                 return 1;
2067         }
2068         return 0;
2069 }
2070
2071
2072 /* rtllib.c */
2073 extern void free_rtllib(struct net_device *dev);
2074 extern struct net_device *alloc_rtllib(int sizeof_priv);
2075
2076 /* rtllib_tx.c */
2077
2078 extern int rtllib_encrypt_fragment(
2079         struct rtllib_device *ieee,
2080         struct sk_buff *frag,
2081         int hdr_len);
2082
2083 extern int rtllib_xmit(struct sk_buff *skb,  struct net_device *dev);
2084 extern int rtllib_xmit_inter(struct sk_buff *skb, struct net_device *dev);
2085 extern void rtllib_txb_free(struct rtllib_txb *);
2086
2087 /* rtllib_rx.c */
2088 extern int rtllib_rx(struct rtllib_device *ieee, struct sk_buff *skb,
2089                         struct rtllib_rx_stats *rx_stats);
2090 extern void rtllib_rx_mgt(struct rtllib_device *ieee,
2091                              struct sk_buff *skb,
2092                              struct rtllib_rx_stats *stats);
2093 extern void rtllib_rx_probe_rq(struct rtllib_device *ieee,
2094                            struct sk_buff *skb);
2095 extern int rtllib_legal_channel(struct rtllib_device *rtllib, u8 channel);
2096
2097 /* rtllib_wx.c */
2098 extern int rtllib_wx_get_scan(struct rtllib_device *ieee,
2099                                  struct iw_request_info *info,
2100                                  union iwreq_data *wrqu, char *key);
2101 extern int rtllib_wx_set_encode(struct rtllib_device *ieee,
2102                                    struct iw_request_info *info,
2103                                    union iwreq_data *wrqu, char *key);
2104 extern int rtllib_wx_get_encode(struct rtllib_device *ieee,
2105                                    struct iw_request_info *info,
2106                                    union iwreq_data *wrqu, char *key);
2107 extern int rtllib_wx_set_encode_ext(struct rtllib_device *ieee,
2108                             struct iw_request_info *info,
2109                             union iwreq_data *wrqu, char *extra);
2110 extern int rtllib_wx_set_auth(struct rtllib_device *ieee,
2111                                struct iw_request_info *info,
2112                                struct iw_param *data, char *extra);
2113 extern int rtllib_wx_set_mlme(struct rtllib_device *ieee,
2114                                struct iw_request_info *info,
2115                                union iwreq_data *wrqu, char *extra);
2116 extern int rtllib_wx_set_gen_ie(struct rtllib_device *ieee, u8 *ie, size_t len);
2117
2118 /* rtllib_softmac.c */
2119 extern short rtllib_is_54g(struct rtllib_network *net);
2120 extern int rtllib_rx_frame_softmac(struct rtllib_device *ieee,
2121                                    struct sk_buff *skb,
2122                                    struct rtllib_rx_stats *rx_stats, u16 type,
2123                                    u16 stype);
2124 extern void rtllib_softmac_new_net(struct rtllib_device *ieee,
2125                                    struct rtllib_network *net);
2126
2127 void SendDisassociation(struct rtllib_device *ieee, bool deauth, u16 asRsn);
2128 extern void rtllib_softmac_xmit(struct rtllib_txb *txb,
2129                                 struct rtllib_device *ieee);
2130
2131 extern void rtllib_stop_send_beacons(struct rtllib_device *ieee);
2132 extern void notify_wx_assoc_event(struct rtllib_device *ieee);
2133 extern void rtllib_softmac_check_all_nets(struct rtllib_device *ieee);
2134 extern void rtllib_start_bss(struct rtllib_device *ieee);
2135 extern void rtllib_start_master_bss(struct rtllib_device *ieee);
2136 extern void rtllib_start_ibss(struct rtllib_device *ieee);
2137 extern void rtllib_softmac_init(struct rtllib_device *ieee);
2138 extern void rtllib_softmac_free(struct rtllib_device *ieee);
2139 extern void rtllib_associate_abort(struct rtllib_device *ieee);
2140 extern void rtllib_disassociate(struct rtllib_device *ieee);
2141 extern void rtllib_stop_scan(struct rtllib_device *ieee);
2142 extern bool rtllib_act_scanning(struct rtllib_device *ieee, bool sync_scan);
2143 extern void rtllib_stop_scan_syncro(struct rtllib_device *ieee);
2144 extern void rtllib_start_scan_syncro(struct rtllib_device *ieee, u8 is_mesh);
2145 extern void rtllib_sta_ps_send_null_frame(struct rtllib_device *ieee,
2146                                           short pwr);
2147 extern void rtllib_sta_wakeup(struct rtllib_device *ieee, short nl);
2148 extern void rtllib_sta_ps_send_pspoll_frame(struct rtllib_device *ieee);
2149 extern void rtllib_start_protocol(struct rtllib_device *ieee);
2150 extern void rtllib_stop_protocol(struct rtllib_device *ieee, u8 shutdown);
2151
2152 extern void rtllib_EnableNetMonitorMode(struct net_device *dev,
2153                                         bool bInitState);
2154 extern void rtllib_DisableNetMonitorMode(struct net_device *dev,
2155                                          bool bInitState);
2156 extern void rtllib_EnableIntelPromiscuousMode(struct net_device *dev,
2157                                               bool bInitState);
2158 extern void rtllib_DisableIntelPromiscuousMode(struct net_device *dev,
2159                                                bool bInitState);
2160 extern void rtllib_send_probe_requests(struct rtllib_device *ieee, u8 is_mesh);
2161
2162 extern void rtllib_softmac_stop_protocol(struct rtllib_device *ieee,
2163                                          u8 mesh_flag, u8 shutdown);
2164 extern void rtllib_softmac_start_protocol(struct rtllib_device *ieee,
2165                                           u8 mesh_flag);
2166
2167 extern void rtllib_reset_queue(struct rtllib_device *ieee);
2168 extern void rtllib_wake_all_queues(struct rtllib_device *ieee);
2169 extern void rtllib_stop_all_queues(struct rtllib_device *ieee);
2170 extern struct sk_buff *rtllib_get_beacon(struct rtllib_device *ieee);
2171 extern void rtllib_start_send_beacons(struct rtllib_device *ieee);
2172 extern void rtllib_stop_send_beacons(struct rtllib_device *ieee);
2173 extern int rtllib_wpa_supplicant_ioctl(struct rtllib_device *ieee,
2174                                        struct iw_point *p, u8 is_mesh);
2175
2176 extern void notify_wx_assoc_event(struct rtllib_device *ieee);
2177 extern void rtllib_ps_tx_ack(struct rtllib_device *ieee, short success);
2178
2179 extern void softmac_mgmt_xmit(struct sk_buff *skb,
2180                               struct rtllib_device *ieee);
2181 extern u16 rtllib_query_seqnum(struct rtllib_device *ieee,
2182                                struct sk_buff *skb, u8 *dst);
2183 extern u8 rtllib_ap_sec_type(struct rtllib_device *ieee);
2184
2185 /* rtllib_softmac_wx.c */
2186
2187 extern int rtllib_wx_get_wap(struct rtllib_device *ieee,
2188                              struct iw_request_info *info,
2189                              union iwreq_data *wrqu, char *ext);
2190
2191 extern int rtllib_wx_set_wap(struct rtllib_device *ieee,
2192                              struct iw_request_info *info,
2193                              union iwreq_data *awrq,
2194                              char *extra);
2195
2196 extern int rtllib_wx_get_essid(struct rtllib_device *ieee,
2197                                struct iw_request_info *a,
2198                                union iwreq_data *wrqu, char *b);
2199
2200 extern int rtllib_wx_set_rate(struct rtllib_device *ieee,
2201                               struct iw_request_info *info,
2202                               union iwreq_data *wrqu, char *extra);
2203
2204 extern int rtllib_wx_get_rate(struct rtllib_device *ieee,
2205                               struct iw_request_info *info,
2206                               union iwreq_data *wrqu, char *extra);
2207
2208 extern int rtllib_wx_set_mode(struct rtllib_device *ieee,
2209                               struct iw_request_info *a,
2210                               union iwreq_data *wrqu, char *b);
2211
2212 extern int rtllib_wx_set_scan(struct rtllib_device *ieee,
2213                               struct iw_request_info *a,
2214                               union iwreq_data *wrqu, char *b);
2215
2216 extern int rtllib_wx_set_essid(struct rtllib_device *ieee,
2217                               struct iw_request_info *a,
2218                               union iwreq_data *wrqu, char *extra);
2219
2220 extern int rtllib_wx_get_mode(struct rtllib_device *ieee,
2221                               struct iw_request_info *a,
2222                               union iwreq_data *wrqu, char *b);
2223
2224 extern int rtllib_wx_set_freq(struct rtllib_device *ieee,
2225                               struct iw_request_info *a,
2226                               union iwreq_data *wrqu, char *b);
2227
2228 extern int rtllib_wx_get_freq(struct rtllib_device *ieee,
2229                               struct iw_request_info *a,
2230                               union iwreq_data *wrqu, char *b);
2231 extern void rtllib_wx_sync_scan_wq(void *data);
2232
2233 extern int rtllib_wx_set_rawtx(struct rtllib_device *ieee,
2234                                struct iw_request_info *info,
2235                                union iwreq_data *wrqu, char *extra);
2236
2237 extern int rtllib_wx_get_name(struct rtllib_device *ieee,
2238                              struct iw_request_info *info,
2239                              union iwreq_data *wrqu, char *extra);
2240
2241 extern int rtllib_wx_set_power(struct rtllib_device *ieee,
2242                                  struct iw_request_info *info,
2243                                  union iwreq_data *wrqu, char *extra);
2244
2245 extern int rtllib_wx_get_power(struct rtllib_device *ieee,
2246                                  struct iw_request_info *info,
2247                                  union iwreq_data *wrqu, char *extra);
2248
2249 extern int rtllib_wx_set_rts(struct rtllib_device *ieee,
2250                              struct iw_request_info *info,
2251                              union iwreq_data *wrqu, char *extra);
2252
2253 extern int rtllib_wx_get_rts(struct rtllib_device *ieee,
2254                              struct iw_request_info *info,
2255                              union iwreq_data *wrqu, char *extra);
2256 #define MAX_RECEIVE_BUFFER_SIZE 9100
2257
2258 void HTSetConnectBwMode(struct rtllib_device *ieee,
2259                         enum ht_channel_width Bandwidth,
2260                         enum ht_extchnl_offset Offset);
2261 extern void HTUpdateDefaultSetting(struct rtllib_device *ieee);
2262 extern void HTConstructCapabilityElement(struct rtllib_device *ieee,
2263                                          u8 *posHTCap, u8 *len,
2264                                          u8 isEncrypt, bool bAssoc);
2265 extern void HTConstructInfoElement(struct rtllib_device *ieee,
2266                                    u8 *posHTInfo, u8 *len, u8 isEncrypt);
2267 extern void HTConstructRT2RTAggElement(struct rtllib_device *ieee,
2268                                        u8 *posRT2RTAgg, u8 *len);
2269 extern void HTOnAssocRsp(struct rtllib_device *ieee);
2270 extern void HTInitializeHTInfo(struct rtllib_device *ieee);
2271 extern void HTInitializeBssDesc(struct bss_ht *pBssHT);
2272 extern void HTResetSelfAndSavePeerSetting(struct rtllib_device *ieee,
2273                                           struct rtllib_network *pNetwork);
2274 extern void HT_update_self_and_peer_setting(struct rtllib_device *ieee,
2275                                             struct rtllib_network *pNetwork);
2276 extern u8 HTGetHighestMCSRate(struct rtllib_device *ieee, u8 *pMCSRateSet,
2277                               u8 *pMCSFilter);
2278 extern u8 MCS_FILTER_ALL[];
2279 extern u16 MCS_DATA_RATE[2][2][77];
2280 extern u8 HTCCheck(struct rtllib_device *ieee, u8 *pFrame);
2281 extern void HTResetIOTSetting(struct rt_hi_throughput *pHTInfo);
2282 extern bool IsHTHalfNmodeAPs(struct rtllib_device *ieee);
2283 extern u16 HTMcsToDataRate(struct rtllib_device *ieee, u8 nMcsRate);
2284 extern u16  TxCountToDataRate(struct rtllib_device *ieee, u8 nDataRate);
2285 extern int rtllib_rx_ADDBAReq(struct rtllib_device *ieee, struct sk_buff *skb);
2286 extern int rtllib_rx_ADDBARsp(struct rtllib_device *ieee, struct sk_buff *skb);
2287 extern int rtllib_rx_DELBA(struct rtllib_device *ieee, struct sk_buff *skb);
2288 extern void TsInitAddBA(struct rtllib_device *ieee, struct tx_ts_record *pTS,
2289                         u8 Policy, u8 bOverwritePending);
2290 extern void TsInitDelBA(struct rtllib_device *ieee,
2291                         struct ts_common_info *pTsCommonInfo,
2292                         enum tr_select TxRxSelect);
2293 extern void BaSetupTimeOut(unsigned long data);
2294 extern void TxBaInactTimeout(unsigned long data);
2295 extern void RxBaInactTimeout(unsigned long data);
2296 extern void ResetBaEntry(struct ba_record *pBA);
2297 extern bool GetTs(
2298         struct rtllib_device *ieee,
2299         struct ts_common_info **ppTS,
2300         u8 *Addr,
2301         u8 TID,
2302         enum tr_select TxRxSelect,
2303         bool bAddNewTs
2304 );
2305 extern void TSInitialize(struct rtllib_device *ieee);
2306 extern  void TsStartAddBaProcess(struct rtllib_device *ieee,
2307                                   struct tx_ts_record *pTxTS);
2308 extern void RemovePeerTS(struct rtllib_device *ieee, u8 *Addr);
2309 extern void RemoveAllTS(struct rtllib_device *ieee);
2310 void rtllib_softmac_scan_syncro(struct rtllib_device *ieee, u8 is_mesh);
2311
2312 extern const long rtllib_wlan_frequencies[];
2313
2314 static inline const char *escape_essid(const char *essid, u8 essid_len)
2315 {
2316         static char escaped[IW_ESSID_MAX_SIZE * 2 + 1];
2317
2318         if (rtllib_is_empty_essid(essid, essid_len)) {
2319                 memcpy(escaped, "<hidden>", sizeof("<hidden>"));
2320                 return escaped;
2321         }
2322
2323         snprintf(escaped, sizeof(escaped), "%*pEn", essid_len, essid);
2324         return escaped;
2325 }
2326
2327 /* fun with the built-in rtllib stack... */
2328 bool rtllib_MgntDisconnect(struct rtllib_device *rtllib, u8 asRsn);
2329
2330
2331 /* For the function is more related to hardware setting, it's better to use the
2332  * ieee handler to refer to it.
2333  */
2334 extern void rtllib_update_active_chan_map(struct rtllib_device *ieee);
2335 extern void rtllib_FlushRxTsPendingPkts(struct rtllib_device *ieee,
2336                                         struct rx_ts_record *pTS);
2337 extern int rtllib_parse_info_param(struct rtllib_device *ieee,
2338                 struct rtllib_info_element *info_element,
2339                 u16 length,
2340                 struct rtllib_network *network,
2341                 struct rtllib_rx_stats *stats);
2342
2343 void rtllib_indicate_packets(struct rtllib_device *ieee,
2344                              struct rtllib_rxb **prxbIndicateArray, u8  index);
2345 extern u8 HTFilterMCSRate(struct rtllib_device *ieee, u8 *pSupportMCS,
2346                           u8 *pOperateMCS);
2347 extern void HTUseDefaultSetting(struct rtllib_device *ieee);
2348 #define RT_ASOC_RETRY_LIMIT     5
2349 u8 MgntQuery_TxRateExcludeCCKRates(struct rtllib_device *ieee);
2350 extern void rtllib_TURBO_Info(struct rtllib_device *ieee, u8 **tag_p);
2351 #define SEM_DOWN_IEEE_WX(psem) down(psem)
2352 #define SEM_UP_IEEE_WX(psem) up(psem)
2353
2354 #endif /* RTLLIB_H */