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