mirror of
https://github.com/ARM-software/arm-trusted-firmware.git
synced 2025-04-27 15:24:54 +00:00
1ae0a49a37
This patch adds an API in runtime service framework to invoke the registered handler corresponding to the SMC function identifier. This is helpful for AArch32 because the number of arguments required by the handler is more than registers available as per AArch32 program calling conventions and requires the use of stack. Hence this new API will do the necessary argument setup and invoke the appropriate handler. Although this API is primarily intended for AArch32, it can be used for AArch64 as well. Change-Id: Iefa15947fe5a1df55b0859886e677446a0fd7241
154 lines
5.6 KiB
C
154 lines
5.6 KiB
C
/*
|
|
* Copyright (c) 2013-2016, ARM Limited and Contributors. All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
*
|
|
* Redistributions of source code must retain the above copyright notice, this
|
|
* list of conditions and the following disclaimer.
|
|
*
|
|
* Redistributions in binary form must reproduce the above copyright notice,
|
|
* this list of conditions and the following disclaimer in the documentation
|
|
* and/or other materials provided with the distribution.
|
|
*
|
|
* Neither the name of ARM nor the names of its contributors may be used
|
|
* to endorse or promote products derived from this software without specific
|
|
* prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
|
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#ifndef __RUNTIME_SVC_H__
|
|
#define __RUNTIME_SVC_H__
|
|
|
|
#include <bl_common.h> /* to include exception types */
|
|
#include <smcc_helpers.h> /* to include SMCC definitions */
|
|
|
|
|
|
/*******************************************************************************
|
|
* Structure definition, typedefs & constants for the runtime service framework
|
|
******************************************************************************/
|
|
|
|
/*
|
|
* Constants to allow the assembler access a runtime service
|
|
* descriptor
|
|
*/
|
|
#ifdef AARCH32
|
|
#define RT_SVC_SIZE_LOG2 4
|
|
#define RT_SVC_DESC_INIT 8
|
|
#define RT_SVC_DESC_HANDLE 12
|
|
#else
|
|
#define RT_SVC_SIZE_LOG2 5
|
|
#define RT_SVC_DESC_INIT 16
|
|
#define RT_SVC_DESC_HANDLE 24
|
|
#endif /* AARCH32 */
|
|
#define SIZEOF_RT_SVC_DESC (1 << RT_SVC_SIZE_LOG2)
|
|
|
|
|
|
/*
|
|
* The function identifier has 6 bits for the owning entity number and
|
|
* single bit for the type of smc call. When taken together these
|
|
* values limit the maximum number of runtime services to 128.
|
|
*/
|
|
#define MAX_RT_SVCS 128
|
|
|
|
#ifndef __ASSEMBLY__
|
|
|
|
/* Prototype for runtime service initializing function */
|
|
typedef int32_t (*rt_svc_init_t)(void);
|
|
|
|
/*
|
|
* Prototype for runtime service SMC handler function. x0 (SMC Function ID) to
|
|
* x4 are as passed by the caller. Rest of the arguments to SMC and the context
|
|
* can be accessed using the handle pointer. The cookie parameter is reserved
|
|
* for future use
|
|
*/
|
|
typedef uintptr_t (*rt_svc_handle_t)(uint32_t smc_fid,
|
|
u_register_t x1,
|
|
u_register_t x2,
|
|
u_register_t x3,
|
|
u_register_t x4,
|
|
void *cookie,
|
|
void *handle,
|
|
u_register_t flags);
|
|
typedef struct rt_svc_desc {
|
|
uint8_t start_oen;
|
|
uint8_t end_oen;
|
|
uint8_t call_type;
|
|
const char *name;
|
|
rt_svc_init_t init;
|
|
rt_svc_handle_t handle;
|
|
} rt_svc_desc_t;
|
|
|
|
/*
|
|
* Convenience macro to declare a service descriptor
|
|
*/
|
|
#define DECLARE_RT_SVC(_name, _start, _end, _type, _setup, _smch) \
|
|
static const rt_svc_desc_t __svc_desc_ ## _name \
|
|
__section("rt_svc_descs") __used = { \
|
|
.start_oen = _start, \
|
|
.end_oen = _end, \
|
|
.call_type = _type, \
|
|
.name = #_name, \
|
|
.init = _setup, \
|
|
.handle = _smch }
|
|
|
|
/*
|
|
* Compile time assertions related to the 'rt_svc_desc' structure to:
|
|
* 1. ensure that the assembler and the compiler view of the size
|
|
* of the structure are the same.
|
|
* 2. ensure that the assembler and the compiler see the initialisation
|
|
* routine at the same offset.
|
|
* 3. ensure that the assembler and the compiler see the handler
|
|
* routine at the same offset.
|
|
*/
|
|
CASSERT((sizeof(rt_svc_desc_t) == SIZEOF_RT_SVC_DESC), \
|
|
assert_sizeof_rt_svc_desc_mismatch);
|
|
CASSERT(RT_SVC_DESC_INIT == __builtin_offsetof(rt_svc_desc_t, init), \
|
|
assert_rt_svc_desc_init_offset_mismatch);
|
|
CASSERT(RT_SVC_DESC_HANDLE == __builtin_offsetof(rt_svc_desc_t, handle), \
|
|
assert_rt_svc_desc_handle_offset_mismatch);
|
|
|
|
|
|
/*
|
|
* This macro combines the call type and the owning entity number corresponding
|
|
* to a runtime service to generate a unique owning entity number. This unique
|
|
* oen is used to access an entry in the 'rt_svc_descs_indices' array. The entry
|
|
* contains the index of the service descriptor in the 'rt_svc_descs' array.
|
|
*/
|
|
#define get_unique_oen(oen, call_type) ((oen & FUNCID_OEN_MASK) | \
|
|
((call_type & FUNCID_TYPE_MASK) \
|
|
<< FUNCID_OEN_WIDTH))
|
|
|
|
/*
|
|
* This macro generates the unique owning entity number from the SMC Function
|
|
* ID. This unique oen is used to access an entry in the
|
|
* 'rt_svc_descs_indices' array to invoke the corresponding runtime service
|
|
* handler during SMC handling.
|
|
*/
|
|
#define get_unique_oen_from_smc_fid(fid) \
|
|
get_unique_oen(((fid) >> FUNCID_OEN_SHIFT), \
|
|
((fid) >> FUNCID_TYPE_SHIFT))
|
|
|
|
/*******************************************************************************
|
|
* Function & variable prototypes
|
|
******************************************************************************/
|
|
void runtime_svc_init(void);
|
|
uintptr_t handle_runtime_svc(uint32_t smc_fid, void *cookie, void *handle,
|
|
unsigned int flags);
|
|
extern uintptr_t __RT_SVC_DESCS_START__;
|
|
extern uintptr_t __RT_SVC_DESCS_END__;
|
|
void init_crash_reporting(void);
|
|
|
|
#endif /*__ASSEMBLY__*/
|
|
#endif /* __RUNTIME_SVC_H__ */
|