[deliverable/linux.git] / drivers / net / wireless / ath / ath9k / rc.h

/*
 * Copyright (c) 2004 Sam Leffler, Errno Consulting
 * Copyright (c) 2004 Video54 Technologies, Inc.
 * Copyright (c) 2008-2009 Atheros Communications Inc.
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef RC_H
#define RC_H

struct ath_softc;

#define ATH_RATE_MAX     30
#define RATE_TABLE_SIZE  64
#define MAX_TX_RATE_PHY  48

/* VALID_ALL - valid for 20/40/Legacy,
 * VALID - Legacy only,
 * VALID_20 - HT 20 only,
 * VALID_40 - HT 40 only */

#define INVALID    0x0
#define VALID      0x1
#define VALID_20   0x2
#define VALID_40   0x4
#define VALID_2040 (VALID_20|VALID_40)
#define VALID_ALL  (VALID_2040|VALID)

enum {
	WLAN_RC_PHY_OFDM,
	WLAN_RC_PHY_CCK,
	WLAN_RC_PHY_HT_20_SS,
	WLAN_RC_PHY_HT_20_DS,
	WLAN_RC_PHY_HT_40_SS,
	WLAN_RC_PHY_HT_40_DS,
	WLAN_RC_PHY_HT_20_SS_HGI,
	WLAN_RC_PHY_HT_20_DS_HGI,
	WLAN_RC_PHY_HT_40_SS_HGI,
	WLAN_RC_PHY_HT_40_DS_HGI,
	WLAN_RC_PHY_MAX
};

#define WLAN_RC_PHY_DS(_phy)   ((_phy == WLAN_RC_PHY_HT_20_DS)		\
				|| (_phy == WLAN_RC_PHY_HT_40_DS)	\
				|| (_phy == WLAN_RC_PHY_HT_20_DS_HGI)	\
				|| (_phy == WLAN_RC_PHY_HT_40_DS_HGI))
#define WLAN_RC_PHY_40(_phy)   ((_phy == WLAN_RC_PHY_HT_40_SS)		\
				|| (_phy == WLAN_RC_PHY_HT_40_DS)	\
				|| (_phy == WLAN_RC_PHY_HT_40_SS_HGI)	\
				|| (_phy == WLAN_RC_PHY_HT_40_DS_HGI))
#define WLAN_RC_PHY_SGI(_phy)  ((_phy == WLAN_RC_PHY_HT_20_SS_HGI)      \
				|| (_phy == WLAN_RC_PHY_HT_20_DS_HGI)   \
				|| (_phy == WLAN_RC_PHY_HT_40_SS_HGI)   \
				|| (_phy == WLAN_RC_PHY_HT_40_DS_HGI))

#define WLAN_RC_PHY_HT(_phy)    (_phy >= WLAN_RC_PHY_HT_20_SS)

#define WLAN_RC_CAP_MODE(capflag) (((capflag & WLAN_RC_HT_FLAG) ?	\
		(capflag & WLAN_RC_40_FLAG) ? VALID_40 : VALID_20 : VALID))

/* Return TRUE if flag supports HT20 && client supports HT20 or
 * return TRUE if flag supports HT40 && client supports HT40.
 * This is used becos some rates overlap between HT20/HT40.
 */
#define WLAN_RC_PHY_HT_VALID(flag, capflag)			\
	(((flag & VALID_20) && !(capflag & WLAN_RC_40_FLAG)) || \
	 ((flag & VALID_40) && (capflag & WLAN_RC_40_FLAG)))

#define WLAN_RC_DS_FLAG         (0x01)
#define WLAN_RC_40_FLAG         (0x02)
#define WLAN_RC_SGI_FLAG        (0x04)
#define WLAN_RC_HT_FLAG         (0x08)

/**
 * struct ath_rate_table - Rate Control table
 * @valid: valid for use in rate control
 * @valid_single_stream: valid for use in rate control for
 * 	single stream operation
 * @phy: CCK/OFDM
 * @ratekbps: rate in Kbits per second
 * @user_ratekbps: user rate in Kbits per second
 * @ratecode: rate that goes into HW descriptors
 * @short_preamble: Mask for enabling short preamble in ratecode for CCK
 * @dot11rate: value that goes into supported
 * 	rates info element of MLME
 * @ctrl_rate: Index of next lower basic rate, used for duration computation
 * @max_4ms_framelen: maximum frame length(bytes) for tx duration
 * @probe_interval: interval for rate control to probe for other rates
 * @rssi_reduce_interval: interval for rate control to reduce rssi
 * @initial_ratemax: initial ratemax value
 */
