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