[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

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;
};

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;
	u8 rates[NDIS_802_11_LENGTH_RATES_EX];
	/* number of content bytes in EIs, which varies */
	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 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

#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
2865d42c	35	struct ndis_802_11_ssid {
0593758e JM	36	u32 SsidLength;
0593758e JM	37	u8 Ssid[32];
2865d42c LF	38	};
	39
	40	enum NDIS_802_11_NETWORK_TYPE {
0593758e JM	41	Ndis802_11FH,
	42	Ndis802_11DS,
	43	Ndis802_11OFDM5,
	44	Ndis802_11OFDM24,
	45	Ndis802_11NetworkTypeMax /* not a real type, defined as an upper bound*/
2865d42c LF	46	};
	47
	48	struct NDIS_802_11_CONFIGURATION_FH {
0593758e JM	49	u32 Length; /* Length of structure */
	50	u32 HopPattern; /* As defined by 802.11, MSB set */
	51	u32 HopSet; /* to one if non-802.11 */
	52	u32 DwellTime; /* units are Kusec */
2865d42c LF	53	};
	54
	55	/*
	56	FW will only save the channel number in DSConfig.
	57	ODI Handler will convert the channel number to freq. number.
	58	*/
	59	struct NDIS_802_11_CONFIGURATION {
0593758e JM	60	u32 Length; /* Length of structure */
	61	u32 BeaconPeriod; /* units are Kusec */
	62	u32 ATIMWindow; /* units are Kusec */
	63	u32 DSConfig; /* Frequency, units are kHz */
	64	struct NDIS_802_11_CONFIGURATION_FH FHConfig;
2865d42c LF	65	};
	66
	67	enum NDIS_802_11_NETWORK_INFRASTRUCTURE {
0593758e JM	68	Ndis802_11IBSS,
	69	Ndis802_11Infrastructure,
	70	Ndis802_11AutoUnknown,
	71	Ndis802_11InfrastructureMax, /Not a real value,defined as upper bound/
	72	Ndis802_11APMode
2865d42c LF	73	};
	74
	75	struct NDIS_802_11_FIXED_IEs {
0593758e JM	76	u8 Timestamp[8];
	77	u16 BeaconInterval;
	78	u16 Capabilities;
2865d42c LF	79	};
2865d42c LF	80
44367877	81	struct wlan_bssid_ex {
0593758e JM	82	u32 Length;
	83	unsigned char MacAddress[6];
	84	u8 Reserved[2];
	85	struct ndis_802_11_ssid Ssid;
	86	u32 Privacy;
	87	s32 Rssi;
	88	enum NDIS_802_11_NETWORK_TYPE NetworkTypeInUse;
	89	struct NDIS_802_11_CONFIGURATION Configuration;
	90	enum NDIS_802_11_NETWORK_INFRASTRUCTURE InfrastructureMode;
7fb539ed	91	u8 rates[NDIS_802_11_LENGTH_RATES_EX];
9bdb70ec	92	/* number of content bytes in EIs, which varies */
0593758e JM	93	u32 IELength;
	94	/(timestamp, beacon interval, and capability information) /
	95	u8 IEs[MAX_IE_SZ];
2865d42c LF	96	};
	97
	98	enum NDIS_802_11_AUTHENTICATION_MODE {
0593758e JM	99	Ndis802_11AuthModeOpen,
	100	Ndis802_11AuthModeShared,
	101	Ndis802_11AuthModeAutoSwitch,
	102	Ndis802_11AuthModeWPA,
	103	Ndis802_11AuthModeWPAPSK,
	104	Ndis802_11AuthModeWPANone,
	105	Ndis802_11AuthModeMax /* Not a real mode, defined as upper bound */
2865d42c LF	106	};
	107
	108	enum {
0593758e JM	109	Ndis802_11WEPEnabled,
	110	Ndis802_11Encryption1Enabled = Ndis802_11WEPEnabled,
	111	Ndis802_11WEPDisabled,
	112	Ndis802_11EncryptionDisabled = Ndis802_11WEPDisabled,
	113	Ndis802_11WEPKeyAbsent,
	114	Ndis802_11Encryption1KeyAbsent = Ndis802_11WEPKeyAbsent,
	115	Ndis802_11WEPNotSupported,
	116	Ndis802_11EncryptionNotSupported = Ndis802_11WEPNotSupported,
	117	Ndis802_11Encryption2Enabled,
	118	Ndis802_11Encryption2KeyAbsent,
	119	Ndis802_11Encryption3Enabled,
	120	Ndis802_11Encryption3KeyAbsent
2865d42c LF	121	};
	122
	123	#define NDIS_802_11_AI_REQFI_CAPABILITIES 1
	124	#define NDIS_802_11_AI_REQFI_LISTENINTERVAL 2
	125	#define NDIS_802_11_AI_REQFI_CURRENTAPADDRESS 4
	126
	127	#define NDIS_802_11_AI_RESFI_CAPABILITIES 1
	128	#define NDIS_802_11_AI_RESFI_STATUSCODE 2
	129	#define NDIS_802_11_AI_RESFI_ASSOCIATIONID 4
	130
	131	struct NDIS_802_11_AI_REQFI {
0593758e JM	132	u16 Capabilities;
	133	u16 ListenInterval;
	134	unsigned char CurrentAPAddress[6];
2865d42c LF	135	};
	136
	137	struct NDIS_802_11_AI_RESFI {
0593758e JM	138	u16 Capabilities;
	139	u16 StatusCode;
	140	u16 AssociationId;
2865d42c LF	141	};
	142
	143	struct NDIS_802_11_ASSOCIATION_INFORMATION {
0593758e JM	144	u32 Length;
	145	u16 AvailableRequestFixedIEs;
	146	struct NDIS_802_11_AI_REQFI RequestFixedIEs;
	147	u32 RequestIELength;
	148	u32 OffsetRequestIEs;
	149	u16 AvailableResponseFixedIEs;
	150	struct NDIS_802_11_AI_RESFI ResponseFixedIEs;
	151	u32 ResponseIELength;
	152	u32 OffsetResponseIEs;
2865d42c LF	153	};
	154
	155	/* Key mapping keys require a BSSID*/
	156	struct NDIS_802_11_KEY {
0593758e JM	157	u32 Length; /* Length of this structure */
	158	u32 KeyIndex;
	159	u32 KeyLength; /* length of key in bytes */
	160	unsigned char BSSID[6];
	161	unsigned long long KeyRSC;
	162	u8 KeyMaterial[32]; /* variable length */
2865d42c LF	163	};
	164
	165	struct NDIS_802_11_REMOVE_KEY {
0593758e JM	166	u32 Length; /* Length of this structure */
	167	u32 KeyIndex;
	168	unsigned char BSSID[6];
2865d42c LF	169	};
	170
	171	struct NDIS_802_11_WEP {
0593758e JM	172	u32 Length; /* Length of this structure */
0593758e JM	173	u32 KeyIndex; /* 0 is the per-client key,
bef611a9 RB	174	* 1-N are the global keys
bef611a9 RB	175	*/
0593758e JM	176	u32 KeyLength; /* length of key in bytes */
0593758e JM	177	u8 KeyMaterial[16]; /* variable length depending on above field */
2865d42c LF	178	};
	179
	180	/* mask for authentication/integrity fields */
	181	#define NDIS_802_11_AUTH_REQUEST_AUTH_FIELDS 0x0f
	182	#define NDIS_802_11_AUTH_REQUEST_REAUTH 0x01
	183	#define NDIS_802_11_AUTH_REQUEST_KEYUPDATE 0x02
	184	#define NDIS_802_11_AUTH_REQUEST_PAIRWISE_ERROR 0x06
	185	#define NDIS_802_11_AUTH_REQUEST_GROUP_ERROR 0x0E
	186
	187	/* MIC check time, 60 seconds. */
	188	#define MIC_CHECK_TIME 60000000
	189
	190	#ifndef Ndis802_11APMode
	191	#define Ndis802_11APMode (Ndis802_11InfrastructureMax+1)
	192	#endif
	193
	194	struct wlan_network {
	195	struct list_head list;
	196	int network_type; /refer to ieee80211.h for WIRELESS_11A/B/G /
	197	int fixed; /* set to fixed when not to be removed asi
bef611a9 RB	198	* site-surveying
bef611a9 RB	199	*/
2865d42c LF	200	unsigned int last_scanned; /timestamp for the network /
	201	int aid; /will only be valid when a BSS is joined. /
	202	int join_res;
44367877	203	struct wlan_bssid_ex network; /must be the last item /
2865d42c LF	204	};
	205
	206	enum VRTL_CARRIER_SENSE {
0593758e JM	207	DISABLE_VCS,
	208	ENABLE_VCS,
	209	AUTO_VCS
2865d42c LF	210	};
	211
	212	enum VCS_TYPE {
0593758e JM	213	NONE_VCS,
	214	RTS_CTS,
	215	CTS_TO_SELF
2865d42c LF	216	};
	217
	218	#define PWR_CAM 0
	219	#define PWR_MINPS 1
	220	#define PWR_MAXPS 2
	221	#define PWR_UAPSD 3
	222	#define PWR_VOIP 4
	223
	224	enum UAPSD_MAX_SP {
	225	NO_LIMIT,
0593758e JM	226	TWO_MSDU,
	227	FOUR_MSDU,
	228	SIX_MSDU
2865d42c LF	229	};
	230
	231	#define NUM_PRE_AUTH_KEY 16
	232	#define NUM_PMKID_CACHE NUM_PRE_AUTH_KEY
	233
2865d42c LF	234	#endif /* #ifndef WLAN_BSSDEF_H_ */
2865d42c LF	235