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__
69 /************************
70 * forward declarations *
71 ************************/
75 #define TIME_UNIT 1024
78 /* set hw dependent parameters */
79 int (*set_hw_params)(struct iwl_priv *priv);
80 /* setup BT Rx handler */
81 void (*bt_rx_handler_setup)(struct iwl_priv *priv);
82 /* setup BT related deferred work */
83 void (*bt_setup_deferred_work)(struct iwl_priv *priv);
84 /* cancel deferred work */
85 void (*cancel_deferred_work)(struct iwl_priv *priv);
86 int (*set_channel_switch)(struct iwl_priv *priv,
87 struct ieee80211_channel_switch *ch_switch);
88 /* device specific configuration */
89 void (*nic_config)(struct iwl_priv *priv);
91 /* eeprom operations (as defined in iwl-eeprom.h) */
92 struct iwl_eeprom_ops eeprom_ops;
95 void (*temperature)(struct iwl_priv *priv);
99 * @max_ll_items: max number of OTP blocks
100 * @shadow_ram_support: shadow support for OTP memory
101 * @led_compensation: compensate on the led on/off time per HW according
102 * to the deviation to achieve the desired led frequency.
103 * The detail algorithm is described in iwl-led.c
104 * @chain_noise_num_beacons: number of beacons used to compute chain noise
105 * @adv_thermal_throttle: support advance thermal throttle
106 * @support_ct_kill_exit: support ct kill exit condition
107 * @support_wimax_coexist: support wimax/wifi co-exist
108 * @plcp_delta_threshold: plcp error rate threshold used to trigger
109 * radio tuning when there is a high receiving plcp error rate
110 * @chain_noise_scale: default chain noise scale used for gain computation
111 * @wd_timeout: TX queues watchdog timeout
112 * @max_event_log_size: size of event log buffer size for ucode event logging
113 * @shadow_reg_enable: HW shadhow register bit
114 * @no_idle_support: do not support idle mode
115 * @hd_v2: v2 of enhanced sensitivity value, used for 2000 series and up
116 * wd_disable: disable watchdog timer
118 struct iwl_base_params {
120 int num_of_queues; /* def: HW dependent */
121 int num_of_ampdu_queues;/* def: HW dependent */
122 /* for iwl_apm_init() */
125 const u16 max_ll_items;
126 const bool shadow_ram_support;
127 u16 led_compensation;
128 bool adv_thermal_throttle;
129 bool support_ct_kill_exit;
130 const bool support_wimax_coexist;
131 u8 plcp_delta_threshold;
132 s32 chain_noise_scale;
133 unsigned int wd_timeout;
134 u32 max_event_log_size;
135 const bool shadow_reg_enable;
136 const bool no_idle_support;
138 const bool wd_disable;
141 * @advanced_bt_coexist: support advanced bt coexist
142 * @bt_init_traffic_load: specify initial bt traffic load
143 * @bt_prio_boost: default bt priority boost value
144 * @agg_time_limit: maximum number of uSec in aggregation
145 * @ampdu_factor: Maximum A-MPDU length factor
146 * @ampdu_density: Minimum A-MPDU spacing
147 * @bt_sco_disable: uCode should not response to BT in SCO/ESCO mode
149 struct iwl_bt_params {
150 bool advanced_bt_coexist;
151 u8 bt_init_traffic_load;
160 * @use_rts_for_aggregation: use rts/cts protection for HT traffic
162 struct iwl_ht_params {
163 const bool ht_greenfield_support; /* if used set to true */
164 bool use_rts_for_aggregation;
165 enum ieee80211_smps_mode smps_mode;
170 * @name: Offical name of the device
171 * @fw_name_pre: Firmware filename prefix. The api version and extension
172 * (.ucode) will be added to filename before loading from disk. The
173 * filename is constructed as fw_name_pre<api>.ucode.
174 * @ucode_api_max: Highest version of uCode API supported by driver.
175 * @ucode_api_ok: oldest version of the uCode API that is OK to load
176 * without a warning, for use in transitions
177 * @ucode_api_min: Lowest version of uCode API supported by driver.
178 * @valid_tx_ant: valid transmit antenna
179 * @valid_rx_ant: valid receive antenna
180 * @sku: sku information from EEPROM
181 * @eeprom_ver: EEPROM version
182 * @eeprom_calib_ver: EEPROM calibration version
183 * @lib: pointer to the lib ops
184 * @additional_nic_config: additional nic configuration
185 * @base_params: pointer to basic parameters
186 * @ht_params: point to ht patameters
187 * @bt_params: pointer to bt parameters
188 * @pa_type: used by 6000 series only to identify the type of Power Amplifier
189 * @need_temp_offset_calib: need to perform temperature offset calibration
190 * @no_xtal_calib: some devices do not need crystal calibration data,
191 * don't send it to those
192 * @scan_antennas: available antenna for scan operation
193 * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
194 * @adv_pm: advance power management
195 * @rx_with_siso_diversity: 1x1 device with rx antenna diversity
196 * @internal_wimax_coex: internal wifi/wimax combo device
197 * @iq_invert: I/Q inversion
198 * @temp_offset_v2: support v2 of temperature offset calibration
200 * We enable the driver to be backward compatible wrt API version. The
201 * driver specifies which APIs it supports (with @ucode_api_max being the
202 * highest and @ucode_api_min the lowest). Firmware will only be loaded if
203 * it has a supported API version.
205 * The ideal usage of this infrastructure is to treat a new ucode API
206 * release as a new hardware revision.
209 /* params specific to an individual device within a device family */
211 const char *fw_name_pre;
212 const unsigned int ucode_api_max;
213 const unsigned int ucode_api_ok;
214 const unsigned int ucode_api_min;
219 u16 eeprom_calib_ver;
220 const struct iwl_lib_ops *lib;
221 void (*additional_nic_config)(struct iwl_priv *priv);
222 /* params not likely to change within a device family */
223 struct iwl_base_params *base_params;
224 /* params likely to change within a device family */
225 struct iwl_ht_params *ht_params;
226 struct iwl_bt_params *bt_params;
227 enum iwl_pa_type pa_type; /* if used set to IWL_PA_SYSTEM */
228 const bool need_temp_offset_calib; /* if used set to true */
229 const bool no_xtal_calib;
230 u8 scan_rx_antennas[IEEE80211_NUM_BANDS];
231 enum iwl_led_mode led_mode;
233 const bool rx_with_siso_diversity;
234 const bool internal_wimax_coex;
235 const bool iq_invert;
236 const bool temp_offset_v2;
239 /***************************
241 ***************************/
243 void iwl_set_rxon_hwcrypto(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
245 int iwl_check_rxon_cmd(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
246 int iwl_full_rxon_required(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
247 int iwl_set_rxon_channel(struct iwl_priv *priv, struct ieee80211_channel *ch,
248 struct iwl_rxon_context *ctx);
249 void iwl_set_flags_for_band(struct iwl_priv *priv,
250 struct iwl_rxon_context *ctx,
251 enum ieee80211_band band,
252 struct ieee80211_vif *vif);
253 u8 iwl_get_single_channel_number(struct iwl_priv *priv,
254 enum ieee80211_band band);
255 void iwl_set_rxon_ht(struct iwl_priv *priv, struct iwl_ht_config *ht_conf);
256 bool iwl_is_ht40_tx_allowed(struct iwl_priv *priv,
257 struct iwl_rxon_context *ctx,
258 struct ieee80211_sta_ht_cap *ht_cap);
259 void iwl_connection_init_rx_config(struct iwl_priv *priv,
260 struct iwl_rxon_context *ctx);
261 void iwl_set_rate(struct iwl_priv *priv);
262 int iwl_cmd_echo_test(struct iwl_priv *priv);
263 #ifdef CONFIG_IWLWIFI_DEBUGFS
264 int iwl_alloc_traffic_mem(struct iwl_priv *priv);
265 void iwl_free_traffic_mem(struct iwl_priv *priv);
266 void iwl_dbg_log_tx_data_frame(struct iwl_priv *priv,
267 u16 length, struct ieee80211_hdr *header);
268 void iwl_dbg_log_rx_data_frame(struct iwl_priv *priv,
269 u16 length, struct ieee80211_hdr *header);
270 const char *get_mgmt_string(int cmd);
271 const char *get_ctrl_string(int cmd);
272 void iwl_clear_traffic_stats(struct iwl_priv *priv);
273 void iwl_update_stats(struct iwl_priv *priv, bool is_tx, __le16 fc,
276 static inline int iwl_alloc_traffic_mem(struct iwl_priv *priv)
280 static inline void iwl_free_traffic_mem(struct iwl_priv *priv)
283 static inline void iwl_reset_traffic_log(struct iwl_priv *priv)
286 static inline void iwl_dbg_log_tx_data_frame(struct iwl_priv *priv,
287 u16 length, struct ieee80211_hdr *header)
290 static inline void iwl_dbg_log_rx_data_frame(struct iwl_priv *priv,
291 u16 length, struct ieee80211_hdr *header)
294 static inline void iwl_update_stats(struct iwl_priv *priv, bool is_tx,
300 /*****************************************************
302 ******************************************************/
303 void iwl_chswitch_done(struct iwl_priv *priv, bool is_success);
305 void iwl_setup_watchdog(struct iwl_priv *priv);
306 /*****************************************************
308 ****************************************************/
309 int iwl_set_tx_power(struct iwl_priv *priv, s8 tx_power, bool force);
311 /*******************************************************************************
313 ******************************************************************************/
314 void iwl_init_scan_params(struct iwl_priv *priv);
315 int iwl_scan_cancel(struct iwl_priv *priv);
316 void iwl_scan_cancel_timeout(struct iwl_priv *priv, unsigned long ms);
317 void iwl_force_scan_end(struct iwl_priv *priv);
318 void iwl_internal_short_hw_scan(struct iwl_priv *priv);
319 int iwl_force_reset(struct iwl_priv *priv, int mode, bool external);
320 u16 iwl_fill_probe_req(struct iwl_priv *priv, struct ieee80211_mgmt *frame,
321 const u8 *ta, const u8 *ie, int ie_len, int left);
322 void iwl_setup_rx_scan_handlers(struct iwl_priv *priv);
323 void iwl_setup_scan_deferred_work(struct iwl_priv *priv);
324 void iwl_cancel_scan_deferred_work(struct iwl_priv *priv);
325 int __must_check iwl_scan_initiate(struct iwl_priv *priv,
326 struct ieee80211_vif *vif,
327 enum iwl_scan_type scan_type,
328 enum ieee80211_band band);
330 /* For faster active scanning, scan will move to the next channel if fewer than
331 * PLCP_QUIET_THRESH packets are heard on this channel within
332 * ACTIVE_QUIET_TIME after sending probe request. This shortens the dwell
333 * time if it's a quiet channel (nothing responded to our probe, and there's
335 * Disable "quiet" feature by setting PLCP_QUIET_THRESH to 0. */
336 #define IWL_ACTIVE_QUIET_TIME cpu_to_le16(10) /* msec */
337 #define IWL_PLCP_QUIET_THRESH cpu_to_le16(1) /* packets */
339 #define IWL_SCAN_CHECK_WATCHDOG (HZ * 7)
341 /*****************************************************
342 * S e n d i n g H o s t C o m m a n d s *
343 *****************************************************/
345 void iwl_bg_watchdog(unsigned long data);
346 u32 iwl_usecs_to_beacons(struct iwl_priv *priv, u32 usec, u32 beacon_interval);
347 __le32 iwl_add_beacon_time(struct iwl_priv *priv, u32 base,
348 u32 addon, u32 beacon_interval);
351 /*****************************************************
353 ******************************************************/
354 int iwl_init_geos(struct iwl_priv *priv);
355 void iwl_free_geos(struct iwl_priv *priv);
357 extern void iwl_send_bt_config(struct iwl_priv *priv);
358 extern int iwl_send_statistics_request(struct iwl_priv *priv,
359 u8 flags, bool clear);
361 int iwl_send_rxon_timing(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
363 static inline const struct ieee80211_supported_band *iwl_get_hw_mode(
364 struct iwl_priv *priv, enum ieee80211_band band)
366 return priv->hw->wiphy->bands[band];
369 static inline bool iwl_advanced_bt_coexist(struct iwl_priv *priv)
371 return priv->cfg->bt_params &&
372 priv->cfg->bt_params->advanced_bt_coexist;
375 static inline void iwl_enable_rfkill_int(struct iwl_priv *priv)
377 IWL_DEBUG_ISR(priv, "Enabling rfkill interrupt\n");
378 iwl_write32(bus(priv), CSR_INT_MASK, CSR_INT_BIT_RF_KILL);
381 extern bool bt_siso_mode;
383 #endif /* __iwl_core_h__ */