hc
2023-12-09 b22da3d8526a935aa31e086e63f60ff3246cb61c
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
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
/* SPDX-License-Identifier: GPL-2.0 */
/******************************************************************************
 *
 * Copyright(c) 2007 - 2011 Realtek Corporation. All rights reserved.
 *
 ******************************************************************************/
 
#ifndef    __HALDMOUTSRC_H__
#define __HALDMOUTSRC_H__
 
/*  Definition */
/*  Define all team support ability. */
 
/*  Define for all teams. Please Define the constant in your precomp header. */
 
/* define        DM_ODM_SUPPORT_AP            0 */
/* define        DM_ODM_SUPPORT_ADSL            0 */
/* define        DM_ODM_SUPPORT_CE            0 */
/* define        DM_ODM_SUPPORT_MP            1 */
 
/*  Define ODM SW team support flag. */
 
/*  Antenna Switch Relative Definition. */
 
/*  Add new function SwAntDivCheck8192C(). */
/*  This is the main function of Antenna diversity function before link. */
/*  Mainly, it just retains last scan result and scan again. */
/*  After that, it compares the scan result to see which one gets better
 *  RSSI. It selects antenna with better receiving power and returns better
 *  scan result.
 */
 
#define    TP_MODE            0
#define    RSSI_MODE        1
#define    TRAFFIC_LOW        0
#define    TRAFFIC_HIGH        1
 
/* 3 Tx Power Tracking */
/* 3============================================================ */
#define        DPK_DELTA_MAPPING_NUM    13
#define        index_mapping_HP_NUM    15
 
/*  */
/* 3 PSD Handler */
/* 3============================================================ */
 
#define    AFH_PSD        1    /* 0:normal PSD scan, 1: only do 20 pts PSD */
#define    MODE_40M    0    /* 0:20M, 1:40M */
#define    PSD_TH2        3
#define    PSD_CHM        20   /*  Minimum channel number for BT AFH */
#define    SIR_STEP_SIZE    3
#define Smooth_Size_1    5
#define    Smooth_TH_1    3
#define Smooth_Size_2    10
#define    Smooth_TH_2    4
#define Smooth_Size_3    20
#define    Smooth_TH_3    4
#define Smooth_Step_Size 5
#define    Adaptive_SIR    1
#define    PSD_RESCAN    4
#define    PSD_SCAN_INTERVAL    700 /* ms */
 
/* 8723A High Power IGI Setting */
#define DM_DIG_HIGH_PWR_IGI_LOWER_BOUND    0x22
#define DM_DIG_Gmode_HIGH_PWR_IGI_LOWER_BOUND 0x28
#define DM_DIG_HIGH_PWR_THRESHOLD    0x3a
 
/*  LPS define */
#define DM_DIG_FA_TH0_LPS        4 /*  4 in lps */
#define DM_DIG_FA_TH1_LPS        15 /*  15 lps */
#define DM_DIG_FA_TH2_LPS        30 /*  30 lps */
#define RSSI_OFFSET_DIG            0x05;
 
struct rtw_dig {
   u8        Dig_Enable_Flag;
   u8        Dig_Ext_Port_Stage;
 
   int        RssiLowThresh;
   int        RssiHighThresh;
 
   u32        FALowThresh;
   u32        FAHighThresh;
 
   u8        CurSTAConnectState;
   u8        PreSTAConnectState;
   u8        CurMultiSTAConnectState;
 
   u8        PreIGValue;
   u8        CurIGValue;
   u8        BackupIGValue;
 
   s8        BackoffVal;
   s8        BackoffVal_range_max;
   s8        BackoffVal_range_min;
   u8        rx_gain_range_max;
   u8        rx_gain_range_min;
   u8        Rssi_val_min;
 
   u8        PreCCK_CCAThres;
   u8        CurCCK_CCAThres;
   u8        PreCCKPDState;
   u8        CurCCKPDState;
 
   u8        LargeFAHit;
   u8        ForbiddenIGI;
   u32        Recover_cnt;
 
   u8        DIG_Dynamic_MIN_0;
   u8        DIG_Dynamic_MIN_1;
   bool        bMediaConnect_0;
   bool        bMediaConnect_1;
 
   u32        AntDiv_RSSI_max;
   u32        RSSI_max;
};
 
struct rtl_ps {
   u8        PreCCAState;
   u8        CurCCAState;
 
   u8        PreRFState;
   u8        CurRFState;
 
   int            Rssi_val_min;
 
   u8        initialize;
   u32        Reg874, RegC70, Reg85C, RegA74;
 
};
 
struct false_alarm_stats {
   u32    Cnt_Parity_Fail;
   u32    Cnt_Rate_Illegal;
   u32    Cnt_Crc8_fail;
   u32    Cnt_Mcs_fail;
   u32    Cnt_Ofdm_fail;
   u32    Cnt_Cck_fail;
   u32    Cnt_all;
   u32    Cnt_Fast_Fsync;
   u32    Cnt_SB_Search_fail;
   u32    Cnt_OFDM_CCA;
   u32    Cnt_CCK_CCA;
   u32    Cnt_CCA_all;
   u32    Cnt_BW_USC;    /* Gary */
   u32    Cnt_BW_LSC;    /* Gary */
};
 
struct rx_hpc {
   u8        RXHP_flag;
   u8        PSD_func_trigger;
   u8        PSD_bitmap_RXHP[80];
   u8        Pre_IGI;
   u8        Cur_IGI;
   u8        Pre_pw_th;
   u8        Cur_pw_th;
   bool        First_time_enter;
   bool        RXHP_enable;
   u8        TP_Mode;
   struct timer_list PSDTimer;
};
 
