1 /*
2  * Copyright (c) 2016-2024, Arm Limited and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #include <stdint.h>
8 
9 #include <common/debug.h>
10 #include <common/runtime_svc.h>
11 #include <drivers/arm/ethosn.h>
12 #include <lib/debugfs.h>
13 #include <lib/pmf/pmf.h>
14 #include <plat/arm/common/arm_sip_svc.h>
15 #include <plat/arm/common/plat_arm.h>
16 #include <tools_share/uuid.h>
17 
18 /* ARM SiP Service UUID */
19 DEFINE_SVC_UUID2(arm_sip_svc_uid,
20 	0x556d75e2, 0x6033, 0xb54b, 0xb5, 0x75,
21 	0x62, 0x79, 0xfd, 0x11, 0x37, 0xff);
22 
arm_sip_setup(void)23 static int arm_sip_setup(void)
24 {
25 #if ENABLE_PMF
26 	if (pmf_setup() != 0) {
27 		return 1;
28 	}
29 #endif /* ENABLE_PMF */
30 
31 #if USE_DEBUGFS
32 
33 	if (debugfs_smc_setup() != 0) {
34 		return 1;
35 	}
36 
37 #endif /* USE_DEBUGFS */
38 
39 #if ETHOSN_NPU_DRIVER
40 
41 	if (ethosn_smc_setup() != 0) {
42 		return 1;
43 	}
44 
45 #endif /* ETHOSN_NPU_DRIVER */
46 
47 	return 0;
48 }
49 
50 /*
51  * This function handles ARM defined SiP Calls
52  */
arm_sip_handler(unsigned int 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)53 static uintptr_t arm_sip_handler(unsigned int smc_fid,
54 			u_register_t x1,
55 			u_register_t x2,
56 			u_register_t x3,
57 			u_register_t x4,
58 			void *cookie,
59 			void *handle,
60 			u_register_t flags)
61 {
62 	int call_count = 0;
63 
64 #if ENABLE_PMF
65 	/*
66 	 * Dispatch PMF calls to PMF SMC handler and return its return
67 	 * value
68 	 */
69 	if (is_pmf_fid_deprecated(smc_fid)) {
70 		NOTICE("PMF Interface usage from arm-sip range is deprecated. \
71 			Please migrate smc call to Vendor-specific el3 range.\n");
72 		return pmf_smc_handler(smc_fid, x1, x2, x3, x4, cookie,
73 				handle, flags);
74 	}
75 
76 #endif /* ENABLE_PMF */
77 
78 #if USE_DEBUGFS
79 	if (is_debugfs_fid_deprecated(smc_fid)) {
80 		NOTICE("Debugfs Interface usage from arm-sip range is deprecated. \
81 			Please migrate smc call to vendor-specific el3 range.\n");
82 		return debugfs_smc_handler(smc_fid, x1, x2, x3, x4, cookie,
83 					   handle, flags);
84 	}
85 
86 #endif /* USE_DEBUGFS */
87 
88 #if ETHOSN_NPU_DRIVER
89 
90 	if (is_ethosn_fid(smc_fid)) {
91 		return ethosn_smc_handler(smc_fid, x1, x2, x3, x4, cookie,
92 					  handle, flags);
93 	}
94 
95 #endif /* ETHOSN_NPU_DRIVER */
96 
97 	switch (smc_fid) {
98 	case ARM_SIP_SVC_EXE_STATE_SWITCH: {
99 		/* Execution state can be switched only if EL3 is AArch64 */
100 #ifdef __aarch64__
101 		/* Allow calls from non-secure only */
102 		if (!is_caller_non_secure(flags))
103 			SMC_RET1(handle, STATE_SW_E_DENIED);
104 
105 		/*
106 		 * Pointers used in execution state switch are all 32 bits wide
107 		 */
108 		return (uintptr_t) arm_execution_state_switch(smc_fid,
109 				(uint32_t) x1, (uint32_t) x2, (uint32_t) x3,
110 				(uint32_t) x4, handle);
111 #else
112 		/* State switch denied */
113 		SMC_RET1(handle, STATE_SW_E_DENIED);
114 #endif /* __aarch64__ */
115 		}
116 
117 	case ARM_SIP_SVC_CALL_COUNT:
118 		/* PMF calls */
119 		call_count += PMF_NUM_SMC_CALLS;
120 
121 #if ETHOSN_NPU_DRIVER
122 		/* ETHOSN calls */
123 		call_count += ETHOSN_NUM_SMC_CALLS;
124 #endif          /* ETHOSN_NPU_DRIVER */
125 
126 		/* State switch call */
127 		call_count += 1;
128 
129 		SMC_RET1(handle, call_count);
130 
131 	case ARM_SIP_SVC_UID:
132 		/* Return UID to the caller */
133 		SMC_UUID_RET(handle, arm_sip_svc_uid);
134 
135 	case ARM_SIP_SVC_VERSION:
136 		/* Return the version of current implementation */
137 		SMC_RET2(handle, ARM_SIP_SVC_VERSION_MAJOR, ARM_SIP_SVC_VERSION_MINOR);
138 
139 	default:
140 		break;
141 	}
142 
143 	/*
144 	 * Fall back to allow Arm platform specific handler.
145 	 * TODO: Refactor needed to move out generic handlers from this file and
146 	 * only keep Arm Platform specific handlers here.
147 	 */
148 	return plat_arm_sip_handler(smc_fid, x1, x2, x3, x4,
149 					cookie, handle, flags);
150 }
151 
152 
153 /* Define a runtime service descriptor for fast SMC calls */
154 DECLARE_RT_SVC(
155 	arm_sip_svc,
156 	OEN_SIP_START,
157 	OEN_SIP_END,
158 	SMC_TYPE_FAST,
159 	arm_sip_setup,
160 	arm_sip_handler
161 );
162