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 - 2009 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 * Intel Linux Wireless <ilw@linux.intel.com>
29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
33 * Copyright(c) 2005 - 2009 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-2009 Intel Corporation"
75 #define DRV_AUTHOR "<ilw@linux.intel.com>"
77 #define IWL_PCI_DEVICE(dev, subdev, cfg) \
78 .vendor = PCI_VENDOR_ID_INTEL, .device = (dev), \
79 .subvendor = PCI_ANY_ID, .subdevice = (subdev), \
80 .driver_data = (kernel_ulong_t)&(cfg)
87 int (*rxon_assoc
)(struct iwl_priv
*priv
);
89 struct iwl_hcmd_utils_ops
{
90 u16 (*get_hcmd_size
)(u8 cmd_id
, u16 len
);
91 u16 (*build_addsta_hcmd
)(const struct iwl_addsta_cmd
*cmd
, u8
*data
);
92 void (*gain_computation
)(struct iwl_priv
*priv
,
94 u16 min_average_noise_antennat_i
,
95 u32 min_average_noise
);
96 void (*chain_noise_reset
)(struct iwl_priv
*priv
);
97 void (*rts_tx_cmd_flag
)(struct ieee80211_tx_info
*info
,
99 int (*calc_rssi
)(struct iwl_priv
*priv
,
100 struct iwl_rx_phy_res
*rx_resp
);
104 /* set hw dependent parameters */
105 int (*set_hw_params
)(struct iwl_priv
*priv
);
107 void (*txq_update_byte_cnt_tbl
)(struct iwl_priv
*priv
,
108 struct iwl_tx_queue
*txq
,
110 void (*txq_inval_byte_cnt_tbl
)(struct iwl_priv
*priv
,
111 struct iwl_tx_queue
*txq
);
112 void (*txq_set_sched
)(struct iwl_priv
*priv
, u32 mask
);
113 int (*txq_attach_buf_to_tfd
)(struct iwl_priv
*priv
,
114 struct iwl_tx_queue
*txq
,
116 u16 len
, u8 reset
, u8 pad
);
117 void (*txq_free_tfd
)(struct iwl_priv
*priv
,
118 struct iwl_tx_queue
*txq
);
119 int (*txq_init
)(struct iwl_priv
*priv
,
120 struct iwl_tx_queue
*txq
);
122 int (*txq_agg_enable
)(struct iwl_priv
*priv
, int txq_id
, int tx_fifo
,
123 int sta_id
, int tid
, u16 ssn_idx
);
124 int (*txq_agg_disable
)(struct iwl_priv
*priv
, u16 txq_id
, u16 ssn_idx
,
126 /* setup Rx handler */
127 void (*rx_handler_setup
)(struct iwl_priv
*priv
);
128 /* setup deferred work */
129 void (*setup_deferred_work
)(struct iwl_priv
*priv
);
130 /* cancel deferred work */
131 void (*cancel_deferred_work
)(struct iwl_priv
*priv
);
132 /* alive notification after init uCode load */
133 void (*init_alive_start
)(struct iwl_priv
*priv
);
134 /* alive notification */
135 int (*alive_notify
)(struct iwl_priv
*priv
);
136 /* check validity of rtc data address */
137 int (*is_valid_rtc_data_addr
)(u32 addr
);
139 int (*load_ucode
)(struct iwl_priv
*priv
);
140 /* power management */
142 int (*init
)(struct iwl_priv
*priv
);
143 int (*reset
)(struct iwl_priv
*priv
);
144 void (*stop
)(struct iwl_priv
*priv
);
145 void (*config
)(struct iwl_priv
*priv
);
146 int (*set_pwr_src
)(struct iwl_priv
*priv
, enum iwl_pwr_src src
);
149 int (*send_tx_power
) (struct iwl_priv
*priv
);
150 void (*update_chain_flags
)(struct iwl_priv
*priv
);
151 void (*temperature
) (struct iwl_priv
*priv
);
152 /* eeprom operations (as defined in iwl-eeprom.h) */
153 struct iwl_eeprom_ops eeprom_ops
;
157 const struct iwl_lib_ops
*lib
;
158 const struct iwl_hcmd_ops
*hcmd
;
159 const struct iwl_hcmd_utils_ops
*utils
;
162 struct iwl_mod_params
{
163 int disable
; /* def: 0 = enable radio */
164 int sw_crypto
; /* def: 0 = using hardware encryption */
165 u32 debug
; /* def: 0 = minimal debug log messages */
166 int disable_hw_scan
; /* def: 0 = use h/w scan */
167 int num_of_queues
; /* def: HW dependent */
168 int num_of_ampdu_queues
;/* def: HW dependent */
169 int disable_11n
; /* def: 0 = disable 11n capabilities */
170 int amsdu_size_8K
; /* def: 1 = enable 8K amsdu size */
171 int antenna
; /* def: 0 = both antennas (use diversity) */
172 int restart_fw
; /* def: 1 = restart firmware */
177 * @fw_name_pre: Firmware filename prefix. The api version and extension
178 * (.ucode) will be added to filename before loading from disk. The
179 * filename is constructed as fw_name_pre<api>.ucode.
180 * @ucode_api_max: Highest version of uCode API supported by driver.
181 * @ucode_api_min: Lowest version of uCode API supported by driver.
183 * We enable the driver to be backward compatible wrt API version. The
184 * driver specifies which APIs it supports (with @ucode_api_max being the
185 * highest and @ucode_api_min the lowest). Firmware will only be loaded if
186 * it has a supported API version. The firmware's API version will be
187 * stored in @iwl_priv, enabling the driver to make runtime changes based
188 * on firmware version used.
191 * if (IWL_UCODE_API(priv->ucode_ver) >= 2) {
192 * Driver interacts with Firmware API version >= 2.
194 * Driver interacts with Firmware API version 1.
197 * The ideal usage of this infrastructure is to treat a new ucode API
198 * release as a new hardware revision. That is, through utilizing the
199 * iwl_hcmd_utils_ops etc. we accommodate different command structures
200 * and flows between hardware versions (4965/5000) as well as their API
205 const char *fw_name_pre
;
206 const unsigned int ucode_api_max
;
207 const unsigned int ucode_api_min
;
211 u16 eeprom_calib_ver
;
212 const struct iwl_ops
*ops
;
213 const struct iwl_mod_params
*mod_params
;
219 /***************************
221 ***************************/
223 struct ieee80211_hw
*iwl_alloc_all(struct iwl_cfg
*cfg
,
224 struct ieee80211_ops
*hw_ops
);
225 void iwl_hw_detect(struct iwl_priv
*priv
);
226 void iwl_reset_qos(struct iwl_priv
*priv
);
227 void iwl_set_rxon_hwcrypto(struct iwl_priv
*priv
, int hw_decrypt
);
228 int iwl_check_rxon_cmd(struct iwl_priv
*priv
);
229 int iwl_full_rxon_required(struct iwl_priv
*priv
);
230 void iwl_set_rxon_chain(struct iwl_priv
*priv
);
231 int iwl_set_rxon_channel(struct iwl_priv
*priv
, struct ieee80211_channel
*ch
);
232 void iwl_set_rxon_ht(struct iwl_priv
*priv
, struct iwl_ht_info
*ht_info
);
233 u8
iwl_is_fat_tx_allowed(struct iwl_priv
*priv
,
234 struct ieee80211_sta_ht_cap
*sta_ht_inf
);
235 void iwl_set_flags_for_band(struct iwl_priv
*priv
, enum ieee80211_band band
);
236 void iwl_connection_init_rx_config(struct iwl_priv
*priv
, int mode
);
237 int iwl_set_decrypted_flag(struct iwl_priv
*priv
,
238 struct ieee80211_hdr
*hdr
,
240 struct ieee80211_rx_status
*stats
);
241 void iwl_irq_handle_error(struct iwl_priv
*priv
);
242 void iwl_configure_filter(struct ieee80211_hw
*hw
,
243 unsigned int changed_flags
,
244 unsigned int *total_flags
,
245 int mc_count
, struct dev_addr_list
*mc_list
);
246 int iwl_hw_nic_init(struct iwl_priv
*priv
);
247 int iwl_setup_mac(struct iwl_priv
*priv
);
248 int iwl_set_hw_params(struct iwl_priv
*priv
);
249 int iwl_init_drv(struct iwl_priv
*priv
);
250 void iwl_uninit_drv(struct iwl_priv
*priv
);
252 /*****************************************************
254 ******************************************************/
255 void iwl_rx_queue_free(struct iwl_priv
*priv
, struct iwl_rx_queue
*rxq
);
256 int iwl_rx_queue_alloc(struct iwl_priv
*priv
);
257 void iwl_rx_handle(struct iwl_priv
*priv
);
258 int iwl_rx_queue_update_write_ptr(struct iwl_priv
*priv
,
259 struct iwl_rx_queue
*q
);
260 void iwl_rx_queue_reset(struct iwl_priv
*priv
, struct iwl_rx_queue
*rxq
);
261 void iwl_rx_replenish(struct iwl_priv
*priv
);
262 int iwl_rx_init(struct iwl_priv
*priv
, struct iwl_rx_queue
*rxq
);
263 int iwl_rx_queue_restock(struct iwl_priv
*priv
);
264 int iwl_rx_queue_space(const struct iwl_rx_queue
*q
);
265 void iwl_rx_allocate(struct iwl_priv
*priv
);
266 void iwl_tx_cmd_complete(struct iwl_priv
*priv
, struct iwl_rx_mem_buffer
*rxb
);
267 int iwl_tx_queue_reclaim(struct iwl_priv
*priv
, int txq_id
, int index
);
269 void iwl_rx_missed_beacon_notif(struct iwl_priv
*priv
,
270 struct iwl_rx_mem_buffer
*rxb
);
271 void iwl_rx_statistics(struct iwl_priv
*priv
,
272 struct iwl_rx_mem_buffer
*rxb
);
273 void iwl_rx_csa(struct iwl_priv
*priv
, struct iwl_rx_mem_buffer
*rxb
);
277 /*****************************************************
279 ******************************************************/
280 int iwl_txq_ctx_reset(struct iwl_priv
*priv
);
281 void iwl_hw_txq_free_tfd(struct iwl_priv
*priv
, struct iwl_tx_queue
*txq
);
282 int iwl_hw_txq_attach_buf_to_tfd(struct iwl_priv
*priv
,
283 struct iwl_tx_queue
*txq
,
284 dma_addr_t addr
, u16 len
, u8 reset
, u8 pad
);
285 int iwl_tx_skb(struct iwl_priv
*priv
, struct sk_buff
*skb
);
286 void iwl_hw_txq_ctx_free(struct iwl_priv
*priv
);
287 int iwl_hw_tx_queue_init(struct iwl_priv
*priv
,
288 struct iwl_tx_queue
*txq
);
289 int iwl_txq_update_write_ptr(struct iwl_priv
*priv
, struct iwl_tx_queue
*txq
);
290 int iwl_tx_queue_init(struct iwl_priv
*priv
, struct iwl_tx_queue
*txq
,
291 int slots_num
, u32 txq_id
);
292 void iwl_tx_queue_free(struct iwl_priv
*priv
, int txq_id
);
293 int iwl_tx_agg_start(struct iwl_priv
*priv
, const u8
*ra
, u16 tid
, u16
*ssn
);
294 int iwl_tx_agg_stop(struct iwl_priv
*priv
, const u8
*ra
, u16 tid
);
295 int iwl_txq_check_empty(struct iwl_priv
*priv
, int sta_id
, u8 tid
, int txq_id
);
296 /*****************************************************
298 ****************************************************/
299 int iwl_set_tx_power(struct iwl_priv
*priv
, s8 tx_power
, bool force
);
301 /*****************************************************
302 * RF -Kill - here and not in iwl-rfkill.h to be available when
303 * RF-kill subsystem is not compiled.
304 ****************************************************/
305 void iwl_bg_rf_kill(struct work_struct
*work
);
306 void iwl_radio_kill_sw_disable_radio(struct iwl_priv
*priv
);
307 int iwl_radio_kill_sw_enable_radio(struct iwl_priv
*priv
);
309 /*******************************************************************************
311 ******************************************************************************/
313 void iwl_hwrate_to_tx_control(struct iwl_priv
*priv
, u32 rate_n_flags
,
314 struct ieee80211_tx_info
*info
);
315 int iwl_hwrate_to_plcp_idx(u32 rate_n_flags
);
317 u8
iwl_rate_get_lowest_plcp(struct iwl_priv
*priv
);
319 void iwl_set_rate(struct iwl_priv
*priv
);
321 u8
iwl_toggle_tx_ant(struct iwl_priv
*priv
, u8 ant_idx
);
323 static inline u32
iwl_ant_idx_to_flags(u8 ant_idx
)
325 return BIT(ant_idx
) << RATE_MCS_ANT_POS
;
328 static inline u8
iwl_hw_get_rate(__le32 rate_n_flags
)
330 return le32_to_cpu(rate_n_flags
) & 0xFF;
332 static inline u32
iwl_hw_get_rate_n_flags(__le32 rate_n_flags
)
334 return le32_to_cpu(rate_n_flags
) & 0x1FFFF;
336 static inline __le32
iwl_hw_set_rate_n_flags(u8 rate
, u32 flags
)
338 return cpu_to_le32(flags
|(u32
)rate
);
341 /*******************************************************************************
343 ******************************************************************************/
344 void iwl_init_scan_params(struct iwl_priv
*priv
);
345 int iwl_scan_cancel(struct iwl_priv
*priv
);
346 int iwl_scan_cancel_timeout(struct iwl_priv
*priv
, unsigned long ms
);
347 int iwl_scan_initiate(struct iwl_priv
*priv
);
348 u16
iwl_fill_probe_req(struct iwl_priv
*priv
, enum ieee80211_band band
,
349 struct ieee80211_mgmt
*frame
, int left
);
350 void iwl_setup_rx_scan_handlers(struct iwl_priv
*priv
);
351 u16
iwl_get_active_dwell_time(struct iwl_priv
*priv
,
352 enum ieee80211_band band
,
354 u16
iwl_get_passive_dwell_time(struct iwl_priv
*priv
,
355 enum ieee80211_band band
);
356 void iwl_bg_scan_check(struct work_struct
*data
);
357 void iwl_bg_abort_scan(struct work_struct
*work
);
358 void iwl_bg_scan_completed(struct work_struct
*work
);
359 void iwl_setup_scan_deferred_work(struct iwl_priv
*priv
);
360 int iwl_send_scan_abort(struct iwl_priv
*priv
);
362 /* For faster active scanning, scan will move to the next channel if fewer than
363 * PLCP_QUIET_THRESH packets are heard on this channel within
364 * ACTIVE_QUIET_TIME after sending probe request. This shortens the dwell
365 * time if it's a quiet channel (nothing responded to our probe, and there's
367 * Disable "quiet" feature by setting PLCP_QUIET_THRESH to 0. */
368 #define IWL_ACTIVE_QUIET_TIME cpu_to_le16(10) /* msec */
369 #define IWL_PLCP_QUIET_THRESH cpu_to_le16(1) /* packets */
372 /*******************************************************************************
373 * Calibrations - implemented in iwl-calib.c
374 ******************************************************************************/
375 int iwl_send_calib_results(struct iwl_priv
*priv
);
376 int iwl_calib_set(struct iwl_calib_result
*res
, const u8
*buf
, int len
);
377 void iwl_calib_free_results(struct iwl_priv
*priv
);
379 /*******************************************************************************
380 * Spectrum Measureemtns in iwl-spectrum.c
381 ******************************************************************************/
382 #ifdef CONFIG_IWLAGN_SPECTRUM_MEASUREMENT
383 void iwl_setup_spectrum_handlers(struct iwl_priv
*priv
);
385 static inline void iwl_setup_spectrum_handlers(struct iwl_priv
*priv
) {}
387 /*****************************************************
388 * S e n d i n g H o s t C o m m a n d s *
389 *****************************************************/
391 const char *get_cmd_string(u8 cmd
);
392 int __must_check
iwl_send_cmd_sync(struct iwl_priv
*priv
,
393 struct iwl_host_cmd
*cmd
);
394 int iwl_send_cmd(struct iwl_priv
*priv
, struct iwl_host_cmd
*cmd
);
395 int __must_check
iwl_send_cmd_pdu(struct iwl_priv
*priv
, u8 id
,
396 u16 len
, const void *data
);
397 int iwl_send_cmd_pdu_async(struct iwl_priv
*priv
, u8 id
, u16 len
,
399 int (*callback
)(struct iwl_priv
*priv
,
401 struct sk_buff
*skb
));
403 int iwl_enqueue_hcmd(struct iwl_priv
*priv
, struct iwl_host_cmd
*cmd
);
405 int iwl_send_card_state(struct iwl_priv
*priv
, u32 flags
,
408 /*****************************************************
410 *****************************************************/
411 void iwl_disable_interrupts(struct iwl_priv
*priv
);
412 void iwl_enable_interrupts(struct iwl_priv
*priv
);
414 /*****************************************************
415 * Error Handling Debugging
416 ******************************************************/
417 void iwl_dump_nic_error_log(struct iwl_priv
*priv
);
418 void iwl_dump_nic_event_log(struct iwl_priv
*priv
);
420 /*****************************************************
422 ******************************************************/
423 int iwlcore_init_geos(struct iwl_priv
*priv
);
424 void iwlcore_free_geos(struct iwl_priv
*priv
);
426 /*************** DRIVER STATUS FUNCTIONS *****/
428 #define STATUS_HCMD_ACTIVE 0 /* host command in progress */
429 #define STATUS_HCMD_SYNC_ACTIVE 1 /* sync host command in progress */
430 #define STATUS_INT_ENABLED 2
431 #define STATUS_RF_KILL_HW 3
432 #define STATUS_RF_KILL_SW 4
433 #define STATUS_INIT 5
434 #define STATUS_ALIVE 6
435 #define STATUS_READY 7
436 #define STATUS_TEMPERATURE 8
437 #define STATUS_GEO_CONFIGURED 9
438 #define STATUS_EXIT_PENDING 10
439 #define STATUS_IN_SUSPEND 11
440 #define STATUS_STATISTICS 12
441 #define STATUS_SCANNING 13
442 #define STATUS_SCAN_ABORTING 14
443 #define STATUS_SCAN_HW 15
444 #define STATUS_POWER_PMI 16
445 #define STATUS_FW_ERROR 17
446 #define STATUS_MODE_PENDING 18
449 static inline int iwl_is_ready(struct iwl_priv
*priv
)
451 /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
452 * set but EXIT_PENDING is not */
453 return test_bit(STATUS_READY
, &priv
->status
) &&
454 test_bit(STATUS_GEO_CONFIGURED
, &priv
->status
) &&
455 !test_bit(STATUS_EXIT_PENDING
, &priv
->status
);
458 static inline int iwl_is_alive(struct iwl_priv
*priv
)
460 return test_bit(STATUS_ALIVE
, &priv
->status
);
463 static inline int iwl_is_init(struct iwl_priv
*priv
)
465 return test_bit(STATUS_INIT
, &priv
->status
);
468 static inline int iwl_is_rfkill_sw(struct iwl_priv
*priv
)
470 return test_bit(STATUS_RF_KILL_SW
, &priv
->status
);
473 static inline int iwl_is_rfkill_hw(struct iwl_priv
*priv
)
475 return test_bit(STATUS_RF_KILL_HW
, &priv
->status
);
478 static inline int iwl_is_rfkill(struct iwl_priv
*priv
)
480 return iwl_is_rfkill_hw(priv
) || iwl_is_rfkill_sw(priv
);
483 static inline int iwl_is_ready_rf(struct iwl_priv
*priv
)
486 if (iwl_is_rfkill(priv
))
489 return iwl_is_ready(priv
);
492 extern void iwl_rf_kill_ct_config(struct iwl_priv
*priv
);
493 extern int iwl_send_bt_config(struct iwl_priv
*priv
);
494 extern int iwl_send_statistics_request(struct iwl_priv
*priv
, u8 flags
);
495 extern int iwl_verify_ucode(struct iwl_priv
*priv
);
496 extern int iwl_send_lq_cmd(struct iwl_priv
*priv
,
497 struct iwl_link_quality_cmd
*lq
, u8 flags
);
498 extern void iwl_rx_reply_rx(struct iwl_priv
*priv
,
499 struct iwl_rx_mem_buffer
*rxb
);
500 extern void iwl_rx_reply_rx_phy(struct iwl_priv
*priv
,
501 struct iwl_rx_mem_buffer
*rxb
);
502 void iwl_rx_reply_compressed_ba(struct iwl_priv
*priv
,
503 struct iwl_rx_mem_buffer
*rxb
);
505 static inline int iwl_send_rxon_assoc(struct iwl_priv
*priv
)
507 return priv
->cfg
->ops
->hcmd
->rxon_assoc(priv
);
510 static inline const struct ieee80211_supported_band
*iwl_get_hw_mode(
511 struct iwl_priv
*priv
, enum ieee80211_band band
)
513 return priv
->hw
->wiphy
->bands
[band
];
516 #endif /* __iwl_core_h__ */