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 Intel Deutschland GmbH
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.
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.
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,
26 * The full GNU General Public License is included in this distribution
27 * in the file called COPYING.
29 * Contact Information:
30 * Intel Linux Wireless <linuxwifi@intel.com>
31 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
35 * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
36 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
37 * Copyright(c) 2016 Intel Deutschland GmbH
38 * All rights reserved.
40 * Redistribution and use in source and binary forms, with or without
41 * modification, are permitted provided that the following conditions
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
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.
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 *****************************************************************************/
67 #ifndef __iwl_fw_file_h__
68 #define __iwl_fw_file_h__
70 #include <linux/netdevice.h>
71 #include <linux/nl80211.h>
73 /* v1/v2 uCode file layout */
74 struct iwl_ucode_header {
75 __le32 ver; /* major/minor/API/serial */
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 */
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 */
98 * new TLV uCode file layout
100 * The new TLV file format contains TLVs, that each specify
101 * some piece of data.
104 enum 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,
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,
148 struct iwl_ucode_tlv {
149 __le32 type; /* see above */
150 __le32 length; /* not including type/length fields */
154 #define IWL_TLV_UCODE_MAGIC 0x0a4c5749
155 #define FW_VER_HUMAN_READABLE_SZ 64
157 struct iwl_tlv_ucode_header {
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.
166 u8 human_readable[FW_VER_HUMAN_READABLE_SZ];
167 /* major/minor/API/serial or major in new format */
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.
183 * ability to get extension for: flags & capabilities from ucode binaries files
185 struct iwl_ucode_api {
190 struct iwl_ucode_capa {
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.
216 enum 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),
231 typedef unsigned int __bitwise iwl_ucode_tlv_api_t;
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
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.
252 * @NUM_IWL_UCODE_TLV_API: number of bits used
254 enum iwl_ucode_tlv_api {
256 IWL_UCODE_TLV_API_FRAGMENTED_SCAN = (__force iwl_ucode_tlv_api_t)8,
257 IWL_UCODE_TLV_API_WIFI_MCC_UPDATE = (__force iwl_ucode_tlv_api_t)9,
258 IWL_UCODE_TLV_API_LQ_SS_PARAMS = (__force iwl_ucode_tlv_api_t)18,
259 IWL_UCODE_TLV_API_NEW_VERSION = (__force iwl_ucode_tlv_api_t)20,
260 IWL_UCODE_TLV_API_SCAN_TSF_REPORT = (__force iwl_ucode_tlv_api_t)28,
261 IWL_UCODE_TLV_API_TKIP_MIC_KEYS = (__force iwl_ucode_tlv_api_t)29,
262 IWL_UCODE_TLV_API_STA_TYPE = (__force iwl_ucode_tlv_api_t)30,
263 IWL_UCODE_TLV_API_NAN2_VER2 = (__force iwl_ucode_tlv_api_t)31,
265 IWL_UCODE_TLV_API_ADAPTIVE_DWELL = (__force iwl_ucode_tlv_api_t)32,
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_QUOTA_LOW_LATENCY = (__force iwl_ucode_tlv_api_t)38,
270 NUM_IWL_UCODE_TLV_API
272 /* sparse says it cannot increment the previous enum member */
277 typedef unsigned int __bitwise iwl_ucode_tlv_capa_t;
280 * enum iwl_ucode_tlv_capa - ucode capabilities
281 * @IWL_UCODE_TLV_CAPA_D0I3_SUPPORT: supports D0i3
282 * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT: supports Location Aware Regulatory
283 * @IWL_UCODE_TLV_CAPA_UMAC_SCAN: supports UMAC scan.
284 * @IWL_UCODE_TLV_CAPA_BEAMFORMER: supports Beamformer
285 * @IWL_UCODE_TLV_CAPA_TOF_SUPPORT: supports Time of Flight (802.11mc FTM)
286 * @IWL_UCODE_TLV_CAPA_TDLS_SUPPORT: support basic TDLS functionality
287 * @IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT: supports insertion of current
288 * tx power value into TPC Report action frame and Link Measurement Report
290 * @IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT: supports updating current
291 * channel in DS parameter set element in probe requests.
292 * @IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT: supports adding TPC Report IE in
294 * @IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT: supports Quiet Period requests
295 * @IWL_UCODE_TLV_CAPA_DQA_SUPPORT: supports dynamic queue allocation (DQA),
296 * which also implies support for the scheduler configuration command
297 * @IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH: supports TDLS channel switching
298 * @IWL_UCODE_TLV_CAPA_CNSLDTD_D3_D0_IMG: Consolidated D3-D0 image
299 * @IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT: supports Hot Spot Command
300 * @IWL_UCODE_TLV_CAPA_DC2DC_SUPPORT: supports DC2DC Command
301 * @IWL_UCODE_TLV_CAPA_CSUM_SUPPORT: supports TCP Checksum Offload
302 * @IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS: support radio and beacon statistics
303 * @IWL_UCODE_TLV_CAPA_P2P_SCM_UAPSD: supports U-APSD on p2p interface when it
304 * is standalone or with a BSS station interface in the same binding.
305 * @IWL_UCODE_TLV_CAPA_BT_COEX_PLCR: enabled BT Coex packet level co-running
306 * @IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC: ucode supports LAR updates with different
307 * sources for the MCC. This TLV bit is a future replacement to
308 * IWL_UCODE_TLV_API_WIFI_MCC_UPDATE. When either is set, multi-source LAR
310 * @IWL_UCODE_TLV_CAPA_BT_COEX_RRC: supports BT Coex RRC
311 * @IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT: supports gscan
312 * @IWL_UCODE_TLV_CAPA_STA_PM_NOTIF: firmware will send STA PM notification
313 * @IWL_UCODE_TLV_CAPA_TLC_OFFLOAD: firmware implements rate scaling algorithm
314 * @IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE: extended DTS measurement
315 * @IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS: supports short PM timeouts
316 * @IWL_UCODE_TLV_CAPA_BT_MPLUT_SUPPORT: supports bt-coex Multi-priority LUT
317 * @IWL_UCODE_TLV_CAPA_CSA_AND_TBTT_OFFLOAD: the firmware supports CSA
318 * countdown offloading. Beacon notifications are not sent to the host.
319 * The fw also offloads TBTT alignment.
320 * @IWL_UCODE_TLV_CAPA_BEACON_ANT_SELECTION: firmware will decide on what
321 * antenna the beacon should be transmitted
322 * @IWL_UCODE_TLV_CAPA_BEACON_STORING: firmware will store the latest beacon
323 * from AP and will send it upon d0i3 exit.
324 * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT_V2: support LAR API V2
325 * @IWL_UCODE_TLV_CAPA_CT_KILL_BY_FW: firmware responsible for CT-kill
326 * @IWL_UCODE_TLV_CAPA_TEMP_THS_REPORT_SUPPORT: supports temperature
327 * thresholds reporting
328 * @IWL_UCODE_TLV_CAPA_CTDP_SUPPORT: supports cTDP command
329 * @IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED: supports usniffer enabled in
331 * @IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG: support getting more shared
332 * memory addresses from the firmware.
333 * @IWL_UCODE_TLV_CAPA_LQM_SUPPORT: supports Link Quality Measurement
334 * @IWL_UCODE_TLV_CAPA_TX_POWER_ACK: reduced TX power API has larger
335 * command size (command version 4) that supports toggling ACK TX
337 * @IWL_UCODE_TLV_CAPA_MLME_OFFLOAD: supports MLME offload
339 * @NUM_IWL_UCODE_TLV_CAPA: number of bits used
341 enum iwl_ucode_tlv_capa {
342 IWL_UCODE_TLV_CAPA_D0I3_SUPPORT = (__force iwl_ucode_tlv_capa_t)0,
343 IWL_UCODE_TLV_CAPA_LAR_SUPPORT = (__force iwl_ucode_tlv_capa_t)1,
344 IWL_UCODE_TLV_CAPA_UMAC_SCAN = (__force iwl_ucode_tlv_capa_t)2,
345 IWL_UCODE_TLV_CAPA_BEAMFORMER = (__force iwl_ucode_tlv_capa_t)3,
346 IWL_UCODE_TLV_CAPA_TOF_SUPPORT = (__force iwl_ucode_tlv_capa_t)5,
347 IWL_UCODE_TLV_CAPA_TDLS_SUPPORT = (__force iwl_ucode_tlv_capa_t)6,
348 IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT = (__force iwl_ucode_tlv_capa_t)8,
349 IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT = (__force iwl_ucode_tlv_capa_t)9,
350 IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT = (__force iwl_ucode_tlv_capa_t)10,
351 IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT = (__force iwl_ucode_tlv_capa_t)11,
352 IWL_UCODE_TLV_CAPA_DQA_SUPPORT = (__force iwl_ucode_tlv_capa_t)12,
353 IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH = (__force iwl_ucode_tlv_capa_t)13,
354 IWL_UCODE_TLV_CAPA_CNSLDTD_D3_D0_IMG = (__force iwl_ucode_tlv_capa_t)17,
355 IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT = (__force iwl_ucode_tlv_capa_t)18,
356 IWL_UCODE_TLV_CAPA_DC2DC_CONFIG_SUPPORT = (__force iwl_ucode_tlv_capa_t)19,
357 IWL_UCODE_TLV_CAPA_CSUM_SUPPORT = (__force iwl_ucode_tlv_capa_t)21,
358 IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS = (__force iwl_ucode_tlv_capa_t)22,
359 IWL_UCODE_TLV_CAPA_P2P_SCM_UAPSD = (__force iwl_ucode_tlv_capa_t)26,
360 IWL_UCODE_TLV_CAPA_BT_COEX_PLCR = (__force iwl_ucode_tlv_capa_t)28,
361 IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC = (__force iwl_ucode_tlv_capa_t)29,
362 IWL_UCODE_TLV_CAPA_BT_COEX_RRC = (__force iwl_ucode_tlv_capa_t)30,
363 IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT = (__force iwl_ucode_tlv_capa_t)31,
364 IWL_UCODE_TLV_CAPA_STA_PM_NOTIF = (__force iwl_ucode_tlv_capa_t)38,
365 IWL_UCODE_TLV_CAPA_BINDING_CDB_SUPPORT = (__force iwl_ucode_tlv_capa_t)39,
366 IWL_UCODE_TLV_CAPA_CDB_SUPPORT = (__force iwl_ucode_tlv_capa_t)40,
367 IWL_UCODE_TLV_CAPA_D0I3_END_FIRST = (__force iwl_ucode_tlv_capa_t)41,
368 IWL_UCODE_TLV_CAPA_TLC_OFFLOAD = (__force iwl_ucode_tlv_capa_t)43,
369 IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE = (__force iwl_ucode_tlv_capa_t)64,
370 IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS = (__force iwl_ucode_tlv_capa_t)65,
371 IWL_UCODE_TLV_CAPA_BT_MPLUT_SUPPORT = (__force iwl_ucode_tlv_capa_t)67,
372 IWL_UCODE_TLV_CAPA_MULTI_QUEUE_RX_SUPPORT = (__force iwl_ucode_tlv_capa_t)68,
373 IWL_UCODE_TLV_CAPA_CSA_AND_TBTT_OFFLOAD = (__force iwl_ucode_tlv_capa_t)70,
374 IWL_UCODE_TLV_CAPA_BEACON_ANT_SELECTION = (__force iwl_ucode_tlv_capa_t)71,
375 IWL_UCODE_TLV_CAPA_BEACON_STORING = (__force iwl_ucode_tlv_capa_t)72,
376 IWL_UCODE_TLV_CAPA_LAR_SUPPORT_V2 = (__force iwl_ucode_tlv_capa_t)73,
377 IWL_UCODE_TLV_CAPA_CT_KILL_BY_FW = (__force iwl_ucode_tlv_capa_t)74,
378 IWL_UCODE_TLV_CAPA_TEMP_THS_REPORT_SUPPORT = (__force iwl_ucode_tlv_capa_t)75,
379 IWL_UCODE_TLV_CAPA_CTDP_SUPPORT = (__force iwl_ucode_tlv_capa_t)76,
380 IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED = (__force iwl_ucode_tlv_capa_t)77,
381 IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG = (__force iwl_ucode_tlv_capa_t)80,
382 IWL_UCODE_TLV_CAPA_LQM_SUPPORT = (__force iwl_ucode_tlv_capa_t)81,
383 IWL_UCODE_TLV_CAPA_TX_POWER_ACK = (__force iwl_ucode_tlv_capa_t)84,
384 IWL_UCODE_TLV_CAPA_LED_CMD_SUPPORT = (__force iwl_ucode_tlv_capa_t)86,
385 IWL_UCODE_TLV_CAPA_MLME_OFFLOAD = (__force iwl_ucode_tlv_capa_t)96,
387 NUM_IWL_UCODE_TLV_CAPA
389 /* sparse says it cannot increment the previous enum member */
394 /* The default calibrate table size if not specified by firmware file */
395 #define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE 18
396 #define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE 19
397 #define IWL_MAX_PHY_CALIBRATE_TBL_SIZE 253
399 /* The default max probe length if not specified by the firmware file */
400 #define IWL_DEFAULT_MAX_PROBE_LENGTH 200
403 * For 16.0 uCode and above, there is no differentiation between sections,
404 * just an offset to the HW address.
406 #define CPU1_CPU2_SEPARATOR_SECTION 0xFFFFCCCC
407 #define PAGING_SEPARATOR_SECTION 0xAAAABBBB
409 /* uCode version contains 4 values: Major/Minor/API/Serial */
410 #define IWL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24)
411 #define IWL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16)
412 #define IWL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8)
413 #define IWL_UCODE_SERIAL(ver) ((ver) & 0x000000FF)
416 * struct iwl_tlv_calib_ctrl - Calibration control struct.
417 * Sent as part of the phy configuration command.
418 * @flow_trigger: bitmap for which calibrations to perform according to
420 * @event_trigger: bitmap for which calibrations to perform according to
423 struct iwl_tlv_calib_ctrl {
425 __le32 event_trigger;
428 enum iwl_fw_phy_cfg {
429 FW_PHY_CFG_RADIO_TYPE_POS = 0,
430 FW_PHY_CFG_RADIO_TYPE = 0x3 << FW_PHY_CFG_RADIO_TYPE_POS,
431 FW_PHY_CFG_RADIO_STEP_POS = 2,
432 FW_PHY_CFG_RADIO_STEP = 0x3 << FW_PHY_CFG_RADIO_STEP_POS,
433 FW_PHY_CFG_RADIO_DASH_POS = 4,
434 FW_PHY_CFG_RADIO_DASH = 0x3 << FW_PHY_CFG_RADIO_DASH_POS,
435 FW_PHY_CFG_TX_CHAIN_POS = 16,
436 FW_PHY_CFG_TX_CHAIN = 0xf << FW_PHY_CFG_TX_CHAIN_POS,
437 FW_PHY_CFG_RX_CHAIN_POS = 20,
438 FW_PHY_CFG_RX_CHAIN = 0xf << FW_PHY_CFG_RX_CHAIN_POS,
441 #define IWL_UCODE_MAX_CS 1
444 * struct iwl_fw_cipher_scheme - a cipher scheme supported by FW.
445 * @cipher: a cipher suite selector
446 * @flags: cipher scheme flags (currently reserved for a future use)
447 * @hdr_len: a size of MPDU security header
448 * @pn_len: a size of PN
449 * @pn_off: an offset of pn from the beginning of the security header
450 * @key_idx_off: an offset of key index byte in the security header
451 * @key_idx_mask: a bit mask of key_idx bits
452 * @key_idx_shift: bit shift needed to get key_idx
453 * @mic_len: mic length in bytes
454 * @hw_cipher: a HW cipher index used in host commands
456 struct iwl_fw_cipher_scheme {
469 enum iwl_fw_dbg_reg_operator {
486 * struct iwl_fw_dbg_reg_op - an operation on a register
488 * @op: &enum iwl_fw_dbg_reg_operator
489 * @addr: offset of the register
492 struct iwl_fw_dbg_reg_op {
500 * enum iwl_fw_dbg_monitor_mode - available monitor recording modes
502 * @SMEM_MODE: monitor stores the data in SMEM
503 * @EXTERNAL_MODE: monitor stores the data in allocated DRAM
504 * @MARBH_MODE: monitor stores the data in MARBH buffer
505 * @MIPI_MODE: monitor outputs the data through the MIPI interface
507 enum iwl_fw_dbg_monitor_mode {
515 * enum iwl_fw_mem_seg_type - memory segment type
516 * @FW_DBG_MEM_TYPE_MASK: mask for the type indication
517 * @FW_DBG_MEM_TYPE_REGULAR: regular memory
518 * @FW_DBG_MEM_TYPE_PRPH: periphery memory (requires special reading)
520 enum iwl_fw_mem_seg_type {
521 FW_DBG_MEM_TYPE_MASK = 0xff000000,
522 FW_DBG_MEM_TYPE_REGULAR = 0x00000000,
523 FW_DBG_MEM_TYPE_PRPH = 0x01000000,
527 * struct iwl_fw_dbg_mem_seg_tlv - configures the debug data memory segments
529 * @data_type: the memory segment type to record, see &enum iwl_fw_mem_seg_type
530 * for what we care about
531 * @ofs: the memory segment offset
532 * @len: the memory segment length, in bytes
534 * This parses IWL_UCODE_TLV_FW_MEM_SEG
536 struct iwl_fw_dbg_mem_seg_tlv {
543 * struct iwl_fw_dbg_dest_tlv - configures the destination of the debug data
545 * @version: version of the TLV - currently 0
546 * @monitor_mode: &enum iwl_fw_dbg_monitor_mode
547 * @size_power: buffer size will be 2^(size_power + 11)
548 * @base_reg: addr of the base addr register (PRPH)
549 * @end_reg: addr of the end addr register (PRPH)
550 * @write_ptr_reg: the addr of the reg of the write pointer
551 * @wrap_count: the addr of the reg of the wrap_count
552 * @base_shift: shift right of the base addr reg
553 * @end_shift: shift right of the end addr reg
554 * @reg_ops: array of registers operations
556 * This parses IWL_UCODE_TLV_FW_DBG_DEST
558 struct iwl_fw_dbg_dest_tlv {
565 __le32 write_ptr_reg;
569 struct iwl_fw_dbg_reg_op reg_ops[0];
572 struct iwl_fw_dbg_conf_hcmd {
580 * enum iwl_fw_dbg_trigger_mode - triggers functionalities
582 * @IWL_FW_DBG_TRIGGER_START: when trigger occurs re-conf the dbg mechanism
583 * @IWL_FW_DBG_TRIGGER_STOP: when trigger occurs pull the dbg data
584 * @IWL_FW_DBG_TRIGGER_MONITOR_ONLY: when trigger occurs trigger is set to
585 * collect only monitor data
587 enum iwl_fw_dbg_trigger_mode {
588 IWL_FW_DBG_TRIGGER_START = BIT(0),
589 IWL_FW_DBG_TRIGGER_STOP = BIT(1),
590 IWL_FW_DBG_TRIGGER_MONITOR_ONLY = BIT(2),
594 * enum iwl_fw_dbg_trigger_vif_type - define the VIF type for a trigger
595 * @IWL_FW_DBG_CONF_VIF_ANY: any vif type
596 * @IWL_FW_DBG_CONF_VIF_IBSS: IBSS mode
597 * @IWL_FW_DBG_CONF_VIF_STATION: BSS mode
598 * @IWL_FW_DBG_CONF_VIF_AP: AP mode
599 * @IWL_FW_DBG_CONF_VIF_P2P_CLIENT: P2P Client mode
600 * @IWL_FW_DBG_CONF_VIF_P2P_GO: P2P GO mode
601 * @IWL_FW_DBG_CONF_VIF_P2P_DEVICE: P2P device
603 enum iwl_fw_dbg_trigger_vif_type {
604 IWL_FW_DBG_CONF_VIF_ANY = NL80211_IFTYPE_UNSPECIFIED,
605 IWL_FW_DBG_CONF_VIF_IBSS = NL80211_IFTYPE_ADHOC,
606 IWL_FW_DBG_CONF_VIF_STATION = NL80211_IFTYPE_STATION,
607 IWL_FW_DBG_CONF_VIF_AP = NL80211_IFTYPE_AP,
608 IWL_FW_DBG_CONF_VIF_P2P_CLIENT = NL80211_IFTYPE_P2P_CLIENT,
609 IWL_FW_DBG_CONF_VIF_P2P_GO = NL80211_IFTYPE_P2P_GO,
610 IWL_FW_DBG_CONF_VIF_P2P_DEVICE = NL80211_IFTYPE_P2P_DEVICE,
614 * struct iwl_fw_dbg_trigger_tlv - a TLV that describes the trigger
615 * @id: &enum iwl_fw_dbg_trigger
616 * @vif_type: &enum iwl_fw_dbg_trigger_vif_type
617 * @stop_conf_ids: bitmap of configurations this trigger relates to.
618 * if the mode is %IWL_FW_DBG_TRIGGER_STOP, then if the bit corresponding
619 * to the currently running configuration is set, the data should be
621 * @stop_delay: how many milliseconds to wait before collecting the data
622 * after the STOP trigger fires.
623 * @mode: &enum iwl_fw_dbg_trigger_mode - can be stop / start of both
624 * @start_conf_id: if mode is %IWL_FW_DBG_TRIGGER_START, this defines what
625 * configuration should be applied when the triggers kicks in.
626 * @occurrences: number of occurrences. 0 means the trigger will never fire.
627 * @trig_dis_ms: the time, in milliseconds, after an occurrence of this
628 * trigger in which another occurrence should be ignored.
630 struct iwl_fw_dbg_trigger_tlv {
633 __le32 stop_conf_ids;
644 #define FW_DBG_START_FROM_ALIVE 0
645 #define FW_DBG_CONF_MAX 32
646 #define FW_DBG_INVALID 0xff
649 * struct iwl_fw_dbg_trigger_missed_bcon - configures trigger for missed beacons
650 * @stop_consec_missed_bcon: stop recording if threshold is crossed.
651 * @stop_consec_missed_bcon_since_rx: stop recording if threshold is crossed.
652 * @start_consec_missed_bcon: start recording if threshold is crossed.
653 * @start_consec_missed_bcon_since_rx: start recording if threshold is crossed.
654 * @reserved1: reserved
655 * @reserved2: reserved
657 struct iwl_fw_dbg_trigger_missed_bcon {
658 __le32 stop_consec_missed_bcon;
659 __le32 stop_consec_missed_bcon_since_rx;
661 __le32 start_consec_missed_bcon;
662 __le32 start_consec_missed_bcon_since_rx;
667 * struct iwl_fw_dbg_trigger_cmd - configures trigger for messages from FW.
668 * cmds: the list of commands to trigger the collection on
670 struct iwl_fw_dbg_trigger_cmd {
678 * iwl_fw_dbg_trigger_stats - configures trigger for statistics
679 * @stop_offset: the offset of the value to be monitored
680 * @stop_threshold: the threshold above which to collect
681 * @start_offset: the offset of the value to be monitored
682 * @start_threshold: the threshold above which to start recording
684 struct iwl_fw_dbg_trigger_stats {
686 __le32 stop_threshold;
688 __le32 start_threshold;
692 * struct iwl_fw_dbg_trigger_low_rssi - trigger for low beacon RSSI
693 * @rssi: RSSI value to trigger at
695 struct iwl_fw_dbg_trigger_low_rssi {
700 * struct iwl_fw_dbg_trigger_mlme - configures trigger for mlme events
701 * @stop_auth_denied: number of denied authentication to collect
702 * @stop_auth_timeout: number of authentication timeout to collect
703 * @stop_rx_deauth: number of Rx deauth before to collect
704 * @stop_tx_deauth: number of Tx deauth before to collect
705 * @stop_assoc_denied: number of denied association to collect
706 * @stop_assoc_timeout: number of association timeout to collect
707 * @stop_connection_loss: number of connection loss to collect
708 * @start_auth_denied: number of denied authentication to start recording
709 * @start_auth_timeout: number of authentication timeout to start recording
710 * @start_rx_deauth: number of Rx deauth to start recording
711 * @start_tx_deauth: number of Tx deauth to start recording
712 * @start_assoc_denied: number of denied association to start recording
713 * @start_assoc_timeout: number of association timeout to start recording
714 * @start_connection_loss: number of connection loss to start recording
716 struct iwl_fw_dbg_trigger_mlme {
718 u8 stop_auth_timeout;
722 u8 stop_assoc_denied;
723 u8 stop_assoc_timeout;
724 u8 stop_connection_loss;
727 u8 start_auth_denied;
728 u8 start_auth_timeout;
732 u8 start_assoc_denied;
733 u8 start_assoc_timeout;
734 u8 start_connection_loss;
739 * struct iwl_fw_dbg_trigger_txq_timer - configures the Tx queue's timer
740 * @command_queue: timeout for the command queue in ms
741 * @bss: timeout for the queues of a BSS (except for TDLS queues) in ms
742 * @softap: timeout for the queues of a softAP in ms
743 * @p2p_go: timeout for the queues of a P2P GO in ms
744 * @p2p_client: timeout for the queues of a P2P client in ms
745 * @p2p_device: timeout for the queues of a P2P device in ms
746 * @ibss: timeout for the queues of an IBSS in ms
747 * @tdls: timeout for the queues of a TDLS station in ms
749 struct iwl_fw_dbg_trigger_txq_timer {
750 __le32 command_queue;
762 * struct iwl_fw_dbg_trigger_time_event - configures a time event trigger
763 * time_Events: a list of tuples <id, action_bitmap>. The driver will issue a
764 * trigger each time a time event notification that relates to time event
765 * id with one of the actions in the bitmap is received and
766 * BIT(notif->status) is set in status_bitmap.
769 struct iwl_fw_dbg_trigger_time_event {
772 __le32 action_bitmap;
773 __le32 status_bitmap;
774 } __packed time_events[16];
778 * struct iwl_fw_dbg_trigger_ba - configures BlockAck related trigger
779 * rx_ba_start: tid bitmap to configure on what tid the trigger should occur
780 * when an Rx BlockAck session is started.
781 * rx_ba_stop: tid bitmap to configure on what tid the trigger should occur
782 * when an Rx BlockAck session is stopped.
783 * tx_ba_start: tid bitmap to configure on what tid the trigger should occur
784 * when a Tx BlockAck session is started.
785 * tx_ba_stop: tid bitmap to configure on what tid the trigger should occur
786 * when a Tx BlockAck session is stopped.
787 * rx_bar: tid bitmap to configure on what tid the trigger should occur
788 * when a BAR is received (for a Tx BlockAck session).
789 * tx_bar: tid bitmap to configure on what tid the trigger should occur
790 * when a BAR is send (for an Rx BlocAck session).
791 * frame_timeout: tid bitmap to configure on what tid the trigger should occur
792 * when a frame times out in the reodering buffer.
794 struct iwl_fw_dbg_trigger_ba {
801 __le16 frame_timeout;
805 * struct iwl_fw_dbg_trigger_tdls - configures trigger for TDLS events.
806 * @action_bitmap: the TDLS action to trigger the collection upon
807 * @peer_mode: trigger on specific peer or all
808 * @peer: the TDLS peer to trigger the collection on
810 struct iwl_fw_dbg_trigger_tdls {
818 * struct iwl_fw_dbg_trigger_tx_status - configures trigger for tx response
820 * @statuses: the list of statuses to trigger the collection on
822 struct iwl_fw_dbg_trigger_tx_status {
826 } __packed statuses[16];
831 * struct iwl_fw_dbg_conf_tlv - a TLV that describes a debug configuration.
833 * @usniffer: should the uSniffer image be used
834 * @num_of_hcmds: how many HCMDs to send are present here
835 * @hcmd: a variable length host command to be sent to apply the configuration.
836 * If there is more than one HCMD to send, they will appear one after the
837 * other and be sent in the order that they appear in.
838 * This parses IWL_UCODE_TLV_FW_DBG_CONF. The user can add up-to
839 * %FW_DBG_CONF_MAX configuration per run.
841 struct iwl_fw_dbg_conf_tlv {
846 struct iwl_fw_dbg_conf_hcmd hcmd;
850 * struct iwl_fw_gscan_capabilities - gscan capabilities supported by FW
851 * @max_scan_cache_size: total space allocated for scan results (in bytes).
852 * @max_scan_buckets: maximum number of channel buckets.
853 * @max_ap_cache_per_scan: maximum number of APs that can be stored per scan.
854 * @max_rssi_sample_size: number of RSSI samples used for averaging RSSI.
855 * @max_scan_reporting_threshold: max possible report threshold. in percentage.
856 * @max_hotlist_aps: maximum number of entries for hotlist APs.
857 * @max_significant_change_aps: maximum number of entries for significant
859 * @max_bssid_history_entries: number of BSSID/RSSI entries that the device can
861 * @max_hotlist_ssids: maximum number of entries for hotlist SSIDs.
862 * @max_number_epno_networks: max number of epno entries.
863 * @max_number_epno_networks_by_ssid: max number of epno entries if ssid is
865 * @max_number_of_white_listed_ssid: max number of white listed SSIDs.
866 * @max_number_of_black_listed_ssid: max number of black listed SSIDs.
868 struct iwl_fw_gscan_capabilities {
869 __le32 max_scan_cache_size;
870 __le32 max_scan_buckets;
871 __le32 max_ap_cache_per_scan;
872 __le32 max_rssi_sample_size;
873 __le32 max_scan_reporting_threshold;
874 __le32 max_hotlist_aps;
875 __le32 max_significant_change_aps;
876 __le32 max_bssid_history_entries;
877 __le32 max_hotlist_ssids;
878 __le32 max_number_epno_networks;
879 __le32 max_number_epno_networks_by_ssid;
880 __le32 max_number_of_white_listed_ssid;
881 __le32 max_number_of_black_listed_ssid;
884 #endif /* __iwl_fw_file_h__ */