blob: 0a2d9277ef695e2633ff146b45907fe14e5a9ca3 [file] [log] [blame]
Yatharth Kochar6c0566c2015-10-02 17:56:48 +01001/*
Dimitris Papastamos0dcdb1a2018-01-19 16:58:29 +00002 * Copyright (c) 2016-2018, ARM Limited and Contributors. All rights reserved.
Yatharth Kochar6c0566c2015-10-02 17:56:48 +01003 *
dp-armfa3cf0b2017-05-03 09:38:09 +01004 * SPDX-License-Identifier: BSD-3-Clause
Yatharth Kochar6c0566c2015-10-02 17:56:48 +01005 */
6
Soby Mathewd0194872016-04-29 19:01:30 +01007#ifndef __SMCC_H__
8#define __SMCC_H__
Yatharth Kochar6c0566c2015-10-02 17:56:48 +01009
Scott Brandenbf404c02017-04-10 11:45:52 -070010#include <utils_def.h>
David Cunado2e36de82017-01-19 10:26:16 +000011
Yatharth Kochar6c0566c2015-10-02 17:56:48 +010012/*******************************************************************************
13 * Bit definitions inside the function id as per the SMC calling convention
14 ******************************************************************************/
Varun Wadekarc6a11f62017-05-25 18:04:48 -070015#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 Kochar6c0566c2015-10-02 17:56:48 +010019
Varun Wadekarc6a11f62017-05-25 18:04:48 -070020#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 Kochar6c0566c2015-10-02 17:56:48 +010024
Varun Wadekarc6a11f62017-05-25 18:04:48 -070025#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 Kochar6c0566c2015-10-02 17:56:48 +010029
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 Wadekarc6a11f62017-05-25 18:04:48 -070035#define SMC_64 U(1)
36#define SMC_32 U(0)
37#define SMC_OK U(0)
Antonio Nino Diaze4794b72018-02-14 14:22:29 +000038#define SMC_UNK -1
David Cunado2e36de82017-01-19 10:26:16 +000039#define SMC_TYPE_FAST ULL(1)
David Cunado28f69ab2017-04-05 11:34:03 +010040#if !ERROR_DEPRECATED
Varun Wadekarc6a11f62017-05-25 18:04:48 -070041#define SMC_TYPE_STD ULL(0)
David Cunado28f69ab2017-04-05 11:34:03 +010042#endif
Varun Wadekarc6a11f62017-05-25 18:04:48 -070043#define SMC_TYPE_YIELD U(0)
Antonio Nino Diaze4794b72018-02-14 14:22:29 +000044#define SMC_PREEMPTED -2
Yatharth Kochar6c0566c2015-10-02 17:56:48 +010045/*******************************************************************************
46 * Owning entity number definitions inside the function id as per the SMC
47 * calling convention
48 ******************************************************************************/
Varun Wadekarc6a11f62017-05-25 18:04:48 -070049#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 Kochar6c0566c2015-10-02 17:56:48 +010064
65#ifndef __ASSEMBLY__
66
67#include <cassert.h>
Yatharth Kochar6c0566c2015-10-02 17:56:48 +010068#include <stdint.h>
69
Dimitris Papastamos0dcdb1a2018-01-19 16:58:29 +000070#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 Kochar6c0566c2015-10-02 17:56:48 +010075/* Various flags passed to SMC handlers */
Varun Wadekarc6a11f62017-05-25 18:04:48 -070076#define SMC_FROM_SECURE (U(0) << 0)
77#define SMC_FROM_NON_SECURE (U(1) << 0)
Yatharth Kochar6c0566c2015-10-02 17:56:48 +010078
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 Kochar6c0566c2015-10-02 17:56:48 +010082/* 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 Papastamos0dcdb1a2018-01-19 16:58:29 +000086/* 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 Kochar6c0566c2015-10-02 17:56:48 +010090/* The macro below is used to identify a valid Fast SMC call */
Varun Wadekarc6a11f62017-05-25 18:04:48 -070091#define is_valid_fast_smc(_fid) ((!(((_fid) >> 16) & U(0xff))) && \
Yatharth Kochar6c0566c2015-10-02 17:56:48 +010092 (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 Diaze4794b72018-02-14 14:22:29 +0000102 CASSERT((uint32_t)(_tl) != (uint32_t) SMC_UNK, invalid_svc_uuid);\
Yatharth Kochar6c0566c2015-10-02 17:56:48 +0100103 static const uuid_t _name = { \
104 _tl, _tm, _th, _cl, _ch, \
105 { _n0, _n1, _n2, _n3, _n4, _n5 } \
106 }
107
Yatharth Kochar6c0566c2015-10-02 17:56:48 +0100108#endif /*__ASSEMBLY__*/
Soby Mathewd0194872016-04-29 19:01:30 +0100109#endif /* __SMCC_H__ */