[deliverable/linux.git] / drivers / net / wireless / iwlwifi / mvm / 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 __rs_h__
#define __rs_h__

#include <net/mac80211.h>

#include "iwl-config.h"

#include "fw-api.h"
#include "iwl-trans.h"

struct iwl_rs_rate_info {
	u8 plcp;	  /* uCode API:  IWL_RATE_6M_PLCP, etc. */
	u8 plcp_ht_siso;  /* uCode API:  IWL_RATE_SISO_6M_PLCP, etc. */
	u8 plcp_ht_mimo2; /* uCode API:  IWL_RATE_MIMO2_6M_PLCP, etc. */
	u8 plcp_vht_siso;
	u8 plcp_vht_mimo2;
	u8 prev_rs;      /* previous rate used in rs algo */
	u8 next_rs;      /* next rate used in rs algo */
};

#define IWL_RATE_60M_PLCP 3

enum {
	IWL_RATE_INVM_INDEX = IWL_RATE_COUNT,
	IWL_RATE_INVALID = IWL_RATE_COUNT,
};

#define LINK_QUAL_MAX_RETRY_NUM 16

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,
};

/* #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 HT/VHT bit rates */
enum {
	IWL_RATE_HT_SISO_MCS_0_PLCP = 0,
	IWL_RATE_HT_SISO_MCS_1_PLCP = 1,
	IWL_RATE_HT_SISO_MCS_2_PLCP = 2,
	IWL_RATE_HT_SISO_MCS_3_PLCP = 3,
	IWL_RATE_HT_SISO_MCS_4_PLCP = 4,
	IWL_RATE_HT_SISO_MCS_5_PLCP = 5,
	IWL_RATE_HT_SISO_MCS_6_PLCP = 6,
	IWL_RATE_HT_SISO_MCS_7_PLCP = 7,
	IWL_RATE_HT_MIMO2_MCS_0_PLCP = 0x8,
	IWL_RATE_HT_MIMO2_MCS_1_PLCP = 0x9,
	IWL_RATE_HT_MIMO2_MCS_2_PLCP = 0xA,
	IWL_RATE_HT_MIMO2_MCS_3_PLCP = 0xB,
	IWL_RATE_HT_MIMO2_MCS_4_PLCP = 0xC,
	IWL_RATE_HT_MIMO2_MCS_5_PLCP = 0xD,
	IWL_RATE_HT_MIMO2_MCS_6_PLCP = 0xE,
	IWL_RATE_HT_MIMO2_MCS_7_PLCP = 0xF,
	IWL_RATE_VHT_SISO_MCS_0_PLCP = 0,
	IWL_RATE_VHT_SISO_MCS_1_PLCP = 1,
	IWL_RATE_VHT_SISO_MCS_2_PLCP = 2,
	IWL_RATE_VHT_SISO_MCS_3_PLCP = 3,
	IWL_RATE_VHT_SISO_MCS_4_PLCP = 4,
	IWL_RATE_VHT_SISO_MCS_5_PLCP = 5,
	IWL_RATE_VHT_SISO_MCS_6_PLCP = 6,
	IWL_RATE_VHT_SISO_MCS_7_PLCP = 7,
	IWL_RATE_VHT_SISO_MCS_8_PLCP = 8,
	IWL_RATE_VHT_SISO_MCS_9_PLCP = 9,
	IWL_RATE_VHT_MIMO2_MCS_0_PLCP = 0x10,
	IWL_RATE_VHT_MIMO2_MCS_1_PLCP = 0x11,
	IWL_RATE_VHT_MIMO2_MCS_2_PLCP = 0x12,
	IWL_RATE_VHT_MIMO2_MCS_3_PLCP = 0x13,
	IWL_RATE_VHT_MIMO2_MCS_4_PLCP = 0x14,
	IWL_RATE_VHT_MIMO2_MCS_5_PLCP = 0x15,
	IWL_RATE_VHT_MIMO2_MCS_6_PLCP = 0x16,
	IWL_RATE_VHT_MIMO2_MCS_7_PLCP = 0x17,
	IWL_RATE_VHT_MIMO2_MCS_8_PLCP = 0x18,
	IWL_RATE_VHT_MIMO2_MCS_9_PLCP = 0x19,
	IWL_RATE_HT_SISO_MCS_INV_PLCP,
	IWL_RATE_HT_MIMO2_MCS_INV_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP,
	IWL_RATE_VHT_SISO_MCS_INV_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP,
	IWL_RATE_VHT_MIMO2_MCS_INV_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP,
	IWL_RATE_HT_SISO_MCS_8_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP,
	IWL_RATE_HT_SISO_MCS_9_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP,
	IWL_RATE_HT_MIMO2_MCS_8_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP,
	IWL_RATE_HT_MIMO2_MCS_9_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP,
};

