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 - 2014 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 COPYING.
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 - 2014 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-config.h"
67
68#include "dev.h"
69
70/* The first 11 queues (0-10) are used otherwise */
71#define IWLAGN_FIRST_AMPDU_QUEUE	11
72
73/* AUX (TX during scan dwell) queue */
74#define IWL_AUX_QUEUE		10
75
76#define IWL_INVALID_STATION	255
77
78/* device operations */
79extern const struct iwl_dvm_cfg iwl_dvm_1000_cfg;
80extern const struct iwl_dvm_cfg iwl_dvm_2000_cfg;
81extern const struct iwl_dvm_cfg iwl_dvm_105_cfg;
82extern const struct iwl_dvm_cfg iwl_dvm_2030_cfg;
83extern const struct iwl_dvm_cfg iwl_dvm_5000_cfg;
84extern const struct iwl_dvm_cfg iwl_dvm_5150_cfg;
85extern const struct iwl_dvm_cfg iwl_dvm_6000_cfg;
86extern const struct iwl_dvm_cfg iwl_dvm_6005_cfg;
87extern const struct iwl_dvm_cfg iwl_dvm_6050_cfg;
88extern const struct iwl_dvm_cfg iwl_dvm_6030_cfg;
89
90
91#define TIME_UNIT		1024
92
93/*****************************************************
94* DRIVER STATUS FUNCTIONS
95******************************************************/
96#define STATUS_RF_KILL_HW	0
97#define STATUS_CT_KILL		1
98#define STATUS_ALIVE		2
99#define STATUS_READY		3
100#define STATUS_EXIT_PENDING	5
101#define STATUS_STATISTICS	6
102#define STATUS_SCANNING		7
103#define STATUS_SCAN_ABORTING	8
104#define STATUS_SCAN_HW		9
105#define STATUS_FW_ERROR		10
106#define STATUS_CHANNEL_SWITCH_PENDING 11
107#define STATUS_SCAN_COMPLETE	12
108#define STATUS_POWER_PMI	13
109
110struct iwl_ucode_capabilities;
111
112extern const struct ieee80211_ops iwlagn_hw_ops;
113
114static inline void iwl_set_calib_hdr(struct iwl_calib_hdr *hdr, u8 cmd)
115{
116	hdr->op_code = cmd;
117	hdr->first_group = 0;
118	hdr->groups_num = 1;
119	hdr->data_valid = 1;
120}
121
122void iwl_down(struct iwl_priv *priv);
123void iwl_cancel_deferred_work(struct iwl_priv *priv);
124void iwlagn_prepare_restart(struct iwl_priv *priv);
125int __must_check iwl_rx_dispatch(struct iwl_op_mode *op_mode,
126				 struct iwl_rx_cmd_buffer *rxb,
127				 struct iwl_device_cmd *cmd);
128
129bool iwl_check_for_ct_kill(struct iwl_priv *priv);
130
131void iwlagn_lift_passive_no_rx(struct iwl_priv *priv);
132
133/* MAC80211 */
134struct ieee80211_hw *iwl_alloc_all(void);
135int iwlagn_mac_setup_register(struct iwl_priv *priv,
136			      const struct iwl_ucode_capabilities *capa);
137void iwlagn_mac_unregister(struct iwl_priv *priv);
138
139/* commands */
140int iwl_dvm_send_cmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
141int iwl_dvm_send_cmd_pdu(struct iwl_priv *priv, u8 id,
142			 u32 flags, u16 len, const void *data);
143
144/* RXON */
145void iwl_connection_init_rx_config(struct iwl_priv *priv,
146				   struct iwl_rxon_context *ctx);
147int iwlagn_set_pan_params(struct iwl_priv *priv);
148int iwlagn_commit_rxon(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
149void iwlagn_set_rxon_chain(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
150int iwlagn_mac_config(struct ieee80211_hw *hw, u32 changed);
151void iwlagn_bss_info_changed(struct ieee80211_hw *hw,
152			     struct ieee80211_vif *vif,
153			     struct ieee80211_bss_conf *bss_conf,
154			     u32 changes);
155void iwlagn_config_ht40(struct ieee80211_conf *conf,
156			struct iwl_rxon_context *ctx);
157void iwl_set_rxon_ht(struct iwl_priv *priv, struct iwl_ht_config *ht_conf);
158void iwl_set_rxon_channel(struct iwl_priv *priv, struct ieee80211_channel *ch,
159			 struct iwl_rxon_context *ctx);
160void iwl_set_flags_for_band(struct iwl_priv *priv,
161			    struct iwl_rxon_context *ctx,
162			    enum ieee80211_band band,
163			    struct ieee80211_vif *vif);
164
165/* uCode */
166int iwl_send_bt_env(struct iwl_priv *priv, u8 action, u8 type);
167void iwl_send_prio_tbl(struct iwl_priv *priv);
168int iwl_init_alive_start(struct iwl_priv *priv);
169int iwl_run_init_ucode(struct iwl_priv *priv);
170int iwl_load_ucode_wait_alive(struct iwl_priv *priv,
171			      enum iwl_ucode_type ucode_type);
172int iwl_send_calib_results(struct iwl_priv *priv);
173int iwl_calib_set(struct iwl_priv *priv,
174		  const struct iwl_calib_hdr *cmd, int len);
175void iwl_calib_free_results(struct iwl_priv *priv);
176int iwl_dump_nic_event_log(struct iwl_priv *priv, bool full_log,
177			    char **buf);
178int iwlagn_hw_valid_rtc_data_addr(u32 addr);
179
180/* lib */
181int iwlagn_send_tx_power(struct iwl_priv *priv);
182void iwlagn_temperature(struct iwl_priv *priv);
183int iwlagn_txfifo_flush(struct iwl_priv *priv, u32 scd_q_msk);
184void iwlagn_dev_txfifo_flush(struct iwl_priv *priv);
185int iwlagn_send_beacon_cmd(struct iwl_priv *priv);
186int iwl_send_statistics_request(struct iwl_priv *priv,
187				u8 flags, bool clear);
188
189static inline const struct ieee80211_supported_band *iwl_get_hw_mode(
190			struct iwl_priv *priv, enum ieee80211_band band)
191{
192	return priv->hw->wiphy->bands[band];
193}
194
195#ifdef CONFIG_PM_SLEEP
196int iwlagn_send_patterns(struct iwl_priv *priv,
197			 struct cfg80211_wowlan *wowlan);
198int iwlagn_suspend(struct iwl_priv *priv, struct cfg80211_wowlan *wowlan);
199#endif
200
201/* rx */
202int iwlagn_hwrate_to_mac80211_idx(u32 rate_n_flags, enum ieee80211_band band);
203void iwl_setup_rx_handlers(struct iwl_priv *priv);
204void iwl_chswitch_done(struct iwl_priv *priv, bool is_success);
205
206
207/* tx */
208int iwlagn_tx_skb(struct iwl_priv *priv,
209		  struct ieee80211_sta *sta,
210		  struct sk_buff *skb);
211int iwlagn_tx_agg_start(struct iwl_priv *priv, struct ieee80211_vif *vif,
212			struct ieee80211_sta *sta, u16 tid, u16 *ssn);
213int iwlagn_tx_agg_oper(struct iwl_priv *priv, struct ieee80211_vif *vif,
214			struct ieee80211_sta *sta, u16 tid, u8 buf_size);
215int iwlagn_tx_agg_stop(struct iwl_priv *priv, struct ieee80211_vif *vif,
216		       struct ieee80211_sta *sta, u16 tid);
217int iwlagn_tx_agg_flush(struct iwl_priv *priv, struct ieee80211_vif *vif,
218			struct ieee80211_sta *sta, u16 tid);
219int iwlagn_rx_reply_compressed_ba(struct iwl_priv *priv,
220				   struct iwl_rx_cmd_buffer *rxb,
221				   struct iwl_device_cmd *cmd);
222int iwlagn_rx_reply_tx(struct iwl_priv *priv, struct iwl_rx_cmd_buffer *rxb,
223			       struct iwl_device_cmd *cmd);
224
225static inline u32 iwl_tx_status_to_mac80211(u32 status)
226{
227	status &= TX_STATUS_MSK;
228
229	switch (status) {
230	case TX_STATUS_SUCCESS:
231	case TX_STATUS_DIRECT_DONE:
232		return IEEE80211_TX_STAT_ACK;
233	case TX_STATUS_FAIL_DEST_PS:
234	case TX_STATUS_FAIL_PASSIVE_NO_RX:
235		return IEEE80211_TX_STAT_TX_FILTERED;
236	default:
237		return 0;
238	}
239}
240
241static inline bool iwl_is_tx_success(u32 status)
242{
243	status &= TX_STATUS_MSK;
244	return (status == TX_STATUS_SUCCESS) ||
245	       (status == TX_STATUS_DIRECT_DONE);
246}
247
248u8 iwl_toggle_tx_ant(struct iwl_priv *priv, u8 ant_idx, u8 valid);
249
250/* scan */
251void iwlagn_post_scan(struct iwl_priv *priv);
252int iwl_force_rf_reset(struct iwl_priv *priv, bool external);
253void iwl_init_scan_params(struct iwl_priv *priv);
254int iwl_scan_cancel(struct iwl_priv *priv);
255void iwl_scan_cancel_timeout(struct iwl_priv *priv, unsigned long ms);
256void iwl_force_scan_end(struct iwl_priv *priv);
257void iwl_internal_short_hw_scan(struct iwl_priv *priv);
258void iwl_setup_rx_scan_handlers(struct iwl_priv *priv);
259void iwl_setup_scan_deferred_work(struct iwl_priv *priv);
260void iwl_cancel_scan_deferred_work(struct iwl_priv *priv);
261int __must_check iwl_scan_initiate(struct iwl_priv *priv,
262				   struct ieee80211_vif *vif,
263				   enum iwl_scan_type scan_type,
264				   enum ieee80211_band band);
265
266/* For faster active scanning, scan will move to the next channel if fewer than
267 * PLCP_QUIET_THRESH packets are heard on this channel within
268 * ACTIVE_QUIET_TIME after sending probe request.  This shortens the dwell
269 * time if it's a quiet channel (nothing responded to our probe, and there's
270 * no other traffic).
271 * Disable "quiet" feature by setting PLCP_QUIET_THRESH to 0. */
272#define IWL_ACTIVE_QUIET_TIME       cpu_to_le16(10)  /* msec */
273#define IWL_PLCP_QUIET_THRESH       cpu_to_le16(1)  /* packets */
274
275#define IWL_SCAN_CHECK_WATCHDOG		(HZ * 15)
276
277
278/* bt coex */
279void iwlagn_send_advance_bt_config(struct iwl_priv *priv);
280int iwlagn_bt_coex_profile_notif(struct iwl_priv *priv,
281				  struct iwl_rx_cmd_buffer *rxb,
282				  struct iwl_device_cmd *cmd);
283void iwlagn_bt_rx_handler_setup(struct iwl_priv *priv);
284void iwlagn_bt_setup_deferred_work(struct iwl_priv *priv);
285void iwlagn_bt_cancel_deferred_work(struct iwl_priv *priv);
286void iwlagn_bt_coex_rssi_monitor(struct iwl_priv *priv);
287void iwlagn_bt_adjust_rssi_monitor(struct iwl_priv *priv, bool rssi_ena);
288
289static inline bool iwl_advanced_bt_coexist(struct iwl_priv *priv)
290{
291	return priv->lib->bt_params &&
292	       priv->lib->bt_params->advanced_bt_coexist;
293}
294
295#ifdef CONFIG_IWLWIFI_DEBUG
296const char *iwl_get_tx_fail_reason(u32 status);
297const char *iwl_get_agg_tx_fail_reason(u16 status);
298#else
299static inline const char *iwl_get_tx_fail_reason(u32 status) { return ""; }
300static inline const char *iwl_get_agg_tx_fail_reason(u16 status) { return ""; }
301#endif
302
303
304/* station management */
305int iwlagn_manage_ibss_station(struct iwl_priv *priv,
306			       struct ieee80211_vif *vif, bool add);
307#define IWL_STA_DRIVER_ACTIVE BIT(0) /* driver entry is active */
308#define IWL_STA_UCODE_ACTIVE  BIT(1) /* ucode entry is active */
309#define IWL_STA_UCODE_INPROGRESS  BIT(2) /* ucode entry is in process of
310					    being activated */
311#define IWL_STA_LOCAL BIT(3) /* station state not directed by mac80211;
312				(this is for the IBSS BSSID stations) */
313#define IWL_STA_BCAST BIT(4) /* this station is the special bcast station */
314
315
316void iwl_restore_stations(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
317void iwl_clear_ucode_stations(struct iwl_priv *priv,
318			      struct iwl_rxon_context *ctx);
319void iwl_dealloc_bcast_stations(struct iwl_priv *priv);
320int iwl_get_free_ucode_key_offset(struct iwl_priv *priv);
321int iwl_send_add_sta(struct iwl_priv *priv,
322		     struct iwl_addsta_cmd *sta, u8 flags);
323int iwl_add_station_common(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
324			   const u8 *addr, bool is_ap,
325			   struct ieee80211_sta *sta, u8 *sta_id_r);
326int iwl_remove_station(struct iwl_priv *priv, const u8 sta_id,
327		       const u8 *addr);
328void iwl_deactivate_station(struct iwl_priv *priv, const u8 sta_id,
329			    const u8 *addr);
330u8 iwl_prep_station(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
331		    const u8 *addr, bool is_ap, struct ieee80211_sta *sta);
332
333int iwl_send_lq_cmd(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
334		    struct iwl_link_quality_cmd *lq, u8 flags, bool init);
335int iwl_add_sta_callback(struct iwl_priv *priv, struct iwl_rx_cmd_buffer *rxb,
336			       struct iwl_device_cmd *cmd);
337int iwl_sta_update_ht(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
338		      struct ieee80211_sta *sta);
339
340bool iwl_is_ht40_tx_allowed(struct iwl_priv *priv,
341			    struct iwl_rxon_context *ctx,
342			    struct ieee80211_sta *sta);
343
344static inline int iwl_sta_id(struct ieee80211_sta *sta)
345{
346	if (WARN_ON(!sta))
347		return IWL_INVALID_STATION;
348
349	return ((struct iwl_station_priv *)sta->drv_priv)->sta_id;
350}
351
352int iwlagn_alloc_bcast_station(struct iwl_priv *priv,
353			       struct iwl_rxon_context *ctx);
354int iwlagn_add_bssid_station(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
355			     const u8 *addr, u8 *sta_id_r);
356int iwl_remove_default_wep_key(struct iwl_priv *priv,
357			       struct iwl_rxon_context *ctx,
358			       struct ieee80211_key_conf *key);
359int iwl_set_default_wep_key(struct iwl_priv *priv,
360			    struct iwl_rxon_context *ctx,
361			    struct ieee80211_key_conf *key);
362int iwl_restore_default_wep_keys(struct iwl_priv *priv,
363				 struct iwl_rxon_context *ctx);
364int iwl_set_dynamic_key(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
365			struct ieee80211_key_conf *key,
366			struct ieee80211_sta *sta);
367int iwl_remove_dynamic_key(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
368			   struct ieee80211_key_conf *key,
369			   struct ieee80211_sta *sta);
370void iwl_update_tkip_key(struct iwl_priv *priv,
371			 struct ieee80211_vif *vif,
372			 struct ieee80211_key_conf *keyconf,
373			 struct ieee80211_sta *sta, u32 iv32, u16 *phase1key);
374int iwl_sta_tx_modify_enable_tid(struct iwl_priv *priv, int sta_id, int tid);
375int iwl_sta_rx_agg_start(struct iwl_priv *priv, struct ieee80211_sta *sta,
376			 int tid, u16 ssn);
377int iwl_sta_rx_agg_stop(struct iwl_priv *priv, struct ieee80211_sta *sta,
378			int tid);
379void iwl_sta_modify_sleep_tx_count(struct iwl_priv *priv, int sta_id, int cnt);
380int iwl_update_bcast_station(struct iwl_priv *priv,
381			     struct iwl_rxon_context *ctx);
382int iwl_update_bcast_stations(struct iwl_priv *priv);
383
384/* rate */
385static inline u32 iwl_ant_idx_to_flags(u8 ant_idx)
386{
387	return BIT(ant_idx) << RATE_MCS_ANT_POS;
388}
389
390static inline u8 iwl_hw_get_rate(__le32 rate_n_flags)
391{
392	return le32_to_cpu(rate_n_flags) & RATE_MCS_RATE_MSK;
393}
394
395static inline __le32 iwl_hw_set_rate_n_flags(u8 rate, u32 flags)
396{
397	return cpu_to_le32(flags|(u32)rate);
398}
399
400int iwl_alive_start(struct iwl_priv *priv);
401
402#ifdef CONFIG_IWLWIFI_DEBUG
403void iwl_print_rx_config_cmd(struct iwl_priv *priv,
404			     enum iwl_rxon_context_id ctxid);
405#else
406static inline void iwl_print_rx_config_cmd(struct iwl_priv *priv,
407					   enum iwl_rxon_context_id ctxid)
408{
409}
410#endif
411
412/* status checks */
413
414static inline int iwl_is_ready(struct iwl_priv *priv)
415{
416	/* The adapter is 'ready' if READY EXIT_PENDING is not set */
417	return test_bit(STATUS_READY, &priv->status) &&
418	       !test_bit(STATUS_EXIT_PENDING, &priv->status);
419}
420
421static inline int iwl_is_alive(struct iwl_priv *priv)
422{
423	return test_bit(STATUS_ALIVE, &priv->status);
424}
425
426static inline int iwl_is_rfkill(struct iwl_priv *priv)
427{
428	return test_bit(STATUS_RF_KILL_HW, &priv->status);
429}
430
431static inline int iwl_is_ctkill(struct iwl_priv *priv)
432{
433	return test_bit(STATUS_CT_KILL, &priv->status);
434}
435
436static inline int iwl_is_ready_rf(struct iwl_priv *priv)
437{
438	if (iwl_is_rfkill(priv))
439		return 0;
440
441	return iwl_is_ready(priv);
442}
443
444static inline void iwl_dvm_set_pmi(struct iwl_priv *priv, bool state)
445{
446	if (state)
447		set_bit(STATUS_POWER_PMI, &priv->status);
448	else
449		clear_bit(STATUS_POWER_PMI, &priv->status);
450	iwl_trans_set_pmi(priv->trans, state);
451}
452
453#ifdef CONFIG_IWLWIFI_DEBUGFS
454int iwl_dbgfs_register(struct iwl_priv *priv, struct dentry *dbgfs_dir);
455#else
456static inline int iwl_dbgfs_register(struct iwl_priv *priv,
457				     struct dentry *dbgfs_dir)
458{
459	return 0;
460}
461#endif /* CONFIG_IWLWIFI_DEBUGFS */
462
463#ifdef CONFIG_IWLWIFI_DEBUG
464#define IWL_DEBUG_QUIET_RFKILL(m, fmt, args...)	\
465do {									\
466	if (!iwl_is_rfkill((m)))					\
467		IWL_ERR(m, fmt, ##args);				\
468	else								\
469		__iwl_err((m)->dev, true,				\
470			  !iwl_have_debug_level(IWL_DL_RADIO),		\
471			  fmt, ##args);					\
472} while (0)
473#else
474#define IWL_DEBUG_QUIET_RFKILL(m, fmt, args...)	\
475do {									\
476	if (!iwl_is_rfkill((m)))					\
477		IWL_ERR(m, fmt, ##args);				\
478	else								\
479		__iwl_err((m)->dev, true, true, fmt, ##args);	\
480} while (0)
481#endif				/* CONFIG_IWLWIFI_DEBUG */
482
483extern const char *const iwl_dvm_cmd_strings[REPLY_MAX];
484
485static inline const char *iwl_dvm_get_cmd_string(u8 cmd)
486{
487	const char *s = iwl_dvm_cmd_strings[cmd];
488	if (s)
489		return s;
490	return "UNKNOWN";
491}
492#endif /* __iwl_agn_h__ */
493