xref: /openbmc/linux/drivers/net/wireless/ath/ath9k/htc.h (revision 4800cd83)
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_ANI_POLLINTERVAL      100     /* 100 ms */
36 #define ATH_LONG_CALINTERVAL      30000   /* 30 seconds */
37 #define ATH_RESTART_CALINTERVAL   1200000 /* 20 minutes */
38 
39 #define ATH_DEFAULT_BMISS_LIMIT 10
40 #define IEEE80211_MS_TO_TU(x)   (((x) * 1000) / 1024)
41 #define TSF_TO_TU(_h, _l) \
42 	((((u32)(_h)) << 22) | (((u32)(_l)) >> 10))
43 
44 extern struct ieee80211_ops ath9k_htc_ops;
45 extern int htc_modparam_nohwcrypt;
46 
47 enum htc_phymode {
48 	HTC_MODE_AUTO		= 0,
49 	HTC_MODE_11A		= 1,
50 	HTC_MODE_11B		= 2,
51 	HTC_MODE_11G		= 3,
52 	HTC_MODE_FH		= 4,
53 	HTC_MODE_TURBO_A	= 5,
54 	HTC_MODE_TURBO_G	= 6,
55 	HTC_MODE_11NA		= 7,
56 	HTC_MODE_11NG		= 8
57 };
58 
59 enum htc_opmode {
60 	HTC_M_STA	= 1,
61 	HTC_M_IBSS	= 0,
62 	HTC_M_AHDEMO	= 3,
63 	HTC_M_HOSTAP	= 6,
64 	HTC_M_MONITOR	= 8,
65 	HTC_M_WDS	= 2
66 };
67 
68 #define ATH9K_HTC_HDRSPACE sizeof(struct htc_frame_hdr)
69 #define ATH9K_HTC_AMPDU	1
70 #define ATH9K_HTC_NORMAL 2
71 
72 #define ATH9K_HTC_TX_CTSONLY      0x1
73 #define ATH9K_HTC_TX_RTSCTS       0x2
74 #define ATH9K_HTC_TX_USE_MIN_RATE 0x100
75 
76 struct tx_frame_hdr {
77 	u8 data_type;
78 	u8 node_idx;
79 	u8 vif_idx;
80 	u8 tidno;
81 	__be32 flags; /* ATH9K_HTC_TX_* */
82 	u8 key_type;
83 	u8 keyix;
84 	u8 reserved[26];
85 } __packed;
86 
87 struct tx_mgmt_hdr {
88 	u8 node_idx;
89 	u8 vif_idx;
90 	u8 tidno;
91 	u8 flags;
92 	u8 key_type;
93 	u8 keyix;
94 	u16 reserved;
95 } __packed;
96 
97 struct tx_beacon_header {
98 	u8 len_changed;
99 	u8 vif_index;
100 	u16 rev;
101 } __packed;
102 
103 struct ath9k_htc_target_hw {
104 	u32 flags;
105 	u32 flags_ext;
106 	u32 ampdu_limit;
107 	u8 ampdu_subframes;
108 	u8 tx_chainmask;
109 	u8 tx_chainmask_legacy;
110 	u8 rtscts_ratecode;
111 	u8 protmode;
112 } __packed;
113 
114 struct ath9k_htc_cap_target {
115 	u32 flags;
116 	u32 flags_ext;
117 	u32 ampdu_limit;
118 	u8 ampdu_subframes;
119 	u8 tx_chainmask;
120 	u8 tx_chainmask_legacy;
121 	u8 rtscts_ratecode;
122 	u8 protmode;
123 } __packed;
124 
125 struct ath9k_htc_target_vif {
126 	u8 index;
127 	u8 des_bssid[ETH_ALEN];
128 	__be32 opmode;
129 	u8 myaddr[ETH_ALEN];
130 	u8 bssid[ETH_ALEN];
131 	u32 flags;
132 	u32 flags_ext;
133 	u16 ps_sta;
134 	__be16 rtsthreshold;
135 	u8 ath_cap;
136 	u8 node;
137 	s8 mcast_rate;
138 } __packed;
139 
140 #define ATH_HTC_STA_AUTH  0x0001
141 #define ATH_HTC_STA_QOS   0x0002
142 #define ATH_HTC_STA_ERP   0x0004
143 #define ATH_HTC_STA_HT    0x0008
144 
145 /* FIXME: UAPSD variables */
146 struct ath9k_htc_target_sta {
147 	u16 associd;
148 	u16 txpower;
149 	u32 ucastkey;
150 	u8 macaddr[ETH_ALEN];
151 	u8 bssid[ETH_ALEN];
152 	u8 sta_index;
153 	u8 vif_index;
154 	u8 vif_sta;
155 	__be16 flags; /* ATH_HTC_STA_* */
156 	u16 htcap;
157 	u8 valid;
158 	u16 capinfo;
159 	struct ath9k_htc_target_hw *hw;
160 	struct ath9k_htc_target_vif *vif;
161 	u16 txseqmgmt;
162 	u8 is_vif_sta;
163 	u16 maxampdu;
164 	u16 iv16;
165 	u32 iv32;
166 } __packed;
167 
168 struct ath9k_htc_target_aggr {
169 	u8 sta_index;
170 	u8 tidno;
171 	u8 aggr_enable;
172 	u8 padding;
173 } __packed;
174 
175 #define ATH_HTC_RATE_MAX 30
176 
177 #define WLAN_RC_DS_FLAG  0x01
178 #define WLAN_RC_40_FLAG  0x02
179 #define WLAN_RC_SGI_FLAG 0x04
180 #define WLAN_RC_HT_FLAG  0x08
181 
182 struct ath9k_htc_rateset {
183 	u8 rs_nrates;
184 	u8 rs_rates[ATH_HTC_RATE_MAX];
185 };
186 
187 struct ath9k_htc_rate {
188 	struct ath9k_htc_rateset legacy_rates;
189 	struct ath9k_htc_rateset ht_rates;
190 } __packed;
191 
192 struct ath9k_htc_target_rate {
193 	u8 sta_index;
194 	u8 isnew;
195 	__be32 capflags;
196 	struct ath9k_htc_rate rates;
197 };
198 
199 struct ath9k_htc_target_stats {
200 	__be32 tx_shortretry;
201 	__be32 tx_longretry;
202 	__be32 tx_xretries;
203 	__be32 ht_txunaggr_xretry;
204 	__be32 ht_tx_xretries;
205 } __packed;
206 
207 struct ath9k_htc_vif {
208 	u8 index;
209 };
210 
211 #define ATH9K_HTC_MAX_STA 8
212 #define ATH9K_HTC_MAX_TID 8
213 
214 enum tid_aggr_state {
215 	AGGR_STOP = 0,
216 	AGGR_PROGRESS,
217 	AGGR_START,
218 	AGGR_OPERATIONAL
219 };
220 
221 struct ath9k_htc_sta {
222 	u8 index;
223 	enum tid_aggr_state tid_state[ATH9K_HTC_MAX_TID];
224 };
225 
226 #define ATH9K_HTC_RXBUF 256
227 #define HTC_RX_FRAME_HEADER_SIZE 40
228 
229 struct ath9k_htc_rxbuf {
230 	bool in_process;
231 	struct sk_buff *skb;
232 	struct ath_htc_rx_status rxstatus;
233 	struct list_head list;
234 };
235 
236 struct ath9k_htc_rx {
237 	int last_rssi; /* FIXME: per-STA */
238 	struct list_head rxbuf;
239 	spinlock_t rxbuflock;
240 };
241 
242 struct ath9k_htc_tx_ctl {
243 	u8 type; /* ATH9K_HTC_* */
244 };
245 
246 #ifdef CONFIG_ATH9K_HTC_DEBUGFS
247 
248 #define TX_STAT_INC(c) (hif_dev->htc_handle->drv_priv->debug.tx_stats.c++)
249 #define RX_STAT_INC(c) (hif_dev->htc_handle->drv_priv->debug.rx_stats.c++)
250 
251 #define TX_QSTAT_INC(q) (priv->debug.tx_stats.queue_stats[q]++)
252 
253 struct ath_tx_stats {
254 	u32 buf_queued;
255 	u32 buf_completed;
256 	u32 skb_queued;
257 	u32 skb_completed;
258 	u32 skb_dropped;
259 	u32 queue_stats[WME_NUM_AC];
260 };
261 
262 struct ath_rx_stats {
263 	u32 skb_allocated;
264 	u32 skb_completed;
265 	u32 skb_dropped;
266 };
267 
268 struct ath9k_debug {
269 	struct dentry *debugfs_phy;
270 	struct dentry *debugfs_tgt_stats;
271 	struct dentry *debugfs_xmit;
272 	struct dentry *debugfs_recv;
273 	struct ath_tx_stats tx_stats;
274 	struct ath_rx_stats rx_stats;
275 	u32 txrate;
276 };
277 
278 #else
279 
280 #define TX_STAT_INC(c) do { } while (0)
281 #define RX_STAT_INC(c) do { } while (0)
282 
283 #define TX_QSTAT_INC(c) do { } while (0)
284 
285 #endif /* CONFIG_ATH9K_HTC_DEBUGFS */
286 
287 #define ATH_LED_PIN_DEF             1
288 #define ATH_LED_PIN_9287            8
289 #define ATH_LED_PIN_9271            15
290 #define ATH_LED_PIN_7010            12
291 #define ATH_LED_ON_DURATION_IDLE    350	/* in msecs */
292 #define ATH_LED_OFF_DURATION_IDLE   250	/* in msecs */
293 
294 enum ath_led_type {
295 	ATH_LED_RADIO,
296 	ATH_LED_ASSOC,
297 	ATH_LED_TX,
298 	ATH_LED_RX
299 };
300 
301 struct ath_led {
302 	struct ath9k_htc_priv *priv;
303 	struct led_classdev led_cdev;
304 	enum ath_led_type led_type;
305 	struct delayed_work brightness_work;
306 	char name[32];
307 	bool registered;
308 	int brightness;
309 };
310 
311 struct htc_beacon_config {
312 	u16 beacon_interval;
313 	u16 listen_interval;
314 	u16 dtim_period;
315 	u16 bmiss_timeout;
316 	u8 dtim_count;
317 };
318 
319 struct ath_btcoex {
320 	u32 bt_priority_cnt;
321 	unsigned long bt_priority_time;
322 	int bt_stomp_type; /* Types of BT stomping */
323 	u32 btcoex_no_stomp;
324 	u32 btcoex_period;
325 	u32 btscan_no_stomp;
326 };
327 
328 void ath_htc_init_btcoex_work(struct ath9k_htc_priv *priv);
329 void ath_htc_resume_btcoex_work(struct ath9k_htc_priv *priv);
330 void ath_htc_cancel_btcoex_work(struct ath9k_htc_priv *priv);
331 
332 #define OP_INVALID		   BIT(0)
333 #define OP_SCANNING		   BIT(1)
334 #define OP_LED_ASSOCIATED	   BIT(2)
335 #define OP_LED_ON		   BIT(3)
336 #define OP_PREAMBLE_SHORT	   BIT(4)
337 #define OP_PROTECT_ENABLE	   BIT(5)
338 #define OP_ASSOCIATED		   BIT(6)
339 #define OP_ENABLE_BEACON	   BIT(7)
340 #define OP_LED_DEINIT		   BIT(8)
341 #define OP_BT_PRIORITY_DETECTED    BIT(9)
342 #define OP_BT_SCAN                 BIT(10)
343 
344 struct ath9k_htc_priv {
345 	struct device *dev;
346 	struct ieee80211_hw *hw;
347 	struct ath_hw *ah;
348 	struct htc_target *htc;
349 	struct wmi *wmi;
350 
351 	enum htc_endpoint_id wmi_cmd_ep;
352 	enum htc_endpoint_id beacon_ep;
353 	enum htc_endpoint_id cab_ep;
354 	enum htc_endpoint_id uapsd_ep;
355 	enum htc_endpoint_id mgmt_ep;
356 	enum htc_endpoint_id data_be_ep;
357 	enum htc_endpoint_id data_bk_ep;
358 	enum htc_endpoint_id data_vi_ep;
359 	enum htc_endpoint_id data_vo_ep;
360 
361 	u16 op_flags;
362 	u16 curtxpow;
363 	u16 txpowlimit;
364 	u16 nvifs;
365 	u16 nstations;
366 	u16 seq_no;
367 	u32 bmiss_cnt;
368 
369 	struct ath9k_hw_cal_data caldata[ATH9K_NUM_CHANNELS];
370 
371 	spinlock_t beacon_lock;
372 
373 	bool tx_queues_stop;
374 	spinlock_t tx_lock;
375 
376 	struct ieee80211_vif *vif;
377 	struct htc_beacon_config cur_beacon_conf;
378 	unsigned int rxfilter;
379 	struct tasklet_struct swba_tasklet;
380 	struct tasklet_struct rx_tasklet;
381 	struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
382 	struct ath9k_htc_rx rx;
383 	struct tasklet_struct tx_tasklet;
384 	struct sk_buff_head tx_queue;
385 	struct delayed_work ath9k_ani_work;
386 	struct work_struct ps_work;
387 	struct work_struct fatal_work;
388 
389 	struct mutex htc_pm_lock;
390 	unsigned long ps_usecount;
391 	bool ps_enabled;
392 	bool ps_idle;
393 
394 	struct ath_led radio_led;
395 	struct ath_led assoc_led;
396 	struct ath_led tx_led;
397 	struct ath_led rx_led;
398 	struct delayed_work ath9k_led_blink_work;
399 	int led_on_duration;
400 	int led_off_duration;
401 	int led_on_cnt;
402 	int led_off_cnt;
403 
404 	int beaconq;
405 	int cabq;
406 	int hwq_map[WME_NUM_AC];
407 
408 	struct ath_btcoex btcoex;
409 	struct delayed_work coex_period_work;
410 	struct delayed_work duty_cycle_work;
411 #ifdef CONFIG_ATH9K_HTC_DEBUGFS
412 	struct ath9k_debug debug;
413 #endif
414 	struct mutex mutex;
415 };
416 
417 static inline void ath_read_cachesize(struct ath_common *common, int *csz)
418 {
419 	common->bus_ops->read_cachesize(common, csz);
420 }
421 
422 void ath9k_htc_reset(struct ath9k_htc_priv *priv);
423 
424 void ath9k_htc_beaconq_config(struct ath9k_htc_priv *priv);
425 void ath9k_htc_beacon_config(struct ath9k_htc_priv *priv,
426 			     struct ieee80211_vif *vif);
427 void ath9k_htc_swba(struct ath9k_htc_priv *priv, u8 beacon_pending);
428 
429 void ath9k_htc_rxep(void *priv, struct sk_buff *skb,
430 		    enum htc_endpoint_id ep_id);
431 void ath9k_htc_txep(void *priv, struct sk_buff *skb, enum htc_endpoint_id ep_id,
432 		    bool txok);
433 void ath9k_htc_beaconep(void *drv_priv, struct sk_buff *skb,
434 			enum htc_endpoint_id ep_id, bool txok);
435 
436 int ath9k_htc_update_cap_target(struct ath9k_htc_priv *priv);
437 void ath9k_htc_station_work(struct work_struct *work);
438 void ath9k_htc_aggr_work(struct work_struct *work);
439 void ath9k_ani_work(struct work_struct *work);;
440 void ath_start_ani(struct ath9k_htc_priv *priv);
441 
442 int ath9k_tx_init(struct ath9k_htc_priv *priv);
443 void ath9k_tx_tasklet(unsigned long data);
444 int ath9k_htc_tx_start(struct ath9k_htc_priv *priv, struct sk_buff *skb);
445 void ath9k_tx_cleanup(struct ath9k_htc_priv *priv);
446 bool ath9k_htc_txq_setup(struct ath9k_htc_priv *priv, int subtype);
447 int ath9k_htc_cabq_setup(struct ath9k_htc_priv *priv);
448 int get_hw_qnum(u16 queue, int *hwq_map);
449 int ath_htc_txq_update(struct ath9k_htc_priv *priv, int qnum,
450 		       struct ath9k_tx_queue_info *qinfo);
451 
452 int ath9k_rx_init(struct ath9k_htc_priv *priv);
453 void ath9k_rx_cleanup(struct ath9k_htc_priv *priv);
454 void ath9k_host_rx_init(struct ath9k_htc_priv *priv);
455 void ath9k_rx_tasklet(unsigned long data);
456 u32 ath9k_htc_calcrxfilter(struct ath9k_htc_priv *priv);
457 
458 void ath9k_htc_ps_wakeup(struct ath9k_htc_priv *priv);
459 void ath9k_htc_ps_restore(struct ath9k_htc_priv *priv);
460 void ath9k_ps_work(struct work_struct *work);
461 bool ath9k_htc_setpower(struct ath9k_htc_priv *priv,
462 			enum ath9k_power_mode mode);
463 void ath_update_txpow(struct ath9k_htc_priv *priv);
464 
465 void ath9k_start_rfkill_poll(struct ath9k_htc_priv *priv);
466 void ath9k_htc_rfkill_poll_state(struct ieee80211_hw *hw);
467 void ath9k_htc_radio_enable(struct ieee80211_hw *hw);
468 void ath9k_htc_radio_disable(struct ieee80211_hw *hw);
469 void ath9k_led_stop_brightness(struct ath9k_htc_priv *priv);
470 void ath9k_init_leds(struct ath9k_htc_priv *priv);
471 void ath9k_deinit_leds(struct ath9k_htc_priv *priv);
472 
473 int ath9k_htc_probe_device(struct htc_target *htc_handle, struct device *dev,
474 			   u16 devid, char *product, u32 drv_info);
475 void ath9k_htc_disconnect_device(struct htc_target *htc_handle, bool hotunplug);
476 #ifdef CONFIG_PM
477 void ath9k_htc_suspend(struct htc_target *htc_handle);
478 int ath9k_htc_resume(struct htc_target *htc_handle);
479 #endif
480 #ifdef CONFIG_ATH9K_HTC_DEBUGFS
481 int ath9k_htc_debug_create_root(void);
482 void ath9k_htc_debug_remove_root(void);
483 int ath9k_htc_init_debug(struct ath_hw *ah);
484 void ath9k_htc_exit_debug(struct ath_hw *ah);
485 #else
486 static inline int ath9k_htc_debug_create_root(void) { return 0; };
487 static inline void ath9k_htc_debug_remove_root(void) {};
488 static inline int ath9k_htc_init_debug(struct ath_hw *ah) { return 0; };
489 static inline void ath9k_htc_exit_debug(struct ath_hw *ah) {};
490 #endif /* CONFIG_ATH9K_HTC_DEBUGFS */
491 
492 #endif /* HTC_H */
493