iwl-agn.h revision 84abd2cc066fc077c424d0faf7618be348a7efb2
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 - 2012 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 - 2012 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
68struct iwl_ucode_capabilities;
69
70extern struct ieee80211_ops iwlagn_hw_ops;
71
72static 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
80void iwl_down(struct iwl_priv *priv);
81void iwl_cancel_deferred_work(struct iwl_priv *priv);
82void iwlagn_prepare_restart(struct iwl_priv *priv);
83void iwl_free_skb(struct iwl_op_mode *op_mode, struct sk_buff *skb);
84int __must_check iwl_rx_dispatch(struct iwl_op_mode *op_mode,
85				 struct iwl_rx_cmd_buffer *rxb,
86				 struct iwl_device_cmd *cmd);
87void iwl_stop_sw_queue(struct iwl_op_mode *op_mode, u8 ac);
88void iwl_wake_sw_queue(struct iwl_op_mode *op_mode, u8 ac);
89void iwl_set_hw_rfkill_state(struct iwl_op_mode *op_mode, bool state);
90void iwl_stop_sw_queue(struct iwl_op_mode *op_mode, u8 ac);
91void iwl_nic_error(struct iwl_op_mode *op_mode);
92
93/* MAC80211 */
94struct ieee80211_hw *iwl_alloc_all(void);
95int iwlagn_mac_setup_register(struct iwl_priv *priv,
96			      const struct iwl_ucode_capabilities *capa);
97void iwlagn_mac_unregister(struct iwl_priv *priv);
98
99/* commands */
100int iwl_dvm_send_cmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
101int iwl_dvm_send_cmd_pdu(struct iwl_priv *priv, u8 id,
102			 u32 flags, u16 len, const void *data);
103
104/* RXON */
105int iwlagn_set_pan_params(struct iwl_priv *priv);
106int iwlagn_commit_rxon(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
107void iwlagn_set_rxon_chain(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
108int iwlagn_mac_config(struct ieee80211_hw *hw, u32 changed);
109void iwlagn_bss_info_changed(struct ieee80211_hw *hw,
110			     struct ieee80211_vif *vif,
111			     struct ieee80211_bss_conf *bss_conf,
112			     u32 changes);
113void iwlagn_config_ht40(struct ieee80211_conf *conf,
114			struct iwl_rxon_context *ctx);
115
116/* uCode */
117int iwlagn_rx_calib_result(struct iwl_priv *priv,
118			    struct iwl_rx_cmd_buffer *rxb,
119			    struct iwl_device_cmd *cmd);
120void iwl_init_context(struct iwl_priv *priv, u32 ucode_flags);
121int iwl_send_bt_env(struct iwl_priv *priv, u8 action, u8 type);
122void iwl_send_prio_tbl(struct iwl_priv *priv);
123int iwl_init_alive_start(struct iwl_priv *priv);
124int iwl_run_init_ucode(struct iwl_priv *priv);
125int iwl_load_ucode_wait_alive(struct iwl_priv *priv,
126			      enum iwl_ucode_type ucode_type);
127int iwl_send_calib_results(struct iwl_priv *priv);
128int iwl_calib_set(struct iwl_priv *priv,
129		  const struct iwl_calib_hdr *cmd, int len);
130void iwl_calib_free_results(struct iwl_priv *priv);
131
132/* lib */
133int iwlagn_send_tx_power(struct iwl_priv *priv);
134void iwlagn_temperature(struct iwl_priv *priv);
135u16 iwl_eeprom_calib_version(struct iwl_shared *shrd);
136int iwlagn_txfifo_flush(struct iwl_priv *priv, u16 flush_control);
137void iwlagn_dev_txfifo_flush(struct iwl_priv *priv, u16 flush_control);
138int iwlagn_send_beacon_cmd(struct iwl_priv *priv);
139#ifdef CONFIG_PM_SLEEP
140int iwlagn_send_patterns(struct iwl_priv *priv,
141			 struct cfg80211_wowlan *wowlan);
142int iwlagn_suspend(struct iwl_priv *priv,
143		   struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
144#endif
145
146/* rx */
147int iwlagn_hwrate_to_mac80211_idx(u32 rate_n_flags, enum ieee80211_band band);
148void iwl_setup_rx_handlers(struct iwl_priv *priv);
149
150
151/* tx */
152int iwlagn_tx_skb(struct iwl_priv *priv, struct sk_buff *skb);
153int iwlagn_tx_agg_start(struct iwl_priv *priv, struct ieee80211_vif *vif,
154			struct ieee80211_sta *sta, u16 tid, u16 *ssn);
155int iwlagn_tx_agg_oper(struct iwl_priv *priv, struct ieee80211_vif *vif,
156			struct ieee80211_sta *sta, u16 tid, u8 buf_size);
157int iwlagn_tx_agg_stop(struct iwl_priv *priv, struct ieee80211_vif *vif,
158		       struct ieee80211_sta *sta, u16 tid);
159int iwlagn_rx_reply_compressed_ba(struct iwl_priv *priv,
160				   struct iwl_rx_cmd_buffer *rxb,
161				   struct iwl_device_cmd *cmd);
162int iwlagn_rx_reply_tx(struct iwl_priv *priv, struct iwl_rx_cmd_buffer *rxb,
163			       struct iwl_device_cmd *cmd);
164
165static inline u32 iwl_tx_status_to_mac80211(u32 status)
166{
167	status &= TX_STATUS_MSK;
168
169	switch (status) {
170	case TX_STATUS_SUCCESS:
171	case TX_STATUS_DIRECT_DONE:
172		return IEEE80211_TX_STAT_ACK;
173	case TX_STATUS_FAIL_DEST_PS:
174	case TX_STATUS_FAIL_PASSIVE_NO_RX:
175		return IEEE80211_TX_STAT_TX_FILTERED;
176	default:
177		return 0;
178	}
179}
180
181static inline bool iwl_is_tx_success(u32 status)
182{
183	status &= TX_STATUS_MSK;
184	return (status == TX_STATUS_SUCCESS) ||
185	       (status == TX_STATUS_DIRECT_DONE);
186}
187
188u8 iwl_toggle_tx_ant(struct iwl_priv *priv, u8 ant_idx, u8 valid);
189
190/* scan */
191void iwlagn_post_scan(struct iwl_priv *priv);
192void iwlagn_disable_roc(struct iwl_priv *priv);
193
194/* bt coex */
195void iwlagn_send_advance_bt_config(struct iwl_priv *priv);
196int iwlagn_bt_coex_profile_notif(struct iwl_priv *priv,
197				  struct iwl_rx_cmd_buffer *rxb,
198				  struct iwl_device_cmd *cmd);
199void iwlagn_bt_rx_handler_setup(struct iwl_priv *priv);
200void iwlagn_bt_setup_deferred_work(struct iwl_priv *priv);
201void iwlagn_bt_cancel_deferred_work(struct iwl_priv *priv);
202void iwlagn_bt_coex_rssi_monitor(struct iwl_priv *priv);
203void iwlagn_bt_adjust_rssi_monitor(struct iwl_priv *priv, bool rssi_ena);
204
205#ifdef CONFIG_IWLWIFI_DEBUG
206const char *iwl_get_tx_fail_reason(u32 status);
207const char *iwl_get_agg_tx_fail_reason(u16 status);
208#else
209static inline const char *iwl_get_tx_fail_reason(u32 status) { return ""; }
210static inline const char *iwl_get_agg_tx_fail_reason(u16 status) { return ""; }
211#endif
212
213
214/* station management */
215int iwlagn_manage_ibss_station(struct iwl_priv *priv,
216			       struct ieee80211_vif *vif, bool add);
217#define IWL_STA_DRIVER_ACTIVE BIT(0) /* driver entry is active */
218#define IWL_STA_UCODE_ACTIVE  BIT(1) /* ucode entry is active */
219#define IWL_STA_UCODE_INPROGRESS  BIT(2) /* ucode entry is in process of
220					    being activated */
221#define IWL_STA_LOCAL BIT(3) /* station state not directed by mac80211;
222				(this is for the IBSS BSSID stations) */
223#define IWL_STA_BCAST BIT(4) /* this station is the special bcast station */
224
225
226void iwl_restore_stations(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
227void iwl_clear_ucode_stations(struct iwl_priv *priv,
228			      struct iwl_rxon_context *ctx);
229void iwl_dealloc_bcast_stations(struct iwl_priv *priv);
230int iwl_get_free_ucode_key_offset(struct iwl_priv *priv);
231int iwl_send_add_sta(struct iwl_priv *priv,
232		     struct iwl_addsta_cmd *sta, u8 flags);
233int iwl_add_station_common(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
234			   const u8 *addr, bool is_ap,
235			   struct ieee80211_sta *sta, u8 *sta_id_r);
236int iwl_remove_station(struct iwl_priv *priv, const u8 sta_id,
237		       const u8 *addr);
238u8 iwl_prep_station(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
239		    const u8 *addr, bool is_ap, struct ieee80211_sta *sta);
240
241void iwl_sta_fill_lq(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
242		     u8 sta_id, struct iwl_link_quality_cmd *link_cmd);
243int iwl_send_lq_cmd(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
244		    struct iwl_link_quality_cmd *lq, u8 flags, bool init);
245int iwl_add_sta_callback(struct iwl_priv *priv, struct iwl_rx_cmd_buffer *rxb,
246			       struct iwl_device_cmd *cmd);
247int iwl_sta_update_ht(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
248		      struct ieee80211_sta *sta);
249
250
251static inline int iwl_sta_id(struct ieee80211_sta *sta)
252{
253	if (WARN_ON(!sta))
254		return IWL_INVALID_STATION;
255
256	return ((struct iwl_station_priv *)sta->drv_priv)->sta_id;
257}
258
259/**
260 * iwl_sta_id_or_broadcast - return sta_id or broadcast sta
261 * @priv: iwl priv
262 * @context: the current context
263 * @sta: mac80211 station
264 *
265 * In certain circumstances mac80211 passes a station pointer
266 * that may be %NULL, for example during TX or key setup. In
267 * that case, we need to use the broadcast station, so this
268 * inline wraps that pattern.
269 */
270static inline int iwl_sta_id_or_broadcast(struct iwl_priv *priv,
271					  struct iwl_rxon_context *context,
272					  struct ieee80211_sta *sta)
273{
274	int sta_id;
275
276	if (!sta)
277		return context->bcast_sta_id;
278
279	sta_id = iwl_sta_id(sta);
280
281	/*
282	 * mac80211 should not be passing a partially
283	 * initialised station!
284	 */
285	WARN_ON(sta_id == IWL_INVALID_STATION);
286
287	return sta_id;
288}
289
290int iwlagn_alloc_bcast_station(struct iwl_priv *priv,
291			       struct iwl_rxon_context *ctx);
292int iwlagn_add_bssid_station(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
293			     const u8 *addr, u8 *sta_id_r);
294int iwl_remove_default_wep_key(struct iwl_priv *priv,
295			       struct iwl_rxon_context *ctx,
296			       struct ieee80211_key_conf *key);
297int iwl_set_default_wep_key(struct iwl_priv *priv,
298			    struct iwl_rxon_context *ctx,
299			    struct ieee80211_key_conf *key);
300int iwl_restore_default_wep_keys(struct iwl_priv *priv,
301				 struct iwl_rxon_context *ctx);
302int iwl_set_dynamic_key(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
303			struct ieee80211_key_conf *key,
304			struct ieee80211_sta *sta);
305int iwl_remove_dynamic_key(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
306			   struct ieee80211_key_conf *key,
307			   struct ieee80211_sta *sta);
308void iwl_update_tkip_key(struct iwl_priv *priv,
309			 struct ieee80211_vif *vif,
310			 struct ieee80211_key_conf *keyconf,
311			 struct ieee80211_sta *sta, u32 iv32, u16 *phase1key);
312int iwl_sta_tx_modify_enable_tid(struct iwl_priv *priv, int sta_id, int tid);
313int iwl_sta_rx_agg_start(struct iwl_priv *priv, struct ieee80211_sta *sta,
314			 int tid, u16 ssn);
315int iwl_sta_rx_agg_stop(struct iwl_priv *priv, struct ieee80211_sta *sta,
316			int tid);
317void iwl_sta_modify_sleep_tx_count(struct iwl_priv *priv, int sta_id, int cnt);
318int iwl_update_bcast_station(struct iwl_priv *priv,
319			     struct iwl_rxon_context *ctx);
320int iwl_update_bcast_stations(struct iwl_priv *priv);
321
322/* rate */
323static inline u32 iwl_ant_idx_to_flags(u8 ant_idx)
324{
325	return BIT(ant_idx) << RATE_MCS_ANT_POS;
326}
327
328static inline u8 iwl_hw_get_rate(__le32 rate_n_flags)
329{
330	return le32_to_cpu(rate_n_flags) & RATE_MCS_RATE_MSK;
331}
332
333static inline __le32 iwl_hw_set_rate_n_flags(u8 rate, u32 flags)
334{
335	return cpu_to_le32(flags|(u32)rate);
336}
337
338/* eeprom */
339void iwl_eeprom_enhanced_txpower(struct iwl_priv *priv);
340void iwl_eeprom_get_mac(const struct iwl_shared *shrd, u8 *mac);
341
342extern int iwl_alive_start(struct iwl_priv *priv);
343/* svtool */
344#ifdef CONFIG_IWLWIFI_DEVICE_TESTMODE
345extern int iwlagn_mac_testmode_cmd(struct ieee80211_hw *hw, void *data,
346				   int len);
347extern int iwlagn_mac_testmode_dump(struct ieee80211_hw *hw,
348				    struct sk_buff *skb,
349				    struct netlink_callback *cb,
350				    void *data, int len);
351extern void iwl_testmode_init(struct iwl_priv *priv);
352extern void iwl_testmode_cleanup(struct iwl_priv *priv);
353#else
354static inline
355int iwlagn_mac_testmode_cmd(struct ieee80211_hw *hw, void *data, int len)
356{
357	return -ENOSYS;
358}
359static inline
360int iwlagn_mac_testmode_dump(struct ieee80211_hw *hw, struct sk_buff *skb,
361		      struct netlink_callback *cb,
362		      void *data, int len)
363{
364	return -ENOSYS;
365}
366static inline
367void iwl_testmode_init(struct iwl_priv *priv)
368{
369}
370static inline
371void iwl_testmode_cleanup(struct iwl_priv *priv)
372{
373}
374#endif
375
376#ifdef CONFIG_IWLWIFI_DEBUG
377void iwl_print_rx_config_cmd(struct iwl_priv *priv,
378			     enum iwl_rxon_context_id ctxid);
379#else
380static inline void iwl_print_rx_config_cmd(struct iwl_priv *priv,
381					   enum iwl_rxon_context_id ctxid)
382{
383}
384#endif
385
386/* status checks */
387
388static inline int iwl_is_ready(struct iwl_shared *shrd)
389{
390	/* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
391	 * set but EXIT_PENDING is not */
392	return test_bit(STATUS_READY, &shrd->status) &&
393	       test_bit(STATUS_GEO_CONFIGURED, &shrd->status) &&
394	       !test_bit(STATUS_EXIT_PENDING, &shrd->status);
395}
396
397static inline int iwl_is_alive(struct iwl_shared *shrd)
398{
399	return test_bit(STATUS_ALIVE, &shrd->status);
400}
401
402static inline int iwl_is_init(struct iwl_shared *shrd)
403{
404	return test_bit(STATUS_INIT, &shrd->status);
405}
406
407static inline int iwl_is_rfkill_hw(struct iwl_shared *shrd)
408{
409	return test_bit(STATUS_RF_KILL_HW, &shrd->status);
410}
411
412static inline int iwl_is_rfkill(struct iwl_shared *shrd)
413{
414	return iwl_is_rfkill_hw(shrd);
415}
416
417static inline int iwl_is_ctkill(struct iwl_shared *shrd)
418{
419	return test_bit(STATUS_CT_KILL, &shrd->status);
420}
421
422static inline int iwl_is_ready_rf(struct iwl_shared *shrd)
423{
424	if (iwl_is_rfkill(shrd))
425		return 0;
426
427	return iwl_is_ready(shrd);
428}
429
430#ifdef CONFIG_IWLWIFI_DEBUG
431#define IWL_DEBUG_QUIET_RFKILL(m, fmt, args...)	\
432do {									\
433	if (!iwl_is_rfkill((m)->shrd))					\
434		IWL_ERR(m, fmt, ##args);				\
435	else								\
436		__iwl_err(trans(m)->dev, true,				\
437			  !iwl_have_debug_level(IWL_DL_RADIO),		\
438			  fmt, ##args);					\
439} while (0)
440#else
441#define IWL_DEBUG_QUIET_RFKILL(m, fmt, args...)	\
442do {									\
443	if (!iwl_is_rfkill((m)->shrd))					\
444		IWL_ERR(m, fmt, ##args);				\
445	else								\
446		__iwl_err(trans(m)->dev, true, true, fmt, ##args);	\
447} while (0)
448#endif				/* CONFIG_IWLWIFI_DEBUG */
449
450#endif /* __iwl_agn_h__ */
451