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