blob: b998aaf5efd1a6b9fa60d2d46bc1a6a1909d2bb4 [file] [log] [blame]
Don Fryedf38332012-01-25 16:18:52 -08001/******************************************************************************
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 *
Emmanuel Grumbach51368bf2013-12-30 13:15:54 +02008 * Copyright(c) 2008 - 2014 Intel Corporation. All rights reserved.
Johannes Berg8b4139d2014-07-24 14:05:26 +02009 * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
Don Fryedf38332012-01-25 16:18:52 -080010 *
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.
14 *
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.
19 *
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,
23 * USA
24 *
25 * The full GNU General Public License is included in this distribution
Emmanuel Grumbach410dc5a2013-02-18 09:22:28 +020026 * in the file called COPYING.
Don Fryedf38332012-01-25 16:18:52 -080027 *
28 * Contact Information:
29 * Intel Linux Wireless <ilw@linux.intel.com>
30 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
31 *
32 * BSD LICENSE
33 *
Emmanuel Grumbach51368bf2013-12-30 13:15:54 +020034 * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
Johannes Berg8b4139d2014-07-24 14:05:26 +020035 * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
Don Fryedf38332012-01-25 16:18:52 -080036 * All rights reserved.
37 *
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
40 * are met:
41 *
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
47 * distribution.
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.
51 *
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 *****************************************************************************/
64
Johannes Berg3995dea2012-03-06 13:30:44 -080065#ifndef __iwl_fw_file_h__
66#define __iwl_fw_file_h__
Don Fryedf38332012-01-25 16:18:52 -080067
Don Fryb1c23d92012-02-07 14:45:58 -080068#include <linux/netdevice.h>
69
Don Fryedf38332012-01-25 16:18:52 -080070/* v1/v2 uCode file layout */
71struct iwl_ucode_header {
72 __le32 ver; /* major/minor/API/serial */
73 union {
74 struct {
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 */
81 } v1;
82 struct {
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 */
90 } v2;
91 } u;
92};
93
94/*
95 * new TLV uCode file layout
96 *
97 * The new TLV file format contains TLVs, that each specify
Johannes Berg0479c192012-03-09 09:16:35 +010098 * some piece of data.
Don Fryedf38332012-01-25 16:18:52 -080099 */
100
101enum 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,
David Spinadeled8c8362012-03-10 13:00:13 -0800121 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,
Eran Hararye2d6f4e2013-10-02 13:53:40 +0300126 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,
Max Stepanove36e5432013-08-27 19:56:13 +0300130 IWL_UCODE_TLV_CSCHEME = 28,
Eran Hararya2978b12014-02-20 11:00:01 +0200131 IWL_UCODE_TLV_API_CHANGES_SET = 29,
132 IWL_UCODE_TLV_ENABLED_CAPABILITIES = 30,
David Spinadel762533b2014-06-05 11:20:43 +0300133 IWL_UCODE_TLV_N_SCAN_CHANNELS = 31,
Eran Harary61df7502014-12-01 17:40:37 +0200134 IWL_UCODE_TLV_SEC_RT_USNIFFER = 34,
Liad Kaufmanb4821762014-10-19 16:58:15 +0200135 IWL_UCODE_TLV_SDIO_ADMA_ADDR = 35,
Liad Kaufman490fefe2014-09-16 15:06:54 +0300136 IWL_UCODE_TLV_FW_DBG_DEST = 38,
137 IWL_UCODE_TLV_FW_DBG_CONF = 39,
Don Fryedf38332012-01-25 16:18:52 -0800138};
139
Don Fryedf38332012-01-25 16:18:52 -0800140struct iwl_ucode_tlv {
Johannes Berg0479c192012-03-09 09:16:35 +0100141 __le32 type; /* see above */
Don Fryedf38332012-01-25 16:18:52 -0800142 __le32 length; /* not including type/length fields */
143 u8 data[0];
144};
145
Emmanuel Grumbach06ddbf52014-06-02 08:34:53 +0300146#define IWL_TLV_UCODE_MAGIC 0x0a4c5749
147#define FW_VER_HUMAN_READABLE_SZ 64
Don Fryedf38332012-01-25 16:18:52 -0800148
149struct iwl_tlv_ucode_header {
150 /*
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.
155 */
156 __le32 zero;
157 __le32 magic;
Emmanuel Grumbach06ddbf52014-06-02 08:34:53 +0300158 u8 human_readable[FW_VER_HUMAN_READABLE_SZ];
Don Fryedf38332012-01-25 16:18:52 -0800159 __le32 ver; /* major/minor/API/serial */
160 __le32 build;
Johannes Berg0479c192012-03-09 09:16:35 +0100161 __le64 ignore;
Don Fryedf38332012-01-25 16:18:52 -0800162 /*
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.
167 */
168 u8 data[0];
169};
170
Eran Hararya2978b12014-02-20 11:00:01 +0200171/*
172 * ucode TLVs
173 *
174 * ability to get extension for: flags & capabilities from ucode binaries files
175 */
176struct iwl_ucode_api {
177 __le32 api_index;
178 __le32 api_flags;
179} __packed;
180
181struct iwl_ucode_capa {
182 __le32 api_index;
183 __le32 api_capa;
184} __packed;
185
Johannes Berga52703b2014-11-19 10:09:00 +0100186/**
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.
214 */
215enum 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),
234};
235
236/**
237 * enum iwl_ucode_tlv_api - ucode api
Johannes Berga52703b2014-11-19 10:09:00 +0100238 * @IWL_UCODE_TLV_API_BT_COEX_SPLIT: new API for BT Coex
Johannes Berga52703b2014-11-19 10:09:00 +0100239 * @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.
Emmanuel Grumbach84bfffa2015-01-13 10:16:30 +0200244 * IWL_UCODE_TLV_API_HDC_PHASE_0: ucode supports finer configuration of LTR
David Spinadel3cae0732014-12-29 15:43:48 +0200245 * @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.
Emmanuel Grumbach0294d9e2015-01-05 16:52:55 +0200248 * @IWL_UCODE_TLV_API_SCD_CFG: This firmware can configure the scheduler
249 * through the dedicated host command.
David Spinadel1f9c4182014-12-01 23:30:07 +0200250 * @IWL_UCODE_TLV_API_SINGLE_SCAN_EBS: EBS is supported for single scans too.
Luciano Coelho57d7b6a2015-01-14 21:39:34 +0200251 * @IWL_UCODE_TLV_API_ASYNC_DTM: Async temperature notifications are supported.
Johannes Berga52703b2014-11-19 10:09:00 +0100252 */
253enum iwl_ucode_tlv_api {
Johannes Berga52703b2014-11-19 10:09:00 +0100254 IWL_UCODE_TLV_API_BT_COEX_SPLIT = BIT(3),
Johannes Berga52703b2014-11-19 10:09:00 +0100255 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),
Emmanuel Grumbach84bfffa2015-01-13 10:16:30 +0200259 IWL_UCODE_TLV_API_HDC_PHASE_0 = BIT(10),
David Spinadel3cae0732014-12-29 15:43:48 +0200260 IWL_UCODE_TLV_API_BASIC_DWELL = BIT(13),
Emmanuel Grumbach0294d9e2015-01-05 16:52:55 +0200261 IWL_UCODE_TLV_API_SCD_CFG = BIT(15),
David Spinadel1f9c4182014-12-01 23:30:07 +0200262 IWL_UCODE_TLV_API_SINGLE_SCAN_EBS = BIT(16),
Luciano Coelho57d7b6a2015-01-14 21:39:34 +0200263 IWL_UCODE_TLV_API_ASYNC_DTM = BIT(17),
Johannes Berga52703b2014-11-19 10:09:00 +0100264};
265
266/**
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
274 * action frame
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
278 * probe requests.
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
284 */
285enum 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),
297};
298
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
303
304/* The default max probe length if not specified by the firmware file */
305#define IWL_DEFAULT_MAX_PROBE_LENGTH 200
306
307/*
308 * For 16.0 uCode and above, there is no differentiation between sections,
309 * just an offset to the HW address.
310 */
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
315
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)
321
322/*
323 * Calibration control struct.
324 * Sent as part of the phy configuration command.
325 * @flow_trigger: bitmap for which calibrations to perform according to
326 * flow triggers.
327 * @event_trigger: bitmap for which calibrations to perform according to
328 * event triggers.
329 */
330struct iwl_tlv_calib_ctrl {
331 __le32 flow_trigger;
332 __le32 event_trigger;
333} __packed;
334
335enum 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,
346};
347
348#define IWL_UCODE_MAX_CS 1
349
350/**
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
362 */
363struct iwl_fw_cipher_scheme {
364 __le32 cipher;
365 u8 flags;
366 u8 hdr_len;
367 u8 pn_len;
368 u8 pn_off;
369 u8 key_idx_off;
370 u8 key_idx_mask;
371 u8 key_idx_shift;
372 u8 mic_len;
373 u8 hw_cipher;
374} __packed;
375
Liad Kaufman490fefe2014-09-16 15:06:54 +0300376enum iwl_fw_dbg_reg_operator {
377 CSR_ASSIGN,
378 CSR_SETBIT,
379 CSR_CLEARBIT,
380
381 PRPH_ASSIGN,
382 PRPH_SETBIT,
383 PRPH_CLEARBIT,
384};
385
386/**
387 * struct iwl_fw_dbg_reg_op - an operation on a register
388 *
389 * @op: %enum iwl_fw_dbg_reg_operator
390 * @addr: offset of the register
391 * @val: value
392 */
393struct iwl_fw_dbg_reg_op {
394 u8 op;
395 u8 reserved[3];
396 __le32 addr;
397 __le32 val;
398} __packed;
399
400/**
401 * enum iwl_fw_dbg_monitor_mode - available monitor recording modes
402 *
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
406 */
407enum iwl_fw_dbg_monitor_mode {
408 SMEM_MODE = 0,
409 EXTERNAL_MODE = 1,
410 MARBH_MODE = 2,
411};
412
413/**
414 * struct iwl_fw_dbg_dest_tlv - configures the destination of the debug data
415 *
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
425 *
426 * This parses IWL_UCODE_TLV_FW_DBG_DEST
427 */
428struct iwl_fw_dbg_dest_tlv {
429 u8 version;
430 u8 monitor_mode;
431 u8 reserved[2];
432 __le32 base_reg;
433 __le32 end_reg;
434 __le32 write_ptr_reg;
435 __le32 wrap_count;
436 u8 base_shift;
437 u8 end_shift;
438 struct iwl_fw_dbg_reg_op reg_ops[0];
439} __packed;
440
441struct iwl_fw_dbg_conf_hcmd {
442 u8 id;
443 u8 reserved;
444 __le16 len;
445 u8 data[0];
446} __packed;
447
448/**
449 * struct iwl_fw_dbg_trigger - a TLV that describes a debug configuration
450 *
451 * @enabled: is this trigger enabled
452 * @reserved:
453 * @len: length, in bytes, of the %trigger field
454 * @trigger: pointer to a trigger struct
455 */
456struct iwl_fw_dbg_trigger {
457 u8 enabled;
458 u8 reserved;
459 u8 len;
460 u8 trigger[0];
461} __packed;
462
463/**
464 * enum iwl_fw_dbg_conf - configurations available
465 *
466 * @FW_DBG_CUSTOM: take this configuration from alive
467 * Note that the trigger is NO-OP for this configuration
468 */
469enum iwl_fw_dbg_conf {
470 FW_DBG_CUSTOM = 0,
471
472 /* must be last */
473 FW_DBG_MAX,
474 FW_DBG_INVALID = 0xff,
475};
476
477/**
478 * struct iwl_fw_dbg_conf_tlv - a TLV that describes a debug configuration
479 *
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
487 */
488struct iwl_fw_dbg_conf_tlv {
489 u8 id;
490 u8 usniffer;
491 u8 reserved;
492 u8 num_of_hcmds;
493 struct iwl_fw_dbg_conf_hcmd hcmd;
494
495 /* struct iwl_fw_dbg_trigger sits after all variable length hcmds */
496} __packed;
497
Johannes Berg3995dea2012-03-06 13:30:44 -0800498#endif /* __iwl_fw_file_h__ */