1 /* 2 * Copyright (c) 2017-2018, ARM Limited and Contributors. All rights reserved. 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 */ 6 7 #ifndef SDEI_PRIVATE_H 8 #define SDEI_PRIVATE_H 9 10 #include <arch_helpers.h> 11 #include <context.h> 12 #include <context_mgmt.h> 13 #include <debug.h> 14 #include <errno.h> 15 #include <interrupt_mgmt.h> 16 #include <platform.h> 17 #include <sdei.h> 18 #include <setjmp.h> 19 #include <spinlock.h> 20 #include <stdbool.h> 21 #include <stdint.h> 22 #include <utils_def.h> 23 24 #ifdef AARCH32 25 # error SDEI is implemented only for AArch64 systems 26 #endif 27 28 #ifndef PLAT_SDEI_CRITICAL_PRI 29 # error Platform must define SDEI critical priority value 30 #endif 31 32 #ifndef PLAT_SDEI_NORMAL_PRI 33 # error Platform must define SDEI normal priority value 34 #endif 35 36 /* Output SDEI logs as verbose */ 37 #define SDEI_LOG(...) VERBOSE("SDEI: " __VA_ARGS__) 38 39 /* SDEI handler unregistered state. This is the default state. */ 40 #define SDEI_STATE_UNREGISTERED 0U 41 42 /* SDE event status values in bit position */ 43 #define SDEI_STATF_REGISTERED 0U 44 #define SDEI_STATF_ENABLED 1U 45 #define SDEI_STATF_RUNNING 2U 46 47 /* SDEI SMC error codes */ 48 #define SDEI_EINVAL (-2) 49 #define SDEI_EDENY (-3) 50 #define SDEI_EPEND (-5) 51 #define SDEI_ENOMEM (-10) 52 53 /* 54 * 'info' parameter to SDEI_EVENT_GET_INFO SMC. 55 * 56 * Note that the SDEI v1.0 speification mistakenly enumerates the 57 * SDEI_INFO_EV_SIGNALED as SDEI_INFO_SIGNALED. This will be corrected in a 58 * future version. 59 */ 60 #define SDEI_INFO_EV_TYPE 0 61 #define SDEI_INFO_EV_NOT_SIGNALED 1 62 #define SDEI_INFO_EV_PRIORITY 2 63 #define SDEI_INFO_EV_ROUTING_MODE 3 64 #define SDEI_INFO_EV_ROUTING_AFF 4 65 66 #define SDEI_PRIVATE_MAPPING() (&sdei_global_mappings[SDEI_MAP_IDX_PRIV_]) 67 #define SDEI_SHARED_MAPPING() (&sdei_global_mappings[SDEI_MAP_IDX_SHRD_]) 68 69 #define for_each_mapping_type(_i, _mapping) \ 70 for ((_i) = 0, (_mapping) = &sdei_global_mappings[(_i)]; \ 71 (_i) < SDEI_MAP_IDX_MAX_; \ 72 (_i)++, (_mapping) = &sdei_global_mappings[(_i)]) 73 74 #define iterate_mapping(_mapping, _i, _map) \ 75 for ((_map) = (_mapping)->map, (_i) = 0; \ 76 (_i) < (_mapping)->num_maps; \ 77 (_i)++, (_map)++) 78 79 #define for_each_private_map(_i, _map) \ 80 iterate_mapping(SDEI_PRIVATE_MAPPING(), _i, _map) 81 82 #define for_each_shared_map(_i, _map) \ 83 iterate_mapping(SDEI_SHARED_MAPPING(), _i, _map) 84 85 /* SDEI_FEATURES */ 86 #define SDEI_FEATURE_BIND_SLOTS 0U 87 #define BIND_SLOTS_MASK 0xffffU 88 #define FEATURES_SHARED_SLOTS_SHIFT 16U 89 #define FEATURES_PRIVATE_SLOTS_SHIFT 0U 90 #define FEATURE_BIND_SLOTS(_priv, _shrd) \ 91 (((((uint64_t) (_priv)) & BIND_SLOTS_MASK) << FEATURES_PRIVATE_SLOTS_SHIFT) | \ 92 ((((uint64_t) (_shrd)) & BIND_SLOTS_MASK) << FEATURES_SHARED_SLOTS_SHIFT)) 93 94 #define GET_EV_STATE(_e, _s) get_ev_state_bit(_e, SDEI_STATF_##_s) 95 #define SET_EV_STATE(_e, _s) clr_ev_state_bit(_e->state, SDEI_STATF_##_s) 96 97 static inline bool is_event_private(sdei_ev_map_t *map) 98 { 99 return ((map->map_flags & BIT_32(SDEI_MAPF_PRIVATE_SHIFT_)) != 0U); 100 } 101 102 static inline bool is_event_shared(sdei_ev_map_t *map) 103 { 104 return !is_event_private(map); 105 } 106 107 static inline bool is_event_critical(sdei_ev_map_t *map) 108 { 109 return ((map->map_flags & BIT_32(SDEI_MAPF_CRITICAL_SHIFT_)) != 0U); 110 } 111 112 static inline bool is_event_normal(sdei_ev_map_t *map) 113 { 114 return !is_event_critical(map); 115 } 116 117 static inline bool is_event_signalable(sdei_ev_map_t *map) 118 { 119 return ((map->map_flags & BIT_32(SDEI_MAPF_SIGNALABLE_SHIFT_)) != 0U); 120 } 121 122 static inline bool is_map_dynamic(sdei_ev_map_t *map) 123 { 124 return ((map->map_flags & BIT_32(SDEI_MAPF_DYNAMIC_SHIFT_)) != 0U); 125 } 126 127 /* 128 * Checks whether an event is associated with an interrupt. Static events always 129 * return true, and dynamic events return whether SDEI_INTERRUPT_BIND had been 130 * called on them. This can be used on both static or dynamic events to check 131 * for an associated interrupt. 132 */ 133 static inline bool is_map_bound(sdei_ev_map_t *map) 134 { 135 return ((map->map_flags & BIT_32(SDEI_MAPF_BOUND_SHIFT_)) != 0U); 136 } 137 138 static inline void set_map_bound(sdei_ev_map_t *map) 139 { 140 map->map_flags |= BIT_32(SDEI_MAPF_BOUND_SHIFT_); 141 } 142 143 static inline bool is_map_explicit(sdei_ev_map_t *map) 144 { 145 return ((map->map_flags & BIT_32(SDEI_MAPF_EXPLICIT_SHIFT_)) != 0U); 146 } 147 148 static inline void clr_map_bound(sdei_ev_map_t *map) 149 { 150 map->map_flags &= ~BIT_32(SDEI_MAPF_BOUND_SHIFT_); 151 } 152 153 static inline bool is_secure_sgi(unsigned int intr) 154 { 155 return ((plat_ic_is_sgi(intr) != 0) && 156 (plat_ic_get_interrupt_type(intr) == INTR_TYPE_EL3)); 157 } 158 159 /* 160 * Determine EL of the client. If EL2 is implemented (hence the enabled HCE 161 * bit), deem EL2; otherwise, deem EL1. 162 */ 163 static inline unsigned int sdei_client_el(void) 164 { 165 cpu_context_t *ns_ctx = cm_get_context(NON_SECURE); 166 el3_state_t *el3_ctx = get_el3state_ctx(ns_ctx); 167 168 return ((read_ctx_reg(el3_ctx, CTX_SCR_EL3) & SCR_HCE_BIT) != 0U) ? 169 MODE_EL2 : MODE_EL1; 170 } 171 172 static inline unsigned int sdei_event_priority(sdei_ev_map_t *map) 173 { 174 return (unsigned int) (is_event_critical(map) ? PLAT_SDEI_CRITICAL_PRI : 175 PLAT_SDEI_NORMAL_PRI); 176 } 177 178 static inline bool get_ev_state_bit(sdei_entry_t *se, unsigned int bit_no) 179 { 180 return ((se->state & BIT_32(bit_no)) != 0U); 181 } 182 183 static inline void clr_ev_state_bit(sdei_entry_t *se, unsigned int bit_no) 184 { 185 se->state &= ~BIT_32(bit_no); 186 } 187 188 /* SDEI actions for state transition */ 189 typedef enum { 190 /* 191 * Actions resulting from client requests. These directly map to SMC 192 * calls. Note that the state table columns are listed in this order 193 * too. 194 */ 195 DO_REGISTER = 0, 196 DO_RELEASE = 1, 197 DO_ENABLE = 2, 198 DO_DISABLE = 3, 199 DO_UNREGISTER = 4, 200 DO_ROUTING = 5, 201 DO_CONTEXT = 6, 202 DO_COMPLETE = 7, 203 DO_COMPLETE_RESUME = 8, 204 205 /* Action for event dispatch */ 206 DO_DISPATCH = 9, 207 208 DO_MAX, 209 } sdei_action_t; 210 211 typedef enum { 212 SDEI_NORMAL, 213 SDEI_CRITICAL 214 } sdei_class_t; 215 216 static inline void sdei_map_lock(sdei_ev_map_t *map) 217 { 218 spin_lock(&map->lock); 219 } 220 221 static inline void sdei_map_unlock(sdei_ev_map_t *map) 222 { 223 spin_unlock(&map->lock); 224 } 225 226 extern const sdei_mapping_t sdei_global_mappings[]; 227 extern sdei_entry_t sdei_private_event_table[]; 228 extern sdei_entry_t sdei_shared_event_table[]; 229 230 void init_sdei_state(void); 231 232 sdei_ev_map_t *find_event_map_by_intr(unsigned int intr_num, bool shared); 233 sdei_ev_map_t *find_event_map(int ev_num); 234 sdei_entry_t *get_event_entry(sdei_ev_map_t *map); 235 236 int64_t sdei_event_context(void *handle, unsigned int param); 237 int sdei_event_complete(bool resume, uint64_t pc); 238 239 void sdei_pe_unmask(void); 240 int64_t sdei_pe_mask(void); 241 242 int sdei_intr_handler(uint32_t intr_raw, uint32_t flags, void *handle, 243 void *cookie); 244 bool can_sdei_state_trans(sdei_entry_t *se, sdei_action_t act); 245 void begin_sdei_synchronous_dispatch(struct jmpbuf *buffer); 246 247 #endif /* SDEI_PRIVATE_H */ 248