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

/******************************************************************************
 *
 * Copyright(c) 2003 - 2009 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__

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

struct iwl3945_rate_info {
	u8 plcp;		/* uCode API:  IWL_RATE_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 */
	u8 table_rs_index;	/* index in rate scale table cmd */
	u8 prev_table_rs;	/* prev in rate table cmd */
};

/*
 * 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_3945 = IWL_RATE_COUNT - 1,
	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,
	IWL39_LAST_OFDM_RATE = IWL_RATE_54M_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_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];
extern const struct iwl3945_rate_info iwl3945_rates[IWL_RATE_COUNT_3945];

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

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


static inline u8 iwl_get_prev_ieee_rate(u8 rate_index)
{
	u8 rate = iwl_rates[rate_index].prev_ieee;

	if (rate == IWL_RATE_INVALID)
		rate = rate_index;
	return rate;
}

static inline u8 iwl3945_get_prev_ieee_rate(u8 rate_index)
{
	u8 rate = iwl3945_rates[rate_index].prev_ieee;

	if (rate == IWL_RATE_INVALID)
		rate = rate_index;
	return rate;
}

/**
 * iwl3945_rate_scale_init - Initialize the rate scale table based on assoc info
 *
 * The specific throughput table used is based on the type of network
 * the associated with, including A, B, G, and G w/ TGG protection
 */
extern void iwl3945_rate_scale_init(struct ieee80211_hw *hw, s32 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);
extern int iwl3945_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);
extern void iwl3945_rate_control_unregister(void);

#endif /* __iwl_agn__rs__ */
Commit	Line	Data
b481de9c ZY	1	/******************************************************************************
b481de9c ZY	2	*
01f8162a	3	* Copyright(c) 2003 - 2009 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
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
d9829a67 SO	44	struct iwl3945_rate_info {
	45	u8 plcp; /* uCode API: IWL_RATE_6M_PLCP, etc. */
	46	u8 ieee; /* MAC header: IWL_RATE_6M_IEEE, etc. */
	47	u8 prev_ieee; /* previous rate in IEEE speeds */
	48	u8 next_ieee; /* next rate in IEEE speeds */
	49	u8 prev_rs; /* previous rate used in rs algo */
	50	u8 next_rs; /* next rate used in rs algo */
	51	u8 prev_rs_tgg; /* previous rate used in TGG rs algo */
	52	u8 next_rs_tgg; /* next rate used in TGG rs algo */
	53	u8 table_rs_index; /* index in rate scale table cmd */
	54	u8 prev_table_rs; /* prev in rate table cmd */
	55	};
	56
9fbab516 BC	57	/*
9fbab516 BC	58	* These serve as indexes into
1826dcc0	59	* struct iwl_rate_info iwl_rates[IWL_RATE_COUNT];
9fbab516	60	*/
b481de9c ZY	61	enum {
	62	IWL_RATE_1M_INDEX = 0,
	63	IWL_RATE_2M_INDEX,
	64	IWL_RATE_5M_INDEX,
	65	IWL_RATE_11M_INDEX,
	66	IWL_RATE_6M_INDEX,
	67	IWL_RATE_9M_INDEX,
	68	IWL_RATE_12M_INDEX,
	69	IWL_RATE_18M_INDEX,
	70	IWL_RATE_24M_INDEX,
	71	IWL_RATE_36M_INDEX,
	72	IWL_RATE_48M_INDEX,
	73	IWL_RATE_54M_INDEX,
	74	IWL_RATE_60M_INDEX,
fde0db31	75	IWL_RATE_COUNT, /FIXME:RS:change to IWL_RATE_INDEX_COUNT,/
d9829a67	76	IWL_RATE_COUNT_3945 = IWL_RATE_COUNT - 1,
b481de9c	77	IWL_RATE_INVM_INDEX = IWL_RATE_COUNT,
fde0db31	78	IWL_RATE_INVALID = IWL_RATE_COUNT,
b481de9c ZY	79	};
b481de9c ZY	80
d9829a67 SO	81	enum {
	82	IWL_RATE_6M_INDEX_TABLE = 0,
	83	IWL_RATE_9M_INDEX_TABLE,
	84	IWL_RATE_12M_INDEX_TABLE,
	85	IWL_RATE_18M_INDEX_TABLE,
	86	IWL_RATE_24M_INDEX_TABLE,
	87	IWL_RATE_36M_INDEX_TABLE,
	88	IWL_RATE_48M_INDEX_TABLE,
	89	IWL_RATE_54M_INDEX_TABLE,
	90	IWL_RATE_1M_INDEX_TABLE,
	91	IWL_RATE_2M_INDEX_TABLE,
	92	IWL_RATE_5M_INDEX_TABLE,
	93	IWL_RATE_11M_INDEX_TABLE,
	94	IWL_RATE_INVM_INDEX_TABLE = IWL_RATE_INVM_INDEX - 1,
	95	};
	96
