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_type
  74  *
  75  * The type of ucode.
  76  *
  77  * @IWL_UCODE_REGULAR: Normal runtime ucode
  78  * @IWL_UCODE_INIT: Initial ucode
  79  * @IWL_UCODE_WOWLAN: Wake on Wireless enabled ucode
  80  * @IWL_UCODE_REGULAR_USNIFFER: Normal runtime ucode when using usniffer image
  81  */
  82 enum iwl_ucode_type {
  83         IWL_UCODE_REGULAR,
  84         IWL_UCODE_INIT,
  85         IWL_UCODE_WOWLAN,
  86         IWL_UCODE_REGULAR_USNIFFER,
  87         IWL_UCODE_TYPE_MAX,
  88 };
  89
  90 /*
  91  * enumeration of ucode section.
  92  * This enumeration is used directly for older firmware (before 16.0).
  93  * For new firmware, there can be up to 4 sections (see below) but the
  94  * first one packaged into the firmware file is the DATA section and
  95  * some debugging code accesses that.
  96  */
  97 enum iwl_ucode_sec {
  98         IWL_UCODE_SECTION_DATA,
  99         IWL_UCODE_SECTION_INST,
 100 };
 101
 102 struct iwl_ucode_capabilities {
 103         u32 max_probe_length;
 104         u32 n_scan_channels;
 105         u32 standard_phy_calibration_size;
 106         u32 flags;
 107         u32 api[IWL_API_ARRAY_SIZE];
 108         u32 capa[IWL_CAPABILITIES_ARRAY_SIZE];
 109 };
 110
 111 /* one for each uCode image (inst/data, init/runtime/wowlan) */
 112 struct fw_desc {
 113         const void *data;       /* vmalloc'ed data */
 114         u32 len;                /* size in bytes */
 115         u32 offset;             /* offset in the device */
 116 };
 117
 118 struct fw_img {
 119         struct fw_desc sec[IWL_UCODE_SECTION_MAX];
 120         bool is_dual_cpus;
 121 };
 122
 123 struct iwl_sf_region {
 124         u32 addr;
 125         u32 size;
 126 };
 127
 128 /**
 129  * struct iwl_fw_cscheme_list - a cipher scheme list
 130  * @size: a number of entries
 131  * @cs: cipher scheme entries
 132  */
 133 struct iwl_fw_cscheme_list {
 134         u8 size;
 135         struct iwl_fw_cipher_scheme cs[];
 136 } __packed;
 137
 138 /**
 139  * struct iwl_fw - variables associated with the firmware
 140  *
 141  * @ucode_ver: ucode version from the ucode file
 142  * @fw_version: firmware version string
 143  * @img: ucode image like ucode_rt, ucode_init, ucode_wowlan.
 144  * @ucode_capa: capabilities parsed from the ucode file.
 145  * @enhance_sensitivity_table: device can do enhanced sensitivity.
 146  * @init_evtlog_ptr: event log offset for init ucode.
 147  * @init_evtlog_size: event log size for init ucode.
 148  * @init_errlog_ptr: error log offfset for init ucode.
 149  * @inst_evtlog_ptr: event log offset for runtime ucode.
 150  * @inst_evtlog_size: event log size for runtime ucode.
 151  * @inst_errlog_ptr: error log offfset for runtime ucode.
 152  * @mvm_fw: indicates this is MVM firmware
 153  * @cipher_scheme: optional external cipher scheme.
 154  * @human_readable: human readable version
 155  * @dbg_dest_tlv: points to the destination TLV for debug
 156  * @dbg_conf_tlv: array of pointers to configuration TLVs for debug
 157  * @dbg_conf_tlv_len: lengths of the @dbg_conf_tlv entries
 158  * @dbg_dest_reg_num: num of reg_ops in %dbg_dest_tlv
 159  */
 160 struct iwl_fw {
 161         u32 ucode_ver;
 162
 163         char fw_version[ETHTOOL_FWVERS_LEN];
 164
 165         /* ucode images */
 166         struct fw_img img[IWL_UCODE_TYPE_MAX];
 167
 168         struct iwl_ucode_capabilities ucode_capa;
 169         bool enhance_sensitivity_table;
 170
 171         u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
 172         u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
 173
 174         struct iwl_tlv_calib_ctrl default_calib[IWL_UCODE_TYPE_MAX];
 175         u32 phy_config;
 176         u8 valid_tx_ant;
 177         u8 valid_rx_ant;
 178
 179         bool mvm_fw;
 180
 181         struct ieee80211_cipher_scheme cs[IWL_UCODE_MAX_CS];
 182         u8 human_readable[FW_VER_HUMAN_READABLE_SZ];
 183
 184         struct iwl_fw_dbg_dest_tlv *dbg_dest_tlv;
 185         struct iwl_fw_dbg_conf_tlv *dbg_conf_tlv[FW_DBG_MAX];
 186         size_t dbg_conf_tlv_len[FW_DBG_MAX];
 187
 188         u8 dbg_dest_reg_num;
 189 };
 190
 191 static inline const char *get_fw_dbg_mode_string(int mode)
 192 {
 193         switch (mode) {
 194         case SMEM_MODE:
 195                 return "SMEM";
 196         case EXTERNAL_MODE:
 197                 return "EXTERNAL_DRAM";
 198         case MARBH_MODE:
 199                 return "MARBH";
 200         default:
 201                 return "UNKNOWN";
 202         }
 203 }
 204
 205 static inline const struct iwl_fw_dbg_trigger *
 206 iwl_fw_dbg_conf_get_trigger(const struct iwl_fw *fw, u8 id)
 207 {
 208         const struct iwl_fw_dbg_conf_tlv *conf_tlv = fw->dbg_conf_tlv[id];
 209         u8 *ptr;
 210         int i;
 211
 212         if (!conf_tlv)
 213                 return NULL;
 214
 215         ptr = (void *)&conf_tlv->hcmd;
 216         for (i = 0; i < conf_tlv->num_of_hcmds; i++) {
 217                 ptr += sizeof(conf_tlv->hcmd);
 218                 ptr += le16_to_cpu(conf_tlv->hcmd.len);
 219         }
 220
 221         return (const struct iwl_fw_dbg_trigger *)ptr;
 222 }
 223
 224 static inline bool
 225 iwl_fw_dbg_conf_enabled(const struct iwl_fw *fw, u8 id)
 226 {
 227         const struct iwl_fw_dbg_trigger *trigger =
 228                 iwl_fw_dbg_conf_get_trigger(fw, id);
 229
 230         if (!trigger)
 231                 return false;
 232
 233         return trigger->enabled;
 234 }
 235
 236 static inline bool
 237 iwl_fw_dbg_conf_usniffer(const struct iwl_fw *fw, u8 id)
 238 {
 239         const struct iwl_fw_dbg_conf_tlv *conf_tlv = fw->dbg_conf_tlv[id];
 240
 241         if (!conf_tlv)
 242                 return false;
 243
 244         return conf_tlv->usniffer;
 245 }
 246
 247 #endif  /* __iwl_fw_h__ */