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
83 struct iwl_hcmd_utils_ops {
84 u16 (*build_addsta_hcmd)(const struct iwl_addsta_cmd *cmd, u8 *data);
85 void (*gain_computation)(struct iwl_priv *priv,
87 u16 min_average_noise_antennat_i,
88 u32 min_average_noise,
90 void (*chain_noise_reset)(struct iwl_priv *priv);
91 void (*tx_cmd_protection)(struct iwl_priv *priv,
92 struct ieee80211_tx_info *info,
93 __le16 fc, __le32 *tx_flags);
94 int (*calc_rssi)(struct iwl_priv *priv,
95 struct iwl_rx_phy_res *rx_resp);
96 int (*request_scan)(struct iwl_priv *priv, struct ieee80211_vif *vif);
100 int (*init)(struct iwl_priv *priv);
101 void (*config)(struct iwl_priv *priv);
104 struct iwl_temp_ops {
105 void (*temperature)(struct iwl_priv *priv);
109 /* set hw dependent parameters */
110 int (*set_hw_params)(struct iwl_priv *priv);
111 /* setup Rx handler */
112 void (*rx_handler_setup)(struct iwl_priv *priv);
113 /* setup deferred work */
114 void (*setup_deferred_work)(struct iwl_priv *priv);
115 /* cancel deferred work */
116 void (*cancel_deferred_work)(struct iwl_priv *priv);
117 /* check validity of rtc data address */
118 int (*is_valid_rtc_data_addr)(u32 addr);
119 int (*set_channel_switch)(struct iwl_priv *priv,
120 struct ieee80211_channel_switch *ch_switch);
121 /* power management */
122 struct iwl_apm_ops apm_ops;
125 void (*update_chain_flags)(struct iwl_priv *priv);
127 /* eeprom operations (as defined in iwl-eeprom.h) */
128 struct iwl_eeprom_ops eeprom_ops;
131 struct iwl_temp_ops temp_ops;
134 /* NIC specific ops */
136 void (*additional_nic_config)(struct iwl_priv *priv);
140 const struct iwl_lib_ops *lib;
141 const struct iwl_hcmd_utils_ops *utils;
142 const struct iwl_nic_ops *nic;
145 struct iwl_mod_params {
146 int sw_crypto; /* def: 0 = using hardware encryption */
147 int num_of_queues; /* def: HW dependent */
148 int disable_11n; /* def: 0 = 11n capabilities enabled */
149 int amsdu_size_8K; /* def: 1 = enable 8K amsdu size */
150 int antenna; /* def: 0 = both antennas (use diversity) */
151 int restart_fw; /* def: 1 = restart firmware */
152 bool plcp_check; /* def: true = enable plcp health check */
153 bool ack_check; /* def: false = disable ack health check */
154 bool wd_disable; /* def: false = enable stuck queue check */
155 bool bt_coex_active; /* def: true = enable bt coex */
156 int led_mode; /* def: 0 = system default */
157 bool no_sleep_autoadjust; /* def: true = disable autoadjust */
158 bool power_save; /* def: false = disable power save */
159 int power_level; /* def: 1 = power level */
163 * @max_ll_items: max number of OTP blocks
164 * @shadow_ram_support: shadow support for OTP memory
165 * @led_compensation: compensate on the led on/off time per HW according
166 * to the deviation to achieve the desired led frequency.
167 * The detail algorithm is described in iwl-led.c
168 * @chain_noise_num_beacons: number of beacons used to compute chain noise
169 * @adv_thermal_throttle: support advance thermal throttle
170 * @support_ct_kill_exit: support ct kill exit condition
171 * @support_wimax_coexist: support wimax/wifi co-exist
172 * @plcp_delta_threshold: plcp error rate threshold used to trigger
173 * radio tuning when there is a high receiving plcp error rate
174 * @chain_noise_scale: default chain noise scale used for gain computation
175 * @wd_timeout: TX queues watchdog timeout
176 * @temperature_kelvin: temperature report by uCode in kelvin
177 * @max_event_log_size: size of event log buffer size for ucode event logging
178 * @shadow_reg_enable: HW shadhow register bit
180 struct iwl_base_params {
182 int num_of_queues; /* def: HW dependent */
183 int num_of_ampdu_queues;/* def: HW dependent */
184 /* for iwl_apm_init() */
187 const u16 max_ll_items;
188 const bool shadow_ram_support;
189 u16 led_compensation;
190 int chain_noise_num_beacons;
191 bool adv_thermal_throttle;
192 bool support_ct_kill_exit;
193 const bool support_wimax_coexist;
194 u8 plcp_delta_threshold;
195 s32 chain_noise_scale;
196 unsigned int wd_timeout;
197 bool temperature_kelvin;
198 u32 max_event_log_size;
199 const bool shadow_reg_enable;
202 * @advanced_bt_coexist: support advanced bt coexist
203 * @bt_init_traffic_load: specify initial bt traffic load
204 * @bt_prio_boost: default bt priority boost value
205 * @agg_time_limit: maximum number of uSec in aggregation
206 * @ampdu_factor: Maximum A-MPDU length factor
207 * @ampdu_density: Minimum A-MPDU spacing
208 * @bt_sco_disable: uCode should not response to BT in SCO/ESCO mode
210 struct iwl_bt_params {
211 bool advanced_bt_coexist;
212 u8 bt_init_traffic_load;
221 * @use_rts_for_aggregation: use rts/cts protection for HT traffic
223 struct iwl_ht_params {
224 const bool ht_greenfield_support; /* if used set to true */
225 bool use_rts_for_aggregation;
226 enum ieee80211_smps_mode smps_mode;
231 * @fw_name_pre: Firmware filename prefix. The api version and extension
232 * (.ucode) will be added to filename before loading from disk. The
233 * filename is constructed as fw_name_pre<api>.ucode.
234 * @ucode_api_max: Highest version of uCode API supported by driver.
235 * @ucode_api_min: Lowest version of uCode API supported by driver.
236 * @pa_type: used by 6000 series only to identify the type of Power Amplifier
237 * @need_dc_calib: need to perform init dc calibration
238 * @need_temp_offset_calib: need to perform temperature offset calibration
239 * @scan_antennas: available antenna for scan operation
240 * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
241 * @adv_pm: advance power management
242 * @rx_with_siso_diversity: 1x1 device with rx antenna diversity
243 * @internal_wimax_coex: internal wifi/wimax combo device
244 * @iq_invert: I/Q inversion
245 * @disable_otp_refresh: disable OTP refresh current limit
247 * We enable the driver to be backward compatible wrt API version. The
248 * driver specifies which APIs it supports (with @ucode_api_max being the
249 * highest and @ucode_api_min the lowest). Firmware will only be loaded if
250 * it has a supported API version. The firmware's API version will be
251 * stored in @iwl_priv, enabling the driver to make runtime changes based
252 * on firmware version used.
255 * if (IWL_UCODE_API(priv->ucode_ver) >= 2) {
256 * Driver interacts with Firmware API version >= 2.
258 * Driver interacts with Firmware API version 1.
261 * The ideal usage of this infrastructure is to treat a new ucode API
262 * release as a new hardware revision. That is, through utilizing the
263 * iwl_hcmd_utils_ops etc. we accommodate different command structures
264 * and flows between hardware versions (4965/5000) as well as their API
269 /* params specific to an individual device within a device family */
271 const char *fw_name_pre;
272 const unsigned int ucode_api_max;
273 const unsigned int ucode_api_min;
278 u16 eeprom_calib_ver;
279 const struct iwl_ops *ops;
280 /* params not likely to change within a device family */
281 struct iwl_base_params *base_params;
282 /* params likely to change within a device family */
283 struct iwl_ht_params *ht_params;
284 struct iwl_bt_params *bt_params;
285 enum iwl_pa_type pa_type; /* if used set to IWL_PA_SYSTEM */
286 const bool need_dc_calib; /* if used set to true */
287 const bool need_temp_offset_calib; /* if used set to true */
288 u8 scan_rx_antennas[IEEE80211_NUM_BANDS];
289 enum iwl_led_mode led_mode;
291 const bool rx_with_siso_diversity;
292 const bool internal_wimax_coex;
293 const bool iq_invert;
294 const bool disable_otp_refresh;
297 /***************************
299 ***************************/
301 int iwl_mac_conf_tx(struct ieee80211_hw *hw, u16 queue,
302 const struct ieee80211_tx_queue_params *params);
303 int iwl_mac_tx_last_beacon(struct ieee80211_hw *hw);
304 void iwl_set_rxon_hwcrypto(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
306 int iwl_check_rxon_cmd(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
307 int iwl_full_rxon_required(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
308 int iwl_set_rxon_channel(struct iwl_priv *priv, struct ieee80211_channel *ch,
309 struct iwl_rxon_context *ctx);
310 void iwl_set_flags_for_band(struct iwl_priv *priv,
311 struct iwl_rxon_context *ctx,
312 enum ieee80211_band band,
313 struct ieee80211_vif *vif);
314 u8 iwl_get_single_channel_number(struct iwl_priv *priv,
315 enum ieee80211_band band);
316 void iwl_set_rxon_ht(struct iwl_priv *priv, struct iwl_ht_config *ht_conf);
317 bool iwl_is_ht40_tx_allowed(struct iwl_priv *priv,
318 struct iwl_rxon_context *ctx,
319 struct ieee80211_sta_ht_cap *ht_cap);
320 void iwl_connection_init_rx_config(struct iwl_priv *priv,
321 struct iwl_rxon_context *ctx);
322 void iwl_set_rate(struct iwl_priv *priv);
323 void iwl_irq_handle_error(struct iwl_priv *priv);
324 int iwl_mac_add_interface(struct ieee80211_hw *hw,
325 struct ieee80211_vif *vif);
326 void iwl_mac_remove_interface(struct ieee80211_hw *hw,
327 struct ieee80211_vif *vif);
328 int iwl_mac_change_interface(struct ieee80211_hw *hw,
329 struct ieee80211_vif *vif,
330 enum nl80211_iftype newtype, bool newp2p);
331 void iwl_free_txq_mem(struct iwl_priv *priv);
333 #ifdef CONFIG_IWLWIFI_DEBUGFS
334 int iwl_alloc_traffic_mem(struct iwl_priv *priv);
335 void iwl_free_traffic_mem(struct iwl_priv *priv);
336 void iwl_reset_traffic_log(struct iwl_priv *priv);
337 void iwl_dbg_log_tx_data_frame(struct iwl_priv *priv,
338 u16 length, struct ieee80211_hdr *header);
339 void iwl_dbg_log_rx_data_frame(struct iwl_priv *priv,
340 u16 length, struct ieee80211_hdr *header);
341 const char *get_mgmt_string(int cmd);
342 const char *get_ctrl_string(int cmd);
343 void iwl_clear_traffic_stats(struct iwl_priv *priv);
344 void iwl_update_stats(struct iwl_priv *priv, bool is_tx, __le16 fc,
347 static inline int iwl_alloc_traffic_mem(struct iwl_priv *priv)
351 static inline void iwl_free_traffic_mem(struct iwl_priv *priv)
354 static inline void iwl_reset_traffic_log(struct iwl_priv *priv)
357 static inline void iwl_dbg_log_tx_data_frame(struct iwl_priv *priv,
358 u16 length, struct ieee80211_hdr *header)
361 static inline void iwl_dbg_log_rx_data_frame(struct iwl_priv *priv,
362 u16 length, struct ieee80211_hdr *header)
365 static inline void iwl_update_stats(struct iwl_priv *priv, bool is_tx,
371 /*****************************************************
373 ******************************************************/
374 void iwl_cmd_queue_free(struct iwl_priv *priv);
375 void iwl_cmd_queue_unmap(struct iwl_priv *priv);
376 void iwl_rx_queue_update_write_ptr(struct iwl_priv *priv,
377 struct iwl_rx_queue *q);
378 int iwl_rx_queue_space(const struct iwl_rx_queue *q);
379 void iwl_tx_cmd_complete(struct iwl_priv *priv, struct iwl_rx_mem_buffer *rxb);
381 void iwl_chswitch_done(struct iwl_priv *priv, bool is_success);
385 /*****************************************************
387 ******************************************************/
388 void iwl_txq_update_write_ptr(struct iwl_priv *priv, struct iwl_tx_queue *txq);
389 void iwl_tx_queue_free(struct iwl_priv *priv, int txq_id);
390 int iwl_queue_init(struct iwl_priv *priv, struct iwl_queue *q,
391 int count, int slots_num, u32 id);
392 void iwl_tx_queue_unmap(struct iwl_priv *priv, int txq_id);
393 void iwl_setup_watchdog(struct iwl_priv *priv);
394 /*****************************************************
396 ****************************************************/
397 int iwl_set_tx_power(struct iwl_priv *priv, s8 tx_power, bool force);
399 /*******************************************************************************
401 ******************************************************************************/
402 void iwl_init_scan_params(struct iwl_priv *priv);
403 int iwl_scan_cancel(struct iwl_priv *priv);
404 int iwl_scan_cancel_timeout(struct iwl_priv *priv, unsigned long ms);
405 void iwl_force_scan_end(struct iwl_priv *priv);
406 int iwl_mac_hw_scan(struct ieee80211_hw *hw,
407 struct ieee80211_vif *vif,
408 struct cfg80211_scan_request *req);
409 void iwl_internal_short_hw_scan(struct iwl_priv *priv);
410 int iwl_force_reset(struct iwl_priv *priv, int mode, bool external);
411 u16 iwl_fill_probe_req(struct iwl_priv *priv, struct ieee80211_mgmt *frame,
412 const u8 *ta, const u8 *ie, int ie_len, int left);
413 void iwl_setup_rx_scan_handlers(struct iwl_priv *priv);
414 u16 iwl_get_active_dwell_time(struct iwl_priv *priv,
415 enum ieee80211_band band,
417 u16 iwl_get_passive_dwell_time(struct iwl_priv *priv,
418 enum ieee80211_band band,
419 struct ieee80211_vif *vif);
420 void iwl_setup_scan_deferred_work(struct iwl_priv *priv);
421 void iwl_cancel_scan_deferred_work(struct iwl_priv *priv);
422 int __must_check iwl_scan_initiate(struct iwl_priv *priv,
423 struct ieee80211_vif *vif,
424 enum iwl_scan_type scan_type,
425 enum ieee80211_band band);
427 /* For faster active scanning, scan will move to the next channel if fewer than
428 * PLCP_QUIET_THRESH packets are heard on this channel within
429 * ACTIVE_QUIET_TIME after sending probe request. This shortens the dwell
430 * time if it's a quiet channel (nothing responded to our probe, and there's
432 * Disable "quiet" feature by setting PLCP_QUIET_THRESH to 0. */
433 #define IWL_ACTIVE_QUIET_TIME cpu_to_le16(10) /* msec */
434 #define IWL_PLCP_QUIET_THRESH cpu_to_le16(1) /* packets */
436 #define IWL_SCAN_CHECK_WATCHDOG (HZ * 7)
438 /*****************************************************
439 * S e n d i n g H o s t C o m m a n d s *
440 *****************************************************/
442 const char *get_cmd_string(u8 cmd);
443 int __must_check iwl_send_cmd_sync(struct iwl_priv *priv,
444 struct iwl_host_cmd *cmd);
445 int iwl_send_cmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
446 int __must_check iwl_send_cmd_pdu(struct iwl_priv *priv, u8 id,
447 u16 len, const void *data);
448 int iwl_send_cmd_pdu_async(struct iwl_priv *priv, u8 id, u16 len,
450 void (*callback)(struct iwl_priv *priv,
451 struct iwl_device_cmd *cmd,
452 struct iwl_rx_packet *pkt));
454 int iwl_enqueue_hcmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
456 void iwl_bg_watchdog(unsigned long data);
457 u32 iwl_usecs_to_beacons(struct iwl_priv *priv, u32 usec, u32 beacon_interval);
458 __le32 iwl_add_beacon_time(struct iwl_priv *priv, u32 base,
459 u32 addon, u32 beacon_interval);
462 int iwl_suspend(struct iwl_priv *priv);
463 int iwl_resume(struct iwl_priv *priv);
464 #endif /* !CONFIG_PM */
466 /*****************************************************
467 * Error Handling Debugging
468 ******************************************************/
469 void iwl_dump_nic_error_log(struct iwl_priv *priv);
470 int iwl_dump_nic_event_log(struct iwl_priv *priv,
471 bool full_log, char **buf, bool display);
472 void iwl_dump_csr(struct iwl_priv *priv);
473 int iwl_dump_fh(struct iwl_priv *priv, char **buf, bool display);
474 #ifdef CONFIG_IWLWIFI_DEBUG
475 void iwl_print_rx_config_cmd(struct iwl_priv *priv,
476 struct iwl_rxon_context *ctx);
478 static inline void iwl_print_rx_config_cmd(struct iwl_priv *priv,
479 struct iwl_rxon_context *ctx)
484 void iwl_clear_isr_stats(struct iwl_priv *priv);
486 /*****************************************************
488 ******************************************************/
489 int iwlcore_init_geos(struct iwl_priv *priv);
490 void iwlcore_free_geos(struct iwl_priv *priv);
492 /*************** DRIVER STATUS FUNCTIONS *****/
494 #define STATUS_HCMD_ACTIVE 0 /* host command in progress */
495 /* 1 is unused (used to be STATUS_HCMD_SYNC_ACTIVE) */
496 #define STATUS_INT_ENABLED 2
497 #define STATUS_RF_KILL_HW 3
498 #define STATUS_CT_KILL 4
499 #define STATUS_INIT 5
500 #define STATUS_ALIVE 6
501 #define STATUS_READY 7
502 #define STATUS_TEMPERATURE 8
503 #define STATUS_GEO_CONFIGURED 9
504 #define STATUS_EXIT_PENDING 10
505 #define STATUS_STATISTICS 12
506 #define STATUS_SCANNING 13
507 #define STATUS_SCAN_ABORTING 14
508 #define STATUS_SCAN_HW 15
509 #define STATUS_POWER_PMI 16
510 #define STATUS_FW_ERROR 17
511 #define STATUS_DEVICE_ENABLED 18
512 #define STATUS_CHANNEL_SWITCH_PENDING 19
515 static inline int iwl_is_ready(struct iwl_priv *priv)
517 /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
518 * set but EXIT_PENDING is not */
519 return test_bit(STATUS_READY, &priv->status) &&
520 test_bit(STATUS_GEO_CONFIGURED, &priv->status) &&
521 !test_bit(STATUS_EXIT_PENDING, &priv->status);
524 static inline int iwl_is_alive(struct iwl_priv *priv)
526 return test_bit(STATUS_ALIVE, &priv->status);
529 static inline int iwl_is_init(struct iwl_priv *priv)
531 return test_bit(STATUS_INIT, &priv->status);
534 static inline int iwl_is_rfkill_hw(struct iwl_priv *priv)
536 return test_bit(STATUS_RF_KILL_HW, &priv->status);
539 static inline int iwl_is_rfkill(struct iwl_priv *priv)
541 return iwl_is_rfkill_hw(priv);
544 static inline int iwl_is_ctkill(struct iwl_priv *priv)
546 return test_bit(STATUS_CT_KILL, &priv->status);
549 static inline int iwl_is_ready_rf(struct iwl_priv *priv)
552 if (iwl_is_rfkill(priv))
555 return iwl_is_ready(priv);
558 extern void iwl_send_bt_config(struct iwl_priv *priv);
559 extern int iwl_send_statistics_request(struct iwl_priv *priv,
560 u8 flags, bool clear);
561 void iwl_apm_stop(struct iwl_priv *priv);
562 int iwl_apm_init(struct iwl_priv *priv);
564 int iwl_send_rxon_timing(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
566 static inline const struct ieee80211_supported_band *iwl_get_hw_mode(
567 struct iwl_priv *priv, enum ieee80211_band band)
569 return priv->hw->wiphy->bands[band];
572 static inline bool iwl_advanced_bt_coexist(struct iwl_priv *priv)
574 return priv->cfg->bt_params &&
575 priv->cfg->bt_params->advanced_bt_coexist;
578 extern bool bt_siso_mode;
581 void iwlagn_fw_error(struct iwl_priv *priv, bool ondemand);
583 #endif /* __iwl_core_h__ */