1 /*
2  * Copyright (c) 2018-2019, ARM Limited and Contributors. All rights reserved.
3  * Copyright (c) 2018-2022, Xilinx, Inc. All rights reserved.
4  * Copyright (C) 2022, Advanced Micro Devices, Inc. All rights reserved.
5  *
6  * SPDX-License-Identifier: BSD-3-Clause
7  */
8 
9 /* Top level SMC handler for SiP calls. Dispatch PM calls to PM SMC handler. */
10 
11 #include <errno.h>
12 
13 #include <common/debug.h>
14 #include <common/runtime_svc.h>
15 #include <tools_share/uuid.h>
16 
17 #include "ipi_mailbox_svc.h"
18 #include "plat_private.h"
19 #include "pm_svc_main.h"
20 
21 /* SMC function IDs for SiP Service queries */
22 #define VERSAL_NET_SIP_SVC_CALL_COUNT	(0x8200ff00U)
23 #define VERSAL_NET_SIP_SVC_UID		(0x8200ff01U)
24 #define VERSAL_NET_SIP_SVC_VERSION	(0x8200ff03U)
25 
26 /* SiP Service Calls version numbers */
27 #define SIP_SVC_VERSION_MAJOR		(0U)
28 #define SIP_SVC_VERSION_MINOR		(1U)
29 
30 /* These macros are used to identify PM calls from the SMC function ID */
31 #define PM_FID_MASK	0xf000u
32 #define PM_FID_VALUE	0u
33 #define IPI_FID_VALUE	0x1000u
34 #define is_pm_fid(_fid)	(((_fid) & PM_FID_MASK) == PM_FID_VALUE)
35 #define is_ipi_fid(_fid) (((_fid) & PM_FID_MASK) == IPI_FID_VALUE)
36 
37 /* SiP Service UUID */
38 DEFINE_SVC_UUID2(versal_net_sip_uuid,
39 		0x80d4c25a, 0xebaf, 0x11eb, 0x94, 0x68,
40 		0x0b, 0x4e, 0x3b, 0x8f, 0xc3, 0x60);
41 
42 /**
43  * sip_svc_setup() - Setup SiP Service
44  */
sip_svc_setup(void)45 static int32_t sip_svc_setup(void)
46 {
47 	return sip_svc_setup_init();
48 }
49 
50 /*
51  * sip_svc_smc_handler() - Top-level SiP Service SMC handler
52  *
53  * Handler for all SiP SMC calls. Handles standard SIP requests
54  * and calls PM SMC handler if the call is for a PM-API function.
55  */
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)56 static uintptr_t sip_svc_smc_handler(uint32_t smc_fid,
57 			     u_register_t x1,
58 			     u_register_t x2,
59 			     u_register_t x3,
60 			     u_register_t x4,
61 			     void *cookie,
62 			     void *handle,
63 			     u_register_t flags)
64 {
65 	/* Let PM SMC handler deal with PM-related requests */
66 	if (is_pm_fid(smc_fid)) {
67 		return smc_handler(smc_fid, x1, x2, x3, x4, cookie, handle,
68 				flags);
69 	}
70 
71 	/* Let IPI SMC handler deal with IPI-related requests if platform */
72 	if (is_ipi_fid(smc_fid)) {
73 		return ipi_smc_handler(smc_fid, x1, x2, x3, x4, cookie, handle, flags);
74 	}
75 
76 	/* Let PM SMC handler deal with PM-related requests */
77 	switch (smc_fid) {
78 	case VERSAL_NET_SIP_SVC_CALL_COUNT:
79 		/* PM functions + default functions */
80 		SMC_RET1(handle, 2);
81 
82 	case VERSAL_NET_SIP_SVC_UID:
83 		SMC_UUID_RET(handle, versal_net_sip_uuid);
84 
85 	case VERSAL_NET_SIP_SVC_VERSION:
86 		SMC_RET2(handle, SIP_SVC_VERSION_MAJOR, SIP_SVC_VERSION_MINOR);
87 
88 	default:
89 		WARN("Unimplemented SiP Service Call: 0x%x\n", smc_fid);
90 		SMC_RET1(handle, SMC_UNK);
91 	}
92 }
93 
94 /* Register PM Service Calls as runtime service */
95 DECLARE_RT_SVC(
96 		sip_svc,
97 		OEN_SIP_START,
98 		OEN_SIP_END,
99 		SMC_TYPE_FAST,
100 		sip_svc_setup,
101 		sip_svc_smc_handler);
102