0d2e2b10358d5abe0bba875181ac8cf8f8858f6e
[pandora-kernel.git] / drivers / net / wireless / ath / ath9k / htc.h
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
71 #define ATH9K_HTC_AMPDU  1
72 #define ATH9K_HTC_NORMAL 2
73 #define ATH9K_HTC_BEACON 3
74 #define ATH9K_HTC_MGMT   4
75
76 #define ATH9K_HTC_TX_CTSONLY      0x1
77 #define ATH9K_HTC_TX_RTSCTS       0x2
78 #define ATH9K_HTC_TX_USE_MIN_RATE 0x100
79
80 struct tx_frame_hdr {
81         u8 data_type;
82         u8 node_idx;
83         u8 vif_idx;
84         u8 tidno;
85         __be32 flags; /* ATH9K_HTC_TX_* */
86         u8 key_type;
87         u8 keyix;
88         u8 cookie;
89         u8 pad;
90 } __packed;
91
92 struct tx_mgmt_hdr {
93         u8 node_idx;
94         u8 vif_idx;
95         u8 tidno;
96         u8 flags;
97         u8 key_type;
98         u8 keyix;
99         u8 cookie;
100         u8 pad;
101 } __packed;
102
103 struct tx_beacon_header {
104         u8 vif_index;
105         u8 len_changed;
106         u16 rev;
107 } __packed;
108
109 struct ath9k_htc_cap_target {
110         u32 flags;
111         u32 flags_ext;
112         u32 ampdu_limit;
113         u8 ampdu_subframes;
114         u8 tx_chainmask;
115         u8 tx_chainmask_legacy;
116         u8 rtscts_ratecode;
117         u8 protmode;
118         u8 pad;
119 } __packed;
120
121 struct ath9k_htc_target_vif {
122         u8 index;
123         u8 opmode;
124         u8 myaddr[ETH_ALEN];
125         u8 ath_cap;
126         __be16 rtsthreshold;
127         u8 pad;
128 } __packed;
129
130 #define ATH_HTC_STA_AUTH  0x0001
131 #define ATH_HTC_STA_QOS   0x0002
132 #define ATH_HTC_STA_ERP   0x0004
133 #define ATH_HTC_STA_HT    0x0008
134
135 struct ath9k_htc_target_sta {
136         u8 macaddr[ETH_ALEN];
137         u8 bssid[ETH_ALEN];
138         u8 sta_index;
139         u8 vif_index;
140         u8 is_vif_sta;
141         __be16 flags; /* ATH_HTC_STA_* */
142         __be16 htcap;
143         __be16 maxampdu;
144         u8 pad;
145 } __packed;
146
147 struct ath9k_htc_target_aggr {
148         u8 sta_index;
149         u8 tidno;
150         u8 aggr_enable;
151         u8 padding;
152 } __packed;
153
154 #define ATH_HTC_RATE_MAX 30
155
156 #define WLAN_RC_DS_FLAG  0x01
157 #define WLAN_RC_40_FLAG  0x02
158 #define WLAN_RC_SGI_FLAG 0x04
159 #define WLAN_RC_HT_FLAG  0x08
160
161 struct ath9k_htc_rateset {
162         u8 rs_nrates;
163         u8 rs_rates[ATH_HTC_RATE_MAX];
164 };
165
166 struct ath9k_htc_rate {
167         struct ath9k_htc_rateset legacy_rates;
168         struct ath9k_htc_rateset ht_rates;
169 } __packed;
170
171 struct ath9k_htc_target_rate {
172         u8 sta_index;
173         u8 isnew;
174         __be32 capflags;
175         struct ath9k_htc_rate rates;
176 };
177
178 struct ath9k_htc_target_stats {
179         __be32 tx_shortretry;
180         __be32 tx_longretry;
181         __be32 tx_xretries;
182         __be32 ht_txunaggr_xretry;
183         __be32 ht_tx_xretries;
184 } __packed;
185
186 #define ATH9K_HTC_MAX_VIF 2
187 #define ATH9K_HTC_MAX_BCN_VIF 2
188
189 #define INC_VIF(_priv, _type) do {              \
190                 switch (_type) {                \
191                 case NL80211_IFTYPE_STATION:    \
192                         _priv->num_sta_vif++;   \
193                         break;                  \
194                 case NL80211_IFTYPE_ADHOC:      \
195                         _priv->num_ibss_vif++;  \
196                         break;                  \
197                 case NL80211_IFTYPE_AP:         \
198                         _priv->num_ap_vif++;    \
199                         break;                  \
200                 default:                        \
201                         break;                  \
202                 }                               \
203         } while (0)
204
205 #define DEC_VIF(_priv, _type) do {              \
206                 switch (_type) {                \
207                 case NL80211_IFTYPE_STATION:    \
208                         _priv->num_sta_vif--;   \
209                         break;                  \
210                 case NL80211_IFTYPE_ADHOC:      \
211                         _priv->num_ibss_vif--;  \
212                         break;                  \
213                 case NL80211_IFTYPE_AP:         \
214                         _priv->num_ap_vif--;    \
215                         break;                  \
216                 default:                        \
217                         break;                  \
218                 }                               \
219         } while (0)
220
221 struct ath9k_htc_vif {
222         u8 index;
223         u16 seq_no;
224         bool beacon_configured;
225         int bslot;
226         __le64 tsfadjust;
227 };
228
229 struct ath9k_vif_iter_data {
230         const u8 *hw_macaddr;
231         u8 mask[ETH_ALEN];
232 };
233
234 #define ATH9K_HTC_MAX_STA 8
235 #define ATH9K_HTC_MAX_TID 8
236
237 enum tid_aggr_state {
238         AGGR_STOP = 0,
239         AGGR_PROGRESS,
240         AGGR_START,
241         AGGR_OPERATIONAL
242 };
243
244 struct ath9k_htc_sta {
245         u8 index;
246         enum tid_aggr_state tid_state[ATH9K_HTC_MAX_TID];
247 };
248
249 #define ATH9K_HTC_RXBUF 256
250 #define HTC_RX_FRAME_HEADER_SIZE 40
251
252 struct ath9k_htc_rxbuf {
253         bool in_process;
254         struct sk_buff *skb;
255         struct ath_htc_rx_status rxstatus;
256         struct list_head list;
257 };
258
259 struct ath9k_htc_rx {
260         int last_rssi; /* FIXME: per-STA */
261         struct list_head rxbuf;
262         spinlock_t rxbuflock;
263 };
264
265 #define ATH9K_HTC_TX_RESERVE   10
266 #define ATH9K_HTC_TX_THRESHOLD (MAX_TX_BUF_NUM - ATH9K_HTC_TX_RESERVE)
267
268 #define ATH9K_HTC_OP_TX_QUEUES_STOP BIT(0)
269
270 struct ath9k_htc_tx {
271         u8 flags;
272         int queued_cnt;
273         struct sk_buff_head tx_queue;
274         struct sk_buff_head tx_failed;
275         DECLARE_BITMAP(tx_slot, MAX_TX_BUF_NUM);
276         spinlock_t tx_lock;
277 };
278
279 struct ath9k_htc_tx_ctl {
280         u8 type; /* ATH9K_HTC_* */
281         u8 epid;
282         u8 txok;
283 };
284
285 static inline struct ath9k_htc_tx_ctl *HTC_SKB_CB(struct sk_buff *skb)
286 {
287         struct ieee80211_tx_info *tx_info = IEEE80211_SKB_CB(skb);
288
289         BUILD_BUG_ON(sizeof(struct ath9k_htc_tx_ctl) >
290                      IEEE80211_TX_INFO_DRIVER_DATA_SIZE);
291         return (struct ath9k_htc_tx_ctl *) &tx_info->driver_data;
292 }
293
294 #ifdef CONFIG_ATH9K_HTC_DEBUGFS
295
296 #define TX_STAT_INC(c) (hif_dev->htc_handle->drv_priv->debug.tx_stats.c++)
297 #define RX_STAT_INC(c) (hif_dev->htc_handle->drv_priv->debug.rx_stats.c++)
298 #define CAB_STAT_INC   priv->debug.tx_stats.cab_queued++
299
300 #define TX_QSTAT_INC(q) (priv->debug.tx_stats.queue_stats[q]++)
301
302 void ath9k_htc_err_stat_rx(struct ath9k_htc_priv *priv,
303                            struct ath_htc_rx_status *rxs);
304
305 struct ath_tx_stats {
306         u32 buf_queued;
307         u32 buf_completed;
308         u32 skb_queued;
309         u32 skb_success;
310         u32 skb_failed;
311         u32 cab_queued;
312         u32 queue_stats[WME_NUM_AC];
313 };
314
315 struct ath_rx_stats {
316         u32 skb_allocated;
317         u32 skb_completed;
318         u32 skb_dropped;
319         u32 err_crc;
320         u32 err_decrypt_crc;
321         u32 err_mic;
322         u32 err_pre_delim;
323         u32 err_post_delim;
324         u32 err_decrypt_busy;
325         u32 err_phy;
326         u32 err_phy_stats[ATH9K_PHYERR_MAX];
327 };
328
329 struct ath9k_debug {
330         struct dentry *debugfs_phy;
331         struct dentry *debugfs_tgt_stats;
332         struct dentry *debugfs_xmit;
333         struct dentry *debugfs_recv;
334         struct ath_tx_stats tx_stats;
335         struct ath_rx_stats rx_stats;
336         u32 txrate;
337 };
338
339 #else
340
341 #define TX_STAT_INC(c) do { } while (0)
342 #define RX_STAT_INC(c) do { } while (0)
343 #define CAB_STAT_INC   do { } while (0)
344
345 #define TX_QSTAT_INC(c) do { } while (0)
346
347 static inline void ath9k_htc_err_stat_rx(struct ath9k_htc_priv *priv,
348                                          struct ath_htc_rx_status *rxs)
349 {
350 }
351
352 #endif /* CONFIG_ATH9K_HTC_DEBUGFS */
353
354 #define ATH_LED_PIN_DEF             1
355 #define ATH_LED_PIN_9287            10
356 #define ATH_LED_PIN_9271            15
357 #define ATH_LED_PIN_7010            12
358 #define ATH_LED_ON_DURATION_IDLE    350 /* in msecs */
359 #define ATH_LED_OFF_DURATION_IDLE   250 /* in msecs */
360
361 enum ath_led_type {
362         ATH_LED_RADIO,
363         ATH_LED_ASSOC,
364         ATH_LED_TX,
365         ATH_LED_RX
366 };
367
368 struct ath_led {
369         struct ath9k_htc_priv *priv;
370         struct led_classdev led_cdev;
371         enum ath_led_type led_type;
372         struct delayed_work brightness_work;
373         char name[32];
374         bool registered;
375         int brightness;
376 };
377
378 #define BSTUCK_THRESHOLD 10
379
380 /*
381  * Adjust these when the max. no of beaconing interfaces is
382  * increased.
383  */
384 #define DEFAULT_SWBA_RESPONSE 40 /* in TUs */
385 #define MIN_SWBA_RESPONSE     10 /* in TUs */
386
387 struct htc_beacon_config {
388         struct ieee80211_vif *bslot[ATH9K_HTC_MAX_BCN_VIF];
389         u16 beacon_interval;
390         u16 dtim_period;
391         u16 bmiss_timeout;
392         u32 bmiss_cnt;
393 };
394
395 struct ath_btcoex {
396         u32 bt_priority_cnt;
397         unsigned long bt_priority_time;
398         int bt_stomp_type; /* Types of BT stomping */
399         u32 btcoex_no_stomp;
400         u32 btcoex_period;
401         u32 btscan_no_stomp;
402 };
403
404 void ath_htc_init_btcoex_work(struct ath9k_htc_priv *priv);
405 void ath_htc_resume_btcoex_work(struct ath9k_htc_priv *priv);
406 void ath_htc_cancel_btcoex_work(struct ath9k_htc_priv *priv);
407
408 #define OP_INVALID                 BIT(0)
409 #define OP_SCANNING                BIT(1)
410 #define OP_LED_ASSOCIATED          BIT(2)
411 #define OP_LED_ON                  BIT(3)
412 #define OP_ENABLE_BEACON           BIT(4)
413 #define OP_LED_DEINIT              BIT(5)
414 #define OP_BT_PRIORITY_DETECTED    BIT(6)
415 #define OP_BT_SCAN                 BIT(7)
416 #define OP_ANI_RUNNING             BIT(8)
417 #define OP_TSF_RESET               BIT(9)
418
419 struct ath9k_htc_priv {
420         struct device *dev;
421         struct ieee80211_hw *hw;
422         struct ath_hw *ah;
423         struct htc_target *htc;
424         struct wmi *wmi;
425
426         u16 fw_version_major;
427         u16 fw_version_minor;
428
429         enum htc_endpoint_id wmi_cmd_ep;
430         enum htc_endpoint_id beacon_ep;
431         enum htc_endpoint_id cab_ep;
432         enum htc_endpoint_id uapsd_ep;
433         enum htc_endpoint_id mgmt_ep;
434         enum htc_endpoint_id data_be_ep;
435         enum htc_endpoint_id data_bk_ep;
436         enum htc_endpoint_id data_vi_ep;
437         enum htc_endpoint_id data_vo_ep;
438
439         u8 vif_slot;
440         u8 mon_vif_idx;
441         u8 sta_slot;
442         u8 vif_sta_pos[ATH9K_HTC_MAX_VIF];
443         u8 num_ibss_vif;
444         u8 num_sta_vif;
445         u8 num_ap_vif;
446
447         u16 op_flags;
448         u16 curtxpow;
449         u16 txpowlimit;
450         u16 nvifs;
451         u16 nstations;
452         bool rearm_ani;
453         bool reconfig_beacon;
454         unsigned int rxfilter;
455
456         struct ath9k_hw_cal_data caldata;
457         struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
458
459         spinlock_t beacon_lock;
460         struct htc_beacon_config cur_beacon_conf;
461
462         struct ath9k_htc_rx rx;
463         struct ath9k_htc_tx tx;
464
465         struct tasklet_struct swba_tasklet;
466         struct tasklet_struct rx_tasklet;
467         struct tasklet_struct tx_tasklet;
468         struct delayed_work ani_work;
469         struct work_struct ps_work;
470         struct work_struct fatal_work;
471
472         struct mutex htc_pm_lock;
473         unsigned long ps_usecount;
474         bool ps_enabled;
475         bool ps_idle;
476
477         struct ath_led radio_led;
478         struct ath_led assoc_led;
479         struct ath_led tx_led;
480         struct ath_led rx_led;
481         struct delayed_work ath9k_led_blink_work;
482         int led_on_duration;
483         int led_off_duration;
484         int led_on_cnt;
485         int led_off_cnt;
486
487         int beaconq;
488         int cabq;
489         int hwq_map[WME_NUM_AC];
490
491         struct ath_btcoex btcoex;
492         struct delayed_work coex_period_work;
493         struct delayed_work duty_cycle_work;
494 #ifdef CONFIG_ATH9K_HTC_DEBUGFS
495         struct ath9k_debug debug;
496 #endif
497         struct mutex mutex;
498 };
499
500 static inline void ath_read_cachesize(struct ath_common *common, int *csz)
501 {
502         common->bus_ops->read_cachesize(common, csz);
503 }
504
505 void ath9k_htc_reset(struct ath9k_htc_priv *priv);
506
507 void ath9k_htc_assign_bslot(struct ath9k_htc_priv *priv,
508                             struct ieee80211_vif *vif);
509 void ath9k_htc_remove_bslot(struct ath9k_htc_priv *priv,
510                             struct ieee80211_vif *vif);
511 void ath9k_htc_set_tsfadjust(struct ath9k_htc_priv *priv,
512                              struct ieee80211_vif *vif);
513 void ath9k_htc_beaconq_config(struct ath9k_htc_priv *priv);
514 void ath9k_htc_beacon_config(struct ath9k_htc_priv *priv,
515                              struct ieee80211_vif *vif);
516 void ath9k_htc_beacon_reconfig(struct ath9k_htc_priv *priv);
517 void ath9k_htc_swba(struct ath9k_htc_priv *priv,
518                     struct wmi_event_swba *swba);
519
520 void ath9k_htc_rxep(void *priv, struct sk_buff *skb,
521                     enum htc_endpoint_id ep_id);
522 void ath9k_htc_txep(void *priv, struct sk_buff *skb, enum htc_endpoint_id ep_id,
523                     bool txok);
524 void ath9k_htc_beaconep(void *drv_priv, struct sk_buff *skb,
525                         enum htc_endpoint_id ep_id, bool txok);
526
527 int ath9k_htc_update_cap_target(struct ath9k_htc_priv *priv);
528 void ath9k_htc_station_work(struct work_struct *work);
529 void ath9k_htc_aggr_work(struct work_struct *work);
530 void ath9k_htc_ani_work(struct work_struct *work);
531 void ath9k_htc_start_ani(struct ath9k_htc_priv *priv);
532 void ath9k_htc_stop_ani(struct ath9k_htc_priv *priv);
533
534 int ath9k_tx_init(struct ath9k_htc_priv *priv);
535 void ath9k_tx_tasklet(unsigned long data);
536 int ath9k_htc_tx_start(struct ath9k_htc_priv *priv,
537                        struct sk_buff *skb, u8 slot, bool is_cab);
538 void ath9k_tx_cleanup(struct ath9k_htc_priv *priv);
539 bool ath9k_htc_txq_setup(struct ath9k_htc_priv *priv, int subtype);
540 int ath9k_htc_cabq_setup(struct ath9k_htc_priv *priv);
541 int get_hw_qnum(u16 queue, int *hwq_map);
542 int ath_htc_txq_update(struct ath9k_htc_priv *priv, int qnum,
543                        struct ath9k_tx_queue_info *qinfo);
544 void ath9k_htc_check_stop_queues(struct ath9k_htc_priv *priv);
545 void ath9k_htc_check_wake_queues(struct ath9k_htc_priv *priv);
546 int ath9k_htc_tx_get_slot(struct ath9k_htc_priv *priv);
547 void ath9k_htc_tx_clear_slot(struct ath9k_htc_priv *priv, int slot);
548 void ath9k_htc_tx_drain(struct ath9k_htc_priv *priv);
549
550 int ath9k_rx_init(struct ath9k_htc_priv *priv);
551 void ath9k_rx_cleanup(struct ath9k_htc_priv *priv);
552 void ath9k_host_rx_init(struct ath9k_htc_priv *priv);
553 void ath9k_rx_tasklet(unsigned long data);
554 u32 ath9k_htc_calcrxfilter(struct ath9k_htc_priv *priv);
555
556 void ath9k_htc_ps_wakeup(struct ath9k_htc_priv *priv);
557 void ath9k_htc_ps_restore(struct ath9k_htc_priv *priv);
558 void ath9k_ps_work(struct work_struct *work);
559 bool ath9k_htc_setpower(struct ath9k_htc_priv *priv,
560                         enum ath9k_power_mode mode);
561
562 void ath9k_start_rfkill_poll(struct ath9k_htc_priv *priv);
563 void ath9k_htc_rfkill_poll_state(struct ieee80211_hw *hw);
564 void ath9k_htc_radio_enable(struct ieee80211_hw *hw);
565 void ath9k_htc_radio_disable(struct ieee80211_hw *hw);
566 void ath9k_led_stop_brightness(struct ath9k_htc_priv *priv);
567 void ath9k_init_leds(struct ath9k_htc_priv *priv);
568 void ath9k_deinit_leds(struct ath9k_htc_priv *priv);
569
570 int ath9k_htc_probe_device(struct htc_target *htc_handle, struct device *dev,
571                            u16 devid, char *product, u32 drv_info);
572 void ath9k_htc_disconnect_device(struct htc_target *htc_handle, bool hotunplug);
573 #ifdef CONFIG_PM
574 void ath9k_htc_suspend(struct htc_target *htc_handle);
575 int ath9k_htc_resume(struct htc_target *htc_handle);
576 #endif
577 #ifdef CONFIG_ATH9K_HTC_DEBUGFS
578 int ath9k_htc_debug_create_root(void);
579 void ath9k_htc_debug_remove_root(void);
580 int ath9k_htc_init_debug(struct ath_hw *ah);
581 void ath9k_htc_exit_debug(struct ath_hw *ah);
582 #else
583 static inline int ath9k_htc_debug_create_root(void) { return 0; };
584 static inline void ath9k_htc_debug_remove_root(void) {};
585 static inline int ath9k_htc_init_debug(struct ath_hw *ah) { return 0; };
586 static inline void ath9k_htc_exit_debug(struct ath_hw *ah) {};
587 #endif /* CONFIG_ATH9K_HTC_DEBUGFS */
588
589 #endif /* HTC_H */