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,
139 IWL_UCODE_TLV_SDIO_ADMA_ADDR
= 35,
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
245 * @NUM_IWL_UCODE_TLV_API: number of bits used
247 enum iwl_ucode_tlv_api
{
248 IWL_UCODE_TLV_API_FRAGMENTED_SCAN
= (__force iwl_ucode_tlv_api_t
)8,
249 IWL_UCODE_TLV_API_WIFI_MCC_UPDATE
= (__force iwl_ucode_tlv_api_t
)9,
250 IWL_UCODE_TLV_API_LQ_SS_PARAMS
= (__force iwl_ucode_tlv_api_t
)18,
251 IWL_UCODE_TLV_API_NEW_VERSION
= (__force iwl_ucode_tlv_api_t
)20,
252 IWL_UCODE_TLV_API_SCAN_TSF_REPORT
= (__force iwl_ucode_tlv_api_t
)28,
254 NUM_IWL_UCODE_TLV_API
256 /* sparse says it cannot increment the previous enum member */
261 typedef unsigned int __bitwise iwl_ucode_tlv_capa_t
;
264 * enum iwl_ucode_tlv_capa - ucode capabilities
265 * @IWL_UCODE_TLV_CAPA_D0I3_SUPPORT: supports D0i3
266 * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT: supports Location Aware Regulatory
267 * @IWL_UCODE_TLV_CAPA_UMAC_SCAN: supports UMAC scan.
268 * @IWL_UCODE_TLV_CAPA_BEAMFORMER: supports Beamformer
269 * @IWL_UCODE_TLV_CAPA_TOF_SUPPORT: supports Time of Flight (802.11mc FTM)
270 * @IWL_UCODE_TLV_CAPA_TDLS_SUPPORT: support basic TDLS functionality
271 * @IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT: supports insertion of current
272 * tx power value into TPC Report action frame and Link Measurement Report
274 * @IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT: supports updating current
275 * channel in DS parameter set element in probe requests.
276 * @IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT: supports adding TPC Report IE in
278 * @IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT: supports Quiet Period requests
279 * @IWL_UCODE_TLV_CAPA_DQA_SUPPORT: supports dynamic queue allocation (DQA),
280 * which also implies support for the scheduler configuration command
281 * @IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH: supports TDLS channel switching
282 * @IWL_UCODE_TLV_CAPA_CNSLDTD_D3_D0_IMG: Consolidated D3-D0 image
283 * @IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT: supports Hot Spot Command
284 * @IWL_UCODE_TLV_CAPA_DC2DC_SUPPORT: supports DC2DC Command
285 * @IWL_UCODE_TLV_CAPA_CSUM_SUPPORT: supports TCP Checksum Offload
286 * @IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS: support radio and beacon statistics
287 * @IWL_UCODE_TLV_CAPA_P2P_SCM_UAPSD: supports U-APSD on p2p interface when it
288 * is standalone or with a BSS station interface in the same binding.
289 * @IWL_UCODE_TLV_CAPA_BT_COEX_PLCR: enabled BT Coex packet level co-running
290 * @IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC: ucode supports LAR updates with different
291 * sources for the MCC. This TLV bit is a future replacement to
292 * IWL_UCODE_TLV_API_WIFI_MCC_UPDATE. When either is set, multi-source LAR
294 * @IWL_UCODE_TLV_CAPA_BT_COEX_RRC: supports BT Coex RRC
295 * @IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT: supports gscan
296 * @IWL_UCODE_TLV_CAPA_STA_PM_NOTIF: firmware will send STA PM notification
297 * @IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE: extended DTS measurement
298 * @IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS: supports short PM timeouts
299 * @IWL_UCODE_TLV_CAPA_BT_MPLUT_SUPPORT: supports bt-coex Multi-priority LUT
300 * @IWL_UCODE_TLV_CAPA_CSA_AND_TBTT_OFFLOAD: the firmware supports CSA
301 * countdown offloading. Beacon notifications are not sent to the host.
302 * The fw also offloads TBTT alignment.
303 * @IWL_UCODE_TLV_CAPA_BEACON_ANT_SELECTION: firmware will decide on what
304 * antenna the beacon should be transmitted
305 * @IWL_UCODE_TLV_CAPA_BEACON_STORING: firmware will store the latest beacon
306 * from AP and will send it upon d0i3 exit.
307 * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT_V2: support LAR API V2
308 * @IWL_UCODE_TLV_CAPA_CT_KILL_BY_FW: firmware responsible for CT-kill
309 * @IWL_UCODE_TLV_CAPA_TEMP_THS_REPORT_SUPPORT: supports temperature
310 * thresholds reporting
311 * @IWL_UCODE_TLV_CAPA_CTDP_SUPPORT: supports cTDP command
312 * @IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED: supports usniffer enabled in
314 * @IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG: support getting more shared
315 * memory addresses from the firmware.
316 * @IWL_UCODE_TLV_CAPA_LQM_SUPPORT: supports Link Quality Measurement
317 * @IWL_UCODE_TLV_CAPA_TX_POWER_ACK: reduced TX power API has larger
318 * command size (command version 4) that supports toggling ACK TX
321 * @NUM_IWL_UCODE_TLV_CAPA: number of bits used
323 enum iwl_ucode_tlv_capa
{
324 IWL_UCODE_TLV_CAPA_D0I3_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)0,
325 IWL_UCODE_TLV_CAPA_LAR_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)1,
326 IWL_UCODE_TLV_CAPA_UMAC_SCAN
= (__force iwl_ucode_tlv_capa_t
)2,
327 IWL_UCODE_TLV_CAPA_BEAMFORMER
= (__force iwl_ucode_tlv_capa_t
)3,
328 IWL_UCODE_TLV_CAPA_TOF_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)5,
329 IWL_UCODE_TLV_CAPA_TDLS_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)6,
330 IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)8,
331 IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)9,
332 IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)10,
333 IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)11,
334 IWL_UCODE_TLV_CAPA_DQA_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)12,
335 IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH
= (__force iwl_ucode_tlv_capa_t
)13,
336 IWL_UCODE_TLV_CAPA_CNSLDTD_D3_D0_IMG
= (__force iwl_ucode_tlv_capa_t
)17,
337 IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)18,
338 IWL_UCODE_TLV_CAPA_DC2DC_CONFIG_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)19,
339 IWL_UCODE_TLV_CAPA_CSUM_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)21,
340 IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS
= (__force iwl_ucode_tlv_capa_t
)22,
341 IWL_UCODE_TLV_CAPA_P2P_SCM_UAPSD
= (__force iwl_ucode_tlv_capa_t
)26,
342 IWL_UCODE_TLV_CAPA_BT_COEX_PLCR
= (__force iwl_ucode_tlv_capa_t
)28,
343 IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC
= (__force iwl_ucode_tlv_capa_t
)29,
344 IWL_UCODE_TLV_CAPA_BT_COEX_RRC
= (__force iwl_ucode_tlv_capa_t
)30,
345 IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)31,
346 IWL_UCODE_TLV_CAPA_STA_PM_NOTIF
= (__force iwl_ucode_tlv_capa_t
)38,
347 IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE
= (__force iwl_ucode_tlv_capa_t
)64,
348 IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS
= (__force iwl_ucode_tlv_capa_t
)65,
349 IWL_UCODE_TLV_CAPA_BT_MPLUT_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)67,
350 IWL_UCODE_TLV_CAPA_MULTI_QUEUE_RX_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)68,
351 IWL_UCODE_TLV_CAPA_CSA_AND_TBTT_OFFLOAD
= (__force iwl_ucode_tlv_capa_t
)70,
352 IWL_UCODE_TLV_CAPA_BEACON_ANT_SELECTION
= (__force iwl_ucode_tlv_capa_t
)71,
353 IWL_UCODE_TLV_CAPA_BEACON_STORING
= (__force iwl_ucode_tlv_capa_t
)72,
354 IWL_UCODE_TLV_CAPA_LAR_SUPPORT_V2
= (__force iwl_ucode_tlv_capa_t
)73,
355 IWL_UCODE_TLV_CAPA_CT_KILL_BY_FW
= (__force iwl_ucode_tlv_capa_t
)74,
356 IWL_UCODE_TLV_CAPA_TEMP_THS_REPORT_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)75,
357 IWL_UCODE_TLV_CAPA_CTDP_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)76,
358 IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED
= (__force iwl_ucode_tlv_capa_t
)77,
359 IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG
= (__force iwl_ucode_tlv_capa_t
)80,
360 IWL_UCODE_TLV_CAPA_LQM_SUPPORT
= (__force iwl_ucode_tlv_capa_t
)81,
361 IWL_UCODE_TLV_CAPA_TX_POWER_ACK
= (__force iwl_ucode_tlv_capa_t
)84,
363 NUM_IWL_UCODE_TLV_CAPA
365 /* sparse says it cannot increment the previous enum member */
370 /* The default calibrate table size if not specified by firmware file */
371 #define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE 18
372 #define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE 19
373 #define IWL_MAX_PHY_CALIBRATE_TBL_SIZE 253
375 /* The default max probe length if not specified by the firmware file */
376 #define IWL_DEFAULT_MAX_PROBE_LENGTH 200
379 * For 16.0 uCode and above, there is no differentiation between sections,
380 * just an offset to the HW address.
382 #define IWL_UCODE_SECTION_MAX 16
383 #define CPU1_CPU2_SEPARATOR_SECTION 0xFFFFCCCC
384 #define PAGING_SEPARATOR_SECTION 0xAAAABBBB
386 /* uCode version contains 4 values: Major/Minor/API/Serial */
387 #define IWL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24)
388 #define IWL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16)
389 #define IWL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8)
390 #define IWL_UCODE_SERIAL(ver) ((ver) & 0x000000FF)
393 * Calibration control struct.
394 * Sent as part of the phy configuration command.
395 * @flow_trigger: bitmap for which calibrations to perform according to
397 * @event_trigger: bitmap for which calibrations to perform according to
400 struct iwl_tlv_calib_ctrl
{
402 __le32 event_trigger
;
405 enum iwl_fw_phy_cfg
{
406 FW_PHY_CFG_RADIO_TYPE_POS
= 0,
407 FW_PHY_CFG_RADIO_TYPE
= 0x3 << FW_PHY_CFG_RADIO_TYPE_POS
,
408 FW_PHY_CFG_RADIO_STEP_POS
= 2,
409 FW_PHY_CFG_RADIO_STEP
= 0x3 << FW_PHY_CFG_RADIO_STEP_POS
,
410 FW_PHY_CFG_RADIO_DASH_POS
= 4,
411 FW_PHY_CFG_RADIO_DASH
= 0x3 << FW_PHY_CFG_RADIO_DASH_POS
,
412 FW_PHY_CFG_TX_CHAIN_POS
= 16,
413 FW_PHY_CFG_TX_CHAIN
= 0xf << FW_PHY_CFG_TX_CHAIN_POS
,
414 FW_PHY_CFG_RX_CHAIN_POS
= 20,
415 FW_PHY_CFG_RX_CHAIN
= 0xf << FW_PHY_CFG_RX_CHAIN_POS
,
418 #define IWL_UCODE_MAX_CS 1
421 * struct iwl_fw_cipher_scheme - a cipher scheme supported by FW.
422 * @cipher: a cipher suite selector
423 * @flags: cipher scheme flags (currently reserved for a future use)
424 * @hdr_len: a size of MPDU security header
425 * @pn_len: a size of PN
426 * @pn_off: an offset of pn from the beginning of the security header
427 * @key_idx_off: an offset of key index byte in the security header
428 * @key_idx_mask: a bit mask of key_idx bits
429 * @key_idx_shift: bit shift needed to get key_idx
430 * @mic_len: mic length in bytes
431 * @hw_cipher: a HW cipher index used in host commands
433 struct iwl_fw_cipher_scheme
{
446 enum iwl_fw_dbg_reg_operator
{
463 * struct iwl_fw_dbg_reg_op - an operation on a register
465 * @op: %enum iwl_fw_dbg_reg_operator
466 * @addr: offset of the register
469 struct iwl_fw_dbg_reg_op
{
477 * enum iwl_fw_dbg_monitor_mode - available monitor recording modes
479 * @SMEM_MODE: monitor stores the data in SMEM
480 * @EXTERNAL_MODE: monitor stores the data in allocated DRAM
481 * @MARBH_MODE: monitor stores the data in MARBH buffer
482 * @MIPI_MODE: monitor outputs the data through the MIPI interface
484 enum iwl_fw_dbg_monitor_mode
{
492 * struct iwl_fw_dbg_mem_seg_tlv - configures the debug data memory segments
494 * @data_type: the memory segment type to record
495 * @ofs: the memory segment offset
496 * @len: the memory segment length, in bytes
498 * This parses IWL_UCODE_TLV_FW_MEM_SEG
500 struct iwl_fw_dbg_mem_seg_tlv
{
507 * struct iwl_fw_dbg_dest_tlv - configures the destination of the debug data
509 * @version: version of the TLV - currently 0
510 * @monitor_mode: %enum iwl_fw_dbg_monitor_mode
511 * @size_power: buffer size will be 2^(size_power + 11)
512 * @base_reg: addr of the base addr register (PRPH)
513 * @end_reg: addr of the end addr register (PRPH)
514 * @write_ptr_reg: the addr of the reg of the write pointer
515 * @wrap_count: the addr of the reg of the wrap_count
516 * @base_shift: shift right of the base addr reg
517 * @end_shift: shift right of the end addr reg
518 * @reg_ops: array of registers operations
520 * This parses IWL_UCODE_TLV_FW_DBG_DEST
522 struct iwl_fw_dbg_dest_tlv
{
529 __le32 write_ptr_reg
;
533 struct iwl_fw_dbg_reg_op reg_ops
[0];
536 struct iwl_fw_dbg_conf_hcmd
{
544 * enum iwl_fw_dbg_trigger_mode - triggers functionalities
546 * @IWL_FW_DBG_TRIGGER_START: when trigger occurs re-conf the dbg mechanism
547 * @IWL_FW_DBG_TRIGGER_STOP: when trigger occurs pull the dbg data
548 * @IWL_FW_DBG_TRIGGER_MONITOR_ONLY: when trigger occurs trigger is set to
549 * collect only monitor data
551 enum iwl_fw_dbg_trigger_mode
{
552 IWL_FW_DBG_TRIGGER_START
= BIT(0),
553 IWL_FW_DBG_TRIGGER_STOP
= BIT(1),
554 IWL_FW_DBG_TRIGGER_MONITOR_ONLY
= BIT(2),
558 * enum iwl_fw_dbg_trigger_vif_type - define the VIF type for a trigger
559 * @IWL_FW_DBG_CONF_VIF_ANY: any vif type
560 * @IWL_FW_DBG_CONF_VIF_IBSS: IBSS mode
561 * @IWL_FW_DBG_CONF_VIF_STATION: BSS mode
562 * @IWL_FW_DBG_CONF_VIF_AP: AP mode
563 * @IWL_FW_DBG_CONF_VIF_P2P_CLIENT: P2P Client mode
564 * @IWL_FW_DBG_CONF_VIF_P2P_GO: P2P GO mode
565 * @IWL_FW_DBG_CONF_VIF_P2P_DEVICE: P2P device
567 enum iwl_fw_dbg_trigger_vif_type
{
568 IWL_FW_DBG_CONF_VIF_ANY
= NL80211_IFTYPE_UNSPECIFIED
,
569 IWL_FW_DBG_CONF_VIF_IBSS
= NL80211_IFTYPE_ADHOC
,
570 IWL_FW_DBG_CONF_VIF_STATION
= NL80211_IFTYPE_STATION
,
571 IWL_FW_DBG_CONF_VIF_AP
= NL80211_IFTYPE_AP
,
572 IWL_FW_DBG_CONF_VIF_P2P_CLIENT
= NL80211_IFTYPE_P2P_CLIENT
,
573 IWL_FW_DBG_CONF_VIF_P2P_GO
= NL80211_IFTYPE_P2P_GO
,
574 IWL_FW_DBG_CONF_VIF_P2P_DEVICE
= NL80211_IFTYPE_P2P_DEVICE
,
578 * struct iwl_fw_dbg_trigger_tlv - a TLV that describes the trigger
579 * @id: %enum iwl_fw_dbg_trigger
580 * @vif_type: %enum iwl_fw_dbg_trigger_vif_type
581 * @stop_conf_ids: bitmap of configurations this trigger relates to.
582 * if the mode is %IWL_FW_DBG_TRIGGER_STOP, then if the bit corresponding
583 * to the currently running configuration is set, the data should be
585 * @stop_delay: how many milliseconds to wait before collecting the data
586 * after the STOP trigger fires.
587 * @mode: %enum iwl_fw_dbg_trigger_mode - can be stop / start of both
588 * @start_conf_id: if mode is %IWL_FW_DBG_TRIGGER_START, this defines what
589 * configuration should be applied when the triggers kicks in.
590 * @occurrences: number of occurrences. 0 means the trigger will never fire.
591 * @trig_dis_ms: the time, in milliseconds, after an occurrence of this
592 * trigger in which another occurrence should be ignored.
594 struct iwl_fw_dbg_trigger_tlv
{
597 __le32 stop_conf_ids
;
608 #define FW_DBG_START_FROM_ALIVE 0
609 #define FW_DBG_CONF_MAX 32
610 #define FW_DBG_INVALID 0xff
613 * struct iwl_fw_dbg_trigger_missed_bcon - configures trigger for missed beacons
614 * @stop_consec_missed_bcon: stop recording if threshold is crossed.
615 * @stop_consec_missed_bcon_since_rx: stop recording if threshold is crossed.
616 * @start_consec_missed_bcon: start recording if threshold is crossed.
617 * @start_consec_missed_bcon_since_rx: start recording if threshold is crossed.
618 * @reserved1: reserved
619 * @reserved2: reserved
621 struct iwl_fw_dbg_trigger_missed_bcon
{
622 __le32 stop_consec_missed_bcon
;
623 __le32 stop_consec_missed_bcon_since_rx
;
625 __le32 start_consec_missed_bcon
;
626 __le32 start_consec_missed_bcon_since_rx
;
631 * struct iwl_fw_dbg_trigger_cmd - configures trigger for messages from FW.
632 * cmds: the list of commands to trigger the collection on
634 struct iwl_fw_dbg_trigger_cmd
{
642 * iwl_fw_dbg_trigger_stats - configures trigger for statistics
643 * @stop_offset: the offset of the value to be monitored
644 * @stop_threshold: the threshold above which to collect
645 * @start_offset: the offset of the value to be monitored
646 * @start_threshold: the threshold above which to start recording
648 struct iwl_fw_dbg_trigger_stats
{
650 __le32 stop_threshold
;
652 __le32 start_threshold
;
656 * struct iwl_fw_dbg_trigger_low_rssi - trigger for low beacon RSSI
657 * @rssi: RSSI value to trigger at
659 struct iwl_fw_dbg_trigger_low_rssi
{
664 * struct iwl_fw_dbg_trigger_mlme - configures trigger for mlme events
665 * @stop_auth_denied: number of denied authentication to collect
666 * @stop_auth_timeout: number of authentication timeout to collect
667 * @stop_rx_deauth: number of Rx deauth before to collect
668 * @stop_tx_deauth: number of Tx deauth before to collect
669 * @stop_assoc_denied: number of denied association to collect
670 * @stop_assoc_timeout: number of association timeout to collect
671 * @stop_connection_loss: number of connection loss to collect
672 * @start_auth_denied: number of denied authentication to start recording
673 * @start_auth_timeout: number of authentication timeout to start recording
674 * @start_rx_deauth: number of Rx deauth to start recording
675 * @start_tx_deauth: number of Tx deauth to start recording
676 * @start_assoc_denied: number of denied association to start recording
677 * @start_assoc_timeout: number of association timeout to start recording
678 * @start_connection_loss: number of connection loss to start recording
680 struct iwl_fw_dbg_trigger_mlme
{
682 u8 stop_auth_timeout
;
686 u8 stop_assoc_denied
;
687 u8 stop_assoc_timeout
;
688 u8 stop_connection_loss
;
691 u8 start_auth_denied
;
692 u8 start_auth_timeout
;
696 u8 start_assoc_denied
;
697 u8 start_assoc_timeout
;
698 u8 start_connection_loss
;
703 * struct iwl_fw_dbg_trigger_txq_timer - configures the Tx queue's timer
704 * @command_queue: timeout for the command queue in ms
705 * @bss: timeout for the queues of a BSS (except for TDLS queues) in ms
706 * @softap: timeout for the queues of a softAP in ms
707 * @p2p_go: timeout for the queues of a P2P GO in ms
708 * @p2p_client: timeout for the queues of a P2P client in ms
709 * @p2p_device: timeout for the queues of a P2P device in ms
710 * @ibss: timeout for the queues of an IBSS in ms
711 * @tdls: timeout for the queues of a TDLS station in ms
713 struct iwl_fw_dbg_trigger_txq_timer
{
714 __le32 command_queue
;
726 * struct iwl_fw_dbg_trigger_time_event - configures a time event trigger
727 * time_Events: a list of tuples <id, action_bitmap>. The driver will issue a
728 * trigger each time a time event notification that relates to time event
729 * id with one of the actions in the bitmap is received and
730 * BIT(notif->status) is set in status_bitmap.
733 struct iwl_fw_dbg_trigger_time_event
{
736 __le32 action_bitmap
;
737 __le32 status_bitmap
;
738 } __packed time_events
[16];
742 * struct iwl_fw_dbg_trigger_ba - configures BlockAck related trigger
743 * rx_ba_start: tid bitmap to configure on what tid the trigger should occur
744 * when an Rx BlockAck session is started.
745 * rx_ba_stop: tid bitmap to configure on what tid the trigger should occur
746 * when an Rx BlockAck session is stopped.
747 * tx_ba_start: tid bitmap to configure on what tid the trigger should occur
748 * when a Tx BlockAck session is started.
749 * tx_ba_stop: tid bitmap to configure on what tid the trigger should occur
750 * when a Tx BlockAck session is stopped.
751 * rx_bar: tid bitmap to configure on what tid the trigger should occur
752 * when a BAR is received (for a Tx BlockAck session).
753 * tx_bar: tid bitmap to configure on what tid the trigger should occur
754 * when a BAR is send (for an Rx BlocAck session).
755 * frame_timeout: tid bitmap to configure on what tid the trigger should occur
756 * when a frame times out in the reodering buffer.
758 struct iwl_fw_dbg_trigger_ba
{
765 __le16 frame_timeout
;
769 * struct iwl_fw_dbg_trigger_tdls - configures trigger for TDLS events.
770 * @action_bitmap: the TDLS action to trigger the collection upon
771 * @peer_mode: trigger on specific peer or all
772 * @peer: the TDLS peer to trigger the collection on
774 struct iwl_fw_dbg_trigger_tdls
{
782 * struct iwl_fw_dbg_trigger_tx_status - configures trigger for tx response
784 * @statuses: the list of statuses to trigger the collection on
786 struct iwl_fw_dbg_trigger_tx_status
{
790 } __packed statuses
[16];
795 * struct iwl_fw_dbg_conf_tlv - a TLV that describes a debug configuration.
797 * @usniffer: should the uSniffer image be used
798 * @num_of_hcmds: how many HCMDs to send are present here
799 * @hcmd: a variable length host command to be sent to apply the configuration.
800 * If there is more than one HCMD to send, they will appear one after the
801 * other and be sent in the order that they appear in.
802 * This parses IWL_UCODE_TLV_FW_DBG_CONF. The user can add up-to
803 * %FW_DBG_CONF_MAX configuration per run.
805 struct iwl_fw_dbg_conf_tlv
{
810 struct iwl_fw_dbg_conf_hcmd hcmd
;
814 * struct iwl_fw_gscan_capabilities - gscan capabilities supported by FW
815 * @max_scan_cache_size: total space allocated for scan results (in bytes).
816 * @max_scan_buckets: maximum number of channel buckets.
817 * @max_ap_cache_per_scan: maximum number of APs that can be stored per scan.
818 * @max_rssi_sample_size: number of RSSI samples used for averaging RSSI.
819 * @max_scan_reporting_threshold: max possible report threshold. in percentage.
820 * @max_hotlist_aps: maximum number of entries for hotlist APs.
821 * @max_significant_change_aps: maximum number of entries for significant
823 * @max_bssid_history_entries: number of BSSID/RSSI entries that the device can
825 * @max_hotlist_ssids: maximum number of entries for hotlist SSIDs.
826 * @max_number_epno_networks: max number of epno entries.
827 * @max_number_epno_networks_by_ssid: max number of epno entries if ssid is
829 * @max_number_of_white_listed_ssid: max number of white listed SSIDs.
830 * @max_number_of_black_listed_ssid: max number of black listed SSIDs.
832 struct iwl_fw_gscan_capabilities
{
833 __le32 max_scan_cache_size
;
834 __le32 max_scan_buckets
;
835 __le32 max_ap_cache_per_scan
;
836 __le32 max_rssi_sample_size
;
837 __le32 max_scan_reporting_threshold
;
838 __le32 max_hotlist_aps
;
839 __le32 max_significant_change_aps
;
840 __le32 max_bssid_history_entries
;
841 __le32 max_hotlist_ssids
;
842 __le32 max_number_epno_networks
;
843 __le32 max_number_epno_networks_by_ssid
;
844 __le32 max_number_of_white_listed_ssid
;
845 __le32 max_number_of_black_listed_ssid
;
848 #endif /* __iwl_fw_file_h__ */