#define ASSOCIATE_ENTRY_NUM    32 /*  Max size of AsocEntry[]. */
#define    ODM_ASSOCIATE_ENTRY_NUM    ASSOCIATE_ENTRY_NUM
 
/*  This indicates two different steps. */
/*  In SWAW_STEP_PEAK, driver needs to switch antenna and listen to
 *  the signal on the air.
 */
/*  In SWAW_STEP_DETERMINE, driver just compares the signal captured in
 *  SWAW_STEP_PEAK with original RSSI to determine if it is necessary to
 *  switch antenna.
 */
 
#define SWAW_STEP_PEAK        0
#define SWAW_STEP_DETERMINE    1
 
#define    TP_MODE            0
#define    RSSI_MODE        1
#define    TRAFFIC_LOW        0
#define    TRAFFIC_HIGH        1
 
struct sw_ant_switch {
   u8    try_flag;
   s32    PreRSSI;
   u8    CurAntenna;
   u8    PreAntenna;
   u8    RSSI_Trying;
   u8    TestMode;
   u8    bTriggerAntennaSwitch;
   u8    SelectAntennaMap;
   u8    RSSI_target;
 
   /*  Before link Antenna Switch check */
   u8    SWAS_NoLink_State;
   u32    SWAS_NoLink_BK_Reg860;
   bool    ANTA_ON;    /* To indicate Ant A is or not */
   bool    ANTB_ON;    /* To indicate Ant B is on or not */
 
   s32    RSSI_sum_A;
   s32    RSSI_sum_B;
   s32    RSSI_cnt_A;
   s32    RSSI_cnt_B;
   u64    lastTxOkCnt;
   u64    lastRxOkCnt;
   u64    TXByteCnt_A;
   u64    TXByteCnt_B;
   u64    RXByteCnt_A;
   u64    RXByteCnt_B;
   u8    TrafficLoad;
   struct timer_list SwAntennaSwitchTimer;
   /* Hybrid Antenna Diversity */
   u32    CCK_Ant1_Cnt[ASSOCIATE_ENTRY_NUM];
   u32    CCK_Ant2_Cnt[ASSOCIATE_ENTRY_NUM];
   u32    OFDM_Ant1_Cnt[ASSOCIATE_ENTRY_NUM];
   u32    OFDM_Ant2_Cnt[ASSOCIATE_ENTRY_NUM];
   u32    RSSI_Ant1_Sum[ASSOCIATE_ENTRY_NUM];
   u32    RSSI_Ant2_Sum[ASSOCIATE_ENTRY_NUM];
   u8    TxAnt[ASSOCIATE_ENTRY_NUM];
   u8    TargetSTA;
   u8    antsel;
   u8    RxIdleAnt;
};
 
struct edca_turbo {
   bool bCurrentTurboEDCA;
   bool bIsCurRDLState;
   u32    prv_traffic_idx; /*  edca turbo */
};
 
struct odm_rate_adapt {
   u8    Type;        /*  DM_Type_ByFW/DM_Type_ByDriver */
   u8    HighRSSIThresh;    /*  if RSSI > HighRSSIThresh    => RATRState is DM_RATR_STA_HIGH */
   u8    LowRSSIThresh;    /*  if RSSI <= LowRSSIThresh    => RATRState is DM_RATR_STA_LOW */
   u8    RATRState;    /*  Current RSSI level, DM_RATR_STA_HIGH/DM_RATR_STA_MIDDLE/DM_RATR_STA_LOW */
   u32    LastRATR;    /*  RATR Register Content */
};
 
#define IQK_MAC_REG_NUM        4
#define IQK_ADDA_REG_NUM    16
#define IQK_BB_REG_NUM        9
#define HP_THERMAL_NUM        8
 
#define AVG_THERMAL_NUM        8
#define IQK_Matrix_REG_NUM    8
#define IQK_Matrix_Settings_NUM    (1 + 24 + 21)
 
#define    DM_Type_ByFWi        0
#define    DM_Type_ByDriver    1
 
/*  Declare for common info */
 
struct odm_phy_status_info {
   u8    RxPWDBAll;
   u8    SignalQuality;     /*  in 0-100 index. */
   u8    RxMIMOSignalQuality[MAX_PATH_NUM_92CS]; /* EVM */
   u8    RxMIMOSignalStrength[MAX_PATH_NUM_92CS];/*  in 0~100 index */
   s8    RxPower; /*  in dBm Translate from PWdB */
   s8    RecvSignalPower;/*  Real power in dBm for this packet, no
                * beautification and aggregation. Keep this raw
                * info to be used for the other procedures.
                */
   u8    BTRxRSSIPercentage;
   u8    SignalStrength; /*  in 0-100 index. */
   u8    RxPwr[MAX_PATH_NUM_92CS];/* per-path's pwdb */
   u8    RxSNR[MAX_PATH_NUM_92CS];/* per-path's SNR */
};
 
struct odm_phy_dbg_info {
   /* ODM Write,debug info */
   s8    RxSNRdB[MAX_PATH_NUM_92CS];
   u64    NumQryPhyStatus;
   u64    NumQryPhyStatusCCK;
   u64    NumQryPhyStatusOFDM;
   /* Others */
   s32    RxEVM[MAX_PATH_NUM_92CS];
};
 
struct odm_per_pkt_info {
   s8    Rate;
   u8    StationID;
   bool    bPacketMatchBSSID;
   bool    bPacketToSelf;
   bool    bPacketBeacon;
};
 
