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 - 2017 Intel Deutschland GmbH
11 * Copyright(c) 2018 Intel Corporation
12 * Copyright(c) 2019 Intel Corporation
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of version 2 of the GNU General Public License as
16 * published by the Free Software Foundation.
18 * This program is distributed in the hope that it will be useful, but
19 * WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 * General Public License for more details.
23 * The full GNU General Public License is included in this distribution
24 * in the file called COPYING.
26 * Contact Information:
28 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
32 * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
33 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
34 * Copyright(c) 2016 - 2017 Intel Deutschland GmbH
35 * Copyright(c) 2018 Intel Corporation
36 * Copyright(c) 2019 Intel Corporation
37 * All rights reserved.
39 * Redistribution and use in source and binary forms, with or without
40 * modification, are permitted provided that the following conditions
43 * * Redistributions of source code must retain the above copyright
44 * notice, this list of conditions and the following disclaimer.
45 * * Redistributions in binary form must reproduce the above copyright
46 * notice, this list of conditions and the following disclaimer in
47 * the documentation and/or other materials provided with the
49 * * Neither the name Intel Corporation nor the names of its
50 * contributors may be used to endorse or promote products derived
51 * from this software without specific prior written permission.
53 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
54 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
55 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
56 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
57 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
58 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
59 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
60 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
61 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
62 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
63 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
64 *****************************************************************************/
66 #ifndef __iwl_fw_file_h__
67 #define __iwl_fw_file_h__
69 #include <linux/netdevice.h>
70 #include <linux/nl80211.h>
72 /* v1/v2 uCode file layout */
73 struct iwl_ucode_header {
74 __le32 ver; /* major/minor/API/serial */
77 __le32 inst_size; /* bytes of runtime code */
78 __le32 data_size; /* bytes of runtime data */
79 __le32 init_size; /* bytes of init code */
80 __le32 init_data_size; /* bytes of init data */
81 __le32 boot_size; /* bytes of bootstrap code */
82 u8 data[0]; /* in same order as sizes */
85 __le32 build; /* build number */
86 __le32 inst_size; /* bytes of runtime code */
87 __le32 data_size; /* bytes of runtime data */
88 __le32 init_size; /* bytes of init code */
89 __le32 init_data_size; /* bytes of init data */
90 __le32 boot_size; /* bytes of bootstrap code */
91 u8 data[0]; /* in same order as sizes */
96 #define IWL_UCODE_INI_TLV_GROUP 0x1000000
99 * new TLV uCode file layout
101 * The new TLV file format contains TLVs, that each specify
102 * some piece of data.
105 enum iwl_ucode_tlv_type {
106 IWL_UCODE_TLV_INVALID = 0, /* unused */
107 IWL_UCODE_TLV_INST = 1,
108 IWL_UCODE_TLV_DATA = 2,
109 IWL_UCODE_TLV_INIT = 3,
110 IWL_UCODE_TLV_INIT_DATA = 4,
111 IWL_UCODE_TLV_BOOT = 5,
112 IWL_UCODE_TLV_PROBE_MAX_LEN = 6, /* a u32 value */
113 IWL_UCODE_TLV_PAN = 7,
114 IWL_UCODE_TLV_RUNT_EVTLOG_PTR = 8,
115 IWL_UCODE_TLV_RUNT_EVTLOG_SIZE = 9,
116 IWL_UCODE_TLV_RUNT_ERRLOG_PTR = 10,
117 IWL_UCODE_TLV_INIT_EVTLOG_PTR = 11,
118 IWL_UCODE_TLV_INIT_EVTLOG_SIZE = 12,
119 IWL_UCODE_TLV_INIT_ERRLOG_PTR = 13,
120 IWL_UCODE_TLV_ENHANCE_SENS_TBL = 14,
121 IWL_UCODE_TLV_PHY_CALIBRATION_SIZE = 15,
122 IWL_UCODE_TLV_WOWLAN_INST = 16,
123 IWL_UCODE_TLV_WOWLAN_DATA = 17,
124 IWL_UCODE_TLV_FLAGS = 18,
125 IWL_UCODE_TLV_SEC_RT = 19,
126 IWL_UCODE_TLV_SEC_INIT = 20,
127 IWL_UCODE_TLV_SEC_WOWLAN = 21,
128 IWL_UCODE_TLV_DEF_CALIB = 22,
129 IWL_UCODE_TLV_PHY_SKU = 23,
130 IWL_UCODE_TLV_SECURE_SEC_RT = 24,
131 IWL_UCODE_TLV_SECURE_SEC_INIT = 25,
132 IWL_UCODE_TLV_SECURE_SEC_WOWLAN = 26,
133 IWL_UCODE_TLV_NUM_OF_CPU = 27,
134 IWL_UCODE_TLV_CSCHEME = 28,
135 IWL_UCODE_TLV_API_CHANGES_SET = 29,
136 IWL_UCODE_TLV_ENABLED_CAPABILITIES = 30,
137 IWL_UCODE_TLV_N_SCAN_CHANNELS = 31,
138 IWL_UCODE_TLV_PAGING = 32,
139 IWL_UCODE_TLV_SEC_RT_USNIFFER = 34,
141 IWL_UCODE_TLV_FW_VERSION = 36,
142 IWL_UCODE_TLV_FW_DBG_DEST = 38,
143 IWL_UCODE_TLV_FW_DBG_CONF = 39,
144 IWL_UCODE_TLV_FW_DBG_TRIGGER = 40,
145 IWL_UCODE_TLV_FW_GSCAN_CAPA = 50,
146 IWL_UCODE_TLV_FW_MEM_SEG = 51,
147 IWL_UCODE_TLV_IML = 52,
148 IWL_UCODE_TLV_UMAC_DEBUG_ADDRS = 54,
149 IWL_UCODE_TLV_LMAC_DEBUG_ADDRS = 55,
150 IWL_UCODE_TLV_FW_RECOVERY_INFO = 57,
152 IWL_UCODE_TLV_TYPE_BUFFER_ALLOCATION = IWL_UCODE_INI_TLV_GROUP + 0x1,
153 IWL_UCODE_TLV_DEBUG_BASE = IWL_UCODE_TLV_TYPE_BUFFER_ALLOCATION,
154 IWL_UCODE_TLV_TYPE_HCMD = IWL_UCODE_INI_TLV_GROUP + 0x2,
155 IWL_UCODE_TLV_TYPE_REGIONS = IWL_UCODE_INI_TLV_GROUP + 0x3,
156 IWL_UCODE_TLV_TYPE_TRIGGERS = IWL_UCODE_INI_TLV_GROUP + 0x4,
157 IWL_UCODE_TLV_TYPE_DEBUG_FLOW = IWL_UCODE_INI_TLV_GROUP + 0x5,
158 IWL_UCODE_TLV_DEBUG_MAX = IWL_UCODE_TLV_TYPE_DEBUG_FLOW,
160 /* TLVs 0x1000-0x2000 are for internal driver usage */
161 IWL_UCODE_TLV_FW_DBG_DUMP_LST = 0x1000,
164 struct iwl_ucode_tlv {
165 __le32 type; /* see above */
166 __le32 length; /* not including type/length fields */
170 #define IWL_TLV_UCODE_MAGIC 0x0a4c5749
171 #define FW_VER_HUMAN_READABLE_SZ 64
173 struct iwl_tlv_ucode_header {
175 * The TLV style ucode header is distinguished from
176 * the v1/v2 style header by first four bytes being
177 * zero, as such is an invalid combination of
178 * major/minor/API/serial versions.
182 u8 human_readable[FW_VER_HUMAN_READABLE_SZ];
183 /* major/minor/API/serial or major in new format */
188 * The data contained herein has a TLV layout,
189 * see above for the TLV header and types.
190 * Note that each TLV is padded to a length
191 * that is a multiple of 4 for alignment.
199 * ability to get extension for: flags & capabilities from ucode binaries files
201 struct iwl_ucode_api {
206 struct iwl_ucode_capa {
212 * enum iwl_ucode_tlv_flag - ucode API flags
213 * @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously
214 * was a separate TLV but moved here to save space.
215 * @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behavior on hidden SSID,
216 * treats good CRC threshold as a boolean
217 * @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w).
218 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: This uCode image supports uAPSD
219 * @IWL_UCODE_TLV_FLAGS_SHORT_BL: 16 entries of black list instead of 64 in scan
220 * offload profile config command.
221 * @IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS: D3 image supports up to six
222 * (rather than two) IPv6 addresses
223 * @IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID: not sending a probe with the SSID element
224 * from the probe request template.
225 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL: new NS offload (small version)
226 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE: new NS offload (large version)
227 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: General support for uAPSD
228 * @IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD: P2P client supports uAPSD power save
229 * @IWL_UCODE_TLV_FLAGS_BCAST_FILTERING: uCode supports broadcast filtering.
230 * @IWL_UCODE_TLV_FLAGS_EBS_SUPPORT: this uCode image supports EBS.
232 enum iwl_ucode_tlv_flag {
233 IWL_UCODE_TLV_FLAGS_PAN = BIT(0),
234 IWL_UCODE_TLV_FLAGS_NEWSCAN = BIT(1),
235 IWL_UCODE_TLV_FLAGS_MFP = BIT(2),
236 IWL_UCODE_TLV_FLAGS_SHORT_BL = BIT(7),
237 IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS = BIT(10),
238 IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID = BIT(12),
239 IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL = BIT(15),
240 IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE = BIT(16),
241 IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT = BIT(24),
242 IWL_UCODE_TLV_FLAGS_EBS_SUPPORT = BIT(25),
243 IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD = BIT(26),
244 IWL_UCODE_TLV_FLAGS_BCAST_FILTERING = BIT(29),
247 typedef unsigned int __bitwise iwl_ucode_tlv_api_t;
250 * enum iwl_ucode_tlv_api - ucode api
251 * @IWL_UCODE_TLV_API_FRAGMENTED_SCAN: This ucode supports active dwell time
252 * longer than the passive one, which is essential for fragmented scan.
253 * @IWL_UCODE_TLV_API_WIFI_MCC_UPDATE: ucode supports MCC updates with source.
254 * @IWL_UCODE_TLV_API_LQ_SS_PARAMS: Configure STBC/BFER via LQ CMD ss_params
255 * @IWL_UCODE_TLV_API_NEW_VERSION: new versioning format
256 * @IWL_UCODE_TLV_API_SCAN_TSF_REPORT: Scan start time reported in scan
257 * iteration complete notification, and the timestamp reported for RX
258 * received during scan, are reported in TSF of the mac specified in the
260 * @IWL_UCODE_TLV_API_TKIP_MIC_KEYS: This ucode supports version 2 of
261 * ADD_MODIFY_STA_KEY_API_S_VER_2.
262 * @IWL_UCODE_TLV_API_STA_TYPE: This ucode supports station type assignement.
263 * @IWL_UCODE_TLV_API_NAN2_VER2: This ucode supports NAN API version 2
264 * @IWL_UCODE_TLV_API_NEW_RX_STATS: should new RX STATISTICS API be used
265 * @IWL_UCODE_TLV_API_QUOTA_LOW_LATENCY: Quota command includes a field
266 * indicating low latency direction.
267 * @IWL_UCODE_TLV_API_DEPRECATE_TTAK: RX status flag TTAK ok (bit 7) is
269 * @IWL_UCODE_TLV_API_ADAPTIVE_DWELL_V2: This ucode supports version 8
270 * of scan request: SCAN_REQUEST_CMD_UMAC_API_S_VER_8
271 * @IWL_UCODE_TLV_API_FRAG_EBS: This ucode supports fragmented EBS
272 * @IWL_UCODE_TLV_API_REDUCE_TX_POWER: This ucode supports v5 of
273 * the REDUCE_TX_POWER_CMD.
274 * @IWL_UCODE_TLV_API_SHORT_BEACON_NOTIF: This ucode supports the short
275 * version of the beacon notification.
276 * @IWL_UCODE_TLV_API_BEACON_FILTER_V4: This ucode supports v4 of
277 * BEACON_FILTER_CONFIG_API_S_VER_4.
278 * @IWL_UCODE_TLV_API_REGULATORY_NVM_INFO: This ucode supports v4 of
279 * REGULATORY_NVM_GET_INFO_RSP_API_S.
280 * @IWL_UCODE_TLV_API_FTM_NEW_RANGE_REQ: This ucode supports v7 of
281 * LOCATION_RANGE_REQ_CMD_API_S and v6 of LOCATION_RANGE_RESP_NTFY_API_S.
282 * @IWL_UCODE_TLV_API_SCAN_OFFLOAD_CHANS: This ucode supports v2 of
283 * SCAN_OFFLOAD_PROFILE_MATCH_RESULTS_S and v3 of
284 * SCAN_OFFLOAD_PROFILES_QUERY_RSP_S.
285 * @IWL_UCODE_TLV_API_MBSSID_HE: This ucode supports v2 of
286 * STA_CONTEXT_DOT11AX_API_S
288 * @NUM_IWL_UCODE_TLV_API: number of bits used
290 enum iwl_ucode_tlv_api {
292 IWL_UCODE_TLV_API_FRAGMENTED_SCAN = (__force iwl_ucode_tlv_api_t)8,
293 IWL_UCODE_TLV_API_WIFI_MCC_UPDATE = (__force iwl_ucode_tlv_api_t)9,
294 IWL_UCODE_TLV_API_LQ_SS_PARAMS = (__force iwl_ucode_tlv_api_t)18,
295 IWL_UCODE_TLV_API_NEW_VERSION = (__force iwl_ucode_tlv_api_t)20,
296 IWL_UCODE_TLV_API_SCAN_TSF_REPORT = (__force iwl_ucode_tlv_api_t)28,
297 IWL_UCODE_TLV_API_TKIP_MIC_KEYS = (__force iwl_ucode_tlv_api_t)29,
298 IWL_UCODE_TLV_API_STA_TYPE = (__force iwl_ucode_tlv_api_t)30,
299 IWL_UCODE_TLV_API_NAN2_VER2 = (__force iwl_ucode_tlv_api_t)31,
301 IWL_UCODE_TLV_API_ADAPTIVE_DWELL = (__force iwl_ucode_tlv_api_t)32,
302 IWL_UCODE_TLV_API_OCE = (__force iwl_ucode_tlv_api_t)33,
303 IWL_UCODE_TLV_API_NEW_BEACON_TEMPLATE = (__force iwl_ucode_tlv_api_t)34,
304 IWL_UCODE_TLV_API_NEW_RX_STATS = (__force iwl_ucode_tlv_api_t)35,
305 IWL_UCODE_TLV_API_WOWLAN_KEY_MATERIAL = (__force iwl_ucode_tlv_api_t)36,
306 IWL_UCODE_TLV_API_QUOTA_LOW_LATENCY = (__force iwl_ucode_tlv_api_t)38,
307 IWL_UCODE_TLV_API_DEPRECATE_TTAK = (__force iwl_ucode_tlv_api_t)41,
308 IWL_UCODE_TLV_API_ADAPTIVE_DWELL_V2 = (__force iwl_ucode_tlv_api_t)42,
309 IWL_UCODE_TLV_API_FRAG_EBS = (__force iwl_ucode_tlv_api_t)44,
310 IWL_UCODE_TLV_API_REDUCE_TX_POWER = (__force iwl_ucode_tlv_api_t)45,
311 IWL_UCODE_TLV_API_SHORT_BEACON_NOTIF = (__force iwl_ucode_tlv_api_t)46,
312 IWL_UCODE_TLV_API_BEACON_FILTER_V4 = (__force iwl_ucode_tlv_api_t)47,
313 IWL_UCODE_TLV_API_REGULATORY_NVM_INFO = (__force iwl_ucode_tlv_api_t)48,
314 IWL_UCODE_TLV_API_FTM_NEW_RANGE_REQ = (__force iwl_ucode_tlv_api_t)49,
315 IWL_UCODE_TLV_API_SCAN_OFFLOAD_CHANS = (__force iwl_ucode_tlv_api_t)50,
316 IWL_UCODE_TLV_API_MBSSID_HE = (__force iwl_ucode_tlv_api_t)52,
318 NUM_IWL_UCODE_TLV_API
320 /* sparse says it cannot increment the previous enum member */
325 typedef unsigned int __bitwise iwl_ucode_tlv_capa_t;
328 * enum iwl_ucode_tlv_capa - ucode capabilities
329 * @IWL_UCODE_TLV_CAPA_D0I3_SUPPORT: supports D0i3
330 * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT: supports Location Aware Regulatory
331 * @IWL_UCODE_TLV_CAPA_UMAC_SCAN: supports UMAC scan.
332 * @IWL_UCODE_TLV_CAPA_BEAMFORMER: supports Beamformer
333 * @IWL_UCODE_TLV_CAPA_TDLS_SUPPORT: support basic TDLS functionality
334 * @IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT: supports insertion of current
335 * tx power value into TPC Report action frame and Link Measurement Report
337 * @IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT: supports updating current
338 * channel in DS parameter set element in probe requests.
339 * @IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT: supports adding TPC Report IE in
341 * @IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT: supports Quiet Period requests
342 * @IWL_UCODE_TLV_CAPA_DQA_SUPPORT: supports dynamic queue allocation (DQA),
343 * which also implies support for the scheduler configuration command
344 * @IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH: supports TDLS channel switching
345 * @IWL_UCODE_TLV_CAPA_CNSLDTD_D3_D0_IMG: Consolidated D3-D0 image
346 * @IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT: supports Hot Spot Command
347 * @IWL_UCODE_TLV_CAPA_DC2DC_SUPPORT: supports DC2DC Command
348 * @IWL_UCODE_TLV_CAPA_CSUM_SUPPORT: supports TCP Checksum Offload
349 * @IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS: support radio and beacon statistics
350 * @IWL_UCODE_TLV_CAPA_P2P_SCM_UAPSD: supports U-APSD on p2p interface when it
351 * is standalone or with a BSS station interface in the same binding.
352 * @IWL_UCODE_TLV_CAPA_BT_COEX_PLCR: enabled BT Coex packet level co-running
353 * @IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC: ucode supports LAR updates with different
354 * sources for the MCC. This TLV bit is a future replacement to
355 * IWL_UCODE_TLV_API_WIFI_MCC_UPDATE. When either is set, multi-source LAR
357 * @IWL_UCODE_TLV_CAPA_BT_COEX_RRC: supports BT Coex RRC
358 * @IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT: supports gscan (no longer used)
359 * @IWL_UCODE_TLV_CAPA_STA_PM_NOTIF: firmware will send STA PM notification
360 * @IWL_UCODE_TLV_CAPA_TLC_OFFLOAD: firmware implements rate scaling algorithm
361 * @IWL_UCODE_TLV_CAPA_DYNAMIC_QUOTA: firmware implements quota related
362 * @IWL_UCODE_TLV_CAPA_COEX_SCHEMA_2: firmware implements Coex Schema 2
363 * IWL_UCODE_TLV_CAPA_CHANNEL_SWITCH_CMD: firmware supports CSA command
364 * @IWL_UCODE_TLV_CAPA_ULTRA_HB_CHANNELS: firmware supports ultra high band
366 * @IWL_UCODE_TLV_CAPA_CS_MODIFY: firmware supports modify action CSA command
367 * @IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE: extended DTS measurement
368 * @IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS: supports short PM timeouts
369 * @IWL_UCODE_TLV_CAPA_BT_MPLUT_SUPPORT: supports bt-coex Multi-priority LUT
370 * @IWL_UCODE_TLV_CAPA_CSA_AND_TBTT_OFFLOAD: the firmware supports CSA
371 * countdown offloading. Beacon notifications are not sent to the host.
372 * The fw also offloads TBTT alignment.
373 * @IWL_UCODE_TLV_CAPA_BEACON_ANT_SELECTION: firmware will decide on what
374 * antenna the beacon should be transmitted
375 * @IWL_UCODE_TLV_CAPA_BEACON_STORING: firmware will store the latest beacon
376 * from AP and will send it upon d0i3 exit.
377 * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT_V3: support LAR API V3
378 * @IWL_UCODE_TLV_CAPA_CT_KILL_BY_FW: firmware responsible for CT-kill
379 * @IWL_UCODE_TLV_CAPA_TEMP_THS_REPORT_SUPPORT: supports temperature
380 * thresholds reporting
381 * @IWL_UCODE_TLV_CAPA_CTDP_SUPPORT: supports cTDP command
382 * @IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED: supports usniffer enabled in
384 * @IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG: support getting more shared
385 * memory addresses from the firmware.
386 * @IWL_UCODE_TLV_CAPA_LQM_SUPPORT: supports Link Quality Measurement
387 * @IWL_UCODE_TLV_CAPA_TX_POWER_ACK: reduced TX power API has larger
388 * command size (command version 4) that supports toggling ACK TX
390 * @IWL_UCODE_TLV_CAPA_D3_DEBUG: supports debug recording during D3
391 * @IWL_UCODE_TLV_CAPA_MCC_UPDATE_11AX_SUPPORT: MCC response support 11ax
393 * @IWL_UCODE_TLV_CAPA_CSI_REPORTING: firmware is capable of being configured
394 * to report the CSI information with (certain) RX frames
395 * @IWL_UCODE_TLV_CAPA_FTM_CALIBRATED: has FTM calibrated and thus supports both
396 * initiator and responder
398 * @IWL_UCODE_TLV_CAPA_MLME_OFFLOAD: supports MLME offload
400 * @NUM_IWL_UCODE_TLV_CAPA: number of bits used
402 enum iwl_ucode_tlv_capa {
404 IWL_UCODE_TLV_CAPA_D0I3_SUPPORT = (__force iwl_ucode_tlv_capa_t)0,
405 IWL_UCODE_TLV_CAPA_LAR_SUPPORT = (__force iwl_ucode_tlv_capa_t)1,
406 IWL_UCODE_TLV_CAPA_UMAC_SCAN = (__force iwl_ucode_tlv_capa_t)2,
407 IWL_UCODE_TLV_CAPA_BEAMFORMER = (__force iwl_ucode_tlv_capa_t)3,
408 IWL_UCODE_TLV_CAPA_TDLS_SUPPORT = (__force iwl_ucode_tlv_capa_t)6,
409 IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT = (__force iwl_ucode_tlv_capa_t)8,
410 IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT = (__force iwl_ucode_tlv_capa_t)9,
411 IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT = (__force iwl_ucode_tlv_capa_t)10,
412 IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT = (__force iwl_ucode_tlv_capa_t)11,
413 IWL_UCODE_TLV_CAPA_DQA_SUPPORT = (__force iwl_ucode_tlv_capa_t)12,
414 IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH = (__force iwl_ucode_tlv_capa_t)13,
415 IWL_UCODE_TLV_CAPA_CNSLDTD_D3_D0_IMG = (__force iwl_ucode_tlv_capa_t)17,
416 IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT = (__force iwl_ucode_tlv_capa_t)18,
417 IWL_UCODE_TLV_CAPA_DC2DC_CONFIG_SUPPORT = (__force iwl_ucode_tlv_capa_t)19,
418 IWL_UCODE_TLV_CAPA_CSUM_SUPPORT = (__force iwl_ucode_tlv_capa_t)21,
419 IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS = (__force iwl_ucode_tlv_capa_t)22,
420 IWL_UCODE_TLV_CAPA_P2P_SCM_UAPSD = (__force iwl_ucode_tlv_capa_t)26,
421 IWL_UCODE_TLV_CAPA_BT_COEX_PLCR = (__force iwl_ucode_tlv_capa_t)28,
422 IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC = (__force iwl_ucode_tlv_capa_t)29,
423 IWL_UCODE_TLV_CAPA_BT_COEX_RRC = (__force iwl_ucode_tlv_capa_t)30,
424 IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT = (__force iwl_ucode_tlv_capa_t)31,
427 IWL_UCODE_TLV_CAPA_STA_PM_NOTIF = (__force iwl_ucode_tlv_capa_t)38,
428 IWL_UCODE_TLV_CAPA_BINDING_CDB_SUPPORT = (__force iwl_ucode_tlv_capa_t)39,
429 IWL_UCODE_TLV_CAPA_CDB_SUPPORT = (__force iwl_ucode_tlv_capa_t)40,
430 IWL_UCODE_TLV_CAPA_D0I3_END_FIRST = (__force iwl_ucode_tlv_capa_t)41,
431 IWL_UCODE_TLV_CAPA_TLC_OFFLOAD = (__force iwl_ucode_tlv_capa_t)43,
432 IWL_UCODE_TLV_CAPA_DYNAMIC_QUOTA = (__force iwl_ucode_tlv_capa_t)44,
433 IWL_UCODE_TLV_CAPA_COEX_SCHEMA_2 = (__force iwl_ucode_tlv_capa_t)45,
434 IWL_UCODE_TLV_CAPA_CHANNEL_SWITCH_CMD = (__force iwl_ucode_tlv_capa_t)46,
435 IWL_UCODE_TLV_CAPA_ULTRA_HB_CHANNELS = (__force iwl_ucode_tlv_capa_t)48,
436 IWL_UCODE_TLV_CAPA_FTM_CALIBRATED = (__force iwl_ucode_tlv_capa_t)47,
437 IWL_UCODE_TLV_CAPA_CS_MODIFY = (__force iwl_ucode_tlv_capa_t)49,
440 IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE = (__force iwl_ucode_tlv_capa_t)64,
441 IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS = (__force iwl_ucode_tlv_capa_t)65,
442 IWL_UCODE_TLV_CAPA_BT_MPLUT_SUPPORT = (__force iwl_ucode_tlv_capa_t)67,
443 IWL_UCODE_TLV_CAPA_MULTI_QUEUE_RX_SUPPORT = (__force iwl_ucode_tlv_capa_t)68,
444 IWL_UCODE_TLV_CAPA_CSA_AND_TBTT_OFFLOAD = (__force iwl_ucode_tlv_capa_t)70,
445 IWL_UCODE_TLV_CAPA_BEACON_ANT_SELECTION = (__force iwl_ucode_tlv_capa_t)71,
446 IWL_UCODE_TLV_CAPA_BEACON_STORING = (__force iwl_ucode_tlv_capa_t)72,
447 IWL_UCODE_TLV_CAPA_LAR_SUPPORT_V3 = (__force iwl_ucode_tlv_capa_t)73,
448 IWL_UCODE_TLV_CAPA_CT_KILL_BY_FW = (__force iwl_ucode_tlv_capa_t)74,
449 IWL_UCODE_TLV_CAPA_TEMP_THS_REPORT_SUPPORT = (__force iwl_ucode_tlv_capa_t)75,
450 IWL_UCODE_TLV_CAPA_CTDP_SUPPORT = (__force iwl_ucode_tlv_capa_t)76,
451 IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED = (__force iwl_ucode_tlv_capa_t)77,
452 IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG = (__force iwl_ucode_tlv_capa_t)80,
453 IWL_UCODE_TLV_CAPA_LQM_SUPPORT = (__force iwl_ucode_tlv_capa_t)81,
454 IWL_UCODE_TLV_CAPA_TX_POWER_ACK = (__force iwl_ucode_tlv_capa_t)84,
455 IWL_UCODE_TLV_CAPA_D3_DEBUG = (__force iwl_ucode_tlv_capa_t)87,
456 IWL_UCODE_TLV_CAPA_LED_CMD_SUPPORT = (__force iwl_ucode_tlv_capa_t)88,
457 IWL_UCODE_TLV_CAPA_MCC_UPDATE_11AX_SUPPORT = (__force iwl_ucode_tlv_capa_t)89,
458 IWL_UCODE_TLV_CAPA_CSI_REPORTING = (__force iwl_ucode_tlv_capa_t)90,
461 IWL_UCODE_TLV_CAPA_MLME_OFFLOAD = (__force iwl_ucode_tlv_capa_t)96,
463 NUM_IWL_UCODE_TLV_CAPA
465 /* sparse says it cannot increment the previous enum member */
470 /* The default calibrate table size if not specified by firmware file */
471 #define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE 18
472 #define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE 19
473 #define IWL_MAX_PHY_CALIBRATE_TBL_SIZE 253
475 /* The default max probe length if not specified by the firmware file */
476 #define IWL_DEFAULT_MAX_PROBE_LENGTH 200
479 * For 16.0 uCode and above, there is no differentiation between sections,
480 * just an offset to the HW address.
482 #define CPU1_CPU2_SEPARATOR_SECTION 0xFFFFCCCC
483 #define PAGING_SEPARATOR_SECTION 0xAAAABBBB
485 /* uCode version contains 4 values: Major/Minor/API/Serial */
486 #define IWL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24)
487 #define IWL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16)
488 #define IWL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8)
489 #define IWL_UCODE_SERIAL(ver) ((ver) & 0x000000FF)
492 * struct iwl_tlv_calib_ctrl - Calibration control struct.
493 * Sent as part of the phy configuration command.
494 * @flow_trigger: bitmap for which calibrations to perform according to
496 * @event_trigger: bitmap for which calibrations to perform according to
499 struct iwl_tlv_calib_ctrl {
501 __le32 event_trigger;
504 enum iwl_fw_phy_cfg {
505 FW_PHY_CFG_RADIO_TYPE_POS = 0,
506 FW_PHY_CFG_RADIO_TYPE = 0x3 << FW_PHY_CFG_RADIO_TYPE_POS,
507 FW_PHY_CFG_RADIO_STEP_POS = 2,
508 FW_PHY_CFG_RADIO_STEP = 0x3 << FW_PHY_CFG_RADIO_STEP_POS,
509 FW_PHY_CFG_RADIO_DASH_POS = 4,
510 FW_PHY_CFG_RADIO_DASH = 0x3 << FW_PHY_CFG_RADIO_DASH_POS,
511 FW_PHY_CFG_TX_CHAIN_POS = 16,
512 FW_PHY_CFG_TX_CHAIN = 0xf << FW_PHY_CFG_TX_CHAIN_POS,
513 FW_PHY_CFG_RX_CHAIN_POS = 20,
514 FW_PHY_CFG_RX_CHAIN = 0xf << FW_PHY_CFG_RX_CHAIN_POS,
515 FW_PHY_CFG_SHARED_CLK = BIT(31),
518 #define IWL_UCODE_MAX_CS 1
521 * struct iwl_fw_cipher_scheme - a cipher scheme supported by FW.
522 * @cipher: a cipher suite selector
523 * @flags: cipher scheme flags (currently reserved for a future use)
524 * @hdr_len: a size of MPDU security header
525 * @pn_len: a size of PN
526 * @pn_off: an offset of pn from the beginning of the security header
527 * @key_idx_off: an offset of key index byte in the security header
528 * @key_idx_mask: a bit mask of key_idx bits
529 * @key_idx_shift: bit shift needed to get key_idx
530 * @mic_len: mic length in bytes
531 * @hw_cipher: a HW cipher index used in host commands
533 struct iwl_fw_cipher_scheme {
546 enum iwl_fw_dbg_reg_operator {
563 * struct iwl_fw_dbg_reg_op - an operation on a register
565 * @op: &enum iwl_fw_dbg_reg_operator
566 * @addr: offset of the register
569 struct iwl_fw_dbg_reg_op {
577 * enum iwl_fw_dbg_monitor_mode - available monitor recording modes
579 * @SMEM_MODE: monitor stores the data in SMEM
580 * @EXTERNAL_MODE: monitor stores the data in allocated DRAM
581 * @MARBH_MODE: monitor stores the data in MARBH buffer
582 * @MIPI_MODE: monitor outputs the data through the MIPI interface
584 enum iwl_fw_dbg_monitor_mode {
592 * struct iwl_fw_dbg_mem_seg_tlv - configures the debug data memory segments
594 * @data_type: the memory segment type to record
595 * @ofs: the memory segment offset
596 * @len: the memory segment length, in bytes
598 * This parses IWL_UCODE_TLV_FW_MEM_SEG
600 struct iwl_fw_dbg_mem_seg_tlv {
607 * struct iwl_fw_dbg_dest_tlv_v1 - configures the destination of the debug data
609 * @version: version of the TLV - currently 0
610 * @monitor_mode: &enum iwl_fw_dbg_monitor_mode
611 * @size_power: buffer size will be 2^(size_power + 11)
612 * @base_reg: addr of the base addr register (PRPH)
613 * @end_reg: addr of the end addr register (PRPH)
614 * @write_ptr_reg: the addr of the reg of the write pointer
615 * @wrap_count: the addr of the reg of the wrap_count
616 * @base_shift: shift right of the base addr reg
617 * @end_shift: shift right of the end addr reg
618 * @reg_ops: array of registers operations
620 * This parses IWL_UCODE_TLV_FW_DBG_DEST
622 struct iwl_fw_dbg_dest_tlv_v1 {
629 __le32 write_ptr_reg;
633 struct iwl_fw_dbg_reg_op reg_ops[0];
636 /* Mask of the register for defining the LDBG MAC2SMEM buffer SMEM size */
637 #define IWL_LDBG_M2S_BUF_SIZE_MSK 0x0fff0000
638 /* Mask of the register for defining the LDBG MAC2SMEM SMEM base address */
639 #define IWL_LDBG_M2S_BUF_BA_MSK 0x00000fff
640 /* The smem buffer chunks are in units of 256 bits */
641 #define IWL_M2S_UNIT_SIZE 0x100
643 struct iwl_fw_dbg_dest_tlv {
649 __le32 write_ptr_reg;
653 struct iwl_fw_dbg_reg_op reg_ops[0];
656 struct iwl_fw_dbg_conf_hcmd {
664 * enum iwl_fw_dbg_trigger_mode - triggers functionalities
666 * @IWL_FW_DBG_TRIGGER_START: when trigger occurs re-conf the dbg mechanism
667 * @IWL_FW_DBG_TRIGGER_STOP: when trigger occurs pull the dbg data
668 * @IWL_FW_DBG_TRIGGER_MONITOR_ONLY: when trigger occurs trigger is set to
669 * collect only monitor data
671 enum iwl_fw_dbg_trigger_mode {
672 IWL_FW_DBG_TRIGGER_START = BIT(0),
673 IWL_FW_DBG_TRIGGER_STOP = BIT(1),
674 IWL_FW_DBG_TRIGGER_MONITOR_ONLY = BIT(2),
678 * enum iwl_fw_dbg_trigger_flags - the flags supported by wrt triggers
679 * @IWL_FW_DBG_FORCE_RESTART: force a firmware restart
681 enum iwl_fw_dbg_trigger_flags {
682 IWL_FW_DBG_FORCE_RESTART = BIT(0),
686 * enum iwl_fw_dbg_trigger_vif_type - define the VIF type for a trigger
687 * @IWL_FW_DBG_CONF_VIF_ANY: any vif type
688 * @IWL_FW_DBG_CONF_VIF_IBSS: IBSS mode
689 * @IWL_FW_DBG_CONF_VIF_STATION: BSS mode
690 * @IWL_FW_DBG_CONF_VIF_AP: AP mode
691 * @IWL_FW_DBG_CONF_VIF_P2P_CLIENT: P2P Client mode
692 * @IWL_FW_DBG_CONF_VIF_P2P_GO: P2P GO mode
693 * @IWL_FW_DBG_CONF_VIF_P2P_DEVICE: P2P device
695 enum iwl_fw_dbg_trigger_vif_type {
696 IWL_FW_DBG_CONF_VIF_ANY = NL80211_IFTYPE_UNSPECIFIED,
697 IWL_FW_DBG_CONF_VIF_IBSS = NL80211_IFTYPE_ADHOC,
698 IWL_FW_DBG_CONF_VIF_STATION = NL80211_IFTYPE_STATION,
699 IWL_FW_DBG_CONF_VIF_AP = NL80211_IFTYPE_AP,
700 IWL_FW_DBG_CONF_VIF_P2P_CLIENT = NL80211_IFTYPE_P2P_CLIENT,
701 IWL_FW_DBG_CONF_VIF_P2P_GO = NL80211_IFTYPE_P2P_GO,
702 IWL_FW_DBG_CONF_VIF_P2P_DEVICE = NL80211_IFTYPE_P2P_DEVICE,
706 * struct iwl_fw_dbg_trigger_tlv - a TLV that describes the trigger
707 * @id: &enum iwl_fw_dbg_trigger
708 * @vif_type: &enum iwl_fw_dbg_trigger_vif_type
709 * @stop_conf_ids: bitmap of configurations this trigger relates to.
710 * if the mode is %IWL_FW_DBG_TRIGGER_STOP, then if the bit corresponding
711 * to the currently running configuration is set, the data should be
713 * @stop_delay: how many milliseconds to wait before collecting the data
714 * after the STOP trigger fires.
715 * @mode: &enum iwl_fw_dbg_trigger_mode - can be stop / start of both
716 * @start_conf_id: if mode is %IWL_FW_DBG_TRIGGER_START, this defines what
717 * configuration should be applied when the triggers kicks in.
718 * @occurrences: number of occurrences. 0 means the trigger will never fire.
719 * @trig_dis_ms: the time, in milliseconds, after an occurrence of this
720 * trigger in which another occurrence should be ignored.
721 * @flags: &enum iwl_fw_dbg_trigger_flags
723 struct iwl_fw_dbg_trigger_tlv {
726 __le32 stop_conf_ids;
738 #define FW_DBG_START_FROM_ALIVE 0
739 #define FW_DBG_CONF_MAX 32
740 #define FW_DBG_INVALID 0xff
743 * struct iwl_fw_dbg_trigger_missed_bcon - configures trigger for missed beacons
744 * @stop_consec_missed_bcon: stop recording if threshold is crossed.
745 * @stop_consec_missed_bcon_since_rx: stop recording if threshold is crossed.
746 * @start_consec_missed_bcon: start recording if threshold is crossed.
747 * @start_consec_missed_bcon_since_rx: start recording if threshold is crossed.
748 * @reserved1: reserved
749 * @reserved2: reserved
751 struct iwl_fw_dbg_trigger_missed_bcon {
752 __le32 stop_consec_missed_bcon;
753 __le32 stop_consec_missed_bcon_since_rx;
755 __le32 start_consec_missed_bcon;
756 __le32 start_consec_missed_bcon_since_rx;
761 * struct iwl_fw_dbg_trigger_cmd - configures trigger for messages from FW.
762 * cmds: the list of commands to trigger the collection on
764 struct iwl_fw_dbg_trigger_cmd {
772 * iwl_fw_dbg_trigger_stats - configures trigger for statistics
773 * @stop_offset: the offset of the value to be monitored
774 * @stop_threshold: the threshold above which to collect
775 * @start_offset: the offset of the value to be monitored
776 * @start_threshold: the threshold above which to start recording
778 struct iwl_fw_dbg_trigger_stats {
780 __le32 stop_threshold;
782 __le32 start_threshold;
786 * struct iwl_fw_dbg_trigger_low_rssi - trigger for low beacon RSSI
787 * @rssi: RSSI value to trigger at
789 struct iwl_fw_dbg_trigger_low_rssi {
794 * struct iwl_fw_dbg_trigger_mlme - configures trigger for mlme events
795 * @stop_auth_denied: number of denied authentication to collect
796 * @stop_auth_timeout: number of authentication timeout to collect
797 * @stop_rx_deauth: number of Rx deauth before to collect
798 * @stop_tx_deauth: number of Tx deauth before to collect
799 * @stop_assoc_denied: number of denied association to collect
800 * @stop_assoc_timeout: number of association timeout to collect
801 * @stop_connection_loss: number of connection loss to collect
802 * @start_auth_denied: number of denied authentication to start recording
803 * @start_auth_timeout: number of authentication timeout to start recording
804 * @start_rx_deauth: number of Rx deauth to start recording
805 * @start_tx_deauth: number of Tx deauth to start recording
806 * @start_assoc_denied: number of denied association to start recording
807 * @start_assoc_timeout: number of association timeout to start recording
808 * @start_connection_loss: number of connection loss to start recording
810 struct iwl_fw_dbg_trigger_mlme {
812 u8 stop_auth_timeout;
816 u8 stop_assoc_denied;
817 u8 stop_assoc_timeout;
818 u8 stop_connection_loss;
821 u8 start_auth_denied;
822 u8 start_auth_timeout;
826 u8 start_assoc_denied;
827 u8 start_assoc_timeout;
828 u8 start_connection_loss;
833 * struct iwl_fw_dbg_trigger_txq_timer - configures the Tx queue's timer
834 * @command_queue: timeout for the command queue in ms
835 * @bss: timeout for the queues of a BSS (except for TDLS queues) in ms
836 * @softap: timeout for the queues of a softAP in ms
837 * @p2p_go: timeout for the queues of a P2P GO in ms
838 * @p2p_client: timeout for the queues of a P2P client in ms
839 * @p2p_device: timeout for the queues of a P2P device in ms
840 * @ibss: timeout for the queues of an IBSS in ms
841 * @tdls: timeout for the queues of a TDLS station in ms
843 struct iwl_fw_dbg_trigger_txq_timer {
844 __le32 command_queue;
856 * struct iwl_fw_dbg_trigger_time_event - configures a time event trigger
857 * time_Events: a list of tuples <id, action_bitmap>. The driver will issue a
858 * trigger each time a time event notification that relates to time event
859 * id with one of the actions in the bitmap is received and
860 * BIT(notif->status) is set in status_bitmap.
863 struct iwl_fw_dbg_trigger_time_event {
866 __le32 action_bitmap;
867 __le32 status_bitmap;
868 } __packed time_events[16];
872 * struct iwl_fw_dbg_trigger_ba - configures BlockAck related trigger
873 * rx_ba_start: tid bitmap to configure on what tid the trigger should occur
874 * when an Rx BlockAck session is started.
875 * rx_ba_stop: tid bitmap to configure on what tid the trigger should occur
876 * when an Rx BlockAck session is stopped.
877 * tx_ba_start: tid bitmap to configure on what tid the trigger should occur
878 * when a Tx BlockAck session is started.
879 * tx_ba_stop: tid bitmap to configure on what tid the trigger should occur
880 * when a Tx BlockAck session is stopped.
881 * rx_bar: tid bitmap to configure on what tid the trigger should occur
882 * when a BAR is received (for a Tx BlockAck session).
883 * tx_bar: tid bitmap to configure on what tid the trigger should occur
884 * when a BAR is send (for an Rx BlocAck session).
885 * frame_timeout: tid bitmap to configure on what tid the trigger should occur
886 * when a frame times out in the reodering buffer.
888 struct iwl_fw_dbg_trigger_ba {
895 __le16 frame_timeout;
899 * struct iwl_fw_dbg_trigger_tdls - configures trigger for TDLS events.
900 * @action_bitmap: the TDLS action to trigger the collection upon
901 * @peer_mode: trigger on specific peer or all
902 * @peer: the TDLS peer to trigger the collection on
904 struct iwl_fw_dbg_trigger_tdls {
912 * struct iwl_fw_dbg_trigger_tx_status - configures trigger for tx response
914 * @statuses: the list of statuses to trigger the collection on
916 struct iwl_fw_dbg_trigger_tx_status {
920 } __packed statuses[16];
925 * struct iwl_fw_dbg_conf_tlv - a TLV that describes a debug configuration.
927 * @usniffer: should the uSniffer image be used
928 * @num_of_hcmds: how many HCMDs to send are present here
929 * @hcmd: a variable length host command to be sent to apply the configuration.
930 * If there is more than one HCMD to send, they will appear one after the
931 * other and be sent in the order that they appear in.
932 * This parses IWL_UCODE_TLV_FW_DBG_CONF. The user can add up-to
933 * %FW_DBG_CONF_MAX configuration per run.
935 struct iwl_fw_dbg_conf_tlv {
940 struct iwl_fw_dbg_conf_hcmd hcmd;
943 #endif /* __iwl_fw_file_h__ */