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_STRING_UNKNOWN    "Unknown CPU Typ"
  48
  49 #define _Bit(n)                 (1ULL << n)
  50 #define _HBit(n)                (1ULL << ((n)+32))
  51
  52 /*
  53  * The CPUID_FEATURE_XXX values define 64-bit values
  54  * returned in %ecx:%edx to a CPUID request with %eax of 1:
  55  */
  56 #define CPUID_FEATURE_FPU     _Bit(0)   /* Floating point unit on-chip */
  57 #define CPUID_FEATURE_VME     _Bit(1)   /* Virtual Mode Extension */
  58 #define CPUID_FEATURE_DE      _Bit(2)   /* Debugging Extension */
  59 #define CPUID_FEATURE_PSE     _Bit(3)   /* Page Size Extension */
  60 #define CPUID_FEATURE_TSC     _Bit(4)   /* Time Stamp Counter */
  61 #define CPUID_FEATURE_MSR     _Bit(5)   /* Model Specific Registers */
  62 #define CPUID_FEATURE_PAE     _Bit(6)   /* Physical Address Extension */
  63 #define CPUID_FEATURE_MCE     _Bit(7)   /* Machine Check Exception */
  64 #define CPUID_FEATURE_CX8     _Bit(8)   /* CMPXCHG8B */
  65 #define CPUID_FEATURE_APIC    _Bit(9)   /* On-chip APIC */
  66 #define CPUID_FEATURE_SEP     _Bit(11)  /* Fast System Call */
  67 #define CPUID_FEATURE_MTRR    _Bit(12)  /* Memory Type Range Register */
  68 #define CPUID_FEATURE_PGE     _Bit(13)  /* Page Global Enable */
  69 #define CPUID_FEATURE_MCA     _Bit(14)  /* Machine Check Architecture */
  70 #define CPUID_FEATURE_CMOV    _Bit(15)  /* Conditional Move Instruction */
  71 #define CPUID_FEATURE_PAT     _Bit(16)  /* Page Attribute Table */
  72 #define CPUID_FEATURE_PSE36   _Bit(17)  /* 36-bit Page Size Extension */
  73 #define CPUID_FEATURE_PSN     _Bit(18)  /* Processor Serial Number */
  74 #define CPUID_FEATURE_CLFSH   _Bit(19)  /* CLFLUSH Instruction supported */
  75 #define CPUID_FEATURE_DS      _Bit(21)  /* Debug Store */
  76 #define CPUID_FEATURE_ACPI    _Bit(22)  /* Thermal monitor and Clock Ctrl */
  77 #define CPUID_FEATURE_MMX     _Bit(23)  /* MMX supported */
  78 #define CPUID_FEATURE_FXSR    _Bit(24)  /* Fast floating pt save/restore */
  79 #define CPUID_FEATURE_SSE     _Bit(25)  /* Streaming SIMD extensions */
  80 #define CPUID_FEATURE_SSE2    _Bit(26)  /* Streaming SIMD extensions 2 */
  81 #define CPUID_FEATURE_SS      _Bit(27)  /* Self-Snoop */
  82 #define CPUID_FEATURE_HTT     _Bit(28)  /* Hyper-Threading Technology */
  83 #define CPUID_FEATURE_TM      _Bit(29)  /* Thermal Monitor (TM1) */
  84 #define CPUID_FEATURE_PBE     _Bit(31)  /* Pend Break Enable */
  85
  86 #define CPUID_FEATURE_SSE3    _HBit(0)  /* Streaming SIMD extensions 3 */
  87 #define CPUID_FEATURE_MONITOR _HBit(3)  /* Monitor/mwait */
  88 #define CPUID_FEATURE_DSCPL   _HBit(4)  /* Debug Store CPL */
  89 #define CPUID_FEATURE_VMX     _HBit(5)  /* VMX */
  90 #define CPUID_FEATURE_SMX     _HBit(6)  /* SMX */
  91 #define CPUID_FEATURE_EST     _HBit(7)  /* Enhanced SpeedsTep (GV3) */
  92 #define CPUID_FEATURE_TM2     _HBit(8)  /* Thermal Monitor 2 */
  93 #define CPUID_FEATURE_SSSE3   _HBit(9)  /* Supplemental SSE3 instructions */
  94 #define CPUID_FEATURE_CID     _HBit(10) /* L1 Context ID */
  95 #define CPUID_FEATURE_CX16    _HBit(13) /* CmpXchg16b instruction */
  96 #define CPUID_FEATURE_xTPR    _HBit(14) /* Send Task PRiority msgs */
  97 #define CPUID_FEATURE_PDCM    _HBit(15) /* Perf/Debug Capability MSR */
  98 #define CPUID_FEATURE_SSE4_1  _HBit(19) /* Streaming SIMD extensions 4.1 */
  99 #define CPUID_FEATURE_SSE4_2  _HBit(20) /* Streaming SIMD extensions 4.1 */
 100 #define CPUID_FEATURE_POPCNT  _HBit(23) /* POPCNT instruction */
 101
 102 /*
 103  * The CPUID_EXTFEATURE_XXX values define 64-bit values
 104  * returned in %ecx:%edx to a CPUID request with %eax of 0x80000001:
 105  */
 106 #define CPUID_EXTFEATURE_SYSCALL   _Bit(11)     /* SYSCALL/sysret */
 107 #define CPUID_EXTFEATURE_XD        _Bit(20)     /* eXecute Disable */
 108 #define CPUID_EXTFEATURE_EM64T     _Bit(29)     /* Extended Mem 64 Technology */
 109
 110 #define CPUID_EXTFEATURE_LAHF      _HBit(20)    /* LAFH/SAHF instructions */
 111
 112 #define CPUID_CACHE_SIZE        16      /* Number of descriptor vales */
 113
 114 #define CPUID_CACHE_NULL           0x00 /* NULL */
 115 #define CPUID_CACHE_ITLB_4K        0x01 /* Instruction TLB: 4K pages */
 116 #define CPUID_CACHE_ITLB_4M        0x02 /* Instruction TLB: 4M pages */
 117 #define CPUID_CACHE_DTLB_4K        0x03 /* Data TLB: 4K pages */
 118 #define CPUID_CACHE_DTLB_4M        0x04 /* Data TLB: 4M pages */
 119 #define CPUID_CACHE_ICACHE_8K      0x06 /* Instruction cache: 8K */
 120 #define CPUID_CACHE_ICACHE_16K     0x08 /* Instruction cache: 16K */
 121 #define CPUID_CACHE_DCACHE_8K      0x0A /* Data cache: 8K */
 122 #define CPUID_CACHE_DCACHE_16K     0x0C /* Data cache: 16K */
 123 #define CPUID_CACHE_L3_512K        0x22 /* L3: 512K */
 124 #define CPUID_CACHE_L3_1M          0x23 /* L3: 1M */
 125 #define CPUID_CACHE_L3_2M          0x25 /* L3: 2M */
 126 #define CPUID_CACHE_L3_4M          0x29 /* L3: 4M */
 127 #define CPUID_CACHE_DCACHE_32K     0x2C /* Data cache: 32K, 8-way */
 128 #define CPUID_CACHE_ICACHE_32K     0x30 /* Instruction cache: 32K, 8-way */
 129 #define CPUID_CACHE_L2_128K_S4     0x39 /* L2: 128K, 4-way, sectored */
 130 #define CPUID_CACHE_L2_128K_S2     0x3B /* L2: 128K, 2-way, sectored */
 131 #define CPUID_CACHE_L2_256K_S4     0x3C /* L2: 256K, 4-way, sectored */
 132 #define CPUID_CACHE_NOCACHE        0x40 /* No 2nd level or 3rd-level cache */
 133 #define CPUID_CACHE_L2_128K        0x41 /* L2: 128K */
 134 #define CPUID_CACHE_L2_256K        0x42 /* L2: 256K */
 135 #define CPUID_CACHE_L2_512K        0x43 /* L2: 512K */
 136 #define CPUID_CACHE_L2_1M_4        0x44 /* L2: 1M, 4-way */
 137 #define CPUID_CACHE_L2_2M_4        0x45 /* L2: 2M, 4-way */
 138 #define CPUID_CACHE_L3_4M_4_64     0x46 /* L3:  4M,  4-way, 64 bytes */
 139 #define CPUID_CACHE_L3_8M_8_64     0x47 /* L3:  8M,  8-way, 64 bytes*/
 140 #define CPUID_CACHE_L2_3M_12_64    0x48 /* L3:  3M,  8-way, 64 bytes*/
 141 #define CPUID_CACHE_L2_4M_16_64    0x49 /* L2:  4M, 16-way, 64 bytes */
 142 #define CPUID_CACHE_L2_6M_12_64    0x4A /* L2:  6M, 12-way, 64 bytes */
 143 #define CPUID_CACHE_L2_8M_16_64    0x4B /* L2:  8M, 16-way, 64 bytes */
 144 #define CPUID_CACHE_L2_12M_12_64   0x4C /* L2: 12M, 12-way, 64 bytes */
 145 #define CPUID_CACHE_L2_16M_16_64   0x4D /* L2: 16M, 16-way, 64 bytes */
 146 #define CPUID_CACHE_L2_6M_24_64    0x4E /* L2:  6M, 24-way, 64 bytes */
 147 #define CPUID_CACHE_ITLB_64        0x50 /* Instruction TLB: 64 entries */
 148 #define CPUID_CACHE_ITLB_128       0x51 /* Instruction TLB: 128 entries */
 149 #define CPUID_CACHE_ITLB_256       0x52 /* Instruction TLB: 256 entries */
 150 #define CPUID_CACHE_DTLB_4M_16_4   0x56 /* Data TLB: 4M, 16 entries, 4-way */
 151 #define CPUID_CACHE_DTLB_4K_16_4   0x56 /* Data TLB: 4K, 16 entries, 4-way */
 152 #define CPUID_CACHE_DTLB_64        0x5B /* Data TLB: 64 entries */
 153 #define CPUID_CACHE_DTLB_128       0x5C /* Data TLB: 128 entries */
 154 #define CPUID_CACHE_DTLB_256       0x5D /* Data TLB: 256 entries */
 155 #define CPUID_CACHE_DCACHE_16K_8_64 0x60 /* Data cache: 16K, 8-way, 64 bytes */
 156 #define CPUID_CACHE_DCACHE_8K_4_64  0x66 /* Data cache:  8K, 4-way, 64 bytes */
 157 #define CPUID_CACHE_DCACHE_16K_4_64 0x67 /* Data cache: 16K, 4-way, 64 bytes */
 158 #define CPUID_CACHE_DCACHE_32K_4_64 0x68 /* Data cache: 32K, 4-way, 64 bytes */
 159 #define CPUID_CACHE_TRACE_12K_8    0x70 /* Trace cache 12K-uop, 8-way */
 160 #define CPUID_CACHE_TRACE_16K_8    0x71 /* Trace cache 16K-uop, 8-way */
 161 #define CPUID_CACHE_TRACE_32K_8    0x72 /* Trace cache 32K-uop, 8-way */
 162 #define CPUID_CACHE_L2_1M_4_64     0x78 /* L2:   1M, 4-way, 64 bytes */
 163 #define CPUID_CACHE_L2_128K_8_64_2 0x79 /* L2: 128K, 8-way, 64b, 2 lines/sec */
 164 #define CPUID_CACHE_L2_256K_8_64_2 0x7A /* L2: 256K, 8-way, 64b, 2 lines/sec */
 165 #define CPUID_CACHE_L2_512K_8_64_2 0x7B /* L2: 512K, 8-way, 64b, 2 lines/sec */
 166 #define CPUID_CACHE_L2_1M_8_64_2   0x7C /* L2:   1M, 8-way, 64b, 2 lines/sec */
 167 #define CPUID_CACHE_L2_2M_8_64     0x7D /* L2:   2M, 8-way, 64 bytes */
 168 #define CPUID_CACHE_L2_512K_2_64   0x7F /* L2: 512K, 2-way, 64 bytes */
 169 #define CPUID_CACHE_L2_256K_8_32   0x82 /* L2: 256K, 8-way, 32 bytes */
 170 #define CPUID_CACHE_L2_512K_8_32   0x83 /* L2: 512K, 8-way, 32 bytes */
 171 #define CPUID_CACHE_L2_1M_8_32     0x84 /* L2:   1M, 8-way, 32 bytes */
 172 #define CPUID_CACHE_L2_2M_8_32     0x85 /* L2:   2M, 8-way, 32 bytes */
 173 #define CPUID_CACHE_L2_512K_4_64   0x86 /* L2: 512K, 4-way, 64 bytes */
 174 #define CPUID_CACHE_L2_1M_8_64     0x87 /* L2:   1M, 8-way, 64 bytes */
 175 #define CPUID_CACHE_ITLB_4K_128_4  0xB0 /* ITLB: 4KB, 128 entries, 4-way */
 176 #define CPUID_CACHE_ITLB_4M_4_4    0xB1 /* ITLB: 4MB,   4 entries, 4-way, or  */
 177 #define CPUID_CACHE_ITLB_2M_8_4    0xB1 /* ITLB: 2MB,   8 entries, 4-way */
 178 #define CPUID_CACHE_DTLB_4K_128_4  0xB3 /* DTLB: 4KB, 128 entries, 4-way */
 179 #define CPUID_CACHE_DTLB_4K_256_4  0xB4 /* DTLB: 4KB, 256 entries, 4-way */
 180 #define CPUID_CACHE_PREFETCH_64    0xF0 /* 64-Byte Prefetching */
 181 #define CPUID_CACHE_PREFETCH_128   0xF1 /* 128-Byte Prefetching */
 182
 183 #define CPUID_MWAIT_EXTENSION   _Bit(0) /* enumeration of WMAIT extensions */
 184 #define CPUID_MWAIT_BREAK       _Bit(1) /* interrupts are break events     */
 185
 186 #ifndef ASSEMBLER
 187 #include <stdint.h>
 188 #include <mach/mach_types.h>
 189 #include <kern/kern_types.h>
 190 #include <mach/machine.h>
 191
 192
 193 typedef enum { eax, ebx, ecx, edx } cpuid_register_t;
 194 static inline void
 195 cpuid(uint32_t *data)
 196 {
 197         asm("cpuid"
 198                 : "=a" (data[eax]),
 199                   "=b" (data[ebx]),
 200                   "=c" (data[ecx]),
 201                   "=d" (data[edx])
 202                 : "a"  (data[eax]),
 203                   "b"  (data[ebx]),
 204                   "c"  (data[ecx]),
 205                   "d"  (data[edx]));
 206 }
 207 static inline void
 208 do_cpuid(uint32_t selector, uint32_t *data)
 209 {
 210         asm("cpuid"
 211                 : "=a" (data[0]),
 212                   "=b" (data[1]),
 213                   "=c" (data[2]),
 214                   "=d" (data[3])
 215                 : "a"(selector));
 216 }
 217
 218 /*
 219  * Cache ID descriptor structure, used to parse CPUID leaf 2.
 220  * Note: not used in kernel.
 221  */
 222 typedef enum { Lnone, L1I, L1D, L2U, L3U, LCACHE_MAX } cache_type_t ;
 223 typedef struct {
 224         unsigned char   value;          /* Descriptor value */
 225         cache_type_t    type;           /* Cache type */
 226         unsigned int    size;           /* Cache size */
 227         unsigned int    linesize;       /* Cache line size */
 228 #ifdef KERNEL
 229         const char      *description;   /* Cache description */
 230 #endif /* KERNEL */
 231 } cpuid_cache_desc_t;
 232
 233 #ifdef KERNEL
 234 #define CACHE_DESC(value,type,size,linesize,text) \
 235         { value, type, size, linesize, text }
 236 #else
 237 #define CACHE_DESC(value,type,size,linesize,text) \
 238         { value, type, size, linesize }
 239 #endif /* KERNEL */
 240
 241 /* Physical CPU info - this is exported out of the kernel (kexts), so be wary of changes */
 242 typedef struct {
 243         char            cpuid_vendor[16];
 244         char            cpuid_brand_string[48];
 245         const char      *cpuid_model_string;
 246
 247         cpu_type_t      cpuid_type;                                     /* this is *not* a cpu_type_t in our <mach/machine.h> */
 248         uint8_t         cpuid_family;
 249         uint8_t         cpuid_model;
 250         uint8_t         cpuid_extmodel;
 251         uint8_t         cpuid_extfamily;
 252         uint8_t         cpuid_stepping;
 253         uint64_t        cpuid_features;
 254         uint64_t        cpuid_extfeatures;
 255         uint32_t        cpuid_signature;
 256         uint8_t         cpuid_brand;
 257
 258         uint32_t        cache_size[LCACHE_MAX];
 259         uint32_t        cache_linesize;
 260
 261         uint8_t         cache_info[64];    /* list of cache descriptors */
 262
 263         uint32_t        cpuid_cores_per_package;
 264         uint32_t        cpuid_logical_per_package;
 265         uint32_t        cache_sharing[LCACHE_MAX];
 266         uint32_t        cache_partitions[LCACHE_MAX];
 267
 268         cpu_type_t      cpuid_cpu_type;                 /* <mach/machine.h> */
 269         cpu_subtype_t   cpuid_cpu_subtype;              /* <mach/machine.h> */
 270
 271         /* Monitor/mwait Leaf: */
 272         uint32_t        cpuid_mwait_linesize_min;
 273         uint32_t        cpuid_mwait_linesize_max;
 274         uint32_t        cpuid_mwait_extensions;
 275         uint32_t        cpuid_mwait_sub_Cstates;
 276
 277         /* Thermal and Power Management Leaf: */
 278         boolean_t       cpuid_thermal_sensor;
 279         boolean_t       cpuid_thermal_dynamic_acceleration;
 280         uint32_t        cpuid_thermal_thresholds;
 281         boolean_t       cpuid_thermal_ACNT_MCNT;
 282
 283         /* Architectural Performance Monitoring Leaf: */
 284         uint8_t         cpuid_arch_perf_version;
 285         uint8_t         cpuid_arch_perf_number;
 286         uint8_t         cpuid_arch_perf_width;
 287         uint8_t         cpuid_arch_perf_events_number;
 288         uint32_t        cpuid_arch_perf_events;
 289         uint8_t         cpuid_arch_perf_fixed_number;
 290         uint8_t         cpuid_arch_perf_fixed_width;
 291
 292         /* Cache details: */
 293         uint32_t        cpuid_cache_linesize;
 294         uint32_t        cpuid_cache_L2_associativity;
 295         uint32_t        cpuid_cache_size;
 296
 297         /* Virtual and physical address aize: */
 298         uint32_t        cpuid_address_bits_physical;
 299         uint32_t        cpuid_address_bits_virtual;
 300 } i386_cpu_info_t;
 301
 302 #ifdef __cplusplus
 303 extern "C" {
 304 #endif
 305
 306 /*
 307  * External declarations
 308  */
 309 extern cpu_type_t       cpuid_cputype(void);
 310 extern cpu_subtype_t    cpuid_cpusubtype(void);
 311 extern void             cpuid_cpu_display(const char *);
 312 extern void             cpuid_feature_display(const char *);
 313 extern void             cpuid_extfeature_display(const char *);
 314 extern char *           cpuid_get_feature_names(uint64_t, char *, unsigned);
 315 extern char *           cpuid_get_extfeature_names(uint64_t, char *, unsigned);
 316
 317 extern uint64_t         cpuid_features(void);
 318 extern uint64_t         cpuid_extfeatures(void);
 319 extern uint32_t         cpuid_family(void);
 320
 321 extern void             cpuid_get_info(i386_cpu_info_t *info_p);
 322 extern i386_cpu_info_t  *cpuid_info(void);
 323
 324 extern void             cpuid_set_info(void);
 325
 326 #ifdef __cplusplus
 327 }
 328 #endif
 329
 330 #endif /* ASSEMBLER */
 331
 332 #endif /* __APPLE_API_PRIVATE */
 333 #endif /* _MACHINE_CPUID_H_ */