struct odm_mac_status_info {
   u8    test;
};
 
enum odm_ability {
   /*  BB Team */
   ODM_DIG            = 0x00000001,
   ODM_HIGH_POWER        = 0x00000002,
   ODM_CCK_CCA_TH        = 0x00000004,
   ODM_FA_STATISTICS    = 0x00000008,
   ODM_RAMASK        = 0x00000010,
   ODM_RSSI_MONITOR    = 0x00000020,
   ODM_SW_ANTDIV        = 0x00000040,
   ODM_HW_ANTDIV        = 0x00000080,
   ODM_BB_PWRSV        = 0x00000100,
   ODM_2TPATHDIV        = 0x00000200,
   ODM_1TPATHDIV        = 0x00000400,
   ODM_PSD2AFH        = 0x00000800
};
 
/*  2011/10/20 MH Define Common info enum for all team. */
 
enum odm_common_info_def {
   /*  Fixed value: */
 
   /* HOOK BEFORE REG INIT----------- */
   ODM_CMNINFO_PLATFORM = 0,
   ODM_CMNINFO_ABILITY,        /* ODM_ABILITY_E */
   ODM_CMNINFO_INTERFACE,        /* ODM_INTERFACE_E */
   ODM_CMNINFO_MP_TEST_CHIP,
   ODM_CMNINFO_IC_TYPE,        /* ODM_IC_TYPE_E */
   ODM_CMNINFO_CUT_VER,        /* ODM_CUT_VERSION_E */
   ODM_CMNINFO_RF_TYPE,        /* ODM_RF_PATH_E or ODM_RF_TYPE_E? */
   ODM_CMNINFO_BOARD_TYPE,        /* ODM_BOARD_TYPE_E */
   ODM_CMNINFO_EXT_LNA,        /* true */
   ODM_CMNINFO_EXT_PA,
   ODM_CMNINFO_EXT_TRSW,
   ODM_CMNINFO_PATCH_ID,        /* CUSTOMER ID */
   ODM_CMNINFO_BINHCT_TEST,
   ODM_CMNINFO_BWIFI_TEST,
   ODM_CMNINFO_SMART_CONCURRENT,
   /* HOOK BEFORE REG INIT-----------  */
 
   /*  Dynamic value: */
/*  POINTER REFERENCE-----------  */
   ODM_CMNINFO_MAC_PHY_MODE,    /*  ODM_MAC_PHY_MODE_E */
   ODM_CMNINFO_TX_UNI,
   ODM_CMNINFO_RX_UNI,
   ODM_CMNINFO_WM_MODE,        /*  ODM_WIRELESS_MODE_E */
   ODM_CMNINFO_BAND,        /*  ODM_BAND_TYPE_E */
   ODM_CMNINFO_SEC_CHNL_OFFSET,    /*  ODM_SEC_CHNL_OFFSET_E */
   ODM_CMNINFO_SEC_MODE,        /*  ODM_SECURITY_E */
   ODM_CMNINFO_BW,            /*  ODM_BW_E */
   ODM_CMNINFO_CHNL,
 
   ODM_CMNINFO_DMSP_GET_VALUE,
   ODM_CMNINFO_BUDDY_ADAPTOR,
   ODM_CMNINFO_DMSP_IS_MASTER,
   ODM_CMNINFO_SCAN,
   ODM_CMNINFO_POWER_SAVING,
   ODM_CMNINFO_ONE_PATH_CCA,    /*  ODM_CCA_PATH_E */
   ODM_CMNINFO_DRV_STOP,
   ODM_CMNINFO_PNP_IN,
   ODM_CMNINFO_INIT_ON,
   ODM_CMNINFO_ANT_TEST,
   ODM_CMNINFO_NET_CLOSED,
   ODM_CMNINFO_MP_MODE,
/*  POINTER REFERENCE----------- */
 
/* CALL BY VALUE------------- */
   ODM_CMNINFO_WIFI_DIRECT,
   ODM_CMNINFO_WIFI_DISPLAY,
   ODM_CMNINFO_LINK,
   ODM_CMNINFO_RSSI_MIN,
   ODM_CMNINFO_DBG_COMP,            /*  u64 */
   ODM_CMNINFO_DBG_LEVEL,            /*  u32 */
   ODM_CMNINFO_RA_THRESHOLD_HIGH,        /*  u8 */
   ODM_CMNINFO_RA_THRESHOLD_LOW,        /*  u8 */
   ODM_CMNINFO_RF_ANTENNA_TYPE,        /*  u8 */
   ODM_CMNINFO_BT_DISABLED,
   ODM_CMNINFO_BT_OPERATION,
   ODM_CMNINFO_BT_DIG,
   ODM_CMNINFO_BT_BUSY,            /* Check Bt is using or not */
   ODM_CMNINFO_BT_DISABLE_EDCA,
/* CALL BY VALUE-------------*/
 
   /*  Dynamic ptr array hook itms. */
   ODM_CMNINFO_STA_STATUS,
   ODM_CMNINFO_PHY_STATUS,
   ODM_CMNINFO_MAC_STATUS,
   ODM_CMNINFO_MAX,
};
 
/*  2011/10/20 MH Define ODM support ability.  ODM_CMNINFO_ABILITY */
 
