[linux.git] / drivers / net / wireless / iwlwifi / iwl-agn-rs.h

/******************************************************************************
 *
 * Copyright(c) 2003 - 2011 Intel Corporation. All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
 *
 * The full GNU General Public License is included in this distribution in the
 * file called LICENSE.
 *
 * Contact Information:
 *  Intel Linux Wireless <[email protected]>
 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
 *
 *****************************************************************************/

#ifndef __iwl_agn_rs_h__
#define __iwl_agn_rs_h__

struct iwl_rate_info {
	u8 plcp;	/* uCode API:  IWL_RATE_6M_PLCP, etc. */
	u8 plcp_siso;	/* uCode API:  IWL_RATE_SISO_6M_PLCP, etc. */
	u8 plcp_mimo2;	/* uCode API:  IWL_RATE_MIMO2_6M_PLCP, etc. */
	u8 plcp_mimo3;  /* uCode API:  IWL_RATE_MIMO3_6M_PLCP, etc. */
	u8 ieee;	/* MAC header:  IWL_RATE_6M_IEEE, etc. */
	u8 prev_ieee;    /* previous rate in IEEE speeds */
	u8 next_ieee;    /* next rate in IEEE speeds */
	u8 prev_rs;      /* previous rate used in rs algo */
	u8 next_rs;      /* next rate used in rs algo */
	u8 prev_rs_tgg;  /* previous rate used in TGG rs algo */
	u8 next_rs_tgg;  /* next rate used in TGG rs algo */
};

/*
 * These serve as indexes into
 * struct iwl_rate_info iwl_rates[IWL_RATE_COUNT];
 */
enum {
	IWL_RATE_1M_INDEX = 0,
	IWL_RATE_2M_INDEX,
	IWL_RATE_5M_INDEX,
	IWL_RATE_11M_INDEX,
	IWL_RATE_6M_INDEX,
	IWL_RATE_9M_INDEX,
	IWL_RATE_12M_INDEX,
	IWL_RATE_18M_INDEX,
	IWL_RATE_24M_INDEX,
	IWL_RATE_36M_INDEX,
	IWL_RATE_48M_INDEX,
	IWL_RATE_54M_INDEX,
	IWL_RATE_60M_INDEX,
	IWL_RATE_COUNT, /*FIXME:RS:change to IWL_RATE_INDEX_COUNT,*/
	IWL_RATE_COUNT_LEGACY = IWL_RATE_COUNT - 1,	/* Excluding 60M */
	IWL_RATE_INVM_INDEX = IWL_RATE_COUNT,
	IWL_RATE_INVALID = IWL_RATE_COUNT,
};

enum {
	IWL_RATE_6M_INDEX_TABLE = 0,
	IWL_RATE_9M_INDEX_TABLE,
	IWL_RATE_12M_INDEX_TABLE,
	IWL_RATE_18M_INDEX_TABLE,
	IWL_RATE_24M_INDEX_TABLE,
	IWL_RATE_36M_INDEX_TABLE,
	IWL_RATE_48M_INDEX_TABLE,
	IWL_RATE_54M_INDEX_TABLE,
	IWL_RATE_1M_INDEX_TABLE,
	IWL_RATE_2M_INDEX_TABLE,
	IWL_RATE_5M_INDEX_TABLE,
	IWL_RATE_11M_INDEX_TABLE,
	IWL_RATE_INVM_INDEX_TABLE = IWL_RATE_INVM_INDEX - 1,
};

enum {
	IWL_FIRST_OFDM_RATE = IWL_RATE_6M_INDEX,
	IWL_LAST_OFDM_RATE = IWL_RATE_60M_INDEX,
	IWL_FIRST_CCK_RATE = IWL_RATE_1M_INDEX,
	IWL_LAST_CCK_RATE = IWL_RATE_11M_INDEX,
};

/* #define vs. enum to keep from defaulting to 'large integer' */
#define	IWL_RATE_6M_MASK   (1 << IWL_RATE_6M_INDEX)
#define	IWL_RATE_9M_MASK   (1 << IWL_RATE_9M_INDEX)
#define	IWL_RATE_12M_MASK  (1 << IWL_RATE_12M_INDEX)
#define	IWL_RATE_18M_MASK  (1 << IWL_RATE_18M_INDEX)
#define	IWL_RATE_24M_MASK  (1 << IWL_RATE_24M_INDEX)
#define	IWL_RATE_36M_MASK  (1 << IWL_RATE_36M_INDEX)
#define	IWL_RATE_48M_MASK  (1 << IWL_RATE_48M_INDEX)
#define	IWL_RATE_54M_MASK  (1 << IWL_RATE_54M_INDEX)
#define IWL_RATE_60M_MASK  (1 << IWL_RATE_60M_INDEX)
#define	IWL_RATE_1M_MASK   (1 << IWL_RATE_1M_INDEX)
#define	IWL_RATE_2M_MASK   (1 << IWL_RATE_2M_INDEX)
#define	IWL_RATE_5M_MASK   (1 << IWL_RATE_5M_INDEX)
#define	IWL_RATE_11M_MASK  (1 << IWL_RATE_11M_INDEX)

/* uCode API values for legacy bit rates, both OFDM and CCK */
enum {
	IWL_RATE_6M_PLCP  = 13,
	IWL_RATE_9M_PLCP  = 15,
	IWL_RATE_12M_PLCP = 5,
	IWL_RATE_18M_PLCP = 7,
	IWL_RATE_24M_PLCP = 9,
	IWL_RATE_36M_PLCP = 11,
	IWL_RATE_48M_PLCP = 1,
	IWL_RATE_54M_PLCP = 3,
	IWL_RATE_60M_PLCP = 3,/*FIXME:RS:should be removed*/
	IWL_RATE_1M_PLCP  = 10,
	IWL_RATE_2M_PLCP  = 20,
	IWL_RATE_5M_PLCP  = 55,
	IWL_RATE_11M_PLCP = 110,
	/*FIXME:RS:change to IWL_RATE_LEGACY_??M_PLCP */
	/*FIXME:RS:add IWL_RATE_LEGACY_INVM_PLCP = 0,*/
};

