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 *****************************************************************************/
67 #include <linux/types.h>
68 #include <net/mac80211.h>
70 #include "iwl-fw-file.h"
73 * enum iwl_ucode_tlv_flag - ucode API flags
74 * @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously
75 * was a separate TLV but moved here to save space.
76 * @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behaviour on hidden SSID,
77 * treats good CRC threshold as a boolean
78 * @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w).
79 * @IWL_UCODE_TLV_FLAGS_P2P: This uCode image supports P2P.
80 * @IWL_UCODE_TLV_FLAGS_DW_BC_TABLE: The SCD byte count table is in DWORDS
81 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: This uCode image supports uAPSD
82 * @IWL_UCODE_TLV_FLAGS_SHORT_BL: 16 entries of black list instead of 64 in scan
83 * offload profile config command.
84 * @IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS: D3 image supports up to six
85 * (rather than two) IPv6 addresses
86 * @IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID: not sending a probe with the SSID element
87 * from the probe request template.
88 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL: new NS offload (small version)
89 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE: new NS offload (large version)
90 * @IWL_UCODE_TLV_FLAGS_P2P_PM: P2P client supports PM as a stand alone MAC
91 * @IWL_UCODE_TLV_FLAGS_P2P_BSS_PS_DCM: support power save on BSS station and
92 * P2P client interfaces simultaneously if they are in different bindings.
93 * @IWL_UCODE_TLV_FLAGS_P2P_BSS_PS_SCM: support power save on BSS station and
94 * P2P client interfaces simultaneously if they are in same bindings.
95 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: General support for uAPSD
96 * @IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD: P2P client supports uAPSD power save
97 * @IWL_UCODE_TLV_FLAGS_BCAST_FILTERING: uCode supports broadcast filtering.
98 * @IWL_UCODE_TLV_FLAGS_GO_UAPSD: AP/GO interfaces support uAPSD clients
99 * @IWL_UCODE_TLV_FLAGS_EBS_SUPPORT: this uCode image supports EBS.
101 enum iwl_ucode_tlv_flag {
102 IWL_UCODE_TLV_FLAGS_PAN = BIT(0),
103 IWL_UCODE_TLV_FLAGS_NEWSCAN = BIT(1),
104 IWL_UCODE_TLV_FLAGS_MFP = BIT(2),
105 IWL_UCODE_TLV_FLAGS_P2P = BIT(3),
106 IWL_UCODE_TLV_FLAGS_DW_BC_TABLE = BIT(4),
107 IWL_UCODE_TLV_FLAGS_SHORT_BL = BIT(7),
108 IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS = BIT(10),
109 IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID = BIT(12),
110 IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL = BIT(15),
111 IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE = BIT(16),
112 IWL_UCODE_TLV_FLAGS_P2P_PM = BIT(21),
113 IWL_UCODE_TLV_FLAGS_BSS_P2P_PS_DCM = BIT(22),
114 IWL_UCODE_TLV_FLAGS_BSS_P2P_PS_SCM = BIT(23),
115 IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT = BIT(24),
116 IWL_UCODE_TLV_FLAGS_EBS_SUPPORT = BIT(25),
117 IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD = BIT(26),
118 IWL_UCODE_TLV_FLAGS_BCAST_FILTERING = BIT(29),
119 IWL_UCODE_TLV_FLAGS_GO_UAPSD = BIT(30),
123 * enum iwl_ucode_tlv_api - ucode api
124 * @IWL_UCODE_TLV_API_WOWLAN_CONFIG_TID: wowlan config includes tid field.
125 * @IWL_UCODE_TLV_CAPA_EXTENDED_BEACON: Support Extended beacon notification
126 * @IWL_UCODE_TLV_API_BT_COEX_SPLIT: new API for BT Coex
127 * @IWL_UCODE_TLV_API_CSA_FLOW: ucode can do unbind-bind flow for CSA.
128 * @IWL_UCODE_TLV_API_DISABLE_STA_TX: ucode supports tx_disable bit.
129 * @IWL_UCODE_TLV_API_LMAC_SCAN: This ucode uses LMAC unified scan API.
130 * @IWL_UCODE_TLV_API_SF_NO_DUMMY_NOTIF: ucode supports disabling dummy notif.
131 * @IWL_UCODE_TLV_API_FRAGMENTED_SCAN: This ucode supports active dwell time
132 * longer than the passive one, which is essential for fragmented scan.
134 enum iwl_ucode_tlv_api {
135 IWL_UCODE_TLV_API_WOWLAN_CONFIG_TID = BIT(0),
136 IWL_UCODE_TLV_CAPA_EXTENDED_BEACON = BIT(1),
137 IWL_UCODE_TLV_API_BT_COEX_SPLIT = BIT(3),
138 IWL_UCODE_TLV_API_CSA_FLOW = BIT(4),
139 IWL_UCODE_TLV_API_DISABLE_STA_TX = BIT(5),
140 IWL_UCODE_TLV_API_LMAC_SCAN = BIT(6),
141 IWL_UCODE_TLV_API_SF_NO_DUMMY_NOTIF = BIT(7),
142 IWL_UCODE_TLV_API_FRAGMENTED_SCAN = BIT(8),
146 * enum iwl_ucode_tlv_capa - ucode capabilities
147 * @IWL_UCODE_TLV_CAPA_D0I3_SUPPORT: supports D0i3
148 * @IWL_UCODE_TLV_CAPA_UMAC_SCAN: supports UMAC scan.
149 * @IWL_UCODE_TLV_CAPA_TDLS_SUPPORT: support basic TDLS functionality
150 * @IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT: supports insertion of current
151 * tx power value into TPC Report action frame and Link Measurement Report
153 * @IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT: supports updating current
154 * channel in DS parameter set element in probe requests.
155 * @IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT: supports adding TPC Report IE in
157 * @IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT: supports Quiet Period requests
158 * @IWL_UCODE_TLV_CAPA_DQA_SUPPORT: supports dynamic queue allocation (DQA),
159 * which also implies support for the scheduler configuration command
161 enum iwl_ucode_tlv_capa {
162 IWL_UCODE_TLV_CAPA_D0I3_SUPPORT = BIT(0),
163 IWL_UCODE_TLV_CAPA_UMAC_SCAN = BIT(2),
164 IWL_UCODE_TLV_CAPA_TDLS_SUPPORT = BIT(6),
165 IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT = BIT(8),
166 IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT = BIT(9),
167 IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT = BIT(10),
168 IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT = BIT(11),
169 IWL_UCODE_TLV_CAPA_DQA_SUPPORT = BIT(12),
172 /* The default calibrate table size if not specified by firmware file */
173 #define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE 18
174 #define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE 19
175 #define IWL_MAX_PHY_CALIBRATE_TBL_SIZE 253
177 /* The default max probe length if not specified by the firmware file */
178 #define IWL_DEFAULT_MAX_PROBE_LENGTH 200
181 * enum iwl_ucode_type
185 * @IWL_UCODE_REGULAR: Normal runtime ucode
186 * @IWL_UCODE_INIT: Initial ucode
187 * @IWL_UCODE_WOWLAN: Wake on Wireless enabled ucode
189 enum iwl_ucode_type {
197 * enumeration of ucode section.
198 * This enumeration is used directly for older firmware (before 16.0).
199 * For new firmware, there can be up to 4 sections (see below) but the
200 * first one packaged into the firmware file is the DATA section and
201 * some debugging code accesses that.
204 IWL_UCODE_SECTION_DATA,
205 IWL_UCODE_SECTION_INST,
208 * For 16.0 uCode and above, there is no differentiation between sections,
209 * just an offset to the HW address.
211 #define IWL_UCODE_SECTION_MAX 12
212 #define IWL_API_ARRAY_SIZE 1
213 #define IWL_CAPABILITIES_ARRAY_SIZE 1
214 #define CPU1_CPU2_SEPARATOR_SECTION 0xFFFFCCCC
216 struct iwl_ucode_capabilities {
217 u32 max_probe_length;
219 u32 standard_phy_calibration_size;
221 u32 api[IWL_API_ARRAY_SIZE];
222 u32 capa[IWL_CAPABILITIES_ARRAY_SIZE];
225 /* one for each uCode image (inst/data, init/runtime/wowlan) */
227 const void *data; /* vmalloc'ed data */
228 u32 len; /* size in bytes */
229 u32 offset; /* offset in the device */
233 struct fw_desc sec[IWL_UCODE_SECTION_MAX];
237 struct iwl_sf_region {
242 /* uCode version contains 4 values: Major/Minor/API/Serial */
243 #define IWL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24)
244 #define IWL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16)
245 #define IWL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8)
246 #define IWL_UCODE_SERIAL(ver) ((ver) & 0x000000FF)
249 * Calibration control struct.
250 * Sent as part of the phy configuration command.
251 * @flow_trigger: bitmap for which calibrations to perform according to
253 * @event_trigger: bitmap for which calibrations to perform according to
256 struct iwl_tlv_calib_ctrl {
258 __le32 event_trigger;
261 enum iwl_fw_phy_cfg {
262 FW_PHY_CFG_RADIO_TYPE_POS = 0,
263 FW_PHY_CFG_RADIO_TYPE = 0x3 << FW_PHY_CFG_RADIO_TYPE_POS,
264 FW_PHY_CFG_RADIO_STEP_POS = 2,
265 FW_PHY_CFG_RADIO_STEP = 0x3 << FW_PHY_CFG_RADIO_STEP_POS,
266 FW_PHY_CFG_RADIO_DASH_POS = 4,
267 FW_PHY_CFG_RADIO_DASH = 0x3 << FW_PHY_CFG_RADIO_DASH_POS,
268 FW_PHY_CFG_TX_CHAIN_POS = 16,
269 FW_PHY_CFG_TX_CHAIN = 0xf << FW_PHY_CFG_TX_CHAIN_POS,
270 FW_PHY_CFG_RX_CHAIN_POS = 20,
271 FW_PHY_CFG_RX_CHAIN = 0xf << FW_PHY_CFG_RX_CHAIN_POS,
274 #define IWL_UCODE_MAX_CS 1
277 * struct iwl_fw_cipher_scheme - a cipher scheme supported by FW.
278 * @cipher: a cipher suite selector
279 * @flags: cipher scheme flags (currently reserved for a future use)
280 * @hdr_len: a size of MPDU security header
281 * @pn_len: a size of PN
282 * @pn_off: an offset of pn from the beginning of the security header
283 * @key_idx_off: an offset of key index byte in the security header
284 * @key_idx_mask: a bit mask of key_idx bits
285 * @key_idx_shift: bit shift needed to get key_idx
286 * @mic_len: mic length in bytes
287 * @hw_cipher: a HW cipher index used in host commands
289 struct iwl_fw_cipher_scheme {
303 * struct iwl_fw_cscheme_list - a cipher scheme list
304 * @size: a number of entries
305 * @cs: cipher scheme entries
307 struct iwl_fw_cscheme_list {
309 struct iwl_fw_cipher_scheme cs[];
313 * struct iwl_fw - variables associated with the firmware
315 * @ucode_ver: ucode version from the ucode file
316 * @fw_version: firmware version string
317 * @img: ucode image like ucode_rt, ucode_init, ucode_wowlan.
318 * @ucode_capa: capabilities parsed from the ucode file.
319 * @enhance_sensitivity_table: device can do enhanced sensitivity.
320 * @init_evtlog_ptr: event log offset for init ucode.
321 * @init_evtlog_size: event log size for init ucode.
322 * @init_errlog_ptr: error log offfset for init ucode.
323 * @inst_evtlog_ptr: event log offset for runtime ucode.
324 * @inst_evtlog_size: event log size for runtime ucode.
325 * @inst_errlog_ptr: error log offfset for runtime ucode.
326 * @mvm_fw: indicates this is MVM firmware
327 * @cipher_scheme: optional external cipher scheme.
332 char fw_version[ETHTOOL_FWVERS_LEN];
335 struct fw_img img[IWL_UCODE_TYPE_MAX];
337 struct iwl_ucode_capabilities ucode_capa;
338 bool enhance_sensitivity_table;
340 u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
341 u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
343 struct iwl_tlv_calib_ctrl default_calib[IWL_UCODE_TYPE_MAX];
350 struct ieee80211_cipher_scheme cs[IWL_UCODE_MAX_CS];
351 u8 human_readable[FW_VER_HUMAN_READABLE_SZ];
354 #endif /* __iwl_fw_h__ */