enum odm_ability_def {
   /*  BB ODM section BIT 0-15 */
   ODM_BB_DIG            = BIT(0),
   ODM_BB_RA_MASK            = BIT(1),
   ODM_BB_DYNAMIC_TXPWR        = BIT(2),
   ODM_BB_FA_CNT            = BIT(3),
   ODM_BB_RSSI_MONITOR        = BIT(4),
   ODM_BB_CCK_PD            = BIT(5),
   ODM_BB_ANT_DIV            = BIT(6),
   ODM_BB_PWR_SAVE            = BIT(7),
   ODM_BB_PWR_TRA            = BIT(8),
   ODM_BB_RATE_ADAPTIVE        = BIT(9),
   ODM_BB_PATH_DIV            = BIT(10),
   ODM_BB_PSD            = BIT(11),
   ODM_BB_RXHP            = BIT(12),
 
   /*  MAC DM section BIT 16-23 */
   ODM_MAC_EDCA_TURBO        = BIT(16),
   ODM_MAC_EARLY_MODE        = BIT(17),
 
   /*  RF ODM section BIT 24-31 */
   ODM_RF_TX_PWR_TRACK        = BIT(24),
   ODM_RF_RX_GAIN_TRACK        = BIT(25),
   ODM_RF_CALIBRATION        = BIT(26),
};
 
#define ODM_RTL8188E        BIT(4)
 
/* ODM_CMNINFO_CUT_VER */
enum odm_cut_version {
   ODM_CUT_A    =    1,
   ODM_CUT_B    =    2,
   ODM_CUT_C    =    3,
   ODM_CUT_D    =    4,
   ODM_CUT_E    =    5,
   ODM_CUT_F    =    6,
   ODM_CUT_TEST    =    7,
};
 
/*  ODM_CMNINFO_RF_TYPE */
/*  For example 1T2R (A+AB = BIT0|BIT4|BIT5) */
enum odm_rf_path {
   ODM_RF_TX_A    =    BIT(0),
   ODM_RF_TX_B    =    BIT(1),
   ODM_RF_TX_C    =    BIT(2),
   ODM_RF_TX_D    =    BIT(3),
   ODM_RF_RX_A    =    BIT(4),
   ODM_RF_RX_B    =    BIT(5),
   ODM_RF_RX_C    =    BIT(6),
   ODM_RF_RX_D    =    BIT(7),
};
 
enum odm_rf_type {
   ODM_1T1R    =    0,
   ODM_1T2R    =    1,
   ODM_2T2R    =    2,
   ODM_2T3R    =    3,
   ODM_2T4R    =    4,
   ODM_3T3R    =    5,
   ODM_3T4R    =    6,
   ODM_4T4R    =    7,
};
 
/*  ODM Dynamic common info value definition */
 
enum odm_mac_phy_mode {
   ODM_SMSP    = 0,
   ODM_DMSP    = 1,
   ODM_DMDP    = 2,
};
 
enum odm_bt_coexist {
   ODM_BT_BUSY        = 1,
   ODM_BT_ON        = 2,
   ODM_BT_OFF        = 3,
   ODM_BT_NONE        = 4,
};
 
/*  ODM_CMNINFO_OP_MODE */
enum odm_operation_mode {
   ODM_NO_LINK        = BIT(0),
   ODM_LINK        = BIT(1),
   ODM_SCAN        = BIT(2),
   ODM_POWERSAVE        = BIT(3),
   ODM_AP_MODE        = BIT(4),
   ODM_CLIENT_MODE        = BIT(5),
   ODM_AD_HOC        = BIT(6),
   ODM_WIFI_DIRECT        = BIT(7),
   ODM_WIFI_DISPLAY    = BIT(8),
};
 
/*  ODM_CMNINFO_WM_MODE */
enum odm_wireless_mode {
   ODM_WM_UNKNOWN    = 0x0,
   ODM_WM_B    = BIT(0),
   ODM_WM_G    = BIT(1),
   ODM_WM_A    = BIT(2),
   ODM_WM_N24G    = BIT(3),
   ODM_WM_N5G    = BIT(4),
   ODM_WM_AUTO    = BIT(5),
   ODM_WM_AC    = BIT(6),
};
 
/*  ODM_CMNINFO_BAND */
enum odm_band_type {
   ODM_BAND_2_4G    = BIT(0),
   ODM_BAND_5G    = BIT(1),
};
 
/*  ODM_CMNINFO_SEC_CHNL_OFFSET */
enum odm_sec_chnl_offset {
   ODM_DONT_CARE    = 0,
   ODM_BELOW    = 1,
   ODM_ABOVE    = 2
};
 
/*  ODM_CMNINFO_SEC_MODE */
enum odm_security {
   ODM_SEC_OPEN        = 0,
   ODM_SEC_WEP40        = 1,
   ODM_SEC_TKIP        = 2,
   ODM_SEC_RESERVE        = 3,
   ODM_SEC_AESCCMP        = 4,
   ODM_SEC_WEP104        = 5,
   ODM_WEP_WPA_MIXED    = 6, /*  WEP + WPA */
   ODM_SEC_SMS4        = 7,
};
 
/*  ODM_CMNINFO_BW */
enum odm_bw {
   ODM_BW20M        = 0,
   ODM_BW40M        = 1,
   ODM_BW80M        = 2,
   ODM_BW160M        = 3,
   ODM_BW10M        = 4,
};
 
/*  ODM_CMNINFO_BOARD_TYPE */
enum odm_board_type {
   ODM_BOARD_NORMAL    = 0,
   ODM_BOARD_HIGHPWR    = 1,
   ODM_BOARD_MINICARD    = 2,
   ODM_BOARD_SLIM        = 3,
   ODM_BOARD_COMBO        = 4,
};
 
