blob: 148643129ca6a59c20a0dd9d4ca93cb04e687b8b [file] [log] [blame]
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +01001/*
Paul Beesley1fbc97b2019-01-11 18:26:51 +00002 * Copyright (c) 2017-2019, 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
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +010010#include <errno.h>
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +010011#include <stdbool.h>
Antonio Nino Diaz4b32e622018-08-16 16:52:57 +010012#include <stdint.h>
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000013
14#include <arch_helpers.h>
15#include <bl31/interrupt_mgmt.h>
16#include <common/debug.h>
17#include <context.h>
18#include <lib/el3_runtime/context_mgmt.h>
19#include <lib/spinlock.h>
20#include <lib/utils_def.h>
21#include <plat/common/platform.h>
22#include <services/sdei.h>
23#include <setjmp.h>
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +010024
25#ifdef AARCH32
26# error SDEI is implemented only for AArch64 systems
27#endif
28
29#ifndef PLAT_SDEI_CRITICAL_PRI
30# error Platform must define SDEI critical priority value
31#endif
32
33#ifndef PLAT_SDEI_NORMAL_PRI
34# error Platform must define SDEI normal priority value
35#endif
36
37/* Output SDEI logs as verbose */
38#define SDEI_LOG(...) VERBOSE("SDEI: " __VA_ARGS__)
39
40/* SDEI handler unregistered state. This is the default state. */
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +010041#define SDEI_STATE_UNREGISTERED 0U
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +010042
43/* SDE event status values in bit position */
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +010044#define SDEI_STATF_REGISTERED 0U
45#define SDEI_STATF_ENABLED 1U
46#define SDEI_STATF_RUNNING 2U
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +010047
48/* SDEI SMC error codes */
49#define SDEI_EINVAL (-2)
50#define SDEI_EDENY (-3)
51#define SDEI_EPEND (-5)
52#define SDEI_ENOMEM (-10)
53
54/*
55 * 'info' parameter to SDEI_EVENT_GET_INFO SMC.
56 *
Paul Beesley1fbc97b2019-01-11 18:26:51 +000057 * Note that the SDEI v1.0 specification mistakenly enumerates the
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +010058 * SDEI_INFO_EV_SIGNALED as SDEI_INFO_SIGNALED. This will be corrected in a
59 * future version.
60 */
61#define SDEI_INFO_EV_TYPE 0
62#define SDEI_INFO_EV_NOT_SIGNALED 1
63#define SDEI_INFO_EV_PRIORITY 2
64#define SDEI_INFO_EV_ROUTING_MODE 3
65#define SDEI_INFO_EV_ROUTING_AFF 4
66
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +010067#define SDEI_PRIVATE_MAPPING() (&sdei_global_mappings[SDEI_MAP_IDX_PRIV_])
68#define SDEI_SHARED_MAPPING() (&sdei_global_mappings[SDEI_MAP_IDX_SHRD_])
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +010069
70#define for_each_mapping_type(_i, _mapping) \
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +010071 for ((_i) = 0, (_mapping) = &sdei_global_mappings[(_i)]; \
72 (_i) < SDEI_MAP_IDX_MAX_; \
73 (_i)++, (_mapping) = &sdei_global_mappings[(_i)])
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +010074
75#define iterate_mapping(_mapping, _i, _map) \
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +010076 for ((_map) = (_mapping)->map, (_i) = 0; \
77 (_i) < (_mapping)->num_maps; \
78 (_i)++, (_map)++)
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +010079
80#define for_each_private_map(_i, _map) \
81 iterate_mapping(SDEI_PRIVATE_MAPPING(), _i, _map)
82
83#define for_each_shared_map(_i, _map) \
84 iterate_mapping(SDEI_SHARED_MAPPING(), _i, _map)
85
86/* SDEI_FEATURES */
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +010087#define SDEI_FEATURE_BIND_SLOTS 0U
88#define BIND_SLOTS_MASK 0xffffU
89#define FEATURES_SHARED_SLOTS_SHIFT 16U
90#define FEATURES_PRIVATE_SLOTS_SHIFT 0U
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +010091#define FEATURE_BIND_SLOTS(_priv, _shrd) \
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +010092 (((((uint64_t) (_priv)) & BIND_SLOTS_MASK) << FEATURES_PRIVATE_SLOTS_SHIFT) | \
93 ((((uint64_t) (_shrd)) & BIND_SLOTS_MASK) << FEATURES_SHARED_SLOTS_SHIFT))
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +010094
95#define GET_EV_STATE(_e, _s) get_ev_state_bit(_e, SDEI_STATF_##_s)
96#define SET_EV_STATE(_e, _s) clr_ev_state_bit(_e->state, SDEI_STATF_##_s)
97
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +010098static inline bool is_event_private(sdei_ev_map_t *map)
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +010099{
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100100 return ((map->map_flags & BIT_32(SDEI_MAPF_PRIVATE_SHIFT_)) != 0U);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100101}
102
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100103static inline bool is_event_shared(sdei_ev_map_t *map)
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100104{
105 return !is_event_private(map);
106}
107
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100108static inline bool is_event_critical(sdei_ev_map_t *map)
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100109{
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100110 return ((map->map_flags & BIT_32(SDEI_MAPF_CRITICAL_SHIFT_)) != 0U);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100111}
112
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100113static inline bool is_event_normal(sdei_ev_map_t *map)
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100114{
115 return !is_event_critical(map);
116}
117
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100118static inline bool is_event_signalable(sdei_ev_map_t *map)
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100119{
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100120 return ((map->map_flags & BIT_32(SDEI_MAPF_SIGNALABLE_SHIFT_)) != 0U);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100121}
122
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100123static inline bool is_map_dynamic(sdei_ev_map_t *map)
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100124{
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100125 return ((map->map_flags & BIT_32(SDEI_MAPF_DYNAMIC_SHIFT_)) != 0U);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100126}
127
128/*
129 * Checks whether an event is associated with an interrupt. Static events always
130 * return true, and dynamic events return whether SDEI_INTERRUPT_BIND had been
131 * called on them. This can be used on both static or dynamic events to check
132 * for an associated interrupt.
133 */
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100134static inline bool is_map_bound(sdei_ev_map_t *map)
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100135{
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100136 return ((map->map_flags & BIT_32(SDEI_MAPF_BOUND_SHIFT_)) != 0U);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100137}
138
139static inline void set_map_bound(sdei_ev_map_t *map)
140{
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100141 map->map_flags |= BIT_32(SDEI_MAPF_BOUND_SHIFT_);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100142}
143
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100144static inline bool is_map_explicit(sdei_ev_map_t *map)
Jeenu Viswambharan34392302018-01-17 12:30:11 +0000145{
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100146 return ((map->map_flags & BIT_32(SDEI_MAPF_EXPLICIT_SHIFT_)) != 0U);
Jeenu Viswambharan34392302018-01-17 12:30:11 +0000147}
148
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100149static inline void clr_map_bound(sdei_ev_map_t *map)
150{
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100151 map->map_flags &= ~BIT_32(SDEI_MAPF_BOUND_SHIFT_);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100152}
153
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100154static inline bool is_secure_sgi(unsigned int intr)
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100155{
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100156 return ((plat_ic_is_sgi(intr) != 0) &&
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100157 (plat_ic_get_interrupt_type(intr) == INTR_TYPE_EL3));
158}
159
160/*
161 * Determine EL of the client. If EL2 is implemented (hence the enabled HCE
162 * bit), deem EL2; otherwise, deem EL1.
163 */
164static inline unsigned int sdei_client_el(void)
165{
Jeenu Viswambharan061e9f52018-06-21 08:47:42 +0100166 cpu_context_t *ns_ctx = cm_get_context(NON_SECURE);
167 el3_state_t *el3_ctx = get_el3state_ctx(ns_ctx);
168
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100169 return ((read_ctx_reg(el3_ctx, CTX_SCR_EL3) & SCR_HCE_BIT) != 0U) ?
170 MODE_EL2 : MODE_EL1;
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100171}
172
173static inline unsigned int sdei_event_priority(sdei_ev_map_t *map)
174{
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100175 return (unsigned int) (is_event_critical(map) ? PLAT_SDEI_CRITICAL_PRI :
176 PLAT_SDEI_NORMAL_PRI);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100177}
178
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100179static inline bool get_ev_state_bit(sdei_entry_t *se, unsigned int bit_no)
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100180{
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100181 return ((se->state & BIT_32(bit_no)) != 0U);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100182}
183
184static inline void clr_ev_state_bit(sdei_entry_t *se, unsigned int bit_no)
185{
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100186 se->state &= ~BIT_32(bit_no);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100187}
188
189/* SDEI actions for state transition */
190typedef enum {
191 /*
192 * Actions resulting from client requests. These directly map to SMC
193 * calls. Note that the state table columns are listed in this order
194 * too.
195 */
196 DO_REGISTER = 0,
197 DO_RELEASE = 1,
198 DO_ENABLE = 2,
199 DO_DISABLE = 3,
200 DO_UNREGISTER = 4,
201 DO_ROUTING = 5,
202 DO_CONTEXT = 6,
203 DO_COMPLETE = 7,
204 DO_COMPLETE_RESUME = 8,
205
206 /* Action for event dispatch */
207 DO_DISPATCH = 9,
208
209 DO_MAX,
210} sdei_action_t;
211
212typedef enum {
213 SDEI_NORMAL,
214 SDEI_CRITICAL
215} sdei_class_t;
216
217static inline void sdei_map_lock(sdei_ev_map_t *map)
218{
219 spin_lock(&map->lock);
220}
221
222static inline void sdei_map_unlock(sdei_ev_map_t *map)
223{
224 spin_unlock(&map->lock);
225}
226
227extern const sdei_mapping_t sdei_global_mappings[];
228extern sdei_entry_t sdei_private_event_table[];
229extern sdei_entry_t sdei_shared_event_table[];
230
231void init_sdei_state(void);
232
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100233sdei_ev_map_t *find_event_map_by_intr(unsigned int intr_num, bool shared);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100234sdei_ev_map_t *find_event_map(int ev_num);
235sdei_entry_t *get_event_entry(sdei_ev_map_t *map);
236
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100237int64_t sdei_event_context(void *handle, unsigned int param);
238int sdei_event_complete(bool resume, uint64_t pc);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100239
240void sdei_pe_unmask(void);
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100241int64_t sdei_pe_mask(void);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100242
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100243int sdei_intr_handler(uint32_t intr_raw, uint32_t flags, void *handle,
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100244 void *cookie);
245bool can_sdei_state_trans(sdei_entry_t *se, sdei_action_t act);
Jeenu Viswambharan8b7e6bc2018-02-16 12:07:48 +0000246void begin_sdei_synchronous_dispatch(struct jmpbuf *buffer);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100247
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100248#endif /* SDEI_PRIVATE_H */