wt_hdr.h

mini-PCI driver for LHWT chipsets

#ifndef _WT_HDR_H
#define _WT_HDR_H

/*================================================================*/
/* System Includes */

/*================================================================*/
/* Project Includes */


/*================================================================*/
/* Constants */

/*--- Sizes -----------------------------------------------*/
#define WLAN_ADDR_LEN			6
#define WLAN_CRC_LEN			4
#define WLAN_BSSID_LEN			6
#define WLAN_BSS_TS_LEN			8
#define WLAN_HDR_A3_LEN			24
#define WLAN_HDR_A4_LEN			30
#define WLAN_SSID_MAXLEN		32
#define WLAN_DATA_MAXLEN		2312
#define WLAN_A3FR_MAXLEN		(WLAN_HDR_A3_LEN + WLAN_DATA_MAXLEN + WLAN_CRC_LEN)
#define WLAN_A4FR_MAXLEN		(WLAN_HDR_A4_LEN + WLAN_DATA_MAXLEN + WLAN_CRC_LEN)
#define WLAN_BEACON_FR_MAXLEN		(WLAN_HDR_A3_LEN + 334)
#define WLAN_ATIM_FR_MAXLEN		(WLAN_HDR_A3_LEN + 0)
#define WLAN_DISASSOC_FR_MAXLEN		(WLAN_HDR_A3_LEN + 2)
#define WLAN_ASSOCREQ_FR_MAXLEN		(WLAN_HDR_A3_LEN + 48)
#define WLAN_ASSOCRESP_FR_MAXLEN	(WLAN_HDR_A3_LEN + 16)
#define WLAN_REASSOCREQ_FR_MAXLEN	(WLAN_HDR_A3_LEN + 54)
#define WLAN_REASSOCRESP_FR_MAXLEN	(WLAN_HDR_A3_LEN + 16)
#define WLAN_PROBEREQ_FR_MAXLEN		(WLAN_HDR_A3_LEN + 44)
#define WLAN_PROBERESP_FR_MAXLEN	(WLAN_HDR_A3_LEN + 78)
#define WLAN_AUTHEN_FR_MAXLEN		(WLAN_HDR_A3_LEN + 261)
#define WLAN_DEAUTHEN_FR_MAXLEN		(WLAN_HDR_A3_LEN + 2)
#define WLAN_WEP_NKEYS			4
#define WLAN_WEP_MAXKEYLEN		13
#define WLAN_CHALLENGE_IE_LEN		130
#define WLAN_CHALLENGE_LEN		128
#define WLAN_WEP_IV_LEN			4
#define WLAN_WEP_ICV_LEN		4

/*--- Frame Control Field -------------------------------------*/
/* Frame Types */
#define WLAN_FTYPE_MGMT			0x00
#define WLAN_FTYPE_CTL			0x01
#define WLAN_FTYPE_DATA			0x02

/* Frame subtypes */
/* Management */
#define WLAN_FSTYPE_ASSOCREQ		0x00
#define WLAN_FSTYPE_ASSOCRESP		0x01
#define WLAN_FSTYPE_REASSOCREQ		0x02
#define WLAN_FSTYPE_REASSOCRESP		0x03
#define WLAN_FSTYPE_PROBEREQ		0x04
#define WLAN_FSTYPE_PROBERESP		0x05
#define WLAN_FSTYPE_BEACON		0x08
#define WLAN_FSTYPE_ATIM		0x09
#define WLAN_FSTYPE_DISASSOC		0x0a
#define WLAN_FSTYPE_AUTHEN		0x0b
#define WLAN_FSTYPE_DEAUTHEN		0x0c

/* Control */
#define WLAN_FSTYPE_PSPOLL		0x0a
#define WLAN_FSTYPE_RTS			0x0b
#define WLAN_FSTYPE_CTS			0x0c
#define WLAN_FSTYPE_ACK			0x0d
#define WLAN_FSTYPE_CFEND		0x0e
#define WLAN_FSTYPE_CFENDCFACK		0x0f

