Loading...
Note: File does not exist in v6.8.
1/******************************************************************************
2 *
3 * This file is provided under a dual BSD/GPLv2 license. When using or
4 * redistributing this file, you may do so under either license.
5 *
6 * GPL LICENSE SUMMARY
7 *
8 * Copyright(c) 2008 - 2014 Intel Corporation. All rights reserved.
9 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
10 * Copyright(c) 2016 Intel Deutschland GmbH
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of version 2 of the GNU General Public License as
14 * published by the Free Software Foundation.
15 *
16 * This program is distributed in the hope that it will be useful, but
17 * WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
24 * USA
25 *
26 * The full GNU General Public License is included in this distribution
27 * in the file called COPYING.
28 *
29 * Contact Information:
30 * Intel Linux Wireless <linuxwifi@intel.com>
31 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
32 *
33 * BSD LICENSE
34 *
35 * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
36 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
37 * Copyright(c) 2016 Intel Deutschland GmbH
38 * All rights reserved.
39 *
40 * Redistribution and use in source and binary forms, with or without
41 * modification, are permitted provided that the following conditions
42 * are met:
43 *
44 * * Redistributions of source code must retain the above copyright
45 * notice, this list of conditions and the following disclaimer.
46 * * Redistributions in binary form must reproduce the above copyright
47 * notice, this list of conditions and the following disclaimer in
48 * the documentation and/or other materials provided with the
49 * distribution.
50 * * Neither the name Intel Corporation nor the names of its
51 * contributors may be used to endorse or promote products derived
52 * from this software without specific prior written permission.
53 *
54 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
55 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
56 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
57 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
58 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
59 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
60 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
61 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
62 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
63 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
64 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
65 *****************************************************************************/
66
67#ifndef __iwl_fw_file_h__
68#define __iwl_fw_file_h__
69
70#include <linux/netdevice.h>
71#include <linux/nl80211.h>
72
73/* v1/v2 uCode file layout */
74struct iwl_ucode_header {
75 __le32 ver; /* major/minor/API/serial */
76 union {
77 struct {
78 __le32 inst_size; /* bytes of runtime code */
79 __le32 data_size; /* bytes of runtime data */
80 __le32 init_size; /* bytes of init code */
81 __le32 init_data_size; /* bytes of init data */
82 __le32 boot_size; /* bytes of bootstrap code */
83 u8 data[0]; /* in same order as sizes */
84 } v1;
85 struct {
86 __le32 build; /* build number */
87 __le32 inst_size; /* bytes of runtime code */
88 __le32 data_size; /* bytes of runtime data */
89 __le32 init_size; /* bytes of init code */
90 __le32 init_data_size; /* bytes of init data */
91 __le32 boot_size; /* bytes of bootstrap code */
92 u8 data[0]; /* in same order as sizes */
93 } v2;
94 } u;
95};
96
97/*
98 * new TLV uCode file layout
99 *
100 * The new TLV file format contains TLVs, that each specify
101 * some piece of data.
102 */
103
104enum iwl_ucode_tlv_type {
105 IWL_UCODE_TLV_INVALID = 0, /* unused */
106 IWL_UCODE_TLV_INST = 1,
107 IWL_UCODE_TLV_DATA = 2,
108 IWL_UCODE_TLV_INIT = 3,
109 IWL_UCODE_TLV_INIT_DATA = 4,
110 IWL_UCODE_TLV_BOOT = 5,
111 IWL_UCODE_TLV_PROBE_MAX_LEN = 6, /* a u32 value */
112 IWL_UCODE_TLV_PAN = 7,
113 IWL_UCODE_TLV_RUNT_EVTLOG_PTR = 8,
114 IWL_UCODE_TLV_RUNT_EVTLOG_SIZE = 9,
115 IWL_UCODE_TLV_RUNT_ERRLOG_PTR = 10,
116 IWL_UCODE_TLV_INIT_EVTLOG_PTR = 11,
117 IWL_UCODE_TLV_INIT_EVTLOG_SIZE = 12,
118 IWL_UCODE_TLV_INIT_ERRLOG_PTR = 13,
119 IWL_UCODE_TLV_ENHANCE_SENS_TBL = 14,
120 IWL_UCODE_TLV_PHY_CALIBRATION_SIZE = 15,
121 IWL_UCODE_TLV_WOWLAN_INST = 16,
122 IWL_UCODE_TLV_WOWLAN_DATA = 17,
123 IWL_UCODE_TLV_FLAGS = 18,
124 IWL_UCODE_TLV_SEC_RT = 19,
125 IWL_UCODE_TLV_SEC_INIT = 20,
126 IWL_UCODE_TLV_SEC_WOWLAN = 21,
127 IWL_UCODE_TLV_DEF_CALIB = 22,
128 IWL_UCODE_TLV_PHY_SKU = 23,
129 IWL_UCODE_TLV_SECURE_SEC_RT = 24,
130 IWL_UCODE_TLV_SECURE_SEC_INIT = 25,
131 IWL_UCODE_TLV_SECURE_SEC_WOWLAN = 26,
132 IWL_UCODE_TLV_NUM_OF_CPU = 27,
133 IWL_UCODE_TLV_CSCHEME = 28,
134 IWL_UCODE_TLV_API_CHANGES_SET = 29,
135 IWL_UCODE_TLV_ENABLED_CAPABILITIES = 30,
136 IWL_UCODE_TLV_N_SCAN_CHANNELS = 31,
137 IWL_UCODE_TLV_PAGING = 32,
138 IWL_UCODE_TLV_SEC_RT_USNIFFER = 34,
139 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,
146};
147
148struct iwl_ucode_tlv {
149 __le32 type; /* see above */
150 __le32 length; /* not including type/length fields */
151 u8 data[0];
152};
153
154#define IWL_TLV_UCODE_MAGIC 0x0a4c5749
155#define FW_VER_HUMAN_READABLE_SZ 64
156
157struct iwl_tlv_ucode_header {
158 /*
159 * The TLV style ucode header is distinguished from
160 * the v1/v2 style header by first four bytes being
161 * zero, as such is an invalid combination of
162 * major/minor/API/serial versions.
163 */
164 __le32 zero;
165 __le32 magic;
166 u8 human_readable[FW_VER_HUMAN_READABLE_SZ];
167 /* major/minor/API/serial or major in new format */
168 __le32 ver;
169 __le32 build;
170 __le64 ignore;
171 /*
172 * The data contained herein has a TLV layout,
173 * see above for the TLV header and types.
174 * Note that each TLV is padded to a length
175 * that is a multiple of 4 for alignment.
176 */
177 u8 data[0];
178};
179
180/*
181 * ucode TLVs
182 *
183 * ability to get extension for: flags & capabilities from ucode binaries files
184 */
185struct iwl_ucode_api {
186 __le32 api_index;
187 __le32 api_flags;
188} __packed;
189
190struct iwl_ucode_capa {
191 __le32 api_index;
192 __le32 api_capa;
193} __packed;
194
195/**
196 * enum iwl_ucode_tlv_flag - ucode API flags
197 * @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously
198 * was a separate TLV but moved here to save space.
199 * @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behavior on hidden SSID,
200 * treats good CRC threshold as a boolean
201 * @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w).
202 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: This uCode image supports uAPSD
203 * @IWL_UCODE_TLV_FLAGS_SHORT_BL: 16 entries of black list instead of 64 in scan
204 * offload profile config command.
205 * @IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS: D3 image supports up to six
206 * (rather than two) IPv6 addresses
207 * @IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID: not sending a probe with the SSID element
208 * from the probe request template.
209 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL: new NS offload (small version)
210 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE: new NS offload (large version)
211 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: General support for uAPSD
212 * @IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD: P2P client supports uAPSD power save
213 * @IWL_UCODE_TLV_FLAGS_BCAST_FILTERING: uCode supports broadcast filtering.
214 * @IWL_UCODE_TLV_FLAGS_EBS_SUPPORT: this uCode image supports EBS.
215 */
216enum iwl_ucode_tlv_flag {
217 IWL_UCODE_TLV_FLAGS_PAN = BIT(0),
218 IWL_UCODE_TLV_FLAGS_NEWSCAN = BIT(1),
219 IWL_UCODE_TLV_FLAGS_MFP = BIT(2),
220 IWL_UCODE_TLV_FLAGS_SHORT_BL = BIT(7),
221 IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS = BIT(10),
222 IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID = BIT(12),
223 IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL = BIT(15),
224 IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE = BIT(16),
225 IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT = BIT(24),
226 IWL_UCODE_TLV_FLAGS_EBS_SUPPORT = BIT(25),
227 IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD = BIT(26),
228 IWL_UCODE_TLV_FLAGS_BCAST_FILTERING = BIT(29),
229};
230
231typedef unsigned int __bitwise iwl_ucode_tlv_api_t;
232
233/**
234 * enum iwl_ucode_tlv_api - ucode api
235 * @IWL_UCODE_TLV_API_FRAGMENTED_SCAN: This ucode supports active dwell time
236 * longer than the passive one, which is essential for fragmented scan.
237 * @IWL_UCODE_TLV_API_WIFI_MCC_UPDATE: ucode supports MCC updates with source.
238 * @IWL_UCODE_TLV_API_LQ_SS_PARAMS: Configure STBC/BFER via LQ CMD ss_params
239 * @IWL_UCODE_TLV_API_NEW_VERSION: new versioning format
240 * @IWL_UCODE_TLV_API_SCAN_TSF_REPORT: Scan start time reported in scan
241 * iteration complete notification, and the timestamp reported for RX
242 * received during scan, are reported in TSF of the mac specified in the
243 * scan request.
244 *
245 * @NUM_IWL_UCODE_TLV_API: number of bits used
246 */
247enum 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,
253
254 NUM_IWL_UCODE_TLV_API
255#ifdef __CHECKER__
256 /* sparse says it cannot increment the previous enum member */
257 = 128
258#endif
259};
260
261typedef unsigned int __bitwise iwl_ucode_tlv_capa_t;
262
263/**
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
273 * action frame
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
277 * probe requests.
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
293 * is supported.
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
313 * regular image.
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
319 * power reduction.
320 *
321 * @NUM_IWL_UCODE_TLV_CAPA: number of bits used
322 */
323enum 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,
362
363 NUM_IWL_UCODE_TLV_CAPA
364#ifdef __CHECKER__
365 /* sparse says it cannot increment the previous enum member */
366 = 128
367#endif
368};
369
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
374
375/* The default max probe length if not specified by the firmware file */
376#define IWL_DEFAULT_MAX_PROBE_LENGTH 200
377
378/*
379 * For 16.0 uCode and above, there is no differentiation between sections,
380 * just an offset to the HW address.
381 */
382#define IWL_UCODE_SECTION_MAX 16
383#define CPU1_CPU2_SEPARATOR_SECTION 0xFFFFCCCC
384#define PAGING_SEPARATOR_SECTION 0xAAAABBBB
385
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)
391
392/*
393 * Calibration control struct.
394 * Sent as part of the phy configuration command.
395 * @flow_trigger: bitmap for which calibrations to perform according to
396 * flow triggers.
397 * @event_trigger: bitmap for which calibrations to perform according to
398 * event triggers.
399 */
400struct iwl_tlv_calib_ctrl {
401 __le32 flow_trigger;
402 __le32 event_trigger;
403} __packed;
404
405enum 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,
416};
417
418#define IWL_UCODE_MAX_CS 1
419
420/**
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
432 */
433struct iwl_fw_cipher_scheme {
434 __le32 cipher;
435 u8 flags;
436 u8 hdr_len;
437 u8 pn_len;
438 u8 pn_off;
439 u8 key_idx_off;
440 u8 key_idx_mask;
441 u8 key_idx_shift;
442 u8 mic_len;
443 u8 hw_cipher;
444} __packed;
445
446enum iwl_fw_dbg_reg_operator {
447 CSR_ASSIGN,
448 CSR_SETBIT,
449 CSR_CLEARBIT,
450
451 PRPH_ASSIGN,
452 PRPH_SETBIT,
453 PRPH_CLEARBIT,
454
455 INDIRECT_ASSIGN,
456 INDIRECT_SETBIT,
457 INDIRECT_CLEARBIT,
458
459 PRPH_BLOCKBIT,
460};
461
462/**
463 * struct iwl_fw_dbg_reg_op - an operation on a register
464 *
465 * @op: %enum iwl_fw_dbg_reg_operator
466 * @addr: offset of the register
467 * @val: value
468 */
469struct iwl_fw_dbg_reg_op {
470 u8 op;
471 u8 reserved[3];
472 __le32 addr;
473 __le32 val;
474} __packed;
475
476/**
477 * enum iwl_fw_dbg_monitor_mode - available monitor recording modes
478 *
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
483 */
484enum iwl_fw_dbg_monitor_mode {
485 SMEM_MODE = 0,
486 EXTERNAL_MODE = 1,
487 MARBH_MODE = 2,
488 MIPI_MODE = 3,
489};
490
491/**
492 * enum iwl_fw_mem_seg_type - data types for dumping on error
493 *
494 * @FW_DBG_MEM_SMEM: the data type is SMEM
495 * @FW_DBG_MEM_DCCM_LMAC: the data type is DCCM_LMAC
496 * @FW_DBG_MEM_DCCM_UMAC: the data type is DCCM_UMAC
497 */
498enum iwl_fw_dbg_mem_seg_type {
499 FW_DBG_MEM_DCCM_LMAC = 0,
500 FW_DBG_MEM_DCCM_UMAC,
501 FW_DBG_MEM_SMEM,
502
503 /* Must be last */
504 FW_DBG_MEM_MAX,
505};
506
507/**
508 * struct iwl_fw_dbg_mem_seg_tlv - configures the debug data memory segments
509 *
510 * @data_type: enum %iwl_fw_mem_seg_type
511 * @ofs: the memory segment offset
512 * @len: the memory segment length, in bytes
513 *
514 * This parses IWL_UCODE_TLV_FW_MEM_SEG
515 */
516struct iwl_fw_dbg_mem_seg_tlv {
517 __le32 data_type;
518 __le32 ofs;
519 __le32 len;
520} __packed;
521
522/**
523 * struct iwl_fw_dbg_dest_tlv - configures the destination of the debug data
524 *
525 * @version: version of the TLV - currently 0
526 * @monitor_mode: %enum iwl_fw_dbg_monitor_mode
527 * @size_power: buffer size will be 2^(size_power + 11)
528 * @base_reg: addr of the base addr register (PRPH)
529 * @end_reg: addr of the end addr register (PRPH)
530 * @write_ptr_reg: the addr of the reg of the write pointer
531 * @wrap_count: the addr of the reg of the wrap_count
532 * @base_shift: shift right of the base addr reg
533 * @end_shift: shift right of the end addr reg
534 * @reg_ops: array of registers operations
535 *
536 * This parses IWL_UCODE_TLV_FW_DBG_DEST
537 */
538struct iwl_fw_dbg_dest_tlv {
539 u8 version;
540 u8 monitor_mode;
541 u8 size_power;
542 u8 reserved;
543 __le32 base_reg;
544 __le32 end_reg;
545 __le32 write_ptr_reg;
546 __le32 wrap_count;
547 u8 base_shift;
548 u8 end_shift;
549 struct iwl_fw_dbg_reg_op reg_ops[0];
550} __packed;
551
552struct iwl_fw_dbg_conf_hcmd {
553 u8 id;
554 u8 reserved;
555 __le16 len;
556 u8 data[0];
557} __packed;
558
559/**
560 * enum iwl_fw_dbg_trigger_mode - triggers functionalities
561 *
562 * @IWL_FW_DBG_TRIGGER_START: when trigger occurs re-conf the dbg mechanism
563 * @IWL_FW_DBG_TRIGGER_STOP: when trigger occurs pull the dbg data
564 * @IWL_FW_DBG_TRIGGER_MONITOR_ONLY: when trigger occurs trigger is set to
565 * collect only monitor data
566 */
567enum iwl_fw_dbg_trigger_mode {
568 IWL_FW_DBG_TRIGGER_START = BIT(0),
569 IWL_FW_DBG_TRIGGER_STOP = BIT(1),
570 IWL_FW_DBG_TRIGGER_MONITOR_ONLY = BIT(2),
571};
572
573/**
574 * enum iwl_fw_dbg_trigger_vif_type - define the VIF type for a trigger
575 * @IWL_FW_DBG_CONF_VIF_ANY: any vif type
576 * @IWL_FW_DBG_CONF_VIF_IBSS: IBSS mode
577 * @IWL_FW_DBG_CONF_VIF_STATION: BSS mode
578 * @IWL_FW_DBG_CONF_VIF_AP: AP mode
579 * @IWL_FW_DBG_CONF_VIF_P2P_CLIENT: P2P Client mode
580 * @IWL_FW_DBG_CONF_VIF_P2P_GO: P2P GO mode
581 * @IWL_FW_DBG_CONF_VIF_P2P_DEVICE: P2P device
582 */
583enum iwl_fw_dbg_trigger_vif_type {
584 IWL_FW_DBG_CONF_VIF_ANY = NL80211_IFTYPE_UNSPECIFIED,
585 IWL_FW_DBG_CONF_VIF_IBSS = NL80211_IFTYPE_ADHOC,
586 IWL_FW_DBG_CONF_VIF_STATION = NL80211_IFTYPE_STATION,
587 IWL_FW_DBG_CONF_VIF_AP = NL80211_IFTYPE_AP,
588 IWL_FW_DBG_CONF_VIF_P2P_CLIENT = NL80211_IFTYPE_P2P_CLIENT,
589 IWL_FW_DBG_CONF_VIF_P2P_GO = NL80211_IFTYPE_P2P_GO,
590 IWL_FW_DBG_CONF_VIF_P2P_DEVICE = NL80211_IFTYPE_P2P_DEVICE,
591};
592
593/**
594 * struct iwl_fw_dbg_trigger_tlv - a TLV that describes the trigger
595 * @id: %enum iwl_fw_dbg_trigger
596 * @vif_type: %enum iwl_fw_dbg_trigger_vif_type
597 * @stop_conf_ids: bitmap of configurations this trigger relates to.
598 * if the mode is %IWL_FW_DBG_TRIGGER_STOP, then if the bit corresponding
599 * to the currently running configuration is set, the data should be
600 * collected.
601 * @stop_delay: how many milliseconds to wait before collecting the data
602 * after the STOP trigger fires.
603 * @mode: %enum iwl_fw_dbg_trigger_mode - can be stop / start of both
604 * @start_conf_id: if mode is %IWL_FW_DBG_TRIGGER_START, this defines what
605 * configuration should be applied when the triggers kicks in.
606 * @occurrences: number of occurrences. 0 means the trigger will never fire.
607 * @trig_dis_ms: the time, in milliseconds, after an occurrence of this
608 * trigger in which another occurrence should be ignored.
609 */
610struct iwl_fw_dbg_trigger_tlv {
611 __le32 id;
612 __le32 vif_type;
613 __le32 stop_conf_ids;
614 __le32 stop_delay;
615 u8 mode;
616 u8 start_conf_id;
617 __le16 occurrences;
618 __le16 trig_dis_ms;
619 __le16 reserved[3];
620
621 u8 data[0];
622} __packed;
623
624#define FW_DBG_START_FROM_ALIVE 0
625#define FW_DBG_CONF_MAX 32
626#define FW_DBG_INVALID 0xff
627
628/**
629 * struct iwl_fw_dbg_trigger_missed_bcon - configures trigger for missed beacons
630 * @stop_consec_missed_bcon: stop recording if threshold is crossed.
631 * @stop_consec_missed_bcon_since_rx: stop recording if threshold is crossed.
632 * @start_consec_missed_bcon: start recording if threshold is crossed.
633 * @start_consec_missed_bcon_since_rx: start recording if threshold is crossed.
634 * @reserved1: reserved
635 * @reserved2: reserved
636 */
637struct iwl_fw_dbg_trigger_missed_bcon {
638 __le32 stop_consec_missed_bcon;
639 __le32 stop_consec_missed_bcon_since_rx;
640 __le32 reserved2[2];
641 __le32 start_consec_missed_bcon;
642 __le32 start_consec_missed_bcon_since_rx;
643 __le32 reserved1[2];
644} __packed;
645
646/**
647 * struct iwl_fw_dbg_trigger_cmd - configures trigger for messages from FW.
648 * cmds: the list of commands to trigger the collection on
649 */
650struct iwl_fw_dbg_trigger_cmd {
651 struct cmd {
652 u8 cmd_id;
653 u8 group_id;
654 } __packed cmds[16];
655} __packed;
656
657/**
658 * iwl_fw_dbg_trigger_stats - configures trigger for statistics
659 * @stop_offset: the offset of the value to be monitored
660 * @stop_threshold: the threshold above which to collect
661 * @start_offset: the offset of the value to be monitored
662 * @start_threshold: the threshold above which to start recording
663 */
664struct iwl_fw_dbg_trigger_stats {
665 __le32 stop_offset;
666 __le32 stop_threshold;
667 __le32 start_offset;
668 __le32 start_threshold;
669} __packed;
670
671/**
672 * struct iwl_fw_dbg_trigger_low_rssi - trigger for low beacon RSSI
673 * @rssi: RSSI value to trigger at
674 */
675struct iwl_fw_dbg_trigger_low_rssi {
676 __le32 rssi;
677} __packed;
678
679/**
680 * struct iwl_fw_dbg_trigger_mlme - configures trigger for mlme events
681 * @stop_auth_denied: number of denied authentication to collect
682 * @stop_auth_timeout: number of authentication timeout to collect
683 * @stop_rx_deauth: number of Rx deauth before to collect
684 * @stop_tx_deauth: number of Tx deauth before to collect
685 * @stop_assoc_denied: number of denied association to collect
686 * @stop_assoc_timeout: number of association timeout to collect
687 * @stop_connection_loss: number of connection loss to collect
688 * @start_auth_denied: number of denied authentication to start recording
689 * @start_auth_timeout: number of authentication timeout to start recording
690 * @start_rx_deauth: number of Rx deauth to start recording
691 * @start_tx_deauth: number of Tx deauth to start recording
692 * @start_assoc_denied: number of denied association to start recording
693 * @start_assoc_timeout: number of association timeout to start recording
694 * @start_connection_loss: number of connection loss to start recording
695 */
696struct iwl_fw_dbg_trigger_mlme {
697 u8 stop_auth_denied;
698 u8 stop_auth_timeout;
699 u8 stop_rx_deauth;
700 u8 stop_tx_deauth;
701
702 u8 stop_assoc_denied;
703 u8 stop_assoc_timeout;
704 u8 stop_connection_loss;
705 u8 reserved;
706
707 u8 start_auth_denied;
708 u8 start_auth_timeout;
709 u8 start_rx_deauth;
710 u8 start_tx_deauth;
711
712 u8 start_assoc_denied;
713 u8 start_assoc_timeout;
714 u8 start_connection_loss;
715 u8 reserved2;
716} __packed;
717
718/**
719 * struct iwl_fw_dbg_trigger_txq_timer - configures the Tx queue's timer
720 * @command_queue: timeout for the command queue in ms
721 * @bss: timeout for the queues of a BSS (except for TDLS queues) in ms
722 * @softap: timeout for the queues of a softAP in ms
723 * @p2p_go: timeout for the queues of a P2P GO in ms
724 * @p2p_client: timeout for the queues of a P2P client in ms
725 * @p2p_device: timeout for the queues of a P2P device in ms
726 * @ibss: timeout for the queues of an IBSS in ms
727 * @tdls: timeout for the queues of a TDLS station in ms
728 */
729struct iwl_fw_dbg_trigger_txq_timer {
730 __le32 command_queue;
731 __le32 bss;
732 __le32 softap;
733 __le32 p2p_go;
734 __le32 p2p_client;
735 __le32 p2p_device;
736 __le32 ibss;
737 __le32 tdls;
738 __le32 reserved[4];
739} __packed;
740
741/**
742 * struct iwl_fw_dbg_trigger_time_event - configures a time event trigger
743 * time_Events: a list of tuples <id, action_bitmap>. The driver will issue a
744 * trigger each time a time event notification that relates to time event
745 * id with one of the actions in the bitmap is received and
746 * BIT(notif->status) is set in status_bitmap.
747 *
748 */
749struct iwl_fw_dbg_trigger_time_event {
750 struct {
751 __le32 id;
752 __le32 action_bitmap;
753 __le32 status_bitmap;
754 } __packed time_events[16];
755} __packed;
756
757/**
758 * struct iwl_fw_dbg_trigger_ba - configures BlockAck related trigger
759 * rx_ba_start: tid bitmap to configure on what tid the trigger should occur
760 * when an Rx BlockAck session is started.
761 * rx_ba_stop: tid bitmap to configure on what tid the trigger should occur
762 * when an Rx BlockAck session is stopped.
763 * tx_ba_start: tid bitmap to configure on what tid the trigger should occur
764 * when a Tx BlockAck session is started.
765 * tx_ba_stop: tid bitmap to configure on what tid the trigger should occur
766 * when a Tx BlockAck session is stopped.
767 * rx_bar: tid bitmap to configure on what tid the trigger should occur
768 * when a BAR is received (for a Tx BlockAck session).
769 * tx_bar: tid bitmap to configure on what tid the trigger should occur
770 * when a BAR is send (for an Rx BlocAck session).
771 * frame_timeout: tid bitmap to configure on what tid the trigger should occur
772 * when a frame times out in the reodering buffer.
773 */
774struct iwl_fw_dbg_trigger_ba {
775 __le16 rx_ba_start;
776 __le16 rx_ba_stop;
777 __le16 tx_ba_start;
778 __le16 tx_ba_stop;
779 __le16 rx_bar;
780 __le16 tx_bar;
781 __le16 frame_timeout;
782} __packed;
783
784/**
785 * struct iwl_fw_dbg_trigger_tdls - configures trigger for TDLS events.
786 * @action_bitmap: the TDLS action to trigger the collection upon
787 * @peer_mode: trigger on specific peer or all
788 * @peer: the TDLS peer to trigger the collection on
789 */
790struct iwl_fw_dbg_trigger_tdls {
791 u8 action_bitmap;
792 u8 peer_mode;
793 u8 peer[ETH_ALEN];
794 u8 reserved[4];
795} __packed;
796
797/**
798 * struct iwl_fw_dbg_trigger_tx_status - configures trigger for tx response
799 * status.
800 * @statuses: the list of statuses to trigger the collection on
801 */
802struct iwl_fw_dbg_trigger_tx_status {
803 struct tx_status {
804 u8 status;
805 u8 reserved[3];
806 } __packed statuses[16];
807 __le32 reserved[2];
808} __packed;
809
810/**
811 * struct iwl_fw_dbg_conf_tlv - a TLV that describes a debug configuration.
812 * @id: conf id
813 * @usniffer: should the uSniffer image be used
814 * @num_of_hcmds: how many HCMDs to send are present here
815 * @hcmd: a variable length host command to be sent to apply the configuration.
816 * If there is more than one HCMD to send, they will appear one after the
817 * other and be sent in the order that they appear in.
818 * This parses IWL_UCODE_TLV_FW_DBG_CONF. The user can add up-to
819 * %FW_DBG_CONF_MAX configuration per run.
820 */
821struct iwl_fw_dbg_conf_tlv {
822 u8 id;
823 u8 usniffer;
824 u8 reserved;
825 u8 num_of_hcmds;
826 struct iwl_fw_dbg_conf_hcmd hcmd;
827} __packed;
828
829/**
830 * struct iwl_fw_gscan_capabilities - gscan capabilities supported by FW
831 * @max_scan_cache_size: total space allocated for scan results (in bytes).
832 * @max_scan_buckets: maximum number of channel buckets.
833 * @max_ap_cache_per_scan: maximum number of APs that can be stored per scan.
834 * @max_rssi_sample_size: number of RSSI samples used for averaging RSSI.
835 * @max_scan_reporting_threshold: max possible report threshold. in percentage.
836 * @max_hotlist_aps: maximum number of entries for hotlist APs.
837 * @max_significant_change_aps: maximum number of entries for significant
838 * change APs.
839 * @max_bssid_history_entries: number of BSSID/RSSI entries that the device can
840 * hold.
841 * @max_hotlist_ssids: maximum number of entries for hotlist SSIDs.
842 * @max_number_epno_networks: max number of epno entries.
843 * @max_number_epno_networks_by_ssid: max number of epno entries if ssid is
844 * specified.
845 * @max_number_of_white_listed_ssid: max number of white listed SSIDs.
846 * @max_number_of_black_listed_ssid: max number of black listed SSIDs.
847 */
848struct iwl_fw_gscan_capabilities {
849 __le32 max_scan_cache_size;
850 __le32 max_scan_buckets;
851 __le32 max_ap_cache_per_scan;
852 __le32 max_rssi_sample_size;
853 __le32 max_scan_reporting_threshold;
854 __le32 max_hotlist_aps;
855 __le32 max_significant_change_aps;
856 __le32 max_bssid_history_entries;
857 __le32 max_hotlist_ssids;
858 __le32 max_number_epno_networks;
859 __le32 max_number_epno_networks_by_ssid;
860 __le32 max_number_of_white_listed_ssid;
861 __le32 max_number_of_black_listed_ssid;
862} __packed;
863
864#endif /* __iwl_fw_file_h__ */