LXR linux/drivers/net/wireless/intel/iwlwifi/dvm/rs.h

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