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) 2008 - 2014 Intel Corporation. All rights reserved.
9 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
10 * Copyright(c) 2016 Intel Deutschland GmbH
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of version 2 of the GNU General Public License as
14 * published by the Free Software Foundation.
16 * This program is distributed in the hope that it will be useful, but
17 * WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
26 * The full GNU General Public License is included in this distribution
27 * in the file called COPYING.
29 * Contact Information:
30 * Intel Linux Wireless <linuxwifi@intel.com>
31 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
35 * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
36 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
37 * Copyright(c) 2016 Intel Deutschland GmbH
38 * All rights reserved.
40 * Redistribution and use in source and binary forms, with or without
41 * modification, are permitted provided that the following conditions
44 * * Redistributions of source code must retain the above copyright
45 * notice, this list of conditions and the following disclaimer.
46 * * Redistributions in binary form must reproduce the above copyright
47 * notice, this list of conditions and the following disclaimer in
48 * the documentation and/or other materials provided with the
50 * * Neither the name Intel Corporation nor the names of its
51 * contributors may be used to endorse or promote products derived
52 * from this software without specific prior written permission.
54 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
55 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
56 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
57 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
58 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
59 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
60 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
61 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
62 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
63 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
64 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
65 *****************************************************************************/
67 #ifndef __iwl_fw_file_h__
68 #define __iwl_fw_file_h__
70 #include <linux/netdevice.h>
71 #include <linux/nl80211.h>
73 /* v1/v2 uCode file layout */
74 struct iwl_ucode_header {
75 __le32 ver; /* major/minor/API/serial */
78 __le32 inst_size; /* bytes of runtime code */
79 __le32 data_size; /* bytes of runtime data */
80 __le32 init_size; /* bytes of init code */
81 __le32 init_data_size; /* bytes of init data */
82 __le32 boot_size; /* bytes of bootstrap code */
83 u8 data[0]; /* in same order as sizes */
86 __le32 build; /* build number */
87 __le32 inst_size; /* bytes of runtime code */
88 __le32 data_size; /* bytes of runtime data */
89 __le32 init_size; /* bytes of init code */
90 __le32 init_data_size; /* bytes of init data */
91 __le32 boot_size; /* bytes of bootstrap code */
92 u8 data[0]; /* in same order as sizes */
98 * new TLV uCode file layout
100 * The new TLV file format contains TLVs, that each specify
101 * some piece of data.
104 enum iwl_ucode_tlv_type {
105 IWL_UCODE_TLV_INVALID = 0, /* unused */
106 IWL_UCODE_TLV_INST = 1,
107 IWL_UCODE_TLV_DATA = 2,
108 IWL_UCODE_TLV_INIT = 3,
109 IWL_UCODE_TLV_INIT_DATA = 4,
110 IWL_UCODE_TLV_BOOT = 5,
111 IWL_UCODE_TLV_PROBE_MAX_LEN = 6, /* a u32 value */
112 IWL_UCODE_TLV_PAN = 7,
113 IWL_UCODE_TLV_RUNT_EVTLOG_PTR = 8,
114 IWL_UCODE_TLV_RUNT_EVTLOG_SIZE = 9,
115 IWL_UCODE_TLV_RUNT_ERRLOG_PTR = 10,
116 IWL_UCODE_TLV_INIT_EVTLOG_PTR = 11,
117 IWL_UCODE_TLV_INIT_EVTLOG_SIZE = 12,
118 IWL_UCODE_TLV_INIT_ERRLOG_PTR = 13,
119 IWL_UCODE_TLV_ENHANCE_SENS_TBL = 14,
120 IWL_UCODE_TLV_PHY_CALIBRATION_SIZE = 15,
121 IWL_UCODE_TLV_WOWLAN_INST = 16,
122 IWL_UCODE_TLV_WOWLAN_DATA = 17,
123 IWL_UCODE_TLV_FLAGS = 18,
124 IWL_UCODE_TLV_SEC_RT = 19,
125 IWL_UCODE_TLV_SEC_INIT = 20,
126 IWL_UCODE_TLV_SEC_WOWLAN = 21,
127 IWL_UCODE_TLV_DEF_CALIB = 22,
128 IWL_UCODE_TLV_PHY_SKU = 23,
129 IWL_UCODE_TLV_SECURE_SEC_RT = 24,
130 IWL_UCODE_TLV_SECURE_SEC_INIT = 25,
131 IWL_UCODE_TLV_SECURE_SEC_WOWLAN = 26,
132 IWL_UCODE_TLV_NUM_OF_CPU = 27,
133 IWL_UCODE_TLV_CSCHEME = 28,
134 IWL_UCODE_TLV_API_CHANGES_SET = 29,
135 IWL_UCODE_TLV_ENABLED_CAPABILITIES = 30,
136 IWL_UCODE_TLV_N_SCAN_CHANNELS = 31,
137 IWL_UCODE_TLV_PAGING = 32,
138 IWL_UCODE_TLV_SEC_RT_USNIFFER = 34,
139 IWL_UCODE_TLV_SDIO_ADMA_ADDR = 35,
140 IWL_UCODE_TLV_FW_VERSION = 36,
141 IWL_UCODE_TLV_FW_DBG_DEST = 38,
142 IWL_UCODE_TLV_FW_DBG_CONF = 39,
143 IWL_UCODE_TLV_FW_DBG_TRIGGER = 40,
144 IWL_UCODE_TLV_FW_GSCAN_CAPA = 50,
147 struct iwl_ucode_tlv {
148 __le32 type; /* see above */
149 __le32 length; /* not including type/length fields */
153 #define IWL_TLV_UCODE_MAGIC 0x0a4c5749
154 #define FW_VER_HUMAN_READABLE_SZ 64
156 struct iwl_tlv_ucode_header {
158 * The TLV style ucode header is distinguished from
159 * the v1/v2 style header by first four bytes being
160 * zero, as such is an invalid combination of
161 * major/minor/API/serial versions.
165 u8 human_readable[FW_VER_HUMAN_READABLE_SZ];
166 /* major/minor/API/serial or major in new format */
171 * The data contained herein has a TLV layout,
172 * see above for the TLV header and types.
173 * Note that each TLV is padded to a length
174 * that is a multiple of 4 for alignment.
182 * ability to get extension for: flags & capabilities from ucode binaries files
184 struct iwl_ucode_api {
189 struct iwl_ucode_capa {
195 * enum iwl_ucode_tlv_flag - ucode API flags
196 * @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously
197 * was a separate TLV but moved here to save space.
198 * @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behavior on hidden SSID,
199 * treats good CRC threshold as a boolean
200 * @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w).
201 * @IWL_UCODE_TLV_FLAGS_P2P: This uCode image supports P2P.
202 * @IWL_UCODE_TLV_FLAGS_DW_BC_TABLE: The SCD byte count table is in DWORDS
203 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: This uCode image supports uAPSD
204 * @IWL_UCODE_TLV_FLAGS_SHORT_BL: 16 entries of black list instead of 64 in scan
205 * offload profile config command.
206 * @IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS: D3 image supports up to six
207 * (rather than two) IPv6 addresses
208 * @IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID: not sending a probe with the SSID element
209 * from the probe request template.
210 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL: new NS offload (small version)
211 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE: new NS offload (large version)
212 * @IWL_UCODE_TLV_FLAGS_P2P_PM: P2P client supports PM as a stand alone MAC
213 * @IWL_UCODE_TLV_FLAGS_P2P_BSS_PS_DCM: support power save on BSS station and
214 * P2P client interfaces simultaneously if they are in different bindings.
215 * @IWL_UCODE_TLV_FLAGS_P2P_BSS_PS_SCM: support power save on BSS station and
216 * P2P client interfaces simultaneously if they are in same bindings.
217 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: General support for uAPSD
218 * @IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD: P2P client supports uAPSD power save
219 * @IWL_UCODE_TLV_FLAGS_BCAST_FILTERING: uCode supports broadcast filtering.
220 * @IWL_UCODE_TLV_FLAGS_GO_UAPSD: AP/GO interfaces support uAPSD clients
221 * @IWL_UCODE_TLV_FLAGS_EBS_SUPPORT: this uCode image supports EBS.
223 enum iwl_ucode_tlv_flag {
224 IWL_UCODE_TLV_FLAGS_PAN = BIT(0),
225 IWL_UCODE_TLV_FLAGS_NEWSCAN = BIT(1),
226 IWL_UCODE_TLV_FLAGS_MFP = BIT(2),
227 IWL_UCODE_TLV_FLAGS_P2P = BIT(3),
228 IWL_UCODE_TLV_FLAGS_DW_BC_TABLE = BIT(4),
229 IWL_UCODE_TLV_FLAGS_SHORT_BL = BIT(7),
230 IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS = BIT(10),
231 IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID = BIT(12),
232 IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL = BIT(15),
233 IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE = BIT(16),
234 IWL_UCODE_TLV_FLAGS_P2P_PM = BIT(21),
235 IWL_UCODE_TLV_FLAGS_BSS_P2P_PS_DCM = BIT(22),
236 IWL_UCODE_TLV_FLAGS_BSS_P2P_PS_SCM = BIT(23),
237 IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT = BIT(24),
238 IWL_UCODE_TLV_FLAGS_EBS_SUPPORT = BIT(25),
239 IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD = BIT(26),
240 IWL_UCODE_TLV_FLAGS_BCAST_FILTERING = BIT(29),
241 IWL_UCODE_TLV_FLAGS_GO_UAPSD = BIT(30),
244 typedef unsigned int __bitwise__ iwl_ucode_tlv_api_t;
247 * enum iwl_ucode_tlv_api - ucode api
248 * @IWL_UCODE_TLV_API_BT_COEX_SPLIT: new API for BT Coex
249 * @IWL_UCODE_TLV_API_FRAGMENTED_SCAN: This ucode supports active dwell time
250 * longer than the passive one, which is essential for fragmented scan.
251 * @IWL_UCODE_TLV_API_WIFI_MCC_UPDATE: ucode supports MCC updates with source.
252 * @IWL_UCODE_TLV_API_WIDE_CMD_HDR: ucode supports wide command header
253 * @IWL_UCODE_TLV_API_LQ_SS_PARAMS: Configure STBC/BFER via LQ CMD ss_params
254 * @IWL_UCODE_TLV_API_NEW_VERSION: new versioning format
255 * @IWL_UCODE_TLV_API_EXT_SCAN_PRIORITY: scan APIs use 8-level priority
257 * @IWL_UCODE_TLV_API_TX_POWER_CHAIN: TX power API has larger command size
258 * (command version 3) that supports per-chain limits
260 * @NUM_IWL_UCODE_TLV_API: number of bits used
262 enum iwl_ucode_tlv_api {
263 IWL_UCODE_TLV_API_BT_COEX_SPLIT = (__force iwl_ucode_tlv_api_t)3,
264 IWL_UCODE_TLV_API_FRAGMENTED_SCAN = (__force iwl_ucode_tlv_api_t)8,
265 IWL_UCODE_TLV_API_WIFI_MCC_UPDATE = (__force iwl_ucode_tlv_api_t)9,
266 IWL_UCODE_TLV_API_WIDE_CMD_HDR = (__force iwl_ucode_tlv_api_t)14,
267 IWL_UCODE_TLV_API_LQ_SS_PARAMS = (__force iwl_ucode_tlv_api_t)18,
268 IWL_UCODE_TLV_API_NEW_VERSION = (__force iwl_ucode_tlv_api_t)20,
269 IWL_UCODE_TLV_API_EXT_SCAN_PRIORITY = (__force iwl_ucode_tlv_api_t)24,
270 IWL_UCODE_TLV_API_TX_POWER_CHAIN = (__force iwl_ucode_tlv_api_t)27,
272 NUM_IWL_UCODE_TLV_API
274 /* sparse says it cannot increment the previous enum member */
279 typedef unsigned int __bitwise__ iwl_ucode_tlv_capa_t;
282 * enum iwl_ucode_tlv_capa - ucode capabilities
283 * @IWL_UCODE_TLV_CAPA_D0I3_SUPPORT: supports D0i3
284 * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT: supports Location Aware Regulatory
285 * @IWL_UCODE_TLV_CAPA_UMAC_SCAN: supports UMAC scan.
286 * @IWL_UCODE_TLV_CAPA_BEAMFORMER: supports Beamformer
287 * @IWL_UCODE_TLV_CAPA_TOF_SUPPORT: supports Time of Flight (802.11mc FTM)
288 * @IWL_UCODE_TLV_CAPA_TDLS_SUPPORT: support basic TDLS functionality
289 * @IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT: supports insertion of current
290 * tx power value into TPC Report action frame and Link Measurement Report
292 * @IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT: supports updating current
293 * channel in DS parameter set element in probe requests.
294 * @IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT: supports adding TPC Report IE in
296 * @IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT: supports Quiet Period requests
297 * @IWL_UCODE_TLV_CAPA_DQA_SUPPORT: supports dynamic queue allocation (DQA),
298 * which also implies support for the scheduler configuration command
299 * @IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH: supports TDLS channel switching
300 * @IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT: supports Hot Spot Command
301 * @IWL_UCODE_TLV_CAPA_DC2DC_SUPPORT: supports DC2DC Command
302 * @IWL_UCODE_TLV_CAPA_CSUM_SUPPORT: supports TCP Checksum Offload
303 * @IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS: support radio and beacon statistics
304 * @IWL_UCODE_TLV_CAPA_BT_COEX_PLCR: enabled BT Coex packet level co-running
305 * @IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC: ucode supports LAR updates with different
306 * sources for the MCC. This TLV bit is a future replacement to
307 * IWL_UCODE_TLV_API_WIFI_MCC_UPDATE. When either is set, multi-source LAR
309 * @IWL_UCODE_TLV_CAPA_BT_COEX_RRC: supports BT Coex RRC
310 * @IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT: supports gscan
311 * @IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE: extended DTS measurement
312 * @IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS: supports short PM timeouts
313 * @IWL_UCODE_TLV_CAPA_BT_MPLUT_SUPPORT: supports bt-coex Multi-priority LUT
314 * @IWL_UCODE_TLV_CAPA_BEACON_ANT_SELECTION: firmware will decide on what
315 * antenna the beacon should be transmitted
316 * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT_V2: support LAR API V2
318 * @NUM_IWL_UCODE_TLV_CAPA: number of bits used
320 enum iwl_ucode_tlv_capa {
321 IWL_UCODE_TLV_CAPA_D0I3_SUPPORT = (__force iwl_ucode_tlv_capa_t)0,
322 IWL_UCODE_TLV_CAPA_LAR_SUPPORT = (__force iwl_ucode_tlv_capa_t)1,
323 IWL_UCODE_TLV_CAPA_UMAC_SCAN = (__force iwl_ucode_tlv_capa_t)2,
324 IWL_UCODE_TLV_CAPA_BEAMFORMER = (__force iwl_ucode_tlv_capa_t)3,
325 IWL_UCODE_TLV_CAPA_TOF_SUPPORT = (__force iwl_ucode_tlv_capa_t)5,
326 IWL_UCODE_TLV_CAPA_TDLS_SUPPORT = (__force iwl_ucode_tlv_capa_t)6,
327 IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT = (__force iwl_ucode_tlv_capa_t)8,
328 IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT = (__force iwl_ucode_tlv_capa_t)9,
329 IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT = (__force iwl_ucode_tlv_capa_t)10,
330 IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT = (__force iwl_ucode_tlv_capa_t)11,
331 IWL_UCODE_TLV_CAPA_DQA_SUPPORT = (__force iwl_ucode_tlv_capa_t)12,
332 IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH = (__force iwl_ucode_tlv_capa_t)13,
333 IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT = (__force iwl_ucode_tlv_capa_t)18,
334 IWL_UCODE_TLV_CAPA_DC2DC_CONFIG_SUPPORT = (__force iwl_ucode_tlv_capa_t)19,
335 IWL_UCODE_TLV_CAPA_CSUM_SUPPORT = (__force iwl_ucode_tlv_capa_t)21,
336 IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS = (__force iwl_ucode_tlv_capa_t)22,
337 IWL_UCODE_TLV_CAPA_BT_COEX_PLCR = (__force iwl_ucode_tlv_capa_t)28,
338 IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC = (__force iwl_ucode_tlv_capa_t)29,
339 IWL_UCODE_TLV_CAPA_BT_COEX_RRC = (__force iwl_ucode_tlv_capa_t)30,
340 IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT = (__force iwl_ucode_tlv_capa_t)31,
341 IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE = (__force iwl_ucode_tlv_capa_t)64,
342 IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS = (__force iwl_ucode_tlv_capa_t)65,
343 IWL_UCODE_TLV_CAPA_BT_MPLUT_SUPPORT = (__force iwl_ucode_tlv_capa_t)67,
344 IWL_UCODE_TLV_CAPA_BEACON_ANT_SELECTION = (__force iwl_ucode_tlv_capa_t)71,
345 IWL_UCODE_TLV_CAPA_LAR_SUPPORT_V2 = (__force iwl_ucode_tlv_capa_t)73,
347 NUM_IWL_UCODE_TLV_CAPA
349 /* sparse says it cannot increment the previous enum member */
354 /* The default calibrate table size if not specified by firmware file */
355 #define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE 18
356 #define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE 19
357 #define IWL_MAX_PHY_CALIBRATE_TBL_SIZE 253
359 /* The default max probe length if not specified by the firmware file */
360 #define IWL_DEFAULT_MAX_PROBE_LENGTH 200
363 * For 16.0 uCode and above, there is no differentiation between sections,
364 * just an offset to the HW address.
366 #define IWL_UCODE_SECTION_MAX 16
367 #define CPU1_CPU2_SEPARATOR_SECTION 0xFFFFCCCC
368 #define PAGING_SEPARATOR_SECTION 0xAAAABBBB
370 /* uCode version contains 4 values: Major/Minor/API/Serial */
371 #define IWL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24)
372 #define IWL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16)
373 #define IWL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8)
374 #define IWL_UCODE_SERIAL(ver) ((ver) & 0x000000FF)
377 * Calibration control struct.
378 * Sent as part of the phy configuration command.
379 * @flow_trigger: bitmap for which calibrations to perform according to
381 * @event_trigger: bitmap for which calibrations to perform according to
384 struct iwl_tlv_calib_ctrl {
386 __le32 event_trigger;
389 enum iwl_fw_phy_cfg {
390 FW_PHY_CFG_RADIO_TYPE_POS = 0,
391 FW_PHY_CFG_RADIO_TYPE = 0x3 << FW_PHY_CFG_RADIO_TYPE_POS,
392 FW_PHY_CFG_RADIO_STEP_POS = 2,
393 FW_PHY_CFG_RADIO_STEP = 0x3 << FW_PHY_CFG_RADIO_STEP_POS,
394 FW_PHY_CFG_RADIO_DASH_POS = 4,
395 FW_PHY_CFG_RADIO_DASH = 0x3 << FW_PHY_CFG_RADIO_DASH_POS,
396 FW_PHY_CFG_TX_CHAIN_POS = 16,
397 FW_PHY_CFG_TX_CHAIN = 0xf << FW_PHY_CFG_TX_CHAIN_POS,
398 FW_PHY_CFG_RX_CHAIN_POS = 20,
399 FW_PHY_CFG_RX_CHAIN = 0xf << FW_PHY_CFG_RX_CHAIN_POS,
402 #define IWL_UCODE_MAX_CS 1
405 * struct iwl_fw_cipher_scheme - a cipher scheme supported by FW.
406 * @cipher: a cipher suite selector
407 * @flags: cipher scheme flags (currently reserved for a future use)
408 * @hdr_len: a size of MPDU security header
409 * @pn_len: a size of PN
410 * @pn_off: an offset of pn from the beginning of the security header
411 * @key_idx_off: an offset of key index byte in the security header
412 * @key_idx_mask: a bit mask of key_idx bits
413 * @key_idx_shift: bit shift needed to get key_idx
414 * @mic_len: mic length in bytes
415 * @hw_cipher: a HW cipher index used in host commands
417 struct iwl_fw_cipher_scheme {
430 enum iwl_fw_dbg_reg_operator {
447 * struct iwl_fw_dbg_reg_op - an operation on a register
449 * @op: %enum iwl_fw_dbg_reg_operator
450 * @addr: offset of the register
453 struct iwl_fw_dbg_reg_op {
461 * enum iwl_fw_dbg_monitor_mode - available monitor recording modes
463 * @SMEM_MODE: monitor stores the data in SMEM
464 * @EXTERNAL_MODE: monitor stores the data in allocated DRAM
465 * @MARBH_MODE: monitor stores the data in MARBH buffer
466 * @MIPI_MODE: monitor outputs the data through the MIPI interface
468 enum iwl_fw_dbg_monitor_mode {
476 * struct iwl_fw_dbg_dest_tlv - configures the destination of the debug data
478 * @version: version of the TLV - currently 0
479 * @monitor_mode: %enum iwl_fw_dbg_monitor_mode
480 * @size_power: buffer size will be 2^(size_power + 11)
481 * @base_reg: addr of the base addr register (PRPH)
482 * @end_reg: addr of the end addr register (PRPH)
483 * @write_ptr_reg: the addr of the reg of the write pointer
484 * @wrap_count: the addr of the reg of the wrap_count
485 * @base_shift: shift right of the base addr reg
486 * @end_shift: shift right of the end addr reg
487 * @reg_ops: array of registers operations
489 * This parses IWL_UCODE_TLV_FW_DBG_DEST
491 struct iwl_fw_dbg_dest_tlv {
498 __le32 write_ptr_reg;
502 struct iwl_fw_dbg_reg_op reg_ops[0];
505 struct iwl_fw_dbg_conf_hcmd {
513 * enum iwl_fw_dbg_trigger_mode - triggers functionalities
515 * @IWL_FW_DBG_TRIGGER_START: when trigger occurs re-conf the dbg mechanism
516 * @IWL_FW_DBG_TRIGGER_STOP: when trigger occurs pull the dbg data
517 * @IWL_FW_DBG_TRIGGER_MONITOR_ONLY: when trigger occurs trigger is set to
518 * collect only monitor data
520 enum iwl_fw_dbg_trigger_mode {
521 IWL_FW_DBG_TRIGGER_START = BIT(0),
522 IWL_FW_DBG_TRIGGER_STOP = BIT(1),
523 IWL_FW_DBG_TRIGGER_MONITOR_ONLY = BIT(2),
527 * enum iwl_fw_dbg_trigger_vif_type - define the VIF type for a trigger
528 * @IWL_FW_DBG_CONF_VIF_ANY: any vif type
529 * @IWL_FW_DBG_CONF_VIF_IBSS: IBSS mode
530 * @IWL_FW_DBG_CONF_VIF_STATION: BSS mode
531 * @IWL_FW_DBG_CONF_VIF_AP: AP mode
532 * @IWL_FW_DBG_CONF_VIF_P2P_CLIENT: P2P Client mode
533 * @IWL_FW_DBG_CONF_VIF_P2P_GO: P2P GO mode
534 * @IWL_FW_DBG_CONF_VIF_P2P_DEVICE: P2P device
536 enum iwl_fw_dbg_trigger_vif_type {
537 IWL_FW_DBG_CONF_VIF_ANY = NL80211_IFTYPE_UNSPECIFIED,
538 IWL_FW_DBG_CONF_VIF_IBSS = NL80211_IFTYPE_ADHOC,
539 IWL_FW_DBG_CONF_VIF_STATION = NL80211_IFTYPE_STATION,
540 IWL_FW_DBG_CONF_VIF_AP = NL80211_IFTYPE_AP,
541 IWL_FW_DBG_CONF_VIF_P2P_CLIENT = NL80211_IFTYPE_P2P_CLIENT,
542 IWL_FW_DBG_CONF_VIF_P2P_GO = NL80211_IFTYPE_P2P_GO,
543 IWL_FW_DBG_CONF_VIF_P2P_DEVICE = NL80211_IFTYPE_P2P_DEVICE,
547 * struct iwl_fw_dbg_trigger_tlv - a TLV that describes the trigger
548 * @id: %enum iwl_fw_dbg_trigger
549 * @vif_type: %enum iwl_fw_dbg_trigger_vif_type
550 * @stop_conf_ids: bitmap of configurations this trigger relates to.
551 * if the mode is %IWL_FW_DBG_TRIGGER_STOP, then if the bit corresponding
552 * to the currently running configuration is set, the data should be
554 * @stop_delay: how many milliseconds to wait before collecting the data
555 * after the STOP trigger fires.
556 * @mode: %enum iwl_fw_dbg_trigger_mode - can be stop / start of both
557 * @start_conf_id: if mode is %IWL_FW_DBG_TRIGGER_START, this defines what
558 * configuration should be applied when the triggers kicks in.
559 * @occurrences: number of occurrences. 0 means the trigger will never fire.
560 * @trig_dis_ms: the time, in milliseconds, after an occurrence of this
561 * trigger in which another occurrence should be ignored.
563 struct iwl_fw_dbg_trigger_tlv {
566 __le32 stop_conf_ids;
577 #define FW_DBG_START_FROM_ALIVE 0
578 #define FW_DBG_CONF_MAX 32
579 #define FW_DBG_INVALID 0xff
582 * struct iwl_fw_dbg_trigger_missed_bcon - configures trigger for missed beacons
583 * @stop_consec_missed_bcon: stop recording if threshold is crossed.
584 * @stop_consec_missed_bcon_since_rx: stop recording if threshold is crossed.
585 * @start_consec_missed_bcon: start recording if threshold is crossed.
586 * @start_consec_missed_bcon_since_rx: start recording if threshold is crossed.
587 * @reserved1: reserved
588 * @reserved2: reserved
590 struct iwl_fw_dbg_trigger_missed_bcon {
591 __le32 stop_consec_missed_bcon;
592 __le32 stop_consec_missed_bcon_since_rx;
594 __le32 start_consec_missed_bcon;
595 __le32 start_consec_missed_bcon_since_rx;
600 * struct iwl_fw_dbg_trigger_cmd - configures trigger for messages from FW.
601 * cmds: the list of commands to trigger the collection on
603 struct iwl_fw_dbg_trigger_cmd {
611 * iwl_fw_dbg_trigger_stats - configures trigger for statistics
612 * @stop_offset: the offset of the value to be monitored
613 * @stop_threshold: the threshold above which to collect
614 * @start_offset: the offset of the value to be monitored
615 * @start_threshold: the threshold above which to start recording
617 struct iwl_fw_dbg_trigger_stats {
619 __le32 stop_threshold;
621 __le32 start_threshold;
625 * struct iwl_fw_dbg_trigger_low_rssi - trigger for low beacon RSSI
626 * @rssi: RSSI value to trigger at
628 struct iwl_fw_dbg_trigger_low_rssi {
633 * struct iwl_fw_dbg_trigger_mlme - configures trigger for mlme events
634 * @stop_auth_denied: number of denied authentication to collect
635 * @stop_auth_timeout: number of authentication timeout to collect
636 * @stop_rx_deauth: number of Rx deauth before to collect
637 * @stop_tx_deauth: number of Tx deauth before to collect
638 * @stop_assoc_denied: number of denied association to collect
639 * @stop_assoc_timeout: number of association timeout to collect
640 * @stop_connection_loss: number of connection loss to collect
641 * @start_auth_denied: number of denied authentication to start recording
642 * @start_auth_timeout: number of authentication timeout to start recording
643 * @start_rx_deauth: number of Rx deauth to start recording
644 * @start_tx_deauth: number of Tx deauth to start recording
645 * @start_assoc_denied: number of denied association to start recording
646 * @start_assoc_timeout: number of association timeout to start recording
647 * @start_connection_loss: number of connection loss to start recording
649 struct iwl_fw_dbg_trigger_mlme {
651 u8 stop_auth_timeout;
655 u8 stop_assoc_denied;
656 u8 stop_assoc_timeout;
657 u8 stop_connection_loss;
660 u8 start_auth_denied;
661 u8 start_auth_timeout;
665 u8 start_assoc_denied;
666 u8 start_assoc_timeout;
667 u8 start_connection_loss;
672 * struct iwl_fw_dbg_trigger_txq_timer - configures the Tx queue's timer
673 * @command_queue: timeout for the command queue in ms
674 * @bss: timeout for the queues of a BSS (except for TDLS queues) in ms
675 * @softap: timeout for the queues of a softAP in ms
676 * @p2p_go: timeout for the queues of a P2P GO in ms
677 * @p2p_client: timeout for the queues of a P2P client in ms
678 * @p2p_device: timeout for the queues of a P2P device in ms
679 * @ibss: timeout for the queues of an IBSS in ms
680 * @tdls: timeout for the queues of a TDLS station in ms
682 struct iwl_fw_dbg_trigger_txq_timer {
683 __le32 command_queue;
695 * struct iwl_fw_dbg_trigger_time_event - configures a time event trigger
696 * time_Events: a list of tuples <id, action_bitmap>. The driver will issue a
697 * trigger each time a time event notification that relates to time event
698 * id with one of the actions in the bitmap is received and
699 * BIT(notif->status) is set in status_bitmap.
702 struct iwl_fw_dbg_trigger_time_event {
705 __le32 action_bitmap;
706 __le32 status_bitmap;
707 } __packed time_events[16];
711 * struct iwl_fw_dbg_trigger_ba - configures BlockAck related trigger
712 * rx_ba_start: tid bitmap to configure on what tid the trigger should occur
713 * when an Rx BlockAck session is started.
714 * rx_ba_stop: tid bitmap to configure on what tid the trigger should occur
715 * when an Rx BlockAck session is stopped.
716 * tx_ba_start: tid bitmap to configure on what tid the trigger should occur
717 * when a Tx BlockAck session is started.
718 * tx_ba_stop: tid bitmap to configure on what tid the trigger should occur
719 * when a Tx BlockAck session is stopped.
720 * rx_bar: tid bitmap to configure on what tid the trigger should occur
721 * when a BAR is received (for a Tx BlockAck session).
722 * tx_bar: tid bitmap to configure on what tid the trigger should occur
723 * when a BAR is send (for an Rx BlocAck session).
724 * frame_timeout: tid bitmap to configure on what tid the trigger should occur
725 * when a frame times out in the reodering buffer.
727 struct iwl_fw_dbg_trigger_ba {
734 __le16 frame_timeout;
738 * struct iwl_fw_dbg_trigger_tdls - configures trigger for TDLS events.
739 * @action_bitmap: the TDLS action to trigger the collection upon
740 * @peer_mode: trigger on specific peer or all
741 * @peer: the TDLS peer to trigger the collection on
743 struct iwl_fw_dbg_trigger_tdls {
751 * struct iwl_fw_dbg_conf_tlv - a TLV that describes a debug configuration.
753 * @usniffer: should the uSniffer image be used
754 * @num_of_hcmds: how many HCMDs to send are present here
755 * @hcmd: a variable length host command to be sent to apply the configuration.
756 * If there is more than one HCMD to send, they will appear one after the
757 * other and be sent in the order that they appear in.
758 * This parses IWL_UCODE_TLV_FW_DBG_CONF. The user can add up-to
759 * %FW_DBG_CONF_MAX configuration per run.
761 struct iwl_fw_dbg_conf_tlv {
766 struct iwl_fw_dbg_conf_hcmd hcmd;
770 * struct iwl_fw_gscan_capabilities - gscan capabilities supported by FW
771 * @max_scan_cache_size: total space allocated for scan results (in bytes).
772 * @max_scan_buckets: maximum number of channel buckets.
773 * @max_ap_cache_per_scan: maximum number of APs that can be stored per scan.
774 * @max_rssi_sample_size: number of RSSI samples used for averaging RSSI.
775 * @max_scan_reporting_threshold: max possible report threshold. in percentage.
776 * @max_hotlist_aps: maximum number of entries for hotlist APs.
777 * @max_significant_change_aps: maximum number of entries for significant
779 * @max_bssid_history_entries: number of BSSID/RSSI entries that the device can
782 struct iwl_fw_gscan_capabilities {
783 __le32 max_scan_cache_size;
784 __le32 max_scan_buckets;
785 __le32 max_ap_cache_per_scan;
786 __le32 max_rssi_sample_size;
787 __le32 max_scan_reporting_threshold;
788 __le32 max_hotlist_aps;
789 __le32 max_significant_change_aps;
790 __le32 max_bssid_history_entries;
793 #endif /* __iwl_fw_file_h__ */