/* uCode API values for OFDM high-throughput (HT) bit rates */
enum {
	IWL_RATE_SISO_6M_PLCP = 0,
	IWL_RATE_SISO_12M_PLCP = 1,
	IWL_RATE_SISO_18M_PLCP = 2,
	IWL_RATE_SISO_24M_PLCP = 3,
	IWL_RATE_SISO_36M_PLCP = 4,
	IWL_RATE_SISO_48M_PLCP = 5,
	IWL_RATE_SISO_54M_PLCP = 6,
	IWL_RATE_SISO_60M_PLCP = 7,
	IWL_RATE_MIMO2_6M_PLCP  = 0x8,
	IWL_RATE_MIMO2_12M_PLCP = 0x9,
	IWL_RATE_MIMO2_18M_PLCP = 0xa,
	IWL_RATE_MIMO2_24M_PLCP = 0xb,
	IWL_RATE_MIMO2_36M_PLCP = 0xc,
	IWL_RATE_MIMO2_48M_PLCP = 0xd,
	IWL_RATE_MIMO2_54M_PLCP = 0xe,
	IWL_RATE_MIMO2_60M_PLCP = 0xf,
	IWL_RATE_MIMO3_6M_PLCP  = 0x10,
	IWL_RATE_MIMO3_12M_PLCP = 0x11,
	IWL_RATE_MIMO3_18M_PLCP = 0x12,
	IWL_RATE_MIMO3_24M_PLCP = 0x13,
	IWL_RATE_MIMO3_36M_PLCP = 0x14,
	IWL_RATE_MIMO3_48M_PLCP = 0x15,
	IWL_RATE_MIMO3_54M_PLCP = 0x16,
	IWL_RATE_MIMO3_60M_PLCP = 0x17,
	IWL_RATE_SISO_INVM_PLCP,
	IWL_RATE_MIMO2_INVM_PLCP = IWL_RATE_SISO_INVM_PLCP,
	IWL_RATE_MIMO3_INVM_PLCP = IWL_RATE_SISO_INVM_PLCP,
};

/* MAC header values for bit rates */
enum {
	IWL_RATE_6M_IEEE  = 12,
	IWL_RATE_9M_IEEE  = 18,
	IWL_RATE_12M_IEEE = 24,
	IWL_RATE_18M_IEEE = 36,
	IWL_RATE_24M_IEEE = 48,
	IWL_RATE_36M_IEEE = 72,
	IWL_RATE_48M_IEEE = 96,
	IWL_RATE_54M_IEEE = 108,
	IWL_RATE_60M_IEEE = 120,
	IWL_RATE_1M_IEEE  = 2,
	IWL_RATE_2M_IEEE  = 4,
	IWL_RATE_5M_IEEE  = 11,
	IWL_RATE_11M_IEEE = 22,
};

#define IWL_CCK_BASIC_RATES_MASK    \
       (IWL_RATE_1M_MASK          | \
	IWL_RATE_2M_MASK)

#define IWL_CCK_RATES_MASK          \
       (IWL_CCK_BASIC_RATES_MASK  | \
	IWL_RATE_5M_MASK          | \
	IWL_RATE_11M_MASK)

#define IWL_OFDM_BASIC_RATES_MASK   \
	(IWL_RATE_6M_MASK         | \
	IWL_RATE_12M_MASK         | \
	IWL_RATE_24M_MASK)

#define IWL_OFDM_RATES_MASK         \
       (IWL_OFDM_BASIC_RATES_MASK | \
	IWL_RATE_9M_MASK          | \
	IWL_RATE_18M_MASK         | \
	IWL_RATE_36M_MASK         | \
	IWL_RATE_48M_MASK         | \
	IWL_RATE_54M_MASK)

#define IWL_BASIC_RATES_MASK         \
	(IWL_OFDM_BASIC_RATES_MASK | \
	 IWL_CCK_BASIC_RATES_MASK)

#define IWL_RATES_MASK ((1 << IWL_RATE_COUNT) - 1)

#define IWL_INVALID_VALUE    -1

#define IWL_MIN_RSSI_VAL                 -100
#define IWL_MAX_RSSI_VAL                    0

/* These values specify how many Tx frame attempts before
 * searching for a new modulation mode */
#define IWL_LEGACY_FAILURE_LIMIT	160
#define IWL_LEGACY_SUCCESS_LIMIT	480
#define IWL_LEGACY_TABLE_COUNT		160

#define IWL_NONE_LEGACY_FAILURE_LIMIT	400
#define IWL_NONE_LEGACY_SUCCESS_LIMIT	4500
#define IWL_NONE_LEGACY_TABLE_COUNT	1500

/* Success ratio (ACKed / attempted tx frames) values (perfect is 128 * 100) */
#define IWL_RS_GOOD_RATIO		12800	/* 100% */
#define IWL_RATE_SCALE_SWITCH		10880	/*  85% */
#define IWL_RATE_HIGH_TH		10880	/*  85% */
#define IWL_RATE_INCREASE_TH		6400	/*  50% */
#define IWL_RATE_DECREASE_TH		1920	/*  15% */

/* possible actions when in legacy mode */
#define IWL_LEGACY_SWITCH_ANTENNA1      0
#define IWL_LEGACY_SWITCH_ANTENNA2      1
#define IWL_LEGACY_SWITCH_SISO          2
#define IWL_LEGACY_SWITCH_MIMO2_AB      3
#define IWL_LEGACY_SWITCH_MIMO2_AC      4
#define IWL_LEGACY_SWITCH_MIMO2_BC      5
#define IWL_LEGACY_SWITCH_MIMO3_ABC     6

/* possible actions when in siso mode */
#define IWL_SISO_SWITCH_ANTENNA1        0
#define IWL_SISO_SWITCH_ANTENNA2        1
#define IWL_SISO_SWITCH_MIMO2_AB        2
#define IWL_SISO_SWITCH_MIMO2_AC        3
#define IWL_SISO_SWITCH_MIMO2_BC        4
#define IWL_SISO_SWITCH_GI              5
#define IWL_SISO_SWITCH_MIMO3_ABC       6