struct ath_rate_table {
	int rate_cnt;
	struct {
		int valid;
		int valid_single_stream;
		u8 phy;
		u32 ratekbps;
		u32 user_ratekbps;
		u8 ratecode;
		u8 short_preamble;
		u8 dot11rate;
		u8 ctrl_rate;
		u8 base_index;
		u8 cw40index;
		u8 sgi_index;
		u8 ht_index;
		u32 max_4ms_framelen;
	} info[RATE_TABLE_SIZE];
	u32 probe_interval;
	u8 initial_ratemax;
};

struct ath_rateset {
	u8 rs_nrates;
	u8 rs_rates[ATH_RATE_MAX];
};

/**
 * struct ath_rate_priv - Rate Control priv data
 * @state: RC state
 * @probe_rate: rate we are probing at
 * @probe_time: msec timestamp for last probe
 * @hw_maxretry_pktcnt: num of packets since we got HW max retry error
 * @max_valid_rate: maximum number of valid rate
 * @per_down_time: msec timestamp for last PER down step
 * @valid_phy_ratecnt: valid rate count
 * @rate_max_phy: phy index for the max rate
 * @per: PER for every valid rate in %
 * @probe_interval: interval for ratectrl to probe for other rates
 * @prev_data_rix: rate idx of last data frame
 * @ht_cap: HT capabilities
 * @neg_rates: Negotatied rates
 * @neg_ht_rates: Negotiated HT rates
 */
struct ath_rate_priv {
	u8 rate_table_size;
	u8 probe_rate;
	u8 hw_maxretry_pktcnt;
	u8 max_valid_rate;
	u8 valid_rate_index[RATE_TABLE_SIZE];
	u8 ht_cap;
	u8 valid_phy_ratecnt[WLAN_RC_PHY_MAX];
	u8 valid_phy_rateidx[WLAN_RC_PHY_MAX][RATE_TABLE_SIZE];
	u8 rate_max_phy;
	u8 per[RATE_TABLE_SIZE];
	u32 probe_time;
	u32 per_down_time;
	u32 probe_interval;
	u32 prev_data_rix;
	u32 tx_triglevel_max;
	struct ath_rateset neg_rates;
	struct ath_rateset neg_ht_rates;
	struct ath_rate_softc *asc;
};

enum ath9k_internal_frame_type {
	ATH9K_NOT_INTERNAL,
	ATH9K_INT_PAUSE,
	ATH9K_INT_UNPAUSE
};

struct ath_tx_info_priv {
	struct ath_wiphy *aphy;
	struct ath_tx_status tx;
	int n_frames;
	int n_bad_frames;
	bool update_rc;
	enum ath9k_internal_frame_type frame_type;
};

#define ATH_TX_INFO_PRIV(tx_info) \
	((struct ath_tx_info_priv *)((tx_info)->rate_driver_data[0]))

void ath_rate_attach(struct ath_softc *sc);
u8 ath_rate_findrateix(struct ath_softc *sc, u8 dot11_rate);
int ath_rate_control_register(void);
void ath_rate_control_unregister(void);

#endif /* RC_H */
Commit	Line	Data
f078f209 LR	1	/*
	2	* Copyright (c) 2004 Sam Leffler, Errno Consulting
	3	* Copyright (c) 2004 Video54 Technologies, Inc.
cee075a2	4	* Copyright (c) 2008-2009 Atheros Communications Inc.
f078f209 LR	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
f078f209 LR	22	struct ath_softc;
f078f209 LR	23
46d14a58 S	24	#define ATH_RATE_MAX 30
	25	#define RATE_TABLE_SIZE 64
	26	#define MAX_TX_RATE_PHY 48
f078f209	27
2c5a744d S	28	/* VALID_ALL - valid for 20/40/Legacy,
	29	* VALID - Legacy only,
	30	* VALID_20 - HT 20 only,
	31	* VALID_40 - HT 40 only */
	32
46d14a58 S	33	#define INVALID 0x0
	34	#define VALID 0x1
	35	#define VALID_20 0x2
	36	#define VALID_40 0x4
	37	#define VALID_2040 (VALID_20\|VALID_40)
	38	#define VALID_ALL (VALID_2040\|VALID)
