xref: /rk3399_ARM-atf/include/lib/smccc.h (revision ff2743e544f0f82381ebb9dff8f14eacb837d2e0)
1 /*
2  * Copyright (c) 2016-2018, ARM Limited and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #ifndef __SMCCC_H__
8 #define __SMCCC_H__
9 
10 #include <utils_def.h>
11 
12 #define SMCCC_VERSION_MAJOR_SHIFT	U(16)
13 #define SMCCC_VERSION_MAJOR_MASK	U(0x7FFF)
14 #define SMCCC_VERSION_MINOR_SHIFT	U(0)
15 #define SMCCC_VERSION_MINOR_MASK	U(0xFFFF)
16 #define MAKE_SMCCC_VERSION(_major, _minor) \
17 	((((uint32_t)(_major) & SMCCC_VERSION_MAJOR_MASK) << \
18 						SMCCC_VERSION_MAJOR_SHIFT) \
19 	| (((uint32_t)(_minor) & SMCCC_VERSION_MINOR_MASK) << \
20 						SMCCC_VERSION_MINOR_SHIFT))
21 
22 #if SMCCC_MAJOR_VERSION == 1
23 # define SMCCC_MINOR_VERSION U(1)
24 # include <smccc_v1.h>
25 #elif SMCCC_MAJOR_VERSION == 2
26 # define SMCCC_MINOR_VERSION U(0)
27 # include <smccc_v2.h>
28 #else
29 # error "Unsupported version of SMCCC."
30 #endif
31 
32 /* Various flags passed to SMC handlers */
33 #define SMC_FROM_SECURE		(U(0) << 0)
34 #define SMC_FROM_NON_SECURE	(U(1) << 0)
35 
36 #ifndef __ASSEMBLY__
37 
38 #include <cassert.h>
39 #include <stdint.h>
40 
41 #define is_caller_non_secure(_f)	(((_f) & SMC_FROM_NON_SECURE) != U(0))
42 #define is_caller_secure(_f)		(!is_caller_non_secure(_f))
43 
44 /* The macro below is used to identify a Standard Service SMC call */
45 #define is_std_svc_call(_fid)		(GET_SMC_OEN(_fid) == OEN_STD_START)
46 
47 /* The macro below is used to identify a Arm Architectural Service SMC call */
48 #define is_arm_arch_svc_call(_fid)	(GET_SMC_OEN(_fid) == OEN_ARM_START)
49 
50 /* The macro below is used to identify a valid Fast SMC call */
51 #define is_valid_fast_smc(_fid)		((!(((_fid) >> 16) & U(0xff))) && \
52 					   (GET_SMC_TYPE(_fid) == SMC_TYPE_FAST))
53 
54 /*
55  * Macro to define UUID for services. Apart from defining and initializing a
56  * uuid_t structure, this macro verifies that the first word of the defined UUID
57  * does not equal SMC_UNK. This is to ensure that the caller won't mistake the
58  * returned UUID in x0 for an invalid SMC error return
59  */
60 #define DEFINE_SVC_UUID(_name, _tl, _tm, _th, _cl, _ch, \
61 		_n0, _n1, _n2, _n3, _n4, _n5) \
62 	CASSERT((uint32_t)(_tl) != (uint32_t) SMC_UNK, invalid_svc_uuid);\
63 	static const uuid_t _name = { \
64 		_tl, _tm, _th, _cl, _ch, \
65 		{ _n0, _n1, _n2, _n3, _n4, _n5 } \
66 	}
67 
68 #endif /*__ASSEMBLY__*/
69 #endif /* __SMCCC_H__ */
70