/* possible actions when in mimo mode */
#define IWL_MIMO2_SWITCH_ANTENNA1       0
#define IWL_MIMO2_SWITCH_ANTENNA2       1
#define IWL_MIMO2_SWITCH_SISO_A         2
#define IWL_MIMO2_SWITCH_SISO_B         3
#define IWL_MIMO2_SWITCH_SISO_C         4
#define IWL_MIMO2_SWITCH_GI             5
#define IWL_MIMO2_SWITCH_MIMO3_ABC      6


/* possible actions when in mimo3 mode */
#define IWL_MIMO3_SWITCH_ANTENNA1       0
#define IWL_MIMO3_SWITCH_ANTENNA2       1
#define IWL_MIMO3_SWITCH_SISO_A         2
#define IWL_MIMO3_SWITCH_SISO_B         3
#define IWL_MIMO3_SWITCH_SISO_C         4
#define IWL_MIMO3_SWITCH_MIMO2_AB       5
#define IWL_MIMO3_SWITCH_MIMO2_AC       6
#define IWL_MIMO3_SWITCH_MIMO2_BC       7
#define IWL_MIMO3_SWITCH_GI             8


#define IWL_MAX_11N_MIMO3_SEARCH IWL_MIMO3_SWITCH_GI
#define IWL_MAX_SEARCH IWL_MIMO2_SWITCH_MIMO3_ABC

/*FIXME:RS:add possible actions for MIMO3*/

#define IWL_ACTION_LIMIT		3	/* # possible actions */

#define LQ_SIZE		2	/* 2 mode tables:  "Active" and "Search" */

/* load per tid defines for A-MPDU activation */
#define IWL_AGG_TPT_THREHOLD	0
#define IWL_AGG_LOAD_THRESHOLD	10
#define IWL_AGG_ALL_TID		0xff
#define TID_QUEUE_CELL_SPACING	50	/*mS */
#define TID_QUEUE_MAX_SIZE	20
#define TID_ROUND_VALUE		5	/* mS */
#define TID_MAX_LOAD_COUNT	8

#define TID_MAX_TIME_DIFF ((TID_QUEUE_MAX_SIZE - 1) * TID_QUEUE_CELL_SPACING)
#define TIME_WRAP_AROUND(x, y) (((y) > (x)) ? (y) - (x) : (0-(x)) + (y))

extern const struct iwl_rate_info iwl_rates[IWL_RATE_COUNT];

enum iwl_table_type {
	LQ_NONE,
	LQ_G,		/* legacy types */
	LQ_A,
	LQ_SISO,	/* high-throughput types */
	LQ_MIMO2,
	LQ_MIMO3,
	LQ_MAX,
};

#define is_legacy(tbl) (((tbl) == LQ_G) || ((tbl) == LQ_A))
#define is_siso(tbl) ((tbl) == LQ_SISO)
#define is_mimo2(tbl) ((tbl) == LQ_MIMO2)
#define is_mimo3(tbl) ((tbl) == LQ_MIMO3)
#define is_mimo(tbl) (is_mimo2(tbl) || is_mimo3(tbl))
#define is_Ht(tbl) (is_siso(tbl) || is_mimo(tbl))
#define is_a_band(tbl) ((tbl) == LQ_A)
#define is_g_and(tbl) ((tbl) == LQ_G)

#define	ANT_NONE	0x0
#define	ANT_A		BIT(0)
#define	ANT_B		BIT(1)
#define	ANT_AB		(ANT_A | ANT_B)
#define ANT_C		BIT(2)
#define	ANT_AC		(ANT_A | ANT_C)
#define ANT_BC		(ANT_B | ANT_C)
#define ANT_ABC		(ANT_AB | ANT_C)

#define IWL_MAX_MCS_DISPLAY_SIZE	12

struct iwl_rate_mcs_info {
	char	mbps[IWL_MAX_MCS_DISPLAY_SIZE];
	char	mcs[IWL_MAX_MCS_DISPLAY_SIZE];
};

/**
 * struct iwl_rate_scale_data -- tx success history for one rate
 */
struct iwl_rate_scale_data {
	u64 data;		/* bitmap of successful frames */
	s32 success_counter;	/* number of frames successful */
	s32 success_ratio;	/* per-cent * 128  */
	s32 counter;		/* number of frames attempted */
	s32 average_tpt;	/* success ratio * expected throughput */
	unsigned long stamp;
};

/**
 * struct iwl_scale_tbl_info -- tx params and success history for all rates
 *
 * There are two of these in struct iwl_lq_sta,
 * one for "active", and one for "search".
 */
struct iwl_scale_tbl_info {
	enum iwl_table_type lq_type;
	u8 ant_type;
	u8 is_SGI;	/* 1 = short guard interval */
	u8 is_ht40;	/* 1 = 40 MHz channel width */
	u8 is_dup;	/* 1 = duplicated data streams */
	u8 action;	/* change modulation; IWL_[LEGACY/SISO/MIMO]_SWITCH_* */
	u8 max_search;	/* maximun number of tables we can search */
	s32 *expected_tpt;	/* throughput metrics; expected_tpt_G, etc. */
	u32 current_rate;  /* rate_n_flags, uCode API format */
	struct iwl_rate_scale_data win[IWL_RATE_COUNT]; /* rate histories */
};

struct iwl_traffic_load {
	unsigned long time_stamp;	/* age of the oldest statistics */
	u32 packet_count[TID_QUEUE_MAX_SIZE];   /* packet count in this time
						 * slice */
	u32 total;			/* total num of packets during the
					 * last TID_MAX_TIME_DIFF */
	u8 queue_count;			/* number of queues that has
					 * been used since the last cleanup */
	u8 head;			/* start of the circular buffer */
};

/**
 * struct iwl_lq_sta -- driver's rate scaling private structure
 *
 * Pointer to this gets passed back and forth between driver and mac80211.
 */
