[deliverable/linux.git] / drivers / net / wireless / mwifiex / decl.h

/*
 * Marvell Wireless LAN device driver: generic data structures and APIs
 *
 * Copyright (C) 2011-2014, Marvell International Ltd.
 *
 * This software file (the "File") is distributed by Marvell International
 * Ltd. under the terms of the GNU General Public License Version 2, June 1991
 * (the "License").  You may use, redistribute and/or modify this File in
 * accordance with the terms and conditions of the License, a copy of which
 * is available by writing to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or on the
 * worldwide web at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
 *
 * THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
 * ARE EXPRESSLY DISCLAIMED.  The License provides additional details about
 * this warranty disclaimer.
 */

#ifndef _MWIFIEX_DECL_H_
#define _MWIFIEX_DECL_H_

#undef pr_fmt
#define pr_fmt(fmt)	KBUILD_MODNAME ": " fmt

#include <linux/wait.h>
#include <linux/timer.h>
#include <linux/ieee80211.h>
#include <uapi/linux/if_arp.h>
#include <net/mac80211.h>


#define MWIFIEX_MAX_BSS_NUM         (3)

#define MWIFIEX_DMA_ALIGN_SZ	    64
#define MAX_TXPD_SZ		    32
#define INTF_HDR_ALIGN		     4

#define MWIFIEX_MIN_DATA_HEADER_LEN (MWIFIEX_DMA_ALIGN_SZ + INTF_HDR_ALIGN + \
				     MAX_TXPD_SZ)
#define MWIFIEX_MGMT_FRAME_HEADER_SIZE	8	/* sizeof(pkt_type)
						 *   + sizeof(tx_control)
						 */

#define MWIFIEX_MAX_TX_BASTREAM_SUPPORTED	2
#define MWIFIEX_MAX_RX_BASTREAM_SUPPORTED	16
#define MWIFIEX_MAX_TDLS_PEER_SUPPORTED 8

#define MWIFIEX_STA_AMPDU_DEF_TXWINSIZE        64
#define MWIFIEX_STA_AMPDU_DEF_RXWINSIZE        64
#define MWIFIEX_UAP_AMPDU_DEF_TXWINSIZE        32
#define MWIFIEX_UAP_AMPDU_DEF_RXWINSIZE        16
#define MWIFIEX_11AC_STA_AMPDU_DEF_TXWINSIZE   64
#define MWIFIEX_11AC_STA_AMPDU_DEF_RXWINSIZE   64
#define MWIFIEX_11AC_UAP_AMPDU_DEF_TXWINSIZE   64
#define MWIFIEX_11AC_UAP_AMPDU_DEF_RXWINSIZE   64

#define MWIFIEX_DEFAULT_BLOCK_ACK_TIMEOUT  0xffff

#define MWIFIEX_RATE_BITMAP_MCS0   32

#define MWIFIEX_RX_DATA_BUF_SIZE     (4 * 1024)
#define MWIFIEX_RX_CMD_BUF_SIZE	     (2 * 1024)

#define MAX_BEACON_PERIOD                  (4000)
#define MIN_BEACON_PERIOD                  (50)
#define MAX_DTIM_PERIOD                    (100)
#define MIN_DTIM_PERIOD                    (1)

#define MWIFIEX_RTS_MIN_VALUE              (0)
#define MWIFIEX_RTS_MAX_VALUE              (2347)
#define MWIFIEX_FRAG_MIN_VALUE             (256)
#define MWIFIEX_FRAG_MAX_VALUE             (2346)
#define MWIFIEX_WMM_VERSION                0x01
#define MWIFIEX_WMM_SUBTYPE                0x01

#define MWIFIEX_RETRY_LIMIT                14
#define MWIFIEX_SDIO_BLOCK_SIZE            256

#define MWIFIEX_BUF_FLAG_REQUEUED_PKT      BIT(0)
#define MWIFIEX_BUF_FLAG_BRIDGED_PKT	   BIT(1)
#define MWIFIEX_BUF_FLAG_TDLS_PKT	   BIT(2)
#define MWIFIEX_BUF_FLAG_EAPOL_TX_STATUS   BIT(3)
#define MWIFIEX_BUF_FLAG_ACTION_TX_STATUS  BIT(4)

#define MWIFIEX_BRIDGED_PKTS_THR_HIGH      1024
#define MWIFIEX_BRIDGED_PKTS_THR_LOW        128

