xref: /OK3568_Linux_fs/kernel/drivers/net/wireless/rockchip_wlan/rtl8723bs/include/hal_com.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
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 __HAL_COMMON_H__
16 #define __HAL_COMMON_H__
17 
18 #include "HalVerDef.h"
19 #include "hal_pg.h"
20 #include "hal_phy.h"
21 #include "hal_phy_reg.h"
22 #include "hal_com_reg.h"
23 #include "hal_com_phycfg.h"
24 #include "../hal/hal_com_c2h.h"
25 
26 /*------------------------------ Tx Desc definition Macro ------------------------*/
27 /* #pragma mark -- Tx Desc related definition. -- */
28 /* ----------------------------------------------------------------------------
29  * -----------------------------------------------------------
30  *	Rate
31  * -----------------------------------------------------------
32  * CCK Rates, TxHT = 0 */
33 #define DESC_RATE1M					0x00
34 #define DESC_RATE2M					0x01
35 #define DESC_RATE5_5M				0x02
36 #define DESC_RATE11M				0x03
37 
38 /* OFDM Rates, TxHT = 0 */
39 #define DESC_RATE6M					0x04
40 #define DESC_RATE9M					0x05
41 #define DESC_RATE12M				0x06
42 #define DESC_RATE18M				0x07
43 #define DESC_RATE24M				0x08
44 #define DESC_RATE36M				0x09
45 #define DESC_RATE48M				0x0a
46 #define DESC_RATE54M				0x0b
47 
48 /* MCS Rates, TxHT = 1 */
49 #define DESC_RATEMCS0				0x0c
50 #define DESC_RATEMCS1				0x0d
51 #define DESC_RATEMCS2				0x0e
52 #define DESC_RATEMCS3				0x0f
53 #define DESC_RATEMCS4				0x10
54 #define DESC_RATEMCS5				0x11
55 #define DESC_RATEMCS6				0x12
56 #define DESC_RATEMCS7				0x13
57 #define DESC_RATEMCS8				0x14
58 #define DESC_RATEMCS9				0x15
59 #define DESC_RATEMCS10				0x16
60 #define DESC_RATEMCS11				0x17
61 #define DESC_RATEMCS12				0x18
62 #define DESC_RATEMCS13				0x19
63 #define DESC_RATEMCS14				0x1a
64 #define DESC_RATEMCS15				0x1b
65 #define DESC_RATEMCS16				0x1C
66 #define DESC_RATEMCS17				0x1D
67 #define DESC_RATEMCS18				0x1E
68 #define DESC_RATEMCS19				0x1F
69 #define DESC_RATEMCS20				0x20
70 #define DESC_RATEMCS21				0x21
71 #define DESC_RATEMCS22				0x22
72 #define DESC_RATEMCS23				0x23
73 #define DESC_RATEMCS24				0x24
74 #define DESC_RATEMCS25				0x25
75 #define DESC_RATEMCS26				0x26
76 #define DESC_RATEMCS27				0x27
77 #define DESC_RATEMCS28				0x28
78 #define DESC_RATEMCS29				0x29
79 #define DESC_RATEMCS30				0x2A
80 #define DESC_RATEMCS31				0x2B
81 #define DESC_RATEVHTSS1MCS0		0x2C
82 #define DESC_RATEVHTSS1MCS1		0x2D
83 #define DESC_RATEVHTSS1MCS2		0x2E
84 #define DESC_RATEVHTSS1MCS3		0x2F
85 #define DESC_RATEVHTSS1MCS4		0x30
86 #define DESC_RATEVHTSS1MCS5		0x31
87 #define DESC_RATEVHTSS1MCS6		0x32
88 #define DESC_RATEVHTSS1MCS7		0x33
89 #define DESC_RATEVHTSS1MCS8		0x34
90 #define DESC_RATEVHTSS1MCS9		0x35
91 #define DESC_RATEVHTSS2MCS0		0x36
92 #define DESC_RATEVHTSS2MCS1		0x37
93 #define DESC_RATEVHTSS2MCS2		0x38
94 #define DESC_RATEVHTSS2MCS3		0x39
95 #define DESC_RATEVHTSS2MCS4		0x3A
96 #define DESC_RATEVHTSS2MCS5		0x3B
97 #define DESC_RATEVHTSS2MCS6		0x3C
98 #define DESC_RATEVHTSS2MCS7		0x3D
99 #define DESC_RATEVHTSS2MCS8		0x3E
100 #define DESC_RATEVHTSS2MCS9		0x3F
101 #define DESC_RATEVHTSS3MCS0		0x40
102 #define DESC_RATEVHTSS3MCS1		0x41
103 #define DESC_RATEVHTSS3MCS2		0x42
104 #define DESC_RATEVHTSS3MCS3		0x43
105 #define DESC_RATEVHTSS3MCS4		0x44
106 #define DESC_RATEVHTSS3MCS5		0x45
107 #define DESC_RATEVHTSS3MCS6		0x46
108 #define DESC_RATEVHTSS3MCS7		0x47
109 #define DESC_RATEVHTSS3MCS8		0x48
110 #define DESC_RATEVHTSS3MCS9		0x49
111 #define DESC_RATEVHTSS4MCS0		0x4A
112 #define DESC_RATEVHTSS4MCS1		0x4B
113 #define DESC_RATEVHTSS4MCS2		0x4C
114 #define DESC_RATEVHTSS4MCS3		0x4D
115 #define DESC_RATEVHTSS4MCS4		0x4E
116 #define DESC_RATEVHTSS4MCS5		0x4F
117 #define DESC_RATEVHTSS4MCS6		0x50
118 #define DESC_RATEVHTSS4MCS7		0x51
119 #define DESC_RATEVHTSS4MCS8		0x52
120 #define DESC_RATEVHTSS4MCS9		0x53
121 
122 #define HDATA_RATE(rate)\
123 	(rate == DESC_RATE1M) ? "CCK_1M" :\
124 	(rate == DESC_RATE2M) ? "CCK_2M" :\
125 	(rate == DESC_RATE5_5M) ? "CCK5_5M" :\
126 	(rate == DESC_RATE11M) ? "CCK_11M" :\
127 	(rate == DESC_RATE6M) ? "OFDM_6M" :\
128 	(rate == DESC_RATE9M) ? "OFDM_9M" :\
129 	(rate == DESC_RATE12M) ? "OFDM_12M" :\
130 	(rate == DESC_RATE18M) ? "OFDM_18M" :\
131 	(rate == DESC_RATE24M) ? "OFDM_24M" :\
132 	(rate == DESC_RATE36M) ? "OFDM_36M" :\
133 	(rate == DESC_RATE48M) ? "OFDM_48M" :\
134 	(rate == DESC_RATE54M) ? "OFDM_54M" :\
135 	(rate == DESC_RATEMCS0) ? "MCS0" :\
136 	(rate == DESC_RATEMCS1) ? "MCS1" :\
137 	(rate == DESC_RATEMCS2) ? "MCS2" :\
138 	(rate == DESC_RATEMCS3) ? "MCS3" :\
139 	(rate == DESC_RATEMCS4) ? "MCS4" :\
140 	(rate == DESC_RATEMCS5) ? "MCS5" :\
141 	(rate == DESC_RATEMCS6) ? "MCS6" :\
142 	(rate == DESC_RATEMCS7) ? "MCS7" :\
143 	(rate == DESC_RATEMCS8) ? "MCS8" :\
144 	(rate == DESC_RATEMCS9) ? "MCS9" :\
145 	(rate == DESC_RATEMCS10) ? "MCS10" :\
146 	(rate == DESC_RATEMCS11) ? "MCS11" :\
147 	(rate == DESC_RATEMCS12) ? "MCS12" :\
148 	(rate == DESC_RATEMCS13) ? "MCS13" :\
149 	(rate == DESC_RATEMCS14) ? "MCS14" :\
150 	(rate == DESC_RATEMCS15) ? "MCS15" :\
151 	(rate == DESC_RATEMCS16) ? "MCS16" :\
152 	(rate == DESC_RATEMCS17) ? "MCS17" :\
153 	(rate == DESC_RATEMCS18) ? "MCS18" :\
154 	(rate == DESC_RATEMCS19) ? "MCS19" :\
155 	(rate == DESC_RATEMCS20) ? "MCS20" :\
156 	(rate == DESC_RATEMCS21) ? "MCS21" :\
157 	(rate == DESC_RATEMCS22) ? "MCS22" :\
158 	(rate == DESC_RATEMCS23) ? "MCS23" :\
159 	(rate == DESC_RATEVHTSS1MCS0) ? "VHTSS1MCS0" :\
160 	(rate == DESC_RATEVHTSS1MCS1) ? "VHTSS1MCS1" :\
161 	(rate == DESC_RATEVHTSS1MCS2) ? "VHTSS1MCS2" :\
162 	(rate == DESC_RATEVHTSS1MCS3) ? "VHTSS1MCS3" :\
163 	(rate == DESC_RATEVHTSS1MCS4) ? "VHTSS1MCS4" :\
164 	(rate == DESC_RATEVHTSS1MCS5) ? "VHTSS1MCS5" :\
165 	(rate == DESC_RATEVHTSS1MCS6) ? "VHTSS1MCS6" :\
166 	(rate == DESC_RATEVHTSS1MCS7) ? "VHTSS1MCS7" :\
167 	(rate == DESC_RATEVHTSS1MCS8) ? "VHTSS1MCS8" :\
168 	(rate == DESC_RATEVHTSS1MCS9) ? "VHTSS1MCS9" :\
169 	(rate == DESC_RATEVHTSS2MCS0) ? "VHTSS2MCS0" :\
170 	(rate == DESC_RATEVHTSS2MCS1) ? "VHTSS2MCS1" :\
171 	(rate == DESC_RATEVHTSS2MCS2) ? "VHTSS2MCS2" :\
172 	(rate == DESC_RATEVHTSS2MCS3) ? "VHTSS2MCS3" :\
173 	(rate == DESC_RATEVHTSS2MCS4) ? "VHTSS2MCS4" :\
174 	(rate == DESC_RATEVHTSS2MCS5) ? "VHTSS2MCS5" :\
175 	(rate == DESC_RATEVHTSS2MCS6) ? "VHTSS2MCS6" :\
176 	(rate == DESC_RATEVHTSS2MCS7) ? "VHTSS2MCS7" :\
177 	(rate == DESC_RATEVHTSS2MCS8) ? "VHTSS2MCS8" :\
178 	(rate == DESC_RATEVHTSS2MCS9) ? "VHTSS2MCS9" :\
179 	(rate == DESC_RATEVHTSS3MCS0) ? "VHTSS3MCS0" :\
180 	(rate == DESC_RATEVHTSS3MCS1) ? "VHTSS3MCS1" :\
181 	(rate == DESC_RATEVHTSS3MCS2) ? "VHTSS3MCS2" :\
182 	(rate == DESC_RATEVHTSS3MCS3) ? "VHTSS3MCS3" :\
183 	(rate == DESC_RATEVHTSS3MCS4) ? "VHTSS3MCS4" :\
184 	(rate == DESC_RATEVHTSS3MCS5) ? "VHTSS3MCS5" :\
185 	(rate == DESC_RATEVHTSS3MCS6) ? "VHTSS3MCS6" :\
186 	(rate == DESC_RATEVHTSS3MCS7) ? "VHTSS3MCS7" :\
187 	(rate == DESC_RATEVHTSS3MCS8) ? "VHTSS3MCS8" :\
188 	(rate == DESC_RATEVHTSS3MCS9) ? "VHTSS3MCS9" : "UNKNOWN"
189 
190 enum {
191 	UP_LINK,
192 	DOWN_LINK,
193 };
194 typedef enum _RT_MEDIA_STATUS {
195 	RT_MEDIA_DISCONNECT = 0,
196 	RT_MEDIA_CONNECT       = 1
197 } RT_MEDIA_STATUS;
198 
199 #define MAX_DLFW_PAGE_SIZE			4096	/* @ page : 4k bytes */
200 typedef enum _FIRMWARE_SOURCE {
201 	FW_SOURCE_IMG_FILE = 0,
202 	FW_SOURCE_HEADER_FILE = 1,		/* from header file */
203 } FIRMWARE_SOURCE, *PFIRMWARE_SOURCE;
204 
205 typedef enum _CH_SW_USE_CASE {
206 	CH_SW_USE_CASE_TDLS		= 0,
207 	CH_SW_USE_CASE_MCC		= 1
208 } CH_SW_USE_CASE;
209 
210 typedef enum _WAKEUP_REASON{
211 	RX_PAIRWISEKEY					= 0x01,
212 	RX_GTK							= 0x02,
213 	RX_FOURWAY_HANDSHAKE			= 0x03,
214 	RX_DISASSOC						= 0x04,
215 	RX_DEAUTH						= 0x08,
216 	RX_ARP_REQUEST					= 0x09,
217 	FW_DECISION_DISCONNECT			= 0x10,
218 	RX_MAGIC_PKT					= 0x21,
219 	RX_UNICAST_PKT					= 0x22,
220 	RX_PATTERN_PKT					= 0x23,
221 	RTD3_SSID_MATCH					= 0x24,
222 	RX_REALWOW_V2_WAKEUP_PKT		= 0x30,
223 	RX_REALWOW_V2_ACK_LOST			= 0x31,
224 	ENABLE_FAIL_DMA_IDLE			= 0x40,
225 	ENABLE_FAIL_DMA_PAUSE			= 0x41,
226 	RTIME_FAIL_DMA_IDLE				= 0x42,
227 	RTIME_FAIL_DMA_PAUSE			= 0x43,
228 	RX_PNO							= 0x55,
229 	AP_OFFLOAD_WAKEUP				= 0x66,
230 	CLK_32K_UNLOCK					= 0xFD,
231 	CLK_32K_LOCK					= 0xFE
232 }WAKEUP_REASON;
233 
234 /*
235  * Queue Select Value in TxDesc
236  *   */
237 #define QSLT_BK							0x2/* 0x01 */
238 #define QSLT_BE							0x0
239 #define QSLT_VI							0x5/* 0x4 */
240 #define QSLT_VO							0x7/* 0x6 */
241 #define QSLT_BEACON						0x10
242 #define QSLT_HIGH						0x11
243 #define QSLT_MGNT						0x12
244 #define QSLT_CMD						0x13
245 
246 /* BK, BE, VI, VO, HCCA, MANAGEMENT, COMMAND, HIGH, BEACON.
247  * #define MAX_TX_QUEUE		9 */
248 
249 #define TX_SELE_HQ			BIT(0)		/* High Queue */
250 #define TX_SELE_LQ			BIT(1)		/* Low Queue */
251 #define TX_SELE_NQ			BIT(2)		/* Normal Queue */
252 #define TX_SELE_EQ			BIT(3)		/* Extern Queue */
253 
254 #define PageNum_128(_Len)		(u32)(((_Len)>>7) + ((_Len) & 0x7F ? 1 : 0))
255 #define PageNum_256(_Len)		(u32)(((_Len)>>8) + ((_Len) & 0xFF ? 1 : 0))
256 #define PageNum_512(_Len)		(u32)(((_Len)>>9) + ((_Len) & 0x1FF ? 1 : 0))
257 #define PageNum(_Len, _Size)		(u32)(((_Len)/(_Size)) + ((_Len)&((_Size) - 1) ? 1 : 0))
258 
259 struct dbg_rx_counter {
260 	u32	rx_pkt_ok;
261 	u32	rx_pkt_crc_error;
262 	u32	rx_pkt_drop;
263 	u32	rx_ofdm_fa;
264 	u32	rx_cck_fa;
265 	u32	rx_ht_fa;
266 };
267 
268 #ifdef CONFIG_MBSSID_CAM
269 	#define DBG_MBID_CAM_DUMP
270 
271 	void rtw_mbid_cam_init(struct dvobj_priv *dvobj);
272 	void rtw_mbid_cam_deinit(struct dvobj_priv *dvobj);
273 	void rtw_mbid_cam_reset(_adapter *adapter);
274 	u8 rtw_get_max_mbid_cam_id(_adapter *adapter);
275 	u8 rtw_get_mbid_cam_entry_num(_adapter *adapter);
276 	int rtw_mbid_cam_cache_dump(void *sel, const char *fun_name , _adapter *adapter);
277 	int rtw_mbid_cam_dump(void *sel, const char *fun_name, _adapter *adapter);
278 	void rtw_mbid_cam_restore(_adapter *adapter);
279 #endif
280 
281 #ifdef CONFIG_MI_WITH_MBSSID_CAM
282 	void rtw_hal_set_macaddr_mbid(_adapter *adapter, u8 *mac_addr);
283 	void rtw_hal_change_macaddr_mbid(_adapter *adapter, u8 *mac_addr);
284 	#ifdef CONFIG_SWTIMER_BASED_TXBCN
285 	u16 rtw_hal_bcn_interval_adjust(_adapter *adapter, u16 bcn_interval);
286 	#endif
287 #endif
288 
289 void rtw_dump_mac_rx_counters(_adapter *padapter, struct dbg_rx_counter *rx_counter);
290 void rtw_dump_phy_rx_counters(_adapter *padapter, struct dbg_rx_counter *rx_counter);
291 void rtw_reset_mac_rx_counters(_adapter *padapter);
292 void rtw_reset_phy_rx_counters(_adapter *padapter);
293 void rtw_reset_phy_trx_ok_counters(_adapter *padapter);
294 
295 #ifdef DBG_RX_COUNTER_DUMP
296 	#define DUMP_DRV_RX_COUNTER	BIT0
297 	#define DUMP_MAC_RX_COUNTER	BIT1
298 	#define DUMP_PHY_RX_COUNTER	BIT2
299 	#define DUMP_DRV_TRX_COUNTER_DATA	BIT3
300 
301 	void rtw_dump_phy_rxcnts_preprocess(_adapter *padapter, u8 rx_cnt_mode);
302 	void rtw_dump_rx_counters(_adapter *padapter);
303 #endif
304 
305 void dump_chip_info(HAL_VERSION	ChipVersion);
306 void rtw_hal_config_rftype(PADAPTER  padapter);
307 
308 #define BAND_CAP_2G			BIT0
309 #define BAND_CAP_5G			BIT1
310 #define BAND_CAP_BIT_NUM	2
311 
312 #define BW_CAP_5M		BIT0
313 #define BW_CAP_10M		BIT1
314 #define BW_CAP_20M		BIT2
315 #define BW_CAP_40M		BIT3
316 #define BW_CAP_80M		BIT4
317 #define BW_CAP_160M		BIT5
318 #define BW_CAP_80_80M	BIT6
319 #define BW_CAP_BIT_NUM	7
320 
321 #define PROTO_CAP_11B		BIT0
322 #define PROTO_CAP_11G		BIT1
323 #define PROTO_CAP_11N		BIT2
324 #define PROTO_CAP_11AC		BIT3
325 #define PROTO_CAP_BIT_NUM	4
326 
327 #define WL_FUNC_P2P			BIT0
328 #define WL_FUNC_MIRACAST	BIT1
329 #define WL_FUNC_TDLS		BIT2
330 #define WL_FUNC_FTM			BIT3
331 #define WL_FUNC_BIT_NUM		4
332 
333 #define TBTT_PROHIBIT_SETUP_TIME 0x04 /* 128us, unit is 32us */
334 #define TBTT_PROHIBIT_HOLD_TIME 0x80 /* 4ms, unit is 32us*/
335 #define TBTT_PROHIBIT_HOLD_TIME_STOP_BCN 0x64 /* 3.2ms unit is 32us*/
336 
337 int hal_spec_init(_adapter *adapter);
338 void dump_hal_spec(void *sel, _adapter *adapter);
339 
340 bool hal_chk_band_cap(_adapter *adapter, u8 cap);
341 bool hal_chk_bw_cap(_adapter *adapter, u8 cap);
342 bool hal_chk_proto_cap(_adapter *adapter, u8 cap);
343 bool hal_is_band_support(_adapter *adapter, u8 band);
344 bool hal_is_bw_support(_adapter *adapter, u8 bw);
345 bool hal_is_wireless_mode_support(_adapter *adapter, u8 mode);
346 u8 hal_largest_bw(_adapter *adapter, u8 in_bw);
347 
348 bool hal_chk_wl_func(_adapter *adapter, u8 func);
349 
350 void hal_com_config_channel_plan(
351 	IN	PADAPTER padapter,
352 	IN	char *hw_alpha2,
353 	IN	u8 hw_chplan,
354 	IN	char *sw_alpha2,
355 	IN	u8 sw_chplan,
356 	IN	u8 def_chplan,
357 	IN	BOOLEAN AutoLoadFail
358 );
359 
360 int hal_config_macaddr(_adapter *adapter, bool autoload_fail);
361 
362 BOOLEAN
363 HAL_IsLegalChannel(
364 	IN	PADAPTER	Adapter,
365 	IN	u32			Channel
366 );
367 
368 u8	MRateToHwRate(u8 rate);
369 
370 u8	hw_rate_to_m_rate(u8 rate);
371 
372 void	HalSetBrateCfg(
373 	IN PADAPTER		Adapter,
374 	IN u8			*mBratesOS,
375 	OUT u16			*pBrateCfg);
376 
377 BOOLEAN
378 Hal_MappingOutPipe(
379 	IN	PADAPTER	pAdapter,
380 	IN	u8		NumOutPipe
381 );
382 
383 void rtw_dump_fw_info(void *sel, _adapter *adapter);
384 void rtw_restore_hw_port_cfg(_adapter *adapter);
385 void rtw_restore_mac_addr(_adapter *adapter);/*set mac addr when hal_init for all iface*/
386 void rtw_hal_dump_macaddr(void *sel, _adapter *adapter);
387 
388 void rtw_init_hal_com_default_value(PADAPTER Adapter);
389 
390 #ifdef CONFIG_FW_C2H_REG
391 void c2h_evt_clear(_adapter *adapter);
392 s32 c2h_evt_read_88xx(_adapter *adapter, u8 *buf);
393 #endif
394 
395 #ifdef CONFIG_FW_C2H_PKT
396 void rtw_hal_c2h_pkt_pre_hdl(_adapter *adapter, u8 *buf, u16 len);
397 void rtw_hal_c2h_pkt_hdl(_adapter *adapter, u8 *buf, u16 len);
398 #endif
399 
400 u8 rtw_get_mgntframe_raid(_adapter *adapter, unsigned char network_type);
401 
402 void rtw_hal_update_sta_wset(_adapter *adapter, struct sta_info *psta);
403 s8 rtw_get_sta_rx_nss(_adapter *adapter, struct sta_info *psta);
404 s8 rtw_get_sta_tx_nss(_adapter *adapter, struct sta_info *psta);
405 void rtw_hal_update_sta_ra_info(PADAPTER padapter, struct sta_info *psta);
406 
407 /* access HW only */
408 u32 rtw_sec_read_cam(_adapter *adapter, u8 addr);
409 void rtw_sec_write_cam(_adapter *adapter, u8 addr, u32 wdata);
410 void rtw_sec_read_cam_ent(_adapter *adapter, u8 id, u8 *ctrl, u8 *mac, u8 *key);
411 void rtw_sec_write_cam_ent(_adapter *adapter, u8 id, u16 ctrl, u8 *mac, u8 *key);
412 void rtw_sec_clr_cam_ent(_adapter *adapter, u8 id);
413 bool rtw_sec_read_cam_is_gk(_adapter *adapter, u8 id);
414 
415 u8 rtw_hal_rcr_check(_adapter *adapter, u32 check_bit);
416 
417 u8 rtw_hal_rcr_add(_adapter *adapter, u32 add);
418 u8 rtw_hal_rcr_clear(_adapter *adapter, u32 clear);
419 void rtw_hal_rcr_set_chk_bssid(_adapter *adapter, u8 self_action);
420 
421 void hw_var_port_switch(_adapter *adapter);
422 
423 u8 SetHwReg(PADAPTER padapter, u8 variable, u8 *val);
424 void GetHwReg(PADAPTER padapter, u8 variable, u8 *val);
425 void rtw_hal_check_rxfifo_full(_adapter *adapter);
426 void rtw_hal_reqtxrpt(_adapter *padapter, u8 macid);
427 
428 u8 SetHalDefVar(_adapter *adapter, HAL_DEF_VARIABLE variable, void *value);
429 u8 GetHalDefVar(_adapter *adapter, HAL_DEF_VARIABLE variable, void *value);
430 
431 BOOLEAN
432 eqNByte(
433 	u8	*str1,
434 	u8	*str2,
435 	u32	num
436 );
437 
438 u32
439 MapCharToHexDigit(
440 	IN	char	chTmp
441 );
442 
443 BOOLEAN
444 GetHexValueFromString(
445 	IN		char			*szStr,
446 	IN OUT	u32			*pu4bVal,
447 	IN OUT	u32			*pu4bMove
448 );
449 
450 BOOLEAN
451 GetFractionValueFromString(
452 	IN		char		*szStr,
453 	IN OUT	u8			*pInteger,
454 	IN OUT	u8			*pFraction,
455 	IN OUT	u32		*pu4bMove
456 );
457 
458 BOOLEAN
459 IsCommentString(
460 	IN		char		*szStr
461 );
462 
463 BOOLEAN
464 ParseQualifiedString(
465 	IN	char *In,
466 	IN OUT  u32 *Start,
467 	OUT	char *Out,
468 	IN	char  LeftQualifier,
469 	IN	char  RightQualifier
470 );
471 
472 BOOLEAN
473 GetU1ByteIntegerFromStringInDecimal(
474 	IN		char *Str,
475 	IN OUT	u8 *pInt
476 );
477 
478 BOOLEAN
479 isAllSpaceOrTab(
480 	u8	*data,
481 	u8	size
482 );
483 
484 void linked_info_dump(_adapter *padapter, u8 benable);
485 #ifdef DBG_RX_SIGNAL_DISPLAY_RAW_DATA
486 	void rtw_get_raw_rssi_info(void *sel, _adapter *padapter);
487 	void rtw_dump_raw_rssi_info(_adapter *padapter, void *sel);
488 #endif
489 
490 #ifdef DBG_RX_DFRAME_RAW_DATA
491 	void rtw_dump_rx_dframe_info(_adapter *padapter, void *sel);
492 #endif
493 void rtw_store_phy_info(_adapter *padapter, union recv_frame *prframe);
494 #define		HWSET_MAX_SIZE			1024
495 #ifdef CONFIG_EFUSE_CONFIG_FILE
496 	#define		EFUSE_FILE_COLUMN_NUM		16
497 	u32 Hal_readPGDataFromConfigFile(PADAPTER padapter);
498 	u32 Hal_ReadMACAddrFromFile(PADAPTER padapter, u8 *mac_addr);
499 #endif /* CONFIG_EFUSE_CONFIG_FILE */
500 
501 int check_phy_efuse_tx_power_info_valid(PADAPTER padapter);
502 int hal_efuse_macaddr_offset(_adapter *adapter);
503 int Hal_GetPhyEfuseMACAddr(PADAPTER padapter, u8 *mac_addr);
504 void rtw_dump_cur_efuse(PADAPTER padapter);
505 
506 #ifdef CONFIG_RF_POWER_TRIM
507 	void rtw_bb_rf_gain_offset(_adapter *padapter);
508 #endif /*CONFIG_RF_POWER_TRIM*/
509 
510 void dm_DynamicUsbTxAgg(_adapter *padapter, u8 from_timer);
511 u8 rtw_hal_busagg_qsel_check(_adapter *padapter, u8 pre_qsel, u8 next_qsel);
512 
513 u8 rtw_get_current_tx_rate(_adapter *padapter, struct sta_info *psta);
514 u8 rtw_get_current_tx_sgi(_adapter *padapter, struct sta_info *psta);
515 void rtw_hal_construct_NullFunctionData(PADAPTER, u8 *pframe, u32 *pLength, u8 *StaAddr, u8 bQoS, u8 AC, u8 bEosp, u8 bForcePowerSave);
516 
517 void rtw_hal_set_fw_rsvd_page(_adapter *adapter, bool finished);
518 u8 rtw_hal_get_rsvd_page_num(struct _ADAPTER *adapter);
519 
520 #ifdef CONFIG_TSF_RESET_OFFLOAD
521 int rtw_hal_reset_tsf(_adapter *adapter, u8 reset_port);
522 #endif
523 
524 #ifdef CONFIG_TDLS
525 	#ifdef CONFIG_TDLS_CH_SW
526 		s32 rtw_hal_ch_sw_oper_offload(_adapter *padapter, u8 channel, u8 channel_offset, u16 bwmode);
527 	#endif
528 #endif
529 #if defined(CONFIG_BT_COEXIST) && defined(CONFIG_FW_MULTI_PORT_SUPPORT)
530 s32 rtw_hal_set_wifi_port_id_cmd(_adapter *adapter);
531 #endif
532 
533 #ifdef CONFIG_GPIO_API
534 	u8 rtw_hal_get_gpio(_adapter *adapter, u8 gpio_num);
535 	int rtw_hal_set_gpio_output_value(_adapter *adapter, u8 gpio_num, bool isHigh);
536 	int rtw_hal_config_gpio(_adapter *adapter, u8 gpio_num, bool isOutput);
537 	int rtw_hal_register_gpio_interrupt(_adapter *adapter, int gpio_num, void(*callback)(u8 level));
538 	int rtw_hal_disable_gpio_interrupt(_adapter *adapter, int gpio_num);
539 #endif
540 
541 s8 rtw_hal_ch_sw_iqk_info_search(_adapter *padapter, u8 central_chnl, u8 bw_mode);
542 void rtw_hal_ch_sw_iqk_info_backup(_adapter *adapter);
543 void rtw_hal_ch_sw_iqk_info_restore(_adapter *padapter, u8 ch_sw_use_case);
544 
545 #ifdef CONFIG_GPIO_WAKEUP
546 	void rtw_hal_switch_gpio_wl_ctrl(_adapter *padapter, u8 index, u8 enable);
547 	void rtw_hal_set_output_gpio(_adapter *padapter, u8 index, u8 outputval);
548 	void rtw_hal_set_input_gpio(_adapter *padapter, u8 index);
549 #endif
550 
551 #ifdef CONFIG_LOAD_PHY_PARA_FROM_FILE
552 	extern char *rtw_phy_file_path;
553 	extern char rtw_phy_para_file_path[PATH_LENGTH_MAX];
554 	#define GetLineFromBuffer(buffer)   strsep(&buffer, "\r\n")
555 #endif
556 
557 void update_IOT_info(_adapter *padapter);
558 
559 void hal_set_crystal_cap(_adapter *adapter, u8 crystal_cap);
560 void rtw_hal_correct_tsf(_adapter *padapter, u8 hw_port, u64 tsf);
561 
562 void ResumeTxBeacon(_adapter *padapter);
563 void StopTxBeacon(_adapter *padapter);
564 #ifdef CONFIG_MI_WITH_MBSSID_CAM /*HW port0 - MBSS*/
565 	void hw_var_set_opmode_mbid(_adapter *Adapter, u8 mode);
566 	u8 rtw_mbid_camid_alloc(_adapter *adapter, u8 *mac_addr);
567 #endif
568 
569 #ifdef CONFIG_ANTENNA_DIVERSITY
570 	u8	rtw_hal_antdiv_before_linked(_adapter *padapter);
571 	void	rtw_hal_antdiv_rssi_compared(_adapter *padapter, WLAN_BSSID_EX *dst, WLAN_BSSID_EX *src);
572 #endif
573 
574 #ifdef DBG_SEC_CAM_MOVE
575 	void rtw_hal_move_sta_gk_to_dk(_adapter *adapter);
576 	void rtw_hal_read_sta_dk_key(_adapter *adapter, u8 key_id);
577 #endif
578 
579 #ifdef CONFIG_LPS_PG
580 #define LPSPG_RSVD_PAGE_SET_MACID(_rsvd_pag, _value)		SET_BITS_TO_LE_4BYTE(_rsvd_pag+0x00, 0, 8, _value)/*used macid*/
581 #define LPSPG_RSVD_PAGE_SET_MBSSCAMID(_rsvd_pag, _value)	SET_BITS_TO_LE_4BYTE(_rsvd_pag+0x00, 8, 8, _value)/*used BSSID CAM entry*/
582 #define LPSPG_RSVD_PAGE_SET_PMC_NUM(_rsvd_pag, _value)		SET_BITS_TO_LE_4BYTE(_rsvd_pag+0x00, 16, 8, _value)/*Max used Pattern Match CAM entry*/
583 #define LPSPG_RSVD_PAGE_SET_MU_RAID_GID(_rsvd_pag, _value)	SET_BITS_TO_LE_4BYTE(_rsvd_pag+0x00, 24, 8, _value)/*Max MU rate table Group ID*/
584 #define LPSPG_RSVD_PAGE_SET_SEC_CAM_NUM(_rsvd_pag, _value)	SET_BITS_TO_LE_4BYTE(_rsvd_pag+0x04, 0, 8, _value)/*used Security CAM entry number*/
585 #define LPSPG_RSVD_PAGE_SET_DRV_RSVDPAGE_NUM(_rsvd_pag, _value)	SET_BITS_TO_LE_4BYTE(_rsvd_pag+0x04, 8, 8, _value)/*Txbuf used page number for fw offload*/
586 #define LPSPG_RSVD_PAGE_SET_SEC_CAM_ID1(_rsvd_pag, _value)	SET_BITS_TO_LE_4BYTE(_rsvd_pag+0x08, 0, 8, _value)/*used Security CAM entry -1*/
587 #define LPSPG_RSVD_PAGE_SET_SEC_CAM_ID2(_rsvd_pag, _value)	SET_BITS_TO_LE_4BYTE(_rsvd_pag+0x08, 8, 8, _value)/*used Security CAM entry -2*/
588 #define LPSPG_RSVD_PAGE_SET_SEC_CAM_ID3(_rsvd_pag, _value)	SET_BITS_TO_LE_4BYTE(_rsvd_pag+0x08, 16, 8, _value)/*used Security CAM entry -3*/
589 #define LPSPG_RSVD_PAGE_SET_SEC_CAM_ID4(_rsvd_pag, _value)	SET_BITS_TO_LE_4BYTE(_rsvd_pag+0x08, 24, 8, _value)/*used Security CAM entry -4*/
590 #define LPSPG_RSVD_PAGE_SET_SEC_CAM_ID5(_rsvd_pag, _value)	SET_BITS_TO_LE_4BYTE(_rsvd_pag+0x0C, 0, 8, _value)/*used Security CAM entry -5*/
591 #define LPSPG_RSVD_PAGE_SET_SEC_CAM_ID6(_rsvd_pag, _value)	SET_BITS_TO_LE_4BYTE(_rsvd_pag+0x0C, 8, 8, _value)/*used Security CAM entry -6*/
592 #define LPSPG_RSVD_PAGE_SET_SEC_CAM_ID7(_rsvd_pag, _value)	SET_BITS_TO_LE_4BYTE(_rsvd_pag+0x0C, 16, 8, _value)/*used Security CAM entry -7*/
593 #define LPSPG_RSVD_PAGE_SET_SEC_CAM_ID8(_rsvd_pag, _value)	SET_BITS_TO_LE_4BYTE(_rsvd_pag+0x0C, 24, 8, _value)/*used Security CAM entry -8*/
594 enum lps_pg_hdl_id {
595 	LPS_PG_INFO_CFG = 0,
596 	LPS_PG_REDLEMEM,
597 	LPS_PG_RESEND_H2C,
598 };
599 
600 	u8 rtw_hal_set_lps_pg_info(_adapter *adapter);
601 #endif
602 
603 int rtw_hal_get_rsvd_page(_adapter *adapter, u32 page_offset, u32 page_num, u8 *buffer, u32 buffer_size);
604 
605 #ifdef CONFIG_WOWLAN
606 struct rtl_wow_pattern {
607 	u16	crc;
608 	u8	type;
609 	u32	mask[4];
610 };
611 void rtw_wow_pattern_cam_dump(_adapter *adapter);
612 
613 #ifdef CONFIG_WOW_PATTERN_HW_CAM
614 void rtw_wow_pattern_read_cam_ent(_adapter *adapter, u8 id, struct  rtl_wow_pattern *context);
615 void rtw_dump_wow_pattern(void *sel, struct rtl_wow_pattern *pwow_pattern, u8 idx);
616 #endif
617 
618 struct rtw_ndp_info {
619 	u8 enable:1;
620 	u8 check_remote_ip:1; /* Need to Check Sender IP or not */
621 	u8 rsvd:6;
622 	u8 num_of_target_ip; /* Number of Check IP which NA query IP */
623 	u8 target_link_addr[6]; /* DUT's MAC address */
624 	u8 remote_ipv6_addr[16]; /* Just respond IP */
625 	u8 target_ipv6_addr[16]; /* target IP */
626 };
627 #define REMOTE_INFO_CTRL_SET_VALD_EN(target, _value) \
628 	SET_BITS_TO_LE_4BYTE(target + 0, 0, 8, _value)
629 #define REMOTE_INFO_CTRL_SET_PTK_EN(target, _value) \
630 	SET_BITS_TO_LE_4BYTE(target + 1, 0, 1, _value)
631 #define REMOTE_INFO_CTRL_SET_GTK_EN(target, _value) \
632 	SET_BITS_TO_LE_4BYTE(target + 1, 1, 1, _value)
633 #define REMOTE_INFO_CTRL_SET_GTK_IDX(target, _value) \
634 	SET_BITS_TO_LE_4BYTE(target + 2, 0, 8, _value)
635 #endif /*CONFIG_WOWLAN*/
636 
637 void rtw_dump_phy_cap(void *sel, _adapter *adapter);
638 void rtw_dump_rsvd_page(void *sel, _adapter *adapter, u8 page_offset, u8 page_num);
639 #ifdef CONFIG_SUPPORT_FIFO_DUMP
640 void rtw_dump_fifo(void *sel, _adapter *adapter, u8 fifo_sel, u32 fifo_addr, u32 fifo_size);
641 #endif
642 
643 #ifdef CONFIG_FW_MULTI_PORT_SUPPORT
644 s32 rtw_hal_set_default_port_id_cmd(_adapter *adapter, u8 mac_id);
645 s32 rtw_set_default_port_id(_adapter *adapter);
646 s32 rtw_set_ps_rsvd_page(_adapter *adapter);
647 #endif
648 
649 #ifdef CONFIG_P2P_PS
650 #ifdef RTW_HALMAC
651 void rtw_set_p2p_ps_offload_cmd(_adapter *adapter, u8 p2p_ps_state);
652 #endif
653 #endif
654 s16 translate_dbm_to_percentage(s16 signal);
655 
656 #ifdef CONFIG_SWTIMER_BASED_TXBCN
657 #ifdef CONFIG_BCN_RECOVERY
658 u8 rtw_ap_bcn_recovery(_adapter *padapter);
659 #endif
660 #ifdef CONFIG_BCN_XMIT_PROTECT
661 u8 rtw_ap_bcn_queue_empty_check(_adapter *padapter, u32 txbcn_timer_ms);
662 #endif
663 #endif /*CONFIG_SWTIMER_BASED_TXBCN*/
664 
665 #endif /* __HAL_COMMON_H__ */
666