xref: /openbmc/linux/drivers/net/wireless/ath/ath9k/htc.h (revision 719c4cf6)
1 /*
2  * Copyright (c) 2010 Atheros Communications Inc.
3  *
4  * Permission to use, copy, modify, and/or distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16 
17 #ifndef HTC_H
18 #define HTC_H
19 
20 #include <linux/module.h>
21 #include <linux/usb.h>
22 #include <linux/firmware.h>
23 #include <linux/skbuff.h>
24 #include <linux/netdevice.h>
25 #include <linux/leds.h>
26 #include <linux/slab.h>
27 #include <net/mac80211.h>
28 
29 #include "common.h"
30 #include "htc_hst.h"
31 #include "hif_usb.h"
32 #include "wmi.h"
33 
34 #define ATH_STA_SHORT_CALINTERVAL 1000    /* 1 second */
35 #define ATH_AP_SHORT_CALINTERVAL  100     /* 100 ms */
36 #define ATH_ANI_POLLINTERVAL      100     /* 100 ms */
37 #define ATH_LONG_CALINTERVAL      30000   /* 30 seconds */
38 #define ATH_RESTART_CALINTERVAL   1200000 /* 20 minutes */
39 
40 #define ATH_DEFAULT_BMISS_LIMIT 10
41 #define IEEE80211_MS_TO_TU(x)   (((x) * 1000) / 1024)
42 #define TSF_TO_TU(_h, _l) \
43 	((((u32)(_h)) << 22) | (((u32)(_l)) >> 10))
44 
45 extern struct ieee80211_ops ath9k_htc_ops;
46 extern int htc_modparam_nohwcrypt;
47 
48 enum htc_phymode {
49 	HTC_MODE_AUTO		= 0,
50 	HTC_MODE_11A		= 1,
51 	HTC_MODE_11B		= 2,
52 	HTC_MODE_11G		= 3,
53 	HTC_MODE_FH		= 4,
54 	HTC_MODE_TURBO_A	= 5,
55 	HTC_MODE_TURBO_G	= 6,
56 	HTC_MODE_11NA		= 7,
57 	HTC_MODE_11NG		= 8
58 };
59 
60 enum htc_opmode {
61 	HTC_M_STA	= 1,
62 	HTC_M_IBSS	= 0,
63 	HTC_M_AHDEMO	= 3,
64 	HTC_M_HOSTAP	= 6,
65 	HTC_M_MONITOR	= 8,
66 	HTC_M_WDS	= 2
67 };
68 
69 #define ATH9K_HTC_HDRSPACE sizeof(struct htc_frame_hdr)
70 #define ATH9K_HTC_AMPDU	1
71 #define ATH9K_HTC_NORMAL 2
72 
73 #define ATH9K_HTC_TX_CTSONLY      0x1
74 #define ATH9K_HTC_TX_RTSCTS       0x2
75 #define ATH9K_HTC_TX_USE_MIN_RATE 0x100
76 
77 struct tx_frame_hdr {
78 	u8 data_type;
79 	u8 node_idx;
80 	u8 vif_idx;
81 	u8 tidno;
82 	__be32 flags; /* ATH9K_HTC_TX_* */
83 	u8 key_type;
84 	u8 keyix;
85 	u8 reserved[26];
86 } __packed;
87 
88 struct tx_mgmt_hdr {
89 	u8 node_idx;
90 	u8 vif_idx;
91 	u8 tidno;
92 	u8 flags;
93 	u8 key_type;
94 	u8 keyix;
95 	u16 reserved;
96 } __packed;
97 
98 struct tx_beacon_header {
99 	u8 vif_index;
100 	u8 len_changed;
101 	u16 rev;
102 } __packed;
103 
104 struct ath9k_htc_target_hw {
105 	u32 flags;
106 	u32 flags_ext;
107 	u32 ampdu_limit;
108 	u8 ampdu_subframes;
109 	u8 tx_chainmask;
110 	u8 tx_chainmask_legacy;
111 	u8 rtscts_ratecode;
112 	u8 protmode;
113 } __packed;
114 
115 struct ath9k_htc_cap_target {
116 	u32 flags;
117 	u32 flags_ext;
118 	u32 ampdu_limit;
119 	u8 ampdu_subframes;
120 	u8 tx_chainmask;
121 	u8 tx_chainmask_legacy;
122 	u8 rtscts_ratecode;
123 	u8 protmode;
124 } __packed;
125 
126 struct ath9k_htc_target_vif {
127 	u8 index;
128 	u8 des_bssid[ETH_ALEN];
129 	__be32 opmode;
130 	u8 myaddr[ETH_ALEN];
131 	u8 bssid[ETH_ALEN];
132 	u32 flags;
133 	u32 flags_ext;
134 	u16 ps_sta;
135 	__be16 rtsthreshold;
136 	u8 ath_cap;
137 	u8 node;
138 	s8 mcast_rate;
139 } __packed;
140 
141 #define ATH_HTC_STA_AUTH  0x0001
142 #define ATH_HTC_STA_QOS   0x0002
143 #define ATH_HTC_STA_ERP   0x0004
144 #define ATH_HTC_STA_HT    0x0008
145 
146 /* FIXME: UAPSD variables */
147 struct ath9k_htc_target_sta {
148 	u16 associd;
149 	u16 txpower;
150 	u32 ucastkey;
151 	u8 macaddr[ETH_ALEN];
152 	u8 bssid[ETH_ALEN];
153 	u8 sta_index;
154 	u8 vif_index;
155 	u8 vif_sta;
156 	__be16 flags; /* ATH_HTC_STA_* */
157 	u16 htcap;
158 	u8 valid;
159 	u16 capinfo;
160 	struct ath9k_htc_target_hw *hw;
161 	struct ath9k_htc_target_vif *vif;
162 	u16 txseqmgmt;
163 	u8 is_vif_sta;
164 	u16 maxampdu;
165 	u16 iv16;
166 	u32 iv32;
167 } __packed;
168 
169 struct ath9k_htc_target_aggr {
170 	u8 sta_index;
171 	u8 tidno;
172 	u8 aggr_enable;
173 	u8 padding;
174 } __packed;
175 
176 #define ATH_HTC_RATE_MAX 30
177 
178 #define WLAN_RC_DS_FLAG  0x01
179 #define WLAN_RC_40_FLAG  0x02
180 #define WLAN_RC_SGI_FLAG 0x04
181 #define WLAN_RC_HT_FLAG  0x08
182 
183 struct ath9k_htc_rateset {
184 	u8 rs_nrates;
185 	u8 rs_rates[ATH_HTC_RATE_MAX];
186 };
187 
188 struct ath9k_htc_rate {
189 	struct ath9k_htc_rateset legacy_rates;
190 	struct ath9k_htc_rateset ht_rates;
191 } __packed;
192 
193 struct ath9k_htc_target_rate {
194 	u8 sta_index;
195 	u8 isnew;
196 	__be32 capflags;
197 	struct ath9k_htc_rate rates;
198 };
199 
200 struct ath9k_htc_target_stats {
201 	__be32 tx_shortretry;
202 	__be32 tx_longretry;
203 	__be32 tx_xretries;
204 	__be32 ht_txunaggr_xretry;
205 	__be32 ht_tx_xretries;
206 } __packed;
207 
208 #define ATH9K_HTC_MAX_VIF 2
209 #define ATH9K_HTC_MAX_BCN_VIF 2
210 
211 #define INC_VIF(_priv, _type) do {		\
212 		switch (_type) {		\
213 		case NL80211_IFTYPE_STATION:	\
214 			_priv->num_sta_vif++;	\
215 			break;			\
216 		case NL80211_IFTYPE_ADHOC:	\
217 			_priv->num_ibss_vif++;	\
218 			break;			\
219 		case NL80211_IFTYPE_AP:		\
220 			_priv->num_ap_vif++;	\
221 			break;			\
222 		default:			\
223 			break;			\
224 		}				\
225 	} while (0)
226 
227 #define DEC_VIF(_priv, _type) do {		\
228 		switch (_type) {		\
229 		case NL80211_IFTYPE_STATION:	\
230 			_priv->num_sta_vif--;	\
231 			break;			\
232 		case NL80211_IFTYPE_ADHOC:	\
233 			_priv->num_ibss_vif--;	\
234 			break;			\
235 		case NL80211_IFTYPE_AP:		\
236 			_priv->num_ap_vif--;	\
237 			break;			\
238 		default:			\
239 			break;			\
240 		}				\
241 	} while (0)
242 
243 struct ath9k_htc_vif {
244 	u8 index;
245 	u16 seq_no;
246 	bool beacon_configured;
247 	int bslot;
248 	__le64 tsfadjust;
249 };
250 
251 struct ath9k_vif_iter_data {
252 	const u8 *hw_macaddr;
253 	u8 mask[ETH_ALEN];
254 };
255 
256 #define ATH9K_HTC_MAX_STA 8
257 #define ATH9K_HTC_MAX_TID 8
258 
259 enum tid_aggr_state {
260 	AGGR_STOP = 0,
261 	AGGR_PROGRESS,
262 	AGGR_START,
263 	AGGR_OPERATIONAL
264 };
265 
266 struct ath9k_htc_sta {
267 	u8 index;
268 	enum tid_aggr_state tid_state[ATH9K_HTC_MAX_TID];
269 };
270 
271 #define ATH9K_HTC_RXBUF 256
272 #define HTC_RX_FRAME_HEADER_SIZE 40
273 
274 struct ath9k_htc_rxbuf {
275 	bool in_process;
276 	struct sk_buff *skb;
277 	struct ath_htc_rx_status rxstatus;
278 	struct list_head list;
279 };
280 
281 struct ath9k_htc_rx {
282 	int last_rssi; /* FIXME: per-STA */
283 	struct list_head rxbuf;
284 	spinlock_t rxbuflock;
285 };
286 
287 struct ath9k_htc_tx_ctl {
288 	u8 type; /* ATH9K_HTC_* */
289 };
290 
291 #ifdef CONFIG_ATH9K_HTC_DEBUGFS
292 
293 #define TX_STAT_INC(c) (hif_dev->htc_handle->drv_priv->debug.tx_stats.c++)
294 #define RX_STAT_INC(c) (hif_dev->htc_handle->drv_priv->debug.rx_stats.c++)
295 #define CAB_STAT_INC   priv->debug.tx_stats.cab_queued++
296 
297 #define TX_QSTAT_INC(q) (priv->debug.tx_stats.queue_stats[q]++)
298 
299 void ath9k_htc_err_stat_rx(struct ath9k_htc_priv *priv,
300 			   struct ath_htc_rx_status *rxs);
301 
302 struct ath_tx_stats {
303 	u32 buf_queued;
304 	u32 buf_completed;
305 	u32 skb_queued;
306 	u32 skb_completed;
307 	u32 skb_dropped;
308 	u32 cab_queued;
309 	u32 queue_stats[WME_NUM_AC];
310 };
311 
312 struct ath_rx_stats {
313 	u32 skb_allocated;
314 	u32 skb_completed;
315 	u32 skb_dropped;
316 	u32 err_crc;
317 	u32 err_decrypt_crc;
318 	u32 err_mic;
319 	u32 err_pre_delim;
320 	u32 err_post_delim;
321 	u32 err_decrypt_busy;
322 	u32 err_phy;
323 	u32 err_phy_stats[ATH9K_PHYERR_MAX];
324 };
325 
326 struct ath9k_debug {
327 	struct dentry *debugfs_phy;
328 	struct dentry *debugfs_tgt_stats;
329 	struct dentry *debugfs_xmit;
330 	struct dentry *debugfs_recv;
331 	struct ath_tx_stats tx_stats;
332 	struct ath_rx_stats rx_stats;
333 	u32 txrate;
334 };
335 
336 #else
337 
338 #define TX_STAT_INC(c) do { } while (0)
339 #define RX_STAT_INC(c) do { } while (0)
340 #define CAB_STAT_INC   do { } while (0)
341 
342 #define TX_QSTAT_INC(c) do { } while (0)
343 
344 static inline void ath9k_htc_err_stat_rx(struct ath9k_htc_priv *priv,
345 					 struct ath_htc_rx_status *rxs)
346 {
347 }
348 
349 #endif /* CONFIG_ATH9K_HTC_DEBUGFS */
350 
351 #define ATH_LED_PIN_DEF             1
352 #define ATH_LED_PIN_9287            10
353 #define ATH_LED_PIN_9271            15
354 #define ATH_LED_PIN_7010            12
355 #define ATH_LED_ON_DURATION_IDLE    350	/* in msecs */
356 #define ATH_LED_OFF_DURATION_IDLE   250	/* in msecs */
357 
358 enum ath_led_type {
359 	ATH_LED_RADIO,
360 	ATH_LED_ASSOC,
361 	ATH_LED_TX,
362 	ATH_LED_RX
363 };
364 
365 struct ath_led {
366 	struct ath9k_htc_priv *priv;
367 	struct led_classdev led_cdev;
368 	enum ath_led_type led_type;
369 	struct delayed_work brightness_work;
370 	char name[32];
371 	bool registered;
372 	int brightness;
373 };
374 
375 #define BSTUCK_THRESHOLD 10
376 
377 /*
378  * Adjust these when the max. no of beaconing interfaces is
379  * increased.
380  */
381 #define DEFAULT_SWBA_RESPONSE 40 /* in TUs */
382 #define MIN_SWBA_RESPONSE     10 /* in TUs */
383 
384 struct htc_beacon_config {
385 	struct ieee80211_vif *bslot[ATH9K_HTC_MAX_BCN_VIF];
386 	u16 beacon_interval;
387 	u16 dtim_period;
388 	u16 bmiss_timeout;
389 	u32 bmiss_cnt;
390 };
391 
392 struct ath_btcoex {
393 	u32 bt_priority_cnt;
394 	unsigned long bt_priority_time;
395 	int bt_stomp_type; /* Types of BT stomping */
396 	u32 btcoex_no_stomp;
397 	u32 btcoex_period;
398 	u32 btscan_no_stomp;
399 };
400 
401 void ath_htc_init_btcoex_work(struct ath9k_htc_priv *priv);
402 void ath_htc_resume_btcoex_work(struct ath9k_htc_priv *priv);
403 void ath_htc_cancel_btcoex_work(struct ath9k_htc_priv *priv);
404 
405 #define OP_INVALID		   BIT(0)
406 #define OP_SCANNING		   BIT(1)
407 #define OP_LED_ASSOCIATED	   BIT(2)
408 #define OP_LED_ON		   BIT(3)
409 #define OP_ENABLE_BEACON	   BIT(4)
410 #define OP_LED_DEINIT		   BIT(5)
411 #define OP_BT_PRIORITY_DETECTED    BIT(6)
412 #define OP_BT_SCAN                 BIT(7)
413 #define OP_ANI_RUNNING             BIT(8)
414 #define OP_TSF_RESET               BIT(9)
415 
416 struct ath9k_htc_priv {
417 	struct device *dev;
418 	struct ieee80211_hw *hw;
419 	struct ath_hw *ah;
420 	struct htc_target *htc;
421 	struct wmi *wmi;
422 
423 	u16 fw_version_major;
424 	u16 fw_version_minor;
425 
426 	enum htc_endpoint_id wmi_cmd_ep;
427 	enum htc_endpoint_id beacon_ep;
428 	enum htc_endpoint_id cab_ep;
429 	enum htc_endpoint_id uapsd_ep;
430 	enum htc_endpoint_id mgmt_ep;
431 	enum htc_endpoint_id data_be_ep;
432 	enum htc_endpoint_id data_bk_ep;
433 	enum htc_endpoint_id data_vi_ep;
434 	enum htc_endpoint_id data_vo_ep;
435 
436 	u8 vif_slot;
437 	u8 mon_vif_idx;
438 	u8 sta_slot;
439 	u8 vif_sta_pos[ATH9K_HTC_MAX_VIF];
440 	u8 num_ibss_vif;
441 	u8 num_sta_vif;
442 	u8 num_ap_vif;
443 
444 	u16 op_flags;
445 	u16 curtxpow;
446 	u16 txpowlimit;
447 	u16 nvifs;
448 	u16 nstations;
449 	bool rearm_ani;
450 	bool reconfig_beacon;
451 
452 	struct ath9k_hw_cal_data caldata;
453 
454 	spinlock_t beacon_lock;
455 
456 	bool tx_queues_stop;
457 	spinlock_t tx_lock;
458 
459 	struct htc_beacon_config cur_beacon_conf;
460 	unsigned int rxfilter;
461 	struct tasklet_struct swba_tasklet;
462 	struct tasklet_struct rx_tasklet;
463 	struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
464 	struct ath9k_htc_rx rx;
465 	struct tasklet_struct tx_tasklet;
466 	struct sk_buff_head tx_queue;
467 	struct delayed_work ani_work;
468 	struct work_struct ps_work;
469 	struct work_struct fatal_work;
470 
471 	struct mutex htc_pm_lock;
472 	unsigned long ps_usecount;
473 	bool ps_enabled;
474 	bool ps_idle;
475 
476 	struct ath_led radio_led;
477 	struct ath_led assoc_led;
478 	struct ath_led tx_led;
479 	struct ath_led rx_led;
480 	struct delayed_work ath9k_led_blink_work;
481 	int led_on_duration;
482 	int led_off_duration;
483 	int led_on_cnt;
484 	int led_off_cnt;
485 
486 	int beaconq;
487 	int cabq;
488 	int hwq_map[WME_NUM_AC];
489 
490 	struct ath_btcoex btcoex;
491 	struct delayed_work coex_period_work;
492 	struct delayed_work duty_cycle_work;
493 #ifdef CONFIG_ATH9K_HTC_DEBUGFS
494 	struct ath9k_debug debug;
495 #endif
496 	struct mutex mutex;
497 };
498 
499 static inline void ath_read_cachesize(struct ath_common *common, int *csz)
500 {
501 	common->bus_ops->read_cachesize(common, csz);
502 }
503 
504 void ath9k_htc_reset(struct ath9k_htc_priv *priv);
505 
506 void ath9k_htc_assign_bslot(struct ath9k_htc_priv *priv,
507 			    struct ieee80211_vif *vif);
508 void ath9k_htc_remove_bslot(struct ath9k_htc_priv *priv,
509 			    struct ieee80211_vif *vif);
510 void ath9k_htc_set_tsfadjust(struct ath9k_htc_priv *priv,
511 			     struct ieee80211_vif *vif);
512 void ath9k_htc_beaconq_config(struct ath9k_htc_priv *priv);
513 void ath9k_htc_beacon_config(struct ath9k_htc_priv *priv,
514 			     struct ieee80211_vif *vif);
515 void ath9k_htc_beacon_reconfig(struct ath9k_htc_priv *priv);
516 void ath9k_htc_swba(struct ath9k_htc_priv *priv,
517 		    struct wmi_event_swba *swba);
518 
519 void ath9k_htc_rxep(void *priv, struct sk_buff *skb,
520 		    enum htc_endpoint_id ep_id);
521 void ath9k_htc_txep(void *priv, struct sk_buff *skb, enum htc_endpoint_id ep_id,
522 		    bool txok);
523 void ath9k_htc_beaconep(void *drv_priv, struct sk_buff *skb,
524 			enum htc_endpoint_id ep_id, bool txok);
525 
526 int ath9k_htc_update_cap_target(struct ath9k_htc_priv *priv);
527 void ath9k_htc_station_work(struct work_struct *work);
528 void ath9k_htc_aggr_work(struct work_struct *work);
529 void ath9k_htc_ani_work(struct work_struct *work);
530 void ath9k_htc_start_ani(struct ath9k_htc_priv *priv);
531 void ath9k_htc_stop_ani(struct ath9k_htc_priv *priv);
532 
533 int ath9k_tx_init(struct ath9k_htc_priv *priv);
534 void ath9k_tx_tasklet(unsigned long data);
535 int ath9k_htc_tx_start(struct ath9k_htc_priv *priv,
536 		       struct sk_buff *skb, bool is_cab);
537 void ath9k_tx_cleanup(struct ath9k_htc_priv *priv);
538 bool ath9k_htc_txq_setup(struct ath9k_htc_priv *priv, int subtype);
539 int ath9k_htc_cabq_setup(struct ath9k_htc_priv *priv);
540 int get_hw_qnum(u16 queue, int *hwq_map);
541 int ath_htc_txq_update(struct ath9k_htc_priv *priv, int qnum,
542 		       struct ath9k_tx_queue_info *qinfo);
543 
544 int ath9k_rx_init(struct ath9k_htc_priv *priv);
545 void ath9k_rx_cleanup(struct ath9k_htc_priv *priv);
546 void ath9k_host_rx_init(struct ath9k_htc_priv *priv);
547 void ath9k_rx_tasklet(unsigned long data);
548 u32 ath9k_htc_calcrxfilter(struct ath9k_htc_priv *priv);
549 
550 void ath9k_htc_ps_wakeup(struct ath9k_htc_priv *priv);
551 void ath9k_htc_ps_restore(struct ath9k_htc_priv *priv);
552 void ath9k_ps_work(struct work_struct *work);
553 bool ath9k_htc_setpower(struct ath9k_htc_priv *priv,
554 			enum ath9k_power_mode mode);
555 
556 void ath9k_start_rfkill_poll(struct ath9k_htc_priv *priv);
557 void ath9k_htc_rfkill_poll_state(struct ieee80211_hw *hw);
558 void ath9k_htc_radio_enable(struct ieee80211_hw *hw);
559 void ath9k_htc_radio_disable(struct ieee80211_hw *hw);
560 void ath9k_led_stop_brightness(struct ath9k_htc_priv *priv);
561 void ath9k_init_leds(struct ath9k_htc_priv *priv);
562 void ath9k_deinit_leds(struct ath9k_htc_priv *priv);
563 
564 int ath9k_htc_probe_device(struct htc_target *htc_handle, struct device *dev,
565 			   u16 devid, char *product, u32 drv_info);
566 void ath9k_htc_disconnect_device(struct htc_target *htc_handle, bool hotunplug);
567 #ifdef CONFIG_PM
568 void ath9k_htc_suspend(struct htc_target *htc_handle);
569 int ath9k_htc_resume(struct htc_target *htc_handle);
570 #endif
571 #ifdef CONFIG_ATH9K_HTC_DEBUGFS
572 int ath9k_htc_debug_create_root(void);
573 void ath9k_htc_debug_remove_root(void);
574 int ath9k_htc_init_debug(struct ath_hw *ah);
575 void ath9k_htc_exit_debug(struct ath_hw *ah);
576 #else
577 static inline int ath9k_htc_debug_create_root(void) { return 0; };
578 static inline void ath9k_htc_debug_remove_root(void) {};
579 static inline int ath9k_htc_init_debug(struct ath_hw *ah) { return 0; };
580 static inline void ath9k_htc_exit_debug(struct ath_hw *ah) {};
581 #endif /* CONFIG_ATH9K_HTC_DEBUGFS */
582 
583 #endif /* HTC_H */
584