#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 RS_SR_FORCE_DECREASE		1920	/*  15% */

#define LINK_QUAL_AGG_TIME_LIMIT_DEF	(4000) /* 4 milliseconds */
#define LINK_QUAL_AGG_TIME_LIMIT_MAX	(8000)
#define LINK_QUAL_AGG_TIME_LIMIT_MIN	(100)

#define LINK_QUAL_AGG_DISABLE_START_DEF	(3)
#define LINK_QUAL_AGG_DISABLE_START_MAX	(255)
#define LINK_QUAL_AGG_DISABLE_START_MIN	(0)

#define LINK_QUAL_AGG_FRAME_LIMIT_DEF	(63)
#define LINK_QUAL_AGG_FRAME_LIMIT_MAX	(63)
#define LINK_QUAL_AGG_FRAME_LIMIT_MIN	(0)

#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))

enum iwl_table_type {
	LQ_NONE,
	LQ_LEGACY_G,	/* legacy types */
	LQ_LEGACY_A,
	LQ_HT_SISO,	/* HT types */
	LQ_HT_MIMO2,
	LQ_VHT_SISO,    /* VHT types */
	LQ_VHT_MIMO2,
	LQ_MAX,
};

struct rs_rate {
	int index;
	enum iwl_table_type type;
	u8 ant;
	u32 bw;
	bool sgi;
};


#define is_type_legacy(type) (((type) == LQ_LEGACY_G) || \
			      ((type) == LQ_LEGACY_A))
#define is_type_ht_siso(type) ((type) == LQ_HT_SISO)
#define is_type_ht_mimo2(type) ((type) == LQ_HT_MIMO2)
#define is_type_vht_siso(type) ((type) == LQ_VHT_SISO)
#define is_type_vht_mimo2(type) ((type) == LQ_VHT_MIMO2)
#define is_type_siso(type) (is_type_ht_siso(type) || is_type_vht_siso(type))
#define is_type_mimo2(type) (is_type_ht_mimo2(type) || is_type_vht_mimo2(type))
#define is_type_mimo(type) (is_type_mimo2(type))
#define is_type_ht(type) (is_type_ht_siso(type) || is_type_ht_mimo2(type))
#define is_type_vht(type) (is_type_vht_siso(type) || is_type_vht_mimo2(type))
#define is_type_a_band(type) ((type) == LQ_LEGACY_A)
#define is_type_g_band(type) ((type) == LQ_LEGACY_G)

#define is_legacy(rate)       is_type_legacy((rate)->type)
#define is_ht_siso(rate)      is_type_ht_siso((rate)->type)
#define is_ht_mimo2(rate)     is_type_ht_mimo2((rate)->type)
#define is_vht_siso(rate)     is_type_vht_siso((rate)->type)
#define is_vht_mimo2(rate)    is_type_vht_mimo2((rate)->type)
#define is_siso(rate)         is_type_siso((rate)->type)
#define is_mimo2(rate)        is_type_mimo2((rate)->type)
#define is_mimo(rate)         is_type_mimo((rate)->type)
#define is_ht(rate)           is_type_ht((rate)->type)
#define is_vht(rate)          is_type_vht((rate)->type)
#define is_a_band(rate)       is_type_a_band((rate)->type)
#define is_g_band(rate)       is_type_g_band((rate)->type)

