xref: /rk3399_ARM-atf/plat/xilinx/zynqmp/sip_svc_setup.c (revision 1d2706dbaf98634aa1eecc65e52b54acf330df3d)
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  * Invokes PM setup
46  */
47 static int32_t sip_svc_setup(void)
48 {
49 	/* PM implementation as SiP Service */
50 	return pm_setup();
51 }
52 
53 /**
54  * sip_svc_smc_handler() - Top-level SiP Service SMC handler
55  *
56  * Handler for all SiP SMC calls. Handles standard SIP requests
57  * and calls PM SMC handler if the call is for a PM-API function.
58  */
59 static uintptr_t sip_svc_smc_handler(uint32_t smc_fid,
60 			      u_register_t x1,
61 			      u_register_t x2,
62 			      u_register_t x3,
63 			      u_register_t x4,
64 			      void *cookie,
65 			      void *handle,
66 			      u_register_t flags)
67 {
68 	VERBOSE("SMCID: 0x%08x, x1: 0x%016" PRIx64 ", x2: 0x%016" PRIx64 ", x3: 0x%016" PRIx64 ", x4: 0x%016" PRIx64 "\n",
69 		smc_fid, x1, x2, x3, x4);
70 
71 	if (smc_fid & SIP_FID_MASK) {
72 		WARN("SMC out of SiP assinged range: 0x%x\n", smc_fid);
73 		SMC_RET1(handle, SMC_UNK);
74 	}
75 
76 	/* Let PM SMC handler deal with PM-related requests */
77 	if (is_pm_fid(smc_fid)) {
78 		return pm_smc_handler(smc_fid, x1, x2, x3, x4, cookie, handle,
79 				      flags);
80 	}
81 
82 	/* Let IPI SMC handler deal with IPI-related requests */
83 	if (is_ipi_fid(smc_fid)) {
84 		return ipi_smc_handler(smc_fid, x1, x2, x3, x4, cookie, handle,
85 				      flags);
86 	}
87 
88 	switch (smc_fid) {
89 	case ZYNQMP_SIP_SVC_CALL_COUNT:
90 		/* PM functions + default functions */
91 		SMC_RET1(handle, PM_API_MAX + 2);
92 
93 	case ZYNQMP_SIP_SVC_UID:
94 		SMC_UUID_RET(handle, zynqmp_sip_uuid);
95 
96 	case ZYNQMP_SIP_SVC_VERSION:
97 		SMC_RET2(handle, SIP_SVC_VERSION_MAJOR, SIP_SVC_VERSION_MINOR);
98 
99 	case ZYNQMP_SIP_SVC_CUSTOM:
100 	case ZYNQMP_SIP_SVC64_CUSTOM:
101 		return custom_smc_handler(smc_fid, x1, x2, x3, x4, cookie,
102 					  handle, flags);
103 
104 	default:
105 		WARN("Unimplemented SiP Service Call: 0x%x\n", smc_fid);
106 		SMC_RET1(handle, SMC_UNK);
107 	}
108 }
109 
110 /* Register PM Service Calls as runtime service */
111 DECLARE_RT_SVC(
112 		sip_svc,
113 		OEN_SIP_START,
114 		OEN_SIP_END,
115 		(uint8_t)SMC_TYPE_FAST,
116 		sip_svc_setup,
117 		sip_svc_smc_handler);
118