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