1 /* 2 * Copyright (c) 2019-2022, Xilinx, Inc. All rights reserved. 3 * Copyright (c) 2022-2023, Advanced Micro Devices, Inc. All rights reserved. 4 * 5 * SPDX-License-Identifier: BSD-3-Clause 6 */ 7 8 /* 9 * Top-level SMC handler for Versal power management calls and 10 * IPI setup functions for communication with PMC. 11 */ 12 13 #include <errno.h> 14 #include <plat_private.h> 15 #include <stdbool.h> 16 #include <common/runtime_svc.h> 17 #include <plat/common/platform.h> 18 #include "pm_api_sys.h" 19 #include "pm_client.h" 20 #include "pm_ipi.h" 21 #include <drivers/arm/gicv3.h> 22 #include "../drivers/arm/gic/v3/gicv3_private.h" 23 24 #define MODE 0x80000000U 25 26 #define XSCUGIC_SGIR_EL1_INITID_SHIFT 24U 27 #define INVALID_SGI 0xFFU 28 #define PM_INIT_SUSPEND_CB (30U) 29 #define PM_NOTIFY_CB (32U) 30 DEFINE_RENAME_SYSREG_RW_FUNCS(icc_asgi1r_el1, S3_0_C12_C11_6) 31 32 /* pm_up = true - UP, pm_up = false - DOWN */ 33 static bool pm_up; 34 static uint32_t sgi = (uint32_t)INVALID_SGI; 35 36 static void notify_os(void) 37 { 38 int32_t cpu; 39 uint32_t reg; 40 41 cpu = plat_my_core_pos() + 1U; 42 43 reg = (cpu | (sgi << XSCUGIC_SGIR_EL1_INITID_SHIFT)); 44 write_icc_asgi1r_el1(reg); 45 } 46 47 static uint64_t ipi_fiq_handler(uint32_t id, uint32_t flags, void *handle, 48 void *cookie) 49 { 50 uint32_t payload[4] = {0}; 51 enum pm_ret_status ret; 52 53 VERBOSE("Received IPI FIQ from firmware\n"); 54 55 (void)plat_ic_acknowledge_interrupt(); 56 57 ret = pm_get_callbackdata(payload, ARRAY_SIZE(payload), 0, 0); 58 if (ret != PM_RET_SUCCESS) { 59 payload[0] = ret; 60 } 61 62 switch (payload[0]) { 63 case PM_INIT_SUSPEND_CB: 64 case PM_NOTIFY_CB: 65 if (sgi != INVALID_SGI) { 66 notify_os(); 67 } 68 break; 69 case PM_RET_ERROR_INVALID_CRC: 70 pm_ipi_irq_clear(primary_proc); 71 WARN("Invalid CRC in the payload\n"); 72 break; 73 74 default: 75 pm_ipi_irq_clear(primary_proc); 76 WARN("Invalid IPI payload\n"); 77 break; 78 } 79 80 /* Clear FIQ */ 81 plat_ic_end_of_interrupt(id); 82 83 return 0; 84 } 85 86 /** 87 * pm_register_sgi() - PM register the IPI interrupt 88 * 89 * @sgi - SGI number to be used for communication. 90 * @reset - Reset to invalid SGI when reset=1. 91 * @return On success, the initialization function must return 0. 92 * Any other return value will cause the framework to ignore 93 * the service 94 * 95 * Update the SGI number to be used. 96 * 97 */ 98 int32_t pm_register_sgi(uint32_t sgi_num, uint32_t reset) 99 { 100 if (reset == 1U) { 101 sgi = INVALID_SGI; 102 return 0; 103 } 104 105 if (sgi != INVALID_SGI) { 106 return -EBUSY; 107 } 108 109 if (sgi_num >= GICV3_MAX_SGI_TARGETS) { 110 return -EINVAL; 111 } 112 113 sgi = (uint32_t)sgi_num; 114 return 0; 115 } 116 117 /** 118 * pm_setup() - PM service setup 119 * 120 * @return On success, the initialization function must return 0. 121 * Any other return value will cause the framework to ignore 122 * the service 123 * 124 * Initialization functions for Versal power management for 125 * communicaton with PMC. 126 * 127 * Called from sip_svc_setup initialization function with the 128 * rt_svc_init signature. 129 */ 130 int32_t pm_setup(void) 131 { 132 int32_t ret = 0; 133 134 pm_ipi_init(primary_proc); 135 pm_up = true; 136 137 /* 138 * Enable IPI IRQ 139 * assume the rich OS is OK to handle callback IRQs now. 140 * Even if we were wrong, it would not enable the IRQ in 141 * the GIC. 142 */ 143 pm_ipi_irq_enable(primary_proc); 144 145 ret = request_intr_type_el3(PLAT_VERSAL_IPI_IRQ, ipi_fiq_handler); 146 if (ret != 0) { 147 WARN("BL31: registering IPI interrupt failed\n"); 148 } 149 150 gicd_write_irouter(gicv3_driver_data->gicd_base, PLAT_VERSAL_IPI_IRQ, MODE); 151 return ret; 152 } 153 154 /** 155 * eemi_for_compatibility() - EEMI calls handler for deprecated calls 156 * 157 * @return - If EEMI API found then, uintptr_t type address, else 0 158 * 159 * Some EEMI API's use case needs to be changed in Linux driver, so they 160 * can take advantage of common EEMI handler in TF-A. As of now the old 161 * implementation of these APIs are required to maintain backward compatibility 162 * until their use case in linux driver changes. 163 */ 164 static uintptr_t eemi_for_compatibility(uint32_t api_id, uint32_t *pm_arg, 165 void *handle, uint32_t security_flag) 166 { 167 enum pm_ret_status ret; 168 169 switch (api_id) { 170 171 case (uint32_t)PM_IOCTL: 172 { 173 uint32_t value = 0U; 174 175 ret = pm_api_ioctl(pm_arg[0], pm_arg[1], pm_arg[2], 176 pm_arg[3], pm_arg[4], 177 &value, security_flag); 178 if (ret == PM_RET_ERROR_NOTSUPPORTED) 179 return (uintptr_t)0; 180 181 SMC_RET1(handle, (uint64_t)ret | ((uint64_t)value) << 32U); 182 } 183 184 case (uint32_t)PM_QUERY_DATA: 185 { 186 uint32_t data[PAYLOAD_ARG_CNT] = { 0 }; 187 188 ret = pm_query_data(pm_arg[0], pm_arg[1], pm_arg[2], 189 pm_arg[3], data, security_flag); 190 191 SMC_RET2(handle, (uint64_t)ret | ((uint64_t)data[0] << 32U), 192 (uint64_t)data[1] | ((uint64_t)data[2] << 32U)); 193 } 194 195 case (uint32_t)PM_FEATURE_CHECK: 196 { 197 uint32_t result[PAYLOAD_ARG_CNT] = {0U}; 198 199 ret = pm_feature_check(pm_arg[0], result, security_flag); 200 SMC_RET2(handle, (uint64_t)ret | ((uint64_t)result[0] << 32U), 201 (uint64_t)result[1] | ((uint64_t)result[2] << 32U)); 202 } 203 204 case PM_LOAD_PDI: 205 { 206 ret = pm_load_pdi(pm_arg[0], pm_arg[1], pm_arg[2], 207 security_flag); 208 SMC_RET1(handle, (uint64_t)ret); 209 } 210 211 default: 212 return (uintptr_t)0; 213 } 214 } 215 216 /** 217 * eemi_psci_debugfs_handler() - EEMI API invoked from PSCI 218 * 219 * These EEMI APIs performs CPU specific power management tasks. 220 * These EEMI APIs are invoked either from PSCI or from debugfs in kernel. 221 * These calls require CPU specific processing before sending IPI request to 222 * Platform Management Controller. For example enable/disable CPU specific 223 * interrupts. This requires separate handler for these calls and may not be 224 * handled using common eemi handler 225 */ 226 static uintptr_t eemi_psci_debugfs_handler(uint32_t api_id, uint32_t *pm_arg, 227 void *handle, uint32_t security_flag) 228 { 229 enum pm_ret_status ret; 230 231 switch (api_id) { 232 233 case (uint32_t)PM_SELF_SUSPEND: 234 ret = pm_self_suspend(pm_arg[0], pm_arg[1], pm_arg[2], 235 pm_arg[3], security_flag); 236 SMC_RET1(handle, (u_register_t)ret); 237 238 case (uint32_t)PM_FORCE_POWERDOWN: 239 ret = pm_force_powerdown(pm_arg[0], pm_arg[1], security_flag); 240 SMC_RET1(handle, (u_register_t)ret); 241 242 case (uint32_t)PM_REQ_SUSPEND: 243 ret = pm_req_suspend(pm_arg[0], pm_arg[1], pm_arg[2], 244 pm_arg[3], security_flag); 245 SMC_RET1(handle, (u_register_t)ret); 246 247 case (uint32_t)PM_ABORT_SUSPEND: 248 ret = pm_abort_suspend(pm_arg[0], security_flag); 249 SMC_RET1(handle, (u_register_t)ret); 250 251 case (uint32_t)PM_SYSTEM_SHUTDOWN: 252 ret = pm_system_shutdown(pm_arg[0], pm_arg[1], security_flag); 253 SMC_RET1(handle, (u_register_t)ret); 254 255 default: 256 return (uintptr_t)0; 257 } 258 } 259 260 /** 261 * TF_A_specific_handler() - SMC handler for TF-A specific functionality 262 * 263 * These EEMI calls performs functionality that does not require 264 * IPI transaction. The handler ends in TF-A and returns requested data to 265 * kernel from TF-A. 266 */ 267 static uintptr_t TF_A_specific_handler(uint32_t api_id, uint32_t *pm_arg, 268 void *handle, uint32_t security_flag) 269 { 270 switch (api_id) { 271 272 case TF_A_PM_REGISTER_SGI: 273 { 274 int32_t ret; 275 276 ret = pm_register_sgi(pm_arg[0], pm_arg[1]); 277 if (ret != 0) { 278 SMC_RET1(handle, (uint32_t)PM_RET_ERROR_ARGS); 279 } 280 281 SMC_RET1(handle, (uint32_t)PM_RET_SUCCESS); 282 } 283 284 case PM_GET_CALLBACK_DATA: 285 { 286 uint32_t result[4] = {0}; 287 enum pm_ret_status ret; 288 289 ret = pm_get_callbackdata(result, ARRAY_SIZE(result), security_flag, 1U); 290 if (ret != 0) { 291 result[0] = ret; 292 } 293 294 SMC_RET2(handle, 295 (uint64_t)result[0] | ((uint64_t)result[1] << 32U), 296 (uint64_t)result[2] | ((uint64_t)result[3] << 32U)); 297 } 298 299 case PM_GET_TRUSTZONE_VERSION: 300 SMC_RET1(handle, (uint64_t)PM_RET_SUCCESS | 301 ((uint64_t)TZ_VERSION << 32U)); 302 303 default: 304 return (uintptr_t)0; 305 } 306 } 307 308 /** 309 * eemi_handler() - Prepare EEMI payload and perform IPI transaction 310 * 311 * EEMI - Embedded Energy Management Interface is Xilinx proprietary protocol 312 * to allow communication between power management controller and different 313 * processing clusters. 314 * 315 * This handler prepares EEMI protocol payload received from kernel and performs 316 * IPI transaction. 317 */ 318 static uintptr_t eemi_handler(uint32_t api_id, uint32_t *pm_arg, 319 void *handle, uint32_t security_flag) 320 { 321 enum pm_ret_status ret; 322 uint32_t buf[PAYLOAD_ARG_CNT] = {0}; 323 324 ret = pm_handle_eemi_call(security_flag, api_id, pm_arg[0], pm_arg[1], 325 pm_arg[2], pm_arg[3], pm_arg[4], 326 (uint64_t *)buf); 327 /* 328 * Two IOCTLs, to get clock name and pinctrl name of pm_query_data API 329 * receives 5 words of respoonse from firmware. Currently linux driver can 330 * receive only 4 words from TF-A. So, this needs to be handled separately 331 * than other eemi calls. 332 */ 333 if (api_id == (uint32_t)PM_QUERY_DATA) { 334 if ((pm_arg[0] == XPM_QID_CLOCK_GET_NAME || 335 pm_arg[0] == XPM_QID_PINCTRL_GET_FUNCTION_NAME) && 336 ret == PM_RET_SUCCESS) { 337 SMC_RET2(handle, (uint64_t)buf[0] | ((uint64_t)buf[1] << 32U), 338 (uint64_t)buf[2] | ((uint64_t)buf[3] << 32U)); 339 } 340 } 341 342 SMC_RET2(handle, (uint64_t)ret | ((uint64_t)buf[0] << 32U), 343 (uint64_t)buf[1] | ((uint64_t)buf[2] << 32U)); 344 } 345 346 /** 347 * pm_smc_handler() - SMC handler for PM-API calls coming from EL1/EL2. 348 * @smc_fid - Function Identifier 349 * @x1 - x4 - SMC64 Arguments from kernel 350 * x3 (upper 32-bits) and x4 are Unused 351 * @cookie - Unused 352 * @handler - Pointer to caller's context structure 353 * 354 * @return - Unused 355 * 356 * Determines that smc_fid is valid and supported PM SMC Function ID from the 357 * list of pm_api_ids, otherwise completes the request with 358 * the unknown SMC Function ID 359 * 360 * The SMC calls for PM service are forwarded from SIP Service SMC handler 361 * function with rt_svc_handle signature 362 */ 363 uint64_t pm_smc_handler(uint32_t smc_fid, uint64_t x1, uint64_t x2, uint64_t x3, 364 uint64_t x4, const void *cookie, void *handle, uint64_t flags) 365 { 366 uintptr_t ret; 367 uint32_t pm_arg[PAYLOAD_ARG_CNT] = {0}; 368 uint32_t security_flag = SECURE_FLAG; 369 uint32_t api_id; 370 371 /* Handle case where PM wasn't initialized properly */ 372 if (pm_up == false) { 373 SMC_RET1(handle, SMC_UNK); 374 } 375 376 /* 377 * Mark BIT24 payload (i.e 1st bit of pm_arg[3] ) as non-secure (1) 378 * if smc called is non secure 379 */ 380 if (is_caller_non_secure(flags) != 0) { 381 security_flag = NON_SECURE_FLAG; 382 } 383 384 pm_arg[0] = (uint32_t)x1; 385 pm_arg[1] = (uint32_t)(x1 >> 32U); 386 pm_arg[2] = (uint32_t)x2; 387 pm_arg[3] = (uint32_t)(x2 >> 32U); 388 pm_arg[4] = (uint32_t)x3; 389 (void)(x4); 390 api_id = smc_fid & FUNCID_NUM_MASK; 391 392 ret = eemi_for_compatibility(api_id, pm_arg, handle, security_flag); 393 if (ret != (uintptr_t)0) { 394 return ret; 395 } 396 397 ret = eemi_psci_debugfs_handler(api_id, pm_arg, handle, flags); 398 if (ret != (uintptr_t)0) { 399 return ret; 400 } 401 402 ret = TF_A_specific_handler(api_id, pm_arg, handle, security_flag); 403 if (ret != (uintptr_t)0) { 404 return ret; 405 } 406 407 ret = eemi_handler(api_id, pm_arg, handle, security_flag); 408 409 return ret; 410 } 411