b481de9c ZY	97	enum {
b481de9c ZY	98	IWL_FIRST_OFDM_RATE = IWL_RATE_6M_INDEX,
d9829a67	99	IWL39_LAST_OFDM_RATE = IWL_RATE_54M_INDEX,
b481de9c ZY	100	IWL_LAST_OFDM_RATE = IWL_RATE_60M_INDEX,
	101	IWL_FIRST_CCK_RATE = IWL_RATE_1M_INDEX,
	102	IWL_LAST_CCK_RATE = IWL_RATE_11M_INDEX,
	103	};
	104
	105	/* #define vs. enum to keep from defaulting to 'large integer' */
8a1b0245 RC	106	#define IWL_RATE_6M_MASK (1 << IWL_RATE_6M_INDEX)
	107	#define IWL_RATE_9M_MASK (1 << IWL_RATE_9M_INDEX)
	108	#define IWL_RATE_12M_MASK (1 << IWL_RATE_12M_INDEX)
	109	#define IWL_RATE_18M_MASK (1 << IWL_RATE_18M_INDEX)
	110	#define IWL_RATE_24M_MASK (1 << IWL_RATE_24M_INDEX)
	111	#define IWL_RATE_36M_MASK (1 << IWL_RATE_36M_INDEX)
	112	#define IWL_RATE_48M_MASK (1 << IWL_RATE_48M_INDEX)
	113	#define IWL_RATE_54M_MASK (1 << IWL_RATE_54M_INDEX)
	114	#define IWL_RATE_60M_MASK (1 << IWL_RATE_60M_INDEX)
	115	#define IWL_RATE_1M_MASK (1 << IWL_RATE_1M_INDEX)
	116	#define IWL_RATE_2M_MASK (1 << IWL_RATE_2M_INDEX)
	117	#define IWL_RATE_5M_MASK (1 << IWL_RATE_5M_INDEX)
	118	#define IWL_RATE_11M_MASK (1 << IWL_RATE_11M_INDEX)
