iwlagn: comments for iwl_cfg
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / net / wireless / iwlwifi / iwl-core.h
blob51873180c81ab534c0105418a554b478bb9dc2bf
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.
6 * GPL LICENSE SUMMARY
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,
22 * USA
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
31 * BSD LICENSE
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
38 * are met:
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
45 * distribution.
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__
66 #include "iwl-dev.h"
68 /************************
69 * forward declarations *
70 ************************/
71 struct iwl_host_cmd;
72 struct iwl_cmd;
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_lib_ops {
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;
102 /* temperature */
103 void (*temperature)(struct iwl_priv *priv);
106 struct iwl_mod_params {
107 int sw_crypto; /* def: 0 = using hardware encryption */
108 int num_of_queues; /* def: HW dependent */
109 int disable_11n; /* def: 0 = 11n capabilities enabled */
110 int amsdu_size_8K; /* def: 1 = enable 8K amsdu size */
111 int antenna; /* def: 0 = both antennas (use diversity) */
112 int restart_fw; /* def: 1 = restart firmware */
113 bool plcp_check; /* def: true = enable plcp health check */
114 bool ack_check; /* def: false = disable ack health check */
115 bool wd_disable; /* def: false = enable stuck queue check */
116 bool bt_coex_active; /* def: true = enable bt coex */
117 int led_mode; /* def: 0 = system default */
118 bool no_sleep_autoadjust; /* def: true = disable autoadjust */
119 bool power_save; /* def: false = disable power save */
120 int power_level; /* def: 1 = power level */
124 * @max_ll_items: max number of OTP blocks
125 * @shadow_ram_support: shadow support for OTP memory
126 * @led_compensation: compensate on the led on/off time per HW according
127 * to the deviation to achieve the desired led frequency.
128 * The detail algorithm is described in iwl-led.c
129 * @chain_noise_num_beacons: number of beacons used to compute chain noise
130 * @adv_thermal_throttle: support advance thermal throttle
131 * @support_ct_kill_exit: support ct kill exit condition
132 * @support_wimax_coexist: support wimax/wifi co-exist
133 * @plcp_delta_threshold: plcp error rate threshold used to trigger
134 * radio tuning when there is a high receiving plcp error rate
135 * @chain_noise_scale: default chain noise scale used for gain computation
136 * @wd_timeout: TX queues watchdog timeout
137 * @temperature_kelvin: temperature report by uCode in kelvin
138 * @max_event_log_size: size of event log buffer size for ucode event logging
139 * @shadow_reg_enable: HW shadhow register bit
141 struct iwl_base_params {
142 int eeprom_size;
143 int num_of_queues; /* def: HW dependent */
144 int num_of_ampdu_queues;/* def: HW dependent */
145 /* for iwl_apm_init() */
146 u32 pll_cfg_val;
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;
163 * @advanced_bt_coexist: support advanced bt coexist
164 * @bt_init_traffic_load: specify initial bt traffic load
165 * @bt_prio_boost: default bt priority boost value
166 * @agg_time_limit: maximum number of uSec in aggregation
167 * @ampdu_factor: Maximum A-MPDU length factor
168 * @ampdu_density: Minimum A-MPDU spacing
169 * @bt_sco_disable: uCode should not response to BT in SCO/ESCO mode
171 struct iwl_bt_params {
172 bool advanced_bt_coexist;
173 u8 bt_init_traffic_load;
174 u8 bt_prio_boost;
175 u16 agg_time_limit;
176 u8 ampdu_factor;
177 u8 ampdu_density;
178 bool bt_sco_disable;
179 bool bt_session_2;
182 * @use_rts_for_aggregation: use rts/cts protection for HT traffic
184 struct iwl_ht_params {
185 const bool ht_greenfield_support; /* if used set to true */
186 bool use_rts_for_aggregation;
187 enum ieee80211_smps_mode smps_mode;
191 * struct iwl_cfg
192 * @name: Offical name of the device
193 * @fw_name_pre: Firmware filename prefix. The api version and extension
194 * (.ucode) will be added to filename before loading from disk. The
195 * filename is constructed as fw_name_pre<api>.ucode.
196 * @ucode_api_max: Highest version of uCode API supported by driver.
197 * @ucode_api_min: Lowest version of uCode API supported by driver.
198 * @valid_tx_ant: valid transmit antenna
199 * @valid_rx_ant: valid receive antenna
200 * @sku: sku information from EEPROM
201 * @eeprom_ver: EEPROM version
202 * @eeprom_calib_ver: EEPROM calibration version
203 * @lib: pointer to the lib ops
204 * @additional_nic_config: additional nic configuration
205 * @base_params: pointer to basic parameters
206 * @ht_params: point to ht patameters
207 * @bt_params: pointer to bt parameters
208 * @pa_type: used by 6000 series only to identify the type of Power Amplifier
209 * @need_dc_calib: need to perform init dc calibration
210 * @need_temp_offset_calib: need to perform temperature offset calibration
211 * @scan_antennas: available antenna for scan operation
212 * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
213 * @adv_pm: advance power management
214 * @rx_with_siso_diversity: 1x1 device with rx antenna diversity
215 * @internal_wimax_coex: internal wifi/wimax combo device
216 * @iq_invert: I/Q inversion
217 * @disable_otp_refresh: disable OTP refresh current limit
219 * We enable the driver to be backward compatible wrt API version. The
220 * driver specifies which APIs it supports (with @ucode_api_max being the
221 * highest and @ucode_api_min the lowest). Firmware will only be loaded if
222 * it has a supported API version. The firmware's API version will be
223 * stored in @iwl_priv, enabling the driver to make runtime changes based
224 * on firmware version used.
226 * For example,
227 * if (IWL_UCODE_API(priv->ucode_ver) >= 2) {
228 * Driver interacts with Firmware API version >= 2.
229 * } else {
230 * Driver interacts with Firmware API version 1.
233 * The ideal usage of this infrastructure is to treat a new ucode API
234 * release as a new hardware revision.
236 struct iwl_cfg {
237 /* params specific to an individual device within a device family */
238 const char *name;
239 const char *fw_name_pre;
240 const unsigned int ucode_api_max;
241 const unsigned int ucode_api_min;
242 u8 valid_tx_ant;
243 u8 valid_rx_ant;
244 u16 sku;
245 u16 eeprom_ver;
246 u16 eeprom_calib_ver;
247 const struct iwl_lib_ops *lib;
248 void (*additional_nic_config)(struct iwl_priv *priv);
249 /* params not likely to change within a device family */
250 struct iwl_base_params *base_params;
251 /* params likely to change within a device family */
252 struct iwl_ht_params *ht_params;
253 struct iwl_bt_params *bt_params;
254 enum iwl_pa_type pa_type; /* if used set to IWL_PA_SYSTEM */
255 const bool need_dc_calib; /* if used set to true */
256 const bool need_temp_offset_calib; /* if used set to true */
257 u8 scan_rx_antennas[IEEE80211_NUM_BANDS];
258 enum iwl_led_mode led_mode;
259 const bool adv_pm;
260 const bool rx_with_siso_diversity;
261 const bool internal_wimax_coex;
262 const bool iq_invert;
263 const bool disable_otp_refresh;
266 /***************************
267 * L i b *
268 ***************************/
270 int iwl_mac_conf_tx(struct ieee80211_hw *hw, u16 queue,
271 const struct ieee80211_tx_queue_params *params);
272 int iwl_mac_tx_last_beacon(struct ieee80211_hw *hw);
273 void iwl_set_rxon_hwcrypto(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
274 int hw_decrypt);
275 int iwl_check_rxon_cmd(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
276 int iwl_full_rxon_required(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
277 int iwl_set_rxon_channel(struct iwl_priv *priv, struct ieee80211_channel *ch,
278 struct iwl_rxon_context *ctx);
279 void iwl_set_flags_for_band(struct iwl_priv *priv,
280 struct iwl_rxon_context *ctx,
281 enum ieee80211_band band,
282 struct ieee80211_vif *vif);
283 u8 iwl_get_single_channel_number(struct iwl_priv *priv,
284 enum ieee80211_band band);
285 void iwl_set_rxon_ht(struct iwl_priv *priv, struct iwl_ht_config *ht_conf);
286 bool iwl_is_ht40_tx_allowed(struct iwl_priv *priv,
287 struct iwl_rxon_context *ctx,
288 struct ieee80211_sta_ht_cap *ht_cap);
289 void iwl_connection_init_rx_config(struct iwl_priv *priv,
290 struct iwl_rxon_context *ctx);
291 void iwl_set_rate(struct iwl_priv *priv);
292 void iwl_irq_handle_error(struct iwl_priv *priv);
293 int iwl_mac_add_interface(struct ieee80211_hw *hw,
294 struct ieee80211_vif *vif);
295 void iwl_mac_remove_interface(struct ieee80211_hw *hw,
296 struct ieee80211_vif *vif);
297 int iwl_mac_change_interface(struct ieee80211_hw *hw,
298 struct ieee80211_vif *vif,
299 enum nl80211_iftype newtype, bool newp2p);
300 #ifdef CONFIG_IWLWIFI_DEBUGFS
301 int iwl_alloc_traffic_mem(struct iwl_priv *priv);
302 void iwl_free_traffic_mem(struct iwl_priv *priv);
303 void iwl_reset_traffic_log(struct iwl_priv *priv);
304 void iwl_dbg_log_tx_data_frame(struct iwl_priv *priv,
305 u16 length, struct ieee80211_hdr *header);
306 void iwl_dbg_log_rx_data_frame(struct iwl_priv *priv,
307 u16 length, struct ieee80211_hdr *header);
308 const char *get_mgmt_string(int cmd);
309 const char *get_ctrl_string(int cmd);
310 void iwl_clear_traffic_stats(struct iwl_priv *priv);
311 void iwl_update_stats(struct iwl_priv *priv, bool is_tx, __le16 fc,
312 u16 len);
313 #else
314 static inline int iwl_alloc_traffic_mem(struct iwl_priv *priv)
316 return 0;
318 static inline void iwl_free_traffic_mem(struct iwl_priv *priv)
321 static inline void iwl_reset_traffic_log(struct iwl_priv *priv)
324 static inline void iwl_dbg_log_tx_data_frame(struct iwl_priv *priv,
325 u16 length, struct ieee80211_hdr *header)
328 static inline void iwl_dbg_log_rx_data_frame(struct iwl_priv *priv,
329 u16 length, struct ieee80211_hdr *header)
332 static inline void iwl_update_stats(struct iwl_priv *priv, bool is_tx,
333 __le16 fc, u16 len)
336 #endif
338 /*****************************************************
339 * RX
340 ******************************************************/
341 void iwl_rx_queue_update_write_ptr(struct iwl_priv *priv,
342 struct iwl_rx_queue *q);
343 int iwl_rx_queue_space(const struct iwl_rx_queue *q);
344 void iwl_tx_cmd_complete(struct iwl_priv *priv, struct iwl_rx_mem_buffer *rxb);
346 void iwl_chswitch_done(struct iwl_priv *priv, bool is_success);
348 /* TX helpers */
350 /*****************************************************
351 * TX
352 ******************************************************/
353 void iwl_txq_update_write_ptr(struct iwl_priv *priv, struct iwl_tx_queue *txq);
354 int iwl_queue_init(struct iwl_priv *priv, struct iwl_queue *q,
355 int count, int slots_num, u32 id);
356 void iwl_setup_watchdog(struct iwl_priv *priv);
357 /*****************************************************
358 * TX power
359 ****************************************************/
360 int iwl_set_tx_power(struct iwl_priv *priv, s8 tx_power, bool force);
362 /*******************************************************************************
363 * Scanning
364 ******************************************************************************/
365 void iwl_init_scan_params(struct iwl_priv *priv);
366 int iwl_scan_cancel(struct iwl_priv *priv);
367 int iwl_scan_cancel_timeout(struct iwl_priv *priv, unsigned long ms);
368 void iwl_force_scan_end(struct iwl_priv *priv);
369 int iwl_mac_hw_scan(struct ieee80211_hw *hw,
370 struct ieee80211_vif *vif,
371 struct cfg80211_scan_request *req);
372 void iwl_internal_short_hw_scan(struct iwl_priv *priv);
373 int iwl_force_reset(struct iwl_priv *priv, int mode, bool external);
374 u16 iwl_fill_probe_req(struct iwl_priv *priv, struct ieee80211_mgmt *frame,
375 const u8 *ta, const u8 *ie, int ie_len, int left);
376 void iwl_setup_rx_scan_handlers(struct iwl_priv *priv);
377 u16 iwl_get_active_dwell_time(struct iwl_priv *priv,
378 enum ieee80211_band band,
379 u8 n_probes);
380 u16 iwl_get_passive_dwell_time(struct iwl_priv *priv,
381 enum ieee80211_band band,
382 struct ieee80211_vif *vif);
383 void iwl_setup_scan_deferred_work(struct iwl_priv *priv);
384 void iwl_cancel_scan_deferred_work(struct iwl_priv *priv);
385 int __must_check iwl_scan_initiate(struct iwl_priv *priv,
386 struct ieee80211_vif *vif,
387 enum iwl_scan_type scan_type,
388 enum ieee80211_band band);
390 /* For faster active scanning, scan will move to the next channel if fewer than
391 * PLCP_QUIET_THRESH packets are heard on this channel within
392 * ACTIVE_QUIET_TIME after sending probe request. This shortens the dwell
393 * time if it's a quiet channel (nothing responded to our probe, and there's
394 * no other traffic).
395 * Disable "quiet" feature by setting PLCP_QUIET_THRESH to 0. */
396 #define IWL_ACTIVE_QUIET_TIME cpu_to_le16(10) /* msec */
397 #define IWL_PLCP_QUIET_THRESH cpu_to_le16(1) /* packets */
399 #define IWL_SCAN_CHECK_WATCHDOG (HZ * 7)
401 /*****************************************************
402 * S e n d i n g H o s t C o m m a n d s *
403 *****************************************************/
405 const char *get_cmd_string(u8 cmd);
406 int iwl_send_cmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
407 int __must_check iwl_send_cmd_pdu(struct iwl_priv *priv, u8 id, u32 flags,
408 u16 len, const void *data);
410 int iwl_enqueue_hcmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
412 void iwl_bg_watchdog(unsigned long data);
413 u32 iwl_usecs_to_beacons(struct iwl_priv *priv, u32 usec, u32 beacon_interval);
414 __le32 iwl_add_beacon_time(struct iwl_priv *priv, u32 base,
415 u32 addon, u32 beacon_interval);
417 #ifdef CONFIG_PM
418 int iwl_suspend(struct iwl_priv *priv);
419 int iwl_resume(struct iwl_priv *priv);
420 #endif /* !CONFIG_PM */
422 /*****************************************************
423 * Error Handling Debugging
424 ******************************************************/
425 void iwl_dump_nic_error_log(struct iwl_priv *priv);
426 int iwl_dump_nic_event_log(struct iwl_priv *priv,
427 bool full_log, char **buf, bool display);
428 void iwl_dump_csr(struct iwl_priv *priv);
429 int iwl_dump_fh(struct iwl_priv *priv, char **buf, bool display);
430 #ifdef CONFIG_IWLWIFI_DEBUG
431 void iwl_print_rx_config_cmd(struct iwl_priv *priv,
432 struct iwl_rxon_context *ctx);
433 #else
434 static inline void iwl_print_rx_config_cmd(struct iwl_priv *priv,
435 struct iwl_rxon_context *ctx)
438 #endif
440 void iwl_clear_isr_stats(struct iwl_priv *priv);
442 /*****************************************************
443 * GEOS
444 ******************************************************/
445 int iwlcore_init_geos(struct iwl_priv *priv);
446 void iwlcore_free_geos(struct iwl_priv *priv);
448 /*************** DRIVER STATUS FUNCTIONS *****/
450 #define STATUS_HCMD_ACTIVE 0 /* host command in progress */
451 /* 1 is unused (used to be STATUS_HCMD_SYNC_ACTIVE) */
452 #define STATUS_INT_ENABLED 2
453 #define STATUS_RF_KILL_HW 3
454 #define STATUS_CT_KILL 4
455 #define STATUS_INIT 5
456 #define STATUS_ALIVE 6
457 #define STATUS_READY 7
458 #define STATUS_TEMPERATURE 8
459 #define STATUS_GEO_CONFIGURED 9
460 #define STATUS_EXIT_PENDING 10
461 #define STATUS_STATISTICS 12
462 #define STATUS_SCANNING 13
463 #define STATUS_SCAN_ABORTING 14
464 #define STATUS_SCAN_HW 15
465 #define STATUS_POWER_PMI 16
466 #define STATUS_FW_ERROR 17
467 #define STATUS_DEVICE_ENABLED 18
468 #define STATUS_CHANNEL_SWITCH_PENDING 19
471 static inline int iwl_is_ready(struct iwl_priv *priv)
473 /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
474 * set but EXIT_PENDING is not */
475 return test_bit(STATUS_READY, &priv->status) &&
476 test_bit(STATUS_GEO_CONFIGURED, &priv->status) &&
477 !test_bit(STATUS_EXIT_PENDING, &priv->status);
480 static inline int iwl_is_alive(struct iwl_priv *priv)
482 return test_bit(STATUS_ALIVE, &priv->status);
485 static inline int iwl_is_init(struct iwl_priv *priv)
487 return test_bit(STATUS_INIT, &priv->status);
490 static inline int iwl_is_rfkill_hw(struct iwl_priv *priv)
492 return test_bit(STATUS_RF_KILL_HW, &priv->status);
495 static inline int iwl_is_rfkill(struct iwl_priv *priv)
497 return iwl_is_rfkill_hw(priv);
500 static inline int iwl_is_ctkill(struct iwl_priv *priv)
502 return test_bit(STATUS_CT_KILL, &priv->status);
505 static inline int iwl_is_ready_rf(struct iwl_priv *priv)
508 if (iwl_is_rfkill(priv))
509 return 0;
511 return iwl_is_ready(priv);
514 extern void iwl_send_bt_config(struct iwl_priv *priv);
515 extern int iwl_send_statistics_request(struct iwl_priv *priv,
516 u8 flags, bool clear);
517 void iwl_apm_stop(struct iwl_priv *priv);
518 int iwl_apm_init(struct iwl_priv *priv);
520 int iwl_send_rxon_timing(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
522 static inline const struct ieee80211_supported_band *iwl_get_hw_mode(
523 struct iwl_priv *priv, enum ieee80211_band band)
525 return priv->hw->wiphy->bands[band];
528 static inline bool iwl_advanced_bt_coexist(struct iwl_priv *priv)
530 return priv->cfg->bt_params &&
531 priv->cfg->bt_params->advanced_bt_coexist;
534 extern bool bt_siso_mode;
537 void iwlagn_fw_error(struct iwl_priv *priv, bool ondemand);
539 #endif /* __iwl_core_h__ */