xref: /rk3399_ARM-atf/plat/xilinx/zynqmp/sip_svc_setup.c (revision 9c571fb0d20b01e1111e2973461ec14830e0724a)
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 <custom_svc.h>
13 #include "ipi_mailbox_svc.h"
14 #include "pm_svc_main.h"
15 
16 /* SMC function IDs for SiP Service queries */
17 #define ZYNQMP_SIP_SVC_CALL_COUNT	U(0x8200ff00)
18 #define ZYNQMP_SIP_SVC_UID		U(0x8200ff01)
19 #define ZYNQMP_SIP_SVC_VERSION		U(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, IPI 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 EM_FID_MASK     0xf0000u
30 #define EM_FID_VALUE    0xE0000u
31 #define is_em_fid(_fid) (((_fid) & EM_FID_MASK) == EM_FID_VALUE)
32 #define is_pm_fid(_fid) (((_fid) & PM_FID_MASK) == PM_FID_VALUE)
33 #define is_ipi_fid(_fid) (((_fid) & PM_FID_MASK) == IPI_FID_VALUE)
34 
35 /* SiP Service UUID */
36 DEFINE_SVC_UUID2(zynqmp_sip_uuid,
37 	0x5c9b1b2a, 0x0586, 0x2340, 0xa6, 0x1b,
38 	0xb9, 0x25, 0x82, 0x2d, 0xe3, 0xa5);
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 	return pm_setup();
49 }
50 
51 /**
52  * sip_svc_smc_handler() - Top-level SiP Service SMC handler
53  *
54  * Handler for all SiP SMC calls. Handles standard SIP requests
55  * and calls PM SMC handler if the call is for a PM-API function.
56  */
57 static uintptr_t sip_svc_smc_handler(uint32_t smc_fid,
58 			      u_register_t x1,
59 			      u_register_t x2,
60 			      u_register_t x3,
61 			      u_register_t x4,
62 			      void *cookie,
63 			      void *handle,
64 			      u_register_t flags)
65 {
66 	/* Let EM SMC handler deal with EM-related requests */
67 	if (is_em_fid(smc_fid)) {
68 		return em_smc_handler(smc_fid, x1, x2, x3, x4, cookie, handle,
69 					flags);
70 	} else if (is_pm_fid(smc_fid)) {
71 	/* Let PM SMC handler deal with PM-related requests */
72 		return pm_smc_handler(smc_fid, x1, x2, x3, x4, cookie, handle,
73 				      flags);
74 	}
75 
76 	/* Let IPI SMC handler deal with IPI-related requests */
77 	if (is_ipi_fid(smc_fid)) {
78 		return ipi_smc_handler(smc_fid, x1, x2, x3, x4, cookie, handle,
79 				      flags);
80 	}
81 
82 	switch (smc_fid) {
83 	case ZYNQMP_SIP_SVC_CALL_COUNT:
84 		/* PM functions + default functions */
85 		SMC_RET1(handle, PM_API_MAX + 2);
86 
87 	case ZYNQMP_SIP_SVC_UID:
88 		SMC_UUID_RET(handle, zynqmp_sip_uuid);
89 
90 	case ZYNQMP_SIP_SVC_VERSION:
91 		SMC_RET2(handle, SIP_SVC_VERSION_MAJOR, SIP_SVC_VERSION_MINOR);
92 
93 	case ZYNQMP_SIP_SVC_CUSTOM:
94 	case ZYNQMP_SIP_SVC64_CUSTOM:
95 		return custom_smc_handler(smc_fid, x1, x2, x3, x4, cookie,
96 					  handle, flags);
97 
98 	default:
99 		WARN("Unimplemented SiP Service Call: 0x%x\n", smc_fid);
100 		SMC_RET1(handle, SMC_UNK);
101 	}
102 }
103 
104 /* Register PM Service Calls as runtime service */
105 DECLARE_RT_SVC(
106 		sip_svc,
107 		OEN_SIP_START,
108 		OEN_SIP_END,
109 		(uint8_t)SMC_TYPE_FAST,
110 		sip_svc_setup,
111 		sip_svc_smc_handler);
112