drivers/net/wireless/iwlwifi/iwl-fw.h

   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  * @IWL_UCODE_TLV_FLAGS_UAPSD: This uCode image supports uAPSD
  78  * @IWL_UCODE_TLV_FLAGS_SHORT_BL: 16 entries of black list instead of 64 in scan
  79  *      offload profile config command.
  80  * @IWL_UCODE_TLV_FLAGS_RX_ENERGY_API: supports rx signal strength api
  81  * @IWL_UCODE_TLV_FLAGS_TIME_EVENT_API_V2: using the new time event API.
  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_BF_UPDATED: new beacon filtering API
  85  * @IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID: not sending a probe with the SSID element
  86  *      from the probe request template.
  87  * @IWL_UCODE_TLV_FLAGS_D3_CONTINUITY_API: modified D3 API to allow keeping
  88  *      connection when going back to D0
  89  * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL: new NS offload (small version)
  90  * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE: new NS offload (large version)
  91  * @IWL_UCODE_TLV_FLAGS_SCHED_SCAN: this uCode image supports scheduled scan.
  92  * @IWL_UCODE_TLV_FLAGS_STA_KEY_CMD: new ADD_STA and ADD_STA_KEY command API
  93  * @IWL_UCODE_TLV_FLAGS_DEVICE_PS_CMD: support device wide power command
  94  *      containing CAM (Continuous Active Mode) indication.
  95  */
  96 enum iwl_ucode_tlv_flag {
  97         IWL_UCODE_TLV_FLAGS_PAN                 = BIT(0),
  98         IWL_UCODE_TLV_FLAGS_NEWSCAN             = BIT(1),
  99         IWL_UCODE_TLV_FLAGS_MFP                 = BIT(2),
 100         IWL_UCODE_TLV_FLAGS_P2P                 = BIT(3),
 101         IWL_UCODE_TLV_FLAGS_DW_BC_TABLE         = BIT(4),
 102         IWL_UCODE_TLV_FLAGS_NEWBT_COEX          = BIT(5),
 103         IWL_UCODE_TLV_FLAGS_PM_CMD_SUPPORT      = BIT(6),
 104         IWL_UCODE_TLV_FLAGS_SHORT_BL            = BIT(7),
 105         IWL_UCODE_TLV_FLAGS_RX_ENERGY_API       = BIT(8),
 106         IWL_UCODE_TLV_FLAGS_TIME_EVENT_API_V2   = BIT(9),
 107         IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS     = BIT(10),
 108         IWL_UCODE_TLV_FLAGS_BF_UPDATED          = BIT(11),
 109         IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID       = BIT(12),
 110         IWL_UCODE_TLV_FLAGS_D3_CONTINUITY_API   = BIT(14),
 111         IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL    = BIT(15),
 112         IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE    = BIT(16),
 113         IWL_UCODE_TLV_FLAGS_SCHED_SCAN          = BIT(17),
 114         IWL_UCODE_TLV_FLAGS_STA_KEY_CMD         = BIT(19),
 115         IWL_UCODE_TLV_FLAGS_DEVICE_PS_CMD       = BIT(20),
 116         IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT       = BIT(24),
 117 };
 118
 119 /* The default calibrate table size if not specified by firmware file */
 120 #define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE     18
 121 #define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE         19
 122 #define IWL_MAX_PHY_CALIBRATE_TBL_SIZE                  253
 123
 124 /* The default max probe length if not specified by the firmware file */
 125 #define IWL_DEFAULT_MAX_PROBE_LENGTH    200
 126
 127 /**
 128  * enum iwl_ucode_type
 129  *
 130  * The type of ucode.
 131  *
 132  * @IWL_UCODE_REGULAR: Normal runtime ucode
 133  * @IWL_UCODE_INIT: Initial ucode
 134  * @IWL_UCODE_WOWLAN: Wake on Wireless enabled ucode
 135  */
 136 enum iwl_ucode_type {
 137         IWL_UCODE_REGULAR,
 138         IWL_UCODE_INIT,
 139         IWL_UCODE_WOWLAN,
 140         IWL_UCODE_TYPE_MAX,
 141 };
 142
 143 /*
 144  * enumeration of ucode section.
 145  * This enumeration is used directly for older firmware (before 16.0).
 146  * For new firmware, there can be up to 4 sections (see below) but the
 147  * first one packaged into the firmware file is the DATA section and
 148  * some debugging code accesses that.
 149  */
 150 enum iwl_ucode_sec {
 151         IWL_UCODE_SECTION_DATA,
 152         IWL_UCODE_SECTION_INST,
 153 };
 154 /*
 155  * For 16.0 uCode and above, there is no differentiation between sections,
 156  * just an offset to the HW address.
 157  */
 158 #define IWL_UCODE_SECTION_MAX 6
 159 #define IWL_UCODE_FIRST_SECTION_OF_SECOND_CPU   (IWL_UCODE_SECTION_MAX/2)
 160
 161 struct iwl_ucode_capabilities {
 162         u32 max_probe_length;
 163         u32 standard_phy_calibration_size;
 164         u32 flags;
 165 };
 166
 167 /* one for each uCode image (inst/data, init/runtime/wowlan) */
 168 struct fw_desc {
 169         const void *data;       /* vmalloc'ed data */
 170         u32 len;                /* size in bytes */
 171         u32 offset;             /* offset in the device */
 172 };
 173
 174 struct fw_img {
 175         struct fw_desc sec[IWL_UCODE_SECTION_MAX];
 176         bool is_secure;
 177         bool is_dual_cpus;
 178 };
 179
 180 /* uCode version contains 4 values: Major/Minor/API/Serial */
 181 #define IWL_UCODE_MAJOR(ver)    (((ver) & 0xFF000000) >> 24)
 182 #define IWL_UCODE_MINOR(ver)    (((ver) & 0x00FF0000) >> 16)
 183 #define IWL_UCODE_API(ver)      (((ver) & 0x0000FF00) >> 8)
 184 #define IWL_UCODE_SERIAL(ver)   ((ver) & 0x000000FF)
 185
 186 /*
 187  * Calibration control struct.
 188  * Sent as part of the phy configuration command.
 189  * @flow_trigger: bitmap for which calibrations to perform according to
 190  *              flow triggers.
 191  * @event_trigger: bitmap for which calibrations to perform according to
 192  *              event triggers.
 193  */
 194 struct iwl_tlv_calib_ctrl {
 195         __le32 flow_trigger;
 196         __le32 event_trigger;
 197 } __packed;
 198
 199 enum iwl_fw_phy_cfg {
 200         FW_PHY_CFG_RADIO_TYPE_POS = 0,
 201         FW_PHY_CFG_RADIO_TYPE = 0x3 << FW_PHY_CFG_RADIO_TYPE_POS,
 202         FW_PHY_CFG_RADIO_STEP_POS = 2,
 203         FW_PHY_CFG_RADIO_STEP = 0x3 << FW_PHY_CFG_RADIO_STEP_POS,
 204         FW_PHY_CFG_RADIO_DASH_POS = 4,
 205         FW_PHY_CFG_RADIO_DASH = 0x3 << FW_PHY_CFG_RADIO_DASH_POS,
 206         FW_PHY_CFG_TX_CHAIN_POS = 16,
 207         FW_PHY_CFG_TX_CHAIN = 0xf << FW_PHY_CFG_TX_CHAIN_POS,
 208         FW_PHY_CFG_RX_CHAIN_POS = 20,
 209         FW_PHY_CFG_RX_CHAIN = 0xf << FW_PHY_CFG_RX_CHAIN_POS,
 210 };
 211
 212 #define IWL_UCODE_MAX_CS                1
 213
 214 /**
 215  * struct iwl_fw_cipher_scheme - a cipher scheme supported by FW.
 216  * @cipher: a cipher suite selector
 217  * @flags: cipher scheme flags (currently reserved for a future use)
 218  * @hdr_len: a size of MPDU security header
 219  * @pn_len: a size of PN
 220  * @pn_off: an offset of pn from the beginning of the security header
 221  * @key_idx_off: an offset of key index byte in the security header
 222  * @key_idx_mask: a bit mask of key_idx bits
 223  * @key_idx_shift: bit shift needed to get key_idx
 224  * @mic_len: mic length in bytes
 225  * @hw_cipher: a HW cipher index used in host commands
 226  */
 227 struct iwl_fw_cipher_scheme {
 228         __le32 cipher;
 229         u8 flags;
 230         u8 hdr_len;
 231         u8 pn_len;
 232         u8 pn_off;
 233         u8 key_idx_off;
 234         u8 key_idx_mask;
 235         u8 key_idx_shift;
 236         u8 mic_len;
 237         u8 hw_cipher;
 238 } __packed;
 239
 240 /**
 241  * struct iwl_fw_cscheme_list - a cipher scheme list
 242  * @size: a number of entries
 243  * @cs: cipher scheme entries
 244  */
 245 struct iwl_fw_cscheme_list {
 246         u8 size;
 247         struct iwl_fw_cipher_scheme cs[];
 248 } __packed;
 249
 250 /**
 251  * struct iwl_fw - variables associated with the firmware
 252  *
 253  * @ucode_ver: ucode version from the ucode file
 254  * @fw_version: firmware version string
 255  * @img: ucode image like ucode_rt, ucode_init, ucode_wowlan.
 256  * @ucode_capa: capabilities parsed from the ucode file.
 257  * @enhance_sensitivity_table: device can do enhanced sensitivity.
 258  * @init_evtlog_ptr: event log offset for init ucode.
 259  * @init_evtlog_size: event log size for init ucode.
 260  * @init_errlog_ptr: error log offfset for init ucode.
 261  * @inst_evtlog_ptr: event log offset for runtime ucode.
 262  * @inst_evtlog_size: event log size for runtime ucode.
 263  * @inst_errlog_ptr: error log offfset for runtime ucode.
 264  * @mvm_fw: indicates this is MVM firmware
 265  * @cipher_scheme: optional external cipher scheme.
 266  */
 267 struct iwl_fw {
 268         u32 ucode_ver;
 269
 270         char fw_version[ETHTOOL_FWVERS_LEN];
 271
 272         /* ucode images */
 273         struct fw_img img[IWL_UCODE_TYPE_MAX];
 274
 275         struct iwl_ucode_capabilities ucode_capa;
 276         bool enhance_sensitivity_table;
 277
 278         u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
 279         u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
 280
 281         struct iwl_tlv_calib_ctrl default_calib[IWL_UCODE_TYPE_MAX];
 282         u32 phy_config;
 283
 284         bool mvm_fw;
 285
 286         struct ieee80211_cipher_scheme cs[IWL_UCODE_MAX_CS];
 287 };
 288
 289 static inline u8 iwl_fw_valid_tx_ant(const struct iwl_fw *fw)
 290 {
 291         return (fw->phy_config & FW_PHY_CFG_TX_CHAIN) >>
 292                 FW_PHY_CFG_TX_CHAIN_POS;
 293 }
 294
 295 static inline u8 iwl_fw_valid_rx_ant(const struct iwl_fw *fw)
 296 {
 297         return (fw->phy_config & FW_PHY_CFG_RX_CHAIN) >>
 298                 FW_PHY_CFG_RX_CHAIN_POS;
 299 }
 300
 301 #endif  /* __iwl_fw_h__ */