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**")
57 #define RALINK_2883_VERSION ((UINT32)0x28830300)
58 #define RALINK_2880E_VERSION ((UINT32)0x28720200)
59 #define RALINK_3070_VERSION ((UINT32)0x30700200)
62 // NDIS version in use by the NIC driver.
63 // The high byte is the major version. The low byte is the minor version.
65 #ifdef NDIS51_MINIPORT
66 #define NIC_DRIVER_VERSION 0x0501
68 #define NIC_DRIVER_VERSION 0x0500
72 // NDIS media type, current is ethernet, change if native wireless supported
74 #define NIC_MEDIA_TYPE NdisMedium802_3
75 #define NIC_PCI_HDR_LENGTH 0xe2
76 #define NIC_MAX_PACKET_SIZE 2304
77 #define NIC_HEADER_SIZE 14
78 #define MAX_MAP_REGISTERS_NEEDED 32
79 #define MIN_MAP_REGISTERS_NEEDED 2 //Todo: should consider fragment issue.
82 // interface type, we use PCI
84 #define NIC_INTERFACE_TYPE NdisInterfacePci
85 #define NIC_INTERRUPT_MODE NdisInterruptLevelSensitive
88 // buffer size passed in NdisMQueryAdapterResources
89 // We should only need three adapter resources (IO, interrupt and memory),
90 // Some devices get extra resources, so have room for 10 resources
91 // UF_SIZE (sizeof(NDIS_RESOURCE_LIST) + (10*sizeof(CM_PARTIAL_RESOURCE_DESCRIPTOR)))
94 #define NIC_RESOURCE_B//
97 #define NIC_MAP_IOSPACE_LENGTH sizeof(CSR_STRUC)
99 #define MAX_RX_PKT_LEN 1520
102 // Entry number for each DMA descriptor ring
106 #define TX_RING_SIZE 64 //64
107 #define MGMT_RING_SIZE 128
108 #define RX_RING_SIZE 128 //64
109 #define MAX_TX_PROCESS TX_RING_SIZE //8
110 #define MAX_DMA_DONE_PROCESS TX_RING_SIZE
111 #define MAX_TX_DONE_PROCESS TX_RING_SIZE //8
112 #define LOCAL_TXBUF_SIZE 2
115 #define TX_RING_SIZE 8 // 1
116 #define PRIO_RING_SIZE 8
117 #define MGMT_RING_SIZE 32 // PRIO_RING_SIZE
118 #define RX_RING_SIZE 8
119 #define MAX_TX_PROCESS 4
120 #define LOCAL_TXBUF_SIZE 2048
123 #define MAX_RX_PROCESS 128 //64 //32
124 #define NUM_OF_LOCAL_TXBUF 2
129 // TXINFO_SIZE + TXWI_SIZE + 802.11 Header Size + AMSDU sub frame header
130 #define TX_DMA_1ST_BUFFER_SIZE 96 // only the 1st physical buffer is pre-allocated
131 #define MGMT_DMA_BUFFER_SIZE 1536 //2048
132 #define RX_BUFFER_AGGRESIZE 3840 //3904 //3968 //4096 //2048 //4096
133 #define RX_BUFFER_NORMSIZE 3840 //3904 //3968 //4096 //2048 //4096
134 #define TX_BUFFER_NORMSIZE RX_BUFFER_NORMSIZE
135 #define MAX_FRAME_SIZE 2346 // Maximum 802.11 frame size
136 #define MAX_AGGREGATION_SIZE 3840 //3904 //3968 //4096
137 #define MAX_NUM_OF_TUPLE_CACHE 2
138 #define MAX_MCAST_LIST_SIZE 32
139 #define MAX_LEN_OF_VENDOR_DESC 64
140 //#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
141 #define MAX_SIZE_OF_MCAST_PSQ 32
143 #define MAX_RX_PROCESS_CNT (RX_RING_SIZE)
146 #define MAX_PACKETS_IN_QUEUE (512) //(512) // to pass WMM A5-WPAPSK
147 #define MAX_PACKETS_IN_MCAST_PS_QUEUE 32
148 #define MAX_PACKETS_IN_PS_QUEUE 128 //32
149 #define WMM_NUM_OF_AC 4 /* AC0, AC1, AC2, and AC3 */
151 #define MAX_EEPROM_BIN_FILE_SIZE 1024
154 #define STANORMAL 0x17f97
155 #define APNORMAL 0x15f97
157 // RTMP_ADAPTER flags
159 #define fRTMP_ADAPTER_MAP_REGISTER 0x00000001
160 #define fRTMP_ADAPTER_INTERRUPT_IN_USE 0x00000002
161 #define fRTMP_ADAPTER_HARDWARE_ERROR 0x00000004
162 #define fRTMP_ADAPTER_SCATTER_GATHER 0x00000008
163 #define fRTMP_ADAPTER_SEND_PACKET_ERROR 0x00000010
164 #define fRTMP_ADAPTER_MLME_RESET_IN_PROGRESS 0x00000020
165 #define fRTMP_ADAPTER_HALT_IN_PROGRESS 0x00000040
166 #define fRTMP_ADAPTER_RESET_IN_PROGRESS 0x00000080
167 #define fRTMP_ADAPTER_NIC_NOT_EXIST 0x00000100
168 #define fRTMP_ADAPTER_TX_RING_ALLOCATED 0x00000200
169 #define fRTMP_ADAPTER_REMOVE_IN_PROGRESS 0x00000400
170 #define fRTMP_ADAPTER_MIMORATE_INUSED 0x00000800
171 #define fRTMP_ADAPTER_RX_RING_ALLOCATED 0x00001000
172 #define fRTMP_ADAPTER_INTERRUPT_ACTIVE 0x00002000
173 #define fRTMP_ADAPTER_BSS_SCAN_IN_PROGRESS 0x00004000
174 #define fRTMP_ADAPTER_REASSOC_IN_PROGRESS 0x00008000
175 #define fRTMP_ADAPTER_MEDIA_STATE_PENDING 0x00010000
176 #define fRTMP_ADAPTER_RADIO_OFF 0x00020000
177 #define fRTMP_ADAPTER_BULKOUT_RESET 0x00040000
178 #define fRTMP_ADAPTER_BULKIN_RESET 0x00080000
179 #define fRTMP_ADAPTER_RDG_ACTIVE 0x00100000
180 #define fRTMP_ADAPTER_DYNAMIC_BE_TXOP_ACTIVE 0x00200000
181 #define fRTMP_ADAPTER_SCAN_2040 0x04000000
182 #define fRTMP_ADAPTER_RADIO_MEASUREMENT 0x08000000
184 #define fRTMP_ADAPTER_START_UP 0x10000000 //Devive already initialized and enabled Tx/Rx.
185 #define fRTMP_ADAPTER_MEDIA_STATE_CHANGE 0x20000000
186 #define fRTMP_ADAPTER_IDLE_RADIO_OFF 0x40000000
189 // STA operation status flags
191 #define fOP_STATUS_INFRA_ON 0x00000001
192 #define fOP_STATUS_ADHOC_ON 0x00000002
193 #define fOP_STATUS_BG_PROTECTION_INUSED 0x00000004
194 #define fOP_STATUS_SHORT_SLOT_INUSED 0x00000008
195 #define fOP_STATUS_SHORT_PREAMBLE_INUSED 0x00000010
196 #define fOP_STATUS_RECEIVE_DTIM 0x00000020
197 #define fOP_STATUS_MEDIA_STATE_CONNECTED 0x00000080
198 #define fOP_STATUS_WMM_INUSED 0x00000100
199 #define fOP_STATUS_AGGREGATION_INUSED 0x00000200
200 #define fOP_STATUS_DOZE 0x00000400 // debug purpose
201 #define fOP_STATUS_PIGGYBACK_INUSED 0x00000800 // piggy-back, and aggregation
202 #define fOP_STATUS_APSD_INUSED 0x00001000
203 #define fOP_STATUS_TX_AMSDU_INUSED 0x00002000
204 #define fOP_STATUS_MAX_RETRY_ENABLED 0x00004000
205 #define fOP_STATUS_WAKEUP_NOW 0x00008000
206 #define fOP_STATUS_ADVANCE_POWER_SAVE_PCIE_DEVICE 0x00020000
210 // RTMP_ADAPTER PSFlags : related to advanced power save.
212 // Indicate whether driver can go to sleep mode from now. This flag is useful AFTER link up
213 #define fRTMP_PS_CAN_GO_SLEEP 0x00000001
214 // Indicate whether driver has issue a LinkControl command to PCIe L1
215 #define fRTMP_PS_SET_PCI_CLK_OFF_COMMAND 0x00000002
216 // Indicate driver should disable kick off hardware to send packets from now.
217 #define fRTMP_PS_DISABLE_TX 0x00000004
218 // Indicate driver should IMMEDIATELY fo to sleep after receiving AP's beacon in which doesn't indicate unicate nor multicast packets for me
219 //. This flag is used ONLY in RTMPHandleRxDoneInterrupt routine.
220 #define fRTMP_PS_GO_TO_SLEEP_NOW 0x00000008
223 #define CCKSETPROTECT 0x1
224 #define OFDMSETPROTECT 0x2
225 #define MM20SETPROTECT 0x4
226 #define MM40SETPROTECT 0x8
227 #define GF20SETPROTECT 0x10
228 #define GR40SETPROTECT 0x20
229 #define ALLN_SETPROTECT (GR40SETPROTECT | GF20SETPROTECT | MM40SETPROTECT | MM20SETPROTECT)
232 // AP's client table operation status flags
234 #define fCLIENT_STATUS_WMM_CAPABLE 0x00000001 // CLIENT can parse QOS DATA frame
235 #define fCLIENT_STATUS_AGGREGATION_CAPABLE 0x00000002 // CLIENT can receive Ralink's proprietary TX aggregation frame
236 #define fCLIENT_STATUS_PIGGYBACK_CAPABLE 0x00000004 // CLIENT support piggy-back
237 #define fCLIENT_STATUS_AMSDU_INUSED 0x00000008
238 #define fCLIENT_STATUS_SGI20_CAPABLE 0x00000010
239 #define fCLIENT_STATUS_SGI40_CAPABLE 0x00000020
240 #define fCLIENT_STATUS_TxSTBC_CAPABLE 0x00000040
241 #define fCLIENT_STATUS_RxSTBC_CAPABLE 0x00000080
242 #define fCLIENT_STATUS_HTC_CAPABLE 0x00000100
243 #define fCLIENT_STATUS_RDG_CAPABLE 0x00000200
244 #define fCLIENT_STATUS_MCSFEEDBACK_CAPABLE 0x00000400
245 #define fCLIENT_STATUS_APSD_CAPABLE 0x00000800 /* UAPSD STATION */
247 #define fCLIENT_STATUS_RALINK_CHIPSET 0x00100000
249 // STA configuration flags
252 // 802.11n Operating Mode Definition. 0-3 also used in ASICUPdateProtect switch case
253 #define HT_NO_PROTECT 0
254 #define HT_LEGACY_PROTECT 1
255 #define HT_40_PROTECT 2
256 #define HT_2040_PROTECT 3
257 #define HT_RTSCTS_6M 7
258 //following is our own definition in order to turn on our ASIC protection register in INFRASTRUCTURE.
259 #define HT_ATHEROS 8 // rt2860c has problem with atheros chip. we need to turn on RTS/CTS .
260 #define HT_FORCERTSCTS 9 // Force turn on RTS/CTS first. then go to evaluate if this force RTS is necessary.
263 // RX Packet Filter control flags. Apply on pAd->PacketFilter
265 #define fRX_FILTER_ACCEPT_DIRECT NDIS_PACKET_TYPE_DIRECTED
266 #define fRX_FILTER_ACCEPT_MULTICAST NDIS_PACKET_TYPE_MULTICAST
267 #define fRX_FILTER_ACCEPT_BROADCAST NDIS_PACKET_TYPE_BROADCAST
268 #define fRX_FILTER_ACCEPT_ALL_MULTICAST NDIS_PACKET_TYPE_ALL_MULTICAST
271 // Error code section
273 // NDIS_ERROR_CODE_ADAPTER_NOT_FOUND
274 #define ERRLOG_READ_PCI_SLOT_FAILED 0x00000101L
275 #define ERRLOG_WRITE_PCI_SLOT_FAILED 0x00000102L
276 #define ERRLOG_VENDOR_DEVICE_NOMATCH 0x00000103L
278 // NDIS_ERROR_CODE_ADAPTER_DISABLED
279 #define ERRLOG_BUS_MASTER_DISABLED 0x00000201L
281 // NDIS_ERROR_CODE_UNSUPPORTED_CONFIGURATION
282 #define ERRLOG_INVALID_SPEED_DUPLEX 0x00000301L
283 #define ERRLOG_SET_SECONDARY_FAILED 0x00000302L
285 // NDIS_ERROR_CODE_OUT_OF_RESOURCES
286 #define ERRLOG_OUT_OF_MEMORY 0x00000401L
287 #define ERRLOG_OUT_OF_SHARED_MEMORY 0x00000402L
288 #define ERRLOG_OUT_OF_MAP_REGISTERS 0x00000403L
289 #define ERRLOG_OUT_OF_BUFFER_POOL 0x00000404L
290 #define ERRLOG_OUT_OF_NDIS_BUFFER 0x00000405L
291 #define ERRLOG_OUT_OF_PACKET_POOL 0x00000406L
292 #define ERRLOG_OUT_OF_NDIS_PACKET 0x00000407L
293 #define ERRLOG_OUT_OF_LOOKASIDE_MEMORY 0x00000408L
295 // NDIS_ERROR_CODE_HARDWARE_FAILURE
296 #define ERRLOG_SELFTEST_FAILED 0x00000501L
297 #define ERRLOG_INITIALIZE_ADAPTER 0x00000502L
298 #define ERRLOG_REMOVE_MINIPORT 0x00000503L
300 // NDIS_ERROR_CODE_RESOURCE_CONFLICT
301 #define ERRLOG_MAP_IO_SPACE 0x00000601L
302 #define ERRLOG_QUERY_ADAPTER_RESOURCES 0x00000602L
303 #define ERRLOG_NO_IO_RESOURCE 0x00000603L
304 #define ERRLOG_NO_INTERRUPT_RESOURCE 0x00000604L
305 #define ERRLOG_NO_MEMORY_RESOURCE 0x00000605L
309 #define MAX_WDS_ENTRY 4
310 #define WDS_PAIRWISE_KEY_OFFSET 60 // WDS links uses pairwise key#60 ~ 63 in ASIC pairwise key table
312 #define WDS_DISABLE_MODE 0
313 #define WDS_RESTRICT_MODE 1
314 #define WDS_BRIDGE_MODE 2
315 #define WDS_REPEATER_MODE 3
316 #define WDS_LAZY_MODE 4
319 #define MAX_MESH_NUM 0
321 #define MAX_APCLI_NUM 0
323 #define MAX_MBSSID_NUM 1
324 #if defined(RT2860) || defined(RT30xx)
326 #undef MAX_MBSSID_NUM
327 #define MAX_MBSSID_NUM (8 - MAX_MESH_NUM - MAX_APCLI_NUM)
328 #endif // MBSS_SUPPORT //
331 /* sanity check for apidx */
332 #define MBSS_MR_APIDX_SANITY_CHECK(apidx) \
333 { if (apidx > MAX_MBSSID_NUM) { \
334 printk("%s> Error! apidx = %d > MAX_MBSSID_NUM!\n", __func__, apidx); \
335 apidx = MAIN_MBSSID; } }
337 #define VALID_WCID(_wcid) ((_wcid) > 0 && (_wcid) < MAX_LEN_OF_MAC_TABLE )
339 #define MAIN_MBSSID 0
340 #define FIRST_MBSSID 1
343 #define MAX_BEACON_SIZE 512
344 // If the MAX_MBSSID_NUM is larger than 6,
345 // it shall reserve some WCID space(wcid 222~253) for beacon frames.
346 // - these wcid 238~253 are reserved for beacon#6(ra6).
347 // - these wcid 222~237 are reserved for beacon#7(ra7).
348 #if defined(MAX_MBSSID_NUM) && (MAX_MBSSID_NUM == 8)
349 #define HW_RESERVED_WCID 222
350 #elif defined(MAX_MBSSID_NUM) && (MAX_MBSSID_NUM == 7)
351 #define HW_RESERVED_WCID 238
353 #define HW_RESERVED_WCID 255
356 // Then dedicate wcid of DFS and Carrier-Sense.
357 #define DFS_CTS_WCID (HW_RESERVED_WCID - 1)
358 #define CS_CTS_WCID (HW_RESERVED_WCID - 2)
359 #define LAST_SPECIFIC_WCID (HW_RESERVED_WCID - 2)
361 // If MAX_MBSSID_NUM is 8, the maximum available wcid for the associated STA is 211.
362 // If MAX_MBSSID_NUM is 7, the maximum available wcid for the associated STA is 228.
363 #define MAX_AVAILABLE_CLIENT_WCID (LAST_SPECIFIC_WCID - MAX_MBSSID_NUM - 1)
365 // TX need WCID to find Cipher Key
366 // these wcid 212 ~ 219 are reserved for bc/mc packets if MAX_MBSSID_NUM is 8.
367 #define GET_GroupKey_WCID(__wcid, __bssidx) \
369 __wcid = LAST_SPECIFIC_WCID - (MAX_MBSSID_NUM) + __bssidx; \
372 #define IsGroupKeyWCID(__wcid) (((__wcid) < LAST_SPECIFIC_WCID) && ((__wcid) >= (LAST_SPECIFIC_WCID - (MAX_MBSSID_NUM))))
375 // definition to support multiple BSSID
386 //============================================================
387 // Length definitions
388 #define PEER_KEY_NO 2
389 #define MAC_ADDR_LEN 6
390 #define TIMESTAMP_LEN 8
391 #define MAX_LEN_OF_SUPPORTED_RATES MAX_LENGTH_OF_SUPPORT_RATES // 1, 2, 5.5, 11, 6, 9, 12, 18, 24, 36, 48, 54
392 #define MAX_LEN_OF_KEY 32 // 32 octets == 256 bits, Redefine for WPA
393 #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
394 #define MAX_NUM_OF_11JCHANNELS 20 // 14 channels @2.4G + 12@UNII + 4 @MMAC + 11 @HiperLAN2 + 7 @Japan + 1 as NULL termination
395 #define MAX_LEN_OF_SSID 32
396 #define CIPHER_TEXT_LEN 128
397 #define HASH_TABLE_SIZE 256
398 #define MAX_VIE_LEN 1024 // New for WPA cipher suite variable IE sizes.
399 #define MAX_SUPPORT_MCS 32
401 //============================================================
402 // ASIC WCID Table definition.
403 //============================================================
404 #define BSSID_WCID 1 // in infra mode, always put bssid with this WCID
405 #define MCAST_WCID 0x0
406 #define BSS0Mcast_WCID 0x0
407 #define BSS1Mcast_WCID 0xf8
408 #define BSS2Mcast_WCID 0xf9
409 #define BSS3Mcast_WCID 0xfa
410 #define BSS4Mcast_WCID 0xfb
411 #define BSS5Mcast_WCID 0xfc
412 #define BSS6Mcast_WCID 0xfd
413 #define BSS7Mcast_WCID 0xfe
414 #define RESERVED_WCID 0xff
416 #define MAX_NUM_OF_ACL_LIST MAX_NUMBER_OF_ACL
418 #define MAX_LEN_OF_MAC_TABLE MAX_NUMBER_OF_MAC // if MAX_MBSSID_NUM is 8, this value can't be larger than 211
420 #if MAX_LEN_OF_MAC_TABLE>MAX_AVAILABLE_CLIENT_WCID
421 #error MAX_LEN_OF_MAC_TABLE can not be larger than MAX_AVAILABLE_CLIENT_WCID!!!!
424 #define MAX_NUM_OF_WDS_LINK_PERBSSID 3
425 #define MAX_NUM_OF_WDS_LINK (MAX_NUM_OF_WDS_LINK_PERBSSID*MAX_MBSSID_NUM)
426 #define MAX_NUM_OF_EVENT MAX_NUMBER_OF_EVENT
427 #define WDS_LINK_START_WCID (MAX_LEN_OF_MAC_TABLE-1)
431 #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
432 #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
433 #define MAX_LEN_OF_BSS_TABLE 64
434 #define MAX_REORDERING_MPDU_NUM 512
436 // key related definitions
437 #define SHARE_KEY_NUM 4
438 #define MAX_LEN_OF_SHARE_KEY 16 // byte count
439 #define MAX_LEN_OF_PEER_KEY 16 // byte count
440 #define PAIRWISE_KEY_NUM 64 // in MAC ASIC pairwise key table
441 #define GROUP_KEY_NUM 4
443 #define WDS_PAIRWISE_KEY_OFFSET 60 // WDS links uses pairwise key#60 ~ 63 in ASIC pairwise key table
444 #define PMKID_NO 4 // Number of PMKID saved supported
445 #define MAX_LEN_OF_MLME_BUFFER 2048
447 // power status related definitions
450 #define PWR_MMPS 2 //MIMO power save
452 // Auth and Assoc mode related definitions
453 #define AUTH_MODE_OPEN 0x00
454 #define AUTH_MODE_KEY 0x01
456 // BSS Type definitions
457 #define BSS_ADHOC 0 // = Ndis802_11IBSS
458 #define BSS_INFRA 1 // = Ndis802_11Infrastructure
459 #define BSS_ANY 2 // = Ndis802_11AutoUnknown
460 #define BSS_MONITOR 3 // = Ndis802_11Monitor
463 // Reason code definitions
464 #define REASON_RESERVED 0
465 #define REASON_UNSPECIFY 1
466 #define REASON_NO_LONGER_VALID 2
467 #define REASON_DEAUTH_STA_LEAVING 3
468 #define REASON_DISASSOC_INACTIVE 4
469 #define REASON_DISASSPC_AP_UNABLE 5
470 #define REASON_CLS2ERR 6
471 #define REASON_CLS3ERR 7
472 #define REASON_DISASSOC_STA_LEAVING 8
473 #define REASON_STA_REQ_ASSOC_NOT_AUTH 9
474 #define REASON_INVALID_IE 13
475 #define REASON_MIC_FAILURE 14
476 #define REASON_4_WAY_TIMEOUT 15
477 #define REASON_GROUP_KEY_HS_TIMEOUT 16
478 #define REASON_IE_DIFFERENT 17
479 #define REASON_MCIPHER_NOT_VALID 18
480 #define REASON_UCIPHER_NOT_VALID 19
481 #define REASON_AKMP_NOT_VALID 20
482 #define REASON_UNSUPPORT_RSNE_VER 21
483 #define REASON_INVALID_RSNE_CAP 22
484 #define REASON_8021X_AUTH_FAIL 23
485 #define REASON_CIPHER_SUITE_REJECTED 24
486 #define REASON_DECLINED 37
488 #define REASON_QOS_UNSPECIFY 32
489 #define REASON_QOS_LACK_BANDWIDTH 33
490 #define REASON_POOR_CHANNEL_CONDITION 34
491 #define REASON_QOS_OUTSIDE_TXOP_LIMITION 35
492 #define REASON_QOS_QSTA_LEAVING_QBSS 36
493 #define REASON_QOS_UNWANTED_MECHANISM 37
494 #define REASON_QOS_MECH_SETUP_REQUIRED 38
495 #define REASON_QOS_REQUEST_TIMEOUT 39
496 #define REASON_QOS_CIPHER_NOT_SUPPORT 45
498 // Status code definitions
499 #define MLME_SUCCESS 0
500 #define MLME_UNSPECIFY_FAIL 1
501 #define MLME_CANNOT_SUPPORT_CAP 10
502 #define MLME_REASSOC_DENY_ASSOC_EXIST 11
503 #define MLME_ASSOC_DENY_OUT_SCOPE 12
504 #define MLME_ALG_NOT_SUPPORT 13
505 #define MLME_SEQ_NR_OUT_OF_SEQUENCE 14
506 #define MLME_REJ_CHALLENGE_FAILURE 15
507 #define MLME_REJ_TIMEOUT 16
508 #define MLME_ASSOC_REJ_UNABLE_HANDLE_STA 17
509 #define MLME_ASSOC_REJ_DATA_RATE 18
511 #define MLME_ASSOC_REJ_NO_EXT_RATE 22
512 #define MLME_ASSOC_REJ_NO_EXT_RATE_PBCC 23
513 #define MLME_ASSOC_REJ_NO_CCK_OFDM 24
515 #define MLME_QOS_UNSPECIFY 32
516 #define MLME_REQUEST_DECLINED 37
517 #define MLME_REQUEST_WITH_INVALID_PARAM 38
518 #define MLME_DLS_NOT_ALLOW_IN_QBSS 48
519 #define MLME_DEST_STA_NOT_IN_QBSS 49
520 #define MLME_DEST_STA_IS_NOT_A_QSTA 50
522 #define MLME_INVALID_FORMAT 0x51
523 #define MLME_FAIL_NO_RESOURCE 0x52
524 #define MLME_STATE_MACHINE_REJECT 0x53
525 #define MLME_MAC_TABLE_FAIL 0x54
529 #define IE_SUPP_RATES 1
534 #define IE_IBSS_PARM 6
535 #define IE_COUNTRY 7 // 802.11d
536 #define IE_802_11D_REQUEST 10 // 802.11d
537 #define IE_QBSS_LOAD 11 // 802.11e d9
538 #define IE_EDCA_PARAMETER 12 // 802.11e d9
539 #define IE_TSPEC 13 // 802.11e d9
540 #define IE_TCLAS 14 // 802.11e d9
541 #define IE_SCHEDULE 15 // 802.11e d9
542 #define IE_CHALLENGE_TEXT 16
543 #define IE_POWER_CONSTRAINT 32 // 802.11h d3.3
544 #define IE_POWER_CAPABILITY 33 // 802.11h d3.3
545 #define IE_TPC_REQUEST 34 // 802.11h d3.3
546 #define IE_TPC_REPORT 35 // 802.11h d3.3
547 #define IE_SUPP_CHANNELS 36 // 802.11h d3.3
548 #define IE_CHANNEL_SWITCH_ANNOUNCEMENT 37 // 802.11h d3.3
549 #define IE_MEASUREMENT_REQUEST 38 // 802.11h d3.3
550 #define IE_MEASUREMENT_REPORT 39 // 802.11h d3.3
551 #define IE_QUIET 40 // 802.11h d3.3
552 #define IE_IBSS_DFS 41 // 802.11h d3.3
553 #define IE_ERP 42 // 802.11g
554 #define IE_TS_DELAY 43 // 802.11e d9
555 #define IE_TCLAS_PROCESSING 44 // 802.11e d9
556 #define IE_QOS_CAPABILITY 46 // 802.11e d6
557 #define IE_HT_CAP 45 // 802.11n d1. HT CAPABILITY. ELEMENT ID TBD
558 #define IE_AP_CHANNEL_REPORT 51 // 802.11k d6
559 #define IE_HT_CAP2 52 // 802.11n d1. HT CAPABILITY. ELEMENT ID TBD
560 #define IE_RSN 48 // 802.11i d3.0
561 #define IE_WPA2 48 // WPA2
562 #define IE_EXT_SUPP_RATES 50 // 802.11g
563 #define IE_SUPP_REG_CLASS 59 // 802.11y. Supported regulatory classes.
564 #define IE_EXT_CHANNEL_SWITCH_ANNOUNCEMENT 60 // 802.11n
565 #define IE_ADD_HT 61 // 802.11n d1. ADDITIONAL HT CAPABILITY. ELEMENT ID TBD
566 #define IE_ADD_HT2 53 // 802.11n d1. ADDITIONAL HT CAPABILITY. ELEMENT ID TBD
570 //#define IE_NEW_EXT_CHA_OFFSET 62 // 802.11n d1. New extension channel offset elemet
571 #define IE_SECONDARY_CH_OFFSET 62 // 802.11n D3.03 Secondary Channel Offset element
573 #define IE_WAPI 68 // WAPI information element
575 #define IE_2040_BSS_COEXIST 72 // 802.11n D3.0.3
576 #define IE_2040_BSS_INTOLERANT_REPORT 73 // 802.11n D3.03
577 #define IE_OVERLAPBSS_SCAN_PARM 74 // 802.11n D3.03
578 #define IE_EXT_CAPABILITY 127 // 802.11n D3.03
581 #define IE_WPA 221 // WPA
582 #define IE_VENDOR_SPECIFIC 221 // Wifi WMM (WME)
584 #define OUI_BROADCOM_HT 51 //
585 #define OUI_BROADCOM_HTADD 52 //
586 #define OUI_PREN_HT_CAP 51 //
587 #define OUI_PREN_ADD_HT 52 //
590 #define IE_AIRONET_CKIP 133 // CCX1.0 ID 85H for CKIP
591 #define IE_AP_TX_POWER 150 // CCX 2.0 for AP transmit power
592 #define IE_MEASUREMENT_CAPABILITY 221 // CCX 2.0
593 #define IE_CCX_V2 221
594 #define IE_AIRONET_IPADDRESS 149 // CCX ID 95H for IP Address
595 #define IE_AIRONET_CCKMREASSOC 156 // CCX ID 9CH for CCKM Reassociation Request element
596 #define CKIP_NEGOTIATION_LENGTH 30
597 #define AIRONET_IPADDRESS_LENGTH 10
598 #define AIRONET_CCKMREASSOC_LENGTH 24
600 // ========================================================
601 // MLME state machine definition
602 // ========================================================
604 // STA MLME state mahcines
605 #define ASSOC_STATE_MACHINE 1
606 #define AUTH_STATE_MACHINE 2
607 #define AUTH_RSP_STATE_MACHINE 3
608 #define SYNC_STATE_MACHINE 4
609 #define MLME_CNTL_STATE_MACHINE 5
610 #define WPA_PSK_STATE_MACHINE 6
611 #define LEAP_STATE_MACHINE 7
612 #define AIRONET_STATE_MACHINE 8
613 #define ACTION_STATE_MACHINE 9
615 // AP MLME state machines
616 #define AP_ASSOC_STATE_MACHINE 11
617 #define AP_AUTH_STATE_MACHINE 12
618 #define AP_AUTH_RSP_STATE_MACHINE 13
619 #define AP_SYNC_STATE_MACHINE 14
620 #define AP_CNTL_STATE_MACHINE 15
621 #define AP_WPA_STATE_MACHINE 16
624 // STA's CONTROL/CONNECT state machine: states, events, total function #
627 #define CNTL_WAIT_DISASSOC 1
628 #define CNTL_WAIT_JOIN 2
629 #define CNTL_WAIT_REASSOC 3
630 #define CNTL_WAIT_START 4
631 #define CNTL_WAIT_AUTH 5
632 #define CNTL_WAIT_ASSOC 6
633 #define CNTL_WAIT_AUTH2 7
634 #define CNTL_WAIT_OID_LIST_SCAN 8
635 #define CNTL_WAIT_OID_DISASSOC 9
637 #define CNTL_WAIT_SCAN_FOR_CONNECT 10
640 #define MT2_ASSOC_CONF 34
641 #define MT2_AUTH_CONF 35
642 #define MT2_DEAUTH_CONF 36
643 #define MT2_DISASSOC_CONF 37
644 #define MT2_REASSOC_CONF 38
645 #define MT2_PWR_MGMT_CONF 39
646 #define MT2_JOIN_CONF 40
647 #define MT2_SCAN_CONF 41
648 #define MT2_START_CONF 42
649 #define MT2_GET_CONF 43
650 #define MT2_SET_CONF 44
651 #define MT2_RESET_CONF 45
652 #define MT2_MLME_ROAMING_REQ 52
654 #define CNTL_FUNC_SIZE 1
657 // STA's ASSOC state machine: states, events, total function #
660 #define ASSOC_WAIT_RSP 1
661 #define REASSOC_WAIT_RSP 2
662 #define DISASSOC_WAIT_RSP 3
663 #define MAX_ASSOC_STATE 4
665 #define ASSOC_MACHINE_BASE 0
666 #define MT2_MLME_ASSOC_REQ 0
667 #define MT2_MLME_REASSOC_REQ 1
668 #define MT2_MLME_DISASSOC_REQ 2
669 #define MT2_PEER_DISASSOC_REQ 3
670 #define MT2_PEER_ASSOC_REQ 4
671 #define MT2_PEER_ASSOC_RSP 5
672 #define MT2_PEER_REASSOC_REQ 6
673 #define MT2_PEER_REASSOC_RSP 7
674 #define MT2_DISASSOC_TIMEOUT 8
675 #define MT2_ASSOC_TIMEOUT 9
676 #define MT2_REASSOC_TIMEOUT 10
677 #define MAX_ASSOC_MSG 11
679 #define ASSOC_FUNC_SIZE (MAX_ASSOC_STATE * MAX_ASSOC_MSG)
682 // ACT state machine: states, events, total function #
685 #define MAX_ACT_STATE 1
687 #define ACT_MACHINE_BASE 0
689 //Those PEER_xx_CATE number is based on real Categary value in IEEE spec. Please don'es modify it by your self.
691 #define MT2_PEER_SPECTRUM_CATE 0
692 #define MT2_PEER_QOS_CATE 1
693 #define MT2_PEER_DLS_CATE 2
694 #define MT2_PEER_BA_CATE 3
695 #define MT2_PEER_PUBLIC_CATE 4
696 #define MT2_PEER_RM_CATE 5
697 #define MT2_PEER_HT_CATE 7 // 7.4.7
698 #define MAX_PEER_CATE_MSG 7
699 #define MT2_MLME_ADD_BA_CATE 8
700 #define MT2_MLME_ORI_DELBA_CATE 9
701 #define MT2_MLME_REC_DELBA_CATE 10
702 #define MT2_MLME_QOS_CATE 11
703 #define MT2_MLME_DLS_CATE 12
704 #define MT2_ACT_INVALID 13
705 #define MAX_ACT_MSG 14
708 #define CATEGORY_SPECTRUM 0
709 #define CATEGORY_QOS 1
710 #define CATEGORY_DLS 2
711 #define CATEGORY_BA 3
712 #define CATEGORY_PUBLIC 4
713 #define CATEGORY_RM 5
714 #define CATEGORY_HT 7
717 // DLS Action frame definition
718 #define ACTION_DLS_REQUEST 0
719 #define ACTION_DLS_RESPONSE 1
720 #define ACTION_DLS_TEARDOWN 2
722 //Spectrum Action field value 802.11h 7.4.1
723 #define SPEC_MRQ 0 // Request
724 #define SPEC_MRP 1 //Report
727 #define SPEC_CHANNEL_SWITCH 4
730 //BA Action field value
735 //Public's Action field value in Public Category. Some in 802.11y and some in 11n
736 #define ACTION_BSS_2040_COEXIST 0 // 11n
737 #define ACTION_DSE_ENABLEMENT 1 // 11y D9.0
738 #define ACTION_DSE_DEENABLEMENT 2 // 11y D9.0
739 #define ACTION_DSE_REG_LOCATION_ANNOUNCE 3 // 11y D9.0
740 #define ACTION_EXT_CH_SWITCH_ANNOUNCE 4 // 11y D9.0
741 #define ACTION_DSE_MEASUREMENT_REQ 5 // 11y D9.0
742 #define ACTION_DSE_MEASUREMENT_REPORT 6 // 11y D9.0
743 #define ACTION_MEASUREMENT_PILOT_ACTION 7 // 11y D9.0
744 #define ACTION_DSE_POWER_CONSTRAINT 8 // 11y D9.0
747 //HT Action field value
748 #define NOTIFY_BW_ACTION 0
749 #define SMPS_ACTION 1
750 #define PSMP_ACTION 2
751 #define SETPCO_ACTION 3
752 #define MIMO_CHA_MEASURE_ACTION 4
753 #define MIMO_N_BEACONFORM 5
754 #define MIMO_BEACONFORM 6
755 #define ANTENNA_SELECT 7
756 #define HT_INFO_EXCHANGE 8
758 #define ACT_FUNC_SIZE (MAX_ACT_STATE * MAX_ACT_MSG)
760 // STA's AUTHENTICATION state machine: states, evvents, total function #
762 #define AUTH_REQ_IDLE 0
763 #define AUTH_WAIT_SEQ2 1
764 #define AUTH_WAIT_SEQ4 2
765 #define MAX_AUTH_STATE 3
767 #define AUTH_MACHINE_BASE 0
768 #define MT2_MLME_AUTH_REQ 0
769 #define MT2_PEER_AUTH_EVEN 1
770 #define MT2_AUTH_TIMEOUT 2
771 #define MAX_AUTH_MSG 3
773 #define AUTH_FUNC_SIZE (MAX_AUTH_STATE * MAX_AUTH_MSG)
776 // STA's AUTH_RSP state machine: states, events, total function #
778 #define AUTH_RSP_IDLE 0
779 #define AUTH_RSP_WAIT_CHAL 1
780 #define MAX_AUTH_RSP_STATE 2
782 #define AUTH_RSP_MACHINE_BASE 0
783 #define MT2_AUTH_CHALLENGE_TIMEOUT 0
784 #define MT2_PEER_AUTH_ODD 1
785 #define MT2_PEER_DEAUTH 2
786 #define MAX_AUTH_RSP_MSG 3
788 #define AUTH_RSP_FUNC_SIZE (MAX_AUTH_RSP_STATE * MAX_AUTH_RSP_MSG)
791 // STA's SYNC state machine: states, events, total function #
793 #define SYNC_IDLE 0 // merge NO_BSS,IBSS_IDLE,IBSS_ACTIVE and BSS in to 1 state
794 #define JOIN_WAIT_BEACON 1
795 #define SCAN_LISTEN 2
796 #define MAX_SYNC_STATE 3
798 #define SYNC_MACHINE_BASE 0
799 #define MT2_MLME_SCAN_REQ 0
800 #define MT2_MLME_JOIN_REQ 1
801 #define MT2_MLME_START_REQ 2
802 #define MT2_PEER_BEACON 3
803 #define MT2_PEER_PROBE_RSP 4
804 #define MT2_PEER_ATIM 5
805 #define MT2_SCAN_TIMEOUT 6
806 #define MT2_BEACON_TIMEOUT 7
807 #define MT2_ATIM_TIMEOUT 8
808 #define MT2_PEER_PROBE_REQ 9
809 #define MAX_SYNC_MSG 10
811 #define SYNC_FUNC_SIZE (MAX_SYNC_STATE * MAX_SYNC_MSG)
813 //Messages for the DLS state machine
815 #define MAX_DLS_STATE 1
817 #define DLS_MACHINE_BASE 0
818 #define MT2_MLME_DLS_REQ 0
819 #define MT2_PEER_DLS_REQ 1
820 #define MT2_PEER_DLS_RSP 2
821 #define MT2_MLME_DLS_TEAR_DOWN 3
822 #define MT2_PEER_DLS_TEAR_DOWN 4
823 #define MAX_DLS_MSG 5
825 #define DLS_FUNC_SIZE (MAX_DLS_STATE * MAX_DLS_MSG)
828 // STA's WPA-PSK State machine: states, events, total function #
830 #define WPA_PSK_IDLE 0
831 #define MAX_WPA_PSK_STATE 1
833 #define WPA_MACHINE_BASE 0
834 #define MT2_EAPPacket 0
835 #define MT2_EAPOLStart 1
836 #define MT2_EAPOLLogoff 2
837 #define MT2_EAPOLKey 3
838 #define MT2_EAPOLASFAlert 4
839 #define MAX_WPA_PSK_MSG 5
841 #define WPA_PSK_FUNC_SIZE (MAX_WPA_PSK_STATE * MAX_WPA_PSK_MSG)
844 // STA's CISCO-AIRONET State machine: states, events, total function #
846 #define AIRONET_IDLE 0
847 #define AIRONET_SCANNING 1
848 #define MAX_AIRONET_STATE 2
850 #define AIRONET_MACHINE_BASE 0
851 #define MT2_AIRONET_MSG 0
852 #define MT2_AIRONET_SCAN_REQ 1
853 #define MT2_AIRONET_SCAN_DONE 2
854 #define MAX_AIRONET_MSG 3
856 #define AIRONET_FUNC_SIZE (MAX_AIRONET_STATE * MAX_AIRONET_MSG)
859 // AP's CONTROL/CONNECT state machine: states, events, total function #
861 #define AP_CNTL_FUNC_SIZE 1
864 // AP's ASSOC state machine: states, events, total function #
866 #define AP_ASSOC_IDLE 0
867 #define AP_MAX_ASSOC_STATE 1
869 #define AP_ASSOC_MACHINE_BASE 0
870 #define APMT2_MLME_DISASSOC_REQ 0
871 #define APMT2_PEER_DISASSOC_REQ 1
872 #define APMT2_PEER_ASSOC_REQ 2
873 #define APMT2_PEER_REASSOC_REQ 3
874 #define APMT2_CLS3ERR 4
875 #define AP_MAX_ASSOC_MSG 5
877 #define AP_ASSOC_FUNC_SIZE (AP_MAX_ASSOC_STATE * AP_MAX_ASSOC_MSG)
880 // AP's AUTHENTICATION state machine: states, events, total function #
882 #define AP_AUTH_REQ_IDLE 0
883 #define AP_MAX_AUTH_STATE 1
885 #define AP_AUTH_MACHINE_BASE 0
886 #define APMT2_MLME_DEAUTH_REQ 0
887 #define APMT2_CLS2ERR 1
888 #define AP_MAX_AUTH_MSG 2
890 #define AP_AUTH_FUNC_SIZE (AP_MAX_AUTH_STATE * AP_MAX_AUTH_MSG)
893 // AP's AUTH-RSP state machine: states, events, total function #
895 #define AP_AUTH_RSP_IDLE 0
896 #define AP_MAX_AUTH_RSP_STATE 1
898 #define AP_AUTH_RSP_MACHINE_BASE 0
899 #define APMT2_AUTH_CHALLENGE_TIMEOUT 0
900 #define APMT2_PEER_AUTH_ODD 1
901 #define APMT2_PEER_DEAUTH 2
902 #define AP_MAX_AUTH_RSP_MSG 3
904 #define AP_AUTH_RSP_FUNC_SIZE (AP_MAX_AUTH_RSP_STATE * AP_MAX_AUTH_RSP_MSG)
907 // AP's SYNC state machine: states, events, total function #
909 #define AP_SYNC_IDLE 0
910 #define AP_SCAN_LISTEN 1
911 #define AP_MAX_SYNC_STATE 2
913 #define AP_SYNC_MACHINE_BASE 0
914 #define APMT2_PEER_PROBE_REQ 0
915 #define APMT2_PEER_BEACON 1
916 #define APMT2_MLME_SCAN_REQ 2
917 #define APMT2_PEER_PROBE_RSP 3
918 #define APMT2_SCAN_TIMEOUT 4
919 #define APMT2_MLME_SCAN_CNCL 5
920 #define AP_MAX_SYNC_MSG 6
922 #define AP_SYNC_FUNC_SIZE (AP_MAX_SYNC_STATE * AP_MAX_SYNC_MSG)
925 // AP's WPA state machine: states, events, total function #
928 #define AP_MAX_WPA_PTK_STATE 1
930 #define AP_WPA_MACHINE_BASE 0
931 #define APMT2_EAPPacket 0
932 #define APMT2_EAPOLStart 1
933 #define APMT2_EAPOLLogoff 2
934 #define APMT2_EAPOLKey 3
935 #define APMT2_EAPOLASFAlert 4
936 #define AP_MAX_WPA_MSG 5
938 #define AP_WPA_FUNC_SIZE (AP_MAX_WPA_PTK_STATE * AP_MAX_WPA_MSG)
940 // =============================================================================
942 // value domain of 802.11 header FC.Tyte, which is b3..b2 of the 1st-byte of MAC header
947 // value domain of 802.11 MGMT frame's FC.subtype, which is b7..4 of the 1st-byte of MAC header
948 #define SUBTYPE_ASSOC_REQ 0
949 #define SUBTYPE_ASSOC_RSP 1
950 #define SUBTYPE_REASSOC_REQ 2
951 #define SUBTYPE_REASSOC_RSP 3
952 #define SUBTYPE_PROBE_REQ 4
953 #define SUBTYPE_PROBE_RSP 5
954 #define SUBTYPE_BEACON 8
955 #define SUBTYPE_ATIM 9
956 #define SUBTYPE_DISASSOC 10
957 #define SUBTYPE_AUTH 11
958 #define SUBTYPE_DEAUTH 12
959 #define SUBTYPE_ACTION 13
960 #define SUBTYPE_ACTION_NO_ACK 14
962 // value domain of 802.11 CNTL frame's FC.subtype, which is b7..4 of the 1st-byte of MAC header
963 #define SUBTYPE_WRAPPER 7
964 #define SUBTYPE_BLOCK_ACK_REQ 8
965 #define SUBTYPE_BLOCK_ACK 9
966 #define SUBTYPE_PS_POLL 10
967 #define SUBTYPE_RTS 11
968 #define SUBTYPE_CTS 12
969 #define SUBTYPE_ACK 13
970 #define SUBTYPE_CFEND 14
971 #define SUBTYPE_CFEND_CFACK 15
973 // value domain of 802.11 DATA frame's FC.subtype, which is b7..4 of the 1st-byte of MAC header
974 #define SUBTYPE_DATA 0
975 #define SUBTYPE_DATA_CFACK 1
976 #define SUBTYPE_DATA_CFPOLL 2
977 #define SUBTYPE_DATA_CFACK_CFPOLL 3
978 #define SUBTYPE_NULL_FUNC 4
979 #define SUBTYPE_CFACK 5
980 #define SUBTYPE_CFPOLL 6
981 #define SUBTYPE_CFACK_CFPOLL 7
982 #define SUBTYPE_QDATA 8
983 #define SUBTYPE_QDATA_CFACK 9
984 #define SUBTYPE_QDATA_CFPOLL 10
985 #define SUBTYPE_QDATA_CFACK_CFPOLL 11
986 #define SUBTYPE_QOS_NULL 12
987 #define SUBTYPE_QOS_CFACK 13
988 #define SUBTYPE_QOS_CFPOLL 14
989 #define SUBTYPE_QOS_CFACK_CFPOLL 15
991 // ACK policy of QOS Control field bit 6:5
992 #define NORMAL_ACK 0x00 // b6:5 = 00
993 #define NO_ACK 0x20 // b6:5 = 01
994 #define NO_EXPLICIT_ACK 0x40 // b6:5 = 10
995 #define BLOCK_ACK 0x60 // b6:5 = 11
998 // rtmp_data.c use these definition
1000 #define LENGTH_802_11 24
1001 #define LENGTH_802_11_AND_H 30
1002 #define LENGTH_802_11_CRC_H 34
1003 #define LENGTH_802_11_CRC 28
1004 #define LENGTH_802_11_WITH_ADDR4 30
1005 #define LENGTH_802_3 14
1006 #define LENGTH_802_3_TYPE 2
1007 #define LENGTH_802_1_H 8
1008 #define LENGTH_EAPOL_H 4
1009 #define LENGTH_WMMQOS_H 2
1010 #define LENGTH_CRC 4
1011 #define MAX_SEQ_NUMBER 0x0fff
1012 #define LENGTH_802_3_NO_TYPE 12
1013 #define LENGTH_802_1Q 4 /* VLAN related */
1015 // STA_CSR4.field.TxResult
1016 #define TX_RESULT_SUCCESS 0
1017 #define TX_RESULT_ZERO_LENGTH 1
1018 #define TX_RESULT_UNDER_RUN 2
1019 #define TX_RESULT_OHY_ERROR 4
1020 #define TX_RESULT_RETRY_FAIL 6
1022 // All PHY rate summary in TXD
1023 // Preamble MODE in TxD
1026 #define MODE_HTMIX 2
1027 #define MODE_HTGREENFIELD 3
1029 // MCS for CCK. BW.SGI.STBC are reserved
1030 #define MCS_LONGP_RATE_1 0 // long preamble CCK 1Mbps
1031 #define MCS_LONGP_RATE_2 1 // long preamble CCK 1Mbps
1032 #define MCS_LONGP_RATE_5_5 2
1033 #define MCS_LONGP_RATE_11 3
1034 #define MCS_SHORTP_RATE_1 4 // long preamble CCK 1Mbps. short is forbidden in 1Mbps
1035 #define MCS_SHORTP_RATE_2 5 // short preamble CCK 2Mbps
1036 #define MCS_SHORTP_RATE_5_5 6
1037 #define MCS_SHORTP_RATE_11 7
1038 // To send duplicate legacy OFDM. set BW=BW_40. SGI.STBC are reserved
1039 #define MCS_RATE_6 0 // legacy OFDM
1040 #define MCS_RATE_9 1 // OFDM
1041 #define MCS_RATE_12 2 // OFDM
1042 #define MCS_RATE_18 3 // OFDM
1043 #define MCS_RATE_24 4 // OFDM
1044 #define MCS_RATE_36 5 // OFDM
1045 #define MCS_RATE_48 6 // OFDM
1046 #define MCS_RATE_54 7 // OFDM
1048 #define MCS_0 0 // 1S
1056 #define MCS_8 8 // 2S
1064 #define MCS_16 16 // 3*3
1080 // Fixed Tx MODE - HT, CCK or OFDM
1081 #define FIXED_TXMODE_HT 0
1082 #define FIXED_TXMODE_CCK 1
1083 #define FIXED_TXMODE_OFDM 2
1085 #define BW_20 BAND_WIDTH_20
1086 #define BW_40 BAND_WIDTH_40
1087 #define BW_BOTH BAND_WIDTH_BOTH
1088 #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.
1091 #define GI_400 GAP_INTERVAL_400 // only support in HT mode
1092 #define GI_BOTH GAP_INTERVAL_BOTH
1093 #define GI_800 GAP_INTERVAL_800
1096 #define STBC_USE 1 // limited use in rt2860b phy
1097 #define RXSTBC_ONE 1 // rx support of one spatial stream
1098 #define RXSTBC_TWO 2 // rx support of 1 and 2 spatial stream
1099 #define RXSTBC_THR 3 // rx support of 1~3 spatial stream
1101 #define MCSFBK_NONE 0 // not support mcs feedback /
1102 #define MCSFBK_RSV 1 // reserved
1103 #define MCSFBK_UNSOLICIT 2 // only support unsolict mcs feedback
1104 #define MCSFBK_MRQ 3 // response to both MRQ and unsolict mcs feedback
1107 #define MMPS_STATIC 0
1108 #define MMPS_DYNAMIC 1
1110 #define MMPS_ENABLE 3
1118 #define TXRATEMIMO 0x80
1119 #define TXRATEMCS 0x7F
1120 #define TXRATEOFDM 0x7F
1125 #define RATE_6 4 // OFDM
1126 #define RATE_9 5 // OFDM
1127 #define RATE_12 6 // OFDM
1128 #define RATE_18 7 // OFDM
1129 #define RATE_24 8 // OFDM
1130 #define RATE_36 9 // OFDM
1131 #define RATE_48 10 // OFDM
1132 #define RATE_54 11 // OFDM
1133 #define RATE_FIRST_OFDM_RATE RATE_6
1134 #define RATE_LAST_OFDM_RATE RATE_54
1135 #define RATE_6_5 12 // HT mix
1136 #define RATE_13 13 // HT mix
1137 #define RATE_19_5 14 // HT mix
1138 #define RATE_26 15 // HT mix
1139 #define RATE_39 16 // HT mix
1140 #define RATE_52 17 // HT mix
1141 #define RATE_58_5 18 // HT mix
1142 #define RATE_65 19 // HT mix
1143 #define RATE_78 20 // HT mix
1144 #define RATE_104 21 // HT mix
1145 #define RATE_117 22 // HT mix
1146 #define RATE_130 23 // HT mix
1147 //#define RATE_AUTO_SWITCH 255 // for StaCfg.FixedTxRate only
1149 #define RATE_FIRST_MM_RATE HTRATE_0
1150 #define RATE_FIRST_HT_RATE HTRATE_0
1151 #define RATE_LAST_HT_RATE HTRATE_0
1154 #define IFS_HTTXOP 0 // The txop will be handles by ASIC.
1157 #define IFS_BACKOFF 3
1160 #define LONG_RETRY 1
1161 #define SHORT_RETRY 0
1163 // Country Region definition
1164 #define REGION_MINIMUM_BG_BAND 0
1165 #define REGION_0_BG_BAND 0 // 1-11
1166 #define REGION_1_BG_BAND 1 // 1-13
1167 #define REGION_2_BG_BAND 2 // 10-11
1168 #define REGION_3_BG_BAND 3 // 10-13
1169 #define REGION_4_BG_BAND 4 // 14
1170 #define REGION_5_BG_BAND 5 // 1-14
1171 #define REGION_6_BG_BAND 6 // 3-9
1172 #define REGION_7_BG_BAND 7 // 5-13
1173 #define REGION_31_BG_BAND 31 // 5-13
1174 #define REGION_MAXIMUM_BG_BAND 7
1176 #define REGION_MINIMUM_A_BAND 0
1177 #define REGION_0_A_BAND 0 // 36, 40, 44, 48, 52, 56, 60, 64, 149, 153, 157, 161, 165
1178 #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
1179 #define REGION_2_A_BAND 2 // 36, 40, 44, 48, 52, 56, 60, 64
1180 #define REGION_3_A_BAND 3 // 52, 56, 60, 64, 149, 153, 157, 161
1181 #define REGION_4_A_BAND 4 // 149, 153, 157, 161, 165
1182 #define REGION_5_A_BAND 5 // 149, 153, 157, 161
1183 #define REGION_6_A_BAND 6 // 36, 40, 44, 48
1184 #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
1185 #define REGION_8_A_BAND 8 // 52, 56, 60, 64
1186 #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
1187 #define REGION_10_A_BAND 10 // 36, 40, 44, 48, 149, 153, 157, 161, 165
1188 #define REGION_11_A_BAND 11 // 36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 149, 153, 157, 161
1189 #define REGION_MAXIMUM_A_BAND 11
1192 #define CIPHER_NONE 0
1193 #define CIPHER_WEP64 1
1194 #define CIPHER_WEP128 2
1195 #define CIPHER_TKIP 3
1196 #define CIPHER_AES 4
1197 #define CIPHER_CKIP64 5
1198 #define CIPHER_CKIP128 6
1199 #define CIPHER_TKIP_NO_MIC 7 // MIC appended by driver: not a valid value in hardware key table
1200 #define CIPHER_SMS4 8
1202 // value domain of pAd->RfIcType
1203 #define RFIC_2820 1 // 2.4G 2T3R
1204 #define RFIC_2850 2 // 2.4G/5G 2T3R
1205 #define RFIC_2720 3 // 2.4G 1T2R
1206 #define RFIC_2750 4 // 2.4G/5G 1T2R
1207 #define RFIC_3020 5 // 2.4G 1T1R
1208 #define RFIC_2020 6 // 2.4G B/G
1209 #define RFIC_3021 7 // 2.4G 1T2R
1210 #define RFIC_3022 8 // 2.4G 2T2R
1213 #define LED_LINK_DOWN 0
1214 #define LED_LINK_UP 1
1215 #define LED_RADIO_OFF 2
1216 #define LED_RADIO_ON 3
1219 #define LED_ON_SITE_SURVEY 6
1220 #define LED_POWER_UP 7
1222 // value domain of pAd->LedCntl.LedMode and E2PROM
1223 #define LED_MODE_DEFAULT 0
1224 #define LED_MODE_TWO_LED 1
1225 #define LED_MODE_SIGNAL_STREGTH 8 // EEPROM define =8
1227 // RC4 init value, used fro WEP & TKIP
1228 #define PPPINITFCS32 0xffffffff /* Initial FCS value */
1230 // value domain of pAd->StaCfg.PortSecured. 802.1X controlled port definition
1231 #define WPA_802_1X_PORT_SECURED 1
1232 #define WPA_802_1X_PORT_NOT_SECURED 2
1234 #define PAIRWISE_KEY 1
1238 #define MAX_STEP_OF_TX_RATE_SWITCH 32
1241 // pre-allocated free NDIS PACKET/BUFFER poll for internal usage
1242 #define MAX_NUM_OF_FREE_NDIS_PACKET 128
1245 #define MAX_TX_REORDERBUF 64
1246 #define MAX_RX_REORDERBUF 64
1247 #define DEFAULT_TX_TIMEOUT 30
1248 #define DEFAULT_RX_TIMEOUT 30
1250 // definition of Recipient or Originator
1251 #define I_RECIPIENT TRUE
1252 #define I_ORIGINATOR FALSE
1254 #define DEFAULT_BBP_TX_POWER 0
1255 #define DEFAULT_RF_TX_POWER 5
1257 #define MAX_INI_BUFFER_SIZE 4096
1258 #define MAX_PARAM_BUFFER_SIZE (2048) // enough for ACL (18*64)
1259 //18 : the length of Mac address acceptable format "01:02:03:04:05:06;")
1260 //64 : MAX_NUM_OF_ACL_LIST
1261 // definition of pAd->OpMode
1262 #define OPMODE_STA 0
1264 //#define OPMODE_L3_BRG 2 // as AP and STA at the same time
1266 // ========================= AP rtmp_def.h ===========================
1267 // value domain for pAd->EventTab.Log[].Event
1268 #define EVENT_RESET_ACCESS_POINT 0 // Log = "hh:mm:ss Restart Access Point"
1269 #define EVENT_ASSOCIATED 1 // Log = "hh:mm:ss STA 00:01:02:03:04:05 associated"
1270 #define EVENT_DISASSOCIATED 2 // Log = "hh:mm:ss STA 00:01:02:03:04:05 left this BSS"
1271 #define EVENT_AGED_OUT 3 // Log = "hh:mm:ss STA 00:01:02:03:04:05 was aged-out and removed from this BSS"
1272 #define EVENT_COUNTER_M 4
1273 #define EVENT_INVALID_PSK 5
1274 #define EVENT_MAX_EVENT_TYPE 6
1275 // ==== end of AP rtmp_def.h ============
1277 // definition RSSI Number
1282 // definition of radar detection
1283 #define RD_NORMAL_MODE 0 // Not found radar signal
1284 #define RD_SWITCHING_MODE 1 // Found radar signal, and doing channel switch
1285 #define RD_SILENCE_MODE 2 // After channel switch, need to be silence a while to ensure radar not found
1287 //Driver defined cid for mapping status and command.
1288 #define SLEEPCID 0x11
1289 #define WAKECID 0x22
1290 #define QUERYPOWERCID 0x33
1291 #define OWNERMCU 0x1
1292 #define OWNERCPU 0x0
1294 // MBSSID definition
1295 #define ENTRY_NOT_FOUND 0xFF
1298 /* After Linux 2.6.9,
1299 * VLAN module use Private (from user) interface flags (netdevice->priv_flags).
1300 * #define IFF_802_1Q_VLAN 0x1 -- 802.1Q VLAN device. in if.h
1301 * ref to ip_sabotage_out() [ out->priv_flags & IFF_802_1Q_VLAN ] in br_netfilter.c
1303 * For this reason, we MUST use EVEN value in priv_flags
1305 #define INT_MAIN 0x0100
1306 #define INT_MBSSID 0x0200
1307 #define INT_WDS 0x0300
1308 #define INT_APCLI 0x0400
1309 #define INT_MESH 0x0500
1311 // Use bitmap to allow coexist of ATE_TXFRAME and ATE_RXFRAME(i.e.,to support LoopBack mode)
1314 #define WEP_HEXADECIMAL_TYPE 0
1315 #define WEP_ASCII_TYPE 1
1319 // WIRELESS EVENTS definition
1320 /* Max number of char in custom event, refer to wireless_tools.28/wireless.20.h */
1321 #define IW_CUSTOM_MAX_LEN 255 /* In bytes */
1323 // For system event - start
1324 #define IW_SYS_EVENT_FLAG_START 0x0200
1325 #define IW_ASSOC_EVENT_FLAG 0x0200
1326 #define IW_DISASSOC_EVENT_FLAG 0x0201
1327 #define IW_DEAUTH_EVENT_FLAG 0x0202
1328 #define IW_AGEOUT_EVENT_FLAG 0x0203
1329 #define IW_COUNTER_MEASURES_EVENT_FLAG 0x0204
1330 #define IW_REPLAY_COUNTER_DIFF_EVENT_FLAG 0x0205
1331 #define IW_RSNIE_DIFF_EVENT_FLAG 0x0206
1332 #define IW_MIC_DIFF_EVENT_FLAG 0x0207
1333 #define IW_ICV_ERROR_EVENT_FLAG 0x0208
1334 #define IW_MIC_ERROR_EVENT_FLAG 0x0209
1335 #define IW_GROUP_HS_TIMEOUT_EVENT_FLAG 0x020A
1336 #define IW_PAIRWISE_HS_TIMEOUT_EVENT_FLAG 0x020B
1337 #define IW_RSNIE_SANITY_FAIL_EVENT_FLAG 0x020C
1338 #define IW_SET_KEY_DONE_WPA1_EVENT_FLAG 0x020D
1339 #define IW_SET_KEY_DONE_WPA2_EVENT_FLAG 0x020E
1340 #define IW_STA_LINKUP_EVENT_FLAG 0x020F
1341 #define IW_STA_LINKDOWN_EVENT_FLAG 0x0210
1342 #define IW_SCAN_COMPLETED_EVENT_FLAG 0x0211
1343 #define IW_SCAN_ENQUEUE_FAIL_EVENT_FLAG 0x0212
1344 // if add new system event flag, please upadte the IW_SYS_EVENT_FLAG_END
1345 #define IW_SYS_EVENT_FLAG_END 0x0212
1346 #define IW_SYS_EVENT_TYPE_NUM (IW_SYS_EVENT_FLAG_END - IW_SYS_EVENT_FLAG_START + 1)
1347 // For system event - end
1349 // For spoof attack event - start
1350 #define IW_SPOOF_EVENT_FLAG_START 0x0300
1351 #define IW_CONFLICT_SSID_EVENT_FLAG 0x0300
1352 #define IW_SPOOF_ASSOC_RESP_EVENT_FLAG 0x0301
1353 #define IW_SPOOF_REASSOC_RESP_EVENT_FLAG 0x0302
1354 #define IW_SPOOF_PROBE_RESP_EVENT_FLAG 0x0303
1355 #define IW_SPOOF_BEACON_EVENT_FLAG 0x0304
1356 #define IW_SPOOF_DISASSOC_EVENT_FLAG 0x0305
1357 #define IW_SPOOF_AUTH_EVENT_FLAG 0x0306
1358 #define IW_SPOOF_DEAUTH_EVENT_FLAG 0x0307
1359 #define IW_SPOOF_UNKNOWN_MGMT_EVENT_FLAG 0x0308
1360 #define IW_REPLAY_ATTACK_EVENT_FLAG 0x0309
1361 // if add new spoof attack event flag, please upadte the IW_SPOOF_EVENT_FLAG_END
1362 #define IW_SPOOF_EVENT_FLAG_END 0x0309
1363 #define IW_SPOOF_EVENT_TYPE_NUM (IW_SPOOF_EVENT_FLAG_END - IW_SPOOF_EVENT_FLAG_START + 1)
1364 // For spoof attack event - end
1366 // For flooding attack event - start
1367 #define IW_FLOOD_EVENT_FLAG_START 0x0400
1368 #define IW_FLOOD_AUTH_EVENT_FLAG 0x0400
1369 #define IW_FLOOD_ASSOC_REQ_EVENT_FLAG 0x0401
1370 #define IW_FLOOD_REASSOC_REQ_EVENT_FLAG 0x0402
1371 #define IW_FLOOD_PROBE_REQ_EVENT_FLAG 0x0403
1372 #define IW_FLOOD_DISASSOC_EVENT_FLAG 0x0404
1373 #define IW_FLOOD_DEAUTH_EVENT_FLAG 0x0405
1374 #define IW_FLOOD_EAP_REQ_EVENT_FLAG 0x0406
1375 // if add new flooding attack event flag, please upadte the IW_FLOOD_EVENT_FLAG_END
1376 #define IW_FLOOD_EVENT_FLAG_END 0x0406
1377 #define IW_FLOOD_EVENT_TYPE_NUM (IW_FLOOD_EVENT_FLAG_END - IW_FLOOD_EVENT_FLAG_START + 1)
1378 // For flooding attack - end
1380 // End - WIRELESS EVENTS definition
1382 // definition for DLS, kathy
1383 #define MAX_NUM_OF_INIT_DLS_ENTRY 1
1384 #define MAX_NUM_OF_DLS_ENTRY MAX_NUMBER_OF_DLS_ENTRY
1386 //Block ACK , rt2860, kathy
1387 #define MAX_TX_REORDERBUF 64
1388 #define MAX_RX_REORDERBUF 64
1389 #define DEFAULT_TX_TIMEOUT 30
1390 #define DEFAULT_RX_TIMEOUT 30
1391 #define MAX_BARECI_SESSION 8
1393 #ifndef IW_ESSID_MAX_SIZE
1394 /* Maximum size of the ESSID and pAd->nickname strings */
1395 #define IW_ESSID_MAX_SIZE 32
1398 #ifdef MCAST_RATE_SPECIFIC
1399 #define MCAST_DISABLE 0
1401 #define MCAST_OFDM 2
1402 #define MCAST_HTMIX 3
1403 #endif // MCAST_RATE_SPECIFIC //
1406 // For AsicRadioOff/AsicRadioOn/AsicForceWakeup function
1407 // This is to indicate from where to call this function.
1408 #define DOT11POWERSAVE 0 // TO do .11 power save sleep
1409 #define GUIRADIO_OFF 1 // To perform Radio OFf command from GUI
1410 #define RTMP_HALT 2 // Called from Halt handler.
1411 #define GUI_IDLE_POWER_SAVE 3 // Call to sleep before link up with AP
1412 #define FROM_TX 4 // Force wake up from Tx packet.
1415 // For AsicRadioOff/AsicRadioOn function
1416 #define DOT11POWERSAVE 0
1417 #define GUIRADIO_OFF 1
1419 #define GUI_IDLE_POWER_SAVE 3
1422 // definition for WpaSupport flag
1423 #define WPA_SUPPLICANT_DISABLE 0
1424 #define WPA_SUPPLICANT_ENABLE 1
1425 #define WPA_SUPPLICANT_ENABLE_WITH_WEB_UI 2
1427 // Endian byte swapping codes
1430 (((UINT16)(x) & (UINT16) 0x00ffU) << 8) | \
1431 (((UINT16)(x) & (UINT16) 0xff00U) >> 8) ))
1435 (((UINT32)(x) & (UINT32) 0x000000ffUL) << 24) | \
1436 (((UINT32)(x) & (UINT32) 0x0000ff00UL) << 8) | \
1437 (((UINT32)(x) & (UINT32) 0x00ff0000UL) >> 8) | \
1438 (((UINT32)(x) & (UINT32) 0xff000000UL) >> 24) ))
1442 (UINT64)(((UINT64)(x) & (UINT64) 0x00000000000000ffULL) << 56) | \
1443 (UINT64)(((UINT64)(x) & (UINT64) 0x000000000000ff00ULL) << 40) | \
1444 (UINT64)(((UINT64)(x) & (UINT64) 0x0000000000ff0000ULL) << 24) | \
1445 (UINT64)(((UINT64)(x) & (UINT64) 0x00000000ff000000ULL) << 8) | \
1446 (UINT64)(((UINT64)(x) & (UINT64) 0x000000ff00000000ULL) >> 8) | \
1447 (UINT64)(((UINT64)(x) & (UINT64) 0x0000ff0000000000ULL) >> 24) | \
1448 (UINT64)(((UINT64)(x) & (UINT64) 0x00ff000000000000ULL) >> 40) | \
1449 (UINT64)(((UINT64)(x) & (UINT64) 0xff00000000000000ULL) >> 56) ))
1451 #define cpu2le64(x) ((UINT64)(x))
1452 #define le2cpu64(x) ((UINT64)(x))
1453 #define cpu2le32(x) ((UINT32)(x))
1454 #define le2cpu32(x) ((UINT32)(x))
1455 #define cpu2le16(x) ((UINT16)(x))
1456 #define le2cpu16(x) ((UINT16)(x))
1457 #define cpu2be64(x) SWAP64((x))
1458 #define be2cpu64(x) SWAP64((x))
1459 #define cpu2be32(x) SWAP32((x))
1460 #define be2cpu32(x) SWAP32((x))
1461 #define cpu2be16(x) SWAP16((x))
1462 #define be2cpu16(x) SWAP16((x))
1464 #endif // __RTMP_DEF_H__
git://ftp.safe.ca / safe / jmp / linux-2.6 / blob