drivers/net/wireless/iwlwifi/iwl-agn-rs.h

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