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 - 2014 Intel Mobile Communications GmbH
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of version 2 of the GNU General Public License as
13 * published by the Free Software Foundation.
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
25 * The full GNU General Public License is included in this distribution
26 * in the file called COPYING.
28 * Contact Information:
29 * Intel Linux Wireless <ilw@linux.intel.com>
30 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
34 * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
35 * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
36 * All rights reserved.
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
42 * * Redistributions of source code must retain the above copyright
43 * notice, this list of conditions and the following disclaimer.
44 * * Redistributions in binary form must reproduce the above copyright
45 * notice, this list of conditions and the following disclaimer in
46 * the documentation and/or other materials provided with the
48 * * Neither the name Intel Corporation nor the names of its
49 * contributors may be used to endorse or promote products derived
50 * from this software without specific prior written permission.
52 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
53 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
54 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
55 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
56 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
57 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
58 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
59 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
60 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
61 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
62 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
63 *****************************************************************************/
65 #ifndef __iwl_fw_file_h__
66 #define __iwl_fw_file_h__
68 #include <linux/netdevice.h>
70 /* v1/v2 uCode file layout */
71 struct iwl_ucode_header {
72 __le32 ver; /* major/minor/API/serial */
75 __le32 inst_size; /* bytes of runtime code */
76 __le32 data_size; /* bytes of runtime data */
77 __le32 init_size; /* bytes of init code */
78 __le32 init_data_size; /* bytes of init data */
79 __le32 boot_size; /* bytes of bootstrap code */
80 u8 data[0]; /* in same order as sizes */
83 __le32 build; /* build number */
84 __le32 inst_size; /* bytes of runtime code */
85 __le32 data_size; /* bytes of runtime data */
86 __le32 init_size; /* bytes of init code */
87 __le32 init_data_size; /* bytes of init data */
88 __le32 boot_size; /* bytes of bootstrap code */
89 u8 data[0]; /* in same order as sizes */
95 * new TLV uCode file layout
97 * The new TLV file format contains TLVs, that each specify
101 enum iwl_ucode_tlv_type {
102 IWL_UCODE_TLV_INVALID = 0, /* unused */
103 IWL_UCODE_TLV_INST = 1,
104 IWL_UCODE_TLV_DATA = 2,
105 IWL_UCODE_TLV_INIT = 3,
106 IWL_UCODE_TLV_INIT_DATA = 4,
107 IWL_UCODE_TLV_BOOT = 5,
108 IWL_UCODE_TLV_PROBE_MAX_LEN = 6, /* a u32 value */
109 IWL_UCODE_TLV_PAN = 7,
110 IWL_UCODE_TLV_RUNT_EVTLOG_PTR = 8,
111 IWL_UCODE_TLV_RUNT_EVTLOG_SIZE = 9,
112 IWL_UCODE_TLV_RUNT_ERRLOG_PTR = 10,
113 IWL_UCODE_TLV_INIT_EVTLOG_PTR = 11,
114 IWL_UCODE_TLV_INIT_EVTLOG_SIZE = 12,
115 IWL_UCODE_TLV_INIT_ERRLOG_PTR = 13,
116 IWL_UCODE_TLV_ENHANCE_SENS_TBL = 14,
117 IWL_UCODE_TLV_PHY_CALIBRATION_SIZE = 15,
118 IWL_UCODE_TLV_WOWLAN_INST = 16,
119 IWL_UCODE_TLV_WOWLAN_DATA = 17,
120 IWL_UCODE_TLV_FLAGS = 18,
121 IWL_UCODE_TLV_SEC_RT = 19,
122 IWL_UCODE_TLV_SEC_INIT = 20,
123 IWL_UCODE_TLV_SEC_WOWLAN = 21,
124 IWL_UCODE_TLV_DEF_CALIB = 22,
125 IWL_UCODE_TLV_PHY_SKU = 23,
126 IWL_UCODE_TLV_SECURE_SEC_RT = 24,
127 IWL_UCODE_TLV_SECURE_SEC_INIT = 25,
128 IWL_UCODE_TLV_SECURE_SEC_WOWLAN = 26,
129 IWL_UCODE_TLV_NUM_OF_CPU = 27,
130 IWL_UCODE_TLV_CSCHEME = 28,
131 IWL_UCODE_TLV_API_CHANGES_SET = 29,
132 IWL_UCODE_TLV_ENABLED_CAPABILITIES = 30,
133 IWL_UCODE_TLV_N_SCAN_CHANNELS = 31,
134 IWL_UCODE_TLV_SEC_RT_USNIFFER = 34,
135 IWL_UCODE_TLV_SDIO_ADMA_ADDR = 35,
136 IWL_UCODE_TLV_FW_DBG_DEST = 38,
137 IWL_UCODE_TLV_FW_DBG_CONF = 39,
140 struct iwl_ucode_tlv {
141 __le32 type; /* see above */
142 __le32 length; /* not including type/length fields */
146 #define IWL_TLV_UCODE_MAGIC 0x0a4c5749
147 #define FW_VER_HUMAN_READABLE_SZ 64
149 struct iwl_tlv_ucode_header {
151 * The TLV style ucode header is distinguished from
152 * the v1/v2 style header by first four bytes being
153 * zero, as such is an invalid combination of
154 * major/minor/API/serial versions.
158 u8 human_readable[FW_VER_HUMAN_READABLE_SZ];
159 __le32 ver; /* major/minor/API/serial */
163 * The data contained herein has a TLV layout,
164 * see above for the TLV header and types.
165 * Note that each TLV is padded to a length
166 * that is a multiple of 4 for alignment.
174 * ability to get extension for: flags & capabilities from ucode binaries files
176 struct iwl_ucode_api {
181 struct iwl_ucode_capa {
187 * enum iwl_ucode_tlv_flag - ucode API flags
188 * @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously
189 * was a separate TLV but moved here to save space.
190 * @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behaviour on hidden SSID,
191 * treats good CRC threshold as a boolean
192 * @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w).
193 * @IWL_UCODE_TLV_FLAGS_P2P: This uCode image supports P2P.
194 * @IWL_UCODE_TLV_FLAGS_DW_BC_TABLE: The SCD byte count table is in DWORDS
195 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: This uCode image supports uAPSD
196 * @IWL_UCODE_TLV_FLAGS_SHORT_BL: 16 entries of black list instead of 64 in scan
197 * offload profile config command.
198 * @IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS: D3 image supports up to six
199 * (rather than two) IPv6 addresses
200 * @IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID: not sending a probe with the SSID element
201 * from the probe request template.
202 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL: new NS offload (small version)
203 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE: new NS offload (large version)
204 * @IWL_UCODE_TLV_FLAGS_P2P_PM: P2P client supports PM as a stand alone MAC
205 * @IWL_UCODE_TLV_FLAGS_P2P_BSS_PS_DCM: support power save on BSS station and
206 * P2P client interfaces simultaneously if they are in different bindings.
207 * @IWL_UCODE_TLV_FLAGS_P2P_BSS_PS_SCM: support power save on BSS station and
208 * P2P client interfaces simultaneously if they are in same bindings.
209 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: General support for uAPSD
210 * @IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD: P2P client supports uAPSD power save
211 * @IWL_UCODE_TLV_FLAGS_BCAST_FILTERING: uCode supports broadcast filtering.
212 * @IWL_UCODE_TLV_FLAGS_GO_UAPSD: AP/GO interfaces support uAPSD clients
213 * @IWL_UCODE_TLV_FLAGS_EBS_SUPPORT: this uCode image supports EBS.
215 enum iwl_ucode_tlv_flag {
216 IWL_UCODE_TLV_FLAGS_PAN = BIT(0),
217 IWL_UCODE_TLV_FLAGS_NEWSCAN = BIT(1),
218 IWL_UCODE_TLV_FLAGS_MFP = BIT(2),
219 IWL_UCODE_TLV_FLAGS_P2P = BIT(3),
220 IWL_UCODE_TLV_FLAGS_DW_BC_TABLE = BIT(4),
221 IWL_UCODE_TLV_FLAGS_SHORT_BL = BIT(7),
222 IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS = BIT(10),
223 IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID = BIT(12),
224 IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL = BIT(15),
225 IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE = BIT(16),
226 IWL_UCODE_TLV_FLAGS_P2P_PM = BIT(21),
227 IWL_UCODE_TLV_FLAGS_BSS_P2P_PS_DCM = BIT(22),
228 IWL_UCODE_TLV_FLAGS_BSS_P2P_PS_SCM = BIT(23),
229 IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT = BIT(24),
230 IWL_UCODE_TLV_FLAGS_EBS_SUPPORT = BIT(25),
231 IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD = BIT(26),
232 IWL_UCODE_TLV_FLAGS_BCAST_FILTERING = BIT(29),
233 IWL_UCODE_TLV_FLAGS_GO_UAPSD = BIT(30),
237 * enum iwl_ucode_tlv_api - ucode api
238 * @IWL_UCODE_TLV_API_BT_COEX_SPLIT: new API for BT Coex
239 * @IWL_UCODE_TLV_API_DISABLE_STA_TX: ucode supports tx_disable bit.
240 * @IWL_UCODE_TLV_API_LMAC_SCAN: This ucode uses LMAC unified scan API.
241 * @IWL_UCODE_TLV_API_SF_NO_DUMMY_NOTIF: ucode supports disabling dummy notif.
242 * @IWL_UCODE_TLV_API_FRAGMENTED_SCAN: This ucode supports active dwell time
243 * longer than the passive one, which is essential for fragmented scan.
244 * IWL_UCODE_TLV_API_HDC_PHASE_0: ucode supports finer configuration of LTR
245 * @IWL_UCODE_TLV_API_BASIC_DWELL: use only basic dwell time in scan command,
246 * regardless of the band or the number of the probes. FW will calculate
247 * the actual dwell time.
248 * @IWL_UCODE_TLV_API_SCD_CFG: This firmware can configure the scheduler
249 * through the dedicated host command.
250 * @IWL_UCODE_TLV_API_SINGLE_SCAN_EBS: EBS is supported for single scans too.
251 * @IWL_UCODE_TLV_API_ASYNC_DTM: Async temperature notifications are supported.
253 enum iwl_ucode_tlv_api {
254 IWL_UCODE_TLV_API_BT_COEX_SPLIT = BIT(3),
255 IWL_UCODE_TLV_API_DISABLE_STA_TX = BIT(5),
256 IWL_UCODE_TLV_API_LMAC_SCAN = BIT(6),
257 IWL_UCODE_TLV_API_SF_NO_DUMMY_NOTIF = BIT(7),
258 IWL_UCODE_TLV_API_FRAGMENTED_SCAN = BIT(8),
259 IWL_UCODE_TLV_API_HDC_PHASE_0 = BIT(10),
260 IWL_UCODE_TLV_API_BASIC_DWELL = BIT(13),
261 IWL_UCODE_TLV_API_SCD_CFG = BIT(15),
262 IWL_UCODE_TLV_API_SINGLE_SCAN_EBS = BIT(16),
263 IWL_UCODE_TLV_API_ASYNC_DTM = BIT(17),
267 * enum iwl_ucode_tlv_capa - ucode capabilities
268 * @IWL_UCODE_TLV_CAPA_D0I3_SUPPORT: supports D0i3
269 * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT: supports Location Aware Regulatory
270 * @IWL_UCODE_TLV_CAPA_UMAC_SCAN: supports UMAC scan.
271 * @IWL_UCODE_TLV_CAPA_TDLS_SUPPORT: support basic TDLS functionality
272 * @IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT: supports insertion of current
273 * tx power value into TPC Report action frame and Link Measurement Report
275 * @IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT: supports updating current
276 * channel in DS parameter set element in probe requests.
277 * @IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT: supports adding TPC Report IE in
279 * @IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT: supports Quiet Period requests
280 * @IWL_UCODE_TLV_CAPA_DQA_SUPPORT: supports dynamic queue allocation (DQA),
281 * which also implies support for the scheduler configuration command
282 * @IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH: supports TDLS channel switching
283 * @IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT: supports Hot Spot Command
285 enum iwl_ucode_tlv_capa {
286 IWL_UCODE_TLV_CAPA_D0I3_SUPPORT = BIT(0),
287 IWL_UCODE_TLV_CAPA_LAR_SUPPORT = BIT(1),
288 IWL_UCODE_TLV_CAPA_UMAC_SCAN = BIT(2),
289 IWL_UCODE_TLV_CAPA_TDLS_SUPPORT = BIT(6),
290 IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT = BIT(8),
291 IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT = BIT(9),
292 IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT = BIT(10),
293 IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT = BIT(11),
294 IWL_UCODE_TLV_CAPA_DQA_SUPPORT = BIT(12),
295 IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH = BIT(13),
296 IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT = BIT(18),
299 /* The default calibrate table size if not specified by firmware file */
300 #define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE 18
301 #define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE 19
302 #define IWL_MAX_PHY_CALIBRATE_TBL_SIZE 253
304 /* The default max probe length if not specified by the firmware file */
305 #define IWL_DEFAULT_MAX_PROBE_LENGTH 200
308 * For 16.0 uCode and above, there is no differentiation between sections,
309 * just an offset to the HW address.
311 #define IWL_UCODE_SECTION_MAX 12
312 #define IWL_API_ARRAY_SIZE 1
313 #define IWL_CAPABILITIES_ARRAY_SIZE 1
314 #define CPU1_CPU2_SEPARATOR_SECTION 0xFFFFCCCC
316 /* uCode version contains 4 values: Major/Minor/API/Serial */
317 #define IWL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24)
318 #define IWL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16)
319 #define IWL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8)
320 #define IWL_UCODE_SERIAL(ver) ((ver) & 0x000000FF)
323 * Calibration control struct.
324 * Sent as part of the phy configuration command.
325 * @flow_trigger: bitmap for which calibrations to perform according to
327 * @event_trigger: bitmap for which calibrations to perform according to
330 struct iwl_tlv_calib_ctrl {
332 __le32 event_trigger;
335 enum iwl_fw_phy_cfg {
336 FW_PHY_CFG_RADIO_TYPE_POS = 0,
337 FW_PHY_CFG_RADIO_TYPE = 0x3 << FW_PHY_CFG_RADIO_TYPE_POS,
338 FW_PHY_CFG_RADIO_STEP_POS = 2,
339 FW_PHY_CFG_RADIO_STEP = 0x3 << FW_PHY_CFG_RADIO_STEP_POS,
340 FW_PHY_CFG_RADIO_DASH_POS = 4,
341 FW_PHY_CFG_RADIO_DASH = 0x3 << FW_PHY_CFG_RADIO_DASH_POS,
342 FW_PHY_CFG_TX_CHAIN_POS = 16,
343 FW_PHY_CFG_TX_CHAIN = 0xf << FW_PHY_CFG_TX_CHAIN_POS,
344 FW_PHY_CFG_RX_CHAIN_POS = 20,
345 FW_PHY_CFG_RX_CHAIN = 0xf << FW_PHY_CFG_RX_CHAIN_POS,
348 #define IWL_UCODE_MAX_CS 1
351 * struct iwl_fw_cipher_scheme - a cipher scheme supported by FW.
352 * @cipher: a cipher suite selector
353 * @flags: cipher scheme flags (currently reserved for a future use)
354 * @hdr_len: a size of MPDU security header
355 * @pn_len: a size of PN
356 * @pn_off: an offset of pn from the beginning of the security header
357 * @key_idx_off: an offset of key index byte in the security header
358 * @key_idx_mask: a bit mask of key_idx bits
359 * @key_idx_shift: bit shift needed to get key_idx
360 * @mic_len: mic length in bytes
361 * @hw_cipher: a HW cipher index used in host commands
363 struct iwl_fw_cipher_scheme {
376 enum iwl_fw_dbg_reg_operator {
387 * struct iwl_fw_dbg_reg_op - an operation on a register
389 * @op: %enum iwl_fw_dbg_reg_operator
390 * @addr: offset of the register
393 struct iwl_fw_dbg_reg_op {
401 * enum iwl_fw_dbg_monitor_mode - available monitor recording modes
403 * @SMEM_MODE: monitor stores the data in SMEM
404 * @EXTERNAL_MODE: monitor stores the data in allocated DRAM
405 * @MARBH_MODE: monitor stores the data in MARBH buffer
407 enum iwl_fw_dbg_monitor_mode {
414 * struct iwl_fw_dbg_dest_tlv - configures the destination of the debug data
416 * @version: version of the TLV - currently 0
417 * @monitor_mode: %enum iwl_fw_dbg_monitor_mode
418 * @base_reg: addr of the base addr register (PRPH)
419 * @end_reg: addr of the end addr register (PRPH)
420 * @write_ptr_reg: the addr of the reg of the write pointer
421 * @wrap_count: the addr of the reg of the wrap_count
422 * @base_shift: shift right of the base addr reg
423 * @end_shift: shift right of the end addr reg
424 * @reg_ops: array of registers operations
426 * This parses IWL_UCODE_TLV_FW_DBG_DEST
428 struct iwl_fw_dbg_dest_tlv {
434 __le32 write_ptr_reg;
438 struct iwl_fw_dbg_reg_op reg_ops[0];
441 struct iwl_fw_dbg_conf_hcmd {
449 * struct iwl_fw_dbg_trigger - a TLV that describes a debug configuration
451 * @enabled: is this trigger enabled
453 * @len: length, in bytes, of the %trigger field
454 * @trigger: pointer to a trigger struct
456 struct iwl_fw_dbg_trigger {
464 * enum iwl_fw_dbg_conf - configurations available
466 * @FW_DBG_CUSTOM: take this configuration from alive
467 * Note that the trigger is NO-OP for this configuration
469 enum iwl_fw_dbg_conf {
474 FW_DBG_INVALID = 0xff,
478 * struct iwl_fw_dbg_conf_tlv - a TLV that describes a debug configuration
480 * @id: %enum iwl_fw_dbg_conf
481 * @usniffer: should the uSniffer image be used
482 * @num_of_hcmds: how many HCMDs to send are present here
483 * @hcmd: a variable length host command to be sent to apply the configuration.
484 * If there is more than one HCMD to send, they will appear one after the
485 * other and be sent in the order that they appear in.
486 * This parses IWL_UCODE_TLV_FW_DBG_CONF
488 struct iwl_fw_dbg_conf_tlv {
493 struct iwl_fw_dbg_conf_hcmd hcmd;
495 /* struct iwl_fw_dbg_trigger sits after all variable length hcmds */
498 #endif /* __iwl_fw_file_h__ */