drivers/staging/rtl8188eu/include/Hal8188EPhyCfg.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  * 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  *
  19  ******************************************************************************/
  20 #ifndef __INC_HAL8188EPHYCFG_H__
  21 #define __INC_HAL8188EPHYCFG_H__
  22
  23
  24 /*--------------------------Define Parameters-------------------------------*/
  25 #define LOOP_LIMIT                      5
  26 #define MAX_STALL_TIME                  50              /* us */
  27 #define AntennaDiversityValue           0x80
  28 #define MAX_TXPWR_IDX_NMODE_92S         63
  29 #define Reset_Cnt_Limit                 3
  30
  31 #define IQK_MAC_REG_NUM                 4
  32 #define IQK_ADDA_REG_NUM                16
  33 #define IQK_BB_REG_NUM                  9
  34 #define HP_THERMAL_NUM                  8
  35
  36 #define MAX_AGGR_NUM                    0x07
  37
  38
  39 /*--------------------------Define Parameters-------------------------------*/
  40
  41
  42 /*------------------------------Define structure----------------------------*/
  43 enum sw_chnl_cmd_id {
  44         CmdID_End,
  45         CmdID_SetTxPowerLevel,
  46         CmdID_BBRegWrite10,
  47         CmdID_WritePortUlong,
  48         CmdID_WritePortUshort,
  49         CmdID_WritePortUchar,
  50         CmdID_RF_WriteReg,
  51 };
  52
  53 /* 1. Switch channel related */
  54 struct sw_chnl_cmd {
  55         enum sw_chnl_cmd_id CmdID;
  56         u32 Para1;
  57         u32 Para2;
  58         u32 msDelay;
  59 };
  60
  61 enum hw90_block {
  62         HW90_BLOCK_MAC = 0,
  63         HW90_BLOCK_PHY0 = 1,
  64         HW90_BLOCK_PHY1 = 2,
  65         HW90_BLOCK_RF = 3,
  66         HW90_BLOCK_MAXIMUM = 4, /*  Never use this */
  67 };
  68
  69 enum rf_radio_path {
  70         RF_PATH_A = 0,                  /* Radio Path A */
  71         RF_PATH_B = 1,                  /* Radio Path B */
  72 };
  73
  74 #define MAX_PG_GROUP 13
  75
  76 #define RF_PATH_MAX                     2
  77 #define         MAX_RF_PATH             RF_PATH_MAX
  78 #define         MAX_TX_COUNT            4 /* path numbers */
  79
  80 #define CHANNEL_MAX_NUMBER              14      /*  14 is the max chnl number */
  81 #define MAX_CHNL_GROUP_24G              6       /*  ch1~2, ch3~5, ch6~8,
  82                                                  *ch9~11, ch12~13, CH 14
  83                                                  * total three groups */
  84 #define CHANNEL_GROUP_MAX_88E           6
  85
  86 enum wireless_mode {
  87         WIRELESS_MODE_UNKNOWN = 0x00,
  88         WIRELESS_MODE_A                 = BIT(2),
  89         WIRELESS_MODE_B                 = BIT(0),
  90         WIRELESS_MODE_G                 = BIT(1),
  91         WIRELESS_MODE_AUTO              = BIT(5),
  92         WIRELESS_MODE_N_24G             = BIT(3),
  93         WIRELESS_MODE_N_5G              = BIT(4),
  94         WIRELESS_MODE_AC                = BIT(6)
  95 };
  96
  97 enum phy_rate_tx_offset_area {
  98         RA_OFFSET_LEGACY_OFDM1,
  99         RA_OFFSET_LEGACY_OFDM2,
 100         RA_OFFSET_HT_OFDM1,
 101         RA_OFFSET_HT_OFDM2,
 102         RA_OFFSET_HT_OFDM3,
 103         RA_OFFSET_HT_OFDM4,
 104         RA_OFFSET_HT_CCK,
 105 };
 106
 107 /* BB/RF related */
 108 enum RF_TYPE_8190P {
 109         RF_TYPE_MIN,            /*  0 */
 110         RF_8225 = 1,            /*  1 11b/g RF for verification only */
 111         RF_8256 = 2,            /*  2 11b/g/n */
 112         RF_8258 = 3,            /*  3 11a/b/g/n RF */
 113         RF_6052 = 4,            /*  4 11b/g/n RF */
 114         /*  TODO: We should remove this psudo PHY RF after we get new RF. */
 115         RF_PSEUDO_11N = 5,      /*  5, It is a temporality RF. */
 116 };
 117
 118 struct bb_reg_def {
 119         u32 rfintfs;            /*  set software control: */
 120                                 /*      0x870~0x877[8 bytes] */
 121         u32 rfintfi;            /*  readback data: */
 122                                 /*      0x8e0~0x8e7[8 bytes] */
 123         u32 rfintfo;            /*  output data: */
 124                                 /*      0x860~0x86f [16 bytes] */
 125         u32 rfintfe;            /*  output enable: */
 126                                 /*      0x860~0x86f [16 bytes] */
 127         u32 rf3wireOffset;      /*  LSSI data: */
 128                                 /*      0x840~0x84f [16 bytes] */
 129         u32 rfLSSI_Select;      /*  BB Band Select: */
 130                                 /*      0x878~0x87f [8 bytes] */
 131         u32 rfTxGainStage;      /*  Tx gain stage: */
 132                                 /*      0x80c~0x80f [4 bytes] */
 133         u32 rfHSSIPara1;        /*  wire parameter control1 : */
 134                                 /*      0x820~0x823,0x828~0x82b,
 135                                  *      0x830~0x833, 0x838~0x83b [16 bytes] */
 136         u32 rfHSSIPara2;        /*  wire parameter control2 : */
 137                                 /*      0x824~0x827,0x82c~0x82f, 0x834~0x837,
 138                                  *      0x83c~0x83f [16 bytes] */
 139         u32 rfSwitchControl;    /* Tx Rx antenna control : */
 140                                 /*      0x858~0x85f [16 bytes] */
 141         u32 rfAGCControl1;      /* AGC parameter control1 : */
 142                                 /*      0xc50~0xc53,0xc58~0xc5b, 0xc60~0xc63,
 143                                  * 0xc68~0xc6b [16 bytes] */
 144         u32 rfAGCControl2;      /* AGC parameter control2 : */
 145                                 /*      0xc54~0xc57,0xc5c~0xc5f, 0xc64~0xc67,
 146                                  *      0xc6c~0xc6f [16 bytes] */
 147         u32 rfRxIQImbalance;    /* OFDM Rx IQ imbalance matrix : */
 148                                 /*      0xc14~0xc17,0xc1c~0xc1f, 0xc24~0xc27,
 149                                  *      0xc2c~0xc2f [16 bytes] */
 150         u32 rfRxAFE;            /* Rx IQ DC ofset and Rx digital filter,
 151                                  * Rx DC notch filter : */
 152                                 /*      0xc10~0xc13,0xc18~0xc1b, 0xc20~0xc23,
 153                                  *      0xc28~0xc2b [16 bytes] */
 154         u32 rfTxIQImbalance;    /* OFDM Tx IQ imbalance matrix */
 155                                 /*      0xc80~0xc83,0xc88~0xc8b, 0xc90~0xc93,
 156                                  *       0xc98~0xc9b [16 bytes] */
 157         u32 rfTxAFE;            /* Tx IQ DC Offset and Tx DFIR type */
 158                                 /*      0xc84~0xc87,0xc8c~0xc8f, 0xc94~0xc97,
 159                                  *      0xc9c~0xc9f [16 bytes] */
 160         u32 rfLSSIReadBack;     /* LSSI RF readback data SI mode */
 161                                 /*      0x8a0~0x8af [16 bytes] */
 162         u32 rfLSSIReadBackPi;   /* LSSI RF readback data PI mode 0x8b8-8bc for
 163                                  * Path A and B */
 164 };
 165
 166 struct ant_sel_ofdm {
 167         u32 r_tx_antenna:4;
 168         u32 r_ant_l:4;
 169         u32 r_ant_non_ht:4;
 170         u32 r_ant_ht1:4;
 171         u32 r_ant_ht2:4;
 172         u32 r_ant_ht_s1:4;
 173         u32 r_ant_non_ht_s1:4;
 174         u32 OFDM_TXSC:2;
 175         u32 reserved:2;
 176 };
 177
 178 struct ant_sel_cck {
 179         u8 r_cckrx_enable_2:2;
 180         u8 r_cckrx_enable:2;
 181         u8 r_ccktx_enable:4;
 182 };
 183
 184 /*------------------------------Define structure----------------------------*/
 185
 186
 187 /*------------------------Export global variable----------------------------*/
 188 /*------------------------Export global variable----------------------------*/
 189
 190
 191 /*------------------------Export Marco Definition---------------------------*/
 192 /*------------------------Export Marco Definition---------------------------*/
 193
 194
 195 /*--------------------------Exported Function prototype---------------------*/
 196 /*  */
 197 /*  BB and RF register read/write */
 198 /*  */
 199
 200 /* Read initi reg value for tx power setting. */
 201 void rtl8192c_PHY_GetHWRegOriginalValue(struct adapter *adapter);
 202
 203 /*  BB TX Power R/W */
 204 void PHY_GetTxPowerLevel8188E(struct adapter *adapter, u32 *powerlevel);
 205
 206 void PHY_ScanOperationBackup8188E(struct adapter *Adapter, u8 Operation);
 207
 208 /*  Call after initialization */
 209 void ChkFwCmdIoDone(struct adapter *adapter);
 210
 211 /*  BB/MAC/RF other monitor API */
 212 void PHY_SetRFPathSwitch_8188E(struct adapter *adapter, bool main);
 213
 214 void PHY_SwitchEphyParameter(struct adapter *adapter);
 215
 216 void PHY_EnableHostClkReq(struct adapter *adapter);
 217
 218 bool SetAntennaConfig92C(struct adapter *adapter, u8 defaultant);
 219
 220 /*--------------------------Exported Function prototype---------------------*/
 221
 222 #define PHY_SetMacReg   PHY_SetBBReg
 223
 224 #define SIC_HW_SUPPORT                  0
 225
 226 #define SIC_MAX_POLL_CNT                5
 227
 228 #define SIC_CMD_READY                   0
 229 #define SIC_CMD_WRITE                   1
 230 #define SIC_CMD_READ                    2
 231
 232 #define SIC_CMD_REG                     0x1EB           /*  1byte */
 233 #define SIC_ADDR_REG                    0x1E8           /*  1b9~1ba, 2 bytes */
 234 #define SIC_DATA_REG                    0x1EC           /*  1bc~1bf */
 235
 236 #endif  /*  __INC_HAL8192CPHYCFG_H */