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

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2005 - 2007 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  * James P. Ketrenos <ipw2100-admin@linux.intel.com>
  23  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  24  *
  25  *****************************************************************************/
  26
  27 #ifndef __iwl_3945_rs_h__
  28 #define __iwl_3945_rs_h__
  29
  30 struct iwl3945_rate_info {
  31         u8 plcp;                /* uCode API:  IWL_RATE_6M_PLCP, etc. */
  32         u8 ieee;                /* MAC header:  IWL_RATE_6M_IEEE, etc. */
  33         u8 prev_ieee;           /* previous rate in IEEE speeds */
  34         u8 next_ieee;           /* next rate in IEEE speeds */
  35         u8 prev_rs;             /* previous rate used in rs algo */
  36         u8 next_rs;             /* next rate used in rs algo */
  37         u8 prev_rs_tgg;         /* previous rate used in TGG rs algo */
  38         u8 next_rs_tgg;         /* next rate used in TGG rs algo */
  39         u8 table_rs_index;      /* index in rate scale table cmd */
  40         u8 prev_table_rs;       /* prev in rate table cmd */
  41 };
  42
  43 /*
  44  * These serve as indexes into
  45  * struct iwl3945_rate_info iwl3945_rates[IWL_RATE_COUNT];
  46  */
  47 enum {
  48         IWL_RATE_1M_INDEX = 0,
  49         IWL_RATE_2M_INDEX,
  50         IWL_RATE_5M_INDEX,
  51         IWL_RATE_11M_INDEX,
  52         IWL_RATE_6M_INDEX,
  53         IWL_RATE_9M_INDEX,
  54         IWL_RATE_12M_INDEX,
  55         IWL_RATE_18M_INDEX,
  56         IWL_RATE_24M_INDEX,
  57         IWL_RATE_36M_INDEX,
  58         IWL_RATE_48M_INDEX,
  59         IWL_RATE_54M_INDEX,
  60         IWL_RATE_COUNT,
  61         IWL_RATE_INVM_INDEX,
  62         IWL_RATE_INVALID = IWL_RATE_INVM_INDEX
  63 };
  64
  65 enum {
  66         IWL_RATE_6M_INDEX_TABLE = 0,
  67         IWL_RATE_9M_INDEX_TABLE,
  68         IWL_RATE_12M_INDEX_TABLE,
  69         IWL_RATE_18M_INDEX_TABLE,
  70         IWL_RATE_24M_INDEX_TABLE,
  71         IWL_RATE_36M_INDEX_TABLE,
  72         IWL_RATE_48M_INDEX_TABLE,
  73         IWL_RATE_54M_INDEX_TABLE,
  74         IWL_RATE_1M_INDEX_TABLE,
  75         IWL_RATE_2M_INDEX_TABLE,
  76         IWL_RATE_5M_INDEX_TABLE,
  77         IWL_RATE_11M_INDEX_TABLE,
  78         IWL_RATE_INVM_INDEX_TABLE = IWL_RATE_INVM_INDEX,
  79 };
  80
  81 enum {
  82         IWL_FIRST_OFDM_RATE = IWL_RATE_6M_INDEX,
  83         IWL_LAST_OFDM_RATE = IWL_RATE_54M_INDEX,
  84         IWL_FIRST_CCK_RATE = IWL_RATE_1M_INDEX,
  85         IWL_LAST_CCK_RATE = IWL_RATE_11M_INDEX,
  86 };
  87
  88 /* #define vs. enum to keep from defaulting to 'large integer' */
  89 #define IWL_RATE_6M_MASK   (1 << IWL_RATE_6M_INDEX)
  90 #define IWL_RATE_9M_MASK   (1 << IWL_RATE_9M_INDEX)
  91 #define IWL_RATE_12M_MASK  (1 << IWL_RATE_12M_INDEX)
  92 #define IWL_RATE_18M_MASK  (1 << IWL_RATE_18M_INDEX)
  93 #define IWL_RATE_24M_MASK  (1 << IWL_RATE_24M_INDEX)
  94 #define IWL_RATE_36M_MASK  (1 << IWL_RATE_36M_INDEX)
  95 #define IWL_RATE_48M_MASK  (1 << IWL_RATE_48M_INDEX)
  96 #define IWL_RATE_54M_MASK  (1 << IWL_RATE_54M_INDEX)
  97 #define IWL_RATE_1M_MASK   (1 << IWL_RATE_1M_INDEX)
  98 #define IWL_RATE_2M_MASK   (1 << IWL_RATE_2M_INDEX)
  99 #define IWL_RATE_5M_MASK   (1 << IWL_RATE_5M_INDEX)
 100 #define IWL_RATE_11M_MASK  (1 << IWL_RATE_11M_INDEX)
 101
 102 /* 3945 uCode API values for (legacy) bit rates, both OFDM and CCK */
 103 enum {
 104         IWL_RATE_6M_PLCP = 13,
 105         IWL_RATE_9M_PLCP = 15,
 106         IWL_RATE_12M_PLCP = 5,
 107         IWL_RATE_18M_PLCP = 7,
 108         IWL_RATE_24M_PLCP = 9,
 109         IWL_RATE_36M_PLCP = 11,
 110         IWL_RATE_48M_PLCP = 1,
 111         IWL_RATE_54M_PLCP = 3,
 112         IWL_RATE_1M_PLCP = 10,
 113         IWL_RATE_2M_PLCP = 20,
 114         IWL_RATE_5M_PLCP = 55,
 115         IWL_RATE_11M_PLCP = 110,
 116 };
 117
 118 /* MAC header values for bit rates */
 119 enum {
 120         IWL_RATE_6M_IEEE = 12,
 121         IWL_RATE_9M_IEEE = 18,
 122         IWL_RATE_12M_IEEE = 24,
 123         IWL_RATE_18M_IEEE = 36,
 124         IWL_RATE_24M_IEEE = 48,
 125         IWL_RATE_36M_IEEE = 72,
 126         IWL_RATE_48M_IEEE = 96,
 127         IWL_RATE_54M_IEEE = 108,
 128         IWL_RATE_1M_IEEE = 2,
 129         IWL_RATE_2M_IEEE = 4,
 130         IWL_RATE_5M_IEEE = 11,
 131         IWL_RATE_11M_IEEE = 22,
 132 };
 133
 134 #define IWL_CCK_BASIC_RATES_MASK    \
 135        (IWL_RATE_1M_MASK          | \
 136         IWL_RATE_2M_MASK)
 137
 138 #define IWL_CCK_RATES_MASK          \
 139        (IWL_BASIC_RATES_MASK      | \
 140         IWL_RATE_5M_MASK          | \
 141         IWL_RATE_11M_MASK)
 142
 143 #define IWL_OFDM_BASIC_RATES_MASK   \
 144         (IWL_RATE_6M_MASK         | \
 145         IWL_RATE_12M_MASK         | \
 146         IWL_RATE_24M_MASK)
 147
 148 #define IWL_OFDM_RATES_MASK         \
 149        (IWL_OFDM_BASIC_RATES_MASK | \
 150         IWL_RATE_9M_MASK          | \
 151         IWL_RATE_18M_MASK         | \
 152         IWL_RATE_36M_MASK         | \
 153         IWL_RATE_48M_MASK         | \
 154         IWL_RATE_54M_MASK)
 155
 156 #define IWL_BASIC_RATES_MASK         \
 157         (IWL_OFDM_BASIC_RATES_MASK | \
 158          IWL_CCK_BASIC_RATES_MASK)
 159
 160 #define IWL_RATES_MASK ((1 << IWL_RATE_COUNT) - 1)
 161
 162 #define IWL_INVALID_VALUE    -1
 163
 164 #define IWL_MIN_RSSI_VAL                 -100
 165 #define IWL_MAX_RSSI_VAL                    0
 166
 167 extern const struct iwl3945_rate_info iwl3945_rates[IWL_RATE_COUNT];
 168
 169 static inline u8 iwl3945_get_prev_ieee_rate(u8 rate_index)
 170 {
 171         u8 rate = iwl3945_rates[rate_index].prev_ieee;
 172
 173         if (rate == IWL_RATE_INVALID)
 174                 rate = rate_index;
 175         return rate;
 176 }
 177
 178 /**
 179  * iwl3945_fill_rs_info - Fill an output text buffer with the rate representation
 180  *
 181  * NOTE:  This is provided as a quick mechanism for a user to visualize
 182  * the performance of the rate control algorithm and is not meant to be
 183  * parsed software.
 184  */
 185 extern int iwl3945_fill_rs_info(struct ieee80211_hw *, char *buf, u8 sta_id);
 186
 187 /**
 188  * iwl3945_rate_scale_init - Initialize the rate scale table based on assoc info
 189  *
 190  * The specific throughput table used is based on the type of network
 191  * the associated with, including A, B, G, and G w/ TGG protection
 192  */
 193 extern void iwl3945_rate_scale_init(struct ieee80211_hw *hw, s32 sta_id);
 194
 195 /**
 196  * iwl3945_rate_control_register - Register the rate control algorithm callbacks
 197  *
 198  * Since the rate control algorithm is hardware specific, there is no need
 199  * or reason to place it as a stand alone module.  The driver can call
 200  * iwl3945_rate_control_register in order to register the rate control callbacks
 201  * with the mac80211 subsystem.  This should be performed prior to calling
 202  * ieee80211_register_hw
 203  *
 204  */
 205 extern void iwl3945_rate_control_register(struct ieee80211_hw *hw);
 206
 207 /**
 208  * iwl3945_rate_control_unregister - Unregister the rate control callbacks
 209  *
 210  * This should be called after calling ieee80211_unregister_hw, but before
 211  * the driver is unloaded.
 212  */
 213 extern void iwl3945_rate_control_unregister(struct ieee80211_hw *hw);
 214
 215 #endif