1 /******************************************************************************
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.
8 * Copyright(c) 2008 - 2009 Intel Corporation. All rights reserved.
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.
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.
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,
24 * The full GNU General Public License is included in this distribution
25 * in the file called LICENSE.GPL.
27 * Contact Information:
28 * Intel Linux Wireless <ilw@linux.intel.com>
29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
33 * Copyright(c) 2005 - 2009 Intel Corporation. All rights reserved.
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
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
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.
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 *****************************************************************************/
63 #ifndef __iwl_core_h__
64 #define __iwl_core_h__
66 /************************
67 * forward declarations *
68 ************************/
73 #define IWLWIFI_VERSION "1.3.27k"
74 #define DRV_COPYRIGHT "Copyright(c) 2003-2009 Intel Corporation"
75 #define DRV_AUTHOR "<ilw@linux.intel.com>"
77 #define IWL_PCI_DEVICE(dev, subdev, cfg) \
78 .vendor = PCI_VENDOR_ID_INTEL, .device = (dev), \
79 .subvendor = PCI_ANY_ID, .subdevice = (subdev), \
80 .driver_data = (kernel_ulong_t)&(cfg)
87 int (*rxon_assoc)(struct iwl_priv *priv);
89 struct iwl_hcmd_utils_ops {
90 u16 (*get_hcmd_size)(u8 cmd_id, u16 len);
91 u16 (*build_addsta_hcmd)(const struct iwl_addsta_cmd *cmd, u8 *data);
92 void (*gain_computation)(struct iwl_priv *priv,
94 u16 min_average_noise_antennat_i,
95 u32 min_average_noise);
96 void (*chain_noise_reset)(struct iwl_priv *priv);
97 void (*rts_tx_cmd_flag)(struct ieee80211_tx_info *info,
99 int (*calc_rssi)(struct iwl_priv *priv,
100 struct iwl_rx_phy_res *rx_resp);
104 /* set hw dependent parameters */
105 int (*set_hw_params)(struct iwl_priv *priv);
107 void (*txq_update_byte_cnt_tbl)(struct iwl_priv *priv,
108 struct iwl_tx_queue *txq,
110 void (*txq_inval_byte_cnt_tbl)(struct iwl_priv *priv,
111 struct iwl_tx_queue *txq);
112 void (*txq_set_sched)(struct iwl_priv *priv, u32 mask);
113 int (*txq_attach_buf_to_tfd)(struct iwl_priv *priv,
114 struct iwl_tx_queue *txq,
116 u16 len, u8 reset, u8 pad);
117 void (*txq_free_tfd)(struct iwl_priv *priv,
118 struct iwl_tx_queue *txq);
119 int (*txq_init)(struct iwl_priv *priv,
120 struct iwl_tx_queue *txq);
122 int (*txq_agg_enable)(struct iwl_priv *priv, int txq_id, int tx_fifo,
123 int sta_id, int tid, u16 ssn_idx);
124 int (*txq_agg_disable)(struct iwl_priv *priv, u16 txq_id, u16 ssn_idx,
126 /* setup Rx handler */
127 void (*rx_handler_setup)(struct iwl_priv *priv);
128 /* setup deferred work */
129 void (*setup_deferred_work)(struct iwl_priv *priv);
130 /* cancel deferred work */
131 void (*cancel_deferred_work)(struct iwl_priv *priv);
132 /* alive notification after init uCode load */
133 void (*init_alive_start)(struct iwl_priv *priv);
134 /* alive notification */
135 int (*alive_notify)(struct iwl_priv *priv);
136 /* check validity of rtc data address */
137 int (*is_valid_rtc_data_addr)(u32 addr);
139 int (*load_ucode)(struct iwl_priv *priv);
140 /* power management */
142 int (*init)(struct iwl_priv *priv);
143 int (*reset)(struct iwl_priv *priv);
144 void (*stop)(struct iwl_priv *priv);
145 void (*config)(struct iwl_priv *priv);
146 int (*set_pwr_src)(struct iwl_priv *priv, enum iwl_pwr_src src);
149 int (*send_tx_power) (struct iwl_priv *priv);
150 void (*update_chain_flags)(struct iwl_priv *priv);
151 void (*temperature) (struct iwl_priv *priv);
152 /* eeprom operations (as defined in iwl-eeprom.h) */
153 struct iwl_eeprom_ops eeprom_ops;
157 const struct iwl_lib_ops *lib;
158 const struct iwl_hcmd_ops *hcmd;
159 const struct iwl_hcmd_utils_ops *utils;
162 struct iwl_mod_params {
163 int disable; /* def: 0 = enable radio */
164 int sw_crypto; /* def: 0 = using hardware encryption */
165 u32 debug; /* def: 0 = minimal debug log messages */
166 int disable_hw_scan; /* def: 0 = use h/w scan */
167 int num_of_queues; /* def: HW dependent */
168 int num_of_ampdu_queues;/* def: HW dependent */
169 int disable_11n; /* def: 0 = disable 11n capabilities */
170 int amsdu_size_8K; /* def: 1 = enable 8K amsdu size */
171 int antenna; /* def: 0 = both antennas (use diversity) */
172 int restart_fw; /* def: 1 = restart firmware */
177 * @fw_name_pre: Firmware filename prefix. The api version and extension
178 * (.ucode) will be added to filename before loading from disk. The
179 * filename is constructed as fw_name_pre<api>.ucode.
180 * @ucode_api_max: Highest version of uCode API supported by driver.
181 * @ucode_api_min: Lowest version of uCode API supported by driver.
183 * We enable the driver to be backward compatible wrt API version. The
184 * driver specifies which APIs it supports (with @ucode_api_max being the
185 * highest and @ucode_api_min the lowest). Firmware will only be loaded if
186 * it has a supported API version. The firmware's API version will be
187 * stored in @iwl_priv, enabling the driver to make runtime changes based
188 * on firmware version used.
191 * if (IWL_UCODE_API(priv->ucode_ver) >= 2) {
192 * Driver interacts with Firmware API version >= 2.
194 * Driver interacts with Firmware API version 1.
197 * The ideal usage of this infrastructure is to treat a new ucode API
198 * release as a new hardware revision. That is, through utilizing the
199 * iwl_hcmd_utils_ops etc. we accommodate different command structures
200 * and flows between hardware versions (4965/5000) as well as their API
205 const char *fw_name_pre;
206 const unsigned int ucode_api_max;
207 const unsigned int ucode_api_min;
211 u16 eeprom_calib_ver;
212 const struct iwl_ops *ops;
213 const struct iwl_mod_params *mod_params;
219 /***************************
221 ***************************/
223 struct ieee80211_hw *iwl_alloc_all(struct iwl_cfg *cfg,
224 struct ieee80211_ops *hw_ops);
225 void iwl_hw_detect(struct iwl_priv *priv);
226 void iwl_reset_qos(struct iwl_priv *priv);
227 void iwl_activate_qos(struct iwl_priv *priv, u8 force);
228 void iwl_set_rxon_hwcrypto(struct iwl_priv *priv, int hw_decrypt);
229 int iwl_check_rxon_cmd(struct iwl_priv *priv);
230 int iwl_full_rxon_required(struct iwl_priv *priv);
231 void iwl_set_rxon_chain(struct iwl_priv *priv);
232 int iwl_set_rxon_channel(struct iwl_priv *priv, struct ieee80211_channel *ch);
233 void iwl_set_rxon_ht(struct iwl_priv *priv, struct iwl_ht_info *ht_info);
234 u8 iwl_is_fat_tx_allowed(struct iwl_priv *priv,
235 struct ieee80211_sta_ht_cap *sta_ht_inf);
236 void iwl_set_flags_for_band(struct iwl_priv *priv, enum ieee80211_band band);
237 void iwl_connection_init_rx_config(struct iwl_priv *priv, int mode);
238 int iwl_set_decrypted_flag(struct iwl_priv *priv,
239 struct ieee80211_hdr *hdr,
241 struct ieee80211_rx_status *stats);
242 void iwl_irq_handle_error(struct iwl_priv *priv);
243 void iwl_configure_filter(struct ieee80211_hw *hw,
244 unsigned int changed_flags,
245 unsigned int *total_flags,
246 int mc_count, struct dev_addr_list *mc_list);
247 int iwl_hw_nic_init(struct iwl_priv *priv);
248 int iwl_setup_mac(struct iwl_priv *priv);
249 int iwl_set_hw_params(struct iwl_priv *priv);
250 int iwl_init_drv(struct iwl_priv *priv);
251 void iwl_uninit_drv(struct iwl_priv *priv);
253 /*****************************************************
255 * **************************************************/
256 void iwl_rx_pm_sleep_notif(struct iwl_priv *priv,
257 struct iwl_rx_mem_buffer *rxb);
258 void iwl_rx_pm_debug_statistics_notif(struct iwl_priv *priv,
259 struct iwl_rx_mem_buffer *rxb);
260 void iwl_rx_reply_error(struct iwl_priv *priv,
261 struct iwl_rx_mem_buffer *rxb);
263 /*****************************************************
265 ******************************************************/
266 void iwl_rx_queue_free(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
267 void iwl_cmd_queue_free(struct iwl_priv *priv);
268 int iwl_rx_queue_alloc(struct iwl_priv *priv);
269 void iwl_rx_handle(struct iwl_priv *priv);
270 int iwl_rx_queue_update_write_ptr(struct iwl_priv *priv,
271 struct iwl_rx_queue *q);
272 void iwl_rx_queue_reset(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
273 void iwl_rx_replenish(struct iwl_priv *priv);
274 int iwl_rx_init(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
275 int iwl_rx_queue_restock(struct iwl_priv *priv);
276 int iwl_rx_queue_space(const struct iwl_rx_queue *q);
277 void iwl_rx_allocate(struct iwl_priv *priv);
278 void iwl_tx_cmd_complete(struct iwl_priv *priv, struct iwl_rx_mem_buffer *rxb);
279 int iwl_tx_queue_reclaim(struct iwl_priv *priv, int txq_id, int index);
281 void iwl_rx_missed_beacon_notif(struct iwl_priv *priv,
282 struct iwl_rx_mem_buffer *rxb);
283 void iwl_rx_statistics(struct iwl_priv *priv,
284 struct iwl_rx_mem_buffer *rxb);
285 void iwl_rx_csa(struct iwl_priv *priv, struct iwl_rx_mem_buffer *rxb);
289 /*****************************************************
291 ******************************************************/
292 int iwl_txq_ctx_reset(struct iwl_priv *priv);
293 void iwl_hw_txq_free_tfd(struct iwl_priv *priv, struct iwl_tx_queue *txq);
294 int iwl_hw_txq_attach_buf_to_tfd(struct iwl_priv *priv,
295 struct iwl_tx_queue *txq,
296 dma_addr_t addr, u16 len, u8 reset, u8 pad);
297 int iwl_tx_skb(struct iwl_priv *priv, struct sk_buff *skb);
298 void iwl_hw_txq_ctx_free(struct iwl_priv *priv);
299 int iwl_hw_tx_queue_init(struct iwl_priv *priv,
300 struct iwl_tx_queue *txq);
301 int iwl_txq_update_write_ptr(struct iwl_priv *priv, struct iwl_tx_queue *txq);
302 int iwl_tx_queue_init(struct iwl_priv *priv, struct iwl_tx_queue *txq,
303 int slots_num, u32 txq_id);
304 void iwl_tx_queue_free(struct iwl_priv *priv, int txq_id);
305 int iwl_tx_agg_start(struct iwl_priv *priv, const u8 *ra, u16 tid, u16 *ssn);
306 int iwl_tx_agg_stop(struct iwl_priv *priv , const u8 *ra, u16 tid);
307 int iwl_txq_check_empty(struct iwl_priv *priv, int sta_id, u8 tid, int txq_id);
308 /*****************************************************
310 ****************************************************/
311 int iwl_set_tx_power(struct iwl_priv *priv, s8 tx_power, bool force);
313 /*****************************************************
314 * RF -Kill - here and not in iwl-rfkill.h to be available when
315 * RF-kill subsystem is not compiled.
316 ****************************************************/
317 void iwl_bg_rf_kill(struct work_struct *work);
318 void iwl_radio_kill_sw_disable_radio(struct iwl_priv *priv);
319 int iwl_radio_kill_sw_enable_radio(struct iwl_priv *priv);
321 /*******************************************************************************
323 ******************************************************************************/
325 void iwl_hwrate_to_tx_control(struct iwl_priv *priv, u32 rate_n_flags,
326 struct ieee80211_tx_info *info);
327 int iwl_hwrate_to_plcp_idx(u32 rate_n_flags);
329 u8 iwl_rate_get_lowest_plcp(struct iwl_priv *priv);
331 void iwl_set_rate(struct iwl_priv *priv);
333 u8 iwl_toggle_tx_ant(struct iwl_priv *priv, u8 ant_idx);
335 static inline u32 iwl_ant_idx_to_flags(u8 ant_idx)
337 return BIT(ant_idx) << RATE_MCS_ANT_POS;
340 static inline u8 iwl_hw_get_rate(__le32 rate_n_flags)
342 return le32_to_cpu(rate_n_flags) & 0xFF;
344 static inline u32 iwl_hw_get_rate_n_flags(__le32 rate_n_flags)
346 return le32_to_cpu(rate_n_flags) & 0x1FFFF;
348 static inline __le32 iwl_hw_set_rate_n_flags(u8 rate, u32 flags)
350 return cpu_to_le32(flags|(u32)rate);
353 /*******************************************************************************
355 ******************************************************************************/
356 void iwl_init_scan_params(struct iwl_priv *priv);
357 int iwl_scan_cancel(struct iwl_priv *priv);
358 int iwl_scan_cancel_timeout(struct iwl_priv *priv, unsigned long ms);
359 int iwl_scan_initiate(struct iwl_priv *priv);
360 int iwl_mac_hw_scan(struct ieee80211_hw *hw, struct cfg80211_scan_request *req);
361 u16 iwl_fill_probe_req(struct iwl_priv *priv, enum ieee80211_band band,
362 struct ieee80211_mgmt *frame, int left);
363 void iwl_setup_rx_scan_handlers(struct iwl_priv *priv);
364 u16 iwl_get_active_dwell_time(struct iwl_priv *priv,
365 enum ieee80211_band band,
367 u16 iwl_get_passive_dwell_time(struct iwl_priv *priv,
368 enum ieee80211_band band);
369 void iwl_bg_scan_check(struct work_struct *data);
370 void iwl_bg_abort_scan(struct work_struct *work);
371 void iwl_bg_scan_completed(struct work_struct *work);
372 void iwl_setup_scan_deferred_work(struct iwl_priv *priv);
373 int iwl_send_scan_abort(struct iwl_priv *priv);
375 /* For faster active scanning, scan will move to the next channel if fewer than
376 * PLCP_QUIET_THRESH packets are heard on this channel within
377 * ACTIVE_QUIET_TIME after sending probe request. This shortens the dwell
378 * time if it's a quiet channel (nothing responded to our probe, and there's
380 * Disable "quiet" feature by setting PLCP_QUIET_THRESH to 0. */
381 #define IWL_ACTIVE_QUIET_TIME cpu_to_le16(10) /* msec */
382 #define IWL_PLCP_QUIET_THRESH cpu_to_le16(1) /* packets */
385 /*******************************************************************************
386 * Calibrations - implemented in iwl-calib.c
387 ******************************************************************************/
388 int iwl_send_calib_results(struct iwl_priv *priv);
389 int iwl_calib_set(struct iwl_calib_result *res, const u8 *buf, int len);
390 void iwl_calib_free_results(struct iwl_priv *priv);
392 /*******************************************************************************
393 * Spectrum Measureemtns in iwl-spectrum.c
394 ******************************************************************************/
395 #ifdef CONFIG_IWLWIFI_SPECTRUM_MEASUREMENT
396 void iwl_setup_spectrum_handlers(struct iwl_priv *priv);
398 static inline void iwl_setup_spectrum_handlers(struct iwl_priv *priv) {}
400 /*****************************************************
401 * S e n d i n g H o s t C o m m a n d s *
402 *****************************************************/
404 const char *get_cmd_string(u8 cmd);
405 int __must_check iwl_send_cmd_sync(struct iwl_priv *priv,
406 struct iwl_host_cmd *cmd);
407 int iwl_send_cmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
408 int __must_check iwl_send_cmd_pdu(struct iwl_priv *priv, u8 id,
409 u16 len, const void *data);
410 int iwl_send_cmd_pdu_async(struct iwl_priv *priv, u8 id, u16 len,
412 int (*callback)(struct iwl_priv *priv,
414 struct sk_buff *skb));
416 int iwl_enqueue_hcmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
418 int iwl_send_card_state(struct iwl_priv *priv, u32 flags,
421 /*****************************************************
423 *****************************************************/
424 void iwl_disable_interrupts(struct iwl_priv *priv);
425 void iwl_enable_interrupts(struct iwl_priv *priv);
426 irqreturn_t iwl_isr(int irq, void *data);
427 static inline u16 iwl_pcie_link_ctl(struct iwl_priv *priv)
431 pos = pci_find_capability(priv->pci_dev, PCI_CAP_ID_EXP);
432 pci_read_config_word(priv->pci_dev, pos + PCI_EXP_LNKCTL, &pci_lnk_ctl);
436 /*****************************************************
437 * Error Handling Debugging
438 ******************************************************/
439 void iwl_dump_nic_error_log(struct iwl_priv *priv);
440 void iwl_dump_nic_event_log(struct iwl_priv *priv);
442 /*****************************************************
444 ******************************************************/
445 int iwlcore_init_geos(struct iwl_priv *priv);
446 void iwlcore_free_geos(struct iwl_priv *priv);
448 /*************** DRIVER STATUS FUNCTIONS *****/
450 #define STATUS_HCMD_ACTIVE 0 /* host command in progress */
451 #define STATUS_HCMD_SYNC_ACTIVE 1 /* sync host command in progress */
452 #define STATUS_INT_ENABLED 2
453 #define STATUS_RF_KILL_HW 3
454 #define STATUS_RF_KILL_SW 4
455 #define STATUS_INIT 5
456 #define STATUS_ALIVE 6
457 #define STATUS_READY 7
458 #define STATUS_TEMPERATURE 8
459 #define STATUS_GEO_CONFIGURED 9
460 #define STATUS_EXIT_PENDING 10
461 #define STATUS_IN_SUSPEND 11
462 #define STATUS_STATISTICS 12
463 #define STATUS_SCANNING 13
464 #define STATUS_SCAN_ABORTING 14
465 #define STATUS_SCAN_HW 15
466 #define STATUS_POWER_PMI 16
467 #define STATUS_FW_ERROR 17
468 #define STATUS_MODE_PENDING 18
471 static inline int iwl_is_ready(struct iwl_priv *priv)
473 /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
474 * set but EXIT_PENDING is not */
475 return test_bit(STATUS_READY, &priv->status) &&
476 test_bit(STATUS_GEO_CONFIGURED, &priv->status) &&
477 !test_bit(STATUS_EXIT_PENDING, &priv->status);
480 static inline int iwl_is_alive(struct iwl_priv *priv)
482 return test_bit(STATUS_ALIVE, &priv->status);
485 static inline int iwl_is_init(struct iwl_priv *priv)
487 return test_bit(STATUS_INIT, &priv->status);
490 static inline int iwl_is_rfkill_sw(struct iwl_priv *priv)
492 return test_bit(STATUS_RF_KILL_SW, &priv->status);
495 static inline int iwl_is_rfkill_hw(struct iwl_priv *priv)
497 return test_bit(STATUS_RF_KILL_HW, &priv->status);
500 static inline int iwl_is_rfkill(struct iwl_priv *priv)
502 return iwl_is_rfkill_hw(priv) || iwl_is_rfkill_sw(priv);
505 static inline int iwl_is_ready_rf(struct iwl_priv *priv)
508 if (iwl_is_rfkill(priv))
511 return iwl_is_ready(priv);
514 extern void iwl_rf_kill_ct_config(struct iwl_priv *priv);
515 extern int iwl_send_bt_config(struct iwl_priv *priv);
516 extern int iwl_send_statistics_request(struct iwl_priv *priv, u8 flags);
517 extern int iwl_verify_ucode(struct iwl_priv *priv);
518 extern int iwl_send_lq_cmd(struct iwl_priv *priv,
519 struct iwl_link_quality_cmd *lq, u8 flags);
520 extern void iwl_rx_reply_rx(struct iwl_priv *priv,
521 struct iwl_rx_mem_buffer *rxb);
522 extern void iwl_rx_reply_rx_phy(struct iwl_priv *priv,
523 struct iwl_rx_mem_buffer *rxb);
524 void iwl_rx_reply_compressed_ba(struct iwl_priv *priv,
525 struct iwl_rx_mem_buffer *rxb);
527 static inline int iwl_send_rxon_assoc(struct iwl_priv *priv)
529 return priv->cfg->ops->hcmd->rxon_assoc(priv);
532 static inline const struct ieee80211_supported_band *iwl_get_hw_mode(
533 struct iwl_priv *priv, enum ieee80211_band band)
535 return priv->hw->wiphy->bands[band];
538 #endif /* __iwl_core_h__ */