/* Data */
#define WLAN_FSTYPE_DATAONLY		0x00
#define WLAN_FSTYPE_DATA_CFACK		0x01
#define WLAN_FSTYPE_DATA_CFPOLL		0x02
#define WLAN_FSTYPE_DATA_CFACK_CFPOLL	0x03
#define WLAN_FSTYPE_NULL		0x04
#define WLAN_FSTYPE_CFACK		0x05
#define WLAN_FSTYPE_CFPOLL		0x06
#define WLAN_FSTYPE_CFACK_CFPOLL	0x07


typedef enum
{
  WLAN_ASSOC_REQ           = ( WLAN_FTYPE_MGMT | WLAN_FSTYPE_ASSOCREQ           ),
  WLAN_ASSOC_RESP          = ( WLAN_FTYPE_MGMT | WLAN_FSTYPE_ASSOCRESP          ),
  WLAN_REASSOC_REQ         = ( WLAN_FTYPE_MGMT | WLAN_FSTYPE_REASSOCREQ         ),
  WLAN_REASSOC_RESP        = ( WLAN_FTYPE_MGMT | WLAN_FSTYPE_REASSOCRESP        ),
  WLAN_PROBE_REQ           = ( WLAN_FTYPE_MGMT | WLAN_FSTYPE_PROBEREQ           ),
  WLAN_PROBE_RESP          = ( WLAN_FTYPE_MGMT | WLAN_FSTYPE_PROBERESP          ),
  WLAN_BEACON              = ( WLAN_FTYPE_MGMT | WLAN_FSTYPE_BEACON              ),
  WLAN_ATIM                = ( WLAN_FTYPE_MGMT | WLAN_FSTYPE_ATIM                ),
  WLAN_DISASSOC            = ( WLAN_FTYPE_MGMT | WLAN_FSTYPE_DISASSOC            ),
  WLAN_AUTH                = ( WLAN_FTYPE_MGMT | WLAN_FSTYPE_AUTHEN                ),
  WLAN_DEAUTH              = ( WLAN_FTYPE_MGMT | WLAN_FSTYPE_DEAUTHEN              ),
  WLAN_PS_POLL             = ( WLAN_FTYPE_CTL | WLAN_FSTYPE_PSPOLL             ),
  WLAN_RTS                 = ( WLAN_FTYPE_CTL | WLAN_FSTYPE_RTS                 ),
  WLAN_CTS                 = ( WLAN_FTYPE_CTL | WLAN_FSTYPE_CTS                 ),
  WLAN_ACK                 = ( WLAN_FTYPE_CTL | WLAN_FSTYPE_ACK                 ),
  WLAN_CF_END              = ( WLAN_FTYPE_CTL | WLAN_FSTYPE_CFEND              ),
  WLAN_CF_END_CF_ACK       = ( WLAN_FTYPE_CTL | WLAN_FSTYPE_CFENDCFACK       ),
  WLAN_DATA                = ( WLAN_FTYPE_DATA | WLAN_FSTYPE_DATAONLY                ),
  WLAN_DATA_CF_ACK         = ( WLAN_FTYPE_DATA | WLAN_FSTYPE_DATA_CFACK         ),
  WLAN_DATA_CF_POLL        = ( WLAN_FTYPE_DATA | WLAN_FSTYPE_DATA_CFPOLL        ),
  WLAN_DATA_CF_ACK_CF_POLL   = ( WLAN_FTYPE_DATA | WLAN_FSTYPE_DATA_CFACK_CFPOLL ),
  WLAN_DATA_NULL_FUNCTION  = ( WLAN_FTYPE_DATA | WLAN_FSTYPE_NULL       ),
  WLAN_CF_ACK              = ( WLAN_FTYPE_DATA | WLAN_FSTYPE_CFACK              ),
  WLAN_CF_POLL             = ( WLAN_FTYPE_DATA | WLAN_FSTYPE_CFPOLL             ),
  WLAN_CF_ACK_CF_POLL      = ( WLAN_FTYPE_DATA | WLAN_FSTYPE_CFACK_CFPOLL      )
} WLAN_FRAME_TYPE_T;

/*================================================================*/
/* Macros */

