iwlwifi: use .cfg to enable/disable continuous ucode trace
[safe/jmp/linux-2.6] / 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 - 2010 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 - 2010 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 /************************
67  * forward declarations *
68  ************************/
69 struct iwl_host_cmd;
70 struct iwl_cmd;
71
72
73 #define IWLWIFI_VERSION "in-tree:"
74 #define DRV_COPYRIGHT   "Copyright(c) 2003-2010 Intel Corporation"
75 #define DRV_AUTHOR     "<ilw@linux.intel.com>"
76
77 #define IWL_PCI_DEVICE(dev, subdev, cfg) \
78         .vendor = PCI_VENDOR_ID_INTEL,  .device = (dev), \
79         .subvendor = PCI_ANY_ID, .subdevice = (subdev), \
80         .driver_data = (kernel_ulong_t)&(cfg)
81
82 #define IWL_SKU_G       0x1
83 #define IWL_SKU_A       0x2
84 #define IWL_SKU_N       0x8
85
86 #define IWL_CMD(x) case x: return #x
87
88 struct iwl_hcmd_ops {
89         int (*rxon_assoc)(struct iwl_priv *priv);
90         int (*commit_rxon)(struct iwl_priv *priv);
91         void (*set_rxon_chain)(struct iwl_priv *priv);
92         int (*set_tx_ant)(struct iwl_priv *priv, u8 valid_tx_ant);
93         void (*send_bt_config)(struct iwl_priv *priv);
94 };
95
96 struct iwl_hcmd_utils_ops {
97         u16 (*get_hcmd_size)(u8 cmd_id, u16 len);
98         u16 (*build_addsta_hcmd)(const struct iwl_addsta_cmd *cmd, u8 *data);
99         void (*gain_computation)(struct iwl_priv *priv,
100                         u32 *average_noise,
101                         u16 min_average_noise_antennat_i,
102                         u32 min_average_noise,
103                         u8 default_chain);
104         void (*chain_noise_reset)(struct iwl_priv *priv);
105         void (*rts_tx_cmd_flag)(struct ieee80211_tx_info *info,
106                         __le32 *tx_flags);
107         int  (*calc_rssi)(struct iwl_priv *priv,
108                           struct iwl_rx_phy_res *rx_resp);
109         void (*request_scan)(struct iwl_priv *priv);
110 };
111
112 struct iwl_apm_ops {
113         int (*init)(struct iwl_priv *priv);
114         void (*stop)(struct iwl_priv *priv);
115         void (*config)(struct iwl_priv *priv);
116         int (*set_pwr_src)(struct iwl_priv *priv, enum iwl_pwr_src src);
117 };
118
119 struct iwl_debugfs_ops {
120         ssize_t (*rx_stats_read)(struct file *file, char __user *user_buf,
121                                  size_t count, loff_t *ppos);
122         ssize_t (*tx_stats_read)(struct file *file, char __user *user_buf,
123                                  size_t count, loff_t *ppos);
124         ssize_t (*general_stats_read)(struct file *file, char __user *user_buf,
125                                       size_t count, loff_t *ppos);
126 };
127
128 struct iwl_temp_ops {
129         void (*temperature)(struct iwl_priv *priv);
130         void (*set_ct_kill)(struct iwl_priv *priv);
131         void (*set_calib_version)(struct iwl_priv *priv);
132 };
133
134 struct iwl_ucode_ops {
135         u32 (*get_header_size)(u32);
136         u32 (*get_build)(const struct iwl_ucode_header *, u32);
137         u32 (*get_inst_size)(const struct iwl_ucode_header *, u32);
138         u32 (*get_data_size)(const struct iwl_ucode_header *, u32);
139         u32 (*get_init_size)(const struct iwl_ucode_header *, u32);
140         u32 (*get_init_data_size)(const struct iwl_ucode_header *, u32);
141         u32 (*get_boot_size)(const struct iwl_ucode_header *, u32);
142         u8 * (*get_data)(const struct iwl_ucode_header *, u32);
143 };
144
145 struct iwl_lib_ops {
146         /* set hw dependent parameters */
147         int (*set_hw_params)(struct iwl_priv *priv);
148         /* Handling TX */
149         void (*txq_update_byte_cnt_tbl)(struct iwl_priv *priv,
150                                         struct iwl_tx_queue *txq,
151                                         u16 byte_cnt);
152         void (*txq_inval_byte_cnt_tbl)(struct iwl_priv *priv,
153                                        struct iwl_tx_queue *txq);
154         void (*txq_set_sched)(struct iwl_priv *priv, u32 mask);
155         int (*txq_attach_buf_to_tfd)(struct iwl_priv *priv,
156                                      struct iwl_tx_queue *txq,
157                                      dma_addr_t addr,
158                                      u16 len, u8 reset, u8 pad);
159         void (*txq_free_tfd)(struct iwl_priv *priv,
160                              struct iwl_tx_queue *txq);
161         int (*txq_init)(struct iwl_priv *priv,
162                         struct iwl_tx_queue *txq);
163         /* aggregations */
164         int (*txq_agg_enable)(struct iwl_priv *priv, int txq_id, int tx_fifo,
165                               int sta_id, int tid, u16 ssn_idx);
166         int (*txq_agg_disable)(struct iwl_priv *priv, u16 txq_id, u16 ssn_idx,
167                                u8 tx_fifo);
168         /* setup Rx handler */
169         void (*rx_handler_setup)(struct iwl_priv *priv);
170         /* setup deferred work */
171         void (*setup_deferred_work)(struct iwl_priv *priv);
172         /* cancel deferred work */
173         void (*cancel_deferred_work)(struct iwl_priv *priv);
174         /* alive notification after init uCode load */
175         void (*init_alive_start)(struct iwl_priv *priv);
176         /* alive notification */
177         int (*alive_notify)(struct iwl_priv *priv);
178         /* check validity of rtc data address */
179         int (*is_valid_rtc_data_addr)(u32 addr);
180         /* 1st ucode load */
181         int (*load_ucode)(struct iwl_priv *priv);
182         int (*dump_nic_event_log)(struct iwl_priv *priv,
183                                   bool full_log, char **buf, bool display);
184         void (*dump_nic_error_log)(struct iwl_priv *priv);
185         void (*dump_csr)(struct iwl_priv *priv);
186         int (*dump_fh)(struct iwl_priv *priv, char **buf, bool display);
187         int (*set_channel_switch)(struct iwl_priv *priv, u16 channel);
188         /* power management */
189         struct iwl_apm_ops apm_ops;
190
191         /* power */
192         int (*send_tx_power) (struct iwl_priv *priv);
193         void (*update_chain_flags)(struct iwl_priv *priv);
194         void (*post_associate) (struct iwl_priv *priv);
195         void (*config_ap) (struct iwl_priv *priv);
196         irqreturn_t (*isr) (int irq, void *data);
197
198         /* eeprom operations (as defined in iwl-eeprom.h) */
199         struct iwl_eeprom_ops eeprom_ops;
200
201         /* temperature */
202         struct iwl_temp_ops temp_ops;
203         /* station management */
204         void (*add_bcast_station)(struct iwl_priv *priv);
205         /* recover from tx queue stall */
206         void (*recover_from_tx_stall)(unsigned long data);
207         /* check for plcp health */
208         bool (*check_plcp_health)(struct iwl_priv *priv,
209                                         struct iwl_rx_packet *pkt);
210         /* check for ack health */
211         bool (*check_ack_health)(struct iwl_priv *priv,
212                                         struct iwl_rx_packet *pkt);
213         struct iwl_debugfs_ops debugfs_ops;
214 };
215
216 struct iwl_led_ops {
217         int (*cmd)(struct iwl_priv *priv, struct iwl_led_cmd *led_cmd);
218         int (*on)(struct iwl_priv *priv);
219         int (*off)(struct iwl_priv *priv);
220 };
221
222 struct iwl_ops {
223         const struct iwl_ucode_ops *ucode;
224         const struct iwl_lib_ops *lib;
225         const struct iwl_hcmd_ops *hcmd;
226         const struct iwl_hcmd_utils_ops *utils;
227         const struct iwl_led_ops *led;
228 };
229
230 struct iwl_mod_params {
231         int sw_crypto;          /* def: 0 = using hardware encryption */
232         int disable_hw_scan;    /* def: 0 = use h/w scan */
233         int num_of_queues;      /* def: HW dependent */
234         int disable_11n;        /* def: 0 = 11n capabilities enabled */
235         int amsdu_size_8K;      /* def: 1 = enable 8K amsdu size */
236         int antenna;            /* def: 0 = both antennas (use diversity) */
237         int restart_fw;         /* def: 1 = restart firmware */
238 };
239
240 /**
241  * struct iwl_cfg
242  * @fw_name_pre: Firmware filename prefix. The api version and extension
243  *      (.ucode) will be added to filename before loading from disk. The
244  *      filename is constructed as fw_name_pre<api>.ucode.
245  * @ucode_api_max: Highest version of uCode API supported by driver.
246  * @ucode_api_min: Lowest version of uCode API supported by driver.
247  * @pa_type: used by 6000 series only to identify the type of Power Amplifier
248  * @max_ll_items: max number of OTP blocks
249  * @shadow_ram_support: shadow support for OTP memory
250  * @led_compensation: compensate on the led on/off time per HW according
251  *      to the deviation to achieve the desired led frequency.
252  *      The detail algorithm is described in iwl-led.c
253  * @use_rts_for_ht: use rts/cts protection for HT traffic
254  * @chain_noise_num_beacons: number of beacons used to compute chain noise
255  * @adv_thermal_throttle: support advance thermal throttle
256  * @support_ct_kill_exit: support ct kill exit condition
257  * @support_wimax_coexist: support wimax/wifi co-exist
258  * @plcp_delta_threshold: plcp error rate threshold used to trigger
259  *      radio tuning when there is a high receiving plcp error rate
260  *
261  * We enable the driver to be backward compatible wrt API version. The
262  * driver specifies which APIs it supports (with @ucode_api_max being the
263  * highest and @ucode_api_min the lowest). Firmware will only be loaded if
264  * it has a supported API version. The firmware's API version will be
265  * stored in @iwl_priv, enabling the driver to make runtime changes based
266  * on firmware version used.
267  *
268  * For example,
269  * if (IWL_UCODE_API(priv->ucode_ver) >= 2) {
270  *      Driver interacts with Firmware API version >= 2.
271  * } else {
272  *      Driver interacts with Firmware API version 1.
273  * }
274  *
275  * The ideal usage of this infrastructure is to treat a new ucode API
276  * release as a new hardware revision. That is, through utilizing the
277  * iwl_hcmd_utils_ops etc. we accommodate different command structures
278  * and flows between hardware versions (4965/5000) as well as their API
279  * versions.
280  *
281  */
282 struct iwl_cfg {
283         const char *name;
284         const char *fw_name_pre;
285         const unsigned int ucode_api_max;
286         const unsigned int ucode_api_min;
287         unsigned int sku;
288         int eeprom_size;
289         u16  eeprom_ver;
290         u16  eeprom_calib_ver;
291         int num_of_queues;      /* def: HW dependent */
292         int num_of_ampdu_queues;/* def: HW dependent */
293         const struct iwl_ops *ops;
294         const struct iwl_mod_params *mod_params;
295         u8   valid_tx_ant;
296         u8   valid_rx_ant;
297
298         /* for iwl_apm_init() */
299         u32 pll_cfg_val;
300         bool set_l0s;
301         bool use_bsm;
302
303         bool use_isr_legacy;
304         enum iwl_pa_type pa_type;
305         const u16 max_ll_items;
306         const bool shadow_ram_support;
307         const bool ht_greenfield_support;
308         u16 led_compensation;
309         const bool broken_powersave;
310         bool use_rts_for_ht;
311         int chain_noise_num_beacons;
312         const bool supports_idle;
313         bool adv_thermal_throttle;
314         bool support_ct_kill_exit;
315         const bool support_wimax_coexist;
316         u8 plcp_delta_threshold;
317         s32 chain_noise_scale;
318         /* timer period for monitor the driver queues */
319         u32 monitor_recover_period;
320         bool temperature_kelvin;
321         u32 max_event_log_size;
322         const bool tx_power_by_driver;
323         const bool ucode_tracing;
324         u8 scan_antennas[IEEE80211_NUM_BANDS];
325 };
326
327 /***************************
328  *   L i b                 *
329  ***************************/
330
331 struct ieee80211_hw *iwl_alloc_all(struct iwl_cfg *cfg,
332                 struct ieee80211_ops *hw_ops);
333 void iwl_hw_detect(struct iwl_priv *priv);
334 void iwl_activate_qos(struct iwl_priv *priv);
335 int iwl_mac_conf_tx(struct ieee80211_hw *hw, u16 queue,
336                     const struct ieee80211_tx_queue_params *params);
337 void iwl_set_rxon_hwcrypto(struct iwl_priv *priv, int hw_decrypt);
338 int iwl_check_rxon_cmd(struct iwl_priv *priv);
339 int iwl_full_rxon_required(struct iwl_priv *priv);
340 void iwl_set_rxon_chain(struct iwl_priv *priv);
341 int iwl_set_rxon_channel(struct iwl_priv *priv, struct ieee80211_channel *ch);
342 void iwl_set_rxon_ht(struct iwl_priv *priv, struct iwl_ht_config *ht_conf);
343 u8 iwl_is_ht40_tx_allowed(struct iwl_priv *priv,
344                          struct ieee80211_sta_ht_cap *sta_ht_inf);
345 void iwl_set_flags_for_band(struct iwl_priv *priv, enum ieee80211_band band);
346 void iwl_connection_init_rx_config(struct iwl_priv *priv, int mode);
347 int iwl_set_decrypted_flag(struct iwl_priv *priv,
348                            struct ieee80211_hdr *hdr,
349                            u32 decrypt_res,
350                            struct ieee80211_rx_status *stats);
351 void iwl_irq_handle_error(struct iwl_priv *priv);
352 void iwl_configure_filter(struct ieee80211_hw *hw,
353                           unsigned int changed_flags,
354                           unsigned int *total_flags, u64 multicast);
355 int iwl_set_hw_params(struct iwl_priv *priv);
356 void iwl_post_associate(struct iwl_priv *priv);
357 void iwl_bss_info_changed(struct ieee80211_hw *hw,
358                                      struct ieee80211_vif *vif,
359                                      struct ieee80211_bss_conf *bss_conf,
360                                      u32 changes);
361 int iwl_mac_beacon_update(struct ieee80211_hw *hw, struct sk_buff *skb);
362 int iwl_commit_rxon(struct iwl_priv *priv);
363 int iwl_mac_add_interface(struct ieee80211_hw *hw,
364                           struct ieee80211_vif *vif);
365 void iwl_mac_remove_interface(struct ieee80211_hw *hw,
366                               struct ieee80211_vif *vif);
367 int iwl_mac_config(struct ieee80211_hw *hw, u32 changed);
368 void iwl_config_ap(struct iwl_priv *priv);
369 void iwl_mac_reset_tsf(struct ieee80211_hw *hw);
370 int iwl_alloc_txq_mem(struct iwl_priv *priv);
371 void iwl_free_txq_mem(struct iwl_priv *priv);
372 void iwlcore_rts_tx_cmd_flag(struct ieee80211_tx_info *info,
373                                 __le32 *tx_flags);
374 int iwl_send_wimax_coex(struct iwl_priv *priv);
375 #ifdef CONFIG_IWLWIFI_DEBUGFS
376 int iwl_alloc_traffic_mem(struct iwl_priv *priv);
377 void iwl_free_traffic_mem(struct iwl_priv *priv);
378 void iwl_reset_traffic_log(struct iwl_priv *priv);
379 void iwl_dbg_log_tx_data_frame(struct iwl_priv *priv,
380                                 u16 length, struct ieee80211_hdr *header);
381 void iwl_dbg_log_rx_data_frame(struct iwl_priv *priv,
382                                 u16 length, struct ieee80211_hdr *header);
383 const char *get_mgmt_string(int cmd);
384 const char *get_ctrl_string(int cmd);
385 void iwl_clear_traffic_stats(struct iwl_priv *priv);
386 void iwl_update_stats(struct iwl_priv *priv, bool is_tx, __le16 fc,
387                       u16 len);
388 #else
389 static inline int iwl_alloc_traffic_mem(struct iwl_priv *priv)
390 {
391         return 0;
392 }
393 static inline void iwl_free_traffic_mem(struct iwl_priv *priv)
394 {
395 }
396 static inline void iwl_reset_traffic_log(struct iwl_priv *priv)
397 {
398 }
399 static inline void iwl_dbg_log_tx_data_frame(struct iwl_priv *priv,
400                       u16 length, struct ieee80211_hdr *header)
401 {
402 }
403 static inline void iwl_dbg_log_rx_data_frame(struct iwl_priv *priv,
404                       u16 length, struct ieee80211_hdr *header)
405 {
406 }
407 static inline void iwl_update_stats(struct iwl_priv *priv, bool is_tx,
408                                     __le16 fc, u16 len)
409 {
410         struct traffic_stats    *stats;
411
412         if (is_tx)
413                 stats = &priv->tx_stats;
414         else
415                 stats = &priv->rx_stats;
416
417         if (ieee80211_is_data(fc)) {
418                 /* data */
419                 stats->data_bytes += len;
420         }
421         iwl_leds_background(priv);
422 }
423 #endif
424 /*****************************************************
425  * RX handlers.
426  * **************************************************/
427 void iwl_rx_pm_sleep_notif(struct iwl_priv *priv,
428                            struct iwl_rx_mem_buffer *rxb);
429 void iwl_rx_pm_debug_statistics_notif(struct iwl_priv *priv,
430                                       struct iwl_rx_mem_buffer *rxb);
431 void iwl_rx_reply_error(struct iwl_priv *priv,
432                         struct iwl_rx_mem_buffer *rxb);
433
434 /*****************************************************
435 * RX
436 ******************************************************/
437 void iwl_cmd_queue_free(struct iwl_priv *priv);
438 int iwl_rx_queue_alloc(struct iwl_priv *priv);
439 void iwl_rx_handle(struct iwl_priv *priv);
440 void iwl_rx_queue_update_write_ptr(struct iwl_priv *priv,
441                                   struct iwl_rx_queue *q);
442 int iwl_rx_queue_space(const struct iwl_rx_queue *q);
443 void iwl_tx_cmd_complete(struct iwl_priv *priv, struct iwl_rx_mem_buffer *rxb);
444 /* Handlers */
445 void iwl_rx_missed_beacon_notif(struct iwl_priv *priv,
446                                struct iwl_rx_mem_buffer *rxb);
447 void iwl_rx_spectrum_measure_notif(struct iwl_priv *priv,
448                                           struct iwl_rx_mem_buffer *rxb);
449 bool iwl_good_plcp_health(struct iwl_priv *priv,
450                                  struct iwl_rx_packet *pkt);
451 bool iwl_good_ack_health(struct iwl_priv *priv,
452                                  struct iwl_rx_packet *pkt);
453 void iwl_rx_statistics(struct iwl_priv *priv,
454                               struct iwl_rx_mem_buffer *rxb);
455 void iwl_reply_statistics(struct iwl_priv *priv,
456                           struct iwl_rx_mem_buffer *rxb);
457 void iwl_rx_csa(struct iwl_priv *priv, struct iwl_rx_mem_buffer *rxb);
458
459 /* TX helpers */
460
461 /*****************************************************
462 * TX
463 ******************************************************/
464 void iwl_hw_txq_free_tfd(struct iwl_priv *priv, struct iwl_tx_queue *txq);
465 int iwl_hw_txq_attach_buf_to_tfd(struct iwl_priv *priv,
466                                  struct iwl_tx_queue *txq,
467                                  dma_addr_t addr, u16 len, u8 reset, u8 pad);
468 int iwl_hw_tx_queue_init(struct iwl_priv *priv,
469                          struct iwl_tx_queue *txq);
470 void iwl_free_tfds_in_queue(struct iwl_priv *priv,
471                             int sta_id, int tid, int freed);
472 void iwl_txq_update_write_ptr(struct iwl_priv *priv, struct iwl_tx_queue *txq);
473 int iwl_tx_queue_init(struct iwl_priv *priv, struct iwl_tx_queue *txq,
474                       int slots_num, u32 txq_id);
475 void iwl_tx_queue_reset(struct iwl_priv *priv, struct iwl_tx_queue *txq,
476                         int slots_num, u32 txq_id);
477 void iwl_tx_queue_free(struct iwl_priv *priv, int txq_id);
478 /*****************************************************
479  * TX power
480  ****************************************************/
481 int iwl_set_tx_power(struct iwl_priv *priv, s8 tx_power, bool force);
482
483 /*******************************************************************************
484  * Rate
485  ******************************************************************************/
486
487 int iwl_hwrate_to_plcp_idx(u32 rate_n_flags);
488
489 u8 iwl_rate_get_lowest_plcp(struct iwl_priv *priv);
490
491 u8 iwl_toggle_tx_ant(struct iwl_priv *priv, u8 ant_idx);
492
493 static inline u32 iwl_ant_idx_to_flags(u8 ant_idx)
494 {
495         return BIT(ant_idx) << RATE_MCS_ANT_POS;
496 }
497
498 static inline u8 iwl_hw_get_rate(__le32 rate_n_flags)
499 {
500         return le32_to_cpu(rate_n_flags) & 0xFF;
501 }
502 static inline u32 iwl_hw_get_rate_n_flags(__le32 rate_n_flags)
503 {
504         return le32_to_cpu(rate_n_flags) & 0x1FFFF;
505 }
506 static inline __le32 iwl_hw_set_rate_n_flags(u8 rate, u32 flags)
507 {
508         return cpu_to_le32(flags|(u32)rate);
509 }
510
511 /*******************************************************************************
512  * Scanning
513  ******************************************************************************/
514 void iwl_init_scan_params(struct iwl_priv *priv);
515 int iwl_scan_cancel(struct iwl_priv *priv);
516 int iwl_scan_cancel_timeout(struct iwl_priv *priv, unsigned long ms);
517 int iwl_mac_hw_scan(struct ieee80211_hw *hw,
518                     struct ieee80211_vif *vif,
519                     struct cfg80211_scan_request *req);
520 void iwl_bg_start_internal_scan(struct work_struct *work);
521 void iwl_internal_short_hw_scan(struct iwl_priv *priv);
522 int iwl_force_reset(struct iwl_priv *priv, int mode);
523 u16 iwl_fill_probe_req(struct iwl_priv *priv, struct ieee80211_mgmt *frame,
524                        const u8 *ie, int ie_len, int left);
525 void iwl_setup_rx_scan_handlers(struct iwl_priv *priv);
526 u16 iwl_get_active_dwell_time(struct iwl_priv *priv,
527                               enum ieee80211_band band,
528                               u8 n_probes);
529 u16 iwl_get_passive_dwell_time(struct iwl_priv *priv,
530                                enum ieee80211_band band);
531 void iwl_bg_scan_check(struct work_struct *data);
532 void iwl_bg_abort_scan(struct work_struct *work);
533 void iwl_bg_scan_completed(struct work_struct *work);
534 void iwl_setup_scan_deferred_work(struct iwl_priv *priv);
535
536 /* For faster active scanning, scan will move to the next channel if fewer than
537  * PLCP_QUIET_THRESH packets are heard on this channel within
538  * ACTIVE_QUIET_TIME after sending probe request.  This shortens the dwell
539  * time if it's a quiet channel (nothing responded to our probe, and there's
540  * no other traffic).
541  * Disable "quiet" feature by setting PLCP_QUIET_THRESH to 0. */
542 #define IWL_ACTIVE_QUIET_TIME       cpu_to_le16(10)  /* msec */
543 #define IWL_PLCP_QUIET_THRESH       cpu_to_le16(1)  /* packets */
544
545 #define IWL_SCAN_CHECK_WATCHDOG         (HZ * 7)
546
547 /*******************************************************************************
548  * Calibrations - implemented in iwl-calib.c
549  ******************************************************************************/
550 int iwl_send_calib_results(struct iwl_priv *priv);
551 int iwl_calib_set(struct iwl_calib_result *res, const u8 *buf, int len);
552 void iwl_calib_free_results(struct iwl_priv *priv);
553
554 /*****************************************************
555  *   S e n d i n g     H o s t     C o m m a n d s   *
556  *****************************************************/
557
558 const char *get_cmd_string(u8 cmd);
559 int __must_check iwl_send_cmd_sync(struct iwl_priv *priv,
560                                    struct iwl_host_cmd *cmd);
561 int iwl_send_cmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
562 int __must_check iwl_send_cmd_pdu(struct iwl_priv *priv, u8 id,
563                                   u16 len, const void *data);
564 int iwl_send_cmd_pdu_async(struct iwl_priv *priv, u8 id, u16 len,
565                            const void *data,
566                            void (*callback)(struct iwl_priv *priv,
567                                             struct iwl_device_cmd *cmd,
568                                             struct iwl_rx_packet *pkt));
569
570 int iwl_enqueue_hcmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
571
572 int iwl_send_card_state(struct iwl_priv *priv, u32 flags,
573                         u8 meta_flag);
574
575 /*****************************************************
576  * PCI                                               *
577  *****************************************************/
578 irqreturn_t iwl_isr_legacy(int irq, void *data);
579
580 static inline u16 iwl_pcie_link_ctl(struct iwl_priv *priv)
581 {
582         int pos;
583         u16 pci_lnk_ctl;
584         pos = pci_find_capability(priv->pci_dev, PCI_CAP_ID_EXP);
585         pci_read_config_word(priv->pci_dev, pos + PCI_EXP_LNKCTL, &pci_lnk_ctl);
586         return pci_lnk_ctl;
587 }
588
589 void iwl_bg_monitor_recover(unsigned long data);
590
591 #ifdef CONFIG_PM
592 int iwl_pci_suspend(struct pci_dev *pdev, pm_message_t state);
593 int iwl_pci_resume(struct pci_dev *pdev);
594 #endif /* CONFIG_PM */
595
596 /*****************************************************
597 *  Error Handling Debugging
598 ******************************************************/
599 void iwl_dump_nic_error_log(struct iwl_priv *priv);
600 int iwl_dump_nic_event_log(struct iwl_priv *priv,
601                            bool full_log, char **buf, bool display);
602 void iwl_dump_csr(struct iwl_priv *priv);
603 int iwl_dump_fh(struct iwl_priv *priv, char **buf, bool display);
604 #ifdef CONFIG_IWLWIFI_DEBUG
605 void iwl_print_rx_config_cmd(struct iwl_priv *priv);
606 #else
607 static inline void iwl_print_rx_config_cmd(struct iwl_priv *priv)
608 {
609 }
610 #endif
611
612 void iwl_clear_isr_stats(struct iwl_priv *priv);
613
614 /*****************************************************
615 *  GEOS
616 ******************************************************/
617 int iwlcore_init_geos(struct iwl_priv *priv);
618 void iwlcore_free_geos(struct iwl_priv *priv);
619
620 /*************** DRIVER STATUS FUNCTIONS   *****/
621
622 #define STATUS_HCMD_ACTIVE      0       /* host command in progress */
623 /* 1 is unused (used to be STATUS_HCMD_SYNC_ACTIVE) */
624 #define STATUS_INT_ENABLED      2
625 #define STATUS_RF_KILL_HW       3
626 #define STATUS_CT_KILL          4
627 #define STATUS_INIT             5
628 #define STATUS_ALIVE            6
629 #define STATUS_READY            7
630 #define STATUS_TEMPERATURE      8
631 #define STATUS_GEO_CONFIGURED   9
632 #define STATUS_EXIT_PENDING     10
633 #define STATUS_STATISTICS       12
634 #define STATUS_SCANNING         13
635 #define STATUS_SCAN_ABORTING    14
636 #define STATUS_SCAN_HW          15
637 #define STATUS_POWER_PMI        16
638 #define STATUS_FW_ERROR         17
639
640
641 static inline int iwl_is_ready(struct iwl_priv *priv)
642 {
643         /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
644          * set but EXIT_PENDING is not */
645         return test_bit(STATUS_READY, &priv->status) &&
646                test_bit(STATUS_GEO_CONFIGURED, &priv->status) &&
647                !test_bit(STATUS_EXIT_PENDING, &priv->status);
648 }
649
650 static inline int iwl_is_alive(struct iwl_priv *priv)
651 {
652         return test_bit(STATUS_ALIVE, &priv->status);
653 }
654
655 static inline int iwl_is_init(struct iwl_priv *priv)
656 {
657         return test_bit(STATUS_INIT, &priv->status);
658 }
659
660 static inline int iwl_is_rfkill_hw(struct iwl_priv *priv)
661 {
662         return test_bit(STATUS_RF_KILL_HW, &priv->status);
663 }
664
665 static inline int iwl_is_rfkill(struct iwl_priv *priv)
666 {
667         return iwl_is_rfkill_hw(priv);
668 }
669
670 static inline int iwl_is_ctkill(struct iwl_priv *priv)
671 {
672         return test_bit(STATUS_CT_KILL, &priv->status);
673 }
674
675 static inline int iwl_is_ready_rf(struct iwl_priv *priv)
676 {
677
678         if (iwl_is_rfkill(priv))
679                 return 0;
680
681         return iwl_is_ready(priv);
682 }
683
684 extern void iwl_rf_kill_ct_config(struct iwl_priv *priv);
685 extern void iwl_send_bt_config(struct iwl_priv *priv);
686 extern int iwl_send_statistics_request(struct iwl_priv *priv,
687                                        u8 flags, bool clear);
688 extern int iwl_verify_ucode(struct iwl_priv *priv);
689 extern int iwl_send_lq_cmd(struct iwl_priv *priv,
690                 struct iwl_link_quality_cmd *lq, u8 flags, bool init);
691 void iwl_apm_stop(struct iwl_priv *priv);
692 int iwl_apm_init(struct iwl_priv *priv);
693
694 void iwl_setup_rxon_timing(struct iwl_priv *priv);
695 static inline int iwl_send_rxon_assoc(struct iwl_priv *priv)
696 {
697         return priv->cfg->ops->hcmd->rxon_assoc(priv);
698 }
699 static inline int iwlcore_commit_rxon(struct iwl_priv *priv)
700 {
701         return priv->cfg->ops->hcmd->commit_rxon(priv);
702 }
703 static inline void iwlcore_config_ap(struct iwl_priv *priv)
704 {
705         priv->cfg->ops->lib->config_ap(priv);
706 }
707 static inline const struct ieee80211_supported_band *iwl_get_hw_mode(
708                         struct iwl_priv *priv, enum ieee80211_band band)
709 {
710         return priv->hw->wiphy->bands[band];
711 }
712 #endif /* __iwl_core_h__ */