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