projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
iwl3945: sync tx queue data structure with iwlagn
[linux-2.6-block.git] / drivers / net / wireless / iwlwifi / iwl-core.h
CommitLineData
82b9a121
TW		 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 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:
759ef89f 28 * Intel Linux Wireless <ilw@linux.intel.com>
82b9a121
TW		 29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
30 *
31 * BSD LICENSE
32 *
33 * Copyright(c) 2005 - 2008 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
857485c0
TW		 66/************************
67 * forward declarations *
68 ************************/
69struct iwl_host_cmd;
70struct iwl_cmd;
71
72
d16dc48a 73#define IWLWIFI_VERSION "1.3.27k"
df48c323 74#define DRV_COPYRIGHT "Copyright(c) 2003-2008 Intel Corporation"
a7b75207 75#define DRV_AUTHOR "<ilw@linux.intel.com>"
df48c323 76
82b9a121
TW		 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
3c424c28 86struct iwl_hcmd_ops {
7e8c519e 87 int (*rxon_assoc)(struct iwl_priv *priv);
3c424c28 88};
857485c0 89struct iwl_hcmd_utils_ops {
c1adf9fb 90 u16 (*get_hcmd_size)(u8 cmd_id, u16 len);
133636de 91 u16 (*build_addsta_hcmd)(const struct iwl_addsta_cmd *cmd, u8 *data);
f0832f13
EG		 92 void (*gain_computation)(struct iwl_priv *priv,
93 u32 *average_noise,
94 u16 min_average_noise_antennat_i,
95 u32 min_average_noise);
96 void (*chain_noise_reset)(struct iwl_priv *priv);
a326a5d0
EG		 97 void (*rts_tx_cmd_flag)(struct ieee80211_tx_info *info,
98 __le32 *tx_flags);
caab8f1a
TW		 99 int (*calc_rssi)(struct iwl_priv *priv,
100 struct iwl_rx_phy_res *rx_resp);
857485c0
TW		 101};
102
6bc913bd 103struct iwl_lib_ops {
a96a27f9 104 /* set hw dependent parameters */
5425e490 105 int (*set_hw_params)(struct iwl_priv *priv);
30e553e3 106 /* Handling TX */
e2a722eb 107 void (*txq_update_byte_cnt_tbl)(struct iwl_priv *priv,
16466903 108 struct iwl_tx_queue *txq,
e2a722eb 109 u16 byte_cnt);
972cf447
TW		 110 void (*txq_inval_byte_cnt_tbl)(struct iwl_priv *priv,
111 struct iwl_tx_queue *txq);
112 void (*txq_set_sched)(struct iwl_priv *priv, u32 mask);
30e553e3
TW		 113 /* aggregations */
114 int (*txq_agg_enable)(struct iwl_priv *priv, int txq_id, int tx_fifo,
115 int sta_id, int tid, u16 ssn_idx);
116 int (*txq_agg_disable)(struct iwl_priv *priv, u16 txq_id, u16 ssn_idx,
117 u8 tx_fifo);
d4789efe
EG		 118 /* setup Rx handler */
119 void (*rx_handler_setup)(struct iwl_priv *priv);
4e39317d
EG		 120 /* setup deferred work */
121 void (*setup_deferred_work)(struct iwl_priv *priv);
122 /* cancel deferred work */
123 void (*cancel_deferred_work)(struct iwl_priv *priv);
f3ccc08c
EG		 124 /* alive notification after init uCode load */
125 void (*init_alive_start)(struct iwl_priv *priv);
57aab75a
TW		 126 /* alive notification */
127 int (*alive_notify)(struct iwl_priv *priv);
128 /* check validity of rtc data address */
129 int (*is_valid_rtc_data_addr)(u32 addr);
130 /* 1st ucode load */
131 int (*load_ucode)(struct iwl_priv *priv);
91238714 132 /* power management */
6f4083aa 133 struct {
91238714 134 int (*init)(struct iwl_priv *priv);
7f066108 135 int (*reset)(struct iwl_priv *priv);
f118a91d 136 void (*stop)(struct iwl_priv *priv);
694cc56d 137 void (*config)(struct iwl_priv *priv);
6f4083aa
TW		 138 int (*set_pwr_src)(struct iwl_priv *priv, enum iwl_pwr_src src);
139 } apm_ops;
5da4b55f 140 /* power */
630fe9b6 141 int (*send_tx_power) (struct iwl_priv *priv);
5da4b55f 142 void (*update_chain_flags)(struct iwl_priv *priv);
5225640b 143 void (*temperature) (struct iwl_priv *priv);
6bc913bd
AK		 144 /* eeprom operations (as defined in iwl-eeprom.h) */
145 struct iwl_eeprom_ops eeprom_ops;
146};
147
148struct iwl_ops {
149 const struct iwl_lib_ops *lib;
3c424c28 150 const struct iwl_hcmd_ops *hcmd;
857485c0 151 const struct iwl_hcmd_utils_ops *utils;
6bc913bd
AK		 152};
153
00acbc91
AK		 154struct iwl_mod_params {
155 int disable; /* def: 0 = enable radio */
fcc76c6b 156 int sw_crypto; /* def: 0 = using hardware encryption */
95aa194a 157 u32 debug; /* def: 0 = minimal debug log messages */
00acbc91
AK		 158 int disable_hw_scan; /* def: 0 = use h/w scan */
159 int num_of_queues; /* def: HW dependent */
9f17b318 160 int num_of_ampdu_queues;/* def: HW dependent */
49779293 161 int disable_11n; /* def: 0 = disable 11n capabilities */
00acbc91
AK		 162 int amsdu_size_8K; /* def: 1 = enable 8K amsdu size */
163 int antenna; /* def: 0 = both antennas (use diversity) */
3a1081e8 164 int restart_fw; /* def: 1 = restart firmware */
00acbc91
AK		 165};
166
a0987a8d
RC		 167/**
168 * struct iwl_cfg
169 * @fw_name_pre: Firmware filename prefix. The api version and extension
170 * (.ucode) will be added to filename before loading from disk. The
171 * filename is constructed as fw_name_pre<api>.ucode.
172 * @ucode_api_max: Highest version of uCode API supported by driver.
173 * @ucode_api_min: Lowest version of uCode API supported by driver.
174 *
175 * We enable the driver to be backward compatible wrt API version. The
176 * driver specifies which APIs it supports (with @ucode_api_max being the
177 * highest and @ucode_api_min the lowest). Firmware will only be loaded if
178 * it has a supported API version. The firmware's API version will be
179 * stored in @iwl_priv, enabling the driver to make runtime changes based
180 * on firmware version used.
181 *
182 * For example,
183 * if (IWL_UCODE_API(priv->ucode_ver) >= 2) {
184 * Driver interacts with Firmware API version >= 2.
185 * } else {
186 * Driver interacts with Firmware API version 1.
187 * }
188 *
189 * The ideal usage of this infrastructure is to treat a new ucode API
190 * release as a new hardware revision. That is, through utilizing the
191 * iwl_hcmd_utils_ops etc. we accommodate different command structures
192 * and flows between hardware versions (4965/5000) as well as their API
193 * versions.
194 */
82b9a121
TW		 195struct iwl_cfg {
196 const char *name;
a0987a8d
RC		 197 const char *fw_name_pre;
198 const unsigned int ucode_api_max;
199 const unsigned int ucode_api_min;
82b9a121 200 unsigned int sku;
073d3f5f 201 int eeprom_size;
0ef2ca67
TW		 202 u16 eeprom_ver;
203 u16 eeprom_calib_ver;
6bc913bd 204 const struct iwl_ops *ops;
00acbc91 205 const struct iwl_mod_params *mod_params;
82b9a121
TW		 206};
207
1d0a082d
AK		 208/***************************
209 * L i b *
210 ***************************/
211
212struct ieee80211_hw *iwl_alloc_all(struct iwl_cfg *cfg,
213 struct ieee80211_ops *hw_ops);
b661c819 214void iwl_hw_detect(struct iwl_priv *priv);
c7de35cd
RR		 215void iwl_reset_qos(struct iwl_priv *priv);
216void iwl_set_rxon_chain(struct iwl_priv *priv);
17e72782 217int iwl_set_rxon_channel(struct iwl_priv *priv, struct ieee80211_channel *ch);
47c5196e
TW		 218void iwl_set_rxon_ht(struct iwl_priv *priv, struct iwl_ht_info *ht_info);
219u8 iwl_is_fat_tx_allowed(struct iwl_priv *priv,
d9fe60de 220 struct ieee80211_sta_ht_cap *sta_ht_inf);
1053d35f 221int iwl_hw_nic_init(struct iwl_priv *priv);
6ba87956 222int iwl_setup_mac(struct iwl_priv *priv);
da154e30 223int iwl_set_hw_params(struct iwl_priv *priv);
6ba87956
TW		 224int iwl_init_drv(struct iwl_priv *priv);
225void iwl_uninit_drv(struct iwl_priv *priv);
bf85ea4f 226
a55360e4
TW		 227/*****************************************************
228* RX
229******************************************************/
230void iwl_rx_queue_free(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
231int iwl_rx_queue_alloc(struct iwl_priv *priv);
232void iwl_rx_handle(struct iwl_priv *priv);
233int iwl_rx_queue_update_write_ptr(struct iwl_priv *priv,
234 struct iwl_rx_queue *q);
235void iwl_rx_queue_reset(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
236void iwl_rx_replenish(struct iwl_priv *priv);
1053d35f 237int iwl_rx_init(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
a55360e4
TW		 238int iwl_rx_queue_restock(struct iwl_priv *priv);
239int iwl_rx_queue_space(const struct iwl_rx_queue *q);
240void iwl_rx_allocate(struct iwl_priv *priv);
17b88929
TW		 241void iwl_tx_cmd_complete(struct iwl_priv *priv, struct iwl_rx_mem_buffer *rxb);
242int iwl_tx_queue_reclaim(struct iwl_priv *priv, int txq_id, int index);
c1354754
TW		 243/* Handlers */
244void iwl_rx_missed_beacon_notif(struct iwl_priv *priv,
245 struct iwl_rx_mem_buffer *rxb);
8f91aecb
EG		 246void iwl_rx_statistics(struct iwl_priv *priv,
247 struct iwl_rx_mem_buffer *rxb);
a55360e4 248
a332f8d6
TW		 249/* TX helpers */
250
1053d35f
RR		 251/*****************************************************
252* TX
253******************************************************/
254int iwl_txq_ctx_reset(struct iwl_priv *priv);
e039fa4a 255int iwl_tx_skb(struct iwl_priv *priv, struct sk_buff *skb);
1053d35f 256void iwl_hw_txq_ctx_free(struct iwl_priv *priv);
fd4abac5 257int iwl_txq_update_write_ptr(struct iwl_priv *priv, struct iwl_tx_queue *txq);
30e553e3
TW		 258int iwl_tx_agg_start(struct iwl_priv *priv, const u8 *ra, u16 tid, u16 *ssn);
259int iwl_tx_agg_stop(struct iwl_priv *priv , const u8 *ra, u16 tid);
260int iwl_txq_check_empty(struct iwl_priv *priv, int sta_id, u8 tid, int txq_id);
630fe9b6
TW		 261/*****************************************************
262 * TX power
263 ****************************************************/
264int iwl_set_tx_power(struct iwl_priv *priv, s8 tx_power, bool force);
265
14a08a7f
EG		 266/*****************************************************
267 * RF -Kill - here and not in iwl-rfkill.h to be available when
268 * RF-kill subsystem is not compiled.
269 ****************************************************/
a33c2f47 270void iwl_rf_kill(struct iwl_priv *priv);
14a08a7f
EG		 271void iwl_radio_kill_sw_disable_radio(struct iwl_priv *priv);
272int iwl_radio_kill_sw_enable_radio(struct iwl_priv *priv);
273
e7d326ac
TW		 274/*******************************************************************************
275 * Rate
276 ******************************************************************************/
277
278void iwl_hwrate_to_tx_control(struct iwl_priv *priv, u32 rate_n_flags,
279 struct ieee80211_tx_info *info);
280int iwl_hwrate_to_plcp_idx(u32 rate_n_flags);
281
76eff18b
TW		 282u8 iwl_toggle_tx_ant(struct iwl_priv *priv, u8 ant_idx);
283
284static inline u32 iwl_ant_idx_to_flags(u8 ant_idx)
285{
286 return BIT(ant_idx) << RATE_MCS_ANT_POS;
287}
288
e7d326ac
TW		 289static inline u8 iwl_hw_get_rate(__le32 rate_n_flags)
290{
291 return le32_to_cpu(rate_n_flags) & 0xFF;
292}
293static inline u32 iwl_hw_get_rate_n_flags(__le32 rate_n_flags)
294{
295 return le32_to_cpu(rate_n_flags) & 0x1FFFF;
296}
297static inline __le32 iwl_hw_set_rate_n_flags(u8 rate, u32 flags)
298{
299 return cpu_to_le32(flags|(u32)rate);
300}
301
2a421b91
TW		 302/*******************************************************************************
303 * Scanning
304 ******************************************************************************/
f53696de 305void iwl_init_scan_params(struct iwl_priv *priv);
2a421b91
TW		 306int iwl_scan_cancel(struct iwl_priv *priv);
307int iwl_scan_cancel_timeout(struct iwl_priv *priv, unsigned long ms);
2a421b91
TW		 308int iwl_scan_initiate(struct iwl_priv *priv);
309void iwl_setup_rx_scan_handlers(struct iwl_priv *priv);
310void iwl_setup_scan_deferred_work(struct iwl_priv *priv);
311
6e21f2c1
TW		 312/*******************************************************************************
313 * Calibrations - implemented in iwl-calib.c
314 ******************************************************************************/
315int iwl_send_calib_results(struct iwl_priv *priv);
316int iwl_calib_set(struct iwl_calib_result *res, const u8 *buf, int len);
317void iwl_calib_free_results(struct iwl_priv *priv);
318
21c339bf
TW		 319/*******************************************************************************
320 * Spectrum Measureemtns in iwl-spectrum.c
321 ******************************************************************************/
322#ifdef CONFIG_IWLAGN_SPECTRUM_MEASUREMENT
323void iwl_setup_spectrum_handlers(struct iwl_priv *priv);
324#else
325static inline void iwl_setup_spectrum_handlers(struct iwl_priv *priv) {}
326#endif
857485c0
TW		 327/*****************************************************
328 * S e n d i n g H o s t C o m m a n d s *
329 *****************************************************/
330
331const char *get_cmd_string(u8 cmd);
e5472978
TW		 332int __must_check iwl_send_cmd_sync(struct iwl_priv *priv,
333 struct iwl_host_cmd *cmd);
857485c0 334int iwl_send_cmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
e5472978
TW		 335int __must_check iwl_send_cmd_pdu(struct iwl_priv *priv, u8 id,
336 u16 len, const void *data);
857485c0
TW		 337int iwl_send_cmd_pdu_async(struct iwl_priv *priv, u8 id, u16 len,
338 const void *data,
339 int (*callback)(struct iwl_priv *priv,
340 struct iwl_cmd *cmd,
341 struct sk_buff *skb));
fd4abac5
TW		 342
343int iwl_enqueue_hcmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
189a2b59 344
0ad91a35
WT		 345/*****************************************************
346 * PCI *
347 *****************************************************/
348void iwl_disable_interrupts(struct iwl_priv *priv);
349void iwl_enable_interrupts(struct iwl_priv *priv);
350
189a2b59
EK		 351/*****************************************************
352* Error Handling Debugging
353******************************************************/
ede0cba4 354void iwl_dump_nic_error_log(struct iwl_priv *priv);
189a2b59
EK		 355void iwl_dump_nic_event_log(struct iwl_priv *priv);
356
76eff18b 357
fee1247a
TW		 358/*************** DRIVER STATUS FUNCTIONS *****/
359
360#define STATUS_HCMD_ACTIVE 0 /* host command in progress */
361#define STATUS_HCMD_SYNC_ACTIVE 1 /* sync host command in progress */
362#define STATUS_INT_ENABLED 2
363#define STATUS_RF_KILL_HW 3
364#define STATUS_RF_KILL_SW 4
365#define STATUS_INIT 5
366#define STATUS_ALIVE 6
367#define STATUS_READY 7
368#define STATUS_TEMPERATURE 8
369#define STATUS_GEO_CONFIGURED 9
370#define STATUS_EXIT_PENDING 10
371#define STATUS_IN_SUSPEND 11
372#define STATUS_STATISTICS 12
373#define STATUS_SCANNING 13
374#define STATUS_SCAN_ABORTING 14
375#define STATUS_SCAN_HW 15
376#define STATUS_POWER_PMI 16
377#define STATUS_FW_ERROR 17
eedda367 378#define STATUS_MODE_PENDING 18
fee1247a
TW		 379
380
381static inline int iwl_is_ready(struct iwl_priv *priv)
382{
383 /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
384 * set but EXIT_PENDING is not */
385 return test_bit(STATUS_READY, &priv->status) &&
386 test_bit(STATUS_GEO_CONFIGURED, &priv->status) &&
387 !test_bit(STATUS_EXIT_PENDING, &priv->status);
388}
389
390static inline int iwl_is_alive(struct iwl_priv *priv)
391{
392 return test_bit(STATUS_ALIVE, &priv->status);
393}
394
395static inline int iwl_is_init(struct iwl_priv *priv)
396{
397 return test_bit(STATUS_INIT, &priv->status);
398}
399
80fcc9e2
AG		 400static inline int iwl_is_rfkill_sw(struct iwl_priv *priv)
401{
402 return test_bit(STATUS_RF_KILL_SW, &priv->status);
403}
404
405static inline int iwl_is_rfkill_hw(struct iwl_priv *priv)
406{
407 return test_bit(STATUS_RF_KILL_HW, &priv->status);
408}
409
fee1247a
TW		 410static inline int iwl_is_rfkill(struct iwl_priv *priv)
411{
80fcc9e2 412 return iwl_is_rfkill_hw(priv) || iwl_is_rfkill_sw(priv);
fee1247a
TW		 413}
414
415static inline int iwl_is_ready_rf(struct iwl_priv *priv)
416{
417
418 if (iwl_is_rfkill(priv))
419 return 0;
420
421 return iwl_is_ready(priv);
422}
423
14a08a7f 424extern void iwl_rf_kill_ct_config(struct iwl_priv *priv);
49ea8596 425extern int iwl_send_statistics_request(struct iwl_priv *priv, u8 flags);
b0692f2f 426extern int iwl_verify_ucode(struct iwl_priv *priv);
14a08a7f 427extern int iwl_send_lq_cmd(struct iwl_priv *priv,
1781a07f
EG		 428 struct iwl_link_quality_cmd *lq, u8 flags);
429extern void iwl_rx_reply_rx(struct iwl_priv *priv,
430 struct iwl_rx_mem_buffer *rxb);
431extern void iwl_rx_reply_rx_phy(struct iwl_priv *priv,
432 struct iwl_rx_mem_buffer *rxb);
653fa4a0
EG		 433void iwl_rx_reply_compressed_ba(struct iwl_priv *priv,
434 struct iwl_rx_mem_buffer *rxb);
7e8c519e
TW		 435
436static inline int iwl_send_rxon_assoc(struct iwl_priv *priv)
437{
438 return priv->cfg->ops->hcmd->rxon_assoc(priv);
439}
440
3c57601d
RR		 441static inline const struct ieee80211_supported_band *iwl_get_hw_mode(
442 struct iwl_priv *priv, enum ieee80211_band band)
443{
444 return priv->hw->wiphy->bands[band];
445}
446
82b9a121 447#endif /* __iwl_core_h__ */
Linux 6.x block layer and io_uring tree(s)