2 *************************************************************************
4 * 5F., No.36, Taiyuan St., Jhubei City,
8 * (c) Copyright 2002-2007, Ralink Technology, Inc.
10 * This program is free software; you can redistribute it and/or modify *
11 * it under the terms of the GNU General Public License as published by *
12 * the Free Software Foundation; either version 2 of the License, or *
13 * (at your option) any later version. *
15 * This program is distributed in the hope that it will be useful, *
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
18 * GNU General Public License for more details. *
20 * You should have received a copy of the GNU General Public License *
21 * along with this program; if not, write to the *
22 * Free Software Foundation, Inc., *
23 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
25 *************************************************************************
31 Miniport related definition header
35 -------- ---------- ----------------------------------------------
36 Paul Lin 08-01-2002 created
37 John Chang 08-05-2003 add definition for 11g & other drafts
39 #ifndef __RTMP_DEF_H__
40 #define __RTMP_DEF_H__
45 // Debug information verbosity: lower values indicate higher urgency
47 #define RT_DEBUG_OFF 0
48 #define RT_DEBUG_ERROR 1
49 #define RT_DEBUG_WARN 2
50 #define RT_DEBUG_TRACE 3
51 #define RT_DEBUG_INFO 4
52 #define RT_DEBUG_LOUD 5
54 #define NIC_TAG ((ULONG)'0682')
55 #define NIC_DBG_STRING ("**RT28xx**")
59 // to get manufacturer OUI, kathy, 2008_0220
60 #define ManufacturerOUI_LEN 3
61 #define ManufacturerNAME ("Ralink Technology Company.")
62 #define ResourceTypeIdName ("Ralink_ID")
66 #define RALINK_2883_VERSION ((UINT32)0x28830300)
67 #define RALINK_2880E_VERSION ((UINT32)0x28720200)
68 #define RALINK_3070_VERSION ((UINT32)0x30700200)
71 // NDIS version in use by the NIC driver.
72 // The high byte is the major version. The low byte is the minor version.
74 #ifdef NDIS51_MINIPORT
75 #define NIC_DRIVER_VERSION 0x0501
77 #define NIC_DRIVER_VERSION 0x0500
81 // NDIS media type, current is ethernet, change if native wireless supported
83 #define NIC_MEDIA_TYPE NdisMedium802_3
84 #define NIC_PCI_HDR_LENGTH 0xe2
85 #define NIC_MAX_PACKET_SIZE 2304
86 #define NIC_HEADER_SIZE 14
87 #define MAX_MAP_REGISTERS_NEEDED 32
88 #define MIN_MAP_REGISTERS_NEEDED 2 //Todo: should consider fragment issue.
91 // interface type, we use PCI
93 #define NIC_INTERFACE_TYPE NdisInterfacePci
94 #define NIC_INTERRUPT_MODE NdisInterruptLevelSensitive
97 // buffer size passed in NdisMQueryAdapterResources
98 // We should only need three adapter resources (IO, interrupt and memory),
99 // Some devices get extra resources, so have room for 10 resources
100 // UF_SIZE (sizeof(NDIS_RESOURCE_LIST) + (10*sizeof(CM_PARTIAL_RESOURCE_DESCRIPTOR)))
103 #define NIC_RESOURCE_B//
106 #define NIC_MAP_IOSPACE_LENGTH sizeof(CSR_STRUC)
108 #define MAX_RX_PKT_LEN 1520
111 // Entry number for each DMA descriptor ring
114 #define TX_RING_SIZE 64 //64
115 #define MGMT_RING_SIZE 128
116 #define RX_RING_SIZE 128 //64
117 #define MAX_TX_PROCESS TX_RING_SIZE //8
118 #define MAX_DMA_DONE_PROCESS TX_RING_SIZE
119 #define MAX_TX_DONE_PROCESS TX_RING_SIZE //8
120 #define LOCAL_TXBUF_SIZE 2
123 #ifdef MULTIPLE_CARD_SUPPORT
125 #define MAX_NUM_OF_MULTIPLE_CARD 32
126 #endif // MULTIPLE_CARD_SUPPORT //
128 #define MAX_RX_PROCESS 128 //64 //32
129 #define NUM_OF_LOCAL_TXBUF 2
134 // TXINFO_SIZE + TXWI_SIZE + 802.11 Header Size + AMSDU sub frame header
135 #define TX_DMA_1ST_BUFFER_SIZE 96 // only the 1st physical buffer is pre-allocated
136 #define MGMT_DMA_BUFFER_SIZE 1536 //2048
137 #define RX_BUFFER_AGGRESIZE 3840 //3904 //3968 //4096 //2048 //4096
138 #define RX_BUFFER_NORMSIZE 3840 //3904 //3968 //4096 //2048 //4096
139 #define TX_BUFFER_NORMSIZE RX_BUFFER_NORMSIZE
140 #define MAX_FRAME_SIZE 2346 // Maximum 802.11 frame size
141 #define MAX_AGGREGATION_SIZE 3840 //3904 //3968 //4096
142 #define MAX_NUM_OF_TUPLE_CACHE 2
143 #define MAX_MCAST_LIST_SIZE 32
144 #define MAX_LEN_OF_VENDOR_DESC 64
145 //#define MAX_SIZE_OF_MCAST_PSQ (NUM_OF_LOCAL_TXBUF >> 2) // AP won't spend more than 1/4 of total buffers on M/BCAST PSQ
146 #define MAX_SIZE_OF_MCAST_PSQ 32
148 #define MAX_RX_PROCESS_CNT (RX_RING_SIZE)
151 #define MAX_PACKETS_IN_QUEUE (512) //(512) // to pass WMM A5-WPAPSK
152 #define MAX_PACKETS_IN_MCAST_PS_QUEUE 32
153 #define MAX_PACKETS_IN_PS_QUEUE 128 //32
154 #define WMM_NUM_OF_AC 4 /* AC0, AC1, AC2, and AC3 */
159 #define STANORMAL 0x17f97
160 #define APNORMAL 0x15f97
162 // RTMP_ADAPTER flags
164 #define fRTMP_ADAPTER_MAP_REGISTER 0x00000001
165 #define fRTMP_ADAPTER_INTERRUPT_IN_USE 0x00000002
166 #define fRTMP_ADAPTER_HARDWARE_ERROR 0x00000004
167 #define fRTMP_ADAPTER_SCATTER_GATHER 0x00000008
168 #define fRTMP_ADAPTER_SEND_PACKET_ERROR 0x00000010
169 #define fRTMP_ADAPTER_MLME_RESET_IN_PROGRESS 0x00000020
170 #define fRTMP_ADAPTER_HALT_IN_PROGRESS 0x00000040
171 #define fRTMP_ADAPTER_RESET_IN_PROGRESS 0x00000080
172 #define fRTMP_ADAPTER_NIC_NOT_EXIST 0x00000100
173 #define fRTMP_ADAPTER_TX_RING_ALLOCATED 0x00000200
174 #define fRTMP_ADAPTER_REMOVE_IN_PROGRESS 0x00000400
175 #define fRTMP_ADAPTER_MIMORATE_INUSED 0x00000800
176 #define fRTMP_ADAPTER_RX_RING_ALLOCATED 0x00001000
177 #define fRTMP_ADAPTER_INTERRUPT_ACTIVE 0x00002000
178 #define fRTMP_ADAPTER_BSS_SCAN_IN_PROGRESS 0x00004000
179 #define fRTMP_ADAPTER_REASSOC_IN_PROGRESS 0x00008000
180 #define fRTMP_ADAPTER_MEDIA_STATE_PENDING 0x00010000
181 #define fRTMP_ADAPTER_RADIO_OFF 0x00020000
182 #define fRTMP_ADAPTER_BULKOUT_RESET 0x00040000
183 #define fRTMP_ADAPTER_BULKIN_RESET 0x00080000
184 #define fRTMP_ADAPTER_RDG_ACTIVE 0x00100000
185 #define fRTMP_ADAPTER_DYNAMIC_BE_TXOP_ACTIVE 0x00200000
186 #define fRTMP_ADAPTER_SCAN_2040 0x04000000
187 #define fRTMP_ADAPTER_RADIO_MEASUREMENT 0x08000000
189 #define fRTMP_ADAPTER_START_UP 0x10000000 //Devive already initialized and enabled Tx/Rx.
190 #define fRTMP_ADAPTER_MEDIA_STATE_CHANGE 0x20000000
191 #define fRTMP_ADAPTER_IDLE_RADIO_OFF 0x40000000
194 // STA operation status flags
196 #define fOP_STATUS_INFRA_ON 0x00000001
197 #define fOP_STATUS_ADHOC_ON 0x00000002
198 #define fOP_STATUS_BG_PROTECTION_INUSED 0x00000004
199 #define fOP_STATUS_SHORT_SLOT_INUSED 0x00000008
200 #define fOP_STATUS_SHORT_PREAMBLE_INUSED 0x00000010
201 #define fOP_STATUS_RECEIVE_DTIM 0x00000020
202 #define fOP_STATUS_MEDIA_STATE_CONNECTED 0x00000080
203 #define fOP_STATUS_WMM_INUSED 0x00000100
204 #define fOP_STATUS_AGGREGATION_INUSED 0x00000200
205 #define fOP_STATUS_DOZE 0x00000400 // debug purpose
206 #define fOP_STATUS_PIGGYBACK_INUSED 0x00000800 // piggy-back, and aggregation
207 #define fOP_STATUS_APSD_INUSED 0x00001000
208 #define fOP_STATUS_TX_AMSDU_INUSED 0x00002000
209 #define fOP_STATUS_MAX_RETRY_ENABLED 0x00004000
210 #define fOP_STATUS_WAKEUP_NOW 0x00008000
211 #define fOP_STATUS_ADVANCE_POWER_SAVE_PCIE_DEVICE 0x00020000
214 // RTMP_ADAPTER PSFlags : related to advanced power save.
216 // Indicate whether driver can go to sleep mode from now. This flag is useful AFTER link up
217 #define fRTMP_PS_CAN_GO_SLEEP 0x00000001
218 // Indicate whether driver has issue a LinkControl command to PCIe L1
219 #define fRTMP_PS_SET_PCI_CLK_OFF_COMMAND 0x00000002
220 // Indicate driver should disable kick off hardware to send packets from now.
221 #define fRTMP_PS_DISABLE_TX 0x00000004
222 // Indicate driver should IMMEDIATELY fo to sleep after receiving AP's beacon in which doesn't indicate unicate nor multicast packets for me
223 //. This flag is used ONLY in RTMPHandleRxDoneInterrupt routine.
224 #define fRTMP_PS_GO_TO_SLEEP_NOW 0x00000008
227 #define fOP_STATUS_SCAN_2040 0x00040000
228 #endif // DOT11N_DRAFT3 //
230 #define CCKSETPROTECT 0x1
231 #define OFDMSETPROTECT 0x2
232 #define MM20SETPROTECT 0x4
233 #define MM40SETPROTECT 0x8
234 #define GF20SETPROTECT 0x10
235 #define GR40SETPROTECT 0x20
236 #define ALLN_SETPROTECT (GR40SETPROTECT | GF20SETPROTECT | MM40SETPROTECT | MM20SETPROTECT)
239 // AP's client table operation status flags
241 #define fCLIENT_STATUS_WMM_CAPABLE 0x00000001 // CLIENT can parse QOS DATA frame
242 #define fCLIENT_STATUS_AGGREGATION_CAPABLE 0x00000002 // CLIENT can receive Ralink's proprietary TX aggregation frame
243 #define fCLIENT_STATUS_PIGGYBACK_CAPABLE 0x00000004 // CLIENT support piggy-back
244 #define fCLIENT_STATUS_AMSDU_INUSED 0x00000008
245 #define fCLIENT_STATUS_SGI20_CAPABLE 0x00000010
246 #define fCLIENT_STATUS_SGI40_CAPABLE 0x00000020
247 #define fCLIENT_STATUS_TxSTBC_CAPABLE 0x00000040
248 #define fCLIENT_STATUS_RxSTBC_CAPABLE 0x00000080
249 #define fCLIENT_STATUS_HTC_CAPABLE 0x00000100
250 #define fCLIENT_STATUS_RDG_CAPABLE 0x00000200
251 #define fCLIENT_STATUS_MCSFEEDBACK_CAPABLE 0x00000400
252 #define fCLIENT_STATUS_APSD_CAPABLE 0x00000800 /* UAPSD STATION */
255 #define fCLIENT_STATUS_BSSCOEXIST_CAPABLE 0x00001000
256 #endif // DOT11N_DRAFT3 //
258 #define fCLIENT_STATUS_RALINK_CHIPSET 0x00100000
260 // STA configuration flags
263 // 802.11n Operating Mode Definition. 0-3 also used in ASICUPdateProtect switch case
264 #define HT_NO_PROTECT 0
265 #define HT_LEGACY_PROTECT 1
266 #define HT_40_PROTECT 2
267 #define HT_2040_PROTECT 3
268 #define HT_RTSCTS_6M 7
269 //following is our own definition in order to turn on our ASIC protection register in INFRASTRUCTURE.
270 #define HT_ATHEROS 8 // rt2860c has problem with atheros chip. we need to turn on RTS/CTS .
271 #define HT_FORCERTSCTS 9 // Force turn on RTS/CTS first. then go to evaluate if this force RTS is necessary.
274 // RX Packet Filter control flags. Apply on pAd->PacketFilter
276 #define fRX_FILTER_ACCEPT_DIRECT NDIS_PACKET_TYPE_DIRECTED
277 #define fRX_FILTER_ACCEPT_MULTICAST NDIS_PACKET_TYPE_MULTICAST
278 #define fRX_FILTER_ACCEPT_BROADCAST NDIS_PACKET_TYPE_BROADCAST
279 #define fRX_FILTER_ACCEPT_ALL_MULTICAST NDIS_PACKET_TYPE_ALL_MULTICAST
282 // Error code section
284 // NDIS_ERROR_CODE_ADAPTER_NOT_FOUND
285 #define ERRLOG_READ_PCI_SLOT_FAILED 0x00000101L
286 #define ERRLOG_WRITE_PCI_SLOT_FAILED 0x00000102L
287 #define ERRLOG_VENDOR_DEVICE_NOMATCH 0x00000103L
289 // NDIS_ERROR_CODE_ADAPTER_DISABLED
290 #define ERRLOG_BUS_MASTER_DISABLED 0x00000201L
292 // NDIS_ERROR_CODE_UNSUPPORTED_CONFIGURATION
293 #define ERRLOG_INVALID_SPEED_DUPLEX 0x00000301L
294 #define ERRLOG_SET_SECONDARY_FAILED 0x00000302L
296 // NDIS_ERROR_CODE_OUT_OF_RESOURCES
297 #define ERRLOG_OUT_OF_MEMORY 0x00000401L
298 #define ERRLOG_OUT_OF_SHARED_MEMORY 0x00000402L
299 #define ERRLOG_OUT_OF_MAP_REGISTERS 0x00000403L
300 #define ERRLOG_OUT_OF_BUFFER_POOL 0x00000404L
301 #define ERRLOG_OUT_OF_NDIS_BUFFER 0x00000405L
302 #define ERRLOG_OUT_OF_PACKET_POOL 0x00000406L
303 #define ERRLOG_OUT_OF_NDIS_PACKET 0x00000407L
304 #define ERRLOG_OUT_OF_LOOKASIDE_MEMORY 0x00000408L
306 // NDIS_ERROR_CODE_HARDWARE_FAILURE
307 #define ERRLOG_SELFTEST_FAILED 0x00000501L
308 #define ERRLOG_INITIALIZE_ADAPTER 0x00000502L
309 #define ERRLOG_REMOVE_MINIPORT 0x00000503L
311 // NDIS_ERROR_CODE_RESOURCE_CONFLICT
312 #define ERRLOG_MAP_IO_SPACE 0x00000601L
313 #define ERRLOG_QUERY_ADAPTER_RESOURCES 0x00000602L
314 #define ERRLOG_NO_IO_RESOURCE 0x00000603L
315 #define ERRLOG_NO_INTERRUPT_RESOURCE 0x00000604L
316 #define ERRLOG_NO_MEMORY_RESOURCE 0x00000605L
320 #define MAX_WDS_ENTRY 4
321 #define WDS_PAIRWISE_KEY_OFFSET 60 // WDS links uses pairwise key#60 ~ 63 in ASIC pairwise key table
323 #define WDS_DISABLE_MODE 0
324 #define WDS_RESTRICT_MODE 1
325 #define WDS_BRIDGE_MODE 2
326 #define WDS_REPEATER_MODE 3
327 #define WDS_LAZY_MODE 4
330 #define MAX_MESH_NUM 0
332 #define MAX_APCLI_NUM 0
334 #define MAX_MBSSID_NUM 1
336 #undef MAX_MBSSID_NUM
337 #define MAX_MBSSID_NUM (8 - MAX_MESH_NUM - MAX_APCLI_NUM)
338 #endif // MBSS_SUPPORT //
340 /* sanity check for apidx */
341 #define MBSS_MR_APIDX_SANITY_CHECK(apidx) \
342 { if (apidx > MAX_MBSSID_NUM) { \
343 printk("%s> Error! apidx = %d > MAX_MBSSID_NUM!\n", __func__, apidx); \
344 apidx = MAIN_MBSSID; } }
346 #define VALID_WCID(_wcid) ((_wcid) > 0 && (_wcid) < MAX_LEN_OF_MAC_TABLE )
348 #define MAIN_MBSSID 0
349 #define FIRST_MBSSID 1
352 #define MAX_BEACON_SIZE 512
353 // If the MAX_MBSSID_NUM is larger than 6,
354 // it shall reserve some WCID space(wcid 222~253) for beacon frames.
355 // - these wcid 238~253 are reserved for beacon#6(ra6).
356 // - these wcid 222~237 are reserved for beacon#7(ra7).
357 #if defined(MAX_MBSSID_NUM) && (MAX_MBSSID_NUM == 8)
358 #define HW_RESERVED_WCID 222
359 #elif defined(MAX_MBSSID_NUM) && (MAX_MBSSID_NUM == 7)
360 #define HW_RESERVED_WCID 238
362 #define HW_RESERVED_WCID 255
365 // Then dedicate wcid of DFS and Carrier-Sense.
366 #define DFS_CTS_WCID (HW_RESERVED_WCID - 1)
367 #define CS_CTS_WCID (HW_RESERVED_WCID - 2)
368 #define LAST_SPECIFIC_WCID (HW_RESERVED_WCID - 2)
370 // If MAX_MBSSID_NUM is 8, the maximum available wcid for the associated STA is 211.
371 // If MAX_MBSSID_NUM is 7, the maximum available wcid for the associated STA is 228.
372 #define MAX_AVAILABLE_CLIENT_WCID (LAST_SPECIFIC_WCID - MAX_MBSSID_NUM - 1)
374 // TX need WCID to find Cipher Key
375 // these wcid 212 ~ 219 are reserved for bc/mc packets if MAX_MBSSID_NUM is 8.
376 #define GET_GroupKey_WCID(__wcid, __bssidx) \
378 __wcid = LAST_SPECIFIC_WCID - (MAX_MBSSID_NUM) + __bssidx; \
381 #define IsGroupKeyWCID(__wcid) (((__wcid) < LAST_SPECIFIC_WCID) && ((__wcid) >= (LAST_SPECIFIC_WCID - (MAX_MBSSID_NUM))))
384 // definition to support multiple BSSID
395 //============================================================
396 // Length definitions
397 #define PEER_KEY_NO 2
398 #define MAC_ADDR_LEN 6
399 #define TIMESTAMP_LEN 8
400 #define MAX_LEN_OF_SUPPORTED_RATES MAX_LENGTH_OF_SUPPORT_RATES // 1, 2, 5.5, 11, 6, 9, 12, 18, 24, 36, 48, 54
401 #define MAX_LEN_OF_KEY 32 // 32 octets == 256 bits, Redefine for WPA
402 #define MAX_NUM_OF_CHANNELS MAX_NUM_OF_CHS // 14 channels @2.4G + 12@UNII + 4 @MMAC + 11 @HiperLAN2 + 7 @Japan + 1 as NULL termination
403 #define MAX_NUM_OF_11JCHANNELS 20 // 14 channels @2.4G + 12@UNII + 4 @MMAC + 11 @HiperLAN2 + 7 @Japan + 1 as NULL termination
404 #define MAX_LEN_OF_SSID 32
405 #define CIPHER_TEXT_LEN 128
406 #define HASH_TABLE_SIZE 256
407 #define MAX_VIE_LEN 1024 // New for WPA cipher suite variable IE sizes.
408 #define MAX_SUPPORT_MCS 32
410 //============================================================
411 // ASIC WCID Table definition.
412 //============================================================
413 #define BSSID_WCID 1 // in infra mode, always put bssid with this WCID
414 #define MCAST_WCID 0x0
415 #define BSS0Mcast_WCID 0x0
416 #define BSS1Mcast_WCID 0xf8
417 #define BSS2Mcast_WCID 0xf9
418 #define BSS3Mcast_WCID 0xfa
419 #define BSS4Mcast_WCID 0xfb
420 #define BSS5Mcast_WCID 0xfc
421 #define BSS6Mcast_WCID 0xfd
422 #define BSS7Mcast_WCID 0xfe
423 #define RESERVED_WCID 0xff
425 #define MAX_NUM_OF_ACL_LIST MAX_NUMBER_OF_ACL
427 #define MAX_LEN_OF_MAC_TABLE MAX_NUMBER_OF_MAC // if MAX_MBSSID_NUM is 8, this value can't be larger than 211
429 #if MAX_LEN_OF_MAC_TABLE>MAX_AVAILABLE_CLIENT_WCID
430 #error MAX_LEN_OF_MAC_TABLE can not be larger than MAX_AVAILABLE_CLIENT_WCID!!!!
433 #define MAX_NUM_OF_WDS_LINK_PERBSSID 3
434 #define MAX_NUM_OF_WDS_LINK (MAX_NUM_OF_WDS_LINK_PERBSSID*MAX_MBSSID_NUM)
435 #define MAX_NUM_OF_EVENT MAX_NUMBER_OF_EVENT
436 #define WDS_LINK_START_WCID (MAX_LEN_OF_MAC_TABLE-1)
440 #define MAX_LEN_OF_BA_REC_TABLE ((NUM_OF_TID * MAX_LEN_OF_MAC_TABLE)/2)// (NUM_OF_TID*MAX_AID_BA + 32) //Block ACK recipient
441 #define MAX_LEN_OF_BA_ORI_TABLE ((NUM_OF_TID * MAX_LEN_OF_MAC_TABLE)/2)// (NUM_OF_TID*MAX_AID_BA + 32) // Block ACK originator
442 #define MAX_LEN_OF_BSS_TABLE 64
443 #define MAX_REORDERING_MPDU_NUM 512
445 // key related definitions
446 #define SHARE_KEY_NUM 4
447 #define MAX_LEN_OF_SHARE_KEY 16 // byte count
448 #define MAX_LEN_OF_PEER_KEY 16 // byte count
449 #define PAIRWISE_KEY_NUM 64 // in MAC ASIC pairwise key table
450 #define GROUP_KEY_NUM 4
452 #define WDS_PAIRWISE_KEY_OFFSET 60 // WDS links uses pairwise key#60 ~ 63 in ASIC pairwise key table
453 #define PMKID_NO 4 // Number of PMKID saved supported
454 #define MAX_LEN_OF_MLME_BUFFER 2048
456 // power status related definitions
459 #define PWR_MMPS 2 //MIMO power save
461 // Auth and Assoc mode related definitions
462 #define AUTH_MODE_OPEN 0x00
463 #define AUTH_MODE_KEY 0x01
465 // BSS Type definitions
466 #define BSS_ADHOC 0 // = Ndis802_11IBSS
467 #define BSS_INFRA 1 // = Ndis802_11Infrastructure
468 #define BSS_ANY 2 // = Ndis802_11AutoUnknown
469 #define BSS_MONITOR 3 // = Ndis802_11Monitor
472 // Reason code definitions
473 #define REASON_RESERVED 0
474 #define REASON_UNSPECIFY 1
475 #define REASON_NO_LONGER_VALID 2
476 #define REASON_DEAUTH_STA_LEAVING 3
477 #define REASON_DISASSOC_INACTIVE 4
478 #define REASON_DISASSPC_AP_UNABLE 5
479 #define REASON_CLS2ERR 6
480 #define REASON_CLS3ERR 7
481 #define REASON_DISASSOC_STA_LEAVING 8
482 #define REASON_STA_REQ_ASSOC_NOT_AUTH 9
483 #define REASON_INVALID_IE 13
484 #define REASON_MIC_FAILURE 14
485 #define REASON_4_WAY_TIMEOUT 15
486 #define REASON_GROUP_KEY_HS_TIMEOUT 16
487 #define REASON_IE_DIFFERENT 17
488 #define REASON_MCIPHER_NOT_VALID 18
489 #define REASON_UCIPHER_NOT_VALID 19
490 #define REASON_AKMP_NOT_VALID 20
491 #define REASON_UNSUPPORT_RSNE_VER 21
492 #define REASON_INVALID_RSNE_CAP 22
493 #define REASON_8021X_AUTH_FAIL 23
494 #define REASON_CIPHER_SUITE_REJECTED 24
495 #define REASON_DECLINED 37
497 #define REASON_QOS_UNSPECIFY 32
498 #define REASON_QOS_LACK_BANDWIDTH 33
499 #define REASON_POOR_CHANNEL_CONDITION 34
500 #define REASON_QOS_OUTSIDE_TXOP_LIMITION 35
501 #define REASON_QOS_QSTA_LEAVING_QBSS 36
502 #define REASON_QOS_UNWANTED_MECHANISM 37
503 #define REASON_QOS_MECH_SETUP_REQUIRED 38
504 #define REASON_QOS_REQUEST_TIMEOUT 39
505 #define REASON_QOS_CIPHER_NOT_SUPPORT 45
507 // Status code definitions
508 #define MLME_SUCCESS 0
509 #define MLME_UNSPECIFY_FAIL 1
510 #define MLME_CANNOT_SUPPORT_CAP 10
511 #define MLME_REASSOC_DENY_ASSOC_EXIST 11
512 #define MLME_ASSOC_DENY_OUT_SCOPE 12
513 #define MLME_ALG_NOT_SUPPORT 13
514 #define MLME_SEQ_NR_OUT_OF_SEQUENCE 14
515 #define MLME_REJ_CHALLENGE_FAILURE 15
516 #define MLME_REJ_TIMEOUT 16
517 #define MLME_ASSOC_REJ_UNABLE_HANDLE_STA 17
518 #define MLME_ASSOC_REJ_DATA_RATE 18
520 #define MLME_ASSOC_REJ_NO_EXT_RATE 22
521 #define MLME_ASSOC_REJ_NO_EXT_RATE_PBCC 23
522 #define MLME_ASSOC_REJ_NO_CCK_OFDM 24
524 #define MLME_QOS_UNSPECIFY 32
525 #define MLME_REQUEST_DECLINED 37
526 #define MLME_REQUEST_WITH_INVALID_PARAM 38
527 #define MLME_DLS_NOT_ALLOW_IN_QBSS 48
528 #define MLME_DEST_STA_NOT_IN_QBSS 49
529 #define MLME_DEST_STA_IS_NOT_A_QSTA 50
531 #define MLME_INVALID_FORMAT 0x51
532 #define MLME_FAIL_NO_RESOURCE 0x52
533 #define MLME_STATE_MACHINE_REJECT 0x53
534 #define MLME_MAC_TABLE_FAIL 0x54
538 #define IE_SUPP_RATES 1
543 #define IE_IBSS_PARM 6
544 #define IE_COUNTRY 7 // 802.11d
545 #define IE_802_11D_REQUEST 10 // 802.11d
546 #define IE_QBSS_LOAD 11 // 802.11e d9
547 #define IE_EDCA_PARAMETER 12 // 802.11e d9
548 #define IE_TSPEC 13 // 802.11e d9
549 #define IE_TCLAS 14 // 802.11e d9
550 #define IE_SCHEDULE 15 // 802.11e d9
551 #define IE_CHALLENGE_TEXT 16
552 #define IE_POWER_CONSTRAINT 32 // 802.11h d3.3
553 #define IE_POWER_CAPABILITY 33 // 802.11h d3.3
554 #define IE_TPC_REQUEST 34 // 802.11h d3.3
555 #define IE_TPC_REPORT 35 // 802.11h d3.3
556 #define IE_SUPP_CHANNELS 36 // 802.11h d3.3
557 #define IE_CHANNEL_SWITCH_ANNOUNCEMENT 37 // 802.11h d3.3
558 #define IE_MEASUREMENT_REQUEST 38 // 802.11h d3.3
559 #define IE_MEASUREMENT_REPORT 39 // 802.11h d3.3
560 #define IE_QUIET 40 // 802.11h d3.3
561 #define IE_IBSS_DFS 41 // 802.11h d3.3
562 #define IE_ERP 42 // 802.11g
563 #define IE_TS_DELAY 43 // 802.11e d9
564 #define IE_TCLAS_PROCESSING 44 // 802.11e d9
565 #define IE_QOS_CAPABILITY 46 // 802.11e d6
566 #define IE_HT_CAP 45 // 802.11n d1. HT CAPABILITY. ELEMENT ID TBD
567 #define IE_AP_CHANNEL_REPORT 51 // 802.11k d6
568 #define IE_HT_CAP2 52 // 802.11n d1. HT CAPABILITY. ELEMENT ID TBD
569 #define IE_RSN 48 // 802.11i d3.0
570 #define IE_WPA2 48 // WPA2
571 #define IE_EXT_SUPP_RATES 50 // 802.11g
572 #define IE_SUPP_REG_CLASS 59 // 802.11y. Supported regulatory classes.
573 #define IE_EXT_CHANNEL_SWITCH_ANNOUNCEMENT 60 // 802.11n
574 #define IE_ADD_HT 61 // 802.11n d1. ADDITIONAL HT CAPABILITY. ELEMENT ID TBD
575 #define IE_ADD_HT2 53 // 802.11n d1. ADDITIONAL HT CAPABILITY. ELEMENT ID TBD
579 //#define IE_NEW_EXT_CHA_OFFSET 62 // 802.11n d1. New extension channel offset elemet
580 #define IE_SECONDARY_CH_OFFSET 62 // 802.11n D3.03 Secondary Channel Offset element
581 #define IE_2040_BSS_COEXIST 72 // 802.11n D3.0.3
582 #define IE_2040_BSS_INTOLERANT_REPORT 73 // 802.11n D3.03
583 #define IE_OVERLAPBSS_SCAN_PARM 74 // 802.11n D3.03
584 #define IE_EXT_CAPABILITY 127 // 802.11n D3.03
587 #define IE_WPA 221 // WPA
588 #define IE_VENDOR_SPECIFIC 221 // Wifi WMM (WME)
590 #define OUI_BROADCOM_HT 51 //
591 #define OUI_BROADCOM_HTADD 52 //
592 #define OUI_PREN_HT_CAP 51 //
593 #define OUI_PREN_ADD_HT 52 //
596 #define IE_AIRONET_CKIP 133 // CCX1.0 ID 85H for CKIP
597 #define IE_AP_TX_POWER 150 // CCX 2.0 for AP transmit power
598 #define IE_MEASUREMENT_CAPABILITY 221 // CCX 2.0
599 #define IE_CCX_V2 221
600 #define IE_AIRONET_IPADDRESS 149 // CCX ID 95H for IP Address
601 #define IE_AIRONET_CCKMREASSOC 156 // CCX ID 9CH for CCKM Reassociation Request element
602 #define CKIP_NEGOTIATION_LENGTH 30
603 #define AIRONET_IPADDRESS_LENGTH 10
604 #define AIRONET_CCKMREASSOC_LENGTH 24
606 // ========================================================
607 // MLME state machine definition
608 // ========================================================
610 // STA MLME state mahcines
611 #define ASSOC_STATE_MACHINE 1
612 #define AUTH_STATE_MACHINE 2
613 #define AUTH_RSP_STATE_MACHINE 3
614 #define SYNC_STATE_MACHINE 4
615 #define MLME_CNTL_STATE_MACHINE 5
616 #define WPA_PSK_STATE_MACHINE 6
617 #define LEAP_STATE_MACHINE 7
618 #define AIRONET_STATE_MACHINE 8
619 #define ACTION_STATE_MACHINE 9
621 // AP MLME state machines
622 #define AP_ASSOC_STATE_MACHINE 11
623 #define AP_AUTH_STATE_MACHINE 12
624 #define AP_AUTH_RSP_STATE_MACHINE 13
625 #define AP_SYNC_STATE_MACHINE 14
626 #define AP_CNTL_STATE_MACHINE 15
627 #define AP_WPA_STATE_MACHINE 16
629 #ifdef QOS_DLS_SUPPORT
630 #define DLS_STATE_MACHINE 26
631 #endif // QOS_DLS_SUPPORT //
634 // STA's CONTROL/CONNECT state machine: states, events, total function #
637 #define CNTL_WAIT_DISASSOC 1
638 #define CNTL_WAIT_JOIN 2
639 #define CNTL_WAIT_REASSOC 3
640 #define CNTL_WAIT_START 4
641 #define CNTL_WAIT_AUTH 5
642 #define CNTL_WAIT_ASSOC 6
643 #define CNTL_WAIT_AUTH2 7
644 #define CNTL_WAIT_OID_LIST_SCAN 8
645 #define CNTL_WAIT_OID_DISASSOC 9
647 #define MT2_ASSOC_CONF 34
648 #define MT2_AUTH_CONF 35
649 #define MT2_DEAUTH_CONF 36
650 #define MT2_DISASSOC_CONF 37
651 #define MT2_REASSOC_CONF 38
652 #define MT2_PWR_MGMT_CONF 39
653 #define MT2_JOIN_CONF 40
654 #define MT2_SCAN_CONF 41
655 #define MT2_START_CONF 42
656 #define MT2_GET_CONF 43
657 #define MT2_SET_CONF 44
658 #define MT2_RESET_CONF 45
659 #define MT2_MLME_ROAMING_REQ 52
661 #define CNTL_FUNC_SIZE 1
664 // STA's ASSOC state machine: states, events, total function #
667 #define ASSOC_WAIT_RSP 1
668 #define REASSOC_WAIT_RSP 2
669 #define DISASSOC_WAIT_RSP 3
670 #define MAX_ASSOC_STATE 4
672 #define ASSOC_MACHINE_BASE 0
673 #define MT2_MLME_ASSOC_REQ 0
674 #define MT2_MLME_REASSOC_REQ 1
675 #define MT2_MLME_DISASSOC_REQ 2
676 #define MT2_PEER_DISASSOC_REQ 3
677 #define MT2_PEER_ASSOC_REQ 4
678 #define MT2_PEER_ASSOC_RSP 5
679 #define MT2_PEER_REASSOC_REQ 6
680 #define MT2_PEER_REASSOC_RSP 7
681 #define MT2_DISASSOC_TIMEOUT 8
682 #define MT2_ASSOC_TIMEOUT 9
683 #define MT2_REASSOC_TIMEOUT 10
684 #define MAX_ASSOC_MSG 11
686 #define ASSOC_FUNC_SIZE (MAX_ASSOC_STATE * MAX_ASSOC_MSG)
689 // ACT state machine: states, events, total function #
692 #define MAX_ACT_STATE 1
694 #define ACT_MACHINE_BASE 0
696 //Those PEER_xx_CATE number is based on real Categary value in IEEE spec. Please don'es modify it by your self.
698 #define MT2_PEER_SPECTRUM_CATE 0
699 #define MT2_PEER_QOS_CATE 1
700 #define MT2_PEER_DLS_CATE 2
701 #define MT2_PEER_BA_CATE 3
702 #define MT2_PEER_PUBLIC_CATE 4
703 #define MT2_PEER_RM_CATE 5
704 #define MT2_PEER_HT_CATE 7 // 7.4.7
705 #define MAX_PEER_CATE_MSG 7
706 #define MT2_MLME_ADD_BA_CATE 8
707 #define MT2_MLME_ORI_DELBA_CATE 9
708 #define MT2_MLME_REC_DELBA_CATE 10
709 #define MT2_MLME_QOS_CATE 11
710 #define MT2_MLME_DLS_CATE 12
711 #define MT2_ACT_INVALID 13
712 #define MAX_ACT_MSG 14
715 #define CATEGORY_SPECTRUM 0
716 #define CATEGORY_QOS 1
717 #define CATEGORY_DLS 2
718 #define CATEGORY_BA 3
719 #define CATEGORY_PUBLIC 4
720 #define CATEGORY_RM 5
721 #define CATEGORY_HT 7
724 // DLS Action frame definition
725 #define ACTION_DLS_REQUEST 0
726 #define ACTION_DLS_RESPONSE 1
727 #define ACTION_DLS_TEARDOWN 2
729 //Spectrum Action field value 802.11h 7.4.1
730 #define SPEC_MRQ 0 // Request
731 #define SPEC_MRP 1 //Report
734 #define SPEC_CHANNEL_SWITCH 4
737 //BA Action field value
742 //Public's Action field value in Public Category. Some in 802.11y and some in 11n
743 #define ACTION_BSS_2040_COEXIST 0 // 11n
744 #define ACTION_DSE_ENABLEMENT 1 // 11y D9.0
745 #define ACTION_DSE_DEENABLEMENT 2 // 11y D9.0
746 #define ACTION_DSE_REG_LOCATION_ANNOUNCE 3 // 11y D9.0
747 #define ACTION_EXT_CH_SWITCH_ANNOUNCE 4 // 11y D9.0
748 #define ACTION_DSE_MEASUREMENT_REQ 5 // 11y D9.0
749 #define ACTION_DSE_MEASUREMENT_REPORT 6 // 11y D9.0
750 #define ACTION_MEASUREMENT_PILOT_ACTION 7 // 11y D9.0
751 #define ACTION_DSE_POWER_CONSTRAINT 8 // 11y D9.0
754 //HT Action field value
755 #define NOTIFY_BW_ACTION 0
756 #define SMPS_ACTION 1
757 #define PSMP_ACTION 2
758 #define SETPCO_ACTION 3
759 #define MIMO_CHA_MEASURE_ACTION 4
760 #define MIMO_N_BEACONFORM 5
761 #define MIMO_BEACONFORM 6
762 #define ANTENNA_SELECT 7
763 #define HT_INFO_EXCHANGE 8
765 #define ACT_FUNC_SIZE (MAX_ACT_STATE * MAX_ACT_MSG)
767 // STA's AUTHENTICATION state machine: states, evvents, total function #
769 #define AUTH_REQ_IDLE 0
770 #define AUTH_WAIT_SEQ2 1
771 #define AUTH_WAIT_SEQ4 2
772 #define MAX_AUTH_STATE 3
774 #define AUTH_MACHINE_BASE 0
775 #define MT2_MLME_AUTH_REQ 0
776 #define MT2_PEER_AUTH_EVEN 1
777 #define MT2_AUTH_TIMEOUT 2
778 #define MAX_AUTH_MSG 3
780 #define AUTH_FUNC_SIZE (MAX_AUTH_STATE * MAX_AUTH_MSG)
783 // STA's AUTH_RSP state machine: states, events, total function #
785 #define AUTH_RSP_IDLE 0
786 #define AUTH_RSP_WAIT_CHAL 1
787 #define MAX_AUTH_RSP_STATE 2
789 #define AUTH_RSP_MACHINE_BASE 0
790 #define MT2_AUTH_CHALLENGE_TIMEOUT 0
791 #define MT2_PEER_AUTH_ODD 1
792 #define MT2_PEER_DEAUTH 2
793 #define MAX_AUTH_RSP_MSG 3
795 #define AUTH_RSP_FUNC_SIZE (MAX_AUTH_RSP_STATE * MAX_AUTH_RSP_MSG)
798 // STA's SYNC state machine: states, events, total function #
800 #define SYNC_IDLE 0 // merge NO_BSS,IBSS_IDLE,IBSS_ACTIVE and BSS in to 1 state
801 #define JOIN_WAIT_BEACON 1
802 #define SCAN_LISTEN 2
803 #define MAX_SYNC_STATE 3
805 #define SYNC_MACHINE_BASE 0
806 #define MT2_MLME_SCAN_REQ 0
807 #define MT2_MLME_JOIN_REQ 1
808 #define MT2_MLME_START_REQ 2
809 #define MT2_PEER_BEACON 3
810 #define MT2_PEER_PROBE_RSP 4
811 #define MT2_PEER_ATIM 5
812 #define MT2_SCAN_TIMEOUT 6
813 #define MT2_BEACON_TIMEOUT 7
814 #define MT2_ATIM_TIMEOUT 8
815 #define MT2_PEER_PROBE_REQ 9
816 #define MAX_SYNC_MSG 10
818 #define SYNC_FUNC_SIZE (MAX_SYNC_STATE * MAX_SYNC_MSG)
820 //Messages for the DLS state machine
822 #define MAX_DLS_STATE 1
824 #define DLS_MACHINE_BASE 0
825 #define MT2_MLME_DLS_REQ 0
826 #define MT2_PEER_DLS_REQ 1
827 #define MT2_PEER_DLS_RSP 2
828 #define MT2_MLME_DLS_TEAR_DOWN 3
829 #define MT2_PEER_DLS_TEAR_DOWN 4
830 #define MAX_DLS_MSG 5
832 #define DLS_FUNC_SIZE (MAX_DLS_STATE * MAX_DLS_MSG)
835 // STA's WPA-PSK State machine: states, events, total function #
837 #define WPA_PSK_IDLE 0
838 #define MAX_WPA_PSK_STATE 1
840 #define WPA_MACHINE_BASE 0
841 #define MT2_EAPPacket 0
842 #define MT2_EAPOLStart 1
843 #define MT2_EAPOLLogoff 2
844 #define MT2_EAPOLKey 3
845 #define MT2_EAPOLASFAlert 4
846 #define MAX_WPA_PSK_MSG 5
848 #define WPA_PSK_FUNC_SIZE (MAX_WPA_PSK_STATE * MAX_WPA_PSK_MSG)
851 // STA's CISCO-AIRONET State machine: states, events, total function #
853 #define AIRONET_IDLE 0
854 #define AIRONET_SCANNING 1
855 #define MAX_AIRONET_STATE 2
857 #define AIRONET_MACHINE_BASE 0
858 #define MT2_AIRONET_MSG 0
859 #define MT2_AIRONET_SCAN_REQ 1
860 #define MT2_AIRONET_SCAN_DONE 2
861 #define MAX_AIRONET_MSG 3
863 #define AIRONET_FUNC_SIZE (MAX_AIRONET_STATE * MAX_AIRONET_MSG)
866 // AP's CONTROL/CONNECT state machine: states, events, total function #
868 #define AP_CNTL_FUNC_SIZE 1
871 // AP's ASSOC state machine: states, events, total function #
873 #define AP_ASSOC_IDLE 0
874 #define AP_MAX_ASSOC_STATE 1
876 #define AP_ASSOC_MACHINE_BASE 0
877 #define APMT2_MLME_DISASSOC_REQ 0
878 #define APMT2_PEER_DISASSOC_REQ 1
879 #define APMT2_PEER_ASSOC_REQ 2
880 #define APMT2_PEER_REASSOC_REQ 3
881 #define APMT2_CLS3ERR 4
882 #define AP_MAX_ASSOC_MSG 5
884 #define AP_ASSOC_FUNC_SIZE (AP_MAX_ASSOC_STATE * AP_MAX_ASSOC_MSG)
887 // AP's AUTHENTICATION state machine: states, events, total function #
889 #define AP_AUTH_REQ_IDLE 0
890 #define AP_MAX_AUTH_STATE 1
892 #define AP_AUTH_MACHINE_BASE 0
893 #define APMT2_MLME_DEAUTH_REQ 0
894 #define APMT2_CLS2ERR 1
895 #define AP_MAX_AUTH_MSG 2
897 #define AP_AUTH_FUNC_SIZE (AP_MAX_AUTH_STATE * AP_MAX_AUTH_MSG)
900 // AP's AUTH-RSP state machine: states, events, total function #
902 #define AP_AUTH_RSP_IDLE 0
903 #define AP_MAX_AUTH_RSP_STATE 1
905 #define AP_AUTH_RSP_MACHINE_BASE 0
906 #define APMT2_AUTH_CHALLENGE_TIMEOUT 0
907 #define APMT2_PEER_AUTH_ODD 1
908 #define APMT2_PEER_DEAUTH 2
909 #define AP_MAX_AUTH_RSP_MSG 3
911 #define AP_AUTH_RSP_FUNC_SIZE (AP_MAX_AUTH_RSP_STATE * AP_MAX_AUTH_RSP_MSG)
914 // AP's SYNC state machine: states, events, total function #
916 #define AP_SYNC_IDLE 0
917 #define AP_SCAN_LISTEN 1
918 #define AP_MAX_SYNC_STATE 2
920 #define AP_SYNC_MACHINE_BASE 0
921 #define APMT2_PEER_PROBE_REQ 0
922 #define APMT2_PEER_BEACON 1
923 #define APMT2_MLME_SCAN_REQ 2
924 #define APMT2_PEER_PROBE_RSP 3
925 #define APMT2_SCAN_TIMEOUT 4
926 #define APMT2_MLME_SCAN_CNCL 5
927 #define AP_MAX_SYNC_MSG 6
929 #define AP_SYNC_FUNC_SIZE (AP_MAX_SYNC_STATE * AP_MAX_SYNC_MSG)
932 // AP's WPA state machine: states, events, total function #
935 #define AP_MAX_WPA_PTK_STATE 1
937 #define AP_WPA_MACHINE_BASE 0
938 #define APMT2_EAPPacket 0
939 #define APMT2_EAPOLStart 1
940 #define APMT2_EAPOLLogoff 2
941 #define APMT2_EAPOLKey 3
942 #define APMT2_EAPOLASFAlert 4
943 #define AP_MAX_WPA_MSG 5
945 #define AP_WPA_FUNC_SIZE (AP_MAX_WPA_PTK_STATE * AP_MAX_WPA_MSG)
947 // =============================================================================
949 // value domain of 802.11 header FC.Tyte, which is b3..b2 of the 1st-byte of MAC header
954 // value domain of 802.11 MGMT frame's FC.subtype, which is b7..4 of the 1st-byte of MAC header
955 #define SUBTYPE_ASSOC_REQ 0
956 #define SUBTYPE_ASSOC_RSP 1
957 #define SUBTYPE_REASSOC_REQ 2
958 #define SUBTYPE_REASSOC_RSP 3
959 #define SUBTYPE_PROBE_REQ 4
960 #define SUBTYPE_PROBE_RSP 5
961 #define SUBTYPE_BEACON 8
962 #define SUBTYPE_ATIM 9
963 #define SUBTYPE_DISASSOC 10
964 #define SUBTYPE_AUTH 11
965 #define SUBTYPE_DEAUTH 12
966 #define SUBTYPE_ACTION 13
967 #define SUBTYPE_ACTION_NO_ACK 14
969 // value domain of 802.11 CNTL frame's FC.subtype, which is b7..4 of the 1st-byte of MAC header
970 #define SUBTYPE_WRAPPER 7
971 #define SUBTYPE_BLOCK_ACK_REQ 8
972 #define SUBTYPE_BLOCK_ACK 9
973 #define SUBTYPE_PS_POLL 10
974 #define SUBTYPE_RTS 11
975 #define SUBTYPE_CTS 12
976 #define SUBTYPE_ACK 13
977 #define SUBTYPE_CFEND 14
978 #define SUBTYPE_CFEND_CFACK 15
980 // value domain of 802.11 DATA frame's FC.subtype, which is b7..4 of the 1st-byte of MAC header
981 #define SUBTYPE_DATA 0
982 #define SUBTYPE_DATA_CFACK 1
983 #define SUBTYPE_DATA_CFPOLL 2
984 #define SUBTYPE_DATA_CFACK_CFPOLL 3
985 #define SUBTYPE_NULL_FUNC 4
986 #define SUBTYPE_CFACK 5
987 #define SUBTYPE_CFPOLL 6
988 #define SUBTYPE_CFACK_CFPOLL 7
989 #define SUBTYPE_QDATA 8
990 #define SUBTYPE_QDATA_CFACK 9
991 #define SUBTYPE_QDATA_CFPOLL 10
992 #define SUBTYPE_QDATA_CFACK_CFPOLL 11
993 #define SUBTYPE_QOS_NULL 12
994 #define SUBTYPE_QOS_CFACK 13
995 #define SUBTYPE_QOS_CFPOLL 14
996 #define SUBTYPE_QOS_CFACK_CFPOLL 15
998 // ACK policy of QOS Control field bit 6:5
999 #define NORMAL_ACK 0x00 // b6:5 = 00
1000 #define NO_ACK 0x20 // b6:5 = 01
1001 #define NO_EXPLICIT_ACK 0x40 // b6:5 = 10
1002 #define BLOCK_ACK 0x60 // b6:5 = 11
1005 // rtmp_data.c use these definition
1007 #define LENGTH_802_11 24
1008 #define LENGTH_802_11_AND_H 30
1009 #define LENGTH_802_11_CRC_H 34
1010 #define LENGTH_802_11_CRC 28
1011 #define LENGTH_802_11_WITH_ADDR4 30
1012 #define LENGTH_802_3 14
1013 #define LENGTH_802_3_TYPE 2
1014 #define LENGTH_802_1_H 8
1015 #define LENGTH_EAPOL_H 4
1016 #define LENGTH_WMMQOS_H 2
1017 #define LENGTH_CRC 4
1018 #define MAX_SEQ_NUMBER 0x0fff
1019 #define LENGTH_802_3_NO_TYPE 12
1020 #define LENGTH_802_1Q 4 /* VLAN related */
1022 // STA_CSR4.field.TxResult
1023 #define TX_RESULT_SUCCESS 0
1024 #define TX_RESULT_ZERO_LENGTH 1
1025 #define TX_RESULT_UNDER_RUN 2
1026 #define TX_RESULT_OHY_ERROR 4
1027 #define TX_RESULT_RETRY_FAIL 6
1029 // All PHY rate summary in TXD
1030 // Preamble MODE in TxD
1033 #ifdef DOT11_N_SUPPORT
1034 #define MODE_HTMIX 2
1035 #define MODE_HTGREENFIELD 3
1036 #endif // DOT11_N_SUPPORT //
1037 // MCS for CCK. BW.SGI.STBC are reserved
1038 #define MCS_LONGP_RATE_1 0 // long preamble CCK 1Mbps
1039 #define MCS_LONGP_RATE_2 1 // long preamble CCK 1Mbps
1040 #define MCS_LONGP_RATE_5_5 2
1041 #define MCS_LONGP_RATE_11 3
1042 #define MCS_SHORTP_RATE_1 4 // long preamble CCK 1Mbps. short is forbidden in 1Mbps
1043 #define MCS_SHORTP_RATE_2 5 // short preamble CCK 2Mbps
1044 #define MCS_SHORTP_RATE_5_5 6
1045 #define MCS_SHORTP_RATE_11 7
1046 // To send duplicate legacy OFDM. set BW=BW_40. SGI.STBC are reserved
1047 #define MCS_RATE_6 0 // legacy OFDM
1048 #define MCS_RATE_9 1 // OFDM
1049 #define MCS_RATE_12 2 // OFDM
1050 #define MCS_RATE_18 3 // OFDM
1051 #define MCS_RATE_24 4 // OFDM
1052 #define MCS_RATE_36 5 // OFDM
1053 #define MCS_RATE_48 6 // OFDM
1054 #define MCS_RATE_54 7 // OFDM
1056 #define MCS_0 0 // 1S
1064 #define MCS_8 8 // 2S
1072 #define MCS_16 16 // 3*3
1083 #ifdef DOT11_N_SUPPORT
1088 #endif // DOT11_N_SUPPORT //
1090 // Fixed Tx MODE - HT, CCK or OFDM
1091 #define FIXED_TXMODE_HT 0
1092 #define FIXED_TXMODE_CCK 1
1093 #define FIXED_TXMODE_OFDM 2
1095 #define BW_20 BAND_WIDTH_20
1096 #define BW_40 BAND_WIDTH_40
1097 #define BW_BOTH BAND_WIDTH_BOTH
1098 #define BW_10 BAND_WIDTH_10 // 802.11j has 10MHz. This definition is for internal usage. doesn't fill in the IE or other field.
1100 #ifdef DOT11_N_SUPPORT
1102 #define GI_400 GAP_INTERVAL_400 // only support in HT mode
1103 #define GI_BOTH GAP_INTERVAL_BOTH
1104 #endif // DOT11_N_SUPPORT //
1105 #define GI_800 GAP_INTERVAL_800
1108 #ifdef DOT11_N_SUPPORT
1109 #define STBC_USE 1 // limited use in rt2860b phy
1110 #define RXSTBC_ONE 1 // rx support of one spatial stream
1111 #define RXSTBC_TWO 2 // rx support of 1 and 2 spatial stream
1112 #define RXSTBC_THR 3 // rx support of 1~3 spatial stream
1114 #define MCSFBK_NONE 0 // not support mcs feedback /
1115 #define MCSFBK_RSV 1 // reserved
1116 #define MCSFBK_UNSOLICIT 2 // only support unsolict mcs feedback
1117 #define MCSFBK_MRQ 3 // response to both MRQ and unsolict mcs feedback
1120 #define MMPS_STATIC 0
1121 #define MMPS_DYNAMIC 1
1123 #define MMPS_ENABLE 3
1130 #endif // DOT11_N_SUPPORT //
1133 #define TXRATEMIMO 0x80
1134 #define TXRATEMCS 0x7F
1135 #define TXRATEOFDM 0x7F
1140 #define RATE_6 4 // OFDM
1141 #define RATE_9 5 // OFDM
1142 #define RATE_12 6 // OFDM
1143 #define RATE_18 7 // OFDM
1144 #define RATE_24 8 // OFDM
1145 #define RATE_36 9 // OFDM
1146 #define RATE_48 10 // OFDM
1147 #define RATE_54 11 // OFDM
1148 #define RATE_FIRST_OFDM_RATE RATE_6
1149 #define RATE_LAST_OFDM_RATE RATE_54
1150 #define RATE_6_5 12 // HT mix
1151 #define RATE_13 13 // HT mix
1152 #define RATE_19_5 14 // HT mix
1153 #define RATE_26 15 // HT mix
1154 #define RATE_39 16 // HT mix
1155 #define RATE_52 17 // HT mix
1156 #define RATE_58_5 18 // HT mix
1157 #define RATE_65 19 // HT mix
1158 #define RATE_78 20 // HT mix
1159 #define RATE_104 21 // HT mix
1160 #define RATE_117 22 // HT mix
1161 #define RATE_130 23 // HT mix
1162 //#define RATE_AUTO_SWITCH 255 // for StaCfg.FixedTxRate only
1164 #define RATE_FIRST_MM_RATE HTRATE_0
1165 #define RATE_FIRST_HT_RATE HTRATE_0
1166 #define RATE_LAST_HT_RATE HTRATE_0
1169 #define IFS_HTTXOP 0 // The txop will be handles by ASIC.
1172 #define IFS_BACKOFF 3
1175 #define LONG_RETRY 1
1176 #define SHORT_RETRY 0
1178 // Country Region definition
1179 #define REGION_MINIMUM_BG_BAND 0
1180 #define REGION_0_BG_BAND 0 // 1-11
1181 #define REGION_1_BG_BAND 1 // 1-13
1182 #define REGION_2_BG_BAND 2 // 10-11
1183 #define REGION_3_BG_BAND 3 // 10-13
1184 #define REGION_4_BG_BAND 4 // 14
1185 #define REGION_5_BG_BAND 5 // 1-14
1186 #define REGION_6_BG_BAND 6 // 3-9
1187 #define REGION_7_BG_BAND 7 // 5-13
1188 #define REGION_31_BG_BAND 31 // 5-13
1189 #define REGION_MAXIMUM_BG_BAND 7
1191 #define REGION_MINIMUM_A_BAND 0
1192 #define REGION_0_A_BAND 0 // 36, 40, 44, 48, 52, 56, 60, 64, 149, 153, 157, 161, 165
1193 #define REGION_1_A_BAND 1 // 36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140
1194 #define REGION_2_A_BAND 2 // 36, 40, 44, 48, 52, 56, 60, 64
1195 #define REGION_3_A_BAND 3 // 52, 56, 60, 64, 149, 153, 157, 161
1196 #define REGION_4_A_BAND 4 // 149, 153, 157, 161, 165
1197 #define REGION_5_A_BAND 5 // 149, 153, 157, 161
1198 #define REGION_6_A_BAND 6 // 36, 40, 44, 48
1199 #define REGION_7_A_BAND 7 // 36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140, 149, 153, 157, 161, 165
1200 #define REGION_8_A_BAND 8 // 52, 56, 60, 64
1201 #define REGION_9_A_BAND 9 // 36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 132, 136, 140, 149, 153, 157, 161, 165
1202 #define REGION_10_A_BAND 10 // 36, 40, 44, 48, 149, 153, 157, 161, 165
1203 #define REGION_11_A_BAND 11 // 36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 149, 153, 157, 161
1204 #define REGION_MAXIMUM_A_BAND 11
1207 #define CIPHER_NONE 0
1208 #define CIPHER_WEP64 1
1209 #define CIPHER_WEP128 2
1210 #define CIPHER_TKIP 3
1211 #define CIPHER_AES 4
1212 #define CIPHER_CKIP64 5
1213 #define CIPHER_CKIP128 6
1214 #define CIPHER_TKIP_NO_MIC 7 // MIC appended by driver: not a valid value in hardware key table
1215 #define CIPHER_SMS4 8
1217 // value domain of pAd->RfIcType
1218 #define RFIC_2820 1 // 2.4G 2T3R
1219 #define RFIC_2850 2 // 2.4G/5G 2T3R
1220 #define RFIC_2720 3 // 2.4G 1T2R
1221 #define RFIC_2750 4 // 2.4G/5G 1T2R
1222 #define RFIC_3020 5 // 2.4G 1T1R
1223 #define RFIC_2020 6 // 2.4G B/G
1226 #define LED_LINK_DOWN 0
1227 #define LED_LINK_UP 1
1228 #define LED_RADIO_OFF 2
1229 #define LED_RADIO_ON 3
1232 #define LED_ON_SITE_SURVEY 6
1233 #define LED_POWER_UP 7
1235 // value domain of pAd->LedCntl.LedMode and E2PROM
1236 #define LED_MODE_DEFAULT 0
1237 #define LED_MODE_TWO_LED 1
1238 #define LED_MODE_SIGNAL_STREGTH 8 // EEPROM define =8
1240 // RC4 init value, used fro WEP & TKIP
1241 #define PPPINITFCS32 0xffffffff /* Initial FCS value */
1243 // value domain of pAd->StaCfg.PortSecured. 802.1X controlled port definition
1244 #define WPA_802_1X_PORT_SECURED 1
1245 #define WPA_802_1X_PORT_NOT_SECURED 2
1247 #define PAIRWISE_KEY 1
1251 #define MAX_STEP_OF_TX_RATE_SWITCH 32
1254 // pre-allocated free NDIS PACKET/BUFFER poll for internal usage
1255 #define MAX_NUM_OF_FREE_NDIS_PACKET 128
1258 #define MAX_TX_REORDERBUF 64
1259 #define MAX_RX_REORDERBUF 64
1260 #define DEFAULT_TX_TIMEOUT 30
1261 #define DEFAULT_RX_TIMEOUT 30
1263 // definition of Recipient or Originator
1264 #define I_RECIPIENT TRUE
1265 #define I_ORIGINATOR FALSE
1267 #define DEFAULT_BBP_TX_POWER 0
1268 #define DEFAULT_RF_TX_POWER 5
1270 #define MAX_INI_BUFFER_SIZE 4096
1271 #define MAX_PARAM_BUFFER_SIZE (2048) // enough for ACL (18*64)
1272 //18 : the length of Mac address acceptable format "01:02:03:04:05:06;")
1273 //64 : MAX_NUM_OF_ACL_LIST
1274 // definition of pAd->OpMode
1275 #define OPMODE_STA 0
1277 //#define OPMODE_L3_BRG 2 // as AP and STA at the same time
1279 #ifdef RT_BIG_ENDIAN
1284 #define TYPE_TXINFO 0
1285 #define TYPE_RXINFO 1
1290 // ========================= AP rtmp_def.h ===========================
1291 // value domain for pAd->EventTab.Log[].Event
1292 #define EVENT_RESET_ACCESS_POINT 0 // Log = "hh:mm:ss Restart Access Point"
1293 #define EVENT_ASSOCIATED 1 // Log = "hh:mm:ss STA 00:01:02:03:04:05 associated"
1294 #define EVENT_DISASSOCIATED 2 // Log = "hh:mm:ss STA 00:01:02:03:04:05 left this BSS"
1295 #define EVENT_AGED_OUT 3 // Log = "hh:mm:ss STA 00:01:02:03:04:05 was aged-out and removed from this BSS"
1296 #define EVENT_COUNTER_M 4
1297 #define EVENT_INVALID_PSK 5
1298 #define EVENT_MAX_EVENT_TYPE 6
1299 // ==== end of AP rtmp_def.h ============
1301 // definition RSSI Number
1306 // definition of radar detection
1307 #define RD_NORMAL_MODE 0 // Not found radar signal
1308 #define RD_SWITCHING_MODE 1 // Found radar signal, and doing channel switch
1309 #define RD_SILENCE_MODE 2 // After channel switch, need to be silence a while to ensure radar not found
1311 //Driver defined cid for mapping status and command.
1312 #define SLEEPCID 0x11
1313 #define WAKECID 0x22
1314 #define QUERYPOWERCID 0x33
1315 #define OWNERMCU 0x1
1316 #define OWNERCPU 0x0
1318 // MBSSID definition
1319 #define ENTRY_NOT_FOUND 0xFF
1322 /* After Linux 2.6.9,
1323 * VLAN module use Private (from user) interface flags (netdevice->priv_flags).
1324 * #define IFF_802_1Q_VLAN 0x1 -- 802.1Q VLAN device. in if.h
1325 * ref to ip_sabotage_out() [ out->priv_flags & IFF_802_1Q_VLAN ] in br_netfilter.c
1327 * For this reason, we MUST use EVEN value in priv_flags
1329 #define INT_MAIN 0x0100
1330 #define INT_MBSSID 0x0200
1331 #define INT_WDS 0x0300
1332 #define INT_APCLI 0x0400
1333 #define INT_MESH 0x0500
1336 #define WEP_HEXADECIMAL_TYPE 0
1337 #define WEP_ASCII_TYPE 1
1341 // WIRELESS EVENTS definition
1342 /* Max number of char in custom event, refer to wireless_tools.28/wireless.20.h */
1343 #define IW_CUSTOM_MAX_LEN 255 /* In bytes */
1345 // For system event - start
1346 #define IW_SYS_EVENT_FLAG_START 0x0200
1347 #define IW_ASSOC_EVENT_FLAG 0x0200
1348 #define IW_DISASSOC_EVENT_FLAG 0x0201
1349 #define IW_DEAUTH_EVENT_FLAG 0x0202
1350 #define IW_AGEOUT_EVENT_FLAG 0x0203
1351 #define IW_COUNTER_MEASURES_EVENT_FLAG 0x0204
1352 #define IW_REPLAY_COUNTER_DIFF_EVENT_FLAG 0x0205
1353 #define IW_RSNIE_DIFF_EVENT_FLAG 0x0206
1354 #define IW_MIC_DIFF_EVENT_FLAG 0x0207
1355 #define IW_ICV_ERROR_EVENT_FLAG 0x0208
1356 #define IW_MIC_ERROR_EVENT_FLAG 0x0209
1357 #define IW_GROUP_HS_TIMEOUT_EVENT_FLAG 0x020A
1358 #define IW_PAIRWISE_HS_TIMEOUT_EVENT_FLAG 0x020B
1359 #define IW_RSNIE_SANITY_FAIL_EVENT_FLAG 0x020C
1360 #define IW_SET_KEY_DONE_WPA1_EVENT_FLAG 0x020D
1361 #define IW_SET_KEY_DONE_WPA2_EVENT_FLAG 0x020E
1362 #define IW_STA_LINKUP_EVENT_FLAG 0x020F
1363 #define IW_STA_LINKDOWN_EVENT_FLAG 0x0210
1364 #define IW_SCAN_COMPLETED_EVENT_FLAG 0x0211
1365 #define IW_SCAN_ENQUEUE_FAIL_EVENT_FLAG 0x0212
1366 // if add new system event flag, please upadte the IW_SYS_EVENT_FLAG_END
1367 #define IW_SYS_EVENT_FLAG_END 0x0212
1368 #define IW_SYS_EVENT_TYPE_NUM (IW_SYS_EVENT_FLAG_END - IW_SYS_EVENT_FLAG_START + 1)
1369 // For system event - end
1371 // For spoof attack event - start
1372 #define IW_SPOOF_EVENT_FLAG_START 0x0300
1373 #define IW_CONFLICT_SSID_EVENT_FLAG 0x0300
1374 #define IW_SPOOF_ASSOC_RESP_EVENT_FLAG 0x0301
1375 #define IW_SPOOF_REASSOC_RESP_EVENT_FLAG 0x0302
1376 #define IW_SPOOF_PROBE_RESP_EVENT_FLAG 0x0303
1377 #define IW_SPOOF_BEACON_EVENT_FLAG 0x0304
1378 #define IW_SPOOF_DISASSOC_EVENT_FLAG 0x0305
1379 #define IW_SPOOF_AUTH_EVENT_FLAG 0x0306
1380 #define IW_SPOOF_DEAUTH_EVENT_FLAG 0x0307
1381 #define IW_SPOOF_UNKNOWN_MGMT_EVENT_FLAG 0x0308
1382 #define IW_REPLAY_ATTACK_EVENT_FLAG 0x0309
1383 // if add new spoof attack event flag, please upadte the IW_SPOOF_EVENT_FLAG_END
1384 #define IW_SPOOF_EVENT_FLAG_END 0x0309
1385 #define IW_SPOOF_EVENT_TYPE_NUM (IW_SPOOF_EVENT_FLAG_END - IW_SPOOF_EVENT_FLAG_START + 1)
1386 // For spoof attack event - end
1388 // For flooding attack event - start
1389 #define IW_FLOOD_EVENT_FLAG_START 0x0400
1390 #define IW_FLOOD_AUTH_EVENT_FLAG 0x0400
1391 #define IW_FLOOD_ASSOC_REQ_EVENT_FLAG 0x0401
1392 #define IW_FLOOD_REASSOC_REQ_EVENT_FLAG 0x0402
1393 #define IW_FLOOD_PROBE_REQ_EVENT_FLAG 0x0403
1394 #define IW_FLOOD_DISASSOC_EVENT_FLAG 0x0404
1395 #define IW_FLOOD_DEAUTH_EVENT_FLAG 0x0405
1396 #define IW_FLOOD_EAP_REQ_EVENT_FLAG 0x0406
1397 // if add new flooding attack event flag, please upadte the IW_FLOOD_EVENT_FLAG_END
1398 #define IW_FLOOD_EVENT_FLAG_END 0x0406
1399 #define IW_FLOOD_EVENT_TYPE_NUM (IW_FLOOD_EVENT_FLAG_END - IW_FLOOD_EVENT_FLAG_START + 1)
1400 // For flooding attack - end
1402 // End - WIRELESS EVENTS definition
1404 #ifdef CONFIG_STA_SUPPORT
1405 // definition for DLS, kathy
1406 #define MAX_NUM_OF_INIT_DLS_ENTRY 1
1407 #define MAX_NUM_OF_DLS_ENTRY MAX_NUMBER_OF_DLS_ENTRY
1409 //Block ACK , rt2860, kathy
1410 #define MAX_TX_REORDERBUF 64
1411 #define MAX_RX_REORDERBUF 64
1412 #define DEFAULT_TX_TIMEOUT 30
1413 #define DEFAULT_RX_TIMEOUT 30
1414 #ifndef CONFIG_AP_SUPPORT
1415 #define MAX_BARECI_SESSION 8
1418 #ifndef IW_ESSID_MAX_SIZE
1419 /* Maximum size of the ESSID and pAd->nickname strings */
1420 #define IW_ESSID_MAX_SIZE 32
1422 #endif // CONFIG_STA_SUPPORT //
1424 #ifdef MCAST_RATE_SPECIFIC
1425 #define MCAST_DISABLE 0
1427 #define MCAST_OFDM 2
1428 #define MCAST_HTMIX 3
1429 #endif // MCAST_RATE_SPECIFIC //
1431 // For AsicRadioOff/AsicRadioOn/AsicForceWakeup function
1432 // This is to indicate from where to call this function.
1433 #define DOT11POWERSAVE 0 // TO do .11 power save sleep
1434 #define GUIRADIO_OFF 1 // To perform Radio OFf command from GUI
1435 #define RTMP_HALT 2 // Called from Halt handler.
1436 #define GUI_IDLE_POWER_SAVE 3 // Call to sleep before link up with AP
1437 #define FROM_TX 4 // Force wake up from Tx packet.
1441 // definition for WpaSupport flag
1442 #define WPA_SUPPLICANT_DISABLE 0
1443 #define WPA_SUPPLICANT_ENABLE 1
1444 #define WPA_SUPPLICANT_ENABLE_WITH_WEB_UI 2
1446 // Endian byte swapping codes
1449 (((UINT16)(x) & (UINT16) 0x00ffU) << 8) | \
1450 (((UINT16)(x) & (UINT16) 0xff00U) >> 8) ))
1454 (((UINT32)(x) & (UINT32) 0x000000ffUL) << 24) | \
1455 (((UINT32)(x) & (UINT32) 0x0000ff00UL) << 8) | \
1456 (((UINT32)(x) & (UINT32) 0x00ff0000UL) >> 8) | \
1457 (((UINT32)(x) & (UINT32) 0xff000000UL) >> 24) ))
1461 (UINT64)(((UINT64)(x) & (UINT64) 0x00000000000000ffULL) << 56) | \
1462 (UINT64)(((UINT64)(x) & (UINT64) 0x000000000000ff00ULL) << 40) | \
1463 (UINT64)(((UINT64)(x) & (UINT64) 0x0000000000ff0000ULL) << 24) | \
1464 (UINT64)(((UINT64)(x) & (UINT64) 0x00000000ff000000ULL) << 8) | \
1465 (UINT64)(((UINT64)(x) & (UINT64) 0x000000ff00000000ULL) >> 8) | \
1466 (UINT64)(((UINT64)(x) & (UINT64) 0x0000ff0000000000ULL) >> 24) | \
1467 (UINT64)(((UINT64)(x) & (UINT64) 0x00ff000000000000ULL) >> 40) | \
1468 (UINT64)(((UINT64)(x) & (UINT64) 0xff00000000000000ULL) >> 56) ))
1470 #ifdef RT_BIG_ENDIAN
1472 #define cpu2le64(x) SWAP64((x))
1473 #define le2cpu64(x) SWAP64((x))
1474 #define cpu2le32(x) SWAP32((x))
1475 #define le2cpu32(x) SWAP32((x))
1476 #define cpu2le16(x) SWAP16((x))
1477 #define le2cpu16(x) SWAP16((x))
1478 #define cpu2be64(x) ((UINT64)(x))
1479 #define be2cpu64(x) ((UINT64)(x))
1480 #define cpu2be32(x) ((UINT32)(x))
1481 #define be2cpu32(x) ((UINT32)(x))
1482 #define cpu2be16(x) ((UINT16)(x))
1483 #define be2cpu16(x) ((UINT16)(x))
1485 #else // Little_Endian
1487 #define cpu2le64(x) ((UINT64)(x))
1488 #define le2cpu64(x) ((UINT64)(x))
1489 #define cpu2le32(x) ((UINT32)(x))
1490 #define le2cpu32(x) ((UINT32)(x))
1491 #define cpu2le16(x) ((UINT16)(x))
1492 #define le2cpu16(x) ((UINT16)(x))
1493 #define cpu2be64(x) SWAP64((x))
1494 #define be2cpu64(x) SWAP64((x))
1495 #define cpu2be32(x) SWAP32((x))
1496 #define be2cpu32(x) SWAP32((x))
1497 #define cpu2be16(x) SWAP16((x))
1498 #define be2cpu16(x) SWAP16((x))
1500 #endif // RT_BIG_ENDIAN
1502 #endif // __RTMP_DEF_H__
projects / linux-2.6 / blob