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 - 2011 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 - 2011 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__
68 /************************
69 * forward declarations *
70 ************************/
75 #define IWLWIFI_VERSION "in-tree:"
76 #define DRV_COPYRIGHT "Copyright(c) 2003-2011 Intel Corporation"
77 #define DRV_AUTHOR "<ilw@linux.intel.com>"
79 #define TIME_UNIT 1024
81 #define IWL_CMD(x) case x: return #x
84 /* set hw dependent parameters */
85 int (*set_hw_params)(struct iwl_priv *priv);
86 /* setup Rx handler */
87 void (*rx_handler_setup)(struct iwl_priv *priv);
88 /* setup deferred work */
89 void (*setup_deferred_work)(struct iwl_priv *priv);
90 /* cancel deferred work */
91 void (*cancel_deferred_work)(struct iwl_priv *priv);
92 /* check validity of rtc data address */
93 int (*is_valid_rtc_data_addr)(u32 addr);
94 int (*set_channel_switch)(struct iwl_priv *priv,
95 struct ieee80211_channel_switch *ch_switch);
96 /* device specific configuration */
97 void (*nic_config)(struct iwl_priv *priv);
99 /* eeprom operations (as defined in iwl-eeprom.h) */
100 struct iwl_eeprom_ops eeprom_ops;
103 void (*temperature)(struct iwl_priv *priv);
106 /* NIC specific ops */
108 void (*additional_nic_config)(struct iwl_priv *priv);
112 const struct iwl_lib_ops *lib;
113 const struct iwl_nic_ops *nic;
116 struct iwl_mod_params {
117 int sw_crypto; /* def: 0 = using hardware encryption */
118 int num_of_queues; /* def: HW dependent */
119 int disable_11n; /* def: 0 = 11n capabilities enabled */
120 int amsdu_size_8K; /* def: 1 = enable 8K amsdu size */
121 int antenna; /* def: 0 = both antennas (use diversity) */
122 int restart_fw; /* def: 1 = restart firmware */
123 bool plcp_check; /* def: true = enable plcp health check */
124 bool ack_check; /* def: false = disable ack health check */
125 bool wd_disable; /* def: false = enable stuck queue check */
126 bool bt_coex_active; /* def: true = enable bt coex */
127 int led_mode; /* def: 0 = system default */
128 bool no_sleep_autoadjust; /* def: true = disable autoadjust */
129 bool power_save; /* def: false = disable power save */
130 int power_level; /* def: 1 = power level */
134 * @max_ll_items: max number of OTP blocks
135 * @shadow_ram_support: shadow support for OTP memory
136 * @led_compensation: compensate on the led on/off time per HW according
137 * to the deviation to achieve the desired led frequency.
138 * The detail algorithm is described in iwl-led.c
139 * @chain_noise_num_beacons: number of beacons used to compute chain noise
140 * @adv_thermal_throttle: support advance thermal throttle
141 * @support_ct_kill_exit: support ct kill exit condition
142 * @support_wimax_coexist: support wimax/wifi co-exist
143 * @plcp_delta_threshold: plcp error rate threshold used to trigger
144 * radio tuning when there is a high receiving plcp error rate
145 * @chain_noise_scale: default chain noise scale used for gain computation
146 * @wd_timeout: TX queues watchdog timeout
147 * @temperature_kelvin: temperature report by uCode in kelvin
148 * @max_event_log_size: size of event log buffer size for ucode event logging
149 * @shadow_reg_enable: HW shadhow register bit
151 struct iwl_base_params {
153 int num_of_queues; /* def: HW dependent */
154 int num_of_ampdu_queues;/* def: HW dependent */
155 /* for iwl_apm_init() */
158 const u16 max_ll_items;
159 const bool shadow_ram_support;
160 u16 led_compensation;
161 int chain_noise_num_beacons;
162 bool adv_thermal_throttle;
163 bool support_ct_kill_exit;
164 const bool support_wimax_coexist;
165 u8 plcp_delta_threshold;
166 s32 chain_noise_scale;
167 unsigned int wd_timeout;
168 bool temperature_kelvin;
169 u32 max_event_log_size;
170 const bool shadow_reg_enable;
173 * @advanced_bt_coexist: support advanced bt coexist
174 * @bt_init_traffic_load: specify initial bt traffic load
175 * @bt_prio_boost: default bt priority boost value
176 * @agg_time_limit: maximum number of uSec in aggregation
177 * @ampdu_factor: Maximum A-MPDU length factor
178 * @ampdu_density: Minimum A-MPDU spacing
179 * @bt_sco_disable: uCode should not response to BT in SCO/ESCO mode
181 struct iwl_bt_params {
182 bool advanced_bt_coexist;
183 u8 bt_init_traffic_load;
192 * @use_rts_for_aggregation: use rts/cts protection for HT traffic
194 struct iwl_ht_params {
195 const bool ht_greenfield_support; /* if used set to true */
196 bool use_rts_for_aggregation;
197 enum ieee80211_smps_mode smps_mode;
202 * @fw_name_pre: Firmware filename prefix. The api version and extension
203 * (.ucode) will be added to filename before loading from disk. The
204 * filename is constructed as fw_name_pre<api>.ucode.
205 * @ucode_api_max: Highest version of uCode API supported by driver.
206 * @ucode_api_min: Lowest version of uCode API supported by driver.
207 * @pa_type: used by 6000 series only to identify the type of Power Amplifier
208 * @need_dc_calib: need to perform init dc calibration
209 * @need_temp_offset_calib: need to perform temperature offset calibration
210 * @scan_antennas: available antenna for scan operation
211 * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
212 * @adv_pm: advance power management
213 * @rx_with_siso_diversity: 1x1 device with rx antenna diversity
214 * @internal_wimax_coex: internal wifi/wimax combo device
215 * @iq_invert: I/Q inversion
216 * @disable_otp_refresh: disable OTP refresh current limit
218 * We enable the driver to be backward compatible wrt API version. The
219 * driver specifies which APIs it supports (with @ucode_api_max being the
220 * highest and @ucode_api_min the lowest). Firmware will only be loaded if
221 * it has a supported API version. The firmware's API version will be
222 * stored in @iwl_priv, enabling the driver to make runtime changes based
223 * on firmware version used.
226 * if (IWL_UCODE_API(priv->ucode_ver) >= 2) {
227 * Driver interacts with Firmware API version >= 2.
229 * Driver interacts with Firmware API version 1.
232 * The ideal usage of this infrastructure is to treat a new ucode API
233 * release as a new hardware revision. That is, through utilizing the
234 * iwl_hcmd_utils_ops etc. we accommodate different command structures
235 * and flows between hardware versions (4965/5000) as well as their API
240 /* params specific to an individual device within a device family */
242 const char *fw_name_pre;
243 const unsigned int ucode_api_max;
244 const unsigned int ucode_api_min;
249 u16 eeprom_calib_ver;
250 const struct iwl_ops *ops;
251 /* params not likely to change within a device family */
252 struct iwl_base_params *base_params;
253 /* params likely to change within a device family */
254 struct iwl_ht_params *ht_params;
255 struct iwl_bt_params *bt_params;
256 enum iwl_pa_type pa_type; /* if used set to IWL_PA_SYSTEM */
257 const bool need_dc_calib; /* if used set to true */
258 const bool need_temp_offset_calib; /* if used set to true */
259 u8 scan_rx_antennas[IEEE80211_NUM_BANDS];
260 enum iwl_led_mode led_mode;
262 const bool rx_with_siso_diversity;
263 const bool internal_wimax_coex;
264 const bool iq_invert;
265 const bool disable_otp_refresh;
268 /***************************
270 ***************************/
272 int iwl_mac_conf_tx(struct ieee80211_hw *hw, u16 queue,
273 const struct ieee80211_tx_queue_params *params);
274 int iwl_mac_tx_last_beacon(struct ieee80211_hw *hw);
275 void iwl_set_rxon_hwcrypto(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
277 int iwl_check_rxon_cmd(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
278 int iwl_full_rxon_required(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
279 int iwl_set_rxon_channel(struct iwl_priv *priv, struct ieee80211_channel *ch,
280 struct iwl_rxon_context *ctx);
281 void iwl_set_flags_for_band(struct iwl_priv *priv,
282 struct iwl_rxon_context *ctx,
283 enum ieee80211_band band,
284 struct ieee80211_vif *vif);
285 u8 iwl_get_single_channel_number(struct iwl_priv *priv,
286 enum ieee80211_band band);
287 void iwl_set_rxon_ht(struct iwl_priv *priv, struct iwl_ht_config *ht_conf);
288 bool iwl_is_ht40_tx_allowed(struct iwl_priv *priv,
289 struct iwl_rxon_context *ctx,
290 struct ieee80211_sta_ht_cap *ht_cap);
291 void iwl_connection_init_rx_config(struct iwl_priv *priv,
292 struct iwl_rxon_context *ctx);
293 void iwl_set_rate(struct iwl_priv *priv);
294 void iwl_irq_handle_error(struct iwl_priv *priv);
295 int iwl_mac_add_interface(struct ieee80211_hw *hw,
296 struct ieee80211_vif *vif);
297 void iwl_mac_remove_interface(struct ieee80211_hw *hw,
298 struct ieee80211_vif *vif);
299 int iwl_mac_change_interface(struct ieee80211_hw *hw,
300 struct ieee80211_vif *vif,
301 enum nl80211_iftype newtype, bool newp2p);
302 #ifdef CONFIG_IWLWIFI_DEBUGFS
303 int iwl_alloc_traffic_mem(struct iwl_priv *priv);
304 void iwl_free_traffic_mem(struct iwl_priv *priv);
305 void iwl_reset_traffic_log(struct iwl_priv *priv);
306 void iwl_dbg_log_tx_data_frame(struct iwl_priv *priv,
307 u16 length, struct ieee80211_hdr *header);
308 void iwl_dbg_log_rx_data_frame(struct iwl_priv *priv,
309 u16 length, struct ieee80211_hdr *header);
310 const char *get_mgmt_string(int cmd);
311 const char *get_ctrl_string(int cmd);
312 void iwl_clear_traffic_stats(struct iwl_priv *priv);
313 void iwl_update_stats(struct iwl_priv *priv, bool is_tx, __le16 fc,
316 static inline int iwl_alloc_traffic_mem(struct iwl_priv *priv)
320 static inline void iwl_free_traffic_mem(struct iwl_priv *priv)
323 static inline void iwl_reset_traffic_log(struct iwl_priv *priv)
326 static inline void iwl_dbg_log_tx_data_frame(struct iwl_priv *priv,
327 u16 length, struct ieee80211_hdr *header)
330 static inline void iwl_dbg_log_rx_data_frame(struct iwl_priv *priv,
331 u16 length, struct ieee80211_hdr *header)
334 static inline void iwl_update_stats(struct iwl_priv *priv, bool is_tx,
340 /*****************************************************
342 ******************************************************/
343 void iwl_rx_queue_update_write_ptr(struct iwl_priv *priv,
344 struct iwl_rx_queue *q);
345 int iwl_rx_queue_space(const struct iwl_rx_queue *q);
346 void iwl_tx_cmd_complete(struct iwl_priv *priv, struct iwl_rx_mem_buffer *rxb);
348 void iwl_chswitch_done(struct iwl_priv *priv, bool is_success);
352 /*****************************************************
354 ******************************************************/
355 void iwl_txq_update_write_ptr(struct iwl_priv *priv, struct iwl_tx_queue *txq);
356 int iwl_queue_init(struct iwl_priv *priv, struct iwl_queue *q,
357 int count, int slots_num, u32 id);
358 void iwl_setup_watchdog(struct iwl_priv *priv);
359 /*****************************************************
361 ****************************************************/
362 int iwl_set_tx_power(struct iwl_priv *priv, s8 tx_power, bool force);
364 /*******************************************************************************
366 ******************************************************************************/
367 void iwl_init_scan_params(struct iwl_priv *priv);
368 int iwl_scan_cancel(struct iwl_priv *priv);
369 int iwl_scan_cancel_timeout(struct iwl_priv *priv, unsigned long ms);
370 void iwl_force_scan_end(struct iwl_priv *priv);
371 int iwl_mac_hw_scan(struct ieee80211_hw *hw,
372 struct ieee80211_vif *vif,
373 struct cfg80211_scan_request *req);
374 void iwl_internal_short_hw_scan(struct iwl_priv *priv);
375 int iwl_force_reset(struct iwl_priv *priv, int mode, bool external);
376 u16 iwl_fill_probe_req(struct iwl_priv *priv, struct ieee80211_mgmt *frame,
377 const u8 *ta, const u8 *ie, int ie_len, int left);
378 void iwl_setup_rx_scan_handlers(struct iwl_priv *priv);
379 u16 iwl_get_active_dwell_time(struct iwl_priv *priv,
380 enum ieee80211_band band,
382 u16 iwl_get_passive_dwell_time(struct iwl_priv *priv,
383 enum ieee80211_band band,
384 struct ieee80211_vif *vif);
385 void iwl_setup_scan_deferred_work(struct iwl_priv *priv);
386 void iwl_cancel_scan_deferred_work(struct iwl_priv *priv);
387 int __must_check iwl_scan_initiate(struct iwl_priv *priv,
388 struct ieee80211_vif *vif,
389 enum iwl_scan_type scan_type,
390 enum ieee80211_band band);
392 /* For faster active scanning, scan will move to the next channel if fewer than
393 * PLCP_QUIET_THRESH packets are heard on this channel within
394 * ACTIVE_QUIET_TIME after sending probe request. This shortens the dwell
395 * time if it's a quiet channel (nothing responded to our probe, and there's
397 * Disable "quiet" feature by setting PLCP_QUIET_THRESH to 0. */
398 #define IWL_ACTIVE_QUIET_TIME cpu_to_le16(10) /* msec */
399 #define IWL_PLCP_QUIET_THRESH cpu_to_le16(1) /* packets */
401 #define IWL_SCAN_CHECK_WATCHDOG (HZ * 7)
403 /*****************************************************
404 * S e n d i n g H o s t C o m m a n d s *
405 *****************************************************/
407 const char *get_cmd_string(u8 cmd);
408 int iwl_send_cmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
409 int __must_check iwl_send_cmd_pdu(struct iwl_priv *priv, u8 id, u32 flags,
410 u16 len, const void *data);
412 int iwl_enqueue_hcmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
414 void iwl_bg_watchdog(unsigned long data);
415 u32 iwl_usecs_to_beacons(struct iwl_priv *priv, u32 usec, u32 beacon_interval);
416 __le32 iwl_add_beacon_time(struct iwl_priv *priv, u32 base,
417 u32 addon, u32 beacon_interval);
420 int iwl_suspend(struct iwl_priv *priv);
421 int iwl_resume(struct iwl_priv *priv);
422 #endif /* !CONFIG_PM */
424 /*****************************************************
425 * Error Handling Debugging
426 ******************************************************/
427 void iwl_dump_nic_error_log(struct iwl_priv *priv);
428 int iwl_dump_nic_event_log(struct iwl_priv *priv,
429 bool full_log, char **buf, bool display);
430 void iwl_dump_csr(struct iwl_priv *priv);
431 int iwl_dump_fh(struct iwl_priv *priv, char **buf, bool display);
432 #ifdef CONFIG_IWLWIFI_DEBUG
433 void iwl_print_rx_config_cmd(struct iwl_priv *priv,
434 struct iwl_rxon_context *ctx);
436 static inline void iwl_print_rx_config_cmd(struct iwl_priv *priv,
437 struct iwl_rxon_context *ctx)
442 void iwl_clear_isr_stats(struct iwl_priv *priv);
444 /*****************************************************
446 ******************************************************/
447 int iwlcore_init_geos(struct iwl_priv *priv);
448 void iwlcore_free_geos(struct iwl_priv *priv);
450 /*************** DRIVER STATUS FUNCTIONS *****/
452 #define STATUS_HCMD_ACTIVE 0 /* host command in progress */
453 /* 1 is unused (used to be STATUS_HCMD_SYNC_ACTIVE) */
454 #define STATUS_INT_ENABLED 2
455 #define STATUS_RF_KILL_HW 3
456 #define STATUS_CT_KILL 4
457 #define STATUS_INIT 5
458 #define STATUS_ALIVE 6
459 #define STATUS_READY 7
460 #define STATUS_TEMPERATURE 8
461 #define STATUS_GEO_CONFIGURED 9
462 #define STATUS_EXIT_PENDING 10
463 #define STATUS_STATISTICS 12
464 #define STATUS_SCANNING 13
465 #define STATUS_SCAN_ABORTING 14
466 #define STATUS_SCAN_HW 15
467 #define STATUS_POWER_PMI 16
468 #define STATUS_FW_ERROR 17
469 #define STATUS_DEVICE_ENABLED 18
470 #define STATUS_CHANNEL_SWITCH_PENDING 19
473 static inline int iwl_is_ready(struct iwl_priv *priv)
475 /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
476 * set but EXIT_PENDING is not */
477 return test_bit(STATUS_READY, &priv->status) &&
478 test_bit(STATUS_GEO_CONFIGURED, &priv->status) &&
479 !test_bit(STATUS_EXIT_PENDING, &priv->status);
482 static inline int iwl_is_alive(struct iwl_priv *priv)
484 return test_bit(STATUS_ALIVE, &priv->status);
487 static inline int iwl_is_init(struct iwl_priv *priv)
489 return test_bit(STATUS_INIT, &priv->status);
492 static inline int iwl_is_rfkill_hw(struct iwl_priv *priv)
494 return test_bit(STATUS_RF_KILL_HW, &priv->status);
497 static inline int iwl_is_rfkill(struct iwl_priv *priv)
499 return iwl_is_rfkill_hw(priv);
502 static inline int iwl_is_ctkill(struct iwl_priv *priv)
504 return test_bit(STATUS_CT_KILL, &priv->status);
507 static inline int iwl_is_ready_rf(struct iwl_priv *priv)
510 if (iwl_is_rfkill(priv))
513 return iwl_is_ready(priv);
516 extern void iwl_send_bt_config(struct iwl_priv *priv);
517 extern int iwl_send_statistics_request(struct iwl_priv *priv,
518 u8 flags, bool clear);
519 void iwl_apm_stop(struct iwl_priv *priv);
520 int iwl_apm_init(struct iwl_priv *priv);
522 int iwl_send_rxon_timing(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
524 static inline const struct ieee80211_supported_band *iwl_get_hw_mode(
525 struct iwl_priv *priv, enum ieee80211_band band)
527 return priv->hw->wiphy->bands[band];
530 static inline bool iwl_advanced_bt_coexist(struct iwl_priv *priv)
532 return priv->cfg->bt_params &&
533 priv->cfg->bt_params->advanced_bt_coexist;
536 extern bool bt_siso_mode;
539 void iwlagn_fw_error(struct iwl_priv *priv, bool ondemand);
541 #endif /* __iwl_core_h__ */