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