| 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 | u16 (*get_hcmd_size)(u8 cmd_id, u16 len); |
| 90 | u16 (*build_addsta_hcmd)(const struct iwl_addsta_cmd *cmd, u8 *data); |
| 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 | }; |
| 97 | |
| 98 | struct iwl_lib_ops { |
| 99 | /* set hw dependant perameters */ |
| 100 | int (*set_hw_params)(struct iwl_priv *priv); |
| 101 | /* ucode shared memory */ |
| 102 | int (*alloc_shared_mem)(struct iwl_priv *priv); |
| 103 | void (*free_shared_mem)(struct iwl_priv *priv); |
| 104 | int (*shared_mem_rx_idx)(struct iwl_priv *priv); |
| 105 | /* Handling TX */ |
| 106 | void (*txq_update_byte_cnt_tbl)(struct iwl_priv *priv, |
| 107 | struct iwl_tx_queue *txq, |
| 108 | u16 byte_cnt); |
| 109 | void (*txq_inval_byte_cnt_tbl)(struct iwl_priv *priv, |
| 110 | struct iwl_tx_queue *txq); |
| 111 | void (*txq_set_sched)(struct iwl_priv *priv, u32 mask); |
| 112 | /* aggregations */ |
| 113 | int (*txq_agg_enable)(struct iwl_priv *priv, int txq_id, int tx_fifo, |
| 114 | int sta_id, int tid, u16 ssn_idx); |
| 115 | int (*txq_agg_disable)(struct iwl_priv *priv, u16 txq_id, u16 ssn_idx, |
| 116 | u8 tx_fifo); |
| 117 | /* setup Rx handler */ |
| 118 | void (*rx_handler_setup)(struct iwl_priv *priv); |
| 119 | /* setup deferred work */ |
| 120 | void (*setup_deferred_work)(struct iwl_priv *priv); |
| 121 | /* cancel deferred work */ |
| 122 | void (*cancel_deferred_work)(struct iwl_priv *priv); |
| 123 | /* alive notification after init uCode load */ |
| 124 | void (*init_alive_start)(struct iwl_priv *priv); |
| 125 | /* alive notification */ |
| 126 | int (*alive_notify)(struct iwl_priv *priv); |
| 127 | /* check validity of rtc data address */ |
| 128 | int (*is_valid_rtc_data_addr)(u32 addr); |
| 129 | /* 1st ucode load */ |
| 130 | int (*load_ucode)(struct iwl_priv *priv); |
| 131 | /* power management */ |
| 132 | struct { |
| 133 | int (*init)(struct iwl_priv *priv); |
| 134 | int (*reset)(struct iwl_priv *priv); |
| 135 | void (*stop)(struct iwl_priv *priv); |
| 136 | void (*config)(struct iwl_priv *priv); |
| 137 | int (*set_pwr_src)(struct iwl_priv *priv, enum iwl_pwr_src src); |
| 138 | } apm_ops; |
| 139 | /* power */ |
| 140 | int (*set_power)(struct iwl_priv *priv, void *cmd); |
| 141 | int (*send_tx_power) (struct iwl_priv *priv); |
| 142 | void (*update_chain_flags)(struct iwl_priv *priv); |
| 143 | void (*temperature) (struct iwl_priv *priv, |
| 144 | struct iwl_notif_statistics *stats); |
| 145 | /* eeprom operations (as defined in iwl-eeprom.h) */ |
| 146 | struct iwl_eeprom_ops eeprom_ops; |
| 147 | }; |
| 148 | |
| 149 | struct iwl_ops { |
| 150 | const struct iwl_lib_ops *lib; |
| 151 | const struct iwl_hcmd_ops *hcmd; |
| 152 | const struct iwl_hcmd_utils_ops *utils; |
| 153 | }; |
| 154 | |
| 155 | struct iwl_mod_params { |
| 156 | int disable; /* def: 0 = enable radio */ |
| 157 | int sw_crypto; /* def: 0 = using hardware encryption */ |
| 158 | int debug; /* def: 0 = minimal debug log messages */ |
| 159 | int disable_hw_scan; /* def: 0 = use h/w scan */ |
| 160 | int num_of_queues; /* def: HW dependent */ |
| 161 | int enable_qos; /* def: 1 = use quality of service */ |
| 162 | int amsdu_size_8K; /* def: 1 = enable 8K amsdu size */ |
| 163 | int antenna; /* def: 0 = both antennas (use diversity) */ |
| 164 | int restart_fw; /* def: 1 = restart firmware */ |
| 165 | }; |
| 166 | |
| 167 | struct iwl_cfg { |
| 168 | const char *name; |
| 169 | const char *fw_name; |
| 170 | unsigned int sku; |
| 171 | int eeprom_size; |
| 172 | const struct iwl_ops *ops; |
| 173 | const struct iwl_mod_params *mod_params; |
| 174 | }; |
| 175 | |
| 176 | /*************************** |
| 177 | * L i b * |
| 178 | ***************************/ |
| 179 | |
| 180 | struct ieee80211_hw *iwl_alloc_all(struct iwl_cfg *cfg, |
| 181 | struct ieee80211_ops *hw_ops); |
| 182 | void iwl_hw_detect(struct iwl_priv *priv); |
| 183 | |
| 184 | void iwl_clear_stations_table(struct iwl_priv *priv); |
| 185 | void iwl_free_calib_results(struct iwl_priv *priv); |
| 186 | void iwl_reset_qos(struct iwl_priv *priv); |
| 187 | void iwl_set_rxon_chain(struct iwl_priv *priv); |
| 188 | int iwl_set_rxon_channel(struct iwl_priv *priv, |
| 189 | enum ieee80211_band band, |
| 190 | u16 channel); |
| 191 | void iwl_set_rxon_ht(struct iwl_priv *priv, struct iwl_ht_info *ht_info); |
| 192 | u8 iwl_is_fat_tx_allowed(struct iwl_priv *priv, |
| 193 | struct ieee80211_ht_info *sta_ht_inf); |
| 194 | int iwl_hw_nic_init(struct iwl_priv *priv); |
| 195 | int iwl_setup_mac(struct iwl_priv *priv); |
| 196 | int iwl_init_drv(struct iwl_priv *priv); |
| 197 | void iwl_uninit_drv(struct iwl_priv *priv); |
| 198 | /* "keep warm" functions */ |
| 199 | int iwl_kw_init(struct iwl_priv *priv); |
| 200 | int iwl_kw_alloc(struct iwl_priv *priv); |
| 201 | void iwl_kw_free(struct iwl_priv *priv); |
| 202 | |
| 203 | /***************************************************** |
| 204 | * RX |
| 205 | ******************************************************/ |
| 206 | void iwl_rx_queue_free(struct iwl_priv *priv, struct iwl_rx_queue *rxq); |
| 207 | int iwl_rx_queue_alloc(struct iwl_priv *priv); |
| 208 | void iwl_rx_handle(struct iwl_priv *priv); |
| 209 | int iwl_rx_queue_update_write_ptr(struct iwl_priv *priv, |
| 210 | struct iwl_rx_queue *q); |
| 211 | void iwl_rx_queue_reset(struct iwl_priv *priv, struct iwl_rx_queue *rxq); |
| 212 | void iwl_rx_replenish(struct iwl_priv *priv); |
| 213 | int iwl_rx_init(struct iwl_priv *priv, struct iwl_rx_queue *rxq); |
| 214 | /* FIXME: remove when TX is moved to iwl core */ |
| 215 | int iwl_rx_queue_restock(struct iwl_priv *priv); |
| 216 | int iwl_rx_queue_space(const struct iwl_rx_queue *q); |
| 217 | void iwl_rx_allocate(struct iwl_priv *priv); |
| 218 | void iwl_tx_cmd_complete(struct iwl_priv *priv, struct iwl_rx_mem_buffer *rxb); |
| 219 | int iwl_tx_queue_reclaim(struct iwl_priv *priv, int txq_id, int index); |
| 220 | /* Handlers */ |
| 221 | void iwl_rx_missed_beacon_notif(struct iwl_priv *priv, |
| 222 | struct iwl_rx_mem_buffer *rxb); |
| 223 | void iwl_rx_statistics(struct iwl_priv *priv, |
| 224 | struct iwl_rx_mem_buffer *rxb); |
| 225 | |
| 226 | /* TX helpers */ |
| 227 | |
| 228 | /***************************************************** |
| 229 | * TX |
| 230 | ******************************************************/ |
| 231 | int iwl_txq_ctx_reset(struct iwl_priv *priv); |
| 232 | int iwl_tx_skb(struct iwl_priv *priv, struct sk_buff *skb); |
| 233 | /* FIXME: remove when free Tx is fully merged into iwlcore */ |
| 234 | int iwl_hw_txq_free_tfd(struct iwl_priv *priv, struct iwl_tx_queue *txq); |
| 235 | void iwl_hw_txq_ctx_free(struct iwl_priv *priv); |
| 236 | int iwl_hw_txq_attach_buf_to_tfd(struct iwl_priv *priv, void *tfd, |
| 237 | dma_addr_t addr, u16 len); |
| 238 | int iwl_txq_update_write_ptr(struct iwl_priv *priv, struct iwl_tx_queue *txq); |
| 239 | int iwl_tx_agg_start(struct iwl_priv *priv, const u8 *ra, u16 tid, u16 *ssn); |
| 240 | int iwl_tx_agg_stop(struct iwl_priv *priv , const u8 *ra, u16 tid); |
| 241 | int iwl_txq_check_empty(struct iwl_priv *priv, int sta_id, u8 tid, int txq_id); |
| 242 | |
| 243 | /***************************************************** |
| 244 | * TX power |
| 245 | ****************************************************/ |
| 246 | int iwl_set_tx_power(struct iwl_priv *priv, s8 tx_power, bool force); |
| 247 | |
| 248 | /***************************************************** |
| 249 | * RF -Kill - here and not in iwl-rfkill.h to be available when |
| 250 | * RF-kill subsystem is not compiled. |
| 251 | ****************************************************/ |
| 252 | void iwl_radio_kill_sw_disable_radio(struct iwl_priv *priv); |
| 253 | int iwl_radio_kill_sw_enable_radio(struct iwl_priv *priv); |
| 254 | |
| 255 | /******************************************************************************* |
| 256 | * Rate |
| 257 | ******************************************************************************/ |
| 258 | |
| 259 | void iwl_hwrate_to_tx_control(struct iwl_priv *priv, u32 rate_n_flags, |
| 260 | struct ieee80211_tx_info *info); |
| 261 | int iwl_hwrate_to_plcp_idx(u32 rate_n_flags); |
| 262 | |
| 263 | static inline u8 iwl_hw_get_rate(__le32 rate_n_flags) |
| 264 | { |
| 265 | return le32_to_cpu(rate_n_flags) & 0xFF; |
| 266 | } |
| 267 | static inline u32 iwl_hw_get_rate_n_flags(__le32 rate_n_flags) |
| 268 | { |
| 269 | return le32_to_cpu(rate_n_flags) & 0x1FFFF; |
| 270 | } |
| 271 | static inline __le32 iwl_hw_set_rate_n_flags(u8 rate, u32 flags) |
| 272 | { |
| 273 | return cpu_to_le32(flags|(u32)rate); |
| 274 | } |
| 275 | |
| 276 | /******************************************************************************* |
| 277 | * Scanning |
| 278 | ******************************************************************************/ |
| 279 | void iwl_init_scan_params(struct iwl_priv *priv); |
| 280 | int iwl_scan_cancel(struct iwl_priv *priv); |
| 281 | int iwl_scan_cancel_timeout(struct iwl_priv *priv, unsigned long ms); |
| 282 | const char *iwl_escape_essid(const char *essid, u8 essid_len); |
| 283 | int iwl_scan_initiate(struct iwl_priv *priv); |
| 284 | void iwl_setup_rx_scan_handlers(struct iwl_priv *priv); |
| 285 | void iwl_setup_scan_deferred_work(struct iwl_priv *priv); |
| 286 | |
| 287 | /***************************************************** |
| 288 | * S e n d i n g H o s t C o m m a n d s * |
| 289 | *****************************************************/ |
| 290 | |
| 291 | const char *get_cmd_string(u8 cmd); |
| 292 | int __must_check iwl_send_cmd_sync(struct iwl_priv *priv, |
| 293 | struct iwl_host_cmd *cmd); |
| 294 | int iwl_send_cmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd); |
| 295 | int __must_check iwl_send_cmd_pdu(struct iwl_priv *priv, u8 id, |
| 296 | u16 len, const void *data); |
| 297 | int iwl_send_cmd_pdu_async(struct iwl_priv *priv, u8 id, u16 len, |
| 298 | const void *data, |
| 299 | int (*callback)(struct iwl_priv *priv, |
| 300 | struct iwl_cmd *cmd, |
| 301 | struct sk_buff *skb)); |
| 302 | |
| 303 | int iwl_enqueue_hcmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd); |
| 304 | |
| 305 | /***************************************************** |
| 306 | * Error Handling Debugging |
| 307 | ******************************************************/ |
| 308 | void iwl_print_event_log(struct iwl_priv *priv, u32 start_idx, |
| 309 | u32 num_events, u32 mode); |
| 310 | void iwl_dump_nic_error_log(struct iwl_priv *priv); |
| 311 | void iwl_dump_nic_event_log(struct iwl_priv *priv); |
| 312 | |
| 313 | /*************** DRIVER STATUS FUNCTIONS *****/ |
| 314 | |
| 315 | #define STATUS_HCMD_ACTIVE 0 /* host command in progress */ |
| 316 | #define STATUS_HCMD_SYNC_ACTIVE 1 /* sync host command in progress */ |
| 317 | #define STATUS_INT_ENABLED 2 |
| 318 | #define STATUS_RF_KILL_HW 3 |
| 319 | #define STATUS_RF_KILL_SW 4 |
| 320 | #define STATUS_INIT 5 |
| 321 | #define STATUS_ALIVE 6 |
| 322 | #define STATUS_READY 7 |
| 323 | #define STATUS_TEMPERATURE 8 |
| 324 | #define STATUS_GEO_CONFIGURED 9 |
| 325 | #define STATUS_EXIT_PENDING 10 |
| 326 | #define STATUS_IN_SUSPEND 11 |
| 327 | #define STATUS_STATISTICS 12 |
| 328 | #define STATUS_SCANNING 13 |
| 329 | #define STATUS_SCAN_ABORTING 14 |
| 330 | #define STATUS_SCAN_HW 15 |
| 331 | #define STATUS_POWER_PMI 16 |
| 332 | #define STATUS_FW_ERROR 17 |
| 333 | #define STATUS_CONF_PENDING 18 |
| 334 | #define STATUS_MODE_PENDING 19 |
| 335 | |
| 336 | |
| 337 | static inline int iwl_is_ready(struct iwl_priv *priv) |
| 338 | { |
| 339 | /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are |
| 340 | * set but EXIT_PENDING is not */ |
| 341 | return test_bit(STATUS_READY, &priv->status) && |
| 342 | test_bit(STATUS_GEO_CONFIGURED, &priv->status) && |
| 343 | !test_bit(STATUS_EXIT_PENDING, &priv->status); |
| 344 | } |
| 345 | |
| 346 | static inline int iwl_is_alive(struct iwl_priv *priv) |
| 347 | { |
| 348 | return test_bit(STATUS_ALIVE, &priv->status); |
| 349 | } |
| 350 | |
| 351 | static inline int iwl_is_init(struct iwl_priv *priv) |
| 352 | { |
| 353 | return test_bit(STATUS_INIT, &priv->status); |
| 354 | } |
| 355 | |
| 356 | static inline int iwl_is_rfkill(struct iwl_priv *priv) |
| 357 | { |
| 358 | return test_bit(STATUS_RF_KILL_HW, &priv->status) || |
| 359 | test_bit(STATUS_RF_KILL_SW, &priv->status); |
| 360 | } |
| 361 | |
| 362 | static inline int iwl_is_ready_rf(struct iwl_priv *priv) |
| 363 | { |
| 364 | |
| 365 | if (iwl_is_rfkill(priv)) |
| 366 | return 0; |
| 367 | |
| 368 | return iwl_is_ready(priv); |
| 369 | } |
| 370 | |
| 371 | extern void iwl_rf_kill_ct_config(struct iwl_priv *priv); |
| 372 | extern int iwl_send_statistics_request(struct iwl_priv *priv, u8 flags); |
| 373 | extern int iwl_verify_ucode(struct iwl_priv *priv); |
| 374 | extern int iwl_send_lq_cmd(struct iwl_priv *priv, |
| 375 | struct iwl_link_quality_cmd *lq, u8 flags); |
| 376 | extern void iwl_rx_reply_rx(struct iwl_priv *priv, |
| 377 | struct iwl_rx_mem_buffer *rxb); |
| 378 | extern void iwl_rx_reply_rx_phy(struct iwl_priv *priv, |
| 379 | struct iwl_rx_mem_buffer *rxb); |
| 380 | |
| 381 | static inline int iwl_send_rxon_assoc(struct iwl_priv *priv) |
| 382 | { |
| 383 | return priv->cfg->ops->hcmd->rxon_assoc(priv); |
| 384 | } |
| 385 | |
| 386 | static inline const struct ieee80211_supported_band *iwl_get_hw_mode( |
| 387 | struct iwl_priv *priv, enum ieee80211_band band) |
| 388 | { |
| 389 | return priv->hw->wiphy->bands[band]; |
| 390 | } |
| 391 | |
| 392 | #endif /* __iwl_core_h__ */ |