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  * The full GNU General Public License is included in this distribution
20  * in the file called COPYING.
21  *
22  * Contact Information:
23  *  Intel Linux Wireless <linuxwifi@intel.com>
24  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
25  *
26  * BSD LICENSE
27  *
28  * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
29  * All rights reserved.
30  *
31  * Redistribution and use in source and binary forms, with or without
32  * modification, are permitted provided that the following conditions
33  * are met:
34  *
35  *  * Redistributions of source code must retain the above copyright
36  *    notice, this list of conditions and the following disclaimer.
37  *  * Redistributions in binary form must reproduce the above copyright
38  *    notice, this list of conditions and the following disclaimer in
39  *    the documentation and/or other materials provided with the
40  *    distribution.
41  *  * Neither the name Intel Corporation nor the names of its
42  *    contributors may be used to endorse or promote products derived
43  *    from this software without specific prior written permission.
44  *
45  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
46  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
47  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
48  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
49  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
50  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
51  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
52  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
53  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
54  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
55  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
56  *****************************************************************************/
57 
58 #ifndef __iwl_agn_h__
59 #define __iwl_agn_h__
60 
61 #include "iwl-config.h"
62 
63 #include "dev.h"
64 
65 /* The first 11 queues (0-10) are used otherwise */
66 #define IWLAGN_FIRST_AMPDU_QUEUE	11
67 
68 /* AUX (TX during scan dwell) queue */
69 #define IWL_AUX_QUEUE		10
70 
71 #define IWL_INVALID_STATION	255
72 
73 /* device operations */
74 extern const struct iwl_dvm_cfg iwl_dvm_1000_cfg;
75 extern const struct iwl_dvm_cfg iwl_dvm_2000_cfg;
76 extern const struct iwl_dvm_cfg iwl_dvm_105_cfg;
77 extern const struct iwl_dvm_cfg iwl_dvm_2030_cfg;
78 extern const struct iwl_dvm_cfg iwl_dvm_5000_cfg;
79 extern const struct iwl_dvm_cfg iwl_dvm_5150_cfg;
80 extern const struct iwl_dvm_cfg iwl_dvm_6000_cfg;
81 extern const struct iwl_dvm_cfg iwl_dvm_6005_cfg;
82 extern const struct iwl_dvm_cfg iwl_dvm_6050_cfg;
83 extern const struct iwl_dvm_cfg iwl_dvm_6030_cfg;
84 
85 
86 #define TIME_UNIT		1024
87 
88 /*****************************************************
89 * DRIVER STATUS FUNCTIONS
90 ******************************************************/
91 #define STATUS_RF_KILL_HW	0
92 #define STATUS_CT_KILL		1
93 #define STATUS_ALIVE		2
94 #define STATUS_READY		3
95 #define STATUS_EXIT_PENDING	5
96 #define STATUS_STATISTICS	6
97 #define STATUS_SCANNING		7
98 #define STATUS_SCAN_ABORTING	8
99 #define STATUS_SCAN_HW		9
100 #define STATUS_FW_ERROR		10
101 #define STATUS_CHANNEL_SWITCH_PENDING 11
102 #define STATUS_SCAN_COMPLETE	12
103 #define STATUS_POWER_PMI	13
104 
105 struct iwl_ucode_capabilities;
106 
107 extern const struct ieee80211_ops iwlagn_hw_ops;
108 
109 static inline void iwl_set_calib_hdr(struct iwl_calib_hdr *hdr, u8 cmd)
110 {
111 	hdr->op_code = cmd;
112 	hdr->first_group = 0;
113 	hdr->groups_num = 1;
114 	hdr->data_valid = 1;
115 }
116 
117 void iwl_down(struct iwl_priv *priv);
118 void iwl_cancel_deferred_work(struct iwl_priv *priv);
119 void iwlagn_prepare_restart(struct iwl_priv *priv);
120 void iwl_rx_dispatch(struct iwl_op_mode *op_mode, struct napi_struct *napi,
121 		     struct iwl_rx_cmd_buffer *rxb);
122 
123 bool iwl_check_for_ct_kill(struct iwl_priv *priv);
124 
125 void iwlagn_lift_passive_no_rx(struct iwl_priv *priv);
126 
127 /* MAC80211 */
128 struct ieee80211_hw *iwl_alloc_all(void);
129 int iwlagn_mac_setup_register(struct iwl_priv *priv,
130 			      const struct iwl_ucode_capabilities *capa);
131 void iwlagn_mac_unregister(struct iwl_priv *priv);
132 
133 /* commands */
134 int iwl_dvm_send_cmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
135 int iwl_dvm_send_cmd_pdu(struct iwl_priv *priv, u8 id,
136 			 u32 flags, u16 len, const void *data);
137 
138 /* RXON */
139 void iwl_connection_init_rx_config(struct iwl_priv *priv,
140 				   struct iwl_rxon_context *ctx);
141 int iwlagn_set_pan_params(struct iwl_priv *priv);
142 int iwlagn_commit_rxon(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
143 void iwlagn_set_rxon_chain(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
144 int iwlagn_mac_config(struct ieee80211_hw *hw, u32 changed);
145 void iwlagn_bss_info_changed(struct ieee80211_hw *hw,
146 			     struct ieee80211_vif *vif,
147 			     struct ieee80211_bss_conf *bss_conf,
148 			     u32 changes);
149 void iwlagn_config_ht40(struct ieee80211_conf *conf,
150 			struct iwl_rxon_context *ctx);
151 void iwl_set_rxon_ht(struct iwl_priv *priv, struct iwl_ht_config *ht_conf);
152 void iwl_set_rxon_channel(struct iwl_priv *priv, struct ieee80211_channel *ch,
153 			 struct iwl_rxon_context *ctx);
154 void iwl_set_flags_for_band(struct iwl_priv *priv,
155 			    struct iwl_rxon_context *ctx,
156 			    enum nl80211_band band,
157 			    struct ieee80211_vif *vif);
158 
159 /* uCode */
160 int iwl_send_bt_env(struct iwl_priv *priv, u8 action, u8 type);
161 void iwl_send_prio_tbl(struct iwl_priv *priv);
162 int iwl_init_alive_start(struct iwl_priv *priv);
163 int iwl_run_init_ucode(struct iwl_priv *priv);
164 int iwl_load_ucode_wait_alive(struct iwl_priv *priv,
165 			      enum iwl_ucode_type ucode_type);
166 int iwl_send_calib_results(struct iwl_priv *priv);
167 int iwl_calib_set(struct iwl_priv *priv,
168 		  const struct iwl_calib_hdr *cmd, int len);
169 void iwl_calib_free_results(struct iwl_priv *priv);
170 int iwl_dump_nic_event_log(struct iwl_priv *priv, bool full_log,
171 			    char **buf);
172 int iwlagn_hw_valid_rtc_data_addr(u32 addr);
173 
174 /* lib */
175 int iwlagn_send_tx_power(struct iwl_priv *priv);
176 void iwlagn_temperature(struct iwl_priv *priv);
177 int iwlagn_txfifo_flush(struct iwl_priv *priv, u32 scd_q_msk);
178 void iwlagn_dev_txfifo_flush(struct iwl_priv *priv);
179 int iwlagn_send_beacon_cmd(struct iwl_priv *priv);
180 int iwl_send_statistics_request(struct iwl_priv *priv,
181 				u8 flags, bool clear);
182 
183 static inline const struct ieee80211_supported_band *iwl_get_hw_mode(
184 			struct iwl_priv *priv, enum nl80211_band band)
185 {
186 	return priv->hw->wiphy->bands[band];
187 }
188 
189 #ifdef CONFIG_PM_SLEEP
190 int iwlagn_send_patterns(struct iwl_priv *priv,
191 			 struct cfg80211_wowlan *wowlan);
192 int iwlagn_suspend(struct iwl_priv *priv, struct cfg80211_wowlan *wowlan);
193 #endif
194 
195 /* rx */
196 int iwlagn_hwrate_to_mac80211_idx(u32 rate_n_flags, enum nl80211_band band);
197 void iwl_setup_rx_handlers(struct iwl_priv *priv);
198 void iwl_chswitch_done(struct iwl_priv *priv, bool is_success);
199 
200 
201 /* tx */
202 int iwlagn_tx_skb(struct iwl_priv *priv,
203 		  struct ieee80211_sta *sta,
204 		  struct sk_buff *skb);
205 int iwlagn_tx_agg_start(struct iwl_priv *priv, struct ieee80211_vif *vif,
206 			struct ieee80211_sta *sta, u16 tid, u16 *ssn);
207 int iwlagn_tx_agg_oper(struct iwl_priv *priv, struct ieee80211_vif *vif,
208 			struct ieee80211_sta *sta, u16 tid, u8 buf_size);
209 int iwlagn_tx_agg_stop(struct iwl_priv *priv, struct ieee80211_vif *vif,
210 		       struct ieee80211_sta *sta, u16 tid);
211 int iwlagn_tx_agg_flush(struct iwl_priv *priv, struct ieee80211_vif *vif,
212 			struct ieee80211_sta *sta, u16 tid);
213 void iwlagn_rx_reply_compressed_ba(struct iwl_priv *priv,
214 				   struct iwl_rx_cmd_buffer *rxb);
215 void iwlagn_rx_reply_tx(struct iwl_priv *priv, struct iwl_rx_cmd_buffer *rxb);
216 
217 static inline u32 iwl_tx_status_to_mac80211(u32 status)
218 {
219 	status &= TX_STATUS_MSK;
220 
221 	switch (status) {
222 	case TX_STATUS_SUCCESS:
223 	case TX_STATUS_DIRECT_DONE:
224 		return IEEE80211_TX_STAT_ACK;
225 	case TX_STATUS_FAIL_DEST_PS:
226 	case TX_STATUS_FAIL_PASSIVE_NO_RX:
227 		return IEEE80211_TX_STAT_TX_FILTERED;
228 	default:
229 		return 0;
230 	}
231 }
232 
233 static inline bool iwl_is_tx_success(u32 status)
234 {
235 	status &= TX_STATUS_MSK;
236 	return (status == TX_STATUS_SUCCESS) ||
237 	       (status == TX_STATUS_DIRECT_DONE);
238 }
239 
240 u8 iwl_toggle_tx_ant(struct iwl_priv *priv, u8 ant_idx, u8 valid);
241 
242 /* scan */
243 void iwlagn_post_scan(struct iwl_priv *priv);
244 int iwl_force_rf_reset(struct iwl_priv *priv, bool external);
245 void iwl_init_scan_params(struct iwl_priv *priv);
246 int iwl_scan_cancel(struct iwl_priv *priv);
247 void iwl_scan_cancel_timeout(struct iwl_priv *priv, unsigned long ms);
248 void iwl_force_scan_end(struct iwl_priv *priv);
249 void iwl_internal_short_hw_scan(struct iwl_priv *priv);
250 void iwl_setup_rx_scan_handlers(struct iwl_priv *priv);
251 void iwl_setup_scan_deferred_work(struct iwl_priv *priv);
252 void iwl_cancel_scan_deferred_work(struct iwl_priv *priv);
253 int __must_check iwl_scan_initiate(struct iwl_priv *priv,
254 				   struct ieee80211_vif *vif,
255 				   enum iwl_scan_type scan_type,
256 				   enum nl80211_band band);
257 
258 /* For faster active scanning, scan will move to the next channel if fewer than
259  * PLCP_QUIET_THRESH packets are heard on this channel within
260  * ACTIVE_QUIET_TIME after sending probe request.  This shortens the dwell
261  * time if it's a quiet channel (nothing responded to our probe, and there's
262  * no other traffic).
263  * Disable "quiet" feature by setting PLCP_QUIET_THRESH to 0. */
264 #define IWL_ACTIVE_QUIET_TIME       cpu_to_le16(10)  /* msec */
265 #define IWL_PLCP_QUIET_THRESH       cpu_to_le16(1)  /* packets */
266 
267 #define IWL_SCAN_CHECK_WATCHDOG		(HZ * 15)
268 
269 
270 /* bt coex */
271 void iwlagn_send_advance_bt_config(struct iwl_priv *priv);
272 void iwlagn_bt_rx_handler_setup(struct iwl_priv *priv);
273 void iwlagn_bt_setup_deferred_work(struct iwl_priv *priv);
274 void iwlagn_bt_cancel_deferred_work(struct iwl_priv *priv);
275 void iwlagn_bt_coex_rssi_monitor(struct iwl_priv *priv);
276 void iwlagn_bt_adjust_rssi_monitor(struct iwl_priv *priv, bool rssi_ena);
277 
278 static inline bool iwl_advanced_bt_coexist(struct iwl_priv *priv)
279 {
280 	return priv->lib->bt_params &&
281 	       priv->lib->bt_params->advanced_bt_coexist;
282 }
283 
284 #ifdef CONFIG_IWLWIFI_DEBUG
285 const char *iwl_get_tx_fail_reason(u32 status);
286 const char *iwl_get_agg_tx_fail_reason(u16 status);
287 #else
288 static inline const char *iwl_get_tx_fail_reason(u32 status) { return ""; }
289 static inline const char *iwl_get_agg_tx_fail_reason(u16 status) { return ""; }
290 #endif
291 
292 
293 /* station management */
294 int iwlagn_manage_ibss_station(struct iwl_priv *priv,
295 			       struct ieee80211_vif *vif, bool add);
296 #define IWL_STA_DRIVER_ACTIVE BIT(0) /* driver entry is active */
297 #define IWL_STA_UCODE_ACTIVE  BIT(1) /* ucode entry is active */
298 #define IWL_STA_UCODE_INPROGRESS  BIT(2) /* ucode entry is in process of
299 					    being activated */
300 #define IWL_STA_LOCAL BIT(3) /* station state not directed by mac80211;
301 				(this is for the IBSS BSSID stations) */
302 #define IWL_STA_BCAST BIT(4) /* this station is the special bcast station */
303 
304 
305 void iwl_restore_stations(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
306 void iwl_clear_ucode_stations(struct iwl_priv *priv,
307 			      struct iwl_rxon_context *ctx);
308 void iwl_dealloc_bcast_stations(struct iwl_priv *priv);
309 int iwl_get_free_ucode_key_offset(struct iwl_priv *priv);
310 int iwl_send_add_sta(struct iwl_priv *priv,
311 		     struct iwl_addsta_cmd *sta, u8 flags);
312 int iwl_add_station_common(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
313 			   const u8 *addr, bool is_ap,
314 			   struct ieee80211_sta *sta, u8 *sta_id_r);
315 int iwl_remove_station(struct iwl_priv *priv, const u8 sta_id,
316 		       const u8 *addr);
317 void iwl_deactivate_station(struct iwl_priv *priv, const u8 sta_id,
318 			    const u8 *addr);
319 u8 iwl_prep_station(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
320 		    const u8 *addr, bool is_ap, struct ieee80211_sta *sta);
321 
322 int iwl_send_lq_cmd(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
323 		    struct iwl_link_quality_cmd *lq, u8 flags, bool init);
324 void iwl_add_sta_callback(struct iwl_priv *priv, struct iwl_rx_cmd_buffer *rxb);
325 int iwl_sta_update_ht(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
326 		      struct ieee80211_sta *sta);
327 
328 bool iwl_is_ht40_tx_allowed(struct iwl_priv *priv,
329 			    struct iwl_rxon_context *ctx,
330 			    struct ieee80211_sta *sta);
331 
332 static inline int iwl_sta_id(struct ieee80211_sta *sta)
333 {
334 	if (WARN_ON(!sta))
335 		return IWL_INVALID_STATION;
336 
337 	return ((struct iwl_station_priv *)sta->drv_priv)->sta_id;
338 }
339 
340 int iwlagn_alloc_bcast_station(struct iwl_priv *priv,
341 			       struct iwl_rxon_context *ctx);
342 int iwlagn_add_bssid_station(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
343 			     const u8 *addr, u8 *sta_id_r);
344 int iwl_remove_default_wep_key(struct iwl_priv *priv,
345 			       struct iwl_rxon_context *ctx,
346 			       struct ieee80211_key_conf *key);
347 int iwl_set_default_wep_key(struct iwl_priv *priv,
348 			    struct iwl_rxon_context *ctx,
349 			    struct ieee80211_key_conf *key);
350 int iwl_restore_default_wep_keys(struct iwl_priv *priv,
351 				 struct iwl_rxon_context *ctx);
352 int iwl_set_dynamic_key(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
353 			struct ieee80211_key_conf *key,
354 			struct ieee80211_sta *sta);
355 int iwl_remove_dynamic_key(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
356 			   struct ieee80211_key_conf *key,
357 			   struct ieee80211_sta *sta);
358 void iwl_update_tkip_key(struct iwl_priv *priv,
359 			 struct ieee80211_vif *vif,
360 			 struct ieee80211_key_conf *keyconf,
361 			 struct ieee80211_sta *sta, u32 iv32, u16 *phase1key);
362 int iwl_sta_tx_modify_enable_tid(struct iwl_priv *priv, int sta_id, int tid);
363 int iwl_sta_rx_agg_start(struct iwl_priv *priv, struct ieee80211_sta *sta,
364 			 int tid, u16 ssn);
365 int iwl_sta_rx_agg_stop(struct iwl_priv *priv, struct ieee80211_sta *sta,
366 			int tid);
367 void iwl_sta_modify_sleep_tx_count(struct iwl_priv *priv, int sta_id, int cnt);
368 int iwl_update_bcast_station(struct iwl_priv *priv,
369 			     struct iwl_rxon_context *ctx);
370 int iwl_update_bcast_stations(struct iwl_priv *priv);
371 
372 /* rate */
373 static inline u32 iwl_ant_idx_to_flags(u8 ant_idx)
374 {
375 	return BIT(ant_idx) << RATE_MCS_ANT_POS;
376 }
377 
378 static inline u8 iwl_hw_get_rate(__le32 rate_n_flags)
379 {
380 	return le32_to_cpu(rate_n_flags) & RATE_MCS_RATE_MSK;
381 }
382 
383 static inline __le32 iwl_hw_set_rate_n_flags(u8 rate, u32 flags)
384 {
385 	return cpu_to_le32(flags|(u32)rate);
386 }
387 
388 int iwl_alive_start(struct iwl_priv *priv);
389 
390 #ifdef CONFIG_IWLWIFI_DEBUG
391 void iwl_print_rx_config_cmd(struct iwl_priv *priv,
392 			     enum iwl_rxon_context_id ctxid);
393 #else
394 static inline void iwl_print_rx_config_cmd(struct iwl_priv *priv,
395 					   enum iwl_rxon_context_id ctxid)
396 {
397 }
398 #endif
399 
400 /* status checks */
401 
402 static inline int iwl_is_ready(struct iwl_priv *priv)
403 {
404 	/* The adapter is 'ready' if READY EXIT_PENDING is not set */
405 	return test_bit(STATUS_READY, &priv->status) &&
406 	       !test_bit(STATUS_EXIT_PENDING, &priv->status);
407 }
408 
409 static inline int iwl_is_alive(struct iwl_priv *priv)
410 {
411 	return test_bit(STATUS_ALIVE, &priv->status);
412 }
413 
414 static inline int iwl_is_rfkill(struct iwl_priv *priv)
415 {
416 	return test_bit(STATUS_RF_KILL_HW, &priv->status);
417 }
418 
419 static inline int iwl_is_ctkill(struct iwl_priv *priv)
420 {
421 	return test_bit(STATUS_CT_KILL, &priv->status);
422 }
423 
424 static inline int iwl_is_ready_rf(struct iwl_priv *priv)
425 {
426 	if (iwl_is_rfkill(priv))
427 		return 0;
428 
429 	return iwl_is_ready(priv);
430 }
431 
432 static inline void iwl_dvm_set_pmi(struct iwl_priv *priv, bool state)
433 {
434 	if (state)
435 		set_bit(STATUS_POWER_PMI, &priv->status);
436 	else
437 		clear_bit(STATUS_POWER_PMI, &priv->status);
438 	iwl_trans_set_pmi(priv->trans, state);
439 }
440 
441 #ifdef CONFIG_IWLWIFI_DEBUGFS
442 int iwl_dbgfs_register(struct iwl_priv *priv, struct dentry *dbgfs_dir);
443 #else
444 static inline int iwl_dbgfs_register(struct iwl_priv *priv,
445 				     struct dentry *dbgfs_dir)
446 {
447 	return 0;
448 }
449 #endif /* CONFIG_IWLWIFI_DEBUGFS */
450 
451 #ifdef CONFIG_IWLWIFI_DEBUG
452 #define IWL_DEBUG_QUIET_RFKILL(m, fmt, args...)	\
453 do {									\
454 	if (!iwl_is_rfkill((m)))					\
455 		IWL_ERR(m, fmt, ##args);				\
456 	else								\
457 		__iwl_err((m)->dev, true,				\
458 			  !iwl_have_debug_level(IWL_DL_RADIO),		\
459 			  fmt, ##args);					\
460 } while (0)
461 #else
462 #define IWL_DEBUG_QUIET_RFKILL(m, fmt, args...)	\
463 do {									\
464 	if (!iwl_is_rfkill((m)))					\
465 		IWL_ERR(m, fmt, ##args);				\
466 	else								\
467 		__iwl_err((m)->dev, true, true, fmt, ##args);	\
468 } while (0)
469 #endif				/* CONFIG_IWLWIFI_DEBUG */
470 
471 #endif /* __iwl_agn_h__ */
472