drivers/net/wireless/rockchip_wlan/rtl8723bu/include/rtw_efuse.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 __RTW_EFUSE_H__
  21 #define __RTW_EFUSE_H__
  22
  23
  24 #define EFUSE_ERROE_HANDLE              1
  25
  26 #define PG_STATE_HEADER                 0x01
  27 #define PG_STATE_WORD_0         0x02
  28 #define PG_STATE_WORD_1         0x04
  29 #define PG_STATE_WORD_2         0x08
  30 #define PG_STATE_WORD_3         0x10
  31 #define PG_STATE_DATA                   0x20
  32
  33 #define PG_SWBYTE_H                     0x01
  34 #define PG_SWBYTE_L                     0x02
  35
  36 #define PGPKT_DATA_SIZE         8
  37
  38 #define EFUSE_WIFI                              0
  39 #define EFUSE_BT                                1
  40
  41 enum _EFUSE_DEF_TYPE {
  42         TYPE_EFUSE_MAX_SECTION                          = 0,
  43         TYPE_EFUSE_REAL_CONTENT_LEN                     = 1,
  44         TYPE_AVAILABLE_EFUSE_BYTES_BANK         = 2,
  45         TYPE_AVAILABLE_EFUSE_BYTES_TOTAL        = 3,
  46         TYPE_EFUSE_MAP_LEN                                      = 4,
  47         TYPE_EFUSE_PROTECT_BYTES_BANK           = 5,
  48         TYPE_EFUSE_CONTENT_LEN_BANK                     = 6,
  49 };
  50
  51 #define         EFUSE_MAX_MAP_LEN               512
  52
  53 #define         EFUSE_MAX_HW_SIZE               512
  54 #define         EFUSE_MAX_SECTION_BASE  16
  55
  56 #define EXT_HEADER(header) ((header & 0x1F ) == 0x0F)
  57 #define ALL_WORDS_DISABLED(wde) ((wde & 0x0F) == 0x0F)
  58 #define GET_HDR_OFFSET_2_0(header) ( (header & 0xE0) >> 5)
  59
  60 #define         EFUSE_REPEAT_THRESHOLD_                 3
  61
  62 #define IS_MASKED_MP(ic, txt, offset) (EFUSE_IsAddressMasked_MP_##ic##txt(offset))
  63 #define IS_MASKED_TC(ic, txt, offset) (EFUSE_IsAddressMasked_TC_##ic##txt(offset))
  64 #define GET_MASK_ARRAY_LEN_MP(ic, txt) (EFUSE_GetArrayLen_MP_##ic##txt())
  65 #define GET_MASK_ARRAY_LEN_TC(ic, txt) (EFUSE_GetArrayLen_TC_##ic##txt())
  66 #define GET_MASK_ARRAY_MP(ic, txt, offset) (EFUSE_GetMaskArray_MP_##ic##txt(offset))
  67 #define GET_MASK_ARRAY_TC(ic, txt, offset) (EFUSE_GetMaskArray_TC_##ic##txt(offset))
  68
  69
  70 #define IS_MASKED(ic, txt, offset) ( IS_MASKED_MP(ic,txt, offset) )
  71 #define GET_MASK_ARRAY_LEN(ic, txt) ( GET_MASK_ARRAY_LEN_MP(ic,txt) )
  72 #define GET_MASK_ARRAY(ic, txt, out) do { GET_MASK_ARRAY_MP(ic,txt, out);} while(0)
  73
  74 //=============================================
  75 //      The following is for BT Efuse definition
  76 //=============================================
  77 #define         EFUSE_BT_MAX_MAP_LEN            1024
  78 #define         EFUSE_MAX_BANK                  4
  79 #define         EFUSE_MAX_BT_BANK               (EFUSE_MAX_BANK-1)
  80 //=============================================
  81 /*--------------------------Define Parameters-------------------------------*/
  82 #define         EFUSE_MAX_WORD_UNIT                     4
  83
  84 /*------------------------------Define structure----------------------------*/
  85 typedef struct PG_PKT_STRUCT_A{
  86         u8 offset;
  87         u8 word_en;
  88         u8 data[8];
  89         u8 word_cnts;
  90 }PGPKT_STRUCT,*PPGPKT_STRUCT;
  91
  92 typedef enum
  93 {
  94         ERR_SUCCESS = 0,
  95         ERR_DRIVER_FAILURE,
  96         ERR_IO_FAILURE,
  97         ERR_WI_TIMEOUT,
  98         ERR_WI_BUSY,
  99         ERR_BAD_FORMAT,
 100         ERR_INVALID_DATA,
 101         ERR_NOT_ENOUGH_SPACE,
 102         ERR_WRITE_PROTECT,
 103         ERR_READ_BACK_FAIL,
 104         ERR_OUT_OF_RANGE
 105 } ERROR_CODE;
 106
 107 /*------------------------------Define structure----------------------------*/
 108 typedef struct _EFUSE_HAL{
 109         u8      fakeEfuseBank;
 110         u32     fakeEfuseUsedBytes;
 111         u8      fakeEfuseContent[EFUSE_MAX_HW_SIZE];
 112         u8      fakeEfuseInitMap[EFUSE_MAX_MAP_LEN];
 113         u8      fakeEfuseModifiedMap[EFUSE_MAX_MAP_LEN];
 114         u32     EfuseUsedBytes;
 115         u8      EfuseUsedPercentage;
 116
 117         u16     BTEfuseUsedBytes;
 118         u8      BTEfuseUsedPercentage;
 119         u8      BTEfuseContent[EFUSE_MAX_BT_BANK][EFUSE_MAX_HW_SIZE];
 120         u8      BTEfuseInitMap[EFUSE_BT_MAX_MAP_LEN];
 121         u8      BTEfuseModifiedMap[EFUSE_BT_MAX_MAP_LEN];
 122
 123         u16     fakeBTEfuseUsedBytes;
 124         u8      fakeBTEfuseContent[EFUSE_MAX_BT_BANK][EFUSE_MAX_HW_SIZE];
 125         u8      fakeBTEfuseInitMap[EFUSE_BT_MAX_MAP_LEN];
 126         u8      fakeBTEfuseModifiedMap[EFUSE_BT_MAX_MAP_LEN];
 127
 128         // EFUSE Configuration, initialized in HAL_CmnInitPGData().
 129         const u16  MaxSecNum_WiFi;
 130         const u16  MaxSecNum_BT;
 131         const u16  WordUnit;
 132         const u16  PhysicalLen_WiFi;
 133         const u16  PhysicalLen_BT;
 134         const u16  LogicalLen_WiFi;
 135         const u16  LogicalLen_BT;
 136         const u16  BankSize;
 137         const u16  TotalBankNum;
 138         const u16  BankNum_WiFi;
 139         const u16  BankNum_BT;
 140         const u16  OOBProtectBytes;
 141         const u16  ProtectBytes;
 142         const u16  BankAvailBytes;
 143         const u16  TotalAvailBytes_WiFi;
 144         const u16  TotalAvailBytes_BT;
 145         const u16  HeaderRetry;
 146         const u16  DataRetry;
 147
 148         ERROR_CODE        Status;
 149
 150 }EFUSE_HAL, *PEFUSE_HAL;
 151
 152 extern u8 maskfileBuffer[32];
 153
 154 /*------------------------Export global variable----------------------------*/
 155 extern u8 fakeEfuseBank;
 156 extern u32 fakeEfuseUsedBytes;
 157 extern u8 fakeEfuseContent[];
 158 extern u8 fakeEfuseInitMap[];
 159 extern u8 fakeEfuseModifiedMap[];
 160
 161 extern u32 BTEfuseUsedBytes;
 162 extern u8 BTEfuseContent[EFUSE_MAX_BT_BANK][EFUSE_MAX_HW_SIZE];
 163 extern u8 BTEfuseInitMap[];
 164 extern u8 BTEfuseModifiedMap[];
 165
 166 extern u32 fakeBTEfuseUsedBytes;
 167 extern u8 fakeBTEfuseContent[EFUSE_MAX_BT_BANK][EFUSE_MAX_HW_SIZE];
 168 extern u8 fakeBTEfuseInitMap[];
 169 extern u8 fakeBTEfuseModifiedMap[];
 170 /*------------------------Export global variable----------------------------*/
 171
 172 u8      efuse_GetCurrentSize(PADAPTER padapter, u16 *size);
 173 u16     efuse_GetMaxSize(PADAPTER padapter);
 174 u8      rtw_efuse_access(PADAPTER padapter, u8 bRead, u16 start_addr, u16 cnts, u8 *data);
 175 u8      rtw_efuse_mask_map_read(PADAPTER padapter, u16 addr, u16 cnts, u8 *data);
 176 u8      rtw_efuse_map_read(PADAPTER padapter, u16 addr, u16 cnts, u8 *data);
 177 u8      rtw_efuse_map_write(PADAPTER padapter, u16 addr, u16 cnts, u8 *data);
 178 u8      rtw_BT_efuse_map_read(PADAPTER padapter, u16 addr, u16 cnts, u8 *data);
 179 u8      rtw_BT_efuse_map_write(PADAPTER padapter, u16 addr, u16 cnts, u8 *data);
 180
 181 u16     Efuse_GetCurrentSize(PADAPTER pAdapter, u8 efuseType, BOOLEAN bPseudoTest);
 182 u8      Efuse_CalculateWordCnts(u8 word_en);
 183 void    ReadEFuseByte(PADAPTER Adapter, u16 _offset, u8 *pbuf, BOOLEAN bPseudoTest) ;
 184 void    EFUSE_GetEfuseDefinition(PADAPTER pAdapter, u8 efuseType, u8 type, void *pOut, BOOLEAN bPseudoTest);
 185 u8      efuse_OneByteRead(PADAPTER pAdapter, u16 addr, u8 *data, BOOLEAN         bPseudoTest);
 186 u8      efuse_OneByteWrite(PADAPTER pAdapter, u16 addr, u8 data, BOOLEAN         bPseudoTest);
 187
 188 void    BTEfuse_PowerSwitch(PADAPTER pAdapter,u8        bWrite,u8        PwrState);
 189 void    Efuse_PowerSwitch(PADAPTER pAdapter,u8  bWrite,u8        PwrState);
 190 int     Efuse_PgPacketRead(PADAPTER pAdapter, u8 offset, u8 *data, BOOLEAN bPseudoTest);
 191 int     Efuse_PgPacketWrite(PADAPTER pAdapter, u8 offset, u8 word_en, u8 *data, BOOLEAN bPseudoTest);
 192 void    efuse_WordEnableDataRead(u8 word_en, u8 *sourdata, u8 *targetdata);
 193 u8      Efuse_WordEnableDataWrite(PADAPTER pAdapter, u16 efuse_addr, u8 word_en, u8 *data, BOOLEAN bPseudoTest);
 194
 195 u8      EFUSE_Read1Byte(PADAPTER pAdapter, u16 Address);
 196 void    EFUSE_ShadowMapUpdate(PADAPTER pAdapter, u8 efuseType, BOOLEAN bPseudoTest);
 197 void    EFUSE_ShadowRead(PADAPTER pAdapter, u8 Type, u16 Offset, u32 *Value);
 198 void Rtw_Hal_ReadMACAddrFromFile(PADAPTER padapter);
 199 u32 Rtw_Hal_readPGDataFromConfigFile(PADAPTER   padapter);
 200 u8 rtw_efuse_file_read(PADAPTER padapter,u8 *filepatch,u8 *buf, u32 len);
 201
 202 #endif
 203