7bcc12fd1ca299763f5b1b5fd485ceac043869f4
[dpdk.git] / lib / librte_eal / common / include / arch / arm / rte_cpuflags_64.h
1 /*
2  *   BSD LICENSE
3  *
4  *   Copyright (C) Cavium networks Ltd. 2015.
5  *
6  *   Redistribution and use in source and binary forms, with or without
7  *   modification, are permitted provided that the following conditions
8  *   are met:
9  *
10  *     * Redistributions of source code must retain the above copyright
11  *       notice, this list of conditions and the following disclaimer.
12  *     * Redistributions in binary form must reproduce the above copyright
13  *       notice, this list of conditions and the following disclaimer in
14  *       the documentation and/or other materials provided with the
15  *       distribution.
16  *     * Neither the name of Cavium networks nor the names of its
17  *       contributors may be used to endorse or promote products derived
18  *       from this software without specific prior written permission.
19  *
20  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32
33 #ifndef _RTE_CPUFLAGS_ARM64_H_
34 #define _RTE_CPUFLAGS_ARM64_H_
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 #include <elf.h>
41 #include <fcntl.h>
42 #include <assert.h>
43 #include <unistd.h>
44 #include <string.h>
45
46 #include "generic/rte_cpuflags.h"
47
48 #ifndef AT_HWCAP
49 #define AT_HWCAP 16
50 #endif
51
52 #ifndef AT_HWCAP2
53 #define AT_HWCAP2 26
54 #endif
55
56 #ifndef AT_PLATFORM
57 #define AT_PLATFORM 15
58 #endif
59
60 /* software based registers */
61 enum cpu_register_t {
62         REG_HWCAP = 0,
63         REG_HWCAP2,
64         REG_PLATFORM,
65 };
66
67 /**
68  * Enumeration of all CPU features supported
69  */
70 enum rte_cpu_flag_t {
71         RTE_CPUFLAG_FP = 0,
72         RTE_CPUFLAG_NEON,
73         RTE_CPUFLAG_EVTSTRM,
74         RTE_CPUFLAG_AES,
75         RTE_CPUFLAG_PMULL,
76         RTE_CPUFLAG_SHA1,
77         RTE_CPUFLAG_SHA2,
78         RTE_CPUFLAG_CRC32,
79         RTE_CPUFLAG_AARCH64,
80         /* The last item */
81         RTE_CPUFLAG_NUMFLAGS,/**< This should always be the last! */
82 };
83
84 static const struct feature_entry cpu_feature_table[] = {
85         FEAT_DEF(FP,            0x00000001, 0, REG_HWCAP,  0)
86         FEAT_DEF(NEON,          0x00000001, 0, REG_HWCAP,  1)
87         FEAT_DEF(EVTSTRM,       0x00000001, 0, REG_HWCAP,  2)
88         FEAT_DEF(AES,           0x00000001, 0, REG_HWCAP,  3)
89         FEAT_DEF(PMULL,         0x00000001, 0, REG_HWCAP,  4)
90         FEAT_DEF(SHA1,          0x00000001, 0, REG_HWCAP,  5)
91         FEAT_DEF(SHA2,          0x00000001, 0, REG_HWCAP,  6)
92         FEAT_DEF(CRC32,         0x00000001, 0, REG_HWCAP,  7)
93         FEAT_DEF(AARCH64,       0x00000001, 0, REG_PLATFORM, 1)
94 };
95
96 /*
97  * Read AUXV software register and get cpu features for ARM
98  */
99 static inline void
100 rte_cpu_get_features(__attribute__((unused)) uint32_t leaf,
101                      __attribute__((unused)) uint32_t subleaf,
102                      cpuid_registers_t out)
103 {
104         int auxv_fd;
105         Elf64_auxv_t auxv;
106
107         auxv_fd = open("/proc/self/auxv", O_RDONLY);
108         assert(auxv_fd);
109         while (read(auxv_fd, &auxv,
110                     sizeof(Elf64_auxv_t)) == sizeof(Elf64_auxv_t)) {
111                 if (auxv.a_type == AT_HWCAP) {
112                         out[REG_HWCAP] = auxv.a_un.a_val;
113                 } else if (auxv.a_type == AT_HWCAP2) {
114                         out[REG_HWCAP2] = auxv.a_un.a_val;
115                 } else if (auxv.a_type == AT_PLATFORM) {
116                         if (!strcmp((const char *)auxv.a_un.a_val, "aarch64"))
117                                 out[REG_PLATFORM] = 0x0001;
118                 }
119         }
120 }
121
122 /*
123  * Checks if a particular flag is available on current machine.
124  */
125 static inline int
126 rte_cpu_get_flag_enabled(enum rte_cpu_flag_t feature)
127 {
128         const struct feature_entry *feat;
129         cpuid_registers_t regs = {0};
130
131         if (feature >= RTE_CPUFLAG_NUMFLAGS)
132                 /* Flag does not match anything in the feature tables */
133                 return -ENOENT;
134
135         feat = &cpu_feature_table[feature];
136
137         if (!feat->leaf)
138                 /* This entry in the table wasn't filled out! */
139                 return -EFAULT;
140
141         /* get the cpuid leaf containing the desired feature */
142         rte_cpu_get_features(feat->leaf, feat->subleaf, regs);
143
144         /* check if the feature is enabled */
145         return (regs[feat->reg] >> feat->bit) & 1;
146 }
147
148 #ifdef __cplusplus
149 }
150 #endif
151
152 #endif /* _RTE_CPUFLAGS_ARM64_H_ */