1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
2 /*
3 * Copyright (C) 2008-2014, 2018-2024, 2026 Intel Corporation
4 * Copyright (C) 2013-2015 Intel Mobile Communications GmbH
5 * Copyright (C) 2016-2017 Intel Deutschland GmbH
6 */
7 #ifndef __iwl_fw_file_h__
8 #define __iwl_fw_file_h__
9
10 #include <linux/netdevice.h>
11 #include <linux/nl80211.h>
12
13 /* v1/v2 uCode file layout */
14 struct iwl_ucode_header {
15 __le32 ver; /* major/minor/API/serial */
16 union {
17 struct {
18 __le32 inst_size; /* bytes of runtime code */
19 __le32 data_size; /* bytes of runtime data */
20 __le32 init_size; /* bytes of init code */
21 __le32 init_data_size; /* bytes of init data */
22 __le32 boot_size; /* bytes of bootstrap code */
23 u8 data[]; /* in same order as sizes */
24 } v1;
25 struct {
26 __le32 build; /* build number */
27 __le32 inst_size; /* bytes of runtime code */
28 __le32 data_size; /* bytes of runtime data */
29 __le32 init_size; /* bytes of init code */
30 __le32 init_data_size; /* bytes of init data */
31 __le32 boot_size; /* bytes of bootstrap code */
32 u8 data[]; /* in same order as sizes */
33 } v2;
34 } u;
35 };
36
37 #define IWL_UCODE_TLV_DEBUG_BASE 0x1000005
38 #define IWL_UCODE_TLV_CONST_BASE 0x100
39
40 /*
41 * new TLV uCode file layout
42 *
43 * The new TLV file format contains TLVs, that each specify
44 * some piece of data.
45 */
46
47 enum iwl_ucode_tlv_type {
48 IWL_UCODE_TLV_INVALID = 0, /* unused */
49 IWL_UCODE_TLV_INST = 1,
50 IWL_UCODE_TLV_DATA = 2,
51 IWL_UCODE_TLV_INIT = 3,
52 IWL_UCODE_TLV_INIT_DATA = 4,
53 IWL_UCODE_TLV_BOOT = 5,
54 IWL_UCODE_TLV_PROBE_MAX_LEN = 6, /* a u32 value */
55 IWL_UCODE_TLV_PAN = 7, /* deprecated -- only used in DVM */
56 IWL_UCODE_TLV_MEM_DESC = 7, /* replaces PAN in non-DVM */
57 IWL_UCODE_TLV_RUNT_EVTLOG_PTR = 8,
58 IWL_UCODE_TLV_RUNT_EVTLOG_SIZE = 9,
59 IWL_UCODE_TLV_RUNT_ERRLOG_PTR = 10,
60 IWL_UCODE_TLV_INIT_EVTLOG_PTR = 11,
61 IWL_UCODE_TLV_INIT_EVTLOG_SIZE = 12,
62 IWL_UCODE_TLV_INIT_ERRLOG_PTR = 13,
63 IWL_UCODE_TLV_ENHANCE_SENS_TBL = 14,
64 IWL_UCODE_TLV_PHY_CALIBRATION_SIZE = 15,
65 IWL_UCODE_TLV_WOWLAN_INST = 16,
66 IWL_UCODE_TLV_WOWLAN_DATA = 17,
67 IWL_UCODE_TLV_FLAGS = 18,
68 IWL_UCODE_TLV_SEC_RT = 19,
69 IWL_UCODE_TLV_SEC_INIT = 20,
70 IWL_UCODE_TLV_SEC_WOWLAN = 21,
71 IWL_UCODE_TLV_DEF_CALIB = 22,
72 IWL_UCODE_TLV_PHY_SKU = 23,
73 IWL_UCODE_TLV_SECURE_SEC_RT = 24,
74 IWL_UCODE_TLV_SECURE_SEC_INIT = 25,
75 IWL_UCODE_TLV_SECURE_SEC_WOWLAN = 26,
76 IWL_UCODE_TLV_NUM_OF_CPU = 27,
77 IWL_UCODE_TLV_CSCHEME = 28,
78 IWL_UCODE_TLV_API_CHANGES_SET = 29,
79 IWL_UCODE_TLV_ENABLED_CAPABILITIES = 30,
80 IWL_UCODE_TLV_N_SCAN_CHANNELS = 31,
81 IWL_UCODE_TLV_PAGING = 32,
82 IWL_UCODE_TLV_SEC_RT_USNIFFER = 34,
83 /* 35 is unused */
84 IWL_UCODE_TLV_FW_VERSION = 36,
85 IWL_UCODE_TLV_FW_DBG_DEST = 38,
86 IWL_UCODE_TLV_FW_DBG_CONF = 39,
87 IWL_UCODE_TLV_FW_DBG_TRIGGER = 40,
88 IWL_UCODE_TLV_CMD_VERSIONS = 48,
89 IWL_UCODE_TLV_FW_GSCAN_CAPA = 50,
90 IWL_UCODE_TLV_FW_MEM_SEG = 51,
91 IWL_UCODE_TLV_IML = 52,
92 IWL_UCODE_TLV_UMAC_DEBUG_ADDRS = 54,
93 IWL_UCODE_TLV_LMAC_DEBUG_ADDRS = 55,
94 IWL_UCODE_TLV_FW_RECOVERY_INFO = 57,
95 IWL_UCODE_TLV_HW_TYPE = 58,
96 IWL_UCODE_TLV_FW_FSEQ_VERSION = 60,
97 IWL_UCODE_TLV_PHY_INTEGRATION_VERSION = 61,
98
99 IWL_UCODE_TLV_PNVM_VERSION = 62,
100 IWL_UCODE_TLV_PNVM_SKU = 64,
101
102 IWL_UCODE_TLV_SEC_TABLE_ADDR = 66,
103 IWL_UCODE_TLV_D3_KEK_KCK_ADDR = 67,
104 IWL_UCODE_TLV_CURRENT_PC = 68,
105 IWL_UCODE_TLV_FSEQ_BIN_VERSION = 72,
106 IWL_UCODE_TLV_CMD_BIOS_TABLE = 73,
107
108 /* contains sub-sections like PNVM file does (did) */
109 IWL_UCODE_TLV_PNVM_DATA = 74,
110
111 IWL_UCODE_TLV_FW_NUM_STATIONS = IWL_UCODE_TLV_CONST_BASE + 0,
112 IWL_UCODE_TLV_FW_NUM_LINKS = IWL_UCODE_TLV_CONST_BASE + 1,
113 IWL_UCODE_TLV_FW_NUM_BEACONS = IWL_UCODE_TLV_CONST_BASE + 2,
114 IWL_UCODE_TLV_FW_NUM_MCAST_KEY_ENTRIES = IWL_UCODE_TLV_CONST_BASE + 3,
115 IWL_UCODE_TLV_FW_NAN_MAX_CHAN_SWITCH_TIME = IWL_UCODE_TLV_CONST_BASE + 4,
116
117 IWL_UCODE_TLV_TYPE_DEBUG_INFO = IWL_UCODE_TLV_DEBUG_BASE + 0,
118 IWL_UCODE_TLV_TYPE_BUFFER_ALLOCATION = IWL_UCODE_TLV_DEBUG_BASE + 1,
119 IWL_UCODE_TLV_TYPE_HCMD = IWL_UCODE_TLV_DEBUG_BASE + 2,
120 IWL_UCODE_TLV_TYPE_REGIONS = IWL_UCODE_TLV_DEBUG_BASE + 3,
121 IWL_UCODE_TLV_TYPE_TRIGGERS = IWL_UCODE_TLV_DEBUG_BASE + 4,
122 IWL_UCODE_TLV_TYPE_CONF_SET = IWL_UCODE_TLV_DEBUG_BASE + 5,
123 IWL_UCODE_TLV_DEBUG_MAX = IWL_UCODE_TLV_TYPE_TRIGGERS,
124
125 /* TLVs 0x1000-0x2000 are for internal driver usage */
126 IWL_UCODE_TLV_FW_DBG_DUMP_LST = 0x1000,
127 };
128
129 struct iwl_ucode_tlv {
130 __le32 type; /* see above */
131 __le32 length; /* not including type/length fields */
132 u8 data[];
133 };
134
135 #define IWL_TLV_UCODE_MAGIC 0x0a4c5749
136 #define FW_VER_HUMAN_READABLE_SZ 64
137
138 struct iwl_tlv_ucode_header {
139 /*
140 * The TLV style ucode header is distinguished from
141 * the v1/v2 style header by first four bytes being
142 * zero, as such is an invalid combination of
143 * major/minor/API/serial versions.
144 */
145 __le32 zero;
146 __le32 magic;
147 u8 human_readable[FW_VER_HUMAN_READABLE_SZ];
148 /* major/minor/API/serial or major in new format */
149 __le32 ver;
150 __le32 build;
151 __le64 ignore;
152 /*
153 * The data contained herein has a TLV layout,
154 * see above for the TLV header and types.
155 * Note that each TLV is padded to a length
156 * that is a multiple of 4 for alignment.
157 */
158 u8 data[];
159 };
160
161 /*
162 * ucode TLVs
163 *
164 * ability to get extension for: flags & capabilities from ucode binaries files
165 */
166 struct iwl_ucode_api {
167 __le32 api_index;
168 __le32 api_flags;
169 } __packed;
170
171 struct iwl_ucode_capa {
172 __le32 api_index;
173 __le32 api_capa;
174 } __packed;
175
176 /**
177 * enum iwl_ucode_tlv_flag - ucode API flags
178 * @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously
179 * was a separate TLV but moved here to save space.
180 * @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behavior on hidden SSID,
181 * treats good CRC threshold as a boolean
182 * @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w).
183 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: This uCode image supports uAPSD
184 * @IWL_UCODE_TLV_FLAGS_SHORT_BL: 16 entries of block list instead of 64 in scan
185 * offload profile config command.
186 * @IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS: D3 image supports up to six
187 * (rather than two) IPv6 addresses
188 * @IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID: not sending a probe with the SSID element
189 * from the probe request template.
190 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL: new NS offload (small version)
191 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE: new NS offload (large version)
192 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: General support for uAPSD
193 * @IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD: P2P client supports uAPSD power save
194 * @IWL_UCODE_TLV_FLAGS_EBS_SUPPORT: this uCode image supports EBS.
195 */
196 enum iwl_ucode_tlv_flag {
197 IWL_UCODE_TLV_FLAGS_PAN = BIT(0),
198 IWL_UCODE_TLV_FLAGS_NEWSCAN = BIT(1),
199 IWL_UCODE_TLV_FLAGS_MFP = BIT(2),
200 IWL_UCODE_TLV_FLAGS_SHORT_BL = BIT(7),
201 IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS = BIT(10),
202 IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID = BIT(12),
203 IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL = BIT(15),
204 IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE = BIT(16),
205 IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT = BIT(24),
206 IWL_UCODE_TLV_FLAGS_EBS_SUPPORT = BIT(25),
207 IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD = BIT(26),
208 };
209
210 typedef unsigned int __bitwise iwl_ucode_tlv_api_t;
211
212 /**
213 * enum iwl_ucode_tlv_api - ucode api
214 * @IWL_UCODE_TLV_API_FRAGMENTED_SCAN: This ucode supports active dwell time
215 * longer than the passive one, which is essential for fragmented scan.
216 * @IWL_UCODE_TLV_API_WIFI_MCC_UPDATE: ucode supports MCC updates with source.
217 * @IWL_UCODE_TLV_API_LQ_SS_PARAMS: Configure STBC/BFER via LQ CMD ss_params
218 * @IWL_UCODE_TLV_API_NEW_VERSION: new versioning format
219 * @IWL_UCODE_TLV_API_SCAN_TSF_REPORT: Scan start time reported in scan
220 * iteration complete notification, and the timestamp reported for RX
221 * received during scan, are reported in TSF of the mac specified in the
222 * scan request.
223 * @IWL_UCODE_TLV_API_TKIP_MIC_KEYS: This ucode supports version 2 of
224 * ADD_MODIFY_STA_KEY_API_S_VER_2.
225 * @IWL_UCODE_TLV_API_STA_TYPE: This ucode supports station type assignement.
226 * @IWL_UCODE_TLV_API_NAN2_VER2: This ucode supports NAN API version 2
227 * @IWL_UCODE_TLV_API_ADAPTIVE_DWELL: support for adaptive dwell in scanning
228 * @IWL_UCODE_TLV_API_OCE: support for OCE
229 * @IWL_UCODE_TLV_API_NEW_BEACON_TEMPLATE: new beacon template
230 * @IWL_UCODE_TLV_API_NEW_RX_STATS: should new RX STATISTICS API be used
231 * @IWL_UCODE_TLV_API_WOWLAN_KEY_MATERIAL: WoWLAN key material support
232 * @IWL_UCODE_TLV_API_QUOTA_LOW_LATENCY: Quota command includes a field
233 * indicating low latency direction.
234 * @IWL_UCODE_TLV_API_DEPRECATE_TTAK: RX status flag TTAK ok (bit 7) is
235 * deprecated.
236 * @IWL_UCODE_TLV_API_ADAPTIVE_DWELL_V2: This ucode supports version 8
237 * of scan request: SCAN_REQUEST_CMD_UMAC_API_S_VER_8
238 * @IWL_UCODE_TLV_API_FRAG_EBS: This ucode supports fragmented EBS
239 * @IWL_UCODE_TLV_API_REDUCE_TX_POWER: This ucode supports v5 of
240 * the REDUCE_TX_POWER_CMD.
241 * @IWL_UCODE_TLV_API_SHORT_BEACON_NOTIF: This ucode supports the short
242 * version of the beacon notification.
243 * @IWL_UCODE_TLV_API_BEACON_FILTER_V4: This ucode supports v4 of
244 * BEACON_FILTER_CONFIG_API_S_VER_4.
245 * @IWL_UCODE_TLV_API_REGULATORY_NVM_INFO: This ucode supports v4 of
246 * REGULATORY_NVM_GET_INFO_RSP_API_S.
247 * @IWL_UCODE_TLV_API_FTM_NEW_RANGE_REQ: This ucode supports v7 of
248 * LOCATION_RANGE_REQ_CMD_API_S and v6 of LOCATION_RANGE_RESP_NTFY_API_S.
249 * @IWL_UCODE_TLV_API_SCAN_OFFLOAD_CHANS: This ucode supports v2 of
250 * SCAN_OFFLOAD_PROFILE_MATCH_RESULTS_S and v3 of
251 * SCAN_OFFLOAD_PROFILES_QUERY_RSP_S.
252 * @IWL_UCODE_TLV_API_MBSSID_HE: This ucode supports v2 of
253 * STA_CONTEXT_DOT11AX_API_S
254 * @IWL_UCODE_TLV_API_WOWLAN_TCP_SYN_WAKE: WoWLAN TCP-SYN wake support
255 * @IWL_UCODE_TLV_API_FTM_RTT_ACCURACY: version 7 of the range response API
256 * is supported by FW, this indicates the RTT confidence value
257 * @IWL_UCODE_TLV_API_SAR_TABLE_VER: This ucode supports different sar
258 * version tables.
259 * @IWL_UCODE_TLV_API_REDUCED_SCAN_CONFIG: This ucode supports v3 of
260 * SCAN_CONFIG_DB_CMD_API_S.
261 * @IWL_UCODE_TLV_API_ADWELL_HB_DEF_N_AP: support for setting adaptive dwell
262 * number of APs in the 5 GHz band
263 * @IWL_UCODE_TLV_API_SCAN_EXT_CHAN_VER: extended channel config in scan
264 * @IWL_UCODE_TLV_API_BAND_IN_RX_DATA: FW reports band number in RX notification
265 * @IWL_UCODE_TLV_API_NO_HOST_DISABLE_TX: Firmware offloaded the station disable tx
266 * logic.
267 * @IWL_UCODE_TLV_API_INT_DBG_BUF_CLEAR: Firmware supports clearing the debug
268 * internal buffer
269 * @IWL_UCODE_TLV_API_SMART_FIFO_OFFLOAD: Firmware doesn't need the host to
270 * configure the smart fifo
271 *
272 * @NUM_IWL_UCODE_TLV_API: number of bits used
273 */
274 enum iwl_ucode_tlv_api {
275 /* API Set 0 */
276 IWL_UCODE_TLV_API_FRAGMENTED_SCAN = (__force iwl_ucode_tlv_api_t)8,
277 IWL_UCODE_TLV_API_WIFI_MCC_UPDATE = (__force iwl_ucode_tlv_api_t)9,
278 IWL_UCODE_TLV_API_LQ_SS_PARAMS = (__force iwl_ucode_tlv_api_t)18,
279 IWL_UCODE_TLV_API_NEW_VERSION = (__force iwl_ucode_tlv_api_t)20,
280 IWL_UCODE_TLV_API_SCAN_TSF_REPORT = (__force iwl_ucode_tlv_api_t)28,
281 IWL_UCODE_TLV_API_TKIP_MIC_KEYS = (__force iwl_ucode_tlv_api_t)29,
282 IWL_UCODE_TLV_API_STA_TYPE = (__force iwl_ucode_tlv_api_t)30,
283 IWL_UCODE_TLV_API_NAN2_VER2 = (__force iwl_ucode_tlv_api_t)31,
284 /* API Set 1 */
285 IWL_UCODE_TLV_API_ADAPTIVE_DWELL = (__force iwl_ucode_tlv_api_t)32,
286 IWL_UCODE_TLV_API_OCE = (__force iwl_ucode_tlv_api_t)33,
287 IWL_UCODE_TLV_API_NEW_BEACON_TEMPLATE = (__force iwl_ucode_tlv_api_t)34,
288 IWL_UCODE_TLV_API_NEW_RX_STATS = (__force iwl_ucode_tlv_api_t)35,
289 IWL_UCODE_TLV_API_WOWLAN_KEY_MATERIAL = (__force iwl_ucode_tlv_api_t)36,
290 IWL_UCODE_TLV_API_QUOTA_LOW_LATENCY = (__force iwl_ucode_tlv_api_t)38,
291 IWL_UCODE_TLV_API_DEPRECATE_TTAK = (__force iwl_ucode_tlv_api_t)41,
292 IWL_UCODE_TLV_API_ADAPTIVE_DWELL_V2 = (__force iwl_ucode_tlv_api_t)42,
293 IWL_UCODE_TLV_API_FRAG_EBS = (__force iwl_ucode_tlv_api_t)44,
294 IWL_UCODE_TLV_API_REDUCE_TX_POWER = (__force iwl_ucode_tlv_api_t)45,
295 IWL_UCODE_TLV_API_SHORT_BEACON_NOTIF = (__force iwl_ucode_tlv_api_t)46,
296 IWL_UCODE_TLV_API_BEACON_FILTER_V4 = (__force iwl_ucode_tlv_api_t)47,
297 IWL_UCODE_TLV_API_REGULATORY_NVM_INFO = (__force iwl_ucode_tlv_api_t)48,
298 IWL_UCODE_TLV_API_FTM_NEW_RANGE_REQ = (__force iwl_ucode_tlv_api_t)49,
299 IWL_UCODE_TLV_API_SCAN_OFFLOAD_CHANS = (__force iwl_ucode_tlv_api_t)50,
300 IWL_UCODE_TLV_API_MBSSID_HE = (__force iwl_ucode_tlv_api_t)52,
301 IWL_UCODE_TLV_API_WOWLAN_TCP_SYN_WAKE = (__force iwl_ucode_tlv_api_t)53,
302 IWL_UCODE_TLV_API_FTM_RTT_ACCURACY = (__force iwl_ucode_tlv_api_t)54,
303 IWL_UCODE_TLV_API_SAR_TABLE_VER = (__force iwl_ucode_tlv_api_t)55,
304 IWL_UCODE_TLV_API_REDUCED_SCAN_CONFIG = (__force iwl_ucode_tlv_api_t)56,
305 IWL_UCODE_TLV_API_ADWELL_HB_DEF_N_AP = (__force iwl_ucode_tlv_api_t)57,
306 IWL_UCODE_TLV_API_SCAN_EXT_CHAN_VER = (__force iwl_ucode_tlv_api_t)58,
307 IWL_UCODE_TLV_API_BAND_IN_RX_DATA = (__force iwl_ucode_tlv_api_t)59,
308 /* API Set 2 */
309 IWL_UCODE_TLV_API_NO_HOST_DISABLE_TX = (__force iwl_ucode_tlv_api_t)66,
310 IWL_UCODE_TLV_API_INT_DBG_BUF_CLEAR = (__force iwl_ucode_tlv_api_t)67,
311 IWL_UCODE_TLV_API_SMART_FIFO_OFFLOAD = (__force iwl_ucode_tlv_api_t)68,
312
313 NUM_IWL_UCODE_TLV_API
314 /*
315 * This construction make both sparse (which cannot increment the previous
316 * member due to its bitwise type) and kernel-doc (which doesn't understand
317 * the ifdef/else properly) work.
318 */
319 #ifdef __CHECKER__
320 #define __CHECKER_NUM_IWL_UCODE_TLV_API 128
321 = (__force iwl_ucode_tlv_api_t)__CHECKER_NUM_IWL_UCODE_TLV_API,
322 #define NUM_IWL_UCODE_TLV_API __CHECKER_NUM_IWL_UCODE_TLV_API
323 #endif
324 };
325
326 typedef unsigned int __bitwise iwl_ucode_tlv_capa_t;
327
328 /**
329 * enum iwl_ucode_tlv_capa - ucode capabilities
330 * @IWL_UCODE_TLV_CAPA_D0I3_SUPPORT: supports D0i3
331 * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT: supports Location Aware Regulatory
332 * @IWL_UCODE_TLV_CAPA_UMAC_SCAN: supports UMAC scan.
333 * @IWL_UCODE_TLV_CAPA_BEAMFORMER: supports Beamformer
334 * @IWL_UCODE_TLV_CAPA_TDLS_SUPPORT: support basic TDLS functionality
335 * @IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT: supports insertion of current
336 * tx power value into TPC Report action frame and Link Measurement Report
337 * action frame
338 * @IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT: supports updating current
339 * channel in DS parameter set element in probe requests.
340 * @IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT: supports adding TPC Report IE in
341 * probe requests.
342 * @IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT: supports Quiet Period requests
343 * @IWL_UCODE_TLV_CAPA_DQA_SUPPORT: supports dynamic queue allocation (DQA),
344 * which also implies support for the scheduler configuration command
345 * @IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH: supports TDLS channel switching
346 * @IWL_UCODE_TLV_CAPA_CNSLDTD_D3_D0_IMG: Consolidated D3-D0 image
347 * @IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT: supports Hot Spot 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
356 * is supported.
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_FRAGMENTED_PNVM_IMG: supports fragmented PNVM image
360 * @IWL_UCODE_TLV_CAPA_SOC_LATENCY_SUPPORT: the firmware supports setting
361 * stabilization latency for SoCs.
362 * @IWL_UCODE_TLV_CAPA_STA_PM_NOTIF: firmware will send STA PM notification
363 * @IWL_UCODE_TLV_CAPA_BINDING_CDB_SUPPORT: binding CDB support
364 * @IWL_UCODE_TLV_CAPA_CDB_SUPPORT: CDB support
365 * @IWL_UCODE_TLV_CAPA_D0I3_END_FIRST: D0I3 end command comes first
366 * @IWL_UCODE_TLV_CAPA_TLC_OFFLOAD: firmware implements rate scaling algorithm
367 * @IWL_UCODE_TLV_CAPA_DYNAMIC_QUOTA: firmware implements quota related
368 * @IWL_UCODE_TLV_CAPA_COEX_SCHEMA_2: firmware implements Coex Schema 2
369 * @IWL_UCODE_TLV_CAPA_CHANNEL_SWITCH_CMD: firmware supports CSA command
370 * @IWL_UCODE_TLV_CAPA_ULTRA_HB_CHANNELS: firmware supports ultra high band
371 * (6 GHz).
372 * @IWL_UCODE_TLV_CAPA_CS_MODIFY: firmware supports modify action CSA command
373 * @IWL_UCODE_TLV_CAPA_SET_LTR_GEN2: LTR gen2 support
374 * @IWL_UCODE_TLV_CAPA_TAS_CFG: TAS configuration support
375 * @IWL_UCODE_TLV_CAPA_SESSION_PROT_CMD: session protection command
376 * @IWL_UCODE_TLV_CAPA_SET_PPAG: PPAG support
377 * @IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE: extended DTS measurement
378 * @IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS: supports short PM timeouts
379 * @IWL_UCODE_TLV_CAPA_BT_MPLUT_SUPPORT: supports bt-coex Multi-priority LUT
380 * @IWL_UCODE_TLV_CAPA_MULTI_QUEUE_RX_SUPPORT: MQ RX support
381 * @IWL_UCODE_TLV_CAPA_CSA_AND_TBTT_OFFLOAD: the firmware supports CSA
382 * countdown offloading. Beacon notifications are not sent to the host.
383 * The fw also offloads TBTT alignment.
384 * @IWL_UCODE_TLV_CAPA_BEACON_ANT_SELECTION: firmware will decide on what
385 * antenna the beacon should be transmitted
386 * @IWL_UCODE_TLV_CAPA_BEACON_STORING: firmware will store the latest beacon
387 * from AP and will send it upon d0i3 exit.
388 * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT_V3: support LAR API V3
389 * @IWL_UCODE_TLV_CAPA_CT_KILL_BY_FW: firmware responsible for CT-kill
390 * @IWL_UCODE_TLV_CAPA_TEMP_THS_REPORT_SUPPORT: supports temperature
391 * thresholds reporting
392 * @IWL_UCODE_TLV_CAPA_CTDP_SUPPORT: supports cTDP command
393 * @IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED: supports usniffer enabled in
394 * regular image.
395 * @IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG: support getting more shared
396 * memory addresses from the firmware.
397 * @IWL_UCODE_TLV_CAPA_LQM_SUPPORT: supports Link Quality Measurement
398 * @IWL_UCODE_TLV_CAPA_TX_POWER_ACK: reduced TX power API has larger
399 * command size (command version 4) that supports toggling ACK TX
400 * power reduction.
401 * @IWL_UCODE_TLV_CAPA_D3_DEBUG: supports debug recording during D3
402 * @IWL_UCODE_TLV_CAPA_LED_CMD_SUPPORT: LED command support
403 * @IWL_UCODE_TLV_CAPA_MCC_UPDATE_11AX_SUPPORT: MCC response support 11ax
404 * capability.
405 * @IWL_UCODE_TLV_CAPA_CSI_REPORTING: firmware is capable of being configured
406 * to report the CSI information with (certain) RX frames
407 * @IWL_UCODE_TLV_CAPA_DBG_SUSPEND_RESUME_CMD_SUPP: suspend/resume command
408 * @IWL_UCODE_TLV_CAPA_DBG_BUF_ALLOC_CMD_SUPP: support for DBGC
409 * buffer allocation command
410 * @IWL_UCODE_TLV_CAPA_FTM_CALIBRATED: has FTM calibrated and thus supports both
411 * initiator and responder
412 * @IWL_UCODE_TLV_CAPA_BIOS_OVERRIDE_UNII4_US_CA: supports (de)activating UNII-4
413 * for US/CA/WW from BIOS
414 * @IWL_UCODE_TLV_CAPA_PSC_CHAN_SUPPORT: supports PSC channels
415 * @IWL_UCODE_TLV_CAPA_BIGTK_SUPPORT: BIGTK support
416 * @IWL_UCODE_TLV_CAPA_PROTECTED_TWT: Supports protection of TWT action frames
417 * @IWL_UCODE_TLV_CAPA_FW_RESET_HANDSHAKE: Supports the firmware handshake in
418 * reset flow
419 * @IWL_UCODE_TLV_CAPA_PASSIVE_6GHZ_SCAN: Support for passive scan on 6GHz PSC
420 * channels even when these are not enabled.
421 * @IWL_UCODE_TLV_CAPA_HIDDEN_6GHZ_SCAN: hidden SSID 6 GHz scan support
422 * @IWL_UCODE_TLV_CAPA_BROADCAST_TWT: broadcast TWT support
423 * @IWL_UCODE_TLV_CAPA_COEX_HIGH_PRIO: support for BT-coex high
424 * priority for 802.1X/4-way-HS
425 * @IWL_UCODE_TLV_CAPA_BAID_ML_SUPPORT: multi-link BAID support
426 * @IWL_UCODE_TLV_CAPA_SYNCED_TIME: synced time command support
427 * @IWL_UCODE_TLV_CAPA_TIME_SYNC_BOTH_FTM_TM: time sync support
428 * @IWL_UCODE_TLV_CAPA_BIGTK_TX_SUPPORT: BIGTK TX support
429 * @IWL_UCODE_TLV_CAPA_MLD_API_SUPPORT: MLD API support
430 * @IWL_UCODE_TLV_CAPA_SCAN_DONT_TOGGLE_ANT: fixed antenna scan support
431 * @IWL_UCODE_TLV_CAPA_PPAG_CHINA_BIOS_SUPPORT: PPAG China BIOS support
432 * @IWL_UCODE_TLV_CAPA_OFFLOAD_BTM_SUPPORT: BTM protocol offload support
433 * @IWL_UCODE_TLV_CAPA_STA_EXP_MFP_SUPPORT: STA command MFP support
434 * @IWL_UCODE_TLV_CAPA_SNIFF_VALIDATE_SUPPORT: sniffer validate bits support
435 * @IWL_UCODE_TLV_CAPA_CHINA_22_REG_SUPPORT: China 2022 regulator support
436 * @IWL_UCODE_TLV_CAPA_DUMP_COMPLETE_SUPPORT: Support for indicating dump collection
437 * complete to FW.
438 * @IWL_UCODE_TLV_CAPA_SPP_AMSDU_SUPPORT: Support SPP (signaling and payload
439 * protected) A-MSDU.
440 * @IWL_UCODE_TLV_CAPA_DRAM_FRAG_SUPPORT: support for DBGC fragmented
441 * DRAM buffers
442 * @IWL_UCODE_TLV_CAPA_SECURE_LTF_SUPPORT: Support secure LTF measurement.
443 * @IWL_UCODE_TLV_CAPA_MONITOR_PASSIVE_CHANS: Support monitor mode on otherwise
444 * passive channels
445 * @IWL_UCODE_TLV_CAPA_BIOS_OVERRIDE_5G9_FOR_CA: supports (de)activating 5G9
446 * for CA from BIOS.
447 * @IWL_UCODE_TLV_CAPA_UHB_CANADA_TAS_SUPPORT: supports %TAS_UHB_ALLOWED_CANADA
448 * @IWL_UCODE_TLV_CAPA_EXT_FSEQ_IMAGE_SUPPORT: external FSEQ image support
449 * @IWL_UCODE_TLV_CAPA_RESET_DURING_ASSERT: FW reset handshake is needed
450 * during assert handling even if the dump isn't split
451 * @IWL_UCODE_TLV_CAPA_FW_ACCEPTS_RAW_DSM_TABLE: Firmware can handle raw DSM
452 * table data. For LARI_CONFIG_CHANGE command version 13 and above, this
453 * capability is obsolete since raw DSM values are accepted by default.
454 * @IWL_UCODE_TLV_CAPA_NAN_SYNC_SUPPORT: Supports NAN synchronization
455 *
456 * @NUM_IWL_UCODE_TLV_CAPA: number of bits used
457 */
458 enum iwl_ucode_tlv_capa {
459 /* set 0 */
460 IWL_UCODE_TLV_CAPA_D0I3_SUPPORT = (__force iwl_ucode_tlv_capa_t)0,
461 IWL_UCODE_TLV_CAPA_LAR_SUPPORT = (__force iwl_ucode_tlv_capa_t)1,
462 IWL_UCODE_TLV_CAPA_UMAC_SCAN = (__force iwl_ucode_tlv_capa_t)2,
463 IWL_UCODE_TLV_CAPA_BEAMFORMER = (__force iwl_ucode_tlv_capa_t)3,
464 IWL_UCODE_TLV_CAPA_TDLS_SUPPORT = (__force iwl_ucode_tlv_capa_t)6,
465 IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT = (__force iwl_ucode_tlv_capa_t)8,
466 IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT = (__force iwl_ucode_tlv_capa_t)9,
467 IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT = (__force iwl_ucode_tlv_capa_t)10,
468 IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT = (__force iwl_ucode_tlv_capa_t)11,
469 IWL_UCODE_TLV_CAPA_DQA_SUPPORT = (__force iwl_ucode_tlv_capa_t)12,
470 IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH = (__force iwl_ucode_tlv_capa_t)13,
471 IWL_UCODE_TLV_CAPA_CNSLDTD_D3_D0_IMG = (__force iwl_ucode_tlv_capa_t)17,
472 IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT = (__force iwl_ucode_tlv_capa_t)18,
473 IWL_UCODE_TLV_CAPA_CSUM_SUPPORT = (__force iwl_ucode_tlv_capa_t)21,
474 IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS = (__force iwl_ucode_tlv_capa_t)22,
475 IWL_UCODE_TLV_CAPA_P2P_SCM_UAPSD = (__force iwl_ucode_tlv_capa_t)26,
476 IWL_UCODE_TLV_CAPA_BT_COEX_PLCR = (__force iwl_ucode_tlv_capa_t)28,
477 IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC = (__force iwl_ucode_tlv_capa_t)29,
478 IWL_UCODE_TLV_CAPA_BT_COEX_RRC = (__force iwl_ucode_tlv_capa_t)30,
479 IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT = (__force iwl_ucode_tlv_capa_t)31,
480
481 /* set 1 */
482 IWL_UCODE_TLV_CAPA_FRAGMENTED_PNVM_IMG = (__force iwl_ucode_tlv_capa_t)32,
483 IWL_UCODE_TLV_CAPA_SOC_LATENCY_SUPPORT = (__force iwl_ucode_tlv_capa_t)37,
484 IWL_UCODE_TLV_CAPA_STA_PM_NOTIF = (__force iwl_ucode_tlv_capa_t)38,
485 IWL_UCODE_TLV_CAPA_BINDING_CDB_SUPPORT = (__force iwl_ucode_tlv_capa_t)39,
486 IWL_UCODE_TLV_CAPA_CDB_SUPPORT = (__force iwl_ucode_tlv_capa_t)40,
487 IWL_UCODE_TLV_CAPA_D0I3_END_FIRST = (__force iwl_ucode_tlv_capa_t)41,
488 IWL_UCODE_TLV_CAPA_TLC_OFFLOAD = (__force iwl_ucode_tlv_capa_t)43,
489 IWL_UCODE_TLV_CAPA_DYNAMIC_QUOTA = (__force iwl_ucode_tlv_capa_t)44,
490 IWL_UCODE_TLV_CAPA_COEX_SCHEMA_2 = (__force iwl_ucode_tlv_capa_t)45,
491 IWL_UCODE_TLV_CAPA_CHANNEL_SWITCH_CMD = (__force iwl_ucode_tlv_capa_t)46,
492 IWL_UCODE_TLV_CAPA_FTM_CALIBRATED = (__force iwl_ucode_tlv_capa_t)47,
493 IWL_UCODE_TLV_CAPA_ULTRA_HB_CHANNELS = (__force iwl_ucode_tlv_capa_t)48,
494 IWL_UCODE_TLV_CAPA_CS_MODIFY = (__force iwl_ucode_tlv_capa_t)49,
495 IWL_UCODE_TLV_CAPA_SET_LTR_GEN2 = (__force iwl_ucode_tlv_capa_t)50,
496 IWL_UCODE_TLV_CAPA_SET_PPAG = (__force iwl_ucode_tlv_capa_t)52,
497 IWL_UCODE_TLV_CAPA_TAS_CFG = (__force iwl_ucode_tlv_capa_t)53,
498 IWL_UCODE_TLV_CAPA_SESSION_PROT_CMD = (__force iwl_ucode_tlv_capa_t)54,
499 IWL_UCODE_TLV_CAPA_PROTECTED_TWT = (__force iwl_ucode_tlv_capa_t)56,
500 IWL_UCODE_TLV_CAPA_FW_RESET_HANDSHAKE = (__force iwl_ucode_tlv_capa_t)57,
501 IWL_UCODE_TLV_CAPA_PASSIVE_6GHZ_SCAN = (__force iwl_ucode_tlv_capa_t)58,
502 IWL_UCODE_TLV_CAPA_HIDDEN_6GHZ_SCAN = (__force iwl_ucode_tlv_capa_t)59,
503 IWL_UCODE_TLV_CAPA_BROADCAST_TWT = (__force iwl_ucode_tlv_capa_t)60,
504 IWL_UCODE_TLV_CAPA_COEX_HIGH_PRIO = (__force iwl_ucode_tlv_capa_t)61,
505 IWL_UCODE_TLV_CAPA_RFIM_SUPPORT = (__force iwl_ucode_tlv_capa_t)62,
506 IWL_UCODE_TLV_CAPA_BAID_ML_SUPPORT = (__force iwl_ucode_tlv_capa_t)63,
507
508 /* set 2 */
509 IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE = (__force iwl_ucode_tlv_capa_t)64,
510 IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS = (__force iwl_ucode_tlv_capa_t)65,
511 IWL_UCODE_TLV_CAPA_BT_MPLUT_SUPPORT = (__force iwl_ucode_tlv_capa_t)67,
512 IWL_UCODE_TLV_CAPA_MULTI_QUEUE_RX_SUPPORT = (__force iwl_ucode_tlv_capa_t)68,
513 IWL_UCODE_TLV_CAPA_CSA_AND_TBTT_OFFLOAD = (__force iwl_ucode_tlv_capa_t)70,
514 IWL_UCODE_TLV_CAPA_BEACON_ANT_SELECTION = (__force iwl_ucode_tlv_capa_t)71,
515 IWL_UCODE_TLV_CAPA_BEACON_STORING = (__force iwl_ucode_tlv_capa_t)72,
516 IWL_UCODE_TLV_CAPA_LAR_SUPPORT_V3 = (__force iwl_ucode_tlv_capa_t)73,
517 IWL_UCODE_TLV_CAPA_CT_KILL_BY_FW = (__force iwl_ucode_tlv_capa_t)74,
518 IWL_UCODE_TLV_CAPA_TEMP_THS_REPORT_SUPPORT = (__force iwl_ucode_tlv_capa_t)75,
519 IWL_UCODE_TLV_CAPA_CTDP_SUPPORT = (__force iwl_ucode_tlv_capa_t)76,
520 IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED = (__force iwl_ucode_tlv_capa_t)77,
521 IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG = (__force iwl_ucode_tlv_capa_t)80,
522 IWL_UCODE_TLV_CAPA_LQM_SUPPORT = (__force iwl_ucode_tlv_capa_t)81,
523 IWL_UCODE_TLV_CAPA_TX_POWER_ACK = (__force iwl_ucode_tlv_capa_t)84,
524 IWL_UCODE_TLV_CAPA_D3_DEBUG = (__force iwl_ucode_tlv_capa_t)87,
525 IWL_UCODE_TLV_CAPA_LED_CMD_SUPPORT = (__force iwl_ucode_tlv_capa_t)88,
526 IWL_UCODE_TLV_CAPA_MCC_UPDATE_11AX_SUPPORT = (__force iwl_ucode_tlv_capa_t)89,
527 IWL_UCODE_TLV_CAPA_CSI_REPORTING = (__force iwl_ucode_tlv_capa_t)90,
528 IWL_UCODE_TLV_CAPA_DBG_SUSPEND_RESUME_CMD_SUPP = (__force iwl_ucode_tlv_capa_t)92,
529 IWL_UCODE_TLV_CAPA_DBG_BUF_ALLOC_CMD_SUPP = (__force iwl_ucode_tlv_capa_t)93,
530
531 /* set 3 */
532 IWL_UCODE_TLV_CAPA_BIOS_OVERRIDE_UNII4_US_CA = (__force iwl_ucode_tlv_capa_t)96,
533 IWL_UCODE_TLV_CAPA_PSC_CHAN_SUPPORT = (__force iwl_ucode_tlv_capa_t)98,
534 IWL_UCODE_TLV_CAPA_BIGTK_SUPPORT = (__force iwl_ucode_tlv_capa_t)100,
535 IWL_UCODE_TLV_CAPA_SPP_AMSDU_SUPPORT = (__force iwl_ucode_tlv_capa_t)103,
536 IWL_UCODE_TLV_CAPA_DRAM_FRAG_SUPPORT = (__force iwl_ucode_tlv_capa_t)104,
537 IWL_UCODE_TLV_CAPA_DUMP_COMPLETE_SUPPORT = (__force iwl_ucode_tlv_capa_t)105,
538 IWL_UCODE_TLV_CAPA_SYNCED_TIME = (__force iwl_ucode_tlv_capa_t)106,
539 IWL_UCODE_TLV_CAPA_TIME_SYNC_BOTH_FTM_TM = (__force iwl_ucode_tlv_capa_t)108,
540 IWL_UCODE_TLV_CAPA_BIGTK_TX_SUPPORT = (__force iwl_ucode_tlv_capa_t)109,
541 IWL_UCODE_TLV_CAPA_MLD_API_SUPPORT = (__force iwl_ucode_tlv_capa_t)110,
542 IWL_UCODE_TLV_CAPA_SCAN_DONT_TOGGLE_ANT = (__force iwl_ucode_tlv_capa_t)111,
543 IWL_UCODE_TLV_CAPA_PPAG_CHINA_BIOS_SUPPORT = (__force iwl_ucode_tlv_capa_t)112,
544 IWL_UCODE_TLV_CAPA_OFFLOAD_BTM_SUPPORT = (__force iwl_ucode_tlv_capa_t)113,
545 IWL_UCODE_TLV_CAPA_STA_EXP_MFP_SUPPORT = (__force iwl_ucode_tlv_capa_t)114,
546 IWL_UCODE_TLV_CAPA_SNIFF_VALIDATE_SUPPORT = (__force iwl_ucode_tlv_capa_t)116,
547 IWL_UCODE_TLV_CAPA_CHINA_22_REG_SUPPORT = (__force iwl_ucode_tlv_capa_t)117,
548 IWL_UCODE_TLV_CAPA_SECURE_LTF_SUPPORT = (__force iwl_ucode_tlv_capa_t)121,
549 IWL_UCODE_TLV_CAPA_MONITOR_PASSIVE_CHANS = (__force iwl_ucode_tlv_capa_t)122,
550 IWL_UCODE_TLV_CAPA_BIOS_OVERRIDE_5G9_FOR_CA = (__force iwl_ucode_tlv_capa_t)123,
551 IWL_UCODE_TLV_CAPA_UHB_CANADA_TAS_SUPPORT = (__force iwl_ucode_tlv_capa_t)124,
552 IWL_UCODE_TLV_CAPA_EXT_FSEQ_IMAGE_SUPPORT = (__force iwl_ucode_tlv_capa_t)125,
553
554 /* set 4 */
555
556 IWL_UCODE_TLV_CAPA_RESET_DURING_ASSERT = (__force iwl_ucode_tlv_capa_t)(4 * 32 + 0),
557 IWL_UCODE_TLV_CAPA_FW_ACCEPTS_RAW_DSM_TABLE = (__force iwl_ucode_tlv_capa_t)(4 * 32 + 1),
558 IWL_UCODE_TLV_CAPA_NAN_SYNC_SUPPORT = (__force iwl_ucode_tlv_capa_t)(4 * 32 + 2),
559 NUM_IWL_UCODE_TLV_CAPA
560 /*
561 * This construction make both sparse (which cannot increment the previous
562 * member due to its bitwise type) and kernel-doc (which doesn't understand
563 * the ifdef/else properly) work.
564 */
565 #ifdef __CHECKER__
566 #define __CHECKER_NUM_IWL_UCODE_TLV_CAPA 128
567 = (__force iwl_ucode_tlv_capa_t)__CHECKER_NUM_IWL_UCODE_TLV_CAPA,
568 #define NUM_IWL_UCODE_TLV_CAPA __CHECKER_NUM_IWL_UCODE_TLV_CAPA
569 #endif
570 };
571
572 /* The default calibrate table size if not specified by firmware file */
573 #define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE 18
574 #define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE 19
575 #define IWL_MAX_PHY_CALIBRATE_TBL_SIZE 253
576
577 /* The default max probe length if not specified by the firmware file */
578 #define IWL_DEFAULT_MAX_PROBE_LENGTH 200
579
580 /*
581 * For 16.0 uCode and above, there is no differentiation between sections,
582 * just an offset to the HW address.
583 */
584 #define CPU1_CPU2_SEPARATOR_SECTION 0xFFFFCCCC
585 #define PAGING_SEPARATOR_SECTION 0xAAAABBBB
586
587 /* uCode version contains 4 values: Major/Minor/API/Serial */
588 #define IWL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24)
589 #define IWL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16)
590 #define IWL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8)
591 #define IWL_UCODE_SERIAL(ver) ((ver) & 0x000000FF)
592
593 /**
594 * struct iwl_tlv_calib_ctrl - Calibration control struct.
595 * Sent as part of the phy configuration command.
596 * @flow_trigger: bitmap for which calibrations to perform according to
597 * flow triggers.
598 * @event_trigger: bitmap for which calibrations to perform according to
599 * event triggers.
600 */
601 struct iwl_tlv_calib_ctrl {
602 __le32 flow_trigger;
603 __le32 event_trigger;
604 } __packed;
605
606 enum iwl_fw_phy_cfg {
607 FW_PHY_CFG_RADIO_TYPE_POS = 0,
608 FW_PHY_CFG_RADIO_TYPE = 0x3 << FW_PHY_CFG_RADIO_TYPE_POS,
609 FW_PHY_CFG_RADIO_STEP_POS = 2,
610 FW_PHY_CFG_RADIO_STEP = 0x3 << FW_PHY_CFG_RADIO_STEP_POS,
611 FW_PHY_CFG_RADIO_DASH_POS = 4,
612 FW_PHY_CFG_RADIO_DASH = 0x3 << FW_PHY_CFG_RADIO_DASH_POS,
613 FW_PHY_CFG_TX_CHAIN_POS = 16,
614 FW_PHY_CFG_TX_CHAIN = 0xf << FW_PHY_CFG_TX_CHAIN_POS,
615 FW_PHY_CFG_RX_CHAIN_POS = 20,
616 FW_PHY_CFG_RX_CHAIN = 0xf << FW_PHY_CFG_RX_CHAIN_POS,
617 FW_PHY_CFG_CHAIN_SAD_POS = 23,
618 FW_PHY_CFG_CHAIN_SAD_ENABLED = 0x1 << FW_PHY_CFG_CHAIN_SAD_POS,
619 FW_PHY_CFG_CHAIN_SAD_ANT_A = 0x2 << FW_PHY_CFG_CHAIN_SAD_POS,
620 FW_PHY_CFG_CHAIN_SAD_ANT_B = 0x4 << FW_PHY_CFG_CHAIN_SAD_POS,
621 FW_PHY_CFG_SHARED_CLK = BIT(31),
622 };
623
624 enum iwl_fw_dbg_reg_operator {
625 CSR_ASSIGN,
626 CSR_SETBIT,
627 CSR_CLEARBIT,
628
629 PRPH_ASSIGN,
630 PRPH_SETBIT,
631 PRPH_CLEARBIT,
632
633 INDIRECT_ASSIGN,
634 INDIRECT_SETBIT,
635 INDIRECT_CLEARBIT,
636
637 PRPH_BLOCKBIT,
638 };
639
640 /**
641 * struct iwl_fw_dbg_reg_op - an operation on a register
642 *
643 * @op: &enum iwl_fw_dbg_reg_operator
644 * @reserved: reserved
645 * @addr: offset of the register
646 * @val: value
647 */
648 struct iwl_fw_dbg_reg_op {
649 u8 op;
650 u8 reserved[3];
651 __le32 addr;
652 __le32 val;
653 } __packed;
654
655 /**
656 * enum iwl_fw_dbg_monitor_mode - available monitor recording modes
657 *
658 * @SMEM_MODE: monitor stores the data in SMEM
659 * @EXTERNAL_MODE: monitor stores the data in allocated DRAM
660 * @MARBH_MODE: monitor stores the data in MARBH buffer
661 * @MIPI_MODE: monitor outputs the data through the MIPI interface
662 */
663 enum iwl_fw_dbg_monitor_mode {
664 SMEM_MODE = 0,
665 EXTERNAL_MODE = 1,
666 MARBH_MODE = 2,
667 MIPI_MODE = 3,
668 };
669
670 /**
671 * struct iwl_fw_dbg_mem_seg_tlv - configures the debug data memory segments
672 *
673 * @data_type: the memory segment type to record
674 * @ofs: the memory segment offset
675 * @len: the memory segment length, in bytes
676 *
677 * This parses IWL_UCODE_TLV_FW_MEM_SEG
678 */
679 struct iwl_fw_dbg_mem_seg_tlv {
680 __le32 data_type;
681 __le32 ofs;
682 __le32 len;
683 } __packed;
684
685 /**
686 * struct iwl_fw_dbg_dest_tlv_v1 - configures the destination of the debug data
687 *
688 * @version: version of the TLV - currently 0
689 * @monitor_mode: &enum iwl_fw_dbg_monitor_mode
690 * @size_power: buffer size will be 2^(size_power + 11)
691 * @reserved: reserved
692 * @base_reg: addr of the base addr register (PRPH)
693 * @end_reg: addr of the end addr register (PRPH)
694 * @write_ptr_reg: the addr of the reg of the write pointer
695 * @wrap_count: the addr of the reg of the wrap_count
696 * @base_shift: shift right of the base addr reg
697 * @end_shift: shift right of the end addr reg
698 * @reg_ops: array of registers operations
699 *
700 * This parses IWL_UCODE_TLV_FW_DBG_DEST
701 */
702 struct iwl_fw_dbg_dest_tlv_v1 {
703 u8 version;
704 u8 monitor_mode;
705 u8 size_power;
706 u8 reserved;
707 __le32 base_reg;
708 __le32 end_reg;
709 __le32 write_ptr_reg;
710 __le32 wrap_count;
711 u8 base_shift;
712 u8 end_shift;
713 struct iwl_fw_dbg_reg_op reg_ops[];
714 } __packed;
715
716 /* Mask of the register for defining the LDBG MAC2SMEM buffer SMEM size */
717 #define IWL_LDBG_M2S_BUF_SIZE_MSK 0x0fff0000
718 /* Mask of the register for defining the LDBG MAC2SMEM SMEM base address */
719 #define IWL_LDBG_M2S_BUF_BA_MSK 0x00000fff
720 /* The smem buffer chunks are in units of 256 bits */
721 #define IWL_M2S_UNIT_SIZE 0x100
722
723 struct iwl_fw_dbg_dest_tlv {
724 u8 version;
725 u8 monitor_mode;
726 u8 size_power;
727 u8 reserved;
728 __le32 cfg_reg;
729 __le32 write_ptr_reg;
730 __le32 wrap_count;
731 u8 base_shift;
732 u8 size_shift;
733 struct iwl_fw_dbg_reg_op reg_ops[];
734 } __packed;
735
736 struct iwl_fw_dbg_conf_hcmd {
737 u8 id;
738 u8 reserved;
739 __le16 len;
740 u8 data[];
741 } __packed;
742
743 /**
744 * enum iwl_fw_dbg_trigger_mode - triggers functionalities
745 *
746 * @IWL_FW_DBG_TRIGGER_START: when trigger occurs re-conf the dbg mechanism
747 * @IWL_FW_DBG_TRIGGER_STOP: when trigger occurs pull the dbg data
748 * @IWL_FW_DBG_TRIGGER_MONITOR_ONLY: when trigger occurs trigger is set to
749 * collect only monitor data
750 */
751 enum iwl_fw_dbg_trigger_mode {
752 IWL_FW_DBG_TRIGGER_START = BIT(0),
753 IWL_FW_DBG_TRIGGER_STOP = BIT(1),
754 IWL_FW_DBG_TRIGGER_MONITOR_ONLY = BIT(2),
755 };
756
757 /**
758 * enum iwl_fw_dbg_trigger_flags - the flags supported by wrt triggers
759 * @IWL_FW_DBG_FORCE_RESTART: force a firmware restart
760 */
761 enum iwl_fw_dbg_trigger_flags {
762 IWL_FW_DBG_FORCE_RESTART = BIT(0),
763 };
764
765 /**
766 * enum iwl_fw_dbg_trigger_vif_type - define the VIF type for a trigger
767 * @IWL_FW_DBG_CONF_VIF_ANY: any vif type
768 * @IWL_FW_DBG_CONF_VIF_IBSS: IBSS mode
769 * @IWL_FW_DBG_CONF_VIF_STATION: BSS mode
770 * @IWL_FW_DBG_CONF_VIF_AP: AP mode
771 * @IWL_FW_DBG_CONF_VIF_P2P_CLIENT: P2P Client mode
772 * @IWL_FW_DBG_CONF_VIF_P2P_GO: P2P GO mode
773 * @IWL_FW_DBG_CONF_VIF_P2P_DEVICE: P2P device
774 */
775 enum iwl_fw_dbg_trigger_vif_type {
776 IWL_FW_DBG_CONF_VIF_ANY = NL80211_IFTYPE_UNSPECIFIED,
777 IWL_FW_DBG_CONF_VIF_IBSS = NL80211_IFTYPE_ADHOC,
778 IWL_FW_DBG_CONF_VIF_STATION = NL80211_IFTYPE_STATION,
779 IWL_FW_DBG_CONF_VIF_AP = NL80211_IFTYPE_AP,
780 IWL_FW_DBG_CONF_VIF_P2P_CLIENT = NL80211_IFTYPE_P2P_CLIENT,
781 IWL_FW_DBG_CONF_VIF_P2P_GO = NL80211_IFTYPE_P2P_GO,
782 IWL_FW_DBG_CONF_VIF_P2P_DEVICE = NL80211_IFTYPE_P2P_DEVICE,
783 };
784
785 /**
786 * struct iwl_fw_dbg_trigger_tlv - a TLV that describes the trigger
787 * @id: &enum iwl_fw_dbg_trigger
788 * @vif_type: &enum iwl_fw_dbg_trigger_vif_type
789 * @stop_conf_ids: bitmap of configurations this trigger relates to.
790 * if the mode is %IWL_FW_DBG_TRIGGER_STOP, then if the bit corresponding
791 * to the currently running configuration is set, the data should be
792 * collected.
793 * @stop_delay: how many milliseconds to wait before collecting the data
794 * after the STOP trigger fires.
795 * @mode: &enum iwl_fw_dbg_trigger_mode - can be stop / start of both
796 * @start_conf_id: if mode is %IWL_FW_DBG_TRIGGER_START, this defines what
797 * configuration should be applied when the triggers kicks in.
798 * @occurrences: number of occurrences. 0 means the trigger will never fire.
799 * @trig_dis_ms: the time, in milliseconds, after an occurrence of this
800 * trigger in which another occurrence should be ignored.
801 * @flags: &enum iwl_fw_dbg_trigger_flags
802 * @reserved: reserved (for alignment)
803 * @data: trigger data
804 */
805 struct iwl_fw_dbg_trigger_tlv {
806 __le32 id;
807 __le32 vif_type;
808 __le32 stop_conf_ids;
809 __le32 stop_delay;
810 u8 mode;
811 u8 start_conf_id;
812 __le16 occurrences;
813 __le16 trig_dis_ms;
814 u8 flags;
815 u8 reserved[5];
816
817 u8 data[];
818 } __packed;
819
820 #define FW_DBG_START_FROM_ALIVE 0
821 #define FW_DBG_CONF_MAX 32
822 #define FW_DBG_INVALID 0xff
823
824 /**
825 * struct iwl_fw_dbg_trigger_missed_bcon - configures trigger for missed beacons
826 * @stop_consec_missed_bcon: stop recording if threshold is crossed.
827 * @stop_consec_missed_bcon_since_rx: stop recording if threshold is crossed.
828 * @start_consec_missed_bcon: start recording if threshold is crossed.
829 * @start_consec_missed_bcon_since_rx: start recording if threshold is crossed.
830 * @reserved1: reserved
831 * @reserved2: reserved
832 */
833 struct iwl_fw_dbg_trigger_missed_bcon {
834 __le32 stop_consec_missed_bcon;
835 __le32 stop_consec_missed_bcon_since_rx;
836 __le32 reserved2[2];
837 __le32 start_consec_missed_bcon;
838 __le32 start_consec_missed_bcon_since_rx;
839 __le32 reserved1[2];
840 } __packed;
841
842 /**
843 * struct iwl_fw_dbg_trigger_cmd - configures trigger for messages from FW.
844 * @cmds: the list of commands to trigger the collection on
845 */
846 struct iwl_fw_dbg_trigger_cmd {
847 struct cmd {
848 u8 cmd_id;
849 u8 group_id;
850 } __packed cmds[16];
851 } __packed;
852
853 /**
854 * struct iwl_fw_dbg_trigger_stats - configures trigger for statistics
855 * @stop_offset: the offset of the value to be monitored
856 * @stop_threshold: the threshold above which to collect
857 * @start_offset: the offset of the value to be monitored
858 * @start_threshold: the threshold above which to start recording
859 */
860 struct iwl_fw_dbg_trigger_stats {
861 __le32 stop_offset;
862 __le32 stop_threshold;
863 __le32 start_offset;
864 __le32 start_threshold;
865 } __packed;
866
867 /**
868 * struct iwl_fw_dbg_trigger_low_rssi - trigger for low beacon RSSI
869 * @rssi: RSSI value to trigger at
870 */
871 struct iwl_fw_dbg_trigger_low_rssi {
872 __le32 rssi;
873 } __packed;
874
875 /**
876 * struct iwl_fw_dbg_trigger_mlme - configures trigger for mlme events
877 * @stop_auth_denied: number of denied authentication to collect
878 * @stop_auth_timeout: number of authentication timeout to collect
879 * @stop_rx_deauth: number of Rx deauth before to collect
880 * @stop_tx_deauth: number of Tx deauth before to collect
881 * @stop_assoc_denied: number of denied association to collect
882 * @stop_assoc_timeout: number of association timeout to collect
883 * @stop_connection_loss: number of connection loss to collect
884 * @start_auth_denied: number of denied authentication to start recording
885 * @start_auth_timeout: number of authentication timeout to start recording
886 * @start_rx_deauth: number of Rx deauth to start recording
887 * @start_tx_deauth: number of Tx deauth to start recording
888 * @start_assoc_denied: number of denied association to start recording
889 * @start_assoc_timeout: number of association timeout to start recording
890 * @start_connection_loss: number of connection loss to start recording
891 * @reserved: reserved
892 * @reserved2: reserved
893 */
894 struct iwl_fw_dbg_trigger_mlme {
895 u8 stop_auth_denied;
896 u8 stop_auth_timeout;
897 u8 stop_rx_deauth;
898 u8 stop_tx_deauth;
899
900 u8 stop_assoc_denied;
901 u8 stop_assoc_timeout;
902 u8 stop_connection_loss;
903 u8 reserved;
904
905 u8 start_auth_denied;
906 u8 start_auth_timeout;
907 u8 start_rx_deauth;
908 u8 start_tx_deauth;
909
910 u8 start_assoc_denied;
911 u8 start_assoc_timeout;
912 u8 start_connection_loss;
913 u8 reserved2;
914 } __packed;
915
916 /**
917 * struct iwl_fw_dbg_trigger_txq_timer - configures the Tx queue's timer
918 * @command_queue: timeout for the command queue in ms
919 * @bss: timeout for the queues of a BSS (except for TDLS queues) in ms
920 * @softap: timeout for the queues of a softAP in ms
921 * @p2p_go: timeout for the queues of a P2P GO in ms
922 * @p2p_client: timeout for the queues of a P2P client in ms
923 * @p2p_device: timeout for the queues of a P2P device in ms
924 * @ibss: timeout for the queues of an IBSS in ms
925 * @tdls: timeout for the queues of a TDLS station in ms
926 * @reserved: reserved
927 */
928 struct iwl_fw_dbg_trigger_txq_timer {
929 __le32 command_queue;
930 __le32 bss;
931 __le32 softap;
932 __le32 p2p_go;
933 __le32 p2p_client;
934 __le32 p2p_device;
935 __le32 ibss;
936 __le32 tdls;
937 __le32 reserved[4];
938 } __packed;
939
940 /**
941 * struct iwl_fw_dbg_trigger_time_event - configures a time event trigger
942 * @time_events: a list of tuples <id, action_bitmap>. The driver will issue a
943 * trigger each time a time event notification that relates to time event
944 * id with one of the actions in the bitmap is received and
945 * BIT(notif->status) is set in status_bitmap.
946 *
947 */
948 struct iwl_fw_dbg_trigger_time_event {
949 struct {
950 __le32 id;
951 __le32 action_bitmap;
952 __le32 status_bitmap;
953 } __packed time_events[16];
954 } __packed;
955
956 /**
957 * struct iwl_fw_dbg_trigger_ba - configures BlockAck related trigger
958 * @rx_ba_start: tid bitmap to configure on what tid the trigger should occur
959 * when an Rx BlockAck session is started.
960 * @rx_ba_stop: tid bitmap to configure on what tid the trigger should occur
961 * when an Rx BlockAck session is stopped.
962 * @tx_ba_start: tid bitmap to configure on what tid the trigger should occur
963 * when a Tx BlockAck session is started.
964 * @tx_ba_stop: tid bitmap to configure on what tid the trigger should occur
965 * when a Tx BlockAck session is stopped.
966 * @rx_bar: tid bitmap to configure on what tid the trigger should occur
967 * when a BAR is received (for a Tx BlockAck session).
968 * @tx_bar: tid bitmap to configure on what tid the trigger should occur
969 * when a BAR is send (for an Rx BlocAck session).
970 * @frame_timeout: tid bitmap to configure on what tid the trigger should occur
971 * when a frame times out in the reordering buffer.
972 */
973 struct iwl_fw_dbg_trigger_ba {
974 __le16 rx_ba_start;
975 __le16 rx_ba_stop;
976 __le16 tx_ba_start;
977 __le16 tx_ba_stop;
978 __le16 rx_bar;
979 __le16 tx_bar;
980 __le16 frame_timeout;
981 } __packed;
982
983 /**
984 * struct iwl_fw_dbg_trigger_tdls - configures trigger for TDLS events.
985 * @action_bitmap: the TDLS action to trigger the collection upon
986 * @peer_mode: trigger on specific peer or all
987 * @peer: the TDLS peer to trigger the collection on
988 * @reserved: reserved
989 */
990 struct iwl_fw_dbg_trigger_tdls {
991 u8 action_bitmap;
992 u8 peer_mode;
993 u8 peer[ETH_ALEN];
994 u8 reserved[4];
995 } __packed;
996
997 /**
998 * struct iwl_fw_dbg_trigger_tx_status - configures trigger for tx response
999 * status.
1000 * @statuses: the list of statuses to trigger the collection on
1001 * @reserved: reserved
1002 */
1003 struct iwl_fw_dbg_trigger_tx_status {
1004 struct tx_status {
1005 u8 status;
1006 u8 reserved[3];
1007 } __packed statuses[16];
1008 __le32 reserved[2];
1009 } __packed;
1010
1011 /**
1012 * struct iwl_fw_dbg_conf_tlv - a TLV that describes a debug configuration.
1013 * @id: conf id
1014 * @usniffer: should the uSniffer image be used
1015 * @reserved: reserved
1016 * @num_of_hcmds: how many HCMDs to send are present here
1017 * @hcmd: a variable length host command to be sent to apply the configuration.
1018 * If there is more than one HCMD to send, they will appear one after the
1019 * other and be sent in the order that they appear in.
1020 * This parses IWL_UCODE_TLV_FW_DBG_CONF. The user can add up-to
1021 * %FW_DBG_CONF_MAX configuration per run.
1022 */
1023 struct iwl_fw_dbg_conf_tlv {
1024 u8 id;
1025 u8 usniffer;
1026 u8 reserved;
1027 u8 num_of_hcmds;
1028 struct iwl_fw_dbg_conf_hcmd hcmd;
1029 } __packed;
1030
1031 #define IWL_FW_CMD_VER_UNKNOWN 99
1032
1033 /**
1034 * struct iwl_fw_cmd_version - firmware command version entry
1035 * @cmd: command ID
1036 * @group: group ID
1037 * @cmd_ver: command version
1038 * @notif_ver: notification version
1039 */
1040 struct iwl_fw_cmd_version {
1041 u8 cmd;
1042 u8 group;
1043 u8 cmd_ver;
1044 u8 notif_ver;
1045 } __packed;
1046
1047 /**
1048 * struct iwl_fw_cmd_bios_table - firmware command BIOS revision entry
1049 * @cmd: command ID
1050 * @group: group ID
1051 * @max_acpi_revision: max supported ACPI revision of command.
1052 * @max_uefi_revision: max supported UEFI revision of command.
1053 */
1054 struct iwl_fw_cmd_bios_table {
1055 u8 cmd;
1056 u8 group;
1057 u8 max_acpi_revision;
1058 u8 max_uefi_revision;
1059 } __packed;
1060
1061 struct iwl_fw_tcm_error_addr {
1062 __le32 addr;
1063 }; /* FW_TLV_TCM_ERROR_INFO_ADDRS_S */
1064
1065 struct iwl_fw_dump_exclude {
1066 __le32 addr, size;
1067 };
1068
1069 struct iwl_fw_fseq_bin_version_v1 {
1070 __le32 major, minor;
1071 }; /* FW_TLV_FSEQ_BIN_VERSION_S */
1072
1073 struct iwl_fw_fseq_bin_version {
1074 /* rf_id is currently unused and always zero */
1075 __le32 mac_id, rf_id, major, minor;
1076 }; /* FW_TLV_FSEQ_BIN_VERSION_S */
1077
_iwl_tlv_array_len(const struct iwl_ucode_tlv * tlv,size_t fixed_size,size_t var_size)1078 static inline size_t _iwl_tlv_array_len(const struct iwl_ucode_tlv *tlv,
1079 size_t fixed_size, size_t var_size)
1080 {
1081 size_t var_len = le32_to_cpu(tlv->length) - fixed_size;
1082
1083 if (WARN_ON(var_len % var_size))
1084 return 0;
1085
1086 return var_len / var_size;
1087 }
1088
1089 #define iwl_tlv_array_len(_tlv_ptr, _struct_ptr, _memb) \
1090 _iwl_tlv_array_len((_tlv_ptr), sizeof(*(_struct_ptr)), \
1091 sizeof(_struct_ptr->_memb[0]))
1092
1093 #define iwl_tlv_array_len_with_size(_tlv_ptr, _struct_ptr, _size) \
1094 _iwl_tlv_array_len((_tlv_ptr), sizeof(*(_struct_ptr)), _size)
1095
1096 /* external FSEQ file */
1097 #define IWL_FSEQ_FILE "intel/fseq-%04x-%04x"
1098 #define IWL_FSEQ_MAGIC "INTEL-CNV-FSEQ\n\0"
1099
1100 struct iwl_fseq_file {
1101 char magic[16];
1102 char version[16];
1103 __le32 bt_len;
1104 __le32 wifi_len;
1105 u8 reserved[8];
1106 u8 data[];
1107 } __packed;
1108
1109 #endif /* __iwl_fw_file_h__ */
1110