#define is_ht20(rate)         ((rate)->bw == RATE_MCS_CHAN_WIDTH_20)
#define is_ht40(rate)         ((rate)->bw == RATE_MCS_CHAN_WIDTH_40)
#define is_ht80(rate)         ((rate)->bw == RATE_MCS_CHAN_WIDTH_80)

#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 */
};

/* Possible Tx columns
 * Tx Column = a combo of legacy/siso/mimo x antenna x SGI
 */
enum rs_column {
	RS_COLUMN_LEGACY_ANT_A = 0,
	RS_COLUMN_LEGACY_ANT_B,
	RS_COLUMN_SISO_ANT_A,
	RS_COLUMN_SISO_ANT_B,
	RS_COLUMN_SISO_ANT_A_SGI,
	RS_COLUMN_SISO_ANT_B_SGI,
	RS_COLUMN_MIMO2,
	RS_COLUMN_MIMO2_SGI,

	RS_COLUMN_LAST = RS_COLUMN_MIMO2_SGI,
	RS_COLUMN_INVALID,
};

/**
 * 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 {
	struct rs_rate rate;
	enum rs_column column;
	s32 *expected_tpt;	/* throughput metrics; expected_tpt_G, etc. */
	struct iwl_rate_scale_data win[IWL_RATE_COUNT]; /* rate histories */
};

enum {
	RS_STATE_SEARCH_CYCLE_STARTED,
	RS_STATE_SEARCH_CYCLE_ENDED,
	RS_STATE_STAY_IN_COLUMN,
};

/**
 * 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 rs_state;            /* RS_STATE_* */
	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 */

	u32 visited_columns;    /* Bitmask marking which Tx columns were
				 * explored during a search cycle
				 */
	bool is_vht;
	enum ieee80211_band band;

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

	struct iwl_lq_cmd lq;
	struct iwl_scale_tbl_info lq_info[LQ_SIZE]; /* "active", "search" */
	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_tx_agg_tid_en_file;
	u32 dbg_fixed_rate;
#endif
	struct iwl_mvm *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;
};

/* Initialize station's rate scaling information after adding station */
void iwl_mvm_rs_rate_init(struct iwl_mvm *mvm, struct ieee80211_sta *sta,
			  enum ieee80211_band band, bool init);

