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