1 /* 2 * Copyright (c) 2013-2018, ARM Limited and Contributors. All rights reserved. 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 */ 6 7 #include <assert.h> 8 #include <debug.h> 9 #include <errno.h> 10 #include <runtime_svc.h> 11 #include <string.h> 12 13 /******************************************************************************* 14 * 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. 21 ******************************************************************************/ 22 uint8_t rt_svc_descs_indices[MAX_RT_SVCS]; 23 static rt_svc_desc_t *rt_svc_descs; 24 25 #define RT_SVC_DECS_NUM ((RT_SVC_DESCS_END - RT_SVC_DESCS_START)\ 26 / sizeof(rt_svc_desc_t)) 27 28 /******************************************************************************* 29 * Function to invoke the registered `handle` corresponding to the smc_fid in 30 * AArch32 mode. 31 ******************************************************************************/ 32 #if SMCCC_MAJOR_VERSION == 1 33 uintptr_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; 39 int index; 40 unsigned int idx; 41 const rt_svc_desc_t *rt_svc_descs; 42 43 assert(handle); 44 idx = get_unique_oen_from_smc_fid(smc_fid); 45 assert(idx < MAX_RT_SVCS); 46 47 index = rt_svc_descs_indices[idx]; 48 if (index < 0 || index >= (int)RT_SVC_DECS_NUM) 49 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 } 58 #endif /* SMCCC_MAJOR_VERSION */ 59 60 /******************************************************************************* 61 * Simple routine to sanity check a runtime service descriptor before using it 62 ******************************************************************************/ 63 static int32_t validate_rt_svc_desc(const rt_svc_desc_t *desc) 64 { 65 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 74 #if SMCCC_MAJOR_VERSION == 1 75 if ((desc->call_type != SMC_TYPE_FAST) && 76 (desc->call_type != SMC_TYPE_YIELD)) 77 return -EINVAL; 78 #elif SMCCC_MAJOR_VERSION == 2 79 if (desc->is_vendor > 1U) 80 return -EINVAL; 81 #endif /* SMCCC_MAJOR_VERSION */ 82 83 /* A runtime service having no init or handle function doesn't make sense */ 84 if ((desc->init == NULL) && (desc->handle == NULL)) 85 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 ******************************************************************************/ 97 void runtime_svc_init(void) 98 { 99 int rc = 0; 100 unsigned int index, start_idx, end_idx; 101 102 /* Assert the number of descriptors detected are less than maximum indices */ 103 assert((RT_SVC_DESCS_END >= RT_SVC_DESCS_START) && 104 (RT_SVC_DECS_NUM < MAX_RT_SVCS)); 105 106 /* If no runtime services are implemented then simply bail out */ 107 if (RT_SVC_DECS_NUM == 0U) 108 return; 109 110 /* Initialise internal variables to invalid state */ 111 memset(rt_svc_descs_indices, -1, sizeof(rt_svc_descs_indices)); 112 113 rt_svc_descs = (rt_svc_desc_t *) RT_SVC_DESCS_START; 114 for (index = 0; index < RT_SVC_DECS_NUM; index++) { 115 rt_svc_desc_t *service = &rt_svc_descs[index]; 116 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 */ 122 rc = validate_rt_svc_desc(service); 123 if (rc) { 124 ERROR("Invalid runtime service descriptor %p\n", 125 (void *) service); 126 panic(); 127 } 128 129 /* 130 * The runtime service may have separate rt_svc_desc_t 131 * for its fast smc and yielding smc. Since the service itself 132 * 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 */ 136 if (service->init) { 137 rc = service->init(); 138 if (rc) { 139 ERROR("Error initializing runtime service %s\n", 140 service->name); 141 continue; 142 } 143 } 144 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 */ 151 #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); 163 assert(end_idx < MAX_RT_SVCS); 164 for (; start_idx <= end_idx; start_idx++) 165 rt_svc_descs_indices[start_idx] = index; 166 } 167 } 168