[deliverable/linux.git] / drivers / net / wireless / iwlwifi / dvm / rs.h

/******************************************************************************
 *
 * Copyright(c) 2003 - 2014 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 <ilw@linux.intel.com>
 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
 *
 *****************************************************************************/

#ifndef __iwl_agn_rs_h__
#define __iwl_agn_rs_h__

#include <net/mac80211.h>

#include "iwl-config.h"

#include "commands.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_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_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 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[IWL_MAX_TID_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 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 */
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
 *
 */
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.
 */
void iwlagn_rate_control_unregister(void);

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