/*

 * IEEE 802.11 defines

 *

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

 * <jkmaline@cc.hut.fi>

 * Copyright (c) 2002-2003, Jouni Malinen <jkmaline@cc.hut.fi>

 * Copyright (c) 2005, Devicescape Software, Inc.

 * Copyright (c) 2006, Michael Wu <flamingice@sourmilk.net>

 *

 * 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.

 */

#ifndef IEEE80211_H

#define IEEE80211_H

#include <linux/types.h>

#include <asm/byteorder.h>

#define FCS_LEN 4

#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_SCTL_FRAG		0x000F

#define IEEE80211_SCTL_SEQ		0xFFF0

#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_BACK_REQ	0x0080

#define IEEE80211_STYPE_BACK		0x0090

#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_STYPE_QOS_DATA_CFACK		0x0090

#define IEEE80211_STYPE_QOS_DATA_CFPOLL		0x00A0

#define IEEE80211_STYPE_QOS_DATA_CFACKPOLL	0x00B0

#define IEEE80211_STYPE_QOS_NULLFUNC		0x00C0

#define IEEE80211_STYPE_QOS_CFACK		0x00D0

#define IEEE80211_STYPE_QOS_CFPOLL		0x00E0

#define IEEE80211_STYPE_QOS_CFACKPOLL		0x00F0

/* miscellaneous IEEE 802.11 constants */

#define IEEE80211_MAX_FRAG_THRESHOLD	2352

#define IEEE80211_MAX_RTS_THRESHOLD	2353

#define IEEE80211_MAX_AID		2007

#define IEEE80211_MAX_TIM_LEN		251

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

   6.2.1.1.2.

   802.11e clarifies the figure in section 7.1.2. The frame body is

   up to 2304 octets long (maximum MSDU size) plus any crypt overhead. */

#define IEEE80211_MAX_DATA_LEN		2304

/* 30 byte 4 addr hdr, 2 byte QoS, 2304 byte MSDU, 12 byte crypt, 4 byte FCS */

#define IEEE80211_MAX_FRAME_LEN		2352

#define IEEE80211_MAX_SSID_LEN		32

#define IEEE80211_MAX_MESH_ID_LEN	32

#define IEEE80211_QOS_CTL_LEN		2

#define IEEE80211_QOS_CTL_TID_MASK	0x000F

#define IEEE80211_QOS_CTL_TAG1D_MASK	0x0007

struct ieee80211_hdr {

	__le16 frame_control;

	__le16 duration_id;

	u8 addr1[6];

	u8 addr2[6];

	u8 addr3[6];

	__le16 seq_ctrl;

	u8 addr4[6];

} __attribute__ ((packed));

