1 /*
2  * Marvell Wireless LAN device driver: generic data structures and APIs
3  *
4  * Copyright (C) 2011-2014, Marvell International Ltd.
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>
29 #include <uapi/linux/if_arp.h>
30 #include <net/mac80211.h>
31 
32 
33 #define MWIFIEX_MAX_BSS_NUM         (3)
34 
35 #define MWIFIEX_DMA_ALIGN_SZ	    64
36 #define MWIFIEX_RX_HEADROOM	    64
37 #define MAX_TXPD_SZ		    32
38 #define INTF_HDR_ALIGN		     4
39 
40 #define MWIFIEX_MIN_DATA_HEADER_LEN (MWIFIEX_DMA_ALIGN_SZ + INTF_HDR_ALIGN + \
41 				     MAX_TXPD_SZ)
42 #define MWIFIEX_MGMT_FRAME_HEADER_SIZE	8	/* sizeof(pkt_type)
43 						 *   + sizeof(tx_control)
44 						 */
45 
46 #define MWIFIEX_MAX_TX_BASTREAM_SUPPORTED	2
47 #define MWIFIEX_MAX_RX_BASTREAM_SUPPORTED	16
48 #define MWIFIEX_MAX_TDLS_PEER_SUPPORTED 8
49 
50 #define MWIFIEX_STA_AMPDU_DEF_TXWINSIZE        64
51 #define MWIFIEX_STA_AMPDU_DEF_RXWINSIZE        64
52 #define MWIFIEX_UAP_AMPDU_DEF_TXWINSIZE        32
53 #define MWIFIEX_UAP_AMPDU_DEF_RXWINSIZE        16
54 #define MWIFIEX_11AC_STA_AMPDU_DEF_TXWINSIZE   64
55 #define MWIFIEX_11AC_STA_AMPDU_DEF_RXWINSIZE   64
56 #define MWIFIEX_11AC_UAP_AMPDU_DEF_TXWINSIZE   64
57 #define MWIFIEX_11AC_UAP_AMPDU_DEF_RXWINSIZE   64
58 
59 #define MWIFIEX_DEFAULT_BLOCK_ACK_TIMEOUT  0xffff
60 
61 #define MWIFIEX_RATE_BITMAP_MCS0   32
62 
63 #define MWIFIEX_RX_DATA_BUF_SIZE     (4 * 1024)
64 #define MWIFIEX_RX_CMD_BUF_SIZE	     (2 * 1024)
65 
66 #define MAX_BEACON_PERIOD                  (4000)
67 #define MIN_BEACON_PERIOD                  (50)
68 #define MAX_DTIM_PERIOD                    (100)
69 #define MIN_DTIM_PERIOD                    (1)
70 
71 #define MWIFIEX_RTS_MIN_VALUE              (0)
72 #define MWIFIEX_RTS_MAX_VALUE              (2347)
73 #define MWIFIEX_FRAG_MIN_VALUE             (256)
74 #define MWIFIEX_FRAG_MAX_VALUE             (2346)
75 #define MWIFIEX_WMM_VERSION                0x01
76 #define MWIFIEX_WMM_SUBTYPE                0x01
77 
78 #define MWIFIEX_RETRY_LIMIT                14
79 #define MWIFIEX_SDIO_BLOCK_SIZE            256
80 
81 #define MWIFIEX_BUF_FLAG_REQUEUED_PKT      BIT(0)
82 #define MWIFIEX_BUF_FLAG_BRIDGED_PKT	   BIT(1)
83 #define MWIFIEX_BUF_FLAG_TDLS_PKT	   BIT(2)
84 #define MWIFIEX_BUF_FLAG_EAPOL_TX_STATUS   BIT(3)
85 #define MWIFIEX_BUF_FLAG_ACTION_TX_STATUS  BIT(4)
86 #define MWIFIEX_BUF_FLAG_AGGR_PKT          BIT(5)
87 
88 #define MWIFIEX_BRIDGED_PKTS_THR_HIGH      1024
89 #define MWIFIEX_BRIDGED_PKTS_THR_LOW        128
90 
91 #define MWIFIEX_TDLS_DISABLE_LINK             0x00
92 #define MWIFIEX_TDLS_ENABLE_LINK              0x01
93 #define MWIFIEX_TDLS_CREATE_LINK              0x02
94 #define MWIFIEX_TDLS_CONFIG_LINK              0x03
95 
96 #define MWIFIEX_TDLS_RSSI_HIGH		50
97 #define MWIFIEX_TDLS_RSSI_LOW		55
98 #define MWIFIEX_TDLS_MAX_FAIL_COUNT      4
99 #define MWIFIEX_AUTO_TDLS_IDLE_TIME     10
100 
101 /* 54M rates, index from 0 to 11 */
102 #define MWIFIEX_RATE_INDEX_MCS0 12
103 /* 12-27=MCS0-15(BW20) */
104 #define MWIFIEX_BW20_MCS_NUM 15
105 
106 /* Rate index for OFDM 0 */
107 #define MWIFIEX_RATE_INDEX_OFDM0   4
108 
109 #define MWIFIEX_MAX_STA_NUM		1
110 #define MWIFIEX_MAX_UAP_NUM		1
111 #define MWIFIEX_MAX_P2P_NUM		1
112 
113 #define MWIFIEX_A_BAND_START_FREQ	5000
114 
115 /* SDIO Aggr data packet special info */
116 #define SDIO_MAX_AGGR_BUF_SIZE		(256 * 255)
117 #define BLOCK_NUMBER_OFFSET		15
118 #define SDIO_HEADER_OFFSET		28
119 
120 enum mwifiex_bss_type {
121 	MWIFIEX_BSS_TYPE_STA = 0,
122 	MWIFIEX_BSS_TYPE_UAP = 1,
123 	MWIFIEX_BSS_TYPE_P2P = 2,
124 	MWIFIEX_BSS_TYPE_ANY = 0xff,
125 };
126 
127 enum mwifiex_bss_role {
128 	MWIFIEX_BSS_ROLE_STA = 0,
129 	MWIFIEX_BSS_ROLE_UAP = 1,
130 	MWIFIEX_BSS_ROLE_ANY = 0xff,
131 };
132 
133 enum mwifiex_tdls_status {
134 	TDLS_NOT_SETUP = 0,
135 	TDLS_SETUP_INPROGRESS,
136 	TDLS_SETUP_COMPLETE,
137 	TDLS_SETUP_FAILURE,
138 	TDLS_LINK_TEARDOWN,
139 };
140 
141 enum mwifiex_tdls_error_code {
142 	TDLS_ERR_NO_ERROR = 0,
143 	TDLS_ERR_INTERNAL_ERROR,
144 	TDLS_ERR_MAX_LINKS_EST,
145 	TDLS_ERR_LINK_EXISTS,
146 	TDLS_ERR_LINK_NONEXISTENT,
147 	TDLS_ERR_PEER_STA_UNREACHABLE = 25,
148 };
149 
150 #define BSS_ROLE_BIT_MASK    BIT(0)
151 
152 #define GET_BSS_ROLE(priv)   ((priv)->bss_role & BSS_ROLE_BIT_MASK)
153 
154 enum mwifiex_data_frame_type {
155 	MWIFIEX_DATA_FRAME_TYPE_ETH_II = 0,
156 	MWIFIEX_DATA_FRAME_TYPE_802_11,
157 };
158 
159 struct mwifiex_fw_image {
160 	u8 *helper_buf;
161 	u32 helper_len;
162 	u8 *fw_buf;
163 	u32 fw_len;
164 };
165 
166 struct mwifiex_802_11_ssid {
167 	u32 ssid_len;
168 	u8 ssid[IEEE80211_MAX_SSID_LEN];
169 };
170 
171 struct mwifiex_wait_queue {
172 	wait_queue_head_t wait;
173 	int status;
174 };
175 
176 struct mwifiex_rxinfo {
177 	struct sk_buff *parent;
178 	u8 bss_num;
179 	u8 bss_type;
180 	u8 use_count;
181 	u8 buf_type;
182 };
183 
184 struct mwifiex_txinfo {
185 	u32 status_code;
186 	u8 flags;
187 	u8 bss_num;
188 	u8 bss_type;
189 	u8 aggr_num;
190 	u32 pkt_len;
191 	u8 ack_frame_id;
192 	u64 cookie;
193 };
194 
195 enum mwifiex_wmm_ac_e {
196 	WMM_AC_BK,
197 	WMM_AC_BE,
198 	WMM_AC_VI,
199 	WMM_AC_VO
200 } __packed;
201 
202 struct ieee_types_wmm_ac_parameters {
203 	u8 aci_aifsn_bitmap;
204 	u8 ecw_bitmap;
205 	__le16 tx_op_limit;
206 } __packed;
207 
208 struct mwifiex_types_wmm_info {
209 	u8 oui[4];
210 	u8 subtype;
211 	u8 version;
212 	u8 qos_info;
213 	u8 reserved;
214 	struct ieee_types_wmm_ac_parameters ac_params[IEEE80211_NUM_ACS];
215 } __packed;
216 
217 struct mwifiex_arp_eth_header {
218 	struct arphdr hdr;
219 	u8 ar_sha[ETH_ALEN];
220 	u8 ar_sip[4];
221 	u8 ar_tha[ETH_ALEN];
222 	u8 ar_tip[4];
223 } __packed;
224 
225 struct mwifiex_chan_stats {
226 	u8 chan_num;
227 	u8 bandcfg;
228 	u8 flags;
229 	s8 noise;
230 	u16 total_bss;
231 	u16 cca_scan_dur;
232 	u16 cca_busy_dur;
233 } __packed;
234 
235 #define MWIFIEX_HIST_MAX_SAMPLES	1048576
236 #define MWIFIEX_MAX_RX_RATES		     44
237 #define MWIFIEX_MAX_AC_RX_RATES		     74
238 #define MWIFIEX_MAX_SNR			    256
239 #define MWIFIEX_MAX_NOISE_FLR		    256
240 #define MWIFIEX_MAX_SIG_STRENGTH	    256
241 
242 struct mwifiex_histogram_data {
243 	atomic_t rx_rate[MWIFIEX_MAX_AC_RX_RATES];
244 	atomic_t snr[MWIFIEX_MAX_SNR];
245 	atomic_t noise_flr[MWIFIEX_MAX_NOISE_FLR];
246 	atomic_t sig_str[MWIFIEX_MAX_SIG_STRENGTH];
247 	atomic_t num_samples;
248 };
249 
250 struct mwifiex_iface_comb {
251 	u8 sta_intf;
252 	u8 uap_intf;
253 	u8 p2p_intf;
254 };
255 
256 struct mwifiex_radar_params {
257 	struct cfg80211_chan_def *chandef;
258 	u32 cac_time_ms;
259 } __packed;
260 
261 struct mwifiex_11h_intf_state {
262 	bool is_11h_enabled;
263 	bool is_11h_active;
264 } __packed;
265 #endif /* !_MWIFIEX_DECL_H_ */
266