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 <ilw@linux.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 enum iwl_ac {
76 AC_BK,
77 AC_BE,
78 AC_VI,
79 AC_VO,
80 AC_NUM,
81 };
82
83 /**
84 * enum iwl_mac_protection_flags - MAC context flags
85 * @MAC_PROT_FLG_TGG_PROTECT: 11g protection when transmitting OFDM frames,
86 * this will require CCK RTS/CTS2self.
87 * RTS/CTS will protect full burst time.
88 * @MAC_PROT_FLG_HT_PROT: enable HT protection
89 * @MAC_PROT_FLG_FAT_PROT: protect 40 MHz transmissions
90 * @MAC_PROT_FLG_SELF_CTS_EN: allow CTS2self
91 */
92 enum iwl_mac_protection_flags {
93 MAC_PROT_FLG_TGG_PROTECT = BIT(3),
94 MAC_PROT_FLG_HT_PROT = BIT(23),
95 MAC_PROT_FLG_FAT_PROT = BIT(24),
96 MAC_PROT_FLG_SELF_CTS_EN = BIT(30),
97 };
98
99 #define MAC_FLG_SHORT_SLOT BIT(4)
100 #define MAC_FLG_SHORT_PREAMBLE BIT(5)
101
102 /**
103 * enum iwl_mac_types - Supported MAC types
104 * @FW_MAC_TYPE_FIRST: lowest supported MAC type
105 * @FW_MAC_TYPE_AUX: Auxiliary MAC (internal)
106 * @FW_MAC_TYPE_LISTENER: monitor MAC type (?)
107 * @FW_MAC_TYPE_PIBSS: Pseudo-IBSS
108 * @FW_MAC_TYPE_IBSS: IBSS
109 * @FW_MAC_TYPE_BSS_STA: BSS (managed) station
110 * @FW_MAC_TYPE_P2P_DEVICE: P2P Device
111 * @FW_MAC_TYPE_P2P_STA: P2P client
112 * @FW_MAC_TYPE_GO: P2P GO
113 * @FW_MAC_TYPE_TEST: ?
114 * @FW_MAC_TYPE_MAX: highest support MAC type
115 */
116 enum iwl_mac_types {
117 FW_MAC_TYPE_FIRST = 1,
118 FW_MAC_TYPE_AUX = FW_MAC_TYPE_FIRST,
119 FW_MAC_TYPE_LISTENER,
120 FW_MAC_TYPE_PIBSS,
121 FW_MAC_TYPE_IBSS,
122 FW_MAC_TYPE_BSS_STA,
123 FW_MAC_TYPE_P2P_DEVICE,
124 FW_MAC_TYPE_P2P_STA,
125 FW_MAC_TYPE_GO,
126 FW_MAC_TYPE_TEST,
127 FW_MAC_TYPE_MAX = FW_MAC_TYPE_TEST
128 }; /* MAC_CONTEXT_TYPE_API_E_VER_1 */
129
130 /**
131 * enum iwl_tsf_id - TSF hw timer ID
132 * @TSF_ID_A: use TSF A
133 * @TSF_ID_B: use TSF B
134 * @TSF_ID_C: use TSF C
135 * @TSF_ID_D: use TSF D
136 * @NUM_TSF_IDS: number of TSF timers available
137 */
138 enum iwl_tsf_id {
139 TSF_ID_A = 0,
140 TSF_ID_B = 1,
141 TSF_ID_C = 2,
142 TSF_ID_D = 3,
143 NUM_TSF_IDS = 4,
144 }; /* TSF_ID_API_E_VER_1 */
145
146 /**
147 * struct iwl_mac_data_ap - configuration data for AP MAC context
148 * @beacon_time: beacon transmit time in system time
149 * @beacon_tsf: beacon transmit time in TSF
150 * @bi: beacon interval in TU
151 * @bi_reciprocal: 2^32 / bi
152 * @dtim_interval: dtim transmit time in TU
153 * @dtim_reciprocal: 2^32 / dtim_interval
154 * @mcast_qid: queue ID for multicast traffic
155 * @beacon_template: beacon template ID
156 */
157 struct iwl_mac_data_ap {
158 __le32 beacon_time;
159 __le64 beacon_tsf;
160 __le32 bi;
161 __le32 bi_reciprocal;
162 __le32 dtim_interval;
163 __le32 dtim_reciprocal;
164 __le32 mcast_qid;
165 __le32 beacon_template;
166 } __packed; /* AP_MAC_DATA_API_S_VER_1 */
167
168 /**
169 * struct iwl_mac_data_ibss - configuration data for IBSS MAC context
170 * @beacon_time: beacon transmit time in system time
171 * @beacon_tsf: beacon transmit time in TSF
172 * @bi: beacon interval in TU
173 * @bi_reciprocal: 2^32 / bi
174 * @beacon_template: beacon template ID
175 */
176 struct iwl_mac_data_ibss {
177 __le32 beacon_time;
178 __le64 beacon_tsf;
179 __le32 bi;
180 __le32 bi_reciprocal;
181 __le32 beacon_template;
182 } __packed; /* IBSS_MAC_DATA_API_S_VER_1 */
183
184 /**
185 * struct iwl_mac_data_sta - configuration data for station MAC context
186 * @is_assoc: 1 for associated state, 0 otherwise
187 * @dtim_time: DTIM arrival time in system time
188 * @dtim_tsf: DTIM arrival time in TSF
189 * @bi: beacon interval in TU, applicable only when associated
190 * @bi_reciprocal: 2^32 / bi , applicable only when associated
191 * @dtim_interval: DTIM interval in TU, applicable only when associated
192 * @dtim_reciprocal: 2^32 / dtim_interval , applicable only when associated
193 * @listen_interval: in beacon intervals, applicable only when associated
194 * @assoc_id: unique ID assigned by the AP during association
195 */
196 struct iwl_mac_data_sta {
197 __le32 is_assoc;
198 __le32 dtim_time;
199 __le64 dtim_tsf;
200 __le32 bi;
201 __le32 bi_reciprocal;
202 __le32 dtim_interval;
203 __le32 dtim_reciprocal;
204 __le32 listen_interval;
205 __le32 assoc_id;
206 __le32 assoc_beacon_arrive_time;
207 } __packed; /* STA_MAC_DATA_API_S_VER_1 */
208
209 /**
210 * struct iwl_mac_data_go - configuration data for P2P GO MAC context
211 * @ap: iwl_mac_data_ap struct with most config data
212 * @ctwin: client traffic window in TU (period after TBTT when GO is present).
213 * 0 indicates that there is no CT window.
214 * @opp_ps_enabled: indicate that opportunistic PS allowed
215 */
216 struct iwl_mac_data_go {
217 struct iwl_mac_data_ap ap;
218 __le32 ctwin;
219 __le32 opp_ps_enabled;
220 } __packed; /* GO_MAC_DATA_API_S_VER_1 */
221
222 /**
223 * struct iwl_mac_data_p2p_sta - configuration data for P2P client MAC context
224 * @sta: iwl_mac_data_sta struct with most config data
225 * @ctwin: client traffic window in TU (period after TBTT when GO is present).
226 * 0 indicates that there is no CT window.
227 */
228 struct iwl_mac_data_p2p_sta {
229 struct iwl_mac_data_sta sta;
230 __le32 ctwin;
231 } __packed; /* P2P_STA_MAC_DATA_API_S_VER_1 */
232
233 /**
234 * struct iwl_mac_data_pibss - Pseudo IBSS config data
235 * @stats_interval: interval in TU between statistics notifications to host.
236 */
237 struct iwl_mac_data_pibss {
238 __le32 stats_interval;
239 } __packed; /* PIBSS_MAC_DATA_API_S_VER_1 */
240
241 /*
242 * struct iwl_mac_data_p2p_dev - configuration data for the P2P Device MAC
243 * context.
244 * @is_disc_extended: if set to true, P2P Device discoverability is enabled on
245 * other channels as well. This should be to true only in case that the
246 * device is discoverable and there is an active GO. Note that setting this
247 * field when not needed, will increase the number of interrupts and have
248 * effect on the platform power, as this setting opens the Rx filters on
249 * all macs.
250 */
251 struct iwl_mac_data_p2p_dev {
252 __le32 is_disc_extended;
253 } __packed; /* _P2P_DEV_MAC_DATA_API_S_VER_1 */
254
255 /**
256 * enum iwl_mac_filter_flags - MAC context filter flags
257 * @MAC_FILTER_IN_PROMISC: accept all data frames
258 * @MAC_FILTER_IN_CONTROL_AND_MGMT: pass all management and
259 * control frames to the host
260 * @MAC_FILTER_ACCEPT_GRP: accept multicast frames
261 * @MAC_FILTER_DIS_DECRYPT: don't decrypt unicast frames
262 * @MAC_FILTER_DIS_GRP_DECRYPT: don't decrypt multicast frames
263 * @MAC_FILTER_IN_BEACON: transfer foreign BSS's beacons to host
264 * (in station mode when associated)
265 * @MAC_FILTER_OUT_BCAST: filter out all broadcast frames
266 * @MAC_FILTER_IN_CRC32: extract FCS and append it to frames
267 * @MAC_FILTER_IN_PROBE_REQUEST: pass probe requests to host
268 */
269 enum iwl_mac_filter_flags {
270 MAC_FILTER_IN_PROMISC = BIT(0),
271 MAC_FILTER_IN_CONTROL_AND_MGMT = BIT(1),
272 MAC_FILTER_ACCEPT_GRP = BIT(2),
273 MAC_FILTER_DIS_DECRYPT = BIT(3),
274 MAC_FILTER_DIS_GRP_DECRYPT = BIT(4),
275 MAC_FILTER_IN_BEACON = BIT(6),
276 MAC_FILTER_OUT_BCAST = BIT(8),
277 MAC_FILTER_IN_CRC32 = BIT(11),
278 MAC_FILTER_IN_PROBE_REQUEST = BIT(12),
279 };
280
281 /**
282 * enum iwl_mac_qos_flags - QoS flags
283 * @MAC_QOS_FLG_UPDATE_EDCA: ?
284 * @MAC_QOS_FLG_TGN: HT is enabled
285 * @MAC_QOS_FLG_TXOP_TYPE: ?
286 *
287 */
288 enum iwl_mac_qos_flags {
289 MAC_QOS_FLG_UPDATE_EDCA = BIT(0),
290 MAC_QOS_FLG_TGN = BIT(1),
291 MAC_QOS_FLG_TXOP_TYPE = BIT(4),
292 };
293
294 /**
295 * struct iwl_ac_qos - QOS timing params for MAC_CONTEXT_CMD
296 * @cw_min: Contention window, start value in numbers of slots.
297 * Should be a power-of-2, minus 1. Device's default is 0x0f.
298 * @cw_max: Contention window, max value in numbers of slots.
299 * Should be a power-of-2, minus 1. Device's default is 0x3f.
300 * @aifsn: Number of slots in Arbitration Interframe Space (before
301 * performing random backoff timing prior to Tx). Device default 1.
302 * @fifos_mask: FIFOs used by this MAC for this AC
303 * @edca_txop: Length of Tx opportunity, in uSecs. Device default is 0.
304 *
305 * One instance of this config struct for each of 4 EDCA access categories
306 * in struct iwl_qosparam_cmd.
307 *
308 * Device will automatically increase contention window by (2*CW) + 1 for each
309 * transmission retry. Device uses cw_max as a bit mask, ANDed with new CW
310 * value, to cap the CW value.
311 */
312 struct iwl_ac_qos {
313 __le16 cw_min;
314 __le16 cw_max;
315 u8 aifsn;
316 u8 fifos_mask;
317 __le16 edca_txop;
318 } __packed; /* AC_QOS_API_S_VER_2 */
319
320 /**
321 * struct iwl_mac_ctx_cmd - command structure to configure MAC contexts
322 * ( MAC_CONTEXT_CMD = 0x28 )
323 * @id_and_color: ID and color of the MAC
324 * @action: action to perform, one of FW_CTXT_ACTION_*
325 * @mac_type: one of FW_MAC_TYPE_*
326 * @tsd_id: TSF HW timer, one of TSF_ID_*
327 * @node_addr: MAC address
328 * @bssid_addr: BSSID
329 * @cck_rates: basic rates available for CCK
330 * @ofdm_rates: basic rates available for OFDM
331 * @protection_flags: combination of MAC_PROT_FLG_FLAG_*
332 * @cck_short_preamble: 0x20 for enabling short preamble, 0 otherwise
333 * @short_slot: 0x10 for enabling short slots, 0 otherwise
334 * @filter_flags: combination of MAC_FILTER_*
335 * @qos_flags: from MAC_QOS_FLG_*
336 * @ac: one iwl_mac_qos configuration for each AC
337 * @mac_specific: one of struct iwl_mac_data_*, according to mac_type
338 */
339 struct iwl_mac_ctx_cmd {
340 /* COMMON_INDEX_HDR_API_S_VER_1 */
341 __le32 id_and_color;
342 __le32 action;
343 /* MAC_CONTEXT_COMMON_DATA_API_S_VER_1 */
344 __le32 mac_type;
345 __le32 tsf_id;
346 u8 node_addr[6];
347 __le16 reserved_for_node_addr;
348 u8 bssid_addr[6];
349 __le16 reserved_for_bssid_addr;
350 __le32 cck_rates;
351 __le32 ofdm_rates;
352 __le32 protection_flags;
353 __le32 cck_short_preamble;
354 __le32 short_slot;
355 __le32 filter_flags;
356 /* MAC_QOS_PARAM_API_S_VER_1 */
357 __le32 qos_flags;
358 struct iwl_ac_qos ac[AC_NUM+1];
359 /* MAC_CONTEXT_COMMON_DATA_API_S */
360 union {
361 struct iwl_mac_data_ap ap;
362 struct iwl_mac_data_go go;
363 struct iwl_mac_data_sta sta;
364 struct iwl_mac_data_p2p_sta p2p_sta;
365 struct iwl_mac_data_p2p_dev p2p_dev;
366 struct iwl_mac_data_pibss pibss;
367 struct iwl_mac_data_ibss ibss;
368 };
369 } __packed; /* MAC_CONTEXT_CMD_API_S_VER_1 */
370
iwl_mvm_reciprocal(u32 v)371 static inline u32 iwl_mvm_reciprocal(u32 v)
372 {
373 if (!v)
374 return 0;
375 return 0xFFFFFFFF / v;
376 }
377
378 #define IWL_NONQOS_SEQ_GET 0x1
379 #define IWL_NONQOS_SEQ_SET 0x2
380 struct iwl_nonqos_seq_query_cmd {
381 __le32 get_set_flag;
382 __le32 mac_id_n_color;
383 __le16 value;
384 __le16 reserved;
385 } __packed; /* NON_QOS_TX_COUNTER_GET_SET_API_S_VER_1 */
386
387 #endif /* __fw_api_mac_h__ */
388