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.2.26k"
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 #ifdef CONFIG_IWLWIFI_RUN_TIME_CALIB
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);
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 int (*shared_mem_rx_idx)(struct iwl_priv *priv);
107 void (*txq_update_byte_cnt_tbl)(struct iwl_priv *priv,
108 struct iwl_tx_queue *txq,
110 /* setup Rx handler */
111 void (*rx_handler_setup)(struct iwl_priv *priv);
112 /* nic Tx fifo handling */
113 int (*disable_tx_fifo)(struct iwl_priv *priv);
114 /* alive notification after init uCode load */
115 void (*init_alive_start)(struct iwl_priv *priv);
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);
121 int (*load_ucode)(struct iwl_priv *priv);
123 void (*radio_kill_sw)(struct iwl_priv *priv, int disable_radio);
124 /* power management */
126 int (*init)(struct iwl_priv *priv);
127 int (*reset)(struct iwl_priv *priv);
128 void (*config)(struct iwl_priv *priv);
129 int (*set_pwr_src)(struct iwl_priv *priv, enum iwl_pwr_src src);
132 int (*set_power)(struct iwl_priv *priv, void *cmd);
133 void (*update_chain_flags)(struct iwl_priv *priv);
134 /* eeprom operations (as defined in iwl-eeprom.h) */
135 struct iwl_eeprom_ops eeprom_ops;
139 const struct iwl_lib_ops *lib;
140 const struct iwl_hcmd_ops *hcmd;
141 const struct iwl_hcmd_utils_ops *utils;
144 struct iwl_mod_params {
145 int disable; /* def: 0 = enable radio */
146 int sw_crypto; /* def: 0 = using hardware encryption */
147 int debug; /* def: 0 = minimal debug log messages */
148 int disable_hw_scan; /* def: 0 = use h/w scan */
149 int num_of_queues; /* def: HW dependent */
150 int enable_qos; /* def: 1 = use quality of service */
151 int amsdu_size_8K; /* def: 1 = enable 8K amsdu size */
152 int antenna; /* def: 0 = both antennas (use diversity) */
153 int restart_fw; /* def: 1 = restart firmware */
161 const struct iwl_ops *ops;
162 const struct iwl_mod_params *mod_params;
165 /***************************
167 ***************************/
169 struct ieee80211_hw *iwl_alloc_all(struct iwl_cfg *cfg,
170 struct ieee80211_ops *hw_ops);
171 void iwl_hw_detect(struct iwl_priv *priv);
173 void iwlcore_clear_stations_table(struct iwl_priv *priv);
174 void iwl_reset_qos(struct iwl_priv *priv);
175 void iwl_set_rxon_chain(struct iwl_priv *priv);
176 int iwl_set_rxon_channel(struct iwl_priv *priv,
177 enum ieee80211_band band,
179 void iwl_set_rxon_ht(struct iwl_priv *priv, struct iwl_ht_info *ht_info);
180 u8 iwl_is_fat_tx_allowed(struct iwl_priv *priv,
181 struct ieee80211_ht_info *sta_ht_inf);
182 int iwl_hw_nic_init(struct iwl_priv *priv);
183 int iwl_setup_mac(struct iwl_priv *priv);
184 int iwl_init_drv(struct iwl_priv *priv);
185 void iwl_uninit_drv(struct iwl_priv *priv);
186 /* "keep warm" functions */
187 int iwl_kw_init(struct iwl_priv *priv);
188 int iwl_kw_alloc(struct iwl_priv *priv);
189 void iwl_kw_free(struct iwl_priv *priv);
191 /*****************************************************
193 ******************************************************/
194 void iwl_rx_queue_free(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
195 int iwl_rx_queue_alloc(struct iwl_priv *priv);
196 void iwl_rx_handle(struct iwl_priv *priv);
197 int iwl_rx_queue_update_write_ptr(struct iwl_priv *priv,
198 struct iwl_rx_queue *q);
199 void iwl_rx_queue_reset(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
200 void iwl_rx_replenish(struct iwl_priv *priv);
201 int iwl_rx_init(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
202 /* FIXME: remove when TX is moved to iwl core */
203 int iwl_rx_queue_restock(struct iwl_priv *priv);
204 int iwl_rx_queue_space(const struct iwl_rx_queue *q);
205 void iwl_rx_allocate(struct iwl_priv *priv);
207 /*****************************************************
209 ******************************************************/
210 int iwl_txq_ctx_reset(struct iwl_priv *priv);
211 int iwl_tx_skb(struct iwl_priv *priv, struct sk_buff *skb);
212 /* FIXME: remove when free Tx is fully merged into iwlcore */
213 int iwl_hw_txq_free_tfd(struct iwl_priv *priv, struct iwl_tx_queue *txq);
214 void iwl_hw_txq_ctx_free(struct iwl_priv *priv);
215 int iwl_hw_txq_attach_buf_to_tfd(struct iwl_priv *priv, void *tfd,
216 dma_addr_t addr, u16 len);
217 int iwl_txq_update_write_ptr(struct iwl_priv *priv, struct iwl_tx_queue *txq);
218 /*****************************************************
219 * S e n d i n g H o s t C o m m a n d s *
220 *****************************************************/
222 const char *get_cmd_string(u8 cmd);
223 int __must_check iwl_send_cmd_sync(struct iwl_priv *priv,
224 struct iwl_host_cmd *cmd);
225 int iwl_send_cmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
226 int __must_check iwl_send_cmd_pdu(struct iwl_priv *priv, u8 id,
227 u16 len, const void *data);
228 int iwl_send_cmd_pdu_async(struct iwl_priv *priv, u8 id, u16 len,
230 int (*callback)(struct iwl_priv *priv,
232 struct sk_buff *skb));
234 int iwl_enqueue_hcmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
236 /*****************************************************
237 * Error Handling Debugging
238 ******************************************************/
239 void iwl_print_event_log(struct iwl_priv *priv, u32 start_idx,
240 u32 num_events, u32 mode);
241 void iwl_dump_nic_error_log(struct iwl_priv *priv);
242 void iwl_dump_nic_event_log(struct iwl_priv *priv);
244 /*************** DRIVER STATUS FUNCTIONS *****/
246 #define STATUS_HCMD_ACTIVE 0 /* host command in progress */
247 #define STATUS_HCMD_SYNC_ACTIVE 1 /* sync host command in progress */
248 #define STATUS_INT_ENABLED 2
249 #define STATUS_RF_KILL_HW 3
250 #define STATUS_RF_KILL_SW 4
251 #define STATUS_INIT 5
252 #define STATUS_ALIVE 6
253 #define STATUS_READY 7
254 #define STATUS_TEMPERATURE 8
255 #define STATUS_GEO_CONFIGURED 9
256 #define STATUS_EXIT_PENDING 10
257 #define STATUS_IN_SUSPEND 11
258 #define STATUS_STATISTICS 12
259 #define STATUS_SCANNING 13
260 #define STATUS_SCAN_ABORTING 14
261 #define STATUS_SCAN_HW 15
262 #define STATUS_POWER_PMI 16
263 #define STATUS_FW_ERROR 17
264 #define STATUS_CONF_PENDING 18
267 static inline int iwl_is_ready(struct iwl_priv *priv)
269 /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
270 * set but EXIT_PENDING is not */
271 return test_bit(STATUS_READY, &priv->status) &&
272 test_bit(STATUS_GEO_CONFIGURED, &priv->status) &&
273 !test_bit(STATUS_EXIT_PENDING, &priv->status);
276 static inline int iwl_is_alive(struct iwl_priv *priv)
278 return test_bit(STATUS_ALIVE, &priv->status);
281 static inline int iwl_is_init(struct iwl_priv *priv)
283 return test_bit(STATUS_INIT, &priv->status);
286 static inline int iwl_is_rfkill(struct iwl_priv *priv)
288 return test_bit(STATUS_RF_KILL_HW, &priv->status) ||
289 test_bit(STATUS_RF_KILL_SW, &priv->status);
292 static inline int iwl_is_ready_rf(struct iwl_priv *priv)
295 if (iwl_is_rfkill(priv))
298 return iwl_is_ready(priv);
302 enum iwlcore_card_notify {
303 IWLCORE_INIT_EVT = 0,
304 IWLCORE_START_EVT = 1,
305 IWLCORE_STOP_EVT = 2,
306 IWLCORE_REMOVE_EVT = 3,
309 int iwlcore_low_level_notify(struct iwl_priv *priv,
310 enum iwlcore_card_notify notify);
311 extern int iwl_send_statistics_request(struct iwl_priv *priv, u8 flags);
312 extern int iwl_verify_ucode(struct iwl_priv *priv);
313 int iwl_send_lq_cmd(struct iwl_priv *priv,
314 struct iwl_link_quality_cmd *lq, u8 flags);
316 static inline int iwl_send_rxon_assoc(struct iwl_priv *priv)
318 return priv->cfg->ops->hcmd->rxon_assoc(priv);
321 #endif /* __iwl_core_h__ */