/**
 * 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 iwl_mvm_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 iwl_mvm_rate_control_unregister(void);

struct iwl_mvm_sta;

int iwl_mvm_tx_protection(struct iwl_mvm *mvm, struct iwl_mvm_sta *mvmsta,
			  bool enable);

#endif /* __rs__ */
Commit	Line	Data
8ca151b5 JB	1	/******************************************************************************
8ca151b5 JB	2	*
51368bf7	3	* Copyright(c) 2003 - 2014 Intel Corporation. All rights reserved.
8ca151b5 JB	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:
	22	* Intel Linux Wireless <ilw@linux.intel.com>
	23	* Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
	24	*
	25	*****************************************************************************/
	26
	27	#ifndef __rs_h__
	28	#define __rs_h__
	29
	30	#include <net/mac80211.h>
	31
	32	#include "iwl-config.h"
	33
	34	#include "fw-api.h"
	35	#include "iwl-trans.h"
	36
	37	struct iwl_rs_rate_info {
d310e405 ES	38	u8 plcp; /* uCode API: IWL_RATE_6M_PLCP, etc. */
	39	u8 plcp_ht_siso; /* uCode API: IWL_RATE_SISO_6M_PLCP, etc. */
	40	u8 plcp_ht_mimo2; /* uCode API: IWL_RATE_MIMO2_6M_PLCP, etc. */
	41	u8 plcp_vht_siso;
	42	u8 plcp_vht_mimo2;
8ca151b5 JB	43	u8 prev_rs; /* previous rate used in rs algo */
8ca151b5 JB	44	u8 next_rs; /* next rate used in rs algo */
8ca151b5 JB	45	};
	46
	47	#define IWL_RATE_60M_PLCP 3
	48
	49	enum {
	50	IWL_RATE_INVM_INDEX = IWL_RATE_COUNT,
	51	IWL_RATE_INVALID = IWL_RATE_COUNT,
	52	};
	53
	54	#define LINK_QUAL_MAX_RETRY_NUM 16
	55
	56	enum {
	57	IWL_RATE_6M_INDEX_TABLE = 0,
	58	IWL_RATE_9M_INDEX_TABLE,
	59	IWL_RATE_12M_INDEX_TABLE,
	60	IWL_RATE_18M_INDEX_TABLE,
	61	IWL_RATE_24M_INDEX_TABLE,
	62	IWL_RATE_36M_INDEX_TABLE,
	63	IWL_RATE_48M_INDEX_TABLE,
	64	IWL_RATE_54M_INDEX_TABLE,
	65	IWL_RATE_1M_INDEX_TABLE,
	66	IWL_RATE_2M_INDEX_TABLE,
	67	IWL_RATE_5M_INDEX_TABLE,
	68	IWL_RATE_11M_INDEX_TABLE,
	69	IWL_RATE_INVM_INDEX_TABLE = IWL_RATE_INVM_INDEX - 1,
	70	};
	71
	72	/* #define vs. enum to keep from defaulting to 'large integer' */
	73	#define IWL_RATE_6M_MASK (1 << IWL_RATE_6M_INDEX)
	74	#define IWL_RATE_9M_MASK (1 << IWL_RATE_9M_INDEX)
	75	#define IWL_RATE_12M_MASK (1 << IWL_RATE_12M_INDEX)
	76	#define IWL_RATE_18M_MASK (1 << IWL_RATE_18M_INDEX)
	77	#define IWL_RATE_24M_MASK (1 << IWL_RATE_24M_INDEX)
	78	#define IWL_RATE_36M_MASK (1 << IWL_RATE_36M_INDEX)
	79	#define IWL_RATE_48M_MASK (1 << IWL_RATE_48M_INDEX)
	80	#define IWL_RATE_54M_MASK (1 << IWL_RATE_54M_INDEX)
	81	#define IWL_RATE_60M_MASK (1 << IWL_RATE_60M_INDEX)
	82	#define IWL_RATE_1M_MASK (1 << IWL_RATE_1M_INDEX)
	83	#define IWL_RATE_2M_MASK (1 << IWL_RATE_2M_INDEX)
	84	#define IWL_RATE_5M_MASK (1 << IWL_RATE_5M_INDEX)
	85	#define IWL_RATE_11M_MASK (1 << IWL_RATE_11M_INDEX)
	86
	87
