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 - 2013 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 - 2013 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>
69 * enum iwl_ucode_tlv_flag - ucode API flags
70 * @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously
71 * was a separate TLV but moved here to save space.
72 * @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behaviour on hidden SSID,
73 * treats good CRC threshold as a boolean
74 * @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w).
75 * @IWL_UCODE_TLV_FLAGS_P2P: This uCode image supports P2P.
76 * @IWL_UCODE_TLV_FLAGS_DW_BC_TABLE: The SCD byte count table is in DWORDS
77 * @IWL_UCODE_TLV_FLAGS_UAPSD: This uCode image supports uAPSD
78 * @IWL_UCODE_TLV_FLAGS_RX_ENERGY_API: supports rx signal strength api
79 * @IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS: D3 image supports up to six
80 * (rather than two) IPv6 addresses
82 enum iwl_ucode_tlv_flag {
83 IWL_UCODE_TLV_FLAGS_PAN = BIT(0),
84 IWL_UCODE_TLV_FLAGS_NEWSCAN = BIT(1),
85 IWL_UCODE_TLV_FLAGS_MFP = BIT(2),
86 IWL_UCODE_TLV_FLAGS_P2P = BIT(3),
87 IWL_UCODE_TLV_FLAGS_DW_BC_TABLE = BIT(4),
88 IWL_UCODE_TLV_FLAGS_UAPSD = BIT(6),
89 IWL_UCODE_TLV_FLAGS_RX_ENERGY_API = BIT(8),
90 IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS = BIT(10),
93 /* The default calibrate table size if not specified by firmware file */
94 #define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE 18
95 #define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE 19
96 #define IWL_MAX_PHY_CALIBRATE_TBL_SIZE 253
103 * @IWL_UCODE_REGULAR: Normal runtime ucode
104 * @IWL_UCODE_INIT: Initial ucode
105 * @IWL_UCODE_WOWLAN: Wake on Wireless enabled ucode
107 enum iwl_ucode_type {
115 * enumeration of ucode section.
116 * This enumeration is used directly for older firmware (before 16.0).
117 * For new firmware, there can be up to 4 sections (see below) but the
118 * first one packaged into the firmware file is the DATA section and
119 * some debugging code accesses that.
122 IWL_UCODE_SECTION_DATA,
123 IWL_UCODE_SECTION_INST,
126 * For 16.0 uCode and above, there is no differentiation between sections,
127 * just an offset to the HW address.
129 #define IWL_UCODE_SECTION_MAX 4
131 struct iwl_ucode_capabilities {
132 u32 max_probe_length;
133 u32 standard_phy_calibration_size;
137 /* one for each uCode image (inst/data, init/runtime/wowlan) */
139 const void *data; /* vmalloc'ed data */
140 u32 len; /* size in bytes */
141 u32 offset; /* offset in the device */
145 struct fw_desc sec[IWL_UCODE_SECTION_MAX];
148 /* uCode version contains 4 values: Major/Minor/API/Serial */
149 #define IWL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24)
150 #define IWL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16)
151 #define IWL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8)
152 #define IWL_UCODE_SERIAL(ver) ((ver) & 0x000000FF)
155 * Calibration control struct.
156 * Sent as part of the phy configuration command.
157 * @flow_trigger: bitmap for which calibrations to perform according to
159 * @event_trigger: bitmap for which calibrations to perform according to
162 struct iwl_tlv_calib_ctrl {
164 __le32 event_trigger;
167 enum iwl_fw_phy_cfg {
168 FW_PHY_CFG_RADIO_TYPE_POS = 0,
169 FW_PHY_CFG_RADIO_TYPE = 0x3 << FW_PHY_CFG_RADIO_TYPE_POS,
170 FW_PHY_CFG_RADIO_STEP_POS = 2,
171 FW_PHY_CFG_RADIO_STEP = 0x3 << FW_PHY_CFG_RADIO_STEP_POS,
172 FW_PHY_CFG_RADIO_DASH_POS = 4,
173 FW_PHY_CFG_RADIO_DASH = 0x3 << FW_PHY_CFG_RADIO_DASH_POS,
174 FW_PHY_CFG_TX_CHAIN_POS = 16,
175 FW_PHY_CFG_TX_CHAIN = 0xf << FW_PHY_CFG_TX_CHAIN_POS,
176 FW_PHY_CFG_RX_CHAIN_POS = 20,
177 FW_PHY_CFG_RX_CHAIN = 0xf << FW_PHY_CFG_RX_CHAIN_POS,
181 * struct iwl_fw - variables associated with the firmware
183 * @ucode_ver: ucode version from the ucode file
184 * @fw_version: firmware version string
185 * @img: ucode image like ucode_rt, ucode_init, ucode_wowlan.
186 * @ucode_capa: capabilities parsed from the ucode file.
187 * @enhance_sensitivity_table: device can do enhanced sensitivity.
188 * @init_evtlog_ptr: event log offset for init ucode.
189 * @init_evtlog_size: event log size for init ucode.
190 * @init_errlog_ptr: error log offfset for init ucode.
191 * @inst_evtlog_ptr: event log offset for runtime ucode.
192 * @inst_evtlog_size: event log size for runtime ucode.
193 * @inst_errlog_ptr: error log offfset for runtime ucode.
194 * @mvm_fw: indicates this is MVM firmware
199 char fw_version[ETHTOOL_FWVERS_LEN];
202 struct fw_img img[IWL_UCODE_TYPE_MAX];
204 struct iwl_ucode_capabilities ucode_capa;
205 bool enhance_sensitivity_table;
207 u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
208 u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
210 struct iwl_tlv_calib_ctrl default_calib[IWL_UCODE_TYPE_MAX];
216 static inline u8 iwl_fw_valid_tx_ant(const struct iwl_fw *fw)
218 return (fw->phy_config & FW_PHY_CFG_TX_CHAIN) >>
219 FW_PHY_CFG_TX_CHAIN_POS;
222 static inline u8 iwl_fw_valid_rx_ant(const struct iwl_fw *fw)
224 return (fw->phy_config & FW_PHY_CFG_RX_CHAIN) >>
225 FW_PHY_CFG_RX_CHAIN_POS;
228 #endif /* __iwl_fw_h__ */