1 /******************************************************************************
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.
8 * Copyright(c) 2008 - 2014 Intel Corporation. All rights reserved.
9 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
10 * Copyright(c) 2016 - 2017 Intel Deutschland GmbH
11 * Copyright(c) 2018 Intel Corporation
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of version 2 of the GNU General Public License as
15 * published by the Free Software Foundation.
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
27 * The full GNU General Public License is included in this distribution
28 * in the file called COPYING.
30 * Contact Information:
31 * Intel Linux Wireless <linuxwifi@intel.com>
32 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
36 * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
37 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
38 * Copyright(c) 2016 - 2017 Intel Deutschland GmbH
39 * Copyright(c) 2018 Intel Corporation
40 * All rights reserved.
42 * Redistribution and use in source and binary forms, with or without
43 * modification, are permitted provided that the following conditions
46 * * Redistributions of source code must retain the above copyright
47 * notice, this list of conditions and the following disclaimer.
48 * * Redistributions in binary form must reproduce the above copyright
49 * notice, this list of conditions and the following disclaimer in
50 * the documentation and/or other materials provided with the
52 * * Neither the name Intel Corporation nor the names of its
53 * contributors may be used to endorse or promote products derived
54 * from this software without specific prior written permission.
56 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
57 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
58 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
59 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
60 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
61 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
62 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
63 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
64 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
65 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
66 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
67 *****************************************************************************/
69 #ifndef __iwl_fw_file_h__
70 #define __iwl_fw_file_h__
72 #include <linux/netdevice.h>
73 #include <linux/nl80211.h>
75 /* v1/v2 uCode file layout */
76 struct iwl_ucode_header {
77 __le32 ver; /* major/minor/API/serial */
80 __le32 inst_size; /* bytes of runtime code */
81 __le32 data_size; /* bytes of runtime data */
82 __le32 init_size; /* bytes of init code */
83 __le32 init_data_size; /* bytes of init data */
84 __le32 boot_size; /* bytes of bootstrap code */
85 u8 data[0]; /* in same order as sizes */
88 __le32 build; /* build number */
89 __le32 inst_size; /* bytes of runtime code */
90 __le32 data_size; /* bytes of runtime data */
91 __le32 init_size; /* bytes of init code */
92 __le32 init_data_size; /* bytes of init data */
93 __le32 boot_size; /* bytes of bootstrap code */
94 u8 data[0]; /* in same order as sizes */
100 * new TLV uCode file layout
102 * The new TLV file format contains TLVs, that each specify
103 * some piece of data.
106 enum iwl_ucode_tlv_type {
107 IWL_UCODE_TLV_INVALID = 0, /* unused */
108 IWL_UCODE_TLV_INST = 1,
109 IWL_UCODE_TLV_DATA = 2,
110 IWL_UCODE_TLV_INIT = 3,
111 IWL_UCODE_TLV_INIT_DATA = 4,
112 IWL_UCODE_TLV_BOOT = 5,
113 IWL_UCODE_TLV_PROBE_MAX_LEN = 6, /* a u32 value */
114 IWL_UCODE_TLV_PAN = 7,
115 IWL_UCODE_TLV_RUNT_EVTLOG_PTR = 8,
116 IWL_UCODE_TLV_RUNT_EVTLOG_SIZE = 9,
117 IWL_UCODE_TLV_RUNT_ERRLOG_PTR = 10,
118 IWL_UCODE_TLV_INIT_EVTLOG_PTR = 11,
119 IWL_UCODE_TLV_INIT_EVTLOG_SIZE = 12,
120 IWL_UCODE_TLV_INIT_ERRLOG_PTR = 13,
121 IWL_UCODE_TLV_ENHANCE_SENS_TBL = 14,
122 IWL_UCODE_TLV_PHY_CALIBRATION_SIZE = 15,
123 IWL_UCODE_TLV_WOWLAN_INST = 16,
124 IWL_UCODE_TLV_WOWLAN_DATA = 17,
125 IWL_UCODE_TLV_FLAGS = 18,
126 IWL_UCODE_TLV_SEC_RT = 19,
127 IWL_UCODE_TLV_SEC_INIT = 20,
128 IWL_UCODE_TLV_SEC_WOWLAN = 21,
129 IWL_UCODE_TLV_DEF_CALIB = 22,
130 IWL_UCODE_TLV_PHY_SKU = 23,
131 IWL_UCODE_TLV_SECURE_SEC_RT = 24,
132 IWL_UCODE_TLV_SECURE_SEC_INIT = 25,
133 IWL_UCODE_TLV_SECURE_SEC_WOWLAN = 26,
134 IWL_UCODE_TLV_NUM_OF_CPU = 27,
135 IWL_UCODE_TLV_CSCHEME = 28,
136 IWL_UCODE_TLV_API_CHANGES_SET = 29,
137 IWL_UCODE_TLV_ENABLED_CAPABILITIES = 30,
138 IWL_UCODE_TLV_N_SCAN_CHANNELS = 31,
139 IWL_UCODE_TLV_PAGING = 32,
140 IWL_UCODE_TLV_SEC_RT_USNIFFER = 34,
142 IWL_UCODE_TLV_FW_VERSION = 36,
143 IWL_UCODE_TLV_FW_DBG_DEST = 38,
144 IWL_UCODE_TLV_FW_DBG_CONF = 39,
145 IWL_UCODE_TLV_FW_DBG_TRIGGER = 40,
146 IWL_UCODE_TLV_FW_GSCAN_CAPA = 50,
147 IWL_UCODE_TLV_FW_MEM_SEG = 51,
148 IWL_UCODE_TLV_IML = 52,
150 /* TLVs 0x1000-0x2000 are for internal driver usage */
151 IWL_UCODE_TLV_FW_DBG_DUMP_LST = 0x1000,
154 struct iwl_ucode_tlv {
155 __le32 type; /* see above */
156 __le32 length; /* not including type/length fields */
160 #define IWL_TLV_UCODE_MAGIC 0x0a4c5749
161 #define FW_VER_HUMAN_READABLE_SZ 64
163 struct iwl_tlv_ucode_header {
165 * The TLV style ucode header is distinguished from
166 * the v1/v2 style header by first four bytes being
167 * zero, as such is an invalid combination of
168 * major/minor/API/serial versions.
172 u8 human_readable[FW_VER_HUMAN_READABLE_SZ];
173 /* major/minor/API/serial or major in new format */
178 * The data contained herein has a TLV layout,
179 * see above for the TLV header and types.
180 * Note that each TLV is padded to a length
181 * that is a multiple of 4 for alignment.
189 * ability to get extension for: flags & capabilities from ucode binaries files
191 struct iwl_ucode_api {
196 struct iwl_ucode_capa {
202 * enum iwl_ucode_tlv_flag - ucode API flags
203 * @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously
204 * was a separate TLV but moved here to save space.
205 * @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behavior on hidden SSID,
206 * treats good CRC threshold as a boolean
207 * @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w).
208 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: This uCode image supports uAPSD
209 * @IWL_UCODE_TLV_FLAGS_SHORT_BL: 16 entries of black list instead of 64 in scan
210 * offload profile config command.
211 * @IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS: D3 image supports up to six
212 * (rather than two) IPv6 addresses
213 * @IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID: not sending a probe with the SSID element
214 * from the probe request template.
215 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL: new NS offload (small version)
216 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE: new NS offload (large version)
217 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: General support for uAPSD
218 * @IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD: P2P client supports uAPSD power save
219 * @IWL_UCODE_TLV_FLAGS_BCAST_FILTERING: uCode supports broadcast filtering.
220 * @IWL_UCODE_TLV_FLAGS_EBS_SUPPORT: this uCode image supports EBS.
222 enum iwl_ucode_tlv_flag {
223 IWL_UCODE_TLV_FLAGS_PAN = BIT(0),
224 IWL_UCODE_TLV_FLAGS_NEWSCAN = BIT(1),
225 IWL_UCODE_TLV_FLAGS_MFP = BIT(2),
226 IWL_UCODE_TLV_FLAGS_SHORT_BL = BIT(7),
227 IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS = BIT(10),
228 IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID = BIT(12),
229 IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL = BIT(15),
230 IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE = BIT(16),
231 IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT = BIT(24),
232 IWL_UCODE_TLV_FLAGS_EBS_SUPPORT = BIT(25),
233 IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD = BIT(26),
234 IWL_UCODE_TLV_FLAGS_BCAST_FILTERING = BIT(29),
237 typedef unsigned int __bitwise iwl_ucode_tlv_api_t;
240 * enum iwl_ucode_tlv_api - ucode api
241 * @IWL_UCODE_TLV_API_FRAGMENTED_SCAN: This ucode supports active dwell time
242 * longer than the passive one, which is essential for fragmented scan.
243 * @IWL_UCODE_TLV_API_WIFI_MCC_UPDATE: ucode supports MCC updates with source.
244 * @IWL_UCODE_TLV_API_LQ_SS_PARAMS: Configure STBC/BFER via LQ CMD ss_params
245 * @IWL_UCODE_TLV_API_NEW_VERSION: new versioning format
246 * @IWL_UCODE_TLV_API_SCAN_TSF_REPORT: Scan start time reported in scan
247 * iteration complete notification, and the timestamp reported for RX
248 * received during scan, are reported in TSF of the mac specified in the
250 * @IWL_UCODE_TLV_API_TKIP_MIC_KEYS: This ucode supports version 2 of
251 * ADD_MODIFY_STA_KEY_API_S_VER_2.
252 * @IWL_UCODE_TLV_API_STA_TYPE: This ucode supports station type assignement.
253 * @IWL_UCODE_TLV_API_NAN2_VER2: This ucode supports NAN API version 2
254 * @IWL_UCODE_TLV_API_NEW_RX_STATS: should new RX STATISTICS API be used
255 * @IWL_UCODE_TLV_API_QUOTA_LOW_LATENCY: Quota command includes a field
256 * indicating low latency direction.
257 * @IWL_UCODE_TLV_API_DEPRECATE_TTAK: RX status flag TTAK ok (bit 7) is
259 * @IWL_UCODE_TLV_API_ADAPTIVE_DWELL_V2: This ucode supports version 8
260 * of scan request: SCAN_REQUEST_CMD_UMAC_API_S_VER_8
262 * @NUM_IWL_UCODE_TLV_API: number of bits used
264 enum iwl_ucode_tlv_api {
266 IWL_UCODE_TLV_API_FRAGMENTED_SCAN = (__force iwl_ucode_tlv_api_t)8,
267 IWL_UCODE_TLV_API_WIFI_MCC_UPDATE = (__force iwl_ucode_tlv_api_t)9,
268 IWL_UCODE_TLV_API_LQ_SS_PARAMS = (__force iwl_ucode_tlv_api_t)18,
269 IWL_UCODE_TLV_API_NEW_VERSION = (__force iwl_ucode_tlv_api_t)20,
270 IWL_UCODE_TLV_API_SCAN_TSF_REPORT = (__force iwl_ucode_tlv_api_t)28,
271 IWL_UCODE_TLV_API_TKIP_MIC_KEYS = (__force iwl_ucode_tlv_api_t)29,
272 IWL_UCODE_TLV_API_STA_TYPE = (__force iwl_ucode_tlv_api_t)30,
273 IWL_UCODE_TLV_API_NAN2_VER2 = (__force iwl_ucode_tlv_api_t)31,
275 IWL_UCODE_TLV_API_ADAPTIVE_DWELL = (__force iwl_ucode_tlv_api_t)32,
276 IWL_UCODE_TLV_API_OCE = (__force iwl_ucode_tlv_api_t)33,
277 IWL_UCODE_TLV_API_NEW_BEACON_TEMPLATE = (__force iwl_ucode_tlv_api_t)34,
278 IWL_UCODE_TLV_API_NEW_RX_STATS = (__force iwl_ucode_tlv_api_t)35,
279 IWL_UCODE_TLV_API_QUOTA_LOW_LATENCY = (__force iwl_ucode_tlv_api_t)38,
280 IWL_UCODE_TLV_API_DEPRECATE_TTAK = (__force iwl_ucode_tlv_api_t)41,
281 IWL_UCODE_TLV_API_ADAPTIVE_DWELL_V2 = (__force iwl_ucode_tlv_api_t)42,
283 NUM_IWL_UCODE_TLV_API
285 /* sparse says it cannot increment the previous enum member */
290 typedef unsigned int __bitwise iwl_ucode_tlv_capa_t;
293 * enum iwl_ucode_tlv_capa - ucode capabilities
294 * @IWL_UCODE_TLV_CAPA_D0I3_SUPPORT: supports D0i3
295 * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT: supports Location Aware Regulatory
296 * @IWL_UCODE_TLV_CAPA_UMAC_SCAN: supports UMAC scan.
297 * @IWL_UCODE_TLV_CAPA_BEAMFORMER: supports Beamformer
298 * @IWL_UCODE_TLV_CAPA_TOF_SUPPORT: supports Time of Flight (802.11mc FTM)
299 * @IWL_UCODE_TLV_CAPA_TDLS_SUPPORT: support basic TDLS functionality
300 * @IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT: supports insertion of current
301 * tx power value into TPC Report action frame and Link Measurement Report
303 * @IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT: supports updating current
304 * channel in DS parameter set element in probe requests.
305 * @IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT: supports adding TPC Report IE in
307 * @IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT: supports Quiet Period requests
308 * @IWL_UCODE_TLV_CAPA_DQA_SUPPORT: supports dynamic queue allocation (DQA),
309 * which also implies support for the scheduler configuration command
310 * @IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH: supports TDLS channel switching
311 * @IWL_UCODE_TLV_CAPA_CNSLDTD_D3_D0_IMG: Consolidated D3-D0 image
312 * @IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT: supports Hot Spot Command
313 * @IWL_UCODE_TLV_CAPA_DC2DC_SUPPORT: supports DC2DC Command
314 * @IWL_UCODE_TLV_CAPA_CSUM_SUPPORT: supports TCP Checksum Offload
315 * @IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS: support radio and beacon statistics
316 * @IWL_UCODE_TLV_CAPA_P2P_SCM_UAPSD: supports U-APSD on p2p interface when it
317 * is standalone or with a BSS station interface in the same binding.
318 * @IWL_UCODE_TLV_CAPA_BT_COEX_PLCR: enabled BT Coex packet level co-running
319 * @IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC: ucode supports LAR updates with different
320 * sources for the MCC. This TLV bit is a future replacement to
321 * IWL_UCODE_TLV_API_WIFI_MCC_UPDATE. When either is set, multi-source LAR
323 * @IWL_UCODE_TLV_CAPA_BT_COEX_RRC: supports BT Coex RRC
324 * @IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT: supports gscan (no longer used)
325 * @IWL_UCODE_TLV_CAPA_STA_PM_NOTIF: firmware will send STA PM notification
326 * @IWL_UCODE_TLV_CAPA_TLC_OFFLOAD: firmware implements rate scaling algorithm
327 * @IWL_UCODE_TLV_CAPA_DYNAMIC_QUOTA: firmware implements quota related
328 * @IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE: extended DTS measurement
329 * @IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS: supports short PM timeouts
330 * @IWL_UCODE_TLV_CAPA_BT_MPLUT_SUPPORT: supports bt-coex Multi-priority LUT
331 * @IWL_UCODE_TLV_CAPA_CSA_AND_TBTT_OFFLOAD: the firmware supports CSA
332 * countdown offloading. Beacon notifications are not sent to the host.
333 * The fw also offloads TBTT alignment.
334 * @IWL_UCODE_TLV_CAPA_BEACON_ANT_SELECTION: firmware will decide on what
335 * antenna the beacon should be transmitted
336 * @IWL_UCODE_TLV_CAPA_BEACON_STORING: firmware will store the latest beacon
337 * from AP and will send it upon d0i3 exit.
338 * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT_V2: support LAR API V2
339 * @IWL_UCODE_TLV_CAPA_CT_KILL_BY_FW: firmware responsible for CT-kill
340 * @IWL_UCODE_TLV_CAPA_TEMP_THS_REPORT_SUPPORT: supports temperature
341 * thresholds reporting
342 * @IWL_UCODE_TLV_CAPA_CTDP_SUPPORT: supports cTDP command
343 * @IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED: supports usniffer enabled in
345 * @IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG: support getting more shared
346 * memory addresses from the firmware.
347 * @IWL_UCODE_TLV_CAPA_LQM_SUPPORT: supports Link Quality Measurement
348 * @IWL_UCODE_TLV_CAPA_TX_POWER_ACK: reduced TX power API has larger
349 * command size (command version 4) that supports toggling ACK TX
351 * @IWL_UCODE_TLV_CAPA_MLME_OFFLOAD: supports MLME offload
353 * @NUM_IWL_UCODE_TLV_CAPA: number of bits used
355 enum iwl_ucode_tlv_capa {
356 IWL_UCODE_TLV_CAPA_D0I3_SUPPORT = (__force iwl_ucode_tlv_capa_t)0,
357 IWL_UCODE_TLV_CAPA_LAR_SUPPORT = (__force iwl_ucode_tlv_capa_t)1,
358 IWL_UCODE_TLV_CAPA_UMAC_SCAN = (__force iwl_ucode_tlv_capa_t)2,
359 IWL_UCODE_TLV_CAPA_BEAMFORMER = (__force iwl_ucode_tlv_capa_t)3,
360 IWL_UCODE_TLV_CAPA_TOF_SUPPORT = (__force iwl_ucode_tlv_capa_t)5,
361 IWL_UCODE_TLV_CAPA_TDLS_SUPPORT = (__force iwl_ucode_tlv_capa_t)6,
362 IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT = (__force iwl_ucode_tlv_capa_t)8,
363 IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT = (__force iwl_ucode_tlv_capa_t)9,
364 IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT = (__force iwl_ucode_tlv_capa_t)10,
365 IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT = (__force iwl_ucode_tlv_capa_t)11,
366 IWL_UCODE_TLV_CAPA_DQA_SUPPORT = (__force iwl_ucode_tlv_capa_t)12,
367 IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH = (__force iwl_ucode_tlv_capa_t)13,
368 IWL_UCODE_TLV_CAPA_CNSLDTD_D3_D0_IMG = (__force iwl_ucode_tlv_capa_t)17,
369 IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT = (__force iwl_ucode_tlv_capa_t)18,
370 IWL_UCODE_TLV_CAPA_DC2DC_CONFIG_SUPPORT = (__force iwl_ucode_tlv_capa_t)19,
371 IWL_UCODE_TLV_CAPA_CSUM_SUPPORT = (__force iwl_ucode_tlv_capa_t)21,
372 IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS = (__force iwl_ucode_tlv_capa_t)22,
373 IWL_UCODE_TLV_CAPA_P2P_SCM_UAPSD = (__force iwl_ucode_tlv_capa_t)26,
374 IWL_UCODE_TLV_CAPA_BT_COEX_PLCR = (__force iwl_ucode_tlv_capa_t)28,
375 IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC = (__force iwl_ucode_tlv_capa_t)29,
376 IWL_UCODE_TLV_CAPA_BT_COEX_RRC = (__force iwl_ucode_tlv_capa_t)30,
377 IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT = (__force iwl_ucode_tlv_capa_t)31,
378 IWL_UCODE_TLV_CAPA_STA_PM_NOTIF = (__force iwl_ucode_tlv_capa_t)38,
379 IWL_UCODE_TLV_CAPA_BINDING_CDB_SUPPORT = (__force iwl_ucode_tlv_capa_t)39,
380 IWL_UCODE_TLV_CAPA_CDB_SUPPORT = (__force iwl_ucode_tlv_capa_t)40,
381 IWL_UCODE_TLV_CAPA_D0I3_END_FIRST = (__force iwl_ucode_tlv_capa_t)41,
382 IWL_UCODE_TLV_CAPA_TLC_OFFLOAD = (__force iwl_ucode_tlv_capa_t)43,
383 IWL_UCODE_TLV_CAPA_DYNAMIC_QUOTA = (__force iwl_ucode_tlv_capa_t)44,
384 IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE = (__force iwl_ucode_tlv_capa_t)64,
385 IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS = (__force iwl_ucode_tlv_capa_t)65,
386 IWL_UCODE_TLV_CAPA_BT_MPLUT_SUPPORT = (__force iwl_ucode_tlv_capa_t)67,
387 IWL_UCODE_TLV_CAPA_MULTI_QUEUE_RX_SUPPORT = (__force iwl_ucode_tlv_capa_t)68,
388 IWL_UCODE_TLV_CAPA_CSA_AND_TBTT_OFFLOAD = (__force iwl_ucode_tlv_capa_t)70,
389 IWL_UCODE_TLV_CAPA_BEACON_ANT_SELECTION = (__force iwl_ucode_tlv_capa_t)71,
390 IWL_UCODE_TLV_CAPA_BEACON_STORING = (__force iwl_ucode_tlv_capa_t)72,
391 IWL_UCODE_TLV_CAPA_LAR_SUPPORT_V2 = (__force iwl_ucode_tlv_capa_t)73,
392 IWL_UCODE_TLV_CAPA_CT_KILL_BY_FW = (__force iwl_ucode_tlv_capa_t)74,
393 IWL_UCODE_TLV_CAPA_TEMP_THS_REPORT_SUPPORT = (__force iwl_ucode_tlv_capa_t)75,
394 IWL_UCODE_TLV_CAPA_CTDP_SUPPORT = (__force iwl_ucode_tlv_capa_t)76,
395 IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED = (__force iwl_ucode_tlv_capa_t)77,
396 IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG = (__force iwl_ucode_tlv_capa_t)80,
397 IWL_UCODE_TLV_CAPA_LQM_SUPPORT = (__force iwl_ucode_tlv_capa_t)81,
398 IWL_UCODE_TLV_CAPA_TX_POWER_ACK = (__force iwl_ucode_tlv_capa_t)84,
399 IWL_UCODE_TLV_CAPA_LED_CMD_SUPPORT = (__force iwl_ucode_tlv_capa_t)86,
400 IWL_UCODE_TLV_CAPA_MLME_OFFLOAD = (__force iwl_ucode_tlv_capa_t)96,
402 NUM_IWL_UCODE_TLV_CAPA
404 /* sparse says it cannot increment the previous enum member */
409 /* The default calibrate table size if not specified by firmware file */
410 #define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE 18
411 #define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE 19
412 #define IWL_MAX_PHY_CALIBRATE_TBL_SIZE 253
414 /* The default max probe length if not specified by the firmware file */
415 #define IWL_DEFAULT_MAX_PROBE_LENGTH 200
418 * For 16.0 uCode and above, there is no differentiation between sections,
419 * just an offset to the HW address.
421 #define CPU1_CPU2_SEPARATOR_SECTION 0xFFFFCCCC
422 #define PAGING_SEPARATOR_SECTION 0xAAAABBBB
424 /* uCode version contains 4 values: Major/Minor/API/Serial */
425 #define IWL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24)
426 #define IWL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16)
427 #define IWL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8)
428 #define IWL_UCODE_SERIAL(ver) ((ver) & 0x000000FF)
431 * struct iwl_tlv_calib_ctrl - Calibration control struct.
432 * Sent as part of the phy configuration command.
433 * @flow_trigger: bitmap for which calibrations to perform according to
435 * @event_trigger: bitmap for which calibrations to perform according to
438 struct iwl_tlv_calib_ctrl {
440 __le32 event_trigger;
443 enum iwl_fw_phy_cfg {
444 FW_PHY_CFG_RADIO_TYPE_POS = 0,
445 FW_PHY_CFG_RADIO_TYPE = 0x3 << FW_PHY_CFG_RADIO_TYPE_POS,
446 FW_PHY_CFG_RADIO_STEP_POS = 2,
447 FW_PHY_CFG_RADIO_STEP = 0x3 << FW_PHY_CFG_RADIO_STEP_POS,
448 FW_PHY_CFG_RADIO_DASH_POS = 4,
449 FW_PHY_CFG_RADIO_DASH = 0x3 << FW_PHY_CFG_RADIO_DASH_POS,
450 FW_PHY_CFG_TX_CHAIN_POS = 16,
451 FW_PHY_CFG_TX_CHAIN = 0xf << FW_PHY_CFG_TX_CHAIN_POS,
452 FW_PHY_CFG_RX_CHAIN_POS = 20,
453 FW_PHY_CFG_RX_CHAIN = 0xf << FW_PHY_CFG_RX_CHAIN_POS,
454 FW_PHY_CFG_SHARED_CLK = BIT(31),
457 #define IWL_UCODE_MAX_CS 1
460 * struct iwl_fw_cipher_scheme - a cipher scheme supported by FW.
461 * @cipher: a cipher suite selector
462 * @flags: cipher scheme flags (currently reserved for a future use)
463 * @hdr_len: a size of MPDU security header
464 * @pn_len: a size of PN
465 * @pn_off: an offset of pn from the beginning of the security header
466 * @key_idx_off: an offset of key index byte in the security header
467 * @key_idx_mask: a bit mask of key_idx bits
468 * @key_idx_shift: bit shift needed to get key_idx
469 * @mic_len: mic length in bytes
470 * @hw_cipher: a HW cipher index used in host commands
472 struct iwl_fw_cipher_scheme {
485 enum iwl_fw_dbg_reg_operator {
502 * struct iwl_fw_dbg_reg_op - an operation on a register
504 * @op: &enum iwl_fw_dbg_reg_operator
505 * @addr: offset of the register
508 struct iwl_fw_dbg_reg_op {
516 * enum iwl_fw_dbg_monitor_mode - available monitor recording modes
518 * @SMEM_MODE: monitor stores the data in SMEM
519 * @EXTERNAL_MODE: monitor stores the data in allocated DRAM
520 * @MARBH_MODE: monitor stores the data in MARBH buffer
521 * @MIPI_MODE: monitor outputs the data through the MIPI interface
523 enum iwl_fw_dbg_monitor_mode {
531 * enum iwl_fw_mem_seg_type - memory segment type
532 * @FW_DBG_MEM_TYPE_MASK: mask for the type indication
533 * @FW_DBG_MEM_TYPE_REGULAR: regular memory
534 * @FW_DBG_MEM_TYPE_PRPH: periphery memory (requires special reading)
536 enum iwl_fw_mem_seg_type {
537 FW_DBG_MEM_TYPE_MASK = 0xff000000,
538 FW_DBG_MEM_TYPE_REGULAR = 0x00000000,
539 FW_DBG_MEM_TYPE_PRPH = 0x01000000,
543 * struct iwl_fw_dbg_mem_seg_tlv - configures the debug data memory segments
545 * @data_type: the memory segment type to record, see &enum iwl_fw_mem_seg_type
546 * for what we care about
547 * @ofs: the memory segment offset
548 * @len: the memory segment length, in bytes
550 * This parses IWL_UCODE_TLV_FW_MEM_SEG
552 struct iwl_fw_dbg_mem_seg_tlv {
559 * struct iwl_fw_dbg_dest_tlv_v1 - configures the destination of the debug data
561 * @version: version of the TLV - currently 0
562 * @monitor_mode: &enum iwl_fw_dbg_monitor_mode
563 * @size_power: buffer size will be 2^(size_power + 11)
564 * @base_reg: addr of the base addr register (PRPH)
565 * @end_reg: addr of the end addr register (PRPH)
566 * @write_ptr_reg: the addr of the reg of the write pointer
567 * @wrap_count: the addr of the reg of the wrap_count
568 * @base_shift: shift right of the base addr reg
569 * @end_shift: shift right of the end addr reg
570 * @reg_ops: array of registers operations
572 * This parses IWL_UCODE_TLV_FW_DBG_DEST
574 struct iwl_fw_dbg_dest_tlv_v1 {
581 __le32 write_ptr_reg;
585 struct iwl_fw_dbg_reg_op reg_ops[0];
588 /* Mask of the register for defining the LDBG MAC2SMEM buffer SMEM size */
589 #define IWL_LDBG_M2S_BUF_SIZE_MSK 0x0fff0000
590 /* Mask of the register for defining the LDBG MAC2SMEM SMEM base address */
591 #define IWL_LDBG_M2S_BUF_BA_MSK 0x00000fff
592 /* The smem buffer chunks are in units of 256 bits */
593 #define IWL_M2S_UNIT_SIZE 0x100
595 struct iwl_fw_dbg_dest_tlv {
601 __le32 write_ptr_reg;
605 struct iwl_fw_dbg_reg_op reg_ops[0];
608 struct iwl_fw_dbg_conf_hcmd {
616 * enum iwl_fw_dbg_trigger_mode - triggers functionalities
618 * @IWL_FW_DBG_TRIGGER_START: when trigger occurs re-conf the dbg mechanism
619 * @IWL_FW_DBG_TRIGGER_STOP: when trigger occurs pull the dbg data
620 * @IWL_FW_DBG_TRIGGER_MONITOR_ONLY: when trigger occurs trigger is set to
621 * collect only monitor data
623 enum iwl_fw_dbg_trigger_mode {
624 IWL_FW_DBG_TRIGGER_START = BIT(0),
625 IWL_FW_DBG_TRIGGER_STOP = BIT(1),
626 IWL_FW_DBG_TRIGGER_MONITOR_ONLY = BIT(2),
630 * enum iwl_fw_dbg_trigger_flags - the flags supported by wrt triggers
631 * @IWL_FW_DBG_FORCE_RESTART: force a firmware restart
633 enum iwl_fw_dbg_trigger_flags {
634 IWL_FW_DBG_FORCE_RESTART = BIT(0),
638 * enum iwl_fw_dbg_trigger_vif_type - define the VIF type for a trigger
639 * @IWL_FW_DBG_CONF_VIF_ANY: any vif type
640 * @IWL_FW_DBG_CONF_VIF_IBSS: IBSS mode
641 * @IWL_FW_DBG_CONF_VIF_STATION: BSS mode
642 * @IWL_FW_DBG_CONF_VIF_AP: AP mode
643 * @IWL_FW_DBG_CONF_VIF_P2P_CLIENT: P2P Client mode
644 * @IWL_FW_DBG_CONF_VIF_P2P_GO: P2P GO mode
645 * @IWL_FW_DBG_CONF_VIF_P2P_DEVICE: P2P device
647 enum iwl_fw_dbg_trigger_vif_type {
648 IWL_FW_DBG_CONF_VIF_ANY = NL80211_IFTYPE_UNSPECIFIED,
649 IWL_FW_DBG_CONF_VIF_IBSS = NL80211_IFTYPE_ADHOC,
650 IWL_FW_DBG_CONF_VIF_STATION = NL80211_IFTYPE_STATION,
651 IWL_FW_DBG_CONF_VIF_AP = NL80211_IFTYPE_AP,
652 IWL_FW_DBG_CONF_VIF_P2P_CLIENT = NL80211_IFTYPE_P2P_CLIENT,
653 IWL_FW_DBG_CONF_VIF_P2P_GO = NL80211_IFTYPE_P2P_GO,
654 IWL_FW_DBG_CONF_VIF_P2P_DEVICE = NL80211_IFTYPE_P2P_DEVICE,
658 * struct iwl_fw_dbg_trigger_tlv - a TLV that describes the trigger
659 * @id: &enum iwl_fw_dbg_trigger
660 * @vif_type: &enum iwl_fw_dbg_trigger_vif_type
661 * @stop_conf_ids: bitmap of configurations this trigger relates to.
662 * if the mode is %IWL_FW_DBG_TRIGGER_STOP, then if the bit corresponding
663 * to the currently running configuration is set, the data should be
665 * @stop_delay: how many milliseconds to wait before collecting the data
666 * after the STOP trigger fires.
667 * @mode: &enum iwl_fw_dbg_trigger_mode - can be stop / start of both
668 * @start_conf_id: if mode is %IWL_FW_DBG_TRIGGER_START, this defines what
669 * configuration should be applied when the triggers kicks in.
670 * @occurrences: number of occurrences. 0 means the trigger will never fire.
671 * @trig_dis_ms: the time, in milliseconds, after an occurrence of this
672 * trigger in which another occurrence should be ignored.
673 * @flags: &enum iwl_fw_dbg_trigger_flags
675 struct iwl_fw_dbg_trigger_tlv {
678 __le32 stop_conf_ids;
690 #define FW_DBG_START_FROM_ALIVE 0
691 #define FW_DBG_CONF_MAX 32
692 #define FW_DBG_INVALID 0xff
695 * struct iwl_fw_dbg_trigger_missed_bcon - configures trigger for missed beacons
696 * @stop_consec_missed_bcon: stop recording if threshold is crossed.
697 * @stop_consec_missed_bcon_since_rx: stop recording if threshold is crossed.
698 * @start_consec_missed_bcon: start recording if threshold is crossed.
699 * @start_consec_missed_bcon_since_rx: start recording if threshold is crossed.
700 * @reserved1: reserved
701 * @reserved2: reserved
703 struct iwl_fw_dbg_trigger_missed_bcon {
704 __le32 stop_consec_missed_bcon;
705 __le32 stop_consec_missed_bcon_since_rx;
707 __le32 start_consec_missed_bcon;
708 __le32 start_consec_missed_bcon_since_rx;
713 * struct iwl_fw_dbg_trigger_cmd - configures trigger for messages from FW.
714 * cmds: the list of commands to trigger the collection on
716 struct iwl_fw_dbg_trigger_cmd {
724 * iwl_fw_dbg_trigger_stats - configures trigger for statistics
725 * @stop_offset: the offset of the value to be monitored
726 * @stop_threshold: the threshold above which to collect
727 * @start_offset: the offset of the value to be monitored
728 * @start_threshold: the threshold above which to start recording
730 struct iwl_fw_dbg_trigger_stats {
732 __le32 stop_threshold;
734 __le32 start_threshold;
738 * struct iwl_fw_dbg_trigger_low_rssi - trigger for low beacon RSSI
739 * @rssi: RSSI value to trigger at
741 struct iwl_fw_dbg_trigger_low_rssi {
746 * struct iwl_fw_dbg_trigger_mlme - configures trigger for mlme events
747 * @stop_auth_denied: number of denied authentication to collect
748 * @stop_auth_timeout: number of authentication timeout to collect
749 * @stop_rx_deauth: number of Rx deauth before to collect
750 * @stop_tx_deauth: number of Tx deauth before to collect
751 * @stop_assoc_denied: number of denied association to collect
752 * @stop_assoc_timeout: number of association timeout to collect
753 * @stop_connection_loss: number of connection loss to collect
754 * @start_auth_denied: number of denied authentication to start recording
755 * @start_auth_timeout: number of authentication timeout to start recording
756 * @start_rx_deauth: number of Rx deauth to start recording
757 * @start_tx_deauth: number of Tx deauth to start recording
758 * @start_assoc_denied: number of denied association to start recording
759 * @start_assoc_timeout: number of association timeout to start recording
760 * @start_connection_loss: number of connection loss to start recording
762 struct iwl_fw_dbg_trigger_mlme {
764 u8 stop_auth_timeout;
768 u8 stop_assoc_denied;
769 u8 stop_assoc_timeout;
770 u8 stop_connection_loss;
773 u8 start_auth_denied;
774 u8 start_auth_timeout;
778 u8 start_assoc_denied;
779 u8 start_assoc_timeout;
780 u8 start_connection_loss;
785 * struct iwl_fw_dbg_trigger_txq_timer - configures the Tx queue's timer
786 * @command_queue: timeout for the command queue in ms
787 * @bss: timeout for the queues of a BSS (except for TDLS queues) in ms
788 * @softap: timeout for the queues of a softAP in ms
789 * @p2p_go: timeout for the queues of a P2P GO in ms
790 * @p2p_client: timeout for the queues of a P2P client in ms
791 * @p2p_device: timeout for the queues of a P2P device in ms
792 * @ibss: timeout for the queues of an IBSS in ms
793 * @tdls: timeout for the queues of a TDLS station in ms
795 struct iwl_fw_dbg_trigger_txq_timer {
796 __le32 command_queue;
808 * struct iwl_fw_dbg_trigger_time_event - configures a time event trigger
809 * time_Events: a list of tuples <id, action_bitmap>. The driver will issue a
810 * trigger each time a time event notification that relates to time event
811 * id with one of the actions in the bitmap is received and
812 * BIT(notif->status) is set in status_bitmap.
815 struct iwl_fw_dbg_trigger_time_event {
818 __le32 action_bitmap;
819 __le32 status_bitmap;
820 } __packed time_events[16];
824 * struct iwl_fw_dbg_trigger_ba - configures BlockAck related trigger
825 * rx_ba_start: tid bitmap to configure on what tid the trigger should occur
826 * when an Rx BlockAck session is started.
827 * rx_ba_stop: tid bitmap to configure on what tid the trigger should occur
828 * when an Rx BlockAck session is stopped.
829 * tx_ba_start: tid bitmap to configure on what tid the trigger should occur
830 * when a Tx BlockAck session is started.
831 * tx_ba_stop: tid bitmap to configure on what tid the trigger should occur
832 * when a Tx BlockAck session is stopped.
833 * rx_bar: tid bitmap to configure on what tid the trigger should occur
834 * when a BAR is received (for a Tx BlockAck session).
835 * tx_bar: tid bitmap to configure on what tid the trigger should occur
836 * when a BAR is send (for an Rx BlocAck session).
837 * frame_timeout: tid bitmap to configure on what tid the trigger should occur
838 * when a frame times out in the reodering buffer.
840 struct iwl_fw_dbg_trigger_ba {
847 __le16 frame_timeout;
851 * struct iwl_fw_dbg_trigger_tdls - configures trigger for TDLS events.
852 * @action_bitmap: the TDLS action to trigger the collection upon
853 * @peer_mode: trigger on specific peer or all
854 * @peer: the TDLS peer to trigger the collection on
856 struct iwl_fw_dbg_trigger_tdls {
864 * struct iwl_fw_dbg_trigger_tx_status - configures trigger for tx response
866 * @statuses: the list of statuses to trigger the collection on
868 struct iwl_fw_dbg_trigger_tx_status {
872 } __packed statuses[16];
877 * struct iwl_fw_dbg_conf_tlv - a TLV that describes a debug configuration.
879 * @usniffer: should the uSniffer image be used
880 * @num_of_hcmds: how many HCMDs to send are present here
881 * @hcmd: a variable length host command to be sent to apply the configuration.
882 * If there is more than one HCMD to send, they will appear one after the
883 * other and be sent in the order that they appear in.
884 * This parses IWL_UCODE_TLV_FW_DBG_CONF. The user can add up-to
885 * %FW_DBG_CONF_MAX configuration per run.
887 struct iwl_fw_dbg_conf_tlv {
892 struct iwl_fw_dbg_conf_hcmd hcmd;
895 #endif /* __iwl_fw_file_h__ */