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