1 /*
2 * Copyright (c) 2013-2020, Arm Limited and Contributors. All rights reserved.
3 * Copyright (c) 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/runtime_svc.h>
13 #include <tools_share/uuid.h>
14
15 #include <custom_svc.h>
16 #include "ipi_mailbox_svc.h"
17 #include "pm_defs.h"
18 #include "zynqmp_pm_svc_main.h"
19
20 /* SMC function IDs for SiP Service queries */
21 #define ZYNQMP_SIP_SVC_CALL_COUNT U(0x8200ff00)
22 #define ZYNQMP_SIP_SVC_UID U(0x8200ff01)
23 #define ZYNQMP_SIP_SVC_VERSION U(0x8200ff03)
24
25 /* SiP Service Calls version numbers */
26 #define SIP_SVC_VERSION_MAJOR 0
27 #define SIP_SVC_VERSION_MINOR 1
28
29 /* These macros are used to identify PM, IPI calls from the SMC function ID */
30 #define SIP_FID_MASK GENMASK(23, 16)
31 #define XLNX_FID_MASK GENMASK(23, 12)
32 #define PM_FID_VALUE 0u
33 #define IPI_FID_VALUE 0x1000u
34 #define is_pm_fid(_fid) (((_fid) & XLNX_FID_MASK) == PM_FID_VALUE)
35 #define is_ipi_fid(_fid) (((_fid) & XLNX_FID_MASK) == IPI_FID_VALUE)
36
37 /* SiP Service UUID */
38 DEFINE_SVC_UUID2(zynqmp_sip_uuid,
39 0x5c9b1b2a, 0x0586, 0x2340, 0xa6, 0x1b,
40 0xb9, 0x25, 0x82, 0x2d, 0xe3, 0xa5);
41
42 /**
43 * sip_svc_setup() - Setup SiP Service.
44 *
45 * Return: On success, the initialization function must return 0.
46 * Any other return value will cause the framework to ignore
47 * the service.
48 *
49 * Invokes PM setup.
50 */
sip_svc_setup(void)51 static int32_t sip_svc_setup(void)
52 {
53 /* PM implementation as SiP Service */
54 return pm_setup();
55 }
56
57 /**
58 * sip_svc_smc_handler() - Top-level SiP Service SMC handler
59 * @smc_fid: Function Identifier.
60 * @x1: SMC64 Arguments 1 from kernel.
61 * @x2: SMC64 Arguments 2 from kernel.
62 * @x3: SMC64 Arguments 3 from kernel(upper 32-bits).
63 * @x4: SMC64 Arguments 4 from kernel.
64 * @cookie: Unused
65 * @handle: Pointer to caller's context structure.
66 * @flags: SECURE_FLAG or NON_SECURE_FLAG.
67 *
68 * Handler for all SiP SMC calls. Handles standard SIP requests
69 * and calls PM SMC handler if the call is for a PM-API function.
70 *
71 * Return: Unused.
72 */
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)73 static uintptr_t sip_svc_smc_handler(uint32_t smc_fid,
74 u_register_t x1,
75 u_register_t x2,
76 u_register_t x3,
77 u_register_t x4,
78 void *cookie,
79 void *handle,
80 u_register_t flags)
81 {
82 VERBOSE("SMCID: 0x%08x, x1: 0x%016" PRIx64 ", x2: 0x%016" PRIx64 ", x3: 0x%016" PRIx64 ", x4: 0x%016" PRIx64 "\n",
83 smc_fid, x1, x2, x3, x4);
84
85 if (smc_fid & SIP_FID_MASK) {
86 WARN("SMC out of SiP assinged range: 0x%x\n", smc_fid);
87 SMC_RET1(handle, SMC_UNK);
88 }
89
90 /* Let PM SMC handler deal with PM-related requests */
91 if (is_pm_fid(smc_fid)) {
92 return pm_smc_handler(smc_fid, x1, x2, x3, x4, cookie, handle,
93 flags);
94 }
95
96 /* Let IPI SMC handler deal with IPI-related requests */
97 if (is_ipi_fid(smc_fid)) {
98 return ipi_smc_handler(smc_fid, x1, x2, x3, x4, cookie, handle,
99 flags);
100 }
101
102 switch (smc_fid) {
103 case ZYNQMP_SIP_SVC_CALL_COUNT:
104 /* PM functions + default functions */
105 SMC_RET1(handle, PM_API_MAX + 2);
106
107 case ZYNQMP_SIP_SVC_UID:
108 SMC_UUID_RET(handle, zynqmp_sip_uuid);
109
110 case ZYNQMP_SIP_SVC_VERSION:
111 SMC_RET2(handle, SIP_SVC_VERSION_MAJOR, SIP_SVC_VERSION_MINOR);
112
113 case ZYNQMP_SIP_SVC_CUSTOM:
114 case ZYNQMP_SIP_SVC64_CUSTOM:
115 return custom_smc_handler(smc_fid, x1, x2, x3, x4, cookie,
116 handle, flags);
117
118 default:
119 WARN("Unimplemented SiP Service Call: 0x%x\n", smc_fid);
120 SMC_RET1(handle, SMC_UNK);
121 }
122 }
123
124 /* Register PM Service Calls as runtime service */
125 DECLARE_RT_SVC(
126 sip_svc,
127 OEN_SIP_START,
128 OEN_SIP_END,
129 (uint8_t)SMC_TYPE_FAST,
130 sip_svc_setup,
131 sip_svc_smc_handler);
132
