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
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 - 2017 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.
251 * @IWL_UCODE_TLV_API_DEPRECATE_TTAK: RX status flag TTAK ok (bit 7) is
254 * @NUM_IWL_UCODE_TLV_API: number of bits used
256 enum iwl_ucode_tlv_api
{
258 IWL_UCODE_TLV_API_FRAGMENTED_SCAN
= (__force iwl_ucode_tlv_api_t
)8,
259 IWL_UCODE_TLV_API_WIFI_MCC_UPDATE
= (__force iwl_ucode_tlv_api_t
)9,
260 IWL_UCODE_TLV_API_LQ_SS_PARAMS
= (__force iwl_ucode_tlv_api_t
)18,
261 IWL_UCODE_TLV_API_NEW_VERSION
= (__force iwl_ucode_tlv_api_t
)20,
262 IWL_UCODE_TLV_API_SCAN_TSF_REPORT
= (__force iwl_ucode_tlv_api_t
)28,
263 IWL_UCODE_TLV_API_TKIP_MIC_KEYS
= (__force iwl_ucode_tlv_api_t
)29,
264 IWL_UCODE_TLV_API_STA_TYPE
= (__force iwl_ucode_tlv_api_t
)30,
265 IWL_UCODE_TLV_API_NAN2_VER2
= (__force iwl_ucode_tlv_api_t
)31,
267 IWL_UCODE_TLV_API_ADAPTIVE_DWELL
= (__force iwl_ucode_tlv_api_t
)32,
268 IWL_UCODE_TLV_API_NEW_BEACON_TEMPLATE
= (__force iwl_ucode_tlv_api_t
)34,
269 IWL_UCODE_TLV_API_NEW_RX_STATS
= (__force iwl_ucode_tlv_api_t
)35,
270 IWL_UCODE_TLV_API_QUOTA_LOW_LATENCY
= (__force iwl_ucode_tlv_api_t
)38,
271 IWL_UCODE_TLV_API_DEPRECATE_TTAK
= (__force iwl_ucode_tlv_api_t
)41,
273 NUM_IWL_UCODE_TLV_API
275 /* sparse says it cannot increment the previous enum member */
280 typedef unsigned int __bitwise iwl_ucode_tlv_capa_t
;
283 * enum iwl_ucode_tlv_capa - ucode capabilities
284 * @IWL_UCODE_TLV_CAPA_D0I3_SUPPORT: supports D0i3
285 * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT: supports Location Aware Regulatory
286 * @IWL_UCODE_TLV_CAPA_UMAC_SCAN: supports UMAC scan.
287 * @IWL_UCODE_TLV_CAPA_BEAMFORMER: supports Beamformer
288 * @IWL_UCODE_TLV_CAPA_TOF_SUPPORT: supports Time of Flight (802.11mc FTM)
289 * @IWL_UCODE_TLV_CAPA_TDLS_SUPPORT: support basic TDLS functionality
290 * @IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT: supports insertion of current
291 * tx power value into TPC Report action frame and Link Measurement Report
293 * @IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT: supports updating current
294 * channel in DS parameter set element in probe requests.
295 * @IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT: supports adding TPC Report IE in
297 * @IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT: supports Quiet Period requests
298 * @IWL_UCODE_TLV_CAPA_DQA_SUPPORT: supports dynamic queue allocation (DQA),
299 * which also implies support for the scheduler configuration command
300 * @IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH: supports TDLS channel switching
301 * @IWL_UCODE_TLV_CAPA_CNSLDTD_D3_D0_IMG: Consolidated D3-D0 image
302 * @IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT: supports Hot Spot Command
303 * @IWL_UCODE_TLV_CAPA_DC2DC_SUPPORT: supports DC2DC Command
304 * @IWL_UCODE_TLV_CAPA_CSUM_SUPPORT: supports TCP Checksum Offload
305 * @IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS: support radio and beacon statistics
306 * @IWL_UCODE_TLV_CAPA_P2P_SCM_UAPSD: supports U-APSD on p2p interface when it
307 * is standalone or with a BSS station interface in the same binding.
308 * @IWL_UCODE_TLV_CAPA_BT_COEX_PLCR: enabled BT Coex packet level co-running
309 * @IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC: ucode supports LAR updates with different
310 * sources for the MCC. This TLV bit is a future replacement to
311 * IWL_UCODE_TLV_API_WIFI_MCC_UPDATE. When either is set, multi-source LAR
313 * @IWL_UCODE_TLV_CAPA_BT_COEX_RRC: supports BT Coex RRC
314 * @IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT: supports gscan
315 * @IWL_UCODE_TLV_CAPA_STA_PM_NOTIF: firmware will send STA PM notification
316 * @IWL_UCODE_TLV_CAPA_TLC_OFFLOAD: firmware implements rate scaling algorithm
317 * @IWL_UCODE_TLV_CAPA_DYNAMIC_QUOTA: firmware implements quota related
318 * @IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE: extended DTS measurement
319 * @IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS: supports short PM timeouts
320 * @IWL_UCODE_TLV_CAPA_BT_MPLUT_SUPPORT: supports bt-coex Multi-priority LUT
321 * @IWL_UCODE_TLV_CAPA_CSA_AND_TBTT_OFFLOAD: the firmware supports CSA
322 * countdown offloading. Beacon notifications are not sent to the host.
323 * The fw also offloads TBTT alignment.
324 * @IWL_UCODE_TLV_CAPA_BEACON_ANT_SELECTION: firmware will decide on what
325 * antenna the beacon should be transmitted
326 * @IWL_UCODE_TLV_CAPA_BEACON_STORING: firmware will store the latest beacon
327 * from AP and will send it upon d0i3 exit.
328 * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT_V2: support LAR API V2
329 * @IWL_UCODE_TLV_CAPA_CT_KILL_BY_FW: firmware responsible for CT-kill
330 * @IWL_UCODE_TLV_CAPA_TEMP_THS_REPORT_SUPPORT: supports temperature
331 * thresholds reporting
332 * @IWL_UCODE_TLV_CAPA_CTDP_SUPPORT: supports cTDP command
333 * @IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED: supports usniffer enabled in
335 * @IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG: support getting more shared
336 * memory addresses from the firmware.
337 * @IWL_UCODE_TLV_CAPA_LQM_SUPPORT: supports Link Quality Measurement
338 * @IWL_UCODE_TLV_CAPA_TX_POWER_ACK: reduced TX power API has larger
339 * command size (command version 4) that supports toggling ACK TX
341 * @IWL_UCODE_TLV_CAPA_MLME_OFFLOAD: supports MLME offload
343 * @NUM_IWL_UCODE_TLV_CAPA: number of bits used
345 enum iwl_ucode_tlv_capa
{
346 IWL_UCODE_TLV_CAPA_D0I3_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)0,
347 IWL_UCODE_TLV_CAPA_LAR_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)1,
348 IWL_UCODE_TLV_CAPA_UMAC_SCAN
= (__force iwl_ucode_tlv_capa_t
)2,
349 IWL_UCODE_TLV_CAPA_BEAMFORMER
= (__force iwl_ucode_tlv_capa_t
)3,
350 IWL_UCODE_TLV_CAPA_TOF_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)5,
351 IWL_UCODE_TLV_CAPA_TDLS_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)6,
352 IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)8,
353 IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)9,
354 IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)10,
355 IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)11,
356 IWL_UCODE_TLV_CAPA_DQA_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)12,
357 IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH
= (__force iwl_ucode_tlv_capa_t
)13,
358 IWL_UCODE_TLV_CAPA_CNSLDTD_D3_D0_IMG
= (__force iwl_ucode_tlv_capa_t
)17,
359 IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)18,
360 IWL_UCODE_TLV_CAPA_DC2DC_CONFIG_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)19,
361 IWL_UCODE_TLV_CAPA_CSUM_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)21,
362 IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS
= (__force iwl_ucode_tlv_capa_t
)22,
363 IWL_UCODE_TLV_CAPA_P2P_SCM_UAPSD
= (__force iwl_ucode_tlv_capa_t
)26,
364 IWL_UCODE_TLV_CAPA_BT_COEX_PLCR
= (__force iwl_ucode_tlv_capa_t
)28,
365 IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC
= (__force iwl_ucode_tlv_capa_t
)29,
366 IWL_UCODE_TLV_CAPA_BT_COEX_RRC
= (__force iwl_ucode_tlv_capa_t
)30,
367 IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)31,
368 IWL_UCODE_TLV_CAPA_STA_PM_NOTIF
= (__force iwl_ucode_tlv_capa_t
)38,
369 IWL_UCODE_TLV_CAPA_BINDING_CDB_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)39,
370 IWL_UCODE_TLV_CAPA_CDB_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)40,
371 IWL_UCODE_TLV_CAPA_D0I3_END_FIRST
= (__force iwl_ucode_tlv_capa_t
)41,
372 IWL_UCODE_TLV_CAPA_TLC_OFFLOAD
= (__force iwl_ucode_tlv_capa_t
)43,
373 IWL_UCODE_TLV_CAPA_DYNAMIC_QUOTA
= (__force iwl_ucode_tlv_capa_t
)44,
374 IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE
= (__force iwl_ucode_tlv_capa_t
)64,
375 IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS
= (__force iwl_ucode_tlv_capa_t
)65,
376 IWL_UCODE_TLV_CAPA_BT_MPLUT_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)67,
377 IWL_UCODE_TLV_CAPA_MULTI_QUEUE_RX_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)68,
378 IWL_UCODE_TLV_CAPA_CSA_AND_TBTT_OFFLOAD
= (__force iwl_ucode_tlv_capa_t
)70,
379 IWL_UCODE_TLV_CAPA_BEACON_ANT_SELECTION
= (__force iwl_ucode_tlv_capa_t
)71,
380 IWL_UCODE_TLV_CAPA_BEACON_STORING
= (__force iwl_ucode_tlv_capa_t
)72,
381 IWL_UCODE_TLV_CAPA_LAR_SUPPORT_V2
= (__force iwl_ucode_tlv_capa_t
)73,
382 IWL_UCODE_TLV_CAPA_CT_KILL_BY_FW
= (__force iwl_ucode_tlv_capa_t
)74,
383 IWL_UCODE_TLV_CAPA_TEMP_THS_REPORT_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)75,
384 IWL_UCODE_TLV_CAPA_CTDP_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)76,
385 IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED
= (__force iwl_ucode_tlv_capa_t
)77,
386 IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG
= (__force iwl_ucode_tlv_capa_t
)80,
387 IWL_UCODE_TLV_CAPA_LQM_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)81,
388 IWL_UCODE_TLV_CAPA_TX_POWER_ACK
= (__force iwl_ucode_tlv_capa_t
)84,
389 IWL_UCODE_TLV_CAPA_LED_CMD_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)86,
390 IWL_UCODE_TLV_CAPA_MLME_OFFLOAD
= (__force iwl_ucode_tlv_capa_t
)96,
392 NUM_IWL_UCODE_TLV_CAPA
394 /* sparse says it cannot increment the previous enum member */
399 /* The default calibrate table size if not specified by firmware file */
400 #define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE 18
401 #define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE 19
402 #define IWL_MAX_PHY_CALIBRATE_TBL_SIZE 253
404 /* The default max probe length if not specified by the firmware file */
405 #define IWL_DEFAULT_MAX_PROBE_LENGTH 200
408 * For 16.0 uCode and above, there is no differentiation between sections,
409 * just an offset to the HW address.
411 #define CPU1_CPU2_SEPARATOR_SECTION 0xFFFFCCCC
412 #define PAGING_SEPARATOR_SECTION 0xAAAABBBB
414 /* uCode version contains 4 values: Major/Minor/API/Serial */
415 #define IWL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24)
416 #define IWL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16)
417 #define IWL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8)
418 #define IWL_UCODE_SERIAL(ver) ((ver) & 0x000000FF)
421 * struct iwl_tlv_calib_ctrl - Calibration control struct.
422 * Sent as part of the phy configuration command.
423 * @flow_trigger: bitmap for which calibrations to perform according to
425 * @event_trigger: bitmap for which calibrations to perform according to
428 struct iwl_tlv_calib_ctrl
{
430 __le32 event_trigger
;
433 enum iwl_fw_phy_cfg
{
434 FW_PHY_CFG_RADIO_TYPE_POS
= 0,
435 FW_PHY_CFG_RADIO_TYPE
= 0x3 << FW_PHY_CFG_RADIO_TYPE_POS
,
436 FW_PHY_CFG_RADIO_STEP_POS
= 2,
437 FW_PHY_CFG_RADIO_STEP
= 0x3 << FW_PHY_CFG_RADIO_STEP_POS
,
438 FW_PHY_CFG_RADIO_DASH_POS
= 4,
439 FW_PHY_CFG_RADIO_DASH
= 0x3 << FW_PHY_CFG_RADIO_DASH_POS
,
440 FW_PHY_CFG_TX_CHAIN_POS
= 16,
441 FW_PHY_CFG_TX_CHAIN
= 0xf << FW_PHY_CFG_TX_CHAIN_POS
,
442 FW_PHY_CFG_RX_CHAIN_POS
= 20,
443 FW_PHY_CFG_RX_CHAIN
= 0xf << FW_PHY_CFG_RX_CHAIN_POS
,
446 #define IWL_UCODE_MAX_CS 1
449 * struct iwl_fw_cipher_scheme - a cipher scheme supported by FW.
450 * @cipher: a cipher suite selector
451 * @flags: cipher scheme flags (currently reserved for a future use)
452 * @hdr_len: a size of MPDU security header
453 * @pn_len: a size of PN
454 * @pn_off: an offset of pn from the beginning of the security header
455 * @key_idx_off: an offset of key index byte in the security header
456 * @key_idx_mask: a bit mask of key_idx bits
457 * @key_idx_shift: bit shift needed to get key_idx
458 * @mic_len: mic length in bytes
459 * @hw_cipher: a HW cipher index used in host commands
461 struct iwl_fw_cipher_scheme
{
474 enum iwl_fw_dbg_reg_operator
{
491 * struct iwl_fw_dbg_reg_op - an operation on a register
493 * @op: &enum iwl_fw_dbg_reg_operator
494 * @addr: offset of the register
497 struct iwl_fw_dbg_reg_op
{
505 * enum iwl_fw_dbg_monitor_mode - available monitor recording modes
507 * @SMEM_MODE: monitor stores the data in SMEM
508 * @EXTERNAL_MODE: monitor stores the data in allocated DRAM
509 * @MARBH_MODE: monitor stores the data in MARBH buffer
510 * @MIPI_MODE: monitor outputs the data through the MIPI interface
512 enum iwl_fw_dbg_monitor_mode
{
520 * enum iwl_fw_mem_seg_type - memory segment type
521 * @FW_DBG_MEM_TYPE_MASK: mask for the type indication
522 * @FW_DBG_MEM_TYPE_REGULAR: regular memory
523 * @FW_DBG_MEM_TYPE_PRPH: periphery memory (requires special reading)
525 enum iwl_fw_mem_seg_type
{
526 FW_DBG_MEM_TYPE_MASK
= 0xff000000,
527 FW_DBG_MEM_TYPE_REGULAR
= 0x00000000,
528 FW_DBG_MEM_TYPE_PRPH
= 0x01000000,
532 * struct iwl_fw_dbg_mem_seg_tlv - configures the debug data memory segments
534 * @data_type: the memory segment type to record, see &enum iwl_fw_mem_seg_type
535 * for what we care about
536 * @ofs: the memory segment offset
537 * @len: the memory segment length, in bytes
539 * This parses IWL_UCODE_TLV_FW_MEM_SEG
541 struct iwl_fw_dbg_mem_seg_tlv
{
548 * struct iwl_fw_dbg_dest_tlv_v1 - configures the destination of the debug data
550 * @version: version of the TLV - currently 0
551 * @monitor_mode: &enum iwl_fw_dbg_monitor_mode
552 * @size_power: buffer size will be 2^(size_power + 11)
553 * @base_reg: addr of the base addr register (PRPH)
554 * @end_reg: addr of the end addr register (PRPH)
555 * @write_ptr_reg: the addr of the reg of the write pointer
556 * @wrap_count: the addr of the reg of the wrap_count
557 * @base_shift: shift right of the base addr reg
558 * @end_shift: shift right of the end addr reg
559 * @reg_ops: array of registers operations
561 * This parses IWL_UCODE_TLV_FW_DBG_DEST
563 struct iwl_fw_dbg_dest_tlv_v1
{
570 __le32 write_ptr_reg
;
574 struct iwl_fw_dbg_reg_op reg_ops
[0];
577 /* Mask of the register for defining the LDBG MAC2SMEM buffer SMEM size */
578 #define IWL_LDBG_M2S_BUF_SIZE_MSK 0x0fff0000
579 /* Mask of the register for defining the LDBG MAC2SMEM SMEM base address */
580 #define IWL_LDBG_M2S_BUF_BA_MSK 0x00000fff
581 /* The smem buffer chunks are in units of 256 bits */
582 #define IWL_M2S_UNIT_SIZE 0x100
584 struct iwl_fw_dbg_dest_tlv
{
590 __le32 write_ptr_reg
;
594 struct iwl_fw_dbg_reg_op reg_ops
[0];
597 struct iwl_fw_dbg_conf_hcmd
{
605 * enum iwl_fw_dbg_trigger_mode - triggers functionalities
607 * @IWL_FW_DBG_TRIGGER_START: when trigger occurs re-conf the dbg mechanism
608 * @IWL_FW_DBG_TRIGGER_STOP: when trigger occurs pull the dbg data
609 * @IWL_FW_DBG_TRIGGER_MONITOR_ONLY: when trigger occurs trigger is set to
610 * collect only monitor data
612 enum iwl_fw_dbg_trigger_mode
{
613 IWL_FW_DBG_TRIGGER_START
= BIT(0),
614 IWL_FW_DBG_TRIGGER_STOP
= BIT(1),
615 IWL_FW_DBG_TRIGGER_MONITOR_ONLY
= BIT(2),
619 * enum iwl_fw_dbg_trigger_vif_type - define the VIF type for a trigger
620 * @IWL_FW_DBG_CONF_VIF_ANY: any vif type
621 * @IWL_FW_DBG_CONF_VIF_IBSS: IBSS mode
622 * @IWL_FW_DBG_CONF_VIF_STATION: BSS mode
623 * @IWL_FW_DBG_CONF_VIF_AP: AP mode
624 * @IWL_FW_DBG_CONF_VIF_P2P_CLIENT: P2P Client mode
625 * @IWL_FW_DBG_CONF_VIF_P2P_GO: P2P GO mode
626 * @IWL_FW_DBG_CONF_VIF_P2P_DEVICE: P2P device
628 enum iwl_fw_dbg_trigger_vif_type
{
629 IWL_FW_DBG_CONF_VIF_ANY
= NL80211_IFTYPE_UNSPECIFIED
,
630 IWL_FW_DBG_CONF_VIF_IBSS
= NL80211_IFTYPE_ADHOC
,
631 IWL_FW_DBG_CONF_VIF_STATION
= NL80211_IFTYPE_STATION
,
632 IWL_FW_DBG_CONF_VIF_AP
= NL80211_IFTYPE_AP
,
633 IWL_FW_DBG_CONF_VIF_P2P_CLIENT
= NL80211_IFTYPE_P2P_CLIENT
,
634 IWL_FW_DBG_CONF_VIF_P2P_GO
= NL80211_IFTYPE_P2P_GO
,
635 IWL_FW_DBG_CONF_VIF_P2P_DEVICE
= NL80211_IFTYPE_P2P_DEVICE
,
639 * struct iwl_fw_dbg_trigger_tlv - a TLV that describes the trigger
640 * @id: &enum iwl_fw_dbg_trigger
641 * @vif_type: &enum iwl_fw_dbg_trigger_vif_type
642 * @stop_conf_ids: bitmap of configurations this trigger relates to.
643 * if the mode is %IWL_FW_DBG_TRIGGER_STOP, then if the bit corresponding
644 * to the currently running configuration is set, the data should be
646 * @stop_delay: how many milliseconds to wait before collecting the data
647 * after the STOP trigger fires.
648 * @mode: &enum iwl_fw_dbg_trigger_mode - can be stop / start of both
649 * @start_conf_id: if mode is %IWL_FW_DBG_TRIGGER_START, this defines what
650 * configuration should be applied when the triggers kicks in.
651 * @occurrences: number of occurrences. 0 means the trigger will never fire.
652 * @trig_dis_ms: the time, in milliseconds, after an occurrence of this
653 * trigger in which another occurrence should be ignored.
655 struct iwl_fw_dbg_trigger_tlv
{
658 __le32 stop_conf_ids
;
669 #define FW_DBG_START_FROM_ALIVE 0
670 #define FW_DBG_CONF_MAX 32
671 #define FW_DBG_INVALID 0xff
674 * struct iwl_fw_dbg_trigger_missed_bcon - configures trigger for missed beacons
675 * @stop_consec_missed_bcon: stop recording if threshold is crossed.
676 * @stop_consec_missed_bcon_since_rx: stop recording if threshold is crossed.
677 * @start_consec_missed_bcon: start recording if threshold is crossed.
678 * @start_consec_missed_bcon_since_rx: start recording if threshold is crossed.
679 * @reserved1: reserved
680 * @reserved2: reserved
682 struct iwl_fw_dbg_trigger_missed_bcon
{
683 __le32 stop_consec_missed_bcon
;
684 __le32 stop_consec_missed_bcon_since_rx
;
686 __le32 start_consec_missed_bcon
;
687 __le32 start_consec_missed_bcon_since_rx
;
692 * struct iwl_fw_dbg_trigger_cmd - configures trigger for messages from FW.
693 * cmds: the list of commands to trigger the collection on
695 struct iwl_fw_dbg_trigger_cmd
{
703 * iwl_fw_dbg_trigger_stats - configures trigger for statistics
704 * @stop_offset: the offset of the value to be monitored
705 * @stop_threshold: the threshold above which to collect
706 * @start_offset: the offset of the value to be monitored
707 * @start_threshold: the threshold above which to start recording
709 struct iwl_fw_dbg_trigger_stats
{
711 __le32 stop_threshold
;
713 __le32 start_threshold
;
717 * struct iwl_fw_dbg_trigger_low_rssi - trigger for low beacon RSSI
718 * @rssi: RSSI value to trigger at
720 struct iwl_fw_dbg_trigger_low_rssi
{
725 * struct iwl_fw_dbg_trigger_mlme - configures trigger for mlme events
726 * @stop_auth_denied: number of denied authentication to collect
727 * @stop_auth_timeout: number of authentication timeout to collect
728 * @stop_rx_deauth: number of Rx deauth before to collect
729 * @stop_tx_deauth: number of Tx deauth before to collect
730 * @stop_assoc_denied: number of denied association to collect
731 * @stop_assoc_timeout: number of association timeout to collect
732 * @stop_connection_loss: number of connection loss to collect
733 * @start_auth_denied: number of denied authentication to start recording
734 * @start_auth_timeout: number of authentication timeout to start recording
735 * @start_rx_deauth: number of Rx deauth to start recording
736 * @start_tx_deauth: number of Tx deauth to start recording
737 * @start_assoc_denied: number of denied association to start recording
738 * @start_assoc_timeout: number of association timeout to start recording
739 * @start_connection_loss: number of connection loss to start recording
741 struct iwl_fw_dbg_trigger_mlme
{
743 u8 stop_auth_timeout
;
747 u8 stop_assoc_denied
;
748 u8 stop_assoc_timeout
;
749 u8 stop_connection_loss
;
752 u8 start_auth_denied
;
753 u8 start_auth_timeout
;
757 u8 start_assoc_denied
;
758 u8 start_assoc_timeout
;
759 u8 start_connection_loss
;
764 * struct iwl_fw_dbg_trigger_txq_timer - configures the Tx queue's timer
765 * @command_queue: timeout for the command queue in ms
766 * @bss: timeout for the queues of a BSS (except for TDLS queues) in ms
767 * @softap: timeout for the queues of a softAP in ms
768 * @p2p_go: timeout for the queues of a P2P GO in ms
769 * @p2p_client: timeout for the queues of a P2P client in ms
770 * @p2p_device: timeout for the queues of a P2P device in ms
771 * @ibss: timeout for the queues of an IBSS in ms
772 * @tdls: timeout for the queues of a TDLS station in ms
774 struct iwl_fw_dbg_trigger_txq_timer
{
775 __le32 command_queue
;
787 * struct iwl_fw_dbg_trigger_time_event - configures a time event trigger
788 * time_Events: a list of tuples <id, action_bitmap>. The driver will issue a
789 * trigger each time a time event notification that relates to time event
790 * id with one of the actions in the bitmap is received and
791 * BIT(notif->status) is set in status_bitmap.
794 struct iwl_fw_dbg_trigger_time_event
{
797 __le32 action_bitmap
;
798 __le32 status_bitmap
;
799 } __packed time_events
[16];
803 * struct iwl_fw_dbg_trigger_ba - configures BlockAck related trigger
804 * rx_ba_start: tid bitmap to configure on what tid the trigger should occur
805 * when an Rx BlockAck session is started.
806 * rx_ba_stop: tid bitmap to configure on what tid the trigger should occur
807 * when an Rx BlockAck session is stopped.
808 * tx_ba_start: tid bitmap to configure on what tid the trigger should occur
809 * when a Tx BlockAck session is started.
810 * tx_ba_stop: tid bitmap to configure on what tid the trigger should occur
811 * when a Tx BlockAck session is stopped.
812 * rx_bar: tid bitmap to configure on what tid the trigger should occur
813 * when a BAR is received (for a Tx BlockAck session).
814 * tx_bar: tid bitmap to configure on what tid the trigger should occur
815 * when a BAR is send (for an Rx BlocAck session).
816 * frame_timeout: tid bitmap to configure on what tid the trigger should occur
817 * when a frame times out in the reodering buffer.
819 struct iwl_fw_dbg_trigger_ba
{
826 __le16 frame_timeout
;
830 * struct iwl_fw_dbg_trigger_tdls - configures trigger for TDLS events.
831 * @action_bitmap: the TDLS action to trigger the collection upon
832 * @peer_mode: trigger on specific peer or all
833 * @peer: the TDLS peer to trigger the collection on
835 struct iwl_fw_dbg_trigger_tdls
{
843 * struct iwl_fw_dbg_trigger_tx_status - configures trigger for tx response
845 * @statuses: the list of statuses to trigger the collection on
847 struct iwl_fw_dbg_trigger_tx_status
{
851 } __packed statuses
[16];
856 * struct iwl_fw_dbg_conf_tlv - a TLV that describes a debug configuration.
858 * @usniffer: should the uSniffer image be used
859 * @num_of_hcmds: how many HCMDs to send are present here
860 * @hcmd: a variable length host command to be sent to apply the configuration.
861 * If there is more than one HCMD to send, they will appear one after the
862 * other and be sent in the order that they appear in.
863 * This parses IWL_UCODE_TLV_FW_DBG_CONF. The user can add up-to
864 * %FW_DBG_CONF_MAX configuration per run.
866 struct iwl_fw_dbg_conf_tlv
{
871 struct iwl_fw_dbg_conf_hcmd hcmd
;
875 * struct iwl_fw_gscan_capabilities - gscan capabilities supported by FW
876 * @max_scan_cache_size: total space allocated for scan results (in bytes).
877 * @max_scan_buckets: maximum number of channel buckets.
878 * @max_ap_cache_per_scan: maximum number of APs that can be stored per scan.
879 * @max_rssi_sample_size: number of RSSI samples used for averaging RSSI.
880 * @max_scan_reporting_threshold: max possible report threshold. in percentage.
881 * @max_hotlist_aps: maximum number of entries for hotlist APs.
882 * @max_significant_change_aps: maximum number of entries for significant
884 * @max_bssid_history_entries: number of BSSID/RSSI entries that the device can
886 * @max_hotlist_ssids: maximum number of entries for hotlist SSIDs.
887 * @max_number_epno_networks: max number of epno entries.
888 * @max_number_epno_networks_by_ssid: max number of epno entries if ssid is
890 * @max_number_of_white_listed_ssid: max number of white listed SSIDs.
891 * @max_number_of_black_listed_ssid: max number of black listed SSIDs.
893 struct iwl_fw_gscan_capabilities
{
894 __le32 max_scan_cache_size
;
895 __le32 max_scan_buckets
;
896 __le32 max_ap_cache_per_scan
;
897 __le32 max_rssi_sample_size
;
898 __le32 max_scan_reporting_threshold
;
899 __le32 max_hotlist_aps
;
900 __le32 max_significant_change_aps
;
901 __le32 max_bssid_history_entries
;
902 __le32 max_hotlist_ssids
;
903 __le32 max_number_epno_networks
;
904 __le32 max_number_epno_networks_by_ssid
;
905 __le32 max_number_of_white_listed_ssid
;
906 __le32 max_number_of_black_listed_ssid
;
909 #endif /* __iwl_fw_file_h__ */