#define MWIFIEX_TDLS_DISABLE_LINK             0x00
#define MWIFIEX_TDLS_ENABLE_LINK              0x01
#define MWIFIEX_TDLS_CREATE_LINK              0x02
#define MWIFIEX_TDLS_CONFIG_LINK              0x03

#define MWIFIEX_TDLS_RSSI_HIGH		50
#define MWIFIEX_TDLS_RSSI_LOW		55
#define MWIFIEX_TDLS_MAX_FAIL_COUNT      4
#define MWIFIEX_AUTO_TDLS_IDLE_TIME     10

/* 54M rates, index from 0 to 11 */
#define MWIFIEX_RATE_INDEX_MCS0 12
/* 12-27=MCS0-15(BW20) */
#define MWIFIEX_BW20_MCS_NUM 15

/* Rate index for OFDM 0 */
#define MWIFIEX_RATE_INDEX_OFDM0   4

enum mwifiex_bss_type {
	MWIFIEX_BSS_TYPE_STA = 0,
	MWIFIEX_BSS_TYPE_UAP = 1,
	MWIFIEX_BSS_TYPE_P2P = 2,
	MWIFIEX_BSS_TYPE_ANY = 0xff,
};

enum mwifiex_bss_role {
	MWIFIEX_BSS_ROLE_STA = 0,
	MWIFIEX_BSS_ROLE_UAP = 1,
	MWIFIEX_BSS_ROLE_ANY = 0xff,
};

enum mwifiex_tdls_status {
	TDLS_NOT_SETUP = 0,
	TDLS_SETUP_INPROGRESS,
	TDLS_SETUP_COMPLETE,
	TDLS_SETUP_FAILURE,
	TDLS_LINK_TEARDOWN,
};

enum mwifiex_tdls_error_code {
	TDLS_ERR_NO_ERROR = 0,
	TDLS_ERR_INTERNAL_ERROR,
	TDLS_ERR_MAX_LINKS_EST,
	TDLS_ERR_LINK_EXISTS,
	TDLS_ERR_LINK_NONEXISTENT,
	TDLS_ERR_PEER_STA_UNREACHABLE = 25,
};

#define BSS_ROLE_BIT_MASK    BIT(0)

#define GET_BSS_ROLE(priv)   ((priv)->bss_role & BSS_ROLE_BIT_MASK)

enum mwifiex_data_frame_type {
	MWIFIEX_DATA_FRAME_TYPE_ETH_II = 0,
	MWIFIEX_DATA_FRAME_TYPE_802_11,
};

struct mwifiex_fw_image {
	u8 *helper_buf;
	u32 helper_len;
	u8 *fw_buf;
	u32 fw_len;
};

struct mwifiex_802_11_ssid {
	u32 ssid_len;
	u8 ssid[IEEE80211_MAX_SSID_LEN];
};

struct mwifiex_wait_queue {
	wait_queue_head_t wait;
	int status;
};

struct mwifiex_rxinfo {
	u8 bss_num;
	u8 bss_type;
	struct sk_buff *parent;
	u8 use_count;
};

struct mwifiex_txinfo {
	u32 status_code;
	u8 flags;
	u8 bss_num;
	u8 bss_type;
	u32 pkt_len;
	u8 ack_frame_id;
	u64 cookie;
};

enum mwifiex_wmm_ac_e {
	WMM_AC_BK,
	WMM_AC_BE,
	WMM_AC_VI,
	WMM_AC_VO
} __packed;

struct ieee_types_wmm_ac_parameters {
	u8 aci_aifsn_bitmap;
	u8 ecw_bitmap;
	__le16 tx_op_limit;
} __packed;

struct mwifiex_types_wmm_info {
	u8 oui[4];
	u8 subtype;
	u8 version;
	u8 qos_info;
	u8 reserved;
	struct ieee_types_wmm_ac_parameters ac_params[IEEE80211_NUM_ACS];
} __packed;

struct mwifiex_arp_eth_header {
	struct arphdr hdr;
	u8 ar_sha[ETH_ALEN];
	u8 ar_sip[4];
	u8 ar_tha[ETH_ALEN];
	u8 ar_tip[4];
} __packed;

struct mwifiex_chan_stats {
	u8 chan_num;
	u8 bandcfg;
	u8 flags;
	s8 noise;
	u16 total_bss;
	u16 cca_scan_dur;
	u16 cca_busy_dur;
} __packed;

