Yatharth Kochar | bbf8f6f | 2015-10-02 17:56:48 +0100 | [diff] [blame] | 1 | /* |
Dimitris Papastamos | 3a1b067 | 2018-01-19 16:58:29 +0000 | [diff] [blame] | 2 | * Copyright (c) 2016-2018, ARM Limited and Contributors. All rights reserved. |
Yatharth Kochar | bbf8f6f | 2015-10-02 17:56:48 +0100 | [diff] [blame] | 3 | * |
dp-arm | 82cb2c1 | 2017-05-03 09:38:09 +0100 | [diff] [blame] | 4 | * SPDX-License-Identifier: BSD-3-Clause |
Yatharth Kochar | bbf8f6f | 2015-10-02 17:56:48 +0100 | [diff] [blame] | 5 | */ |
| 6 | |
Soby Mathew | cf0b149 | 2016-04-29 19:01:30 +0100 | [diff] [blame] | 7 | #ifndef __SMCC_H__ |
| 8 | #define __SMCC_H__ |
Yatharth Kochar | bbf8f6f | 2015-10-02 17:56:48 +0100 | [diff] [blame] | 9 | |
Scott Branden | 53d9c9c | 2017-04-10 11:45:52 -0700 | [diff] [blame] | 10 | #include <utils_def.h> |
David Cunado | 9edac04 | 2017-01-19 10:26:16 +0000 | [diff] [blame] | 11 | |
Yatharth Kochar | bbf8f6f | 2015-10-02 17:56:48 +0100 | [diff] [blame] | 12 | /******************************************************************************* |
| 13 | * Bit definitions inside the function id as per the SMC calling convention |
| 14 | ******************************************************************************/ |
Varun Wadekar | 030567e | 2017-05-25 18:04:48 -0700 | [diff] [blame] | 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) |
Yatharth Kochar | bbf8f6f | 2015-10-02 17:56:48 +0100 | [diff] [blame] | 19 | |
Varun Wadekar | 030567e | 2017-05-25 18:04:48 -0700 | [diff] [blame] | 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) |
Yatharth Kochar | bbf8f6f | 2015-10-02 17:56:48 +0100 | [diff] [blame] | 24 | |
Varun Wadekar | 030567e | 2017-05-25 18:04:48 -0700 | [diff] [blame] | 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) |
Yatharth Kochar | bbf8f6f | 2015-10-02 17:56:48 +0100 | [diff] [blame] | 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 | |
Varun Wadekar | 030567e | 2017-05-25 18:04:48 -0700 | [diff] [blame] | 35 | #define SMC_64 U(1) |
| 36 | #define SMC_32 U(0) |
| 37 | #define SMC_OK U(0) |
Antonio Nino Diaz | 4abd7fa | 2018-02-14 14:22:29 +0000 | [diff] [blame^] | 38 | #define SMC_UNK -1 |
David Cunado | 9edac04 | 2017-01-19 10:26:16 +0000 | [diff] [blame] | 39 | #define SMC_TYPE_FAST ULL(1) |
David Cunado | 16292f5 | 2017-04-05 11:34:03 +0100 | [diff] [blame] | 40 | #if !ERROR_DEPRECATED |
Varun Wadekar | 030567e | 2017-05-25 18:04:48 -0700 | [diff] [blame] | 41 | #define SMC_TYPE_STD ULL(0) |
David Cunado | 16292f5 | 2017-04-05 11:34:03 +0100 | [diff] [blame] | 42 | #endif |
Varun Wadekar | 030567e | 2017-05-25 18:04:48 -0700 | [diff] [blame] | 43 | #define SMC_TYPE_YIELD U(0) |
Antonio Nino Diaz | 4abd7fa | 2018-02-14 14:22:29 +0000 | [diff] [blame^] | 44 | #define SMC_PREEMPTED -2 |
Yatharth Kochar | bbf8f6f | 2015-10-02 17:56:48 +0100 | [diff] [blame] | 45 | /******************************************************************************* |
| 46 | * Owning entity number definitions inside the function id as per the SMC |
| 47 | * calling convention |
| 48 | ******************************************************************************/ |
Varun Wadekar | 030567e | 2017-05-25 18:04:48 -0700 | [diff] [blame] | 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) |
Yatharth Kochar | bbf8f6f | 2015-10-02 17:56:48 +0100 | [diff] [blame] | 64 | |
| 65 | #ifndef __ASSEMBLY__ |
| 66 | |
| 67 | #include <cassert.h> |
Yatharth Kochar | bbf8f6f | 2015-10-02 17:56:48 +0100 | [diff] [blame] | 68 | #include <stdint.h> |
| 69 | |
Dimitris Papastamos | 3a1b067 | 2018-01-19 16:58:29 +0000 | [diff] [blame] | 70 | #define SMCCC_MAJOR_VERSION U(1) |
| 71 | #define SMCCC_MINOR_VERSION U(1) |
| 72 | |
| 73 | #define MAKE_SMCCC_VERSION(_major, _minor) (((_major) << 16) | (_minor)) |
| 74 | |
Yatharth Kochar | bbf8f6f | 2015-10-02 17:56:48 +0100 | [diff] [blame] | 75 | /* Various flags passed to SMC handlers */ |
Varun Wadekar | 030567e | 2017-05-25 18:04:48 -0700 | [diff] [blame] | 76 | #define SMC_FROM_SECURE (U(0) << 0) |
| 77 | #define SMC_FROM_NON_SECURE (U(1) << 0) |
Yatharth Kochar | bbf8f6f | 2015-10-02 17:56:48 +0100 | [diff] [blame] | 78 | |
| 79 | #define is_caller_non_secure(_f) (!!(_f & SMC_FROM_NON_SECURE)) |
| 80 | #define is_caller_secure(_f) (!(is_caller_non_secure(_f))) |
| 81 | |
Yatharth Kochar | bbf8f6f | 2015-10-02 17:56:48 +0100 | [diff] [blame] | 82 | /* The macro below is used to identify a Standard Service SMC call */ |
| 83 | #define is_std_svc_call(_fid) ((((_fid) >> FUNCID_OEN_SHIFT) & \ |
| 84 | FUNCID_OEN_MASK) == OEN_STD_START) |
| 85 | |
Dimitris Papastamos | 3a1b067 | 2018-01-19 16:58:29 +0000 | [diff] [blame] | 86 | /* The macro below is used to identify a Arm Architectural Service SMC call */ |
| 87 | #define is_arm_arch_svc_call(_fid) ((((_fid) >> FUNCID_OEN_SHIFT) & \ |
| 88 | FUNCID_OEN_MASK) == OEN_ARM_START) |
| 89 | |
Yatharth Kochar | bbf8f6f | 2015-10-02 17:56:48 +0100 | [diff] [blame] | 90 | /* The macro below is used to identify a valid Fast SMC call */ |
Varun Wadekar | 030567e | 2017-05-25 18:04:48 -0700 | [diff] [blame] | 91 | #define is_valid_fast_smc(_fid) ((!(((_fid) >> 16) & U(0xff))) && \ |
Yatharth Kochar | bbf8f6f | 2015-10-02 17:56:48 +0100 | [diff] [blame] | 92 | (GET_SMC_TYPE(_fid) == SMC_TYPE_FAST)) |
| 93 | |
| 94 | /* |
| 95 | * Macro to define UUID for services. Apart from defining and initializing a |
| 96 | * uuid_t structure, this macro verifies that the first word of the defined UUID |
| 97 | * does not equal SMC_UNK. This is to ensure that the caller won't mistake the |
| 98 | * returned UUID in x0 for an invalid SMC error return |
| 99 | */ |
| 100 | #define DEFINE_SVC_UUID(_name, _tl, _tm, _th, _cl, _ch, \ |
| 101 | _n0, _n1, _n2, _n3, _n4, _n5) \ |
Antonio Nino Diaz | 4abd7fa | 2018-02-14 14:22:29 +0000 | [diff] [blame^] | 102 | CASSERT((uint32_t)(_tl) != (uint32_t) SMC_UNK, invalid_svc_uuid);\ |
Yatharth Kochar | bbf8f6f | 2015-10-02 17:56:48 +0100 | [diff] [blame] | 103 | static const uuid_t _name = { \ |
| 104 | _tl, _tm, _th, _cl, _ch, \ |
| 105 | { _n0, _n1, _n2, _n3, _n4, _n5 } \ |
| 106 | } |
| 107 | |
Yatharth Kochar | bbf8f6f | 2015-10-02 17:56:48 +0100 | [diff] [blame] | 108 | #endif /*__ASSEMBLY__*/ |
Soby Mathew | cf0b149 | 2016-04-29 19:01:30 +0100 | [diff] [blame] | 109 | #endif /* __SMCC_H__ */ |