rtl8821ce/include/rtw_efuse.h

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2007 - 2017 Realtek Corporation.
   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 #ifndef __RTW_EFUSE_H__
  16 #define __RTW_EFUSE_H__
  17
  18
  19 #define EFUSE_ERROE_HANDLE              1
  20
  21 #define PG_STATE_HEADER         0x01
  22 #define PG_STATE_WORD_0         0x02
  23 #define PG_STATE_WORD_1         0x04
  24 #define PG_STATE_WORD_2         0x08
  25 #define PG_STATE_WORD_3         0x10
  26 #define PG_STATE_DATA                   0x20
  27
  28 #define PG_SWBYTE_H                     0x01
  29 #define PG_SWBYTE_L                     0x02
  30
  31 #define PGPKT_DATA_SIZE         8
  32
  33 #define EFUSE_WIFI                              0
  34 #define EFUSE_BT                                1
  35
  36 enum _EFUSE_DEF_TYPE {
  37         TYPE_EFUSE_MAX_SECTION                          = 0,
  38         TYPE_EFUSE_REAL_CONTENT_LEN                     = 1,
  39         TYPE_AVAILABLE_EFUSE_BYTES_BANK         = 2,
  40         TYPE_AVAILABLE_EFUSE_BYTES_TOTAL        = 3,
  41         TYPE_EFUSE_MAP_LEN                                      = 4,
  42         TYPE_EFUSE_PROTECT_BYTES_BANK           = 5,
  43         TYPE_EFUSE_CONTENT_LEN_BANK                     = 6,
  44 };
  45
  46 #define         EFUSE_MAX_MAP_LEN               1024
  47
  48 #define         EFUSE_MAX_HW_SIZE               1024
  49 #define         EFUSE_MAX_SECTION_BASE  16
  50 #define         EFUSE_MAX_SECTION_NUM   128
  51 #define         EFUSE_MAX_BANK_SIZE             512
  52
  53 /*RTL8822B 8821C BT EFUSE Define 1 BANK 128 size logical map 1024*/
  54 #ifdef RTW_HALMAC
  55 #define BANK_NUM                1
  56 #define EFUSE_BT_REAL_BANK_CONTENT_LEN  128
  57 #define EFUSE_BT_REAL_CONTENT_LEN               (EFUSE_BT_REAL_BANK_CONTENT_LEN * BANK_NUM)
  58 #define EFUSE_BT_MAP_LEN                                1024    /* 1k bytes */
  59 #define EFUSE_BT_MAX_SECTION                    (EFUSE_BT_MAP_LEN / 8)
  60 #define EFUSE_PROTECT_BYTES_BANK                16
  61 #define AVAILABLE_EFUSE_ADDR(addr)      (addr < EFUSE_BT_REAL_CONTENT_LEN)
  62 #endif
  63
  64 #define EXT_HEADER(header) ((header & 0x1F) == 0x0F)
  65 #define ALL_WORDS_DISABLED(wde) ((wde & 0x0F) == 0x0F)
  66 #define GET_HDR_OFFSET_2_0(header) ((header & 0xE0) >> 5)
  67
  68 #define         EFUSE_REPEAT_THRESHOLD_                 3
  69
  70 #define IS_MASKED_MP(ic, txt, offset) (EFUSE_IsAddressMasked_MP_##ic##txt(offset))
  71 #define IS_MASKED_TC(ic, txt, offset) (EFUSE_IsAddressMasked_TC_##ic##txt(offset))
  72 #define GET_MASK_ARRAY_LEN_MP(ic, txt) (EFUSE_GetArrayLen_MP_##ic##txt())
  73 #define GET_MASK_ARRAY_LEN_TC(ic, txt) (EFUSE_GetArrayLen_TC_##ic##txt())
  74 #define GET_MASK_ARRAY_MP(ic, txt, offset) (EFUSE_GetMaskArray_MP_##ic##txt(offset))
  75 #define GET_MASK_ARRAY_TC(ic, txt, offset) (EFUSE_GetMaskArray_TC_##ic##txt(offset))
  76
  77
  78 #define IS_MASKED(ic, txt, offset) (IS_MASKED_MP(ic, txt, offset))
  79 #define GET_MASK_ARRAY_LEN(ic, txt) (GET_MASK_ARRAY_LEN_MP(ic, txt))
  80 #define GET_MASK_ARRAY(ic, txt, out) do { GET_MASK_ARRAY_MP(ic, txt, out); } while (0)
  81
  82 /* *********************************************
  83  *      The following is for BT Efuse definition
  84  * ********************************************* */
  85 #define         EFUSE_BT_MAX_MAP_LEN            1024
  86 #define         EFUSE_MAX_BANK                  4
  87 #define         EFUSE_MAX_BT_BANK               (EFUSE_MAX_BANK-1)
  88 /* *********************************************
  89  *--------------------------Define Parameters-------------------------------*/
  90 #define         EFUSE_MAX_WORD_UNIT                     4
  91
  92 /*------------------------------Define structure----------------------------*/
  93 typedef struct PG_PKT_STRUCT_A {
  94         u8 offset;
  95         u8 word_en;
  96         u8 data[8];
  97         u8 word_cnts;
  98 } PGPKT_STRUCT, *PPGPKT_STRUCT;
  99
 100 typedef enum {
 101         ERR_SUCCESS = 0,
 102         ERR_DRIVER_FAILURE,
 103         ERR_IO_FAILURE,
 104         ERR_WI_TIMEOUT,
 105         ERR_WI_BUSY,
 106         ERR_BAD_FORMAT,
 107         ERR_INVALID_DATA,
 108         ERR_NOT_ENOUGH_SPACE,
 109         ERR_WRITE_PROTECT,
 110         ERR_READ_BACK_FAIL,
 111         ERR_OUT_OF_RANGE
 112 } ERROR_CODE;
 113
 114 /*------------------------------Define structure----------------------------*/
 115 typedef struct _EFUSE_HAL {
 116         u8      fakeEfuseBank;
 117         u32     fakeEfuseUsedBytes;
 118         u8      fakeEfuseContent[EFUSE_MAX_HW_SIZE];
 119         u8      fakeEfuseInitMap[EFUSE_MAX_MAP_LEN];
 120         u8      fakeEfuseModifiedMap[EFUSE_MAX_MAP_LEN];
 121         u32     EfuseUsedBytes;
 122         u8      EfuseUsedPercentage;
 123
 124         u16     BTEfuseUsedBytes;
 125         u8      BTEfuseUsedPercentage;
 126         u8      BTEfuseContent[EFUSE_MAX_BT_BANK][EFUSE_MAX_HW_SIZE];
 127         u8      BTEfuseInitMap[EFUSE_BT_MAX_MAP_LEN];
 128         u8      BTEfuseModifiedMap[EFUSE_BT_MAX_MAP_LEN];
 129
 130         u16     fakeBTEfuseUsedBytes;
 131         u8      fakeBTEfuseContent[EFUSE_MAX_BT_BANK][EFUSE_MAX_HW_SIZE];
 132         u8      fakeBTEfuseInitMap[EFUSE_BT_MAX_MAP_LEN];
 133         u8      fakeBTEfuseModifiedMap[EFUSE_BT_MAX_MAP_LEN];
 134
 135         /* EFUSE Configuration, initialized in HAL_CmnInitPGData(). */
 136         const u16  MaxSecNum_WiFi;
 137         const u16  MaxSecNum_BT;
 138         const u16  WordUnit;
 139         const u16  PhysicalLen_WiFi;
 140         const u16  PhysicalLen_BT;
 141         const u16  LogicalLen_WiFi;
 142         const u16  LogicalLen_BT;
 143         const u16  BankSize;
 144         const u16  TotalBankNum;
 145         const u16  BankNum_WiFi;
 146         const u16  BankNum_BT;
 147         const u16  OOBProtectBytes;
 148         const u16  ProtectBytes;
 149         const u16  BankAvailBytes;
 150         const u16  TotalAvailBytes_WiFi;
 151         const u16  TotalAvailBytes_BT;
 152         const u16  HeaderRetry;
 153         const u16  DataRetry;
 154
 155         ERROR_CODE        Status;
 156
 157 } EFUSE_HAL, *PEFUSE_HAL;
 158
 159 extern u8 maskfileBuffer[64];
 160
 161 /*------------------------Export global variable----------------------------*/
 162 extern u8 fakeEfuseBank;
 163 extern u32 fakeEfuseUsedBytes;
 164 extern u8 fakeEfuseContent[];
 165 extern u8 fakeEfuseInitMap[];
 166 extern u8 fakeEfuseModifiedMap[];
 167
 168 extern u32 BTEfuseUsedBytes;
 169 extern u8 BTEfuseContent[EFUSE_MAX_BT_BANK][EFUSE_MAX_HW_SIZE];
 170 extern u8 BTEfuseInitMap[];
 171 extern u8 BTEfuseModifiedMap[];
 172
 173 extern u32 fakeBTEfuseUsedBytes;
 174 extern u8 fakeBTEfuseContent[EFUSE_MAX_BT_BANK][EFUSE_MAX_HW_SIZE];
 175 extern u8 fakeBTEfuseInitMap[];
 176 extern u8 fakeBTEfuseModifiedMap[];
 177 /*------------------------Export global variable----------------------------*/
 178 #define         MAX_SEGMENT_SIZE                        200
 179 #define         MAX_SEGMENT_NUM                 200
 180 #define         MAX_BUF_SIZE                            (MAX_SEGMENT_SIZE*MAX_SEGMENT_NUM)
 181 #define         TMP_BUF_SIZE                            100
 182 #define         rtprintf                                        dcmd_Store_Return_Buf
 183
 184 u8      efuse_bt_GetCurrentSize(PADAPTER padapter, u16 *size);
 185 u16     efuse_bt_GetMaxSize(PADAPTER padapter);
 186 u16 efuse_GetavailableSize(PADAPTER adapter);
 187
 188 u8      efuse_GetCurrentSize(PADAPTER padapter, u16 *size);
 189 u16     efuse_GetMaxSize(PADAPTER padapter);
 190 u8      rtw_efuse_access(PADAPTER padapter, u8 bRead, u16 start_addr, u16 cnts, u8 *data);
 191 u8      rtw_efuse_bt_access(PADAPTER adapter, u8 write, u16 addr, u16 cnts, u8 *data);
 192
 193 u8      rtw_efuse_mask_map_read(PADAPTER padapter, u16 addr, u16 cnts, u8 *data);
 194 u8      rtw_efuse_map_read(PADAPTER padapter, u16 addr, u16 cnts, u8 *data);
 195 u8      rtw_efuse_map_write(PADAPTER padapter, u16 addr, u16 cnts, u8 *data);
 196 u8      rtw_BT_efuse_map_read(PADAPTER padapter, u16 addr, u16 cnts, u8 *data);
 197 u8      rtw_BT_efuse_map_write(PADAPTER padapter, u16 addr, u16 cnts, u8 *data);
 198
 199 u16     Efuse_GetCurrentSize(PADAPTER pAdapter, u8 efuseType, BOOLEAN bPseudoTest);
 200 u8      Efuse_CalculateWordCnts(u8 word_en);
 201 void    ReadEFuseByte(PADAPTER Adapter, u16 _offset, u8 *pbuf, BOOLEAN bPseudoTest) ;
 202 void    EFUSE_GetEfuseDefinition(PADAPTER pAdapter, u8 efuseType, u8 type, void *pOut, BOOLEAN bPseudoTest);
 203 u8      efuse_OneByteRead(PADAPTER pAdapter, u16 addr, u8 *data, BOOLEAN         bPseudoTest);
 204 #define efuse_onebyte_read(adapter, addr, data, pseudo_test) efuse_OneByteRead((adapter), (addr), (data), (pseudo_test))
 205
 206 u8      efuse_OneByteWrite(PADAPTER pAdapter, u16 addr, u8 data, BOOLEAN         bPseudoTest);
 207
 208 void    BTEfuse_PowerSwitch(PADAPTER pAdapter, u8       bWrite, u8       PwrState);
 209 void    Efuse_PowerSwitch(PADAPTER pAdapter, u8 bWrite, u8       PwrState);
 210 int     Efuse_PgPacketRead(PADAPTER pAdapter, u8 offset, u8 *data, BOOLEAN bPseudoTest);
 211 int     Efuse_PgPacketWrite(PADAPTER pAdapter, u8 offset, u8 word_en, u8 *data, BOOLEAN bPseudoTest);
 212 void    efuse_WordEnableDataRead(u8 word_en, u8 *sourdata, u8 *targetdata);
 213 u8      Efuse_WordEnableDataWrite(PADAPTER pAdapter, u16 efuse_addr, u8 word_en, u8 *data, BOOLEAN bPseudoTest);
 214 void    EFUSE_ShadowMapUpdate(PADAPTER pAdapter, u8 efuseType, BOOLEAN bPseudoTest);
 215 void    EFUSE_ShadowRead(PADAPTER pAdapter, u8 Type, u16 Offset, u32 *Value);
 216 #define efuse_logical_map_read(adapter, type, offset, value) EFUSE_ShadowRead((adapter), (type), (offset), (value))
 217
 218 BOOLEAN rtw_file_efuse_IsMasked(PADAPTER pAdapter, u16 Offset);
 219 BOOLEAN efuse_IsMasked(PADAPTER pAdapter, u16 Offset);
 220
 221 VOID    hal_ReadEFuse_BT_logic_map(
 222         PADAPTER        padapter,
 223         u16                     _offset,
 224         u16                     _size_byte,
 225         u8                      *pbuf
 226 );
 227 u8      EfusePgPacketWrite_BT(
 228         PADAPTER        pAdapter,
 229         u8                      offset,
 230         u8                      word_en,
 231         u8                      *pData,
 232         u8                      bPseudoTest);
 233 u16 rtw_get_efuse_mask_arraylen(PADAPTER pAdapter);
 234 void rtw_efuse_mask_array(PADAPTER pAdapter, u8 *pArray);
 235 void rtw_efuse_analyze(PADAPTER padapter, u8 Type, u8 Fake);
 236
 237 #define MAC_HIDDEN_MAX_BW_NUM 8
 238 extern const u8 _mac_hidden_max_bw_to_hal_bw_cap[];
 239 #define mac_hidden_max_bw_to_hal_bw_cap(max_bw) (((max_bw) >= MAC_HIDDEN_MAX_BW_NUM) ? 0 : _mac_hidden_max_bw_to_hal_bw_cap[(max_bw)])
 240
 241 #define MAC_HIDDEN_PROTOCOL_NUM 4
 242 extern const u8 _mac_hidden_proto_to_hal_proto_cap[];
 243 #define mac_hidden_proto_to_hal_proto_cap(proto) (((proto) >= MAC_HIDDEN_PROTOCOL_NUM) ? 0 : _mac_hidden_proto_to_hal_proto_cap[(proto)])
 244
 245 u8 mac_hidden_wl_func_to_hal_wl_func(u8 func);
 246
 247 #ifdef PLATFORM_LINUX
 248 u8 rtw_efuse_file_read(PADAPTER padapter, u8 *filepatch, u8 *buf, u32 len);
 249 #ifdef CONFIG_EFUSE_CONFIG_FILE
 250 u32 rtw_read_efuse_from_file(const char *path, u8 *buf, int map_size);
 251 u32 rtw_read_macaddr_from_file(const char *path, u8 *buf);
 252 #endif /* CONFIG_EFUSE_CONFIG_FILE */
 253 #endif /* PLATFORM_LINUX */
 254
 255 #endif