b481de9c	119
e227ceac	120	/* uCode API values for legacy bit rates, both OFDM and CCK */
b481de9c ZY	121	enum {
	122	IWL_RATE_6M_PLCP = 13,
	123	IWL_RATE_9M_PLCP = 15,
	124	IWL_RATE_12M_PLCP = 5,
	125	IWL_RATE_18M_PLCP = 7,
	126	IWL_RATE_24M_PLCP = 9,
	127	IWL_RATE_36M_PLCP = 11,
	128	IWL_RATE_48M_PLCP = 1,
	129	IWL_RATE_54M_PLCP = 3,
fde0db31	130	IWL_RATE_60M_PLCP = 3,/FIXME:RS:should be removed/
b481de9c ZY	131	IWL_RATE_1M_PLCP = 10,
	132	IWL_RATE_2M_PLCP = 20,
	133	IWL_RATE_5M_PLCP = 55,
	134	IWL_RATE_11M_PLCP = 110,
fde0db31 GC	135	/FIXME:RS:change to IWL_RATE_LEGACY_??M_PLCP /
fde0db31 GC	136	/FIXME:RS:add IWL_RATE_LEGACY_INVM_PLCP = 0,/
b481de9c ZY	137	};
b481de9c ZY	138
e227ceac	139	/* uCode API values for OFDM high-throughput (HT) bit rates */
b481de9c ZY	140	enum {
	141	IWL_RATE_SISO_6M_PLCP = 0,
	142	IWL_RATE_SISO_12M_PLCP = 1,
	143	IWL_RATE_SISO_18M_PLCP = 2,
	144	IWL_RATE_SISO_24M_PLCP = 3,
	145	IWL_RATE_SISO_36M_PLCP = 4,
	146	IWL_RATE_SISO_48M_PLCP = 5,
	147	IWL_RATE_SISO_54M_PLCP = 6,
	148	IWL_RATE_SISO_60M_PLCP = 7,
fde0db31 GC	149	IWL_RATE_MIMO2_6M_PLCP = 0x8,
	150	IWL_RATE_MIMO2_12M_PLCP = 0x9,
	151	IWL_RATE_MIMO2_18M_PLCP = 0xa,
	152	IWL_RATE_MIMO2_24M_PLCP = 0xb,
	153	IWL_RATE_MIMO2_36M_PLCP = 0xc,
	154	IWL_RATE_MIMO2_48M_PLCP = 0xd,
	155	IWL_RATE_MIMO2_54M_PLCP = 0xe,
	156	IWL_RATE_MIMO2_60M_PLCP = 0xf,
	157	IWL_RATE_MIMO3_6M_PLCP = 0x10,
	158	IWL_RATE_MIMO3_12M_PLCP = 0x11,
	159	IWL_RATE_MIMO3_18M_PLCP = 0x12,
	160	IWL_RATE_MIMO3_24M_PLCP = 0x13,
	161	IWL_RATE_MIMO3_36M_PLCP = 0x14,
	162	IWL_RATE_MIMO3_48M_PLCP = 0x15,
	163	IWL_RATE_MIMO3_54M_PLCP = 0x16,
	164	IWL_RATE_MIMO3_60M_PLCP = 0x17,
b481de9c	165	IWL_RATE_SISO_INVM_PLCP,
fde0db31 GC	166	IWL_RATE_MIMO2_INVM_PLCP = IWL_RATE_SISO_INVM_PLCP,
fde0db31 GC	167	IWL_RATE_MIMO3_INVM_PLCP = IWL_RATE_SISO_INVM_PLCP,
b481de9c ZY	168	};
b481de9c ZY	169
77626355	170	/* MAC header values for bit rates */
b481de9c ZY	171	enum {
	172	IWL_RATE_6M_IEEE = 12,
	173	IWL_RATE_9M_IEEE = 18,
	174	IWL_RATE_12M_IEEE = 24,
	175	IWL_RATE_18M_IEEE = 36,
	176	IWL_RATE_24M_IEEE = 48,
	177	IWL_RATE_36M_IEEE = 72,
	178	IWL_RATE_48M_IEEE = 96,
	179	IWL_RATE_54M_IEEE = 108,
	180	IWL_RATE_60M_IEEE = 120,
	181	IWL_RATE_1M_IEEE = 2,
	182	IWL_RATE_2M_IEEE = 4,
	183	IWL_RATE_5M_IEEE = 11,
	184	IWL_RATE_11M_IEEE = 22,
	185	};
	186
	187	#define IWL_CCK_BASIC_RATES_MASK \
	188	(IWL_RATE_1M_MASK \| \
	189	IWL_RATE_2M_MASK)
	190
	191	#define IWL_CCK_RATES_MASK \
	192	(IWL_BASIC_RATES_MASK \| \
	193	IWL_RATE_5M_MASK \| \
	194	IWL_RATE_11M_MASK)
	195
	196	#define IWL_OFDM_BASIC_RATES_MASK \
	197	(IWL_RATE_6M_MASK \| \
	198	IWL_RATE_12M_MASK \| \
	199	IWL_RATE_24M_MASK)
	200
	201	#define IWL_OFDM_RATES_MASK \
	202	(IWL_OFDM_BASIC_RATES_MASK \| \
	203	IWL_RATE_9M_MASK \| \
	204	IWL_RATE_18M_MASK \| \
	205	IWL_RATE_36M_MASK \| \
	206	IWL_RATE_48M_MASK \| \
	207	IWL_RATE_54M_MASK)
	208
	209	#define IWL_BASIC_RATES_MASK \
	210	(IWL_OFDM_BASIC_RATES_MASK \| \
	211	IWL_CCK_BASIC_RATES_MASK)
	212
