drivers/net/wireless/iwlwifi/mvm/rs.h

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