struct iwl_lq_sta {
	u8 active_tbl;		/* index of active table, range 0-1 */
	u8 enable_counter;	/* indicates HT mode */
	u8 stay_in_tbl;		/* 1: disallow, 0: allow search for new mode */
	u8 search_better_tbl;	/* 1: currently trying alternate mode */
	s32 last_tpt;

	/* The following determine when to search for a new mode */
	u32 table_count_limit;
	u32 max_failure_limit;	/* # failed frames before new search */
	u32 max_success_limit;	/* # successful frames before new search */
	u32 table_count;
	u32 total_failed;	/* total failed frames, any/all rates */
	u32 total_success;	/* total successful frames, any/all rates */
	u64 flush_timer;	/* time staying in mode before new search */

	u8 action_counter;	/* # mode-switch actions tried */
	u8 is_green;
	u8 is_dup;
	enum ieee80211_band band;

	/* The following are bitmaps of rates; IWL_RATE_6M_MASK, etc. */
	u32 supp_rates;
	u16 active_legacy_rate;
	u16 active_siso_rate;
	u16 active_mimo2_rate;
	u16 active_mimo3_rate;
	s8 max_rate_idx;     /* Max rate set by user */
	u8 missed_rate_counter;

	struct iwl_link_quality_cmd lq;
	struct iwl_scale_tbl_info lq_info[LQ_SIZE]; /* "active", "search" */
	struct iwl_traffic_load load[TID_MAX_LOAD_COUNT];
	u8 tx_agg_tid_en;
#ifdef CONFIG_MAC80211_DEBUGFS
	struct dentry *rs_sta_dbgfs_scale_table_file;
	struct dentry *rs_sta_dbgfs_stats_table_file;
	struct dentry *rs_sta_dbgfs_rate_scale_data_file;
	struct dentry *rs_sta_dbgfs_tx_agg_tid_en_file;
	u32 dbg_fixed_rate;
#endif
	struct iwl_priv *drv;

	/* used to be in sta_info */
	int last_txrate_idx;
	/* last tx rate_n_flags */
	u32 last_rate_n_flags;
	/* packets destined for this STA are aggregated */
	u8 is_agg;
	/* BT traffic this sta was last updated in */
	u8 last_bt_traffic;
};

static inline u8 num_of_ant(u8 mask)
{
	return  !!((mask) & ANT_A) +
		!!((mask) & ANT_B) +
		!!((mask) & ANT_C);
}

static inline u8 first_antenna(u8 mask)
{
	if (mask & ANT_A)
		return ANT_A;
	if (mask & ANT_B)
		return ANT_B;
	return ANT_C;
}


/* Initialize station's rate scaling information after adding station */
extern void iwl_rs_rate_init(struct iwl_priv *priv,
			     struct ieee80211_sta *sta, u8 sta_id);

/**
 * iwl_rate_control_register - Register the rate control algorithm callbacks
 *
 * Since the rate control algorithm is hardware specific, there is no need
 * or reason to place it as a stand alone module.  The driver can call
 * iwl_rate_control_register in order to register the rate control callbacks
 * with the mac80211 subsystem.  This should be performed prior to calling
 * ieee80211_register_hw
 *
 */
extern int iwlagn_rate_control_register(void);

/**
 * iwl_rate_control_unregister - Unregister the rate control callbacks
 *
 * This should be called after calling ieee80211_unregister_hw, but before
 * the driver is unloaded.
 */
extern void iwlagn_rate_control_unregister(void);

#endif /* __iwl_agn__rs__ */
Commit	Line	Data
b481de9c ZY	1	/******************************************************************************
b481de9c ZY	2	*
901069c7	3	* Copyright(c) 2003 - 2011 Intel Corporation. All rights reserved.
b481de9c ZY	4	*
	5	* This program is free software; you can redistribute it and/or modify it
	6	* under the terms of version 2 of the GNU General Public License as
	7	* published by the Free Software Foundation.
	8	*
	9	* This program is distributed in the hope that it will be useful, but WITHOUT
	10	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	11	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	12	* more details.
	13	*
	14	* You should have received a copy of the GNU General Public License along with
	15	* this program; if not, write to the Free Software Foundation, Inc.,
	16	* 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
	17	*
	18	* The full GNU General Public License is included in this distribution in the
	19	* file called LICENSE.
	20	*
	21	* Contact Information:
759ef89f	22	* Intel Linux Wireless <[email protected]>
b481de9c ZY	23	* Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
	24	*
	25	*****************************************************************************/
	26
e227ceac TW	27	#ifndef __iwl_agn_rs_h__
e227ceac TW	28	#define __iwl_agn_rs_h__
b481de9c	29
1826dcc0	30	struct iwl_rate_info {
77626355 BC	31	u8 plcp; /* uCode API: IWL_RATE_6M_PLCP, etc. */
77626355 BC	32	u8 plcp_siso; /* uCode API: IWL_RATE_SISO_6M_PLCP, etc. */
fde0db31 GC	33	u8 plcp_mimo2; /* uCode API: IWL_RATE_MIMO2_6M_PLCP, etc. */
fde0db31 GC	34	u8 plcp_mimo3; /* uCode API: IWL_RATE_MIMO3_6M_PLCP, etc. */
77626355	35	u8 ieee; /* MAC header: IWL_RATE_6M_IEEE, etc. */
b481de9c ZY	36	u8 prev_ieee; /* previous rate in IEEE speeds */
	37	u8 next_ieee; /* next rate in IEEE speeds */
	38	u8 prev_rs; /* previous rate used in rs algo */
	39	u8 next_rs; /* next rate used in rs algo */
	40	u8 prev_rs_tgg; /* previous rate used in TGG rs algo */
	41	u8 next_rs_tgg; /* next rate used in TGG rs algo */
	42	};
	43
