staging: r8188eu: Additional cleanup of include/odm.h
[firefly-linux-kernel-4.4.55.git] / drivers / staging / rtl8188eu / include / odm.h
1 /******************************************************************************
2  *
3  * Copyright(c) 2007 - 2011 Realtek Corporation. All rights reserved.
4  *
5  * This program is free software; you can redistribute it and/or modify it
6  * under the terms of version 2 of the GNU General Public License as
7  * published by the Free Software Foundation.
8  *
9  * This program is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
12  * more details.
13  *
14  * You should have received a copy of the GNU General Public License along with
15  * this program; if not, write to the Free Software Foundation, Inc.,
16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
17  *
18  *
19  ******************************************************************************/
20
21
22 #ifndef __HALDMOUTSRC_H__
23 #define __HALDMOUTSRC_H__
24
25 /*  Definition */
26 /*  Define all team support ability. */
27
28 /*  Define for all teams. Please Define the constant in your precomp header. */
29
30 /* define               DM_ODM_SUPPORT_AP                       0 */
31 /* define               DM_ODM_SUPPORT_ADSL                     0 */
32 /* define               DM_ODM_SUPPORT_CE                       0 */
33 /* define               DM_ODM_SUPPORT_MP                       1 */
34
35 /*  Define ODM SW team support flag. */
36
37 /*  Antenna Switch Relative Definition. */
38
39 /*  Add new function SwAntDivCheck8192C(). */
40 /*  This is the main function of Antenna diversity function before link. */
41 /*  Mainly, it just retains last scan result and scan again. */
42 /*  After that, it compares the scan result to see which one gets better
43  *  RSSI. It selects antenna with better receiving power and returns better
44  *  scan result. */
45
46 #define TP_MODE                 0
47 #define RSSI_MODE               1
48 #define TRAFFIC_LOW             0
49 #define TRAFFIC_HIGH            1
50
51 /* 3 Tx Power Tracking */
52 /* 3============================================================ */
53 #define         DPK_DELTA_MAPPING_NUM   13
54 #define         index_mapping_HP_NUM    15
55
56
57 /*  */
58 /* 3 PSD Handler */
59 /* 3============================================================ */
60
61 #define AFH_PSD         1       /* 0:normal PSD scan, 1: only do 20 pts PSD */
62 #define MODE_40M        0       /* 0:20M, 1:40M */
63 #define PSD_TH2         3
64 #define PSD_CHM         20   /*  Minimum channel number for BT AFH */
65 #define SIR_STEP_SIZE   3
66 #define Smooth_Size_1   5
67 #define Smooth_TH_1     3
68 #define Smooth_Size_2   10
69 #define Smooth_TH_2     4
70 #define Smooth_Size_3   20
71 #define Smooth_TH_3     4
72 #define Smooth_Step_Size 5
73 #define Adaptive_SIR    1
74 #define PSD_RESCAN      4
75 #define PSD_SCAN_INTERVAL       700 /* ms */
76
77 /* 8723A High Power IGI Setting */
78 #define DM_DIG_HIGH_PWR_IGI_LOWER_BOUND 0x22
79 #define DM_DIG_Gmode_HIGH_PWR_IGI_LOWER_BOUND 0x28
80 #define DM_DIG_HIGH_PWR_THRESHOLD       0x3a
81
82 /*  LPS define */
83 #define DM_DIG_FA_TH0_LPS               4 /*  4 in lps */
84 #define DM_DIG_FA_TH1_LPS               15 /*  15 lps */
85 #define DM_DIG_FA_TH2_LPS               30 /*  30 lps */
86 #define RSSI_OFFSET_DIG                 0x05;
87
88 /* ANT Test */
89 #define ANTTESTALL              0x00    /* Ant A or B will be Testing */
90 #define ANTTESTA                0x01    /* Ant A will be Testing */
91 #define ANTTESTB                0x02    /* Ant B will be testing */
92
93 /*  structure and define */
94
95 /*  Add for AP/ADSLpseudo DM structuer requirement. */
96 /*  We need to remove to other position??? */
97 struct rtl8192cd_priv {
98         u8              temp;
99 };
100
101 struct rtw_dig {
102         u8              Dig_Enable_Flag;
103         u8              Dig_Ext_Port_Stage;
104
105         int             RssiLowThresh;
106         int             RssiHighThresh;
107
108         u32             FALowThresh;
109         u32             FAHighThresh;
110
111         u8              CurSTAConnectState;
112         u8              PreSTAConnectState;
113         u8              CurMultiSTAConnectState;
114
115         u8              PreIGValue;
116         u8              CurIGValue;
117         u8              BackupIGValue;
118
119         s8              BackoffVal;
120         s8              BackoffVal_range_max;
121         s8              BackoffVal_range_min;
122         u8              rx_gain_range_max;
123         u8              rx_gain_range_min;
124         u8              Rssi_val_min;
125
126         u8              PreCCK_CCAThres;
127         u8              CurCCK_CCAThres;
128         u8              PreCCKPDState;
129         u8              CurCCKPDState;
130
131         u8              LargeFAHit;
132         u8              ForbiddenIGI;
133         u32             Recover_cnt;
134
135         u8              DIG_Dynamic_MIN_0;
136         u8              DIG_Dynamic_MIN_1;
137         bool            bMediaConnect_0;
138         bool            bMediaConnect_1;
139
140         u32             AntDiv_RSSI_max;
141         u32             RSSI_max;
142 };
143
144 struct rtl_ps {
145         u8              PreCCAState;
146         u8              CurCCAState;
147
148         u8              PreRFState;
149         u8              CurRFState;
150
151         int                 Rssi_val_min;
152
153         u8              initialize;
154         u32             Reg874,RegC70,Reg85C,RegA74;
155
156 };
157
158 struct false_alarm_stats {
159         u32     Cnt_Parity_Fail;
160         u32     Cnt_Rate_Illegal;
161         u32     Cnt_Crc8_fail;
162         u32     Cnt_Mcs_fail;
163         u32     Cnt_Ofdm_fail;
164         u32     Cnt_Cck_fail;
165         u32     Cnt_all;
166         u32     Cnt_Fast_Fsync;
167         u32     Cnt_SB_Search_fail;
168         u32     Cnt_OFDM_CCA;
169         u32     Cnt_CCK_CCA;
170         u32     Cnt_CCA_all;
171         u32     Cnt_BW_USC;     /* Gary */
172         u32     Cnt_BW_LSC;     /* Gary */
173 };
174
175 struct dyn_primary_cca {
176         u8              PriCCA_flag;
177         u8              intf_flag;
178         u8              intf_type;
179         u8              DupRTS_flag;
180         u8              Monitor_flag;
181 };
182
183 struct rx_hpc {
184         u8              RXHP_flag;
185         u8              PSD_func_trigger;
186         u8              PSD_bitmap_RXHP[80];
187         u8              Pre_IGI;
188         u8              Cur_IGI;
189         u8              Pre_pw_th;
190         u8              Cur_pw_th;
191         bool            First_time_enter;
192         bool            RXHP_enable;
193         u8              TP_Mode;
194         struct timer_list PSDTimer;
195 };
196
197 #define ASSOCIATE_ENTRY_NUM     32 /*  Max size of AsocEntry[]. */
198 #define ODM_ASSOCIATE_ENTRY_NUM ASSOCIATE_ENTRY_NUM
199
200 /*  This indicates two different steps. */
201 /*  In SWAW_STEP_PEAK, driver needs to switch antenna and listen to
202  *  the signal on the air. */
203 /*  In SWAW_STEP_DETERMINE, driver just compares the signal captured in
204  *  SWAW_STEP_PEAK with original RSSI to determine if it is necessary to
205  *  switch antenna. */
206
207 #define SWAW_STEP_PEAK          0
208 #define SWAW_STEP_DETERMINE     1
209
210 #define TP_MODE                 0
211 #define RSSI_MODE               1
212 #define TRAFFIC_LOW             0
213 #define TRAFFIC_HIGH            1
214
215 struct sw_ant_switch {
216         u8      try_flag;
217         s32     PreRSSI;
218         u8      CurAntenna;
219         u8      PreAntenna;
220         u8      RSSI_Trying;
221         u8      TestMode;
222         u8      bTriggerAntennaSwitch;
223         u8      SelectAntennaMap;
224         u8      RSSI_target;
225
226         /*  Before link Antenna Switch check */
227         u8      SWAS_NoLink_State;
228         u32     SWAS_NoLink_BK_Reg860;
229         bool    ANTA_ON;        /* To indicate Ant A is or not */
230         bool    ANTB_ON;        /* To indicate Ant B is on or not */
231
232         s32     RSSI_sum_A;
233         s32     RSSI_sum_B;
234         s32     RSSI_cnt_A;
235         s32     RSSI_cnt_B;
236         u64     lastTxOkCnt;
237         u64     lastRxOkCnt;
238         u64     TXByteCnt_A;
239         u64     TXByteCnt_B;
240         u64     RXByteCnt_A;
241         u64     RXByteCnt_B;
242         u8      TrafficLoad;
243         struct timer_list SwAntennaSwitchTimer;
244         /* Hybrid Antenna Diversity */
245         u32     CCK_Ant1_Cnt[ASSOCIATE_ENTRY_NUM];
246         u32     CCK_Ant2_Cnt[ASSOCIATE_ENTRY_NUM];
247         u32     OFDM_Ant1_Cnt[ASSOCIATE_ENTRY_NUM];
248         u32     OFDM_Ant2_Cnt[ASSOCIATE_ENTRY_NUM];
249         u32     RSSI_Ant1_Sum[ASSOCIATE_ENTRY_NUM];
250         u32     RSSI_Ant2_Sum[ASSOCIATE_ENTRY_NUM];
251         u8      TxAnt[ASSOCIATE_ENTRY_NUM];
252         u8      TargetSTA;
253         u8      antsel;
254         u8      RxIdleAnt;
255 };
256
257 struct edca_turbo {
258         bool bCurrentTurboEDCA;
259         bool bIsCurRDLState;
260         u32     prv_traffic_idx; /*  edca turbo */
261 };
262
263 struct odm_rate_adapt {
264         u8      Type;           /*  DM_Type_ByFW/DM_Type_ByDriver */
265         u8      HighRSSIThresh; /*  if RSSI > HighRSSIThresh    => RATRState is DM_RATR_STA_HIGH */
266         u8      LowRSSIThresh;  /*  if RSSI <= LowRSSIThresh    => RATRState is DM_RATR_STA_LOW */
267         u8      RATRState;      /*  Current RSSI level, DM_RATR_STA_HIGH/DM_RATR_STA_MIDDLE/DM_RATR_STA_LOW */
268         u32     LastRATR;       /*  RATR Register Content */
269 };
270
271 #define IQK_MAC_REG_NUM         4
272 #define IQK_ADDA_REG_NUM        16
273 #define IQK_BB_REG_NUM_MAX      10
274 #define IQK_BB_REG_NUM          9
275 #define HP_THERMAL_NUM          8
276
277 #define AVG_THERMAL_NUM         8
278 #define IQK_Matrix_REG_NUM      8
279 #define IQK_Matrix_Settings_NUM 1+24+21
280
281 #define DM_Type_ByFWi           0
282 #define DM_Type_ByDriver        1
283
284 /*  Declare for common info */
285
286 struct odm_phy_status_info {
287         u8      RxPWDBAll;
288         u8      SignalQuality;   /*  in 0-100 index. */
289         u8      RxMIMOSignalQuality[MAX_PATH_NUM_92CS]; /* EVM */
290         u8      RxMIMOSignalStrength[MAX_PATH_NUM_92CS];/*  in 0~100 index */
291         s8      RxPower; /*  in dBm Translate from PWdB */
292         s8      RecvSignalPower;/*  Real power in dBm for this packet, no
293                                  * beautification and aggregation. Keep this raw
294                                  * info to be used for the other procedures. */
295         u8      BTRxRSSIPercentage;
296         u8      SignalStrength; /*  in 0-100 index. */
297         u8      RxPwr[MAX_PATH_NUM_92CS];/* per-path's pwdb */
298         u8      RxSNR[MAX_PATH_NUM_92CS];/* per-path's SNR */
299 };
300
301 struct odm_phy_dbg_info {
302         /* ODM Write,debug info */
303         s8      RxSNRdB[MAX_PATH_NUM_92CS];
304         u64     NumQryPhyStatus;
305         u64     NumQryPhyStatusCCK;
306         u64     NumQryPhyStatusOFDM;
307         /* Others */
308         s32     RxEVM[MAX_PATH_NUM_92CS];
309 };
310
311 struct odm_per_pkt_info {
312         s8      Rate;
313         u8      StationID;
314         bool    bPacketMatchBSSID;
315         bool    bPacketToSelf;
316         bool    bPacketBeacon;
317 };
318
319 struct odm_mac_status_info {
320         u8      test;
321 };
322
323 enum odm_ability {
324         /*  BB Team */
325         ODM_DIG                 = 0x00000001,
326         ODM_HIGH_POWER          = 0x00000002,
327         ODM_CCK_CCA_TH          = 0x00000004,
328         ODM_FA_STATISTICS       = 0x00000008,
329         ODM_RAMASK              = 0x00000010,
330         ODM_RSSI_MONITOR        = 0x00000020,
331         ODM_SW_ANTDIV           = 0x00000040,
332         ODM_HW_ANTDIV           = 0x00000080,
333         ODM_BB_PWRSV            = 0x00000100,
334         ODM_2TPATHDIV           = 0x00000200,
335         ODM_1TPATHDIV           = 0x00000400,
336         ODM_PSD2AFH             = 0x00000800
337 };
338
339 /*  2011/20/20 MH For MP driver RT_WLAN_STA =  struct sta_info */
340 /*  Please declare below ODM relative info in your STA info structure. */
341
342 struct odm_sta_info {
343         /*  Driver Write */
344         bool    bUsed;          /*  record the sta status link or not? */
345         u8      IOTPeer;        /*  Enum value. HT_IOT_PEER_E */
346
347         /*  ODM Write */
348         /* 1 PHY_STATUS_INFO */
349         u8      RSSI_Path[4];           /*  */
350         u8      RSSI_Ave;
351         u8      RXEVM[4];
352         u8      RXSNR[4];
353 };
354
355 /*  2011/10/20 MH Define Common info enum for all team. */
356
357 enum odm_common_info_def {
358         /*  Fixed value: */
359
360         /* HOOK BEFORE REG INIT----------- */
361         ODM_CMNINFO_PLATFORM = 0,
362         ODM_CMNINFO_ABILITY,            /* ODM_ABILITY_E */
363         ODM_CMNINFO_INTERFACE,          /* ODM_INTERFACE_E */
364         ODM_CMNINFO_MP_TEST_CHIP,
365         ODM_CMNINFO_IC_TYPE,            /* ODM_IC_TYPE_E */
366         ODM_CMNINFO_CUT_VER,            /* ODM_CUT_VERSION_E */
367         ODM_CMNINFO_FAB_VER,            /* ODM_FAB_E */
368         ODM_CMNINFO_RF_TYPE,            /* ODM_RF_PATH_E or ODM_RF_TYPE_E? */
369         ODM_CMNINFO_BOARD_TYPE,         /* ODM_BOARD_TYPE_E */
370         ODM_CMNINFO_EXT_LNA,            /* true */
371         ODM_CMNINFO_EXT_PA,
372         ODM_CMNINFO_EXT_TRSW,
373         ODM_CMNINFO_PATCH_ID,           /* CUSTOMER ID */
374         ODM_CMNINFO_BINHCT_TEST,
375         ODM_CMNINFO_BWIFI_TEST,
376         ODM_CMNINFO_SMART_CONCURRENT,
377         /* HOOK BEFORE REG INIT-----------  */
378
379         /*  Dynamic value: */
380 /*  POINTER REFERENCE-----------  */
381         ODM_CMNINFO_MAC_PHY_MODE,       /*  ODM_MAC_PHY_MODE_E */
382         ODM_CMNINFO_TX_UNI,
383         ODM_CMNINFO_RX_UNI,
384         ODM_CMNINFO_WM_MODE,            /*  ODM_WIRELESS_MODE_E */
385         ODM_CMNINFO_BAND,               /*  ODM_BAND_TYPE_E */
386         ODM_CMNINFO_SEC_CHNL_OFFSET,    /*  ODM_SEC_CHNL_OFFSET_E */
387         ODM_CMNINFO_SEC_MODE,           /*  ODM_SECURITY_E */
388         ODM_CMNINFO_BW,                 /*  ODM_BW_E */
389         ODM_CMNINFO_CHNL,
390
391         ODM_CMNINFO_DMSP_GET_VALUE,
392         ODM_CMNINFO_BUDDY_ADAPTOR,
393         ODM_CMNINFO_DMSP_IS_MASTER,
394         ODM_CMNINFO_SCAN,
395         ODM_CMNINFO_POWER_SAVING,
396         ODM_CMNINFO_ONE_PATH_CCA,       /*  ODM_CCA_PATH_E */
397         ODM_CMNINFO_DRV_STOP,
398         ODM_CMNINFO_PNP_IN,
399         ODM_CMNINFO_INIT_ON,
400         ODM_CMNINFO_ANT_TEST,
401         ODM_CMNINFO_NET_CLOSED,
402         ODM_CMNINFO_MP_MODE,
403 /*  POINTER REFERENCE----------- */
404
405 /* CALL BY VALUE------------- */
406         ODM_CMNINFO_WIFI_DIRECT,
407         ODM_CMNINFO_WIFI_DISPLAY,
408         ODM_CMNINFO_LINK,
409         ODM_CMNINFO_RSSI_MIN,
410         ODM_CMNINFO_DBG_COMP,                   /*  u64 */
411         ODM_CMNINFO_DBG_LEVEL,                  /*  u32 */
412         ODM_CMNINFO_RA_THRESHOLD_HIGH,          /*  u8 */
413         ODM_CMNINFO_RA_THRESHOLD_LOW,           /*  u8 */
414         ODM_CMNINFO_RF_ANTENNA_TYPE,            /*  u8 */
415         ODM_CMNINFO_BT_DISABLED,
416         ODM_CMNINFO_BT_OPERATION,
417         ODM_CMNINFO_BT_DIG,
418         ODM_CMNINFO_BT_BUSY,                    /* Check Bt is using or not */
419         ODM_CMNINFO_BT_DISABLE_EDCA,
420 /* CALL BY VALUE-------------*/
421
422         /*  Dynamic ptr array hook itms. */
423         ODM_CMNINFO_STA_STATUS,
424         ODM_CMNINFO_PHY_STATUS,
425         ODM_CMNINFO_MAC_STATUS,
426         ODM_CMNINFO_MAX,
427 };
428
429 /*  2011/10/20 MH Define ODM support ability.  ODM_CMNINFO_ABILITY */
430
431 enum odm_ability_def {
432         /*  BB ODM section BIT 0-15 */
433         ODM_BB_DIG                      = BIT0,
434         ODM_BB_RA_MASK                  = BIT1,
435         ODM_BB_DYNAMIC_TXPWR            = BIT2,
436         ODM_BB_FA_CNT                   = BIT3,
437         ODM_BB_RSSI_MONITOR             = BIT4,
438         ODM_BB_CCK_PD                   = BIT5,
439         ODM_BB_ANT_DIV                  = BIT6,
440         ODM_BB_PWR_SAVE                 = BIT7,
441         ODM_BB_PWR_TRA                  = BIT8,
442         ODM_BB_RATE_ADAPTIVE            = BIT9,
443         ODM_BB_PATH_DIV                 = BIT10,
444         ODM_BB_PSD                      = BIT11,
445         ODM_BB_RXHP                     = BIT12,
446
447         /*  MAC DM section BIT 16-23 */
448         ODM_MAC_EDCA_TURBO              = BIT16,
449         ODM_MAC_EARLY_MODE              = BIT17,
450
451         /*  RF ODM section BIT 24-31 */
452         ODM_RF_TX_PWR_TRACK             = BIT24,
453         ODM_RF_RX_GAIN_TRACK            = BIT25,
454         ODM_RF_CALIBRATION              = BIT26,
455 };
456
457 #define ODM_RTL8188E            BIT4
458
459 /* ODM_CMNINFO_CUT_VER */
460 enum odm_cut_version {
461         ODM_CUT_A       =       1,
462         ODM_CUT_B       =       2,
463         ODM_CUT_C       =       3,
464         ODM_CUT_D       =       4,
465         ODM_CUT_E       =       5,
466         ODM_CUT_F       =       6,
467         ODM_CUT_TEST    =       7,
468 };
469
470 /*  ODM_CMNINFO_FAB_VER */
471 enum odm_fab_Version {
472         ODM_TSMC        =       0,
473         ODM_UMC         =       1,
474 };
475
476 /*  ODM_CMNINFO_RF_TYPE */
477 /*  For example 1T2R (A+AB = BIT0|BIT4|BIT5) */
478 enum odm_rf_path {
479         ODM_RF_TX_A     =       BIT0,
480         ODM_RF_TX_B     =       BIT1,
481         ODM_RF_TX_C     =       BIT2,
482         ODM_RF_TX_D     =       BIT3,
483         ODM_RF_RX_A     =       BIT4,
484         ODM_RF_RX_B     =       BIT5,
485         ODM_RF_RX_C     =       BIT6,
486         ODM_RF_RX_D     =       BIT7,
487 };
488
489 enum odm_rf_type {
490         ODM_1T1R        =       0,
491         ODM_1T2R        =       1,
492         ODM_2T2R        =       2,
493         ODM_2T3R        =       3,
494         ODM_2T4R        =       4,
495         ODM_3T3R        =       5,
496         ODM_3T4R        =       6,
497         ODM_4T4R        =       7,
498 };
499
500 /*  ODM Dynamic common info value definition */
501
502 enum odm_mac_phy_mode {
503         ODM_SMSP        = 0,
504         ODM_DMSP        = 1,
505         ODM_DMDP        = 2,
506 };
507
508 enum odm_bt_coexist {
509         ODM_BT_BUSY             = 1,
510         ODM_BT_ON               = 2,
511         ODM_BT_OFF              = 3,
512         ODM_BT_NONE             = 4,
513 };
514
515 /*  ODM_CMNINFO_OP_MODE */
516 enum odm_operation_mode {
517         ODM_NO_LINK             = BIT0,
518         ODM_LINK                = BIT1,
519         ODM_SCAN                = BIT2,
520         ODM_POWERSAVE           = BIT3,
521         ODM_AP_MODE             = BIT4,
522         ODM_CLIENT_MODE         = BIT5,
523         ODM_AD_HOC              = BIT6,
524         ODM_WIFI_DIRECT         = BIT7,
525         ODM_WIFI_DISPLAY        = BIT8,
526 };
527
528 /*  ODM_CMNINFO_WM_MODE */
529 enum odm_wireless_mode {
530         ODM_WM_UNKNOW   = 0x0,
531         ODM_WM_B        = BIT0,
532         ODM_WM_G        = BIT1,
533         ODM_WM_A        = BIT2,
534         ODM_WM_N24G     = BIT3,
535         ODM_WM_N5G      = BIT4,
536         ODM_WM_AUTO     = BIT5,
537         ODM_WM_AC       = BIT6,
538 };
539
540 /*  ODM_CMNINFO_BAND */
541 enum odm_band_type {
542         ODM_BAND_2_4G   = BIT0,
543         ODM_BAND_5G     = BIT1,
544 };
545
546 /*  ODM_CMNINFO_SEC_CHNL_OFFSET */
547 enum odm_sec_chnl_offset {
548         ODM_DONT_CARE   = 0,
549         ODM_BELOW       = 1,
550         ODM_ABOVE       = 2
551 };
552
553 /*  ODM_CMNINFO_SEC_MODE */
554 enum odm_security {
555         ODM_SEC_OPEN            = 0,
556         ODM_SEC_WEP40           = 1,
557         ODM_SEC_TKIP            = 2,
558         ODM_SEC_RESERVE         = 3,
559         ODM_SEC_AESCCMP         = 4,
560         ODM_SEC_WEP104          = 5,
561         ODM_WEP_WPA_MIXED       = 6, /*  WEP + WPA */
562         ODM_SEC_SMS4            = 7,
563 };
564
565 /*  ODM_CMNINFO_BW */
566 enum odm_bw {
567         ODM_BW20M               = 0,
568         ODM_BW40M               = 1,
569         ODM_BW80M               = 2,
570         ODM_BW160M              = 3,
571         ODM_BW10M               = 4,
572 };
573
574 /*  ODM_CMNINFO_BOARD_TYPE */
575 enum odm_board_type {
576         ODM_BOARD_NORMAL        = 0,
577         ODM_BOARD_HIGHPWR       = 1,
578         ODM_BOARD_MINICARD      = 2,
579         ODM_BOARD_SLIM          = 3,
580         ODM_BOARD_COMBO         = 4,
581 };
582
583 /*  ODM_CMNINFO_ONE_PATH_CCA */
584 enum odm_cca_path {
585         ODM_CCA_2R              = 0,
586         ODM_CCA_1R_A            = 1,
587         ODM_CCA_1R_B            = 2,
588 };
589
590 struct odm_ra_info {
591         u8 RateID;
592         u32 RateMask;
593         u32 RAUseRate;
594         u8 RateSGI;
595         u8 RssiStaRA;
596         u8 PreRssiStaRA;
597         u8 SGIEnable;
598         u8 DecisionRate;
599         u8 PreRate;
600         u8 HighestRate;
601         u8 LowestRate;
602         u32 NscUp;
603         u32 NscDown;
604         u16 RTY[5];
605         u32 TOTAL;
606         u16 DROP;
607         u8 Active;
608         u16 RptTime;
609         u8 RAWaitingCounter;
610         u8 RAPendingCounter;
611         u8 PTActive;    /*  on or off */
612         u8 PTTryState;  /*  0 trying state, 1 for decision state */
613         u8 PTStage;     /*  0~6 */
614         u8 PTStopCount; /* Stop PT counter */
615         u8 PTPreRate;   /*  if rate change do PT */
616         u8 PTPreRssi;   /*  if RSSI change 5% do PT */
617         u8 PTModeSS;    /*  decide whitch rate should do PT */
618         u8 RAstage;     /*  StageRA, decide how many times RA will be done
619                          * between PT */
620         u8 PTSmoothFactor;
621 };
622
623 struct ijk_matrix_regs_set {
624         bool    bIQKDone;
625         s32     Value[1][IQK_Matrix_REG_NUM];
626 };
627
628 struct odm_rf_cal {
629         /* for tx power tracking */
630         u32     RegA24; /*  for TempCCK */
631         s32     RegE94;
632         s32     RegE9C;
633         s32     RegEB4;
634         s32     RegEBC;
635
636         u8      TXPowercount;
637         bool    bTXPowerTrackingInit;
638         bool    bTXPowerTracking;
639         u8      TxPowerTrackControl; /* for mp mode, turn off txpwrtracking
640                                       * as default */
641         u8      TM_Trigger;
642         u8      InternalPA5G[2];        /* pathA / pathB */
643
644         u8      ThermalMeter[2];    /* ThermalMeter, index 0 for RFIC0,
645                                      * and 1 for RFIC1 */
646         u8      ThermalValue;
647         u8      ThermalValue_LCK;
648         u8      ThermalValue_IQK;
649         u8      ThermalValue_DPK;
650         u8      ThermalValue_AVG[AVG_THERMAL_NUM];
651         u8      ThermalValue_AVG_index;
652         u8      ThermalValue_RxGain;
653         u8      ThermalValue_Crystal;
654         u8      ThermalValue_DPKstore;
655         u8      ThermalValue_DPKtrack;
656         bool    TxPowerTrackingInProgress;
657         bool    bDPKenable;
658
659         bool    bReloadtxpowerindex;
660         u8      bRfPiEnable;
661         u32     TXPowerTrackingCallbackCnt; /* cosa add for debug */
662
663         u8      bCCKinCH14;
664         u8      CCK_index;
665         u8      OFDM_index[2];
666         bool bDoneTxpower;
667
668         u8      ThermalValue_HP[HP_THERMAL_NUM];
669         u8      ThermalValue_HP_index;
670         struct ijk_matrix_regs_set IQKMatrixRegSetting[IQK_Matrix_Settings_NUM];
671
672         u8      Delta_IQK;
673         u8      Delta_LCK;
674
675         /* for IQK */
676         u32     RegC04;
677         u32     Reg874;
678         u32     RegC08;
679         u32     RegB68;
680         u32     RegB6C;
681         u32     Reg870;
682         u32     Reg860;
683         u32     Reg864;
684
685         bool    bIQKInitialized;
686         bool    bLCKInProgress;
687         bool    bAntennaDetected;
688         u32     ADDA_backup[IQK_ADDA_REG_NUM];
689         u32     IQK_MAC_backup[IQK_MAC_REG_NUM];
690         u32     IQK_BB_backup_recover[9];
691         u32     IQK_BB_backup[IQK_BB_REG_NUM];
692
693         /* for APK */
694         u32     APKoutput[2][2]; /* path A/B; output1_1a/output1_2a */
695         u8      bAPKdone;
696         u8      bAPKThermalMeterIgnore;
697         u8      bDPdone;
698         u8      bDPPathAOK;
699         u8      bDPPathBOK;
700 };
701
702 /*  ODM Dynamic common info value definition */
703
704 struct fast_ant_train {
705         u8      Bssid[6];
706         u8      antsel_rx_keep_0;
707         u8      antsel_rx_keep_1;
708         u8      antsel_rx_keep_2;
709         u32     antSumRSSI[7];
710         u32     antRSSIcnt[7];
711         u32     antAveRSSI[7];
712         u8      FAT_State;
713         u32     TrainIdx;
714         u8      antsel_a[ODM_ASSOCIATE_ENTRY_NUM];
715         u8      antsel_b[ODM_ASSOCIATE_ENTRY_NUM];
716         u8      antsel_c[ODM_ASSOCIATE_ENTRY_NUM];
717         u32     MainAnt_Sum[ODM_ASSOCIATE_ENTRY_NUM];
718         u32     AuxAnt_Sum[ODM_ASSOCIATE_ENTRY_NUM];
719         u32     MainAnt_Cnt[ODM_ASSOCIATE_ENTRY_NUM];
720         u32     AuxAnt_Cnt[ODM_ASSOCIATE_ENTRY_NUM];
721         u8      RxIdleAnt;
722         bool    bBecomeLinked;
723 };
724
725 enum fat_state {
726         FAT_NORMAL_STATE                = 0,
727         FAT_TRAINING_STATE              = 1,
728 };
729
730 enum ant_div_type {
731         NO_ANTDIV                       = 0xFF,
732         CG_TRX_HW_ANTDIV                = 0x01,
733         CGCS_RX_HW_ANTDIV               = 0x02,
734         FIXED_HW_ANTDIV                 = 0x03,
735         CG_TRX_SMART_ANTDIV             = 0x04,
736         CGCS_RX_SW_ANTDIV               = 0x05,
737 };
738
739 /* Copy from SD4 defined structure. We use to support PHY DM integration. */
740 struct odm_dm_struct {
741         /*      Add for different team use temporarily */
742         struct adapter *Adapter;        /*  For CE/NIC team */
743         struct rtl8192cd_priv *priv;    /*  For AP/ADSL team */
744         /*  WHen you use above pointers, they must be initialized. */
745         bool    odm_ready;
746
747         struct rtl8192cd_priv *fake_priv;
748         u64     DebugComponents;
749         u32     DebugLevel;
750
751 /*  ODM HANDLE, DRIVER NEEDS NOT TO HOOK------ */
752         bool    bCckHighPower;
753         u8      RFPathRxEnable;         /*  ODM_CMNINFO_RFPATH_ENABLE */
754         u8      ControlChannel;
755 /*  ODM HANDLE, DRIVER NEEDS NOT TO HOOK------ */
756
757 /* 1  COMMON INFORMATION */
758         /*  Init Value */
759 /* HOOK BEFORE REG INIT----------- */
760         /*  ODM Platform info AP/ADSL/CE/MP = 1/2/3/4 */
761         u8      SupportPlatform;
762         /*  ODM Support Ability DIG/RATR/TX_PWR_TRACK/ Â¡K¡K = 1/2/3/¡K */
763         u32     SupportAbility;
764         /*  ODM PCIE/USB/SDIO/GSPI = 0/1/2/3 */
765         u8      SupportInterface;
766         /*  ODM composite or independent. Bit oriented/ 92C+92D+ .... or any
767          *  other type = 1/2/3/... */
768         u32     SupportICType;
769         /*  Cut Version TestChip/A-cut/B-cut... = 0/1/2/3/... */
770         u8      CutVersion;
771         /*  Fab Version TSMC/UMC = 0/1 */
772         u8      FabVersion;
773         /*  RF Type 4T4R/3T3R/2T2R/1T2R/1T1R/... */
774         u8      RFType;
775         /*  Board Type Normal/HighPower/MiniCard/SLIM/Combo/. = 0/1/2/3/4/. */
776         u8      BoardType;
777         /*  with external LNA  NO/Yes = 0/1 */
778         u8      ExtLNA;
779         /*  with external PA  NO/Yes = 0/1 */
780         u8      ExtPA;
781         /*  with external TRSW  NO/Yes = 0/1 */
782         u8      ExtTRSW;
783         u8      PatchID; /* Customer ID */
784         bool    bInHctTest;
785         bool    bWIFITest;
786
787         bool    bDualMacSmartConcurrent;
788         u32     BK_SupportAbility;
789         u8      AntDivType;
790 /* HOOK BEFORE REG INIT----------- */
791
792         /*  Dynamic Value */
793 /*  POINTER REFERENCE----------- */
794
795         u8      u8_temp;
796         bool    bool_temp;
797         struct adapter *adapter_temp;
798
799         /*  MAC PHY Mode SMSP/DMSP/DMDP = 0/1/2 */
800         u8      *pMacPhyMode;
801         /* TX Unicast byte count */
802         u64     *pNumTxBytesUnicast;
803         /* RX Unicast byte count */
804         u64     *pNumRxBytesUnicast;
805         /*  Wireless mode B/G/A/N = BIT0/BIT1/BIT2/BIT3 */
806         u8      *pWirelessMode; /* ODM_WIRELESS_MODE_E */
807         /*  Frequence band 2.4G/5G = 0/1 */
808         u8      *pBandType;
809         /*  Secondary channel offset don't_care/below/above = 0/1/2 */
810         u8      *pSecChOffset;
811         /*  Security mode Open/WEP/AES/TKIP = 0/1/2/3 */
812         u8      *pSecurity;
813         /*  BW info 20M/40M/80M = 0/1/2 */
814         u8      *pBandWidth;
815         /*  Central channel location Ch1/Ch2/.... */
816         u8      *pChannel;      /* central channel number */
817         /*  Common info for 92D DMSP */
818
819         bool    *pbGetValueFromOtherMac;
820         struct adapter **pBuddyAdapter;
821         bool    *pbMasterOfDMSP; /* MAC0: master, MAC1: slave */
822         /*  Common info for Status */
823         bool    *pbScanInProcess;
824         bool    *pbPowerSaving;
825         /*  CCA Path 2-path/path-A/path-B = 0/1/2; using ODM_CCA_PATH_E. */
826         u8      *pOnePathCCA;
827         /* pMgntInfo->AntennaTest */
828         u8      *pAntennaTest;
829         bool    *pbNet_closed;
830 /*  POINTER REFERENCE----------- */
831         /*  */
832 /* CALL BY VALUE------------- */
833         bool    bWIFI_Direct;
834         bool    bWIFI_Display;
835         bool    bLinked;
836         u8      RSSI_Min;
837         u8      InterfaceIndex; /*  Add for 92D  dual MAC: 0--Mac0 1--Mac1 */
838         bool    bIsMPChip;
839         bool    bOneEntryOnly;
840         /*  Common info for BTDM */
841         bool    bBtDisabled;    /*  BT is disabled */
842         bool    bBtHsOperation; /*  BT HS mode is under progress */
843         u8      btHsDigVal;     /*  use BT rssi to decide the DIG value */
844         bool    bBtDisableEdcaTurbo;/* Under some condition, don't enable the
845                                      * EDCA Turbo */
846         bool    bBtBusy;                        /*  BT is busy. */
847 /* CALL BY VALUE------------- */
848
849         /* 2 Define STA info. */
850         /*  _ODM_STA_INFO */
851         /*  For MP, we need to reduce one array pointer for default port.?? */
852         struct sta_info *pODM_StaInfo[ODM_ASSOCIATE_ENTRY_NUM];
853
854         u16     CurrminRptTime;
855         struct odm_ra_info RAInfo[ODM_ASSOCIATE_ENTRY_NUM]; /* Use MacID as
856                         * array index. STA MacID=0,
857                         * VWiFi Client MacID={1, ODM_ASSOCIATE_ENTRY_NUM-1} */
858         /*  */
859         /*  2012/02/14 MH Add to share 88E ra with other SW team. */
860         /*  We need to colelct all support abilit to a proper area. */
861         /*  */
862         bool    RaSupport88E;
863
864         /*  Define ........... */
865
866         /*  Latest packet phy info (ODM write) */
867         struct odm_phy_dbg_info PhyDbgInfo;
868
869         /*  Latest packet phy info (ODM write) */
870         struct odm_mac_status_info *pMacInfo;
871
872         /*  Different Team independt structure?? */
873
874         /* ODM Structure */
875         struct fast_ant_train DM_FatTable;
876         struct rtw_dig  DM_DigTable;
877         struct rtl_ps   DM_PSTable;
878         struct dyn_primary_cca DM_PriCCA;
879         struct rx_hpc   DM_RXHP_Table;
880         struct false_alarm_stats FalseAlmCnt;
881         struct false_alarm_stats FlaseAlmCntBuddyAdapter;
882         struct sw_ant_switch DM_SWAT_Table;
883         bool            RSSI_test;
884
885         struct edca_turbo DM_EDCA_Table;
886         u32             WMMEDCA_BE;
887         /*  Copy from SD4 structure */
888         /*  */
889         /*  ================================================== */
890         /*  */
891
892         bool    *pbDriverStopped;
893         bool    *pbDriverIsGoingToPnpSetPowerSleep;
894         bool    *pinit_adpt_in_progress;
895
896         /* PSD */
897         bool    bUserAssignLevel;
898         struct timer_list PSDTimer;
899         u8      RSSI_BT;                        /* come from BT */
900         bool    bPSDinProcess;
901         bool    bDMInitialGainEnable;
902
903         /* for rate adaptive, in fact,  88c/92c fw will handle this */
904         u8      bUseRAMask;
905
906         struct odm_rate_adapt RateAdaptive;
907
908         struct odm_rf_cal RFCalibrateInfo;
909
910         /*  TX power tracking */
911         u8      BbSwingIdxOfdm;
912         u8      BbSwingIdxOfdmCurrent;
913         u8      BbSwingIdxOfdmBase;
914         bool    BbSwingFlagOfdm;
915         u8      BbSwingIdxCck;
916         u8      BbSwingIdxCckCurrent;
917         u8      BbSwingIdxCckBase;
918         bool    BbSwingFlagCck;
919         u8      *mp_mode;
920         /*  ODM system resource. */
921
922         /*  ODM relative time. */
923         struct timer_list PathDivSwitchTimer;
924         /* 2011.09.27 add for Path Diversity */
925         struct timer_list CCKPathDiversityTimer;
926         struct timer_list FastAntTrainingTimer;
927 };              /*  DM_Dynamic_Mechanism_Structure */
928
929 #define ODM_RF_PATH_MAX 3
930
931 enum ODM_RF_RADIO_PATH {
932         ODM_RF_PATH_A = 0,   /* Radio Path A */
933         ODM_RF_PATH_B = 1,   /* Radio Path B */
934         ODM_RF_PATH_C = 2,   /* Radio Path C */
935         ODM_RF_PATH_D = 3,   /* Radio Path D */
936 };
937
938 enum ODM_RF_CONTENT {
939         odm_radioa_txt = 0x1000,
940         odm_radiob_txt = 0x1001,
941         odm_radioc_txt = 0x1002,
942         odm_radiod_txt = 0x1003
943 };
944
945 enum odm_bb_config_type {
946     CONFIG_BB_PHY_REG,
947     CONFIG_BB_AGC_TAB,
948     CONFIG_BB_AGC_TAB_2G,
949     CONFIG_BB_AGC_TAB_5G,
950     CONFIG_BB_PHY_REG_PG,
951 };
952
953 /*  Status code */
954 enum rt_status {
955         RT_STATUS_SUCCESS,
956         RT_STATUS_FAILURE,
957         RT_STATUS_PENDING,
958         RT_STATUS_RESOURCE,
959         RT_STATUS_INVALID_CONTEXT,
960         RT_STATUS_INVALID_PARAMETER,
961         RT_STATUS_NOT_SUPPORT,
962         RT_STATUS_OS_API_FAILED,
963 };
964
965 /* 3=========================================================== */
966 /* 3 DIG */
967 /* 3=========================================================== */
968
969 enum dm_dig_op {
970         RT_TYPE_THRESH_HIGH     = 0,
971         RT_TYPE_THRESH_LOW      = 1,
972         RT_TYPE_BACKOFF         = 2,
973         RT_TYPE_RX_GAIN_MIN     = 3,
974         RT_TYPE_RX_GAIN_MAX     = 4,
975         RT_TYPE_ENABLE          = 5,
976         RT_TYPE_DISABLE         = 6,
977         DIG_OP_TYPE_MAX
978 };
979
980 #define         DM_DIG_THRESH_HIGH      40
981 #define         DM_DIG_THRESH_LOW       35
982
983 #define         DM_SCAN_RSSI_TH         0x14 /* scan return issue for LC */
984
985
986 #define         DM_false_ALARM_THRESH_LOW       400
987 #define         DM_false_ALARM_THRESH_HIGH      1000
988
989 #define         DM_DIG_MAX_NIC                  0x4e
990 #define         DM_DIG_MIN_NIC                  0x1e /* 0x22/0x1c */
991
992 #define         DM_DIG_MAX_AP                   0x32
993 #define         DM_DIG_MIN_AP                   0x20
994
995 #define         DM_DIG_MAX_NIC_HP               0x46
996 #define         DM_DIG_MIN_NIC_HP               0x2e
997
998 #define         DM_DIG_MAX_AP_HP                0x42
999 #define         DM_DIG_MIN_AP_HP                0x30
1000
1001 /* vivi 92c&92d has different definition, 20110504 */
1002 /* this is for 92c */
1003 #define         DM_DIG_FA_TH0                   0x200/* 0x20 */
1004 #define         DM_DIG_FA_TH1                   0x300/* 0x100 */
1005 #define         DM_DIG_FA_TH2                   0x400/* 0x200 */
1006 /* this is for 92d */
1007 #define         DM_DIG_FA_TH0_92D               0x100
1008 #define         DM_DIG_FA_TH1_92D               0x400
1009 #define         DM_DIG_FA_TH2_92D               0x600
1010
1011 #define         DM_DIG_BACKOFF_MAX              12
1012 #define         DM_DIG_BACKOFF_MIN              -4
1013 #define         DM_DIG_BACKOFF_DEFAULT          10
1014
1015 /* 3=========================================================== */
1016 /* 3 AGC RX High Power Mode */
1017 /* 3=========================================================== */
1018 #define   LNA_Low_Gain_1                0x64
1019 #define   LNA_Low_Gain_2                0x5A
1020 #define   LNA_Low_Gain_3                0x58
1021
1022 #define   FA_RXHP_TH1                   5000
1023 #define   FA_RXHP_TH2                   1500
1024 #define   FA_RXHP_TH3                   800
1025 #define   FA_RXHP_TH4                   600
1026 #define   FA_RXHP_TH5                   500
1027
1028 /* 3=========================================================== */
1029 /* 3 EDCA */
1030 /* 3=========================================================== */
1031
1032 /* 3=========================================================== */
1033 /* 3 Dynamic Tx Power */
1034 /* 3=========================================================== */
1035 /* Dynamic Tx Power Control Threshold */
1036 #define         TX_POWER_NEAR_FIELD_THRESH_LVL2 74
1037 #define         TX_POWER_NEAR_FIELD_THRESH_LVL1 67
1038 #define         TX_POWER_NEAR_FIELD_THRESH_AP           0x3F
1039
1040 #define         TxHighPwrLevel_Normal           0
1041 #define         TxHighPwrLevel_Level1           1
1042 #define         TxHighPwrLevel_Level2           2
1043 #define         TxHighPwrLevel_BT1              3
1044 #define         TxHighPwrLevel_BT2              4
1045 #define         TxHighPwrLevel_15               5
1046 #define         TxHighPwrLevel_35               6
1047 #define         TxHighPwrLevel_50               7
1048 #define         TxHighPwrLevel_70               8
1049 #define         TxHighPwrLevel_100              9
1050
1051 /* 3=========================================================== */
1052 /* 3 Rate Adaptive */
1053 /* 3=========================================================== */
1054 #define         DM_RATR_STA_INIT                0
1055 #define         DM_RATR_STA_HIGH                1
1056 #define         DM_RATR_STA_MIDDLE              2
1057 #define         DM_RATR_STA_LOW                 3
1058
1059 /* 3=========================================================== */
1060 /* 3 BB Power Save */
1061 /* 3=========================================================== */
1062
1063
1064 enum dm_1r_cca {
1065         CCA_1R = 0,
1066         CCA_2R = 1,
1067         CCA_MAX = 2,
1068 };
1069
1070 enum dm_rf {
1071         RF_Save = 0,
1072         RF_Normal = 1,
1073         RF_MAX = 2,
1074 };
1075
1076 /* 3=========================================================== */
1077 /* 3 Antenna Diversity */
1078 /* 3=========================================================== */
1079 enum dm_swas {
1080         Antenna_A = 1,
1081         Antenna_B = 2,
1082         Antenna_MAX = 3,
1083 };
1084
1085 /*  Maximal number of antenna detection mechanism needs to perform. */
1086 #define MAX_ANTENNA_DETECTION_CNT       10
1087
1088 /*  Extern Global Variables. */
1089 #define OFDM_TABLE_SIZE_92C     37
1090 #define OFDM_TABLE_SIZE_92D     43
1091 #define CCK_TABLE_SIZE          33
1092
1093 extern  u32 OFDMSwingTable[OFDM_TABLE_SIZE_92D];
1094 extern  u8 CCKSwingTable_Ch1_Ch13[CCK_TABLE_SIZE][8];
1095 extern  u8 CCKSwingTable_Ch14 [CCK_TABLE_SIZE][8];
1096
1097 /*  check Sta pointer valid or not */
1098 #define IS_STA_VALID(pSta)              (pSta)
1099 /*  20100514 Joseph: Add definition for antenna switching test after link. */
1100 /*  This indicates two different the steps. */
1101 /*  In SWAW_STEP_PEAK, driver needs to switch antenna and listen to the
1102  *  signal on the air. */
1103 /*  In SWAW_STEP_DETERMINE, driver just compares the signal captured in
1104  *  SWAW_STEP_PEAK */
1105 /*  with original RSSI to determine if it is necessary to switch antenna. */
1106 #define SWAW_STEP_PEAK          0
1107 #define SWAW_STEP_DETERMINE     1
1108
1109 #define dm_CheckTXPowerTracking ODM_TXPowerTrackingCheck
1110 #define dm_RF_Saving    ODM_RF_Saving
1111
1112 void ODM_RF_Saving(struct odm_dm_struct *pDM_Odm, u8 bForceInNormal);
1113 void ODM_TXPowerTrackingCheck(struct odm_dm_struct *pDM_Odm);
1114 void odm_DIGbyRSSI_LPS(struct odm_dm_struct *pDM_Odm);
1115 void ODM_Write_CCK_CCA_Thres(struct odm_dm_struct *pDM_Odm, u8 CurCCK_CCAThres);
1116 bool ODM_RAStateCheck(struct odm_dm_struct *pDM_Odm, s32 RSSI,
1117                       bool bForceUpdate, u8 *pRATRState);
1118 u32 ConvertTo_dB(u32 Value);
1119 u32 ODM_Get_Rate_Bitmap(struct odm_dm_struct *pDM_Odm, u32 macid,
1120                         u32 ra_mask, u8 rssi_level);
1121 void ODM_CmnInfoInit(struct odm_dm_struct *pDM_Odm,
1122                      enum odm_common_info_def CmnInfo, u32 Value);
1123 void ODM_CmnInfoUpdate(struct odm_dm_struct *pDM_Odm, u32 CmnInfo, u64 Value);
1124 void ODM_CmnInfoHook(struct odm_dm_struct *pDM_Odm,
1125                      enum odm_common_info_def CmnInfo, void *pValue);
1126 void ODM_CmnInfoPtrArrayHook(struct odm_dm_struct *pDM_Odm,
1127                              enum odm_common_info_def CmnInfo,
1128                              u16 Index, void *pValue);
1129 void ODM_DMInit(struct odm_dm_struct *pDM_Odm);
1130 void ODM_DMWatchdog(struct odm_dm_struct *pDM_Odm);
1131 void ODM_Write_DIG(struct odm_dm_struct *pDM_Odm, u8 CurrentIGI);
1132
1133 #endif