1 /******************************************************************************
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.
8 * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
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.
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.
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,
24 * The full GNU General Public License is included in this distribution
25 * in the file called COPYING.
27 * Contact Information:
28 * Intel Linux Wireless <linuxwifi@intel.com>
29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
33 * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
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
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.
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 *****************************************************************************/
63 #ifndef __fw_api_mac_h__
64 #define __fw_api_mac_h__
67 * The first MAC indices (starting from 0) are available to the driver,
68 * AUX indices follows - 1 for non-CDB, 2 for CDB.
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 (NUM_MAC_INDEX_DRIVER + 1)
74 #define NUM_MAC_INDEX_CDB (NUM_MAC_INDEX_DRIVER + 2)
76 #define IWL_MVM_STATION_COUNT 16
77 #define IWL_MVM_INVALID_STA 0xFF
79 #define IWL_MVM_TDLS_STA_COUNT 4
90 * enum iwl_mac_protection_flags - MAC context flags
91 * @MAC_PROT_FLG_TGG_PROTECT: 11g protection when transmitting OFDM frames,
92 * this will require CCK RTS/CTS2self.
93 * RTS/CTS will protect full burst time.
94 * @MAC_PROT_FLG_HT_PROT: enable HT protection
95 * @MAC_PROT_FLG_FAT_PROT: protect 40 MHz transmissions
96 * @MAC_PROT_FLG_SELF_CTS_EN: allow CTS2self
98 enum iwl_mac_protection_flags {
99 MAC_PROT_FLG_TGG_PROTECT = BIT(3),
100 MAC_PROT_FLG_HT_PROT = BIT(23),
101 MAC_PROT_FLG_FAT_PROT = BIT(24),
102 MAC_PROT_FLG_SELF_CTS_EN = BIT(30),
105 #define MAC_FLG_SHORT_SLOT BIT(4)
106 #define MAC_FLG_SHORT_PREAMBLE BIT(5)
109 * enum iwl_mac_types - Supported MAC types
110 * @FW_MAC_TYPE_FIRST: lowest supported MAC type
111 * @FW_MAC_TYPE_AUX: Auxiliary MAC (internal)
112 * @FW_MAC_TYPE_LISTENER: monitor MAC type (?)
113 * @FW_MAC_TYPE_PIBSS: Pseudo-IBSS
114 * @FW_MAC_TYPE_IBSS: IBSS
115 * @FW_MAC_TYPE_BSS_STA: BSS (managed) station
116 * @FW_MAC_TYPE_P2P_DEVICE: P2P Device
117 * @FW_MAC_TYPE_P2P_STA: P2P client
118 * @FW_MAC_TYPE_GO: P2P GO
119 * @FW_MAC_TYPE_TEST: ?
120 * @FW_MAC_TYPE_MAX: highest support MAC type
123 FW_MAC_TYPE_FIRST = 1,
124 FW_MAC_TYPE_AUX = FW_MAC_TYPE_FIRST,
125 FW_MAC_TYPE_LISTENER,
129 FW_MAC_TYPE_P2P_DEVICE,
133 FW_MAC_TYPE_MAX = FW_MAC_TYPE_TEST
134 }; /* MAC_CONTEXT_TYPE_API_E_VER_1 */
137 * enum iwl_tsf_id - TSF hw timer ID
138 * @TSF_ID_A: use TSF A
139 * @TSF_ID_B: use TSF B
140 * @TSF_ID_C: use TSF C
141 * @TSF_ID_D: use TSF D
142 * @NUM_TSF_IDS: number of TSF timers available
150 }; /* TSF_ID_API_E_VER_1 */
153 * struct iwl_mac_data_ap - configuration data for AP MAC context
154 * @beacon_time: beacon transmit time in system time
155 * @beacon_tsf: beacon transmit time in TSF
156 * @bi: beacon interval in TU
157 * @bi_reciprocal: 2^32 / bi
158 * @dtim_interval: dtim transmit time in TU
159 * @dtim_reciprocal: 2^32 / dtim_interval
160 * @mcast_qid: queue ID for multicast traffic.
161 * NOTE: obsolete from VER2 and on
162 * @beacon_template: beacon template ID
164 struct iwl_mac_data_ap {
168 __le32 bi_reciprocal;
169 __le32 dtim_interval;
170 __le32 dtim_reciprocal;
172 __le32 beacon_template;
173 } __packed; /* AP_MAC_DATA_API_S_VER_2 */
176 * struct iwl_mac_data_ibss - configuration data for IBSS MAC context
177 * @beacon_time: beacon transmit time in system time
178 * @beacon_tsf: beacon transmit time in TSF
179 * @bi: beacon interval in TU
180 * @bi_reciprocal: 2^32 / bi
181 * @beacon_template: beacon template ID
183 struct iwl_mac_data_ibss {
187 __le32 bi_reciprocal;
188 __le32 beacon_template;
189 } __packed; /* IBSS_MAC_DATA_API_S_VER_1 */
192 * struct iwl_mac_data_sta - configuration data for station MAC context
193 * @is_assoc: 1 for associated state, 0 otherwise
194 * @dtim_time: DTIM arrival time in system time
195 * @dtim_tsf: DTIM arrival time in TSF
196 * @bi: beacon interval in TU, applicable only when associated
197 * @bi_reciprocal: 2^32 / bi , applicable only when associated
198 * @dtim_interval: DTIM interval in TU, applicable only when associated
199 * @dtim_reciprocal: 2^32 / dtim_interval , applicable only when associated
200 * @listen_interval: in beacon intervals, applicable only when associated
201 * @assoc_id: unique ID assigned by the AP during association
203 struct iwl_mac_data_sta {
208 __le32 bi_reciprocal;
209 __le32 dtim_interval;
210 __le32 dtim_reciprocal;
211 __le32 listen_interval;
213 __le32 assoc_beacon_arrive_time;
214 } __packed; /* STA_MAC_DATA_API_S_VER_1 */
217 * struct iwl_mac_data_go - configuration data for P2P GO MAC context
218 * @ap: iwl_mac_data_ap struct with most config data
219 * @ctwin: client traffic window in TU (period after TBTT when GO is present).
220 * 0 indicates that there is no CT window.
221 * @opp_ps_enabled: indicate that opportunistic PS allowed
223 struct iwl_mac_data_go {
224 struct iwl_mac_data_ap ap;
226 __le32 opp_ps_enabled;
227 } __packed; /* GO_MAC_DATA_API_S_VER_1 */
230 * struct iwl_mac_data_p2p_sta - configuration data for P2P client MAC context
231 * @sta: iwl_mac_data_sta struct with most config data
232 * @ctwin: client traffic window in TU (period after TBTT when GO is present).
233 * 0 indicates that there is no CT window.
235 struct iwl_mac_data_p2p_sta {
236 struct iwl_mac_data_sta sta;
238 } __packed; /* P2P_STA_MAC_DATA_API_S_VER_1 */
241 * struct iwl_mac_data_pibss - Pseudo IBSS config data
242 * @stats_interval: interval in TU between statistics notifications to host.
244 struct iwl_mac_data_pibss {
245 __le32 stats_interval;
246 } __packed; /* PIBSS_MAC_DATA_API_S_VER_1 */
249 * struct iwl_mac_data_p2p_dev - configuration data for the P2P Device MAC
251 * @is_disc_extended: if set to true, P2P Device discoverability is enabled on
252 * other channels as well. This should be to true only in case that the
253 * device is discoverable and there is an active GO. Note that setting this
254 * field when not needed, will increase the number of interrupts and have
255 * effect on the platform power, as this setting opens the Rx filters on
258 struct iwl_mac_data_p2p_dev {
259 __le32 is_disc_extended;
260 } __packed; /* _P2P_DEV_MAC_DATA_API_S_VER_1 */
263 * enum iwl_mac_filter_flags - MAC context filter flags
264 * @MAC_FILTER_IN_PROMISC: accept all data frames
265 * @MAC_FILTER_IN_CONTROL_AND_MGMT: pass all management and
266 * control frames to the host
267 * @MAC_FILTER_ACCEPT_GRP: accept multicast frames
268 * @MAC_FILTER_DIS_DECRYPT: don't decrypt unicast frames
269 * @MAC_FILTER_DIS_GRP_DECRYPT: don't decrypt multicast frames
270 * @MAC_FILTER_IN_BEACON: transfer foreign BSS's beacons to host
271 * (in station mode when associated)
272 * @MAC_FILTER_OUT_BCAST: filter out all broadcast frames
273 * @MAC_FILTER_IN_CRC32: extract FCS and append it to frames
274 * @MAC_FILTER_IN_PROBE_REQUEST: pass probe requests to host
276 enum iwl_mac_filter_flags {
277 MAC_FILTER_IN_PROMISC = BIT(0),
278 MAC_FILTER_IN_CONTROL_AND_MGMT = BIT(1),
279 MAC_FILTER_ACCEPT_GRP = BIT(2),
280 MAC_FILTER_DIS_DECRYPT = BIT(3),
281 MAC_FILTER_DIS_GRP_DECRYPT = BIT(4),
282 MAC_FILTER_IN_BEACON = BIT(6),
283 MAC_FILTER_OUT_BCAST = BIT(8),
284 MAC_FILTER_IN_CRC32 = BIT(11),
285 MAC_FILTER_IN_PROBE_REQUEST = BIT(12),
289 * enum iwl_mac_qos_flags - QoS flags
290 * @MAC_QOS_FLG_UPDATE_EDCA: ?
291 * @MAC_QOS_FLG_TGN: HT is enabled
292 * @MAC_QOS_FLG_TXOP_TYPE: ?
295 enum iwl_mac_qos_flags {
296 MAC_QOS_FLG_UPDATE_EDCA = BIT(0),
297 MAC_QOS_FLG_TGN = BIT(1),
298 MAC_QOS_FLG_TXOP_TYPE = BIT(4),
302 * struct iwl_ac_qos - QOS timing params for MAC_CONTEXT_CMD
303 * @cw_min: Contention window, start value in numbers of slots.
304 * Should be a power-of-2, minus 1. Device's default is 0x0f.
305 * @cw_max: Contention window, max value in numbers of slots.
306 * Should be a power-of-2, minus 1. Device's default is 0x3f.
307 * @aifsn: Number of slots in Arbitration Interframe Space (before
308 * performing random backoff timing prior to Tx). Device default 1.
309 * @fifos_mask: FIFOs used by this MAC for this AC
310 * @edca_txop: Length of Tx opportunity, in uSecs. Device default is 0.
312 * One instance of this config struct for each of 4 EDCA access categories
313 * in struct iwl_qosparam_cmd.
315 * Device will automatically increase contention window by (2*CW) + 1 for each
316 * transmission retry. Device uses cw_max as a bit mask, ANDed with new CW
317 * value, to cap the CW value.
325 } __packed; /* AC_QOS_API_S_VER_2 */
328 * struct iwl_mac_ctx_cmd - command structure to configure MAC contexts
329 * ( MAC_CONTEXT_CMD = 0x28 )
330 * @id_and_color: ID and color of the MAC
331 * @action: action to perform, one of FW_CTXT_ACTION_*
332 * @mac_type: one of FW_MAC_TYPE_*
333 * @tsd_id: TSF HW timer, one of TSF_ID_*
334 * @node_addr: MAC address
336 * @cck_rates: basic rates available for CCK
337 * @ofdm_rates: basic rates available for OFDM
338 * @protection_flags: combination of MAC_PROT_FLG_FLAG_*
339 * @cck_short_preamble: 0x20 for enabling short preamble, 0 otherwise
340 * @short_slot: 0x10 for enabling short slots, 0 otherwise
341 * @filter_flags: combination of MAC_FILTER_*
342 * @qos_flags: from MAC_QOS_FLG_*
343 * @ac: one iwl_mac_qos configuration for each AC
344 * @mac_specific: one of struct iwl_mac_data_*, according to mac_type
346 struct iwl_mac_ctx_cmd {
347 /* COMMON_INDEX_HDR_API_S_VER_1 */
350 /* MAC_CONTEXT_COMMON_DATA_API_S_VER_1 */
354 __le16 reserved_for_node_addr;
356 __le16 reserved_for_bssid_addr;
359 __le32 protection_flags;
360 __le32 cck_short_preamble;
363 /* MAC_QOS_PARAM_API_S_VER_1 */
365 struct iwl_ac_qos ac[AC_NUM+1];
366 /* MAC_CONTEXT_COMMON_DATA_API_S */
368 struct iwl_mac_data_ap ap;
369 struct iwl_mac_data_go go;
370 struct iwl_mac_data_sta sta;
371 struct iwl_mac_data_p2p_sta p2p_sta;
372 struct iwl_mac_data_p2p_dev p2p_dev;
373 struct iwl_mac_data_pibss pibss;
374 struct iwl_mac_data_ibss ibss;
376 } __packed; /* MAC_CONTEXT_CMD_API_S_VER_1 */
378 static inline u32 iwl_mvm_reciprocal(u32 v)
382 return 0xFFFFFFFF / v;
385 #define IWL_NONQOS_SEQ_GET 0x1
386 #define IWL_NONQOS_SEQ_SET 0x2
387 struct iwl_nonqos_seq_query_cmd {
389 __le32 mac_id_n_color;
392 } __packed; /* NON_QOS_TX_COUNTER_GET_SET_API_S_VER_1 */
394 #endif /* __fw_api_mac_h__ */