1 /*++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
4 // This file contains the definitions and data structures used by SW-MAC.
9 // 0.2 20021004 PD43 CCLiu6
10 // 20021018 PD43 CCLiu6
11 // Add enum_TxRate type
12 // Modify enum_STAState type
13 // 0.3 20021023 PE23 CYLiu update MAC session struct
15 // 20021122 PD43 Austin
16 // Deleted some unused.
17 // 20021129 PD43 Austin
18 // 20030617 increase the 802.11g definition
19 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++*/
21 #ifndef _MAC_Structures_H_
22 #define _MAC_Structures_H_
24 #include <linux/skbuff.h>
26 /*=========================================================
27 // Some miscellaneous definitions
29 #define MAX_CHANNELS 30
30 #define MAC_ADDR_LENGTH 6
31 #define MAX_WEP_KEY_SIZE 16 /* 128 bits */
32 #define MAX_802_11_FRAGMENT_NUMBER 10 /* By spec */
34 /* ========================================================
35 // 802.11 Frame define
37 #define MASK_PROTOCOL_VERSION_TYPE 0x0F
38 #define MASK_FRAGMENT_NUMBER 0x000F
39 #define SEQUENCE_NUMBER_SHIFT 4
40 #define DIFFER_11_TO_3 18
41 #define DOT_11_MAC_HEADER_SIZE 24
42 #define DOT_11_SNAP_SIZE 6
43 #define DOT_11_DURATION_OFFSET 2
44 #define DOT_11_SEQUENCE_OFFSET 22 /* Sequence control offset */
45 #define DOT_11_TYPE_OFFSET 30 /* The start offset of 802.11 Frame// */
46 #define DOT_11_DATA_OFFSET 24
47 #define DOT_11_DA_OFFSET 4
48 #define DOT_3_TYPE_ARP 0x80F3
49 #define DOT_3_TYPE_IPX 0x8137
50 #define DOT_3_TYPE_OFFSET 12
53 #define ETHERNET_HEADER_SIZE 14
54 #define MAX_ETHERNET_PACKET_SIZE 1514
57 /* ----- management : Type of Bits (2, 3) and Subtype of Bits (4, 5, 6, 7) */
58 #define MAC_SUBTYPE_MNGMNT_ASSOC_REQUEST 0x00
59 #define MAC_SUBTYPE_MNGMNT_ASSOC_RESPONSE 0x10
60 #define MAC_SUBTYPE_MNGMNT_REASSOC_REQUEST 0x20
61 #define MAC_SUBTYPE_MNGMNT_REASSOC_RESPONSE 0x30
62 #define MAC_SUBTYPE_MNGMNT_PROBE_REQUEST 0x40
63 #define MAC_SUBTYPE_MNGMNT_PROBE_RESPONSE 0x50
64 #define MAC_SUBTYPE_MNGMNT_BEACON 0x80
65 #define MAC_SUBTYPE_MNGMNT_ATIM 0x90
66 #define MAC_SUBTYPE_MNGMNT_DISASSOCIATION 0xA0
67 #define MAC_SUBTYPE_MNGMNT_AUTHENTICATION 0xB0
68 #define MAC_SUBTYPE_MNGMNT_DEAUTHENTICATION 0xC0
70 /* ----- control : Type of Bits (2, 3) and Subtype of Bits (4, 5, 6, 7) */
71 #define MAC_SUBTYPE_CONTROL_PSPOLL 0xA4
72 #define MAC_SUBTYPE_CONTROL_RTS 0xB4
73 #define MAC_SUBTYPE_CONTROL_CTS 0xC4
74 #define MAC_SUBTYPE_CONTROL_ACK 0xD4
75 #define MAC_SUBTYPE_CONTROL_CFEND 0xE4
76 #define MAC_SUBTYPE_CONTROL_CFEND_CFACK 0xF4
78 /* ----- data : Type of Bits (2, 3) and Subtype of Bits (4, 5, 6, 7) */
79 #define MAC_SUBTYPE_DATA 0x08
80 #define MAC_SUBTYPE_DATA_CFACK 0x18
81 #define MAC_SUBTYPE_DATA_CFPOLL 0x28
82 #define MAC_SUBTYPE_DATA_CFACK_CFPOLL 0x38
83 #define MAC_SUBTYPE_DATA_NULL 0x48
84 #define MAC_SUBTYPE_DATA_CFACK_NULL 0x58
85 #define MAC_SUBTYPE_DATA_CFPOLL_NULL 0x68
86 #define MAC_SUBTYPE_DATA_CFACK_CFPOLL_NULL 0x78
88 /* ----- Frame Type of Bits (2, 3) */
89 #define MAC_TYPE_MANAGEMENT 0x00
90 #define MAC_TYPE_CONTROL 0x04
91 #define MAC_TYPE_DATA 0x08
93 /* ----- definitions for Management Frame Element ID (1 BYTE) */
94 #define ELEMENT_ID_SSID 0
95 #define ELEMENT_ID_SUPPORTED_RATES 1
96 #define ELEMENT_ID_FH_PARAMETER_SET 2
97 #define ELEMENT_ID_DS_PARAMETER_SET 3
98 #define ELEMENT_ID_CF_PARAMETER_SET 4
99 #define ELEMENT_ID_TIM 5
100 #define ELEMENT_ID_IBSS_PARAMETER_SET 6
102 #define ELEMENT_ID_CHALLENGE_TEXT 16
103 // 17~31 reserved for challenge text extension
106 #define ELEMENT_ID_ERP_INFORMATION 42
107 #define ELEMENT_ID_EXTENDED_SUPPORTED_RATES 50
111 #define ELEMENT_ID_RSN_WPA 221
113 #define ELEMENT_ID_RSN_WPA2 48
116 #define WLAN_MAX_PAIRWISE_CIPHER_SUITE_COUNT ((u16) 6)
117 #define WLAN_MAX_AUTH_KEY_MGT_SUITE_LIST_COUNT ((u16) 2)
119 //===================================================================
120 // Reason Code (Table 18): indicate the reason of DisAssoc, DeAuthen
121 // length of ReasonCode is 2 Octs.
122 //===================================================================
123 #define REASON_REASERED 0
124 #define REASON_UNSPECIDIED 1
125 #define REASON_PREAUTH_INVALID 2
126 #define DEAUTH_REASON_LEFT_BSS 3
127 #define DISASS_REASON_AP_INACTIVE 4
128 #define DISASS_REASON_AP_BUSY 5
129 #define REASON_CLASS2_FRAME_FROM_NONAUTH_STA 6
130 #define REASON_CLASS3_FRAME_FROM_NONASSO_STA 7
131 #define DISASS_REASON_LEFT_BSS 8
132 #define REASON_NOT_AUTH_YET 9
134 #define REASON_INVALID_IE 13
135 #define REASON_MIC_ERROR 14
136 #define REASON_4WAY_HANDSHAKE_TIMEOUT 15
137 #define REASON_GROUPKEY_UPDATE_TIMEOUT 16
138 #define REASON_IE_DIFF_4WAY_ASSOC 17
139 #define REASON_INVALID_MULTICAST_CIPHER 18
140 #define REASON_INVALID_UNICAST_CIPHER 19
141 #define REASON_INVALID_AKMP 20
142 #define REASON_UNSUPPORTED_RSNIE_VERSION 21
143 #define REASON_INVALID_RSNIE_CAPABILITY 22
144 #define REASON_802_1X_AUTH_FAIL 23
145 #define REASON_CIPHER_REJECT_PER_SEC_POLICY 14
148 //===========================================================
149 // enum_MMPDUResultCode --
150 // Status code (2 Octs) in the MMPDU's frame body. Table.19
152 //===========================================================
153 enum enum_MMPDUResultCode
155 // SUCCESS = 0, // Redefined
156 UNSPECIFIED_FAILURE = 1,
160 NOT_SUPPROT_CAPABILITIES = 10,
162 //REASSOCIATION_DENIED
164 REASSOC_DENIED_UNABLE_CFM_ASSOC_EXIST = 11,
166 //ASSOCIATION_DENIED_NOT_IN_STANDARD
168 ASSOC_DENIED_REASON_NOT_IN_STANDARD = 12,
169 PEER_NOT_SUPPORT_AUTH_ALGORITHM = 13,
170 AUTH_SEQNUM_OUT_OF_EXPECT = 14,
171 AUTH_REJECT_REASON_CHALLENGE_FAIL = 15,
172 AUTH_REJECT_REASON_WAIT_TIMEOUT = 16,
173 ASSOC_DENIED_REASON_AP_BUSY = 17,
174 ASSOC_DENIED_REASON_NOT_SUPPORT_BASIC_RATE = 18
175 } WB_MMPDURESULTCODE, *PWB_MMPDURESULTCODE;
178 /*===========================================================
180 // Define the transmission constants based on W89C32 MAC
181 // target specification.
182 //===========================================================*/
183 typedef enum enum_TxRate {
191 TXRATE_AUTO = 255 /* PD43 20021108 */
192 } WB_TXRATE, *PWB_TXRATE;
195 #define RATE_BITMAP_1M 1
196 #define RATE_BITMAP_2M 2
197 #define RATE_BITMAP_5dot5M 5
198 #define RATE_BITMAP_6M 6
199 #define RATE_BITMAP_9M 9
200 #define RATE_BITMAP_11M 11
201 #define RATE_BITMAP_12M 12
202 #define RATE_BITMAP_18M 18
203 #define RATE_BITMAP_22M 22
204 #define RATE_BITMAP_24M 24
205 #define RATE_BITMAP_33M 17
206 #define RATE_BITMAP_36M 19
207 #define RATE_BITMAP_48M 25
208 #define RATE_BITMAP_54M 28
213 #define RATE_5dot5M 11
228 #define CAPABILITY_ESS_BIT 0x0001
229 #define CAPABILITY_IBSS_BIT 0x0002
230 #define CAPABILITY_CF_POLL_BIT 0x0004
231 #define CAPABILITY_CF_POLL_REQ_BIT 0x0008
232 #define CAPABILITY_PRIVACY_BIT 0x0010
233 #define CAPABILITY_SHORT_PREAMBLE_BIT 0x0020
234 #define CAPABILITY_PBCC_BIT 0x0040
235 #define CAPABILITY_CHAN_AGILITY_BIT 0x0080
236 #define CAPABILITY_SHORT_SLOT_TIME_BIT 0x0400
237 #define CAPABILITY_DSSS_OFDM_BIT 0x2000
240 struct Capability_Information_Element {
242 u16 __attribute__ ((packed)) wValue;
243 #ifdef _BIG_ENDIAN_ /* 20060926 add by anson's endian */
249 u8 Short_Slot_Time:1;
251 u8 Channel_Agility:1;
255 u8 CF_Poll_Request:1;
259 } __attribute__ ((packed)) Capability;
265 u8 CF_Poll_Request:1;
269 u8 Channel_Agility:1;
272 u8 Short_Slot_Time:1;
276 } __attribute__ ((packed)) Capability;
278 } __attribute__ ((packed)) ;
279 } __attribute__ ((packed));
281 struct FH_Parameter_Set_Element {
290 struct DS_Parameter_Set_Element {
296 struct Supported_Rates_Element {
299 u8 SupportedRates[8];
300 } __attribute__ ((packed));
302 struct SSID_Element {
306 } __attribute__ ((packed)) ;
308 struct CF_Parameter_Set_Element {
313 u8 CFP_MaxDuration[2]; /* in Time Units */
314 u8 CFP_DurRemaining[2]; /* in time units */
323 u8 Partial_Virtual_Bitmap[251];
326 struct IBSS_Parameter_Set_Element {
332 struct Challenge_Text_Element {
335 u8 Challenge_Text[253];
338 struct PHY_Parameter_Set_Element {
342 s32 aRxTxTurnaroundTime;
350 s32 aAirPropagationTime;
351 s32 aMACProcessingDelay;
353 s32 aPLCPHeaderLength;
354 s32 aMPDUDurationFactor;
361 struct ERP_Information_Element {
364 #ifdef _BIG_ENDIAN_ /* 20060926 add by anson's endian */
365 u8 Reserved:5; /* 20060926 add by anson */
366 u8 Barker_Preamble_Mode:1;
372 u8 Barker_Preamble_Mode:1;
377 struct Extended_Supported_Rates_Element {
380 u8 ExtendedSupportedRates[255];
381 } __attribute__ ((packed));
383 /* WPA(802.11i draft 3.0) */
384 #define VERSION_WPA 1
386 #define VERSION_WPA2 1
387 #endif /* end def _WPA2_ */
388 #define OUI_WPA 0x00F25000 /* WPA2.0 OUI=00:50:F2, the MSB is reserved for suite type */
390 #define OUI_WPA2 0x00AC0F00 /* for wpa2 change to 0x00ACOF04 by Ws 26/04/04 */
391 #endif /* end def _WPA2_ */
393 #define OUI_WPA_ADDITIONAL 0x01
394 #define WLAN_MIN_RSN_WPA_LENGTH 6 /* added by ws 09/10/04 */
396 #define WLAN_MIN_RSN_WPA2_LENGTH 2 /* Fix to 2 09/14/05 */
397 #endif /* end def _WPA2_ */
399 #define oui_wpa (u32)(OUI_WPA|OUI_WPA_ADDITIONAL)
401 #define WPA_OUI_BIG ((u32) 0x01F25000)/* added by ws 09/23/04 */
402 #define WPA_OUI_LITTLE ((u32) 0x01F25001)/* added by ws 09/23/04 */
404 #define WPA_WPS_OUI cpu_to_le32(0x04F25000) /* 20061108 For WPS. It's little endian. Big endian is 0x0050F204 */
408 #define WPA2_OUI_BIG ((u32)0x01AC0F00)
409 #define WPA2_OUI_LITTLE ((u32)0x01AC0F01)
410 #endif /* end def _WPA2_ */
412 /* Authentication suite */
413 #define OUI_AUTH_WPA_NONE 0x00 /* for WPA_NONE */
414 #define OUI_AUTH_8021X 0x01
415 #define OUI_AUTH_PSK 0x02
417 #define OUI_CIPHER_GROUP_KEY 0x00 /* added by ws 05/21/04 */
418 #define OUI_CIPHER_WEP_40 0x01
419 #define OUI_CIPHER_TKIP 0x02
420 #define OUI_CIPHER_CCMP 0x04
421 #define OUI_CIPHER_WEP_104 0x05
423 struct suite_selector
437 struct RSN_Information_Element
441 struct suite_selector OuiWPAAdditional; /* WPA version 2.0 additional field, and should be 00:50:F2:01 */
443 struct suite_selector GroupKeySuite;
444 u16 PairwiseKeySuiteCount;
445 struct suite_selector PairwiseKeySuite[1];
446 }__attribute__ ((packed));
447 struct RSN_Auth_Sub_Information_Element
449 u16 AuthKeyMngtSuiteCount;
450 struct suite_selector AuthKeyMngtSuite[1];
451 }__attribute__ ((packed));
454 struct RSN_Capability_Element
458 u16 __attribute__ ((packed)) wValue;
459 #ifdef _BIG_ENDIAN_ /* 20060927 add by anson's endian */
460 struct _RSN_Capability
462 u16 __attribute__ ((packed)) Reserved2 : 8; /* 20051201 */
463 u16 __attribute__ ((packed)) Reserved1 : 2;
464 u16 __attribute__ ((packed)) GTK_Replay_Counter : 2;
465 u16 __attribute__ ((packed)) PTK_Replay_Counter : 2;
466 u16 __attribute__ ((packed)) No_Pairwise : 1;
467 u16 __attribute__ ((packed)) Pre_Auth : 1;
468 }__attribute__ ((packed)) RSN_Capability;
470 struct _RSN_Capability
472 u16 __attribute__ ((packed)) Pre_Auth : 1;
473 u16 __attribute__ ((packed)) No_Pairwise : 1;
474 u16 __attribute__ ((packed)) PTK_Replay_Counter : 2;
475 u16 __attribute__ ((packed)) GTK_Replay_Counter : 2;
476 u16 __attribute__ ((packed)) Reserved1 : 2;
477 u16 __attribute__ ((packed)) Reserved2 : 8; /* 20051201 */
478 }__attribute__ ((packed)) RSN_Capability;
481 }__attribute__ ((packed)) ;
482 }__attribute__ ((packed)) ;
490 struct WPA2_RSN_Information_Element
495 struct suite_selector GroupKeySuite;
496 u16 PairwiseKeySuiteCount;
497 struct suite_selector PairwiseKeySuite[1];
499 }__attribute__ ((packed));
501 struct WPA2_RSN_Auth_Sub_Information_Element
503 u16 AuthKeyMngtSuiteCount;
504 struct suite_selector AuthKeyMngtSuite[1];
505 }__attribute__ ((packed));
508 struct PMKID_Information_Element
511 struct pmkid pmkid[16];
512 }__attribute__ ((packed));
514 #endif /* enddef _WPA2_ */
515 /*============================================================
516 // MAC Frame structure (different type) and subfield structure
517 //============================================================*/
518 struct MAC_frame_control
520 u8 mac_frame_info; /* a combination of the [Protocol Version, Control Type, Control Subtype]*/
521 #ifdef _BIG_ENDIAN_ /* 20060927 add by anson's endian */
540 } __attribute__ ((packed));
542 struct Management_Frame {
543 struct MAC_frame_control frame_control; /* 2B, ToDS,FromDS,MoreFrag,MoreData,Order=0 */
545 u8 DA[MAC_ADDR_LENGTH]; /* Addr1 */
546 u8 SA[MAC_ADDR_LENGTH]; /* Addr2 */
547 u8 BSSID[MAC_ADDR_LENGTH]; /* Addr3 */
548 u16 Sequence_Control;
549 /* Management Frame Body <= 325 bytes */
551 } __attribute__ ((packed));
553 /* SW-MAC don't Tx/Rx Control-Frame, HW-MAC do it. */
554 struct Control_Frame {
555 struct MAC_frame_control frame_control; /* ToDS,FromDS,MoreFrag,Retry,MoreData,WEP,Order=0 */
557 u8 RA[MAC_ADDR_LENGTH];
558 u8 TA[MAC_ADDR_LENGTH];
560 } __attribute__ ((packed));
563 struct MAC_frame_control frame_control;
565 u8 Addr1[MAC_ADDR_LENGTH];
566 u8 Addr2[MAC_ADDR_LENGTH];
567 u8 Addr3[MAC_ADDR_LENGTH];
568 u16 Sequence_Control;
569 u8 Addr4[MAC_ADDR_LENGTH]; /* only exist when ToDS=FromDS=1 */
570 /* Data Frame Body <= 2312 */
572 } __attribute__ ((packed));
574 struct Disassociation_Frame_Body {
576 } __attribute__ ((packed));
578 struct Association_Request_Frame_Body {
579 u16 capability_information;
581 u8 Current_AP_Address[MAC_ADDR_LENGTH];/* for reassociation only */
582 /* SSID (2+32 bytes) */
583 /* Supported_Rates (2+8 bytes) */
584 } __attribute__ ((packed));
586 struct Association_Response_Frame_Body {
587 u16 capability_information;
590 struct Supported_Rates_Element supportedRates;
591 } __attribute__ ((packed));
593 /*struct Reassociation_Request_Frame_Body
595 u16 capability_information;
597 u8 Current_AP_Address[MAC_ADDR_LENGTH];
599 // Supported_Rates (2+8 bytes)
601 /* eliminated by WS 07/22/04 comboined with associateion request frame. */
603 struct Reassociation_Response_Frame_Body {
604 u16 capability_information;
607 struct Supported_Rates_Element supportedRates;
608 } __attribute__ ((packed));
610 struct Deauthentication_Frame_Body {
612 } __attribute__ ((packed));
615 struct Probe_Response_Frame_Body {
618 u16 Capability_Information;
621 // PHY parameter Set (DS Parameters)
623 // IBSS parameter Set */
624 } __attribute__ ((packed));
626 struct Authentication_Frame_Body {
630 /* NB: don't include ChallengeText in this structure
631 // struct Challenge_Text_Element sChallengeTextElement; // wkchen added */
632 } __attribute__ ((packed));
635 #endif /* _MAC_Structure_H_ */