9fbab516 BC	44	/*
9fbab516 BC	45	* These serve as indexes into
1826dcc0	46	* struct iwl_rate_info iwl_rates[IWL_RATE_COUNT];
9fbab516	47	*/
b481de9c ZY	48	enum {
	49	IWL_RATE_1M_INDEX = 0,
	50	IWL_RATE_2M_INDEX,
	51	IWL_RATE_5M_INDEX,
	52	IWL_RATE_11M_INDEX,
	53	IWL_RATE_6M_INDEX,
	54	IWL_RATE_9M_INDEX,
	55	IWL_RATE_12M_INDEX,
	56	IWL_RATE_18M_INDEX,
	57	IWL_RATE_24M_INDEX,
	58	IWL_RATE_36M_INDEX,
	59	IWL_RATE_48M_INDEX,
	60	IWL_RATE_54M_INDEX,
	61	IWL_RATE_60M_INDEX,
fde0db31	62	IWL_RATE_COUNT, /FIXME:RS:change to IWL_RATE_INDEX_COUNT,/
5027309b	63	IWL_RATE_COUNT_LEGACY = IWL_RATE_COUNT - 1, /* Excluding 60M */
b481de9c	64	IWL_RATE_INVM_INDEX = IWL_RATE_COUNT,
fde0db31	65	IWL_RATE_INVALID = IWL_RATE_COUNT,
b481de9c ZY	66	};
b481de9c ZY	67
d9829a67 SO	68	enum {
	69	IWL_RATE_6M_INDEX_TABLE = 0,
	70	IWL_RATE_9M_INDEX_TABLE,
	71	IWL_RATE_12M_INDEX_TABLE,
	72	IWL_RATE_18M_INDEX_TABLE,
	73	IWL_RATE_24M_INDEX_TABLE,
	74	IWL_RATE_36M_INDEX_TABLE,
	75	IWL_RATE_48M_INDEX_TABLE,
	76	IWL_RATE_54M_INDEX_TABLE,
	77	IWL_RATE_1M_INDEX_TABLE,
	78	IWL_RATE_2M_INDEX_TABLE,
	79	IWL_RATE_5M_INDEX_TABLE,
	80	IWL_RATE_11M_INDEX_TABLE,
	81	IWL_RATE_INVM_INDEX_TABLE = IWL_RATE_INVM_INDEX - 1,
	82	};
	83
b481de9c ZY	84	enum {
	85	IWL_FIRST_OFDM_RATE = IWL_RATE_6M_INDEX,
	86	IWL_LAST_OFDM_RATE = IWL_RATE_60M_INDEX,
	87	IWL_FIRST_CCK_RATE = IWL_RATE_1M_INDEX,
	88	IWL_LAST_CCK_RATE = IWL_RATE_11M_INDEX,
	89	};
	90
	91	/* #define vs. enum to keep from defaulting to 'large integer' */
8a1b0245 RC	92	#define IWL_RATE_6M_MASK (1 << IWL_RATE_6M_INDEX)
	93	#define IWL_RATE_9M_MASK (1 << IWL_RATE_9M_INDEX)
	94	#define IWL_RATE_12M_MASK (1 << IWL_RATE_12M_INDEX)
	95	#define IWL_RATE_18M_MASK (1 << IWL_RATE_18M_INDEX)
	96	#define IWL_RATE_24M_MASK (1 << IWL_RATE_24M_INDEX)
	97	#define IWL_RATE_36M_MASK (1 << IWL_RATE_36M_INDEX)
	98	#define IWL_RATE_48M_MASK (1 << IWL_RATE_48M_INDEX)
	99	#define IWL_RATE_54M_MASK (1 << IWL_RATE_54M_INDEX)
	100	#define IWL_RATE_60M_MASK (1 << IWL_RATE_60M_INDEX)
	101	#define IWL_RATE_1M_MASK (1 << IWL_RATE_1M_INDEX)
	102	#define IWL_RATE_2M_MASK (1 << IWL_RATE_2M_INDEX)
	103	#define IWL_RATE_5M_MASK (1 << IWL_RATE_5M_INDEX)
	104	#define IWL_RATE_11M_MASK (1 << IWL_RATE_11M_INDEX)