#define MWIFIEX_HIST_MAX_SAMPLES	1048576
#define MWIFIEX_MAX_RX_RATES		     44
#define MWIFIEX_MAX_AC_RX_RATES		     74
#define MWIFIEX_MAX_SNR			    256
#define MWIFIEX_MAX_NOISE_FLR		    256
#define MWIFIEX_MAX_SIG_STRENGTH	    256

struct mwifiex_histogram_data {
	atomic_t rx_rate[MWIFIEX_MAX_AC_RX_RATES];
	atomic_t snr[MWIFIEX_MAX_SNR];
	atomic_t noise_flr[MWIFIEX_MAX_NOISE_FLR];
	atomic_t sig_str[MWIFIEX_MAX_SIG_STRENGTH];
	atomic_t num_samples;
};

#endif /* !_MWIFIEX_DECL_H_ */
Commit	Line	Data
5e6e3a92 BZ	1	/*
	2	* Marvell Wireless LAN device driver: generic data structures and APIs
	3	*
65da33f5	4	* Copyright (C) 2011-2014, Marvell International Ltd.
5e6e3a92 BZ	5	*
	6	* This software file (the "File") is distributed by Marvell International
	7	* Ltd. under the terms of the GNU General Public License Version 2, June 1991
	8	* (the "License"). You may use, redistribute and/or modify this File in
	9	* accordance with the terms and conditions of the License, a copy of which
	10	* is available by writing to the Free Software Foundation, Inc.,
	11	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or on the
	12	* worldwide web at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
	13	*
	14	* THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE
	15	* IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
	16	* ARE EXPRESSLY DISCLAIMED. The License provides additional details about
	17	* this warranty disclaimer.
	18	*/
	19
	20	#ifndef _MWIFIEX_DECL_H_
	21	#define _MWIFIEX_DECL_H_
	22
	23	#undef pr_fmt
	24	#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
	25
	26	#include <linux/wait.h>
	27	#include <linux/timer.h>
	28	#include <linux/ieee80211.h>
587b36d3	29	#include <uapi/linux/if_arp.h>
54428c57	30	#include <net/mac80211.h>
5e6e3a92 BZ	31
5e6e3a92 BZ	32
197f4a2e	33	#define MWIFIEX_MAX_BSS_NUM (3)
5e6e3a92	34
84b313b3 XH	35	#define MWIFIEX_DMA_ALIGN_SZ 64
	36	#define MAX_TXPD_SZ 32
	37	#define INTF_HDR_ALIGN 4
	38
	39	#define MWIFIEX_MIN_DATA_HEADER_LEN (MWIFIEX_DMA_ALIGN_SZ + INTF_HDR_ALIGN + \
	40	MAX_TXPD_SZ)
e39faa73 SP	41	#define MWIFIEX_MGMT_FRAME_HEADER_SIZE 8 /* sizeof(pkt_type)
	42	* + sizeof(tx_control)
	43	*/
5e6e3a92 BZ	44
	45	#define MWIFIEX_MAX_TX_BASTREAM_SUPPORTED 2
	46	#define MWIFIEX_MAX_RX_BASTREAM_SUPPORTED 16
72df6310	47	#define MWIFIEX_MAX_TDLS_PEER_SUPPORTED 8
5e6e3a92	48
42e37272 AK	49	#define MWIFIEX_STA_AMPDU_DEF_TXWINSIZE 64
42e37272 AK	50	#define MWIFIEX_STA_AMPDU_DEF_RXWINSIZE 64
04abc0a3 AP	51	#define MWIFIEX_UAP_AMPDU_DEF_TXWINSIZE 32
04abc0a3 AP	52	#define MWIFIEX_UAP_AMPDU_DEF_RXWINSIZE 16
258ed9f0 AK	53	#define MWIFIEX_11AC_STA_AMPDU_DEF_TXWINSIZE 64
258ed9f0 AK	54	#define MWIFIEX_11AC_STA_AMPDU_DEF_RXWINSIZE 64
50398ee0 AP	55	#define MWIFIEX_11AC_UAP_AMPDU_DEF_TXWINSIZE 64
50398ee0 AP	56	#define MWIFIEX_11AC_UAP_AMPDU_DEF_RXWINSIZE 64
04abc0a3	57
5e6e3a92 BZ	58	#define MWIFIEX_DEFAULT_BLOCK_ACK_TIMEOUT 0xffff
5e6e3a92 BZ	59
5e6e3a92	60	#define MWIFIEX_RATE_BITMAP_MCS0 32
5e6e3a92 BZ	61
5e6e3a92 BZ	62	#define MWIFIEX_RX_DATA_BUF_SIZE (4 * 1024)
4daffe35	63	#define MWIFIEX_RX_CMD_BUF_SIZE (2 * 1024)
5e6e3a92	64
12190c5d AP	65	#define MAX_BEACON_PERIOD (4000)
	66	#define MIN_BEACON_PERIOD (50)
	67	#define MAX_DTIM_PERIOD (100)
	68	#define MIN_DTIM_PERIOD (1)
	69
