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 ************************/
74 #define TIME_UNIT 1024
77 /* set hw dependent parameters */
78 int (*set_hw_params
)(struct iwl_priv
*priv
);
79 /* setup BT Rx handler */
80 void (*bt_rx_handler_setup
)(struct iwl_priv
*priv
);
81 /* setup BT related deferred work */
82 void (*bt_setup_deferred_work
)(struct iwl_priv
*priv
);
83 /* cancel deferred work */
84 void (*cancel_deferred_work
)(struct iwl_priv
*priv
);
85 int (*set_channel_switch
)(struct iwl_priv
*priv
,
86 struct ieee80211_channel_switch
*ch_switch
);
87 /* device specific configuration */
88 void (*nic_config
)(struct iwl_priv
*priv
);
90 /* eeprom operations (as defined in iwl-eeprom.h) */
91 struct iwl_eeprom_ops eeprom_ops
;
94 void (*temperature
)(struct iwl_priv
*priv
);
98 * @max_ll_items: max number of OTP blocks
99 * @shadow_ram_support: shadow support for OTP memory
100 * @led_compensation: compensate on the led on/off time per HW according
101 * to the deviation to achieve the desired led frequency.
102 * The detail algorithm is described in iwl-led.c
103 * @chain_noise_num_beacons: number of beacons used to compute chain noise
104 * @adv_thermal_throttle: support advance thermal throttle
105 * @support_ct_kill_exit: support ct kill exit condition
106 * @support_wimax_coexist: support wimax/wifi co-exist
107 * @plcp_delta_threshold: plcp error rate threshold used to trigger
108 * radio tuning when there is a high receiving plcp error rate
109 * @chain_noise_scale: default chain noise scale used for gain computation
110 * @wd_timeout: TX queues watchdog timeout
111 * @max_event_log_size: size of event log buffer size for ucode event logging
112 * @shadow_reg_enable: HW shadhow register bit
113 * @no_idle_support: do not support idle mode
114 * @hd_v2: v2 of enhanced sensitivity value, used for 2000 series and up
116 struct iwl_base_params
{
118 int num_of_queues
; /* def: HW dependent */
119 int num_of_ampdu_queues
;/* def: HW dependent */
120 /* for iwl_apm_init() */
123 const u16 max_ll_items
;
124 const bool shadow_ram_support
;
125 u16 led_compensation
;
126 bool adv_thermal_throttle
;
127 bool support_ct_kill_exit
;
128 const bool support_wimax_coexist
;
129 u8 plcp_delta_threshold
;
130 s32 chain_noise_scale
;
131 unsigned int wd_timeout
;
132 u32 max_event_log_size
;
133 const bool shadow_reg_enable
;
134 const bool no_idle_support
;
138 * @advanced_bt_coexist: support advanced bt coexist
139 * @bt_init_traffic_load: specify initial bt traffic load
140 * @bt_prio_boost: default bt priority boost value
141 * @agg_time_limit: maximum number of uSec in aggregation
142 * @ampdu_factor: Maximum A-MPDU length factor
143 * @ampdu_density: Minimum A-MPDU spacing
144 * @bt_sco_disable: uCode should not response to BT in SCO/ESCO mode
146 struct iwl_bt_params
{
147 bool advanced_bt_coexist
;
148 u8 bt_init_traffic_load
;
157 * @use_rts_for_aggregation: use rts/cts protection for HT traffic
159 struct iwl_ht_params
{
160 const bool ht_greenfield_support
; /* if used set to true */
161 bool use_rts_for_aggregation
;
162 enum ieee80211_smps_mode smps_mode
;
167 * @name: Offical name of the device
168 * @fw_name_pre: Firmware filename prefix. The api version and extension
169 * (.ucode) will be added to filename before loading from disk. The
170 * filename is constructed as fw_name_pre<api>.ucode.
171 * @ucode_api_max: Highest version of uCode API supported by driver.
172 * @ucode_api_ok: oldest version of the uCode API that is OK to load
173 * without a warning, for use in transitions
174 * @ucode_api_min: Lowest version of uCode API supported by driver.
175 * @valid_tx_ant: valid transmit antenna
176 * @valid_rx_ant: valid receive antenna
177 * @sku: sku information from EEPROM
178 * @eeprom_ver: EEPROM version
179 * @eeprom_calib_ver: EEPROM calibration version
180 * @lib: pointer to the lib ops
181 * @additional_nic_config: additional nic configuration
182 * @base_params: pointer to basic parameters
183 * @ht_params: point to ht patameters
184 * @bt_params: pointer to bt parameters
185 * @pa_type: used by 6000 series only to identify the type of Power Amplifier
186 * @need_dc_calib: need to perform init dc calibration
187 * @need_temp_offset_calib: need to perform temperature offset calibration
188 * @scan_antennas: available antenna for scan operation
189 * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
190 * @adv_pm: advance power management
191 * @rx_with_siso_diversity: 1x1 device with rx antenna diversity
192 * @internal_wimax_coex: internal wifi/wimax combo device
193 * @iq_invert: I/Q inversion
194 * @temp_offset_v2: support v2 of temperature offset calibration
196 * We enable the driver to be backward compatible wrt API version. The
197 * driver specifies which APIs it supports (with @ucode_api_max being the
198 * highest and @ucode_api_min the lowest). Firmware will only be loaded if
199 * it has a supported API version.
201 * The ideal usage of this infrastructure is to treat a new ucode API
202 * release as a new hardware revision.
205 /* params specific to an individual device within a device family */
207 const char *fw_name_pre
;
208 const unsigned int ucode_api_max
;
209 const unsigned int ucode_api_ok
;
210 const unsigned int ucode_api_min
;
215 u16 eeprom_calib_ver
;
216 const struct iwl_lib_ops
*lib
;
217 void (*additional_nic_config
)(struct iwl_priv
*priv
);
218 /* params not likely to change within a device family */
219 struct iwl_base_params
*base_params
;
220 /* params likely to change within a device family */
221 struct iwl_ht_params
*ht_params
;
222 struct iwl_bt_params
*bt_params
;
223 enum iwl_pa_type pa_type
; /* if used set to IWL_PA_SYSTEM */
224 const bool need_dc_calib
; /* if used set to true */
225 const bool need_temp_offset_calib
; /* if used set to true */
226 u8 scan_rx_antennas
[IEEE80211_NUM_BANDS
];
227 enum iwl_led_mode led_mode
;
229 const bool rx_with_siso_diversity
;
230 const bool internal_wimax_coex
;
231 const bool iq_invert
;
232 const bool temp_offset_v2
;
235 /***************************
237 ***************************/
239 int iwl_mac_conf_tx(struct ieee80211_hw
*hw
,
240 struct ieee80211_vif
*vif
, u16 queue
,
241 const struct ieee80211_tx_queue_params
*params
);
242 int iwl_mac_tx_last_beacon(struct ieee80211_hw
*hw
);
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_mac_add_interface(struct ieee80211_hw
*hw
,
263 struct ieee80211_vif
*vif
);
264 void iwl_mac_remove_interface(struct ieee80211_hw
*hw
,
265 struct ieee80211_vif
*vif
);
266 int iwl_mac_change_interface(struct ieee80211_hw
*hw
,
267 struct ieee80211_vif
*vif
,
268 enum nl80211_iftype newtype
, bool newp2p
);
269 int iwl_cmd_echo_test(struct iwl_priv
*priv
);
270 #ifdef CONFIG_IWLWIFI_DEBUGFS
271 int iwl_alloc_traffic_mem(struct iwl_priv
*priv
);
272 void iwl_free_traffic_mem(struct iwl_priv
*priv
);
273 void iwl_dbg_log_tx_data_frame(struct iwl_priv
*priv
,
274 u16 length
, struct ieee80211_hdr
*header
);
275 void iwl_dbg_log_rx_data_frame(struct iwl_priv
*priv
,
276 u16 length
, struct ieee80211_hdr
*header
);
277 const char *get_mgmt_string(int cmd
);
278 const char *get_ctrl_string(int cmd
);
279 void iwl_clear_traffic_stats(struct iwl_priv
*priv
);
280 void iwl_update_stats(struct iwl_priv
*priv
, bool is_tx
, __le16 fc
,
283 static inline int iwl_alloc_traffic_mem(struct iwl_priv
*priv
)
287 static inline void iwl_free_traffic_mem(struct iwl_priv
*priv
)
290 static inline void iwl_reset_traffic_log(struct iwl_priv
*priv
)
293 static inline void iwl_dbg_log_tx_data_frame(struct iwl_priv
*priv
,
294 u16 length
, struct ieee80211_hdr
*header
)
297 static inline void iwl_dbg_log_rx_data_frame(struct iwl_priv
*priv
,
298 u16 length
, struct ieee80211_hdr
*header
)
301 static inline void iwl_update_stats(struct iwl_priv
*priv
, bool is_tx
,
307 /*****************************************************
309 ******************************************************/
310 void iwl_chswitch_done(struct iwl_priv
*priv
, bool is_success
);
312 void iwl_setup_watchdog(struct iwl_priv
*priv
);
313 /*****************************************************
315 ****************************************************/
316 int iwl_set_tx_power(struct iwl_priv
*priv
, s8 tx_power
, bool force
);
318 /*******************************************************************************
320 ******************************************************************************/
321 void iwl_init_scan_params(struct iwl_priv
*priv
);
322 int iwl_scan_cancel(struct iwl_priv
*priv
);
323 void iwl_scan_cancel_timeout(struct iwl_priv
*priv
, unsigned long ms
);
324 void iwl_force_scan_end(struct iwl_priv
*priv
);
325 int iwl_mac_hw_scan(struct ieee80211_hw
*hw
,
326 struct ieee80211_vif
*vif
,
327 struct cfg80211_scan_request
*req
);
328 void iwl_internal_short_hw_scan(struct iwl_priv
*priv
);
329 int iwl_force_reset(struct iwl_priv
*priv
, int mode
, bool external
);
330 u16
iwl_fill_probe_req(struct iwl_priv
*priv
, struct ieee80211_mgmt
*frame
,
331 const u8
*ta
, const u8
*ie
, int ie_len
, int left
);
332 void iwl_setup_rx_scan_handlers(struct iwl_priv
*priv
);
333 void iwl_setup_scan_deferred_work(struct iwl_priv
*priv
);
334 void iwl_cancel_scan_deferred_work(struct iwl_priv
*priv
);
335 int __must_check
iwl_scan_initiate(struct iwl_priv
*priv
,
336 struct ieee80211_vif
*vif
,
337 enum iwl_scan_type scan_type
,
338 enum ieee80211_band band
);
340 /* For faster active scanning, scan will move to the next channel if fewer than
341 * PLCP_QUIET_THRESH packets are heard on this channel within
342 * ACTIVE_QUIET_TIME after sending probe request. This shortens the dwell
343 * time if it's a quiet channel (nothing responded to our probe, and there's
345 * Disable "quiet" feature by setting PLCP_QUIET_THRESH to 0. */
346 #define IWL_ACTIVE_QUIET_TIME cpu_to_le16(10) /* msec */
347 #define IWL_PLCP_QUIET_THRESH cpu_to_le16(1) /* packets */
349 #define IWL_SCAN_CHECK_WATCHDOG (HZ * 7)
351 /*****************************************************
352 * S e n d i n g H o s t C o m m a n d s *
353 *****************************************************/
355 void iwl_bg_watchdog(unsigned long data
);
356 u32
iwl_usecs_to_beacons(struct iwl_priv
*priv
, u32 usec
, u32 beacon_interval
);
357 __le32
iwl_add_beacon_time(struct iwl_priv
*priv
, u32 base
,
358 u32 addon
, u32 beacon_interval
);
361 /*****************************************************
363 ******************************************************/
364 int iwl_init_geos(struct iwl_priv
*priv
);
365 void iwl_free_geos(struct iwl_priv
*priv
);
367 extern void iwl_send_bt_config(struct iwl_priv
*priv
);
368 extern int iwl_send_statistics_request(struct iwl_priv
*priv
,
369 u8 flags
, bool clear
);
371 int iwl_send_rxon_timing(struct iwl_priv
*priv
, struct iwl_rxon_context
*ctx
);
373 static inline const struct ieee80211_supported_band
*iwl_get_hw_mode(
374 struct iwl_priv
*priv
, enum ieee80211_band band
)
376 return priv
->hw
->wiphy
->bands
[band
];
379 static inline bool iwl_advanced_bt_coexist(struct iwl_priv
*priv
)
381 return priv
->cfg
->bt_params
&&
382 priv
->cfg
->bt_params
->advanced_bt_coexist
;
385 extern bool bt_siso_mode
;
387 #endif /* __iwl_core_h__ */