f078f209	39
394cf0a1 S	40	enum {
	41	WLAN_RC_PHY_OFDM,
	42	WLAN_RC_PHY_CCK,
	43	WLAN_RC_PHY_HT_20_SS,
	44	WLAN_RC_PHY_HT_20_DS,
	45	WLAN_RC_PHY_HT_40_SS,
	46	WLAN_RC_PHY_HT_40_DS,
	47	WLAN_RC_PHY_HT_20_SS_HGI,
	48	WLAN_RC_PHY_HT_20_DS_HGI,
	49	WLAN_RC_PHY_HT_40_SS_HGI,
	50	WLAN_RC_PHY_HT_40_DS_HGI,
	51	WLAN_RC_PHY_MAX
	52	};
	53
5701ed84 S	54	#define WLAN_RC_PHY_DS(_phy) ((_phy == WLAN_RC_PHY_HT_20_DS) \
	55	\|\| (_phy == WLAN_RC_PHY_HT_40_DS) \
	56	\|\| (_phy == WLAN_RC_PHY_HT_20_DS_HGI) \
	57	\|\| (_phy == WLAN_RC_PHY_HT_40_DS_HGI))
	58	#define WLAN_RC_PHY_40(_phy) ((_phy == WLAN_RC_PHY_HT_40_SS) \
	59	\|\| (_phy == WLAN_RC_PHY_HT_40_DS) \
	60	\|\| (_phy == WLAN_RC_PHY_HT_40_SS_HGI) \
	61	\|\| (_phy == WLAN_RC_PHY_HT_40_DS_HGI))
f078f209	62	#define WLAN_RC_PHY_SGI(_phy) ((_phy == WLAN_RC_PHY_HT_20_SS_HGI) \
5701ed84 S	63	\|\| (_phy == WLAN_RC_PHY_HT_20_DS_HGI) \
	64	\|\| (_phy == WLAN_RC_PHY_HT_40_SS_HGI) \
	65	\|\| (_phy == WLAN_RC_PHY_HT_40_DS_HGI))
f078f209 LR	66
	67	#define WLAN_RC_PHY_HT(_phy) (_phy >= WLAN_RC_PHY_HT_20_SS)
	68
f078f209	69	#define WLAN_RC_CAP_MODE(capflag) (((capflag & WLAN_RC_HT_FLAG) ? \
46d14a58	70	(capflag & WLAN_RC_40_FLAG) ? VALID_40 : VALID_20 : VALID))
f078f209 LR	71
	72	/* Return TRUE if flag supports HT20 && client supports HT20 or
	73	* return TRUE if flag supports HT40 && client supports HT40.
	74	* This is used becos some rates overlap between HT20/HT40.
	75	*/
46d14a58 S	76	#define WLAN_RC_PHY_HT_VALID(flag, capflag) \
	77	(((flag & VALID_20) && !(capflag & WLAN_RC_40_FLAG)) \|\| \
	78	((flag & VALID_40) && (capflag & WLAN_RC_40_FLAG)))
f078f209 LR	79
	80	#define WLAN_RC_DS_FLAG (0x01)
	81	#define WLAN_RC_40_FLAG (0x02)
	82	#define WLAN_RC_SGI_FLAG (0x04)
	83	#define WLAN_RC_HT_FLAG (0x08)
	84
5701ed84 S	85	/**
	86	* struct ath_rate_table - Rate Control table
	87	* @valid: valid for use in rate control
	88	* @valid_single_stream: valid for use in rate control for
	89	* single stream operation
	90	* @phy: CCK/OFDM
	91	* @ratekbps: rate in Kbits per second
	92	* @user_ratekbps: user rate in Kbits per second
	93	* @ratecode: rate that goes into HW descriptors
	94	* @short_preamble: Mask for enabling short preamble in ratecode for CCK
	95	* @dot11rate: value that goes into supported
	96	* rates info element of MLME
	97	* @ctrl_rate: Index of next lower basic rate, used for duration computation
	98	* @max_4ms_framelen: maximum frame length(bytes) for tx duration
	99	* @probe_interval: interval for rate control to probe for other rates
	100	* @rssi_reduce_interval: interval for rate control to reduce rssi
46d14a58	101	* @initial_ratemax: initial ratemax value
5701ed84	102	*/
f078f209 LR	103	struct ath_rate_table {
	104	int rate_cnt;
	105	struct {
5701ed84 S	106	int valid;
	107	int valid_single_stream;
	108	u8 phy;
	109	u32 ratekbps;
	110	u32 user_ratekbps;
	111	u8 ratecode;
	112	u8 short_preamble;
	113	u8 dot11rate;
	114	u8 ctrl_rate;
5701ed84 S	115	u8 base_index;
	116	u8 cw40index;
	117	u8 sgi_index;
	118	u8 ht_index;
	119	u32 max_4ms_framelen;
f078f209	120	} info[RATE_TABLE_SIZE];
5701ed84	121	u32 probe_interval;
5701ed84	122	u8 initial_ratemax;
f078f209 LR	123	};
f078f209 LR	124
256b7759 S	125	struct ath_rateset {
	126	u8 rs_nrates;
	127	u8 rs_rates[ATH_RATE_MAX];
	128	};
	129
