rtmp_def.h

TP Link 321 Linux Driver

/*
 ***************************************************************************
 * Ralink Tech Inc.
 * 4F, No. 2 Technology	5th	Rd.
 * Science-based Industrial	Park
 * Hsin-chu, Taiwan, R.O.C.
 *
 * (c) Copyright 2002-2006, Ralink Technology, Inc.
 *
 * All rights reserved.	Ralink's source	code is	an unpublished work	and	the
 * use of a	copyright notice does not imply	otherwise. This	source code
 * contains	confidential trade secret material of Ralink Tech. Any attemp
 * or participation	in deciphering,	decoding, reverse engineering or in	any
 * way altering	the	source code	is stricitly prohibited, unless	the	prior
 * written consent of Ralink Technology, Inc. is obtained.
 ***************************************************************************

	Module Name:
	rtmp_def.h

	Abstract:
	Miniport related definition header

	Revision History:
	Who 		When		  What
	--------	----------	  ----------------------------------------------
	Paul Lin	08-01-2002	  created
	John Chang	08-05-2003	  add definition for 11g & other drafts
*/
#ifndef __RTMP_DEF_H__
#define __RTMP_DEF_H__

//
//	Debug information verbosity: lower values indicate higher urgency
//
#define RT_DEBUG_OFF		0
#define RT_DEBUG_ERROR		1
#define RT_DEBUG_WARN		2
#define RT_DEBUG_TRACE		3
#define RT_DEBUG_INFO		4
#define RT_DEBUG_LOUD		5

#define NIC_TAG 			((ULONG)'3752')
#define NIC_DBG_STRING		("-RT73-")

#ifdef BIG_ENDIAN
#define DIR_READ					0
#define DIR_WRITE					1
#define TYPE_TXD					0
#define TYPE_RXD					1
#endif

//WEP 
#define WEP_SMALL_KEY_LEN	(40/8)
#define WEP_LARGE_KEY_LEN	(104/8)

//
// Entry number for each DMA descriptor ring
//
#define MAX_TX_QUEUE_SIZE		1600
#define TX_RING_SIZE			64
#define PRIO_RING_SIZE			16
#define RX_RING_SIZE			64
#define	BEACON_RING_SIZE		2
#define MGMT_RING_SIZE			PRIO_RING_SIZE
#define PRIO_BUFFER_SIZE		1024	// 2048
#define BUFFER_SIZE				2400	//2048
#define	MAX_FRAME_SIZE			2346	// Maximum 802.11 frame size
#define ALLOC_RX_PACKET_POOL	(RX_RING_SIZE)
#define ALLOC_RX_BUFFER_POOL	(ALLOC_RX_PACKET_POOL)
#define	TX_RING					0xa
#define	ATIM_RING				0xb
#define	PRIO_RING				0xc
#define	RX_RING					0xd
#define	BEACON_RING				0xe
#define	NULL_RING				0xf
#define	MAX_TX_PROCESS			2
#define	MAX_RX_PROCESS			4
#define	MAX_CLIENT				2

#define LOCAL_TXBUF_SIZE		2048
#define TXD_SIZE				24
#define RXD_SIZE				24
#define TX_DMA_1ST_BUFFER_SIZE	64	  // only the 1st physical buffer is pre-allocated
#define MGMT_DMA_BUFFER_SIZE	2048
#define RX_DMA_BUFFER_SIZE      4096
#define MAX_AGGREGATION_SIZE	4096
#define MAX_DMA_DONE_PROCESS	TX_RING_SIZE
#define MAX_TX_DONE_PROCESS 	8
#define MAX_NUM_OF_TUPLE_CACHE	2
#define MAX_MCAST_LIST_SIZE 	32


//
//	RTMP_ADAPTER flags
//
#define	fRTMP_ADAPTER_TEST_MODE				0x00000001
#define fRTMP_ADAPTER_MLME_RESET_IN_PROGRESS	 0x00000002
#define fRTMP_ADAPTER_HARDWARE_ERROR		0x00000004
#define fRTMP_ADAPTER_SEND_PACKET_ERROR 	0x00000010
#define fRTMP_ADAPTER_RECEIVE_PACKET_ERROR	0x00000020
#define fRTMP_ADAPTER_HALT_IN_PROGRESS		0x00000040
#define fRTMP_ADAPTER_RESET_IN_PROGRESS 	0x00000080
#define fRTMP_ADAPTER_NIC_NOT_EXIST 		0x00000100
#define fRTMP_ADAPTER_TX_RING_ALLOCATED 	0x00000200
#define fRTMP_ADAPTER_ATIM_RING_ALLOCATED	0x00000400
#define fRTMP_ADAPTER_PRIO_RING_ALLOCATED	0x00000800
#define fRTMP_ADAPTER_RX_RING_ALLOCATED 	0x00001000
#define fRTMP_ADAPTER_BSS_JOIN_IN_PROGRESS	0x00002000
#define fRTMP_ADAPTER_BSS_SCAN_IN_PROGRESS	0x00004000
#define	fRTMP_ADAPTER_REASSOC_IN_PROGRESS	0x00008000
#define	fRTMP_ADAPTER_MEDIA_STATE_PENDING	0x00010000
#define	fRTMP_ADAPTER_RADIO_OFF				0x00020000
#define	fRTMP_ADAPTER_BULKOUT_RESET			0x00040000
#define	fRTMP_ADAPTER_BULKIN_RESET			0x00080000
#define fRTMP_ADAPTER_RESET_DATA_SW_QUEUE	0x00100000
#define fRTMP_ADAPTER_RESET_PIPE_IN_PROGRESS 0x00200000
#define fRTMP_ADAPTER_SCAN_CHANNEL_IN_PROGRESS 0x04000000
#define	fRTMP_ADAPTER_RADIO_MEASUREMENT		0x08000000
#define fRTMP_ADAPTER_REMOVE_IN_PROGRESS	0x10000000
#define fRTMP_ADAPTER_MEDIA_STATE_CHANGE	0x20000000