/*  ODM_CMNINFO_ONE_PATH_CCA */
enum odm_cca_path {
   ODM_CCA_2R        = 0,
   ODM_CCA_1R_A        = 1,
   ODM_CCA_1R_B        = 2,
};
 
struct odm_ra_info {
   u8 RateID;
   u32 RateMask;
   u32 RAUseRate;
   u8 RateSGI;
   u8 RssiStaRA;
   u8 PreRssiStaRA;
   u8 SGIEnable;
   u8 DecisionRate;
   u8 PreRate;
   u8 HighestRate;
   u8 LowestRate;
   u32 NscUp;
   u32 NscDown;
   u16 RTY[5];
   u32 TOTAL;
   u16 DROP;
   u8 Active;
   u16 RptTime;
   u8 RAWaitingCounter;
   u8 RAPendingCounter;
   u8 PTActive;    /*  on or off */
   u8 PTTryState;    /*  0 trying state, 1 for decision state */
   u8 PTStage;    /*  0~6 */
   u8 PTStopCount;    /* Stop PT counter */
   u8 PTPreRate;    /*  if rate change do PT */
   u8 PTPreRssi;    /*  if RSSI change 5% do PT */
   u8 PTModeSS;    /*  decide whitch rate should do PT */
   u8 RAstage;    /*  StageRA, decide how many times RA will be done
            * between PT
            */
   u8 PTSmoothFactor;
};
 
struct ijk_matrix_regs_set {
   bool    bIQKDone;
   s32    Value[1][IQK_Matrix_REG_NUM];
};
 
struct odm_rf_cal {
   /* for tx power tracking */
   u32    RegA24; /*  for TempCCK */
   s32    RegE94;
   s32    RegE9C;
   s32    RegEB4;
   s32    RegEBC;
 
   u8    TXPowercount;
   bool    bTXPowerTracking;
   u8    TxPowerTrackControl; /* for mp mode, turn off txpwrtracking
                     * as default
                     */
   u8    TM_Trigger;
   u8    InternalPA5G[2];    /* pathA / pathB */
 
   u8    ThermalMeter[2];    /* ThermalMeter, index 0 for RFIC0,
                    * and 1 for RFIC1
                    */
   u8    ThermalValue;
   u8    ThermalValue_LCK;
   u8    ThermalValue_IQK;
   u8    ThermalValue_DPK;
   u8    ThermalValue_AVG[AVG_THERMAL_NUM];
   u8    ThermalValue_AVG_index;
   u8    ThermalValue_RxGain;
   u8    ThermalValue_Crystal;
   u8    ThermalValue_DPKstore;
   u8    ThermalValue_DPKtrack;
   bool    TxPowerTrackingInProgress;
   bool    bDPKenable;
 
   bool    bReloadtxpowerindex;
   u8    bRfPiEnable;
   u32    TXPowerTrackingCallbackCnt; /* cosa add for debug */
 
   u8    bCCKinCH14;
   u8    CCK_index;
   u8    OFDM_index[2];
   bool bDoneTxpower;
 
   u8    ThermalValue_HP[HP_THERMAL_NUM];
   u8    ThermalValue_HP_index;
   struct ijk_matrix_regs_set IQKMatrixRegSetting[IQK_Matrix_Settings_NUM];
 
   u8    Delta_IQK;
   u8    Delta_LCK;
 
   /* for IQK */
   u32    RegC04;
   u32    Reg874;
   u32    RegC08;
   u32    RegB68;
   u32    RegB6C;
   u32    Reg870;
   u32    Reg860;
   u32    Reg864;
 
   bool    bIQKInitialized;
   bool    bLCKInProgress;
   bool    bAntennaDetected;
   u32    ADDA_backup[IQK_ADDA_REG_NUM];
   u32    IQK_MAC_backup[IQK_MAC_REG_NUM];
   u32    IQK_BB_backup_recover[9];
   u32    IQK_BB_backup[IQK_BB_REG_NUM];
 
   /* for APK */
   u32    APKoutput[2][2]; /* path A/B; output1_1a/output1_2a */
   u8    bAPKdone;
   u8    bAPKThermalMeterIgnore;
   u8    bDPdone;
   u8    bDPPathAOK;
   u8    bDPPathBOK;
};
 
/*  ODM Dynamic common info value definition */
 
struct fast_ant_train {
   u8    Bssid[6];
   u8    antsel_rx_keep_0;
   u8    antsel_rx_keep_1;
   u8    antsel_rx_keep_2;
   u32    antSumRSSI[7];
   u32    antRSSIcnt[7];
   u32    antAveRSSI[7];
   u8    FAT_State;
   u32    TrainIdx;
   u8    antsel_a[ODM_ASSOCIATE_ENTRY_NUM];
   u8    antsel_b[ODM_ASSOCIATE_ENTRY_NUM];
   u8    antsel_c[ODM_ASSOCIATE_ENTRY_NUM];
   u32    MainAnt_Sum[ODM_ASSOCIATE_ENTRY_NUM];
   u32    AuxAnt_Sum[ODM_ASSOCIATE_ENTRY_NUM];
   u32    MainAnt_Cnt[ODM_ASSOCIATE_ENTRY_NUM];
   u32    AuxAnt_Cnt[ODM_ASSOCIATE_ENTRY_NUM];
   u8    RxIdleAnt;
   bool    bBecomeLinked;
};
 
enum fat_state {
   FAT_NORMAL_STATE        = 0,
   FAT_TRAINING_STATE        = 1,
};
 
