[deliverable/linux.git] / drivers / staging / rtl8712 / wlan_bssdef.h

/******************************************************************************
 *
 * Copyright(c) 2007 - 2010 Realtek Corporation. All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
 *
 * Modifications for inclusion into the Linux staging tree are
 * Copyright(c) 2010 Larry Finger. All rights reserved.
 *
 * Contact information:
 * WLAN FAE <wlanfae@realtek.com>
 * Larry Finger <Larry.Finger@lwfinger.net>
 *
 ******************************************************************************/
#ifndef __WLAN_BSSDEF_H__
#define __WLAN_BSSDEF_H__

#define MAX_IE_SZ	768

#define NDIS_802_11_LENGTH_SSID         32
#define NDIS_802_11_LENGTH_RATES        8
#define NDIS_802_11_LENGTH_RATES_EX     16

/* Set of 8 data rates*/
typedef unsigned char   NDIS_802_11_RATES[NDIS_802_11_LENGTH_RATES];
/* Set of 16 data rates */
typedef unsigned char   NDIS_802_11_RATES_EX[NDIS_802_11_LENGTH_RATES_EX];

struct ndis_802_11_ssid {
	u32 SsidLength;
	u8  Ssid[32];
};

enum NDIS_802_11_NETWORK_TYPE {
	Ndis802_11FH,
	Ndis802_11DS,
	Ndis802_11OFDM5,
	Ndis802_11OFDM24,
	Ndis802_11NetworkTypeMax /* not a real type, defined as an upper bound*/
};

struct NDIS_802_11_CONFIGURATION_FH {
	u32 Length;             /* Length of structure */
	u32 HopPattern;         /* As defined by 802.11, MSB set */
	u32 HopSet;             /* to one if non-802.11 */
	u32 DwellTime;          /* units are Kusec */
};

/*
	FW will only save the channel number in DSConfig.
	ODI Handler will convert the channel number to freq. number.
*/
struct NDIS_802_11_CONFIGURATION {
	u32 Length;             /* Length of structure */
	u32 BeaconPeriod;       /* units are Kusec */
	u32 ATIMWindow;         /* units are Kusec */
	u32 DSConfig;           /* Frequency, units are kHz */
	struct NDIS_802_11_CONFIGURATION_FH FHConfig;
};

enum NDIS_802_11_NETWORK_INFRASTRUCTURE {
	Ndis802_11IBSS,
	Ndis802_11Infrastructure,
	Ndis802_11AutoUnknown,
	Ndis802_11InfrastructureMax, /*Not a real value,defined as upper bound*/
	Ndis802_11APMode
};

struct NDIS_802_11_FIXED_IEs {
	u8  Timestamp[8];
	u16 BeaconInterval;
	u16 Capabilities;
};

/*
 * Length is the 4 bytes multiples of the sume of
 * 6 * sizeof (unsigned char) + 2 + sizeof (ndis_802_11_ssid) + sizeof (u32)
 * + sizeof (s32) + sizeof (NDIS_802_11_NETWORK_TYPE)
 * + sizeof (struct NDIS_802_11_CONFIGURATION)
 * + sizeof (NDIS_802_11_RATES_EX) + IELength

 * Except the IELength, all other fields are fixed length. Therefore, we can
 * define a macro to present the partial sum.
 */

struct ndis_wlan_bssid_ex {
	u32 Length;
	unsigned char  MacAddress[6];
	u8  Reserved[2];
	struct ndis_802_11_ssid  Ssid;
	u32 Privacy;
	s32 Rssi;
	enum NDIS_802_11_NETWORK_TYPE  NetworkTypeInUse;
	struct NDIS_802_11_CONFIGURATION  Configuration;
	enum NDIS_802_11_NETWORK_INFRASTRUCTURE  InfrastructureMode;
	NDIS_802_11_RATES_EX  SupportedRates;
	u32 IELength;
	/*(timestamp, beacon interval, and capability information) */
	u8 IEs[MAX_IE_SZ];
};

enum NDIS_802_11_AUTHENTICATION_MODE {
	Ndis802_11AuthModeOpen,
	Ndis802_11AuthModeShared,
	Ndis802_11AuthModeAutoSwitch,
	Ndis802_11AuthModeWPA,
	Ndis802_11AuthModeWPAPSK,
	Ndis802_11AuthModeWPANone,
	Ndis802_11AuthModeMax      /* Not a real mode, defined as upper bound */
};

