/*

 * Merged with mainline ieee80211.h in Aug 2004.  Original ieee802_11

 * remains copyright by the original authors

 *

 * Portions of the merged code are based on Host AP (software wireless

 * LAN access point) driver for Intersil Prism2/2.5/3.

 *

 * Copyright (c) 2001-2002, SSH Communications Security Corp and Jouni Malinen

 * <j@w1.fi>

 * Copyright (c) 2002-2003, Jouni Malinen <j@w1.fi>

 *

 * Adaption to a generic IEEE 802.11 stack by James Ketrenos

 * <jketreno@linux.intel.com>

 * Copyright (c) 2004-2005, Intel Corporation

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License version 2 as

 * published by the Free Software Foundation. See README and COPYING for

 * more details.

 *

 * API Version History

 * 1.0.x -- Initial version

 * 1.1.x -- Added radiotap, QoS, TIM, ieee80211_geo APIs,

 *          various structure changes, and crypto API init method

 */

#ifndef IEEE80211_H

#define IEEE80211_H

#include <linux/if_ether.h>	/* ETH_ALEN */

#include <linux/kernel.h>	/* ARRAY_SIZE */

#include <linux/wireless.h>

#define IEEE80211_VERSION "git-1.1.13"

#define IEEE80211_DATA_LEN		2304

/* Maximum size for the MA-UNITDATA primitive, 802.11 standard section

   6.2.1.1.2.

   The figure in section 7.1.2 suggests a body size of up to 2312

   bytes is allowed, which is a bit confusing, I suspect this

   represents the 2304 bytes of real data, plus a possible 8 bytes of

   WEP IV and ICV. (this interpretation suggested by Ramiro Barreiro) */

#define IEEE80211_1ADDR_LEN 10

#define IEEE80211_2ADDR_LEN 16

#define IEEE80211_3ADDR_LEN 24

#define IEEE80211_4ADDR_LEN 30

#define IEEE80211_FCS_LEN    4

#define IEEE80211_HLEN			(IEEE80211_4ADDR_LEN)

#define IEEE80211_FRAME_LEN		(IEEE80211_DATA_LEN + IEEE80211_HLEN)

#define MIN_FRAG_THRESHOLD     256U

#define	MAX_FRAG_THRESHOLD     2346U

/* Frame control field constants */

#define IEEE80211_FCTL_VERS		0x0003

#define IEEE80211_FCTL_FTYPE		0x000c

#define IEEE80211_FCTL_STYPE		0x00f0

#define IEEE80211_FCTL_TODS		0x0100

#define IEEE80211_FCTL_FROMDS		0x0200

#define IEEE80211_FCTL_MOREFRAGS	0x0400

#define IEEE80211_FCTL_RETRY		0x0800

#define IEEE80211_FCTL_PM		0x1000

#define IEEE80211_FCTL_MOREDATA		0x2000

#define IEEE80211_FCTL_PROTECTED	0x4000

#define IEEE80211_FCTL_ORDER		0x8000

#define IEEE80211_FTYPE_MGMT		0x0000

#define IEEE80211_FTYPE_CTL		0x0004

#define IEEE80211_FTYPE_DATA		0x0008

/* management */

#define IEEE80211_STYPE_ASSOC_REQ	0x0000

#define IEEE80211_STYPE_ASSOC_RESP 	0x0010

#define IEEE80211_STYPE_REASSOC_REQ	0x0020

#define IEEE80211_STYPE_REASSOC_RESP	0x0030

#define IEEE80211_STYPE_PROBE_REQ	0x0040

#define IEEE80211_STYPE_PROBE_RESP	0x0050

#define IEEE80211_STYPE_BEACON		0x0080

#define IEEE80211_STYPE_ATIM		0x0090

#define IEEE80211_STYPE_DISASSOC	0x00A0

#define IEEE80211_STYPE_AUTH		0x00B0

#define IEEE80211_STYPE_DEAUTH		0x00C0

#define IEEE80211_STYPE_ACTION		0x00D0

