xref: /linux/drivers/net/wireless/ath/ath9k/htc.h (revision 5d4a2e29fba5b2bef95b96a46b338ec4d76fa4fd)
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 	u32 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 struct ath9k_htc_aggr_work {
227 	u16 tid;
228 	u8 sta_addr[ETH_ALEN];
229 	struct ieee80211_hw *hw;
230 	struct ieee80211_vif *vif;
231 	enum ieee80211_ampdu_mlme_action action;
232 	struct mutex mutex;
233 };
234 
235 #define ATH9K_HTC_RXBUF 256
236 #define HTC_RX_FRAME_HEADER_SIZE 40
237 
238 struct ath9k_htc_rxbuf {
239 	bool in_process;
240 	struct sk_buff *skb;
241 	struct ath_htc_rx_status rxstatus;
242 	struct list_head list;
243 };
244 
245 struct ath9k_htc_rx {
246 	int last_rssi; /* FIXME: per-STA */
247 	struct list_head rxbuf;
248 	spinlock_t rxbuflock;
249 };
250 
251 struct ath9k_htc_tx_ctl {
252 	u8 type; /* ATH9K_HTC_* */
253 };
254 
255 #ifdef CONFIG_ATH9K_HTC_DEBUGFS
256 
257 #define TX_STAT_INC(c) (hif_dev->htc_handle->drv_priv->debug.tx_stats.c++)
258 #define RX_STAT_INC(c) (hif_dev->htc_handle->drv_priv->debug.rx_stats.c++)
259 
260 struct ath_tx_stats {
261 	u32 buf_queued;
262 	u32 buf_completed;
263 	u32 skb_queued;
264 	u32 skb_completed;
265 	u32 skb_dropped;
266 };
267 
268 struct ath_rx_stats {
269 	u32 skb_allocated;
270 	u32 skb_completed;
271 	u32 skb_dropped;
272 };
273 
274 struct ath9k_debug {
275 	struct dentry *debugfs_phy;
276 	struct dentry *debugfs_tgt_stats;
277 	struct dentry *debugfs_xmit;
278 	struct dentry *debugfs_recv;
279 	struct ath_tx_stats tx_stats;
280 	struct ath_rx_stats rx_stats;
281 	u32 txrate;
282 };
283 
284 #else
285 
286 #define TX_STAT_INC(c) do { } while (0)
287 #define RX_STAT_INC(c) do { } while (0)
288 
289 #endif /* CONFIG_ATH9K_HTC_DEBUGFS */
290 
291 #define ATH_LED_PIN_DEF             1
292 #define ATH_LED_PIN_9287            8
293 #define ATH_LED_PIN_9271            15
294 #define ATH_LED_ON_DURATION_IDLE    350	/* in msecs */
295 #define ATH_LED_OFF_DURATION_IDLE   250	/* in msecs */
296 
297 enum ath_led_type {
298 	ATH_LED_RADIO,
299 	ATH_LED_ASSOC,
300 	ATH_LED_TX,
301 	ATH_LED_RX
302 };
303 
304 struct ath_led {
305 	struct ath9k_htc_priv *priv;
306 	struct led_classdev led_cdev;
307 	enum ath_led_type led_type;
308 	struct delayed_work brightness_work;
309 	char name[32];
310 	bool registered;
311 	int brightness;
312 };
313 
314 struct htc_beacon_config {
315 	u16 beacon_interval;
316 	u16 listen_interval;
317 	u16 dtim_period;
318 	u16 bmiss_timeout;
319 	u8 dtim_count;
320 };
321 
322 #define OP_INVALID        BIT(0)
323 #define OP_SCANNING       BIT(1)
324 #define OP_FULL_RESET     BIT(2)
325 #define OP_LED_ASSOCIATED BIT(3)
326 #define OP_LED_ON         BIT(4)
327 #define OP_PREAMBLE_SHORT BIT(5)
328 #define OP_PROTECT_ENABLE BIT(6)
329 #define OP_TXAGGR         BIT(7)
330 #define OP_ASSOCIATED     BIT(8)
331 #define OP_ENABLE_BEACON  BIT(9)
332 #define OP_LED_DEINIT     BIT(10)
333 #define OP_UNPLUGGED      BIT(11)
334 
335 struct ath9k_htc_priv {
336 	struct device *dev;
337 	struct ieee80211_hw *hw;
338 	struct ath_hw *ah;
339 	struct htc_target *htc;
340 	struct wmi *wmi;
341 
342 	enum htc_endpoint_id wmi_cmd_ep;
343 	enum htc_endpoint_id beacon_ep;
344 	enum htc_endpoint_id cab_ep;
345 	enum htc_endpoint_id uapsd_ep;
346 	enum htc_endpoint_id mgmt_ep;
347 	enum htc_endpoint_id data_be_ep;
348 	enum htc_endpoint_id data_bk_ep;
349 	enum htc_endpoint_id data_vi_ep;
350 	enum htc_endpoint_id data_vo_ep;
351 
352 	u16 op_flags;
353 	u16 curtxpow;
354 	u16 txpowlimit;
355 	u16 nvifs;
356 	u16 nstations;
357 	u16 seq_no;
358 	u32 bmiss_cnt;
359 
360 	spinlock_t beacon_lock;
361 
362 	bool tx_queues_stop;
363 	spinlock_t tx_lock;
364 
365 	struct ieee80211_vif *vif;
366 	struct htc_beacon_config cur_beacon_conf;
367 	unsigned int rxfilter;
368 	struct tasklet_struct wmi_tasklet;
369 	struct tasklet_struct rx_tasklet;
370 	struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
371 	struct ath9k_htc_rx rx;
372 	struct tasklet_struct tx_tasklet;
373 	struct sk_buff_head tx_queue;
374 	struct ath9k_htc_aggr_work aggr_work;
375 	struct delayed_work ath9k_aggr_work;
376 	struct delayed_work ath9k_ani_work;
377 	struct work_struct ps_work;
378 
379 	struct mutex htc_pm_lock;
380 	unsigned long ps_usecount;
381 	bool ps_enabled;
382 	bool ps_idle;
383 
384 	struct ath_led radio_led;
385 	struct ath_led assoc_led;
386 	struct ath_led tx_led;
387 	struct ath_led rx_led;
388 	struct delayed_work ath9k_led_blink_work;
389 	int led_on_duration;
390 	int led_off_duration;
391 	int led_on_cnt;
392 	int led_off_cnt;
393 	int hwq_map[ATH9K_WME_AC_VO+1];
394 
395 #ifdef CONFIG_ATH9K_HTC_DEBUGFS
396 	struct ath9k_debug debug;
397 #endif
398 	struct ath9k_htc_target_rate tgt_rate;
399 
400 	struct mutex mutex;
401 };
402 
403 static inline void ath_read_cachesize(struct ath_common *common, int *csz)
404 {
405 	common->bus_ops->read_cachesize(common, csz);
406 }
407 
408 void ath9k_htc_beacon_config(struct ath9k_htc_priv *priv,
409 			     struct ieee80211_vif *vif);
410 void ath9k_htc_swba(struct ath9k_htc_priv *priv, u8 beacon_pending);
411 
412 void ath9k_htc_rxep(void *priv, struct sk_buff *skb,
413 		    enum htc_endpoint_id ep_id);
414 void ath9k_htc_txep(void *priv, struct sk_buff *skb, enum htc_endpoint_id ep_id,
415 		    bool txok);
416 void ath9k_htc_beaconep(void *drv_priv, struct sk_buff *skb,
417 			enum htc_endpoint_id ep_id, bool txok);
418 
419 void ath9k_htc_station_work(struct work_struct *work);
420 void ath9k_htc_aggr_work(struct work_struct *work);
421 void ath9k_ani_work(struct work_struct *work);;
422 
423 int ath9k_tx_init(struct ath9k_htc_priv *priv);
424 void ath9k_tx_tasklet(unsigned long data);
425 int ath9k_htc_tx_start(struct ath9k_htc_priv *priv, struct sk_buff *skb);
426 void ath9k_tx_cleanup(struct ath9k_htc_priv *priv);
427 bool ath9k_htc_txq_setup(struct ath9k_htc_priv *priv,
428 			 enum ath9k_tx_queue_subtype qtype);
429 int get_hw_qnum(u16 queue, int *hwq_map);
430 int ath_htc_txq_update(struct ath9k_htc_priv *priv, int qnum,
431 		       struct ath9k_tx_queue_info *qinfo);
432 
433 int ath9k_rx_init(struct ath9k_htc_priv *priv);
434 void ath9k_rx_cleanup(struct ath9k_htc_priv *priv);
435 void ath9k_host_rx_init(struct ath9k_htc_priv *priv);
436 void ath9k_rx_tasklet(unsigned long data);
437 u32 ath9k_htc_calcrxfilter(struct ath9k_htc_priv *priv);
438 
439 void ath9k_htc_ps_wakeup(struct ath9k_htc_priv *priv);
440 void ath9k_htc_ps_restore(struct ath9k_htc_priv *priv);
441 void ath9k_ps_work(struct work_struct *work);
442 
443 void ath9k_start_rfkill_poll(struct ath9k_htc_priv *priv);
444 void ath9k_init_leds(struct ath9k_htc_priv *priv);
445 void ath9k_deinit_leds(struct ath9k_htc_priv *priv);
446 
447 int ath9k_htc_probe_device(struct htc_target *htc_handle, struct device *dev,
448 			   u16 devid);
449 void ath9k_htc_disconnect_device(struct htc_target *htc_handle, bool hotunplug);
450 #ifdef CONFIG_PM
451 int ath9k_htc_resume(struct htc_target *htc_handle);
452 #endif
453 #ifdef CONFIG_ATH9K_HTC_DEBUGFS
454 int ath9k_htc_debug_create_root(void);
455 void ath9k_htc_debug_remove_root(void);
456 int ath9k_htc_init_debug(struct ath_hw *ah);
457 void ath9k_htc_exit_debug(struct ath_hw *ah);
458 #else
459 static inline int ath9k_htc_debug_create_root(void) { return 0; };
460 static inline void ath9k_htc_debug_remove_root(void) {};
461 static inline int ath9k_htc_init_debug(struct ath_hw *ah) { return 0; };
462 static inline void ath9k_htc_exit_debug(struct ath_hw *ah) {};
463 #endif /* CONFIG_ATH9K_HTC_DEBUGFS */
464 
465 #endif /* HTC_H */
466