1 /*
2 * Copyright (c) 2018-2021, Arm Limited and Contributors. All rights reserved.
3 * Copyright (c) 2022-2023, Advanced Micro Devices, Inc. All rights reserved.
4 *
5 * SPDX-License-Identifier: BSD-3-Clause
6 */
7
8 /* Top level SMC handler for SiP calls. Dispatch PM calls to PM SMC handler. */
9
10 #include <inttypes.h>
11
12 #include <common/debug.h>
13 #include <common/runtime_svc.h>
14 #include <tools_share/uuid.h>
15
16 #include "ipi_mailbox_svc.h"
17 #include "pm_svc_main.h"
18
19 /* SMC function IDs for SiP Service queries */
20 #define VERSAL_SIP_SVC_CALL_COUNT U(0x8200ff00)
21 #define VERSAL_SIP_SVC_UID U(0x8200ff01)
22 #define VERSAL_SIP_SVC_VERSION U(0x8200ff03)
23
24 /* SiP Service Calls version numbers */
25 #define SIP_SVC_VERSION_MAJOR U(0)
26 #define SIP_SVC_VERSION_MINOR U(1)
27
28 /* These macros are used to identify PM calls from the SMC function ID */
29 #define SIP_FID_MASK GENMASK(23, 16)
30 #define XLNX_FID_MASK GENMASK(23, 12)
31 #define PM_FID_VALUE 0u
32 #define IPI_FID_VALUE 0x1000u
33 #define is_pm_fid(_fid) (((_fid) & XLNX_FID_MASK) == PM_FID_VALUE)
34 #define is_ipi_fid(_fid) (((_fid) & XLNX_FID_MASK) == IPI_FID_VALUE)
35
36 /* SiP Service UUID */
37 DEFINE_SVC_UUID2(versal_sip_uuid,
38 0x2ab9e4ecU, 0x93b9U, 0x11e7U, 0xa0U, 0x19U,
39 0xdfU, 0xe0U, 0xdbU, 0xadU, 0x0aU, 0xe0U);
40
41 /**
42 * sip_svc_setup() - Setup SiP Service
43 *
44 * Return: 0 on success,negative error code on failure.
45 *
46 * Invokes PM setup.
47 */
sip_svc_setup(void)48 static int32_t sip_svc_setup(void)
49 {
50 /* PM implementation as SiP Service */
51 (void)pm_setup();
52
53 return 0;
54 }
55
56 /**
57 * sip_svc_smc_handler() - Top-level SiP Service SMC handler.
58 * @smc_fid: Function Identifier.
59 * @x1: SMC64 Arguments 1 from kernel.
60 * @x2: SMC64 Arguments 2 from kernel.
61 * @x3: SMC64 Arguments 3 from kernel(upper 32-bits).
62 * @x4: SMC64 Arguments 4 from kernel.
63 * @cookie: Unused
64 * @handle: Pointer to caller's context structure.
65 * @flags: SECURE_FLAG or NON_SECURE_FLAG.
66 *
67 * Handler for all SiP SMC calls. Handles standard SIP requests
68 * and calls PM SMC handler if the call is for a PM-API function.
69 *
70 * Return: Unused.
71 */
sip_svc_smc_handler(uint32_t smc_fid,u_register_t x1,u_register_t x2,u_register_t x3,u_register_t x4,void * cookie,void * handle,u_register_t flags)72 uintptr_t sip_svc_smc_handler(uint32_t smc_fid,
73 u_register_t x1,
74 u_register_t x2,
75 u_register_t x3,
76 u_register_t x4,
77 void *cookie,
78 void *handle,
79 u_register_t flags)
80 {
81 VERBOSE("SMCID: 0x%08x, x1: 0x%016" PRIx64 ", x2: 0x%016" PRIx64 ", x3: 0x%016" PRIx64 ", x4: 0x%016" PRIx64 "\n",
82 smc_fid, x1, x2, x3, x4);
83
84 if (smc_fid & SIP_FID_MASK) {
85 WARN("SMC out of SiP assinged range: 0x%x\n", smc_fid);
86 SMC_RET1(handle, SMC_UNK);
87 }
88
89 /* Let PM SMC handler deal with PM-related requests */
90 if (is_pm_fid(smc_fid)) {
91 return pm_smc_handler(smc_fid, x1, x2, x3, x4, cookie, handle,
92 flags);
93 }
94
95 /* Let IPI SMC handler deal with IPI-related requests */
96 if (is_ipi_fid(smc_fid)) {
97 return ipi_smc_handler(smc_fid, x1, x2, x3, x4, cookie, handle,
98 flags);
99 }
100
101 /* Let PM SMC handler deal with PM-related requests */
102 switch (smc_fid) {
103 case VERSAL_SIP_SVC_CALL_COUNT:
104 /* PM functions + default functions */
105 SMC_RET1(handle, 2);
106
107 case VERSAL_SIP_SVC_UID:
108 SMC_UUID_RET(handle, versal_sip_uuid);
109
110 case VERSAL_SIP_SVC_VERSION:
111 SMC_RET2(handle, SIP_SVC_VERSION_MAJOR, SIP_SVC_VERSION_MINOR);
112
113 default:
114 WARN("Unimplemented SiP Service Call: 0x%x\n", smc_fid);
115 SMC_RET1(handle, SMC_UNK);
116 }
117 }
118
119 /* Register PM Service Calls as runtime service */
120 DECLARE_RT_SVC(
121 sip_svc,
122 OEN_SIP_START,
123 OEN_SIP_END,
124 SMC_TYPE_FAST,
125 sip_svc_setup,
126 sip_svc_smc_handler);
127
