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