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 - 2012 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 LICENSE.GPL. 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 - 2012 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 67 /** 68 * enum iwl_ucode_tlv_flag - ucode API flags 69 * @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously 70 * was a separate TLV but moved here to save space. 71 * @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behaviour on hidden SSID, 72 * treats good CRC threshold as a boolean 73 * @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w). 74 * @IWL_UCODE_TLV_FLAGS_P2P: This uCode image supports P2P. 75 */ 76 enum iwl_ucode_tlv_flag { 77 IWL_UCODE_TLV_FLAGS_PAN = BIT(0), 78 IWL_UCODE_TLV_FLAGS_NEWSCAN = BIT(1), 79 IWL_UCODE_TLV_FLAGS_MFP = BIT(2), 80 IWL_UCODE_TLV_FLAGS_P2P = BIT(3), 81 }; 82 83 /* The default calibrate table size if not specified by firmware file */ 84 #define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE 18 85 #define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE 19 86 #define IWL_MAX_PHY_CALIBRATE_TBL_SIZE 253 87 88 /** 89 * enum iwl_ucode_type 90 * 91 * The type of ucode. 92 * 93 * @IWL_UCODE_REGULAR: Normal runtime ucode 94 * @IWL_UCODE_INIT: Initial ucode 95 * @IWL_UCODE_WOWLAN: Wake on Wireless enabled ucode 96 */ 97 enum iwl_ucode_type { 98 IWL_UCODE_REGULAR, 99 IWL_UCODE_INIT, 100 IWL_UCODE_WOWLAN, 101 IWL_UCODE_TYPE_MAX, 102 }; 103 104 /* 105 * enumeration of ucode section. 106 * This enumeration is used for legacy tlv style (before 16.0 uCode). 107 */ 108 enum iwl_ucode_sec { 109 IWL_UCODE_SECTION_INST, 110 IWL_UCODE_SECTION_DATA, 111 }; 112 /* 113 * For 16.0 uCode and above, there is no differentiation between sections, 114 * just an offset to the HW address. 115 */ 116 #define IWL_UCODE_SECTION_MAX 4 117 118 struct iwl_ucode_capabilities { 119 u32 max_probe_length; 120 u32 standard_phy_calibration_size; 121 u32 flags; 122 }; 123 124 /* one for each uCode image (inst/data, init/runtime/wowlan) */ 125 struct fw_desc { 126 dma_addr_t p_addr; /* hardware address */ 127 void *v_addr; /* software address */ 128 u32 len; /* size in bytes */ 129 u32 offset; /* offset in the device */ 130 }; 131 132 struct fw_img { 133 struct fw_desc sec[IWL_UCODE_SECTION_MAX]; 134 }; 135 136 /* uCode version contains 4 values: Major/Minor/API/Serial */ 137 #define IWL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24) 138 #define IWL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16) 139 #define IWL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8) 140 #define IWL_UCODE_SERIAL(ver) ((ver) & 0x000000FF) 141 142 /** 143 * struct iwl_fw - variables associated with the firmware 144 * 145 * @ucode_ver: ucode version from the ucode file 146 * @fw_version: firmware version string 147 * @img: ucode image like ucode_rt, ucode_init, ucode_wowlan. 148 * @ucode_capa: capabilities parsed from the ucode file. 149 * @enhance_sensitivity_table: device can do enhanced sensitivity. 150 * @init_evtlog_ptr: event log offset for init ucode. 151 * @init_evtlog_size: event log size for init ucode. 152 * @init_errlog_ptr: error log offfset for init ucode. 153 * @inst_evtlog_ptr: event log offset for runtime ucode. 154 * @inst_evtlog_size: event log size for runtime ucode. 155 * @inst_errlog_ptr: error log offfset for runtime ucode. 156 */ 157 struct iwl_fw { 158 u32 ucode_ver; 159 160 char fw_version[ETHTOOL_BUSINFO_LEN]; 161 162 /* ucode images */ 163 struct fw_img img[IWL_UCODE_TYPE_MAX]; 164 165 struct iwl_ucode_capabilities ucode_capa; 166 bool enhance_sensitivity_table; 167 168 u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr; 169 u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr; 170 171 u64 default_calib[IWL_UCODE_TYPE_MAX]; 172 u32 phy_config; 173 174 bool mvm_fw; 175 }; 176 177 #endif /* __iwl_fw_h__ */ 178