1 /* 2 * Copyright (c) 2016-2017, ARM Limited and Contributors. All rights reserved. 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 */ 6 7 #ifndef __SMCC_H__ 8 #define __SMCC_H__ 9 10 #include <utils_def.h> 11 12 /******************************************************************************* 13 * Bit definitions inside the function id as per the SMC calling convention 14 ******************************************************************************/ 15 #define FUNCID_TYPE_SHIFT U(31) 16 #define FUNCID_CC_SHIFT U(30) 17 #define FUNCID_OEN_SHIFT U(24) 18 #define FUNCID_NUM_SHIFT U(0) 19 20 #define FUNCID_TYPE_MASK U(0x1) 21 #define FUNCID_CC_MASK U(0x1) 22 #define FUNCID_OEN_MASK U(0x3f) 23 #define FUNCID_NUM_MASK U(0xffff) 24 25 #define FUNCID_TYPE_WIDTH U(1) 26 #define FUNCID_CC_WIDTH U(1) 27 #define FUNCID_OEN_WIDTH U(6) 28 #define FUNCID_NUM_WIDTH U(16) 29 30 #define GET_SMC_CC(id) ((id >> FUNCID_CC_SHIFT) & \ 31 FUNCID_CC_MASK) 32 #define GET_SMC_TYPE(id) ((id >> FUNCID_TYPE_SHIFT) & \ 33 FUNCID_TYPE_MASK) 34 35 #define SMC_64 U(1) 36 #define SMC_32 U(0) 37 #define SMC_OK U(0) 38 #define SMC_UNK U(0xffffffff) 39 #define SMC_TYPE_FAST ULL(1) 40 #if !ERROR_DEPRECATED 41 #define SMC_TYPE_STD ULL(0) 42 #endif 43 #define SMC_TYPE_YIELD U(0) 44 #define SMC_PREEMPTED U(0xfffffffe) 45 /******************************************************************************* 46 * Owning entity number definitions inside the function id as per the SMC 47 * calling convention 48 ******************************************************************************/ 49 #define OEN_ARM_START U(0) 50 #define OEN_ARM_END U(0) 51 #define OEN_CPU_START U(1) 52 #define OEN_CPU_END U(1) 53 #define OEN_SIP_START U(2) 54 #define OEN_SIP_END U(2) 55 #define OEN_OEM_START U(3) 56 #define OEN_OEM_END U(3) 57 #define OEN_STD_START U(4) /* Standard Service Calls */ 58 #define OEN_STD_END U(4) 59 #define OEN_TAP_START U(48) /* Trusted Applications */ 60 #define OEN_TAP_END U(49) 61 #define OEN_TOS_START U(50) /* Trusted OS */ 62 #define OEN_TOS_END U(63) 63 #define OEN_LIMIT U(64) 64 65 #ifndef __ASSEMBLY__ 66 67 #include <cassert.h> 68 #include <stdint.h> 69 70 /* Various flags passed to SMC handlers */ 71 #define SMC_FROM_SECURE (U(0) << 0) 72 #define SMC_FROM_NON_SECURE (U(1) << 0) 73 74 #define is_caller_non_secure(_f) (!!(_f & SMC_FROM_NON_SECURE)) 75 #define is_caller_secure(_f) (!(is_caller_non_secure(_f))) 76 77 /* The macro below is used to identify a Standard Service SMC call */ 78 #define is_std_svc_call(_fid) ((((_fid) >> FUNCID_OEN_SHIFT) & \ 79 FUNCID_OEN_MASK) == OEN_STD_START) 80 81 /* The macro below is used to identify a valid Fast SMC call */ 82 #define is_valid_fast_smc(_fid) ((!(((_fid) >> 16) & U(0xff))) && \ 83 (GET_SMC_TYPE(_fid) == SMC_TYPE_FAST)) 84 85 /* 86 * Macro to define UUID for services. Apart from defining and initializing a 87 * uuid_t structure, this macro verifies that the first word of the defined UUID 88 * does not equal SMC_UNK. This is to ensure that the caller won't mistake the 89 * returned UUID in x0 for an invalid SMC error return 90 */ 91 #define DEFINE_SVC_UUID(_name, _tl, _tm, _th, _cl, _ch, \ 92 _n0, _n1, _n2, _n3, _n4, _n5) \ 93 CASSERT(_tl != SMC_UNK, invalid_svc_uuid);\ 94 static const uuid_t _name = { \ 95 _tl, _tm, _th, _cl, _ch, \ 96 { _n0, _n1, _n2, _n3, _n4, _n5 } \ 97 } 98 99 #endif /*__ASSEMBLY__*/ 100 #endif /* __SMCC_H__ */ 101