/* control */

#define IEEE80211_STYPE_PSPOLL		0x00A0

#define IEEE80211_STYPE_RTS		0x00B0

#define IEEE80211_STYPE_CTS		0x00C0

#define IEEE80211_STYPE_ACK		0x00D0

#define IEEE80211_STYPE_CFEND		0x00E0

#define IEEE80211_STYPE_CFENDACK	0x00F0

/* data */

#define IEEE80211_STYPE_DATA		0x0000

#define IEEE80211_STYPE_DATA_CFACK	0x0010

#define IEEE80211_STYPE_DATA_CFPOLL	0x0020

#define IEEE80211_STYPE_DATA_CFACKPOLL	0x0030

#define IEEE80211_STYPE_NULLFUNC	0x0040

#define IEEE80211_STYPE_CFACK		0x0050

#define IEEE80211_STYPE_CFPOLL		0x0060

#define IEEE80211_STYPE_CFACKPOLL	0x0070

#define IEEE80211_STYPE_QOS_DATA        0x0080

#define IEEE80211_SCTL_FRAG		0x000F

#define IEEE80211_SCTL_SEQ		0xFFF0

/* QOS control */

#define IEEE80211_QCTL_TID		0x000F

/* debug macros */

#ifdef CONFIG_IEEE80211_DEBUG

extern u32 ieee80211_debug_level;

#define IEEE80211_DEBUG(level, fmt, args...) \

