xref: /rk3399_ARM-atf/plat/xilinx/zynqmp/sip_svc_setup.c (revision 6bb49c876c7593ed5f61c20ef3d989dcff8e8d8c)
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_svc_main.h"
18 
19 /* SMC function IDs for SiP Service queries */
20 #define ZYNQMP_SIP_SVC_CALL_COUNT	U(0x8200ff00)
21 #define ZYNQMP_SIP_SVC_UID		U(0x8200ff01)
22 #define ZYNQMP_SIP_SVC_VERSION		U(0x8200ff03)
23 
24 /* SiP Service Calls version numbers */
25 #define SIP_SVC_VERSION_MAJOR	0
26 #define SIP_SVC_VERSION_MINOR	1
27 
28 /* These macros are used to identify PM, IPI 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(zynqmp_sip_uuid,
38 	0x5c9b1b2a, 0x0586, 0x2340, 0xa6, 0x1b,
39 	0xb9, 0x25, 0x82, 0x2d, 0xe3, 0xa5);
40 
41 /**
42  * sip_svc_setup() - Setup SiP Service
43  *
44  * Invokes PM setup
45  */
46 static int32_t sip_svc_setup(void)
47 {
48 	/* PM implementation as SiP Service */
49 	return pm_setup();
50 }
51 
52 /**
53  * sip_svc_smc_handler() - Top-level SiP Service SMC handler
54  *
55  * Handler for all SiP SMC calls. Handles standard SIP requests
56  * and calls PM SMC handler if the call is for a PM-API function.
57  */
58 static uintptr_t sip_svc_smc_handler(uint32_t smc_fid,
59 			      u_register_t x1,
60 			      u_register_t x2,
61 			      u_register_t x3,
62 			      u_register_t x4,
63 			      void *cookie,
64 			      void *handle,
65 			      u_register_t flags)
66 {
67 	VERBOSE("SMCID: 0x%08x, x1: 0x%016" PRIx64 ", x2: 0x%016" PRIx64 ", x3: 0x%016" PRIx64 ", x4: 0x%016" PRIx64 "\n",
68 		smc_fid, x1, x2, x3, x4);
69 
70 	if (smc_fid & SIP_FID_MASK) {
71 		WARN("SMC out of SiP assinged range: 0x%x\n", smc_fid);
72 		SMC_RET1(handle, SMC_UNK);
73 	}
74 
75 	/* Let PM SMC handler deal with PM-related requests */
76 	if (is_pm_fid(smc_fid)) {
77 		return pm_smc_handler(smc_fid, x1, x2, x3, x4, cookie, handle,
78 				      flags);
79 	}
80 
81 	/* Let IPI SMC handler deal with IPI-related requests */
82 	if (is_ipi_fid(smc_fid)) {
83 		return ipi_smc_handler(smc_fid, x1, x2, x3, x4, cookie, handle,
84 				      flags);
85 	}
86 
87 	switch (smc_fid) {
88 	case ZYNQMP_SIP_SVC_CALL_COUNT:
89 		/* PM functions + default functions */
90 		SMC_RET1(handle, PM_API_MAX + 2);
91 
92 	case ZYNQMP_SIP_SVC_UID:
93 		SMC_UUID_RET(handle, zynqmp_sip_uuid);
94 
95 	case ZYNQMP_SIP_SVC_VERSION:
96 		SMC_RET2(handle, SIP_SVC_VERSION_MAJOR, SIP_SVC_VERSION_MINOR);
97 
98 	case ZYNQMP_SIP_SVC_CUSTOM:
99 	case ZYNQMP_SIP_SVC64_CUSTOM:
100 		return custom_smc_handler(smc_fid, x1, x2, x3, x4, cookie,
101 					  handle, flags);
102 
103 	default:
104 		WARN("Unimplemented SiP Service Call: 0x%x\n", smc_fid);
105 		SMC_RET1(handle, SMC_UNK);
106 	}
107 }
108 
109 /* Register PM Service Calls as runtime service */
110 DECLARE_RT_SVC(
111 		sip_svc,
112 		OEN_SIP_START,
113 		OEN_SIP_END,
114 		(uint8_t)SMC_TYPE_FAST,
115 		sip_svc_setup,
116 		sip_svc_smc_handler);
117