8a1b0245	213	#define IWL_RATES_MASK ((1 << IWL_RATE_COUNT) - 1)
b481de9c ZY	214
	215	#define IWL_INVALID_VALUE -1
	216
	217	#define IWL_MIN_RSSI_VAL -100
	218	#define IWL_MAX_RSSI_VAL 0
	219
77626355 BC	220	/* These values specify how many Tx frame attempts before
77626355 BC	221	* searching for a new modulation mode */
b481de9c ZY	222	#define IWL_LEGACY_FAILURE_LIMIT 160
	223	#define IWL_LEGACY_SUCCESS_LIMIT 480
	224	#define IWL_LEGACY_TABLE_COUNT 160
	225
	226	#define IWL_NONE_LEGACY_FAILURE_LIMIT 400
	227	#define IWL_NONE_LEGACY_SUCCESS_LIMIT 4500
	228	#define IWL_NONE_LEGACY_TABLE_COUNT 1500
	229
77626355 BC	230	/* Success ratio (ACKed / attempted tx frames) values (perfect is 128 * 100) */
	231	#define IWL_RS_GOOD_RATIO 12800 /* 100% */
	232	#define IWL_RATE_SCALE_SWITCH 10880 /* 85% */
	233	#define IWL_RATE_HIGH_TH 10880 /* 85% */
8fe72311	234	#define IWL_RATE_INCREASE_TH 6400 /* 50% */
77626355	235	#define IWL_RATE_DECREASE_TH 1920 /* 15% */
b481de9c	236
77626355	237	/* possible actions when in legacy mode */
3110bef7 GC	238	#define IWL_LEGACY_SWITCH_ANTENNA1 0
	239	#define IWL_LEGACY_SWITCH_ANTENNA2 1
	240	#define IWL_LEGACY_SWITCH_SISO 2
	241	#define IWL_LEGACY_SWITCH_MIMO2_AB 3
	242	#define IWL_LEGACY_SWITCH_MIMO2_AC 4
	243	#define IWL_LEGACY_SWITCH_MIMO2_BC 5
584a0f00	244	#define IWL_LEGACY_SWITCH_MIMO3_ABC 6
77626355 BC	245
77626355 BC	246	/* possible actions when in siso mode */
3110bef7 GC	247	#define IWL_SISO_SWITCH_ANTENNA1 0
	248	#define IWL_SISO_SWITCH_ANTENNA2 1
	249	#define IWL_SISO_SWITCH_MIMO2_AB 2
	250	#define IWL_SISO_SWITCH_MIMO2_AC 3
	251	#define IWL_SISO_SWITCH_MIMO2_BC 4
	252	#define IWL_SISO_SWITCH_GI 5
