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