]> git.saurik.com Git - apple/xnu.git/blob - osfmk/i386/cpuid.h
xnu-3789.21.4.tar.gz
[apple/xnu.git] / osfmk / i386 / cpuid.h
1 /*
2 * Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28 /*
29 * @OSF_COPYRIGHT@
30 */
31
32 /*
33 * x86 CPU identification
34 *
35 */
36
37 #ifndef _MACHINE_CPUID_H_
38 #define _MACHINE_CPUID_H_
39
40 #include <sys/appleapiopts.h>
41
42 #ifdef __APPLE_API_PRIVATE
43
44 #define CPUID_VID_INTEL "GenuineIntel"
45 #define CPUID_VID_AMD "AuthenticAMD"
46
47 #define CPUID_VMM_ID_VMWARE "VMwareVMware"
48 #define CPUID_VMM_ID_PARALLELS "Parallels\0\0\0"
49
50 #define CPUID_STRING_UNKNOWN "Unknown CPU Typ"
51
52 #define _Bit(n) (1ULL << n)
53 #define _HBit(n) (1ULL << ((n)+32))
54
55 /*
56 * The CPUID_FEATURE_XXX values define 64-bit values
57 * returned in %ecx:%edx to a CPUID request with %eax of 1:
58 */
59 #define CPUID_FEATURE_FPU _Bit(0) /* Floating point unit on-chip */
60 #define CPUID_FEATURE_VME _Bit(1) /* Virtual Mode Extension */
61 #define CPUID_FEATURE_DE _Bit(2) /* Debugging Extension */
62 #define CPUID_FEATURE_PSE _Bit(3) /* Page Size Extension */
63 #define CPUID_FEATURE_TSC _Bit(4) /* Time Stamp Counter */
64 #define CPUID_FEATURE_MSR _Bit(5) /* Model Specific Registers */
65 #define CPUID_FEATURE_PAE _Bit(6) /* Physical Address Extension */
66 #define CPUID_FEATURE_MCE _Bit(7) /* Machine Check Exception */
67 #define CPUID_FEATURE_CX8 _Bit(8) /* CMPXCHG8B */
68 #define CPUID_FEATURE_APIC _Bit(9) /* On-chip APIC */
69 #define CPUID_FEATURE_SEP _Bit(11) /* Fast System Call */
70 #define CPUID_FEATURE_MTRR _Bit(12) /* Memory Type Range Register */
71 #define CPUID_FEATURE_PGE _Bit(13) /* Page Global Enable */
72 #define CPUID_FEATURE_MCA _Bit(14) /* Machine Check Architecture */
73 #define CPUID_FEATURE_CMOV _Bit(15) /* Conditional Move Instruction */
74 #define CPUID_FEATURE_PAT _Bit(16) /* Page Attribute Table */
75 #define CPUID_FEATURE_PSE36 _Bit(17) /* 36-bit Page Size Extension */
76 #define CPUID_FEATURE_PSN _Bit(18) /* Processor Serial Number */
77 #define CPUID_FEATURE_CLFSH _Bit(19) /* CLFLUSH Instruction supported */
78 #define CPUID_FEATURE_DS _Bit(21) /* Debug Store */
79 #define CPUID_FEATURE_ACPI _Bit(22) /* Thermal monitor and Clock Ctrl */
80 #define CPUID_FEATURE_MMX _Bit(23) /* MMX supported */
81 #define CPUID_FEATURE_FXSR _Bit(24) /* Fast floating pt save/restore */
82 #define CPUID_FEATURE_SSE _Bit(25) /* Streaming SIMD extensions */
83 #define CPUID_FEATURE_SSE2 _Bit(26) /* Streaming SIMD extensions 2 */
84 #define CPUID_FEATURE_SS _Bit(27) /* Self-Snoop */
85 #define CPUID_FEATURE_HTT _Bit(28) /* Hyper-Threading Technology */
86 #define CPUID_FEATURE_TM _Bit(29) /* Thermal Monitor (TM1) */
87 #define CPUID_FEATURE_PBE _Bit(31) /* Pend Break Enable */
88
89 #define CPUID_FEATURE_SSE3 _HBit(0) /* Streaming SIMD extensions 3 */
90 #define CPUID_FEATURE_PCLMULQDQ _HBit(1) /* PCLMULQDQ instruction */
91 #define CPUID_FEATURE_DTES64 _HBit(2) /* 64-bit DS layout */
92 #define CPUID_FEATURE_MONITOR _HBit(3) /* Monitor/mwait */
93 #define CPUID_FEATURE_DSCPL _HBit(4) /* Debug Store CPL */
94 #define CPUID_FEATURE_VMX _HBit(5) /* VMX */
95 #define CPUID_FEATURE_SMX _HBit(6) /* SMX */
96 #define CPUID_FEATURE_EST _HBit(7) /* Enhanced SpeedsTep (GV3) */
97 #define CPUID_FEATURE_TM2 _HBit(8) /* Thermal Monitor 2 */
98 #define CPUID_FEATURE_SSSE3 _HBit(9) /* Supplemental SSE3 instructions */
99 #define CPUID_FEATURE_CID _HBit(10) /* L1 Context ID */
100 #define CPUID_FEATURE_SEGLIM64 _HBit(11) /* 64-bit segment limit checking */
101 #define CPUID_FEATURE_FMA _HBit(12) /* Fused-Multiply-Add support */
102 #define CPUID_FEATURE_CX16 _HBit(13) /* CmpXchg16b instruction */
103 #define CPUID_FEATURE_xTPR _HBit(14) /* Send Task PRiority msgs */
104 #define CPUID_FEATURE_PDCM _HBit(15) /* Perf/Debug Capability MSR */
105
106 #define CPUID_FEATURE_PCID _HBit(17) /* ASID-PCID support */
107 #define CPUID_FEATURE_DCA _HBit(18) /* Direct Cache Access */
108 #define CPUID_FEATURE_SSE4_1 _HBit(19) /* Streaming SIMD extensions 4.1 */
109 #define CPUID_FEATURE_SSE4_2 _HBit(20) /* Streaming SIMD extensions 4.2 */
110 #define CPUID_FEATURE_x2APIC _HBit(21) /* Extended APIC Mode */
111 #define CPUID_FEATURE_MOVBE _HBit(22) /* MOVBE instruction */
112 #define CPUID_FEATURE_POPCNT _HBit(23) /* POPCNT instruction */
113 #define CPUID_FEATURE_TSCTMR _HBit(24) /* TSC deadline timer */
114 #define CPUID_FEATURE_AES _HBit(25) /* AES instructions */
115 #define CPUID_FEATURE_XSAVE _HBit(26) /* XSAVE instructions */
116 #define CPUID_FEATURE_OSXSAVE _HBit(27) /* XGETBV/XSETBV instructions */
117 #define CPUID_FEATURE_AVX1_0 _HBit(28) /* AVX 1.0 instructions */
118 #define CPUID_FEATURE_F16C _HBit(29) /* Float16 convert instructions */
119 #define CPUID_FEATURE_RDRAND _HBit(30) /* RDRAND instruction */
120 #define CPUID_FEATURE_VMM _HBit(31) /* VMM (Hypervisor) present */
121
122 /*
123 * Leaf 7, subleaf 0 additional features.
124 * Bits returned in %ebx:%ecx to a CPUID request with {%eax,%ecx} of (0x7,0x0}:
125 */
126 #define CPUID_LEAF7_FEATURE_RDWRFSGS _Bit(0) /* FS/GS base read/write */
127 #define CPUID_LEAF7_FEATURE_TSCOFF _Bit(1) /* TSC thread offset */
128 #define CPUID_LEAF7_FEATURE_BMI1 _Bit(3) /* Bit Manipulation Instrs, set 1 */
129 #define CPUID_LEAF7_FEATURE_HLE _Bit(4) /* Hardware Lock Elision*/
130 #define CPUID_LEAF7_FEATURE_AVX2 _Bit(5) /* AVX2 Instructions */
131 #define CPUID_LEAF7_FEATURE_SMEP _Bit(7) /* Supervisor Mode Execute Protect */
132 #define CPUID_LEAF7_FEATURE_BMI2 _Bit(8) /* Bit Manipulation Instrs, set 2 */
133 #define CPUID_LEAF7_FEATURE_ERMS _Bit(9) /* Enhanced Rep Movsb/Stosb */
134 #define CPUID_LEAF7_FEATURE_INVPCID _Bit(10) /* INVPCID intruction, TDB */
135 #define CPUID_LEAF7_FEATURE_RTM _Bit(11) /* RTM */
136 #define CPUID_LEAF7_FEATURE_RDSEED _Bit(18) /* RDSEED Instruction */
137 #define CPUID_LEAF7_FEATURE_ADX _Bit(19) /* ADX Instructions */
138 #define CPUID_LEAF7_FEATURE_SMAP _Bit(20) /* Supervisor Mode Access Protect */
139 #define CPUID_LEAF7_FEATURE_SGX _Bit(2) /* Software Guard eXtensions */
140 #define CPUID_LEAF7_FEATURE_PQM _Bit(12) /* Platform Qos Monitoring */
141 #define CPUID_LEAF7_FEATURE_FPU_CSDS _Bit(13) /* FPU CS/DS deprecation */
142 #define CPUID_LEAF7_FEATURE_MPX _Bit(14) /* Memory Protection eXtensions */
143 #define CPUID_LEAF7_FEATURE_PQE _Bit(15) /* Platform Qos Enforcement */
144 #define CPUID_LEAF7_FEATURE_CLFSOPT _Bit(23) /* CLFSOPT */
145 #define CPUID_LEAF7_FEATURE_IPT _Bit(25) /* Intel Processor Trace */
146 #define CPUID_LEAF7_FEATURE_SHA _Bit(29) /* SHA instructions */
147
148 #define CPUID_LEAF7_FEATURE_PREFETCHWT1 _HBit(0)/* Prefetch Write/T1 hint */
149
150 /*
151 * The CPUID_EXTFEATURE_XXX values define 64-bit values
152 * returned in %ecx:%edx to a CPUID request with %eax of 0x80000001:
153 */
154 #define CPUID_EXTFEATURE_SYSCALL _Bit(11) /* SYSCALL/sysret */
155 #define CPUID_EXTFEATURE_XD _Bit(20) /* eXecute Disable */
156
157 #define CPUID_EXTFEATURE_1GBPAGE _Bit(26) /* 1GB pages */
158 #define CPUID_EXTFEATURE_RDTSCP _Bit(27) /* RDTSCP */
159 #define CPUID_EXTFEATURE_EM64T _Bit(29) /* Extended Mem 64 Technology */
160
161 #define CPUID_EXTFEATURE_LAHF _HBit(0) /* LAFH/SAHF instructions */
162 #define CPUID_EXTFEATURE_LZCNT _HBit(5) /* LZCNT instruction */
163 #define CPUID_EXTFEATURE_PREFETCHW _HBit(8) /* PREFETCHW instruction */
164
165 /*
166 * The CPUID_EXTFEATURE_XXX values define 64-bit values
167 * returned in %ecx:%edx to a CPUID request with %eax of 0x80000007:
168 */
169 #define CPUID_EXTFEATURE_TSCI _Bit(8) /* TSC Invariant */
170
171 /*
172 * CPUID_X86_64_H_FEATURE_SUBSET and CPUID_X86_64_H_LEAF7_FEATURE_SUBSET
173 * indicate the bitmask of features that must be present before the system
174 * is eligible to run the "x86_64h" "Haswell feature subset" slice.
175 */
176 #define CPUID_X86_64_H_FEATURE_SUBSET ( CPUID_FEATURE_FMA | \
177 CPUID_FEATURE_SSE4_2 | \
178 CPUID_FEATURE_MOVBE | \
179 CPUID_FEATURE_POPCNT | \
180 CPUID_FEATURE_AVX1_0 \
181 )
182
183 #define CPUID_X86_64_H_EXTFEATURE_SUBSET ( CPUID_EXTFEATURE_LZCNT \
184 )
185
186 #define CPUID_X86_64_H_LEAF7_FEATURE_SUBSET ( CPUID_LEAF7_FEATURE_BMI1 | \
187 CPUID_LEAF7_FEATURE_AVX2 | \
188 CPUID_LEAF7_FEATURE_BMI2 \
189 )
190
191 #define CPUID_CACHE_SIZE 16 /* Number of descriptor values */
192
193 #define CPUID_MWAIT_EXTENSION _Bit(0) /* enumeration of WMAIT extensions */
194 #define CPUID_MWAIT_BREAK _Bit(1) /* interrupts are break events */
195
196 #define CPUID_MODEL_PENRYN 0x17
197 #define CPUID_MODEL_NEHALEM 0x1A
198 #define CPUID_MODEL_FIELDS 0x1E /* Lynnfield, Clarksfield */
199 #define CPUID_MODEL_DALES 0x1F /* Havendale, Auburndale */
200 #define CPUID_MODEL_NEHALEM_EX 0x2E
201 #define CPUID_MODEL_DALES_32NM 0x25 /* Clarkdale, Arrandale */
202 #define CPUID_MODEL_WESTMERE 0x2C /* Gulftown, Westmere-EP/-WS */
203 #define CPUID_MODEL_WESTMERE_EX 0x2F
204 #define CPUID_MODEL_SANDYBRIDGE 0x2A
205 #define CPUID_MODEL_JAKETOWN 0x2D
206 #define CPUID_MODEL_IVYBRIDGE 0x3A
207 #define CPUID_MODEL_IVYBRIDGE_EP 0x3E
208 #define CPUID_MODEL_CRYSTALWELL 0x46
209 #define CPUID_MODEL_HASWELL 0x3C
210 #define CPUID_MODEL_HASWELL_EP 0x3F
211 #define CPUID_MODEL_HASWELL_ULT 0x45
212 #define CPUID_MODEL_BROADWELL 0x3D
213 #define CPUID_MODEL_BROADWELL_ULX 0x3D
214 #define CPUID_MODEL_BROADWELL_ULT 0x3D
215 #define CPUID_MODEL_BRYSTALWELL 0x47
216 #define CPUID_MODEL_SKYLAKE 0x4E
217 #define CPUID_MODEL_SKYLAKE_ULT 0x4E
218 #define CPUID_MODEL_SKYLAKE_ULX 0x4E
219 #define CPUID_MODEL_SKYLAKE_DT 0x5E
220
221 #define CPUID_VMM_FAMILY_UNKNOWN 0x0
222 #define CPUID_VMM_FAMILY_VMWARE 0x1
223 #define CPUID_VMM_FAMILY_PARALLELS 0x2
224
225 #ifndef ASSEMBLER
226 #include <stdint.h>
227 #include <mach/mach_types.h>
228 #include <kern/kern_types.h>
229 #include <mach/machine.h>
230
231
232 typedef enum { eax, ebx, ecx, edx } cpuid_register_t;
233 static inline void
234 cpuid(uint32_t *data)
235 {
236 __asm__ volatile ("cpuid"
237 : "=a" (data[eax]),
238 "=b" (data[ebx]),
239 "=c" (data[ecx]),
240 "=d" (data[edx])
241 : "a" (data[eax]),
242 "b" (data[ebx]),
243 "c" (data[ecx]),
244 "d" (data[edx]));
245 }
246
247 static inline void
248 do_cpuid(uint32_t selector, uint32_t *data)
249 {
250 __asm__ volatile ("cpuid"
251 : "=a" (data[0]),
252 "=b" (data[1]),
253 "=c" (data[2]),
254 "=d" (data[3])
255 : "a"(selector),
256 "b" (0),
257 "c" (0),
258 "d" (0));
259 }
260
261 /*
262 * Cache ID descriptor structure, used to parse CPUID leaf 2.
263 * Note: not used in kernel.
264 */
265 typedef enum { Lnone, L1I, L1D, L2U, L3U, LCACHE_MAX } cache_type_t ;
266 typedef struct {
267 unsigned char value; /* Descriptor value */
268 cache_type_t type; /* Cache type */
269 unsigned int size; /* Cache size */
270 unsigned int linesize; /* Cache line size */
271 #ifdef KERNEL
272 const char *description; /* Cache description */
273 #endif /* KERNEL */
274 } cpuid_cache_desc_t;
275
276 #ifdef KERNEL
277 #define CACHE_DESC(value,type,size,linesize,text) \
278 { value, type, size, linesize, text }
279 #else
280 #define CACHE_DESC(value,type,size,linesize,text) \
281 { value, type, size, linesize }
282 #endif /* KERNEL */
283
284 /* Monitor/mwait Leaf: */
285 typedef struct {
286 uint32_t linesize_min;
287 uint32_t linesize_max;
288 uint32_t extensions;
289 uint32_t sub_Cstates;
290 } cpuid_mwait_leaf_t;
291
292 /* Thermal and Power Management Leaf: */
293 typedef struct {
294 boolean_t sensor;
295 boolean_t dynamic_acceleration;
296 boolean_t invariant_APIC_timer;
297 boolean_t core_power_limits;
298 boolean_t fine_grain_clock_mod;
299 boolean_t package_thermal_intr;
300 uint32_t thresholds;
301 boolean_t ACNT_MCNT;
302 boolean_t hardware_feedback;
303 boolean_t energy_policy;
304 } cpuid_thermal_leaf_t;
305
306
307 /* XSAVE Feature Leaf: */
308 typedef struct {
309 uint32_t extended_state[4]; /* eax .. edx */
310 } cpuid_xsave_leaf_t;
311
312
313 /* Architectural Performance Monitoring Leaf: */
314 typedef struct {
315 uint8_t version;
316 uint8_t number;
317 uint8_t width;
318 uint8_t events_number;
319 uint32_t events;
320 uint8_t fixed_number;
321 uint8_t fixed_width;
322 } cpuid_arch_perf_leaf_t;
323
324 /* The TSC to Core Crystal (RefCLK) Clock Information leaf */
325 typedef struct {
326 uint32_t numerator;
327 uint32_t denominator;
328 } cpuid_tsc_leaf_t;
329
330 /* Physical CPU info - this is exported out of the kernel (kexts), so be wary of changes */
331 typedef struct {
332 char cpuid_vendor[16];
333 char cpuid_brand_string[48];
334 const char *cpuid_model_string;
335
336 cpu_type_t cpuid_type; /* this is *not* a cpu_type_t in our <mach/machine.h> */
337 uint8_t cpuid_family;
338 uint8_t cpuid_model;
339 uint8_t cpuid_extmodel;
340 uint8_t cpuid_extfamily;
341 uint8_t cpuid_stepping;
342 uint64_t cpuid_features;
343 uint64_t cpuid_extfeatures;
344 uint32_t cpuid_signature;
345 uint8_t cpuid_brand;
346 uint8_t cpuid_processor_flag;
347
348 uint32_t cache_size[LCACHE_MAX];
349 uint32_t cache_linesize;
350
351 uint8_t cache_info[64]; /* list of cache descriptors */
352
353 uint32_t cpuid_cores_per_package;
354 uint32_t cpuid_logical_per_package;
355 uint32_t cache_sharing[LCACHE_MAX];
356 uint32_t cache_partitions[LCACHE_MAX];
357
358 cpu_type_t cpuid_cpu_type; /* <mach/machine.h> */
359 cpu_subtype_t cpuid_cpu_subtype; /* <mach/machine.h> */
360
361 /* Per-vendor info */
362 cpuid_mwait_leaf_t cpuid_mwait_leaf;
363 #define cpuid_mwait_linesize_max cpuid_mwait_leaf.linesize_max
364 #define cpuid_mwait_linesize_min cpuid_mwait_leaf.linesize_min
365 #define cpuid_mwait_extensions cpuid_mwait_leaf.extensions
366 #define cpuid_mwait_sub_Cstates cpuid_mwait_leaf.sub_Cstates
367 cpuid_thermal_leaf_t cpuid_thermal_leaf;
368 cpuid_arch_perf_leaf_t cpuid_arch_perf_leaf;
369 uint32_t unused[4]; /* cpuid_xsave_leaf */
370
371 /* Cache details: */
372 uint32_t cpuid_cache_linesize;
373 uint32_t cpuid_cache_L2_associativity;
374 uint32_t cpuid_cache_size;
375
376 /* Virtual and physical address aize: */
377 uint32_t cpuid_address_bits_physical;
378 uint32_t cpuid_address_bits_virtual;
379
380 uint32_t cpuid_microcode_version;
381
382 /* Numbers of tlbs per processor [i|d, small|large, level0|level1] */
383 uint32_t cpuid_tlb[2][2][2];
384 #define TLB_INST 0
385 #define TLB_DATA 1
386 #define TLB_SMALL 0
387 #define TLB_LARGE 1
388 uint32_t cpuid_stlb;
389
390 uint32_t core_count;
391 uint32_t thread_count;
392
393 /* Max leaf ids available from CPUID */
394 uint32_t cpuid_max_basic;
395 uint32_t cpuid_max_ext;
396
397 /* Family-specific info links */
398 uint32_t cpuid_cpufamily;
399 cpuid_mwait_leaf_t *cpuid_mwait_leafp;
400 cpuid_thermal_leaf_t *cpuid_thermal_leafp;
401 cpuid_arch_perf_leaf_t *cpuid_arch_perf_leafp;
402 cpuid_xsave_leaf_t *cpuid_xsave_leafp;
403 uint64_t cpuid_leaf7_features;
404 cpuid_tsc_leaf_t cpuid_tsc_leaf;
405 cpuid_xsave_leaf_t cpuid_xsave_leaf[2];
406 } i386_cpu_info_t;
407
408 #ifdef MACH_KERNEL_PRIVATE
409 typedef struct {
410 char cpuid_vmm_vendor[16];
411 uint32_t cpuid_vmm_family;
412 uint32_t cpuid_vmm_bus_frequency;
413 uint32_t cpuid_vmm_tsc_frequency;
414 } i386_vmm_info_t;
415 #endif
416
417 #ifdef __cplusplus
418 extern "C" {
419 #endif
420
421 /*
422 * External declarations
423 */
424 extern cpu_type_t cpuid_cputype(void);
425 extern cpu_subtype_t cpuid_cpusubtype(void);
426 extern void cpuid_cpu_display(const char *);
427 extern void cpuid_feature_display(const char *);
428 extern void cpuid_extfeature_display(const char *);
429 extern char * cpuid_get_feature_names(uint64_t, char *, unsigned);
430 extern char * cpuid_get_extfeature_names(uint64_t, char *, unsigned);
431 extern char * cpuid_get_leaf7_feature_names(uint64_t, char *, unsigned);
432
433 extern uint64_t cpuid_features(void);
434 extern uint64_t cpuid_extfeatures(void);
435 extern uint64_t cpuid_leaf7_features(void);
436 extern uint32_t cpuid_family(void);
437 extern uint32_t cpuid_cpufamily(void);
438
439 extern i386_cpu_info_t *cpuid_info(void);
440 extern void cpuid_set_info(void);
441
442 #ifdef MACH_KERNEL_PRIVATE
443 extern boolean_t cpuid_vmm_present(void);
444 extern i386_vmm_info_t *cpuid_vmm_info(void);
445 extern uint32_t cpuid_vmm_family(void);
446 #endif
447
448 #ifdef __cplusplus
449 }
450 #endif
451
452 #endif /* ASSEMBLER */
453
454 #endif /* __APPLE_API_PRIVATE */
455 #endif /* _MACHINE_CPUID_H_ */