summaryrefslogtreecommitdiff
path: root/drivers/net/wireless/iwlegacy/iwl-legacy-rs.h
blob: 744829a662842350bd9cc4b823f6ad989ebb9ad9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
/******************************************************************************
 *
 * 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 <ilw@linux.intel.com>
 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
 *
 *****************************************************************************/

#ifndef __il_rs_h__
#define __il_rs_h__

struct il_rate_info {
	u8 plcp;	/* uCode API:  IL_RATE_6M_PLCP, etc. */
	u8 plcp_siso;	/* uCode API:  IL_RATE_SISO_6M_PLCP, etc. */
	u8 plcp_mimo2;	/* uCode API:  IL_RATE_MIMO2_6M_PLCP, etc. */
	u8 ieee;	/* MAC header:  IL_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 il3945_rate_info {
	u8 plcp;		/* uCode API:  IL_RATE_6M_PLCP, etc. */
	u8 ieee;		/* MAC header:  IL_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 il_rate_info il_rates[IL_RATE_COUNT];
 */
enum {
	IL_RATE_1M_INDEX = 0,
	IL_RATE_2M_INDEX,
	IL_RATE_5M_INDEX,
	IL_RATE_11M_INDEX,
	IL_RATE_6M_INDEX,
	IL_RATE_9M_INDEX,
	IL_RATE_12M_INDEX,
	IL_RATE_18M_INDEX,
	IL_RATE_24M_INDEX,
	IL_RATE_36M_INDEX,
	IL_RATE_48M_INDEX,
	IL_RATE_54M_INDEX,
	IL_RATE_60M_INDEX,
	IL_RATE_COUNT,
	IL_RATE_COUNT_LEGACY = IL_RATE_COUNT - 1,	/* Excluding 60M */
	IL_RATE_COUNT_3945 = IL_RATE_COUNT - 1,
	IL_RATE_INVM_INDEX = IL_RATE_COUNT,
	IL_RATE_INVALID = IL_RATE_COUNT,
};

enum {
	IL_RATE_6M_INDEX_TABLE = 0,
	IL_RATE_9M_INDEX_TABLE,
	IL_RATE_12M_INDEX_TABLE,
	IL_RATE_18M_INDEX_TABLE,
	IL_RATE_24M_INDEX_TABLE,
	IL_RATE_36M_INDEX_TABLE,
	IL_RATE_48M_INDEX_TABLE,
	IL_RATE_54M_INDEX_TABLE,
	IL_RATE_1M_INDEX_TABLE,
	IL_RATE_2M_INDEX_TABLE,
	IL_RATE_5M_INDEX_TABLE,
	IL_RATE_11M_INDEX_TABLE,
	IL_RATE_INVM_INDEX_TABLE = IL_RATE_INVM_INDEX - 1,
};

enum {
	IL_FIRST_OFDM_RATE = IL_RATE_6M_INDEX,
	IWL39_LAST_OFDM_RATE = IL_RATE_54M_INDEX,
	IL_LAST_OFDM_RATE = IL_RATE_60M_INDEX,
	IL_FIRST_CCK_RATE = IL_RATE_1M_INDEX,
	IL_LAST_CCK_RATE = IL_RATE_11M_INDEX,
};

/* #define vs. enum to keep from defaulting to 'large integer' */
#define	IL_RATE_6M_MASK   (1 << IL_RATE_6M_INDEX)
#define	IL_RATE_9M_MASK   (1 << IL_RATE_9M_INDEX)
#define	IL_RATE_12M_MASK  (1 << IL_RATE_12M_INDEX)
#define	IL_RATE_18M_MASK  (1 << IL_RATE_18M_INDEX)
#define	IL_RATE_24M_MASK  (1 << IL_RATE_24M_INDEX)
#define	IL_RATE_36M_MASK  (1 << IL_RATE_36M_INDEX)
#define	IL_RATE_48M_MASK  (1 << IL_RATE_48M_INDEX)
#define	IL_RATE_54M_MASK  (1 << IL_RATE_54M_INDEX)
#define IL_RATE_60M_MASK  (1 << IL_RATE_60M_INDEX)
#define	IL_RATE_1M_MASK   (1 << IL_RATE_1M_INDEX)
#define	IL_RATE_2M_MASK   (1 << IL_RATE_2M_INDEX)
#define	IL_RATE_5M_MASK   (1 << IL_RATE_5M_INDEX)
#define	IL_RATE_11M_MASK  (1 << IL_RATE_11M_INDEX)

/* uCode API values for legacy bit rates, both OFDM and CCK */
enum {
	IL_RATE_6M_PLCP  = 13,
	IL_RATE_9M_PLCP  = 15,
	IL_RATE_12M_PLCP = 5,
	IL_RATE_18M_PLCP = 7,
	IL_RATE_24M_PLCP = 9,
	IL_RATE_36M_PLCP = 11,
	IL_RATE_48M_PLCP = 1,
	IL_RATE_54M_PLCP = 3,
	IL_RATE_60M_PLCP = 3,/*FIXME:RS:should be removed*/
	IL_RATE_1M_PLCP  = 10,
	IL_RATE_2M_PLCP  = 20,
	IL_RATE_5M_PLCP  = 55,
	IL_RATE_11M_PLCP = 110,
	/*FIXME:RS:add IL_RATE_LEGACY_INVM_PLCP = 0,*/
};

/* uCode API values for OFDM high-throughput (HT) bit rates */
enum {
	IL_RATE_SISO_6M_PLCP = 0,
	IL_RATE_SISO_12M_PLCP = 1,
	IL_RATE_SISO_18M_PLCP = 2,
	IL_RATE_SISO_24M_PLCP = 3,
	IL_RATE_SISO_36M_PLCP = 4,
	IL_RATE_SISO_48M_PLCP = 5,
	IL_RATE_SISO_54M_PLCP = 6,
	IL_RATE_SISO_60M_PLCP = 7,
	IL_RATE_MIMO2_6M_PLCP  = 0x8,
	IL_RATE_MIMO2_12M_PLCP = 0x9,
	IL_RATE_MIMO2_18M_PLCP = 0xa,
	IL_RATE_MIMO2_24M_PLCP = 0xb,
	IL_RATE_MIMO2_36M_PLCP = 0xc,
	IL_RATE_MIMO2_48M_PLCP = 0xd,
	IL_RATE_MIMO2_54M_PLCP = 0xe,
	IL_RATE_MIMO2_60M_PLCP = 0xf,
	IL_RATE_SISO_INVM_PLCP,
	IL_RATE_MIMO2_INVM_PLCP = IL_RATE_SISO_INVM_PLCP,
};

/* MAC header values for bit rates */
enum {
	IL_RATE_6M_IEEE  = 12,
	IL_RATE_9M_IEEE  = 18,
	IL_RATE_12M_IEEE = 24,
	IL_RATE_18M_IEEE = 36,
	IL_RATE_24M_IEEE = 48,
	IL_RATE_36M_IEEE = 72,
	IL_RATE_48M_IEEE = 96,
	IL_RATE_54M_IEEE = 108,
	IL_RATE_60M_IEEE = 120,
	IL_RATE_1M_IEEE  = 2,
	IL_RATE_2M_IEEE  = 4,
	IL_RATE_5M_IEEE  = 11,
	IL_RATE_11M_IEEE = 22,
};

#define IL_CCK_BASIC_RATES_MASK    \
	(IL_RATE_1M_MASK          | \
	IL_RATE_2M_MASK)

#define IL_CCK_RATES_MASK          \
	(IL_CCK_BASIC_RATES_MASK  | \
	IL_RATE_5M_MASK          | \
	IL_RATE_11M_MASK)

#define IL_OFDM_BASIC_RATES_MASK   \
	(IL_RATE_6M_MASK         | \
	IL_RATE_12M_MASK         | \
	IL_RATE_24M_MASK)

#define IL_OFDM_RATES_MASK         \
	(IL_OFDM_BASIC_RATES_MASK | \
	IL_RATE_9M_MASK          | \
	IL_RATE_18M_MASK         | \
	IL_RATE_36M_MASK         | \
	IL_RATE_48M_MASK         | \
	IL_RATE_54M_MASK)

#define IL_BASIC_RATES_MASK         \
	(IL_OFDM_BASIC_RATES_MASK | \
	 IL_CCK_BASIC_RATES_MASK)

#define IL_RATES_MASK ((1 << IL_RATE_COUNT) - 1)
#define IL_RATES_MASK_3945 ((1 << IL_RATE_COUNT_3945) - 1)

#define IL_INVALID_VALUE    -1

#define IL_MIN_RSSI_VAL                 -100
#define IL_MAX_RSSI_VAL                    0

/* These values specify how many Tx frame attempts before
 * searching for a new modulation mode */
#define IL_LEGACY_FAILURE_LIMIT	160
#define IL_LEGACY_SUCCESS_LIMIT	480
#define IL_LEGACY_TABLE_COUNT		160

#define IL_NONE_LEGACY_FAILURE_LIMIT	400
#define IL_NONE_LEGACY_SUCCESS_LIMIT	4500
#define IL_NONE_LEGACY_TABLE_COUNT	1500

/* Success ratio (ACKed / attempted tx frames) values (perfect is 128 * 100) */
#define IL_RS_GOOD_RATIO		12800	/* 100% */
#define IL_RATE_SCALE_SWITCH		10880	/*  85% */
#define IL_RATE_HIGH_TH		10880	/*  85% */
#define IL_RATE_INCREASE_TH		6400	/*  50% */
#define IL_RATE_DECREASE_TH		1920	/*  15% */

/* possible actions when in legacy mode */
#define IL_LEGACY_SWITCH_ANTENNA1      0
#define IL_LEGACY_SWITCH_ANTENNA2      1
#define IL_LEGACY_SWITCH_SISO          2
#define IL_LEGACY_SWITCH_MIMO2_AB      3
#define IL_LEGACY_SWITCH_MIMO2_AC      4
#define IL_LEGACY_SWITCH_MIMO2_BC      5

/* possible actions when in siso mode */
#define IL_SISO_SWITCH_ANTENNA1        0
#define IL_SISO_SWITCH_ANTENNA2        1
#define IL_SISO_SWITCH_MIMO2_AB        2
#define IL_SISO_SWITCH_MIMO2_AC        3
#define IL_SISO_SWITCH_MIMO2_BC        4
#define IL_SISO_SWITCH_GI              5

/* possible actions when in mimo mode */
#define IL_MIMO2_SWITCH_ANTENNA1       0
#define IL_MIMO2_SWITCH_ANTENNA2       1
#define IL_MIMO2_SWITCH_SISO_A         2
#define IL_MIMO2_SWITCH_SISO_B         3
#define IL_MIMO2_SWITCH_SISO_C         4
#define IL_MIMO2_SWITCH_GI             5

#define IL_MAX_SEARCH IL_MIMO2_SWITCH_GI

#define IL_ACTION_LIMIT		3	/* # possible actions */

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

/* load per tid defines for A-MPDU activation */
#define IL_AGG_TPT_THREHOLD	0
#define IL_AGG_LOAD_THRESHOLD	10
#define IL_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 il_rate_info il_rates[IL_RATE_COUNT];

enum il_table_type {
	LQ_NONE,
	LQ_G,		/* legacy types */
	LQ_A,
	LQ_SISO,	/* high-throughput types */
	LQ_MIMO2,
	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_mimo(tbl) (is_mimo2(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 IL_MAX_MCS_DISPLAY_SIZE	12

struct il_rate_mcs_info {
	char	mbps[IL_MAX_MCS_DISPLAY_SIZE];
	char	mcs[IL_MAX_MCS_DISPLAY_SIZE];
};

/**
 * struct il_rate_scale_data -- tx success history for one rate
 */
struct il_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 il_scale_tbl_info -- tx params and success history for all rates
 *
 * There are two of these in struct il_lq_sta,
 * one for "active", and one for "search".
 */
struct il_scale_tbl_info {
	enum il_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; IL_[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 il_rate_scale_data win[IL_RATE_COUNT]; /* rate histories */
};

struct il_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 il_lq_sta -- driver's rate scaling ilate structure
 *
 * Pointer to this gets passed back and forth between driver and mac80211.
 */
struct il_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; IL_RATE_6M_MASK, etc. */
	u32 supp_rates;
	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 il_link_quality_cmd lq;
	struct il_scale_tbl_info lq_info[LQ_SIZE]; /* "active", "search" */
	struct il_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 il_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;
};

static inline u8 il4965_num_of_ant(u8 m)
{
	return !!(m & ANT_A) + !!(m & ANT_B) + !!(m & ANT_C);
}

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


/**
 * il3945_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 il3945_rate_scale_init(struct ieee80211_hw *hw, s32 sta_id);

/* Initialize station's rate scaling information after adding station */
extern void il4965_rs_rate_init(struct il_priv *il,
			     struct ieee80211_sta *sta, u8 sta_id);
extern void il3945_rs_rate_init(struct il_priv *il,
				 struct ieee80211_sta *sta, u8 sta_id);

/**
 * il_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
 * il_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 il4965_rate_control_register(void);
extern int il3945_rate_control_register(void);

/**
 * il_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 il4965_rate_control_unregister(void);
extern void il3945_rate_control_unregister(void);

#endif /* __il_rs__ */