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 - 2011 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 - 2011 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 /*This files includes all the types / functions that are exported by the
  67  * upper layer to the bus and transport layer */
  68
  69 struct iwl_cfg;
  70 struct iwl_bus;
  71 struct iwl_priv;
  72 struct iwl_sensitivity_ranges;
  73 struct iwl_trans_ops;
  74
  75 extern struct iwl_mod_params iwlagn_mod_params;
  76
  77 /**
  78  * struct iwl_mod_params
  79  * @sw_crypto: using hardware encryption, default = 0
  80  * @num_of_queues: number of tx queue, HW dependent
  81  * @disable_11n: 11n capabilities enabled, default = 0
  82  * @amsdu_size_8K: enable 8K amsdu size, default = 1
  83  * @antenna: both antennas (use diversity), default = 0
  84  * @restart_fw: restart firmware, default = 1
  85  * @plcp_check: enable plcp health check, default = true
  86  * @ack_check: disable ack health check, default = false
  87  * @wd_disable: enable stuck queue check, default = false
  88  * @bt_coex_active: enable bt coex, default = true
  89  * @led_mode: system default, default = 0
  90  * @no_sleep_autoadjust: disable autoadjust, default = true
  91  * @power_save: disable power save, default = false
  92  * @power_level: power level, default = 1
  93  * @debug_level: levels are IWL_DL_*
  94  * @ant_coupling: antenna coupling in dB, default = 0
  95  * @bt_ch_announce: BT channel inhibition, default = enable
  96  * @wanted_ucode_alternative: ucode alternative to use, default = 1
  97  * @auto_agg: enable agg. without check, default = true
  98  */
  99 struct iwl_mod_params {
 100         int sw_crypto;
 101         int num_of_queues;
 102         int disable_11n;
 103         int amsdu_size_8K;
 104         int antenna;
 105         int restart_fw;
 106         bool plcp_check;
 107         bool ack_check;
 108         bool wd_disable;
 109         bool bt_coex_active;
 110         int led_mode;
 111         bool no_sleep_autoadjust;
 112         bool power_save;
 113         int power_level;
 114         u32 debug_level;
 115         int ant_coupling;
 116         bool bt_ch_announce;
 117         int wanted_ucode_alternative;
 118         bool auto_agg;
 119 };
 120
 121 /**
 122  * struct iwl_hw_params
 123  * @max_txq_num: Max # Tx queues supported
 124  * @tx/rx_chains_num: Number of TX/RX chains
 125  * @valid_tx/rx_ant: usable antennas
 126  * @rx_page_order: Rx buffer page order
 127  * @rx_wrt_ptr_reg: FH{39}_RSCSR_CHNL0_WPTR
 128  * @max_stations:
 129  * @ht40_channel: is 40MHz width possible in band 2.4
 130  * BIT(IEEE80211_BAND_5GHZ) BIT(IEEE80211_BAND_5GHZ)
 131  * @sw_crypto: 0 for hw, 1 for sw
 132  * @max_xxx_size: for ucode uses
 133  * @ct_kill_threshold: temperature threshold
 134  * @beacon_time_tsf_bits: number of valid tsf bits for beacon time
 135  * @calib_init_cfg: setup initial calibrations for the hw
 136  * @calib_rt_cfg: setup runtime calibrations for the hw
 137  * @struct iwl_sensitivity_ranges: range of sensitivity values
 138  */
 139 struct iwl_hw_params {
 140         u8 max_txq_num;
 141         u8  tx_chains_num;
 142         u8  rx_chains_num;
 143         u8  valid_tx_ant;
 144         u8  valid_rx_ant;
 145         u32 rx_page_order;
 146         u8  max_stations;
 147         u8  ht40_channel;
 148         u32 max_inst_size;
 149         u32 max_data_size;
 150         u32 ct_kill_threshold; /* value in hw-dependent units */
 151         u32 ct_kill_exit_threshold; /* value in hw-dependent units */
 152                                     /* for 1000, 6000 series and up */
 153         u16 beacon_time_tsf_bits;
 154         u32 calib_init_cfg;
 155         u32 calib_rt_cfg;
 156         const struct iwl_sensitivity_ranges *sens;
 157 };
 158
 159 /**
 160  * struct iwl_shared - shared fields for all the layers of the driver
 161  *
 162  * @dbg_level_dev: dbg level set per device. Prevails on
 163  *      iwlagn_mod_params.debug_level if set (!= 0)
 164  * @cmd_queue: command queue number
 165  * @status: STATUS_*
 166  * @bus: pointer to the bus layer data
 167  * @priv: pointer to the upper layer data
 168  * @hw_params: see struct iwl_hw_params
 169  * @workqueue: the workqueue used by all the layers of the driver
 170  * @lock: protect general shared data
 171  * @sta_lock: protects the station table.
 172  *      If lock and sta_lock are needed, lock must be acquired first.
 173  * @mutex:
 174  */
 175 struct iwl_shared {
 176 #ifdef CONFIG_IWLWIFI_DEBUG
 177         u32 dbg_level_dev;
 178 #endif /* CONFIG_IWLWIFI_DEBUG */
 179
 180         u8 cmd_queue;
 181         unsigned long status;
 182         bool wowlan;
 183
 184         struct iwl_bus *bus;
 185         struct iwl_priv *priv;
 186         struct iwl_trans *trans;
 187         struct iwl_hw_params hw_params;
 188
 189         struct workqueue_struct *workqueue;
 190         spinlock_t lock;
 191         spinlock_t sta_lock;
 192         struct mutex mutex;
 193 };
 194
 195 /*Whatever _m is (iwl_trans, iwl_priv, iwl_bus, these macros will work */
 196 #define priv(_m)        ((_m)->shrd->priv)
 197 #define bus(_m)         ((_m)->shrd->bus)
 198 #define trans(_m)       ((_m)->shrd->trans)
 199 #define hw_params(_m)   ((_m)->shrd->hw_params)
 200
 201 #ifdef CONFIG_IWLWIFI_DEBUG
 202 /*
 203  * iwl_get_debug_level: Return active debug level for device
 204  *
 205  * Using sysfs it is possible to set per device debug level. This debug
 206  * level will be used if set, otherwise the global debug level which can be
 207  * set via module parameter is used.
 208  */
 209 static inline u32 iwl_get_debug_level(struct iwl_shared *shrd)
 210 {
 211         if (shrd->dbg_level_dev)
 212                 return shrd->dbg_level_dev;
 213         else
 214                 return iwlagn_mod_params.debug_level;
 215 }
 216 #else
 217 static inline u32 iwl_get_debug_level(struct iwl_shared *shrd)
 218 {
 219         return iwlagn_mod_params.debug_level;
 220 }
 221 #endif
 222
 223 static inline void iwl_free_pages(struct iwl_shared *shrd, unsigned long page)
 224 {
 225         free_pages(page, shrd->hw_params.rx_page_order);
 226 }
 227
 228 struct iwl_rx_mem_buffer {
 229         dma_addr_t page_dma;
 230         struct page *page;
 231         struct list_head list;
 232 };
 233
 234 #define rxb_addr(r) page_address(r->page)
 235
 236 #ifdef CONFIG_PM
 237 int iwl_suspend(struct iwl_priv *priv);
 238 int iwl_resume(struct iwl_priv *priv);
 239 #endif /* !CONFIG_PM */
 240
 241 int iwl_probe(struct iwl_bus *bus, const struct iwl_trans_ops *trans_ops,
 242                 struct iwl_cfg *cfg);
 243 void __devexit iwl_remove(struct iwl_priv * priv);
 244
 245 /*****************************************************
 246 * DRIVER STATUS FUNCTIONS
 247 ******************************************************/
 248 #define STATUS_HCMD_ACTIVE      0       /* host command in progress */
 249 /* 1 is unused (used to be STATUS_HCMD_SYNC_ACTIVE) */
 250 #define STATUS_INT_ENABLED      2
 251 #define STATUS_RF_KILL_HW       3
 252 #define STATUS_CT_KILL          4
 253 #define STATUS_INIT             5
 254 #define STATUS_ALIVE            6
 255 #define STATUS_READY            7
 256 #define STATUS_TEMPERATURE      8
 257 #define STATUS_GEO_CONFIGURED   9
 258 #define STATUS_EXIT_PENDING     10
 259 #define STATUS_STATISTICS       12
 260 #define STATUS_SCANNING         13
 261 #define STATUS_SCAN_ABORTING    14
 262 #define STATUS_SCAN_HW          15
 263 #define STATUS_POWER_PMI        16
 264 #define STATUS_FW_ERROR         17
 265 #define STATUS_DEVICE_ENABLED   18
 266 #define STATUS_CHANNEL_SWITCH_PENDING 19
 267
 268 static inline int iwl_is_ready(struct iwl_shared *shrd)
 269 {
 270         /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
 271          * set but EXIT_PENDING is not */
 272         return test_bit(STATUS_READY, &shrd->status) &&
 273                test_bit(STATUS_GEO_CONFIGURED, &shrd->status) &&
 274                !test_bit(STATUS_EXIT_PENDING, &shrd->status);
 275 }
 276
 277 static inline int iwl_is_alive(struct iwl_shared *shrd)
 278 {
 279         return test_bit(STATUS_ALIVE, &shrd->status);
 280 }
 281
 282 static inline int iwl_is_init(struct iwl_shared *shrd)
 283 {
 284         return test_bit(STATUS_INIT, &shrd->status);
 285 }
 286
 287 static inline int iwl_is_rfkill_hw(struct iwl_shared *shrd)
 288 {
 289         return test_bit(STATUS_RF_KILL_HW, &shrd->status);
 290 }
 291
 292 static inline int iwl_is_rfkill(struct iwl_shared *shrd)
 293 {
 294         return iwl_is_rfkill_hw(shrd);
 295 }
 296
 297 static inline int iwl_is_ctkill(struct iwl_shared *shrd)
 298 {
 299         return test_bit(STATUS_CT_KILL, &shrd->status);
 300 }
 301
 302 static inline int iwl_is_ready_rf(struct iwl_shared *shrd)
 303 {
 304         if (iwl_is_rfkill(shrd))
 305                 return 0;
 306
 307         return iwl_is_ready(shrd);
 308 }
 309
 310 #endif /* #__iwl_shared_h__ */