enum {
	Ndis802_11WEPEnabled,
	Ndis802_11Encryption1Enabled = Ndis802_11WEPEnabled,
	Ndis802_11WEPDisabled,
	Ndis802_11EncryptionDisabled = Ndis802_11WEPDisabled,
	Ndis802_11WEPKeyAbsent,
	Ndis802_11Encryption1KeyAbsent = Ndis802_11WEPKeyAbsent,
	Ndis802_11WEPNotSupported,
	Ndis802_11EncryptionNotSupported = Ndis802_11WEPNotSupported,
	Ndis802_11Encryption2Enabled,
	Ndis802_11Encryption2KeyAbsent,
	Ndis802_11Encryption3Enabled,
	Ndis802_11Encryption3KeyAbsent
};

#define NDIS_802_11_AI_REQFI_CAPABILITIES      1
#define NDIS_802_11_AI_REQFI_LISTENINTERVAL    2
#define NDIS_802_11_AI_REQFI_CURRENTAPADDRESS  4

#define NDIS_802_11_AI_RESFI_CAPABILITIES      1
#define NDIS_802_11_AI_RESFI_STATUSCODE        2
#define NDIS_802_11_AI_RESFI_ASSOCIATIONID     4

struct NDIS_802_11_AI_REQFI {
	u16 Capabilities;
	u16 ListenInterval;
	unsigned char CurrentAPAddress[6];
};

struct NDIS_802_11_AI_RESFI {
	u16 Capabilities;
	u16 StatusCode;
	u16 AssociationId;
};

struct NDIS_802_11_ASSOCIATION_INFORMATION {
	u32 Length;
	u16 AvailableRequestFixedIEs;
	struct NDIS_802_11_AI_REQFI RequestFixedIEs;
	u32 RequestIELength;
	u32 OffsetRequestIEs;
	u16 AvailableResponseFixedIEs;
	struct NDIS_802_11_AI_RESFI ResponseFixedIEs;
	u32 ResponseIELength;
	u32 OffsetResponseIEs;
};

/* Key mapping keys require a BSSID*/
struct NDIS_802_11_KEY {
	u32 Length;			/* Length of this structure */
	u32 KeyIndex;
	u32 KeyLength;			/* length of key in bytes */
	unsigned char BSSID[6];
	unsigned long long KeyRSC;
	u8  KeyMaterial[32];		/* variable length */
};

struct NDIS_802_11_REMOVE_KEY {
	u32 Length;			/* Length of this structure */
	u32 KeyIndex;
	unsigned char BSSID[6];
};

struct NDIS_802_11_WEP {
	u32 Length;		  /* Length of this structure */
	u32 KeyIndex;		  /* 0 is the per-client key,
				   * 1-N are the global keys */
	u32 KeyLength;		  /* length of key in bytes */
	u8  KeyMaterial[16];      /* variable length depending on above field */
};

/* mask for authentication/integrity fields */
#define NDIS_802_11_AUTH_REQUEST_AUTH_FIELDS        0x0f
#define NDIS_802_11_AUTH_REQUEST_REAUTH			0x01
#define NDIS_802_11_AUTH_REQUEST_KEYUPDATE		0x02
#define NDIS_802_11_AUTH_REQUEST_PAIRWISE_ERROR		0x06
#define NDIS_802_11_AUTH_REQUEST_GROUP_ERROR		0x0E

/* MIC check time, 60 seconds. */
#define MIC_CHECK_TIME	60000000

#ifndef Ndis802_11APMode
#define Ndis802_11APMode (Ndis802_11InfrastructureMax+1)
#endif

struct	wlan_network {
	struct list_head list;
	int	network_type;	/*refer to ieee80211.h for WIRELESS_11A/B/G */
	int	fixed;		/* set to fixed when not to be removed asi
				 * site-surveying */
	unsigned int	last_scanned; /*timestamp for the network */
	int	aid;		/*will only be valid when a BSS is joined. */
	int	join_res;
	struct ndis_wlan_bssid_ex network; /*must be the last item */
};

enum VRTL_CARRIER_SENSE {
	DISABLE_VCS,
	ENABLE_VCS,
	AUTO_VCS
};

enum VCS_TYPE {
	NONE_VCS,
	RTS_CTS,
	CTS_TO_SELF
};

#define PWR_CAM 0
#define PWR_MINPS 1
#define PWR_MAXPS 2
#define PWR_UAPSD 3
#define PWR_VOIP 4

enum UAPSD_MAX_SP {
	NO_LIMIT,
	TWO_MSDU,
	FOUR_MSDU,
	SIX_MSDU
};

