Merge branch 'master' of ozlabs.org:ccan
[ccan] / ccan / cpuid / cpuid.h
1 /*
2  * Copyright (c) 2013 Ahmed Samy  <f.fallen45@gmail.com>
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a copy
5  * of this software and associated documentation files (the "Software"), to deal
6  * in the Software without restriction, including without limitation the rights
7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8  * copies of the Software, and to permit persons to whom the Software is
9  * furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20  * THE SOFTWARE.
21  */
22 #ifndef CCAN_CPUID_H
23 #define CCAN_CPUID_H
24
25 #include <stdbool.h>
26 #include <stdint.h>
27
28 /**
29  * enum cpuid - stuff to get information about from the CPU.
30  *
31  * This is used as a parameter in cpuid().
32  *
33  * CPUID_VENDORID:
34  *      The CPU's Vendor ID.
35  *
36  * CPUID_PROCINFO_AND_FEATUREBITS:
37  *      Processor information and feature bits (SSE, etc.).
38  *
39  * CPUID_CACHE_AND_TLBD_INFO
40  *      Cache and TLBD Information.
41  *      For AMD: Use CPUID_EXTENDED_L2_CACHE_FEATURES
42  *
43  * CPUID_HIGHEST_EXTENDED_FUNCTION_SUPPORTED:
44  *      Highest extended function supported address.
45  *      Can be like 0x80000008.
46  *
47  * CPUID_EXTENDED_PROC_INFO_FEATURE_BITS:
48  *      Extended processor information and feature bits (64bit etc.)
49  *
50  * CPUID_PROC_BRAND_STRING:
51  *      The Processor's brand string.
52  *
53  * CPUID_L1_CACHE_AND_TLB_IDS:
54  *      L1 Cache and TLB Identifications.
55  *      AMD Only.
56  *
57  * CPUID_EXTENDED_L2_CACHE_FEATURES:
58  *      Extended L2 Cache features.
59  *
60  * CPUID_ADV_POWER_MGT_INFO:
61  *      Advaned power management information.
62  *
63  * CPUID_VIRT_PHYS_ADDR_SIZES:
64  *      Virtual and physical address sizes.
65  */
66
67 typedef enum cpuid {
68         CPUID_VENDORID                                  = 0,
69         CPUID_PROCINFO_AND_FEATUREBITS                  = 1,
70         CPUID_CACHE_AND_TLBD_INFO                       = 2,
71
72         CPUID_HIGHEST_EXTENDED_FUNCTION_SUPPORTED       = 0x80000000,
73         CPUID_EXTENDED_PROC_INFO_FEATURE_BITS           = 0x80000001,
74         CPUID_PROC_BRAND_STRING                         = 0x80000002,
75         CPUID_L1_CACHE_AND_TLB_IDS                      = 0x80000005,
76         CPUID_EXTENDED_L2_CACHE_FEATURES                = 0x80000006,
77         CPUID_ADV_POWER_MGT_INFO                        = 0x80000007,
78         CPUID_VIRT_PHYS_ADDR_SIZES                      = 0x80000008
79 } cpuid_t;
80
81 enum {
82         CPUID_FEAT_ECX_SSE3         = 1 << 0, 
83         CPUID_FEAT_ECX_PCLMUL       = 1 << 1,
84         CPUID_FEAT_ECX_DTES64       = 1 << 2,
85         CPUID_FEAT_ECX_MONITOR      = 1 << 3,  
86         CPUID_FEAT_ECX_DS_CPL       = 1 << 4,  
87         CPUID_FEAT_ECX_VMX          = 1 << 5,  
88         CPUID_FEAT_ECX_SMX          = 1 << 6,  
89         CPUID_FEAT_ECX_EST          = 1 << 7,  
90         CPUID_FEAT_ECX_TM2          = 1 << 8,  
91         CPUID_FEAT_ECX_SSSE3        = 1 << 9,  
92         CPUID_FEAT_ECX_CID          = 1 << 10,
93         CPUID_FEAT_ECX_FMA          = 1 << 12,
94         CPUID_FEAT_ECX_CX16         = 1 << 13, 
95         CPUID_FEAT_ECX_ETPRD        = 1 << 14, 
96         CPUID_FEAT_ECX_PDCM         = 1 << 15, 
97         CPUID_FEAT_ECX_DCA          = 1 << 18, 
98         CPUID_FEAT_ECX_SSE4_1       = 1 << 19, 
99         CPUID_FEAT_ECX_SSE4_2       = 1 << 20, 
100         CPUID_FEAT_ECX_x2APIC       = 1 << 21, 
101         CPUID_FEAT_ECX_MOVBE        = 1 << 22, 
102         CPUID_FEAT_ECX_POPCNT       = 1 << 23, 
103         CPUID_FEAT_ECX_AES          = 1 << 25, 
104         CPUID_FEAT_ECX_XSAVE        = 1 << 26, 
105         CPUID_FEAT_ECX_OSXSAVE      = 1 << 27, 
106         CPUID_FEAT_ECX_AVX          = 1 << 28,
107
108         CPUID_FEAT_EDX_FPU          = 1 << 0,  
109         CPUID_FEAT_EDX_VME          = 1 << 1,  
110         CPUID_FEAT_EDX_DE           = 1 << 2,  
111         CPUID_FEAT_EDX_PSE          = 1 << 3,  
112         CPUID_FEAT_EDX_TSC          = 1 << 4,  
113         CPUID_FEAT_EDX_MSR          = 1 << 5,  
114         CPUID_FEAT_EDX_PAE          = 1 << 6,  
115         CPUID_FEAT_EDX_MCE          = 1 << 7,  
116         CPUID_FEAT_EDX_CX8          = 1 << 8,  
117         CPUID_FEAT_EDX_APIC         = 1 << 9,  
118         CPUID_FEAT_EDX_SEP          = 1 << 11, 
119         CPUID_FEAT_EDX_MTRR         = 1 << 12, 
120         CPUID_FEAT_EDX_PGE          = 1 << 13, 
121         CPUID_FEAT_EDX_MCA          = 1 << 14, 
122         CPUID_FEAT_EDX_CMOV         = 1 << 15, 
123         CPUID_FEAT_EDX_PAT          = 1 << 16, 
124         CPUID_FEAT_EDX_PSE36        = 1 << 17, 
125         CPUID_FEAT_EDX_PSN          = 1 << 18, 
126         CPUID_FEAT_EDX_CLF          = 1 << 19, 
127         CPUID_FEAT_EDX_DTES         = 1 << 21, 
128         CPUID_FEAT_EDX_ACPI         = 1 << 22, 
129         CPUID_FEAT_EDX_MMX          = 1 << 23, 
130         CPUID_FEAT_EDX_FXSR         = 1 << 24, 
131         CPUID_FEAT_EDX_SSE          = 1 << 25, 
132         CPUID_FEAT_EDX_SSE2         = 1 << 26, 
133         CPUID_FEAT_EDX_SS           = 1 << 27, 
134         CPUID_FEAT_EDX_HTT          = 1 << 28, 
135         CPUID_FEAT_EDX_TM1          = 1 << 29, 
136         CPUID_FEAT_EDX_IA64         = 1 << 30,
137         CPUID_FEAT_EDX_PBE          = 1 << 31
138 };
139
140 typedef enum cputype {
141         CT_NONE,
142         CT_AMDK5,
143         CT_AMD,
144         CT_CENTAUR,
145         CT_CYRIX,
146         CT_INTEL,
147         CT_TRANSMETA,
148         CT_NATIONAL_SEMICONDUCTOR,
149         CT_NEXGEN,
150         CT_RISE,
151         CT_SIS,
152         CT_UMC,
153         CT_VIA,
154         CT_VORTEX,
155         CT_KVM
156 } cputype_t;
157
158 #if defined(__i386__) || defined(__i386) || defined(__x86_64) \
159         || defined(_M_AMD64) || defined(__M_X64)
160
161 /**
162  * cpuid_get_cpu_type - Get CPU Type
163  *
164  * Returns the CPU Type as cputype_t.
165  *
166  * See also: cpuid_get_cpu_type_string()
167  */
168 #define is_intel_cpu()  cpuid_get_cpu_type() == CT_INTEL
169 #define is_amd_cpu()    cpuid_get_cpu_type() == CT_AMDK5 || cpuid_get_cpu_type() == CT_AMD
170 cputype_t cpuid_get_cpu_type(void);
171
172 /**
173  * cpuid_sprintf_cputype - Get CPU Type string
174  * @cputype: a char of atleast 12 bytes in it.
175  *
176  * Returns true on success, false on failure
177  */
178 bool cpuid_sprintf_cputype(const cputype_t cputype, char *buf);
179
180 /**
181  * cpuid_is_supported - test if the CPUID instruction is supported
182  *
183  * CPUID is not supported by old CPUS.
184  *
185  * Returns true if the cpuid instruction is supported, false otherwise.
186  *
187  * See also: cpuid()
188  */
189 bool cpuid_is_supported(void);
190
191 /**
192  * cpuid_highest_ext_func_supported - Get the highest extended function supported
193  *
194  *
195  * Returns the highest extended function supported.
196  *
197  * This is the same as calling:
198  *      cpuid(CPUID_HIGHEST_EEXTENDED_FUNCTION_SUPPORTED, &highest);
199  *
200  * This is made visible to the linker because it's easier to call it
201  * instead of calling cpuid with less type-checking.  cpuid calls this.
202  *
203  * See also: cpuid()
204  */
205 uint32_t cpuid_highest_ext_func_supported(void);
206
207 /**
208  * cpuid - Get Some information from the CPU.
209  *
210  * This function expects buf to be a valid pointer to a string/int/...
211  * depending on the requested information.
212  *
213  * For CPUID_VENDOR_ID:
214  *      Returns a string into buf.
215  *
216  * For CPUID_PROCINFO_AND_FEATUREBITS:
217  *      buf[0]: Stepping
218  *      buf[1]: Model
219  *      buf[2]: Family
220  *      buf[3]: Extended Model
221  *      buf[4]: Extended Family
222  *      buf[5]: Brand Index
223  *      buf[6]: CL Flush Line Size
224  *      buf[7]: Logical Processors
225  *      buf[8]: Initial APICID
226  *
227  * For CPUID_L1_CACHE_AND_TLB_IDS:
228  *      buf[0] to buf[3]: 2M+4M page TLB info
229  *              0: Inst count
230  *              1: Inst Assoc
231  *              2: Data Count
232  *              3: Data Assoc
233  *      buf[4] to buf[7]: 4k page TLB info
234  *              0: Inst count
235  *              1: Inst Assoc
236  *              2: Data Count
237  *              3: Data Assoc
238  *      buf[8] to buf[11]: L1 data cache information
239  *              0: Line Size
240  *              1: LinesPerTag
241  *              2: Associativity
242  *              3: CacheSize
243  *      buf[12] to buf[15]: L1 instruction cache info
244  *              0: Line Size
245  *              1: LinesPerTag
246  *              2: Associativity
247  *              3: CacheSize
248  *
249  * For CPUID_HIGHEST_EXTENDED_FUNCTION_SUPPORTED:
250  *      Returns the highest supported function in *buf (expects an integer ofc)
251  *
252  * For CPUID_EXTENDED_PROC_INFO_FEATURE_BITS:
253  *      Returns them in buf[0] and buf[1].
254  *
255  * For CPUID_EXTENDED_L2_CACHE_FEATURES:
256  *      buf[0]: Line size
257  *      buf[1]: Associativity
258  *      buf[2]: Cache size.
259  *
260  * For CPUID_VIRT_PHYS_ADDR_SIZES:
261  *      buf[0]: Physical
262  *      buf[1]: Virtual
263  *
264  * For CPUID_PROC_BRAND_STRING:
265  *      Have a char array with at least 48 bytes assigned to it.
266  *
267  * If an invalid flag has been passed a 0xbaadf00d is returned in *buf.
268  */
269 void cpuid(cpuid_t info, uint32_t *buf);
270
271 /**
272  * cpuid_test_feature - Test if @feature is available
273  *
274  * Returns true if feature is supported, false otherwise.
275  *
276  * The feature parameter must be >= CPUID_EXTENDED_PROC_INFO_FEATURE_BITS
277  *  and <= CPUID_VIRT_PHYS_ADDR_SIZES.
278  */
279 bool cpuid_test_feature(cpuid_t feature);
280
281 /**
282  * cpuid_has_feature - Test if @feature is supported
283  *
284  * Test if the CPU supports MMX/SSE* etc.
285  * Use cpuid_has_ecxfeature() for *_ECX* features and
286  * cpuid_has_edxfeature() for *_EDX* features.
287  *
288  * Returns true if the feature is available, false otherwise.
289  */
290 bool cpuid_has_ecxfeature(int feature);
291 bool cpuid_has_edxfeature(int feature);
292
293 #else
294 #include <ccan/build_assert/build_assert.h>
295
296 #define cpuid_get_cpu_type()                    BUILD_ASSERT_OR_ZERO(0)
297 #define cpuid_get_cpu_type_string()             BUILD_ASSERT_OR_ZERO(0)
298
299 #define cpuid_is_supported()                    BUILD_ASSERT_OR_ZERO(0)
300 #define cpuid(info, buf)                        BUILD_ASSERT_OR_ZERO(0)
301
302 #define cpuid_highest_ext_func_supported()      BUILD_ASSERT_OR_ZERO(0)
303 #define cpuid_test_feature(feature)             BUILD_ASSERT_OR_ZERO(0)
304 #define cpuid_has_ecxfeature(feature)           BUILD_ASSERT_OR_ZERO(0)
305 #define cpuid_has_edxfeature(feature)           BUILD_ASSERT_OR_ZERO(0)
306
307 #endif
308 #endif