94cb9f8d2446f8f21935c8118ca9c573aeab6e86
[pandora-kernel.git] / drivers / net / wireless / ath / ath9k / rc.h
1 /*
2  * Copyright (c) 2004 Sam Leffler, Errno Consulting
3  * Copyright (c) 2004 Video54 Technologies, Inc.
4  * Copyright (c) 2008-2009 Atheros Communications Inc.
5  *
6  * Permission to use, copy, modify, and/or distribute this software for any
7  * purpose with or without fee is hereby granted, provided that the above
8  * copyright notice and this permission notice appear in all copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17  */
18
19 #ifndef RC_H
20 #define RC_H
21
22 #include "hw.h"
23
24 struct ath_softc;
25
26 #define ATH_RATE_MAX     30
27 #define RATE_TABLE_SIZE  64
28 #define MAX_TX_RATE_PHY  48
29
30 /* VALID_ALL - valid for 20/40/Legacy,
31  * VALID - Legacy only,
32  * VALID_20 - HT 20 only,
33  * VALID_40 - HT 40 only */
34
35 #define INVALID    0x0
36 #define VALID      0x1
37 #define VALID_20   0x2
38 #define VALID_40   0x4
39 #define VALID_2040 (VALID_20|VALID_40)
40 #define VALID_ALL  (VALID_2040|VALID)
41
42 enum {
43         WLAN_RC_PHY_OFDM,
44         WLAN_RC_PHY_CCK,
45         WLAN_RC_PHY_HT_20_SS,
46         WLAN_RC_PHY_HT_20_DS,
47         WLAN_RC_PHY_HT_40_SS,
48         WLAN_RC_PHY_HT_40_DS,
49         WLAN_RC_PHY_HT_20_SS_HGI,
50         WLAN_RC_PHY_HT_20_DS_HGI,
51         WLAN_RC_PHY_HT_40_SS_HGI,
52         WLAN_RC_PHY_HT_40_DS_HGI,
53         WLAN_RC_PHY_MAX
54 };
55
56 #define WLAN_RC_PHY_DS(_phy)   ((_phy == WLAN_RC_PHY_HT_20_DS)          \
57                                 || (_phy == WLAN_RC_PHY_HT_40_DS)       \
58                                 || (_phy == WLAN_RC_PHY_HT_20_DS_HGI)   \
59                                 || (_phy == WLAN_RC_PHY_HT_40_DS_HGI))
60 #define WLAN_RC_PHY_40(_phy)   ((_phy == WLAN_RC_PHY_HT_40_SS)          \
61                                 || (_phy == WLAN_RC_PHY_HT_40_DS)       \
62                                 || (_phy == WLAN_RC_PHY_HT_40_SS_HGI)   \
63                                 || (_phy == WLAN_RC_PHY_HT_40_DS_HGI))
64 #define WLAN_RC_PHY_SGI(_phy)  ((_phy == WLAN_RC_PHY_HT_20_SS_HGI)      \
65                                 || (_phy == WLAN_RC_PHY_HT_20_DS_HGI)   \
66                                 || (_phy == WLAN_RC_PHY_HT_40_SS_HGI)   \
67                                 || (_phy == WLAN_RC_PHY_HT_40_DS_HGI))
68
69 #define WLAN_RC_PHY_HT(_phy)    (_phy >= WLAN_RC_PHY_HT_20_SS)
70
71 #define WLAN_RC_CAP_MODE(capflag) (((capflag & WLAN_RC_HT_FLAG) ?       \
72                 (capflag & WLAN_RC_40_FLAG) ? VALID_40 : VALID_20 : VALID))
73
74 /* Return TRUE if flag supports HT20 && client supports HT20 or
75  * return TRUE if flag supports HT40 && client supports HT40.
76  * This is used becos some rates overlap between HT20/HT40.
77  */
78 #define WLAN_RC_PHY_HT_VALID(flag, capflag)                     \
79         (((flag & VALID_20) && !(capflag & WLAN_RC_40_FLAG)) || \
80          ((flag & VALID_40) && (capflag & WLAN_RC_40_FLAG)))
81
82 #define WLAN_RC_DS_FLAG         (0x01)
83 #define WLAN_RC_40_FLAG         (0x02)
84 #define WLAN_RC_SGI_FLAG        (0x04)
85 #define WLAN_RC_HT_FLAG         (0x08)
86
87 /**
88  * struct ath_rate_table - Rate Control table
89  * @valid: valid for use in rate control
90  * @valid_single_stream: valid for use in rate control for
91  *      single stream operation
92  * @phy: CCK/OFDM
93  * @ratekbps: rate in Kbits per second
94  * @user_ratekbps: user rate in Kbits per second
95  * @ratecode: rate that goes into HW descriptors
96  * @short_preamble: Mask for enabling short preamble in ratecode for CCK
97  * @dot11rate: value that goes into supported
98  *      rates info element of MLME
99  * @ctrl_rate: Index of next lower basic rate, used for duration computation
100  * @max_4ms_framelen: maximum frame length(bytes) for tx duration
101  * @probe_interval: interval for rate control to probe for other rates
102  * @rssi_reduce_interval: interval for rate control to reduce rssi
103  * @initial_ratemax: initial ratemax value
104  */
105 struct ath_rate_table {
106         int rate_cnt;
107         struct {
108                 int valid;
109                 int valid_single_stream;
110                 u8 phy;
111                 u32 ratekbps;
112                 u32 user_ratekbps;
113                 u8 ratecode;
114                 u8 short_preamble;
115                 u8 dot11rate;
116                 u8 ctrl_rate;
117                 u8 base_index;
118                 u8 cw40index;
119                 u8 sgi_index;
120                 u8 ht_index;
121                 u32 max_4ms_framelen;
122         } info[RATE_TABLE_SIZE];
123         u32 probe_interval;
124         u8 initial_ratemax;
125 };
126
127 struct ath_rateset {
128         u8 rs_nrates;
129         u8 rs_rates[ATH_RATE_MAX];
130 };
131
132 /**
133  * struct ath_rate_priv - Rate Control priv data
134  * @state: RC state
135  * @probe_rate: rate we are probing at
136  * @probe_time: msec timestamp for last probe
137  * @hw_maxretry_pktcnt: num of packets since we got HW max retry error
138  * @max_valid_rate: maximum number of valid rate
139  * @per_down_time: msec timestamp for last PER down step
140  * @valid_phy_ratecnt: valid rate count
141  * @rate_max_phy: phy index for the max rate
142  * @per: PER for every valid rate in %
143  * @probe_interval: interval for ratectrl to probe for other rates
144  * @prev_data_rix: rate idx of last data frame
145  * @ht_cap: HT capabilities
146  * @neg_rates: Negotatied rates
147  * @neg_ht_rates: Negotiated HT rates
148  */
149 struct ath_rate_priv {
150         u8 rate_table_size;
151         u8 probe_rate;
152         u8 hw_maxretry_pktcnt;
153         u8 max_valid_rate;
154         u8 valid_rate_index[RATE_TABLE_SIZE];
155         u8 ht_cap;
156         u8 valid_phy_ratecnt[WLAN_RC_PHY_MAX];
157         u8 valid_phy_rateidx[WLAN_RC_PHY_MAX][RATE_TABLE_SIZE];
158         u8 rate_max_phy;
159         u8 per[RATE_TABLE_SIZE];
160         u32 probe_time;
161         u32 per_down_time;
162         u32 probe_interval;
163         u32 prev_data_rix;
164         u32 tx_triglevel_max;
165         struct ath_rateset neg_rates;
166         struct ath_rateset neg_ht_rates;
167         struct ath_rate_softc *asc;
168 };
169
170 enum ath9k_internal_frame_type {
171         ATH9K_NOT_INTERNAL,
172         ATH9K_INT_PAUSE,
173         ATH9K_INT_UNPAUSE
174 };
175
176 struct ath_tx_info_priv {
177         struct ath_wiphy *aphy;
178         struct ath_tx_status tx;
179         int n_frames;
180         int n_bad_frames;
181         bool update_rc;
182         enum ath9k_internal_frame_type frame_type;
183 };
184
185 #define ATH_TX_INFO_PRIV(tx_info) \
186         ((struct ath_tx_info_priv *)((tx_info)->rate_driver_data[0]))
187
188 void ath_rate_attach(struct ath_softc *sc);
189 u8 ath_rate_findrateix(struct ath_softc *sc, u8 dot11_rate);
190 int ath_rate_control_register(void);
191 void ath_rate_control_unregister(void);
192
193 #endif /* RC_H */