8723BU: Update 8723BU wifi driver to version v4.3.16_14189.20150519_BTCOEX2015119...
[firefly-linux-kernel-4.4.55.git] / drivers / net / wireless / rockchip_wlan / rtl8723bu / include / HalVerDef.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 #ifndef __HAL_VERSION_DEF_H__
21 #define __HAL_VERSION_DEF_H__
22
23 #define TRUE    _TRUE   
24 #define FALSE   _FALSE
25
26 // HAL_IC_TYPE_E
27 typedef enum tag_HAL_IC_Type_Definition
28 {
29         CHIP_8192S      =       0,
30         CHIP_8188C      =       1,
31         CHIP_8192C      =       2,
32         CHIP_8192D      =       3,
33         CHIP_8723A      =       4,
34         CHIP_8188E      =       5,
35         CHIP_8812       =       6,
36         CHIP_8821       =       7,
37         CHIP_8723B      =       8,
38         CHIP_8192E      =       9,
39         CHIP_8814A      =       10,
40 }HAL_IC_TYPE_E;
41
42 //HAL_CHIP_TYPE_E
43 typedef enum tag_HAL_CHIP_Type_Definition
44 {
45         TEST_CHIP               =       0,
46         NORMAL_CHIP     =       1,
47         FPGA                    =       2,
48 }HAL_CHIP_TYPE_E;
49
50 //HAL_CUT_VERSION_E
51 typedef enum tag_HAL_Cut_Version_Definition
52 {
53         A_CUT_VERSION           =       0,
54         B_CUT_VERSION           =       1,
55         C_CUT_VERSION           =       2,
56         D_CUT_VERSION           =       3,
57         E_CUT_VERSION           =       4,
58         F_CUT_VERSION           =       5,
59         G_CUT_VERSION           =       6,
60         H_CUT_VERSION           =       7,      
61         I_CUT_VERSION           =       8,
62         J_CUT_VERSION           =       9,
63         K_CUT_VERSION           =       10,
64 }HAL_CUT_VERSION_E;
65
66 // HAL_Manufacturer
67 typedef enum tag_HAL_Manufacturer_Version_Definition
68 {
69         CHIP_VENDOR_TSMC        =       0,
70         CHIP_VENDOR_UMC         =       1,
71         CHIP_VENDOR_SMIC        =       2, 
72 }HAL_VENDOR_E;
73
74 typedef enum tag_HAL_RF_Type_Definition
75 {
76         RF_TYPE_1T1R    =       0,
77         RF_TYPE_1T2R    =       1,
78         RF_TYPE_2T2R    =       2,
79         RF_TYPE_2T3R    =       3,
80         RF_TYPE_2T4R    =       4,
81         RF_TYPE_3T3R    =       5,
82         RF_TYPE_3T4R    =       6,
83         RF_TYPE_4T4R    =       7,
84 }HAL_RF_TYPE_E;
85
86 typedef struct tag_HAL_VERSION
87 {
88         HAL_IC_TYPE_E           ICType;
89         HAL_CHIP_TYPE_E         ChipType;
90         HAL_CUT_VERSION_E       CUTVersion;
91         HAL_VENDOR_E            VendorType;
92         HAL_RF_TYPE_E           RFType; 
93         u8                                      ROMVer;
94 }HAL_VERSION,*PHAL_VERSION;
95
96 //VERSION_8192C                 VersionID;
97 //HAL_VERSION                   VersionID;
98
99 // Get element
100 #define GET_CVID_IC_TYPE(version)                       ((HAL_IC_TYPE_E)(((HAL_VERSION)version).ICType) )
101 #define GET_CVID_CHIP_TYPE(version)                     ((HAL_CHIP_TYPE_E)(((HAL_VERSION)version).ChipType)     )
102 #define GET_CVID_RF_TYPE(version)                       ((HAL_RF_TYPE_E)(((HAL_VERSION)version).RFType))
103 #define GET_CVID_MANUFACTUER(version)           ((HAL_VENDOR_E)(((HAL_VERSION)version).VendorType))
104 #define GET_CVID_CUT_VERSION(version)           ((HAL_CUT_VERSION_E)(((HAL_VERSION)version).CUTVersion))
105 #define GET_CVID_ROM_VERSION(version)           ((((HAL_VERSION)version).ROMVer) & ROM_VERSION_MASK)
106
107 //----------------------------------------------------------------------------
108 //Common Macro. --
109 //----------------------------------------------------------------------------
110 //HAL_VERSION VersionID
111
112 // HAL_IC_TYPE_E
113 #if 0
114 #define IS_81XXC(version)                               (((GET_CVID_IC_TYPE(version) == CHIP_8192C)||(GET_CVID_IC_TYPE(version) == CHIP_8188C))? TRUE : FALSE)
115 #define IS_8723_SERIES(version)                 ((GET_CVID_IC_TYPE(version) == CHIP_8723A)? TRUE : FALSE)
116 #define IS_92D(version)                                 ((GET_CVID_IC_TYPE(version) == CHIP_8192D)? TRUE : FALSE)
117 #endif
118
119 #define IS_8188E(version)                                       ((GET_CVID_IC_TYPE(version) == CHIP_8188E)? TRUE : FALSE)
120 #define IS_8192E(version)                                       ((GET_CVID_IC_TYPE(version) == CHIP_8192E)? TRUE : FALSE)
121 #define IS_8812_SERIES(version)                 ((GET_CVID_IC_TYPE(version) == CHIP_8812)? TRUE : FALSE)
122 #define IS_8821_SERIES(version)                 ((GET_CVID_IC_TYPE(version) == CHIP_8821)? TRUE : FALSE)
123 #define IS_8814A_SERIES(version)                        ((GET_CVID_IC_TYPE(version) == CHIP_8814A) ? TRUE : FALSE)
124 #define IS_8723B_SERIES(version)                        ((GET_CVID_IC_TYPE(version) == CHIP_8723B)? TRUE : FALSE)
125
126
127 //HAL_CHIP_TYPE_E
128 #define IS_TEST_CHIP(version)                   ((GET_CVID_CHIP_TYPE(version)==TEST_CHIP)? TRUE: FALSE)
129 #define IS_NORMAL_CHIP(version)                 ((GET_CVID_CHIP_TYPE(version)==NORMAL_CHIP)? TRUE: FALSE)
130
131 //HAL_CUT_VERSION_E
132 #define IS_A_CUT(version)                               ((GET_CVID_CUT_VERSION(version) == A_CUT_VERSION) ? TRUE : FALSE)
133 #define IS_B_CUT(version)                               ((GET_CVID_CUT_VERSION(version) == B_CUT_VERSION) ? TRUE : FALSE)
134 #define IS_C_CUT(version)                               ((GET_CVID_CUT_VERSION(version) == C_CUT_VERSION) ? TRUE : FALSE)
135 #define IS_D_CUT(version)                               ((GET_CVID_CUT_VERSION(version) == D_CUT_VERSION) ? TRUE : FALSE)
136 #define IS_E_CUT(version)                               ((GET_CVID_CUT_VERSION(version) == E_CUT_VERSION) ? TRUE : FALSE)
137 #define IS_F_CUT(version)                               ((GET_CVID_CUT_VERSION(version) == F_CUT_VERSION) ? TRUE : FALSE)
138 #define IS_I_CUT(version)                               ((GET_CVID_CUT_VERSION(version) == I_CUT_VERSION) ? TRUE : FALSE)
139 #define IS_J_CUT(version)                               ((GET_CVID_CUT_VERSION(version) == J_CUT_VERSION) ? TRUE : FALSE)
140 #define IS_K_CUT(version)                               ((GET_CVID_CUT_VERSION(version) == K_CUT_VERSION) ? TRUE : FALSE)
141
142 //HAL_VENDOR_E
143 #define IS_CHIP_VENDOR_TSMC(version)    ((GET_CVID_MANUFACTUER(version) == CHIP_VENDOR_TSMC)? TRUE: FALSE)
144 #define IS_CHIP_VENDOR_UMC(version)     ((GET_CVID_MANUFACTUER(version) == CHIP_VENDOR_UMC)? TRUE: FALSE)
145 #define IS_CHIP_VENDOR_SMIC(version)    ((GET_CVID_MANUFACTUER(version) == CHIP_VENDOR_SMIC)? TRUE: FALSE)
146
147 //HAL_RF_TYPE_E
148 #define IS_1T1R(version)                                        ((GET_CVID_RF_TYPE(version) == RF_TYPE_1T1R)? TRUE : FALSE )
149 #define IS_1T2R(version)                                        ((GET_CVID_RF_TYPE(version) == RF_TYPE_1T2R)? TRUE : FALSE)
150 #define IS_2T2R(version)                                        ((GET_CVID_RF_TYPE(version) == RF_TYPE_2T2R)? TRUE : FALSE)
151 #define IS_3T3R(version)                                        ((GET_CVID_RF_TYPE(version) == RF_TYPE_3T3R)? TRUE : FALSE)
152 #define IS_3T4R(version)                                        ((GET_CVID_RF_TYPE(version) == RF_TYPE_3T4R)? TRUE : FALSE)
153 #define IS_4T4R(version)                                        ((GET_CVID_RF_TYPE(version) == RF_TYPE_4T4R)? TRUE : FALSE)
154
155
156
157 //----------------------------------------------------------------------------
158 //Chip version Macro. --
159 //----------------------------------------------------------------------------
160 #if 0
161 #define IS_81XXC_TEST_CHIP(version)             ((IS_81XXC(version) && (!IS_NORMAL_CHIP(version)))? TRUE: FALSE)
162
163 #define IS_92C_SERIAL(version)                                          ((IS_81XXC(version) && IS_2T2R(version)) ? TRUE : FALSE)
164 #define IS_81xxC_VENDOR_UMC_A_CUT(version)      (IS_81XXC(version)?(IS_CHIP_VENDOR_UMC(version) ? (IS_A_CUT(version) ? TRUE : FALSE) : FALSE): FALSE)
165 #define IS_81xxC_VENDOR_UMC_B_CUT(version)      (IS_81XXC(version)?(IS_CHIP_VENDOR_UMC(version) ? (IS_B_CUT(version) ? TRUE : FALSE) : FALSE): FALSE)
166 #define IS_81xxC_VENDOR_UMC_C_CUT(version)      (IS_81XXC(version)?(IS_CHIP_VENDOR_UMC(version) ? (IS_C_CUT(version) ? TRUE : FALSE) : FALSE): FALSE)
167
168 #define IS_NORMAL_CHIP92D(version)              (( IS_92D(version))?((GET_CVID_CHIP_TYPE(version)==NORMAL_CHIP)? TRUE: FALSE):FALSE)
169
170 #define IS_92D_SINGLEPHY(version)               ((IS_92D(version)) ? (IS_2T2R(version) ? TRUE: FALSE) : FALSE)
171 #define IS_92D_C_CUT(version)                   ((IS_92D(version)) ? (IS_C_CUT(version) ? TRUE : FALSE) : FALSE)
172 #define IS_92D_D_CUT(version)                   ((IS_92D(version)) ? (IS_D_CUT(version) ? TRUE : FALSE) : FALSE)
173 #define IS_92D_E_CUT(version)                   ((IS_92D(version)) ? (IS_E_CUT(version) ? TRUE : FALSE) : FALSE)
174
175 #define IS_8723A_A_CUT(version)                         ((IS_8723_SERIES(version)) ? ( IS_A_CUT(version)?TRUE : FALSE) : FALSE)
176 #define IS_8723A_B_CUT(version)                         ((IS_8723_SERIES(version)) ? ( IS_B_CUT(version)?TRUE : FALSE) : FALSE)
177 #endif
178
179 #define IS_VENDOR_8188E_I_CUT_SERIES(_Adapter)          ((IS_8188E(GET_HAL_DATA(_Adapter)->VersionID)) ? ((GET_CVID_CUT_VERSION(GET_HAL_DATA(_Adapter)->VersionID) >= I_CUT_VERSION) ? TRUE : FALSE) : FALSE)
180
181 #define IS_VENDOR_8812A_TEST_CHIP(_Adapter)             ((IS_8812_SERIES(GET_HAL_DATA(_Adapter)->VersionID)) ? ((IS_NORMAL_CHIP(GET_HAL_DATA(_Adapter)->VersionID)) ? FALSE : TRUE) : FALSE)
182 #define IS_VENDOR_8812A_MP_CHIP(_Adapter)               ((IS_8812_SERIES(GET_HAL_DATA(_Adapter)->VersionID)) ? ((IS_NORMAL_CHIP(GET_HAL_DATA(_Adapter)->VersionID)) ? TRUE : FALSE) : FALSE)
183 #define IS_VENDOR_8812A_C_CUT(_Adapter)                 ((IS_8812_SERIES(GET_HAL_DATA(_Adapter)->VersionID)) ? ((GET_CVID_CUT_VERSION(GET_HAL_DATA(_Adapter)->VersionID) == C_CUT_VERSION) ? TRUE : FALSE) : FALSE)
184
185 #define IS_VENDOR_8821A_TEST_CHIP(_Adapter)     ((IS_8821_SERIES(GET_HAL_DATA(_Adapter)->VersionID)) ? ((IS_NORMAL_CHIP(GET_HAL_DATA(_Adapter)->VersionID)) ? FALSE : TRUE) : FALSE)
186 #define IS_VENDOR_8821A_MP_CHIP(_Adapter)               ((IS_8821_SERIES(GET_HAL_DATA(_Adapter)->VersionID)) ? ((IS_NORMAL_CHIP(GET_HAL_DATA(_Adapter)->VersionID)) ? TRUE : FALSE) : FALSE)
187
188 #define IS_VENDOR_8192E_B_CUT(_Adapter)         ((GET_CVID_CUT_VERSION(GET_HAL_DATA(_Adapter)->VersionID) == B_CUT_VERSION) ? TRUE : FALSE)
189
190 #define IS_VENDOR_8723B_TEST_CHIP(_Adapter)     ((IS_8723B_SERIES(GET_HAL_DATA(_Adapter)->VersionID)) ? ((IS_NORMAL_CHIP(GET_HAL_DATA(_Adapter)->VersionID)) ? FALSE : TRUE) : FALSE)
191 #define IS_VENDOR_8723B_MP_CHIP(_Adapter)               ((IS_8723B_SERIES(GET_HAL_DATA(_Adapter)->VersionID)) ? ((IS_NORMAL_CHIP(GET_HAL_DATA(_Adapter)->VersionID)) ? TRUE : FALSE) : FALSE)
192
193 #endif
194