xref: /rk3399_ARM-atf/plat/xilinx/zynqmp/sip_svc_setup.c (revision 45d7c51ae46cdb7acd73dcebbed23cd7a36f7358)
1 /*
2  * Copyright (c) 2013-2020, ARM Limited and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 /* Top level SMC handler for SiP calls. Dispatch PM calls to PM SMC handler. */
8 
9 #include <inttypes.h>
10 
11 #include <common/runtime_svc.h>
12 #include <tools_share/uuid.h>
13 
14 #include <custom_svc.h>
15 #include "ipi_mailbox_svc.h"
16 #include "pm_svc_main.h"
17 
18 /* SMC function IDs for SiP Service queries */
19 #define ZYNQMP_SIP_SVC_CALL_COUNT	U(0x8200ff00)
20 #define ZYNQMP_SIP_SVC_UID		U(0x8200ff01)
21 #define ZYNQMP_SIP_SVC_VERSION		U(0x8200ff03)
22 
23 /* SiP Service Calls version numbers */
24 #define SIP_SVC_VERSION_MAJOR	0
25 #define SIP_SVC_VERSION_MINOR	1
26 
27 /* These macros are used to identify PM, IPI calls from the SMC function ID */
28 #define SIP_FID_MASK	GENMASK(23, 16)
29 #define XLNX_FID_MASK	GENMASK(23, 12)
30 #define PM_FID_VALUE	0u
31 #define IPI_FID_VALUE	0x1000u
32 #define EM_FID_VALUE    0xE0000u
33 #define is_em_fid(_fid) (((_fid) & XLNX_FID_MASK) == EM_FID_VALUE)
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 	/* Let EM SMC handler deal with EM-related requests */
72 	if (is_em_fid(smc_fid)) {
73 		return em_smc_handler(smc_fid, x1, x2, x3, x4, cookie, handle,
74 					flags);
75 	}
76 
77 	if (smc_fid & SIP_FID_MASK) {
78 		WARN("SMC out of SiP assinged range: 0x%x\n", smc_fid);
79 		SMC_RET1(handle, SMC_UNK);
80 	}
81 
82 	/* Let PM SMC handler deal with PM-related requests */
83 	if (is_pm_fid(smc_fid)) {
84 		return pm_smc_handler(smc_fid, x1, x2, x3, x4, cookie, handle,
85 				      flags);
86 	}
87 
88 	/* Let IPI SMC handler deal with IPI-related requests */
89 	if (is_ipi_fid(smc_fid)) {
90 		return ipi_smc_handler(smc_fid, x1, x2, x3, x4, cookie, handle,
91 				      flags);
92 	}
93 
94 	switch (smc_fid) {
95 	case ZYNQMP_SIP_SVC_CALL_COUNT:
96 		/* PM functions + default functions */
97 		SMC_RET1(handle, PM_API_MAX + 2);
98 
99 	case ZYNQMP_SIP_SVC_UID:
100 		SMC_UUID_RET(handle, zynqmp_sip_uuid);
101 
102 	case ZYNQMP_SIP_SVC_VERSION:
103 		SMC_RET2(handle, SIP_SVC_VERSION_MAJOR, SIP_SVC_VERSION_MINOR);
104 
105 	case ZYNQMP_SIP_SVC_CUSTOM:
106 	case ZYNQMP_SIP_SVC64_CUSTOM:
107 		return custom_smc_handler(smc_fid, x1, x2, x3, x4, cookie,
108 					  handle, flags);
109 
110 	default:
111 		WARN("Unimplemented SiP Service Call: 0x%x\n", smc_fid);
112 		SMC_RET1(handle, SMC_UNK);
113 	}
114 }
115 
116 /* Register PM Service Calls as runtime service */
117 DECLARE_RT_SVC(
118 		sip_svc,
119 		OEN_SIP_START,
120 		OEN_SIP_END,
121 		(uint8_t)SMC_TYPE_FAST,
122 		sip_svc_setup,
123 		sip_svc_smc_handler);
124