1 /*
2  * Copyright (c) 2018-2019, 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 <common/debug.h>
10 #include <common/runtime_svc.h>
11 #include <tools_share/uuid.h>
12 
13 #include "ipi_mailbox_svc.h"
14 #include "pm_svc_main.h"
15 
16 /* SMC function IDs for SiP Service queries */
17 #define VERSAL_SIP_SVC_CALL_COUNT	0x8200ff00
18 #define VERSAL_SIP_SVC_UID		0x8200ff01
19 #define VERSAL_SIP_SVC_VERSION		0x8200ff03
20 
21 /* SiP Service Calls version numbers */
22 #define SIP_SVC_VERSION_MAJOR	0
23 #define SIP_SVC_VERSION_MINOR	1
24 
25 /* These macros are used to identify PM calls from the SMC function ID */
26 #define PM_FID_MASK	0xf000u
27 #define PM_FID_VALUE	0u
28 #define IPI_FID_VALUE	0x1000u
29 #define is_pm_fid(_fid) (((_fid) & PM_FID_MASK) == PM_FID_VALUE)
30 #define is_ipi_fid(_fid) (((_fid) & PM_FID_MASK) == IPI_FID_VALUE)
31 
32 /* SiP Service UUID */
33 DEFINE_SVC_UUID2(versal_sip_uuid,
34 		0x2ab9e4ec, 0x93b9, 0x11e7, 0xa0, 0x19,
35 		0xdf, 0xe0, 0xdb, 0xad, 0x0a, 0xe0);
36 
37 /**
38  * sip_svc_setup() - Setup SiP Service
39  *
40  * Invokes PM setup
41  */
sip_svc_setup(void)42 static int32_t sip_svc_setup(void)
43 {
44 	/* PM implementation as SiP Service */
45 	pm_setup();
46 
47 	return 0;
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 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 pm_smc_handler(smc_fid, x1, x2, x3, x4, cookie, handle,
68 				      flags);
69 	}
70 
71 	/* Let IPI SMC handler deal with IPI-related requests */
72 	if (is_ipi_fid(smc_fid)) {
73 		return ipi_smc_handler(smc_fid, x1, x2, x3, x4, cookie, handle,
74 				      flags);
75 	}
76 
77 	/* Let PM SMC handler deal with PM-related requests */
78 	switch (smc_fid) {
79 	case VERSAL_SIP_SVC_CALL_COUNT:
80 		/* PM functions + default functions */
81 		SMC_RET1(handle, 2);
82 
83 	case VERSAL_SIP_SVC_UID:
84 		SMC_UUID_RET(handle, versal_sip_uuid);
85 
86 	case VERSAL_SIP_SVC_VERSION:
87 		SMC_RET2(handle, SIP_SVC_VERSION_MAJOR, SIP_SVC_VERSION_MINOR);
88 
89 	default:
90 		WARN("Unimplemented SiP Service Call: 0x%x\n", smc_fid);
91 		SMC_RET1(handle, SMC_UNK);
92 	}
93 }
94 
95 /* Register PM Service Calls as runtime service */
96 DECLARE_RT_SVC(
97 		sip_svc,
98 		OEN_SIP_START,
99 		OEN_SIP_END,
100 		SMC_TYPE_FAST,
101 		sip_svc_setup,
102 		sip_svc_smc_handler);
103