Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 1 | /* |
Dan Handley | e83b0ca | 2014-01-14 18:17:09 +0000 | [diff] [blame] | 2 | * Copyright (c) 2013-2014, ARM Limited and Contributors. All rights reserved. |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 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, this |
| 8 | * list of conditions and the following disclaimer. |
| 9 | * |
| 10 | * Redistributions in binary form must reproduce the above copyright notice, |
| 11 | * this list of conditions and the following disclaimer in the documentation |
| 12 | * and/or other materials provided with the distribution. |
| 13 | * |
| 14 | * Neither the name of ARM nor the names of its contributors may be used |
| 15 | * to endorse or promote products derived from this software without specific |
| 16 | * prior written permission. |
| 17 | * |
| 18 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| 19 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 20 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 21 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
| 22 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| 23 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| 24 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| 25 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| 26 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| 27 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| 28 | * POSSIBILITY OF SUCH DAMAGE. |
| 29 | */ |
| 30 | |
| 31 | #ifndef __RUNTIME_SVC_H__ |
| 32 | #define __RUNTIME_SVC_H__ |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 33 | |
| 34 | /******************************************************************************* |
| 35 | * Bit definitions inside the function id as per the SMC calling convention |
| 36 | ******************************************************************************/ |
| 37 | #define FUNCID_TYPE_SHIFT 31 |
| 38 | #define FUNCID_CC_SHIFT 30 |
Achin Gupta | 7421b46 | 2014-02-01 18:53:26 +0000 | [diff] [blame] | 39 | #define FUNCID_OEN_SHIFT 24 |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 40 | #define FUNCID_NUM_SHIFT 0 |
| 41 | |
| 42 | #define FUNCID_TYPE_MASK 0x1 |
| 43 | #define FUNCID_CC_MASK 0x1 |
Achin Gupta | 7421b46 | 2014-02-01 18:53:26 +0000 | [diff] [blame] | 44 | #define FUNCID_OEN_MASK 0x3f |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 45 | #define FUNCID_NUM_MASK 0xffff |
| 46 | |
Achin Gupta | 7421b46 | 2014-02-01 18:53:26 +0000 | [diff] [blame] | 47 | #define FUNCID_TYPE_WIDTH 1 |
| 48 | #define FUNCID_CC_WIDTH 1 |
| 49 | #define FUNCID_OEN_WIDTH 6 |
| 50 | #define FUNCID_NUM_WIDTH 16 |
| 51 | |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 52 | #define GET_SMC_CC(id) ((id >> FUNCID_CC_SHIFT) & \ |
| 53 | FUNCID_CC_MASK) |
Soby Mathew | 9f71f70 | 2014-05-09 20:49:17 +0100 | [diff] [blame] | 54 | #define GET_SMC_TYPE(id) ((id >> FUNCID_TYPE_SHIFT) & \ |
| 55 | FUNCID_TYPE_MASK) |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 56 | |
| 57 | #define SMC_64 1 |
| 58 | #define SMC_32 0 |
| 59 | #define SMC_UNK 0xffffffff |
Achin Gupta | 7421b46 | 2014-02-01 18:53:26 +0000 | [diff] [blame] | 60 | #define SMC_TYPE_FAST 1 |
| 61 | #define SMC_TYPE_STD 0 |
Soby Mathew | 9f71f70 | 2014-05-09 20:49:17 +0100 | [diff] [blame] | 62 | #define SMC_PREEMPTED 0xfffffffe |
Achin Gupta | 7421b46 | 2014-02-01 18:53:26 +0000 | [diff] [blame] | 63 | /******************************************************************************* |
| 64 | * Owning entity number definitions inside the function id as per the SMC |
| 65 | * calling convention |
| 66 | ******************************************************************************/ |
| 67 | #define OEN_ARM_START 0 |
| 68 | #define OEN_ARM_END 0 |
| 69 | #define OEN_CPU_START 1 |
| 70 | #define OEN_CPU_END 1 |
| 71 | #define OEN_SIP_START 2 |
| 72 | #define OEN_SIP_END 2 |
| 73 | #define OEN_OEM_START 3 |
| 74 | #define OEN_OEM_END 3 |
| 75 | #define OEN_STD_START 4 /* Standard Calls */ |
| 76 | #define OEN_STD_END 4 |
| 77 | #define OEN_TAP_START 48 /* Trusted Applications */ |
| 78 | #define OEN_TAP_END 49 |
| 79 | #define OEN_TOS_START 50 /* Trusted OS */ |
| 80 | #define OEN_TOS_END 63 |
| 81 | #define OEN_LIMIT 64 |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 82 | |
| 83 | /******************************************************************************* |
| 84 | * Constants to indicate type of exception to the common exception handler. |
| 85 | ******************************************************************************/ |
| 86 | #define SYNC_EXCEPTION_SP_EL0 0x0 |
| 87 | #define IRQ_SP_EL0 0x1 |
| 88 | #define FIQ_SP_EL0 0x2 |
| 89 | #define SERROR_SP_EL0 0x3 |
| 90 | #define SYNC_EXCEPTION_SP_ELX 0x4 |
| 91 | #define IRQ_SP_ELX 0x5 |
| 92 | #define FIQ_SP_ELX 0x6 |
| 93 | #define SERROR_SP_ELX 0x7 |
| 94 | #define SYNC_EXCEPTION_AARCH64 0x8 |
| 95 | #define IRQ_AARCH64 0x9 |
| 96 | #define FIQ_AARCH64 0xa |
| 97 | #define SERROR_AARCH64 0xb |
| 98 | #define SYNC_EXCEPTION_AARCH32 0xc |
| 99 | #define IRQ_AARCH32 0xd |
| 100 | #define FIQ_AARCH32 0xe |
| 101 | #define SERROR_AARCH32 0xf |
| 102 | |
Achin Gupta | 4a826dd | 2013-11-25 14:00:56 +0000 | [diff] [blame] | 103 | /******************************************************************************* |
Jeenu Viswambharan | caa8493 | 2014-02-06 10:36:15 +0000 | [diff] [blame] | 104 | * Structure definition, typedefs & constants for the runtime service framework |
Achin Gupta | 4a826dd | 2013-11-25 14:00:56 +0000 | [diff] [blame] | 105 | ******************************************************************************/ |
Achin Gupta | 4a826dd | 2013-11-25 14:00:56 +0000 | [diff] [blame] | 106 | |
Achin Gupta | 7421b46 | 2014-02-01 18:53:26 +0000 | [diff] [blame] | 107 | /* |
| 108 | * Constants to allow the assembler access a runtime service |
| 109 | * descriptor |
| 110 | */ |
Achin Gupta | 07f4e07 | 2014-02-02 12:02:23 +0000 | [diff] [blame] | 111 | #define RT_SVC_SIZE_LOG2 5 |
| 112 | #define SIZEOF_RT_SVC_DESC (1 << RT_SVC_SIZE_LOG2) |
Achin Gupta | 7421b46 | 2014-02-01 18:53:26 +0000 | [diff] [blame] | 113 | #define RT_SVC_DESC_INIT 16 |
| 114 | #define RT_SVC_DESC_HANDLE 24 |
| 115 | |
| 116 | /* |
| 117 | * The function identifier has 6 bits for the owning entity number and |
| 118 | * single bit for the type of smc call. When taken together these |
| 119 | * values limit the maximum number of runtime services to 128. |
| 120 | */ |
| 121 | #define MAX_RT_SVCS 128 |
| 122 | |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 123 | #ifndef __ASSEMBLY__ |
| 124 | |
Dan Handley | 2bd4ef2 | 2014-04-09 13:14:54 +0100 | [diff] [blame] | 125 | #include <cassert.h> |
| 126 | #include <context.h> |
| 127 | #include <stdint.h> |
| 128 | |
Achin Gupta | 07f4e07 | 2014-02-02 12:02:23 +0000 | [diff] [blame] | 129 | /* Various flags passed to SMC handlers */ |
| 130 | #define SMC_FROM_SECURE (0 << 0) |
| 131 | #define SMC_FROM_NON_SECURE (1 << 0) |
| 132 | |
| 133 | #define is_caller_non_secure(_f) (!!(_f & SMC_FROM_NON_SECURE)) |
| 134 | #define is_caller_secure(_f) (!(is_caller_non_secure(_f))) |
| 135 | |
Achin Gupta | 7421b46 | 2014-02-01 18:53:26 +0000 | [diff] [blame] | 136 | /* Prototype for runtime service initializing function */ |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 137 | typedef int32_t (*rt_svc_init_t)(void); |
Achin Gupta | 7421b46 | 2014-02-01 18:53:26 +0000 | [diff] [blame] | 138 | |
| 139 | /* Convenience macros to return from SMC handler */ |
Achin Gupta | aeaab68 | 2014-05-09 13:21:31 +0100 | [diff] [blame] | 140 | #define SMC_RET0(_h) { \ |
| 141 | return (uint64_t) (_h); \ |
| 142 | } |
Achin Gupta | 7421b46 | 2014-02-01 18:53:26 +0000 | [diff] [blame] | 143 | #define SMC_RET1(_h, _x0) { \ |
| 144 | write_ctx_reg(get_gpregs_ctx(_h), CTX_GPREG_X0, (_x0)); \ |
Achin Gupta | aeaab68 | 2014-05-09 13:21:31 +0100 | [diff] [blame] | 145 | SMC_RET0(_h); \ |
Achin Gupta | 7421b46 | 2014-02-01 18:53:26 +0000 | [diff] [blame] | 146 | } |
| 147 | #define SMC_RET2(_h, _x0, _x1) { \ |
| 148 | write_ctx_reg(get_gpregs_ctx(_h), CTX_GPREG_X1, (_x1)); \ |
| 149 | SMC_RET1(_h, (_x0)); \ |
| 150 | } |
| 151 | #define SMC_RET3(_h, _x0, _x1, _x2) { \ |
| 152 | write_ctx_reg(get_gpregs_ctx(_h), CTX_GPREG_X2, (_x2)); \ |
| 153 | SMC_RET2(_h, (_x0), (_x1)); \ |
| 154 | } |
| 155 | #define SMC_RET4(_h, _x0, _x1, _x2, _x3) { \ |
| 156 | write_ctx_reg(get_gpregs_ctx(_h), CTX_GPREG_X3, (_x3)); \ |
| 157 | SMC_RET3(_h, (_x0), (_x1), (_x2)); \ |
| 158 | } |
| 159 | |
| 160 | |
| 161 | /* |
| 162 | * Convenience macros to access general purpose registers using handle provided |
| 163 | * to SMC handler. These takes the offset values defined in context.h |
| 164 | */ |
| 165 | #define SMC_GET_GP(_h, _g) \ |
| 166 | read_ctx_reg(get_gpregs_ctx(_h), (_g)); |
| 167 | #define SMC_SET_GP(_h, _g, _v) \ |
| 168 | write_ctx_reg(get_gpregs_ctx(_h), (_g), (_v)); |
| 169 | |
| 170 | /* |
| 171 | * Convenience macros to access EL3 context registers using handle provided to |
| 172 | * SMC handler. These takes the offset values defined in context.h |
| 173 | */ |
| 174 | #define SMC_GET_EL3(_h, _e) \ |
| 175 | read_ctx_reg(get_el3state_ctx(_h), (_e)); |
| 176 | #define SMC_SET_EL3(_h, _e, _v) \ |
| 177 | write_ctx_reg(get_el3state_ctx(_h), (_e), (_v)); |
| 178 | |
| 179 | /* |
| 180 | * Prototype for runtime service SMC handler function. x0 (SMC Function ID) to |
| 181 | * x4 are as passed by the caller. Rest of the arguments to SMC and the context |
| 182 | * can be accessed using the handle pointer. The cookie parameter is reserved |
| 183 | * for future use |
| 184 | */ |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 185 | typedef uint64_t (*rt_svc_handle_t)(uint32_t smc_fid, |
Achin Gupta | 7421b46 | 2014-02-01 18:53:26 +0000 | [diff] [blame] | 186 | uint64_t x1, |
| 187 | uint64_t x2, |
| 188 | uint64_t x3, |
| 189 | uint64_t x4, |
| 190 | void *cookie, |
| 191 | void *handle, |
| 192 | uint64_t flags); |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 193 | typedef struct rt_svc_desc { |
Achin Gupta | 7421b46 | 2014-02-01 18:53:26 +0000 | [diff] [blame] | 194 | uint8_t start_oen; |
| 195 | uint8_t end_oen; |
| 196 | uint8_t call_type; |
| 197 | const char *name; |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 198 | rt_svc_init_t init; |
| 199 | rt_svc_handle_t handle; |
| 200 | } rt_svc_desc_t; |
Achin Gupta | 7421b46 | 2014-02-01 18:53:26 +0000 | [diff] [blame] | 201 | |
| 202 | /* |
| 203 | * Convenience macro to declare a service descriptor |
| 204 | */ |
| 205 | #define DECLARE_RT_SVC(_name, _start, _end, _type, _setup, _smch) \ |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 206 | static const rt_svc_desc_t __svc_desc_ ## _name \ |
Achin Gupta | 7421b46 | 2014-02-01 18:53:26 +0000 | [diff] [blame] | 207 | __attribute__ ((section("rt_svc_descs"), used)) = { \ |
| 208 | _start, \ |
| 209 | _end, \ |
| 210 | _type, \ |
| 211 | #_name, \ |
| 212 | _setup, \ |
| 213 | _smch } |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 214 | |
Achin Gupta | 7421b46 | 2014-02-01 18:53:26 +0000 | [diff] [blame] | 215 | /* |
| 216 | * Compile time assertions related to the 'rt_svc_desc' structure to: |
| 217 | * 1. ensure that the assembler and the compiler view of the size |
| 218 | * of the structure are the same. |
| 219 | * 2. ensure that the assembler and the compiler see the initialisation |
| 220 | * routine at the same offset. |
Achin Gupta | 07f4e07 | 2014-02-02 12:02:23 +0000 | [diff] [blame] | 221 | * 3. ensure that the assembler and the compiler see the handler |
Achin Gupta | 7421b46 | 2014-02-01 18:53:26 +0000 | [diff] [blame] | 222 | * routine at the same offset. |
| 223 | */ |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 224 | CASSERT((sizeof(rt_svc_desc_t) == SIZEOF_RT_SVC_DESC), \ |
Achin Gupta | 7421b46 | 2014-02-01 18:53:26 +0000 | [diff] [blame] | 225 | assert_sizeof_rt_svc_desc_mismatch); |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 226 | CASSERT(RT_SVC_DESC_INIT == __builtin_offsetof(rt_svc_desc_t, init), \ |
Achin Gupta | 7421b46 | 2014-02-01 18:53:26 +0000 | [diff] [blame] | 227 | assert_rt_svc_desc_init_offset_mismatch); |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 228 | CASSERT(RT_SVC_DESC_HANDLE == __builtin_offsetof(rt_svc_desc_t, handle), \ |
Achin Gupta | 7421b46 | 2014-02-01 18:53:26 +0000 | [diff] [blame] | 229 | assert_rt_svc_desc_handle_offset_mismatch); |
| 230 | |
| 231 | |
| 232 | /* |
| 233 | * This macro combines the call type and the owning entity number corresponding |
| 234 | * to a runtime service to generate a unique owning entity number. This unique |
| 235 | * oen is used to access an entry in the 'rt_svc_descs_indices' array. The entry |
| 236 | * contains the index of the service descriptor in the 'rt_svc_descs' array. |
| 237 | */ |
| 238 | #define get_unique_oen(oen, call_type) ((oen & FUNCID_OEN_MASK) | \ |
| 239 | ((call_type & FUNCID_TYPE_MASK) \ |
| 240 | << FUNCID_OEN_WIDTH)) |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 241 | |
Jeenu Viswambharan | 1814a3e | 2014-02-28 10:08:33 +0000 | [diff] [blame] | 242 | |
| 243 | /* |
| 244 | * Macro to define UUID for services. Apart from defining and initializing a |
| 245 | * uuid_t structure, this macro verifies that the first word of the defined UUID |
| 246 | * does not equal SMC_UNK. This is to ensure that the caller won't mistake the |
| 247 | * returned UUID in x0 for an invalid SMC error return |
| 248 | */ |
| 249 | #define DEFINE_SVC_UUID(_name, _tl, _tm, _th, _cl, _ch, \ |
| 250 | _n0, _n1, _n2, _n3, _n4, _n5) \ |
| 251 | CASSERT(_tl != SMC_UNK, invalid_svc_uuid);\ |
| 252 | static const uuid_t _name = { \ |
| 253 | _tl, _tm, _th, _cl, _ch, \ |
| 254 | { _n0, _n1, _n2, _n3, _n4, _n5 } \ |
| 255 | } |
| 256 | |
| 257 | /* Return a UUID in the SMC return registers */ |
| 258 | #define SMC_UUID_RET(_h, _uuid) \ |
| 259 | SMC_RET4(handle, ((const uint32_t *) &(_uuid))[0], \ |
| 260 | ((const uint32_t *) &(_uuid))[1], \ |
| 261 | ((const uint32_t *) &(_uuid))[2], \ |
| 262 | ((const uint32_t *) &(_uuid))[3]) |
| 263 | |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 264 | /******************************************************************************* |
| 265 | * Function & variable prototypes |
| 266 | ******************************************************************************/ |
Dan Handley | a17fefa | 2014-05-14 12:38:32 +0100 | [diff] [blame] | 267 | void runtime_svc_init(); |
Achin Gupta | 7421b46 | 2014-02-01 18:53:26 +0000 | [diff] [blame] | 268 | extern uint64_t __RT_SVC_DESCS_START__; |
| 269 | extern uint64_t __RT_SVC_DESCS_END__; |
Andrew Thoelke | 8c28fe0 | 2014-06-02 11:40:35 +0100 | [diff] [blame] | 270 | void init_crash_reporting(void); |
Dan Handley | a17fefa | 2014-05-14 12:38:32 +0100 | [diff] [blame] | 271 | void runtime_exceptions(void); |
Andrew Thoelke | 8c28fe0 | 2014-06-02 11:40:35 +0100 | [diff] [blame] | 272 | |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 273 | #endif /*__ASSEMBLY__*/ |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 274 | #endif /* __RUNTIME_SVC_H__ */ |