c29f8b3471298dd52eb7036efe20b6eeacfde725
[linux-2.6.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 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
66 /************************
67  * forward declarations *
68  ************************/
69 struct iwl_host_cmd;
70 struct iwl_cmd;
71
72
73 #define IWLWIFI_VERSION "1.2.26k"
74 #define DRV_COPYRIGHT   "Copyright(c) 2003-2008 Intel Corporation"
75
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
85 struct iwl_hcmd_ops {
86         int (*rxon_assoc)(struct iwl_priv *priv);
87 };
88 struct iwl_hcmd_utils_ops {
89         int (*enqueue_hcmd)(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
90         u16 (*build_addsta_hcmd)(const struct iwl_addsta_cmd *cmd, u8 *data);
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
98 };
99
100 struct iwl_lib_ops {
101         /* set hw dependant perameters */
102         int (*set_hw_params)(struct iwl_priv *priv);
103         /* ucode shared memory */
104         int (*alloc_shared_mem)(struct iwl_priv *priv);
105         void (*free_shared_mem)(struct iwl_priv *priv);
106         void (*txq_update_byte_cnt_tbl)(struct iwl_priv *priv,
107                                         struct iwl4965_tx_queue *txq,
108                                         u16 byte_cnt);
109         /* setup Rx handler */
110         void (*rx_handler_setup)(struct iwl_priv *priv);
111         /* nic init */
112         int (*hw_nic_init)(struct iwl_priv *priv);
113         /* nic Tx fifo handling */
114         int (*disable_tx_fifo)(struct iwl_priv *priv);
115         /* alive notification */
116         int (*alive_notify)(struct iwl_priv *priv);
117         /* check validity of rtc data address */
118         int (*is_valid_rtc_data_addr)(u32 addr);
119         /* 1st ucode load */
120         int (*load_ucode)(struct iwl_priv *priv);
121         /* rfkill */
122         void (*radio_kill_sw)(struct iwl_priv *priv, int disable_radio);
123          /* power management */
124         struct {
125                 int (*init)(struct iwl_priv *priv);
126                 void (*config)(struct iwl_priv *priv);
127                 int (*set_pwr_src)(struct iwl_priv *priv, enum iwl_pwr_src src);
128         } apm_ops;
129         /* power */
130         int (*set_power)(struct iwl_priv *priv, void *cmd);
131         void (*update_chain_flags)(struct iwl_priv *priv);
132         /* eeprom operations (as defined in iwl-eeprom.h) */
133         struct iwl_eeprom_ops eeprom_ops;
134 };
135
136 struct iwl_ops {
137         const struct iwl_lib_ops *lib;
138         const struct iwl_hcmd_ops *hcmd;
139         const struct iwl_hcmd_utils_ops *utils;
140 };
141
142 struct iwl_mod_params {
143         int disable;            /* def: 0 = enable radio */
144         int sw_crypto;          /* def: 0 = using hardware encryption */
145         int debug;              /* def: 0 = minimal debug log messages */
146         int disable_hw_scan;    /* def: 0 = use h/w scan */
147         int num_of_queues;      /* def: HW dependent */
148         int enable_qos;         /* def: 1 = use quality of service */
149         int amsdu_size_8K;      /* def: 1 = enable 8K amsdu size */
150         int antenna;            /* def: 0 = both antennas (use diversity) */
151 };
152
153 struct iwl_cfg {
154         const char *name;
155         const char *fw_name;
156         unsigned int sku;
157         int eeprom_size;
158         const struct iwl_ops *ops;
159         const struct iwl_mod_params *mod_params;
160 };
161
162 /***************************
163  *   L i b                 *
164  ***************************/
165
166 struct ieee80211_hw *iwl_alloc_all(struct iwl_cfg *cfg,
167                 struct ieee80211_ops *hw_ops);
168 void iwl_hw_detect(struct iwl_priv *priv);
169
170 void iwlcore_clear_stations_table(struct iwl_priv *priv);
171 void iwl_reset_qos(struct iwl_priv *priv);
172 void iwl_set_rxon_chain(struct iwl_priv *priv);
173 int iwl_set_rxon_channel(struct iwl_priv *priv,
174                                 enum ieee80211_band band,
175                                 u16 channel);
176 void iwlcore_free_geos(struct iwl_priv *priv);
177 int iwl_setup(struct iwl_priv *priv);
178 void iwl_set_rxon_ht(struct iwl_priv *priv, struct iwl_ht_info *ht_info);
179 u8 iwl_is_fat_tx_allowed(struct iwl_priv *priv,
180                          struct ieee80211_ht_info *sta_ht_inf);
181
182 /*****************************************************
183 * RX
184 ******************************************************/
185 void iwl_rx_queue_free(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
186 int iwl_rx_queue_alloc(struct iwl_priv *priv);
187 void iwl_rx_handle(struct iwl_priv *priv);
188 int iwl_rx_queue_update_write_ptr(struct iwl_priv *priv,
189                                   struct iwl_rx_queue *q);
190 void iwl_rx_queue_reset(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
191 void iwl_rx_replenish(struct iwl_priv *priv);
192 /* FIXME: remove when TX is moved to iwl core */
193 int iwl_rx_queue_restock(struct iwl_priv *priv);
194 int iwl_rx_queue_space(const struct iwl_rx_queue *q);
195 void iwl_rx_allocate(struct iwl_priv *priv);
196
197 /*****************************************************
198  *   S e n d i n g     H o s t     C o m m a n d s   *
199  *****************************************************/
200
201 const char *get_cmd_string(u8 cmd);
202 int __must_check iwl_send_cmd_sync(struct iwl_priv *priv,
203                                    struct iwl_host_cmd *cmd);
204 int iwl_send_cmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
205 int __must_check iwl_send_cmd_pdu(struct iwl_priv *priv, u8 id,
206                                   u16 len, const void *data);
207 int iwl_send_cmd_pdu_async(struct iwl_priv *priv, u8 id, u16 len,
208                            const void *data,
209                            int (*callback)(struct iwl_priv *priv,
210                                            struct iwl_cmd *cmd,
211                                            struct sk_buff *skb));
212 /*************** DRIVER STATUS FUNCTIONS   *****/
213
214 #define STATUS_HCMD_ACTIVE      0       /* host command in progress */
215 #define STATUS_HCMD_SYNC_ACTIVE 1       /* sync host command in progress */
216 #define STATUS_INT_ENABLED      2
217 #define STATUS_RF_KILL_HW       3
218 #define STATUS_RF_KILL_SW       4
219 #define STATUS_INIT             5
220 #define STATUS_ALIVE            6
221 #define STATUS_READY            7
222 #define STATUS_TEMPERATURE      8
223 #define STATUS_GEO_CONFIGURED   9
224 #define STATUS_EXIT_PENDING     10
225 #define STATUS_IN_SUSPEND       11
226 #define STATUS_STATISTICS       12
227 #define STATUS_SCANNING         13
228 #define STATUS_SCAN_ABORTING    14
229 #define STATUS_SCAN_HW          15
230 #define STATUS_POWER_PMI        16
231 #define STATUS_FW_ERROR         17
232 #define STATUS_CONF_PENDING     18
233
234
235 static inline int iwl_is_ready(struct iwl_priv *priv)
236 {
237         /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
238          * set but EXIT_PENDING is not */
239         return test_bit(STATUS_READY, &priv->status) &&
240                test_bit(STATUS_GEO_CONFIGURED, &priv->status) &&
241                !test_bit(STATUS_EXIT_PENDING, &priv->status);
242 }
243
244 static inline int iwl_is_alive(struct iwl_priv *priv)
245 {
246         return test_bit(STATUS_ALIVE, &priv->status);
247 }
248
249 static inline int iwl_is_init(struct iwl_priv *priv)
250 {
251         return test_bit(STATUS_INIT, &priv->status);
252 }
253
254 static inline int iwl_is_rfkill(struct iwl_priv *priv)
255 {
256         return test_bit(STATUS_RF_KILL_HW, &priv->status) ||
257                test_bit(STATUS_RF_KILL_SW, &priv->status);
258 }
259
260 static inline int iwl_is_ready_rf(struct iwl_priv *priv)
261 {
262
263         if (iwl_is_rfkill(priv))
264                 return 0;
265
266         return iwl_is_ready(priv);
267 }
268
269
270 enum iwlcore_card_notify {
271         IWLCORE_INIT_EVT = 0,
272         IWLCORE_START_EVT = 1,
273         IWLCORE_STOP_EVT = 2,
274         IWLCORE_REMOVE_EVT = 3,
275 };
276
277 int iwlcore_low_level_notify(struct iwl_priv *priv,
278                              enum iwlcore_card_notify notify);
279 extern int iwl_send_statistics_request(struct iwl_priv *priv, u8 flags);
280 extern int iwl_verify_ucode(struct iwl_priv *priv);
281 int iwl_send_lq_cmd(struct iwl_priv *priv,
282                     struct iwl_link_quality_cmd *lq, u8 flags);
283
284 static inline int iwl_send_rxon_assoc(struct iwl_priv *priv)
285 {
286         return priv->cfg->ops->hcmd->rxon_assoc(priv);
287 }
288
289
290 #endif /* __iwl_core_h__ */