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