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