do { if (ieee80211_debug_level & (level)) \

  printk(KERN_DEBUG "ieee80211: %c %s " fmt, \

         in_interrupt() ? 'I' : 'U', __func__ , ## args); } while (0)

static inline bool ieee80211_ratelimit_debug(u32 level)

{

	return (ieee80211_debug_level & level) && net_ratelimit();

}

#else

#define IEEE80211_DEBUG(level, fmt, args...) do {} while (0)

static inline bool ieee80211_ratelimit_debug(u32 level)

{

	return false;

}

#endif				/* CONFIG_IEEE80211_DEBUG */

/*

 * To use the debug system:

 *

 * If you are defining a new debug classification, simply add it to the #define

 * list here in the form of:

 *

 * #define IEEE80211_DL_xxxx VALUE

 *

 * shifting value to the left one bit from the previous entry.  xxxx should be

 * the name of the classification (for example, WEP)

 *

 * You then need to either add a IEEE80211_xxxx_DEBUG() macro definition for your

 * classification, or use IEEE80211_DEBUG(IEEE80211_DL_xxxx, ...) whenever you want

 * to send output to that classification.

 *

 * To add your debug level to the list of levels seen when you perform

 *

 * % cat /proc/net/ieee80211/debug_level

 *

 * you simply need to add your entry to the ieee80211_debug_level array.

 *

 * If you do not see debug_level in /proc/net/ieee80211 then you do not have

 * CONFIG_IEEE80211_DEBUG defined in your kernel configuration

 *

 */

#define IEEE80211_DL_INFO          (1<<0)

#define IEEE80211_DL_WX            (1<<1)

#define IEEE80211_DL_SCAN          (1<<2)

#define IEEE80211_DL_STATE         (1<<3)

#define IEEE80211_DL_MGMT          (1<<4)

#define IEEE80211_DL_FRAG          (1<<5)

#define IEEE80211_DL_DROP          (1<<7)

#define IEEE80211_DL_TX            (1<<8)

#define IEEE80211_DL_RX            (1<<9)

#define IEEE80211_DL_QOS           (1<<31)

#define IEEE80211_ERROR(f, a...) printk(KERN_ERR "ieee80211: " f, ## a)

#define IEEE80211_WARNING(f, a...) printk(KERN_WARNING "ieee80211: " f, ## a)

#define IEEE80211_DEBUG_INFO(f, a...)   IEEE80211_DEBUG(IEEE80211_DL_INFO, f, ## a)

#define IEEE80211_DEBUG_WX(f, a...)     IEEE80211_DEBUG(IEEE80211_DL_WX, f, ## a)

#define IEEE80211_DEBUG_SCAN(f, a...)   IEEE80211_DEBUG(IEEE80211_DL_SCAN, f, ## a)

#define IEEE80211_DEBUG_STATE(f, a...)  IEEE80211_DEBUG(IEEE80211_DL_STATE, f, ## a)

#define IEEE80211_DEBUG_MGMT(f, a...)  IEEE80211_DEBUG(IEEE80211_DL_MGMT, f, ## a)

#define IEEE80211_DEBUG_FRAG(f, a...)  IEEE80211_DEBUG(IEEE80211_DL_FRAG, f, ## a)

#define IEEE80211_DEBUG_DROP(f, a...)  IEEE80211_DEBUG(IEEE80211_DL_DROP, f, ## a)

#define IEEE80211_DEBUG_TX(f, a...)  IEEE80211_DEBUG(IEEE80211_DL_TX, f, ## a)

#define IEEE80211_DEBUG_RX(f, a...)  IEEE80211_DEBUG(IEEE80211_DL_RX, f, ## a)

#define IEEE80211_DEBUG_QOS(f, a...)  IEEE80211_DEBUG(IEEE80211_DL_QOS, f, ## a)

#include <linux/netdevice.h>

#include <linux/if_arp.h>	/* ARPHRD_ETHER */

#ifndef WIRELESS_SPY

#define WIRELESS_SPY		/* enable iwspy support */

#endif

#include <net/iw_handler.h>	/* new driver API */

#define ETH_P_PREAUTH 0x88C7	/* IEEE 802.11i pre-authentication */

#ifndef ETH_P_80211_RAW

#define ETH_P_80211_RAW (ETH_P_ECONET + 1)

#endif

/* IEEE 802.11 defines */

#define P80211_OUI_LEN 3

struct ieee80211_snap_hdr {

	u8 dsap;		/* always 0xAA */

	u8 ssap;		/* always 0xAA */

	u8 ctrl;		/* always 0x03 */

	u8 oui[P80211_OUI_LEN];	/* organizational universal id */

} __attribute__ ((packed));

#define SNAP_SIZE sizeof(struct ieee80211_snap_hdr)

#define WLAN_FC_GET_VERS(fc) ((fc) & IEEE80211_FCTL_VERS)

#define WLAN_FC_GET_TYPE(fc) ((fc) & IEEE80211_FCTL_FTYPE)

#define WLAN_FC_GET_STYPE(fc) ((fc) & IEEE80211_FCTL_STYPE)

#define WLAN_GET_SEQ_FRAG(seq) ((seq) & IEEE80211_SCTL_FRAG)

#define WLAN_GET_SEQ_SEQ(seq)  (((seq) & IEEE80211_SCTL_SEQ) >> 4)

/* Action categories - 802.11h */

enum ieee80211_actioncategories {

	WLAN_ACTION_SPECTRUM_MGMT = 0,

	/* Reserved 1-127  */

	/* Error    128-255 */

};

/* Action details - 802.11h */

enum ieee80211_actiondetails {

	WLAN_ACTION_CATEGORY_MEASURE_REQUEST = 0,

	WLAN_ACTION_CATEGORY_MEASURE_REPORT = 1,

	WLAN_ACTION_CATEGORY_TPC_REQUEST = 2,

	WLAN_ACTION_CATEGORY_TPC_REPORT = 3,

	WLAN_ACTION_CATEGORY_CHANNEL_SWITCH = 4,

	/* 5 - 255 Reserved */

};

#define IEEE80211_STATMASK_SIGNAL (1<<0)

#define IEEE80211_STATMASK_RSSI (1<<1)

#define IEEE80211_STATMASK_NOISE (1<<2)

#define IEEE80211_STATMASK_RATE (1<<3)

#define IEEE80211_STATMASK_WEMASK 0x7

#define IEEE80211_CCK_MODULATION    (1<<0)

#define IEEE80211_OFDM_MODULATION   (1<<1)

#define IEEE80211_24GHZ_BAND     (1<<0)

#define IEEE80211_52GHZ_BAND     (1<<1)

#define IEEE80211_CCK_RATE_1MB		        0x02

#define IEEE80211_CCK_RATE_2MB		        0x04

#define IEEE80211_CCK_RATE_5MB		        0x0B

#define IEEE80211_CCK_RATE_11MB		        0x16

#define IEEE80211_OFDM_RATE_6MB		        0x0C

#define IEEE80211_OFDM_RATE_9MB		        0x12

#define IEEE80211_OFDM_RATE_12MB		0x18

#define IEEE80211_OFDM_RATE_18MB		0x24

#define IEEE80211_OFDM_RATE_24MB		0x30

#define IEEE80211_OFDM_RATE_36MB		0x48

#define IEEE80211_OFDM_RATE_48MB		0x60

#define IEEE80211_OFDM_RATE_54MB		0x6C

#define IEEE80211_BASIC_RATE_MASK		0x80

#define IEEE80211_CCK_RATE_1MB_MASK		(1<<0)

#define IEEE80211_CCK_RATE_2MB_MASK		(1<<1)

#define IEEE80211_CCK_RATE_5MB_MASK		(1<<2)

#define IEEE80211_CCK_RATE_11MB_MASK		(1<<3)

#define IEEE80211_OFDM_RATE_6MB_MASK		(1<<4)

#define IEEE80211_OFDM_RATE_9MB_MASK		(1<<5)

#define IEEE80211_OFDM_RATE_12MB_MASK		(1<<6)

#define IEEE80211_OFDM_RATE_18MB_MASK		(1<<7)

#define IEEE80211_OFDM_RATE_24MB_MASK		(1<<8)

#define IEEE80211_OFDM_RATE_36MB_MASK		(1<<9)

#define IEEE80211_OFDM_RATE_48MB_MASK		(1<<10)

#define IEEE80211_OFDM_RATE_54MB_MASK		(1<<11)

#define IEEE80211_CCK_RATES_MASK	        0x0000000F

#define IEEE80211_CCK_BASIC_RATES_MASK	(IEEE80211_CCK_RATE_1MB_MASK | \

	IEEE80211_CCK_RATE_2MB_MASK)

#define IEEE80211_CCK_DEFAULT_RATES_MASK	(IEEE80211_CCK_BASIC_RATES_MASK | \

        IEEE80211_CCK_RATE_5MB_MASK | \

        IEEE80211_CCK_RATE_11MB_MASK)

