1 /*******************************************************************************
2   Copyright (c) 2018-2020, Intel Corporation
3 
4   Redistribution and use in source and binary forms, with or without
5   modification, are permitted provided that the following conditions are met:
6 
7       * Redistributions of source code must retain the above copyright notice,
8         this list of conditions and the following disclaimer.
9       * Redistributions in binary form must reproduce the above copyright
10         notice, this list of conditions and the following disclaimer in the
11         documentation and/or other materials provided with the distribution.
12       * Neither the name of Intel Corporation nor the names of its contributors
13         may be used to endorse or promote products derived from this software
14         without specific prior written permission.
15 
16   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17   AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19   DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
20   FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21   DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22   SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
23   CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 *******************************************************************************/
27 
28 #include "intel-ipsec-mb.h"
29 
30 #ifndef CPU_FEATURE_H
31 #define CPU_FEATURE_H
32 
33 /**
34  * @brief Detects hardware features and returns their status
35  *
36  * @return Bitmask representing presence of CPU features/extensions,
37  *         see intel-ipsec-mb.h IMB_FEATURE_xyz definitions for details.
38  */
39 IMB_DLL_LOCAL uint64_t cpu_feature_detect(void);
40 
41 /**
42  * @brief Modifies CPU \a features mask based on requested \a flags
43  *
44  * @param flags bitmask describing CPU feature adjustments
45  * @param features bitmask describing present CPU features
46  *
47  * @return \a features with applied modifications on them via \a flags
48  */
49 IMB_DLL_LOCAL uint64_t
50 cpu_feature_adjust(const uint64_t flags, uint64_t features);
51 
52 #endif /* CPU_FEATURE_H */
53