5701ed84	130	/**
46d14a58	131	* struct ath_rate_priv - Rate Control priv data
5701ed84	132	* @state: RC state
5701ed84	133	* @probe_rate: rate we are probing at
5701ed84 S	134	* @probe_time: msec timestamp for last probe
	135	* @hw_maxretry_pktcnt: num of packets since we got HW max retry error
	136	* @max_valid_rate: maximum number of valid rate
	137	* @per_down_time: msec timestamp for last PER down step
	138	* @valid_phy_ratecnt: valid rate count
	139	* @rate_max_phy: phy index for the max rate
922bac60	140	* @per: PER for every valid rate in %
5701ed84	141	* @probe_interval: interval for ratectrl to probe for other rates
256b7759 S	142	* @prev_data_rix: rate idx of last data frame
256b7759 S	143	* @ht_cap: HT capabilities
256b7759 S	144	* @neg_rates: Negotatied rates
256b7759 S	145	* @neg_ht_rates: Negotiated HT rates
5701ed84	146	*/
46d14a58	147	struct ath_rate_priv {
5701ed84 S	148	u8 rate_table_size;
5701ed84 S	149	u8 probe_rate;
5701ed84 S	150	u8 hw_maxretry_pktcnt;
5701ed84 S	151	u8 max_valid_rate;
46d14a58	152	u8 valid_rate_index[RATE_TABLE_SIZE];
256b7759	153	u8 ht_cap;
5701ed84	154	u8 valid_phy_ratecnt[WLAN_RC_PHY_MAX];
46d14a58	155	u8 valid_phy_rateidx[WLAN_RC_PHY_MAX][RATE_TABLE_SIZE];
5701ed84	156	u8 rate_max_phy;
922bac60	157	u8 per[RATE_TABLE_SIZE];
256b7759 S	158	u32 probe_time;
256b7759 S	159	u32 per_down_time;
5701ed84	160	u32 probe_interval;
5701ed84	161	u32 prev_data_rix;
fe7f4a77	162	u32 tx_triglevel_max;
5701ed84	163	struct ath_rateset neg_rates;
5701ed84	164	struct ath_rateset neg_ht_rates;
5701ed84	165	struct ath_rate_softc *asc;
f078f209 LR	166	};
f078f209 LR	167
f0ed85c6 JM	168	enum ath9k_internal_frame_type {
	169	ATH9K_NOT_INTERNAL,
	170	ATH9K_INT_PAUSE,
	171	ATH9K_INT_UNPAUSE
	172	};
	173
f078f209	174	struct ath_tx_info_priv {
c52f33d0	175	struct ath_wiphy *aphy;
f078f209 LR	176	struct ath_tx_status tx;
	177	int n_frames;
	178	int n_bad_frames;
7ac47010	179	bool update_rc;
f0ed85c6	180	enum ath9k_internal_frame_type frame_type;
f078f209 LR	181	};
f078f209 LR	182
46d14a58 S	183	#define ATH_TX_INFO_PRIV(tx_info) \
	184	((struct ath_tx_info_priv *)((tx_info)->rate_driver_data[0]))
	185
fe7f4a77	186	void ath_rate_attach(struct ath_softc *sc);
2b406f1e	187	u8 ath_rate_findrateix(struct ath_softc *sc, u8 dot11_rate);
f078f209 LR	188	int ath_rate_control_register(void);
	189	void ath_rate_control_unregister(void);
	190
	191	#endif /* RC_H */