d310e405	88	/* uCode API values for HT/VHT bit rates */
8ca151b5	89	enum {
d310e405 ES	90	IWL_RATE_HT_SISO_MCS_0_PLCP = 0,
	91	IWL_RATE_HT_SISO_MCS_1_PLCP = 1,
	92	IWL_RATE_HT_SISO_MCS_2_PLCP = 2,
	93	IWL_RATE_HT_SISO_MCS_3_PLCP = 3,
	94	IWL_RATE_HT_SISO_MCS_4_PLCP = 4,
	95	IWL_RATE_HT_SISO_MCS_5_PLCP = 5,
	96	IWL_RATE_HT_SISO_MCS_6_PLCP = 6,
	97	IWL_RATE_HT_SISO_MCS_7_PLCP = 7,
	98	IWL_RATE_HT_MIMO2_MCS_0_PLCP = 0x8,
	99	IWL_RATE_HT_MIMO2_MCS_1_PLCP = 0x9,
	100	IWL_RATE_HT_MIMO2_MCS_2_PLCP = 0xA,
	101	IWL_RATE_HT_MIMO2_MCS_3_PLCP = 0xB,
	102	IWL_RATE_HT_MIMO2_MCS_4_PLCP = 0xC,
	103	IWL_RATE_HT_MIMO2_MCS_5_PLCP = 0xD,
	104	IWL_RATE_HT_MIMO2_MCS_6_PLCP = 0xE,
	105	IWL_RATE_HT_MIMO2_MCS_7_PLCP = 0xF,
	106	IWL_RATE_VHT_SISO_MCS_0_PLCP = 0,
	107	IWL_RATE_VHT_SISO_MCS_1_PLCP = 1,
	108	IWL_RATE_VHT_SISO_MCS_2_PLCP = 2,
	109	IWL_RATE_VHT_SISO_MCS_3_PLCP = 3,
	110	IWL_RATE_VHT_SISO_MCS_4_PLCP = 4,
	111	IWL_RATE_VHT_SISO_MCS_5_PLCP = 5,
	112	IWL_RATE_VHT_SISO_MCS_6_PLCP = 6,
	113	IWL_RATE_VHT_SISO_MCS_7_PLCP = 7,
	114	IWL_RATE_VHT_SISO_MCS_8_PLCP = 8,
	115	IWL_RATE_VHT_SISO_MCS_9_PLCP = 9,
	116	IWL_RATE_VHT_MIMO2_MCS_0_PLCP = 0x10,
	117	IWL_RATE_VHT_MIMO2_MCS_1_PLCP = 0x11,
	118	IWL_RATE_VHT_MIMO2_MCS_2_PLCP = 0x12,
	119	IWL_RATE_VHT_MIMO2_MCS_3_PLCP = 0x13,
	120	IWL_RATE_VHT_MIMO2_MCS_4_PLCP = 0x14,
	121	IWL_RATE_VHT_MIMO2_MCS_5_PLCP = 0x15,
	122	IWL_RATE_VHT_MIMO2_MCS_6_PLCP = 0x16,
	123	IWL_RATE_VHT_MIMO2_MCS_7_PLCP = 0x17,
	124	IWL_RATE_VHT_MIMO2_MCS_8_PLCP = 0x18,
	125	IWL_RATE_VHT_MIMO2_MCS_9_PLCP = 0x19,
	126	IWL_RATE_HT_SISO_MCS_INV_PLCP,
	127	IWL_RATE_HT_MIMO2_MCS_INV_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP,
	128	IWL_RATE_VHT_SISO_MCS_INV_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP,
	129	IWL_RATE_VHT_MIMO2_MCS_INV_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP,
	130	IWL_RATE_HT_SISO_MCS_8_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP,
	131	IWL_RATE_HT_SISO_MCS_9_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP,
	132	IWL_RATE_HT_MIMO2_MCS_8_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP,
	133	IWL_RATE_HT_MIMO2_MCS_9_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP,
8ca151b5 JB	134	};
8ca151b5 JB	135
8ca151b5 JB	136	#define IWL_RATES_MASK ((1 << IWL_RATE_COUNT) - 1)
	137
	138	#define IWL_INVALID_VALUE -1
	139
	140	#define IWL_MIN_RSSI_VAL -100
	141	#define IWL_MAX_RSSI_VAL 0
	142
	143	/* These values specify how many Tx frame attempts before
	144	* searching for a new modulation mode */
	145	#define IWL_LEGACY_FAILURE_LIMIT 160
	146	#define IWL_LEGACY_SUCCESS_LIMIT 480
	147	#define IWL_LEGACY_TABLE_COUNT 160
	148
	149	#define IWL_NONE_LEGACY_FAILURE_LIMIT 400
	150	#define IWL_NONE_LEGACY_SUCCESS_LIMIT 4500
	151	#define IWL_NONE_LEGACY_TABLE_COUNT 1500
	152
	153	/* Success ratio (ACKed / attempted tx frames) values (perfect is 128 * 100) */
	154	#define IWL_RS_GOOD_RATIO 12800 /* 100% */
	155	#define IWL_RATE_SCALE_SWITCH 10880 /* 85% */
	156	#define IWL_RATE_HIGH_TH 10880 /* 85% */
	157	#define IWL_RATE_INCREASE_TH 6400 /* 50% */