5e6e3a92 BZ	70	#define MWIFIEX_RTS_MIN_VALUE (0)
	71	#define MWIFIEX_RTS_MAX_VALUE (2347)
	72	#define MWIFIEX_FRAG_MIN_VALUE (256)
	73	#define MWIFIEX_FRAG_MAX_VALUE (2346)
54428c57 AP	74	#define MWIFIEX_WMM_VERSION 0x01
54428c57 AP	75	#define MWIFIEX_WMM_SUBTYPE 0x01
5e6e3a92	76
9b930eae	77	#define MWIFIEX_RETRY_LIMIT 14
5e6e3a92 BZ	78	#define MWIFIEX_SDIO_BLOCK_SIZE 256
	79
	80	#define MWIFIEX_BUF_FLAG_REQUEUED_PKT BIT(0)
838e4f44	81	#define MWIFIEX_BUF_FLAG_BRIDGED_PKT BIT(1)
b23bce29	82	#define MWIFIEX_BUF_FLAG_TDLS_PKT BIT(2)
808bbebc	83	#define MWIFIEX_BUF_FLAG_EAPOL_TX_STATUS BIT(3)
18ca4382	84	#define MWIFIEX_BUF_FLAG_ACTION_TX_STATUS BIT(4)
838e4f44	85
61c87304 AP	86	#define MWIFIEX_BRIDGED_PKTS_THR_HIGH 1024
61c87304 AP	87	#define MWIFIEX_BRIDGED_PKTS_THR_LOW 128
5e6e3a92	88
429d90d2 AP	89	#define MWIFIEX_TDLS_DISABLE_LINK 0x00
	90	#define MWIFIEX_TDLS_ENABLE_LINK 0x01
	91	#define MWIFIEX_TDLS_CREATE_LINK 0x02
	92	#define MWIFIEX_TDLS_CONFIG_LINK 0x03
	93
9927baa3 AP	94	#define MWIFIEX_TDLS_RSSI_HIGH 50
	95	#define MWIFIEX_TDLS_RSSI_LOW 55
	96	#define MWIFIEX_TDLS_MAX_FAIL_COUNT 4
	97	#define MWIFIEX_AUTO_TDLS_IDLE_TIME 10
	98
cbf6e055 XH	99	/* 54M rates, index from 0 to 11 */
	100	#define MWIFIEX_RATE_INDEX_MCS0 12
	101	/* 12-27=MCS0-15(BW20) */
	102	#define MWIFIEX_BW20_MCS_NUM 15
	103
	104	/* Rate index for OFDM 0 */
	105	#define MWIFIEX_RATE_INDEX_OFDM0 4
	106
5e6e3a92 BZ	107	enum mwifiex_bss_type {
	108	MWIFIEX_BSS_TYPE_STA = 0,
	109	MWIFIEX_BSS_TYPE_UAP = 1,
197f4a2e	110	MWIFIEX_BSS_TYPE_P2P = 2,
5e6e3a92 BZ	111	MWIFIEX_BSS_TYPE_ANY = 0xff,
	112	};
	113
	114	enum mwifiex_bss_role {
	115	MWIFIEX_BSS_ROLE_STA = 0,
	116	MWIFIEX_BSS_ROLE_UAP = 1,
	117	MWIFIEX_BSS_ROLE_ANY = 0xff,
	118	};
	119
5f2caaf3 AP	120	enum mwifiex_tdls_status {
	121	TDLS_NOT_SETUP = 0,
	122	TDLS_SETUP_INPROGRESS,
	123	TDLS_SETUP_COMPLETE,
	124	TDLS_SETUP_FAILURE,
	125	TDLS_LINK_TEARDOWN,
	126	};
	127
