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