4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #ifndef _RTE_CPUFLAGS_H_
35 #define _RTE_CPUFLAGS_H_
39 * Architecture specific API to determine available CPU features at runtime.
48 * Enumeration of all CPU features supported
53 * Enumeration of CPU registers
57 typedef uint32_t cpuid_registers_t[4];
59 #define CPU_FLAG_NAME_MAX_LEN 64
62 * Struct to hold a processor feature entry
64 struct feature_entry {
65 uint32_t leaf; /**< cpuid leaf */
66 uint32_t subleaf; /**< cpuid subleaf */
67 uint32_t reg; /**< cpuid register */
68 uint32_t bit; /**< cpuid register bit */
69 char name[CPU_FLAG_NAME_MAX_LEN]; /**< String for printing */
72 #define FEAT_DEF(name, leaf, subleaf, reg, bit) \
73 [RTE_CPUFLAG_##name] = {leaf, subleaf, reg, bit, #name },
76 * An array that holds feature entries
78 static const struct feature_entry cpu_feature_table[];
81 * Execute CPUID instruction and get contents of a specific register
83 * This function, when compiled with GCC, will generate architecture-neutral
84 * code, as per GCC manual.
87 rte_cpu_get_features(uint32_t leaf, uint32_t subleaf, cpuid_registers_t out);
90 * Function for checking a CPU flag availability
93 * CPU flag to query CPU for
95 * 1 if flag is available
96 * 0 if flag is not available
97 * -ENOENT if flag is invalid
100 rte_cpu_get_flag_enabled(enum rte_cpu_flag_t feature);
103 * This function checks that the currently used CPU supports the CPU features
104 * that were specified at compile time. It is called automatically within the
105 * EAL, so does not need to be used by applications.
108 rte_cpu_check_supported(void);
110 #endif /* _RTE_CPUFLAGS_H_ */