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