584a0f00 WYG	253	#define IWL_SISO_SWITCH_MIMO3_ABC 6
584a0f00 WYG	254
b481de9c	255
77626355	256	/* possible actions when in mimo mode */
3110bef7 GC	257	#define IWL_MIMO2_SWITCH_ANTENNA1 0
	258	#define IWL_MIMO2_SWITCH_ANTENNA2 1
	259	#define IWL_MIMO2_SWITCH_SISO_A 2
	260	#define IWL_MIMO2_SWITCH_SISO_B 3
	261	#define IWL_MIMO2_SWITCH_SISO_C 4
	262	#define IWL_MIMO2_SWITCH_GI 5
584a0f00 WYG	263	#define IWL_MIMO2_SWITCH_MIMO3_ABC 6
	264
	265
	266	/* possible actions when in mimo3 mode */
	267	#define IWL_MIMO3_SWITCH_ANTENNA1 0
	268	#define IWL_MIMO3_SWITCH_ANTENNA2 1
	269	#define IWL_MIMO3_SWITCH_SISO_A 2
	270	#define IWL_MIMO3_SWITCH_SISO_B 3
	271	#define IWL_MIMO3_SWITCH_SISO_C 4
	272	#define IWL_MIMO3_SWITCH_MIMO2_AB 5
	273	#define IWL_MIMO3_SWITCH_MIMO2_AC 6
	274	#define IWL_MIMO3_SWITCH_MIMO2_BC 7
	275	#define IWL_MIMO3_SWITCH_GI 8
	276
	277
d6e93399 MA	278	#define IWL_MAX_11N_MIMO3_SEARCH IWL_MIMO3_SWITCH_GI
d6e93399 MA	279	#define IWL_MAX_SEARCH IWL_MIMO2_SWITCH_MIMO3_ABC
fde0db31	280
a96a27f9	281	/FIXME:RS:add possible actions for MIMO3/
fde0db31	282
77626355 BC	283	#define IWL_ACTION_LIMIT 3 /* # possible actions */
	284
	285	#define LQ_SIZE 2 /* 2 mode tables: "Active" and "Search" */
b481de9c	286
0c11b4de RR	287	/* load per tid defines for A-MPDU activation */
	288	#define IWL_AGG_TPT_THREHOLD 0
	289	#define IWL_AGG_LOAD_THRESHOLD 10
	290	#define IWL_AGG_ALL_TID 0xff
	291	#define TID_QUEUE_CELL_SPACING 50 /mS /
	292	#define TID_QUEUE_MAX_SIZE 20
	293	#define TID_ROUND_VALUE 5 /* mS */
	294	#define TID_MAX_LOAD_COUNT 8
	295
	296	#define TID_MAX_TIME_DIFF ((TID_QUEUE_MAX_SIZE - 1) * TID_QUEUE_CELL_SPACING)
	297	#define TIME_WRAP_AROUND(x, y) (((y) > (x)) ? (y) - (x) : (0-(x)) + (y))
	298
1826dcc0	299	extern const struct iwl_rate_info iwl_rates[IWL_RATE_COUNT];
d9829a67	300	extern const struct iwl3945_rate_info iwl3945_rates[IWL_RATE_COUNT_3945];
b481de9c	301
fde0db31	302	enum iwl_table_type {
b481de9c	303	LQ_NONE,
77626355	304	LQ_G, /* legacy types */
b481de9c	305	LQ_A,
77626355	306	LQ_SISO, /* high-throughput types */
fde0db31 GC	307	LQ_MIMO2,
fde0db31 GC	308	LQ_MIMO3,
b481de9c ZY	309	LQ_MAX,
	310	};
	311
81cd110d	312	#define is_legacy(tbl) (((tbl) == LQ_G) \|\| ((tbl) == LQ_A))
fde0db31 GC	313	#define is_siso(tbl) ((tbl) == LQ_SISO)
	314	#define is_mimo2(tbl) ((tbl) == LQ_MIMO2)
	315	#define is_mimo3(tbl) ((tbl) == LQ_MIMO3)
	316	#define is_mimo(tbl) (is_mimo2(tbl) \|\| is_mimo3(tbl))
