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 - 2015 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 - 2015 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 #include "iwl-fw-error-dump.h"
  72
  73 /**
  74  * enum iwl_ucode_type
  75  *
  76  * The type of ucode.
  77  *
  78  * @IWL_UCODE_REGULAR: Normal runtime ucode
  79  * @IWL_UCODE_INIT: Initial ucode
  80  * @IWL_UCODE_WOWLAN: Wake on Wireless enabled ucode
  81  * @IWL_UCODE_REGULAR_USNIFFER: Normal runtime ucode when using usniffer image
  82  */
  83 enum iwl_ucode_type {
  84         IWL_UCODE_REGULAR,
  85         IWL_UCODE_INIT,
  86         IWL_UCODE_WOWLAN,
  87         IWL_UCODE_REGULAR_USNIFFER,
  88         IWL_UCODE_TYPE_MAX,
  89 };
  90
  91 /*
  92  * enumeration of ucode section.
  93  * This enumeration is used directly for older firmware (before 16.0).
  94  * For new firmware, there can be up to 4 sections (see below) but the
  95  * first one packaged into the firmware file is the DATA section and
  96  * some debugging code accesses that.
  97  */
  98 enum iwl_ucode_sec {
  99         IWL_UCODE_SECTION_DATA,
 100         IWL_UCODE_SECTION_INST,
 101 };
 102
 103 struct iwl_ucode_capabilities {
 104         u32 max_probe_length;
 105         u32 n_scan_channels;
 106         u32 standard_phy_calibration_size;
 107         u32 flags;
 108         unsigned long _api[BITS_TO_LONGS(NUM_IWL_UCODE_TLV_API)];
 109         unsigned long _capa[BITS_TO_LONGS(NUM_IWL_UCODE_TLV_CAPA)];
 110 };
 111
 112 static inline bool
 113 fw_has_api(const struct iwl_ucode_capabilities *capabilities,
 114            iwl_ucode_tlv_api_t api)
 115 {
 116         return test_bit((__force long)api, capabilities->_api);
 117 }
 118
 119 static inline bool
 120 fw_has_capa(const struct iwl_ucode_capabilities *capabilities,
 121             iwl_ucode_tlv_capa_t capa)
 122 {
 123         return test_bit((__force long)capa, capabilities->_capa);
 124 }
 125
 126 /* one for each uCode image (inst/data, init/runtime/wowlan) */
 127 struct fw_desc {
 128         const void *data;       /* vmalloc'ed data */
 129         u32 len;                /* size in bytes */
 130         u32 offset;             /* offset in the device */
 131 };
 132
 133 struct fw_img {
 134         struct fw_desc sec[IWL_UCODE_SECTION_MAX];
 135         bool is_dual_cpus;
 136         u32 paging_mem_size;
 137 };
 138
 139 struct iwl_sf_region {
 140         u32 addr;
 141         u32 size;
 142 };
 143
 144 /*
 145  * Block paging calculations
 146  */
 147 #define PAGE_2_EXP_SIZE 12 /* 4K == 2^12 */
 148 #define FW_PAGING_SIZE BIT(PAGE_2_EXP_SIZE) /* page size is 4KB */
 149 #define PAGE_PER_GROUP_2_EXP_SIZE 3
 150 /* 8 pages per group */
 151 #define NUM_OF_PAGE_PER_GROUP BIT(PAGE_PER_GROUP_2_EXP_SIZE)
 152 /* don't change, support only 32KB size */
 153 #define PAGING_BLOCK_SIZE (NUM_OF_PAGE_PER_GROUP * FW_PAGING_SIZE)
 154 /* 32K == 2^15 */
 155 #define BLOCK_2_EXP_SIZE (PAGE_2_EXP_SIZE + PAGE_PER_GROUP_2_EXP_SIZE)
 156
 157 /*
 158  * Image paging calculations
 159  */
 160 #define BLOCK_PER_IMAGE_2_EXP_SIZE 5
 161 /* 2^5 == 32 blocks per image */
 162 #define NUM_OF_BLOCK_PER_IMAGE BIT(BLOCK_PER_IMAGE_2_EXP_SIZE)
 163 /* maximum image size 1024KB */
 164 #define MAX_PAGING_IMAGE_SIZE (NUM_OF_BLOCK_PER_IMAGE * PAGING_BLOCK_SIZE)
 165
 166 /* Virtual address signature */
 167 #define PAGING_ADDR_SIG 0xAA000000
 168
 169 #define PAGING_CMD_IS_SECURED BIT(9)
 170 #define PAGING_CMD_IS_ENABLED BIT(8)
 171 #define PAGING_CMD_NUM_OF_PAGES_IN_LAST_GRP_POS 0
 172 #define PAGING_TLV_SECURE_MASK 1
 173
 174 /**
 175  * struct iwl_fw_paging
 176  * @fw_paging_phys: page phy pointer
 177  * @fw_paging_block: pointer to the allocated block
 178  * @fw_paging_size: page size
 179  */
 180 struct iwl_fw_paging {
 181         dma_addr_t fw_paging_phys;
 182         struct page *fw_paging_block;
 183         u32 fw_paging_size;
 184 };
 185
 186 /**
 187  * struct iwl_fw_cscheme_list - a cipher scheme list
 188  * @size: a number of entries
 189  * @cs: cipher scheme entries
 190  */
 191 struct iwl_fw_cscheme_list {
 192         u8 size;
 193         struct iwl_fw_cipher_scheme cs[];
 194 } __packed;
 195
 196 /**
 197  * struct iwl_gscan_capabilities - gscan capabilities supported by FW
 198  * @max_scan_cache_size: total space allocated for scan results (in bytes).
 199  * @max_scan_buckets: maximum number of channel buckets.
 200  * @max_ap_cache_per_scan: maximum number of APs that can be stored per scan.
 201  * @max_rssi_sample_size: number of RSSI samples used for averaging RSSI.
 202  * @max_scan_reporting_threshold: max possible report threshold. in percentage.
 203  * @max_hotlist_aps: maximum number of entries for hotlist APs.
 204  * @max_significant_change_aps: maximum number of entries for significant
 205  *      change APs.
 206  * @max_bssid_history_entries: number of BSSID/RSSI entries that the device can
 207  *      hold.
 208  */
 209 struct iwl_gscan_capabilities {
 210         u32 max_scan_cache_size;
 211         u32 max_scan_buckets;
 212         u32 max_ap_cache_per_scan;
 213         u32 max_rssi_sample_size;
 214         u32 max_scan_reporting_threshold;
 215         u32 max_hotlist_aps;
 216         u32 max_significant_change_aps;
 217         u32 max_bssid_history_entries;
 218 };
 219
 220 /**
 221  * struct iwl_fw - variables associated with the firmware
 222  *
 223  * @ucode_ver: ucode version from the ucode file
 224  * @fw_version: firmware version string
 225  * @img: ucode image like ucode_rt, ucode_init, ucode_wowlan.
 226  * @ucode_capa: capabilities parsed from the ucode file.
 227  * @enhance_sensitivity_table: device can do enhanced sensitivity.
 228  * @init_evtlog_ptr: event log offset for init ucode.
 229  * @init_evtlog_size: event log size for init ucode.
 230  * @init_errlog_ptr: error log offfset for init ucode.
 231  * @inst_evtlog_ptr: event log offset for runtime ucode.
 232  * @inst_evtlog_size: event log size for runtime ucode.
 233  * @inst_errlog_ptr: error log offfset for runtime ucode.
 234  * @mvm_fw: indicates this is MVM firmware
 235  * @cipher_scheme: optional external cipher scheme.
 236  * @human_readable: human readable version
 237  * @sdio_adma_addr: the default address to set for the ADMA in SDIO mode until
 238  *      we get the ALIVE from the uCode
 239  * @dbg_dest_tlv: points to the destination TLV for debug
 240  * @dbg_conf_tlv: array of pointers to configuration TLVs for debug
 241  * @dbg_conf_tlv_len: lengths of the @dbg_conf_tlv entries
 242  * @dbg_trigger_tlv: array of pointers to triggers TLVs
 243  * @dbg_trigger_tlv_len: lengths of the @dbg_trigger_tlv entries
 244  * @dbg_dest_reg_num: num of reg_ops in %dbg_dest_tlv
 245  */
 246 struct iwl_fw {
 247         u32 ucode_ver;
 248
 249         char fw_version[ETHTOOL_FWVERS_LEN];
 250
 251         /* ucode images */
 252         struct fw_img img[IWL_UCODE_TYPE_MAX];
 253
 254         struct iwl_ucode_capabilities ucode_capa;
 255         bool enhance_sensitivity_table;
 256
 257         u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
 258         u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
 259
 260         struct iwl_tlv_calib_ctrl default_calib[IWL_UCODE_TYPE_MAX];
 261         u32 phy_config;
 262         u8 valid_tx_ant;
 263         u8 valid_rx_ant;
 264
 265         bool mvm_fw;
 266
 267         struct ieee80211_cipher_scheme cs[IWL_UCODE_MAX_CS];
 268         u8 human_readable[FW_VER_HUMAN_READABLE_SZ];
 269
 270         u32 sdio_adma_addr;
 271
 272         struct iwl_fw_dbg_dest_tlv *dbg_dest_tlv;
 273         struct iwl_fw_dbg_conf_tlv *dbg_conf_tlv[FW_DBG_CONF_MAX];
 274         size_t dbg_conf_tlv_len[FW_DBG_CONF_MAX];
 275         struct iwl_fw_dbg_trigger_tlv *dbg_trigger_tlv[FW_DBG_TRIGGER_MAX];
 276         size_t dbg_trigger_tlv_len[FW_DBG_TRIGGER_MAX];
 277         u8 dbg_dest_reg_num;
 278         struct iwl_gscan_capabilities gscan_capa;
 279 };
 280
 281 static inline const char *get_fw_dbg_mode_string(int mode)
 282 {
 283         switch (mode) {
 284         case SMEM_MODE:
 285                 return "SMEM";
 286         case EXTERNAL_MODE:
 287                 return "EXTERNAL_DRAM";
 288         case MARBH_MODE:
 289                 return "MARBH";
 290         case MIPI_MODE:
 291                 return "MIPI";
 292         default:
 293                 return "UNKNOWN";
 294         }
 295 }
 296
 297 static inline bool
 298 iwl_fw_dbg_conf_usniffer(const struct iwl_fw *fw, u8 id)
 299 {
 300         const struct iwl_fw_dbg_conf_tlv *conf_tlv = fw->dbg_conf_tlv[id];
 301
 302         if (!conf_tlv)
 303                 return false;
 304
 305         return conf_tlv->usniffer;
 306 }
 307
 308 #define iwl_fw_dbg_trigger_enabled(fw, id) ({                   \
 309         void *__dbg_trigger = (fw)->dbg_trigger_tlv[(id)];      \
 310         unlikely(__dbg_trigger);                                \
 311 })
 312
 313 static inline struct iwl_fw_dbg_trigger_tlv*
 314 iwl_fw_dbg_get_trigger(const struct iwl_fw *fw, u8 id)
 315 {
 316         if (WARN_ON(id >= ARRAY_SIZE(fw->dbg_trigger_tlv)))
 317                 return NULL;
 318
 319         return fw->dbg_trigger_tlv[id];
 320 }
 321
 322 #endif  /* __iwl_fw_h__ */