drivers/staging/winbond/mto.h

   1 //==================================================================
   2 // MTO.H
   3 //
   4 // Revision history
   5 //=================================
   6 //          20030110    UN20 Pete Chao
   7 //                      Initial Release
   8 //
   9 // Copyright (c) 2003 Winbond Electronics Corp. All rights reserved.
  10 //==================================================================
  11 #ifndef __MTO_H__
  12 #define __MTO_H__
  13
  14 #include <linux/types.h>
  15
  16 struct wbsoft_priv;
  17
  18 #define MTO_DEFAULT_TH_CNT              5
  19 #define MTO_DEFAULT_TH_SQ3              112  //OLD IS 13 reference JohnXu
  20 #define MTO_DEFAULT_TH_IDLE_SLOT        15
  21 #define MTO_DEFAULT_TH_PR_INTERF        30
  22 #define MTO_DEFAULT_TMR_AGING           25  // unit: slot time  10 reference JohnXu
  23 #define MTO_DEFAULT_TMR_PERIODIC        5   // unit: slot time
  24
  25 #define MTO_ANTENNA_DIVERSITY_OFF       0
  26 #define MTO_ANTENNA_DIVERSITY_ON        1
  27
  28 // LA20040210_DTO kevin
  29 //#define MTO_PREAMBLE_LONG               0
  30 //#define MTO_PREAMBLE_SHORT              1
  31 #define MTO_PREAMBLE_LONG               WLAN_PREAMBLE_TYPE_LONG
  32 #define MTO_PREAMBLE_SHORT              WLAN_PREAMBLE_TYPE_SHORT
  33
  34 typedef enum {
  35     TOGGLE_STATE_IDLE             = 0,
  36     TOGGLE_STATE_WAIT0            = 1,
  37     TOGGLE_STATE_WAIT1            = 2,
  38     TOGGLE_STATE_MAKEDESISION     = 3,
  39         TOGGLE_STATE_BKOFF            = 4
  40 } TOGGLE_STATE;
  41
  42 typedef enum {
  43     RATE_CHGSTATE_IDLE         = 0,
  44     RATE_CHGSTATE_CALCULATE    = 1,
  45     RATE_CHGSTATE_BACKOFF          = 2
  46 } TX_RATE_REDUCTION_STATE;
  47
  48 //============================================================================
  49 // struct _MTOParameters --
  50 //
  51 //   Defines the parameters used in the MAC Throughput Optimization algorithm
  52 //============================================================================
  53 struct wb35_mto_params {
  54         u8      Th_Fixant;
  55         u8      Th_Cnt;
  56         u8      Th_SQ3;
  57         u8      Th_IdleSlot;
  58
  59         u16     Tmr_Aging;
  60         u8      Th_PrInterf;
  61         u8      Tmr_Periodic;
  62
  63         //---------        wkchen added      -------------
  64         u32             TxFlowCount;    //to judge what kind the tx flow(sparse or busy) is
  65         //------------------------------------------------
  66
  67         //--------- DTO threshold parameters -------------
  68         u16             DTO_PeriodicCheckCycle;
  69         u16             DTO_RssiThForAntDiv;
  70
  71         u16             DTO_TxCountThForCalcNewRate;
  72         u16             DTO_TxRateIncTh;
  73
  74         u16             DTO_TxRateDecTh;
  75         u16             DTO_TxRateEqTh;
  76
  77         u16             DTO_TxRateBackOff;
  78         u16             DTO_TxRetryRateReduce;
  79
  80         u16             DTO_TxPowerIndex;       //0 ~ 31
  81         u16             reserved_1;
  82         //------------------------------------------------
  83
  84         u8      PowerChangeEnable;
  85         u8      AntDiversityEnable;
  86         u8      Ant_mac;
  87         u8      Ant_div;
  88
  89         u8      CCA_Mode;
  90         u8      CCA_Mode_Setup;
  91         u8      Preamble_Type;
  92         u8      PreambleChangeEnable;
  93
  94         u8      DataRateLevel;
  95         u8      DataRateChangeEnable;
  96         u8      FragThresholdLevel;
  97         u8      FragThresholdChangeEnable;
  98
  99         u16     RTSThreshold;
 100         u16     RTSThreshold_Setup;
 101
 102         u32     AvgIdleSlot;
 103         u32     Pr_Interf;
 104         u32     AvgGapBtwnInterf;
 105
 106         u8         RTSChangeEnable;
 107         u8      Ant_sel;
 108         u8      aging_timeout;
 109         u8         reserved_2;
 110
 111         u32     Cnt_Ant[2];
 112         u32     SQ_Ant[2];
 113
 114 // 20040510 remove from globe vairable
 115         u32                     TmrCnt;
 116         u32                     BackoffTmr;
 117         TOGGLE_STATE            ToggleState;
 118         TX_RATE_REDUCTION_STATE TxRateReductionState;
 119
 120         u8                      Last_Rate;
 121         u8                      Co_efficent;
 122         u8              FallbackRateLevel;
 123         u8              OfdmRateLevel;
 124
 125         u8              RatePolicy;
 126         u8              reserved_3[3];
 127
 128         // For RSSI turning
 129         s32             RSSI_high;
 130         s32             RSSI_low;
 131
 132 };
 133
 134
 135 #define MTO_DATA()                  (adapter->sMtoPara)
 136 #define MTO_HAL()                   (&adapter->sHwData)
 137 #define MTO_SET_PREAMBLE_TYPE(x)    // 20040511 Turbo mark LM_PREAMBLE_TYPE(&pcore_data->lm_data) = (x)
 138 #define MTO_ENABLE                                      (adapter->sLocalPara.TxRateMode == RATE_AUTO)
 139 #define MTO_TXPOWER_FROM_EEPROM         (adapter->sHwData.PowerIndexFromEEPROM)
 140 #define LOCAL_ANTENNA_NO()                      (adapter->sLocalPara.bAntennaNo)
 141 #define LOCAL_IS_CONNECTED()            (adapter->sLocalPara.wConnectedSTAindex != 0)
 142 #define MTO_INITTXRATE_MODE                     (adapter->sHwData.SoftwareSet&0x2)      //bit 1
 143 // 20040510 Turbo add
 144 #define MTO_TMR_CNT()               MTO_DATA().TmrCnt
 145 #define MTO_TOGGLE_STATE()          MTO_DATA().ToggleState
 146 #define MTO_TX_RATE_REDUCTION_STATE() MTO_DATA().TxRateReductionState
 147 #define MTO_BACKOFF_TMR()           MTO_DATA().BackoffTmr
 148 #define MTO_LAST_RATE()             MTO_DATA().Last_Rate
 149 #define MTO_CO_EFFICENT()           MTO_DATA().Co_efficent
 150
 151 #define MTO_TH_CNT()                MTO_DATA().Th_Cnt
 152 #define MTO_TH_SQ3()                MTO_DATA().Th_SQ3
 153 #define MTO_TH_IDLE_SLOT()          MTO_DATA().Th_IdleSlot
 154 #define MTO_TH_PR_INTERF()          MTO_DATA().Th_PrInterf
 155
 156 #define MTO_TMR_AGING()             MTO_DATA().Tmr_Aging
 157 #define MTO_TMR_PERIODIC()          MTO_DATA().Tmr_Periodic
 158
 159 #define MTO_POWER_CHANGE_ENABLE()   MTO_DATA().PowerChangeEnable
 160 #define MTO_ANT_DIVERSITY_ENABLE()  adapter->sLocalPara.boAntennaDiversity
 161 #define MTO_ANT_MAC()               MTO_DATA().Ant_mac
 162 #define MTO_ANT_DIVERSITY()         MTO_DATA().Ant_div
 163 #define MTO_CCA_MODE()              MTO_DATA().CCA_Mode
 164 #define MTO_CCA_MODE_SETUP()        MTO_DATA().CCA_Mode_Setup
 165 #define MTO_PREAMBLE_TYPE()         MTO_DATA().Preamble_Type
 166 #define MTO_PREAMBLE_CHANGE_ENABLE()         MTO_DATA().PreambleChangeEnable
 167
 168 #define MTO_RATE_LEVEL()            MTO_DATA().DataRateLevel
 169 #define MTO_OFDM_RATE_LEVEL()           MTO_DATA().OfdmRateLevel
 170 #define MTO_RATE_CHANGE_ENABLE()    MTO_DATA().DataRateChangeEnable
 171 #define MTO_FRAG_TH_LEVEL()         MTO_DATA().FragThresholdLevel
 172 #define MTO_FRAG_CHANGE_ENABLE()    MTO_DATA().FragThresholdChangeEnable
 173 #define MTO_RTS_THRESHOLD()         MTO_DATA().RTSThreshold
 174 #define MTO_RTS_CHANGE_ENABLE()     MTO_DATA().RTSChangeEnable
 175 #define MTO_RTS_THRESHOLD_SETUP()   MTO_DATA().RTSThreshold_Setup
 176
 177 #define MTO_AVG_IDLE_SLOT()         MTO_DATA().AvgIdleSlot
 178 #define MTO_PR_INTERF()             MTO_DATA().Pr_Interf
 179 #define MTO_AVG_GAP_BTWN_INTERF()   MTO_DATA().AvgGapBtwnInterf
 180
 181 #define MTO_ANT_SEL()               MTO_DATA().Ant_sel
 182 #define MTO_CNT_ANT(x)              MTO_DATA().Cnt_Ant[(x)]
 183 #define MTO_SQ_ANT(x)               MTO_DATA().SQ_Ant[(x)]
 184 #define MTO_AGING_TIMEOUT()         MTO_DATA().aging_timeout
 185
 186
 187 #define MTO_TXFLOWCOUNT()                       MTO_DATA().TxFlowCount
 188 //--------- DTO threshold parameters -------------
 189 #define MTOPARA_PERIODIC_CHECK_CYCLE()          MTO_DATA().DTO_PeriodicCheckCycle
 190 #define MTOPARA_RSSI_TH_FOR_ANTDIV()            MTO_DATA().DTO_RssiThForAntDiv
 191 #define MTOPARA_TXCOUNT_TH_FOR_CALC_RATE()      MTO_DATA().DTO_TxCountThForCalcNewRate
 192 #define MTOPARA_TXRATE_INC_TH()                 MTO_DATA().DTO_TxRateIncTh
 193 #define MTOPARA_TXRATE_DEC_TH()                 MTO_DATA().DTO_TxRateDecTh
 194 #define MTOPARA_TXRATE_EQ_TH()                  MTO_DATA().DTO_TxRateEqTh
 195 #define MTOPARA_TXRATE_BACKOFF()                MTO_DATA().DTO_TxRateBackOff
 196 #define MTOPARA_TXRETRYRATE_REDUCE()            MTO_DATA().DTO_TxRetryRateReduce
 197 #define MTOPARA_TXPOWER_INDEX()                 MTO_DATA().DTO_TxPowerIndex
 198 //------------------------------------------------
 199
 200
 201 extern u16  MTO_Frag_Th_Tbl[];
 202
 203 #define MTO_DATA_RATE()          MTO_Data_Rate_Tbl[MTO_RATE_LEVEL()]
 204 #define MTO_FRAG_TH()            MTO_Frag_Th_Tbl[MTO_FRAG_TH_LEVEL()]
 205
 206 typedef struct {
 207         u8 tx_rate;
 208         u8 tx_retry_rate;
 209 } TXRETRY_REC;
 210
 211 extern void MTO_Init(struct wbsoft_priv *);
 212 extern void MTO_PeriodicTimerExpired(struct wbsoft_priv *);
 213 extern void MTO_SetDTORateRange(struct wbsoft_priv *, u8 *, u8);
 214 extern u8 MTO_GetTxRate(struct wbsoft_priv *adapter, u32 fpdu_len);
 215 extern u8 MTO_GetTxFallbackRate(struct wbsoft_priv *adapter);
 216 extern void MTO_SetTxCount(struct wbsoft_priv *adapter, u8 t0, u8 index);
 217
 218 #endif //__MTO_H__
 219
 220