c48075d2	158	#define RS_SR_FORCE_DECREASE 1920 /* 15% */
8ca151b5	159
8ca151b5 JB	160	#define LINK_QUAL_AGG_TIME_LIMIT_DEF (4000) /* 4 milliseconds */
	161	#define LINK_QUAL_AGG_TIME_LIMIT_MAX (8000)
	162	#define LINK_QUAL_AGG_TIME_LIMIT_MIN (100)
	163
	164	#define LINK_QUAL_AGG_DISABLE_START_DEF (3)
	165	#define LINK_QUAL_AGG_DISABLE_START_MAX (255)
	166	#define LINK_QUAL_AGG_DISABLE_START_MIN (0)
	167
	168	#define LINK_QUAL_AGG_FRAME_LIMIT_DEF (63)
	169	#define LINK_QUAL_AGG_FRAME_LIMIT_MAX (63)
	170	#define LINK_QUAL_AGG_FRAME_LIMIT_MIN (0)
	171
	172	#define LQ_SIZE 2 /* 2 mode tables: "Active" and "Search" */
	173
	174	/* load per tid defines for A-MPDU activation */
	175	#define IWL_AGG_TPT_THREHOLD 0
	176	#define IWL_AGG_LOAD_THRESHOLD 10
	177	#define IWL_AGG_ALL_TID 0xff
	178	#define TID_QUEUE_CELL_SPACING 50 /mS /
	179	#define TID_QUEUE_MAX_SIZE 20
	180	#define TID_ROUND_VALUE 5 /* mS */
	181
	182	#define TID_MAX_TIME_DIFF ((TID_QUEUE_MAX_SIZE - 1) * TID_QUEUE_CELL_SPACING)
	183	#define TIME_WRAP_AROUND(x, y) (((y) > (x)) ? (y) - (x) : (0-(x)) + (y))
	184
	185	enum iwl_table_type {
	186	LQ_NONE,
d310e405 ES	187	LQ_LEGACY_G, /* legacy types */
	188	LQ_LEGACY_A,
	189	LQ_HT_SISO, /* HT types */
	190	LQ_HT_MIMO2,
	191	LQ_VHT_SISO, /* VHT types */
	192	LQ_VHT_MIMO2,
8ca151b5 JB	193	LQ_MAX,
	194	};
	195
5aa33553 ES	196	struct rs_rate {
	197	int index;
	198	enum iwl_table_type type;
	199	u8 ant;
	200	u32 bw;
	201	bool sgi;
	202	};
	203
	204
	205	#define is_type_legacy(type) (((type) == LQ_LEGACY_G) \|\| \
	206	((type) == LQ_LEGACY_A))
	207	#define is_type_ht_siso(type) ((type) == LQ_HT_SISO)
	208	#define is_type_ht_mimo2(type) ((type) == LQ_HT_MIMO2)
	209	#define is_type_vht_siso(type) ((type) == LQ_VHT_SISO)
	210	#define is_type_vht_mimo2(type) ((type) == LQ_VHT_MIMO2)
	211	#define is_type_siso(type) (is_type_ht_siso(type) \|\| is_type_vht_siso(type))
	212	#define is_type_mimo2(type) (is_type_ht_mimo2(type) \|\| is_type_vht_mimo2(type))
	213	#define is_type_mimo(type) (is_type_mimo2(type))
	214	#define is_type_ht(type) (is_type_ht_siso(type) \|\| is_type_ht_mimo2(type))
	215	#define is_type_vht(type) (is_type_vht_siso(type) \|\| is_type_vht_mimo2(type))
	216	#define is_type_a_band(type) ((type) == LQ_LEGACY_A)
	217	#define is_type_g_band(type) ((type) == LQ_LEGACY_G)
	218
	219	#define is_legacy(rate) is_type_legacy((rate)->type)
	220	#define is_ht_siso(rate) is_type_ht_siso((rate)->type)
	221	#define is_ht_mimo2(rate) is_type_ht_mimo2((rate)->type)
	222	#define is_vht_siso(rate) is_type_vht_siso((rate)->type)
	223	#define is_vht_mimo2(rate) is_type_vht_mimo2((rate)->type)
	224	#define is_siso(rate) is_type_siso((rate)->type)
	225	#define is_mimo2(rate) is_type_mimo2((rate)->type)
	226	#define is_mimo(rate) is_type_mimo((rate)->type)
	227	#define is_ht(rate) is_type_ht((rate)->type)
	228	#define is_vht(rate) is_type_vht((rate)->type)
	229	#define is_a_band(rate) is_type_a_band((rate)->type)
	230	#define is_g_band(rate) is_type_g_band((rate)->type)
	231
	232	#define is_ht20(rate) ((rate)->bw == RATE_MCS_CHAN_WIDTH_20)
	233	#define is_ht40(rate) ((rate)->bw == RATE_MCS_CHAN_WIDTH_40)
	234	#define is_ht80(rate) ((rate)->bw == RATE_MCS_CHAN_WIDTH_80)
