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