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