enum ant_div_type {
   NO_ANTDIV            = 0xFF,
   CG_TRX_HW_ANTDIV        = 0x01,
   CGCS_RX_HW_ANTDIV        = 0x02,
   FIXED_HW_ANTDIV            = 0x03,
   CG_TRX_SMART_ANTDIV        = 0x04,
   CGCS_RX_SW_ANTDIV        = 0x05,
};
 
/* Copy from SD4 defined structure. We use to support PHY DM integration. */
struct odm_dm_struct {
   /*    Add for different team use temporarily */
   struct adapter *Adapter;    /*  For CE/NIC team */
   struct rtl8192cd_priv *priv;    /*  For AP/ADSL team */
   /*  WHen you use above pointers, they must be initialized. */
   bool    odm_ready;
 
   struct rtl8192cd_priv *fake_priv;
   u64    DebugComponents;
   u32    DebugLevel;
 
/*  ODM HANDLE, DRIVER NEEDS NOT TO HOOK------ */
   bool    bCckHighPower;
   u8    RFPathRxEnable;        /*  ODM_CMNINFO_RFPATH_ENABLE */
   u8    ControlChannel;
/*  ODM HANDLE, DRIVER NEEDS NOT TO HOOK------ */
 
/* 1  COMMON INFORMATION */
   /*  Init Value */
/* HOOK BEFORE REG INIT----------- */
   /*  ODM Platform info AP/ADSL/CE/MP = 1/2/3/4 */
   u8    SupportPlatform;
   /*  ODM Support Ability DIG/RATR/TX_PWR_TRACK/... = 1/2/3/... */
   u32    SupportAbility;
   /*  ODM PCIE/USB/SDIO/GSPI = 0/1/2/3 */
   u8    SupportInterface;
   /*  ODM composite or independent. Bit oriented/ 92C+92D+ .... or any
    *  other type = 1/2/3/...
    */
   u32    SupportICType;
   /*  Cut Version TestChip/A-cut/B-cut... = 0/1/2/3/... */
   u8    CutVersion;
   /*  Board Type Normal/HighPower/MiniCard/SLIM/Combo/. = 0/1/2/3/4/. */
   u8    BoardType;
   /*  with external LNA  NO/Yes = 0/1 */
   u8    ExtLNA;
   /*  with external PA  NO/Yes = 0/1 */
   u8    ExtPA;
   /*  with external TRSW  NO/Yes = 0/1 */
   u8    ExtTRSW;
   u8    PatchID; /* Customer ID */
   bool    bInHctTest;
   bool    bWIFITest;
 
   bool    bDualMacSmartConcurrent;
   u32    BK_SupportAbility;
   u8    AntDivType;
/* HOOK BEFORE REG INIT----------- */
 
   /*  Dynamic Value */
/*  POINTER REFERENCE----------- */
 
   u8    u8_temp;
   bool    bool_temp;
   struct adapter *adapter_temp;
 
   /*  MAC PHY Mode SMSP/DMSP/DMDP = 0/1/2 */
   u8    *pMacPhyMode;
   /* TX Unicast byte count */
   u64    *pNumTxBytesUnicast;
   /* RX Unicast byte count */
   u64    *pNumRxBytesUnicast;
   /*  Wireless mode B/G/A/N = BIT0/BIT1/BIT2/BIT3 */
   u8    *pWirelessMode; /* ODM_WIRELESS_MODE_E */
   /*  Frequence band 2.4G/5G = 0/1 */
   u8    *pBandType;
   /*  Secondary channel offset don't_care/below/above = 0/1/2 */
   u8    *pSecChOffset;
   /*  Security mode Open/WEP/AES/TKIP = 0/1/2/3 */
   u8    *pSecurity;
   /*  BW info 20M/40M/80M = 0/1/2 */
   u8    *pBandWidth;
   /*  Central channel location Ch1/Ch2/.... */
   u8    *pChannel;    /* central channel number */
   /*  Common info for 92D DMSP */
 
   bool    *pbGetValueFromOtherMac;
   struct adapter **pBuddyAdapter;
   bool    *pbMasterOfDMSP; /* MAC0: master, MAC1: slave */
   /*  Common info for Status */
   bool    *pbScanInProcess;
   bool    *pbPowerSaving;
   /*  CCA Path 2-path/path-A/path-B = 0/1/2; using ODM_CCA_PATH_E. */
   u8    *pOnePathCCA;
   /* pMgntInfo->AntennaTest */
   u8    *pAntennaTest;
   bool    *pbNet_closed;
/*  POINTER REFERENCE----------- */
   /*  */
/* CALL BY VALUE------------- */
   bool    bWIFI_Direct;
   bool    bWIFI_Display;
   bool    bLinked;
   u8    RSSI_Min;
   u8    InterfaceIndex; /*  Add for 92D  dual MAC: 0--Mac0 1--Mac1 */
   bool    bIsMPChip;
   bool    bOneEntryOnly;
   /*  Common info for BTDM */
   bool    bBtDisabled;    /*  BT is disabled */
   bool    bBtHsOperation;    /*  BT HS mode is under progress */
   u8    btHsDigVal;    /*  use BT rssi to decide the DIG value */
   bool    bBtDisableEdcaTurbo;/* Under some condition, don't enable the
                    * EDCA Turbo
                    */
   bool    bBtBusy;            /*  BT is busy. */
/* CALL BY VALUE------------- */
 
   /* 2 Define STA info. */
   /*  _ODM_STA_INFO */
   /*  For MP, we need to reduce one array pointer for default port.??*/
   struct sta_info *pODM_StaInfo[ODM_ASSOCIATE_ENTRY_NUM];
 