429d90d2 AP	128	enum mwifiex_tdls_error_code {
	129	TDLS_ERR_NO_ERROR = 0,
	130	TDLS_ERR_INTERNAL_ERROR,
	131	TDLS_ERR_MAX_LINKS_EST,
	132	TDLS_ERR_LINK_EXISTS,
	133	TDLS_ERR_LINK_NONEXISTENT,
	134	TDLS_ERR_PEER_STA_UNREACHABLE = 25,
	135	};
	136
5e6e3a92 BZ	137	#define BSS_ROLE_BIT_MASK BIT(0)
	138
	139	#define GET_BSS_ROLE(priv) ((priv)->bss_role & BSS_ROLE_BIT_MASK)
	140
	141	enum mwifiex_data_frame_type {
	142	MWIFIEX_DATA_FRAME_TYPE_ETH_II = 0,
	143	MWIFIEX_DATA_FRAME_TYPE_802_11,
	144	};
	145
	146	struct mwifiex_fw_image {
	147	u8 *helper_buf;
	148	u32 helper_len;
	149	u8 *fw_buf;
	150	u32 fw_len;
	151	};
	152
12190c5d AP	153	struct mwifiex_802_11_ssid {
	154	u32 ssid_len;
	155	u8 ssid[IEEE80211_MAX_SSID_LEN];
	156	};
	157
5e6e3a92	158	struct mwifiex_wait_queue {
600f5d90	159	wait_queue_head_t wait;
5e6e3a92	160	int status;
5e6e3a92 BZ	161	};
	162
	163	struct mwifiex_rxinfo {
9da9a3b2 YAP	164	u8 bss_num;
9da9a3b2 YAP	165	u8 bss_type;
5e6e3a92 BZ	166	struct sk_buff *parent;
	167	u8 use_count;
	168	};
	169
	170	struct mwifiex_txinfo {
	171	u32 status_code;
	172	u8 flags;
9da9a3b2 YAP	173	u8 bss_num;
9da9a3b2 YAP	174	u8 bss_type;
a1ed4849	175	u32 pkt_len;
808bbebc	176	u8 ack_frame_id;
18ca4382	177	u64 cookie;
5e6e3a92 BZ	178	};
5e6e3a92 BZ	179
5e6e3a92 BZ	180	enum mwifiex_wmm_ac_e {
	181	WMM_AC_BK,
	182	WMM_AC_BE,
	183	WMM_AC_VI,
	184	WMM_AC_VO
	185	} __packed;
54428c57 AP	186
	187	struct ieee_types_wmm_ac_parameters {
	188	u8 aci_aifsn_bitmap;
	189	u8 ecw_bitmap;
	190	__le16 tx_op_limit;
	191	} __packed;
	192
	193	struct mwifiex_types_wmm_info {
	194	u8 oui[4];
	195	u8 subtype;
	196	u8 version;
	197	u8 qos_info;
	198	u8 reserved;
	199	struct ieee_types_wmm_ac_parameters ac_params[IEEE80211_NUM_ACS];
	200	} __packed;
587b36d3 AP	201
	202	struct mwifiex_arp_eth_header {
	203	struct arphdr hdr;
	204	u8 ar_sha[ETH_ALEN];
	205	u8 ar_sip[4];
	206	u8 ar_tha[ETH_ALEN];
	207	u8 ar_tip[4];
	208	} __packed;
bf354433 AP	209
	210	struct mwifiex_chan_stats {
	211	u8 chan_num;
	212	u8 bandcfg;
	213	u8 flags;
	214	s8 noise;
	215	u16 total_bss;
	216	u16 cca_scan_dur;
	217	u16 cca_busy_dur;
	218	} __packed;
cbf6e055 XH	219
	220	#define MWIFIEX_HIST_MAX_SAMPLES 1048576
	221	#define MWIFIEX_MAX_RX_RATES 44
	222	#define MWIFIEX_MAX_AC_RX_RATES 74
	223	#define MWIFIEX_MAX_SNR 256
	224	#define MWIFIEX_MAX_NOISE_FLR 256
	225	#define MWIFIEX_MAX_SIG_STRENGTH 256
	226
	227	struct mwifiex_histogram_data {
	228	atomic_t rx_rate[MWIFIEX_MAX_AC_RX_RATES];
	229	atomic_t snr[MWIFIEX_MAX_SNR];
	230	atomic_t noise_flr[MWIFIEX_MAX_NOISE_FLR];
	231	atomic_t sig_str[MWIFIEX_MAX_SIG_STRENGTH];
	232	atomic_t num_samples;
	233	};
	234
5e6e3a92	235	#endif /* !_MWIFIEX_DECL_H_ */