Loading...
Note: File does not exist in v6.8.
1/******************************************************************************
2 *
3 * This file is provided under a dual BSD/GPLv2 license. When using or
4 * redistributing this file, you may do so under either license.
5 *
6 * GPL LICENSE SUMMARY
7 *
8 * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of version 2 of the GNU General Public License as
12 * published by the Free Software Foundation.
13 *
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
22 * USA
23 *
24 * The full GNU General Public License is included in this distribution
25 * in the file called COPYING.
26 *
27 * Contact Information:
28 * Intel Linux Wireless <linuxwifi@intel.com>
29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
30 *
31 * BSD LICENSE
32 *
33 * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
34 * All rights reserved.
35 *
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
38 * are met:
39 *
40 * * Redistributions of source code must retain the above copyright
41 * notice, this list of conditions and the following disclaimer.
42 * * Redistributions in binary form must reproduce the above copyright
43 * notice, this list of conditions and the following disclaimer in
44 * the documentation and/or other materials provided with the
45 * distribution.
46 * * Neither the name Intel Corporation nor the names of its
47 * contributors may be used to endorse or promote products derived
48 * from this software without specific prior written permission.
49 *
50 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
51 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
52 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
53 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
54 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
55 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
56 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
57 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
58 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
59 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
60 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
61 *****************************************************************************/
62
63#ifndef __fw_api_mac_h__
64#define __fw_api_mac_h__
65
66/*
67 * The first MAC indices (starting from 0)
68 * are available to the driver, AUX follows
69 */
70#define MAC_INDEX_AUX 4
71#define MAC_INDEX_MIN_DRIVER 0
72#define NUM_MAC_INDEX_DRIVER MAC_INDEX_AUX
73#define NUM_MAC_INDEX (MAC_INDEX_AUX + 1)
74
75#define IWL_MVM_STATION_COUNT 16
76#define IWL_MVM_TDLS_STA_COUNT 4
77
78enum iwl_ac {
79 AC_BK,
80 AC_BE,
81 AC_VI,
82 AC_VO,
83 AC_NUM,
84};
85
86/**
87 * enum iwl_mac_protection_flags - MAC context flags
88 * @MAC_PROT_FLG_TGG_PROTECT: 11g protection when transmitting OFDM frames,
89 * this will require CCK RTS/CTS2self.
90 * RTS/CTS will protect full burst time.
91 * @MAC_PROT_FLG_HT_PROT: enable HT protection
92 * @MAC_PROT_FLG_FAT_PROT: protect 40 MHz transmissions
93 * @MAC_PROT_FLG_SELF_CTS_EN: allow CTS2self
94 */
95enum iwl_mac_protection_flags {
96 MAC_PROT_FLG_TGG_PROTECT = BIT(3),
97 MAC_PROT_FLG_HT_PROT = BIT(23),
98 MAC_PROT_FLG_FAT_PROT = BIT(24),
99 MAC_PROT_FLG_SELF_CTS_EN = BIT(30),
100};
101
102#define MAC_FLG_SHORT_SLOT BIT(4)
103#define MAC_FLG_SHORT_PREAMBLE BIT(5)
104
105/**
106 * enum iwl_mac_types - Supported MAC types
107 * @FW_MAC_TYPE_FIRST: lowest supported MAC type
108 * @FW_MAC_TYPE_AUX: Auxiliary MAC (internal)
109 * @FW_MAC_TYPE_LISTENER: monitor MAC type (?)
110 * @FW_MAC_TYPE_PIBSS: Pseudo-IBSS
111 * @FW_MAC_TYPE_IBSS: IBSS
112 * @FW_MAC_TYPE_BSS_STA: BSS (managed) station
113 * @FW_MAC_TYPE_P2P_DEVICE: P2P Device
114 * @FW_MAC_TYPE_P2P_STA: P2P client
115 * @FW_MAC_TYPE_GO: P2P GO
116 * @FW_MAC_TYPE_TEST: ?
117 * @FW_MAC_TYPE_MAX: highest support MAC type
118 */
119enum iwl_mac_types {
120 FW_MAC_TYPE_FIRST = 1,
121 FW_MAC_TYPE_AUX = FW_MAC_TYPE_FIRST,
122 FW_MAC_TYPE_LISTENER,
123 FW_MAC_TYPE_PIBSS,
124 FW_MAC_TYPE_IBSS,
125 FW_MAC_TYPE_BSS_STA,
126 FW_MAC_TYPE_P2P_DEVICE,
127 FW_MAC_TYPE_P2P_STA,
128 FW_MAC_TYPE_GO,
129 FW_MAC_TYPE_TEST,
130 FW_MAC_TYPE_MAX = FW_MAC_TYPE_TEST
131}; /* MAC_CONTEXT_TYPE_API_E_VER_1 */
132
133/**
134 * enum iwl_tsf_id - TSF hw timer ID
135 * @TSF_ID_A: use TSF A
136 * @TSF_ID_B: use TSF B
137 * @TSF_ID_C: use TSF C
138 * @TSF_ID_D: use TSF D
139 * @NUM_TSF_IDS: number of TSF timers available
140 */
141enum iwl_tsf_id {
142 TSF_ID_A = 0,
143 TSF_ID_B = 1,
144 TSF_ID_C = 2,
145 TSF_ID_D = 3,
146 NUM_TSF_IDS = 4,
147}; /* TSF_ID_API_E_VER_1 */
148
149/**
150 * struct iwl_mac_data_ap - configuration data for AP MAC context
151 * @beacon_time: beacon transmit time in system time
152 * @beacon_tsf: beacon transmit time in TSF
153 * @bi: beacon interval in TU
154 * @bi_reciprocal: 2^32 / bi
155 * @dtim_interval: dtim transmit time in TU
156 * @dtim_reciprocal: 2^32 / dtim_interval
157 * @mcast_qid: queue ID for multicast traffic
158 * @beacon_template: beacon template ID
159 */
160struct iwl_mac_data_ap {
161 __le32 beacon_time;
162 __le64 beacon_tsf;
163 __le32 bi;
164 __le32 bi_reciprocal;
165 __le32 dtim_interval;
166 __le32 dtim_reciprocal;
167 __le32 mcast_qid;
168 __le32 beacon_template;
169} __packed; /* AP_MAC_DATA_API_S_VER_1 */
170
171/**
172 * struct iwl_mac_data_ibss - configuration data for IBSS MAC context
173 * @beacon_time: beacon transmit time in system time
174 * @beacon_tsf: beacon transmit time in TSF
175 * @bi: beacon interval in TU
176 * @bi_reciprocal: 2^32 / bi
177 * @beacon_template: beacon template ID
178 */
179struct iwl_mac_data_ibss {
180 __le32 beacon_time;
181 __le64 beacon_tsf;
182 __le32 bi;
183 __le32 bi_reciprocal;
184 __le32 beacon_template;
185} __packed; /* IBSS_MAC_DATA_API_S_VER_1 */
186
187/**
188 * struct iwl_mac_data_sta - configuration data for station MAC context
189 * @is_assoc: 1 for associated state, 0 otherwise
190 * @dtim_time: DTIM arrival time in system time
191 * @dtim_tsf: DTIM arrival time in TSF
192 * @bi: beacon interval in TU, applicable only when associated
193 * @bi_reciprocal: 2^32 / bi , applicable only when associated
194 * @dtim_interval: DTIM interval in TU, applicable only when associated
195 * @dtim_reciprocal: 2^32 / dtim_interval , applicable only when associated
196 * @listen_interval: in beacon intervals, applicable only when associated
197 * @assoc_id: unique ID assigned by the AP during association
198 */
199struct iwl_mac_data_sta {
200 __le32 is_assoc;
201 __le32 dtim_time;
202 __le64 dtim_tsf;
203 __le32 bi;
204 __le32 bi_reciprocal;
205 __le32 dtim_interval;
206 __le32 dtim_reciprocal;
207 __le32 listen_interval;
208 __le32 assoc_id;
209 __le32 assoc_beacon_arrive_time;
210} __packed; /* STA_MAC_DATA_API_S_VER_1 */
211
212/**
213 * struct iwl_mac_data_go - configuration data for P2P GO MAC context
214 * @ap: iwl_mac_data_ap struct with most config data
215 * @ctwin: client traffic window in TU (period after TBTT when GO is present).
216 * 0 indicates that there is no CT window.
217 * @opp_ps_enabled: indicate that opportunistic PS allowed
218 */
219struct iwl_mac_data_go {
220 struct iwl_mac_data_ap ap;
221 __le32 ctwin;
222 __le32 opp_ps_enabled;
223} __packed; /* GO_MAC_DATA_API_S_VER_1 */
224
225/**
226 * struct iwl_mac_data_p2p_sta - configuration data for P2P client MAC context
227 * @sta: iwl_mac_data_sta struct with most config data
228 * @ctwin: client traffic window in TU (period after TBTT when GO is present).
229 * 0 indicates that there is no CT window.
230 */
231struct iwl_mac_data_p2p_sta {
232 struct iwl_mac_data_sta sta;
233 __le32 ctwin;
234} __packed; /* P2P_STA_MAC_DATA_API_S_VER_1 */
235
236/**
237 * struct iwl_mac_data_pibss - Pseudo IBSS config data
238 * @stats_interval: interval in TU between statistics notifications to host.
239 */
240struct iwl_mac_data_pibss {
241 __le32 stats_interval;
242} __packed; /* PIBSS_MAC_DATA_API_S_VER_1 */
243
244/*
245 * struct iwl_mac_data_p2p_dev - configuration data for the P2P Device MAC
246 * context.
247 * @is_disc_extended: if set to true, P2P Device discoverability is enabled on
248 * other channels as well. This should be to true only in case that the
249 * device is discoverable and there is an active GO. Note that setting this
250 * field when not needed, will increase the number of interrupts and have
251 * effect on the platform power, as this setting opens the Rx filters on
252 * all macs.
253 */
254struct iwl_mac_data_p2p_dev {
255 __le32 is_disc_extended;
256} __packed; /* _P2P_DEV_MAC_DATA_API_S_VER_1 */
257
258/**
259 * enum iwl_mac_filter_flags - MAC context filter flags
260 * @MAC_FILTER_IN_PROMISC: accept all data frames
261 * @MAC_FILTER_IN_CONTROL_AND_MGMT: pass all management and
262 * control frames to the host
263 * @MAC_FILTER_ACCEPT_GRP: accept multicast frames
264 * @MAC_FILTER_DIS_DECRYPT: don't decrypt unicast frames
265 * @MAC_FILTER_DIS_GRP_DECRYPT: don't decrypt multicast frames
266 * @MAC_FILTER_IN_BEACON: transfer foreign BSS's beacons to host
267 * (in station mode when associated)
268 * @MAC_FILTER_OUT_BCAST: filter out all broadcast frames
269 * @MAC_FILTER_IN_CRC32: extract FCS and append it to frames
270 * @MAC_FILTER_IN_PROBE_REQUEST: pass probe requests to host
271 */
272enum iwl_mac_filter_flags {
273 MAC_FILTER_IN_PROMISC = BIT(0),
274 MAC_FILTER_IN_CONTROL_AND_MGMT = BIT(1),
275 MAC_FILTER_ACCEPT_GRP = BIT(2),
276 MAC_FILTER_DIS_DECRYPT = BIT(3),
277 MAC_FILTER_DIS_GRP_DECRYPT = BIT(4),
278 MAC_FILTER_IN_BEACON = BIT(6),
279 MAC_FILTER_OUT_BCAST = BIT(8),
280 MAC_FILTER_IN_CRC32 = BIT(11),
281 MAC_FILTER_IN_PROBE_REQUEST = BIT(12),
282};
283
284/**
285 * enum iwl_mac_qos_flags - QoS flags
286 * @MAC_QOS_FLG_UPDATE_EDCA: ?
287 * @MAC_QOS_FLG_TGN: HT is enabled
288 * @MAC_QOS_FLG_TXOP_TYPE: ?
289 *
290 */
291enum iwl_mac_qos_flags {
292 MAC_QOS_FLG_UPDATE_EDCA = BIT(0),
293 MAC_QOS_FLG_TGN = BIT(1),
294 MAC_QOS_FLG_TXOP_TYPE = BIT(4),
295};
296
297/**
298 * struct iwl_ac_qos - QOS timing params for MAC_CONTEXT_CMD
299 * @cw_min: Contention window, start value in numbers of slots.
300 * Should be a power-of-2, minus 1. Device's default is 0x0f.
301 * @cw_max: Contention window, max value in numbers of slots.
302 * Should be a power-of-2, minus 1. Device's default is 0x3f.
303 * @aifsn: Number of slots in Arbitration Interframe Space (before
304 * performing random backoff timing prior to Tx). Device default 1.
305 * @fifos_mask: FIFOs used by this MAC for this AC
306 * @edca_txop: Length of Tx opportunity, in uSecs. Device default is 0.
307 *
308 * One instance of this config struct for each of 4 EDCA access categories
309 * in struct iwl_qosparam_cmd.
310 *
311 * Device will automatically increase contention window by (2*CW) + 1 for each
312 * transmission retry. Device uses cw_max as a bit mask, ANDed with new CW
313 * value, to cap the CW value.
314 */
315struct iwl_ac_qos {
316 __le16 cw_min;
317 __le16 cw_max;
318 u8 aifsn;
319 u8 fifos_mask;
320 __le16 edca_txop;
321} __packed; /* AC_QOS_API_S_VER_2 */
322
323/**
324 * struct iwl_mac_ctx_cmd - command structure to configure MAC contexts
325 * ( MAC_CONTEXT_CMD = 0x28 )
326 * @id_and_color: ID and color of the MAC
327 * @action: action to perform, one of FW_CTXT_ACTION_*
328 * @mac_type: one of FW_MAC_TYPE_*
329 * @tsd_id: TSF HW timer, one of TSF_ID_*
330 * @node_addr: MAC address
331 * @bssid_addr: BSSID
332 * @cck_rates: basic rates available for CCK
333 * @ofdm_rates: basic rates available for OFDM
334 * @protection_flags: combination of MAC_PROT_FLG_FLAG_*
335 * @cck_short_preamble: 0x20 for enabling short preamble, 0 otherwise
336 * @short_slot: 0x10 for enabling short slots, 0 otherwise
337 * @filter_flags: combination of MAC_FILTER_*
338 * @qos_flags: from MAC_QOS_FLG_*
339 * @ac: one iwl_mac_qos configuration for each AC
340 * @mac_specific: one of struct iwl_mac_data_*, according to mac_type
341 */
342struct iwl_mac_ctx_cmd {
343 /* COMMON_INDEX_HDR_API_S_VER_1 */
344 __le32 id_and_color;
345 __le32 action;
346 /* MAC_CONTEXT_COMMON_DATA_API_S_VER_1 */
347 __le32 mac_type;
348 __le32 tsf_id;
349 u8 node_addr[6];
350 __le16 reserved_for_node_addr;
351 u8 bssid_addr[6];
352 __le16 reserved_for_bssid_addr;
353 __le32 cck_rates;
354 __le32 ofdm_rates;
355 __le32 protection_flags;
356 __le32 cck_short_preamble;
357 __le32 short_slot;
358 __le32 filter_flags;
359 /* MAC_QOS_PARAM_API_S_VER_1 */
360 __le32 qos_flags;
361 struct iwl_ac_qos ac[AC_NUM+1];
362 /* MAC_CONTEXT_COMMON_DATA_API_S */
363 union {
364 struct iwl_mac_data_ap ap;
365 struct iwl_mac_data_go go;
366 struct iwl_mac_data_sta sta;
367 struct iwl_mac_data_p2p_sta p2p_sta;
368 struct iwl_mac_data_p2p_dev p2p_dev;
369 struct iwl_mac_data_pibss pibss;
370 struct iwl_mac_data_ibss ibss;
371 };
372} __packed; /* MAC_CONTEXT_CMD_API_S_VER_1 */
373
374static inline u32 iwl_mvm_reciprocal(u32 v)
375{
376 if (!v)
377 return 0;
378 return 0xFFFFFFFF / v;
379}
380
381#define IWL_NONQOS_SEQ_GET 0x1
382#define IWL_NONQOS_SEQ_SET 0x2
383struct iwl_nonqos_seq_query_cmd {
384 __le32 get_set_flag;
385 __le32 mac_id_n_color;
386 __le16 value;
387 __le16 reserved;
388} __packed; /* NON_QOS_TX_COUNTER_GET_SET_API_S_VER_1 */
389
390#endif /* __fw_api_mac_h__ */