#define IEEE80211_OFDM_RATES_MASK		0x00000FF0

#define IEEE80211_OFDM_BASIC_RATES_MASK	(IEEE80211_OFDM_RATE_6MB_MASK | \

	IEEE80211_OFDM_RATE_12MB_MASK | \

	IEEE80211_OFDM_RATE_24MB_MASK)

#define IEEE80211_OFDM_DEFAULT_RATES_MASK	(IEEE80211_OFDM_BASIC_RATES_MASK | \

	IEEE80211_OFDM_RATE_9MB_MASK  | \

	IEEE80211_OFDM_RATE_18MB_MASK | \

	IEEE80211_OFDM_RATE_36MB_MASK | \

	IEEE80211_OFDM_RATE_48MB_MASK | \

	IEEE80211_OFDM_RATE_54MB_MASK)

#define IEEE80211_DEFAULT_RATES_MASK (IEEE80211_OFDM_DEFAULT_RATES_MASK | \

                                IEEE80211_CCK_DEFAULT_RATES_MASK)

#define IEEE80211_NUM_OFDM_RATES	    8

#define IEEE80211_NUM_CCK_RATES	            4

#define IEEE80211_OFDM_SHIFT_MASK_A         4

/* NOTE: This data is for statistical purposes; not all hardware provides this

 *       information for frames received.

 *       For ieee80211_rx_mgt, you need to set at least the 'len' parameter.

 */

struct ieee80211_rx_stats {

	u32 mac_time;

	s8 rssi;