/*--- FC Macros ----------------------------------------------*/
/* Macros to get/set the bitfields of the Frame Control Field */
/*  GET_FC_??? - takes the host byte-order value of an FC     */
/*               and retrieves the value of one of the        */
/*               bitfields and moves that value so its lsb is */
/*               in bit 0.                                    */
/*  SET_FC_??? - takes a host order value for one of the FC   */
/*               bitfields and moves it to the proper bit     */
/*               location for ORing into a host order FC.     */
/*               To send the FC produced from SET_FC_???,     */
/*               one must put the bytes in IEEE order.        */
/*  e.g.                                                      */
/*     printf("the frame subtype is %x",                      */
/*                 GET_FC_FTYPE( ieee2host( rx.fc )))         */
/*                                                            */
/*     tx.fc = host2ieee( SET_FC_FTYPE(WLAN_FTYP_CTL) |       */
/*                        SET_FC_FSTYPE(WLAN_FSTYPE_RTS) );   */
/*------------------------------------------------------------*/

#define WLAN_GET_FC_PVER(n)	 (((UINT16)(n)) & (BIT0 | BIT1))
#define WLAN_GET_FC_FTYPE(n)	((((UINT16)(n)) & (BIT2 | BIT3)) >> 2)
#define WLAN_GET_FC_FSTYPE(n)	((((UINT16)(n)) & (BIT4|BIT5|BIT6|BIT7)) >> 4)
#define WLAN_GET_FC_TODS(n) 	((((UINT16)(n)) & (BIT8)) >> 8)
#define WLAN_GET_FC_FROMDS(n)	((((UINT16)(n)) & (BIT9)) >> 9)
#define WLAN_GET_FC_MOREFRAG(n) ((((UINT16)(n)) & (BIT10)) >> 10)
#define WLAN_GET_FC_RETRY(n)	((((UINT16)(n)) & (BIT11)) >> 11)
#define WLAN_GET_FC_PWRMGT(n)	((((UINT16)(n)) & (BIT12)) >> 12)
#define WLAN_GET_FC_MOREDATA(n) ((((UINT16)(n)) & (BIT13)) >> 13)
#define WLAN_GET_FC_ISWEP(n)	((((UINT16)(n)) & (BIT14)) >> 14)
#define WLAN_GET_FC_ORDER(n)	((((UINT16)(n)) & (BIT15)) >> 15)

#define WLAN_SET_FC_PVER(n)	((UINT16)(n))
#define WLAN_SET_FC_FTYPE(n)	(((UINT16)(n)) << 2)
#define WLAN_SET_FC_FSTYPE(n)	(((UINT16)(n)) << 4)
#define WLAN_SET_FC_TODS(n) 	(((UINT16)(n)) << 8)
#define WLAN_SET_FC_FROMDS(n)	(((UINT16)(n)) << 9)
#define WLAN_SET_FC_MOREFRAG(n) (((UINT16)(n)) << 10)
#define WLAN_SET_FC_RETRY(n)	(((UINT16)(n)) << 11)
#define WLAN_SET_FC_PWRMGT(n)	(((UINT16)(n)) << 12)
#define WLAN_SET_FC_MOREDATA(n) (((UINT16)(n)) << 13)
#define WLAN_SET_FC_ISWEP(n)	(((UINT16)(n)) << 14)
#define WLAN_SET_FC_ORDER(n)	(((UINT16)(n)) << 15)

/*--- Duration Macros ----------------------------------------*/
/* Macros to get/set the bitfields of the Duration Field      */
/*  - the duration value is only valid when bit15 is zero     */
/*  - the firmware handles these values, so I'm not going     */
/*    these macros right now.                                 */
/*------------------------------------------------------------*/

/*--- Sequence Control  Macros -------------------------------*/
/* Macros to get/set the bitfields of the Sequence Control    */
/* Field.                                                     */
/*------------------------------------------------------------*/
#define WLAN_GET_SEQ_FRGNUM(n) (((UINT16)(n)) & (BIT0|BIT1|BIT2|BIT3))
#define WLAN_GET_SEQ_SEQNUM(n) ((((UINT16)(n)) & (~(BIT0|BIT1|BIT2|BIT3))) >> 4)

/*--- Data ptr macro -----------------------------------------*/
/* Creates a UINT8* to the data portion of a frame            */
/* Assumes you're passing in a ptr to the beginning of the hdr*/
/*------------------------------------------------------------*/
#define WLAN_HDR_A3_DATAP(p) (((UINT8*)(p)) + WLAN_HDR_A3_LEN)
#define WLAN_HDR_A4_DATAP(p) (((UINT8*)(p)) + WLAN_HDR_A4_LEN)

