2 * Copyright (c) 2013 Ahmed Samy <f.fallen45@gmail.com>
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:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
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
26 * enum cpuid - stuff to get information on from the CPU.
28 * This is used as a parameter in cpuid().
31 * The CPU's Vendor ID.
33 * CPU_PROCINFO_AND_FEATUREBITS:
34 * Processor information and feature bits (SSE, etc.).
36 * CPU_CACHE_AND_TLBD_INFO
37 * Cache and TLBD Information.
39 * CPU_HIGHEST_EXTENDED_FUNCTION_SUPPORTED:
40 * Highest extended function supported address.
41 * Can be like 0x80000008.
43 * CPU_EXTENDED_PROC_INFO_FEATURE_BITS:
44 * Extended processor information and feature bits (64bit etc.)
46 * CPU_PROC_BRAND_STRING:
47 * The Processor's brand string.
49 * CPU_L1_CACHE_AND_TLB_IDS:
50 * L1 Cache and TLB Identifications.
52 * CPU_EXTENDED_L2_CACHE_FEATURES:
53 * Extended L2 Cache features.
55 * CPU_ADV_POWER_MGT_INFO:
56 * Advaned power management information.
58 * CPU_VIRT_PHYS_ADDR_SIZES:
59 * Virtual and physical address sizes.
64 CPU_PROCINFO_AND_FEATUREBITS = 1,
65 CPU_CACHE_AND_TLBD_INFO = 2,
67 CPU_HIGHEST_EXTENDED_FUNCTION_SUPPORTED = 0x80000000,
68 CPU_EXTENDED_PROC_INFO_FEATURE_BITS = 0x80000001,
69 CPU_PROC_BRAND_STRING = 0x80000002,
70 CPU_L1_CACHE_AND_TLB_IDS = 0x80000005,
71 CPU_EXTENDED_L2_CACHE_FEATURES = 0x80000006,
72 CPU_ADV_POWER_MGT_INFO = 0x80000007,
73 CPU_VIRT_PHYS_ADDR_SIZES = 0x80000008
90 #define CEF_SYSCALLRET 13
96 typedef enum cputype {
104 CT_NATIONAL_SEMICONDUCTOR,
115 * cpuid_get_cpu_type - Get CPU Type
117 * Returns the CPU Type as cputype_t.
119 * See also: cpuid_get_cpu_type_string()
121 cputype_t cpuid_get_cpu_type(void);
124 * cpuid_get_cpu_type_string - Get CPU Type string
126 * Returns the CPU type string based off cputype_t.
128 const char *cpuid_get_cpu_type_string(const cputype_t cputype);
131 * cpuid_is_supported - test if the CPUID instruction is supported
133 * CPUID is not supported by old CPUS.
135 * Returns 1 if the cpuid instruction is supported, 0 otherwise.
139 int cpuid_is_supported(void);
142 * cpuid_highest_ext_func_supported - Get the highest extended function supported
145 * Returns the highest extended function supported.
147 * This is the same as calling:
148 * cpuid(CPU_HIGHEST_EEXTENDED_FUNCTION_SUPPORTED, &highest);
150 * This is made visible to the linker because it's easier to call it
151 * instead of calling cpuid with less type-checking. cpuid calls this.
155 int cpuid_highest_ext_func_supported(void);
158 * cpuid - Get Some information from the CPU.
160 * This function expects buf to be a valid pointer to a string/int/...
161 * depending on the requested information.
164 * Returns a string into buf.
166 * For CPU_PROCINFO_AND_FEATUREBITS:
171 * - 13:12 - Processor Type
172 * - 19:16 - Extended Model
173 * - 27:20 - Extended family
177 * Additional feature information.
179 * For CPU_HIGHEST_EXTENDED_FUNCTION_SUPPORTED:
180 * Returns the highest supported function in *buf (expects an integer ofc)
182 * For CPU_EXTENDED_PROC_INFO_FEATURE_BITS:
183 * Returns them in buf[0] and buf[1].
185 * For CPU_VIRT_PHYS_ADDR_SIZES:
186 * Returns it as an integer in *buf.
188 * For CPU_PROC_BRAND_STRING:
189 * Have a char array with at least 48 bytes assigned to it.
191 * If an invalid flag has been passed a 0xbaadf00d is returned in *buf.
193 void cpuid(cpuid_t info, void *buf);
196 * cpuid_test_feature - Test if @feature is available
198 * Returns 1 if feature is supported, 0 otherwise.
200 * The feature parameter must be >= CPU_EXTENDED_PROC_INFO_FEATURE_BITS
201 * and <= CPU_VIRT_PHYS_ADDR_SIZES.
203 int cpuid_test_feature(cpuid_t feature);
206 * cpuid_has_feature - Test if @feature is supported
208 * Test if the CPU supports MMX/SSE* etc.
209 * For the extended parameter, usually you want to pass it as
210 * 0 if you're not passing CEF_*.
212 * For more information about the CPU extended features, have a look
214 * http://en.wikipedia.org/wiki/CPUID
216 * Returns 1 if the feature is available, 0 otherwise.
218 #define cpuid_has_mmx() cpuid_has_feature(CF_MMX, 0)
219 #define cpuid_has_sse() cpuid_has_feature(CF_SSE, 0)
220 #define cpuid_has_sse2() cpuid_has_feature(CF_SSE2, 0)
221 #define cpuid_has_sse3() cpuid_has_feature(CF_SSE3, 0)
222 #define cpuid_has_ssse3() cpuid_has_feature(CF_SSSE3, 0)
223 #define cpuid_has_avx() cpuid_has_feature(CF_AVX, 0)
224 #define cpuid_has_fma() cpuid_has_feature(CF_FMA, 0)
225 #define cpuid_has_x64() cpuid_has_feature(CEF_x64, 1)
226 #define cpuid_has_sse4a() cpuid_has_feature(CEF_SSE4a, 1)
227 #define cpuid_has_fma4() cpuid_has_feature(CEF_FMA4, 1)
228 #define cpuid_has_xop() cpuid_has_feature(CEF_XOP, 1)
229 int cpuid_has_feature(int feature, int extended);