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