blob: e179e4bacb8850d7d5144a90d0cfaa8f999a22c5 [file] [log] [blame]
Achin Gupta4f6ad662013-10-25 09:08:21 +01001/*
Soby Mathewa0fedc42016-06-16 14:52:04 +01002 * Copyright (c) 2013-2016, 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
7#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 */
11#include <smcc_helpers.h> /* to include SMCC definitions */
Achin Gupta4f6ad662013-10-25 09:08:21 +010012
Achin Gupta4f6ad662013-10-25 09:08:21 +010013
Achin Gupta4a826dd2013-11-25 14:00:56 +000014/*******************************************************************************
Jeenu Viswambharancaa84932014-02-06 10:36:15 +000015 * Structure definition, typedefs & constants for the runtime service framework
Achin Gupta4a826dd2013-11-25 14:00:56 +000016 ******************************************************************************/
Achin Gupta4a826dd2013-11-25 14:00:56 +000017
Achin Gupta7421b462014-02-01 18:53:26 +000018/*
19 * Constants to allow the assembler access a runtime service
20 * descriptor
21 */
Soby Mathewa9482df2016-05-05 12:49:09 +010022#ifdef AARCH32
23#define RT_SVC_SIZE_LOG2 4
24#define RT_SVC_DESC_INIT 8
25#define RT_SVC_DESC_HANDLE 12
26#else
Achin Gupta07f4e072014-02-02 12:02:23 +000027#define RT_SVC_SIZE_LOG2 5
Achin Gupta7421b462014-02-01 18:53:26 +000028#define RT_SVC_DESC_INIT 16
29#define RT_SVC_DESC_HANDLE 24
Soby Mathewa9482df2016-05-05 12:49:09 +010030#endif /* AARCH32 */
31#define SIZEOF_RT_SVC_DESC (1 << RT_SVC_SIZE_LOG2)
32
Achin Gupta7421b462014-02-01 18:53:26 +000033
34/*
35 * The function identifier has 6 bits for the owning entity number and
36 * single bit for the type of smc call. When taken together these
37 * values limit the maximum number of runtime services to 128.
38 */
39#define MAX_RT_SVCS 128
40
Achin Gupta4f6ad662013-10-25 09:08:21 +010041#ifndef __ASSEMBLY__
42
Achin Gupta7421b462014-02-01 18:53:26 +000043/* Prototype for runtime service initializing function */
Dan Handleye2712bc2014-04-10 15:37:22 +010044typedef int32_t (*rt_svc_init_t)(void);
Achin Gupta7421b462014-02-01 18:53:26 +000045
Achin Gupta7421b462014-02-01 18:53:26 +000046/*
47 * Prototype for runtime service SMC handler function. x0 (SMC Function ID) to
48 * x4 are as passed by the caller. Rest of the arguments to SMC and the context
49 * can be accessed using the handle pointer. The cookie parameter is reserved
50 * for future use
51 */
Soby Mathewa0fedc42016-06-16 14:52:04 +010052typedef uintptr_t (*rt_svc_handle_t)(uint32_t smc_fid,
53 u_register_t x1,
54 u_register_t x2,
55 u_register_t x3,
56 u_register_t x4,
Achin Gupta7421b462014-02-01 18:53:26 +000057 void *cookie,
58 void *handle,
Soby Mathewa0fedc42016-06-16 14:52:04 +010059 u_register_t flags);
Dan Handleye2712bc2014-04-10 15:37:22 +010060typedef struct rt_svc_desc {
Achin Gupta7421b462014-02-01 18:53:26 +000061 uint8_t start_oen;
62 uint8_t end_oen;
63 uint8_t call_type;
64 const char *name;
Dan Handleye2712bc2014-04-10 15:37:22 +010065 rt_svc_init_t init;
66 rt_svc_handle_t handle;
67} rt_svc_desc_t;
Achin Gupta7421b462014-02-01 18:53:26 +000068
69/*
70 * Convenience macro to declare a service descriptor
71 */
72#define DECLARE_RT_SVC(_name, _start, _end, _type, _setup, _smch) \
Dan Handleye2712bc2014-04-10 15:37:22 +010073 static const rt_svc_desc_t __svc_desc_ ## _name \
Soren Brinkmann46dd1702016-01-14 10:11:05 -080074 __section("rt_svc_descs") __used = { \
Soby Mathew7162afa2016-01-12 10:28:42 +000075 .start_oen = _start, \
76 .end_oen = _end, \
77 .call_type = _type, \
78 .name = #_name, \
79 .init = _setup, \
80 .handle = _smch }
Achin Gupta4f6ad662013-10-25 09:08:21 +010081
Achin Gupta7421b462014-02-01 18:53:26 +000082/*
83 * Compile time assertions related to the 'rt_svc_desc' structure to:
84 * 1. ensure that the assembler and the compiler view of the size
85 * of the structure are the same.
86 * 2. ensure that the assembler and the compiler see the initialisation
87 * routine at the same offset.
Achin Gupta07f4e072014-02-02 12:02:23 +000088 * 3. ensure that the assembler and the compiler see the handler
Achin Gupta7421b462014-02-01 18:53:26 +000089 * routine at the same offset.
90 */
Dan Handleye2712bc2014-04-10 15:37:22 +010091CASSERT((sizeof(rt_svc_desc_t) == SIZEOF_RT_SVC_DESC), \
Achin Gupta7421b462014-02-01 18:53:26 +000092 assert_sizeof_rt_svc_desc_mismatch);
Dan Handleye2712bc2014-04-10 15:37:22 +010093CASSERT(RT_SVC_DESC_INIT == __builtin_offsetof(rt_svc_desc_t, init), \
Achin Gupta7421b462014-02-01 18:53:26 +000094 assert_rt_svc_desc_init_offset_mismatch);
Dan Handleye2712bc2014-04-10 15:37:22 +010095CASSERT(RT_SVC_DESC_HANDLE == __builtin_offsetof(rt_svc_desc_t, handle), \
Achin Gupta7421b462014-02-01 18:53:26 +000096 assert_rt_svc_desc_handle_offset_mismatch);
97
98
99/*
100 * This macro combines the call type and the owning entity number corresponding
101 * to a runtime service to generate a unique owning entity number. This unique
102 * oen is used to access an entry in the 'rt_svc_descs_indices' array. The entry
103 * contains the index of the service descriptor in the 'rt_svc_descs' array.
104 */
105#define get_unique_oen(oen, call_type) ((oen & FUNCID_OEN_MASK) | \
106 ((call_type & FUNCID_TYPE_MASK) \
107 << FUNCID_OEN_WIDTH))
Achin Gupta4f6ad662013-10-25 09:08:21 +0100108
Soby Mathewa9482df2016-05-05 12:49:09 +0100109/*
110 * This macro generates the unique owning entity number from the SMC Function
111 * ID. This unique oen is used to access an entry in the
112 * 'rt_svc_descs_indices' array to invoke the corresponding runtime service
113 * handler during SMC handling.
114 */
115#define get_unique_oen_from_smc_fid(fid) \
116 get_unique_oen(((fid) >> FUNCID_OEN_SHIFT), \
117 ((fid) >> FUNCID_TYPE_SHIFT))
118
Achin Gupta4f6ad662013-10-25 09:08:21 +0100119/*******************************************************************************
120 * Function & variable prototypes
121 ******************************************************************************/
Juan Castillo2d552402014-06-13 17:05:10 +0100122void runtime_svc_init(void);
Soby Mathewa9482df2016-05-05 12:49:09 +0100123uintptr_t handle_runtime_svc(uint32_t smc_fid, void *cookie, void *handle,
124 unsigned int flags);
Soby Mathewa0fedc42016-06-16 14:52:04 +0100125extern uintptr_t __RT_SVC_DESCS_START__;
126extern uintptr_t __RT_SVC_DESCS_END__;
Andrew Thoelke8c28fe02014-06-02 11:40:35 +0100127void init_crash_reporting(void);
Andrew Thoelke8c28fe02014-06-02 11:40:35 +0100128
Achin Gupta4f6ad662013-10-25 09:08:21 +0100129#endif /*__ASSEMBLY__*/
Achin Gupta4f6ad662013-10-25 09:08:21 +0100130#endif /* __RUNTIME_SVC_H__ */