/**

 * ieee80211_has_tods - check if IEEE80211_FCTL_TODS is set

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_has_tods(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_TODS)) != 0;

}

/**

 * ieee80211_has_fromds - check if IEEE80211_FCTL_FROMDS is set

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_has_fromds(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_FROMDS)) != 0;

}

/**

 * ieee80211_has_a4 - check if IEEE80211_FCTL_TODS and IEEE80211_FCTL_FROMDS are set

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_has_a4(__le16 fc)

{

	__le16 tmp = cpu_to_le16(IEEE80211_FCTL_TODS | IEEE80211_FCTL_FROMDS);

	return (fc & tmp) == tmp;

}

/**

 * ieee80211_has_morefrags - check if IEEE80211_FCTL_MOREFRAGS is set

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_has_morefrags(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_MOREFRAGS)) != 0;

}

/**

 * ieee80211_has_retry - check if IEEE80211_FCTL_RETRY is set

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_has_retry(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_RETRY)) != 0;

}

/**

 * ieee80211_has_pm - check if IEEE80211_FCTL_PM is set

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_has_pm(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_PM)) != 0;

}

/**

 * ieee80211_has_moredata - check if IEEE80211_FCTL_MOREDATA is set

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_has_moredata(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_MOREDATA)) != 0;

}

/**

 * ieee80211_has_protected - check if IEEE80211_FCTL_PROTECTED is set

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_has_protected(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_PROTECTED)) != 0;

}

/**

 * ieee80211_has_order - check if IEEE80211_FCTL_ORDER is set

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_has_order(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_ORDER)) != 0;

}

/**

 * ieee80211_is_mgmt - check if type is IEEE80211_FTYPE_MGMT

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_is_mgmt(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_FTYPE)) ==

	       cpu_to_le16(IEEE80211_FTYPE_MGMT);

}

/**

 * ieee80211_is_ctl - check if type is IEEE80211_FTYPE_CTL

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_is_ctl(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_FTYPE)) ==

	       cpu_to_le16(IEEE80211_FTYPE_CTL);

}

/**

 * ieee80211_is_data - check if type is IEEE80211_FTYPE_DATA

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_is_data(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_FTYPE)) ==

	       cpu_to_le16(IEEE80211_FTYPE_DATA);

}

/**

 * ieee80211_is_data_qos - check if type is IEEE80211_FTYPE_DATA and IEEE80211_STYPE_QOS_DATA is set

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_is_data_qos(__le16 fc)

{

	/*

	 * mask with QOS_DATA rather than IEEE80211_FCTL_STYPE as we just need

	 * to check the one bit

	 */

	return (fc & cpu_to_le16(IEEE80211_FCTL_FTYPE | IEEE80211_STYPE_QOS_DATA)) ==

	       cpu_to_le16(IEEE80211_FTYPE_DATA | IEEE80211_STYPE_QOS_DATA);

}

/**

 * ieee80211_is_data_present - check if type is IEEE80211_FTYPE_DATA and has data

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_is_data_present(__le16 fc)

{

	/*

	 * mask with 0x40 and test that that bit is clear to only return true

	 * for the data-containing substypes.

	 */

	return (fc & cpu_to_le16(IEEE80211_FCTL_FTYPE | 0x40)) ==

	       cpu_to_le16(IEEE80211_FTYPE_DATA);

}

