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
192 TXRATE_AUTO
= 255 // PD43 20021108
193 } WB_TXRATE
, *PWB_TXRATE
;
196 #define RATE_BITMAP_1M 1
197 #define RATE_BITMAP_2M 2
198 #define RATE_BITMAP_5dot5M 5
199 #define RATE_BITMAP_6M 6
200 #define RATE_BITMAP_9M 9
201 #define RATE_BITMAP_11M 11
202 #define RATE_BITMAP_12M 12
203 #define RATE_BITMAP_18M 18
204 #define RATE_BITMAP_22M 22
205 #define RATE_BITMAP_24M 24
206 #define RATE_BITMAP_33M 17
207 #define RATE_BITMAP_36M 19
208 #define RATE_BITMAP_48M 25
209 #define RATE_BITMAP_54M 28
214 #define RATE_5dot5M 11
229 #define CAPABILITY_ESS_BIT 0x0001
230 #define CAPABILITY_IBSS_BIT 0x0002
231 #define CAPABILITY_CF_POLL_BIT 0x0004
232 #define CAPABILITY_CF_POLL_REQ_BIT 0x0008
233 #define CAPABILITY_PRIVACY_BIT 0x0010
234 #define CAPABILITY_SHORT_PREAMBLE_BIT 0x0020
235 #define CAPABILITY_PBCC_BIT 0x0040
236 #define CAPABILITY_CHAN_AGILITY_BIT 0x0080
237 #define CAPABILITY_SHORT_SLOT_TIME_BIT 0x0400
238 #define CAPABILITY_DSSS_OFDM_BIT 0x2000
241 struct Capability_Information_Element
245 u16
__attribute__ ((packed
)) wValue
;
246 #ifdef _BIG_ENDIAN_ //20060926 add by anson's endian
253 u8 Short_Slot_Time
: 1;
255 u8 Channel_Agility
: 1;
257 u8 ShortPreamble
: 1;
259 u8 CF_Poll_Request
: 1;
263 } __attribute__ ((packed
)) Capability
;
270 u8 CF_Poll_Request
: 1;
272 u8 ShortPreamble
: 1;
274 u8 Channel_Agility
: 1;
277 u8 Short_Slot_Time
: 1;
281 } __attribute__ ((packed
)) Capability
;
283 }__attribute__ ((packed
)) ;
284 }__attribute__ ((packed
));
286 struct FH_Parameter_Set_Element
296 struct DS_Parameter_Set_Element
303 struct Supported_Rates_Element
307 u8 SupportedRates
[8];
308 }__attribute__ ((packed
));
315 }__attribute__ ((packed
)) ;
317 struct CF_Parameter_Set_Element
323 u8 CFP_MaxDuration
[2]; // in Time Units
324 u8 CFP_DurRemaining
[2]; // in time units
334 u8 Partial_Virtual_Bitmap
[251];
337 struct IBSS_Parameter_Set_Element
344 struct Challenge_Text_Element
348 u8 Challenge_Text
[253];
351 struct PHY_Parameter_Set_Element
356 s32 aRxTxTurnaroundTime
;
364 s32 aAirPropagationTime
;
365 s32 aMACProcessingDelay
;
367 s32 aPLCPHeaderLength
;
368 s32 aMPDUDurationFactor
;
375 struct ERP_Information_Element
379 #ifdef _BIG_ENDIAN_ //20060926 add by anson's endian
380 u8 Reserved
:5; //20060926 add by anson
381 u8 Barker_Preamble_Mode
:1;
387 u8 Barker_Preamble_Mode
:1;
392 struct Extended_Supported_Rates_Element
396 u8 ExtendedSupportedRates
[255];
397 }__attribute__ ((packed
));
399 //WPA(802.11i draft 3.0)
400 #define VERSION_WPA 1
402 #define VERSION_WPA2 1
403 #endif //end def _WPA2_
404 #define OUI_WPA 0x00F25000 //WPA2.0 OUI=00:50:F2, the MSB is reserved for suite type
406 #define OUI_WPA2 0x00AC0F00 // for wpa2 change to 0x00ACOF04 by Ws 26/04/04
407 #endif //end def _WPA2_
409 #define OUI_WPA_ADDITIONAL 0x01
410 #define WLAN_MIN_RSN_WPA_LENGTH 6 //added by ws 09/10/04
412 #define WLAN_MIN_RSN_WPA2_LENGTH 2 // Fix to 2 09/14/05
413 #endif //end def _WPA2_
415 #define oui_wpa (u32)(OUI_WPA|OUI_WPA_ADDITIONAL)
417 #define WPA_OUI_BIG ((u32) 0x01F25000)//added by ws 09/23/04
418 #define WPA_OUI_LITTLE ((u32) 0x01F25001)//added by ws 09/23/04
420 #define WPA_WPS_OUI cpu_to_le32(0x04F25000) // 20061108 For WPS. It's little endian. Big endian is 0x0050F204
424 #define WPA2_OUI_BIG ((u32)0x01AC0F00)
425 #define WPA2_OUI_LITTLE ((u32)0x01AC0F01)
426 #endif //end def _WPA2_
428 //Authentication suite
429 #define OUI_AUTH_WPA_NONE 0x00 //for WPA_NONE
430 #define OUI_AUTH_8021X 0x01
431 #define OUI_AUTH_PSK 0x02
433 #define OUI_CIPHER_GROUP_KEY 0x00 //added by ws 05/21/04
434 #define OUI_CIPHER_WEP_40 0x01
435 #define OUI_CIPHER_TKIP 0x02
436 #define OUI_CIPHER_CCMP 0x04
437 #define OUI_CIPHER_WEP_104 0x05
439 struct suite_selector
453 struct RSN_Information_Element
457 struct suite_selector OuiWPAAdditional
; /* WPA version 2.0 additional field, and should be 00:50:F2:01 */
459 struct suite_selector GroupKeySuite
;
460 u16 PairwiseKeySuiteCount
;
461 struct suite_selector PairwiseKeySuite
[1];
462 }__attribute__ ((packed
));
463 struct RSN_Auth_Sub_Information_Element
465 u16 AuthKeyMngtSuiteCount
;
466 struct suite_selector AuthKeyMngtSuite
[1];
467 }__attribute__ ((packed
));
470 struct RSN_Capability_Element
474 u16
__attribute__ ((packed
)) wValue
;
475 #ifdef _BIG_ENDIAN_ //20060927 add by anson's endian
476 struct _RSN_Capability
478 u16
__attribute__ ((packed
)) Reserved2
: 8; // 20051201
479 u16
__attribute__ ((packed
)) Reserved1
: 2;
480 u16
__attribute__ ((packed
)) GTK_Replay_Counter
: 2;
481 u16
__attribute__ ((packed
)) PTK_Replay_Counter
: 2;
482 u16
__attribute__ ((packed
)) No_Pairwise
: 1;
483 u16
__attribute__ ((packed
)) Pre_Auth
: 1;
484 }__attribute__ ((packed
)) RSN_Capability
;
486 struct _RSN_Capability
488 u16
__attribute__ ((packed
)) Pre_Auth
: 1;
489 u16
__attribute__ ((packed
)) No_Pairwise
: 1;
490 u16
__attribute__ ((packed
)) PTK_Replay_Counter
: 2;
491 u16
__attribute__ ((packed
)) GTK_Replay_Counter
: 2;
492 u16
__attribute__ ((packed
)) Reserved1
: 2;
493 u16
__attribute__ ((packed
)) Reserved2
: 8; // 20051201
494 }__attribute__ ((packed
)) RSN_Capability
;
497 }__attribute__ ((packed
)) ;
498 }__attribute__ ((packed
)) ;
506 struct WPA2_RSN_Information_Element
511 struct suite_selector GroupKeySuite
;
512 u16 PairwiseKeySuiteCount
;
513 struct suite_selector PairwiseKeySuite
[1];
515 }__attribute__ ((packed
));
517 struct WPA2_RSN_Auth_Sub_Information_Element
519 u16 AuthKeyMngtSuiteCount
;
520 struct suite_selector AuthKeyMngtSuite
[1];
521 }__attribute__ ((packed
));
524 struct PMKID_Information_Element
527 struct pmkid pmkid
[16];
528 }__attribute__ ((packed
));
530 #endif //enddef _WPA2_
531 //============================================================
532 // MAC Frame structure (different type) and subfield structure
533 //============================================================
534 struct MAC_frame_control
536 u8 mac_frame_info
; // a combination of the [Protocol Version, Control Type, Control Subtype]
537 #ifdef _BIG_ENDIAN_ //20060927 add by anson's endian
556 } __attribute__ ((packed
));
558 struct Management_Frame
{
559 struct MAC_frame_control frame_control
; // 2B, ToDS,FromDS,MoreFrag,MoreData,Order=0
561 u8 DA
[MAC_ADDR_LENGTH
]; // Addr1
562 u8 SA
[MAC_ADDR_LENGTH
]; // Addr2
563 u8 BSSID
[MAC_ADDR_LENGTH
]; // Addr3
564 u16 Sequence_Control
;
565 // Management Frame Body <= 325 bytes
567 }__attribute__ ((packed
));
569 // SW-MAC don't Tx/Rx Control-Frame, HW-MAC do it.
570 struct Control_Frame
{
571 struct MAC_frame_control frame_control
; // ToDS,FromDS,MoreFrag,Retry,MoreData,WEP,Order=0
573 u8 RA
[MAC_ADDR_LENGTH
];
574 u8 TA
[MAC_ADDR_LENGTH
];
576 }__attribute__ ((packed
));
579 struct MAC_frame_control frame_control
;
581 u8 Addr1
[MAC_ADDR_LENGTH
];
582 u8 Addr2
[MAC_ADDR_LENGTH
];
583 u8 Addr3
[MAC_ADDR_LENGTH
];
584 u16 Sequence_Control
;
585 u8 Addr4
[MAC_ADDR_LENGTH
]; // only exist when ToDS=FromDS=1
586 // Data Frame Body <= 2312
588 }__attribute__ ((packed
));
590 struct Disassociation_Frame_Body
593 }__attribute__ ((packed
));
595 struct Association_Request_Frame_Body
597 u16 capability_information
;
599 u8 Current_AP_Address
[MAC_ADDR_LENGTH
];//for reassociation only
601 // Supported_Rates (2+8 bytes)
602 }__attribute__ ((packed
));
604 struct Association_Response_Frame_Body
606 u16 capability_information
;
609 struct Supported_Rates_Element supportedRates
;
610 }__attribute__ ((packed
));
612 /*struct Reassociation_Request_Frame_Body
614 u16 capability_information;
616 u8 Current_AP_Address[MAC_ADDR_LENGTH];
618 // Supported_Rates (2+8 bytes)
620 // eliminated by WS 07/22/04 comboined with associateion request frame.
622 struct Reassociation_Response_Frame_Body
624 u16 capability_information
;
627 struct Supported_Rates_Element supportedRates
;
628 }__attribute__ ((packed
));
630 struct Deauthentication_Frame_Body
633 }__attribute__ ((packed
));
636 struct Probe_Response_Frame_Body
640 u16 Capability_Information
;
643 // PHY parameter Set (DS Parameters)
645 // IBSS parameter Set
646 }__attribute__ ((packed
));
648 struct Authentication_Frame_Body
653 // NB: don't include ChallengeText in this structure
654 // struct Challenge_Text_Element sChallengeTextElement; // wkchen added
655 }__attribute__ ((packed
));
658 #endif // _MAC_Structure_H_