8ca151b5 JB	235
	236	#define IWL_MAX_MCS_DISPLAY_SIZE 12
	237
	238	struct iwl_rate_mcs_info {
	239	char mbps[IWL_MAX_MCS_DISPLAY_SIZE];
	240	char mcs[IWL_MAX_MCS_DISPLAY_SIZE];
	241	};
	242
	243	/**
	244	* struct iwl_rate_scale_data -- tx success history for one rate
	245	*/
	246	struct iwl_rate_scale_data {
	247	u64 data; /* bitmap of successful frames */
	248	s32 success_counter; /* number of frames successful */
	249	s32 success_ratio; /* per-cent * 128 */
	250	s32 counter; /* number of frames attempted */
	251	s32 average_tpt; /* success ratio * expected throughput */
8ca151b5 JB	252	};
8ca151b5 JB	253
b3b06a32 ES	254	/* Possible Tx columns
	255	* Tx Column = a combo of legacy/siso/mimo x antenna x SGI
	256	*/
	257	enum rs_column {
	258	RS_COLUMN_LEGACY_ANT_A = 0,
	259	RS_COLUMN_LEGACY_ANT_B,
	260	RS_COLUMN_SISO_ANT_A,
	261	RS_COLUMN_SISO_ANT_B,
	262	RS_COLUMN_SISO_ANT_A_SGI,
	263	RS_COLUMN_SISO_ANT_B_SGI,
	264	RS_COLUMN_MIMO2,
	265	RS_COLUMN_MIMO2_SGI,
	266
	267	RS_COLUMN_LAST = RS_COLUMN_MIMO2_SGI,
	268	RS_COLUMN_INVALID,
	269	};
	270
8ca151b5 JB	271	/**
	272	* struct iwl_scale_tbl_info -- tx params and success history for all rates
	273	*
	274	* There are two of these in struct iwl_lq_sta,
	275	* one for "active", and one for "search".
	276	*/
	277	struct iwl_scale_tbl_info {
5aa33553	278	struct rs_rate rate;
b3b06a32	279	enum rs_column column;
8ca151b5	280	s32 expected_tpt; / throughput metrics; expected_tpt_G, etc. */
8ca151b5 JB	281	struct iwl_rate_scale_data win[IWL_RATE_COUNT]; /* rate histories */
	282	};
	283
b3b06a32 ES	284	enum {
	285	RS_STATE_SEARCH_CYCLE_STARTED,
	286	RS_STATE_SEARCH_CYCLE_ENDED,
	287	RS_STATE_STAY_IN_COLUMN,
	288	};
	289