/**

 * ieee80211_is_assoc_req - check if IEEE80211_FTYPE_MGMT && IEEE80211_STYPE_ASSOC_REQ

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_is_assoc_req(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_FTYPE | IEEE80211_FCTL_STYPE)) ==

	       cpu_to_le16(IEEE80211_FTYPE_MGMT | IEEE80211_STYPE_ASSOC_REQ);

}

/**

 * ieee80211_is_assoc_resp - check if IEEE80211_FTYPE_MGMT && IEEE80211_STYPE_ASSOC_RESP

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_is_assoc_resp(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_FTYPE | IEEE80211_FCTL_STYPE)) ==

	       cpu_to_le16(IEEE80211_FTYPE_MGMT | IEEE80211_STYPE_ASSOC_RESP);

}

/**

 * ieee80211_is_reassoc_req - check if IEEE80211_FTYPE_MGMT && IEEE80211_STYPE_REASSOC_REQ

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_is_reassoc_req(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_FTYPE | IEEE80211_FCTL_STYPE)) ==

	       cpu_to_le16(IEEE80211_FTYPE_MGMT | IEEE80211_STYPE_REASSOC_REQ);

}

/**

 * ieee80211_is_reassoc_resp - check if IEEE80211_FTYPE_MGMT && IEEE80211_STYPE_REASSOC_RESP

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_is_reassoc_resp(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_FTYPE | IEEE80211_FCTL_STYPE)) ==

	       cpu_to_le16(IEEE80211_FTYPE_MGMT | IEEE80211_STYPE_REASSOC_RESP);

}

/**

 * ieee80211_is_probe_req - check if IEEE80211_FTYPE_MGMT && IEEE80211_STYPE_PROBE_REQ

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_is_probe_req(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_FTYPE | IEEE80211_FCTL_STYPE)) ==

	       cpu_to_le16(IEEE80211_FTYPE_MGMT | IEEE80211_STYPE_PROBE_REQ);

}

/**

 * ieee80211_is_probe_resp - check if IEEE80211_FTYPE_MGMT && IEEE80211_STYPE_PROBE_RESP

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_is_probe_resp(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_FTYPE | IEEE80211_FCTL_STYPE)) ==

	       cpu_to_le16(IEEE80211_FTYPE_MGMT | IEEE80211_STYPE_PROBE_RESP);

}

/**

 * ieee80211_is_beacon - check if IEEE80211_FTYPE_MGMT && IEEE80211_STYPE_BEACON

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_is_beacon(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_FTYPE | IEEE80211_FCTL_STYPE)) ==

	       cpu_to_le16(IEEE80211_FTYPE_MGMT | IEEE80211_STYPE_BEACON);

}

/**

 * ieee80211_is_atim - check if IEEE80211_FTYPE_MGMT && IEEE80211_STYPE_ATIM

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_is_atim(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_FTYPE | IEEE80211_FCTL_STYPE)) ==

	       cpu_to_le16(IEEE80211_FTYPE_MGMT | IEEE80211_STYPE_ATIM);

}

/**

 * ieee80211_is_disassoc - check if IEEE80211_FTYPE_MGMT && IEEE80211_STYPE_DISASSOC

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_is_disassoc(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_FTYPE | IEEE80211_FCTL_STYPE)) ==

	       cpu_to_le16(IEEE80211_FTYPE_MGMT | IEEE80211_STYPE_DISASSOC);

}

/**

 * ieee80211_is_auth - check if IEEE80211_FTYPE_MGMT && IEEE80211_STYPE_AUTH

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_is_auth(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_FTYPE | IEEE80211_FCTL_STYPE)) ==

	       cpu_to_le16(IEEE80211_FTYPE_MGMT | IEEE80211_STYPE_AUTH);

}

/**

 * ieee80211_is_deauth - check if IEEE80211_FTYPE_MGMT && IEEE80211_STYPE_DEAUTH

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_is_deauth(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_FTYPE | IEEE80211_FCTL_STYPE)) ==

	       cpu_to_le16(IEEE80211_FTYPE_MGMT | IEEE80211_STYPE_DEAUTH);

}

/**

 * ieee80211_is_action - check if IEEE80211_FTYPE_MGMT && IEEE80211_STYPE_ACTION

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_is_action(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_FTYPE | IEEE80211_FCTL_STYPE)) ==

	       cpu_to_le16(IEEE80211_FTYPE_MGMT | IEEE80211_STYPE_ACTION);

}

/**

 * ieee80211_is_back_req - check if IEEE80211_FTYPE_CTL && IEEE80211_STYPE_BACK_REQ

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_is_back_req(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_FTYPE | IEEE80211_FCTL_STYPE)) ==

	       cpu_to_le16(IEEE80211_FTYPE_CTL | IEEE80211_STYPE_BACK_REQ);

}

/**

 * ieee80211_is_back - check if IEEE80211_FTYPE_CTL && IEEE80211_STYPE_BACK

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_is_back(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_FTYPE | IEEE80211_FCTL_STYPE)) ==

	       cpu_to_le16(IEEE80211_FTYPE_CTL | IEEE80211_STYPE_BACK);

}

/**

 * ieee80211_is_pspoll - check if IEEE80211_FTYPE_CTL && IEEE80211_STYPE_PSPOLL

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_is_pspoll(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_FTYPE | IEEE80211_FCTL_STYPE)) ==

	       cpu_to_le16(IEEE80211_FTYPE_CTL | IEEE80211_STYPE_PSPOLL);

}

/**

 * ieee80211_is_rts - check if IEEE80211_FTYPE_CTL && IEEE80211_STYPE_RTS

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_is_rts(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_FTYPE | IEEE80211_FCTL_STYPE)) ==

	       cpu_to_le16(IEEE80211_FTYPE_CTL | IEEE80211_STYPE_RTS);

}

/**

 * ieee80211_is_cts - check if IEEE80211_FTYPE_CTL && IEEE80211_STYPE_CTS

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_is_cts(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_FTYPE | IEEE80211_FCTL_STYPE)) ==

	       cpu_to_le16(IEEE80211_FTYPE_CTL | IEEE80211_STYPE_CTS);

}

/**

 * ieee80211_is_ack - check if IEEE80211_FTYPE_CTL && IEEE80211_STYPE_ACK

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_is_ack(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_FTYPE | IEEE80211_FCTL_STYPE)) ==

	       cpu_to_le16(IEEE80211_FTYPE_CTL | IEEE80211_STYPE_ACK);

}

/**

 * ieee80211_is_cfend - check if IEEE80211_FTYPE_CTL && IEEE80211_STYPE_CFEND

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_is_cfend(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_FTYPE | IEEE80211_FCTL_STYPE)) ==

	       cpu_to_le16(IEEE80211_FTYPE_CTL | IEEE80211_STYPE_CFEND);

}

/**

 * ieee80211_is_cfendack - check if IEEE80211_FTYPE_CTL && IEEE80211_STYPE_CFENDACK

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_is_cfendack(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_FTYPE | IEEE80211_FCTL_STYPE)) ==

	       cpu_to_le16(IEEE80211_FTYPE_CTL | IEEE80211_STYPE_CFENDACK);

}

/**

 * ieee80211_is_nullfunc - check if FTYPE=IEEE80211_FTYPE_DATA and STYPE=IEEE80211_STYPE_NULLFUNC

 * @fc: frame control bytes in little-endian byteorder

 */