	u8 signal;

	u8 noise;

	u16 rate;		/* in 100 kbps */

	u8 received_channel;

	u8 control;

	u8 mask;

	u8 freq;

	u16 len;

	u64 tsf;

	u32 beacon_time;

};

/* IEEE 802.11 requires that STA supports concurrent reception of at least

 * three fragmented frames. This define can be increased to support more

 * concurrent frames, but it should be noted that each entry can consume about

 * 2 kB of RAM and increasing cache size will slow down frame reassembly. */

#define IEEE80211_FRAG_CACHE_LEN 4

struct ieee80211_frag_entry {

	unsigned long first_frag_time;

	unsigned int seq;

	unsigned int last_frag;

	struct sk_buff *skb;

	u8 src_addr[ETH_ALEN];

	u8 dst_addr[ETH_ALEN];

};

struct ieee80211_stats {

	unsigned int tx_unicast_frames;

	unsigned int tx_multicast_frames;

	unsigned int tx_fragments;

	unsigned int tx_unicast_octets;

	unsigned int tx_multicast_octets;

	unsigned int tx_deferred_transmissions;

	unsigned int tx_single_retry_frames;

	unsigned int tx_multiple_retry_frames;

	unsigned int tx_retry_limit_exceeded;

	unsigned int tx_discards;

	unsigned int rx_unicast_frames;

	unsigned int rx_multicast_frames;

	unsigned int rx_fragments;

	unsigned int rx_unicast_octets;

	unsigned int rx_multicast_octets;

	unsigned int rx_fcs_errors;

	unsigned int rx_discards_no_buffer;

	unsigned int tx_discards_wrong_sa;

	unsigned int rx_discards_undecryptable;

	unsigned int rx_message_in_msg_fragments;

	unsigned int rx_message_in_bad_msg_fragments;

};

struct ieee80211_device;

#define SEC_KEY_1		(1<<0)

#define SEC_KEY_2		(1<<1)

#define SEC_KEY_3		(1<<2)

#define SEC_KEY_4		(1<<3)

#define SEC_ACTIVE_KEY		(1<<4)

#define SEC_AUTH_MODE		(1<<5)

#define SEC_UNICAST_GROUP	(1<<6)

#define SEC_LEVEL		(1<<7)

#define SEC_ENABLED		(1<<8)

#define SEC_ENCRYPT		(1<<9)

#define SEC_LEVEL_0		0	/* None */

#define SEC_LEVEL_1		1	/* WEP 40 and 104 bit */

#define SEC_LEVEL_2		2	/* Level 1 + TKIP */

#define SEC_LEVEL_2_CKIP	3	/* Level 1 + CKIP */

#define SEC_LEVEL_3		4	/* Level 2 + CCMP */

#define SEC_ALG_NONE		0

#define SEC_ALG_WEP		1

#define SEC_ALG_TKIP		2

#define SEC_ALG_CCMP		3

#define WEP_KEYS		4

#define WEP_KEY_LEN		13

#define SCM_KEY_LEN		32

#define SCM_TEMPORAL_KEY_LENGTH	16

struct ieee80211_security {

	u8 encode_alg[WEP_KEYS];

	u8 key_sizes[WEP_KEYS];

	u8 keys[WEP_KEYS][SCM_KEY_LEN];

	u8 level;

	u16 flags;

} __attribute__ ((packed));

/*

 802.11 data frame from AP

      ,-------------------------------------------------------------------.

Bytes |  2   |  2   |    6    |    6    |    6    |  2   | 0..2312 |   4  |

      |------|------|---------|---------|---------|------|---------|------|

Desc. | ctrl | dura |  DA/RA  |   TA    |    SA   | Sequ |  frame  |  fcs |

      |      | tion | (BSSID) |         |         | ence |  data   |      |

      `-------------------------------------------------------------------'

Total: 28-2340 bytes

*/

#define BEACON_PROBE_SSID_ID_POSITION 12

/* Management Frame Information Element Types */

enum ieee80211_mfie {

