blob: f997c74a0444363e54ff51e9e3d502bff9277d8a [file] [log] [blame]
Achin Gupta4f6ad662013-10-25 09:08:21 +01001/*
Joel Hutton5cc3bc82018-03-21 11:40:57 +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
Soby Mathewa0fedc42016-06-16 14:52:04 +01007#include <assert.h>
Dan Handley2bd4ef22014-04-09 13:14:54 +01008#include <debug.h>
Achin Gupta4f6ad662013-10-25 09:08:21 +01009#include <errno.h>
Achin Guptac8afc782013-11-25 18:45:02 +000010#include <runtime_svc.h>
Dan Handley2bd4ef22014-04-09 13:14:54 +010011#include <string.h>
Achin Gupta4f6ad662013-10-25 09:08:21 +010012
13/*******************************************************************************
Achin Gupta7421b462014-02-01 18:53:26 +000014 * The 'rt_svc_descs' array holds the runtime service descriptors exported by
15 * services by placing them in the 'rt_svc_descs' linker section.
16 * The 'rt_svc_descs_indices' array holds the index of a descriptor in the
17 * 'rt_svc_descs' array. When an SMC arrives, the OEN[29:24] bits and the call
18 * type[31] bit in the function id are combined to get an index into the
19 * 'rt_svc_descs_indices' array. This gives the index of the descriptor in the
20 * 'rt_svc_descs' array which contains the SMC handler.
Achin Gupta4f6ad662013-10-25 09:08:21 +010021 ******************************************************************************/
Achin Gupta7421b462014-02-01 18:53:26 +000022uint8_t rt_svc_descs_indices[MAX_RT_SVCS];
Dan Handleye2712bc2014-04-10 15:37:22 +010023static rt_svc_desc_t *rt_svc_descs;
Achin Gupta7421b462014-02-01 18:53:26 +000024
Soby Mathewa0fedc42016-06-16 14:52:04 +010025#define RT_SVC_DECS_NUM ((RT_SVC_DESCS_END - RT_SVC_DESCS_START)\
26 / sizeof(rt_svc_desc_t))
27
Achin Gupta7421b462014-02-01 18:53:26 +000028/*******************************************************************************
Antonio Nino Diaz35c8cfc2018-04-23 15:43:29 +010029 * Function to invoke the registered `handle` corresponding to the smc_fid in
30 * AArch32 mode.
Soby Mathewa9482df2016-05-05 12:49:09 +010031 ******************************************************************************/
Antonio Nino Diaz35c8cfc2018-04-23 15:43:29 +010032#if SMCCC_MAJOR_VERSION == 1
Soby Mathewa9482df2016-05-05 12:49:09 +010033uintptr_t handle_runtime_svc(uint32_t smc_fid,
34 void *cookie,
35 void *handle,
36 unsigned int flags)
37{
38 u_register_t x1, x2, x3, x4;
Varun Wadekar66231d12017-06-07 09:57:42 -070039 int index;
40 unsigned int idx;
Soby Mathewa9482df2016-05-05 12:49:09 +010041 const rt_svc_desc_t *rt_svc_descs;
42
43 assert(handle);
44 idx = get_unique_oen_from_smc_fid(smc_fid);
Varun Wadekar66231d12017-06-07 09:57:42 -070045 assert(idx < MAX_RT_SVCS);
Soby Mathewa9482df2016-05-05 12:49:09 +010046
47 index = rt_svc_descs_indices[idx];
Varun Wadekar66231d12017-06-07 09:57:42 -070048 if (index < 0 || index >= (int)RT_SVC_DECS_NUM)
Soby Mathewa9482df2016-05-05 12:49:09 +010049 SMC_RET1(handle, SMC_UNK);
50
51 rt_svc_descs = (rt_svc_desc_t *) RT_SVC_DESCS_START;
52
53 get_smc_params_from_ctx(handle, x1, x2, x3, x4);
54
55 return rt_svc_descs[index].handle(smc_fid, x1, x2, x3, x4, cookie,
56 handle, flags);
57}
Antonio Nino Diaz35c8cfc2018-04-23 15:43:29 +010058#endif /* SMCCC_MAJOR_VERSION */
Soby Mathewa9482df2016-05-05 12:49:09 +010059
60/*******************************************************************************
Achin Gupta7421b462014-02-01 18:53:26 +000061 * Simple routine to sanity check a runtime service descriptor before using it
62 ******************************************************************************/
Sandrine Bailleux47110582016-06-28 16:44:28 +010063static int32_t validate_rt_svc_desc(const rt_svc_desc_t *desc)
Achin Gupta4f6ad662013-10-25 09:08:21 +010064{
Achin Gupta7421b462014-02-01 18:53:26 +000065 if (desc == NULL)
66 return -EINVAL;
67
68 if (desc->start_oen > desc->end_oen)
69 return -EINVAL;
70
71 if (desc->end_oen >= OEN_LIMIT)
72 return -EINVAL;
73
Antonio Nino Diaz35c8cfc2018-04-23 15:43:29 +010074#if SMCCC_MAJOR_VERSION == 1
75 if ((desc->call_type != SMC_TYPE_FAST) &&
76 (desc->call_type != SMC_TYPE_YIELD))
Achin Gupta7421b462014-02-01 18:53:26 +000077 return -EINVAL;
Antonio Nino Diaz35c8cfc2018-04-23 15:43:29 +010078#elif SMCCC_MAJOR_VERSION == 2
79 if (desc->is_vendor > 1U)
80 return -EINVAL;
81#endif /* SMCCC_MAJOR_VERSION */
Achin Gupta7421b462014-02-01 18:53:26 +000082
83 /* A runtime service having no init or handle function doesn't make sense */
Antonio Nino Diaz35c8cfc2018-04-23 15:43:29 +010084 if ((desc->init == NULL) && (desc->handle == NULL))
Achin Gupta7421b462014-02-01 18:53:26 +000085 return -EINVAL;
86
87 return 0;
88}
89
90/*******************************************************************************
91 * This function calls the initialisation routine in the descriptor exported by
92 * a runtime service. Once a descriptor has been validated, its start & end
93 * owning entity numbers and the call type are combined to form a unique oen.
94 * The unique oen is used as an index into the 'rt_svc_descs_indices' array.
95 * The index of the runtime service descriptor is stored at this index.
96 ******************************************************************************/
Juan Castillo2d552402014-06-13 17:05:10 +010097void runtime_svc_init(void)
Achin Gupta7421b462014-02-01 18:53:26 +000098{
Varun Wadekar66231d12017-06-07 09:57:42 -070099 int rc = 0;
100 unsigned int index, start_idx, end_idx;
Soby Mathewa0fedc42016-06-16 14:52:04 +0100101
102 /* Assert the number of descriptors detected are less than maximum indices */
Soby Mathewff1c2292016-07-26 16:09:44 +0100103 assert((RT_SVC_DESCS_END >= RT_SVC_DESCS_START) &&
104 (RT_SVC_DECS_NUM < MAX_RT_SVCS));
Achin Gupta7421b462014-02-01 18:53:26 +0000105
106 /* If no runtime services are implemented then simply bail out */
Antonio Nino Diaz35c8cfc2018-04-23 15:43:29 +0100107 if (RT_SVC_DECS_NUM == 0U)
Achin Gupta7421b462014-02-01 18:53:26 +0000108 return;
109
110 /* Initialise internal variables to invalid state */
111 memset(rt_svc_descs_indices, -1, sizeof(rt_svc_descs_indices));
112
Dan Handleye2712bc2014-04-10 15:37:22 +0100113 rt_svc_descs = (rt_svc_desc_t *) RT_SVC_DESCS_START;
Soby Mathewa0fedc42016-06-16 14:52:04 +0100114 for (index = 0; index < RT_SVC_DECS_NUM; index++) {
Sandrine Bailleux47110582016-06-28 16:44:28 +0100115 rt_svc_desc_t *service = &rt_svc_descs[index];
Achin Gupta7421b462014-02-01 18:53:26 +0000116
117 /*
118 * An invalid descriptor is an error condition since it is
119 * difficult to predict the system behaviour in the absence
120 * of this service.
121 */
Sandrine Bailleux47110582016-06-28 16:44:28 +0100122 rc = validate_rt_svc_desc(service);
Achin Gupta7421b462014-02-01 18:53:26 +0000123 if (rc) {
Sandrine Bailleux7304f452016-06-28 16:48:30 +0100124 ERROR("Invalid runtime service descriptor %p\n",
125 (void *) service);
Sandrine Bailleux47110582016-06-28 16:44:28 +0100126 panic();
Achin Gupta7421b462014-02-01 18:53:26 +0000127 }
128
Soby Mathew9f71f702014-05-09 20:49:17 +0100129 /*
Sandrine Bailleuxf4119ec2015-12-17 13:58:58 +0000130 * The runtime service may have separate rt_svc_desc_t
David Cunado28f69ab2017-04-05 11:34:03 +0100131 * for its fast smc and yielding smc. Since the service itself
Soby Mathew9f71f702014-05-09 20:49:17 +0100132 * need to be initialized only once, only one of them will have
133 * an initialisation routine defined. Call the initialisation
134 * routine for this runtime service, if it is defined.
135 */
Sandrine Bailleux47110582016-06-28 16:44:28 +0100136 if (service->init) {
137 rc = service->init();
Soby Mathew9f71f702014-05-09 20:49:17 +0100138 if (rc) {
139 ERROR("Error initializing runtime service %s\n",
Sandrine Bailleux47110582016-06-28 16:44:28 +0100140 service->name);
Soby Mathew9f71f702014-05-09 20:49:17 +0100141 continue;
142 }
Achin Gupta7421b462014-02-01 18:53:26 +0000143 }
Soby Mathew9f71f702014-05-09 20:49:17 +0100144
145 /*
146 * Fill the indices corresponding to the start and end
147 * owning entity numbers with the index of the
148 * descriptor which will handle the SMCs for this owning
149 * entity range.
150 */
Antonio Nino Diaz35c8cfc2018-04-23 15:43:29 +0100151#if SMCCC_MAJOR_VERSION == 1
152 start_idx = get_unique_oen(service->start_oen,
153 service->call_type);
154 end_idx = get_unique_oen(service->end_oen,
155 service->call_type);
156#elif SMCCC_MAJOR_VERSION == 2
157 start_idx = get_rt_desc_idx(service->start_oen,
158 service->is_vendor);
159 end_idx = get_rt_desc_idx(service->end_oen,
160 service->is_vendor);
161#endif
162 assert(start_idx <= end_idx);
Sandrine Bailleux7304f452016-06-28 16:48:30 +0100163 assert(end_idx < MAX_RT_SVCS);
Soby Mathew9f71f702014-05-09 20:49:17 +0100164 for (; start_idx <= end_idx; start_idx++)
165 rt_svc_descs_indices[start_idx] = index;
Achin Gupta7421b462014-02-01 18:53:26 +0000166 }
Achin Gupta4f6ad662013-10-25 09:08:21 +0100167}