static inline int ieee80211_is_nullfunc(__le16 fc)

{

	return (fc & cpu_to_le16(IEEE80211_FCTL_FTYPE | IEEE80211_FCTL_STYPE)) ==

	       cpu_to_le16(IEEE80211_FTYPE_DATA | IEEE80211_STYPE_NULLFUNC);

}

struct ieee80211s_hdr {

	u8 flags;

	u8 ttl;

	__le32 seqnum;

	u8 eaddr1[6];

	u8 eaddr2[6];

	u8 eaddr3[6];

} __attribute__ ((packed));

/* Mesh flags */

#define MESH_FLAGS_AE_A4 	0x1

#define MESH_FLAGS_AE_A5_A6	0x2

#define MESH_FLAGS_PS_DEEP	0x4

/**

 * struct ieee80211_quiet_ie

 *

 * This structure refers to "Quiet information element"

 */

struct ieee80211_quiet_ie {

	u8 count;

	u8 period;

	__le16 duration;

	__le16 offset;

} __attribute__ ((packed));

/**

 * struct ieee80211_msrment_ie

 *

 * This structure refers to "Measurement Request/Report information element"

 */

struct ieee80211_msrment_ie {

	u8 token;

	u8 mode;

	u8 type;

	u8 request[0];

} __attribute__ ((packed));

/**

 * struct ieee80211_channel_sw_ie

 *

 * This structure refers to "Channel Switch Announcement information element"

 */

struct ieee80211_channel_sw_ie {

	u8 mode;

	u8 new_ch_num;

	u8 count;

} __attribute__ ((packed));

/**

 * struct ieee80211_tim

 *

 * This structure refers to "Traffic Indication Map information element"

 */

struct ieee80211_tim_ie {

	u8 dtim_count;

	u8 dtim_period;

	u8 bitmap_ctrl;

	/* variable size: 1 - 251 bytes */

	u8 virtual_map[0];

} __attribute__ ((packed));

struct ieee80211_mgmt {

	__le16 frame_control;

	__le16 duration;