#define NUM_PRE_AUTH_KEY 16
#define NUM_PMKID_CACHE NUM_PRE_AUTH_KEY

/*
 *	WPA2
 */
struct wlan_bssid_ex {
	u32 Length;
	unsigned char  MacAddress[6];
	u8  Reserved[2];
	struct ndis_802_11_ssid  Ssid;
	u32 Privacy;
	s32 Rssi;
	enum NDIS_802_11_NETWORK_TYPE  NetworkTypeInUse;
	struct NDIS_802_11_CONFIGURATION  Configuration;
	enum NDIS_802_11_NETWORK_INFRASTRUCTURE  InfrastructureMode;
	NDIS_802_11_RATES_EX  SupportedRates;
	u32 IELength;
	u8  IEs[MAX_IE_SZ];	/* (timestamp, beacon interval, and capability
				 * information) */
};

#endif /* #ifndef WLAN_BSSDEF_H_ */
Commit	Line	Data
cf3e6881 AB	1	/******************************************************************************
	2	*
	3	* Copyright(c) 2007 - 2010 Realtek Corporation. All rights reserved.
	4	*
	5	* This program is free software; you can redistribute it and/or modify it
	6	* under the terms of version 2 of the GNU General Public License as
	7	* published by the Free Software Foundation.
	8	*
	9	* This program is distributed in the hope that it will be useful, but WITHOUT
	10	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	11	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	12	* more details.
	13	*
	14	* You should have received a copy of the GNU General Public License along with
	15	* this program; if not, write to the Free Software Foundation, Inc.,
	16	* 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
	17	*
	18	* Modifications for inclusion into the Linux staging tree are
	19	* Copyright(c) 2010 Larry Finger. All rights reserved.
	20	*
	21	* Contact information:
	22	* WLAN FAE <wlanfae@realtek.com>
	23	* Larry Finger <Larry.Finger@lwfinger.net>
	24	*
	25	******************************************************************************/
