drivers/net/wireless/iwlwifi/iwl-core.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 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  * Tomas Winkler <tomas.winkler@intel.com>
  29  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  30  *
  31  * BSD LICENSE
  32  *
  33  * Copyright(c) 2005 - 2008 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_core_h__
  64 #define __iwl_core_h__
  65
  66 /************************
  67  * forward declarations *
  68  ************************/
  69 struct iwl_host_cmd;
  70 struct iwl_cmd;
  71
  72
  73 #define IWLWIFI_VERSION "1.2.26k"
  74 #define DRV_COPYRIGHT   "Copyright(c) 2003-2008 Intel Corporation"
  75
  76 #define IWL_PCI_DEVICE(dev, subdev, cfg) \
  77         .vendor = PCI_VENDOR_ID_INTEL,  .device = (dev), \
  78         .subvendor = PCI_ANY_ID, .subdevice = (subdev), \
  79         .driver_data = (kernel_ulong_t)&(cfg)
  80
  81 #define IWL_SKU_G       0x1
  82 #define IWL_SKU_A       0x2
  83 #define IWL_SKU_N       0x8
  84
  85 struct iwl_hcmd_ops {
  86         int (*rxon_assoc)(struct iwl_priv *priv);
  87 };
  88 struct iwl_hcmd_utils_ops {
  89         int (*enqueue_hcmd)(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
  90 #ifdef CONFIG_IWLWIFI_RUN_TIME_CALIB
  91         void (*gain_computation)(struct iwl_priv *priv,
  92                         u32 *average_noise,
  93                         u16 min_average_noise_antennat_i,
  94                         u32 min_average_noise);
  95         void (*chain_noise_reset)(struct iwl_priv *priv);
  96 #endif
  97 };
  98
  99 struct iwl_lib_ops {
 100         /* set hw dependant perameters */
 101         int (*set_hw_params)(struct iwl_priv *priv);
 102         /* ucode shared memory */
 103         int (*alloc_shared_mem)(struct iwl_priv *priv);
 104         void (*free_shared_mem)(struct iwl_priv *priv);
 105         void (*txq_update_byte_cnt_tbl)(struct iwl_priv *priv,
 106                                         struct iwl4965_tx_queue *txq,
 107                                         u16 byte_cnt);
 108         /* setup Rx handler */
 109         void (*rx_handler_setup)(struct iwl_priv *priv);
 110         /* nic init */
 111         int (*hw_nic_init)(struct iwl_priv *priv);
 112         /* alive notification */
 113         int (*alive_notify)(struct iwl_priv *priv);
 114         /* check validity of rtc data address */
 115         int (*is_valid_rtc_data_addr)(u32 addr);
 116         /* 1st ucode load */
 117         int (*load_ucode)(struct iwl_priv *priv);
 118         /* rfkill */
 119         void (*radio_kill_sw)(struct iwl_priv *priv, int disable_radio);
 120          /* power management */
 121         struct {
 122                 int (*init)(struct iwl_priv *priv);
 123                 int (*set_pwr_src)(struct iwl_priv *priv, enum iwl_pwr_src src);
 124         } apm_ops;
 125         /* power */
 126         int (*set_power)(struct iwl_priv *priv, void *cmd);
 127         void (*update_chain_flags)(struct iwl_priv *priv);
 128         /* eeprom operations (as defined in iwl-eeprom.h) */
 129         struct iwl_eeprom_ops eeprom_ops;
 130 };
 131
 132 struct iwl_ops {
 133         const struct iwl_lib_ops *lib;
 134         const struct iwl_hcmd_ops *hcmd;
 135         const struct iwl_hcmd_utils_ops *utils;
 136 };
 137
 138 struct iwl_mod_params {
 139         int disable;            /* def: 0 = enable radio */
 140         int sw_crypto;          /* def: 0 = using hardware encryption */
 141         int debug;              /* def: 0 = minimal debug log messages */
 142         int disable_hw_scan;    /* def: 0 = use h/w scan */
 143         int num_of_queues;      /* def: HW dependent */
 144         int enable_qos;         /* def: 1 = use quality of service */
 145         int amsdu_size_8K;      /* def: 1 = enable 8K amsdu size */
 146         int antenna;            /* def: 0 = both antennas (use diversity) */
 147 };
 148
 149 struct iwl_cfg {
 150         const char *name;
 151         const char *fw_name;
 152         unsigned int sku;
 153         int eeprom_size;
 154         const struct iwl_ops *ops;
 155         const struct iwl_mod_params *mod_params;
 156 };
 157
 158 /***************************
 159  *   L i b                 *
 160  ***************************/
 161
 162 struct ieee80211_hw *iwl_alloc_all(struct iwl_cfg *cfg,
 163                 struct ieee80211_ops *hw_ops);
 164 void iwl_hw_detect(struct iwl_priv *priv);
 165
 166 void iwlcore_clear_stations_table(struct iwl_priv *priv);
 167 void iwl_reset_qos(struct iwl_priv *priv);
 168 void iwl_set_rxon_chain(struct iwl_priv *priv);
 169 int iwl_set_rxon_channel(struct iwl_priv *priv,
 170                                 enum ieee80211_band band,
 171                                 u16 channel);
 172 void iwlcore_free_geos(struct iwl_priv *priv);
 173 int iwl_setup(struct iwl_priv *priv);
 174
 175 /*****************************************************
 176  *   S e n d i n g     H o s t     C o m m a n d s   *
 177  *****************************************************/
 178
 179 const char *get_cmd_string(u8 cmd);
 180 int __must_check iwl_send_cmd_sync(struct iwl_priv *priv,
 181                                    struct iwl_host_cmd *cmd);
 182 int iwl_send_cmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
 183 int __must_check iwl_send_cmd_pdu(struct iwl_priv *priv, u8 id,
 184                                   u16 len, const void *data);
 185 int iwl_send_cmd_pdu_async(struct iwl_priv *priv, u8 id, u16 len,
 186                            const void *data,
 187                            int (*callback)(struct iwl_priv *priv,
 188                                            struct iwl_cmd *cmd,
 189                                            struct sk_buff *skb));
 190 /*************** DRIVER STATUS FUNCTIONS   *****/
 191
 192 #define STATUS_HCMD_ACTIVE      0       /* host command in progress */
 193 #define STATUS_HCMD_SYNC_ACTIVE 1       /* sync host command in progress */
 194 #define STATUS_INT_ENABLED      2
 195 #define STATUS_RF_KILL_HW       3
 196 #define STATUS_RF_KILL_SW       4
 197 #define STATUS_INIT             5
 198 #define STATUS_ALIVE            6
 199 #define STATUS_READY            7
 200 #define STATUS_TEMPERATURE      8
 201 #define STATUS_GEO_CONFIGURED   9
 202 #define STATUS_EXIT_PENDING     10
 203 #define STATUS_IN_SUSPEND       11
 204 #define STATUS_STATISTICS       12
 205 #define STATUS_SCANNING         13
 206 #define STATUS_SCAN_ABORTING    14
 207 #define STATUS_SCAN_HW          15
 208 #define STATUS_POWER_PMI        16
 209 #define STATUS_FW_ERROR         17
 210 #define STATUS_CONF_PENDING     18
 211
 212
 213 static inline int iwl_is_ready(struct iwl_priv *priv)
 214 {
 215         /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
 216          * set but EXIT_PENDING is not */
 217         return test_bit(STATUS_READY, &priv->status) &&
 218                test_bit(STATUS_GEO_CONFIGURED, &priv->status) &&
 219                !test_bit(STATUS_EXIT_PENDING, &priv->status);
 220 }
 221
 222 static inline int iwl_is_alive(struct iwl_priv *priv)
 223 {
 224         return test_bit(STATUS_ALIVE, &priv->status);
 225 }
 226
 227 static inline int iwl_is_init(struct iwl_priv *priv)
 228 {
 229         return test_bit(STATUS_INIT, &priv->status);
 230 }
 231
 232 static inline int iwl_is_rfkill(struct iwl_priv *priv)
 233 {
 234         return test_bit(STATUS_RF_KILL_HW, &priv->status) ||
 235                test_bit(STATUS_RF_KILL_SW, &priv->status);
 236 }
 237
 238 static inline int iwl_is_ready_rf(struct iwl_priv *priv)
 239 {
 240
 241         if (iwl_is_rfkill(priv))
 242                 return 0;
 243
 244         return iwl_is_ready(priv);
 245 }
 246
 247
 248 enum iwlcore_card_notify {
 249         IWLCORE_INIT_EVT = 0,
 250         IWLCORE_START_EVT = 1,
 251         IWLCORE_STOP_EVT = 2,
 252         IWLCORE_REMOVE_EVT = 3,
 253 };
 254
 255 int iwlcore_low_level_notify(struct iwl_priv *priv,
 256                              enum iwlcore_card_notify notify);
 257 extern int iwl_send_statistics_request(struct iwl_priv *priv, u8 flags);
 258 extern int iwl_verify_ucode(struct iwl_priv *priv);
 259 int iwl_send_lq_cmd(struct iwl_priv *priv,
 260                     struct iwl_link_quality_cmd *lq, u8 flags);
 261
 262 static inline int iwl_send_rxon_assoc(struct iwl_priv *priv)
 263 {
 264         return priv->cfg->ops->hcmd->rxon_assoc(priv);
 265 }
 266
 267 #endif /* __iwl_core_h__ */