Zephyr Project API 3.7.0
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
lib_helpers.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2021 Carlo Caione <ccaione@baylibre.com>
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7#ifndef ZEPHYR_INCLUDE_ARCH_ARM64_LIB_HELPERS_H_
8#define ZEPHYR_INCLUDE_ARCH_ARM64_LIB_HELPERS_H_
9
10#ifndef _ASMLANGUAGE
11
13#include <stdint.h>
14
15/* All the macros need a memory clobber */
16
17#define read_sysreg(reg) \
18({ \
19 uint64_t reg_val; \
20 __asm__ volatile ("mrs %0, " STRINGIFY(reg) \
21 : "=r" (reg_val) :: "memory"); \
22 reg_val; \
23})
24
25#define write_sysreg(val, reg) \
26({ \
27 __asm__ volatile ("msr " STRINGIFY(reg) ", %0" \
28 :: "r" (val) : "memory"); \
29})
30
31#define zero_sysreg(reg) \
32({ \
33 __asm__ volatile ("msr " STRINGIFY(reg) ", xzr" \
34 ::: "memory"); \
35})
36
37#define MAKE_REG_HELPER(reg) \
38 static ALWAYS_INLINE uint64_t read_##reg(void) \
39 { \
40 return read_sysreg(reg); \
41 } \
42 static ALWAYS_INLINE void write_##reg(uint64_t val) \
43 { \
44 write_sysreg(val, reg); \
45 } \
46 static ALWAYS_INLINE void zero_##reg(void) \
47 { \
48 zero_sysreg(reg); \
49 }
50
51#define MAKE_REG_HELPER_EL123(reg) \
52 MAKE_REG_HELPER(reg##_el1) \
53 MAKE_REG_HELPER(reg##_el2) \
54 MAKE_REG_HELPER(reg##_el3)
55
56MAKE_REG_HELPER(ccsidr_el1);
57MAKE_REG_HELPER(clidr_el1);
58MAKE_REG_HELPER(cntfrq_el0);
59MAKE_REG_HELPER(cnthctl_el2);
60MAKE_REG_HELPER(cnthp_ctl_el2);
61MAKE_REG_HELPER(cnthps_ctl_el2);
62MAKE_REG_HELPER(cntv_ctl_el0)
63MAKE_REG_HELPER(cntv_cval_el0)
64MAKE_REG_HELPER(cntvct_el0);
65MAKE_REG_HELPER(cntvoff_el2);
66MAKE_REG_HELPER(currentel);
67MAKE_REG_HELPER(csselr_el1);
70MAKE_REG_HELPER(id_aa64pfr0_el1);
71MAKE_REG_HELPER(id_aa64mmfr0_el1);
72MAKE_REG_HELPER(mpidr_el1);
74#if !defined(CONFIG_ARMV8_R)
76#endif /* CONFIG_ARMV8_R */
77MAKE_REG_HELPER(tpidrro_el0);
78MAKE_REG_HELPER(vmpidr_el2);
80
93
94#if defined(CONFIG_ARM_MPU)
95/* Armv8-R aarch64 mpu registers */
96#define mpuir_el1 S3_0_c0_c0_4
97#define prselr_el1 S3_0_c6_c2_1
98#define prbar_el1 S3_0_c6_c8_0
99#define prlar_el1 S3_0_c6_c8_1
100
101MAKE_REG_HELPER(mpuir_el1);
102MAKE_REG_HELPER(prselr_el1);
103MAKE_REG_HELPER(prbar_el1);
104MAKE_REG_HELPER(prlar_el1);
105#endif
106
108{
109 __asm__ volatile ("msr DAIFClr, %0"
110 :: "i" (DAIFCLR_DBG_BIT) : "memory");
111}
112
114{
115 __asm__ volatile ("msr DAIFSet, %0"
116 :: "i" (DAIFSET_DBG_BIT) : "memory");
117}
118
120{
121 __asm__ volatile ("msr DAIFClr, %0"
122 :: "i" (DAIFCLR_ABT_BIT) : "memory");
123}
124
126{
127 __asm__ volatile ("msr DAIFSet, %0"
128 :: "i" (DAIFSET_ABT_BIT) : "memory");
129}
130
131static ALWAYS_INLINE void enable_irq(void)
132{
133 __asm__ volatile ("msr DAIFClr, %0"
134 :: "i" (DAIFCLR_IRQ_BIT) : "memory");
135}
136
137static ALWAYS_INLINE void disable_irq(void)
138{
139 __asm__ volatile ("msr DAIFSet, %0"
140 :: "i" (DAIFSET_IRQ_BIT) : "memory");
141}
142
143static ALWAYS_INLINE void enable_fiq(void)
144{
145 __asm__ volatile ("msr DAIFClr, %0"
146 :: "i" (DAIFCLR_FIQ_BIT) : "memory");
147}
148
149static ALWAYS_INLINE void disable_fiq(void)
150{
151 __asm__ volatile ("msr DAIFSet, %0"
152 :: "i" (DAIFSET_FIQ_BIT) : "memory");
153}
154
155#define sev() __asm__ volatile("sev" : : : "memory")
156#define wfe() __asm__ volatile("wfe" : : : "memory")
157#define wfi() __asm__ volatile("wfi" : : : "memory")
158
159static inline bool is_el_implemented(unsigned int el)
160{
161 unsigned int shift;
162
163 if (el > 3) {
164 return false;
165 }
166
167 shift = ID_AA64PFR0_EL1_SHIFT * el;
168
169 return (((read_id_aa64pfr0_el1() >> shift) & ID_AA64PFR0_ELX_MASK) != 0U);
170}
171
172static inline bool is_el_highest_implemented(void)
173{
174 uint32_t el_highest;
175 uint32_t curr_el;
176
177 el_highest = read_id_aa64pfr0_el1() & 0xFFFF;
178 el_highest = (31U - __builtin_clz(el_highest)) / 4;
179
180 curr_el = GET_EL(read_currentel());
181
182 if (curr_el < el_highest)
183 return false;
184
185 return true;
186}
187
188static inline bool is_el2_sec_supported(void)
189{
191 ID_AA64PFR0_SEL2_MASK) != 0U);
192}
193
194static inline bool is_in_secure_state(void)
195{
196 /* We cannot read SCR_EL3 from EL2 or EL1 */
197 return !IS_ENABLED(CONFIG_ARMV8_A_NS);
198}
199
200#endif /* !_ASMLANGUAGE */
201
202#endif /* ZEPHYR_INCLUDE_ARCH_ARM64_LIB_HELPERS_H_ */
static ALWAYS_INLINE void disable_serror_exceptions(void)
Definition lib_helpers.h:125
static ALWAYS_INLINE uint64_t read_id_aa64pfr0_el1(void)
Definition lib_helpers.h:70
static ALWAYS_INLINE void disable_debug_exceptions(void)
Definition lib_helpers.h:113
static bool is_el_implemented(unsigned int el)
Definition lib_helpers.h:159
static bool is_el_highest_implemented(void)
Definition lib_helpers.h:172
static ALWAYS_INLINE void disable_irq(void)
Definition lib_helpers.h:137
static ALWAYS_INLINE void enable_irq(void)
Definition lib_helpers.h:131
static ALWAYS_INLINE void disable_fiq(void)
Definition lib_helpers.h:149
static ALWAYS_INLINE void enable_debug_exceptions(void)
Definition lib_helpers.h:107
#define MAKE_REG_HELPER_EL123(reg)
Definition lib_helpers.h:51
static ALWAYS_INLINE void enable_serror_exceptions(void)
Definition lib_helpers.h:119
static ALWAYS_INLINE uint64_t read_currentel(void)
Definition lib_helpers.h:66
static ALWAYS_INLINE void enable_fiq(void)
Definition lib_helpers.h:143
static bool is_in_secure_state(void)
Definition lib_helpers.h:194
static bool is_el2_sec_supported(void)
Definition lib_helpers.h:188
#define GET_EL(_mode)
Definition cpu.h:95
#define DAIFCLR_ABT_BIT
Definition cpu.h:20
#define DAIFSET_IRQ_BIT
Definition cpu.h:14
#define ID_AA64PFR0_SEL2_MASK
Definition cpu.h:117
#define DAIFSET_ABT_BIT
Definition cpu.h:15
#define DAIFSET_FIQ_BIT
Definition cpu.h:13
#define DAIFCLR_IRQ_BIT
Definition cpu.h:19
#define ID_AA64PFR0_SEL2_SHIFT
Definition cpu.h:116
#define ID_AA64PFR0_EL1_SHIFT
Definition cpu.h:112
#define DAIFCLR_FIQ_BIT
Definition cpu.h:18
#define ID_AA64PFR0_ELX_MASK
Definition cpu.h:115
#define DAIFSET_DBG_BIT
Definition cpu.h:16
#define DAIFCLR_DBG_BIT
Definition cpu.h:21
#define ALWAYS_INLINE
Definition common.h:129
#define MAKE_REG_HELPER(reg, op1, CRn, CRm, op2)
Definition lib_helpers.h:45
#define IS_ENABLED(config_macro)
Check for macro definition in compiler-visible expressions.
Definition util_macro.h:124
__UINT32_TYPE__ uint32_t
Definition stdint.h:90