2865d42c LF	26	#ifndef __WLAN_BSSDEF_H__
	27	#define __WLAN_BSSDEF_H__
	28
	29	#define MAX_IE_SZ 768
	30
	31	#define NDIS_802_11_LENGTH_SSID 32
	32	#define NDIS_802_11_LENGTH_RATES 8
	33	#define NDIS_802_11_LENGTH_RATES_EX 16
	34
	35	/* Set of 8 data rates*/
	36	typedef unsigned char NDIS_802_11_RATES[NDIS_802_11_LENGTH_RATES];
	37	/* Set of 16 data rates */
	38	typedef unsigned char NDIS_802_11_RATES_EX[NDIS_802_11_LENGTH_RATES_EX];
	39
	40	struct ndis_802_11_ssid {
0593758e JM	41	u32 SsidLength;
0593758e JM	42	u8 Ssid[32];
2865d42c LF	43	};
	44
	45	enum NDIS_802_11_NETWORK_TYPE {
0593758e JM	46	Ndis802_11FH,
	47	Ndis802_11DS,
	48	Ndis802_11OFDM5,
	49	Ndis802_11OFDM24,
	50	Ndis802_11NetworkTypeMax /* not a real type, defined as an upper bound*/
2865d42c LF	51	};
	52
	53	struct NDIS_802_11_CONFIGURATION_FH {
0593758e JM	54	u32 Length; /* Length of structure */
	55	u32 HopPattern; /* As defined by 802.11, MSB set */
	56	u32 HopSet; /* to one if non-802.11 */
	57	u32 DwellTime; /* units are Kusec */
2865d42c LF	58	};
	59
	60	/*
	61	FW will only save the channel number in DSConfig.
	62	ODI Handler will convert the channel number to freq. number.
	63	*/
	64	struct NDIS_802_11_CONFIGURATION {
0593758e JM	65	u32 Length; /* Length of structure */
	66	u32 BeaconPeriod; /* units are Kusec */
	67	u32 ATIMWindow; /* units are Kusec */
	68	u32 DSConfig; /* Frequency, units are kHz */
	69	struct NDIS_802_11_CONFIGURATION_FH FHConfig;
2865d42c LF	70	};
	71
	72	enum NDIS_802_11_NETWORK_INFRASTRUCTURE {
0593758e JM	73	Ndis802_11IBSS,
	74	Ndis802_11Infrastructure,
	75	Ndis802_11AutoUnknown,
	76	Ndis802_11InfrastructureMax, /Not a real value,defined as upper bound/
	77	Ndis802_11APMode
2865d42c LF	78	};
	79
	80	struct NDIS_802_11_FIXED_IEs {
0593758e JM	81	u8 Timestamp[8];
	82	u16 BeaconInterval;
	83	u16 Capabilities;
2865d42c LF	84	};
	85
	86	/*
	87	* Length is the 4 bytes multiples of the sume of
	88	* 6 * sizeof (unsigned char) + 2 + sizeof (ndis_802_11_ssid) + sizeof (u32)
	89	* + sizeof (s32) + sizeof (NDIS_802_11_NETWORK_TYPE)
	90	* + sizeof (struct NDIS_802_11_CONFIGURATION)
	91	* + sizeof (NDIS_802_11_RATES_EX) + IELength
	92
	93	* Except the IELength, all other fields are fixed length. Therefore, we can
	94	* define a macro to present the partial sum.
	95	*/
	96
	97	struct ndis_wlan_bssid_ex {
0593758e JM	98	u32 Length;
	99	unsigned char MacAddress[6];
	100	u8 Reserved[2];
	101	struct ndis_802_11_ssid Ssid;
	102	u32 Privacy;
	103	s32 Rssi;
	104	enum NDIS_802_11_NETWORK_TYPE NetworkTypeInUse;
	105	struct NDIS_802_11_CONFIGURATION Configuration;
	106	enum NDIS_802_11_NETWORK_INFRASTRUCTURE InfrastructureMode;
	107	NDIS_802_11_RATES_EX SupportedRates;
	108	u32 IELength;
	109	/(timestamp, beacon interval, and capability information) /
	110	u8 IEs[MAX_IE_SZ];
2865d42c LF	111	};
	112
	113	enum NDIS_802_11_AUTHENTICATION_MODE {
0593758e JM	114	Ndis802_11AuthModeOpen,
	115	Ndis802_11AuthModeShared,
	116	Ndis802_11AuthModeAutoSwitch,
	117	Ndis802_11AuthModeWPA,
	118	Ndis802_11AuthModeWPAPSK,
	119	Ndis802_11AuthModeWPANone,
	120	Ndis802_11AuthModeMax /* Not a real mode, defined as upper bound */
2865d42c LF	121	};
	122
	123	enum {
0593758e JM	124	Ndis802_11WEPEnabled,
	125	Ndis802_11Encryption1Enabled = Ndis802_11WEPEnabled,
	126	Ndis802_11WEPDisabled,
	127	Ndis802_11EncryptionDisabled = Ndis802_11WEPDisabled,
	128	Ndis802_11WEPKeyAbsent,
	129	Ndis802_11Encryption1KeyAbsent = Ndis802_11WEPKeyAbsent,
	130	Ndis802_11WEPNotSupported,
	131	Ndis802_11EncryptionNotSupported = Ndis802_11WEPNotSupported,
	132	Ndis802_11Encryption2Enabled,
	133	Ndis802_11Encryption2KeyAbsent,
	134	Ndis802_11Encryption3Enabled,
	135	Ndis802_11Encryption3KeyAbsent
2865d42c LF	136	};
	137
	138	#define NDIS_802_11_AI_REQFI_CAPABILITIES 1
	139	#define NDIS_802_11_AI_REQFI_LISTENINTERVAL 2
	140	#define NDIS_802_11_AI_REQFI_CURRENTAPADDRESS 4
	141
	142	#define NDIS_802_11_AI_RESFI_CAPABILITIES 1
	143	#define NDIS_802_11_AI_RESFI_STATUSCODE 2
	144	#define NDIS_802_11_AI_RESFI_ASSOCIATIONID 4
	145
	146	struct NDIS_802_11_AI_REQFI {
0593758e JM	147	u16 Capabilities;
	148	u16 ListenInterval;
	149	unsigned char CurrentAPAddress[6];
2865d42c LF	150	};
	151
	152	struct NDIS_802_11_AI_RESFI {
0593758e JM	153	u16 Capabilities;
	154	u16 StatusCode;
	155	u16 AssociationId;
2865d42c LF	156	};
	157
	158	struct NDIS_802_11_ASSOCIATION_INFORMATION {
0593758e JM	159	u32 Length;
	160	u16 AvailableRequestFixedIEs;
	161	struct NDIS_802_11_AI_REQFI RequestFixedIEs;
	162	u32 RequestIELength;
	163	u32 OffsetRequestIEs;
	164	u16 AvailableResponseFixedIEs;
	165	struct NDIS_802_11_AI_RESFI ResponseFixedIEs;
	166	u32 ResponseIELength;
	167	u32 OffsetResponseIEs;
2865d42c LF	168	};
	169
	170	/* Key mapping keys require a BSSID*/
	171	struct NDIS_802_11_KEY {
0593758e JM	172	u32 Length; /* Length of this structure */
	173	u32 KeyIndex;
	174	u32 KeyLength; /* length of key in bytes */
	175	unsigned char BSSID[6];
	176	unsigned long long KeyRSC;
	177	u8 KeyMaterial[32]; /* variable length */
2865d42c LF	178	};
	179
	180	struct NDIS_802_11_REMOVE_KEY {
0593758e JM	181	u32 Length; /* Length of this structure */
	182	u32 KeyIndex;
	183	unsigned char BSSID[6];
2865d42c LF	184	};
	185
	186	struct NDIS_802_11_WEP {
0593758e JM	187	u32 Length; /* Length of this structure */
	188	u32 KeyIndex; /* 0 is the per-client key,
	189	* 1-N are the global keys */
	190	u32 KeyLength; /* length of key in bytes */
	191	u8 KeyMaterial[16]; /* variable length depending on above field */
2865d42c LF	192	};
	193
	194	/* mask for authentication/integrity fields */
	195	#define NDIS_802_11_AUTH_REQUEST_AUTH_FIELDS 0x0f
	196	#define NDIS_802_11_AUTH_REQUEST_REAUTH 0x01
	197	#define NDIS_802_11_AUTH_REQUEST_KEYUPDATE 0x02
	198	#define NDIS_802_11_AUTH_REQUEST_PAIRWISE_ERROR 0x06
	199	#define NDIS_802_11_AUTH_REQUEST_GROUP_ERROR 0x0E
	200
	201	/* MIC check time, 60 seconds. */
	202	#define MIC_CHECK_TIME 60000000
	203
	204	#ifndef Ndis802_11APMode
	205	#define Ndis802_11APMode (Ndis802_11InfrastructureMax+1)
	206	#endif
	207
	208	struct wlan_network {
	209	struct list_head list;
	210	int network_type; /refer to ieee80211.h for WIRELESS_11A/B/G /
	211	int fixed; /* set to fixed when not to be removed asi
	212	* site-surveying */
	213	unsigned int last_scanned; /timestamp for the network /
	214	int aid; /will only be valid when a BSS is joined. /
	215	int join_res;
	216	struct ndis_wlan_bssid_ex network; /must be the last item /
	217	};
	218
	219	enum VRTL_CARRIER_SENSE {
0593758e JM	220	DISABLE_VCS,
	221	ENABLE_VCS,
	222	AUTO_VCS
2865d42c LF	223	};
	224
	225	enum VCS_TYPE {
0593758e JM	226	NONE_VCS,
	227	RTS_CTS,
	228	CTS_TO_SELF
2865d42c LF	229	};
	230
	231	#define PWR_CAM 0
	232	#define PWR_MINPS 1
	233	#define PWR_MAXPS 2
	234	#define PWR_UAPSD 3
	235	#define PWR_VOIP 4
	236
	237	enum UAPSD_MAX_SP {
	238	NO_LIMIT,
0593758e JM	239	TWO_MSDU,
	240	FOUR_MSDU,
	241	SIX_MSDU
2865d42c LF	242	};
	243
	244	#define NUM_PRE_AUTH_KEY 16
	245	#define NUM_PMKID_CACHE NUM_PRE_AUTH_KEY
	246
	247	/*
	248	* WPA2
	249	*/
	250	struct wlan_bssid_ex {
0593758e JM	251	u32 Length;
	252	unsigned char MacAddress[6];
	253	u8 Reserved[2];
	254	struct ndis_802_11_ssid Ssid;
	255	u32 Privacy;
	256	s32 Rssi;
	257	enum NDIS_802_11_NETWORK_TYPE NetworkTypeInUse;
	258	struct NDIS_802_11_CONFIGURATION Configuration;
	259	enum NDIS_802_11_NETWORK_INFRASTRUCTURE InfrastructureMode;
	260	NDIS_802_11_RATES_EX SupportedRates;
	261	u32 IELength;
	262	u8 IEs[MAX_IE_SZ]; /* (timestamp, beacon interval, and capability
2865d42c LF	263	* information) */
	264	};
	265
	266	#endif /* #ifndef WLAN_BSSDEF_H_ */
	267