xref: /linux/drivers/staging/rtl8192e/rtllib.h (revision 021bc4b9)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Merged with mainline rtllib.h in Aug 2004.  Original ieee802_11
4  * remains copyright by the original authors
5  *
6  * Portions of the merged code are based on Host AP (software wireless
7  * LAN access point) driver for Intersil Prism2/2.5/3.
8  *
9  * Copyright (c) 2001-2002, SSH Communications Security Corp and Jouni Malinen
10  * <jkmaline@cc.hut.fi>
11  * Copyright (c) 2002-2003, Jouni Malinen <jkmaline@cc.hut.fi>
12  *
13  * Adaption to a generic IEEE 802.11 stack by James Ketrenos
14  * <jketreno@linux.intel.com>
15  * Copyright (c) 2004, Intel Corporation
16  *
17  * Modified for Realtek's wi-fi cards by Andrea Merello
18  * <andrea.merello@gmail.com>
19  */
20 #ifndef RTLLIB_H
21 #define RTLLIB_H
22 #include <linux/if_ether.h> /* ETH_ALEN */
23 #include <linux/kernel.h>   /* ARRAY_SIZE */
24 #include <linux/module.h>
25 #include <linux/interrupt.h>
26 #include <linux/jiffies.h>
27 #include <linux/timer.h>
28 #include <linux/sched.h>
29 #include <linux/mutex.h>
30 
31 #include <linux/delay.h>
32 #include <linux/wireless.h>
33 
34 #include "rtl819x_HT.h"
35 #include "rtl819x_BA.h"
36 #include "rtl819x_TS.h"
37 
38 #include <linux/netdevice.h>
39 #include <linux/if_arp.h> /* ARPHRD_ETHER */
40 #include <net/cfg80211.h>
41 #include <net/lib80211.h>
42 
43 #define MAX_PRECMD_CNT 16
44 #define MAX_RFDEPENDCMD_CNT 16
45 #define MAX_POSTCMD_CNT 16
46 
47 #ifndef WIRELESS_SPY
48 #define WIRELESS_SPY
49 #endif
50 #include <net/iw_handler.h>
51 
52 #ifndef IW_MODE_MONITOR
53 #define IW_MODE_MONITOR 6
54 #endif
55 
56 #ifndef IWEVCUSTOM
57 #define IWEVCUSTOM 0x8c02
58 #endif
59 
60 #ifndef IW_CUSTOM_MAX
61 /* Max number of char in custom event - use multiple of them if needed */
62 #define IW_CUSTOM_MAX	256	/* In bytes */
63 #endif
64 
65 #define container_of_dwork_rsl(x, y, z)				\
66 	container_of(to_delayed_work(x), y, z)
67 
68 static inline void *netdev_priv_rsl(struct net_device *dev)
69 {
70 	return netdev_priv(dev);
71 }
72 
73 #define KEY_TYPE_NA		0x0
74 #define KEY_TYPE_WEP40		0x1
75 #define KEY_TYPE_TKIP		0x2
76 #define KEY_TYPE_CCMP		0x4
77 #define KEY_TYPE_WEP104		0x5
78 /* added for rtl819x tx procedure */
79 #define MAX_QUEUE_SIZE		0x10
80 
81 #define BK_QUEUE			       0
82 #define BE_QUEUE			       1
83 #define VI_QUEUE			       2
84 #define VO_QUEUE			       3
85 #define HCCA_QUEUE			     4
86 #define TXCMD_QUEUE			    5
87 #define MGNT_QUEUE			     6
88 #define HIGH_QUEUE			     7
89 #define BEACON_QUEUE			   8
90 
91 #define IE_CISCO_FLAG_POSITION		0x08
92 #define SUPPORT_CKIP_MIC			0x08
93 #define SUPPORT_CKIP_PK			0x10
94 #define	RT_RF_OFF_LEVL_HALT_NIC		BIT(3)
95 #define	RT_IN_PS_LEVEL(psc, _PS_FLAG)		\
96 	((psc->CurPsLevel & _PS_FLAG) ? true : false)
97 #define	RT_CLEAR_PS_LEVEL(psc, _PS_FLAG)	\
98 	(psc->CurPsLevel &= (~(_PS_FLAG)))
99 
100 /* defined for skb cb field */
101 /* At most 28 byte */
102 struct cb_desc {
103 	/* Tx Desc Related flags (8-9) */
104 	u8 bLastIniPkt:1;
105 	u8 bCmdOrInit:1;
106 	u8 tx_dis_rate_fallback:1;
107 	u8 tx_use_drv_assinged_rate:1;
108 	u8 bHwSec:1;
109 
110 	u8 nStuckCount;
111 
112 	/* Tx Firmware Related flags (10-11)*/
113 	u8 bCTSEnable:1;
114 	u8 bRTSEnable:1;
115 	u8 bUseShortGI:1;
116 	u8 bUseShortPreamble:1;
117 	u8 tx_enable_fw_calc_dur:1;
118 	u8 ampdu_enable:1;
119 	u8 bRTSSTBC:1;
120 	u8 RTSSC:1;
121 
122 	u8 bRTSBW:1;
123 	u8 bPacketBW:1;
124 	u8 bRTSUseShortPreamble:1;
125 	u8 bRTSUseShortGI:1;
126 	u8 bMulticast:1;
127 	u8 bBroadcast:1;
128 	u8 drv_agg_enable:1;
129 	u8 reserved2:1;
130 
131 	/* Tx Desc related element(12-19) */
132 	u8 rata_index;
133 	u8 queue_index;
134 	u16 txbuf_size;
135 	u8 ratr_index;
136 	u8 bAMSDU:1;
137 	u8 bFromAggrQ:1;
138 	u8 reserved6:6;
139 	u8 priority;
140 
141 	/* Tx firmware related element(20-27) */
142 	u8 data_rate;
143 	u8 rts_rate;
144 	u8 ampdu_factor;
145 	u8 ampdu_density;
146 	u8 DrvAggrNum;
147 	u8 bdhcp;
148 	u16 pkt_size;
149 	u8 bIsSpecialDataFrame;
150 
151 	u8 bBTTxPacket;
152 	u8 bIsBTProbRsp;
153 };
154 
155 enum sw_chnl_cmd_id {
156 	CmdID_End,
157 	CmdID_SetTxPowerLevel,
158 	CmdID_BBRegWrite10,
159 	CmdID_WritePortUlong,
160 	CmdID_WritePortUshort,
161 	CmdID_WritePortUchar,
162 	CmdID_RF_WriteReg,
163 };
164 
165 struct sw_chnl_cmd {
166 	enum sw_chnl_cmd_id CmdID;
167 	u32			Para1;
168 	u32			Para2;
169 	u32			msDelay;
170 };
171 
172 /*--------------------------Define -------------------------------------------*/
173 #define MGN_1M		  0x02
174 #define MGN_2M		  0x04
175 #define MGN_5_5M		0x0b
176 #define MGN_11M		 0x16
177 
178 #define MGN_6M		  0x0c
179 #define MGN_9M		  0x12
180 #define MGN_12M		 0x18
181 #define MGN_18M		 0x24
182 #define MGN_24M		 0x30
183 #define MGN_36M		 0x48
184 #define MGN_48M		 0x60
185 #define MGN_54M		 0x6c
186 
187 #define MGN_MCS0		0x80
188 #define MGN_MCS1		0x81
189 #define MGN_MCS2		0x82
190 #define MGN_MCS3		0x83
191 #define MGN_MCS4		0x84
192 #define MGN_MCS5		0x85
193 #define MGN_MCS6		0x86
194 #define MGN_MCS7		0x87
195 #define MGN_MCS8		0x88
196 #define MGN_MCS9		0x89
197 #define MGN_MCS10	       0x8a
198 #define MGN_MCS11	       0x8b
199 #define MGN_MCS12	       0x8c
200 #define MGN_MCS13	       0x8d
201 #define MGN_MCS14	       0x8e
202 #define MGN_MCS15	       0x8f
203 
204 enum hw_variables {
205 	HW_VAR_ETHER_ADDR,
206 	HW_VAR_MULTICAST_REG,
207 	HW_VAR_BASIC_RATE,
208 	HW_VAR_BSSID,
209 	HW_VAR_MEDIA_STATUS,
210 	HW_VAR_SECURITY_CONF,
211 	HW_VAR_BEACON_INTERVAL,
212 	HW_VAR_ATIM_WINDOW,
213 	HW_VAR_LISTEN_INTERVAL,
214 	HW_VAR_CS_COUNTER,
215 	HW_VAR_DEFAULTKEY0,
216 	HW_VAR_DEFAULTKEY1,
217 	HW_VAR_DEFAULTKEY2,
218 	HW_VAR_DEFAULTKEY3,
219 	HW_VAR_SIFS,
220 	HW_VAR_DIFS,
221 	HW_VAR_EIFS,
222 	HW_VAR_SLOT_TIME,
223 	HW_VAR_ACK_PREAMBLE,
224 	HW_VAR_CW_CONFIG,
225 	HW_VAR_CW_VALUES,
226 	HW_VAR_RATE_FALLBACK_CONTROL,
227 	HW_VAR_CONTENTION_WINDOW,
228 	HW_VAR_RETRY_COUNT,
229 	HW_VAR_TR_SWITCH,
230 	HW_VAR_COMMAND,
231 	HW_VAR_WPA_CONFIG,
232 	HW_VAR_AMPDU_MIN_SPACE,
233 	HW_VAR_SHORTGI_DENSITY,
234 	HW_VAR_AMPDU_FACTOR,
235 	HW_VAR_MCS_RATE_AVAILABLE,
236 	HW_VAR_AC_PARAM,
237 	HW_VAR_ACM_CTRL,
238 	HW_VAR_DIS_Req_Qsize,
239 	HW_VAR_CCX_CHNL_LOAD,
240 	HW_VAR_CCX_NOISE_HISTOGRAM,
241 	HW_VAR_CCX_CLM_NHM,
242 	HW_VAR_TxOPLimit,
243 	HW_VAR_TURBO_MODE,
244 	HW_VAR_RF_STATE,
245 	HW_VAR_RF_OFF_BY_HW,
246 	HW_VAR_BUS_SPEED,
247 	HW_VAR_SET_DEV_POWER,
248 
249 	HW_VAR_RCR,
250 	HW_VAR_RATR_0,
251 	HW_VAR_RRSR,
252 	HW_VAR_CPU_RST,
253 	HW_VAR_CECHK_BSSID,
254 	HW_VAR_LBK_MODE,
255 	HW_VAR_AES_11N_FIX,
256 	HW_VAR_USB_RX_AGGR,
257 	HW_VAR_USER_CONTROL_TURBO_MODE,
258 	HW_VAR_RETRY_LIMIT,
259 	HW_VAR_INIT_TX_RATE,
260 	HW_VAR_TX_RATE_REG,
261 	HW_VAR_EFUSE_USAGE,
262 	HW_VAR_EFUSE_BYTES,
263 	HW_VAR_AUTOLOAD_STATUS,
264 	HW_VAR_RF_2R_DISABLE,
265 	HW_VAR_SET_RPWM,
266 	HW_VAR_H2C_FW_PWRMODE,
267 	HW_VAR_H2C_FW_JOINBSSRPT,
268 	HW_VAR_1X1_RECV_COMBINE,
269 	HW_VAR_STOP_SEND_BEACON,
270 	HW_VAR_TSF_TIMER,
271 	HW_VAR_IO_CMD,
272 
273 	HW_VAR_RF_RECOVERY,
274 	HW_VAR_H2C_FW_UPDATE_GTK,
275 	HW_VAR_WF_MASK,
276 	HW_VAR_WF_CRC,
277 	HW_VAR_WF_IS_MAC_ADDR,
278 	HW_VAR_H2C_FW_OFFLOAD,
279 	HW_VAR_RESET_WFCRC,
280 
281 	HW_VAR_HANDLE_FW_C2H,
282 	HW_VAR_DL_FW_RSVD_PAGE,
283 	HW_VAR_AID,
284 	HW_VAR_HW_SEQ_ENABLE,
285 	HW_VAR_CORRECT_TSF,
286 	HW_VAR_BCN_VALID,
287 	HW_VAR_FWLPS_RF_ON,
288 	HW_VAR_DUAL_TSF_RST,
289 	HW_VAR_SWITCH_EPHY_WoWLAN,
290 	HW_VAR_INT_MIGRATION,
291 	HW_VAR_INT_AC,
292 	HW_VAR_RF_TIMING,
293 };
294 
295 enum rt_op_mode {
296 	RT_OP_MODE_AP,
297 	RT_OP_MODE_INFRASTRUCTURE,
298 	RT_OP_MODE_IBSS,
299 	RT_OP_MODE_NO_LINK,
300 };
301 
302 #define aSifsTime						\
303 	 ((priv->rtllib->current_network.mode == WIRELESS_MODE_N_24G) ? 16 : 10)
304 
305 #define MGMT_QUEUE_NUM 5
306 
307 #define MAX_IE_LEN  0xff
308 
309 #define msleep_interruptible_rsl  msleep_interruptible
310 
311 /* Maximum size for the MA-UNITDATA primitive, 802.11 standard section
312  * 6.2.1.1.2.
313  *
314  * The figure in section 7.1.2 suggests a body size of up to 2312
315  * bytes is allowed, which is a bit confusing, I suspect this
316  * represents the 2304 bytes of real data, plus a possible 8 bytes of
317  * WEP IV and ICV. (this interpretation suggested by Ramiro Barreiro)
318  */
319 #define RTLLIB_1ADDR_LEN 10
320 #define RTLLIB_2ADDR_LEN 16
321 #define RTLLIB_3ADDR_LEN 24
322 #define RTLLIB_4ADDR_LEN 30
323 #define RTLLIB_FCS_LEN    4
324 
325 #define RTLLIB_SKBBUFFER_SIZE 2500
326 
327 #define MIN_FRAG_THRESHOLD     256U
328 #define MAX_FRAG_THRESHOLD     2346U
329 
330 #define RTLLIB_FTYPE_MGMT		0x0000
331 #define RTLLIB_FTYPE_CTL		0x0004
332 #define RTLLIB_FTYPE_DATA		0x0008
333 
334 #define RTLLIB_SCTL_FRAG		0x000F
335 #define RTLLIB_SCTL_SEQ		0xFFF0
336 
337 /* QOS control */
338 #define RTLLIB_QCTL_TID	      0x000F
339 
340 #define	FC_QOS_BIT					BIT(7)
341 #define IsDataFrame(pdu)	(((pdu[0] & 0x0C) == 0x08) ? true : false)
342 #define	IsLegacyDataFrame(pdu)	(IsDataFrame(pdu) && (!(pdu[0]&FC_QOS_BIT)))
343 #define IsQoSDataFrame(pframe)			\
344 	((*(u16 *)pframe&(IEEE80211_STYPE_QOS_DATA|RTLLIB_FTYPE_DATA)) ==	\
345 	(IEEE80211_STYPE_QOS_DATA|RTLLIB_FTYPE_DATA))
346 #define Frame_Order(pframe)     (*(u16 *)pframe&IEEE80211_FCTL_ORDER)
347 #define SN_LESS(a, b)		(((a-b)&0x800) != 0)
348 #define SN_EQUAL(a, b)	(a == b)
349 #define MAX_DEV_ADDR_SIZE 8
350 
351 enum act_category {
352 	ACT_CAT_QOS = 1,
353 	ACT_CAT_DLS = 2,
354 	ACT_CAT_BA  = 3,
355 	ACT_CAT_HT  = 7,
356 	ACT_CAT_WMM = 17,
357 };
358 
359 enum ba_action {
360 	ACT_ADDBAREQ = 0,
361 	ACT_ADDBARSP = 1,
362 	ACT_DELBA    = 2,
363 };
364 
365 enum init_gain_op_type {
366 	IG_Backup = 0,
367 	IG_Restore,
368 	IG_Max
369 };
370 
371 enum wireless_mode {
372 	WIRELESS_MODE_UNKNOWN = 0x00,
373 	WIRELESS_MODE_A = 0x01,
374 	WIRELESS_MODE_B = 0x02,
375 	WIRELESS_MODE_G = 0x04,
376 	WIRELESS_MODE_AUTO = 0x08,
377 	WIRELESS_MODE_N_24G = 0x10,
378 };
379 
380 #ifndef ETH_P_PAE
381 #define ETH_P_PAE	0x888E		/* Port Access Entity (IEEE 802.1X) */
382 #define ETH_P_IP	0x0800		/* Internet Protocol packet	*/
383 #define ETH_P_ARP	0x0806		/* Address Resolution packet	*/
384 #endif /* ETH_P_PAE */
385 
386 #ifndef ETH_P_80211_RAW
387 #define ETH_P_80211_RAW (ETH_P_ECONET + 1)
388 #endif
389 
390 /* IEEE 802.11 defines */
391 
392 #define P80211_OUI_LEN 3
393 
394 struct rtllib_snap_hdr {
395 	u8    dsap;   /* always 0xAA */
396 	u8    ssap;   /* always 0xAA */
397 	u8    ctrl;   /* always 0x03 */
398 	u8    oui[P80211_OUI_LEN];    /* organizational universal id */
399 
400 } __packed;
401 
402 enum _REG_PREAMBLE_MODE {
403 	PREAMBLE_LONG = 1,
404 	PREAMBLE_AUTO = 2,
405 	PREAMBLE_SHORT = 3,
406 };
407 
408 #define SNAP_SIZE sizeof(struct rtllib_snap_hdr)
409 
410 #define WLAN_FC_GET_TYPE(fc) ((fc) & IEEE80211_FCTL_FTYPE)
411 #define WLAN_FC_GET_STYPE(fc) ((fc) & IEEE80211_FCTL_STYPE)
412 #define WLAN_FC_MORE_DATA(fc) ((fc) & IEEE80211_FCTL_MOREDATA)
413 
414 #define WLAN_GET_SEQ_FRAG(seq) ((seq) & RTLLIB_SCTL_FRAG)
415 #define WLAN_GET_SEQ_SEQ(seq)  (((seq) & RTLLIB_SCTL_SEQ) >> 4)
416 
417 /* Authentication algorithms */
418 #define WLAN_AUTH_OPEN 0
419 #define WLAN_AUTH_SHARED_KEY 1
420 #define WLAN_AUTH_LEAP 128
421 
422 #define WLAN_CAPABILITY_ESS (1<<0)
423 #define WLAN_CAPABILITY_IBSS (1<<1)
424 #define WLAN_CAPABILITY_PRIVACY (1<<4)
425 #define WLAN_CAPABILITY_SHORT_PREAMBLE (1<<5)
426 #define WLAN_CAPABILITY_SHORT_SLOT_TIME (1<<10)
427 
428 #define RTLLIB_STATMASK_SIGNAL (1<<0)
429 #define RTLLIB_STATMASK_RSSI (1<<1)
430 #define RTLLIB_STATMASK_NOISE (1<<2)
431 #define RTLLIB_STATMASK_WEMASK 0x7
432 
433 #define RTLLIB_CCK_MODULATION    (1<<0)
434 #define RTLLIB_OFDM_MODULATION   (1<<1)
435 
436 #define RTLLIB_CCK_RATE_LEN		4
437 #define RTLLIB_CCK_RATE_1MB			0x02
438 #define RTLLIB_CCK_RATE_2MB			0x04
439 #define RTLLIB_CCK_RATE_5MB			0x0B
440 #define RTLLIB_CCK_RATE_11MB			0x16
441 #define RTLLIB_OFDM_RATE_LEN		8
442 #define RTLLIB_OFDM_RATE_6MB			0x0C
443 #define RTLLIB_OFDM_RATE_9MB			0x12
444 #define RTLLIB_OFDM_RATE_12MB		0x18
445 #define RTLLIB_OFDM_RATE_18MB		0x24
446 #define RTLLIB_OFDM_RATE_24MB		0x30
447 #define RTLLIB_OFDM_RATE_36MB		0x48
448 #define RTLLIB_OFDM_RATE_48MB		0x60
449 #define RTLLIB_OFDM_RATE_54MB		0x6C
450 #define RTLLIB_BASIC_RATE_MASK		0x80
451 
452 /* this is stolen and modified from the madwifi driver*/
453 #define RTLLIB_FC0_TYPE_MASK		0x0c
454 #define RTLLIB_FC0_TYPE_DATA		0x08
455 #define RTLLIB_FC0_SUBTYPE_MASK	0xB0
456 #define RTLLIB_FC0_SUBTYPE_QOS	0x80
457 
458 #define RTLLIB_QOS_HAS_SEQ(fc) \
459 	(((fc) & (RTLLIB_FC0_TYPE_MASK | RTLLIB_FC0_SUBTYPE_MASK)) == \
460 	 (RTLLIB_FC0_TYPE_DATA | RTLLIB_FC0_SUBTYPE_QOS))
461 
462 /* this is stolen from ipw2200 driver */
463 #define IEEE_IBSS_MAC_HASH_SIZE 31
464 
465 /* NOTE: This data is for statistical purposes; not all hardware provides this
466  *       information for frames received.  Not setting these will not cause
467  *       any adverse affects.
468  */
469 struct rtllib_rx_stats {
470 	s8  rssi;
471 	u8  signal;
472 	u8  noise;
473 	u16 rate; /* in 100 kbps */
474 	u8  control;
475 	u8  mask;
476 	u16 len;
477 	u64 tsf;
478 	u32 beacon_time;
479 	u8  nic_type;
480 	u16 Length;
481 	u8  SignalQuality;
482 	s32 RecvSignalPower;
483 	s8  RxPower;
484 	u8  SignalStrength;
485 	u16 bHwError:1;
486 	u16 bCRC:1;
487 	u16 bICV:1;
488 	u16 bShortPreamble:1;
489 	u16 Antenna:1;
490 	u16 Decrypted:1;
491 	u16 Wakeup:1;
492 	u16 Reserved0:1;
493 	u8  AGC;
494 	u32 TimeStampLow;
495 	u32 TimeStampHigh;
496 	bool bShift;
497 	bool bIsQosData;
498 
499 	u8    RxDrvInfoSize;
500 	u8    RxBufShift;
501 	bool  bIsAMPDU;
502 	bool  bFirstMPDU;
503 	bool  bContainHTC;
504 	bool  RxIs40MHzPacket;
505 	u32   RxPWDBAll;
506 	u8    RxMIMOSignalStrength[4];
507 	s8    RxMIMOSignalQuality[2];
508 	bool  bPacketMatchBSSID;
509 	bool  bIsCCK;
510 	bool  bPacketToSelf;
511 	u16    packetlength;
512 	u16    fraglength;
513 	u16    fragoffset;
514 	u16    ntotalfrag;
515 	bool   bPacketBeacon;
516 	bool   bToSelfBA;
517 	u16    Seq_Num;
518 };
519 
520 /* IEEE 802.11 requires that STA supports concurrent reception of at least
521  * three fragmented frames. This define can be increased to support more
522  * concurrent frames, but it should be noted that each entry can consume about
523  * 2 kB of RAM and increasing cache size will slow down frame reassembly.
524  */
525 #define RTLLIB_FRAG_CACHE_LEN 4
526 
527 struct rtllib_frag_entry {
528 	unsigned long first_frag_time;
529 	unsigned int seq;
530 	unsigned int last_frag;
531 	struct sk_buff *skb;
532 	u8 src_addr[ETH_ALEN];
533 	u8 dst_addr[ETH_ALEN];
534 };
535 
536 struct rtllib_device;
537 
538 #define SEC_ACTIVE_KEY    (1<<4)
539 #define SEC_AUTH_MODE     (1<<5)
540 #define SEC_UNICAST_GROUP (1<<6)
541 #define SEC_LEVEL	 (1<<7)
542 #define SEC_ENABLED       (1<<8)
543 
544 #define SEC_LEVEL_0      0 /* None */
545 #define SEC_LEVEL_1      1 /* WEP 40 and 104 bit */
546 #define SEC_LEVEL_2      2 /* Level 1 + TKIP */
547 #define SEC_LEVEL_2_CKIP 3 /* Level 1 + CKIP */
548 #define SEC_LEVEL_3      4 /* Level 2 + CCMP */
549 
550 #define SEC_ALG_NONE		0
551 #define SEC_ALG_WEP		1
552 #define SEC_ALG_TKIP		2
553 #define SEC_ALG_CCMP		4
554 
555 #define WEP_KEY_LEN		13
556 #define SCM_KEY_LEN		32
557 
558 struct rtllib_security {
559 	u16 active_key:2,
560 	    enabled:1,
561 	    auth_mode:2,
562 	    auth_algo:4,
563 	    unicast_uses_group:1,
564 	    encrypt:1;
565 	u8 key_sizes[NUM_WEP_KEYS];
566 	u8 keys[NUM_WEP_KEYS][SCM_KEY_LEN];
567 	u8 level;
568 	u16 flags;
569 } __packed;
570 
571 /* 802.11 data frame from AP
572  *       ,-------------------------------------------------------------------.
573  * Bytes |  2   |  2   |    6    |    6    |    6    |  2   | 0..2312 |   4  |
574  *       |------|------|---------|---------|---------|------|---------|------|
575  * Desc. | ctrl | dura |  DA/RA  |   TA    |    SA   | Sequ |  frame  |  fcs |
576  *       |      | tion | (BSSID) |         |         | ence |  data   |      |
577  *       `-------------------------------------------------------------------'
578  * Total: 28-2340 bytes
579  */
580 
581 /* Management Frame Information Element Types */
582 enum rtllib_mfie {
583 	MFIE_TYPE_SSID = 0,
584 	MFIE_TYPE_RATES = 1,
585 	MFIE_TYPE_FH_SET = 2,
586 	MFIE_TYPE_DS_SET = 3,
587 	MFIE_TYPE_CF_SET = 4,
588 	MFIE_TYPE_TIM = 5,
589 	MFIE_TYPE_IBSS_SET = 6,
590 	MFIE_TYPE_COUNTRY = 7,
591 	MFIE_TYPE_HOP_PARAMS = 8,
592 	MFIE_TYPE_HOP_TABLE = 9,
593 	MFIE_TYPE_REQUEST = 10,
594 	MFIE_TYPE_CHALLENGE = 16,
595 	MFIE_TYPE_POWER_CONSTRAINT = 32,
596 	MFIE_TYPE_POWER_CAPABILITY = 33,
597 	MFIE_TYPE_TPC_REQUEST = 34,
598 	MFIE_TYPE_TPC_REPORT = 35,
599 	MFIE_TYPE_SUPP_CHANNELS = 36,
600 	MFIE_TYPE_CSA = 37,
601 	MFIE_TYPE_MEASURE_REQUEST = 38,
602 	MFIE_TYPE_MEASURE_REPORT = 39,
603 	MFIE_TYPE_QUIET = 40,
604 	MFIE_TYPE_IBSS_DFS = 41,
605 	MFIE_TYPE_ERP = 42,
606 	MFIE_TYPE_HT_CAP = 45,
607 	MFIE_TYPE_RSN = 48,
608 	MFIE_TYPE_RATES_EX = 50,
609 	MFIE_TYPE_HT_INFO = 61,
610 	MFIE_TYPE_AIRONET = 133,
611 	MFIE_TYPE_GENERIC = 221,
612 	MFIE_TYPE_QOS_PARAMETER = 222,
613 };
614 
615 /* Minimal header; can be used for passing 802.11 frames with sufficient
616  * information to determine what type of underlying data type is actually
617  * stored in the data.
618  */
619 struct rtllib_info_element {
620 	u8 id;
621 	u8 len;
622 	u8 data[];
623 } __packed;
624 
625 struct rtllib_authentication {
626 	struct ieee80211_hdr_3addr header;
627 	__le16 algorithm;
628 	__le16 transaction;
629 	__le16 status;
630 	/*challenge*/
631 	struct rtllib_info_element info_element[];
632 } __packed __aligned(2);
633 
634 struct rtllib_disauth {
635 	struct ieee80211_hdr_3addr header;
636 	__le16 reason;
637 } __packed __aligned(2);
638 
639 struct rtllib_disassoc {
640 	struct ieee80211_hdr_3addr header;
641 	__le16 reason;
642 } __packed __aligned(2);
643 
644 struct rtllib_probe_request {
645 	struct ieee80211_hdr_3addr header;
646 	/* SSID, supported rates */
647 	struct rtllib_info_element info_element[];
648 } __packed __aligned(2);
649 
650 struct rtllib_probe_response {
651 	struct ieee80211_hdr_3addr header;
652 	u32 time_stamp[2];
653 	__le16 beacon_interval;
654 	__le16 capability;
655 	/* SSID, supported rates, FH params, DS params,
656 	 * CF params, IBSS params, TIM (if beacon), RSN
657 	 */
658 	struct rtllib_info_element info_element[];
659 } __packed __aligned(2);
660 
661 /* Alias beacon for probe_response */
662 #define rtllib_beacon rtllib_probe_response
663 
664 struct rtllib_assoc_request_frame {
665 	struct ieee80211_hdr_3addr header;
666 	__le16 capability;
667 	__le16 listen_interval;
668 	/* SSID, supported rates, RSN */
669 	struct rtllib_info_element info_element[];
670 } __packed __aligned(2);
671 
672 struct rtllib_assoc_response_frame {
673 	struct ieee80211_hdr_3addr header;
674 	__le16 capability;
675 	__le16 status;
676 	__le16 aid;
677 	struct rtllib_info_element info_element[]; /* supported rates */
678 } __packed __aligned(2);
679 
680 struct rtllib_txb {
681 	u8 nr_frags;
682 	u8 encrypted;
683 	u8 queue_index;
684 	u8 rts_included;
685 	u16 reserved;
686 	__le16 frag_size;
687 	__le16 payload_size;
688 	struct sk_buff *fragments[] __counted_by(nr_frags);
689 };
690 
691 #define MAX_SUBFRAME_COUNT		  64
692 struct rtllib_rxb {
693 	u8 nr_subframes;
694 	struct sk_buff *subframes[MAX_SUBFRAME_COUNT];
695 	u8 dst[ETH_ALEN];
696 	u8 src[ETH_ALEN];
697 };
698 
699 union frameqos {
700 	u16 shortdata;
701 	u8  chardata[2];
702 	struct {
703 		u16 tid:4;
704 		u16 eosp:1;
705 		u16 ack_policy:2;
706 		u16 reserved:1;
707 		u16 txop:8;
708 	} field;
709 };
710 
711 /* MAX_RATES_LENGTH needs to be 12.  The spec says 8, and many APs
712  * only use 8, and then use extended rates for the remaining supported
713  * rates.  Other APs, however, stick all of their supported rates on the
714  * main rates information element...
715  */
716 #define MAX_RATES_LENGTH		  ((u8)12)
717 #define MAX_RATES_EX_LENGTH	       ((u8)16)
718 #define MAX_NETWORK_COUNT		  96
719 
720 #define MAX_CHANNEL_NUMBER		 161
721 #define RTLLIB_SOFTMAC_SCAN_TIME	   100
722 #define RTLLIB_SOFTMAC_ASSOC_RETRY_TIME (HZ * 2)
723 
724 #define MAX_WPA_IE_LEN 64
725 #define MAX_WZC_IE_LEN 256
726 
727 #define NETWORK_EMPTY_ESSID (1<<0)
728 #define NETWORK_HAS_OFDM    (1<<1)
729 #define NETWORK_HAS_CCK     (1<<2)
730 
731 /* QoS structure */
732 #define NETWORK_HAS_QOS_PARAMETERS      (1<<3)
733 #define NETWORK_HAS_QOS_INFORMATION     (1<<4)
734 #define NETWORK_HAS_QOS_MASK	    (NETWORK_HAS_QOS_PARAMETERS | \
735 					 NETWORK_HAS_QOS_INFORMATION)
736 /* 802.11h */
737 #define NETWORK_HAS_ERP_VALUE	   (1<<10)
738 
739 #define QOS_QUEUE_NUM		   4
740 #define QOS_OUI_LEN		     3
741 #define QOS_OUI_TYPE		    2
742 #define QOS_ELEMENT_ID		  221
743 #define QOS_OUI_INFO_SUB_TYPE	   0
744 #define QOS_OUI_PARAM_SUB_TYPE	  1
745 #define QOS_VERSION_1		   1
746 
747 struct rtllib_qos_information_element {
748 	u8 elementID;
749 	u8 length;
750 	u8 qui[QOS_OUI_LEN];
751 	u8 qui_type;
752 	u8 qui_subtype;
753 	u8 version;
754 	u8 ac_info;
755 } __packed;
756 
757 struct rtllib_qos_ac_parameter {
758 	u8 aci_aifsn;
759 	u8 ecw_min_max;
760 	__le16 tx_op_limit;
761 } __packed;
762 
763 struct rtllib_qos_parameter_info {
764 	struct rtllib_qos_information_element info_element;
765 	u8 reserved;
766 	struct rtllib_qos_ac_parameter ac_params_record[QOS_QUEUE_NUM];
767 } __packed;
768 
769 struct rtllib_qos_parameters {
770 	__le16 cw_min[QOS_QUEUE_NUM];
771 	__le16 cw_max[QOS_QUEUE_NUM];
772 	u8 aifs[QOS_QUEUE_NUM];
773 	u8 flag[QOS_QUEUE_NUM];
774 	__le16 tx_op_limit[QOS_QUEUE_NUM];
775 } __packed;
776 
777 struct rtllib_qos_data {
778 	struct rtllib_qos_parameters parameters;
779 	unsigned int wmm_acm;
780 	int active;
781 	int supported;
782 	u8 param_count;
783 	u8 old_param_count;
784 };
785 
786 struct rtllib_tim_parameters {
787 	u8 tim_count;
788 	u8 tim_period;
789 } __packed;
790 
791 struct rtllib_wmm_ac_param {
792 	u8 ac_aci_acm_aifsn;
793 	u8 ac_ecwmin_ecwmax;
794 	u16 ac_txop_limit;
795 };
796 
797 enum eap_type {
798 	EAP_PACKET = 0,
799 	EAPOL_START,
800 	EAPOL_LOGOFF,
801 	EAPOL_KEY,
802 	EAPOL_ENCAP_ASF_ALERT
803 };
804 
805 static const char * const eap_types[] = {
806 	[EAP_PACKET]		= "EAP-Packet",
807 	[EAPOL_START]		= "EAPOL-Start",
808 	[EAPOL_LOGOFF]		= "EAPOL-Logoff",
809 	[EAPOL_KEY]		= "EAPOL-Key",
810 	[EAPOL_ENCAP_ASF_ALERT]	= "EAPOL-Encap-ASF-Alert"
811 };
812 
813 static inline const char *eap_get_type(int type)
814 {
815 	return ((u32)type >= ARRAY_SIZE(eap_types)) ? "Unknown" :
816 		 eap_types[type];
817 }
818 
819 static inline u8 Frame_QoSTID(u8 *buf)
820 {
821 	struct ieee80211_hdr_3addr *hdr;
822 	u16 fc;
823 
824 	hdr = (struct ieee80211_hdr_3addr *)buf;
825 	fc = le16_to_cpu(hdr->frame_control);
826 	return (u8)((union frameqos *)(buf + (((fc & IEEE80211_FCTL_TODS) &&
827 		    (fc & IEEE80211_FCTL_FROMDS)) ? 30 : 24)))->field.tid;
828 }
829 
830 struct eapol {
831 	u8 snap[6];
832 	u16 ethertype;
833 	u8 version;
834 	u8 type;
835 	u16 length;
836 } __packed;
837 
838 struct rtllib_softmac_stats {
839 	unsigned int rx_ass_ok;
840 	unsigned int rx_ass_err;
841 	unsigned int rx_probe_rq;
842 	unsigned int tx_probe_rs;
843 	unsigned int tx_beacons;
844 	unsigned int rx_auth_rq;
845 	unsigned int rx_auth_rs_ok;
846 	unsigned int rx_auth_rs_err;
847 	unsigned int tx_auth_rq;
848 	unsigned int no_auth_rs;
849 	unsigned int no_ass_rs;
850 	unsigned int tx_ass_rq;
851 	unsigned int rx_ass_rq;
852 	unsigned int tx_probe_rq;
853 	unsigned int reassoc;
854 	unsigned int swtxstop;
855 	unsigned int swtxawake;
856 	unsigned char CurrentShowTxate;
857 	unsigned char last_packet_rate;
858 	unsigned int txretrycount;
859 };
860 
861 /* These are the data types that can make up management packets
862  *
863  * u16 auth_algorithm;
864  * u16 auth_sequence;
865  * u16 beacon_interval;
866  * u16 capability;
867  * u8 current_ap[ETH_ALEN];
868  * u16 listen_interval;
869  * struct {
870  *   u16 association_id:14, reserved:2;
871  * } __packed;
872  * u32 time_stamp[2];
873  * u16 reason;
874  * u16 status;
875  */
876 
877 #define RTLLIB_DEFAULT_TX_ESSID "Penguin"
878 #define RTLLIB_DEFAULT_BASIC_RATE 2
879 
880 enum {WMM_all_frame, WMM_two_frame, WMM_four_frame, WMM_six_frame};
881 #define MAX_SP_Len  (WMM_all_frame << 4)
882 #define RTLLIB_QOS_TID 0x0f
883 #define QOS_CTL_NOTCONTAIN_ACK (0x01 << 5)
884 
885 #define RTLLIB_DTIM_MBCAST 4
886 #define RTLLIB_DTIM_UCAST 2
887 #define RTLLIB_DTIM_VALID 1
888 #define RTLLIB_DTIM_INVALID 0
889 
890 #define RTLLIB_PS_DISABLED 0
891 #define RTLLIB_PS_UNICAST RTLLIB_DTIM_UCAST
892 #define RTLLIB_PS_MBCAST RTLLIB_DTIM_MBCAST
893 
894 #define WME_AC_BK   0x00
895 #define WME_AC_BE   0x01
896 #define WME_AC_VI   0x02
897 #define WME_AC_VO   0x03
898 #define WME_AC_PRAM_LEN 16
899 
900 #define MAX_RECEIVE_BUFFER_SIZE 9100
901 
902 #define UP2AC(up) (		   \
903 	((up) < 1) ? WME_AC_BE : \
904 	((up) < 3) ? WME_AC_BK : \
905 	((up) < 4) ? WME_AC_BE : \
906 	((up) < 6) ? WME_AC_VI : \
907 	WME_AC_VO)
908 
909 #define ETHERNET_HEADER_SIZE    14      /* length of two Ethernet address
910 					 * plus ether type
911 					 */
912 
913 enum erp_t {
914 	ERP_NonERPpresent	= 0x01,
915 	ERP_UseProtection	= 0x02,
916 	ERP_BarkerPreambleMode = 0x04,
917 };
918 
919 struct rtllib_network {
920 	/* These entries are used to identify a unique network */
921 	u8 bssid[ETH_ALEN];
922 	u8 channel;
923 	/* Ensure null-terminated for any debug msgs */
924 	u8 ssid[IW_ESSID_MAX_SIZE + 1];
925 	u8 ssid_len;
926 	u8 hidden_ssid[IW_ESSID_MAX_SIZE + 1];
927 	u8 hidden_ssid_len;
928 	struct rtllib_qos_data qos_data;
929 
930 	bool	bWithAironetIE;
931 	bool	bCkipSupported;
932 	bool	bCcxRmEnable;
933 	u8	CcxRmState[2];
934 	bool	bMBssidValid;
935 	u8	MBssidMask;
936 	u8	MBssid[ETH_ALEN];
937 	bool	bWithCcxVerNum;
938 	u8	BssCcxVerNumber;
939 	/* These are network statistics */
940 	struct rtllib_rx_stats stats;
941 	u16 capability;
942 	u8  rates[MAX_RATES_LENGTH];
943 	u8  rates_len;
944 	u8  rates_ex[MAX_RATES_EX_LENGTH];
945 	u8  rates_ex_len;
946 	unsigned long last_scanned;
947 	u8  mode;
948 	u32 flags;
949 	u32 time_stamp[2];
950 	u16 beacon_interval;
951 	u16 listen_interval;
952 	u16 atim_window;
953 	u8  erp_value;
954 	u8  wpa_ie[MAX_WPA_IE_LEN];
955 	size_t wpa_ie_len;
956 	u8  rsn_ie[MAX_WPA_IE_LEN];
957 	size_t rsn_ie_len;
958 	u8  wzc_ie[MAX_WZC_IE_LEN];
959 	size_t wzc_ie_len;
960 
961 	struct rtllib_tim_parameters tim;
962 	u8  dtim_period;
963 	u8  dtim_data;
964 	u64 last_dtim_sta_time;
965 
966 	u8 wmm_info;
967 	struct rtllib_wmm_ac_param wmm_param[4];
968 	u8 Turbo_Enable;
969 	u16 CountryIeLen;
970 	u8 CountryIeBuf[MAX_IE_LEN];
971 	struct bss_ht bssht;
972 	bool broadcom_cap_exist;
973 	bool realtek_cap_exit;
974 	bool marvell_cap_exist;
975 	bool ralink_cap_exist;
976 	bool atheros_cap_exist;
977 	bool cisco_cap_exist;
978 	bool airgo_cap_exist;
979 	bool unknown_cap_exist;
980 	bool	berp_info_valid;
981 	bool buseprotection;
982 	u8 SignalStrength;
983 	u8 RSSI;
984 	struct list_head list;
985 };
986 
987 enum rtl_link_state {
988 	/* the card is not linked at all */
989 	MAC80211_NOLINK = 0,
990 
991 	/* RTLLIB_ASSOCIATING* are for BSS client mode
992 	 * the driver shall not perform RX filtering unless
993 	 * the state is LINKED.
994 	 * The driver shall just check for the state LINKED and
995 	 * defaults to NOLINK for ALL the other states (including
996 	 * LINKED_SCANNING)
997 	 */
998 
999 	/* the association procedure will start (wq scheduling)*/
1000 	RTLLIB_ASSOCIATING,
1001 	RTLLIB_ASSOCIATING_RETRY,
1002 
1003 	/* the association procedure is sending AUTH request*/
1004 	RTLLIB_ASSOCIATING_AUTHENTICATING,
1005 
1006 	/* the association procedure has successfully authenticated
1007 	 * and is sending association request
1008 	 */
1009 	RTLLIB_ASSOCIATING_AUTHENTICATED,
1010 
1011 	/* the link is ok. the card associated to a BSS or linked
1012 	 * to a ibss cell or acting as an AP and creating the bss
1013 	 */
1014 	MAC80211_LINKED,
1015 
1016 	/* same as LINKED, but the driver shall apply RX filter
1017 	 * rules as we are in NO_LINK mode. As the card is still
1018 	 * logically linked, but it is doing a syncro site survey
1019 	 * then it will be back to LINKED state.
1020 	 */
1021 	MAC80211_LINKED_SCANNING,
1022 };
1023 
1024 #define DEFAULT_MAX_SCAN_AGE (15 * HZ)
1025 #define DEFAULT_FTS 2346
1026 
1027 #define CFG_RTLLIB_RESERVE_FCS (1<<0)
1028 #define CFG_RTLLIB_COMPUTE_FCS (1<<1)
1029 
1030 struct tx_pending {
1031 	int frag;
1032 	struct rtllib_txb *txb;
1033 };
1034 
1035 struct bandwidth_autoswitch {
1036 	long threshold_20Mhzto40Mhz;
1037 	long	threshold_40Mhzto20Mhz;
1038 	bool bforced_tx20Mhz;
1039 	bool bautoswitch_enable;
1040 };
1041 
1042 #define REORDER_WIN_SIZE	128
1043 #define REORDER_ENTRY_NUM	128
1044 struct rx_reorder_entry {
1045 	struct list_head	list;
1046 	u16			SeqNum;
1047 	struct rtllib_rxb *prxb;
1048 };
1049 
1050 enum fsync_state {
1051 	Default_Fsync,
1052 	HW_Fsync,
1053 	SW_Fsync
1054 };
1055 
1056 enum ips_callback_function {
1057 	IPS_CALLBACK_NONE = 0,
1058 	IPS_CALLBACK_MGNT_LINK_REQUEST = 1,
1059 	IPS_CALLBACK_JOIN_REQUEST = 2,
1060 };
1061 
1062 enum rt_rf_power_state {
1063 	rf_on,
1064 	rf_sleep,
1065 	rf_off
1066 };
1067 
1068 struct rt_pwr_save_ctrl {
1069 	bool				bSwRfProcessing;
1070 	enum rt_rf_power_state eInactivePowerState;
1071 	enum ips_callback_function ReturnPoint;
1072 
1073 	bool				bLeisurePs;
1074 	u8				LpsIdleCount;
1075 	u8				LPSAwakeIntvl;
1076 
1077 	u32				CurPsLevel;
1078 };
1079 
1080 #define RT_RF_CHANGE_SOURCE u32
1081 
1082 #define RF_CHANGE_BY_SW BIT(31)
1083 #define RF_CHANGE_BY_HW BIT(30)
1084 #define RF_CHANGE_BY_PS BIT(29)
1085 #define RF_CHANGE_BY_IPS BIT(28)
1086 #define RF_CHANGE_BY_INIT	0
1087 
1088 enum country_code_type {
1089 	COUNTRY_CODE_FCC = 0,
1090 	COUNTRY_CODE_IC = 1,
1091 	COUNTRY_CODE_ETSI = 2,
1092 	COUNTRY_CODE_SPAIN = 3,
1093 	COUNTRY_CODE_FRANCE = 4,
1094 	COUNTRY_CODE_MKK = 5,
1095 	COUNTRY_CODE_MKK1 = 6,
1096 	COUNTRY_CODE_ISRAEL = 7,
1097 	COUNTRY_CODE_TELEC = 8,
1098 	COUNTRY_CODE_MIC = 9,
1099 	COUNTRY_CODE_GLOBAL_DOMAIN = 10,
1100 	COUNTRY_CODE_WORLD_WIDE_13 = 11,
1101 	COUNTRY_CODE_TELEC_NETGEAR = 12,
1102 	COUNTRY_CODE_MAX
1103 };
1104 
1105 enum scan_op_backup_opt {
1106 	SCAN_OPT_BACKUP = 0,
1107 	SCAN_OPT_RESTORE,
1108 	SCAN_OPT_MAX
1109 };
1110 
1111 #define RT_MAX_LD_SLOT_NUM	10
1112 struct rt_link_detect {
1113 	u32				NumRecvBcnInPeriod;
1114 	u32				NumRecvDataInPeriod;
1115 
1116 	u32				RxBcnNum[RT_MAX_LD_SLOT_NUM];
1117 	u32				RxDataNum[RT_MAX_LD_SLOT_NUM];
1118 	u16				SlotNum;
1119 	u16				SlotIndex;
1120 
1121 	u32				num_tx_ok_in_period;
1122 	u32				num_rx_ok_in_period;
1123 	u32				NumRxUnicastOkInPeriod;
1124 	bool				bBusyTraffic;
1125 	bool				bHigherBusyTraffic;
1126 	bool				bHigherBusyRxTraffic;
1127 };
1128 
1129 struct sw_cam_table {
1130 	u8				macaddr[ETH_ALEN];
1131 	bool				bused;
1132 	u8				key_buf[16];
1133 	u16				key_type;
1134 	u8				useDK;
1135 	u8				key_index;
1136 
1137 };
1138 
1139 #define   TOTAL_CAM_ENTRY				32
1140 struct rate_adaptive {
1141 	u8				ratr_state;
1142 	u16				reserve;
1143 
1144 	u32				high_rssi_thresh_for_ra;
1145 	u32				high2low_rssi_thresh_for_ra;
1146 	u8				low2high_rssi_thresh_for_ra40M;
1147 	u32				low_rssi_thresh_for_ra40M;
1148 	u8				low2high_rssi_thresh_for_ra20M;
1149 	u32				low_rssi_thresh_for_ra20M;
1150 	u32				upper_rssi_threshold_ratr;
1151 	u32				middle_rssi_threshold_ratr;
1152 	u32				low_rssi_threshold_ratr;
1153 	u32				low_rssi_threshold_ratr_40M;
1154 	u32				low_rssi_threshold_ratr_20M;
1155 	u8				ping_rssi_enable;
1156 	u32				ping_rssi_ratr;
1157 	u32				ping_rssi_thresh_for_ra;
1158 	u8				PreRATRState;
1159 
1160 };
1161 
1162 #define	NUM_PMKID_CACHE		16
1163 struct rt_pmkid_list {
1164 	u8 Bssid[ETH_ALEN];
1165 	u8 PMKID[16];
1166 	u8 SsidBuf[33];
1167 	u8 used;
1168 };
1169 
1170 /*************** DRIVER STATUS   *****/
1171 #define STATUS_SCANNING			0
1172 /*************** DRIVER STATUS   *****/
1173 
1174 enum {
1175 	LPS_IS_WAKE = 0,
1176 	LPS_IS_SLEEP = 1,
1177 	LPS_WAIT_NULL_DATA_SEND = 2,
1178 };
1179 
1180 struct rtllib_device {
1181 	struct pci_dev *pdev;
1182 	struct net_device *dev;
1183 	struct rtllib_security sec;
1184 
1185 	bool disable_mgnt_queue;
1186 
1187 	unsigned long status;
1188 	u8	CntAfterLink;
1189 
1190 	enum rt_op_mode op_mode;
1191 
1192 	/* The last AssocReq/Resp IEs */
1193 	u8 *assocreq_ies, *assocresp_ies;
1194 	size_t assocreq_ies_len, assocresp_ies_len;
1195 
1196 	bool	bForcedBgMode;
1197 
1198 	u8 hwsec_active;
1199 	bool is_roaming;
1200 	bool ieee_up;
1201 	bool cannot_notify;
1202 	bool bSupportRemoteWakeUp;
1203 	bool actscanning;
1204 	bool FirstIe_InScan;
1205 	bool be_scan_inprogress;
1206 	bool beinretry;
1207 	enum rt_rf_power_state rf_power_state;
1208 	RT_RF_CHANGE_SOURCE rf_off_reason;
1209 	bool is_set_key;
1210 	bool wx_set_enc;
1211 	struct rt_hi_throughput *ht_info;
1212 
1213 	spinlock_t reorder_spinlock;
1214 	u8	reg_dot11ht_oper_rate_set[16];
1215 	u8	reg_dot11tx_ht_oper_rate_set[16];
1216 	u8	dot11ht_oper_rate_set[16];
1217 	u8	reg_ht_supp_rate_set[16];
1218 	u8	HTCurrentOperaRate;
1219 	u8	HTHighestOperaRate;
1220 	u8	tx_dis_rate_fallback;
1221 	u8	tx_use_drv_assinged_rate;
1222 	u8	tx_enable_fw_calc_dur;
1223 	atomic_t	atm_swbw;
1224 
1225 	struct list_head		Tx_TS_Admit_List;
1226 	struct list_head		Tx_TS_Pending_List;
1227 	struct list_head		Tx_TS_Unused_List;
1228 	struct tx_ts_record tx_ts_records[TOTAL_TS_NUM];
1229 	struct list_head		Rx_TS_Admit_List;
1230 	struct list_head		Rx_TS_Pending_List;
1231 	struct list_head		Rx_TS_Unused_List;
1232 	struct rx_ts_record rx_ts_records[TOTAL_TS_NUM];
1233 	struct rx_reorder_entry RxReorderEntry[128];
1234 	struct list_head		RxReorder_Unused_List;
1235 
1236 	/* Bookkeeping structures */
1237 	struct net_device_stats stats;
1238 	struct rtllib_softmac_stats softmac_stats;
1239 
1240 	/* Probe / Beacon management */
1241 	struct list_head network_free_list;
1242 	struct list_head network_list;
1243 	struct rtllib_network *networks;
1244 	int scans;
1245 	int scan_age;
1246 
1247 	int iw_mode; /* operating mode (IW_MODE_*) */
1248 
1249 	spinlock_t lock;
1250 	spinlock_t wpax_suitlist_lock;
1251 
1252 	int tx_headroom; /* Set to size of any additional room needed at front
1253 			  * of allocated Tx SKBs
1254 			  */
1255 	u32 config;
1256 
1257 	/* WEP and other encryption related settings at the device level */
1258 	int open_wep; /* Set to 1 to allow unencrypted frames */
1259 	int auth_mode;
1260 	int reset_on_keychange; /* Set to 1 if the HW needs to be reset on
1261 				 * WEP key changes
1262 				 */
1263 
1264 	int ieee802_1x; /* is IEEE 802.1X used */
1265 
1266 	/* WPA data */
1267 	bool bHalfWirelessN24GMode;
1268 	int wpa_enabled;
1269 	int drop_unencrypted;
1270 	int tkip_countermeasures;
1271 	int privacy_invoked;
1272 	size_t wpa_ie_len;
1273 	u8 *wpa_ie;
1274 	size_t wps_ie_len;
1275 	u8 *wps_ie;
1276 	u8 ap_mac_addr[ETH_ALEN];
1277 	u16 pairwise_key_type;
1278 	u16 group_key_type;
1279 
1280 	struct lib80211_crypt_info crypt_info;
1281 
1282 	struct sw_cam_table swcamtable[TOTAL_CAM_ENTRY];
1283 
1284 	struct rt_pmkid_list PMKIDList[NUM_PMKID_CACHE];
1285 
1286 	/* Fragmentation structures */
1287 	struct rtllib_frag_entry frag_cache[17][RTLLIB_FRAG_CACHE_LEN];
1288 	unsigned int frag_next_idx[17];
1289 	u16 fts; /* Fragmentation Threshold */
1290 #define DEFAULT_RTS_THRESHOLD 2346U
1291 #define MIN_RTS_THRESHOLD 1
1292 #define MAX_RTS_THRESHOLD 2346U
1293 	u16 rts; /* RTS threshold */
1294 
1295 	/* Association info */
1296 	u8 bssid[ETH_ALEN];
1297 
1298 	/* This stores infos for the current network.
1299 	 * Either the network we are associated in INFRASTRUCTURE
1300 	 * or the network that we are creating in MASTER mode.
1301 	 * ad-hoc is a mixture ;-).
1302 	 * Note that in infrastructure mode, even when not associated,
1303 	 * fields bssid and essid may be valid (if wpa_set and essid_set
1304 	 * are true) as thy carry the value set by the user via iwconfig
1305 	 */
1306 	struct rtllib_network current_network;
1307 
1308 	enum rtl_link_state link_state;
1309 
1310 	int mode;       /* A, B, G */
1311 
1312 	/* used for forcing the ibss workqueue to terminate
1313 	 * without wait for the syncro scan to terminate
1314 	 */
1315 	short sync_scan_hurryup;
1316 	u16 scan_watch_dog;
1317 
1318 	/* map of allowed channels. 0 is dummy */
1319 	u8 active_channel_map[MAX_CHANNEL_NUMBER+1];
1320 
1321 	int rate;       /* current rate */
1322 	int basic_rate;
1323 
1324 	/* this contains flags for selectively enable softmac support */
1325 	u16 softmac_features;
1326 
1327 	/* if the sequence control field is not filled by HW */
1328 	u16 seq_ctrl[5];
1329 
1330 	/* association procedure transaction sequence number */
1331 	u16 associate_seq;
1332 
1333 	/* AID for RTXed association responses */
1334 	u16 assoc_id;
1335 
1336 	/* power save mode related*/
1337 	u8 ack_tx_to_ieee;
1338 	short ps;
1339 	short sta_sleep;
1340 	int ps_timeout;
1341 	int ps_period;
1342 	struct work_struct ps_task;
1343 	u64 ps_time;
1344 	bool polling;
1345 
1346 	/* used if IEEE_SOFTMAC_TX_QUEUE is set */
1347 	short queue_stop;
1348 	short scanning_continue;
1349 	short proto_started;
1350 	short proto_stoppping;
1351 
1352 	struct mutex wx_mutex;
1353 	struct mutex scan_mutex;
1354 	struct mutex ips_mutex;
1355 
1356 	spinlock_t mgmt_tx_lock;
1357 	spinlock_t beacon_lock;
1358 
1359 	short beacon_txing;
1360 
1361 	short wap_set;
1362 	short ssid_set;
1363 
1364 	/* set on initialization */
1365 	unsigned int wmm_acm;
1366 
1367 	/* for discarding duplicated packets in IBSS */
1368 	struct list_head ibss_mac_hash[IEEE_IBSS_MAC_HASH_SIZE];
1369 
1370 	/* for discarding duplicated packets in BSS */
1371 	u16 last_rxseq_num[17]; /* rx seq previous per-tid */
1372 	u16 last_rxfrag_num[17];/* tx frag previous per-tid */
1373 	unsigned long last_packet_time[17];
1374 
1375 	/* for PS mode */
1376 	unsigned long last_rx_ps_time;
1377 	bool			bAwakePktSent;
1378 	u8			LPSDelayCnt;
1379 
1380 	/* used if IEEE_SOFTMAC_SINGLE_QUEUE is set */
1381 	struct sk_buff *mgmt_queue_ring[MGMT_QUEUE_NUM];
1382 	int mgmt_queue_head;
1383 	int mgmt_queue_tail;
1384 	u8 AsocRetryCount;
1385 	struct sk_buff_head skb_waitq[MAX_QUEUE_SIZE];
1386 
1387 	bool	bdynamic_txpower_enable;
1388 
1389 	bool bCTSToSelfEnable;
1390 
1391 	u32	fsync_time_interval;
1392 	u32	fsync_rate_bitmap;
1393 	u8	fsync_rssi_threshold;
1394 	bool	bfsync_enable;
1395 
1396 	u8	fsync_multiple_timeinterval;
1397 	u32	fsync_firstdiff_ratethreshold;
1398 	u32	fsync_seconddiff_ratethreshold;
1399 	enum fsync_state fsync_state;
1400 	bool		bis_any_nonbepkts;
1401 	struct bandwidth_autoswitch bandwidth_auto_switch;
1402 	bool FwRWRF;
1403 
1404 	struct rt_link_detect link_detect_info;
1405 	bool is_aggregate_frame;
1406 	struct rt_pwr_save_ctrl pwr_save_ctrl;
1407 
1408 	/* used if IEEE_SOFTMAC_TX_QUEUE is set */
1409 	struct tx_pending tx_pending;
1410 
1411 	/* used if IEEE_SOFTMAC_ASSOCIATE is set */
1412 	struct timer_list associate_timer;
1413 
1414 	/* used if IEEE_SOFTMAC_BEACONS is set */
1415 	u8 need_sw_enc;
1416 	struct work_struct associate_complete_wq;
1417 	struct work_struct ips_leave_wq;
1418 	struct delayed_work associate_procedure_wq;
1419 	struct delayed_work softmac_scan_wq;
1420 	struct delayed_work associate_retry_wq;
1421 	struct delayed_work hw_wakeup_wq;
1422 	struct delayed_work hw_sleep_wq;
1423 	struct delayed_work link_change_wq;
1424 	struct work_struct wx_sync_scan_wq;
1425 
1426 	union {
1427 		struct rtllib_rxb *RfdArray[REORDER_WIN_SIZE];
1428 		struct rtllib_rxb *stats_IndicateArray[REORDER_WIN_SIZE];
1429 		struct rtllib_rxb *prxbIndicateArray[REORDER_WIN_SIZE];
1430 		struct {
1431 			struct sw_chnl_cmd PreCommonCmd[MAX_PRECMD_CNT];
1432 			struct sw_chnl_cmd PostCommonCmd[MAX_POSTCMD_CNT];
1433 			struct sw_chnl_cmd RfDependCmd[MAX_RFDEPENDCMD_CNT];
1434 		};
1435 	};
1436 
1437 	/* Callback functions */
1438 
1439 	/* Softmac-generated frames (management) are TXed via this
1440 	 * callback if the flag IEEE_SOFTMAC_SINGLE_QUEUE is
1441 	 * not set. As some cards may have different HW queues that
1442 	 * one might want to use for data and management frames
1443 	 * the option to have two callbacks might be useful.
1444 	 * This function can't sleep.
1445 	 */
1446 	int (*softmac_hard_start_xmit)(struct sk_buff *skb,
1447 			       struct net_device *dev);
1448 
1449 	/* used instead of hard_start_xmit (not softmac_hard_start_xmit)
1450 	 * if the IEEE_SOFTMAC_TX_QUEUE feature is used to TX data
1451 	 * frames. If the option IEEE_SOFTMAC_SINGLE_QUEUE is also set
1452 	 * then also management frames are sent via this callback.
1453 	 * This function can't sleep.
1454 	 */
1455 	void (*softmac_data_hard_start_xmit)(struct sk_buff *skb,
1456 			       struct net_device *dev, int rate);
1457 
1458 	/* ask to the driver to retune the radio.
1459 	 * This function can sleep. the driver should ensure
1460 	 * the radio has been switched before return.
1461 	 */
1462 	void (*set_chan)(struct net_device *dev, u8 ch);
1463 
1464 	/* indicate the driver that the link state is changed
1465 	 * for example it may indicate the card is associated now.
1466 	 * Driver might be interested in this to apply RX filter
1467 	 * rules or simply light the LINK led
1468 	 */
1469 	void (*link_change)(struct net_device *dev);
1470 
1471 	/* power save mode related */
1472 	void (*sta_wake_up)(struct net_device *dev);
1473 	void (*enter_sleep_state)(struct net_device *dev, u64 time);
1474 	short (*ps_is_queue_empty)(struct net_device *dev);
1475 	int (*handle_beacon)(struct net_device *dev,
1476 			     struct rtllib_beacon *beacon,
1477 			     struct rtllib_network *network);
1478 	int (*handle_assoc_response)(struct net_device *dev,
1479 				     struct rtllib_assoc_response_frame *resp,
1480 				     struct rtllib_network *network);
1481 
1482 	/* check whether Tx hw resource available */
1483 	short (*check_nic_enough_desc)(struct net_device *dev, int queue_index);
1484 	void (*set_bw_mode_handler)(struct net_device *dev,
1485 				    enum ht_channel_width bandwidth,
1486 				    enum ht_extchnl_offset Offset);
1487 	bool (*GetNmodeSupportBySecCfg)(struct net_device *dev);
1488 	void (*set_wireless_mode)(struct net_device *dev, u8 wireless_mode);
1489 	bool (*GetHalfNmodeSupportByAPsHandler)(struct net_device *dev);
1490 	u8   (*rtllib_ap_sec_type)(struct rtllib_device *ieee);
1491 	void (*init_gain_handler)(struct net_device *dev, u8 Operation);
1492 	void (*ScanOperationBackupHandler)(struct net_device *dev,
1493 					   u8 Operation);
1494 	void (*SetHwRegHandler)(struct net_device *dev, u8 variable, u8 *val);
1495 
1496 	void (*AllowAllDestAddrHandler)(struct net_device *dev,
1497 					bool bAllowAllDA, bool WriteIntoReg);
1498 
1499 	void (*rtllib_ips_leave_wq)(struct net_device *dev);
1500 	void (*rtllib_ips_leave)(struct net_device *dev);
1501 	void (*leisure_ps_leave)(struct net_device *dev);
1502 
1503 	/* This must be the last item so that it points to the data
1504 	 * allocated beyond this structure by alloc_rtllib
1505 	 */
1506 	u8 priv[];
1507 };
1508 
1509 #define IEEE_MODE_MASK    (WIRELESS_MODE_B | WIRELESS_MODE_G)
1510 
1511 /* Generate a 802.11 header */
1512 
1513 /* Uses the channel change callback directly
1514  * instead of [start/stop] scan callbacks
1515  */
1516 #define IEEE_SOFTMAC_SCAN (1<<2)
1517 
1518 /* Perform authentication and association handshake */
1519 #define IEEE_SOFTMAC_ASSOCIATE (1<<3)
1520 
1521 /* Generate probe requests */
1522 #define IEEE_SOFTMAC_PROBERQ (1<<4)
1523 
1524 /* Generate response to probe requests */
1525 #define IEEE_SOFTMAC_PROBERS (1<<5)
1526 
1527 /* The ieee802.11 stack will manage the netif queue
1528  * wake/stop for the driver, taking care of 802.11
1529  * fragmentation. See softmac.c for details.
1530  */
1531 #define IEEE_SOFTMAC_TX_QUEUE (1<<7)
1532 
1533 /* Uses only the softmac_data_hard_start_xmit
1534  * even for TX management frames.
1535  */
1536 #define IEEE_SOFTMAC_SINGLE_QUEUE (1<<8)
1537 
1538 /* Generate beacons.  The stack will enqueue beacons
1539  * to the card
1540  */
1541 #define IEEE_SOFTMAC_BEACONS (1<<6)
1542 
1543 static inline void *rtllib_priv(struct net_device *dev)
1544 {
1545 	return ((struct rtllib_device *)netdev_priv(dev))->priv;
1546 }
1547 
1548 static inline int rtllib_is_empty_essid(const char *essid, int essid_len)
1549 {
1550 	/* Single white space is for Linksys APs */
1551 	if (essid_len == 1 && essid[0] == ' ')
1552 		return 1;
1553 
1554 	/* Otherwise, if the entire essid is 0, we assume it is hidden */
1555 	while (essid_len) {
1556 		essid_len--;
1557 		if (essid[essid_len] != '\0')
1558 			return 0;
1559 	}
1560 
1561 	return 1;
1562 }
1563 
1564 static inline int rtllib_get_hdrlen(u16 fc)
1565 {
1566 	int hdrlen = RTLLIB_3ADDR_LEN;
1567 
1568 	switch (WLAN_FC_GET_TYPE(fc)) {
1569 	case RTLLIB_FTYPE_DATA:
1570 		if ((fc & IEEE80211_FCTL_FROMDS) && (fc & IEEE80211_FCTL_TODS))
1571 			hdrlen = RTLLIB_4ADDR_LEN; /* Addr4 */
1572 		if (RTLLIB_QOS_HAS_SEQ(fc))
1573 			hdrlen += 2; /* QOS ctrl*/
1574 		break;
1575 	case RTLLIB_FTYPE_CTL:
1576 		switch (WLAN_FC_GET_STYPE(fc)) {
1577 		case IEEE80211_STYPE_CTS:
1578 		case IEEE80211_STYPE_ACK:
1579 			hdrlen = RTLLIB_1ADDR_LEN;
1580 			break;
1581 		default:
1582 			hdrlen = RTLLIB_2ADDR_LEN;
1583 			break;
1584 		}
1585 		break;
1586 	}
1587 
1588 	return hdrlen;
1589 }
1590 
1591 static inline int rtllib_is_ofdm_rate(u8 rate)
1592 {
1593 	switch (rate & ~RTLLIB_BASIC_RATE_MASK) {
1594 	case RTLLIB_OFDM_RATE_6MB:
1595 	case RTLLIB_OFDM_RATE_9MB:
1596 	case RTLLIB_OFDM_RATE_12MB:
1597 	case RTLLIB_OFDM_RATE_18MB:
1598 	case RTLLIB_OFDM_RATE_24MB:
1599 	case RTLLIB_OFDM_RATE_36MB:
1600 	case RTLLIB_OFDM_RATE_48MB:
1601 	case RTLLIB_OFDM_RATE_54MB:
1602 		return 1;
1603 	}
1604 	return 0;
1605 }
1606 
1607 static inline int rtllib_is_cck_rate(u8 rate)
1608 {
1609 	switch (rate & ~RTLLIB_BASIC_RATE_MASK) {
1610 	case RTLLIB_CCK_RATE_1MB:
1611 	case RTLLIB_CCK_RATE_2MB:
1612 	case RTLLIB_CCK_RATE_5MB:
1613 	case RTLLIB_CCK_RATE_11MB:
1614 		return 1;
1615 	}
1616 	return 0;
1617 }
1618 
1619 /* rtllib.c */
1620 void free_rtllib(struct net_device *dev);
1621 struct net_device *alloc_rtllib(int sizeof_priv);
1622 
1623 /* rtllib_tx.c */
1624 
1625 int rtllib_encrypt_fragment(struct rtllib_device *ieee,
1626 			    struct sk_buff *frag,
1627 			    int hdr_len);
1628 
1629 netdev_tx_t rtllib_xmit(struct sk_buff *skb,  struct net_device *dev);
1630 void rtllib_txb_free(struct rtllib_txb *txb);
1631 
1632 /* rtllib_rx.c */
1633 int rtllib_rx(struct rtllib_device *ieee, struct sk_buff *skb,
1634 	      struct rtllib_rx_stats *rx_stats);
1635 int rtllib_legal_channel(struct rtllib_device *rtllib, u8 channel);
1636 
1637 /* rtllib_wx.c */
1638 int rtllib_wx_get_scan(struct rtllib_device *ieee,
1639 		       struct iw_request_info *info,
1640 		       union iwreq_data *wrqu, char *key);
1641 int rtllib_wx_set_encode(struct rtllib_device *ieee,
1642 			 struct iw_request_info *info,
1643 			 union iwreq_data *wrqu, char *key);
1644 int rtllib_wx_get_encode(struct rtllib_device *ieee,
1645 			 struct iw_request_info *info,
1646 			 union iwreq_data *wrqu, char *key);
1647 int rtllib_wx_set_encode_ext(struct rtllib_device *ieee,
1648 			     struct iw_request_info *info,
1649 			     union iwreq_data *wrqu, char *extra);
1650 int rtllib_wx_set_auth(struct rtllib_device *ieee,
1651 		       struct iw_request_info *info,
1652 		       struct iw_param *data, char *extra);
1653 int rtllib_wx_set_mlme(struct rtllib_device *ieee,
1654 		       struct iw_request_info *info,
1655 		       union iwreq_data *wrqu, char *extra);
1656 int rtllib_wx_set_gen_ie(struct rtllib_device *ieee, u8 *ie, size_t len);
1657 
1658 /* rtllib_softmac.c */
1659 int rtllib_rx_frame_softmac(struct rtllib_device *ieee, struct sk_buff *skb,
1660 			    struct rtllib_rx_stats *rx_stats, u16 type,
1661 			    u16 stype);
1662 void rtllib_softmac_new_net(struct rtllib_device *ieee,
1663 			    struct rtllib_network *net);
1664 
1665 void SendDisassociation(struct rtllib_device *ieee, bool deauth, u16 asRsn);
1666 void rtllib_softmac_xmit(struct rtllib_txb *txb, struct rtllib_device *ieee);
1667 
1668 int rtllib_softmac_init(struct rtllib_device *ieee);
1669 void rtllib_softmac_free(struct rtllib_device *ieee);
1670 void rtllib_disassociate(struct rtllib_device *ieee);
1671 void rtllib_stop_scan(struct rtllib_device *ieee);
1672 bool rtllib_act_scanning(struct rtllib_device *ieee, bool sync_scan);
1673 void rtllib_stop_scan_syncro(struct rtllib_device *ieee);
1674 void rtllib_start_scan_syncro(struct rtllib_device *ieee);
1675 void rtllib_sta_ps_send_null_frame(struct rtllib_device *ieee, short pwr);
1676 void rtllib_sta_ps_send_pspoll_frame(struct rtllib_device *ieee);
1677 void rtllib_start_protocol(struct rtllib_device *ieee);
1678 void rtllib_stop_protocol(struct rtllib_device *ieee);
1679 
1680 void rtllib_enable_net_monitor_mode(struct net_device *dev, bool init_state);
1681 void rtllib_disable_net_monitor_mode(struct net_device *dev, bool init_state);
1682 
1683 void rtllib_softmac_stop_protocol(struct rtllib_device *ieee);
1684 void rtllib_softmac_start_protocol(struct rtllib_device *ieee);
1685 
1686 void rtllib_reset_queue(struct rtllib_device *ieee);
1687 void rtllib_wake_all_queues(struct rtllib_device *ieee);
1688 void rtllib_stop_all_queues(struct rtllib_device *ieee);
1689 
1690 void notify_wx_assoc_event(struct rtllib_device *ieee);
1691 void rtllib_ps_tx_ack(struct rtllib_device *ieee, short success);
1692 
1693 void softmac_mgmt_xmit(struct sk_buff *skb, struct rtllib_device *ieee);
1694 u8 rtllib_ap_sec_type(struct rtllib_device *ieee);
1695 
1696 /* rtllib_softmac_wx.c */
1697 
1698 int rtllib_wx_get_wap(struct rtllib_device *ieee, struct iw_request_info *info,
1699 		      union iwreq_data *wrqu, char *ext);
1700 
1701 int rtllib_wx_set_wap(struct rtllib_device *ieee, struct iw_request_info *info,
1702 		      union iwreq_data *awrq, char *extra);
1703 
1704 int rtllib_wx_get_essid(struct rtllib_device *ieee, struct iw_request_info *a,
1705 			union iwreq_data *wrqu, char *b);
1706 
1707 int rtllib_wx_set_rate(struct rtllib_device *ieee, struct iw_request_info *info,
1708 		       union iwreq_data *wrqu, char *extra);
1709 
1710 int rtllib_wx_get_rate(struct rtllib_device *ieee, struct iw_request_info *info,
1711 		       union iwreq_data *wrqu, char *extra);
1712 
1713 int rtllib_wx_set_mode(struct rtllib_device *ieee, struct iw_request_info *a,
1714 		       union iwreq_data *wrqu, char *b);
1715 
1716 int rtllib_wx_set_scan(struct rtllib_device *ieee, struct iw_request_info *a,
1717 		       union iwreq_data *wrqu, char *b);
1718 
1719 int rtllib_wx_set_essid(struct rtllib_device *ieee, struct iw_request_info *a,
1720 			union iwreq_data *wrqu, char *extra);
1721 
1722 int rtllib_wx_get_mode(struct rtllib_device *ieee, struct iw_request_info *a,
1723 		       union iwreq_data *wrqu, char *b);
1724 
1725 int rtllib_wx_set_freq(struct rtllib_device *ieee, struct iw_request_info *a,
1726 		       union iwreq_data *wrqu, char *b);
1727 
1728 int rtllib_wx_get_freq(struct rtllib_device *ieee, struct iw_request_info *a,
1729 		       union iwreq_data *wrqu, char *b);
1730 void rtllib_wx_sync_scan_wq(void *data);
1731 
1732 int rtllib_wx_get_name(struct rtllib_device *ieee, struct iw_request_info *info,
1733 		       union iwreq_data *wrqu, char *extra);
1734 
1735 int rtllib_wx_set_power(struct rtllib_device *ieee,
1736 			struct iw_request_info *info,
1737 			union iwreq_data *wrqu, char *extra);
1738 
1739 int rtllib_wx_get_power(struct rtllib_device *ieee,
1740 			struct iw_request_info *info,
1741 			union iwreq_data *wrqu, char *extra);
1742 
1743 int rtllib_wx_set_rts(struct rtllib_device *ieee, struct iw_request_info *info,
1744 		      union iwreq_data *wrqu, char *extra);
1745 
1746 int rtllib_wx_get_rts(struct rtllib_device *ieee, struct iw_request_info *info,
1747 		      union iwreq_data *wrqu, char *extra);
1748 #define MAX_RECEIVE_BUFFER_SIZE 9100
1749 
1750 void ht_set_connect_bw_mode(struct rtllib_device *ieee,
1751 			enum ht_channel_width bandwidth,
1752 			enum ht_extchnl_offset Offset);
1753 void ht_update_default_setting(struct rtllib_device *ieee);
1754 void ht_construct_capability_element(struct rtllib_device *ieee,
1755 				  u8 *posHTCap, u8 *len,
1756 				  u8 isEncrypt, bool bAssoc);
1757 void ht_construct_rt2rt_agg_element(struct rtllib_device *ieee,
1758 				u8 *posRT2RTAgg, u8 *len);
1759 void ht_on_assoc_rsp(struct rtllib_device *ieee);
1760 void ht_initialize_ht_info(struct rtllib_device *ieee);
1761 void ht_initialize_bss_desc(struct bss_ht *pBssHT);
1762 void ht_reset_self_and_save_peer_setting(struct rtllib_device *ieee,
1763 				   struct rtllib_network *pNetwork);
1764 void HT_update_self_and_peer_setting(struct rtllib_device *ieee,
1765 				     struct rtllib_network *pNetwork);
1766 u8 ht_get_highest_mcs_rate(struct rtllib_device *ieee, u8 *pMCSRateSet,
1767 		       u8 *pMCSFilter);
1768 extern u8 MCS_FILTER_ALL[];
1769 extern u16 MCS_DATA_RATE[2][2][77];
1770 u8 ht_c_check(struct rtllib_device *ieee, u8 *pFrame);
1771 void ht_reset_iot_setting(struct rt_hi_throughput *ht_info);
1772 bool is_ht_half_nmode_aps(struct rtllib_device *ieee);
1773 u16  tx_count_to_data_rate(struct rtllib_device *ieee, u8 nDataRate);
1774 int rtllib_rx_ADDBAReq(struct rtllib_device *ieee, struct sk_buff *skb);
1775 int rtllib_rx_ADDBARsp(struct rtllib_device *ieee, struct sk_buff *skb);
1776 int rtllib_rx_DELBA(struct rtllib_device *ieee, struct sk_buff *skb);
1777 void rtllib_ts_init_add_ba(struct rtllib_device *ieee, struct tx_ts_record *ts,
1778 			   u8 policy, u8 overwrite_pending);
1779 void rtllib_ts_init_del_ba(struct rtllib_device *ieee,
1780 			   struct ts_common_info *ts_common_info,
1781 			   enum tr_select TxRxSelect);
1782 void rtllib_ba_setup_timeout(struct timer_list *t);
1783 void rtllib_tx_ba_inact_timeout(struct timer_list *t);
1784 void rtllib_rx_ba_inact_timeout(struct timer_list *t);
1785 void rtllib_reset_ba_entry(struct ba_record *ba);
1786 bool rtllib_get_ts(struct rtllib_device *ieee, struct ts_common_info **ppTS, u8 *addr,
1787 	   u8 TID, enum tr_select TxRxSelect, bool bAddNewTs);
1788 void rtllib_ts_init(struct rtllib_device *ieee);
1789 void TsStartAddBaProcess(struct rtllib_device *ieee,
1790 			 struct tx_ts_record *pTxTS);
1791 void RemovePeerTS(struct rtllib_device *ieee, u8 *addr);
1792 void RemoveAllTS(struct rtllib_device *ieee);
1793 
1794 static inline const char *escape_essid(const char *essid, u8 essid_len)
1795 {
1796 	static char escaped[IW_ESSID_MAX_SIZE * 2 + 1];
1797 
1798 	if (rtllib_is_empty_essid(essid, essid_len)) {
1799 		memcpy(escaped, "<hidden>", sizeof("<hidden>"));
1800 		return escaped;
1801 	}
1802 
1803 	snprintf(escaped, sizeof(escaped), "%*pE", essid_len, essid);
1804 	return escaped;
1805 }
1806 
1807 /* fun with the built-in rtllib stack... */
1808 bool rtllib_MgntDisconnect(struct rtllib_device *rtllib, u8 asRsn);
1809 
1810 /* For the function is more related to hardware setting, it's better to use the
1811  * ieee handler to refer to it.
1812  */
1813 void rtllib_FlushRxTsPendingPkts(struct rtllib_device *ieee,
1814 				 struct rx_ts_record *ts);
1815 int rtllib_parse_info_param(struct rtllib_device *ieee,
1816 			    struct rtllib_info_element *info_element,
1817 			    u16 length,
1818 			    struct rtllib_network *network,
1819 			    struct rtllib_rx_stats *stats);
1820 
1821 void rtllib_indicate_packets(struct rtllib_device *ieee,
1822 			     struct rtllib_rxb **prxbIndicateArray, u8  index);
1823 #define RT_ASOC_RETRY_LIMIT	5
1824 u8 MgntQuery_TxRateExcludeCCKRates(struct rtllib_device *ieee);
1825 
1826 #endif /* RTLLIB_H */
1827