1 /* 2 * Copyright (c) 2013-2014, ARM Limited and Contributors. All rights reserved. 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 #include <stdio.h> 32 #include <string.h> 33 #include <errno.h> 34 #include <assert.h> 35 #include <arch_helpers.h> 36 #include <console.h> 37 #include <platform.h> 38 #include <semihosting.h> 39 #include <bl_common.h> 40 #include <psci.h> 41 #include <runtime_svc.h> 42 #include <debug.h> 43 44 /******************************************************************************* 45 * The 'rt_svc_descs' array holds the runtime service descriptors exported by 46 * services by placing them in the 'rt_svc_descs' linker section. 47 * The 'rt_svc_descs_indices' array holds the index of a descriptor in the 48 * 'rt_svc_descs' array. When an SMC arrives, the OEN[29:24] bits and the call 49 * type[31] bit in the function id are combined to get an index into the 50 * 'rt_svc_descs_indices' array. This gives the index of the descriptor in the 51 * 'rt_svc_descs' array which contains the SMC handler. 52 ******************************************************************************/ 53 #define RT_SVC_DESCS_START ((uint64_t) (&__RT_SVC_DESCS_START__)) 54 #define RT_SVC_DESCS_END ((uint64_t) (&__RT_SVC_DESCS_END__)) 55 uint8_t rt_svc_descs_indices[MAX_RT_SVCS]; 56 static rt_svc_desc *rt_svc_descs; 57 58 /******************************************************************************* 59 * Simple routine to sanity check a runtime service descriptor before using it 60 ******************************************************************************/ 61 static int32_t validate_rt_svc_desc(rt_svc_desc *desc) 62 { 63 if (desc == NULL) 64 return -EINVAL; 65 66 if (desc->start_oen > desc->end_oen) 67 return -EINVAL; 68 69 if (desc->end_oen >= OEN_LIMIT) 70 return -EINVAL; 71 72 if (desc->call_type != SMC_TYPE_FAST && desc->call_type != SMC_TYPE_STD) 73 return -EINVAL; 74 75 /* A runtime service having no init or handle function doesn't make sense */ 76 if (desc->init == NULL && desc->handle == NULL) 77 return -EINVAL; 78 79 return 0; 80 } 81 82 /******************************************************************************* 83 * This function calls the initialisation routine in the descriptor exported by 84 * a runtime service. Once a descriptor has been validated, its start & end 85 * owning entity numbers and the call type are combined to form a unique oen. 86 * The unique oen is used as an index into the 'rt_svc_descs_indices' array. 87 * The index of the runtime service descriptor is stored at this index. 88 ******************************************************************************/ 89 void runtime_svc_init() 90 { 91 int32_t rc = 0; 92 uint32_t index, start_idx, end_idx; 93 uint64_t rt_svc_descs_num; 94 95 /* If no runtime services are implemented then simply bail out */ 96 rt_svc_descs_num = RT_SVC_DESCS_END - RT_SVC_DESCS_START; 97 rt_svc_descs_num /= sizeof(rt_svc_desc); 98 if (rt_svc_descs_num == 0) 99 return; 100 101 /* Initialise internal variables to invalid state */ 102 memset(rt_svc_descs_indices, -1, sizeof(rt_svc_descs_indices)); 103 104 rt_svc_descs = (rt_svc_desc *) RT_SVC_DESCS_START; 105 for (index = 0; index < rt_svc_descs_num; index++) { 106 107 /* 108 * An invalid descriptor is an error condition since it is 109 * difficult to predict the system behaviour in the absence 110 * of this service. 111 */ 112 rc = validate_rt_svc_desc(&rt_svc_descs[index]); 113 if (rc) { 114 ERROR("Invalid runtime service descriptor 0x%x (%s)\n", 115 &rt_svc_descs[index], 116 rt_svc_descs[index].name); 117 goto error; 118 } 119 120 /* 121 * Fill the indices corresponding to the start and end owning 122 * entity numbers with the index of the descriptor which will 123 * handle the SMCs for this owning entity range. 124 */ 125 start_idx = get_unique_oen(rt_svc_descs[index].start_oen, 126 rt_svc_descs[index].call_type); 127 end_idx = get_unique_oen(rt_svc_descs[index].end_oen, 128 rt_svc_descs[index].call_type); 129 for (; start_idx <= end_idx; start_idx++) 130 rt_svc_descs_indices[start_idx] = index; 131 132 /* Call the initialisation routine for this runtime service */ 133 rc = rt_svc_descs[index].init(); 134 if (rc) { 135 ERROR("Error initializing runtime service %s\n", 136 rt_svc_descs[index].name); 137 goto error; 138 } 139 } 140 141 return; 142 error: 143 panic(); 144 } 145