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 BT Rx handler */
87 void (*bt_rx_handler_setup
)(struct iwl_priv
*priv
);
88 /* setup BT related deferred work */
89 void (*bt_setup_deferred_work
)(struct iwl_priv
*priv
);
90 /* cancel deferred work */
91 void (*cancel_deferred_work
)(struct iwl_priv
*priv
);
92 int (*set_channel_switch
)(struct iwl_priv
*priv
,
93 struct ieee80211_channel_switch
*ch_switch
);
94 /* device specific configuration */
95 void (*nic_config
)(struct iwl_priv
*priv
);
97 /* eeprom operations (as defined in iwl-eeprom.h) */
98 struct iwl_eeprom_ops eeprom_ops
;
101 void (*temperature
)(struct iwl_priv
*priv
);
104 struct iwl_mod_params
{
105 int sw_crypto
; /* def: 0 = using hardware encryption */
106 int num_of_queues
; /* def: HW dependent */
107 int disable_11n
; /* def: 0 = 11n capabilities enabled */
108 int amsdu_size_8K
; /* def: 1 = enable 8K amsdu size */
109 int antenna
; /* def: 0 = both antennas (use diversity) */
110 int restart_fw
; /* def: 1 = restart firmware */
111 bool plcp_check
; /* def: true = enable plcp health check */
112 bool ack_check
; /* def: false = disable ack health check */
113 bool wd_disable
; /* def: false = enable stuck queue check */
114 bool bt_coex_active
; /* def: true = enable bt coex */
115 int led_mode
; /* def: 0 = system default */
116 bool no_sleep_autoadjust
; /* def: true = disable autoadjust */
117 bool power_save
; /* def: false = disable power save */
118 int power_level
; /* def: 1 = power level */
122 * @max_ll_items: max number of OTP blocks
123 * @shadow_ram_support: shadow support for OTP memory
124 * @led_compensation: compensate on the led on/off time per HW according
125 * to the deviation to achieve the desired led frequency.
126 * The detail algorithm is described in iwl-led.c
127 * @chain_noise_num_beacons: number of beacons used to compute chain noise
128 * @adv_thermal_throttle: support advance thermal throttle
129 * @support_ct_kill_exit: support ct kill exit condition
130 * @support_wimax_coexist: support wimax/wifi co-exist
131 * @plcp_delta_threshold: plcp error rate threshold used to trigger
132 * radio tuning when there is a high receiving plcp error rate
133 * @chain_noise_scale: default chain noise scale used for gain computation
134 * @wd_timeout: TX queues watchdog timeout
135 * @temperature_kelvin: temperature report by uCode in kelvin
136 * @max_event_log_size: size of event log buffer size for ucode event logging
137 * @shadow_reg_enable: HW shadhow register bit
138 * @no_idle_support: do not support idle mode
139 * @hd_v2: v2 of enhanced sensitivity value, used for 2000 series and up
141 struct iwl_base_params
{
143 int num_of_queues
; /* def: HW dependent */
144 int num_of_ampdu_queues
;/* def: HW dependent */
145 /* for iwl_apm_init() */
148 const u16 max_ll_items
;
149 const bool shadow_ram_support
;
150 u16 led_compensation
;
151 int chain_noise_num_beacons
;
152 bool adv_thermal_throttle
;
153 bool support_ct_kill_exit
;
154 const bool support_wimax_coexist
;
155 u8 plcp_delta_threshold
;
156 s32 chain_noise_scale
;
157 unsigned int wd_timeout
;
158 bool temperature_kelvin
;
159 u32 max_event_log_size
;
160 const bool shadow_reg_enable
;
161 const bool no_idle_support
;
165 * @advanced_bt_coexist: support advanced bt coexist
166 * @bt_init_traffic_load: specify initial bt traffic load
167 * @bt_prio_boost: default bt priority boost value
168 * @agg_time_limit: maximum number of uSec in aggregation
169 * @ampdu_factor: Maximum A-MPDU length factor
170 * @ampdu_density: Minimum A-MPDU spacing
171 * @bt_sco_disable: uCode should not response to BT in SCO/ESCO mode
173 struct iwl_bt_params
{
174 bool advanced_bt_coexist
;
175 u8 bt_init_traffic_load
;
184 * @use_rts_for_aggregation: use rts/cts protection for HT traffic
186 struct iwl_ht_params
{
187 const bool ht_greenfield_support
; /* if used set to true */
188 bool use_rts_for_aggregation
;
189 enum ieee80211_smps_mode smps_mode
;
194 * @name: Offical name of the device
195 * @fw_name_pre: Firmware filename prefix. The api version and extension
196 * (.ucode) will be added to filename before loading from disk. The
197 * filename is constructed as fw_name_pre<api>.ucode.
198 * @ucode_api_max: Highest version of uCode API supported by driver.
199 * @ucode_api_ok: oldest version of the uCode API that is OK to load
200 * without a warning, for use in transitions
201 * @ucode_api_min: Lowest version of uCode API supported by driver.
202 * @valid_tx_ant: valid transmit antenna
203 * @valid_rx_ant: valid receive antenna
204 * @sku: sku information from EEPROM
205 * @eeprom_ver: EEPROM version
206 * @eeprom_calib_ver: EEPROM calibration version
207 * @lib: pointer to the lib ops
208 * @additional_nic_config: additional nic configuration
209 * @base_params: pointer to basic parameters
210 * @ht_params: point to ht patameters
211 * @bt_params: pointer to bt parameters
212 * @pa_type: used by 6000 series only to identify the type of Power Amplifier
213 * @need_dc_calib: need to perform init dc calibration
214 * @need_temp_offset_calib: need to perform temperature offset calibration
215 * @scan_antennas: available antenna for scan operation
216 * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
217 * @adv_pm: advance power management
218 * @rx_with_siso_diversity: 1x1 device with rx antenna diversity
219 * @internal_wimax_coex: internal wifi/wimax combo device
220 * @iq_invert: I/Q inversion
222 * We enable the driver to be backward compatible wrt API version. The
223 * driver specifies which APIs it supports (with @ucode_api_max being the
224 * highest and @ucode_api_min the lowest). Firmware will only be loaded if
225 * it has a supported API version. The firmware's API version will be
226 * stored in @iwl_priv, enabling the driver to make runtime changes based
227 * on firmware version used.
230 * if (IWL_UCODE_API(priv->ucode_ver) >= 2) {
231 * Driver interacts with Firmware API version >= 2.
233 * Driver interacts with Firmware API version 1.
236 * The ideal usage of this infrastructure is to treat a new ucode API
237 * release as a new hardware revision.
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_ok
;
245 const unsigned int ucode_api_min
;
250 u16 eeprom_calib_ver
;
251 const struct iwl_lib_ops
*lib
;
252 void (*additional_nic_config
)(struct iwl_priv
*priv
);
253 /* params not likely to change within a device family */
254 struct iwl_base_params
*base_params
;
255 /* params likely to change within a device family */
256 struct iwl_ht_params
*ht_params
;
257 struct iwl_bt_params
*bt_params
;
258 enum iwl_pa_type pa_type
; /* if used set to IWL_PA_SYSTEM */
259 const bool need_dc_calib
; /* if used set to true */
260 const bool need_temp_offset_calib
; /* if used set to true */
261 u8 scan_rx_antennas
[IEEE80211_NUM_BANDS
];
262 enum iwl_led_mode led_mode
;
264 const bool rx_with_siso_diversity
;
265 const bool internal_wimax_coex
;
266 const bool iq_invert
;
269 /***************************
271 ***************************/
273 int iwl_mac_conf_tx(struct ieee80211_hw
*hw
, u16 queue
,
274 const struct ieee80211_tx_queue_params
*params
);
275 int iwl_mac_tx_last_beacon(struct ieee80211_hw
*hw
);
276 void iwl_set_rxon_hwcrypto(struct iwl_priv
*priv
, struct iwl_rxon_context
*ctx
,
278 int iwl_check_rxon_cmd(struct iwl_priv
*priv
, struct iwl_rxon_context
*ctx
);
279 int iwl_full_rxon_required(struct iwl_priv
*priv
, struct iwl_rxon_context
*ctx
);
280 int iwl_set_rxon_channel(struct iwl_priv
*priv
, struct ieee80211_channel
*ch
,
281 struct iwl_rxon_context
*ctx
);
282 void iwl_set_flags_for_band(struct iwl_priv
*priv
,
283 struct iwl_rxon_context
*ctx
,
284 enum ieee80211_band band
,
285 struct ieee80211_vif
*vif
);
286 u8
iwl_get_single_channel_number(struct iwl_priv
*priv
,
287 enum ieee80211_band band
);
288 void iwl_set_rxon_ht(struct iwl_priv
*priv
, struct iwl_ht_config
*ht_conf
);
289 bool iwl_is_ht40_tx_allowed(struct iwl_priv
*priv
,
290 struct iwl_rxon_context
*ctx
,
291 struct ieee80211_sta_ht_cap
*ht_cap
);
292 void iwl_connection_init_rx_config(struct iwl_priv
*priv
,
293 struct iwl_rxon_context
*ctx
);
294 void iwl_set_rate(struct iwl_priv
*priv
);
295 void iwl_irq_handle_error(struct iwl_priv
*priv
);
296 int iwl_mac_add_interface(struct ieee80211_hw
*hw
,
297 struct ieee80211_vif
*vif
);
298 void iwl_mac_remove_interface(struct ieee80211_hw
*hw
,
299 struct ieee80211_vif
*vif
);
300 int iwl_mac_change_interface(struct ieee80211_hw
*hw
,
301 struct ieee80211_vif
*vif
,
302 enum nl80211_iftype newtype
, bool newp2p
);
303 #ifdef CONFIG_IWLWIFI_DEBUGFS
304 int iwl_alloc_traffic_mem(struct iwl_priv
*priv
);
305 void iwl_free_traffic_mem(struct iwl_priv
*priv
);
306 void iwl_reset_traffic_log(struct iwl_priv
*priv
);
307 void iwl_dbg_log_tx_data_frame(struct iwl_priv
*priv
,
308 u16 length
, struct ieee80211_hdr
*header
);
309 void iwl_dbg_log_rx_data_frame(struct iwl_priv
*priv
,
310 u16 length
, struct ieee80211_hdr
*header
);
311 const char *get_mgmt_string(int cmd
);
312 const char *get_ctrl_string(int cmd
);
313 void iwl_clear_traffic_stats(struct iwl_priv
*priv
);
314 void iwl_update_stats(struct iwl_priv
*priv
, bool is_tx
, __le16 fc
,
317 static inline int iwl_alloc_traffic_mem(struct iwl_priv
*priv
)
321 static inline void iwl_free_traffic_mem(struct iwl_priv
*priv
)
324 static inline void iwl_reset_traffic_log(struct iwl_priv
*priv
)
327 static inline void iwl_dbg_log_tx_data_frame(struct iwl_priv
*priv
,
328 u16 length
, struct ieee80211_hdr
*header
)
331 static inline void iwl_dbg_log_rx_data_frame(struct iwl_priv
*priv
,
332 u16 length
, struct ieee80211_hdr
*header
)
335 static inline void iwl_update_stats(struct iwl_priv
*priv
, bool is_tx
,
341 /*****************************************************
343 ******************************************************/
344 void iwl_chswitch_done(struct iwl_priv
*priv
, bool is_success
);
346 void iwl_setup_watchdog(struct iwl_priv
*priv
);
347 /*****************************************************
349 ****************************************************/
350 int iwl_set_tx_power(struct iwl_priv
*priv
, s8 tx_power
, bool force
);
352 /*******************************************************************************
354 ******************************************************************************/
355 void iwl_init_scan_params(struct iwl_priv
*priv
);
356 int iwl_scan_cancel(struct iwl_priv
*priv
);
357 int iwl_scan_cancel_timeout(struct iwl_priv
*priv
, unsigned long ms
);
358 void iwl_force_scan_end(struct iwl_priv
*priv
);
359 int iwl_mac_hw_scan(struct ieee80211_hw
*hw
,
360 struct ieee80211_vif
*vif
,
361 struct cfg80211_scan_request
*req
);
362 void iwl_internal_short_hw_scan(struct iwl_priv
*priv
);
363 int iwl_force_reset(struct iwl_priv
*priv
, int mode
, bool external
);
364 u16
iwl_fill_probe_req(struct iwl_priv
*priv
, struct ieee80211_mgmt
*frame
,
365 const u8
*ta
, const u8
*ie
, int ie_len
, int left
);
366 void iwl_setup_rx_scan_handlers(struct iwl_priv
*priv
);
367 u16
iwl_get_active_dwell_time(struct iwl_priv
*priv
,
368 enum ieee80211_band band
,
370 u16
iwl_get_passive_dwell_time(struct iwl_priv
*priv
,
371 enum ieee80211_band band
,
372 struct ieee80211_vif
*vif
);
373 void iwl_setup_scan_deferred_work(struct iwl_priv
*priv
);
374 void iwl_cancel_scan_deferred_work(struct iwl_priv
*priv
);
375 int __must_check
iwl_scan_initiate(struct iwl_priv
*priv
,
376 struct ieee80211_vif
*vif
,
377 enum iwl_scan_type scan_type
,
378 enum ieee80211_band band
);
380 /* For faster active scanning, scan will move to the next channel if fewer than
381 * PLCP_QUIET_THRESH packets are heard on this channel within
382 * ACTIVE_QUIET_TIME after sending probe request. This shortens the dwell
383 * time if it's a quiet channel (nothing responded to our probe, and there's
385 * Disable "quiet" feature by setting PLCP_QUIET_THRESH to 0. */
386 #define IWL_ACTIVE_QUIET_TIME cpu_to_le16(10) /* msec */
387 #define IWL_PLCP_QUIET_THRESH cpu_to_le16(1) /* packets */
389 #define IWL_SCAN_CHECK_WATCHDOG (HZ * 7)
391 /*****************************************************
392 * S e n d i n g H o s t C o m m a n d s *
393 *****************************************************/
395 const char *get_cmd_string(u8 cmd
);
396 void iwl_bg_watchdog(unsigned long data
);
397 u32
iwl_usecs_to_beacons(struct iwl_priv
*priv
, u32 usec
, u32 beacon_interval
);
398 __le32
iwl_add_beacon_time(struct iwl_priv
*priv
, u32 base
,
399 u32 addon
, u32 beacon_interval
);
402 int iwl_suspend(struct iwl_priv
*priv
);
403 int iwl_resume(struct iwl_priv
*priv
);
404 #endif /* !CONFIG_PM */
406 int iwl_probe(struct iwl_bus
*bus
, struct iwl_cfg
*cfg
);
407 void __devexit
iwl_remove(struct iwl_priv
* priv
);
409 /*****************************************************
410 * Error Handling Debugging
411 ******************************************************/
412 void iwl_dump_nic_error_log(struct iwl_priv
*priv
);
413 int iwl_dump_nic_event_log(struct iwl_priv
*priv
,
414 bool full_log
, char **buf
, bool display
);
415 void iwl_dump_csr(struct iwl_priv
*priv
);
416 int iwl_dump_fh(struct iwl_priv
*priv
, char **buf
, bool display
);
417 #ifdef CONFIG_IWLWIFI_DEBUG
418 void iwl_print_rx_config_cmd(struct iwl_priv
*priv
,
419 struct iwl_rxon_context
*ctx
);
421 static inline void iwl_print_rx_config_cmd(struct iwl_priv
*priv
,
422 struct iwl_rxon_context
*ctx
)
427 void iwl_clear_isr_stats(struct iwl_priv
*priv
);
429 /*****************************************************
431 ******************************************************/
432 int iwl_init_geos(struct iwl_priv
*priv
);
433 void iwl_free_geos(struct iwl_priv
*priv
);
435 /*************** DRIVER STATUS FUNCTIONS *****/
437 #define STATUS_HCMD_ACTIVE 0 /* host command in progress */
438 /* 1 is unused (used to be STATUS_HCMD_SYNC_ACTIVE) */
439 #define STATUS_INT_ENABLED 2
440 #define STATUS_RF_KILL_HW 3
441 #define STATUS_CT_KILL 4
442 #define STATUS_INIT 5
443 #define STATUS_ALIVE 6
444 #define STATUS_READY 7
445 #define STATUS_TEMPERATURE 8
446 #define STATUS_GEO_CONFIGURED 9
447 #define STATUS_EXIT_PENDING 10
448 #define STATUS_STATISTICS 12
449 #define STATUS_SCANNING 13
450 #define STATUS_SCAN_ABORTING 14
451 #define STATUS_SCAN_HW 15
452 #define STATUS_POWER_PMI 16
453 #define STATUS_FW_ERROR 17
454 #define STATUS_DEVICE_ENABLED 18
455 #define STATUS_CHANNEL_SWITCH_PENDING 19
458 static inline int iwl_is_ready(struct iwl_priv
*priv
)
460 /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
461 * set but EXIT_PENDING is not */
462 return test_bit(STATUS_READY
, &priv
->status
) &&
463 test_bit(STATUS_GEO_CONFIGURED
, &priv
->status
) &&
464 !test_bit(STATUS_EXIT_PENDING
, &priv
->status
);
467 static inline int iwl_is_alive(struct iwl_priv
*priv
)
469 return test_bit(STATUS_ALIVE
, &priv
->status
);
472 static inline int iwl_is_init(struct iwl_priv
*priv
)
474 return test_bit(STATUS_INIT
, &priv
->status
);
477 static inline int iwl_is_rfkill_hw(struct iwl_priv
*priv
)
479 return test_bit(STATUS_RF_KILL_HW
, &priv
->status
);
482 static inline int iwl_is_rfkill(struct iwl_priv
*priv
)
484 return iwl_is_rfkill_hw(priv
);
487 static inline int iwl_is_ctkill(struct iwl_priv
*priv
)
489 return test_bit(STATUS_CT_KILL
, &priv
->status
);
492 static inline int iwl_is_ready_rf(struct iwl_priv
*priv
)
495 if (iwl_is_rfkill(priv
))
498 return iwl_is_ready(priv
);
501 extern void iwl_send_bt_config(struct iwl_priv
*priv
);
502 extern int iwl_send_statistics_request(struct iwl_priv
*priv
,
503 u8 flags
, bool clear
);
504 void iwl_apm_stop(struct iwl_priv
*priv
);
505 int iwl_apm_init(struct iwl_priv
*priv
);
507 int iwl_send_rxon_timing(struct iwl_priv
*priv
, struct iwl_rxon_context
*ctx
);
509 static inline const struct ieee80211_supported_band
*iwl_get_hw_mode(
510 struct iwl_priv
*priv
, enum ieee80211_band band
)
512 return priv
->hw
->wiphy
->bands
[band
];
515 static inline bool iwl_advanced_bt_coexist(struct iwl_priv
*priv
)
517 return priv
->cfg
->bt_params
&&
518 priv
->cfg
->bt_params
->advanced_bt_coexist
;
521 extern bool bt_siso_mode
;
524 void iwlagn_fw_error(struct iwl_priv
*priv
, bool ondemand
);
526 #endif /* __iwl_core_h__ */