81cd110d	317	#define is_Ht(tbl) (is_siso(tbl) \|\| is_mimo(tbl))
fde0db31 GC	318	#define is_a_band(tbl) ((tbl) == LQ_A)
	319	#define is_g_and(tbl) ((tbl) == LQ_G)
	320
	321	#define ANT_NONE 0x0
	322	#define ANT_A BIT(0)
	323	#define ANT_B BIT(1)
	324	#define ANT_AB (ANT_A \| ANT_B)
	325	#define ANT_C BIT(2)
	326	#define ANT_AC (ANT_A \| ANT_C)
	327	#define ANT_BC (ANT_B \| ANT_C)
	328	#define ANT_ABC (ANT_AB \| ANT_C)
	329
12b96817 WYG	330	#define IWL_MAX_MCS_DISPLAY_SIZE 12
	331
	332	struct iwl_rate_mcs_info {
	333	char mbps[IWL_MAX_MCS_DISPLAY_SIZE];
	334	char mcs[IWL_MAX_MCS_DISPLAY_SIZE];
	335	};
	336
fde0db31 GC	337	static inline u8 num_of_ant(u8 mask)
	338	{
	339	return !!((mask) & ANT_A) +
	340	!!((mask) & ANT_B) +
	341	!!((mask) & ANT_C);
	342	}
b481de9c	343
5d664a41 TW	344	static inline u8 first_antenna(u8 mask)
	345	{
	346	if (mask & ANT_A)
	347	return ANT_A;
	348	if (mask & ANT_B)
	349	return ANT_B;
	350	return ANT_C;
	351	}
	352
	353
eb4779c4	354	static inline u8 iwl_get_prev_ieee_rate(u8 rate_index)
b481de9c	355	{
1826dcc0	356	u8 rate = iwl_rates[rate_index].prev_ieee;
b481de9c ZY	357
	358	if (rate == IWL_RATE_INVALID)
	359	rate = rate_index;
	360	return rate;
	361	}
	362
d9829a67 SO	363	static inline u8 iwl3945_get_prev_ieee_rate(u8 rate_index)
	364	{
	365	u8 rate = iwl3945_rates[rate_index].prev_ieee;
	366
	367	if (rate == IWL_RATE_INVALID)
	368	rate = rate_index;
	369	return rate;
	370	}
	371
	372	/**
	373	* iwl3945_rate_scale_init - Initialize the rate scale table based on assoc info
	374	*
	375	* The specific throughput table used is based on the type of network
	376	* the associated with, including A, B, G, and G w/ TGG protection
	377	*/
	378	extern void iwl3945_rate_scale_init(struct ieee80211_hw *hw, s32 sta_id);
	379
b481de9c	380	/**
eb4779c4	381	* iwl_rate_control_register - Register the rate control algorithm callbacks
b481de9c ZY	382	*
	383	* Since the rate control algorithm is hardware specific, there is no need
	384	* or reason to place it as a stand alone module. The driver can call
eb4779c4	385	* iwl_rate_control_register in order to register the rate control callbacks
b481de9c ZY	386	* with the mac80211 subsystem. This should be performed prior to calling
	387	* ieee80211_register_hw
	388	*
	389	*/
e227ceac	390	extern int iwlagn_rate_control_register(void);
d9829a67	391	extern int iwl3945_rate_control_register(void);
b481de9c ZY	392
b481de9c ZY	393	/**
eb4779c4	394	* iwl_rate_control_unregister - Unregister the rate control callbacks
b481de9c ZY	395	*
	396	* This should be called after calling ieee80211_unregister_hw, but before
	397	* the driver is unloaded.
	398	*/
e227ceac	399	extern void iwlagn_rate_control_unregister(void);
d9829a67	400	extern void iwl3945_rate_control_unregister(void);
b481de9c	401
e227ceac	402	#endif /* __iwl_agn__rs__ */