1 /******************************************************************************
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.
8 * Copyright(c) 2008 Intel Corporation. All rights reserved.
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.
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.
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,
24 * The full GNU General Public License is included in this distribution
25 * in the file called LICENSE.GPL.
27 * Contact Information:
28 * Tomas Winkler <tomas.winkler@intel.com>
29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
33 * Copyright(c) 2005 - 2008 Intel Corporation. All rights reserved.
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
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
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.
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 *****************************************************************************/
63 #ifndef __iwl_core_h__
64 #define __iwl_core_h__
66 /************************
67 * forward declarations *
68 ************************/
73 #define IWLWIFI_VERSION "1.3.27k"
74 #define DRV_COPYRIGHT "Copyright(c) 2003-2008 Intel Corporation"
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)
86 int (*rxon_assoc)(struct iwl_priv *priv);
88 struct iwl_hcmd_utils_ops {
89 u16 (*get_hcmd_size)(u8 cmd_id, u16 len);
90 u16 (*build_addsta_hcmd)(const struct iwl_addsta_cmd *cmd, u8 *data);
91 void (*gain_computation)(struct iwl_priv *priv,
93 u16 min_average_noise_antennat_i,
94 u32 min_average_noise);
95 void (*chain_noise_reset)(struct iwl_priv *priv);
96 void (*rts_tx_cmd_flag)(struct ieee80211_tx_info *info,
98 int (*calc_rssi)(struct iwl_priv *priv,
99 struct iwl_rx_phy_res *rx_resp);
103 /* set hw dependent parameters */
104 int (*set_hw_params)(struct iwl_priv *priv);
106 void (*txq_update_byte_cnt_tbl)(struct iwl_priv *priv,
107 struct iwl_tx_queue *txq,
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);
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,
117 /* setup Rx handler */
118 void (*rx_handler_setup)(struct iwl_priv *priv);
119 /* setup deferred work */
120 void (*setup_deferred_work)(struct iwl_priv *priv);
121 /* cancel deferred work */
122 void (*cancel_deferred_work)(struct iwl_priv *priv);
123 /* alive notification after init uCode load */
124 void (*init_alive_start)(struct iwl_priv *priv);
125 /* alive notification */
126 int (*alive_notify)(struct iwl_priv *priv);
127 /* check validity of rtc data address */
128 int (*is_valid_rtc_data_addr)(u32 addr);
130 int (*load_ucode)(struct iwl_priv *priv);
131 /* power management */
133 int (*init)(struct iwl_priv *priv);
134 int (*reset)(struct iwl_priv *priv);
135 void (*stop)(struct iwl_priv *priv);
136 void (*config)(struct iwl_priv *priv);
137 int (*set_pwr_src)(struct iwl_priv *priv, enum iwl_pwr_src src);
140 int (*send_tx_power) (struct iwl_priv *priv);
141 void (*update_chain_flags)(struct iwl_priv *priv);
142 void (*temperature) (struct iwl_priv *priv);
143 /* eeprom operations (as defined in iwl-eeprom.h) */
144 struct iwl_eeprom_ops eeprom_ops;
148 const struct iwl_lib_ops *lib;
149 const struct iwl_hcmd_ops *hcmd;
150 const struct iwl_hcmd_utils_ops *utils;
153 struct iwl_mod_params {
154 int disable; /* def: 0 = enable radio */
155 int sw_crypto; /* def: 0 = using hardware encryption */
156 int debug; /* def: 0 = minimal debug log messages */
157 int disable_hw_scan; /* def: 0 = use h/w scan */
158 int num_of_queues; /* def: HW dependent */
159 int num_of_ampdu_queues;/* def: HW dependent */
160 int enable_qos; /* def: 1 = use quality of service */
161 int disable_11n; /* def: 0 = disable 11n capabilities */
162 int amsdu_size_8K; /* def: 1 = enable 8K amsdu size */
163 int antenna; /* def: 0 = both antennas (use diversity) */
164 int restart_fw; /* def: 1 = restart firmware */
173 u16 eeprom_calib_ver;
174 const struct iwl_ops *ops;
175 const struct iwl_mod_params *mod_params;
178 /***************************
180 ***************************/
182 struct ieee80211_hw *iwl_alloc_all(struct iwl_cfg *cfg,
183 struct ieee80211_ops *hw_ops);
184 void iwl_hw_detect(struct iwl_priv *priv);
185 void iwl_clear_stations_table(struct iwl_priv *priv);
186 void iwl_reset_qos(struct iwl_priv *priv);
187 void iwl_set_rxon_chain(struct iwl_priv *priv);
188 int iwl_set_rxon_channel(struct iwl_priv *priv, struct ieee80211_channel *ch);
189 void iwl_set_rxon_ht(struct iwl_priv *priv, struct iwl_ht_info *ht_info);
190 u8 iwl_is_fat_tx_allowed(struct iwl_priv *priv,
191 struct ieee80211_sta_ht_cap *sta_ht_inf);
192 int iwl_hw_nic_init(struct iwl_priv *priv);
193 int iwl_setup_mac(struct iwl_priv *priv);
194 int iwl_set_hw_params(struct iwl_priv *priv);
195 int iwl_init_drv(struct iwl_priv *priv);
196 void iwl_uninit_drv(struct iwl_priv *priv);
198 /*****************************************************
200 ******************************************************/
201 void iwl_rx_queue_free(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
202 int iwl_rx_queue_alloc(struct iwl_priv *priv);
203 void iwl_rx_handle(struct iwl_priv *priv);
204 int iwl_rx_queue_update_write_ptr(struct iwl_priv *priv,
205 struct iwl_rx_queue *q);
206 void iwl_rx_queue_reset(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
207 void iwl_rx_replenish(struct iwl_priv *priv);
208 int iwl_rx_init(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
209 int iwl_rx_agg_start(struct iwl_priv *priv, const u8 *addr, int tid, u16 ssn);
210 int iwl_rx_agg_stop(struct iwl_priv *priv, const u8 *addr, int tid);
211 int iwl_rx_queue_restock(struct iwl_priv *priv);
212 int iwl_rx_queue_space(const struct iwl_rx_queue *q);
213 void iwl_rx_allocate(struct iwl_priv *priv);
214 void iwl_tx_cmd_complete(struct iwl_priv *priv, struct iwl_rx_mem_buffer *rxb);
215 int iwl_tx_queue_reclaim(struct iwl_priv *priv, int txq_id, int index);
217 void iwl_rx_missed_beacon_notif(struct iwl_priv *priv,
218 struct iwl_rx_mem_buffer *rxb);
219 void iwl_rx_statistics(struct iwl_priv *priv,
220 struct iwl_rx_mem_buffer *rxb);
224 /*****************************************************
226 ******************************************************/
227 int iwl_txq_ctx_reset(struct iwl_priv *priv);
228 int iwl_tx_skb(struct iwl_priv *priv, struct sk_buff *skb);
229 void iwl_hw_txq_ctx_free(struct iwl_priv *priv);
230 int iwl_txq_update_write_ptr(struct iwl_priv *priv, struct iwl_tx_queue *txq);
231 int iwl_tx_agg_start(struct iwl_priv *priv, const u8 *ra, u16 tid, u16 *ssn);
232 int iwl_tx_agg_stop(struct iwl_priv *priv , const u8 *ra, u16 tid);
233 int iwl_txq_check_empty(struct iwl_priv *priv, int sta_id, u8 tid, int txq_id);
234 /*****************************************************
236 ****************************************************/
237 int iwl_set_tx_power(struct iwl_priv *priv, s8 tx_power, bool force);
239 /*****************************************************
240 * RF -Kill - here and not in iwl-rfkill.h to be available when
241 * RF-kill subsystem is not compiled.
242 ****************************************************/
243 void iwl_rf_kill(struct iwl_priv *priv);
244 void iwl_radio_kill_sw_disable_radio(struct iwl_priv *priv);
245 int iwl_radio_kill_sw_enable_radio(struct iwl_priv *priv);
247 /*******************************************************************************
249 ******************************************************************************/
251 void iwl_hwrate_to_tx_control(struct iwl_priv *priv, u32 rate_n_flags,
252 struct ieee80211_tx_info *info);
253 int iwl_hwrate_to_plcp_idx(u32 rate_n_flags);
255 u8 iwl_toggle_tx_ant(struct iwl_priv *priv, u8 ant_idx);
257 static inline u32 iwl_ant_idx_to_flags(u8 ant_idx)
259 return BIT(ant_idx) << RATE_MCS_ANT_POS;
262 static inline u8 iwl_hw_get_rate(__le32 rate_n_flags)
264 return le32_to_cpu(rate_n_flags) & 0xFF;
266 static inline u32 iwl_hw_get_rate_n_flags(__le32 rate_n_flags)
268 return le32_to_cpu(rate_n_flags) & 0x1FFFF;
270 static inline __le32 iwl_hw_set_rate_n_flags(u8 rate, u32 flags)
272 return cpu_to_le32(flags|(u32)rate);
275 /*******************************************************************************
277 ******************************************************************************/
278 void iwl_init_scan_params(struct iwl_priv *priv);
279 int iwl_scan_cancel(struct iwl_priv *priv);
280 int iwl_scan_cancel_timeout(struct iwl_priv *priv, unsigned long ms);
281 int iwl_scan_initiate(struct iwl_priv *priv);
282 void iwl_setup_rx_scan_handlers(struct iwl_priv *priv);
283 void iwl_setup_scan_deferred_work(struct iwl_priv *priv);
285 /*******************************************************************************
286 * Calibrations - implemented in iwl-calib.c
287 ******************************************************************************/
288 int iwl_send_calib_results(struct iwl_priv *priv);
289 int iwl_calib_set(struct iwl_calib_result *res, const u8 *buf, int len);
290 void iwl_calib_free_results(struct iwl_priv *priv);
292 /*******************************************************************************
293 * Spectrum Measureemtns in iwl-spectrum.c
294 ******************************************************************************/
295 #ifdef CONFIG_IWLAGN_SPECTRUM_MEASUREMENT
296 void iwl_setup_spectrum_handlers(struct iwl_priv *priv);
298 static inline void iwl_setup_spectrum_handlers(struct iwl_priv *priv) {}
300 /*****************************************************
301 * S e n d i n g H o s t C o m m a n d s *
302 *****************************************************/
304 const char *get_cmd_string(u8 cmd);
305 int __must_check iwl_send_cmd_sync(struct iwl_priv *priv,
306 struct iwl_host_cmd *cmd);
307 int iwl_send_cmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
308 int __must_check iwl_send_cmd_pdu(struct iwl_priv *priv, u8 id,
309 u16 len, const void *data);
310 int iwl_send_cmd_pdu_async(struct iwl_priv *priv, u8 id, u16 len,
312 int (*callback)(struct iwl_priv *priv,
314 struct sk_buff *skb));
316 int iwl_enqueue_hcmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
318 /*****************************************************
319 * Error Handling Debugging
320 ******************************************************/
321 void iwl_dump_nic_error_log(struct iwl_priv *priv);
322 void iwl_dump_nic_event_log(struct iwl_priv *priv);
325 /*************** DRIVER STATUS FUNCTIONS *****/
327 #define STATUS_HCMD_ACTIVE 0 /* host command in progress */
328 #define STATUS_HCMD_SYNC_ACTIVE 1 /* sync host command in progress */
329 #define STATUS_INT_ENABLED 2
330 #define STATUS_RF_KILL_HW 3
331 #define STATUS_RF_KILL_SW 4
332 #define STATUS_INIT 5
333 #define STATUS_ALIVE 6
334 #define STATUS_READY 7
335 #define STATUS_TEMPERATURE 8
336 #define STATUS_GEO_CONFIGURED 9
337 #define STATUS_EXIT_PENDING 10
338 #define STATUS_IN_SUSPEND 11
339 #define STATUS_STATISTICS 12
340 #define STATUS_SCANNING 13
341 #define STATUS_SCAN_ABORTING 14
342 #define STATUS_SCAN_HW 15
343 #define STATUS_POWER_PMI 16
344 #define STATUS_FW_ERROR 17
345 #define STATUS_MODE_PENDING 18
348 static inline int iwl_is_ready(struct iwl_priv *priv)
350 /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
351 * set but EXIT_PENDING is not */
352 return test_bit(STATUS_READY, &priv->status) &&
353 test_bit(STATUS_GEO_CONFIGURED, &priv->status) &&
354 !test_bit(STATUS_EXIT_PENDING, &priv->status);
357 static inline int iwl_is_alive(struct iwl_priv *priv)
359 return test_bit(STATUS_ALIVE, &priv->status);
362 static inline int iwl_is_init(struct iwl_priv *priv)
364 return test_bit(STATUS_INIT, &priv->status);
367 static inline int iwl_is_rfkill_sw(struct iwl_priv *priv)
369 return test_bit(STATUS_RF_KILL_SW, &priv->status);
372 static inline int iwl_is_rfkill_hw(struct iwl_priv *priv)
374 return test_bit(STATUS_RF_KILL_HW, &priv->status);
377 static inline int iwl_is_rfkill(struct iwl_priv *priv)
379 return iwl_is_rfkill_hw(priv) || iwl_is_rfkill_sw(priv);
382 static inline int iwl_is_ready_rf(struct iwl_priv *priv)
385 if (iwl_is_rfkill(priv))
388 return iwl_is_ready(priv);
391 extern void iwl_rf_kill_ct_config(struct iwl_priv *priv);
392 extern int iwl_send_statistics_request(struct iwl_priv *priv, u8 flags);
393 extern int iwl_verify_ucode(struct iwl_priv *priv);
394 extern int iwl_send_lq_cmd(struct iwl_priv *priv,
395 struct iwl_link_quality_cmd *lq, u8 flags);
396 extern void iwl_rx_reply_rx(struct iwl_priv *priv,
397 struct iwl_rx_mem_buffer *rxb);
398 extern void iwl_rx_reply_rx_phy(struct iwl_priv *priv,
399 struct iwl_rx_mem_buffer *rxb);
400 void iwl_rx_reply_compressed_ba(struct iwl_priv *priv,
401 struct iwl_rx_mem_buffer *rxb);
403 static inline int iwl_send_rxon_assoc(struct iwl_priv *priv)
405 return priv->cfg->ops->hcmd->rxon_assoc(priv);
408 static inline const struct ieee80211_supported_band *iwl_get_hw_mode(
409 struct iwl_priv *priv, enum ieee80211_band band)
411 return priv->hw->wiphy->bands[band];
414 #endif /* __iwl_core_h__ */