blob: d99aceacb195e583a71d8fb83b8e60626d266c61 [file] [log] [blame]
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +01001/*
Jeenu Viswambharan34392302018-01-17 12:30:11 +00002 * Copyright (c) 2017-2018, ARM Limited and Contributors. All rights reserved.
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +01003 *
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +01007#ifndef SDEI_PRIVATE_H
8#define SDEI_PRIVATE_H
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +01009
10#include <arch_helpers.h>
Jeenu Viswambharan061e9f52018-06-21 08:47:42 +010011#include <context_mgmt.h>
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +010012#include <debug.h>
13#include <errno.h>
14#include <interrupt_mgmt.h>
15#include <platform.h>
16#include <sdei.h>
Jeenu Viswambharan8b7e6bc2018-02-16 12:07:48 +000017#include <setjmp.h>
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +010018#include <spinlock.h>
19#include <stdbool.h>
20#include <types.h>
21#include <utils_def.h>
22
23#ifdef AARCH32
24# error SDEI is implemented only for AArch64 systems
25#endif
26
27#ifndef PLAT_SDEI_CRITICAL_PRI
28# error Platform must define SDEI critical priority value
29#endif
30
31#ifndef PLAT_SDEI_NORMAL_PRI
32# error Platform must define SDEI normal priority value
33#endif
34
35/* Output SDEI logs as verbose */
36#define SDEI_LOG(...) VERBOSE("SDEI: " __VA_ARGS__)
37
38/* SDEI handler unregistered state. This is the default state. */
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +010039#define SDEI_STATE_UNREGISTERED 0U
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +010040
41/* SDE event status values in bit position */
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +010042#define SDEI_STATF_REGISTERED 0U
43#define SDEI_STATF_ENABLED 1U
44#define SDEI_STATF_RUNNING 2U
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +010045
46/* SDEI SMC error codes */
47#define SDEI_EINVAL (-2)
48#define SDEI_EDENY (-3)
49#define SDEI_EPEND (-5)
50#define SDEI_ENOMEM (-10)
51
52/*
53 * 'info' parameter to SDEI_EVENT_GET_INFO SMC.
54 *
55 * Note that the SDEI v1.0 speification mistakenly enumerates the
56 * SDEI_INFO_EV_SIGNALED as SDEI_INFO_SIGNALED. This will be corrected in a
57 * future version.
58 */
59#define SDEI_INFO_EV_TYPE 0
60#define SDEI_INFO_EV_NOT_SIGNALED 1
61#define SDEI_INFO_EV_PRIORITY 2
62#define SDEI_INFO_EV_ROUTING_MODE 3
63#define SDEI_INFO_EV_ROUTING_AFF 4
64
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +010065#define SDEI_PRIVATE_MAPPING() (&sdei_global_mappings[SDEI_MAP_IDX_PRIV_])
66#define SDEI_SHARED_MAPPING() (&sdei_global_mappings[SDEI_MAP_IDX_SHRD_])
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +010067
68#define for_each_mapping_type(_i, _mapping) \
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +010069 for ((_i) = 0, (_mapping) = &sdei_global_mappings[(_i)]; \
70 (_i) < SDEI_MAP_IDX_MAX_; \
71 (_i)++, (_mapping) = &sdei_global_mappings[(_i)])
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +010072
73#define iterate_mapping(_mapping, _i, _map) \
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +010074 for ((_map) = (_mapping)->map, (_i) = 0; \
75 (_i) < (_mapping)->num_maps; \
76 (_i)++, (_map)++)
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +010077
78#define for_each_private_map(_i, _map) \
79 iterate_mapping(SDEI_PRIVATE_MAPPING(), _i, _map)
80
81#define for_each_shared_map(_i, _map) \
82 iterate_mapping(SDEI_SHARED_MAPPING(), _i, _map)
83
84/* SDEI_FEATURES */
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +010085#define SDEI_FEATURE_BIND_SLOTS 0U
86#define BIND_SLOTS_MASK 0xffffU
87#define FEATURES_SHARED_SLOTS_SHIFT 16U
88#define FEATURES_PRIVATE_SLOTS_SHIFT 0U
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +010089#define FEATURE_BIND_SLOTS(_priv, _shrd) \
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +010090 (((((uint64_t) (_priv)) & BIND_SLOTS_MASK) << FEATURES_PRIVATE_SLOTS_SHIFT) | \
91 ((((uint64_t) (_shrd)) & BIND_SLOTS_MASK) << FEATURES_SHARED_SLOTS_SHIFT))
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +010092
93#define GET_EV_STATE(_e, _s) get_ev_state_bit(_e, SDEI_STATF_##_s)
94#define SET_EV_STATE(_e, _s) clr_ev_state_bit(_e->state, SDEI_STATF_##_s)
95
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +010096static inline bool is_event_private(sdei_ev_map_t *map)
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +010097{
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +010098 return ((map->map_flags & BIT_32(SDEI_MAPF_PRIVATE_SHIFT_)) != 0U);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +010099}
100
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100101static inline bool is_event_shared(sdei_ev_map_t *map)
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100102{
103 return !is_event_private(map);
104}
105
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100106static inline bool is_event_critical(sdei_ev_map_t *map)
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100107{
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100108 return ((map->map_flags & BIT_32(SDEI_MAPF_CRITICAL_SHIFT_)) != 0U);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100109}
110
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100111static inline bool is_event_normal(sdei_ev_map_t *map)
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100112{
113 return !is_event_critical(map);
114}
115
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100116static inline bool is_event_signalable(sdei_ev_map_t *map)
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100117{
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100118 return ((map->map_flags & BIT_32(SDEI_MAPF_SIGNALABLE_SHIFT_)) != 0U);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100119}
120
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100121static inline bool is_map_dynamic(sdei_ev_map_t *map)
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100122{
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100123 return ((map->map_flags & BIT_32(SDEI_MAPF_DYNAMIC_SHIFT_)) != 0U);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100124}
125
126/*
127 * Checks whether an event is associated with an interrupt. Static events always
128 * return true, and dynamic events return whether SDEI_INTERRUPT_BIND had been
129 * called on them. This can be used on both static or dynamic events to check
130 * for an associated interrupt.
131 */
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100132static inline bool is_map_bound(sdei_ev_map_t *map)
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100133{
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100134 return ((map->map_flags & BIT_32(SDEI_MAPF_BOUND_SHIFT_)) != 0U);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100135}
136
137static inline void set_map_bound(sdei_ev_map_t *map)
138{
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100139 map->map_flags |= BIT_32(SDEI_MAPF_BOUND_SHIFT_);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100140}
141
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100142static inline bool is_map_explicit(sdei_ev_map_t *map)
Jeenu Viswambharan34392302018-01-17 12:30:11 +0000143{
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100144 return ((map->map_flags & BIT_32(SDEI_MAPF_EXPLICIT_SHIFT_)) != 0U);
Jeenu Viswambharan34392302018-01-17 12:30:11 +0000145}
146
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100147static inline void clr_map_bound(sdei_ev_map_t *map)
148{
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100149 map->map_flags &= ~BIT_32(SDEI_MAPF_BOUND_SHIFT_);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100150}
151
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100152static inline bool is_secure_sgi(unsigned int intr)
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100153{
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100154 return ((plat_ic_is_sgi(intr) != 0) &&
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100155 (plat_ic_get_interrupt_type(intr) == INTR_TYPE_EL3));
156}
157
158/*
159 * Determine EL of the client. If EL2 is implemented (hence the enabled HCE
160 * bit), deem EL2; otherwise, deem EL1.
161 */
162static inline unsigned int sdei_client_el(void)
163{
Jeenu Viswambharan061e9f52018-06-21 08:47:42 +0100164 cpu_context_t *ns_ctx = cm_get_context(NON_SECURE);
165 el3_state_t *el3_ctx = get_el3state_ctx(ns_ctx);
166
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100167 return ((read_ctx_reg(el3_ctx, CTX_SCR_EL3) & SCR_HCE_BIT) != 0U) ?
168 MODE_EL2 : MODE_EL1;
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100169}
170
171static inline unsigned int sdei_event_priority(sdei_ev_map_t *map)
172{
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100173 return (unsigned int) (is_event_critical(map) ? PLAT_SDEI_CRITICAL_PRI :
174 PLAT_SDEI_NORMAL_PRI);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100175}
176
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100177static inline bool get_ev_state_bit(sdei_entry_t *se, unsigned int bit_no)
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100178{
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100179 return ((se->state & BIT_32(bit_no)) != 0U);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100180}
181
182static inline void clr_ev_state_bit(sdei_entry_t *se, unsigned int bit_no)
183{
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100184 se->state &= ~BIT_32(bit_no);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100185}
186
187/* SDEI actions for state transition */
188typedef enum {
189 /*
190 * Actions resulting from client requests. These directly map to SMC
191 * calls. Note that the state table columns are listed in this order
192 * too.
193 */
194 DO_REGISTER = 0,
195 DO_RELEASE = 1,
196 DO_ENABLE = 2,
197 DO_DISABLE = 3,
198 DO_UNREGISTER = 4,
199 DO_ROUTING = 5,
200 DO_CONTEXT = 6,
201 DO_COMPLETE = 7,
202 DO_COMPLETE_RESUME = 8,
203
204 /* Action for event dispatch */
205 DO_DISPATCH = 9,
206
207 DO_MAX,
208} sdei_action_t;
209
210typedef enum {
211 SDEI_NORMAL,
212 SDEI_CRITICAL
213} sdei_class_t;
214
215static inline void sdei_map_lock(sdei_ev_map_t *map)
216{
217 spin_lock(&map->lock);
218}
219
220static inline void sdei_map_unlock(sdei_ev_map_t *map)
221{
222 spin_unlock(&map->lock);
223}
224
225extern const sdei_mapping_t sdei_global_mappings[];
226extern sdei_entry_t sdei_private_event_table[];
227extern sdei_entry_t sdei_shared_event_table[];
228
229void init_sdei_state(void);
230
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100231sdei_ev_map_t *find_event_map_by_intr(unsigned int intr_num, bool shared);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100232sdei_ev_map_t *find_event_map(int ev_num);
233sdei_entry_t *get_event_entry(sdei_ev_map_t *map);
234
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100235int64_t sdei_event_context(void *handle, unsigned int param);
236int sdei_event_complete(bool resume, uint64_t pc);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100237
238void sdei_pe_unmask(void);
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100239int64_t sdei_pe_mask(void);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100240
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100241int sdei_intr_handler(uint32_t intr_raw, uint32_t flags, void *handle,
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100242 void *cookie);
243bool can_sdei_state_trans(sdei_entry_t *se, sdei_action_t act);
Jeenu Viswambharan8b7e6bc2018-02-16 12:07:48 +0000244void begin_sdei_synchronous_dispatch(struct jmpbuf *buffer);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100245
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100246#endif /* SDEI_PRIVATE_H */