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

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