blob: 728507749b07011bc47c0e428b46f95524275ce4 [file] [log] [blame]
J-Alves2672cde2020-05-07 18:42:25 +01001/*
2 * Copyright (c) 2020, Arm Limited. All rights reserved.
3 *
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6
7#ifndef FFA_SVC_H
8#define FFA_SVC_H
9
10#include <lib/smccc.h>
11#include <lib/utils_def.h>
12#include <tools_share/uuid.h>
13
14/* FFA error codes. */
J-Alves4c95c702020-05-26 14:03:05 +010015#define FFA_ERROR_NOT_SUPPORTED -1
J-Alves2672cde2020-05-07 18:42:25 +010016#define FFA_ERROR_INVALID_PARAMETER -2
17#define FFA_ERROR_NO_MEMORY -3
18#define FFA_ERROR_BUSY -4
19#define FFA_ERROR_INTERRUPTED -5
20#define FFA_ERROR_DENIED -6
J-Alves4c95c702020-05-26 14:03:05 +010021#define FFA_ERROR_RETRY -7
J-Alves2672cde2020-05-07 18:42:25 +010022
23/* The macros below are used to identify FFA calls from the SMC function ID */
24#define FFA_FNUM_MIN_VALUE U(0x60)
25#define FFA_FNUM_MAX_VALUE U(0x7f)
26#define is_ffa_fid(fid) __extension__ ({ \
27 __typeof__(fid) _fid = (fid); \
28 ((GET_SMC_NUM(_fid) >= FFA_FNUM_MIN_VALUE) && \
29 (GET_SMC_NUM(_fid) <= FFA_FNUM_MAX_VALUE)); })
30
31/* FFA_VERSION helpers */
32#define FFA_VERSION_MAJOR U(1)
J-Alves4c95c702020-05-26 14:03:05 +010033#define FFA_VERSION_MAJOR_SHIFT 16
J-Alves2672cde2020-05-07 18:42:25 +010034#define FFA_VERSION_MAJOR_MASK U(0x7FFF)
35#define FFA_VERSION_MINOR U(0)
J-Alves4c95c702020-05-26 14:03:05 +010036#define FFA_VERSION_MINOR_SHIFT 0
J-Alves2672cde2020-05-07 18:42:25 +010037#define FFA_VERSION_MINOR_MASK U(0xFFFF)
J-Alves4c95c702020-05-26 14:03:05 +010038#define FFA_VERSION_BIT31_MASK U(0x1u << 31)
39
J-Alves2672cde2020-05-07 18:42:25 +010040
J-Alves4c95c702020-05-26 14:03:05 +010041#define MAKE_FFA_VERSION(major, minor) \
J-Alves2672cde2020-05-07 18:42:25 +010042 ((((major) & FFA_VERSION_MAJOR_MASK) << FFA_VERSION_MAJOR_SHIFT) | \
43 (((minor) & FFA_VERSION_MINOR_MASK) << FFA_VERSION_MINOR_SHIFT))
44#define FFA_VERSION_COMPILED MAKE_FFA_VERSION(FFA_VERSION_MAJOR, \
45 FFA_VERSION_MINOR)
46
47/* FFA_MSG_SEND helpers */
48#define FFA_MSG_SEND_ATTRS_BLK_SHIFT U(0)
49#define FFA_MSG_SEND_ATTRS_BLK_MASK U(0x1)
50#define FFA_MSG_SEND_ATTRS_BLK U(0)
51#define FFA_MSG_SEND_ATTRS_BLK_NOT U(1)
52#define FFA_MSG_SEND_ATTRS(blk) \
53 (((blk) & FFA_MSG_SEND_ATTRS_BLK_MASK) \
54 << FFA_MSG_SEND_ATTRS_BLK_SHIFT)
55
56/* Get FFA fastcall std FID from function number */
57#define FFA_FID(smc_cc, func_num) \
58 ((SMC_TYPE_FAST << FUNCID_TYPE_SHIFT) | \
59 ((smc_cc) << FUNCID_CC_SHIFT) | \
60 (OEN_STD_START << FUNCID_OEN_SHIFT) | \
61 ((func_num) << FUNCID_NUM_SHIFT))
62
63/* FFA function numbers */
64#define FFA_FNUM_ERROR U(0x60)
65#define FFA_FNUM_SUCCESS U(0x61)
66#define FFA_FNUM_INTERRUPT U(0x62)
67#define FFA_FNUM_VERSION U(0x63)
68#define FFA_FNUM_FEATURES U(0x64)
69#define FFA_FNUM_RX_RELEASE U(0x65)
70#define FFA_FNUM_RXTX_MAP U(0x66)
71#define FFA_FNUM_RXTX_UNMAP U(0x67)
72#define FFA_FNUM_PARTITION_INFO_GET U(0x68)
73#define FFA_FNUM_ID_GET U(0x69)
74#define FFA_FNUM_MSG_POLL U(0x6A)
75#define FFA_FNUM_MSG_WAIT U(0x6B)
76#define FFA_FNUM_MSG_YIELD U(0x6C)
77#define FFA_FNUM_MSG_RUN U(0x6D)
78#define FFA_FNUM_MSG_SEND U(0x6E)
79#define FFA_FNUM_MSG_SEND_DIRECT_REQ U(0x6F)
80#define FFA_FNUM_MSG_SEND_DIRECT_RESP U(0x70)
81#define FFA_FNUM_MEM_DONATE U(0x71)
82#define FFA_FNUM_MEM_LEND U(0x72)
83#define FFA_FNUM_MEM_SHARE U(0x73)
84#define FFA_FNUM_MEM_RETRIEVE_REQ U(0x74)
85#define FFA_FNUM_MEM_RETRIEVE_RESP U(0x75)
86#define FFA_FNUM_MEM_RELINQUISH U(0x76)
87#define FFA_FNUM_MEM_RECLAIM U(0x77)
88
89/* FFA SMC32 FIDs */
90#define FFA_ERROR FFA_FID(SMC_32, FFA_FNUM_ERROR)
91#define FFA_SUCCESS_SMC32 FFA_FID(SMC_32, FFA_FNUM_SUCCESS)
92#define FFA_INTERRUPT FFA_FID(SMC_32, FFA_FNUM_INTERRUPT)
93#define FFA_VERSION FFA_FID(SMC_32, FFA_FNUM_VERSION)
94#define FFA_FEATURES FFA_FID(SMC_32, FFA_FNUM_FEATURES)
95#define FFA_RX_RELEASE FFA_FID(SMC_32, FFA_FNUM_RX_RELEASE)
96#define FFA_RXTX_MAP_SMC32 FFA_FID(SMC_32, FFA_FNUM_RXTX_MAP)
97#define FFA_RXTX_UNMAP FFA_FID(SMC_32, FFA_FNUM_RXTX_UNMAP)
98#define FFA_PARTITION_INFO_GET FFA_FID(SMC_32, FFA_FNUM_PARTITION_INFO_GET)
99#define FFA_ID_GET FFA_FID(SMC_32, FFA_FNUM_ID_GET)
100#define FFA_MSG_POLL FFA_FID(SMC_32, FFA_FNUM_MSG_POLL)
101#define FFA_MSG_WAIT FFA_FID(SMC_32, FFA_FNUM_MSG_WAIT)
102#define FFA_MSG_YIELD FFA_FID(SMC_32, FFA_FNUM_MSG_YIELD)
103#define FFA_MSG_RUN FFA_FID(SMC_32, FFA_FNUM_MSG_RUN)
104#define FFA_MSG_SEND FFA_FID(SMC_32, FFA_FNUM_MSG_SEND)
105#define FFA_MSG_SEND_DIRECT_REQ_SMC32 \
106 FFA_FID(SMC_32, FFA_FNUM_MSG_SEND_DIRECT_REQ)
107#define FFA_MSG_SEND_DIRECT_RESP_SMC32 \
108 FFA_FID(SMC_32, FFA_FNUM_MSG_SEND_DIRECT_RESP)
109#define FFA_MEM_DONATE_SMC32 FFA_FID(SMC_32, FFA_FNUM_MEM_DONATE)
110#define FFA_MEM_LEND_SMC32 FFA_FID(SMC_32, FFA_FNUM_MEM_LEND)
111#define FFA_MEM_SHARE_SMC32 FFA_FID(SMC_32, FFA_FNUM_MEM_SHARE)
112#define FFA_MEM_RETRIEVE_REQ_SMC32 \
113 FFA_FID(SMC_32, FFA_FNUM_MEM_RETRIEVE_REQ)
114#define FFA_MEM_RETRIEVE_RESP FFA_FID(SMC_32, FFA_FNUM_MEM_RETRIEVE_RESP)
115#define FFA_MEM_RELINQUISH FFA_FID(SMC_32, FFA_FNUM_MEM_RELINQUISH)
116#define FFA_MEM_RECLAIM FFA_FID(SMC_32, FFA_FNUM_MEM_RECLAIM)
117
118/* FFA SMC64 FIDs */
119#define FFA_SUCCESS_SMC64 FFA_FID(SMC_64, FFA_FNUM_SUCCESS)
120#define FFA_RXTX_MAP_SMC64 FFA_FID(SMC_64, FFA_FNUM_RXTX_MAP)
121#define FFA_MSG_SEND_DIRECT_REQ_SMC64 \
122 FFA_FID(SMC_64, FFA_FNUM_MSG_SEND_DIRECT_REQ)
123#define FFA_MSG_SEND_DIRECT_RESP_SMC64 \
124 FFA_FID(SMC_64, FFA_FNUM_MSG_SEND_DIRECT_RESP)
125#define FFA_MEM_DONATE_SMC64 FFA_FID(SMC_64, FFA_FNUM_MEM_DONATE)
126#define FFA_MEM_LEND_SMC64 FFA_FID(SMC_64, FFA_FNUM_MEM_LEND)
127#define FFA_MEM_SHARE_SMC64 FFA_FID(SMC_64, FFA_FNUM_MEM_SHARE)
128#define FFA_MEM_RETRIEVE_REQ_SMC64 \
129 FFA_FID(SMC_64, FFA_FNUM_MEM_RETRIEVE_REQ)
130
131/*
132 * Reserve a special value for traffic targeted to the Hypervisor or SPM.
133 */
134#define FFA_TARGET_INFO_MBZ U(0x0)
135
136/*
137 * Reserve a special value for MBZ parameters.
138 */
139#define FFA_PARAM_MBZ U(0x0)
140
141#endif /* FFA_SVC_H */