   u16    CurrminRptTime;
   struct odm_ra_info RAInfo[ODM_ASSOCIATE_ENTRY_NUM]; /* Use MacID as
                                * array index. STA MacID=0,
                                * VWiFi Client MacID={1, ODM_ASSOCIATE_ENTRY_NUM-1}
                                */
   /*  */
   /*  2012/02/14 MH Add to share 88E ra with other SW team. */
   /*  We need to colelct all support abilit to a proper area. */
   /*  */
   bool    RaSupport88E;
 
   /*  Define ........... */
 
   /*  Latest packet phy info (ODM write) */
   struct odm_phy_dbg_info PhyDbgInfo;
 
   /*  Latest packet phy info (ODM write) */
   struct odm_mac_status_info *pMacInfo;
 
   /*  Different Team independt structure?? */
 
   /* ODM Structure */
   struct fast_ant_train DM_FatTable;
   struct rtw_dig    DM_DigTable;
   struct rtl_ps    DM_PSTable;
   struct rx_hpc    DM_RXHP_Table;
   struct false_alarm_stats FalseAlmCnt;
   struct false_alarm_stats FlaseAlmCntBuddyAdapter;
   struct sw_ant_switch DM_SWAT_Table;
   bool        RSSI_test;
 
   struct edca_turbo DM_EDCA_Table;
   u32        WMMEDCA_BE;
   /*  Copy from SD4 structure */
   /*  */
   /*  ================================================== */
   /*  */
 
   bool    *pbDriverStopped;
   bool    *pbDriverIsGoingToPnpSetPowerSleep;
   bool    *pinit_adpt_in_progress;
 
   /* PSD */
   bool    bUserAssignLevel;
   struct timer_list PSDTimer;
   u8    RSSI_BT;            /* come from BT */
   bool    bPSDinProcess;
   bool    bDMInitialGainEnable;
 
   /* for rate adaptive, in fact,  88c/92c fw will handle this */
   u8    bUseRAMask;
 
   struct odm_rate_adapt RateAdaptive;
 
   struct odm_rf_cal RFCalibrateInfo;
 
   /*  TX power tracking */
   u8    BbSwingIdxOfdm;
   u8    BbSwingIdxOfdmCurrent;
   u8    BbSwingIdxOfdmBase;
   bool    BbSwingFlagOfdm;
   u8    BbSwingIdxCck;
   u8    BbSwingIdxCckCurrent;
   u8    BbSwingIdxCckBase;
   bool    BbSwingFlagCck;
   u8    *mp_mode;
   /*  ODM system resource. */
 
   /*  ODM relative time. */
   struct timer_list PathDivSwitchTimer;
   /* 2011.09.27 add for Path Diversity */
   struct timer_list CCKPathDiversityTimer;
   struct timer_list FastAntTrainingTimer;
};        /*  DM_Dynamic_Mechanism_Structure */
 
#define ODM_RF_PATH_MAX 3
 
enum ODM_RF_CONTENT {
   odm_radioa_txt = 0x1000,
   odm_radiob_txt = 0x1001,
   odm_radioc_txt = 0x1002,
   odm_radiod_txt = 0x1003
};
 
/*  Status code */
enum rt_status {
   RT_STATUS_SUCCESS,
   RT_STATUS_FAILURE,
   RT_STATUS_PENDING,
   RT_STATUS_RESOURCE,
   RT_STATUS_INVALID_CONTEXT,
   RT_STATUS_INVALID_PARAMETER,
   RT_STATUS_NOT_SUPPORT,
   RT_STATUS_OS_API_FAILED,
};
 
/* 3=========================================================== */
/* 3 DIG */
/* 3=========================================================== */
 
enum dm_dig_op {
   RT_TYPE_THRESH_HIGH    = 0,
   RT_TYPE_THRESH_LOW    = 1,
   RT_TYPE_BACKOFF        = 2,
   RT_TYPE_RX_GAIN_MIN    = 3,
   RT_TYPE_RX_GAIN_MAX    = 4,
   RT_TYPE_ENABLE        = 5,
   RT_TYPE_DISABLE        = 6,
   DIG_OP_TYPE_MAX
};
 
#define        DM_DIG_THRESH_HIGH    40
#define        DM_DIG_THRESH_LOW    35
 
#define        DM_SCAN_RSSI_TH        0x14 /* scan return issue for LC */
 
#define        DM_false_ALARM_THRESH_LOW    400
#define        DM_false_ALARM_THRESH_HIGH    1000
 
#define        DM_DIG_MAX_NIC            0x4e
#define        DM_DIG_MIN_NIC            0x1e /* 0x22/0x1c */
 
#define        DM_DIG_MAX_AP            0x32
#define        DM_DIG_MIN_AP            0x20
 
#define        DM_DIG_MAX_NIC_HP        0x46
#define        DM_DIG_MIN_NIC_HP        0x2e
 
#define        DM_DIG_MAX_AP_HP        0x42
#define        DM_DIG_MIN_AP_HP        0x30
 
/* vivi 92c&92d has different definition, 20110504 */
/* this is for 92c */
#define        DM_DIG_FA_TH0            0x200/* 0x20 */
#define        DM_DIG_FA_TH1            0x300/* 0x100 */
#define        DM_DIG_FA_TH2            0x400/* 0x200 */
/* this is for 92d */
#define        DM_DIG_FA_TH0_92D        0x100
#define        DM_DIG_FA_TH1_92D        0x400
#define        DM_DIG_FA_TH2_92D        0x600
 