// Lock bit for accessing different ring buffers
#define fRTMP_ADAPTER_TX_RING_BUSY			0x80000000
#define fRTMP_ADAPTER_PRIO_RING_BUSY		0x40000000
#define fRTMP_ADAPTER_ATIM_RING_BUSY		0x20000000
#define fRTMP_ADAPTER_RX_RING_BUSY			0x10000000

// Lock bit for accessing different queue
#define	fRTMP_ADAPTER_TX_QUEUE_BUSY 		0x08000000
#define	fRTMP_ADAPTER_PRIO_QUEUE_BUSY		0x04000000


//
//	STA operation status flags
//
#define fOP_STATUS_INFRA_ON 				0x00000001
#define fOP_STATUS_ADHOC_ON 				0x00000002
#define fOP_STATUS_BG_PROTECTION_INUSED 	0x00000004
#define fOP_STATUS_SHORT_SLOT_INUSED		0x00000008
#define fOP_STATUS_SHORT_PREAMBLE_INUSED	0x00000010
#define fOP_STATUS_RECEIVE_DTIM 			0x00000020
#define fOP_STATUS_TX_RATE_SWITCH_ENABLED	0x00000040
#define fOP_STATUS_MEDIA_STATE_CONNECTED	0x00000080
#define fOP_STATUS_WMM_INUSED				0x00000100
#define fOP_STATUS_AGGREGATION_INUSED		0x00000200
#define fOP_STATUS_DOZE 					0x00000400
#define fOP_STATUS_MAX_RETRY_ENABLED		0x00000800
#define fOP_STATUS_RTS_PROTECTION_ENABLE	0x00001000

//
// Flags for Bulkflags control for bulk out data
//
#define	fRTUSB_BULK_OUT_DATA_NULL				0x00000001
#define fRTUSB_BULK_OUT_RTS						0x00000002
#define	fRTUSB_BULK_OUT_MLME					0x00000004
#define	fRTUSB_BULK_OUT_BEACON_1				0x00000008

#define	fRTUSB_BULK_OUT_DATA_NORMAL				0x00010000
#define	fRTUSB_BULK_OUT_DATA_NORMAL_2			0x00020000
#define	fRTUSB_BULK_OUT_DATA_NORMAL_3			0x00040000
#define	fRTUSB_BULK_OUT_DATA_NORMAL_4			0x00080000


#define	fRTUSB_BULK_OUT_BEACON_0				0x00000010
#define	fRTUSB_BULK_OUT_PSPOLL					0x00000020
#define	fRTUSB_BULK_OUT_DATA_FRAG				0x00000040
#define	fRTUSB_BULK_OUT_DATA_FRAG_2				0x00000080
#define	fRTUSB_BULK_OUT_DATA_FRAG_3				0x00000100
#define	fRTUSB_BULK_OUT_DATA_FRAG_4				0x00000200
#ifdef RALINK_ATE
#define	fRTUSB_BULK_OUT_DATA_ATE				0x00100000
#endif

//
//	AP's client table operation status flags
//
#define fCLIENT_STATUS_WMM_CAPABLE			0x00000001	// CLIENT can parse QOS DATA frame
#define fCLIENT_STATUS_AGGREGATION_CAPABLE	0x00000002	// CLIENT can receive Ralink's proprietary TX aggregation frame

//
//	STA configuration flags
//
//#define fSTA_CFG_ENABLE_TX_BURST			0x00000001


//
// Error code section
//
// NDIS_ERROR_CODE_ADAPTER_NOT_FOUND
#define ERRLOG_READ_PCI_SLOT_FAILED 	0x00000101L
#define ERRLOG_WRITE_PCI_SLOT_FAILED	0x00000102L
#define ERRLOG_VENDOR_DEVICE_NOMATCH	0x00000103L

// NDIS_ERROR_CODE_ADAPTER_DISABLED
#define ERRLOG_BUS_MASTER_DISABLED		0x00000201L

// NDIS_ERROR_CODE_UNSUPPORTED_CONFIGURATION
#define ERRLOG_INVALID_SPEED_DUPLEX 	0x00000301L
#define ERRLOG_SET_SECONDARY_FAILED 	0x00000302L