	MFIE_TYPE_SSID = 0,

	MFIE_TYPE_RATES = 1,

	MFIE_TYPE_FH_SET = 2,

	MFIE_TYPE_DS_SET = 3,

	MFIE_TYPE_CF_SET = 4,

	MFIE_TYPE_TIM = 5,

	MFIE_TYPE_IBSS_SET = 6,

	MFIE_TYPE_COUNTRY = 7,

	MFIE_TYPE_HOP_PARAMS = 8,

	MFIE_TYPE_HOP_TABLE = 9,

	MFIE_TYPE_REQUEST = 10,

	MFIE_TYPE_CHALLENGE = 16,

	MFIE_TYPE_POWER_CONSTRAINT = 32,

	MFIE_TYPE_POWER_CAPABILITY = 33,

	MFIE_TYPE_TPC_REQUEST = 34,

	MFIE_TYPE_TPC_REPORT = 35,

	MFIE_TYPE_SUPP_CHANNELS = 36,

	MFIE_TYPE_CSA = 37,

	MFIE_TYPE_MEASURE_REQUEST = 38,

	MFIE_TYPE_MEASURE_REPORT = 39,

	MFIE_TYPE_QUIET = 40,

	MFIE_TYPE_IBSS_DFS = 41,

	MFIE_TYPE_ERP_INFO = 42,

	MFIE_TYPE_RSN = 48,

	MFIE_TYPE_RATES_EX = 50,

	MFIE_TYPE_GENERIC = 221,

	MFIE_TYPE_QOS_PARAMETER = 222,

};

struct ieee80211_hdr_1addr {

	__le16 frame_ctl;

	__le16 duration_id;

	u8 addr1[ETH_ALEN];

	u8 payload[0];

} __attribute__ ((packed));

struct ieee80211_hdr_2addr {

	__le16 frame_ctl;

	__le16 duration_id;

	u8 addr1[ETH_ALEN];

	u8 addr2[ETH_ALEN];

	u8 payload[0];

} __attribute__ ((packed));

struct ieee80211_hdr_3addr {

	__le16 frame_ctl;

	__le16 duration_id;

	u8 addr1[ETH_ALEN];

	u8 addr2[ETH_ALEN];

	u8 addr3[ETH_ALEN];

	__le16 seq_ctl;

	u8 payload[0];

} __attribute__ ((packed));

struct ieee80211_hdr_4addr {

	__le16 frame_ctl;

	__le16 duration_id;

	u8 addr1[ETH_ALEN];

	u8 addr2[ETH_ALEN];

	u8 addr3[ETH_ALEN];

	__le16 seq_ctl;

	u8 addr4[ETH_ALEN];

	u8 payload[0];

} __attribute__ ((packed));

struct ieee80211_hdr_3addrqos {

	__le16 frame_ctl;

	__le16 duration_id;

	u8 addr1[ETH_ALEN];

	u8 addr2[ETH_ALEN];

	u8 addr3[ETH_ALEN];

	__le16 seq_ctl;

	u8 payload[0];

	__le16 qos_ctl;

} __attribute__ ((packed));

struct ieee80211_info_element {

	u8 id;

	u8 len;

	u8 data[0];

} __attribute__ ((packed));

/*

 * These are the data types that can make up management packets

 *

	u16 auth_algorithm;

	u16 auth_sequence;

	u16 beacon_interval;

	u16 capability;

	u8 current_ap[ETH_ALEN];

	u16 listen_interval;

	struct {

		u16 association_id:14, reserved:2;

	} __attribute__ ((packed));

	u32 time_stamp[2];

	u16 reason;

	u16 status;

*/

struct ieee80211_auth {

	struct ieee80211_hdr_3addr header;

	__le16 algorithm;

	__le16 transaction;

	__le16 status;

	/* challenge */

	struct ieee80211_info_element info_element[0];

} __attribute__ ((packed));

struct ieee80211_channel_switch {

	u8 id;

	u8 len;

	u8 mode;

	u8 channel;