b481de9c	105
e227ceac	106	/* uCode API values for legacy bit rates, both OFDM and CCK */
b481de9c ZY	107	enum {
	108	IWL_RATE_6M_PLCP = 13,
	109	IWL_RATE_9M_PLCP = 15,
	110	IWL_RATE_12M_PLCP = 5,
	111	IWL_RATE_18M_PLCP = 7,
	112	IWL_RATE_24M_PLCP = 9,
	113	IWL_RATE_36M_PLCP = 11,
	114	IWL_RATE_48M_PLCP = 1,
	115	IWL_RATE_54M_PLCP = 3,
fde0db31	116	IWL_RATE_60M_PLCP = 3,/FIXME:RS:should be removed/
b481de9c ZY	117	IWL_RATE_1M_PLCP = 10,
	118	IWL_RATE_2M_PLCP = 20,
	119	IWL_RATE_5M_PLCP = 55,
	120	IWL_RATE_11M_PLCP = 110,
fde0db31 GC	121	/FIXME:RS:change to IWL_RATE_LEGACY_??M_PLCP /
fde0db31 GC	122	/FIXME:RS:add IWL_RATE_LEGACY_INVM_PLCP = 0,/
b481de9c ZY	123	};
b481de9c ZY	124
e227ceac	125	/* uCode API values for OFDM high-throughput (HT) bit rates */
b481de9c ZY	126	enum {
	127	IWL_RATE_SISO_6M_PLCP = 0,
	128	IWL_RATE_SISO_12M_PLCP = 1,
	129	IWL_RATE_SISO_18M_PLCP = 2,
	130	IWL_RATE_SISO_24M_PLCP = 3,
	131	IWL_RATE_SISO_36M_PLCP = 4,
	132	IWL_RATE_SISO_48M_PLCP = 5,
	133	IWL_RATE_SISO_54M_PLCP = 6,
	134	IWL_RATE_SISO_60M_PLCP = 7,
fde0db31 GC	135	IWL_RATE_MIMO2_6M_PLCP = 0x8,
	136	IWL_RATE_MIMO2_12M_PLCP = 0x9,
	137	IWL_RATE_MIMO2_18M_PLCP = 0xa,
	138	IWL_RATE_MIMO2_24M_PLCP = 0xb,
	139	IWL_RATE_MIMO2_36M_PLCP = 0xc,
	140	IWL_RATE_MIMO2_48M_PLCP = 0xd,
	141	IWL_RATE_MIMO2_54M_PLCP = 0xe,
	142	IWL_RATE_MIMO2_60M_PLCP = 0xf,
	143	IWL_RATE_MIMO3_6M_PLCP = 0x10,
	144	IWL_RATE_MIMO3_12M_PLCP = 0x11,
	145	IWL_RATE_MIMO3_18M_PLCP = 0x12,
	146	IWL_RATE_MIMO3_24M_PLCP = 0x13,
	147	IWL_RATE_MIMO3_36M_PLCP = 0x14,
	148	IWL_RATE_MIMO3_48M_PLCP = 0x15,
	149	IWL_RATE_MIMO3_54M_PLCP = 0x16,
	150	IWL_RATE_MIMO3_60M_PLCP = 0x17,
b481de9c	151	IWL_RATE_SISO_INVM_PLCP,
fde0db31 GC	152	IWL_RATE_MIMO2_INVM_PLCP = IWL_RATE_SISO_INVM_PLCP,
fde0db31 GC	153	IWL_RATE_MIMO3_INVM_PLCP = IWL_RATE_SISO_INVM_PLCP,
b481de9c ZY	154	};
b481de9c ZY	155
77626355	156	/* MAC header values for bit rates */
b481de9c ZY	157	enum {
	158	IWL_RATE_6M_IEEE = 12,
	159	IWL_RATE_9M_IEEE = 18,
	160	IWL_RATE_12M_IEEE = 24,
	161	IWL_RATE_18M_IEEE = 36,
	162	IWL_RATE_24M_IEEE = 48,
	163	IWL_RATE_36M_IEEE = 72,
	164	IWL_RATE_48M_IEEE = 96,
	165	IWL_RATE_54M_IEEE = 108,
	166	IWL_RATE_60M_IEEE = 120,
	167	IWL_RATE_1M_IEEE = 2,
	168	IWL_RATE_2M_IEEE = 4,
	169	IWL_RATE_5M_IEEE = 11,
	170	IWL_RATE_11M_IEEE = 22,
	171	};
	172
	173	#define IWL_CCK_BASIC_RATES_MASK \
	174	(IWL_RATE_1M_MASK \| \
	175	IWL_RATE_2M_MASK)
	176
	177	#define IWL_CCK_RATES_MASK \
7ae81077	178	(IWL_CCK_BASIC_RATES_MASK \| \
b481de9c ZY	179	IWL_RATE_5M_MASK \| \
	180	IWL_RATE_11M_MASK)
	181
	182	#define IWL_OFDM_BASIC_RATES_MASK \
	183	(IWL_RATE_6M_MASK \| \
	184	IWL_RATE_12M_MASK \| \
	185	IWL_RATE_24M_MASK)
	186
	187	#define IWL_OFDM_RATES_MASK \
	188	(IWL_OFDM_BASIC_RATES_MASK \| \
	189	IWL_RATE_9M_MASK \| \
	190	IWL_RATE_18M_MASK \| \
	191	IWL_RATE_36M_MASK \| \
	192	IWL_RATE_48M_MASK \| \
	193	IWL_RATE_54M_MASK)
	194
	195	#define IWL_BASIC_RATES_MASK \
	196	(IWL_OFDM_BASIC_RATES_MASK \| \
	197	IWL_CCK_BASIC_RATES_MASK)
	198
8a1b0245	199	#define IWL_RATES_MASK ((1 << IWL_RATE_COUNT) - 1)
b481de9c ZY	200
	201	#define IWL_INVALID_VALUE -1
	202
	203	#define IWL_MIN_RSSI_VAL -100
	204	#define IWL_MAX_RSSI_VAL 0
	205
77626355 BC	206	/* These values specify how many Tx frame attempts before
77626355 BC	207	* searching for a new modulation mode */
b481de9c ZY	208	#define IWL_LEGACY_FAILURE_LIMIT 160
	209	#define IWL_LEGACY_SUCCESS_LIMIT 480
	210	#define IWL_LEGACY_TABLE_COUNT 160
	211
	212	#define IWL_NONE_LEGACY_FAILURE_LIMIT 400
	213	#define IWL_NONE_LEGACY_SUCCESS_LIMIT 4500
	214	#define IWL_NONE_LEGACY_TABLE_COUNT 1500
	215
77626355 BC	216	/* Success ratio (ACKed / attempted tx frames) values (perfect is 128 * 100) */
	217	#define IWL_RS_GOOD_RATIO 12800 /* 100% */
	218	#define IWL_RATE_SCALE_SWITCH 10880 /* 85% */
	219	#define IWL_RATE_HIGH_TH 10880 /* 85% */
8fe72311	220	#define IWL_RATE_INCREASE_TH 6400 /* 50% */
77626355	221	#define IWL_RATE_DECREASE_TH 1920 /* 15% */
b481de9c	222
77626355	223	/* possible actions when in legacy mode */
3110bef7 GC	224	#define IWL_LEGACY_SWITCH_ANTENNA1 0
	225	#define IWL_LEGACY_SWITCH_ANTENNA2 1
	226	#define IWL_LEGACY_SWITCH_SISO 2
	227	#define IWL_LEGACY_SWITCH_MIMO2_AB 3
	228	#define IWL_LEGACY_SWITCH_MIMO2_AC 4
	229	#define IWL_LEGACY_SWITCH_MIMO2_BC 5
