drivers/staging/rtl8723au/include/odm.h

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2007 - 2011 Realtek 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  ******************************************************************************/
  15
  16
  17 #ifndef __HALDMOUTSRC_H__
  18 #define __HALDMOUTSRC_H__
  19
  20 /*  */
  21 /*  Definition */
  22 /*  */
  23 /*  */
  24 /*  2011/09/22 MH Define all team supprt ability. */
  25 /*  */
  26
  27 /*  */
  28 /*  2011/09/22 MH Define for all teams. Please Define the constan in your precomp header. */
  29 /*  */
  30 /* define               DM_ODM_SUPPORT_AP                       0 */
  31 /* define               DM_ODM_SUPPORT_ADSL                     0 */
  32 /* define               DM_ODM_SUPPORT_CE                       0 */
  33 /* define               DM_ODM_SUPPORT_MP                       1 */
  34
  35 #define TP_MODE         0
  36 #define RSSI_MODE               1
  37 #define TRAFFIC_LOW     0
  38 #define TRAFFIC_HIGH    1
  39
  40
  41 /*  */
  42 /* 3 Tx Power Tracking */
  43 /* 3============================================================ */
  44 #define         DPK_DELTA_MAPPING_NUM   13
  45 #define         index_mapping_HP_NUM    15
  46
  47
  48 /*  */
  49 /* 3 PSD Handler */
  50 /* 3============================================================ */
  51
  52 #define AFH_PSD         1       /* 0:normal PSD scan, 1: only do 20 pts PSD */
  53 #define MODE_40M                0       /* 0:20M, 1:40M */
  54 #define PSD_TH2         3
  55 #define PSD_CHMIN               20   /*  Minimum channel number for BT AFH */
  56 #define SIR_STEP_SIZE   3
  57 #define   Smooth_Size_1         5
  58 #define Smooth_TH_1     3
  59 #define   Smooth_Size_2         10
  60 #define Smooth_TH_2     4
  61 #define   Smooth_Size_3         20
  62 #define Smooth_TH_3     4
  63 #define   Smooth_Step_Size 5
  64 #define Adaptive_SIR    1
  65 #define PSD_RESCAN              4
  66 #define PSD_SCAN_INTERVAL       700 /* ms */
  67
  68 /* 8723A High Power IGI Setting */
  69 #define DM_DIG_HIGH_PWR_IGI_LOWER_BOUND 0x22
  70 #define DM_DIG_Gmode_HIGH_PWR_IGI_LOWER_BOUND 0x28
  71 #define DM_DIG_HIGH_PWR_THRESHOLD       0x3a
  72
  73 /*  LPS define */
  74 #define DM_DIG_FA_TH0_LPS                               4 /*  4 in lps */
  75 #define DM_DIG_FA_TH1_LPS                               15 /*  15 lps */
  76 #define DM_DIG_FA_TH2_LPS                               30 /*  30 lps */
  77 #define RSSI_OFFSET_DIG                                 0x05;
  78
  79 /* ANT Test */
  80 #define                 ANTTESTALL              0x00            /* Ant A or B will be Testing */
  81 #define         ANTTESTA                0x01            /* Ant A will be Testing */
  82 #define         ANTTESTB                0x02            /* Ant B will be testing */
  83
  84
  85 /*  */
  86 /*  structure and define */
  87 /*  */
  88
  89 struct  dig_t {
  90         u8              Dig_Enable_Flag;
  91         u8              Dig_Ext_Port_Stage;
  92
  93         int             RssiLowThresh;
  94         int             RssiHighThresh;
  95
  96         u32             FALowThresh;
  97         u32             FAHighThresh;
  98
  99         u8              CurSTAConnectState;
 100         u8              PreSTAConnectState;
 101         u8              CurMultiSTAConnectState;
 102
 103         u8              PreIGValue;
 104         u8              CurIGValue;
 105         u8              BackupIGValue;
 106
 107         s8              BackoffVal;
 108         s8              BackoffVal_range_max;
 109         s8              BackoffVal_range_min;
 110         u8              rx_gain_range_max;
 111         u8              rx_gain_range_min;
 112         u8              Rssi_val_min;
 113
 114         u8              PreCCK_CCAThres;
 115         u8              CurCCK_CCAThres;
 116         u8              PreCCKPDState;
 117         u8              CurCCKPDState;
 118
 119         u8              LargeFAHit;
 120         u8              ForbiddenIGI;
 121         u32             Recover_cnt;
 122
 123         u8              DIG_Dynamic_MIN_0;
 124         u8              DIG_Dynamic_MIN_1;
 125         bool            bMediaConnect_0;
 126         bool            bMediaConnect_1;
 127
 128         u32             AntDiv_RSSI_max;
 129         u32             RSSI_max;
 130 };
 131
 132 struct dynamic_pwr_sav {
 133         u8              PreCCAState;
 134         u8              CurCCAState;
 135
 136         u8              PreRFState;
 137         u8              CurRFState;
 138
 139         int                 Rssi_val_min;
 140
 141         u8              initialize;
 142         u32             Reg874,RegC70,Reg85C,RegA74;
 143 };
 144
 145 struct false_alarm_stats {
 146         u32     Cnt_Parity_Fail;
 147         u32     Cnt_Rate_Illegal;
 148         u32     Cnt_Crc8_fail;
 149         u32     Cnt_Mcs_fail;
 150         u32     Cnt_Ofdm_fail;
 151         u32     Cnt_Cck_fail;
 152         u32     Cnt_all;
 153         u32     Cnt_Fast_Fsync;
 154         u32     Cnt_SB_Search_fail;
 155         u32     Cnt_OFDM_CCA;
 156         u32     Cnt_CCK_CCA;
 157         u32     Cnt_CCA_all;
 158         u32     Cnt_BW_USC;     /* Gary */
 159         u32     Cnt_BW_LSC;     /* Gary */
 160 };
 161
 162 struct pri_cca {
 163         u8              PriCCA_flag;
 164         u8              intf_flag;
 165         u8              intf_type;
 166         u8              DupRTS_flag;
 167         u8              Monitor_flag;
 168 };
 169
 170 struct rx_hp {
 171         u8              RXHP_flag;
 172         u8              PSD_func_trigger;
 173         u8              PSD_bitmap_RXHP[80];
 174         u8              Pre_IGI;
 175         u8              Cur_IGI;
 176         u8              Pre_pw_th;
 177         u8              Cur_pw_th;
 178         bool            First_time_enter;
 179         bool            RXHP_enable;
 180         u8              TP_Mode;
 181 };
 182
 183 #define ASSOCIATE_ENTRY_NUM                                     32 /*  Max size of AsocEntry[]. */
 184 #define ODM_ASSOCIATE_ENTRY_NUM                         ASSOCIATE_ENTRY_NUM
 185
 186 /*  This indicates two different the steps. */
 187 /*  In SWAW_STEP_PEAK, driver needs to switch antenna and listen to the signal on the air. */
 188 /*  In SWAW_STEP_DETERMINE, driver just compares the signal captured in SWAW_STEP_PEAK */
 189 /*  with original RSSI to determine if it is necessary to switch antenna. */
 190 #define SWAW_STEP_PEAK          0
 191 #define SWAW_STEP_DETERMINE     1
 192
 193 #define TP_MODE         0
 194 #define RSSI_MODE               1
 195 #define TRAFFIC_LOW     0
 196 #define TRAFFIC_HIGH    1
 197
 198 struct sw_ant_sw {
 199         u8              try_flag;
 200         s32             PreRSSI;
 201         u8              CurAntenna;
 202         u8              PreAntenna;
 203         u8              RSSI_Trying;
 204         u8              TestMode;
 205         u8              bTriggerAntennaSwitch;
 206         u8              SelectAntennaMap;
 207         u8              RSSI_target;
 208
 209         /*  Before link Antenna Switch check */
 210         u8              SWAS_NoLink_State;
 211         u32             SWAS_NoLink_BK_Reg860;
 212         bool            ANTA_ON;        /* To indicate Ant A is or not */
 213         bool            ANTB_ON;        /* To indicate Ant B is on or not */
 214
 215         s32             RSSI_sum_A;
 216         s32             RSSI_sum_B;
 217         s32             RSSI_cnt_A;
 218         s32             RSSI_cnt_B;
 219
 220         u64             lastTxOkCnt;
 221         u64             lastRxOkCnt;
 222         u64             TXByteCnt_A;
 223         u64             TXByteCnt_B;
 224         u64             RXByteCnt_A;
 225         u64             RXByteCnt_B;
 226         u8              TrafficLoad;
 227 };
 228
 229 struct edca_turbo {
 230         bool bCurrentTurboEDCA;
 231         bool bIsCurRDLState;
 232         u32     prv_traffic_idx; /*  edca turbo */
 233 };
 234
 235 struct odm_rate_adapt {
 236         u8      Type;           /*  DM_Type_ByFW/DM_Type_ByDriver */
 237         u8      HighRSSIThresh; /*  if RSSI > HighRSSIThresh    => RATRState is DM_RATR_STA_HIGH */
 238         u8      LowRSSIThresh;  /*  if RSSI <= LowRSSIThresh    => RATRState is DM_RATR_STA_LOW */
 239         u8      RATRState;      /*  Current RSSI level, DM_RATR_STA_HIGH/DM_RATR_STA_MIDDLE/DM_RATR_STA_LOW */
 240         u32     LastRATR;       /*  RATR Register Content */
 241 };
 242
 243 #define IQK_MAC_REG_NUM         4
 244 #define IQK_ADDA_REG_NUM                16
 245 #define IQK_BB_REG_NUM_MAX      10
 246 #define IQK_BB_REG_NUM          9
 247 #define HP_THERMAL_NUM          8
 248
 249 #define AVG_THERMAL_NUM         8
 250 #define IQK_Matrix_REG_NUM      8
 251 #define IQK_Matrix_Settings_NUM 1+24+21
 252
 253 #define         DM_Type_ByFW                    0
 254 #define         DM_Type_ByDriver                1
 255
 256 /*  Declare for common info */
 257
 258 struct odm_phy_dbg_info {
 259         /* ODM Write,debug info */
 260         s8              RxSNRdB[RF_PATH_MAX];
 261         u64             NumQryPhyStatus;
 262         u64             NumQryPhyStatusCCK;
 263         u64             NumQryPhyStatusOFDM;
 264         /* Others */
 265         s32             RxEVM[RF_PATH_MAX];
 266
 267 };
 268
 269 struct odm_packet_info {
 270         u8              Rate;
 271         u8              StationID;
 272         bool            bPacketMatchBSSID;
 273         bool            bPacketToSelf;
 274         bool            bPacketBeacon;
 275 };
 276
 277
 278 enum {
 279         /*  BB Team */
 280         ODM_DIG                 = 0x00000001,
 281         ODM_HIGH_POWER          = 0x00000002,
 282         ODM_CCK_CCA_TH          = 0x00000004,
 283         ODM_FA_STATISTICS       = 0x00000008,
 284         ODM_RAMASK              = 0x00000010,
 285         ODM_RSSI_MONITOR        = 0x00000020,
 286         ODM_SW_ANTDIV           = 0x00000040,
 287         ODM_HW_ANTDIV           = 0x00000080,
 288         ODM_BB_PWRSV            = 0x00000100,
 289         ODM_2TPATHDIV           = 0x00000200,
 290         ODM_1TPATHDIV           = 0x00000400,
 291         ODM_PSD2AFH             = 0x00000800
 292 };
 293
 294 /*  */
 295 /*  2011/10/20 MH Define Common info enum for all team. */
 296 /*  */
 297
 298 enum odm_cmninfo {
 299         /*  Fixed value: */
 300         /*  */
 301
 302         ODM_CMNINFO_PLATFORM = 0,
 303         ODM_CMNINFO_INTERFACE,                          /*  enum odm_interface_def */
 304         ODM_CMNINFO_MP_TEST_CHIP,
 305         ODM_CMNINFO_IC_TYPE,                                    /*  enum odm_ic_type_def */
 306         ODM_CMNINFO_CUT_VER,                                    /*  enum odm_cut_version */
 307         ODM_CMNINFO_FAB_VER,                                    /*  enum odm_fab_version */
 308         ODM_CMNINFO_RF_TYPE,                                    /*  enum rf_path_def or enum odm_rf_type? */
 309         ODM_CMNINFO_BOARD_TYPE,                         /*  enum odm_board_type */
 310         ODM_CMNINFO_EXT_LNA,                                    /*  true */
 311         ODM_CMNINFO_EXT_PA,
 312         ODM_CMNINFO_EXT_TRSW,
 313         ODM_CMNINFO_PATCH_ID,                           /* CUSTOMER ID */
 314         ODM_CMNINFO_BINHCT_TEST,
 315         ODM_CMNINFO_BWIFI_TEST,
 316         ODM_CMNINFO_SMART_CONCURRENT,
 317
 318
 319         /*  */
 320         /*  Dynamic value: */
 321         /*  */
 322         ODM_CMNINFO_POWER_SAVING,
 323         ODM_CMNINFO_MP_MODE,
 324
 325         ODM_CMNINFO_WIFI_DIRECT,
 326         ODM_CMNINFO_WIFI_DISPLAY,
 327         ODM_CMNINFO_LINK,
 328         ODM_CMNINFO_RSSI_MIN,
 329         ODM_CMNINFO_DBG_COMP,                           /*  u64 */
 330         ODM_CMNINFO_DBG_LEVEL,                          /*  u32 */
 331         ODM_CMNINFO_RA_THRESHOLD_HIGH,          /*  u8 */
 332         ODM_CMNINFO_RA_THRESHOLD_LOW,           /*  u8 */
 333         ODM_CMNINFO_RF_ANTENNA_TYPE,            /*  u8 */
 334         ODM_CMNINFO_BT_DISABLED,
 335         ODM_CMNINFO_BT_OPERATION,
 336         ODM_CMNINFO_BT_DIG,
 337         ODM_CMNINFO_BT_BUSY,                                    /* Check Bt is using or not */
 338         ODM_CMNINFO_BT_DISABLE_EDCA,
 339
 340         /*  */
 341         /*  Dynamic ptr array hook itms. */
 342         /*  */
 343         ODM_CMNINFO_STA_STATUS,
 344         ODM_CMNINFO_PHY_STATUS,
 345         ODM_CMNINFO_MAC_STATUS,
 346
 347         ODM_CMNINFO_MAX,
 348 };
 349
 350 /*  Define ODM support ability.  ODM_CMNINFO_ABILITY */
 351 enum {
 352         /*  BB ODM section BIT 0-15 */
 353         ODM_BB_DIG                              = BIT(0),
 354         ODM_BB_RA_MASK                          = BIT(1),
 355         ODM_BB_DYNAMIC_TXPWR                    = BIT(2),
 356         ODM_BB_FA_CNT                           = BIT(3),
 357         ODM_BB_RSSI_MONITOR                     = BIT(4),
 358         ODM_BB_CCK_PD                           = BIT(5),
 359         ODM_BB_ANT_DIV                          = BIT(6),
 360         ODM_BB_PWR_SAVE                         = BIT(7),
 361         ODM_BB_PWR_TRAIN                        = BIT(8),
 362         ODM_BB_RATE_ADAPTIVE                    = BIT(9),
 363         ODM_BB_PATH_DIV                         = BIT(10),
 364         ODM_BB_PSD                              = BIT(11),
 365         ODM_BB_RXHP                             = BIT(12),
 366
 367         /*  MAC DM section BIT 16-23 */
 368         ODM_MAC_EDCA_TURBO                      = BIT(16),
 369         ODM_MAC_EARLY_MODE                      = BIT(17),
 370
 371         /*  RF ODM section BIT 24-31 */
 372         ODM_RF_TX_PWR_TRACK                     = BIT(24),
 373         ODM_RF_RX_GAIN_TRACK                    = BIT(25),
 374         ODM_RF_CALIBRATION                      = BIT(26),
 375
 376 };
 377
 378 /*      ODM_CMNINFO_INTERFACE */
 379 enum odm_interface_def {
 380         ODM_ITRF_PCIE   =       0x1,
 381         ODM_ITRF_USB    =       0x2,
 382         ODM_ITRF_SDIO   =       0x4,
 383         ODM_ITRF_ALL    =       0x7,
 384 };
 385
 386 /*  ODM_CMNINFO_IC_TYPE */
 387 enum odm_ic_type_def {
 388         ODM_RTL8192S    =       BIT(0),
 389         ODM_RTL8192C    =       BIT(1),
 390         ODM_RTL8192D    =       BIT(2),
 391         ODM_RTL8723A    =       BIT(3),
 392         ODM_RTL8188E    =       BIT(4),
 393         ODM_RTL8812     =       BIT(5),
 394         ODM_RTL8821     =       BIT(6),
 395 };
 396
 397 /* ODM_CMNINFO_CUT_VER */
 398 enum odm_cut_version {
 399         ODM_CUT_A               =       1,
 400         ODM_CUT_B               =       2,
 401         ODM_CUT_C               =       3,
 402         ODM_CUT_D               =       4,
 403         ODM_CUT_E               =       5,
 404         ODM_CUT_F               =       6,
 405         ODM_CUT_TEST            =       7,
 406 };
 407
 408 /*  ODM_CMNINFO_FAB_VER */
 409 enum odm_fab_version {
 410         ODM_TSMC        =       0,
 411         ODM_UMC         =       1,
 412 };
 413
 414 /*  ODM_CMNINFO_RF_TYPE */
 415 /*  For example 1T2R (A+AB = BIT0|BIT4|BIT5) */
 416 enum rf_path_def {
 417         ODM_RF_TX_A     =       BIT(0),
 418         ODM_RF_TX_B     =       BIT(1),
 419         ODM_RF_TX_C     =       BIT(2),
 420         ODM_RF_TX_D     =       BIT(3),
 421         ODM_RF_RX_A     =       BIT(4),
 422         ODM_RF_RX_B     =       BIT(5),
 423         ODM_RF_RX_C     =       BIT(6),
 424         ODM_RF_RX_D     =       BIT(7),
 425 };
 426
 427
 428 enum odm_rf_type {
 429         ODM_1T1R        =       0,
 430         ODM_1T2R        =       1,
 431         ODM_2T2R        =       2,
 432         ODM_2T3R        =       3,
 433         ODM_2T4R        =       4,
 434         ODM_3T3R        =       5,
 435         ODM_3T4R        =       6,
 436         ODM_4T4R        =       7,
 437 };
 438
 439 /*  ODM Dynamic common info value definition */
 440
 441 enum odm_mac_phy_mode {
 442         ODM_SMSP        = 0,
 443         ODM_DMSP        = 1,
 444         ODM_DMDP        = 2,
 445 };
 446
 447
 448 enum odm_bt_coexist {
 449         ODM_BT_BUSY             = 1,
 450         ODM_BT_ON               = 2,
 451         ODM_BT_OFF              = 3,
 452         ODM_BT_NONE             = 4,
 453 };
 454
 455 /*  ODM_CMNINFO_OP_MODE */
 456 enum odm_operation_mode {
 457         ODM_NO_LINK             = BIT(0),
 458         ODM_LINK                = BIT(1),
 459         ODM_SCAN                = BIT(2),
 460         ODM_POWERSAVE           = BIT(3),
 461         ODM_AP_MODE             = BIT(4),
 462         ODM_CLIENT_MODE         = BIT(5),
 463         ODM_AD_HOC              = BIT(6),
 464         ODM_WIFI_DIRECT         = BIT(7),
 465         ODM_WIFI_DISPLAY        = BIT(8),
 466 };
 467
 468 /*  ODM_CMNINFO_WM_MODE */
 469 enum odm_wireless_mode {
 470         ODM_WM_UNKNOW           = 0x0,
 471         ODM_WM_B                = BIT(0),
 472         ODM_WM_G                = BIT(1),
 473         ODM_WM_A                = BIT(2),
 474         ODM_WM_N24G             = BIT(3),
 475         ODM_WM_N5G              = BIT(4),
 476         ODM_WM_AUTO             = BIT(5),
 477         ODM_WM_AC               = BIT(6),
 478 };
 479
 480 /*  ODM_CMNINFO_BAND */
 481 enum odm_band_type {
 482         ODM_BAND_2_4G           = BIT(0),
 483         ODM_BAND_5G             = BIT(1),
 484
 485 };
 486
 487 /*  ODM_CMNINFO_SEC_CHNL_OFFSET */
 488 enum odm_sec_chnl_offset {
 489         ODM_DONT_CARE           = 0,
 490         ODM_BELOW               = 1,
 491         ODM_ABOVE               = 2
 492 };
 493
 494 /*  ODM_CMNINFO_CHNL */
 495
 496 /*  ODM_CMNINFO_BOARD_TYPE */
 497 enum odm_board_type {
 498         ODM_BOARD_NORMAL        = 0,
 499         ODM_BOARD_HIGHPWR       = 1,
 500         ODM_BOARD_MINICARD      = 2,
 501         ODM_BOARD_SLIM          = 3,
 502         ODM_BOARD_COMBO         = 4,
 503
 504 };
 505
 506 /*  ODM_CMNINFO_ONE_PATH_CCA */
 507 enum odm_cca_path {
 508         ODM_CCA_2R                      = 0,
 509         ODM_CCA_1R_A                    = 1,
 510         ODM_CCA_1R_B                    = 2,
 511 };
 512
 513 struct iqk_matrix_regs_set {
 514         bool    bIQKDone;
 515         s32     Value[1][IQK_Matrix_REG_NUM];
 516 };
 517
 518 struct odm_rf_cal_t {
 519         /* for tx power tracking */
 520
 521         u32     RegA24; /*  for TempCCK */
 522         s32     RegE94;
 523         s32     RegE9C;
 524         s32     RegEB4;
 525         s32     RegEBC;
 526
 527         /* u8 bTXPowerTracking; */
 528         u8              TXPowercount;
 529         bool bTXPowerTrackingInit;
 530         bool bTXPowerTracking;
 531         u8              TxPowerTrackControl; /* for mp mode, turn off txpwrtracking as default */
 532         u8              TM_Trigger;
 533         u8              InternalPA5G[2];        /* pathA / pathB */
 534
 535         u8              ThermalMeter[2];    /*  ThermalMeter, index 0 for RFIC0, and 1 for RFIC1 */
 536         u8              ThermalValue;
 537         u8              ThermalValue_LCK;
 538         u8              ThermalValue_IQK;
 539         u8      ThermalValue_DPK;
 540         u8      ThermalValue_AVG[AVG_THERMAL_NUM];
 541         u8      ThermalValue_AVG_index;
 542         u8      ThermalValue_RxGain;
 543         u8      ThermalValue_Crystal;
 544         u8      ThermalValue_DPKstore;
 545         u8      ThermalValue_DPKtrack;
 546         bool    TxPowerTrackingInProgress;
 547         bool    bDPKenable;
 548
 549         bool    bReloadtxpowerindex;
 550         u8      bRfPiEnable;
 551         u32     TXPowerTrackingCallbackCnt; /* cosa add for debug */
 552
 553         u8      bCCKinCH14;
 554         u8      CCK_index;
 555         u8      OFDM_index[2];
 556         bool bDoneTxpower;
 557
 558         u8      ThermalValue_HP[HP_THERMAL_NUM];
 559         u8      ThermalValue_HP_index;
 560         struct iqk_matrix_regs_set IQKMatrixRegSetting[IQK_Matrix_Settings_NUM];
 561
 562         u8      Delta_IQK;
 563         u8      Delta_LCK;
 564
 565         /* for IQK */
 566         u32     RegC04;
 567         u32     Reg874;
 568         u32     RegC08;
 569         u32     RegB68;
 570         u32     RegB6C;
 571         u32     Reg870;
 572         u32     Reg860;
 573         u32     Reg864;
 574
 575         bool    bIQKInitialized;
 576         bool bLCKInProgress;
 577         bool    bAntennaDetected;
 578         u32     ADDA_backup[IQK_ADDA_REG_NUM];
 579         u32     IQK_MAC_backup[IQK_MAC_REG_NUM];
 580         u32     IQK_BB_backup_recover[9];
 581         u32     IQK_BB_backup[IQK_BB_REG_NUM];
 582
 583         /* for APK */
 584         u32     APKoutput[2][2]; /* path A/B; output1_1a/output1_2a */
 585         u8      bAPKdone;
 586         u8      bAPKThermalMeterIgnore;
 587         u8      bDPdone;
 588         u8      bDPPathAOK;
 589         u8      bDPPathBOK;
 590 };
 591
 592 /*  ODM Dynamic common info value definition */
 593 struct odm_fat_t {
 594         u8      Bssid[6];
 595         u8      antsel_rx_keep_0;
 596         u8      antsel_rx_keep_1;
 597         u8      antsel_rx_keep_2;
 598         u32     antSumRSSI[7];
 599         u32     antRSSIcnt[7];
 600         u32     antAveRSSI[7];
 601         u8      FAT_State;
 602         u32     TrainIdx;
 603         u8      antsel_a[ODM_ASSOCIATE_ENTRY_NUM];
 604         u8      antsel_b[ODM_ASSOCIATE_ENTRY_NUM];
 605         u8      antsel_c[ODM_ASSOCIATE_ENTRY_NUM];
 606         u32     MainAnt_Sum[ODM_ASSOCIATE_ENTRY_NUM];
 607         u32     AuxAnt_Sum[ODM_ASSOCIATE_ENTRY_NUM];
 608         u32     MainAnt_Cnt[ODM_ASSOCIATE_ENTRY_NUM];
 609         u32     AuxAnt_Cnt[ODM_ASSOCIATE_ENTRY_NUM];
 610         u8      RxIdleAnt;
 611         bool    bBecomeLinked;
 612 };
 613
 614 enum fat_state {
 615         FAT_NORMAL_STATE                = 0,
 616         FAT_TRAINING_STATE              = 1,
 617 };
 618
 619 enum ant_dif_type {
 620         NO_ANTDIV                       = 0xFF,
 621         CG_TRX_HW_ANTDIV                = 0x01,
 622         CGCS_RX_HW_ANTDIV               = 0x02,
 623         FIXED_HW_ANTDIV                 = 0x03,
 624         CG_TRX_SMART_ANTDIV             = 0x04,
 625         CGCS_RX_SW_ANTDIV               = 0x05,
 626 };
 627
 628 /*  2011/09/22 MH Copy from SD4 defined structure. We use to support PHY DM integration. */
 629 struct dm_odm_t {
 630         /*  */
 631         /*      Add for different team use temporarily */
 632         /*  */
 633         struct rtw_adapter      *Adapter;               /*  For CE/NIC team */
 634
 635         u64                     DebugComponents;
 636         u32                     DebugLevel;
 637
 638 /*  ODM HANDLE, DRIVER NEEDS NOT TO HOOK------ */
 639         bool                    bCckHighPower;
 640         u8                      RFPathRxEnable;         /*  ODM_CMNINFO_RFPATH_ENABLE */
 641         u8                      ControlChannel;
 642 /*  ODM HANDLE, DRIVER NEEDS NOT TO HOOK------ */
 643
 644 /* 1  COMMON INFORMATION */
 645
 646         /*  Init Value */
 647 /* HOOK BEFORE REG INIT----------- */
 648         /*  ODM Support Ability DIG/RATR/TX_PWR_TRACK/ ¡K¡K = 1/2/3/¡K */
 649         u32                     SupportAbility;
 650         /*  ODM PCIE/USB/SDIO/GSPI = 0/1/2/3 */
 651         u8                      SupportInterface;
 652         /*  ODM composite or independent. Bit oriented/ 92C+92D+ .... or any other type = 1/2/3/... */
 653         u32                     SupportICType;
 654         /*  Cut Version TestChip/A-cut/B-cut... = 0/1/2/3/... */
 655         u8                      CutVersion;
 656         /*  Fab Version TSMC/UMC = 0/1 */
 657         u8                      FabVersion;
 658         /*  RF Type 4T4R/3T3R/2T2R/1T2R/1T1R/... */
 659         u8                      RFType;
 660         /*  Board Type Normal/HighPower/MiniCard/SLIM/Combo/... = 0/1/2/3/4/... */
 661         u8                      BoardType;
 662         /*  with external LNA  NO/Yes = 0/1 */
 663         u8                      ExtLNA;
 664         /*  with external PA  NO/Yes = 0/1 */
 665         u8                      ExtPA;
 666         /*  with external TRSW  NO/Yes = 0/1 */
 667         u8                      ExtTRSW;
 668         u8                      PatchID; /* Customer ID */
 669         bool                    bInHctTest;
 670         bool                    bWIFITest;
 671
 672         bool                    bDualMacSmartConcurrent;
 673         u32                     BK_SupportAbility;
 674         u8                      AntDivType;
 675 /* HOOK BEFORE REG INIT----------- */
 676
 677         /*  */
 678         /*  Dynamic Value */
 679         /*  */
 680 /*  POINTER REFERENCE----------- */
 681
 682         u8                      u8_temp;
 683         bool                    bool_temp;
 684         struct rtw_adapter      *PADAPTER_temp;
 685
 686         /*  Common info for Status */
 687         bool                    *pbPowerSaving;
 688 /*  POINTER REFERENCE----------- */
 689         /*  */
 690 /* CALL BY VALUE------------- */
 691         bool                    bWIFI_Direct;
 692         bool                    bWIFI_Display;
 693         bool                    bLinked;
 694         u8                      RSSI_Min;
 695         u8                      InterfaceIndex; /*  Add for 92D  dual MAC: 0--Mac0 1--Mac1 */
 696         bool            bIsMPChip;
 697         bool                    bOneEntryOnly;
 698         /*  Common info for BTDM */
 699         bool                    bBtDisabled;                    /*  BT is disabled */
 700         bool                    bBtHsOperation;         /*  BT HS mode is under progress */
 701         u8                      btHsDigVal;                     /*  use BT rssi to decide the DIG value */
 702         bool                    bBtDisableEdcaTurbo;    /*  Under some condition, don't enable the EDCA Turbo */
 703         bool                    bBtBusy;                        /*  BT is busy. */
 704 /* CALL BY VALUE------------- */
 705
 706         /* 2 Define STA info. */
 707         /*  _ODM_STA_INFO */
 708         /*  2012/01/12 MH For MP, we need to reduce one array pointer for default port.?? */
 709         struct sta_info *               pODM_StaInfo[ODM_ASSOCIATE_ENTRY_NUM];
 710
 711         /*  */
 712         /*  2012/02/14 MH Add to share 88E ra with other SW team. */
 713         /*  We need to colelct all support abilit to a proper area. */
 714         /*  */
 715         bool                            RaSupport88E;
 716
 717         /*  Define ........... */
 718
 719         /*  Latest packet phy info (ODM write) */
 720         struct odm_phy_dbg_info  PhyDbgInfo;
 721         /* PHY_INFO_88E         PhyInfo; */
 722
 723         /*  Latest packet phy info (ODM write) */
 724         /* MAC_INFO_88E         MacInfo; */
 725
 726         /*  Different Team independt structure?? */
 727
 728         /*  */
 729         /* TX_RTP_CMN           TX_retrpo; */
 730         /* TX_RTP_88E           TX_retrpo; */
 731         /* TX_RTP_8195          TX_retrpo; */
 732
 733         /*  */
 734         /* ODM Structure */
 735         /*  */
 736         struct odm_fat_t                DM_FatTable;
 737         struct dig_t    DM_DigTable;
 738         struct dynamic_pwr_sav          DM_PSTable;
 739         struct pri_cca  DM_PriCCA;
 740         struct rx_hp            DM_RXHP_Table;
 741         struct false_alarm_stats        FalseAlmCnt;
 742         struct false_alarm_stats        FlaseAlmCntBuddyAdapter;
 743         struct sw_ant_sw                DM_SWAT_Table;
 744         bool            RSSI_test;
 745
 746         struct edca_turbo               DM_EDCA_Table;
 747         u32             WMMEDCA_BE;
 748         /*  Copy from SD4 structure */
 749         /*  */
 750         /*  ================================================== */
 751         /*  */
 752
 753         /* PSD */
 754         bool                    bUserAssignLevel;
 755         u8                      RSSI_BT;                        /* come from BT */
 756         bool                    bPSDinProcess;
 757
 758         /* for rate adaptive, in fact,  88c/92c fw will handle this */
 759         u8                      bUseRAMask;
 760
 761         struct odm_rate_adapt   RateAdaptive;
 762
 763
 764         struct odm_rf_cal_t     RFCalibrateInfo;
 765
 766         /*  */
 767         /*  TX power tracking */
 768         /*  */
 769         u8                      BbSwingIdxOfdm;
 770         u8                      BbSwingIdxOfdmCurrent;
 771         u8                      BbSwingIdxOfdmBase;
 772         bool                    BbSwingFlagOfdm;
 773         u8                      BbSwingIdxCck;
 774         u8                      BbSwingIdxCckCurrent;
 775         u8                      BbSwingIdxCckBase;
 776         bool                    BbSwingFlagCck;
 777         /*  */
 778         /*  ODM system resource. */
 779         /*  */
 780 };      /*  DM_Dynamic_Mechanism_Structure */
 781
 782 enum odm_rf_content {
 783         odm_radioa_txt = 0x1000,
 784         odm_radiob_txt = 0x1001,
 785         odm_radioc_txt = 0x1002,
 786         odm_radiod_txt = 0x1003
 787 };
 788
 789 /*  Status code */
 790 enum rt_status {
 791         RT_STATUS_SUCCESS,
 792         RT_STATUS_FAILURE,
 793         RT_STATUS_PENDING,
 794         RT_STATUS_RESOURCE,
 795         RT_STATUS_INVALID_CONTEXT,
 796         RT_STATUS_INVALID_PARAMETER,
 797         RT_STATUS_NOT_SUPPORT,
 798         RT_STATUS_OS_API_FAILED,
 799 };
 800
 801 /* include "odm_function.h" */
 802
 803 /* 3=========================================================== */
 804 /* 3 DIG */
 805 /* 3=========================================================== */
 806
 807 enum dm_dig_op {
 808         DIG_TYPE_THRESH_HIGH    = 0,
 809         DIG_TYPE_THRESH_LOW     = 1,
 810         DIG_TYPE_BACKOFF                = 2,
 811         DIG_TYPE_RX_GAIN_MIN    = 3,
 812         DIG_TYPE_RX_GAIN_MAX    = 4,
 813         DIG_TYPE_ENABLE                 = 5,
 814         DIG_TYPE_DISABLE                = 6,
 815         DIG_OP_TYPE_MAX
 816 };
 817
 818 #define         DM_DIG_THRESH_HIGH                      40
 819 #define         DM_DIG_THRESH_LOW                       35
 820
 821 #define         DM_SCAN_RSSI_TH                         0x14 /* scan return issue for LC */
 822
 823
 824 #define         DM_FALSEALARM_THRESH_LOW        400
 825 #define         DM_FALSEALARM_THRESH_HIGH       1000
 826
 827 #define         DM_DIG_MAX_NIC                          0x4e
 828 #define         DM_DIG_MIN_NIC                          0x1e
 829
 830 #define         DM_DIG_MAX_AP                           0x32
 831 #define         DM_DIG_MIN_AP                           0x20
 832
 833 #define         DM_DIG_MAX_NIC_HP                       0x46
 834 #define         DM_DIG_MIN_NIC_HP                       0x2e
 835
 836 #define         DM_DIG_MAX_AP_HP                                0x42
 837 #define         DM_DIG_MIN_AP_HP                                0x30
 838
 839 /* vivi 92c&92d has different definition, 20110504 */
 840 /* this is for 92c */
 841 #define         DM_DIG_FA_TH0                           0x200
 842 #define         DM_DIG_FA_TH1                           0x300
 843 #define         DM_DIG_FA_TH2                           0x400
 844 /* this is for 92d */
 845 #define         DM_DIG_FA_TH0_92D                       0x100
 846 #define         DM_DIG_FA_TH1_92D                       0x400
 847 #define         DM_DIG_FA_TH2_92D                       0x600
 848
 849 #define         DM_DIG_BACKOFF_MAX                      12
 850 #define         DM_DIG_BACKOFF_MIN                      -4
 851 #define         DM_DIG_BACKOFF_DEFAULT          10
 852
 853 /* 3=========================================================== */
 854 /* 3 AGC RX High Power Mode */
 855 /* 3=========================================================== */
 856 #define          LNA_Low_Gain_1                      0x64
 857 #define          LNA_Low_Gain_2                      0x5A
 858 #define          LNA_Low_Gain_3                      0x58
 859
 860 #define          FA_RXHP_TH1                           5000
 861 #define          FA_RXHP_TH2                           1500
 862 #define          FA_RXHP_TH3                             800
 863 #define          FA_RXHP_TH4                             600
 864 #define          FA_RXHP_TH5                             500
 865
 866 /* 3=========================================================== */
 867 /* 3 EDCA */
 868 /* 3=========================================================== */
 869
 870 /* 3=========================================================== */
 871 /* 3 Dynamic Tx Power */
 872 /* 3=========================================================== */
 873 /* Dynamic Tx Power Control Threshold */
 874 #define         TX_POWER_NEAR_FIELD_THRESH_LVL2 74
 875 #define         TX_POWER_NEAR_FIELD_THRESH_LVL1 67
 876 #define         TX_POWER_NEAR_FIELD_THRESH_AP           0x3F
 877
 878 #define         TxHighPwrLevel_Normal           0
 879 #define         TxHighPwrLevel_Level1           1
 880 #define         TxHighPwrLevel_Level2           2
 881 #define         TxHighPwrLevel_BT1                      3
 882 #define         TxHighPwrLevel_BT2                      4
 883 #define         TxHighPwrLevel_15                       5
 884 #define         TxHighPwrLevel_35                       6
 885 #define         TxHighPwrLevel_50                       7
 886 #define         TxHighPwrLevel_70                       8
 887 #define         TxHighPwrLevel_100                      9
 888
 889 /* 3=========================================================== */
 890 /* 3 Rate Adaptive */
 891 /* 3=========================================================== */
 892 #define         DM_RATR_STA_INIT                        0
 893 #define         DM_RATR_STA_HIGH                        1
 894 #define                 DM_RATR_STA_MIDDLE              2
 895 #define                 DM_RATR_STA_LOW                 3
 896
 897 /* 3=========================================================== */
 898 /* 3 BB Power Save */
 899 /* 3=========================================================== */
 900
 901
 902 enum dm_1r_cca {
 903         CCA_1R =0,
 904         CCA_2R = 1,
 905         CCA_MAX = 2,
 906 };
 907
 908 enum dm_rf_def {
 909         RF_Save =0,
 910         RF_Normal = 1,
 911         RF_MAX = 2,
 912 };
 913
 914 /* 3=========================================================== */
 915 /* 3 Antenna Diversity */
 916 /* 3=========================================================== */
 917 enum dm_swas {
 918         Antenna_A = 1,
 919         Antenna_B = 2,
 920         Antenna_MAX = 3,
 921 };
 922
 923 /*  Maximal number of antenna detection mechanism needs to perform, added by Roger, 2011.12.28. */
 924 #define MAX_ANTENNA_DETECTION_CNT       10
 925
 926 /*  */
 927 /*  Extern Global Variables. */
 928 /*  */
 929 #define OFDM_TABLE_SIZE_92C     37
 930 #define OFDM_TABLE_SIZE_92D     43
 931 #define CCK_TABLE_SIZE          33
 932
 933 extern  u32 OFDMSwingTable23A[OFDM_TABLE_SIZE_92D];
 934 extern  u8 CCKSwingTable_Ch1_Ch1323A[CCK_TABLE_SIZE][8];
 935 extern  u8 CCKSwingTable_Ch1423A [CCK_TABLE_SIZE][8];
 936
 937
 938
 939 /*  20100514 Joseph: Add definition for antenna switching test after link. */
 940 /*  This indicates two different the steps. */
 941 /*  In SWAW_STEP_PEAK, driver needs to switch antenna and listen to the signal on the air. */
 942 /*  In SWAW_STEP_DETERMINE, driver just compares the signal captured in SWAW_STEP_PEAK */
 943 /*  with original RSSI to determine if it is necessary to switch antenna. */
 944 #define SWAW_STEP_PEAK          0
 945 #define SWAW_STEP_DETERMINE     1
 946
 947 struct hal_data_8723a;
 948
 949 void ODM_Write_DIG23a(struct dm_odm_t *pDM_Odm, u8      CurrentIGI);
 950 void ODM_Write_CCK_CCA_Thres23a(struct dm_odm_t *pDM_Odm, u8    CurCCK_CCAThres);
 951
 952 void ODM_SetAntenna(struct dm_odm_t *pDM_Odm, u8 Antenna);
 953
 954
 955 #define dm_RF_Saving    ODM_RF_Saving23a
 956 void ODM_RF_Saving23a(struct dm_odm_t *pDM_Odm, u8 bForceInNormal);
 957
 958 #define SwAntDivRestAfterLink   ODM_SwAntDivRestAfterLink
 959 void ODM_SwAntDivRestAfterLink(struct dm_odm_t *pDM_Odm);
 960
 961 #define dm_CheckTXPowerTracking         ODM_TXPowerTrackingCheck23a
 962 void ODM_TXPowerTrackingCheck23a(struct dm_odm_t *pDM_Odm);
 963
 964 bool ODM_RAStateCheck23a(struct dm_odm_t *pDM_Odm, s32 RSSI, bool bForceUpdate,
 965                       u8 *pRATRState);
 966
 967
 968 #define dm_SWAW_RSSI_Check      ODM_SwAntDivChkPerPktRssi
 969 void ODM_SwAntDivChkPerPktRssi(struct dm_odm_t *pDM_Odm, u8 StationID,
 970                                struct phy_info *pPhyInfo);
 971
 972 u32 ConvertTo_dB23a(u32 Value);
 973
 974 u32 GetPSDData(struct dm_odm_t *pDM_Odm, unsigned int point, u8 initial_gain_psd);
 975
 976 void odm_DIG23abyRSSI_LPS(struct dm_odm_t *pDM_Odm);
 977
 978 u32 ODM_Get_Rate_Bitmap23a(struct hal_data_8723a *pHalData, u32 macid, u32 ra_mask, u8 rssi_level);
 979
 980
 981 void ODM23a_DMInit(struct dm_odm_t *pDM_Odm);
 982
 983 void ODM_DMWatchdog23a(struct rtw_adapter *adapter);
 984
 985 void ODM_CmnInfoInit23a(struct dm_odm_t *pDM_Odm, enum odm_cmninfo      CmnInfo, u32 Value);
 986
 987 void ODM23a_CmnInfoHook(struct dm_odm_t *pDM_Odm, enum odm_cmninfo      CmnInfo, void *pValue);
 988
 989 void ODM_CmnInfoPtrArrayHook23a(struct dm_odm_t *pDM_Odm, enum odm_cmninfo      CmnInfo, u16 Index, void *pValue);
 990
 991 void ODM_CmnInfoUpdate23a(struct dm_odm_t *pDM_Odm, u32 CmnInfo, u64 Value);
 992
 993 void ODM_ResetIQKResult(struct dm_odm_t *pDM_Odm);
 994
 995 void ODM_AntselStatistics_88C(struct dm_odm_t *pDM_Odm, u8 MacId, u32 PWDBAll, bool isCCKrate);
 996
 997 void ODM_SingleDualAntennaDefaultSetting(struct dm_odm_t *pDM_Odm);
 998
 999 bool ODM_SingleDualAntennaDetection(struct dm_odm_t *pDM_Odm, u8 mode);
1000
1001 void odm_dtc(struct dm_odm_t *pDM_Odm);
1002
1003 #endif