iwlwifi: handle shared memory Rx index access
[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
TW
88struct iwl_hcmd_utils_ops {
89 int (*enqueue_hcmd)(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
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
TW
107 void (*txq_update_byte_cnt_tbl)(struct iwl_priv *priv,
108 struct iwl4965_tx_queue *txq,
109 u16 byte_cnt);
d4789efe
EG
110 /* setup Rx handler */
111 void (*rx_handler_setup)(struct iwl_priv *priv);
5a676bbe
RR
112 /* nic Tx fifo handling */
113 int (*disable_tx_fifo)(struct iwl_priv *priv);
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);
694cc56d 127 void (*config)(struct iwl_priv *priv);
6f4083aa
TW
128 int (*set_pwr_src)(struct iwl_priv *priv, enum iwl_pwr_src src);
129 } apm_ops;
5da4b55f
MA
130 /* power */
131 int (*set_power)(struct iwl_priv *priv, void *cmd);
132 void (*update_chain_flags)(struct iwl_priv *priv);
6bc913bd
AK
133 /* eeprom operations (as defined in iwl-eeprom.h) */
134 struct iwl_eeprom_ops eeprom_ops;
135};
136
137struct iwl_ops {
138 const struct iwl_lib_ops *lib;
3c424c28 139 const struct iwl_hcmd_ops *hcmd;
857485c0 140 const struct iwl_hcmd_utils_ops *utils;
6bc913bd
AK
141};
142
00acbc91
AK
143struct iwl_mod_params {
144 int disable; /* def: 0 = enable radio */
fcc76c6b 145 int sw_crypto; /* def: 0 = using hardware encryption */
00acbc91
AK
146 int debug; /* def: 0 = minimal debug log messages */
147 int disable_hw_scan; /* def: 0 = use h/w scan */
148 int num_of_queues; /* def: HW dependent */
149 int enable_qos; /* def: 1 = use quality of service */
150 int amsdu_size_8K; /* def: 1 = enable 8K amsdu size */
151 int antenna; /* def: 0 = both antennas (use diversity) */
152};
153
82b9a121
TW
154struct iwl_cfg {
155 const char *name;
156 const char *fw_name;
157 unsigned int sku;
073d3f5f 158 int eeprom_size;
6bc913bd 159 const struct iwl_ops *ops;
00acbc91 160 const struct iwl_mod_params *mod_params;
82b9a121
TW
161};
162
1d0a082d
AK
163/***************************
164 * L i b *
165 ***************************/
166
167struct ieee80211_hw *iwl_alloc_all(struct iwl_cfg *cfg,
168 struct ieee80211_ops *hw_ops);
b661c819 169void iwl_hw_detect(struct iwl_priv *priv);
1d0a082d 170
bf85ea4f 171void iwlcore_clear_stations_table(struct iwl_priv *priv);
c7de35cd
RR
172void iwl_reset_qos(struct iwl_priv *priv);
173void iwl_set_rxon_chain(struct iwl_priv *priv);
174int iwl_set_rxon_channel(struct iwl_priv *priv,
bf85ea4f
AK
175 enum ieee80211_band band,
176 u16 channel);
c7de35cd 177void iwlcore_free_geos(struct iwl_priv *priv);
bf85ea4f 178int iwl_setup(struct iwl_priv *priv);
47c5196e
TW
179void iwl_set_rxon_ht(struct iwl_priv *priv, struct iwl_ht_info *ht_info);
180u8 iwl_is_fat_tx_allowed(struct iwl_priv *priv,
181 struct ieee80211_ht_info *sta_ht_inf);
1053d35f
RR
182int iwl_hw_nic_init(struct iwl_priv *priv);
183
184/* "keep warm" functions */
185int iwl_kw_init(struct iwl_priv *priv);
186int iwl_kw_alloc(struct iwl_priv *priv);
187void iwl_kw_free(struct iwl_priv *priv);
bf85ea4f 188
a55360e4
TW
189/*****************************************************
190* RX
191******************************************************/
192void iwl_rx_queue_free(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
193int iwl_rx_queue_alloc(struct iwl_priv *priv);
194void iwl_rx_handle(struct iwl_priv *priv);
195int iwl_rx_queue_update_write_ptr(struct iwl_priv *priv,
196 struct iwl_rx_queue *q);
197void iwl_rx_queue_reset(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
198void iwl_rx_replenish(struct iwl_priv *priv);
1053d35f 199int iwl_rx_init(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
a55360e4
TW
200/* FIXME: remove when TX is moved to iwl core */
201int iwl_rx_queue_restock(struct iwl_priv *priv);
202int iwl_rx_queue_space(const struct iwl_rx_queue *q);
203void iwl_rx_allocate(struct iwl_priv *priv);
204
1053d35f
RR
205/*****************************************************
206* TX
207******************************************************/
208int iwl_txq_ctx_reset(struct iwl_priv *priv);
209/* FIXME: remove when free Tx is fully merged into iwlcore */
210int iwl_hw_txq_free_tfd(struct iwl_priv *priv, struct iwl4965_tx_queue *txq);
211void iwl_hw_txq_ctx_free(struct iwl_priv *priv);
212
857485c0
TW
213/*****************************************************
214 * S e n d i n g H o s t C o m m a n d s *
215 *****************************************************/
216
217const char *get_cmd_string(u8 cmd);
e5472978
TW
218int __must_check iwl_send_cmd_sync(struct iwl_priv *priv,
219 struct iwl_host_cmd *cmd);
857485c0 220int iwl_send_cmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
e5472978
TW
221int __must_check iwl_send_cmd_pdu(struct iwl_priv *priv, u8 id,
222 u16 len, const void *data);
857485c0
TW
223int iwl_send_cmd_pdu_async(struct iwl_priv *priv, u8 id, u16 len,
224 const void *data,
225 int (*callback)(struct iwl_priv *priv,
226 struct iwl_cmd *cmd,
227 struct sk_buff *skb));
fee1247a
TW
228/*************** DRIVER STATUS FUNCTIONS *****/
229
230#define STATUS_HCMD_ACTIVE 0 /* host command in progress */
231#define STATUS_HCMD_SYNC_ACTIVE 1 /* sync host command in progress */
232#define STATUS_INT_ENABLED 2
233#define STATUS_RF_KILL_HW 3
234#define STATUS_RF_KILL_SW 4
235#define STATUS_INIT 5
236#define STATUS_ALIVE 6
237#define STATUS_READY 7
238#define STATUS_TEMPERATURE 8
239#define STATUS_GEO_CONFIGURED 9
240#define STATUS_EXIT_PENDING 10
241#define STATUS_IN_SUSPEND 11
242#define STATUS_STATISTICS 12
243#define STATUS_SCANNING 13
244#define STATUS_SCAN_ABORTING 14
245#define STATUS_SCAN_HW 15
246#define STATUS_POWER_PMI 16
247#define STATUS_FW_ERROR 17
248#define STATUS_CONF_PENDING 18
249
250
251static inline int iwl_is_ready(struct iwl_priv *priv)
252{
253 /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
254 * set but EXIT_PENDING is not */
255 return test_bit(STATUS_READY, &priv->status) &&
256 test_bit(STATUS_GEO_CONFIGURED, &priv->status) &&
257 !test_bit(STATUS_EXIT_PENDING, &priv->status);
258}
259
260static inline int iwl_is_alive(struct iwl_priv *priv)
261{
262 return test_bit(STATUS_ALIVE, &priv->status);
263}
264
265static inline int iwl_is_init(struct iwl_priv *priv)
266{
267 return test_bit(STATUS_INIT, &priv->status);
268}
269
270static inline int iwl_is_rfkill(struct iwl_priv *priv)
271{
272 return test_bit(STATUS_RF_KILL_HW, &priv->status) ||
273 test_bit(STATUS_RF_KILL_SW, &priv->status);
274}
275
276static inline int iwl_is_ready_rf(struct iwl_priv *priv)
277{
278
279 if (iwl_is_rfkill(priv))
280 return 0;
281
282 return iwl_is_ready(priv);
283}
284
857485c0 285
c8381fdc
MA
286enum iwlcore_card_notify {
287 IWLCORE_INIT_EVT = 0,
288 IWLCORE_START_EVT = 1,
289 IWLCORE_STOP_EVT = 2,
290 IWLCORE_REMOVE_EVT = 3,
291};
292
293int iwlcore_low_level_notify(struct iwl_priv *priv,
294 enum iwlcore_card_notify notify);
49ea8596 295extern int iwl_send_statistics_request(struct iwl_priv *priv, u8 flags);
b0692f2f 296extern int iwl_verify_ucode(struct iwl_priv *priv);
66c73db7
TW
297int iwl_send_lq_cmd(struct iwl_priv *priv,
298 struct iwl_link_quality_cmd *lq, u8 flags);
7e8c519e
TW
299
300static inline int iwl_send_rxon_assoc(struct iwl_priv *priv)
301{
302 return priv->cfg->ops->hcmd->rxon_assoc(priv);
303}
304
a55360e4 305
82b9a121 306#endif /* __iwl_core_h__ */