584a0f00	230	#define IWL_LEGACY_SWITCH_MIMO3_ABC 6
77626355 BC	231
77626355 BC	232	/* possible actions when in siso mode */
3110bef7 GC	233	#define IWL_SISO_SWITCH_ANTENNA1 0
	234	#define IWL_SISO_SWITCH_ANTENNA2 1
	235	#define IWL_SISO_SWITCH_MIMO2_AB 2
	236	#define IWL_SISO_SWITCH_MIMO2_AC 3
	237	#define IWL_SISO_SWITCH_MIMO2_BC 4
	238	#define IWL_SISO_SWITCH_GI 5
584a0f00 WYG	239	#define IWL_SISO_SWITCH_MIMO3_ABC 6
584a0f00 WYG	240
b481de9c	241
77626355	242	/* possible actions when in mimo mode */
3110bef7 GC	243	#define IWL_MIMO2_SWITCH_ANTENNA1 0
	244	#define IWL_MIMO2_SWITCH_ANTENNA2 1
	245	#define IWL_MIMO2_SWITCH_SISO_A 2
	246	#define IWL_MIMO2_SWITCH_SISO_B 3
	247	#define IWL_MIMO2_SWITCH_SISO_C 4
	248	#define IWL_MIMO2_SWITCH_GI 5
584a0f00 WYG	249	#define IWL_MIMO2_SWITCH_MIMO3_ABC 6
	250
	251
	252	/* possible actions when in mimo3 mode */
	253	#define IWL_MIMO3_SWITCH_ANTENNA1 0
	254	#define IWL_MIMO3_SWITCH_ANTENNA2 1
	255	#define IWL_MIMO3_SWITCH_SISO_A 2
	256	#define IWL_MIMO3_SWITCH_SISO_B 3
	257	#define IWL_MIMO3_SWITCH_SISO_C 4
	258	#define IWL_MIMO3_SWITCH_MIMO2_AB 5
	259	#define IWL_MIMO3_SWITCH_MIMO2_AC 6
	260	#define IWL_MIMO3_SWITCH_MIMO2_BC 7
	261	#define IWL_MIMO3_SWITCH_GI 8
	262
	263
d6e93399 MA	264	#define IWL_MAX_11N_MIMO3_SEARCH IWL_MIMO3_SWITCH_GI
d6e93399 MA	265	#define IWL_MAX_SEARCH IWL_MIMO2_SWITCH_MIMO3_ABC
fde0db31	266
a96a27f9	267	/FIXME:RS:add possible actions for MIMO3/
fde0db31	268
77626355 BC	269	#define IWL_ACTION_LIMIT 3 /* # possible actions */
	270
	271	#define LQ_SIZE 2 /* 2 mode tables: "Active" and "Search" */
b481de9c	272
0c11b4de RR	273	/* load per tid defines for A-MPDU activation */
	274	#define IWL_AGG_TPT_THREHOLD 0
	275	#define IWL_AGG_LOAD_THRESHOLD 10
	276	#define IWL_AGG_ALL_TID 0xff
	277	#define TID_QUEUE_CELL_SPACING 50 /mS /
	278	#define TID_QUEUE_MAX_SIZE 20
	279	#define TID_ROUND_VALUE 5 /* mS */
	280	#define TID_MAX_LOAD_COUNT 8
	281
	282	#define TID_MAX_TIME_DIFF ((TID_QUEUE_MAX_SIZE - 1) * TID_QUEUE_CELL_SPACING)
	283	#define TIME_WRAP_AROUND(x, y) (((y) > (x)) ? (y) - (x) : (0-(x)) + (y))
	284
1826dcc0	285	extern const struct iwl_rate_info iwl_rates[IWL_RATE_COUNT];
b481de9c	286
fde0db31	287	enum iwl_table_type {
b481de9c	288	LQ_NONE,
77626355	289	LQ_G, /* legacy types */
b481de9c	290	LQ_A,
77626355	291	LQ_SISO, /* high-throughput types */
fde0db31 GC	292	LQ_MIMO2,
fde0db31 GC	293	LQ_MIMO3,
b481de9c ZY	294	LQ_MAX,
	295	};
	296
81cd110d	297	#define is_legacy(tbl) (((tbl) == LQ_G) \|\| ((tbl) == LQ_A))
fde0db31 GC	298	#define is_siso(tbl) ((tbl) == LQ_SISO)
	299	#define is_mimo2(tbl) ((tbl) == LQ_MIMO2)
	300	#define is_mimo3(tbl) ((tbl) == LQ_MIMO3)
	301	#define is_mimo(tbl) (is_mimo2(tbl) \|\| is_mimo3(tbl))
81cd110d	302	#define is_Ht(tbl) (is_siso(tbl) \|\| is_mimo(tbl))
fde0db31 GC	303	#define is_a_band(tbl) ((tbl) == LQ_A)
	304	#define is_g_and(tbl) ((tbl) == LQ_G)
	305
	306	#define ANT_NONE 0x0
	307	#define ANT_A BIT(0)
	308	#define ANT_B BIT(1)
	309	#define ANT_AB (ANT_A \| ANT_B)
	310	#define ANT_C BIT(2)
	311	#define ANT_AC (ANT_A \| ANT_C)
	312	#define ANT_BC (ANT_B \| ANT_C)
	313	#define ANT_ABC (ANT_AB \| ANT_C)
	314
12b96817 WYG	315	#define IWL_MAX_MCS_DISPLAY_SIZE 12
	316
	317	struct iwl_rate_mcs_info {
	318	char mbps[IWL_MAX_MCS_DISPLAY_SIZE];
	319	char mcs[IWL_MAX_MCS_DISPLAY_SIZE];
	320	};
	321
