Merge tag 'sched-urgent-2021-07-11' of git://git.kernel.org/pub/scm/linux/kernel...
[linux-2.6-microblaze.git] / drivers / staging / rtl8723bs / include / ieee80211.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /******************************************************************************
3  *
4  * Copyright(c) 2007 - 2011 Realtek Corporation. All rights reserved.
5  *
6  ******************************************************************************/
7 #ifndef __IEEE80211_H
8 #define __IEEE80211_H
9
10 #include <linux/ieee80211.h>
11
12 #define MGMT_QUEUE_NUM 5
13
14 #define ETH_ALEN        6
15 #define ETH_TYPE_LEN            2
16 #define PAYLOAD_TYPE_LEN        1
17
18 #define RTL_IOCTL_HOSTAPD (SIOCIWFIRSTPRIV + 28)
19
20 /* RTL871X_IOCTL_HOSTAPD ioctl() cmd: */
21 enum {
22         RTL871X_HOSTAPD_FLUSH = 1,
23         RTL871X_HOSTAPD_ADD_STA = 2,
24         RTL871X_HOSTAPD_REMOVE_STA = 3,
25         RTL871X_HOSTAPD_GET_INFO_STA = 4,
26         /* REMOVED: PRISM2_HOSTAPD_RESET_TXEXC_STA = 5, */
27         RTL871X_HOSTAPD_GET_WPAIE_STA = 5,
28         RTL871X_SET_ENCRYPTION = 6,
29         RTL871X_GET_ENCRYPTION = 7,
30         RTL871X_HOSTAPD_SET_FLAGS_STA = 8,
31         RTL871X_HOSTAPD_GET_RID = 9,
32         RTL871X_HOSTAPD_SET_RID = 10,
33         RTL871X_HOSTAPD_SET_ASSOC_AP_ADDR = 11,
34         RTL871X_HOSTAPD_SET_GENERIC_ELEMENT = 12,
35         RTL871X_HOSTAPD_MLME = 13,
36         RTL871X_HOSTAPD_SCAN_REQ = 14,
37         RTL871X_HOSTAPD_STA_CLEAR_STATS = 15,
38         RTL871X_HOSTAPD_SET_BEACON = 16,
39         RTL871X_HOSTAPD_SET_WPS_BEACON = 17,
40         RTL871X_HOSTAPD_SET_WPS_PROBE_RESP = 18,
41         RTL871X_HOSTAPD_SET_WPS_ASSOC_RESP = 19,
42         RTL871X_HOSTAPD_SET_HIDDEN_SSID = 20,
43         RTL871X_HOSTAPD_SET_MACADDR_ACL = 21,
44         RTL871X_HOSTAPD_ACL_ADD_STA = 22,
45         RTL871X_HOSTAPD_ACL_REMOVE_STA = 23,
46 };
47
48 /* STA flags */
49 #define WLAN_STA_AUTH BIT(0)
50 #define WLAN_STA_ASSOC BIT(1)
51 #define WLAN_STA_PS BIT(2)
52 #define WLAN_STA_TIM BIT(3)
53 #define WLAN_STA_PERM BIT(4)
54 #define WLAN_STA_AUTHORIZED BIT(5)
55 #define WLAN_STA_PENDING_POLL BIT(6) /* pending activity poll not ACKed */
56 #define WLAN_STA_SHORT_PREAMBLE BIT(7)
57 #define WLAN_STA_PREAUTH BIT(8)
58 #define WLAN_STA_WME BIT(9)
59 #define WLAN_STA_MFP BIT(10)
60 #define WLAN_STA_HT BIT(11)
61 #define WLAN_STA_WPS BIT(12)
62 #define WLAN_STA_MAYBE_WPS BIT(13)
63 #define WLAN_STA_NONERP BIT(31)
64
65 #define IEEE_CMD_SET_WPA_PARAM                  1
66 #define IEEE_CMD_SET_WPA_IE                             2
67 #define IEEE_CMD_SET_ENCRYPTION                 3
68 #define IEEE_CMD_MLME                                           4
69
70 #define IEEE_PARAM_WPA_ENABLED                          1
71 #define IEEE_PARAM_TKIP_COUNTERMEASURES         2
72 #define IEEE_PARAM_DROP_UNENCRYPTED                     3
73 #define IEEE_PARAM_PRIVACY_INVOKED                      4
74 #define IEEE_PARAM_AUTH_ALGS                                    5
75 #define IEEE_PARAM_IEEE_802_1X                          6
76 #define IEEE_PARAM_WPAX_SELECT                          7
77
78 #define IEEE_MLME_STA_DEAUTH                            1
79 #define IEEE_MLME_STA_DISASSOC                  2
80
81 #define IEEE_CRYPT_ERR_UNKNOWN_ALG                      2
82 #define IEEE_CRYPT_ERR_UNKNOWN_ADDR                     3
83 #define IEEE_CRYPT_ERR_CRYPT_INIT_FAILED                4
84 #define IEEE_CRYPT_ERR_KEY_SET_FAILED                   5
85 #define IEEE_CRYPT_ERR_TX_KEY_SET_FAILED                6
86 #define IEEE_CRYPT_ERR_CARD_CONF_FAILED         7
87
88
89 #define IEEE_CRYPT_ALG_NAME_LEN                 16
90
91 #define WPA_CIPHER_NONE         BIT(0)
92 #define WPA_CIPHER_WEP40        BIT(1)
93 #define WPA_CIPHER_WEP104 BIT(2)
94 #define WPA_CIPHER_TKIP         BIT(3)
95 #define WPA_CIPHER_CCMP         BIT(4)
96
97
98
99 #define WPA_SELECTOR_LEN 4
100 extern u8 RTW_WPA_OUI_TYPE[];
101 extern u16 RTW_WPA_VERSION;
102 extern u8 WPA_AUTH_KEY_MGMT_NONE[];
103 extern u8 WPA_AUTH_KEY_MGMT_UNSPEC_802_1X[];
104 extern u8 WPA_AUTH_KEY_MGMT_PSK_OVER_802_1X[];
105 extern u8 WPA_CIPHER_SUITE_NONE[];
106 extern u8 WPA_CIPHER_SUITE_WEP40[];
107 extern u8 WPA_CIPHER_SUITE_TKIP[];
108 extern u8 WPA_CIPHER_SUITE_WRAP[];
109 extern u8 WPA_CIPHER_SUITE_CCMP[];
110 extern u8 WPA_CIPHER_SUITE_WEP104[];
111
112
113 #define RSN_HEADER_LEN 4
114 #define RSN_SELECTOR_LEN 4
115
116 extern u16 RSN_VERSION_BSD;
117 extern u8 RSN_AUTH_KEY_MGMT_UNSPEC_802_1X[];
118 extern u8 RSN_AUTH_KEY_MGMT_PSK_OVER_802_1X[];
119 extern u8 RSN_CIPHER_SUITE_NONE[];
120 extern u8 RSN_CIPHER_SUITE_WEP40[];
121 extern u8 RSN_CIPHER_SUITE_TKIP[];
122 extern u8 RSN_CIPHER_SUITE_WRAP[];
123 extern u8 RSN_CIPHER_SUITE_CCMP[];
124 extern u8 RSN_CIPHER_SUITE_WEP104[];
125
126
127 enum {
128         RATEID_IDX_BGN_40M_2SS = 0,
129         RATEID_IDX_BGN_40M_1SS = 1,
130         RATEID_IDX_BGN_20M_2SS_BN = 2,
131         RATEID_IDX_BGN_20M_1SS_BN = 3,
132         RATEID_IDX_GN_N2SS = 4,
133         RATEID_IDX_GN_N1SS = 5,
134         RATEID_IDX_BG = 6,
135         RATEID_IDX_G = 7,
136         RATEID_IDX_B = 8,
137 };
138
139 enum network_type {
140         WIRELESS_INVALID = 0,
141         /* Sub-Element */
142         WIRELESS_11B = BIT(0), /*  tx: cck only , rx: cck only, hw: cck */
143         WIRELESS_11G = BIT(1), /*  tx: ofdm only, rx: ofdm & cck, hw: cck & ofdm */
144         WIRELESS_11_24N = BIT(3), /*  tx: MCS only, rx: MCS & cck, hw: MCS & cck */
145         WIRELESS_AUTO = BIT(5),
146
147         /* Combination */
148         /* Type for current wireless mode */
149         WIRELESS_11BG = (WIRELESS_11B|WIRELESS_11G), /*  tx: cck & ofdm, rx: cck & ofdm & MCS, hw: cck & ofdm */
150         WIRELESS_11G_24N = (WIRELESS_11G|WIRELESS_11_24N), /*  tx: ofdm & MCS, rx: ofdm & cck & MCS, hw: cck & ofdm */
151         WIRELESS_11B_24N = (WIRELESS_11B|WIRELESS_11_24N), /*  tx: ofdm & cck & MCS, rx: ofdm & cck & MCS, hw: ofdm & cck */
152         WIRELESS_11BG_24N = (WIRELESS_11B|WIRELESS_11G|WIRELESS_11_24N), /*  tx: ofdm & cck & MCS, rx: ofdm & cck & MCS, hw: ofdm & cck */
153 };
154
155 #define SUPPORTED_24G_NETTYPE_MSK (WIRELESS_11B | WIRELESS_11G | WIRELESS_11_24N)
156
157 #define IsLegacyOnly(NetType)  ((NetType) == ((NetType) & (WIRELESS_11BG)))
158
159 #define IsSupported24G(NetType) ((NetType) & SUPPORTED_24G_NETTYPE_MSK ? true : false)
160
161 #define IsEnableHWCCK(NetType) IsSupported24G(NetType)
162 #define IsEnableHWOFDM(NetType) (((NetType) & (WIRELESS_11G|WIRELESS_11_24N)) ? true : false)
163
164 #define IsSupportedRxCCK(NetType) IsEnableHWCCK(NetType)
165 #define IsSupportedRxOFDM(NetType) IsEnableHWOFDM(NetType)
166 #define IsSupportedRxHT(NetType) IsEnableHWOFDM(NetType)
167
168 #define IsSupportedTxCCK(NetType) (((NetType) & (WIRELESS_11B)) ? true : false)
169 #define IsSupportedTxOFDM(NetType) (((NetType) & (WIRELESS_11G) ? true : false)
170 #define IsSupportedHT(NetType) (((NetType) & (WIRELESS_11_24N)) ? true : false)
171
172 struct ieee_param {
173         u32 cmd;
174         u8 sta_addr[ETH_ALEN];
175         union {
176                 struct {
177                         u8 name;
178                         u32 value;
179                 } wpa_param;
180                 struct {
181                         u32 len;
182                         u8 reserved[32];
183                         u8 data[0];
184                 } wpa_ie;
185                 struct{
186                         int command;
187                         int reason_code;
188                 } mlme;
189                 struct {
190                         u8 alg[IEEE_CRYPT_ALG_NAME_LEN];
191                         u8 set_tx;
192                         u32 err;
193                         u8 idx;
194                         u8 seq[8]; /* sequence counter (set: RX, get: TX) */
195                         u16 key_len;
196                         u8 key[0];
197                 } crypt;
198                 struct {
199                         u16 aid;
200                         u16 capability;
201                         int flags;
202                         u8 tx_supp_rates[16];
203                         struct ieee80211_ht_cap ht_cap;
204                 } add_sta;
205                 struct {
206                         u8 reserved[2];/* for set max_num_sta */
207                         u8 buf[0];
208                 } bcn_ie;
209         } u;
210 };
211
212 struct ieee_param_ex {
213         u32 cmd;
214         u8 sta_addr[ETH_ALEN];
215         u8 data[0];
216 };
217
218 struct sta_data {
219         u16 aid;
220         u16 capability;
221         int flags;
222         u32 sta_set;
223         u8 tx_supp_rates[16];
224         u32 tx_supp_rates_len;
225         struct ieee80211_ht_cap ht_cap;
226         u64     rx_pkts;
227         u64     rx_bytes;
228         u64     rx_drops;
229         u64     tx_pkts;
230         u64     tx_bytes;
231         u64     tx_drops;
232 };
233
234 /* this is stolen from ipw2200 driver */
235 #define IEEE_IBSS_MAC_HASH_SIZE 31
236
237 struct eapol {
238         u8 snap[6];
239         u16 ethertype;
240         u8 version;
241         u8 type;
242         u16 length;
243 } __attribute__ ((packed));
244
245 #define IEEE80211_FCS_LEN    4
246
247 #define MIN_FRAG_THRESHOLD     256U
248 #define MAX_FRAG_THRESHOLD     2346U
249
250 /* sequence control field */
251 #define RTW_IEEE80211_SCTL_FRAG 0x000F
252 #define RTW_IEEE80211_SCTL_SEQ  0xFFF0
253
254
255 #define RTW_ERP_INFO_NON_ERP_PRESENT BIT(0)
256 #define RTW_ERP_INFO_USE_PROTECTION BIT(1)
257 #define RTW_ERP_INFO_BARKER_PREAMBLE_MODE BIT(2)
258
259 /* QoS, QOS */
260 #define NORMAL_ACK                      0
261 #define NO_ACK                          1
262 #define NON_EXPLICIT_ACK        2
263 #define BLOCK_ACK                       3
264
265 #ifndef ETH_P_PAE
266 #define ETH_P_PAE 0x888E /* Port Access Entity (IEEE 802.1X) */
267 #endif /* ETH_P_PAE */
268
269 #define ETH_P_PREAUTH 0x88C7 /* IEEE 802.11i pre-authentication */
270
271 #define ETH_P_ECONET    0x0018
272
273 #ifndef ETH_P_80211_RAW
274 #define ETH_P_80211_RAW (ETH_P_ECONET + 1)
275 #endif
276
277 /* IEEE 802.11 defines */
278
279 #define P80211_OUI_LEN 3
280
281 struct ieee80211_snap_hdr {
282         u8    dsap;   /* always 0xAA */
283         u8    ssap;   /* always 0xAA */
284         u8    ctrl;   /* always 0x03 */
285         u8    oui[P80211_OUI_LEN];    /* organizational universal id */
286 } __attribute__ ((packed));
287
288 #define SNAP_SIZE sizeof(struct ieee80211_snap_hdr)
289
290 #define WLAN_FC_GET_TYPE(fc) ((fc) & IEEE80211_FCTL_FTYPE)
291 #define WLAN_FC_GET_STYPE(fc) ((fc) & IEEE80211_FCTL_STYPE)
292
293 #define WLAN_QC_GET_TID(qc) ((qc) & 0x0f)
294
295 #define WLAN_GET_SEQ_FRAG(seq) ((seq) & RTW_IEEE80211_SCTL_FRAG)
296 #define WLAN_GET_SEQ_SEQ(seq)  ((seq) & RTW_IEEE80211_SCTL_SEQ)
297
298 /* Reason codes */
299 #define WLAN_REASON_ACTIVE_ROAM 65533
300 #define WLAN_REASON_JOIN_WRONG_CHANNEL       65534
301 #define WLAN_REASON_EXPIRATION_CHK 65535
302
303 #define IEEE80211_MGMT_HDR_LEN 24
304 #define IEEE80211_DATA_HDR3_LEN 24
305 #define IEEE80211_DATA_HDR4_LEN 30
306
307
308 #define IEEE80211_STATMASK_SIGNAL (1<<0)
309 #define IEEE80211_STATMASK_RSSI (1<<1)
310 #define IEEE80211_STATMASK_NOISE (1<<2)
311 #define IEEE80211_STATMASK_RATE (1<<3)
312 #define IEEE80211_STATMASK_WEMASK 0x7
313
314
315 #define IEEE80211_CCK_MODULATION    (1<<0)
316 #define IEEE80211_OFDM_MODULATION   (1<<1)
317
318 #define IEEE80211_24GHZ_BAND     (1<<0)
319 #define IEEE80211_52GHZ_BAND     (1<<1)
320
321 #define IEEE80211_CCK_RATE_LEN                  4
322 #define IEEE80211_NUM_OFDM_RATESLEN     8
323
324
325 #define IEEE80211_CCK_RATE_1MB                  0x02
326 #define IEEE80211_CCK_RATE_2MB                  0x04
327 #define IEEE80211_CCK_RATE_5MB                  0x0B
328 #define IEEE80211_CCK_RATE_11MB                 0x16
329 #define IEEE80211_OFDM_RATE_LEN                 8
330 #define IEEE80211_OFDM_RATE_6MB                 0x0C
331 #define IEEE80211_OFDM_RATE_9MB                 0x12
332 #define IEEE80211_OFDM_RATE_12MB                0x18
333 #define IEEE80211_OFDM_RATE_18MB                0x24
334 #define IEEE80211_OFDM_RATE_24MB                0x30
335 #define IEEE80211_OFDM_RATE_36MB                0x48
336 #define IEEE80211_OFDM_RATE_48MB                0x60
337 #define IEEE80211_OFDM_RATE_54MB                0x6C
338 #define IEEE80211_BASIC_RATE_MASK               0x80
339
340 #define IEEE80211_CCK_RATE_1MB_MASK             (1<<0)
341 #define IEEE80211_CCK_RATE_2MB_MASK             (1<<1)
342 #define IEEE80211_CCK_RATE_5MB_MASK             (1<<2)
343 #define IEEE80211_CCK_RATE_11MB_MASK            (1<<3)
344 #define IEEE80211_OFDM_RATE_6MB_MASK            (1<<4)
345 #define IEEE80211_OFDM_RATE_9MB_MASK            (1<<5)
346 #define IEEE80211_OFDM_RATE_12MB_MASK           (1<<6)
347 #define IEEE80211_OFDM_RATE_18MB_MASK           (1<<7)
348 #define IEEE80211_OFDM_RATE_24MB_MASK           (1<<8)
349 #define IEEE80211_OFDM_RATE_36MB_MASK           (1<<9)
350 #define IEEE80211_OFDM_RATE_48MB_MASK           (1<<10)
351 #define IEEE80211_OFDM_RATE_54MB_MASK           (1<<11)
352
353 #define IEEE80211_CCK_RATES_MASK                0x0000000F
354 #define IEEE80211_CCK_BASIC_RATES_MASK  (IEEE80211_CCK_RATE_1MB_MASK | \
355         IEEE80211_CCK_RATE_2MB_MASK)
356 #define IEEE80211_CCK_DEFAULT_RATES_MASK        (IEEE80211_CCK_BASIC_RATES_MASK | \
357         IEEE80211_CCK_RATE_5MB_MASK | \
358         IEEE80211_CCK_RATE_11MB_MASK)
359
360 #define IEEE80211_OFDM_RATES_MASK               0x00000FF0
361 #define IEEE80211_OFDM_BASIC_RATES_MASK (IEEE80211_OFDM_RATE_6MB_MASK | \
362         IEEE80211_OFDM_RATE_12MB_MASK | \
363         IEEE80211_OFDM_RATE_24MB_MASK)
364 #define IEEE80211_OFDM_DEFAULT_RATES_MASK       (IEEE80211_OFDM_BASIC_RATES_MASK | \
365         IEEE80211_OFDM_RATE_9MB_MASK  | \
366         IEEE80211_OFDM_RATE_18MB_MASK | \
367         IEEE80211_OFDM_RATE_36MB_MASK | \
368         IEEE80211_OFDM_RATE_48MB_MASK | \
369         IEEE80211_OFDM_RATE_54MB_MASK)
370 #define IEEE80211_DEFAULT_RATES_MASK (IEEE80211_OFDM_DEFAULT_RATES_MASK | \
371                                 IEEE80211_CCK_DEFAULT_RATES_MASK)
372
373 #define IEEE80211_NUM_OFDM_RATES            8
374 #define IEEE80211_NUM_CCK_RATES             4
375 #define IEEE80211_OFDM_SHIFT_MASK_A         4
376
377
378 enum {
379         MGN_1M          = 0x02,
380         MGN_2M          = 0x04,
381         MGN_5_5M        = 0x0B,
382         MGN_6M          = 0x0C,
383         MGN_9M          = 0x12,
384         MGN_11M         = 0x16,
385         MGN_12M = 0x18,
386         MGN_18M = 0x24,
387         MGN_24M = 0x30,
388         MGN_36M = 0x48,
389         MGN_48M = 0x60,
390         MGN_54M = 0x6C,
391         MGN_MCS32       = 0x7F,
392         MGN_MCS0,
393         MGN_MCS1,
394         MGN_MCS2,
395         MGN_MCS3,
396         MGN_MCS4,
397         MGN_MCS5,
398         MGN_MCS6,
399         MGN_MCS7,
400         MGN_MCS8,
401         MGN_MCS9,
402         MGN_MCS10,
403         MGN_MCS11,
404         MGN_MCS12,
405         MGN_MCS13,
406         MGN_MCS14,
407         MGN_MCS15,
408         MGN_MCS16,
409         MGN_MCS17,
410         MGN_MCS18,
411         MGN_MCS19,
412         MGN_MCS20,
413         MGN_MCS21,
414         MGN_MCS22,
415         MGN_MCS23,
416         MGN_MCS24,
417         MGN_MCS25,
418         MGN_MCS26,
419         MGN_MCS27,
420         MGN_MCS28,
421         MGN_MCS29,
422         MGN_MCS30,
423         MGN_MCS31,
424         MGN_UNKNOWN
425 };
426
427 #define IS_HT_RATE(_rate)                               (_rate >= MGN_MCS0 && _rate <= MGN_MCS31)
428 #define IS_CCK_RATE(_rate)                              (MGN_1M == _rate || _rate == MGN_2M || _rate == MGN_5_5M || _rate == MGN_11M)
429 #define IS_OFDM_RATE(_rate)                             (MGN_6M <= _rate && _rate <= MGN_54M  && _rate != MGN_11M)
430
431
432 /* NOTE: This data is for statistical purposes; not all hardware provides this
433  *       information for frames received.  Not setting these will not cause
434  *       any adverse affects. */
435
436 /* IEEE 802.11 requires that STA supports concurrent reception of at least
437  * three fragmented frames. This define can be increased to support more
438  * concurrent frames, but it should be noted that each entry can consume about
439  * 2 kB of RAM and increasing cache size will slow down frame reassembly. */
440 #define IEEE80211_FRAG_CACHE_LEN 4
441
442 #define SEC_KEY_1         (1<<0)
443 #define SEC_KEY_2         (1<<1)
444 #define SEC_KEY_3         (1<<2)
445 #define SEC_KEY_4         (1<<3)
446 #define SEC_ACTIVE_KEY    (1<<4)
447 #define SEC_AUTH_MODE     (1<<5)
448 #define SEC_UNICAST_GROUP (1<<6)
449 #define SEC_LEVEL         (1<<7)
450 #define SEC_ENABLED       (1<<8)
451
452 #define SEC_LEVEL_0      0 /* None */
453 #define SEC_LEVEL_1      1 /* WEP 40 and 104 bit */
454 #define SEC_LEVEL_2      2 /* Level 1 + TKIP */
455 #define SEC_LEVEL_2_CKIP 3 /* Level 1 + CKIP */
456 #define SEC_LEVEL_3      4 /* Level 2 + CCMP */
457
458 #define WEP_KEYS 4
459 #define WEP_KEY_LEN 13
460
461 #define BIP_MAX_KEYID 5
462 #define BIP_AAD_SIZE  20
463
464 /*
465
466  802.11 data frame from AP
467
468       ,-------------------------------------------------------------------.
469 Bytes |  2   |  2   |    6    |    6    |    6    |  2   | 0..2312 |   4  |
470       |------|------|---------|---------|---------|------|---------|------|
471 Desc. | ctrl | dura |  DA/RA  |   TA    |    SA   | Sequ |  frame  |  fcs |
472       |      | tion | (BSSID) |         |         | ence |  data   |      |
473       `-------------------------------------------------------------------'
474
475 Total: 28-2340 bytes
476
477 */
478
479 #define BEACON_PROBE_SSID_ID_POSITION 12
480
481 /* Management Frame Information Element Types */
482 #define MFIE_TYPE_SSID       0
483 #define MFIE_TYPE_RATES      1
484 #define MFIE_TYPE_FH_SET     2
485 #define MFIE_TYPE_DS_SET     3
486 #define MFIE_TYPE_CF_SET     4
487 #define MFIE_TYPE_TIM        5
488 #define MFIE_TYPE_IBSS_SET   6
489 #define MFIE_TYPE_CHALLENGE  16
490 #define MFIE_TYPE_ERP        42
491 #define MFIE_TYPE_RSN        48
492 #define MFIE_TYPE_RATES_EX   50
493 #define MFIE_TYPE_GENERIC    221
494
495 /* SWEEP TABLE ENTRIES NUMBER*/
496 #define MAX_SWEEP_TAB_ENTRIES             42
497 #define MAX_SWEEP_TAB_ENTRIES_PER_PACKET  7
498 /* MAX_RATES_LENGTH needs to be 12.  The spec says 8, and many APs
499  * only use 8, and then use extended rates for the remaining supported
500  * rates.  Other APs, however, stick all of their supported rates on the
501  * main rates information element... */
502 #define MAX_RATES_LENGTH                  ((u8)12)
503 #define MAX_RATES_EX_LENGTH               ((u8)16)
504 #define MAX_NETWORK_COUNT                  128
505 #define MAX_CHANNEL_NUMBER                 161
506 #define IEEE80211_SOFTMAC_SCAN_TIME       400
507 /* HZ / 2) */
508 #define IEEE80211_SOFTMAC_ASSOC_RETRY_TIME (HZ * 2)
509
510 #define CRC_LENGTH                 4U
511
512 #define MAX_WPA_IE_LEN (256)
513 #define MAX_WPS_IE_LEN (512)
514 #define MAX_P2P_IE_LEN (256)
515 #define MAX_WFD_IE_LEN (128)
516
517 #define NETWORK_EMPTY_ESSID (1<<0)
518 #define NETWORK_HAS_OFDM    (1<<1)
519 #define NETWORK_HAS_CCK     (1<<2)
520
521 #define IEEE80211_DTIM_MBCAST 4
522 #define IEEE80211_DTIM_UCAST 2
523 #define IEEE80211_DTIM_VALID 1
524 #define IEEE80211_DTIM_INVALID 0
525
526 #define IEEE80211_PS_DISABLED 0
527 #define IEEE80211_PS_UNICAST IEEE80211_DTIM_UCAST
528 #define IEEE80211_PS_MBCAST IEEE80211_DTIM_MBCAST
529 #define IW_ESSID_MAX_SIZE 32
530 /*
531 join_res:
532 -1: authentication fail
533 -2: association fail
534 > 0: TID
535 */
536
537 #define DEFAULT_MAX_SCAN_AGE (15 * HZ)
538 #define DEFAULT_FTS 2346
539 #define MAC_ARG(x) (x)
540 #define IP_ARG(x) (x)
541
542 static inline int is_multicast_mac_addr(const u8 *addr)
543 {
544         return ((addr[0] != 0xff) && (0x01 & addr[0]));
545 }
546
547 static inline int is_broadcast_mac_addr(const u8 *addr)
548 {
549         return ((addr[0] == 0xff) && (addr[1] == 0xff) && (addr[2] == 0xff) &&   \
550                 (addr[3] == 0xff) && (addr[4] == 0xff) && (addr[5] == 0xff));
551 }
552
553 static inline int is_zero_mac_addr(const u8 *addr)
554 {
555         return ((addr[0] == 0x00) && (addr[1] == 0x00) && (addr[2] == 0x00) &&   \
556                 (addr[3] == 0x00) && (addr[4] == 0x00) && (addr[5] == 0x00));
557 }
558
559 #define CFG_IEEE80211_RESERVE_FCS (1<<0)
560 #define CFG_IEEE80211_COMPUTE_FCS (1<<1)
561
562 #define MAXTID  16
563
564 #define IEEE_A            (1<<0)
565 #define IEEE_B            (1<<1)
566 #define IEEE_G            (1<<2)
567 #define IEEE_MODE_MASK    (IEEE_A|IEEE_B|IEEE_G)
568
569 /* Action category code */
570 enum {
571         RTW_WLAN_CATEGORY_SPECTRUM_MGMT = 0,
572         RTW_WLAN_CATEGORY_QOS = 1,
573         RTW_WLAN_CATEGORY_DLS = 2,
574         RTW_WLAN_CATEGORY_BACK = 3,
575         RTW_WLAN_CATEGORY_PUBLIC = 4, /* IEEE 802.11 public action frames */
576         RTW_WLAN_CATEGORY_RADIO_MEASUREMENT  = 5,
577         RTW_WLAN_CATEGORY_FT = 6,
578         RTW_WLAN_CATEGORY_HT = 7,
579         RTW_WLAN_CATEGORY_SA_QUERY = 8,
580         RTW_WLAN_CATEGORY_UNPROTECTED_WNM = 11, /*  add for CONFIG_IEEE80211W, none 11w also can use */
581         RTW_WLAN_CATEGORY_TDLS = 12,
582         RTW_WLAN_CATEGORY_SELF_PROTECTED = 15, /*  add for CONFIG_IEEE80211W, none 11w also can use */
583         RTW_WLAN_CATEGORY_WMM = 17,
584         RTW_WLAN_CATEGORY_P2P = 0x7f,/* P2P action frames */
585 };
586
587 enum {
588         ACT_PUBLIC_BSSCOEXIST = 0, /*  20/40 BSS Coexistence */
589         ACT_PUBLIC_DSE_ENABLE = 1,
590         ACT_PUBLIC_DSE_DEENABLE = 2,
591         ACT_PUBLIC_DSE_REG_LOCATION = 3,
592         ACT_PUBLIC_EXT_CHL_SWITCH = 4,
593         ACT_PUBLIC_DSE_MSR_REQ = 5,
594         ACT_PUBLIC_DSE_MSR_RPRT = 6,
595         ACT_PUBLIC_MP = 7, /*  Measurement Pilot */
596         ACT_PUBLIC_DSE_PWR_CONSTRAINT = 8,
597         ACT_PUBLIC_VENDOR = 9, /*  for WIFI_DIRECT */
598         ACT_PUBLIC_GAS_INITIAL_REQ = 10,
599         ACT_PUBLIC_GAS_INITIAL_RSP = 11,
600         ACT_PUBLIC_GAS_COMEBACK_REQ = 12,
601         ACT_PUBLIC_GAS_COMEBACK_RSP = 13,
602         ACT_PUBLIC_TDLS_DISCOVERY_RSP = 14,
603         ACT_PUBLIC_LOCATION_TRACK = 15,
604         ACT_PUBLIC_MAX
605 };
606
607 #define OUI_MICROSOFT 0x0050f2 /* Microsoft (also used in Wi-Fi specs)
608                                 * 00:50:F2 */
609 #define WME_OUI_TYPE 2
610 #define WME_OUI_SUBTYPE_INFORMATION_ELEMENT 0
611 #define WME_OUI_SUBTYPE_PARAMETER_ELEMENT 1
612 #define WME_OUI_SUBTYPE_TSPEC_ELEMENT 2
613 #define WME_VERSION 1
614
615 #define WME_ACTION_CODE_SETUP_REQUEST 0
616 #define WME_ACTION_CODE_SETUP_RESPONSE 1
617 #define WME_ACTION_CODE_TEARDOWN 2
618
619 #define WME_SETUP_RESPONSE_STATUS_ADMISSION_ACCEPTED 0
620 #define WME_SETUP_RESPONSE_STATUS_INVALID_PARAMETERS 1
621 #define WME_SETUP_RESPONSE_STATUS_REFUSED 3
622
623 #define WME_TSPEC_DIRECTION_UPLINK 0
624 #define WME_TSPEC_DIRECTION_DOWNLINK 1
625 #define WME_TSPEC_DIRECTION_BI_DIRECTIONAL 3
626
627
628 #define OUI_BROADCOM 0x00904c /* Broadcom (Epigram) */
629
630 #define VENDOR_HT_CAPAB_OUI_TYPE 0x33 /* 00-90-4c:0x33 */
631
632 /**
633  * enum rtw_ieee80211_channel_flags - channel flags
634  *
635  * Channel flags set by the regulatory control code.
636  *
637  * @RTW_IEEE80211_CHAN_DISABLED: This channel is disabled.
638  * @RTW_IEEE80211_CHAN_PASSIVE_SCAN: Only passive scanning is permitted
639  *      on this channel.
640  * @RTW_IEEE80211_CHAN_NO_IBSS: IBSS is not allowed on this channel.
641  * @RTW_IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
642  * @RTW_IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
643  *      is not permitted.
644  * @RTW_IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
645  *      is not permitted.
646  */
647   enum rtw_ieee80211_channel_flags {
648           RTW_IEEE80211_CHAN_DISABLED         = 1<<0,
649           RTW_IEEE80211_CHAN_PASSIVE_SCAN     = 1<<1,
650           RTW_IEEE80211_CHAN_NO_IBSS          = 1<<2,
651           RTW_IEEE80211_CHAN_RADAR            = 1<<3,
652           RTW_IEEE80211_CHAN_NO_HT40PLUS      = 1<<4,
653           RTW_IEEE80211_CHAN_NO_HT40MINUS     = 1<<5,
654   };
655
656   #define RTW_IEEE80211_CHAN_NO_HT40 \
657           (RTW_IEEE80211_CHAN_NO_HT40PLUS | RTW_IEEE80211_CHAN_NO_HT40MINUS)
658
659 /* Represent channel details, subset of ieee80211_channel */
660 struct rtw_ieee80211_channel {
661         /* enum nl80211_band band; */
662         /* u16 center_freq; */
663         u16 hw_value;
664         u32 flags;
665         /* int max_antenna_gain; */
666         /* int max_power; */
667         /* int max_reg_power; */
668         /* bool beacon_found; */
669         /* u32 orig_flags; */
670         /* int orig_mag; */
671         /* int orig_mpwr; */
672 };
673
674 #define CHAN_FMT \
675         /*"band:%d, "*/ \
676         /*"center_freq:%u, "*/ \
677         "hw_value:%u, " \
678         "flags:0x%08x" \
679         /*"max_antenna_gain:%d\n"*/ \
680         /*"max_power:%d\n"*/ \
681         /*"max_reg_power:%d\n"*/ \
682         /*"beacon_found:%u\n"*/ \
683         /*"orig_flags:0x%08x\n"*/ \
684         /*"orig_mag:%d\n"*/ \
685         /*"orig_mpwr:%d\n"*/
686
687 #define CHAN_ARG(channel) \
688         /*(channel)->band*/ \
689         /*, (channel)->center_freq*/ \
690         (channel)->hw_value \
691         , (channel)->flags \
692         /*, (channel)->max_antenna_gain*/ \
693         /*, (channel)->max_power*/ \
694         /*, (channel)->max_reg_power*/ \
695         /*, (channel)->beacon_found*/ \
696         /*, (channel)->orig_flags*/ \
697         /*, (channel)->orig_mag*/ \
698         /*, (channel)->orig_mpwr*/ \
699
700 /* Parsed Information Elements */
701 struct rtw_ieee802_11_elems {
702         u8 *ssid;
703         u8 ssid_len;
704         u8 *supp_rates;
705         u8 supp_rates_len;
706         u8 *fh_params;
707         u8 fh_params_len;
708         u8 *ds_params;
709         u8 ds_params_len;
710         u8 *cf_params;
711         u8 cf_params_len;
712         u8 *tim;
713         u8 tim_len;
714         u8 *ibss_params;
715         u8 ibss_params_len;
716         u8 *challenge;
717         u8 challenge_len;
718         u8 *erp_info;
719         u8 erp_info_len;
720         u8 *ext_supp_rates;
721         u8 ext_supp_rates_len;
722         u8 *wpa_ie;
723         u8 wpa_ie_len;
724         u8 *rsn_ie;
725         u8 rsn_ie_len;
726         u8 *wme;
727         u8 wme_len;
728         u8 *wme_tspec;
729         u8 wme_tspec_len;
730         u8 *wps_ie;
731         u8 wps_ie_len;
732         u8 *power_cap;
733         u8 power_cap_len;
734         u8 *supp_channels;
735         u8 supp_channels_len;
736         u8 *mdie;
737         u8 mdie_len;
738         u8 *ftie;
739         u8 ftie_len;
740         u8 *timeout_int;
741         u8 timeout_int_len;
742         u8 *ht_capabilities;
743         u8 ht_capabilities_len;
744         u8 *ht_operation;
745         u8 ht_operation_len;
746         u8 *vendor_ht_cap;
747         u8 vendor_ht_cap_len;
748         u8 *vht_capabilities;
749         u8 vht_capabilities_len;
750         u8 *vht_operation;
751         u8 vht_operation_len;
752         u8 *vht_op_mode_notify;
753         u8 vht_op_mode_notify_len;
754 };
755
756 enum ParseRes { ParseOK = 0, ParseUnknown = 1, ParseFailed = -1 };
757
758 enum ParseRes rtw_ieee802_11_parse_elems(u8 *start, uint len,
759                                 struct rtw_ieee802_11_elems *elems,
760                                 int show_errors);
761
762 u8 *rtw_set_fixed_ie(unsigned char *pbuf, unsigned int len, unsigned char *source, unsigned int *frlen);
763 u8 *rtw_set_ie(u8 *pbuf, signed int index, uint len, u8 *source, uint *frlen);
764
765 u8 *rtw_get_ie(u8 *pbuf, signed int index, signed int *len, signed int limit);
766 u8 *rtw_get_ie_ex(u8 *in_ie, uint in_len, u8 eid, u8 *oui, u8 oui_len, u8 *ie, uint *ielen);
767 int rtw_ies_remove_ie(u8 *ies, uint *ies_len, uint offset, u8 eid, u8 *oui, u8 oui_len);
768
769 void rtw_set_supported_rate(u8 *SupportedRates, uint mode);
770
771 unsigned char *rtw_get_wpa_ie(unsigned char *pie, int *wpa_ie_len, int limit);
772 unsigned char *rtw_get_wpa2_ie(unsigned char *pie, int *rsn_ie_len, int limit);
773 int rtw_get_wpa_cipher_suite(u8 *s);
774 int rtw_get_wpa2_cipher_suite(u8 *s);
775 int rtw_get_wapi_ie(u8 *in_ie, uint in_len, u8 *wapi_ie, u16 *wapi_len);
776 int rtw_parse_wpa_ie(u8 *wpa_ie, int wpa_ie_len, int *group_cipher, int *pairwise_cipher, int *is_8021x);
777 int rtw_parse_wpa2_ie(u8 *wpa_ie, int wpa_ie_len, int *group_cipher, int *pairwise_cipher, int *is_8021x);
778
779 void rtw_get_sec_ie(u8 *in_ie, uint in_len, u8 *rsn_ie, u16 *rsn_len, u8 *wpa_ie, u16 *wpa_len);
780
781 u8 rtw_is_wps_ie(u8 *ie_ptr, uint *wps_ielen);
782 u8 *rtw_get_wps_ie(u8 *in_ie, uint in_len, u8 *wps_ie, uint *wps_ielen);
783 u8 *rtw_get_wps_attr(u8 *wps_ie, uint wps_ielen, u16 target_attr_id, u8 *buf_attr, u32 *len_attr);
784 u8 *rtw_get_wps_attr_content(u8 *wps_ie, uint wps_ielen, u16 target_attr_id, u8 *buf_content, uint *len_content);
785
786 /**
787  * for_each_ie - iterate over continuous IEs
788  * @ie:
789  * @buf:
790  * @buf_len:
791  */
792 #define for_each_ie(ie, buf, buf_len) \
793         for (ie = (void *)buf; (((u8 *)ie) - ((u8 *)buf) + 1) < buf_len; \
794                 ie = (void *)(((u8 *)ie) + *(((u8 *)ie) + 1) + 2))
795
796 uint    rtw_get_rateset_len(u8 *rateset);
797
798 struct registry_priv;
799 int rtw_generate_ie(struct registry_priv *pregistrypriv);
800
801
802 int rtw_get_bit_value_from_ieee_value(u8 val);
803
804 bool rtw_is_cckrates_included(u8 *rate);
805
806 bool rtw_is_cckratesonly_included(u8 *rate);
807
808 int rtw_check_network_type(unsigned char *rate, int ratelen, int channel);
809
810 void rtw_get_bcn_info(struct wlan_network *pnetwork);
811
812 void rtw_macaddr_cfg(struct device *dev, u8 *mac_addr);
813
814 u16 rtw_mcs_rate(u8 rf_type, u8 bw_40MHz, u8 short_GI, unsigned char *MCS_rate);
815
816 int rtw_action_frame_parse(const u8 *frame, u32 frame_len, u8 *category, u8 *action);
817 const char *action_public_str(u8 action);
818
819 #endif /* IEEE80211_H */