8ca151b5 JB	290	/**
	291	* struct iwl_lq_sta -- driver's rate scaling private structure
	292	*
	293	* Pointer to this gets passed back and forth between driver and mac80211.
	294	*/
	295	struct iwl_lq_sta {
	296	u8 active_tbl; /* index of active table, range 0-1 */
b3b06a32	297	u8 rs_state; /* RS_STATE_* */
8ca151b5 JB	298	u8 search_better_tbl; /* 1: currently trying alternate mode */
	299	s32 last_tpt;
	300
	301	/* The following determine when to search for a new mode */
	302	u32 table_count_limit;
	303	u32 max_failure_limit; /* # failed frames before new search */
	304	u32 max_success_limit; /* # successful frames before new search */
	305	u32 table_count;
	306	u32 total_failed; /* total failed frames, any/all rates */
	307	u32 total_success; /* total successful frames, any/all rates */
	308	u64 flush_timer; /* time staying in mode before new search */
	309
b3b06a32 ES	310	u32 visited_columns; /* Bitmask marking which Tx columns were
	311	* explored during a search cycle
	312	*/
d310e405	313	bool is_vht;
8ca151b5 JB	314	enum ieee80211_band band;
	315
	316	/* The following are bitmaps of rates; IWL_RATE_6M_MASK, etc. */
8ca151b5 JB	317	u16 active_legacy_rate;
	318	u16 active_siso_rate;
	319	u16 active_mimo2_rate;
8ca151b5 JB	320	s8 max_rate_idx; /* Max rate set by user */
	321	u8 missed_rate_counter;
	322
	323	struct iwl_lq_cmd lq;
	324	struct iwl_scale_tbl_info lq_info[LQ_SIZE]; /* "active", "search" */
8ca151b5 JB	325	u8 tx_agg_tid_en;
	326	#ifdef CONFIG_MAC80211_DEBUGFS
	327	struct dentry *rs_sta_dbgfs_scale_table_file;
	328	struct dentry *rs_sta_dbgfs_stats_table_file;
8ca151b5 JB	329	struct dentry *rs_sta_dbgfs_tx_agg_tid_en_file;
	330	u32 dbg_fixed_rate;
	331	#endif
	332	struct iwl_mvm *drv;
	333
	334	/* used to be in sta_info */
	335	int last_txrate_idx;
	336	/* last tx rate_n_flags */
	337	u32 last_rate_n_flags;
	338	/* packets destined for this STA are aggregated */
	339	u8 is_agg;
36946ce6 EG	340	};
36946ce6 EG	341
8ca151b5	342	/* Initialize station's rate scaling information after adding station */
b3818394	343	void iwl_mvm_rs_rate_init(struct iwl_mvm mvm, struct ieee80211_sta sta,
b87c2179	344	enum ieee80211_band band, bool init);
8ca151b5 JB	345
	346	/**
	347	* iwl_rate_control_register - Register the rate control algorithm callbacks
	348	*
	349	* Since the rate control algorithm is hardware specific, there is no need
	350	* or reason to place it as a stand alone module. The driver can call
	351	* iwl_rate_control_register in order to register the rate control callbacks
	352	* with the mac80211 subsystem. This should be performed prior to calling
	353	* ieee80211_register_hw
	354	*
	355	*/
b3818394	356	int iwl_mvm_rate_control_register(void);
8ca151b5 JB	357
	358	/**
	359	* iwl_rate_control_unregister - Unregister the rate control callbacks
	360	*
	361	* This should be called after calling ieee80211_unregister_hw, but before
	362	* the driver is unloaded.
	363	*/
b3818394	364	void iwl_mvm_rate_control_unregister(void);
8ca151b5	365
9ee718aa EL	366	struct iwl_mvm_sta;
9ee718aa EL	367
e126b5d9 JB	368	int iwl_mvm_tx_protection(struct iwl_mvm mvm, struct iwl_mvm_sta mvmsta,
e126b5d9 JB	369	bool enable);
9ee718aa	370
8ca151b5	371	#endif /* __rs__ */