cc1282f6 RC	322	/**
	323	* struct iwl_rate_scale_data -- tx success history for one rate
	324	*/
	325	struct iwl_rate_scale_data {
	326	u64 data; /* bitmap of successful frames */
	327	s32 success_counter; /* number of frames successful */
	328	s32 success_ratio; /* per-cent * 128 */
	329	s32 counter; /* number of frames attempted */
	330	s32 average_tpt; /* success ratio * expected throughput */
	331	unsigned long stamp;
	332	};
	333
	334	/**
	335	* struct iwl_scale_tbl_info -- tx params and success history for all rates
	336	*
	337	* There are two of these in struct iwl_lq_sta,
	338	* one for "active", and one for "search".
	339	*/
	340	struct iwl_scale_tbl_info {
	341	enum iwl_table_type lq_type;
	342	u8 ant_type;
	343	u8 is_SGI; /* 1 = short guard interval */
	344	u8 is_ht40; /* 1 = 40 MHz channel width */
	345	u8 is_dup; /* 1 = duplicated data streams */
	346	u8 action; /* change modulation; IWL_[LEGACY/SISO/MIMO]_SWITCH_* */
	347	u8 max_search; /* maximun number of tables we can search */
	348	s32 expected_tpt; / throughput metrics; expected_tpt_G, etc. */
	349	u32 current_rate; /* rate_n_flags, uCode API format */
	350	struct iwl_rate_scale_data win[IWL_RATE_COUNT]; /* rate histories */
	351	};
	352
	353	struct iwl_traffic_load {
	354	unsigned long time_stamp; /* age of the oldest statistics */
	355	u32 packet_count[TID_QUEUE_MAX_SIZE]; /* packet count in this time
	356	* slice */
	357	u32 total; /* total num of packets during the
	358	* last TID_MAX_TIME_DIFF */
	359	u8 queue_count; /* number of queues that has
	360	* been used since the last cleanup */
	361	u8 head; /* start of the circular buffer */
	362	};
	363
	364	/**
	365	* struct iwl_lq_sta -- driver's rate scaling private structure
	366	*
	367	* Pointer to this gets passed back and forth between driver and mac80211.
	368	*/
	369	struct iwl_lq_sta {
	370	u8 active_tbl; /* index of active table, range 0-1 */
	371	u8 enable_counter; /* indicates HT mode */
	372	u8 stay_in_tbl; /* 1: disallow, 0: allow search for new mode */
	373	u8 search_better_tbl; /* 1: currently trying alternate mode */
	374	s32 last_tpt;
	375
	376	/* The following determine when to search for a new mode */
	377	u32 table_count_limit;
	378	u32 max_failure_limit; /* # failed frames before new search */
	379	u32 max_success_limit; /* # successful frames before new search */
	380	u32 table_count;
	381	u32 total_failed; /* total failed frames, any/all rates */
	382	u32 total_success; /* total successful frames, any/all rates */
	383	u64 flush_timer; /* time staying in mode before new search */
	384
	385	u8 action_counter; /* # mode-switch actions tried */
386	u8 is_green;
387	u8 is_dup;
388	enum ieee80211_band band;
cc1282f6 RC	389
	390	/* The following are bitmaps of rates; IWL_RATE_6M_MASK, etc. */
	391	u32 supp_rates;
	392	u16 active_legacy_rate;
	393	u16 active_siso_rate;
	394	u16 active_mimo2_rate;
	395	u16 active_mimo3_rate;
cc1282f6 RC	396	s8 max_rate_idx; /* Max rate set by user */
	397	u8 missed_rate_counter;
	398
	399	struct iwl_link_quality_cmd lq;
	400	struct iwl_scale_tbl_info lq_info[LQ_SIZE]; /* "active", "search" */
	401	struct iwl_traffic_load load[TID_MAX_LOAD_COUNT];
	402	u8 tx_agg_tid_en;
	403	#ifdef CONFIG_MAC80211_DEBUGFS
	404	struct dentry *rs_sta_dbgfs_scale_table_file;
	405	struct dentry *rs_sta_dbgfs_stats_table_file;
	406	struct dentry *rs_sta_dbgfs_rate_scale_data_file;
	407	struct dentry *rs_sta_dbgfs_tx_agg_tid_en_file;
	408	u32 dbg_fixed_rate;
	409	#endif
	410	struct iwl_priv *drv;
	411
	412	/* used to be in sta_info */
	413	int last_txrate_idx;
	414	/* last tx rate_n_flags */
	415	u32 last_rate_n_flags;
	416	/* packets destined for this STA are aggregated */
	417	u8 is_agg;
290f599c JB	418	/* BT traffic this sta was last updated in */
290f599c JB	419	u8 last_bt_traffic;
cc1282f6 RC	420	};
cc1282f6 RC	421
fde0db31 GC	422	static inline u8 num_of_ant(u8 mask)
	423	{
	424	return !!((mask) & ANT_A) +
	425	!!((mask) & ANT_B) +
	426	!!((mask) & ANT_C);
	427	}
b481de9c	428
5d664a41 TW	429	static inline u8 first_antenna(u8 mask)
	430	{
	431	if (mask & ANT_A)
	432	return ANT_A;
	433	if (mask & ANT_B)
	434	return ANT_B;
	435	return ANT_C;
	436	}
	437
	438
fe6b23dd RC	439	/* Initialize station's rate scaling information after adding station */
	440	extern void iwl_rs_rate_init(struct iwl_priv *priv,
	441	struct ieee80211_sta *sta, u8 sta_id);
fe6b23dd	442
b481de9c	443	/**
eb4779c4	444	* iwl_rate_control_register - Register the rate control algorithm callbacks
b481de9c ZY	445	*
	446	* Since the rate control algorithm is hardware specific, there is no need
	447	* or reason to place it as a stand alone module. The driver can call
eb4779c4	448	* iwl_rate_control_register in order to register the rate control callbacks
b481de9c ZY	449	* with the mac80211 subsystem. This should be performed prior to calling
	450	* ieee80211_register_hw
	451	*
	452	*/
e227ceac	453	extern int iwlagn_rate_control_register(void);
b481de9c ZY	454
b481de9c ZY	455	/**
eb4779c4	456	* iwl_rate_control_unregister - Unregister the rate control callbacks
b481de9c ZY	457	*
	458	* This should be called after calling ieee80211_unregister_hw, but before
	459	* the driver is unloaded.
	460	*/
e227ceac	461	extern void iwlagn_rate_control_unregister(void);
b481de9c	462
e227ceac	463	#endif /* __iwl_agn__rs__ */