blob: e32c2870aee31fc4f237969febfb6c6300862d64 [file] [log] [blame]
Achin Gupta4f6ad662013-10-25 09:08:21 +01001/*
Roberto Vargas05712702018-02-12 12:36:17 +00002 * Copyright (c) 2013-2018, ARM Limited and Contributors. All rights reserved.
Achin Gupta4f6ad662013-10-25 09:08:21 +01003 *
dp-armfa3cf0b2017-05-03 09:38:09 +01004 * SPDX-License-Identifier: BSD-3-Clause
Achin Gupta4f6ad662013-10-25 09:08:21 +01005 */
6
Sathees Balya50905c72018-10-05 13:30:59 +01007#ifndef RUNTIME_SVC_H
8#define RUNTIME_SVC_H
Achin Gupta4f6ad662013-10-25 09:08:21 +01009
Yatharth Kochar6c0566c2015-10-02 17:56:48 +010010#include <bl_common.h> /* to include exception types */
Antonio Nino Diaz35c8cfc2018-04-23 15:43:29 +010011#include <cassert.h>
Antonio Nino Diaz3c817f42018-03-21 10:49:27 +000012#include <smccc_helpers.h> /* to include SMCCC definitions */
Antonio Nino Diaz35c8cfc2018-04-23 15:43:29 +010013#include <utils_def.h>
Achin Gupta4f6ad662013-10-25 09:08:21 +010014
Achin Gupta4a826dd2013-11-25 14:00:56 +000015/*******************************************************************************
Jeenu Viswambharancaa84932014-02-06 10:36:15 +000016 * Structure definition, typedefs & constants for the runtime service framework
Achin Gupta4a826dd2013-11-25 14:00:56 +000017 ******************************************************************************/
Achin Gupta4a826dd2013-11-25 14:00:56 +000018
Achin Gupta7421b462014-02-01 18:53:26 +000019/*
20 * Constants to allow the assembler access a runtime service
21 * descriptor
22 */
Soby Mathewa9482df2016-05-05 12:49:09 +010023#ifdef AARCH32
Antonio Nino Diazf0b14cf2018-10-04 09:55:23 +010024#define RT_SVC_SIZE_LOG2 U(4)
25#define RT_SVC_DESC_INIT U(8)
26#define RT_SVC_DESC_HANDLE U(12)
Soby Mathewa9482df2016-05-05 12:49:09 +010027#else
Antonio Nino Diazf0b14cf2018-10-04 09:55:23 +010028#define RT_SVC_SIZE_LOG2 U(5)
29#define RT_SVC_DESC_INIT U(16)
30#define RT_SVC_DESC_HANDLE U(24)
Soby Mathewa9482df2016-05-05 12:49:09 +010031#endif /* AARCH32 */
Antonio Nino Diazf0b14cf2018-10-04 09:55:23 +010032#define SIZEOF_RT_SVC_DESC (U(1) << RT_SVC_SIZE_LOG2)
Soby Mathewa9482df2016-05-05 12:49:09 +010033
Achin Gupta7421b462014-02-01 18:53:26 +000034
35/*
Antonio Nino Diaz35c8cfc2018-04-23 15:43:29 +010036 * In SMCCC 1.X, the function identifier has 6 bits for the owning entity number
37 * and a single bit for the type of smc call. When taken together, those values
38 * limit the maximum number of runtime services to 128.
39 *
40 * In SMCCC 2.X the type bit is always 1 and there are only 4 OEN bits in the
41 * compatibility namespace, so the total number of services is 16. The LSB of
42 * namespace is also added to these 4 bits to make space for the vendor service
43 * handler and so the total number of runtime services is 32.
Achin Gupta7421b462014-02-01 18:53:26 +000044 */
Antonio Nino Diaz35c8cfc2018-04-23 15:43:29 +010045#if SMCCC_MAJOR_VERSION == 1
Antonio Nino Diazf0b14cf2018-10-04 09:55:23 +010046#define MAX_RT_SVCS U(128)
Antonio Nino Diaz35c8cfc2018-04-23 15:43:29 +010047#elif SMCCC_MAJOR_VERSION == 2
Antonio Nino Diazf0b14cf2018-10-04 09:55:23 +010048#define MAX_RT_SVCS U(32)
Antonio Nino Diaz35c8cfc2018-04-23 15:43:29 +010049#endif
Achin Gupta7421b462014-02-01 18:53:26 +000050
Achin Gupta4f6ad662013-10-25 09:08:21 +010051#ifndef __ASSEMBLY__
52
Achin Gupta7421b462014-02-01 18:53:26 +000053/* Prototype for runtime service initializing function */
Dan Handleye2712bc2014-04-10 15:37:22 +010054typedef int32_t (*rt_svc_init_t)(void);
Achin Gupta7421b462014-02-01 18:53:26 +000055
Achin Gupta7421b462014-02-01 18:53:26 +000056/*
57 * Prototype for runtime service SMC handler function. x0 (SMC Function ID) to
58 * x4 are as passed by the caller. Rest of the arguments to SMC and the context
59 * can be accessed using the handle pointer. The cookie parameter is reserved
60 * for future use
61 */
Soby Mathewa0fedc42016-06-16 14:52:04 +010062typedef uintptr_t (*rt_svc_handle_t)(uint32_t smc_fid,
63 u_register_t x1,
64 u_register_t x2,
65 u_register_t x3,
66 u_register_t x4,
Achin Gupta7421b462014-02-01 18:53:26 +000067 void *cookie,
68 void *handle,
Soby Mathewa0fedc42016-06-16 14:52:04 +010069 u_register_t flags);
Dan Handleye2712bc2014-04-10 15:37:22 +010070typedef struct rt_svc_desc {
Achin Gupta7421b462014-02-01 18:53:26 +000071 uint8_t start_oen;
72 uint8_t end_oen;
Antonio Nino Diaz35c8cfc2018-04-23 15:43:29 +010073#if SMCCC_MAJOR_VERSION == 1
Achin Gupta7421b462014-02-01 18:53:26 +000074 uint8_t call_type;
Antonio Nino Diaz35c8cfc2018-04-23 15:43:29 +010075#elif SMCCC_MAJOR_VERSION == 2
76 uint8_t is_vendor;
77#endif
Achin Gupta7421b462014-02-01 18:53:26 +000078 const char *name;
Dan Handleye2712bc2014-04-10 15:37:22 +010079 rt_svc_init_t init;
80 rt_svc_handle_t handle;
81} rt_svc_desc_t;
Achin Gupta7421b462014-02-01 18:53:26 +000082
83/*
Antonio Nino Diaz35c8cfc2018-04-23 15:43:29 +010084 * Convenience macros to declare a service descriptor
85 */
86#if SMCCC_MAJOR_VERSION == 1
87
88#define DECLARE_RT_SVC(_name, _start, _end, _type, _setup, _smch) \
89 static const rt_svc_desc_t __svc_desc_ ## _name \
90 __section("rt_svc_descs") __used = { \
Sathees Balya50905c72018-10-05 13:30:59 +010091 .start_oen = (_start), \
92 .end_oen = (_end), \
93 .call_type = (_type), \
Antonio Nino Diaz35c8cfc2018-04-23 15:43:29 +010094 .name = #_name, \
Sathees Balya50905c72018-10-05 13:30:59 +010095 .init = (_setup), \
96 .handle = (_smch) \
Antonio Nino Diaz35c8cfc2018-04-23 15:43:29 +010097 }
98
99#elif SMCCC_MAJOR_VERSION == 2
100
101#define DECLARE_RT_SVC(_name, _start, _end, _type, _setup, _smch) \
102 static const rt_svc_desc_t __svc_desc_ ## _name \
103 __section("rt_svc_descs") __used = { \
Sathees Balya50905c72018-10-05 13:30:59 +0100104 .start_oen = (_start), \
105 .end_oen = (_end), \
Antonio Nino Diaz35c8cfc2018-04-23 15:43:29 +0100106 .is_vendor = 0, \
107 .name = #_name, \
Sathees Balya50905c72018-10-05 13:30:59 +0100108 .init = (_setup), \
109 .handle = (_smch), \
Antonio Nino Diaz35c8cfc2018-04-23 15:43:29 +0100110 }; \
111 CASSERT((_type) == SMC_TYPE_FAST, rt_svc_type_check_ ## _name)
112
113/*
114 * The higher 16 entries of the runtime services are used for the vendor
115 * specific descriptor.
Achin Gupta7421b462014-02-01 18:53:26 +0000116 */
Antonio Nino Diaz35c8cfc2018-04-23 15:43:29 +0100117#define DECLARE_RT_SVC_VENDOR(_setup, _smch) \
118 static const rt_svc_desc_t __svc_desc_vendor \
119 __section("rt_svc_descs") __used = { \
120 .start_oen = 0, \
121 .end_oen = 15, \
122 .is_vendor = 1, \
123 .name = "vendor_rt_svc", \
124 .init = _setup, \
125 .handle = _smch, \
126 }
127
128#endif /* SMCCC_MAJOR_VERSION */
Achin Gupta4f6ad662013-10-25 09:08:21 +0100129
Achin Gupta7421b462014-02-01 18:53:26 +0000130/*
131 * Compile time assertions related to the 'rt_svc_desc' structure to:
132 * 1. ensure that the assembler and the compiler view of the size
133 * of the structure are the same.
134 * 2. ensure that the assembler and the compiler see the initialisation
135 * routine at the same offset.
Achin Gupta07f4e072014-02-02 12:02:23 +0000136 * 3. ensure that the assembler and the compiler see the handler
Achin Gupta7421b462014-02-01 18:53:26 +0000137 * routine at the same offset.
138 */
Dan Handleye2712bc2014-04-10 15:37:22 +0100139CASSERT((sizeof(rt_svc_desc_t) == SIZEOF_RT_SVC_DESC), \
Achin Gupta7421b462014-02-01 18:53:26 +0000140 assert_sizeof_rt_svc_desc_mismatch);
Dan Handleye2712bc2014-04-10 15:37:22 +0100141CASSERT(RT_SVC_DESC_INIT == __builtin_offsetof(rt_svc_desc_t, init), \
Achin Gupta7421b462014-02-01 18:53:26 +0000142 assert_rt_svc_desc_init_offset_mismatch);
Dan Handleye2712bc2014-04-10 15:37:22 +0100143CASSERT(RT_SVC_DESC_HANDLE == __builtin_offsetof(rt_svc_desc_t, handle), \
Achin Gupta7421b462014-02-01 18:53:26 +0000144 assert_rt_svc_desc_handle_offset_mismatch);
145
146
Antonio Nino Diaz35c8cfc2018-04-23 15:43:29 +0100147#if SMCCC_MAJOR_VERSION == 1
Achin Gupta7421b462014-02-01 18:53:26 +0000148/*
Antonio Nino Diazf0b14cf2018-10-04 09:55:23 +0100149 * This function combines the call type and the owning entity number
150 * corresponding to a runtime service to generate a unique owning entity number.
151 * This unique oen is used to access an entry in the 'rt_svc_descs_indices'
152 * array. The entry contains the index of the service descriptor in the
153 * 'rt_svc_descs' array.
Achin Gupta7421b462014-02-01 18:53:26 +0000154 */
Antonio Nino Diazf0b14cf2018-10-04 09:55:23 +0100155static inline uint32_t get_unique_oen(uint32_t oen, uint32_t call_type)
156{
157 return ((call_type & FUNCID_TYPE_MASK) << FUNCID_OEN_WIDTH) |
158 (oen & FUNCID_OEN_MASK);
159}
Achin Gupta4f6ad662013-10-25 09:08:21 +0100160
Soby Mathewa9482df2016-05-05 12:49:09 +0100161/*
Antonio Nino Diazf0b14cf2018-10-04 09:55:23 +0100162 * This function generates the unique owning entity number from the SMC Function
Antonio Nino Diaze8811472018-04-17 15:10:18 +0100163 * ID. This unique oen is used to access an entry in the 'rt_svc_descs_indices'
164 * array to invoke the corresponding runtime service handler during SMC
165 * handling.
Soby Mathewa9482df2016-05-05 12:49:09 +0100166 */
Antonio Nino Diazf0b14cf2018-10-04 09:55:23 +0100167static inline uint32_t get_unique_oen_from_smc_fid(uint32_t fid)
168{
169 return get_unique_oen(GET_SMC_OEN(fid), GET_SMC_TYPE(fid));
170}
Antonio Nino Diaz35c8cfc2018-04-23 15:43:29 +0100171
172#elif SMCCC_MAJOR_VERSION == 2
173
174/*
Antonio Nino Diazf0b14cf2018-10-04 09:55:23 +0100175 * This function combines the owning entity number corresponding to a runtime
Antonio Nino Diaz35c8cfc2018-04-23 15:43:29 +0100176 * service with one extra bit for the vendor namespace to generate an index into
177 * the 'rt_svc_descs_indices' array. The entry contains the index of the service
178 * descriptor in the 'rt_svc_descs' array.
179 */
Antonio Nino Diazf0b14cf2018-10-04 09:55:23 +0100180static inline uint32_t get_rt_desc_idx(uint32_t oen, uint32_t is_vendor)
181{
182 return ((is_vendor & 1U) << FUNCID_OEN_WIDTH) |
183 (oen & FUNCID_OEN_MASK);
184}
Antonio Nino Diaz35c8cfc2018-04-23 15:43:29 +0100185
186#endif
Soby Mathewa9482df2016-05-05 12:49:09 +0100187
Achin Gupta4f6ad662013-10-25 09:08:21 +0100188/*******************************************************************************
189 * Function & variable prototypes
190 ******************************************************************************/
Juan Castillo2d552402014-06-13 17:05:10 +0100191void runtime_svc_init(void);
Soby Mathewa9482df2016-05-05 12:49:09 +0100192uintptr_t handle_runtime_svc(uint32_t smc_fid, void *cookie, void *handle,
193 unsigned int flags);
Joel Hutton5cc3bc82018-03-21 11:40:57 +0000194IMPORT_SYM(uintptr_t, __RT_SVC_DESCS_START__, RT_SVC_DESCS_START);
195IMPORT_SYM(uintptr_t, __RT_SVC_DESCS_END__, RT_SVC_DESCS_END);
Andrew Thoelke8c28fe02014-06-02 11:40:35 +0100196void init_crash_reporting(void);
Andrew Thoelke8c28fe02014-06-02 11:40:35 +0100197
Roberto Vargas05712702018-02-12 12:36:17 +0000198extern uint8_t rt_svc_descs_indices[MAX_RT_SVCS];
199
Achin Gupta4f6ad662013-10-25 09:08:21 +0100200#endif /*__ASSEMBLY__*/
Sathees Balya50905c72018-10-05 13:30:59 +0100201#endif /* RUNTIME_SVC_H */