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 - 2014 Intel Corporation. All rights reserved.
   9  * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
  10  *
  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.
  14  *
  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.
  19  *
  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,
  23  * USA
  24  *
  25  * The full GNU General Public License is included in this distribution
  26  * in the file called COPYING.
  27  *
  28  * Contact Information:
  29  *  Intel Linux Wireless <ilw@linux.intel.com>
  30  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  31  *
  32  * BSD LICENSE
  33  *
  34  * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
  35  * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
  36  * All rights reserved.
  37  *
  38  * Redistribution and use in source and binary forms, with or without
  39  * modification, are permitted provided that the following conditions
  40  * are met:
  41  *
  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
  47  *    distribution.
  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.
  51  *
  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  *****************************************************************************/
  64
  65 #ifndef __iwl_fw_h__
  66 #define __iwl_fw_h__
  67 #include <linux/types.h>
  68 #include <net/mac80211.h>
  69
  70 #include "iwl-fw-file.h"
  71
  72 /**
  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.
 100  */
 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),
 120 };
 121
 122 /**
 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.
 133  */
 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),
 143 };
 144
 145 /**
 146  * enum iwl_ucode_tlv_capa - ucode capabilities
 147  * @IWL_UCODE_TLV_CAPA_D0I3_SUPPORT: supports D0i3
 148  * @IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT: supports insertion of current
 149  *      tx power value into TPC Report action frame and Link Measurement Report
 150  *      action frame
 151  * @IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT: supports adding DS params
 152  *      element in probe requests.
 153  * @IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT: supports adding TPC Report IE in
 154  *      probe requests.
 155  * @IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT: supports Quiet Period requests
 156  * @IWL_UCODE_TLV_CAPA_DQA_SUPPORT: supports dynamic queue allocation (DQA),
 157  *      which also implies support for the scheduler configuration command
 158  * @IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT: supports Hot Spot Command
 159  */
 160 enum iwl_ucode_tlv_capa {
 161         IWL_UCODE_TLV_CAPA_D0I3_SUPPORT                 = BIT(0),
 162         IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT    = BIT(8),
 163         IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT      = BIT(9),
 164         IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT       = BIT(10),
 165         IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT         = BIT(11),
 166         IWL_UCODE_TLV_CAPA_DQA_SUPPORT                  = BIT(12),
 167         IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT              = BIT(18),
 168 };
 169
 170 /* The default calibrate table size if not specified by firmware file */
 171 #define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE     18
 172 #define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE         19
 173 #define IWL_MAX_PHY_CALIBRATE_TBL_SIZE                  253
 174
 175 /* The default max probe length if not specified by the firmware file */
 176 #define IWL_DEFAULT_MAX_PROBE_LENGTH    200
 177
 178 /**
 179  * enum iwl_ucode_type
 180  *
 181  * The type of ucode.
 182  *
 183  * @IWL_UCODE_REGULAR: Normal runtime ucode
 184  * @IWL_UCODE_INIT: Initial ucode
 185  * @IWL_UCODE_WOWLAN: Wake on Wireless enabled ucode
 186  */
 187 enum iwl_ucode_type {
 188         IWL_UCODE_REGULAR,
 189         IWL_UCODE_INIT,
 190         IWL_UCODE_WOWLAN,
 191         IWL_UCODE_TYPE_MAX,
 192 };
 193
 194 /*
 195  * enumeration of ucode section.
 196  * This enumeration is used directly for older firmware (before 16.0).
 197  * For new firmware, there can be up to 4 sections (see below) but the
 198  * first one packaged into the firmware file is the DATA section and
 199  * some debugging code accesses that.
 200  */
 201 enum iwl_ucode_sec {
 202         IWL_UCODE_SECTION_DATA,
 203         IWL_UCODE_SECTION_INST,
 204 };
 205 /*
 206  * For 16.0 uCode and above, there is no differentiation between sections,
 207  * just an offset to the HW address.
 208  */
 209 #define IWL_UCODE_SECTION_MAX 12
 210 #define IWL_API_ARRAY_SIZE      1
 211 #define IWL_CAPABILITIES_ARRAY_SIZE     1
 212 #define CPU1_CPU2_SEPARATOR_SECTION     0xFFFFCCCC
 213
 214 struct iwl_ucode_capabilities {
 215         u32 max_probe_length;
 216         u32 n_scan_channels;
 217         u32 standard_phy_calibration_size;
 218         u32 flags;
 219         u32 api[IWL_API_ARRAY_SIZE];
 220         u32 capa[IWL_CAPABILITIES_ARRAY_SIZE];
 221 };
 222
 223 /* one for each uCode image (inst/data, init/runtime/wowlan) */
 224 struct fw_desc {
 225         const void *data;       /* vmalloc'ed data */
 226         u32 len;                /* size in bytes */
 227         u32 offset;             /* offset in the device */
 228 };
 229
 230 struct fw_img {
 231         struct fw_desc sec[IWL_UCODE_SECTION_MAX];
 232         bool is_dual_cpus;
 233 };
 234
 235 struct iwl_sf_region {
 236         u32 addr;
 237         u32 size;
 238 };
 239
 240 /* uCode version contains 4 values: Major/Minor/API/Serial */
 241 #define IWL_UCODE_MAJOR(ver)    (((ver) & 0xFF000000) >> 24)
 242 #define IWL_UCODE_MINOR(ver)    (((ver) & 0x00FF0000) >> 16)
 243 #define IWL_UCODE_API(ver)      (((ver) & 0x0000FF00) >> 8)
 244 #define IWL_UCODE_SERIAL(ver)   ((ver) & 0x000000FF)
 245
 246 /*
 247  * Calibration control struct.
 248  * Sent as part of the phy configuration command.
 249  * @flow_trigger: bitmap for which calibrations to perform according to
 250  *              flow triggers.
 251  * @event_trigger: bitmap for which calibrations to perform according to
 252  *              event triggers.
 253  */
 254 struct iwl_tlv_calib_ctrl {
 255         __le32 flow_trigger;
 256         __le32 event_trigger;
 257 } __packed;
 258
 259 enum iwl_fw_phy_cfg {
 260         FW_PHY_CFG_RADIO_TYPE_POS = 0,
 261         FW_PHY_CFG_RADIO_TYPE = 0x3 << FW_PHY_CFG_RADIO_TYPE_POS,
 262         FW_PHY_CFG_RADIO_STEP_POS = 2,
 263         FW_PHY_CFG_RADIO_STEP = 0x3 << FW_PHY_CFG_RADIO_STEP_POS,
 264         FW_PHY_CFG_RADIO_DASH_POS = 4,
 265         FW_PHY_CFG_RADIO_DASH = 0x3 << FW_PHY_CFG_RADIO_DASH_POS,
 266         FW_PHY_CFG_TX_CHAIN_POS = 16,
 267         FW_PHY_CFG_TX_CHAIN = 0xf << FW_PHY_CFG_TX_CHAIN_POS,
 268         FW_PHY_CFG_RX_CHAIN_POS = 20,
 269         FW_PHY_CFG_RX_CHAIN = 0xf << FW_PHY_CFG_RX_CHAIN_POS,
 270 };
 271
 272 #define IWL_UCODE_MAX_CS                1
 273
 274 /**
 275  * struct iwl_fw_cipher_scheme - a cipher scheme supported by FW.
 276  * @cipher: a cipher suite selector
 277  * @flags: cipher scheme flags (currently reserved for a future use)
 278  * @hdr_len: a size of MPDU security header
 279  * @pn_len: a size of PN
 280  * @pn_off: an offset of pn from the beginning of the security header
 281  * @key_idx_off: an offset of key index byte in the security header
 282  * @key_idx_mask: a bit mask of key_idx bits
 283  * @key_idx_shift: bit shift needed to get key_idx
 284  * @mic_len: mic length in bytes
 285  * @hw_cipher: a HW cipher index used in host commands
 286  */
 287 struct iwl_fw_cipher_scheme {
 288         __le32 cipher;
 289         u8 flags;
 290         u8 hdr_len;
 291         u8 pn_len;
 292         u8 pn_off;
 293         u8 key_idx_off;
 294         u8 key_idx_mask;
 295         u8 key_idx_shift;
 296         u8 mic_len;
 297         u8 hw_cipher;
 298 } __packed;
 299
 300 /**
 301  * struct iwl_fw_cscheme_list - a cipher scheme list
 302  * @size: a number of entries
 303  * @cs: cipher scheme entries
 304  */
 305 struct iwl_fw_cscheme_list {
 306         u8 size;
 307         struct iwl_fw_cipher_scheme cs[];
 308 } __packed;
 309
 310 /**
 311  * struct iwl_fw - variables associated with the firmware
 312  *
 313  * @ucode_ver: ucode version from the ucode file
 314  * @fw_version: firmware version string
 315  * @img: ucode image like ucode_rt, ucode_init, ucode_wowlan.
 316  * @ucode_capa: capabilities parsed from the ucode file.
 317  * @enhance_sensitivity_table: device can do enhanced sensitivity.
 318  * @init_evtlog_ptr: event log offset for init ucode.
 319  * @init_evtlog_size: event log size for init ucode.
 320  * @init_errlog_ptr: error log offfset for init ucode.
 321  * @inst_evtlog_ptr: event log offset for runtime ucode.
 322  * @inst_evtlog_size: event log size for runtime ucode.
 323  * @inst_errlog_ptr: error log offfset for runtime ucode.
 324  * @mvm_fw: indicates this is MVM firmware
 325  * @cipher_scheme: optional external cipher scheme.
 326  */
 327 struct iwl_fw {
 328         u32 ucode_ver;
 329
 330         char fw_version[ETHTOOL_FWVERS_LEN];
 331
 332         /* ucode images */
 333         struct fw_img img[IWL_UCODE_TYPE_MAX];
 334
 335         struct iwl_ucode_capabilities ucode_capa;
 336         bool enhance_sensitivity_table;
 337
 338         u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
 339         u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
 340
 341         struct iwl_tlv_calib_ctrl default_calib[IWL_UCODE_TYPE_MAX];
 342         u32 phy_config;
 343         u8 valid_tx_ant;
 344         u8 valid_rx_ant;
 345
 346         bool mvm_fw;
 347
 348         struct ieee80211_cipher_scheme cs[IWL_UCODE_MAX_CS];
 349         u8 human_readable[FW_VER_HUMAN_READABLE_SZ];
 350 };
 351
 352 #endif  /* __iwl_fw_h__ */