1/****************************************************************************** 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 * 8 * Copyright(c) 2008 - 2013 Intel Corporation. All rights reserved. 9 * 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. 13 * 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. 18 * 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, 22 * USA 23 * 24 * The full GNU General Public License is included in this distribution 25 * in the file called COPYING. 26 * 27 * Contact Information: 28 * Intel Linux Wireless <ilw@linux.intel.com> 29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497 30 * 31 * BSD LICENSE 32 * 33 * Copyright(c) 2005 - 2013 Intel Corporation. All rights reserved. 34 * All rights reserved. 35 * 36 * Redistribution and use in source and binary forms, with or without 37 * modification, are permitted provided that the following conditions 38 * are met: 39 * 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 45 * distribution. 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. 49 * 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 *****************************************************************************/ 62 63#ifndef __iwl_fw_h__ 64#define __iwl_fw_h__ 65#include <linux/types.h> 66#include <net/mac80211.h> 67 68/** 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 */ 78enum iwl_ucode_tlv_flag { 79 IWL_UCODE_TLV_FLAGS_PAN = BIT(0), 80 IWL_UCODE_TLV_FLAGS_NEWSCAN = BIT(1), 81 IWL_UCODE_TLV_FLAGS_MFP = BIT(2), 82 IWL_UCODE_TLV_FLAGS_P2P = BIT(3), 83 IWL_UCODE_TLV_FLAGS_DW_BC_TABLE = BIT(4), 84}; 85 86/* The default calibrate table size if not specified by firmware file */ 87#define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE 18 88#define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE 19 89#define IWL_MAX_PHY_CALIBRATE_TBL_SIZE 253 90 91/** 92 * enum iwl_ucode_type 93 * 94 * The type of ucode. 95 * 96 * @IWL_UCODE_REGULAR: Normal runtime ucode 97 * @IWL_UCODE_INIT: Initial ucode 98 * @IWL_UCODE_WOWLAN: Wake on Wireless enabled ucode 99 */ 100enum iwl_ucode_type { 101 IWL_UCODE_REGULAR, 102 IWL_UCODE_INIT, 103 IWL_UCODE_WOWLAN, 104 IWL_UCODE_TYPE_MAX, 105}; 106 107/* 108 * enumeration of ucode section. 109 * This enumeration is used directly for older firmware (before 16.0). 110 * For new firmware, there can be up to 4 sections (see below) but the 111 * first one packaged into the firmware file is the DATA section and 112 * some debugging code accesses that. 113 */ 114enum iwl_ucode_sec { 115 IWL_UCODE_SECTION_DATA, 116 IWL_UCODE_SECTION_INST, 117}; 118/* 119 * For 16.0 uCode and above, there is no differentiation between sections, 120 * just an offset to the HW address. 121 */ 122#define IWL_UCODE_SECTION_MAX 4 123 124struct iwl_ucode_capabilities { 125 u32 max_probe_length; 126 u32 standard_phy_calibration_size; 127 u32 flags; 128}; 129 130/* one for each uCode image (inst/data, init/runtime/wowlan) */ 131struct fw_desc { 132 const void *data; /* vmalloc'ed data */ 133 u32 len; /* size in bytes */ 134 u32 offset; /* offset in the device */ 135}; 136 137struct fw_img { 138 struct fw_desc sec[IWL_UCODE_SECTION_MAX]; 139}; 140 141/* uCode version contains 4 values: Major/Minor/API/Serial */ 142#define IWL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24) 143#define IWL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16) 144#define IWL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8) 145#define IWL_UCODE_SERIAL(ver) ((ver) & 0x000000FF) 146 147/* 148 * Calibration control struct. 149 * Sent as part of the phy configuration command. 150 * @flow_trigger: bitmap for which calibrations to perform according to 151 * flow triggers. 152 * @event_trigger: bitmap for which calibrations to perform according to 153 * event triggers. 154 */ 155struct iwl_tlv_calib_ctrl { 156 __le32 flow_trigger; 157 __le32 event_trigger; 158} __packed; 159 160enum iwl_fw_phy_cfg { 161 FW_PHY_CFG_RADIO_TYPE_POS = 0, 162 FW_PHY_CFG_RADIO_TYPE = 0x3 << FW_PHY_CFG_RADIO_TYPE_POS, 163 FW_PHY_CFG_RADIO_STEP_POS = 2, 164 FW_PHY_CFG_RADIO_STEP = 0x3 << FW_PHY_CFG_RADIO_STEP_POS, 165 FW_PHY_CFG_RADIO_DASH_POS = 4, 166 FW_PHY_CFG_RADIO_DASH = 0x3 << FW_PHY_CFG_RADIO_DASH_POS, 167 FW_PHY_CFG_TX_CHAIN_POS = 16, 168 FW_PHY_CFG_TX_CHAIN = 0xf << FW_PHY_CFG_TX_CHAIN_POS, 169 FW_PHY_CFG_RX_CHAIN_POS = 20, 170 FW_PHY_CFG_RX_CHAIN = 0xf << FW_PHY_CFG_RX_CHAIN_POS, 171}; 172 173/** 174 * struct iwl_fw - variables associated with the firmware 175 * 176 * @ucode_ver: ucode version from the ucode file 177 * @fw_version: firmware version string 178 * @img: ucode image like ucode_rt, ucode_init, ucode_wowlan. 179 * @ucode_capa: capabilities parsed from the ucode file. 180 * @enhance_sensitivity_table: device can do enhanced sensitivity. 181 * @init_evtlog_ptr: event log offset for init ucode. 182 * @init_evtlog_size: event log size for init ucode. 183 * @init_errlog_ptr: error log offfset for init ucode. 184 * @inst_evtlog_ptr: event log offset for runtime ucode. 185 * @inst_evtlog_size: event log size for runtime ucode. 186 * @inst_errlog_ptr: error log offfset for runtime ucode. 187 * @mvm_fw: indicates this is MVM firmware 188 */ 189struct iwl_fw { 190 u32 ucode_ver; 191 192 char fw_version[ETHTOOL_FWVERS_LEN]; 193 194 /* ucode images */ 195 struct fw_img img[IWL_UCODE_TYPE_MAX]; 196 197 struct iwl_ucode_capabilities ucode_capa; 198 bool enhance_sensitivity_table; 199 200 u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr; 201 u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr; 202 203 struct iwl_tlv_calib_ctrl default_calib[IWL_UCODE_TYPE_MAX]; 204 u32 phy_config; 205 206 bool mvm_fw; 207}; 208 209static inline u8 iwl_fw_valid_tx_ant(const struct iwl_fw *fw) 210{ 211 return (fw->phy_config & FW_PHY_CFG_TX_CHAIN) >> 212 FW_PHY_CFG_TX_CHAIN_POS; 213} 214 215static inline u8 iwl_fw_valid_rx_ant(const struct iwl_fw *fw) 216{ 217 return (fw->phy_config & FW_PHY_CFG_RX_CHAIN) >> 218 FW_PHY_CFG_RX_CHAIN_POS; 219} 220 221#endif /* __iwl_fw_h__ */ 222