#define        DM_DIG_BACKOFF_MAX        12
#define        DM_DIG_BACKOFF_MIN        -4
#define        DM_DIG_BACKOFF_DEFAULT        10
 
/* 3=========================================================== */
/* 3 AGC RX High Power Mode */
/* 3=========================================================== */
#define      LNA_Low_Gain_1        0x64
#define      LNA_Low_Gain_2        0x5A
#define      LNA_Low_Gain_3        0x58
 
#define      FA_RXHP_TH1            5000
#define      FA_RXHP_TH2            1500
#define      FA_RXHP_TH3            800
#define      FA_RXHP_TH4            600
#define      FA_RXHP_TH5            500
 
/* 3=========================================================== */
/* 3 EDCA */
/* 3=========================================================== */
 
/* 3=========================================================== */
/* 3 Dynamic Tx Power */
/* 3=========================================================== */
/* Dynamic Tx Power Control Threshold */
#define        TX_POWER_NEAR_FIELD_THRESH_LVL2    74
#define        TX_POWER_NEAR_FIELD_THRESH_LVL1    67
#define        TX_POWER_NEAR_FIELD_THRESH_AP        0x3F
 
#define        TxHighPwrLevel_Normal        0
#define        TxHighPwrLevel_Level1        1
#define        TxHighPwrLevel_Level2        2
#define        TxHighPwrLevel_BT1        3
#define        TxHighPwrLevel_BT2        4
#define        TxHighPwrLevel_15        5
#define        TxHighPwrLevel_35        6
#define        TxHighPwrLevel_50        7
#define        TxHighPwrLevel_70        8
#define        TxHighPwrLevel_100        9
 
/* 3=========================================================== */
/* 3 Rate Adaptive */
/* 3=========================================================== */
#define        DM_RATR_STA_INIT        0
#define        DM_RATR_STA_HIGH        1
#define        DM_RATR_STA_MIDDLE        2
#define        DM_RATR_STA_LOW            3
 
/* 3=========================================================== */
/* 3 BB Power Save */
/* 3=========================================================== */
 
enum dm_1r_cca {
   CCA_1R = 0,
   CCA_2R = 1,
   CCA_MAX = 2,
};
 
enum dm_rf {
   RF_Save = 0,
   RF_Normal = 1,
   RF_MAX = 2,
};
 
/* 3=========================================================== */
/* 3 Antenna Diversity */
/* 3=========================================================== */
enum dm_swas {
   Antenna_A = 1,
   Antenna_B = 2,
   Antenna_MAX = 3,
};
 
/*  Maximal number of antenna detection mechanism needs to perform. */
#define    MAX_ANTENNA_DETECTION_CNT    10
 
/*  Extern Global Variables. */
#define    OFDM_TABLE_SIZE_92C    37
#define    OFDM_TABLE_SIZE_92D    43
#define    CCK_TABLE_SIZE        33
 
extern    u32 OFDMSwingTable[OFDM_TABLE_SIZE_92D];
extern    u8 CCKSwingTable_Ch1_Ch13[CCK_TABLE_SIZE][8];
extern    u8 CCKSwingTable_Ch14[CCK_TABLE_SIZE][8];
 
/*  check Sta pointer valid or not */
#define IS_STA_VALID(pSta)        (pSta)
/*  20100514 Joseph: Add definition for antenna switching test after link. */
/*  This indicates two different the steps. */
/*  In SWAW_STEP_PEAK, driver needs to switch antenna and listen to the
 *  signal on the air.
 */
/*  In SWAW_STEP_DETERMINE, driver just compares the signal captured in
 *  SWAW_STEP_PEAK
 */
/*  with original RSSI to determine if it is necessary to switch antenna. */
#define SWAW_STEP_PEAK        0
#define SWAW_STEP_DETERMINE    1
 
#define dm_CheckTXPowerTracking ODM_TXPowerTrackingCheck
#define dm_RF_Saving    ODM_RF_Saving
 
void ODM_RF_Saving(struct odm_dm_struct *pDM_Odm, u8 bForceInNormal);
void ODM_TXPowerTrackingCheck(struct odm_dm_struct *pDM_Odm);
void ODM_Write_CCK_CCA_Thres(struct odm_dm_struct *pDM_Odm, u8 CurCCK_CCAThres);
bool ODM_RAStateCheck(struct odm_dm_struct *pDM_Odm, s32 RSSI,
             bool bForceUpdate, u8 *pRATRState);
u32 ConvertTo_dB(u32 Value);
u32 ODM_Get_Rate_Bitmap(struct odm_dm_struct *pDM_Odm, u32 macid,
           u32 ra_mask, u8 rssi_level);
void ODM_CmnInfoInit(struct odm_dm_struct *pDM_Odm,
            enum odm_common_info_def CmnInfo, u32 Value);
void ODM_CmnInfoUpdate(struct odm_dm_struct *pDM_Odm, u32 CmnInfo, u64 Value);
void ODM_CmnInfoHook(struct odm_dm_struct *pDM_Odm,
            enum odm_common_info_def CmnInfo, void *pValue);
void ODM_CmnInfoPtrArrayHook(struct odm_dm_struct *pDM_Odm,
                enum odm_common_info_def CmnInfo,
                u16 Index, void *pValue);
void ODM_DMInit(struct odm_dm_struct *pDM_Odm);
void ODM_DMWatchdog(struct odm_dm_struct *pDM_Odm);
void ODM_Write_DIG(struct odm_dm_struct *pDM_Odm, u8 CurrentIGI);
 
#endif