#define DOT11_RATE5_ISBASIC_GET(r)     (((UINT8)(r)) & BIT7)

/*================================================================*/
/* Types */

/* BSS Timestamp */
typedef UINT8 wlan_bss_ts_t[WLAN_BSS_TS_LEN];

#ifdef NDIS_MINIPORT_DRIVER
#pragma pack(1)
#endif

/* Generic 802.11 Header types */
__WLAN_PRAGMA_PACK1__ typedef struct p80211_hdr_a3 {
	UINT16 fc __WLAN_ATTRIB_PACK__;
	UINT16 dur __WLAN_ATTRIB_PACK__;
	UINT8 a1[WLAN_ADDR_LEN] __WLAN_ATTRIB_PACK__;
	UINT8 a2[WLAN_ADDR_LEN] __WLAN_ATTRIB_PACK__;
	UINT8 a3[WLAN_ADDR_LEN] __WLAN_ATTRIB_PACK__;
	UINT16 seq __WLAN_ATTRIB_PACK__;
} __WLAN_ATTRIB_PACK__ p80211_hdr_a3_t;
__WLAN_PRAGMA_PACKDFLT__ __WLAN_PRAGMA_PACK1__ typedef struct p80211_hdr_a4 {
	UINT16 fc __WLAN_ATTRIB_PACK__;
	UINT16 dur __WLAN_ATTRIB_PACK__;
	UINT8 a1[WLAN_ADDR_LEN] __WLAN_ATTRIB_PACK__;
	UINT8 a2[WLAN_ADDR_LEN] __WLAN_ATTRIB_PACK__;
	UINT8 a3[WLAN_ADDR_LEN] __WLAN_ATTRIB_PACK__;
	UINT16 seq __WLAN_ATTRIB_PACK__;
	UINT8 a4[WLAN_ADDR_LEN] __WLAN_ATTRIB_PACK__;
} __WLAN_ATTRIB_PACK__ p80211_hdr_a4_t;
__WLAN_PRAGMA_PACKDFLT__ typedef union p80211_hdr {
	p80211_hdr_a3_t a3 __WLAN_ATTRIB_PACK__;
	p80211_hdr_a4_t a4 __WLAN_ATTRIB_PACK__;
} __WLAN_ATTRIB_PACK__ p80211_hdr_t;

/*============================================================================*
 * Constants                                                                  *
 *============================================================================*/

#define WLAN_ETHADDR_LEN	6
#define WLAN_IEEE_OUI_LEN	3

#define WLAN_ETHCONV_ENCAP	1
#define WLAN_ETHCONV_RFC1042	2
#define WLAN_ETHCONV_8021h	3

#define WLAN_MIN_ETHFRM_LEN	60
#define WLAN_MAX_ETHFRM_LEN	1514
#define WLAN_ETHHDR_LEN		14

/*============================================================================*
 * Types                                                                      *
 *============================================================================*/

/* local ether header type */
typedef struct wlan_ethhdr {
	UINT8 daddr[WLAN_ETHADDR_LEN] __WLAN_ATTRIB_PACK__;
	UINT8 saddr[WLAN_ETHADDR_LEN] __WLAN_ATTRIB_PACK__;
	UINT16 type __WLAN_ATTRIB_PACK__;
} __WLAN_ATTRIB_PACK__ wlan_ethhdr_t;

/* local llc header type */
typedef struct wlan_llc {
	UINT8 dsap __WLAN_ATTRIB_PACK__;
	UINT8 ssap __WLAN_ATTRIB_PACK__;
	UINT8 ctl __WLAN_ATTRIB_PACK__;
} __WLAN_ATTRIB_PACK__ wlan_llc_t;

/* local snap header type */
typedef struct wlan_snap {
	UINT8 oui[WLAN_IEEE_OUI_LEN] __WLAN_ATTRIB_PACK__;
	UINT16 type __WLAN_ATTRIB_PACK__;
} __WLAN_ATTRIB_PACK__ wlan_snap_t;


#ifdef NDIS_MINIPORT_DRIVER
#pragma pack()
#endif

/*================================================================*/
/* Extern Declarations */


/*================================================================*/
/* Function Declarations */

void p802addr_to_str(char *buf, UINT8 * addr);

#endif				/* _WT_HDR_H */