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 struct iwl_mod_params {
  78         int sw_crypto;          /* def: 0 = using hardware encryption */
  79         int num_of_queues;      /* def: HW dependent */
  80         int disable_11n;        /* def: 0 = 11n capabilities enabled */
  81         int amsdu_size_8K;      /* def: 1 = enable 8K amsdu size */
  82         int antenna;            /* def: 0 = both antennas (use diversity) */
  83         int restart_fw;         /* def: 1 = restart firmware */
  84         bool plcp_check;        /* def: true = enable plcp health check */
  85         bool ack_check;         /* def: false = disable ack health check */
  86         bool wd_disable;        /* def: false = enable stuck queue check */
  87         bool bt_coex_active;    /* def: true = enable bt coex */
  88         int led_mode;           /* def: 0 = system default */
  89         bool no_sleep_autoadjust; /* def: true = disable autoadjust */
  90         bool power_save;        /* def: false = disable power save */
  91         int power_level;        /* def: 1 = power level */
  92         u32 debug_level;        /* levels are IWL_DL_* */
  93         int ant_coupling;
  94         bool bt_ch_announce;
  95         int wanted_ucode_alternative;
  96 };
  97
  98 /**
  99  * struct iwl_hw_params
 100  * @max_txq_num: Max # Tx queues supported
 101  * @scd_bc_tbls_size: size of scheduler byte count tables
 102  * @tfd_size: TFD size
 103  * @tx/rx_chains_num: Number of TX/RX chains
 104  * @valid_tx/rx_ant: usable antennas
 105  * @max_rxq_size: Max # Rx frames in Rx queue (must be power-of-2)
 106  * @max_rxq_log: Log-base-2 of max_rxq_size
 107  * @rx_page_order: Rx buffer page order
 108  * @rx_wrt_ptr_reg: FH{39}_RSCSR_CHNL0_WPTR
 109  * @max_stations:
 110  * @ht40_channel: is 40MHz width possible in band 2.4
 111  * BIT(IEEE80211_BAND_5GHZ) BIT(IEEE80211_BAND_5GHZ)
 112  * @sw_crypto: 0 for hw, 1 for sw
 113  * @max_xxx_size: for ucode uses
 114  * @ct_kill_threshold: temperature threshold
 115  * @beacon_time_tsf_bits: number of valid tsf bits for beacon time
 116  * @calib_init_cfg: setup initial calibrations for the hw
 117  * @calib_rt_cfg: setup runtime calibrations for the hw
 118  * @struct iwl_sensitivity_ranges: range of sensitivity values
 119  */
 120 struct iwl_hw_params {
 121         u8 max_txq_num;
 122         u16 scd_bc_tbls_size;
 123         u32 tfd_size;
 124         u8  tx_chains_num;
 125         u8  rx_chains_num;
 126         u8  valid_tx_ant;
 127         u8  valid_rx_ant;
 128         u16 max_rxq_size;
 129         u16 max_rxq_log;
 130         u32 rx_page_order;
 131         u8  max_stations;
 132         u8  ht40_channel;
 133         u8  max_beacon_itrvl;   /* in 1024 ms */
 134         u32 max_inst_size;
 135         u32 max_data_size;
 136         u32 ct_kill_threshold; /* value in hw-dependent units */
 137         u32 ct_kill_exit_threshold; /* value in hw-dependent units */
 138                                     /* for 1000, 6000 series and up */
 139         u16 beacon_time_tsf_bits;
 140         u32 calib_init_cfg;
 141         u32 calib_rt_cfg;
 142         const struct iwl_sensitivity_ranges *sens;
 143 };
 144
 145 /**
 146  * struct iwl_shared - shared fields for all the layers of the driver
 147  *
 148  * @dbg_level_dev: dbg level set per device. Prevails on
 149  *      iwlagn_mod_params.debug_level if set (!= 0)
 150  * @cmd_queue: command queue number
 151  * @status: STATUS_*
 152  * @bus: pointer to the bus layer data
 153  * @priv: pointer to the upper layer data
 154  * @hw_params: see struct iwl_hw_params
 155  * @workqueue: the workqueue used by all the layers of the driver
 156  * @lock: protect general shared data
 157  * @sta_lock: protects the station table.
 158  *      If lock and sta_lock are needed, lock must be acquired first.
 159  * @mutex:
 160  */
 161 struct iwl_shared {
 162 #ifdef CONFIG_IWLWIFI_DEBUG
 163         u32 dbg_level_dev;
 164 #endif /* CONFIG_IWLWIFI_DEBUG */
 165
 166         u8 cmd_queue;
 167         unsigned long status;
 168
 169         struct iwl_bus *bus;
 170         struct iwl_priv *priv;
 171         struct iwl_trans *trans;
 172         struct iwl_hw_params hw_params;
 173
 174         struct workqueue_struct *workqueue;
 175         spinlock_t lock;
 176         spinlock_t sta_lock;
 177         struct mutex mutex;
 178 };
 179
 180 /*Whatever _m is (iwl_trans, iwl_priv, iwl_bus, these macros will work */
 181 #define priv(_m)        ((_m)->shrd->priv)
 182 #define bus(_m)         ((_m)->shrd->bus)
 183 #define trans(_m)       ((_m)->shrd->trans)
 184 #define hw_params(_m)   ((_m)->shrd->hw_params)
 185
 186 #ifdef CONFIG_IWLWIFI_DEBUG
 187 /*
 188  * iwl_get_debug_level: Return active debug level for device
 189  *
 190  * Using sysfs it is possible to set per device debug level. This debug
 191  * level will be used if set, otherwise the global debug level which can be
 192  * set via module parameter is used.
 193  */
 194 static inline u32 iwl_get_debug_level(struct iwl_shared *shrd)
 195 {
 196         if (shrd->dbg_level_dev)
 197                 return shrd->dbg_level_dev;
 198         else
 199                 return iwlagn_mod_params.debug_level;
 200 }
 201 #else
 202 static inline u32 iwl_get_debug_level(struct iwl_shared *shrd)
 203 {
 204         return iwlagn_mod_params.debug_level;
 205 }
 206 #endif
 207
 208 #ifdef CONFIG_PM
 209 int iwl_suspend(struct iwl_priv *priv);
 210 int iwl_resume(struct iwl_priv *priv);
 211 #endif /* !CONFIG_PM */
 212
 213 int iwl_probe(struct iwl_bus *bus, const struct iwl_trans_ops *trans_ops,
 214                 struct iwl_cfg *cfg);
 215 void __devexit iwl_remove(struct iwl_priv * priv);
 216
 217 #endif /* #__iwl_shared_h__ */