// NDIS_ERROR_CODE_OUT_OF_RESOURCES
#define ERRLOG_OUT_OF_MEMORY			0x00000401L
#define ERRLOG_OUT_OF_SHARED_MEMORY 	0x00000402L
#define ERRLOG_OUT_OF_MAP_REGISTERS 	0x00000403L
#define ERRLOG_OUT_OF_BUFFER_POOL		0x00000404L
#define ERRLOG_OUT_OF_NDIS_BUFFER		0x00000405L
#define ERRLOG_OUT_OF_PACKET_POOL		0x00000406L
#define ERRLOG_OUT_OF_NDIS_PACKET		0x00000407L
#define ERRLOG_OUT_OF_LOOKASIDE_MEMORY	0x00000408L

// NDIS_ERROR_CODE_HARDWARE_FAILURE
#define ERRLOG_SELFTEST_FAILED			0x00000501L
#define ERRLOG_INITIALIZE_ADAPTER		0x00000502L
#define ERRLOG_REMOVE_MINIPORT			0x00000503L

// NDIS_ERROR_CODE_RESOURCE_CONFLICT
#define ERRLOG_MAP_IO_SPACE 			0x00000601L
#define ERRLOG_QUERY_ADAPTER_RESOURCES	0x00000602L
#define ERRLOG_NO_IO_RESOURCE			0x00000603L
#define ERRLOG_NO_INTERRUPT_RESOURCE	0x00000604L
#define ERRLOG_NO_MEMORY_RESOURCE		0x00000605L

//============================================================
// Length definitions
#define PEER_KEY_NO                       2
#define MAC_ADDR_LEN                      6
#define TIMESTAMP_LEN                     8
#define MAX_LEN_OF_SUPPORTED_RATES        12    // 1, 2, 5.5, 11, 6, 9, 12, 18, 24, 36, 48, 54
#define MAX_LEN_OF_KEY                    32      // 32 octets == 256 bits, Redefine for WPA

#define MAX_NUM_OF_CHANNELS               43    //1-14, 36/40/44/48/52/56/60/64/100/104/108/112/116/120/124/ 
                                                //128/132/136/140/149/153/157/161/165/34/38/42/46 + 1 as NULL termination
#define MAX_NUM_OF_A_CHANNELS             24    //36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140, 149, 153, 157, 161, 165
#define J52_CHANNEL_START_OFFSET          38    //1-14, 36/40/44/48/52/56/60/64/100/104/108/112/116/120/124/
                                                //128/132/136/140/149/153/157/161/165/
#define MAX_LEN_OF_SSID                   32
#define CIPHER_TEXT_LEN                   128
#define MAX_LEN_OF_MLME_BUFFER            2048
#define MAX_MLME_HANDLER_MEMORY           20    //each them cantains  MAX_LEN_OF_MLME_BUFFER size 
#define MAX_FRAME_LEN                     2338
#define	MAX_VIE_LEN                       300	// edit by johnli, variable ie length could be > 256, fix WiFi WPS test bug for Conexant AP

#define MAX_TX_POWER_LEVEL                100   /* mW */
#define MAX_RSSI_TRIGGER                 -10    /* dBm */
#define MIN_RSSI_TRIGGER                 -200   /* dBm */
#define MAX_FRAG_THRESHOLD                2346  /* byte count */
#define MIN_FRAG_THRESHOLD                256   /* byte count */
#define MAX_RTS_THRESHOLD                 2347  /* byte count */

// key related definitions
#define SHARE_KEY_NUM                     4
#define MAX_LEN_OF_SHARE_KEY              16    // byte count
#define MAX_LEN_OF_PEER_KEY               16    // byte count
#define PAIRWISE_KEY_NO                   64    // in MAC ASIC pairwise key table
#define GROUP_KEY_NO                      4
#define	PMKID_NO                          4     // Number of PMKID saved supported


// power status related definitions
#define PWR_ACTIVE                        0
#define PWR_SAVE                          1
#define PWR_UNKNOWN                       2

// BSS Type definitions
#define BSS_ADHOC                         0  // = Ndis802_11IBSS
#define BSS_INFRA                         1  // = Ndis802_11Infrastructure
#define BSS_ANY                           2  // = Ndis802_11AutoUnknown

// Reason code definitions
#define REASON_RESERVED                   0
#define REASON_UNSPECIFY                  1
#define REASON_NO_LONGER_VALID            2
#define REASON_DEAUTH_STA_LEAVING         3
#define REASON_DISASSOC_INACTIVE          4
#define REASON_DISASSPC_AP_UNABLE         5
#define REASON_CLS2ERR                    6
#define REASON_CLS3ERR                    7
#define REASON_DISASSOC_STA_LEAVING       8
#define REASON_STA_REQ_ASSOC_NOT_AUTH     9
#define	REASON_INVALID_IE                 13
#define	REASON_MIC_FAILURE                14
#define REASON_4_WAY_TIMEOUT              15
#define REASON_GROUP_KEY_HS_TIMEOUT       16
#define REASON_IE_DIFFERENT               17
#define REASON_MCIPHER_NOT_VALID          18