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