Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/net
[pandora-kernel.git] / drivers / net / wireless / iwlwifi / iwl-core.h
1 /******************************************************************************
2  *
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.
5  *
6  * GPL LICENSE SUMMARY
7  *
8  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
9  *
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.
13  *
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.
18  *
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
23  *
24  * The full GNU General Public License is included in this distribution
25  * in the file called LICENSE.GPL.
26  *
27  * Contact Information:
28  *  Intel Linux Wireless <ilw@linux.intel.com>
29  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
30  *
31  * BSD LICENSE
32  *
33  * Copyright(c) 2005 - 2011 Intel Corporation. All rights reserved.
34  * All rights reserved.
35  *
36  * Redistribution and use in source and binary forms, with or without
37  * modification, are permitted provided that the following conditions
38  * are met:
39  *
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.
49  *
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  *****************************************************************************/
62
63 #ifndef __iwl_core_h__
64 #define __iwl_core_h__
65
66 #include "iwl-dev.h"
67
68 /************************
69  * forward declarations *
70  ************************/
71 struct iwl_host_cmd;
72 struct iwl_cmd;
73
74
75 #define IWLWIFI_VERSION "in-tree:"
76 #define DRV_COPYRIGHT   "Copyright(c) 2003-2011 Intel Corporation"
77 #define DRV_AUTHOR     "<ilw@linux.intel.com>"
78
79 #define TIME_UNIT               1024
80
81 #define IWL_CMD(x) case x: return #x
82
83 struct iwl_lib_ops {
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);
96
97         /* eeprom operations (as defined in iwl-eeprom.h) */
98         struct iwl_eeprom_ops eeprom_ops;
99
100         /* temperature */
101         void (*temperature)(struct iwl_priv *priv);
102 };
103
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 */
119 };
120
121 /*
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  */
140 struct iwl_base_params {
141         int eeprom_size;
142         int num_of_queues;      /* def: HW dependent */
143         int num_of_ampdu_queues;/* def: HW dependent */
144         /* for iwl_apm_init() */
145         u32 pll_cfg_val;
146
147         const u16 max_ll_items;
148         const bool shadow_ram_support;
149         u16 led_compensation;
150         int chain_noise_num_beacons;
151         bool adv_thermal_throttle;
152         bool support_ct_kill_exit;
153         const bool support_wimax_coexist;
154         u8 plcp_delta_threshold;
155         s32 chain_noise_scale;
156         unsigned int wd_timeout;
157         bool temperature_kelvin;
158         u32 max_event_log_size;
159         const bool shadow_reg_enable;
160         const bool no_idle_support;
161 };
162 /*
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
170  */
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;
180 };
181 /*
182  * @use_rts_for_aggregation: use rts/cts protection for HT traffic
183  */
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;
188 };
189
190 /**
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  *
218  * We enable the driver to be backward compatible wrt API version. The
219  * driver specifies which APIs it supports (with @ucode_api_max being the
220  * highest and @ucode_api_min the lowest). Firmware will only be loaded if
221  * it has a supported API version. The firmware's API version will be
222  * stored in @iwl_priv, enabling the driver to make runtime changes based
223  * on firmware version used.
224  *
225  * For example,
226  * if (IWL_UCODE_API(priv->ucode_ver) >= 2) {
227  *      Driver interacts with Firmware API version >= 2.
228  * } else {
229  *      Driver interacts with Firmware API version 1.
230  * }
231  *
232  * The ideal usage of this infrastructure is to treat a new ucode API
233  * release as a new hardware revision.
234  */
235 struct iwl_cfg {
236         /* params specific to an individual device within a device family */
237         const char *name;
238         const char *fw_name_pre;
239         const unsigned int ucode_api_max;
240         const unsigned int ucode_api_min;
241         u8   valid_tx_ant;
242         u8   valid_rx_ant;
243         u16  sku;
244         u16  eeprom_ver;
245         u16  eeprom_calib_ver;
246         const struct iwl_lib_ops *lib;
247         void (*additional_nic_config)(struct iwl_priv *priv);
248         /* params not likely to change within a device family */
249         struct iwl_base_params *base_params;
250         /* params likely to change within a device family */
251         struct iwl_ht_params *ht_params;
252         struct iwl_bt_params *bt_params;
253         enum iwl_pa_type pa_type;         /* if used set to IWL_PA_SYSTEM */
254         const bool need_dc_calib;         /* if used set to true */
255         const bool need_temp_offset_calib; /* if used set to true */
256         u8 scan_rx_antennas[IEEE80211_NUM_BANDS];
257         enum iwl_led_mode led_mode;
258         const bool adv_pm;
259         const bool rx_with_siso_diversity;
260         const bool internal_wimax_coex;
261         const bool iq_invert;
262 };
263
264 /***************************
265  *   L i b                 *
266  ***************************/
267
268 int iwl_mac_conf_tx(struct ieee80211_hw *hw, u16 queue,
269                     const struct ieee80211_tx_queue_params *params);
270 int iwl_mac_tx_last_beacon(struct ieee80211_hw *hw);
271 void iwl_set_rxon_hwcrypto(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
272                            int hw_decrypt);
273 int iwl_check_rxon_cmd(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
274 int iwl_full_rxon_required(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
275 int iwl_set_rxon_channel(struct iwl_priv *priv, struct ieee80211_channel *ch,
276                          struct iwl_rxon_context *ctx);
277 void iwl_set_flags_for_band(struct iwl_priv *priv,
278                             struct iwl_rxon_context *ctx,
279                             enum ieee80211_band band,
280                             struct ieee80211_vif *vif);
281 u8 iwl_get_single_channel_number(struct iwl_priv *priv,
282                                   enum ieee80211_band band);
283 void iwl_set_rxon_ht(struct iwl_priv *priv, struct iwl_ht_config *ht_conf);
284 bool iwl_is_ht40_tx_allowed(struct iwl_priv *priv,
285                             struct iwl_rxon_context *ctx,
286                             struct ieee80211_sta_ht_cap *ht_cap);
287 void iwl_connection_init_rx_config(struct iwl_priv *priv,
288                                    struct iwl_rxon_context *ctx);
289 void iwl_set_rate(struct iwl_priv *priv);
290 void iwl_irq_handle_error(struct iwl_priv *priv);
291 int iwl_mac_add_interface(struct ieee80211_hw *hw,
292                           struct ieee80211_vif *vif);
293 void iwl_mac_remove_interface(struct ieee80211_hw *hw,
294                               struct ieee80211_vif *vif);
295 int iwl_mac_change_interface(struct ieee80211_hw *hw,
296                              struct ieee80211_vif *vif,
297                              enum nl80211_iftype newtype, bool newp2p);
298 #ifdef CONFIG_IWLWIFI_DEBUGFS
299 int iwl_alloc_traffic_mem(struct iwl_priv *priv);
300 void iwl_free_traffic_mem(struct iwl_priv *priv);
301 void iwl_reset_traffic_log(struct iwl_priv *priv);
302 void iwl_dbg_log_tx_data_frame(struct iwl_priv *priv,
303                                 u16 length, struct ieee80211_hdr *header);
304 void iwl_dbg_log_rx_data_frame(struct iwl_priv *priv,
305                                 u16 length, struct ieee80211_hdr *header);
306 const char *get_mgmt_string(int cmd);
307 const char *get_ctrl_string(int cmd);
308 void iwl_clear_traffic_stats(struct iwl_priv *priv);
309 void iwl_update_stats(struct iwl_priv *priv, bool is_tx, __le16 fc,
310                       u16 len);
311 #else
312 static inline int iwl_alloc_traffic_mem(struct iwl_priv *priv)
313 {
314         return 0;
315 }
316 static inline void iwl_free_traffic_mem(struct iwl_priv *priv)
317 {
318 }
319 static inline void iwl_reset_traffic_log(struct iwl_priv *priv)
320 {
321 }
322 static inline void iwl_dbg_log_tx_data_frame(struct iwl_priv *priv,
323                       u16 length, struct ieee80211_hdr *header)
324 {
325 }
326 static inline void iwl_dbg_log_rx_data_frame(struct iwl_priv *priv,
327                       u16 length, struct ieee80211_hdr *header)
328 {
329 }
330 static inline void iwl_update_stats(struct iwl_priv *priv, bool is_tx,
331                                     __le16 fc, u16 len)
332 {
333 }
334 #endif
335
336 /*****************************************************
337 * RX
338 ******************************************************/
339 void iwl_chswitch_done(struct iwl_priv *priv, bool is_success);
340
341 void iwl_setup_watchdog(struct iwl_priv *priv);
342 /*****************************************************
343  * TX power
344  ****************************************************/
345 int iwl_set_tx_power(struct iwl_priv *priv, s8 tx_power, bool force);
346
347 /*******************************************************************************
348  * Scanning
349  ******************************************************************************/
350 void iwl_init_scan_params(struct iwl_priv *priv);
351 int iwl_scan_cancel(struct iwl_priv *priv);
352 int iwl_scan_cancel_timeout(struct iwl_priv *priv, unsigned long ms);
353 void iwl_force_scan_end(struct iwl_priv *priv);
354 int iwl_mac_hw_scan(struct ieee80211_hw *hw,
355                     struct ieee80211_vif *vif,
356                     struct cfg80211_scan_request *req);
357 void iwl_internal_short_hw_scan(struct iwl_priv *priv);
358 int iwl_force_reset(struct iwl_priv *priv, int mode, bool external);
359 u16 iwl_fill_probe_req(struct iwl_priv *priv, struct ieee80211_mgmt *frame,
360                        const u8 *ta, const u8 *ie, int ie_len, int left);
361 void iwl_setup_rx_scan_handlers(struct iwl_priv *priv);
362 u16 iwl_get_active_dwell_time(struct iwl_priv *priv,
363                               enum ieee80211_band band,
364                               u8 n_probes);
365 u16 iwl_get_passive_dwell_time(struct iwl_priv *priv,
366                                enum ieee80211_band band,
367                                struct ieee80211_vif *vif);
368 void iwl_setup_scan_deferred_work(struct iwl_priv *priv);
369 void iwl_cancel_scan_deferred_work(struct iwl_priv *priv);
370 int __must_check iwl_scan_initiate(struct iwl_priv *priv,
371                                    struct ieee80211_vif *vif,
372                                    enum iwl_scan_type scan_type,
373                                    enum ieee80211_band band);
374
375 /* For faster active scanning, scan will move to the next channel if fewer than
376  * PLCP_QUIET_THRESH packets are heard on this channel within
377  * ACTIVE_QUIET_TIME after sending probe request.  This shortens the dwell
378  * time if it's a quiet channel (nothing responded to our probe, and there's
379  * no other traffic).
380  * Disable "quiet" feature by setting PLCP_QUIET_THRESH to 0. */
381 #define IWL_ACTIVE_QUIET_TIME       cpu_to_le16(10)  /* msec */
382 #define IWL_PLCP_QUIET_THRESH       cpu_to_le16(1)  /* packets */
383
384 #define IWL_SCAN_CHECK_WATCHDOG         (HZ * 7)
385
386 /*****************************************************
387  *   S e n d i n g     H o s t     C o m m a n d s   *
388  *****************************************************/
389
390 const char *get_cmd_string(u8 cmd);
391 void iwl_bg_watchdog(unsigned long data);
392 u32 iwl_usecs_to_beacons(struct iwl_priv *priv, u32 usec, u32 beacon_interval);
393 __le32 iwl_add_beacon_time(struct iwl_priv *priv, u32 base,
394                            u32 addon, u32 beacon_interval);
395
396 #ifdef CONFIG_PM
397 int iwl_suspend(struct iwl_priv *priv);
398 int iwl_resume(struct iwl_priv *priv);
399 #endif /* !CONFIG_PM */
400
401 int iwl_probe(struct iwl_bus *bus, struct iwl_cfg *cfg);
402 void __devexit iwl_remove(struct iwl_priv * priv);
403
404 /*****************************************************
405 *  Error Handling Debugging
406 ******************************************************/
407 void iwl_dump_nic_error_log(struct iwl_priv *priv);
408 int iwl_dump_nic_event_log(struct iwl_priv *priv,
409                            bool full_log, char **buf, bool display);
410 void iwl_dump_csr(struct iwl_priv *priv);
411 int iwl_dump_fh(struct iwl_priv *priv, char **buf, bool display);
412 #ifdef CONFIG_IWLWIFI_DEBUG
413 void iwl_print_rx_config_cmd(struct iwl_priv *priv,
414                              struct iwl_rxon_context *ctx);
415 #else
416 static inline void iwl_print_rx_config_cmd(struct iwl_priv *priv,
417                                            struct iwl_rxon_context *ctx)
418 {
419 }
420 #endif
421
422 void iwl_clear_isr_stats(struct iwl_priv *priv);
423
424 /*****************************************************
425 *  GEOS
426 ******************************************************/
427 int iwlcore_init_geos(struct iwl_priv *priv);
428 void iwlcore_free_geos(struct iwl_priv *priv);
429
430 /*************** DRIVER STATUS FUNCTIONS   *****/
431
432 #define STATUS_HCMD_ACTIVE      0       /* host command in progress */
433 /* 1 is unused (used to be STATUS_HCMD_SYNC_ACTIVE) */
434 #define STATUS_INT_ENABLED      2
435 #define STATUS_RF_KILL_HW       3
436 #define STATUS_CT_KILL          4
437 #define STATUS_INIT             5
438 #define STATUS_ALIVE            6
439 #define STATUS_READY            7
440 #define STATUS_TEMPERATURE      8
441 #define STATUS_GEO_CONFIGURED   9
442 #define STATUS_EXIT_PENDING     10
443 #define STATUS_STATISTICS       12
444 #define STATUS_SCANNING         13
445 #define STATUS_SCAN_ABORTING    14
446 #define STATUS_SCAN_HW          15
447 #define STATUS_POWER_PMI        16
448 #define STATUS_FW_ERROR         17
449 #define STATUS_DEVICE_ENABLED   18
450 #define STATUS_CHANNEL_SWITCH_PENDING 19
451
452
453 static inline int iwl_is_ready(struct iwl_priv *priv)
454 {
455         /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
456          * set but EXIT_PENDING is not */
457         return test_bit(STATUS_READY, &priv->status) &&
458                test_bit(STATUS_GEO_CONFIGURED, &priv->status) &&
459                !test_bit(STATUS_EXIT_PENDING, &priv->status);
460 }
461
462 static inline int iwl_is_alive(struct iwl_priv *priv)
463 {
464         return test_bit(STATUS_ALIVE, &priv->status);
465 }
466
467 static inline int iwl_is_init(struct iwl_priv *priv)
468 {
469         return test_bit(STATUS_INIT, &priv->status);
470 }
471
472 static inline int iwl_is_rfkill_hw(struct iwl_priv *priv)
473 {
474         return test_bit(STATUS_RF_KILL_HW, &priv->status);
475 }
476
477 static inline int iwl_is_rfkill(struct iwl_priv *priv)
478 {
479         return iwl_is_rfkill_hw(priv);
480 }
481
482 static inline int iwl_is_ctkill(struct iwl_priv *priv)
483 {
484         return test_bit(STATUS_CT_KILL, &priv->status);
485 }
486
487 static inline int iwl_is_ready_rf(struct iwl_priv *priv)
488 {
489
490         if (iwl_is_rfkill(priv))
491                 return 0;
492
493         return iwl_is_ready(priv);
494 }
495
496 extern void iwl_send_bt_config(struct iwl_priv *priv);
497 extern int iwl_send_statistics_request(struct iwl_priv *priv,
498                                        u8 flags, bool clear);
499 void iwl_apm_stop(struct iwl_priv *priv);
500 int iwl_apm_init(struct iwl_priv *priv);
501
502 int iwl_send_rxon_timing(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
503
504 static inline const struct ieee80211_supported_band *iwl_get_hw_mode(
505                         struct iwl_priv *priv, enum ieee80211_band band)
506 {
507         return priv->hw->wiphy->bands[band];
508 }
509
510 static inline bool iwl_advanced_bt_coexist(struct iwl_priv *priv)
511 {
512         return priv->cfg->bt_params &&
513                priv->cfg->bt_params->advanced_bt_coexist;
514 }
515
516 extern bool bt_siso_mode;
517
518
519 void iwlagn_fw_error(struct iwl_priv *priv, bool ondemand);
520
521 #endif /* __iwl_core_h__ */