iwlagn: move ucode files out of the iwl_priv structure
[linux-2.6-block.git] / drivers / net / wireless / iwlwifi / iwl-agn.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 - 2011 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  *  Intel Linux Wireless <ilw@linux.intel.com>
29  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
30  *
31  * BSD LICENSE
32  *
33  * Copyright(c) 2005 - 2011 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_agn_h__
64 #define __iwl_agn_h__
65
66 #include "iwl-dev.h"
67
68 extern struct ieee80211_ops iwlagn_hw_ops;
69
70 int iwl_reset_ict(struct iwl_trans *trans);
71
72 static inline void iwl_set_calib_hdr(struct iwl_calib_hdr *hdr, u8 cmd)
73 {
74         hdr->op_code = cmd;
75         hdr->first_group = 0;
76         hdr->groups_num = 1;
77         hdr->data_valid = 1;
78 }
79
80 /* RXON */
81 int iwlagn_set_pan_params(struct iwl_priv *priv);
82 int iwlagn_commit_rxon(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
83 void iwlagn_set_rxon_chain(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
84 int iwlagn_mac_config(struct ieee80211_hw *hw, u32 changed);
85 void iwlagn_bss_info_changed(struct ieee80211_hw *hw,
86                              struct ieee80211_vif *vif,
87                              struct ieee80211_bss_conf *bss_conf,
88                              u32 changes);
89
90 /* uCode */
91 int iwlagn_rx_calib_result(struct iwl_priv *priv,
92                             struct iwl_rx_mem_buffer *rxb,
93                             struct iwl_device_cmd *cmd);
94 int iwlagn_send_bt_env(struct iwl_priv *priv, u8 action, u8 type);
95 void iwlagn_send_prio_tbl(struct iwl_priv *priv);
96 int iwlagn_run_init_ucode(struct iwl_priv *priv);
97 int iwlagn_load_ucode_wait_alive(struct iwl_priv *priv,
98                                  enum iwl_ucode_type ucode_type);
99
100 /* lib */
101 int iwlagn_send_tx_power(struct iwl_priv *priv);
102 void iwlagn_temperature(struct iwl_priv *priv);
103 u16 iwlagn_eeprom_calib_version(struct iwl_priv *priv);
104 int iwlagn_txfifo_flush(struct iwl_priv *priv, u16 flush_control);
105 void iwlagn_dev_txfifo_flush(struct iwl_priv *priv, u16 flush_control);
106 int iwlagn_send_beacon_cmd(struct iwl_priv *priv);
107
108 /* rx */
109 int iwlagn_hwrate_to_mac80211_idx(u32 rate_n_flags, enum ieee80211_band band);
110 void iwl_setup_rx_handlers(struct iwl_priv *priv);
111
112
113 /* tx */
114 int iwlagn_tx_skb(struct iwl_priv *priv, struct sk_buff *skb);
115 int iwlagn_tx_agg_start(struct iwl_priv *priv, struct ieee80211_vif *vif,
116                         struct ieee80211_sta *sta, u16 tid, u16 *ssn);
117 int iwlagn_tx_agg_stop(struct iwl_priv *priv, struct ieee80211_vif *vif,
118                        struct ieee80211_sta *sta, u16 tid);
119 int iwlagn_rx_reply_compressed_ba(struct iwl_priv *priv,
120                                    struct iwl_rx_mem_buffer *rxb,
121                                    struct iwl_device_cmd *cmd);
122 int iwlagn_rx_reply_tx(struct iwl_priv *priv, struct iwl_rx_mem_buffer *rxb,
123                                struct iwl_device_cmd *cmd);
124
125 static inline u32 iwl_tx_status_to_mac80211(u32 status)
126 {
127         status &= TX_STATUS_MSK;
128
129         switch (status) {
130         case TX_STATUS_SUCCESS:
131         case TX_STATUS_DIRECT_DONE:
132                 return IEEE80211_TX_STAT_ACK;
133         case TX_STATUS_FAIL_DEST_PS:
134         case TX_STATUS_FAIL_PASSIVE_NO_RX:
135                 return IEEE80211_TX_STAT_TX_FILTERED;
136         default:
137                 return 0;
138         }
139 }
140
141 static inline bool iwl_is_tx_success(u32 status)
142 {
143         status &= TX_STATUS_MSK;
144         return (status == TX_STATUS_SUCCESS) ||
145                (status == TX_STATUS_DIRECT_DONE);
146 }
147
148 u8 iwl_toggle_tx_ant(struct iwl_priv *priv, u8 ant_idx, u8 valid);
149
150 /* scan */
151 void iwlagn_post_scan(struct iwl_priv *priv);
152 void iwlagn_disable_roc(struct iwl_priv *priv);
153
154 /* bt coex */
155 void iwlagn_send_advance_bt_config(struct iwl_priv *priv);
156 int iwlagn_bt_coex_profile_notif(struct iwl_priv *priv,
157                                   struct iwl_rx_mem_buffer *rxb,
158                                   struct iwl_device_cmd *cmd);
159 void iwlagn_bt_rx_handler_setup(struct iwl_priv *priv);
160 void iwlagn_bt_setup_deferred_work(struct iwl_priv *priv);
161 void iwlagn_bt_cancel_deferred_work(struct iwl_priv *priv);
162 void iwlagn_bt_coex_rssi_monitor(struct iwl_priv *priv);
163 void iwlagn_bt_adjust_rssi_monitor(struct iwl_priv *priv, bool rssi_ena);
164
165 #ifdef CONFIG_IWLWIFI_DEBUG
166 const char *iwl_get_tx_fail_reason(u32 status);
167 const char *iwl_get_agg_tx_fail_reason(u16 status);
168 #else
169 static inline const char *iwl_get_tx_fail_reason(u32 status) { return ""; }
170 static inline const char *iwl_get_agg_tx_fail_reason(u16 status) { return ""; }
171 #endif
172
173
174 /* station management */
175 int iwlagn_manage_ibss_station(struct iwl_priv *priv,
176                                struct ieee80211_vif *vif, bool add);
177 #define IWL_STA_DRIVER_ACTIVE BIT(0) /* driver entry is active */
178 #define IWL_STA_UCODE_ACTIVE  BIT(1) /* ucode entry is active */
179 #define IWL_STA_UCODE_INPROGRESS  BIT(2) /* ucode entry is in process of
180                                             being activated */
181 #define IWL_STA_LOCAL BIT(3) /* station state not directed by mac80211;
182                                 (this is for the IBSS BSSID stations) */
183 #define IWL_STA_BCAST BIT(4) /* this station is the special bcast station */
184
185
186 void iwl_restore_stations(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
187 void iwl_clear_ucode_stations(struct iwl_priv *priv,
188                               struct iwl_rxon_context *ctx);
189 void iwl_dealloc_bcast_stations(struct iwl_priv *priv);
190 int iwl_get_free_ucode_key_offset(struct iwl_priv *priv);
191 int iwl_send_add_sta(struct iwl_priv *priv,
192                      struct iwl_addsta_cmd *sta, u8 flags);
193 int iwl_add_station_common(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
194                            const u8 *addr, bool is_ap,
195                            struct ieee80211_sta *sta, u8 *sta_id_r);
196 int iwl_remove_station(struct iwl_priv *priv, const u8 sta_id,
197                        const u8 *addr);
198 int iwlagn_mac_sta_remove(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
199                        struct ieee80211_sta *sta);
200
201 u8 iwl_prep_station(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
202                     const u8 *addr, bool is_ap, struct ieee80211_sta *sta);
203
204 void iwl_sta_fill_lq(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
205                      u8 sta_id, struct iwl_link_quality_cmd *link_cmd);
206 int iwl_send_lq_cmd(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
207                     struct iwl_link_quality_cmd *lq, u8 flags, bool init);
208 void iwl_reprogram_ap_sta(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
209 int iwl_add_sta_callback(struct iwl_priv *priv, struct iwl_rx_mem_buffer *rxb,
210                                struct iwl_device_cmd *cmd);
211
212
213 /**
214  * iwl_clear_driver_stations - clear knowledge of all stations from driver
215  * @priv: iwl priv struct
216  *
217  * This is called during iwl_down() to make sure that in the case
218  * we're coming there from a hardware restart mac80211 will be
219  * able to reconfigure stations -- if we're getting there in the
220  * normal down flow then the stations will already be cleared.
221  */
222 static inline void iwl_clear_driver_stations(struct iwl_priv *priv)
223 {
224         unsigned long flags;
225         struct iwl_rxon_context *ctx;
226
227         spin_lock_irqsave(&priv->shrd->sta_lock, flags);
228         memset(priv->stations, 0, sizeof(priv->stations));
229         priv->num_stations = 0;
230
231         priv->ucode_key_table = 0;
232
233         for_each_context(priv, ctx) {
234                 /*
235                  * Remove all key information that is not stored as part
236                  * of station information since mac80211 may not have had
237                  * a chance to remove all the keys. When device is
238                  * reconfigured by mac80211 after an error all keys will
239                  * be reconfigured.
240                  */
241                 memset(ctx->wep_keys, 0, sizeof(ctx->wep_keys));
242                 ctx->key_mapping_keys = 0;
243         }
244
245         spin_unlock_irqrestore(&priv->shrd->sta_lock, flags);
246 }
247
248 static inline int iwl_sta_id(struct ieee80211_sta *sta)
249 {
250         if (WARN_ON(!sta))
251                 return IWL_INVALID_STATION;
252
253         return ((struct iwl_station_priv *)sta->drv_priv)->sta_id;
254 }
255
256 /**
257  * iwl_sta_id_or_broadcast - return sta_id or broadcast sta
258  * @priv: iwl priv
259  * @context: the current context
260  * @sta: mac80211 station
261  *
262  * In certain circumstances mac80211 passes a station pointer
263  * that may be %NULL, for example during TX or key setup. In
264  * that case, we need to use the broadcast station, so this
265  * inline wraps that pattern.
266  */
267 static inline int iwl_sta_id_or_broadcast(struct iwl_priv *priv,
268                                           struct iwl_rxon_context *context,
269                                           struct ieee80211_sta *sta)
270 {
271         int sta_id;
272
273         if (!sta)
274                 return context->bcast_sta_id;
275
276         sta_id = iwl_sta_id(sta);
277
278         /*
279          * mac80211 should not be passing a partially
280          * initialised station!
281          */
282         WARN_ON(sta_id == IWL_INVALID_STATION);
283
284         return sta_id;
285 }
286
287 int iwlagn_alloc_bcast_station(struct iwl_priv *priv,
288                                struct iwl_rxon_context *ctx);
289 int iwlagn_add_bssid_station(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
290                              const u8 *addr, u8 *sta_id_r);
291 int iwl_remove_default_wep_key(struct iwl_priv *priv,
292                                struct iwl_rxon_context *ctx,
293                                struct ieee80211_key_conf *key);
294 int iwl_set_default_wep_key(struct iwl_priv *priv,
295                             struct iwl_rxon_context *ctx,
296                             struct ieee80211_key_conf *key);
297 int iwl_restore_default_wep_keys(struct iwl_priv *priv,
298                                  struct iwl_rxon_context *ctx);
299 int iwl_set_dynamic_key(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
300                         struct ieee80211_key_conf *key,
301                         struct ieee80211_sta *sta);
302 int iwl_remove_dynamic_key(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
303                            struct ieee80211_key_conf *key,
304                            struct ieee80211_sta *sta);
305 void iwl_update_tkip_key(struct iwl_priv *priv,
306                          struct ieee80211_vif *vif,
307                          struct ieee80211_key_conf *keyconf,
308                          struct ieee80211_sta *sta, u32 iv32, u16 *phase1key);
309 int iwl_sta_tx_modify_enable_tid(struct iwl_priv *priv, int sta_id, int tid);
310 int iwl_sta_rx_agg_start(struct iwl_priv *priv, struct ieee80211_sta *sta,
311                          int tid, u16 ssn);
312 int iwl_sta_rx_agg_stop(struct iwl_priv *priv, struct ieee80211_sta *sta,
313                         int tid);
314 void iwl_sta_modify_sleep_tx_count(struct iwl_priv *priv, int sta_id, int cnt);
315 int iwl_update_bcast_station(struct iwl_priv *priv,
316                              struct iwl_rxon_context *ctx);
317 int iwl_update_bcast_stations(struct iwl_priv *priv);
318 void iwlagn_mac_sta_notify(struct ieee80211_hw *hw,
319                            struct ieee80211_vif *vif,
320                            enum sta_notify_cmd cmd,
321                            struct ieee80211_sta *sta);
322
323 /* rate */
324 static inline u32 iwl_ant_idx_to_flags(u8 ant_idx)
325 {
326         return BIT(ant_idx) << RATE_MCS_ANT_POS;
327 }
328
329 static inline u8 iwl_hw_get_rate(__le32 rate_n_flags)
330 {
331         return le32_to_cpu(rate_n_flags) & RATE_MCS_RATE_MSK;
332 }
333
334 static inline __le32 iwl_hw_set_rate_n_flags(u8 rate, u32 flags)
335 {
336         return cpu_to_le32(flags|(u32)rate);
337 }
338
339 /* eeprom */
340 void iwl_eeprom_enhanced_txpower(struct iwl_priv *priv);
341 void iwl_eeprom_get_mac(const struct iwl_priv *priv, u8 *mac);
342
343 /* notification wait support */
344 void __acquires(wait_entry)
345 iwlagn_init_notification_wait(struct iwl_priv *priv,
346                               struct iwl_notification_wait *wait_entry,
347                               u8 cmd,
348                               void (*fn)(struct iwl_priv *priv,
349                                          struct iwl_rx_packet *pkt,
350                                          void *data),
351                               void *fn_data);
352 int __must_check __releases(wait_entry)
353 iwlagn_wait_notification(struct iwl_priv *priv,
354                          struct iwl_notification_wait *wait_entry,
355                          unsigned long timeout);
356 void __releases(wait_entry)
357 iwlagn_remove_notification(struct iwl_priv *priv,
358                            struct iwl_notification_wait *wait_entry);
359 extern int iwlagn_init_alive_start(struct iwl_priv *priv);
360 extern int iwl_alive_start(struct iwl_priv *priv);
361 /* svtool */
362 #ifdef CONFIG_IWLWIFI_DEVICE_SVTOOL
363 extern int iwlagn_mac_testmode_cmd(struct ieee80211_hw *hw, void *data,
364                                    int len);
365 extern int iwlagn_mac_testmode_dump(struct ieee80211_hw *hw,
366                                     struct sk_buff *skb,
367                                     struct netlink_callback *cb,
368                                     void *data, int len);
369 extern void iwl_testmode_init(struct iwl_priv *priv);
370 extern void iwl_testmode_cleanup(struct iwl_priv *priv);
371 #else
372 static inline
373 int iwlagn_mac_testmode_cmd(struct ieee80211_hw *hw, void *data, int len)
374 {
375         return -ENOSYS;
376 }
377 static inline
378 int iwlagn_mac_testmode_dump(struct ieee80211_hw *hw, struct sk_buff *skb,
379                       struct netlink_callback *cb,
380                       void *data, int len)
381 {
382         return -ENOSYS;
383 }
384 static inline
385 void iwl_testmode_init(struct iwl_priv *priv)
386 {
387 }
388 static inline
389 void iwl_testmode_cleanup(struct iwl_priv *priv)
390 {
391 }
392 #endif
393
394 #endif /* __iwl_agn_h__ */