iwlwifi: move tx reclaim flow into iwl-tx
[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:
28 * Tomas Winkler <tomas.winkler@intel.com>
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
df48c323
TW
73#define IWLWIFI_VERSION "1.2.26k"
74#define DRV_COPYRIGHT "Copyright(c) 2003-2008 Intel Corporation"
75
82b9a121
TW
76#define IWL_PCI_DEVICE(dev, subdev, cfg) \
77 .vendor = PCI_VENDOR_ID_INTEL, .device = (dev), \
78 .subvendor = PCI_ANY_ID, .subdevice = (subdev), \
79 .driver_data = (kernel_ulong_t)&(cfg)
80
81#define IWL_SKU_G 0x1
82#define IWL_SKU_A 0x2
83#define IWL_SKU_N 0x8
84
3c424c28 85struct iwl_hcmd_ops {
7e8c519e 86 int (*rxon_assoc)(struct iwl_priv *priv);
3c424c28 87};
857485c0 88struct iwl_hcmd_utils_ops {
c1adf9fb 89 u16 (*get_hcmd_size)(u8 cmd_id, u16 len);
133636de 90 u16 (*build_addsta_hcmd)(const struct iwl_addsta_cmd *cmd, u8 *data);
f0832f13
EG
91#ifdef CONFIG_IWLWIFI_RUN_TIME_CALIB
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);
97#endif
857485c0
TW
98};
99
6bc913bd 100struct iwl_lib_ops {
5425e490
TW
101 /* set hw dependant perameters */
102 int (*set_hw_params)(struct iwl_priv *priv);
399f4900
RR
103 /* ucode shared memory */
104 int (*alloc_shared_mem)(struct iwl_priv *priv);
105 void (*free_shared_mem)(struct iwl_priv *priv);
d67f5489 106 int (*shared_mem_rx_idx)(struct iwl_priv *priv);
e2a722eb 107 void (*txq_update_byte_cnt_tbl)(struct iwl_priv *priv,
16466903 108 struct iwl_tx_queue *txq,
e2a722eb 109 u16 byte_cnt);
d4789efe
EG
110 /* setup Rx handler */
111 void (*rx_handler_setup)(struct iwl_priv *priv);
5a676bbe 112 /* nic Tx fifo handling */
da1bc453 113 void (*txq_set_sched)(struct iwl_priv *priv, u32 mask);
f3ccc08c
EG
114 /* alive notification after init uCode load */
115 void (*init_alive_start)(struct iwl_priv *priv);
57aab75a
TW
116 /* alive notification */
117 int (*alive_notify)(struct iwl_priv *priv);
118 /* check validity of rtc data address */
119 int (*is_valid_rtc_data_addr)(u32 addr);
120 /* 1st ucode load */
121 int (*load_ucode)(struct iwl_priv *priv);
122 /* rfkill */
123 void (*radio_kill_sw)(struct iwl_priv *priv, int disable_radio);
91238714 124 /* power management */
6f4083aa 125 struct {
91238714 126 int (*init)(struct iwl_priv *priv);
7f066108 127 int (*reset)(struct iwl_priv *priv);
f118a91d 128 void (*stop)(struct iwl_priv *priv);
694cc56d 129 void (*config)(struct iwl_priv *priv);
6f4083aa
TW
130 int (*set_pwr_src)(struct iwl_priv *priv, enum iwl_pwr_src src);
131 } apm_ops;
5da4b55f
MA
132 /* power */
133 int (*set_power)(struct iwl_priv *priv, void *cmd);
134 void (*update_chain_flags)(struct iwl_priv *priv);
6bc913bd
AK
135 /* eeprom operations (as defined in iwl-eeprom.h) */
136 struct iwl_eeprom_ops eeprom_ops;
137};
138
139struct iwl_ops {
140 const struct iwl_lib_ops *lib;
3c424c28 141 const struct iwl_hcmd_ops *hcmd;
857485c0 142 const struct iwl_hcmd_utils_ops *utils;
6bc913bd
AK
143};
144
00acbc91
AK
145struct iwl_mod_params {
146 int disable; /* def: 0 = enable radio */
fcc76c6b 147 int sw_crypto; /* def: 0 = using hardware encryption */
00acbc91
AK
148 int debug; /* def: 0 = minimal debug log messages */
149 int disable_hw_scan; /* def: 0 = use h/w scan */
150 int num_of_queues; /* def: HW dependent */
151 int enable_qos; /* def: 1 = use quality of service */
152 int amsdu_size_8K; /* def: 1 = enable 8K amsdu size */
153 int antenna; /* def: 0 = both antennas (use diversity) */
3a1081e8 154 int restart_fw; /* def: 1 = restart firmware */
00acbc91
AK
155};
156
82b9a121
TW
157struct iwl_cfg {
158 const char *name;
159 const char *fw_name;
160 unsigned int sku;
073d3f5f 161 int eeprom_size;
6bc913bd 162 const struct iwl_ops *ops;
00acbc91 163 const struct iwl_mod_params *mod_params;
82b9a121
TW
164};
165
1d0a082d
AK
166/***************************
167 * L i b *
168 ***************************/
169
170struct ieee80211_hw *iwl_alloc_all(struct iwl_cfg *cfg,
171 struct ieee80211_ops *hw_ops);
b661c819 172void iwl_hw_detect(struct iwl_priv *priv);
1d0a082d 173
bf85ea4f 174void iwlcore_clear_stations_table(struct iwl_priv *priv);
7c616cba 175void iwl_free_calib_results(struct iwl_priv *priv);
c7de35cd
RR
176void iwl_reset_qos(struct iwl_priv *priv);
177void iwl_set_rxon_chain(struct iwl_priv *priv);
178int iwl_set_rxon_channel(struct iwl_priv *priv,
bf85ea4f
AK
179 enum ieee80211_band band,
180 u16 channel);
47c5196e
TW
181void iwl_set_rxon_ht(struct iwl_priv *priv, struct iwl_ht_info *ht_info);
182u8 iwl_is_fat_tx_allowed(struct iwl_priv *priv,
183 struct ieee80211_ht_info *sta_ht_inf);
1053d35f 184int iwl_hw_nic_init(struct iwl_priv *priv);
6ba87956
TW
185int iwl_setup_mac(struct iwl_priv *priv);
186int iwl_init_drv(struct iwl_priv *priv);
187void iwl_uninit_drv(struct iwl_priv *priv);
1053d35f
RR
188/* "keep warm" functions */
189int iwl_kw_init(struct iwl_priv *priv);
190int iwl_kw_alloc(struct iwl_priv *priv);
191void iwl_kw_free(struct iwl_priv *priv);
bf85ea4f 192
a55360e4
TW
193/*****************************************************
194* RX
195******************************************************/
196void iwl_rx_queue_free(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
197int iwl_rx_queue_alloc(struct iwl_priv *priv);
198void iwl_rx_handle(struct iwl_priv *priv);
199int iwl_rx_queue_update_write_ptr(struct iwl_priv *priv,
200 struct iwl_rx_queue *q);
201void iwl_rx_queue_reset(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
202void iwl_rx_replenish(struct iwl_priv *priv);
1053d35f 203int iwl_rx_init(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
a55360e4
TW
204/* FIXME: remove when TX is moved to iwl core */
205int iwl_rx_queue_restock(struct iwl_priv *priv);
206int iwl_rx_queue_space(const struct iwl_rx_queue *q);
207void iwl_rx_allocate(struct iwl_priv *priv);
17b88929
TW
208void iwl_tx_cmd_complete(struct iwl_priv *priv, struct iwl_rx_mem_buffer *rxb);
209int iwl_tx_queue_reclaim(struct iwl_priv *priv, int txq_id, int index);
c1354754
TW
210/* Handlers */
211void iwl_rx_missed_beacon_notif(struct iwl_priv *priv,
212 struct iwl_rx_mem_buffer *rxb);
a55360e4 213
a332f8d6
TW
214/* TX helpers */
215
1053d35f
RR
216/*****************************************************
217* TX
218******************************************************/
219int iwl_txq_ctx_reset(struct iwl_priv *priv);
e039fa4a 220int iwl_tx_skb(struct iwl_priv *priv, struct sk_buff *skb);
1053d35f 221/* FIXME: remove when free Tx is fully merged into iwlcore */
16466903 222int iwl_hw_txq_free_tfd(struct iwl_priv *priv, struct iwl_tx_queue *txq);
1053d35f 223void iwl_hw_txq_ctx_free(struct iwl_priv *priv);
fd4abac5
TW
224int iwl_hw_txq_attach_buf_to_tfd(struct iwl_priv *priv, void *tfd,
225 dma_addr_t addr, u16 len);
226int iwl_txq_update_write_ptr(struct iwl_priv *priv, struct iwl_tx_queue *txq);
a332f8d6 227
857485c0
TW
228/*****************************************************
229 * S e n d i n g H o s t C o m m a n d s *
230 *****************************************************/
231
232const char *get_cmd_string(u8 cmd);
e5472978
TW
233int __must_check iwl_send_cmd_sync(struct iwl_priv *priv,
234 struct iwl_host_cmd *cmd);
857485c0 235int iwl_send_cmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
e5472978
TW
236int __must_check iwl_send_cmd_pdu(struct iwl_priv *priv, u8 id,
237 u16 len, const void *data);
857485c0
TW
238int iwl_send_cmd_pdu_async(struct iwl_priv *priv, u8 id, u16 len,
239 const void *data,
240 int (*callback)(struct iwl_priv *priv,
241 struct iwl_cmd *cmd,
242 struct sk_buff *skb));
fd4abac5
TW
243
244int iwl_enqueue_hcmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
189a2b59
EK
245
246/*****************************************************
247* Error Handling Debugging
248******************************************************/
249void iwl_print_event_log(struct iwl_priv *priv, u32 start_idx,
250 u32 num_events, u32 mode);
ede0cba4 251void iwl_dump_nic_error_log(struct iwl_priv *priv);
189a2b59
EK
252void iwl_dump_nic_event_log(struct iwl_priv *priv);
253
fee1247a
TW
254/*************** DRIVER STATUS FUNCTIONS *****/
255
256#define STATUS_HCMD_ACTIVE 0 /* host command in progress */
257#define STATUS_HCMD_SYNC_ACTIVE 1 /* sync host command in progress */
258#define STATUS_INT_ENABLED 2
259#define STATUS_RF_KILL_HW 3
260#define STATUS_RF_KILL_SW 4
261#define STATUS_INIT 5
262#define STATUS_ALIVE 6
263#define STATUS_READY 7
264#define STATUS_TEMPERATURE 8
265#define STATUS_GEO_CONFIGURED 9
266#define STATUS_EXIT_PENDING 10
267#define STATUS_IN_SUSPEND 11
268#define STATUS_STATISTICS 12
269#define STATUS_SCANNING 13
270#define STATUS_SCAN_ABORTING 14
271#define STATUS_SCAN_HW 15
272#define STATUS_POWER_PMI 16
273#define STATUS_FW_ERROR 17
274#define STATUS_CONF_PENDING 18
275
276
277static inline int iwl_is_ready(struct iwl_priv *priv)
278{
279 /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
280 * set but EXIT_PENDING is not */
281 return test_bit(STATUS_READY, &priv->status) &&
282 test_bit(STATUS_GEO_CONFIGURED, &priv->status) &&
283 !test_bit(STATUS_EXIT_PENDING, &priv->status);
284}
285
286static inline int iwl_is_alive(struct iwl_priv *priv)
287{
288 return test_bit(STATUS_ALIVE, &priv->status);
289}
290
291static inline int iwl_is_init(struct iwl_priv *priv)
292{
293 return test_bit(STATUS_INIT, &priv->status);
294}
295
296static inline int iwl_is_rfkill(struct iwl_priv *priv)
297{
298 return test_bit(STATUS_RF_KILL_HW, &priv->status) ||
299 test_bit(STATUS_RF_KILL_SW, &priv->status);
300}
301
302static inline int iwl_is_ready_rf(struct iwl_priv *priv)
303{
304
305 if (iwl_is_rfkill(priv))
306 return 0;
307
308 return iwl_is_ready(priv);
309}
310
857485c0 311
c8381fdc
MA
312enum iwlcore_card_notify {
313 IWLCORE_INIT_EVT = 0,
314 IWLCORE_START_EVT = 1,
315 IWLCORE_STOP_EVT = 2,
316 IWLCORE_REMOVE_EVT = 3,
317};
318
319int iwlcore_low_level_notify(struct iwl_priv *priv,
320 enum iwlcore_card_notify notify);
49ea8596 321extern int iwl_send_statistics_request(struct iwl_priv *priv, u8 flags);
b0692f2f 322extern int iwl_verify_ucode(struct iwl_priv *priv);
66c73db7
TW
323int iwl_send_lq_cmd(struct iwl_priv *priv,
324 struct iwl_link_quality_cmd *lq, u8 flags);
7e8c519e
TW
325
326static inline int iwl_send_rxon_assoc(struct iwl_priv *priv)
327{
328 return priv->cfg->ops->hcmd->rxon_assoc(priv);
329}
330
82b9a121 331#endif /* __iwl_core_h__ */