xref: /rk3399_ARM-atf/plat/xilinx/versal/sip_svc_setup.c (revision 6bb49c876c7593ed5f61c20ef3d989dcff8e8d8c)
1 /*
2  * Copyright (c) 2018-2021, 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/debug.h>
12 #include <common/runtime_svc.h>
13 #include <tools_share/uuid.h>
14 
15 #include "ipi_mailbox_svc.h"
16 #include "pm_svc_main.h"
17 
18 /* SMC function IDs for SiP Service queries */
19 #define VERSAL_SIP_SVC_CALL_COUNT	U(0x8200ff00)
20 #define VERSAL_SIP_SVC_UID		U(0x8200ff01)
21 #define VERSAL_SIP_SVC_VERSION		U(0x8200ff03)
22 
23 /* SiP Service Calls version numbers */
24 #define SIP_SVC_VERSION_MAJOR	U(0)
25 #define SIP_SVC_VERSION_MINOR	U(1)
26 
27 /* These macros are used to identify PM 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 is_pm_fid(_fid) (((_fid) & XLNX_FID_MASK) == PM_FID_VALUE)
33 #define is_ipi_fid(_fid) (((_fid) & XLNX_FID_MASK) == IPI_FID_VALUE)
34 
35 /* SiP Service UUID */
36 DEFINE_SVC_UUID2(versal_sip_uuid,
37 		0x2ab9e4ecU, 0x93b9U, 0x11e7U, 0xa0U, 0x19U,
38 		0xdfU, 0xe0U, 0xdbU, 0xadU, 0x0aU, 0xe0U);
39 
40 /**
41  * sip_svc_setup() - Setup SiP Service
42  *
43  * Invokes PM setup
44  */
45 static int32_t sip_svc_setup(void)
46 {
47 	/* PM implementation as SiP Service */
48 	(void)pm_setup();
49 
50 	return 0;
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 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 	/* Let PM SMC handler deal with PM-related requests */
89 	switch (smc_fid) {
90 	case VERSAL_SIP_SVC_CALL_COUNT:
91 		/* PM functions + default functions */
92 		SMC_RET1(handle, 2);
93 
94 	case VERSAL_SIP_SVC_UID:
95 		SMC_UUID_RET(handle, versal_sip_uuid);
96 
97 	case VERSAL_SIP_SVC_VERSION:
98 		SMC_RET2(handle, SIP_SVC_VERSION_MAJOR, SIP_SVC_VERSION_MINOR);
99 
100 	default:
101 		WARN("Unimplemented SiP Service Call: 0x%x\n", smc_fid);
102 		SMC_RET1(handle, SMC_UNK);
103 	}
104 }
105 
106 /* Register PM Service Calls as runtime service */
107 DECLARE_RT_SVC(
108 		sip_svc,
109 		OEN_SIP_START,
110 		OEN_SIP_END,
111 		SMC_TYPE_FAST,
112 		sip_svc_setup,
113 		sip_svc_smc_handler);
114