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.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of version 2 of the GNU General Public License as
12 * published by the Free Software Foundation.
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
24 * The full GNU General Public License is included in this distribution
25 * in the file called COPYING.
27 * Contact Information:
28 * Intel Linux Wireless <ilw@linux.intel.com>
29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
33 * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
40 * * Redistributions of source code must retain the above copyright
41 * notice, this list of conditions and the following disclaimer.
42 * * Redistributions in binary form must reproduce the above copyright
43 * notice, this list of conditions and the following disclaimer in
44 * the documentation and/or other materials provided with the
46 * * Neither the name Intel Corporation nor the names of its
47 * contributors may be used to endorse or promote products derived
48 * from this software without specific prior written permission.
50 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
51 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
52 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
53 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
54 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
55 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
56 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
57 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
58 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
59 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
60 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
61 *****************************************************************************/
65 #include <linux/types.h>
66 #include <net/mac80211.h>
68 #include "iwl-fw-file.h"
71 * enum iwl_ucode_tlv_flag - ucode API flags
72 * @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously
73 * was a separate TLV but moved here to save space.
74 * @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behaviour on hidden SSID,
75 * treats good CRC threshold as a boolean
76 * @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w).
77 * @IWL_UCODE_TLV_FLAGS_P2P: This uCode image supports P2P.
78 * @IWL_UCODE_TLV_FLAGS_DW_BC_TABLE: The SCD byte count table is in DWORDS
79 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: This uCode image supports uAPSD
80 * @IWL_UCODE_TLV_FLAGS_SHORT_BL: 16 entries of black list instead of 64 in scan
81 * offload profile config command.
82 * @IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS: D3 image supports up to six
83 * (rather than two) IPv6 addresses
84 * @IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID: not sending a probe with the SSID element
85 * from the probe request template.
86 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL: new NS offload (small version)
87 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE: new NS offload (large version)
88 * @IWL_UCODE_TLV_FLAGS_P2P_PM: P2P client supports PM as a stand alone MAC
89 * @IWL_UCODE_TLV_FLAGS_P2P_BSS_PS_DCM: support power save on BSS station and
90 * P2P client interfaces simultaneously if they are in different bindings.
91 * @IWL_UCODE_TLV_FLAGS_P2P_BSS_PS_SCM: support power save on BSS station and
92 * P2P client interfaces simultaneously if they are in same bindings.
93 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: General support for uAPSD
94 * @IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD: P2P client supports uAPSD power save
95 * @IWL_UCODE_TLV_FLAGS_BCAST_FILTERING: uCode supports broadcast filtering.
96 * @IWL_UCODE_TLV_FLAGS_GO_UAPSD: AP/GO interfaces support uAPSD clients
97 * @IWL_UCODE_TLV_FLAGS_EBS_SUPPORT: this uCode image supports EBS.
99 enum iwl_ucode_tlv_flag {
100 IWL_UCODE_TLV_FLAGS_PAN = BIT(0),
101 IWL_UCODE_TLV_FLAGS_NEWSCAN = BIT(1),
102 IWL_UCODE_TLV_FLAGS_MFP = BIT(2),
103 IWL_UCODE_TLV_FLAGS_P2P = BIT(3),
104 IWL_UCODE_TLV_FLAGS_DW_BC_TABLE = BIT(4),
105 IWL_UCODE_TLV_FLAGS_SHORT_BL = BIT(7),
106 IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS = BIT(10),
107 IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID = BIT(12),
108 IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL = BIT(15),
109 IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE = BIT(16),
110 IWL_UCODE_TLV_FLAGS_P2P_PM = BIT(21),
111 IWL_UCODE_TLV_FLAGS_BSS_P2P_PS_DCM = BIT(22),
112 IWL_UCODE_TLV_FLAGS_BSS_P2P_PS_SCM = BIT(23),
113 IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT = BIT(24),
114 IWL_UCODE_TLV_FLAGS_EBS_SUPPORT = BIT(25),
115 IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD = BIT(26),
116 IWL_UCODE_TLV_FLAGS_BCAST_FILTERING = BIT(29),
117 IWL_UCODE_TLV_FLAGS_GO_UAPSD = BIT(30),
121 * enum iwl_ucode_tlv_api - ucode api
122 * @IWL_UCODE_TLV_API_WOWLAN_CONFIG_TID: wowlan config includes tid field.
123 * @IWL_UCODE_TLV_CAPA_EXTENDED_BEACON: Support Extended beacon notification
124 * @IWL_UCODE_TLV_API_BT_COEX_SPLIT: new API for BT Coex
125 * @IWL_UCODE_TLV_API_CSA_FLOW: ucode can do unbind-bind flow for CSA.
126 * @IWL_UCODE_TLV_API_DISABLE_STA_TX: ucode supports tx_disable bit.
127 * @IWL_UCODE_TLV_API_LMAC_SCAN: This ucode uses LMAC unified scan API.
128 * @IWL_UCODE_TLV_API_FRAGMENTED_SCAN: This ucode supports active dwell time
129 * longer than the passive one, which is essential for fragmented scan.
131 enum iwl_ucode_tlv_api {
132 IWL_UCODE_TLV_API_WOWLAN_CONFIG_TID = BIT(0),
133 IWL_UCODE_TLV_CAPA_EXTENDED_BEACON = BIT(1),
134 IWL_UCODE_TLV_API_BT_COEX_SPLIT = BIT(3),
135 IWL_UCODE_TLV_API_CSA_FLOW = BIT(4),
136 IWL_UCODE_TLV_API_DISABLE_STA_TX = BIT(5),
137 IWL_UCODE_TLV_API_LMAC_SCAN = BIT(6),
138 IWL_UCODE_TLV_API_FRAGMENTED_SCAN = BIT(8),
142 * enum iwl_ucode_tlv_capa - ucode capabilities
143 * @IWL_UCODE_TLV_CAPA_D0I3_SUPPORT: supports D0i3
145 enum iwl_ucode_tlv_capa {
146 IWL_UCODE_TLV_CAPA_D0I3_SUPPORT = BIT(0),
149 /* The default calibrate table size if not specified by firmware file */
150 #define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE 18
151 #define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE 19
152 #define IWL_MAX_PHY_CALIBRATE_TBL_SIZE 253
154 /* The default max probe length if not specified by the firmware file */
155 #define IWL_DEFAULT_MAX_PROBE_LENGTH 200
158 * enum iwl_ucode_type
162 * @IWL_UCODE_REGULAR: Normal runtime ucode
163 * @IWL_UCODE_INIT: Initial ucode
164 * @IWL_UCODE_WOWLAN: Wake on Wireless enabled ucode
166 enum iwl_ucode_type {
174 * enumeration of ucode section.
175 * This enumeration is used directly for older firmware (before 16.0).
176 * For new firmware, there can be up to 4 sections (see below) but the
177 * first one packaged into the firmware file is the DATA section and
178 * some debugging code accesses that.
181 IWL_UCODE_SECTION_DATA,
182 IWL_UCODE_SECTION_INST,
185 * For 16.0 uCode and above, there is no differentiation between sections,
186 * just an offset to the HW address.
188 #define IWL_UCODE_SECTION_MAX 12
189 #define IWL_API_ARRAY_SIZE 1
190 #define IWL_CAPABILITIES_ARRAY_SIZE 1
191 #define CPU1_CPU2_SEPARATOR_SECTION 0xFFFFCCCC
193 struct iwl_ucode_capabilities {
194 u32 max_probe_length;
196 u32 standard_phy_calibration_size;
198 u32 api[IWL_API_ARRAY_SIZE];
199 u32 capa[IWL_CAPABILITIES_ARRAY_SIZE];
202 /* one for each uCode image (inst/data, init/runtime/wowlan) */
204 const void *data; /* vmalloc'ed data */
205 u32 len; /* size in bytes */
206 u32 offset; /* offset in the device */
210 struct fw_desc sec[IWL_UCODE_SECTION_MAX];
215 struct iwl_sf_region {
220 /* uCode version contains 4 values: Major/Minor/API/Serial */
221 #define IWL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24)
222 #define IWL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16)
223 #define IWL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8)
224 #define IWL_UCODE_SERIAL(ver) ((ver) & 0x000000FF)
227 * Calibration control struct.
228 * Sent as part of the phy configuration command.
229 * @flow_trigger: bitmap for which calibrations to perform according to
231 * @event_trigger: bitmap for which calibrations to perform according to
234 struct iwl_tlv_calib_ctrl {
236 __le32 event_trigger;
239 enum iwl_fw_phy_cfg {
240 FW_PHY_CFG_RADIO_TYPE_POS = 0,
241 FW_PHY_CFG_RADIO_TYPE = 0x3 << FW_PHY_CFG_RADIO_TYPE_POS,
242 FW_PHY_CFG_RADIO_STEP_POS = 2,
243 FW_PHY_CFG_RADIO_STEP = 0x3 << FW_PHY_CFG_RADIO_STEP_POS,
244 FW_PHY_CFG_RADIO_DASH_POS = 4,
245 FW_PHY_CFG_RADIO_DASH = 0x3 << FW_PHY_CFG_RADIO_DASH_POS,
246 FW_PHY_CFG_TX_CHAIN_POS = 16,
247 FW_PHY_CFG_TX_CHAIN = 0xf << FW_PHY_CFG_TX_CHAIN_POS,
248 FW_PHY_CFG_RX_CHAIN_POS = 20,
249 FW_PHY_CFG_RX_CHAIN = 0xf << FW_PHY_CFG_RX_CHAIN_POS,
252 #define IWL_UCODE_MAX_CS 1
255 * struct iwl_fw_cipher_scheme - a cipher scheme supported by FW.
256 * @cipher: a cipher suite selector
257 * @flags: cipher scheme flags (currently reserved for a future use)
258 * @hdr_len: a size of MPDU security header
259 * @pn_len: a size of PN
260 * @pn_off: an offset of pn from the beginning of the security header
261 * @key_idx_off: an offset of key index byte in the security header
262 * @key_idx_mask: a bit mask of key_idx bits
263 * @key_idx_shift: bit shift needed to get key_idx
264 * @mic_len: mic length in bytes
265 * @hw_cipher: a HW cipher index used in host commands
267 struct iwl_fw_cipher_scheme {
281 * struct iwl_fw_cscheme_list - a cipher scheme list
282 * @size: a number of entries
283 * @cs: cipher scheme entries
285 struct iwl_fw_cscheme_list {
287 struct iwl_fw_cipher_scheme cs[];
291 * struct iwl_fw - variables associated with the firmware
293 * @ucode_ver: ucode version from the ucode file
294 * @fw_version: firmware version string
295 * @img: ucode image like ucode_rt, ucode_init, ucode_wowlan.
296 * @ucode_capa: capabilities parsed from the ucode file.
297 * @enhance_sensitivity_table: device can do enhanced sensitivity.
298 * @init_evtlog_ptr: event log offset for init ucode.
299 * @init_evtlog_size: event log size for init ucode.
300 * @init_errlog_ptr: error log offfset for init ucode.
301 * @inst_evtlog_ptr: event log offset for runtime ucode.
302 * @inst_evtlog_size: event log size for runtime ucode.
303 * @inst_errlog_ptr: error log offfset for runtime ucode.
304 * @mvm_fw: indicates this is MVM firmware
305 * @cipher_scheme: optional external cipher scheme.
310 char fw_version[ETHTOOL_FWVERS_LEN];
313 struct fw_img img[IWL_UCODE_TYPE_MAX];
315 struct iwl_ucode_capabilities ucode_capa;
316 bool enhance_sensitivity_table;
318 u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
319 u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
321 struct iwl_tlv_calib_ctrl default_calib[IWL_UCODE_TYPE_MAX];
328 struct ieee80211_cipher_scheme cs[IWL_UCODE_MAX_CS];
329 u8 human_readable[FW_VER_HUMAN_READABLE_SZ];
332 #endif /* __iwl_fw_h__ */