drivers/net/wireless/iwlwifi/iwl-shared.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) 2007 - 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_shared_h__
  64 #define __iwl_shared_h__
  65
  66 #include <linux/types.h>
  67 #include <linux/spinlock.h>
  68 #include <linux/gfp.h>
  69 #include <net/mac80211.h>
  70
  71 #include "iwl-commands.h"
  72 #include "iwl-fw.h"
  73 #include "iwl-config.h"
  74
  75 /**
  76  * DOC: shared area - role and goal
  77  *
  78  * The shared area contains all the data exported by the upper layer to the
  79  * other layers. Since the bus and transport layer shouldn't dereference
  80  * iwl_priv, all the data needed by the upper layer and the transport / bus
  81  * layer must be here.
  82  * The shared area also holds pointer to all the other layers. This allows a
  83  * layer to call a function from another layer.
  84  *
  85  * NOTE: All the layers hold a pointer to the shared area which must be shrd.
  86  *      A few macros assume that (_m)->shrd points to the shared area no matter
  87  *      what _m is.
  88  *
  89  * gets notifications about enumeration, suspend, resume.
  90  * For the moment, the bus layer is not a linux kernel module as itself, and
  91  * the module_init function of the driver must call the bus specific
  92  * registration functions. These functions are listed at the end of this file.
  93  * For the moment, there is only one implementation of this interface: PCI-e.
  94  * This implementation is iwl-pci.c
  95  */
  96
  97 struct iwl_priv;
  98 struct iwl_trans;
  99 struct iwl_trans_ops;
 100
 101 #define DRV_NAME        "iwlwifi"
 102 #define IWLWIFI_VERSION "in-tree:"
 103 #define DRV_COPYRIGHT   "Copyright(c) 2003-2012 Intel Corporation"
 104 #define DRV_AUTHOR     "<ilw@linux.intel.com>"
 105
 106 extern struct iwl_mod_params iwlagn_mod_params;
 107
 108 #define IWL_DISABLE_HT_ALL      BIT(0)
 109 #define IWL_DISABLE_HT_TXAGG    BIT(1)
 110 #define IWL_DISABLE_HT_RXAGG    BIT(2)
 111
 112 /**
 113  * struct iwl_mod_params
 114  *
 115  * Holds the module parameters
 116  *
 117  * @sw_crypto: using hardware encryption, default = 0
 118  * @disable_11n: disable 11n capabilities, default = 0,
 119  *      use IWL_DISABLE_HT_* constants
 120  * @amsdu_size_8K: enable 8K amsdu size, default = 1
 121  * @antenna: both antennas (use diversity), default = 0
 122  * @restart_fw: restart firmware, default = 1
 123  * @plcp_check: enable plcp health check, default = true
 124  * @wd_disable: enable stuck queue check, default = 0
 125  * @bt_coex_active: enable bt coex, default = true
 126  * @led_mode: system default, default = 0
 127  * @no_sleep_autoadjust: disable autoadjust, default = true
 128  * @power_save: disable power save, default = false
 129  * @power_level: power level, default = 1
 130  * @debug_level: levels are IWL_DL_*
 131  * @ant_coupling: antenna coupling in dB, default = 0
 132  * @bt_ch_announce: BT channel inhibition, default = enable
 133  * @wanted_ucode_alternative: ucode alternative to use, default = 1
 134  * @auto_agg: enable agg. without check, default = true
 135  */
 136 struct iwl_mod_params {
 137         int sw_crypto;
 138         unsigned int disable_11n;
 139         int amsdu_size_8K;
 140         int antenna;
 141         int restart_fw;
 142         bool plcp_check;
 143         int  wd_disable;
 144         bool bt_coex_active;
 145         int led_mode;
 146         bool no_sleep_autoadjust;
 147         bool power_save;
 148         int power_level;
 149         u32 debug_level;
 150         int ant_coupling;
 151         bool bt_ch_announce;
 152         int wanted_ucode_alternative;
 153         bool auto_agg;
 154 };
 155
 156 /**
 157  * struct iwl_shared - shared fields for all the layers of the driver
 158  *
 159  * @status: STATUS_*
 160  * @wowlan: are we running wowlan uCode
 161  * @bus: pointer to the bus layer data
 162  * @cfg: see struct iwl_cfg
 163  * @priv: pointer to the upper layer data
 164  * @trans: pointer to the transport layer data
 165  * @nic: pointer to the nic data
 166  * @lock: protect general shared data
 167  * @eeprom: pointer to the eeprom/OTP image
 168  */
 169 struct iwl_shared {
 170         unsigned long status;
 171
 172         const struct iwl_cfg *cfg;
 173         struct iwl_trans *trans;
 174         void *drv;
 175 };
 176
 177 /*Whatever _m is (iwl_trans, iwl_priv, these macros will work */
 178 #define cfg(_m)         ((_m)->shrd->cfg)
 179 #define trans(_m)       ((_m)->shrd->trans)
 180
 181 static inline bool iwl_have_debug_level(u32 level)
 182 {
 183         return iwlagn_mod_params.debug_level & level;
 184 }
 185
 186 enum iwl_rxon_context_id {
 187         IWL_RXON_CTX_BSS,
 188         IWL_RXON_CTX_PAN,
 189
 190         NUM_IWL_RXON_CTX
 191 };
 192
 193 const char *get_cmd_string(u8 cmd);
 194
 195 #define IWL_CMD(x) case x: return #x
 196
 197 /*****************************************************
 198 * DRIVER STATUS FUNCTIONS
 199 ******************************************************/
 200 #define STATUS_HCMD_ACTIVE      0       /* host command in progress */
 201 /* 1 is unused (used to be STATUS_HCMD_SYNC_ACTIVE) */
 202 #define STATUS_INT_ENABLED      2
 203 #define STATUS_RF_KILL_HW       3
 204 #define STATUS_CT_KILL          4
 205 #define STATUS_INIT             5
 206 #define STATUS_ALIVE            6
 207 #define STATUS_READY            7
 208 #define STATUS_TEMPERATURE      8
 209 #define STATUS_GEO_CONFIGURED   9
 210 #define STATUS_EXIT_PENDING     10
 211 #define STATUS_STATISTICS       12
 212 #define STATUS_SCANNING         13
 213 #define STATUS_SCAN_ABORTING    14
 214 #define STATUS_SCAN_HW          15
 215 #define STATUS_POWER_PMI        16
 216 #define STATUS_FW_ERROR         17
 217 #define STATUS_DEVICE_ENABLED   18
 218 #define STATUS_CHANNEL_SWITCH_PENDING 19
 219 #define STATUS_SCAN_COMPLETE    20
 220
 221 #endif /* #__iwl_shared_h__ */