drivers/firmware/psci/psci.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  *
   4  * Copyright (C) 2015 ARM Limited
   5  */
   6
   7 #define pr_fmt(fmt) "psci: " fmt
   8
   9 #include <linux/acpi.h>
  10 #include <linux/arm-smccc.h>
  11 #include <linux/cpuidle.h>
  12 #include <linux/errno.h>
  13 #include <linux/linkage.h>
  14 #include <linux/of.h>
  15 #include <linux/pm.h>
  16 #include <linux/printk.h>
  17 #include <linux/psci.h>
  18 #include <linux/reboot.h>
  19 #include <linux/slab.h>
  20 #include <linux/suspend.h>
  21
  22 #include <uapi/linux/psci.h>
  23
  24 #include <asm/cpuidle.h>
  25 #include <asm/cputype.h>
  26 #include <asm/hypervisor.h>
  27 #include <asm/system_misc.h>
  28 #include <asm/smp_plat.h>
  29 #include <asm/suspend.h>
  30
  31 /*
  32  * While a 64-bit OS can make calls with SMC32 calling conventions, for some
  33  * calls it is necessary to use SMC64 to pass or return 64-bit values.
  34  * For such calls PSCI_FN_NATIVE(version, name) will choose the appropriate
  35  * (native-width) function ID.
  36  */
  37 #ifdef CONFIG_64BIT
  38 #define PSCI_FN_NATIVE(version, name)   PSCI_##version##_FN64_##name
  39 #else
  40 #define PSCI_FN_NATIVE(version, name)   PSCI_##version##_FN_##name
  41 #endif
  42
  43 /*
  44  * The CPU any Trusted OS is resident on. The trusted OS may reject CPU_OFF
  45  * calls to its resident CPU, so we must avoid issuing those. We never migrate
  46  * a Trusted OS even if it claims to be capable of migration -- doing so will
  47  * require cooperation with a Trusted OS driver.
  48  */
  49 static int resident_cpu = -1;
  50 struct psci_operations psci_ops;
  51 static enum arm_smccc_conduit psci_conduit = SMCCC_CONDUIT_NONE;
  52
  53 bool psci_tos_resident_on(int cpu)
  54 {
  55         return cpu == resident_cpu;
  56 }
  57
  58 typedef unsigned long (psci_fn)(unsigned long, unsigned long,
  59                                 unsigned long, unsigned long);
  60 static psci_fn *invoke_psci_fn;
  61
  62 static struct psci_0_1_function_ids psci_0_1_function_ids;
  63
  64 struct psci_0_1_function_ids get_psci_0_1_function_ids(void)
  65 {
  66         return psci_0_1_function_ids;
  67 }
  68
  69 #define PSCI_0_2_POWER_STATE_MASK               \
  70                                 (PSCI_0_2_POWER_STATE_ID_MASK | \
  71                                 PSCI_0_2_POWER_STATE_TYPE_MASK | \
  72                                 PSCI_0_2_POWER_STATE_AFFL_MASK)
  73
  74 #define PSCI_1_0_EXT_POWER_STATE_MASK           \
  75                                 (PSCI_1_0_EXT_POWER_STATE_ID_MASK | \
  76                                 PSCI_1_0_EXT_POWER_STATE_TYPE_MASK)
  77
  78 static u32 psci_cpu_suspend_feature;
  79 static bool psci_system_reset2_supported;
  80
  81 static inline bool psci_has_ext_power_state(void)
  82 {
  83         return psci_cpu_suspend_feature &
  84                                 PSCI_1_0_FEATURES_CPU_SUSPEND_PF_MASK;
  85 }
  86
  87 bool psci_has_osi_support(void)
  88 {
  89         return psci_cpu_suspend_feature & PSCI_1_0_OS_INITIATED;
  90 }
  91
  92 static inline bool psci_power_state_loses_context(u32 state)
  93 {
  94         const u32 mask = psci_has_ext_power_state() ?
  95                                         PSCI_1_0_EXT_POWER_STATE_TYPE_MASK :
  96                                         PSCI_0_2_POWER_STATE_TYPE_MASK;
  97
  98         return state & mask;
  99 }
 100
 101 bool psci_power_state_is_valid(u32 state)
 102 {
 103         const u32 valid_mask = psci_has_ext_power_state() ?
 104                                PSCI_1_0_EXT_POWER_STATE_MASK :
 105                                PSCI_0_2_POWER_STATE_MASK;
 106
 107         return !(state & ~valid_mask);
 108 }
 109
 110 static unsigned long __invoke_psci_fn_hvc(unsigned long function_id,
 111                         unsigned long arg0, unsigned long arg1,
 112                         unsigned long arg2)
 113 {
 114         struct arm_smccc_res res;
 115
 116         arm_smccc_hvc(function_id, arg0, arg1, arg2, 0, 0, 0, 0, &res);
 117         return res.a0;
 118 }
 119
 120 static unsigned long __invoke_psci_fn_smc(unsigned long function_id,
 121                         unsigned long arg0, unsigned long arg1,
 122                         unsigned long arg2)
 123 {
 124         struct arm_smccc_res res;
 125
 126         arm_smccc_smc(function_id, arg0, arg1, arg2, 0, 0, 0, 0, &res);
 127         return res.a0;
 128 }
 129
 130 static int psci_to_linux_errno(int errno)
 131 {
 132         switch (errno) {
 133         case PSCI_RET_SUCCESS:
 134                 return 0;
 135         case PSCI_RET_NOT_SUPPORTED:
 136                 return -EOPNOTSUPP;
 137         case PSCI_RET_INVALID_PARAMS:
 138         case PSCI_RET_INVALID_ADDRESS:
 139                 return -EINVAL;
 140         case PSCI_RET_DENIED:
 141                 return -EPERM;
 142         };
 143
 144         return -EINVAL;
 145 }
 146
 147 static u32 psci_0_1_get_version(void)
 148 {
 149         return PSCI_VERSION(0, 1);
 150 }
 151
 152 static u32 psci_0_2_get_version(void)
 153 {
 154         return invoke_psci_fn(PSCI_0_2_FN_PSCI_VERSION, 0, 0, 0);
 155 }
 156
 157 int psci_set_osi_mode(bool enable)
 158 {
 159         unsigned long suspend_mode;
 160         int err;
 161
 162         suspend_mode = enable ? PSCI_1_0_SUSPEND_MODE_OSI :
 163                         PSCI_1_0_SUSPEND_MODE_PC;
 164
 165         err = invoke_psci_fn(PSCI_1_0_FN_SET_SUSPEND_MODE, suspend_mode, 0, 0);
 166         return psci_to_linux_errno(err);
 167 }
 168
 169 static int __psci_cpu_suspend(u32 fn, u32 state, unsigned long entry_point)
 170 {
 171         int err;
 172
 173         err = invoke_psci_fn(fn, state, entry_point, 0);
 174         return psci_to_linux_errno(err);
 175 }
 176
 177 static int psci_0_1_cpu_suspend(u32 state, unsigned long entry_point)
 178 {
 179         return __psci_cpu_suspend(psci_0_1_function_ids.cpu_suspend,
 180                                   state, entry_point);
 181 }
 182
 183 static int psci_0_2_cpu_suspend(u32 state, unsigned long entry_point)
 184 {
 185         return __psci_cpu_suspend(PSCI_FN_NATIVE(0_2, CPU_SUSPEND),
 186                                   state, entry_point);
 187 }
 188
 189 static int __psci_cpu_off(u32 fn, u32 state)
 190 {
 191         int err;
 192
 193         err = invoke_psci_fn(fn, state, 0, 0);
 194         return psci_to_linux_errno(err);
 195 }
 196
 197 static int psci_0_1_cpu_off(u32 state)
 198 {
 199         return __psci_cpu_off(psci_0_1_function_ids.cpu_off, state);
 200 }
 201
 202 static int psci_0_2_cpu_off(u32 state)
 203 {
 204         return __psci_cpu_off(PSCI_0_2_FN_CPU_OFF, state);
 205 }
 206
 207 static int __psci_cpu_on(u32 fn, unsigned long cpuid, unsigned long entry_point)
 208 {
 209         int err;
 210
 211         err = invoke_psci_fn(fn, cpuid, entry_point, 0);
 212         return psci_to_linux_errno(err);
 213 }
 214
 215 static int psci_0_1_cpu_on(unsigned long cpuid, unsigned long entry_point)
 216 {
 217         return __psci_cpu_on(psci_0_1_function_ids.cpu_on, cpuid, entry_point);
 218 }
 219
 220 static int psci_0_2_cpu_on(unsigned long cpuid, unsigned long entry_point)
 221 {
 222         return __psci_cpu_on(PSCI_FN_NATIVE(0_2, CPU_ON), cpuid, entry_point);
 223 }
 224
 225 static int __psci_migrate(u32 fn, unsigned long cpuid)
 226 {
 227         int err;
 228
 229         err = invoke_psci_fn(fn, cpuid, 0, 0);
 230         return psci_to_linux_errno(err);
 231 }
 232
 233 static int psci_0_1_migrate(unsigned long cpuid)
 234 {
 235         return __psci_migrate(psci_0_1_function_ids.migrate, cpuid);
 236 }
 237
 238 static int psci_0_2_migrate(unsigned long cpuid)
 239 {
 240         return __psci_migrate(PSCI_FN_NATIVE(0_2, MIGRATE), cpuid);
 241 }
 242
 243 static int psci_affinity_info(unsigned long target_affinity,
 244                 unsigned long lowest_affinity_level)
 245 {
 246         return invoke_psci_fn(PSCI_FN_NATIVE(0_2, AFFINITY_INFO),
 247                               target_affinity, lowest_affinity_level, 0);
 248 }
 249
 250 static int psci_migrate_info_type(void)
 251 {
 252         return invoke_psci_fn(PSCI_0_2_FN_MIGRATE_INFO_TYPE, 0, 0, 0);
 253 }
 254
 255 static unsigned long psci_migrate_info_up_cpu(void)
 256 {
 257         return invoke_psci_fn(PSCI_FN_NATIVE(0_2, MIGRATE_INFO_UP_CPU),
 258                               0, 0, 0);
 259 }
 260
 261 static void set_conduit(enum arm_smccc_conduit conduit)
 262 {
 263         switch (conduit) {
 264         case SMCCC_CONDUIT_HVC:
 265                 invoke_psci_fn = __invoke_psci_fn_hvc;
 266                 break;
 267         case SMCCC_CONDUIT_SMC:
 268                 invoke_psci_fn = __invoke_psci_fn_smc;
 269                 break;
 270         default:
 271                 WARN(1, "Unexpected PSCI conduit %d\n", conduit);
 272         }
 273
 274         psci_conduit = conduit;
 275 }
 276
 277 static int get_set_conduit_method(struct device_node *np)
 278 {
 279         const char *method;
 280
 281         pr_info("probing for conduit method from DT.\n");
 282
 283         if (of_property_read_string(np, "method", &method)) {
 284                 pr_warn("missing \"method\" property\n");
 285                 return -ENXIO;
 286         }
 287
 288         if (!strcmp("hvc", method)) {
 289                 set_conduit(SMCCC_CONDUIT_HVC);
 290         } else if (!strcmp("smc", method)) {
 291                 set_conduit(SMCCC_CONDUIT_SMC);
 292         } else {
 293                 pr_warn("invalid \"method\" property: %s\n", method);
 294                 return -EINVAL;
 295         }
 296         return 0;
 297 }
 298
 299 static void psci_sys_reset(enum reboot_mode reboot_mode, const char *cmd)
 300 {
 301         if ((reboot_mode == REBOOT_WARM || reboot_mode == REBOOT_SOFT) &&
 302             psci_system_reset2_supported) {
 303                 /*
 304                  * reset_type[31] = 0 (architectural)
 305                  * reset_type[30:0] = 0 (SYSTEM_WARM_RESET)
 306                  * cookie = 0 (ignored by the implementation)
 307                  */
 308                 invoke_psci_fn(PSCI_FN_NATIVE(1_1, SYSTEM_RESET2), 0, 0, 0);
 309         } else {
 310                 invoke_psci_fn(PSCI_0_2_FN_SYSTEM_RESET, 0, 0, 0);
 311         }
 312 }
 313
 314 static void psci_sys_poweroff(void)
 315 {
 316         invoke_psci_fn(PSCI_0_2_FN_SYSTEM_OFF, 0, 0, 0);
 317 }
 318
 319 static int __init psci_features(u32 psci_func_id)
 320 {
 321         return invoke_psci_fn(PSCI_1_0_FN_PSCI_FEATURES,
 322                               psci_func_id, 0, 0);
 323 }
 324
 325 #ifdef CONFIG_CPU_IDLE
 326 static int psci_suspend_finisher(unsigned long state)
 327 {
 328         u32 power_state = state;
 329
 330         return psci_ops.cpu_suspend(power_state, __pa_symbol(cpu_resume));
 331 }
 332
 333 int psci_cpu_suspend_enter(u32 state)
 334 {
 335         int ret;
 336
 337         if (!psci_power_state_loses_context(state))
 338                 ret = psci_ops.cpu_suspend(state, 0);
 339         else
 340                 ret = cpu_suspend(state, psci_suspend_finisher);
 341
 342         return ret;
 343 }
 344 #endif
 345
 346 static int psci_system_suspend(unsigned long unused)
 347 {
 348         return invoke_psci_fn(PSCI_FN_NATIVE(1_0, SYSTEM_SUSPEND),
 349                               __pa_symbol(cpu_resume), 0, 0);
 350 }
 351
 352 static int psci_system_suspend_enter(suspend_state_t state)
 353 {
 354         return cpu_suspend(0, psci_system_suspend);
 355 }
 356
 357 static const struct platform_suspend_ops psci_suspend_ops = {
 358         .valid          = suspend_valid_only_mem,
 359         .enter          = psci_system_suspend_enter,
 360 };
 361
 362 static void __init psci_init_system_reset2(void)
 363 {
 364         int ret;
 365
 366         ret = psci_features(PSCI_FN_NATIVE(1_1, SYSTEM_RESET2));
 367
 368         if (ret != PSCI_RET_NOT_SUPPORTED)
 369                 psci_system_reset2_supported = true;
 370 }
 371
 372 static void __init psci_init_system_suspend(void)
 373 {
 374         int ret;
 375
 376         if (!IS_ENABLED(CONFIG_SUSPEND))
 377                 return;
 378
 379         ret = psci_features(PSCI_FN_NATIVE(1_0, SYSTEM_SUSPEND));
 380
 381         if (ret != PSCI_RET_NOT_SUPPORTED)
 382                 suspend_set_ops(&psci_suspend_ops);
 383 }
 384
 385 static void __init psci_init_cpu_suspend(void)
 386 {
 387         int feature = psci_features(PSCI_FN_NATIVE(0_2, CPU_SUSPEND));
 388
 389         if (feature != PSCI_RET_NOT_SUPPORTED)
 390                 psci_cpu_suspend_feature = feature;
 391 }
 392
 393 /*
 394  * Detect the presence of a resident Trusted OS which may cause CPU_OFF to
 395  * return DENIED (which would be fatal).
 396  */
 397 static void __init psci_init_migrate(void)
 398 {
 399         unsigned long cpuid;
 400         int type, cpu = -1;
 401
 402         type = psci_ops.migrate_info_type();
 403
 404         if (type == PSCI_0_2_TOS_MP) {
 405                 pr_info("Trusted OS migration not required\n");
 406                 return;
 407         }
 408
 409         if (type == PSCI_RET_NOT_SUPPORTED) {
 410                 pr_info("MIGRATE_INFO_TYPE not supported.\n");
 411                 return;
 412         }
 413
 414         if (type != PSCI_0_2_TOS_UP_MIGRATE &&
 415             type != PSCI_0_2_TOS_UP_NO_MIGRATE) {
 416                 pr_err("MIGRATE_INFO_TYPE returned unknown type (%d)\n", type);
 417                 return;
 418         }
 419
 420         cpuid = psci_migrate_info_up_cpu();
 421         if (cpuid & ~MPIDR_HWID_BITMASK) {
 422                 pr_warn("MIGRATE_INFO_UP_CPU reported invalid physical ID (0x%lx)\n",
 423                         cpuid);
 424                 return;
 425         }
 426
 427         cpu = get_logical_index(cpuid);
 428         resident_cpu = cpu >= 0 ? cpu : -1;
 429
 430         pr_info("Trusted OS resident on physical CPU 0x%lx\n", cpuid);
 431 }
 432
 433 static void __init psci_init_smccc(void)
 434 {
 435         u32 ver = ARM_SMCCC_VERSION_1_0;
 436         int feature;
 437
 438         feature = psci_features(ARM_SMCCC_VERSION_FUNC_ID);
 439
 440         if (feature != PSCI_RET_NOT_SUPPORTED) {
 441                 u32 ret;
 442                 ret = invoke_psci_fn(ARM_SMCCC_VERSION_FUNC_ID, 0, 0, 0);
 443                 if (ret >= ARM_SMCCC_VERSION_1_1) {
 444                         arm_smccc_version_init(ret, psci_conduit);
 445                         ver = ret;
 446                 }
 447         }
 448
 449         /*
 450          * Conveniently, the SMCCC and PSCI versions are encoded the
 451          * same way. No, this isn't accidental.
 452          */
 453         pr_info("SMC Calling Convention v%d.%d\n",
 454                 PSCI_VERSION_MAJOR(ver), PSCI_VERSION_MINOR(ver));
 455
 456 }
 457
 458 static void __init psci_0_2_set_functions(void)
 459 {
 460         pr_info("Using standard PSCI v0.2 function IDs\n");
 461
 462         psci_ops = (struct psci_operations){
 463                 .get_version = psci_0_2_get_version,
 464                 .cpu_suspend = psci_0_2_cpu_suspend,
 465                 .cpu_off = psci_0_2_cpu_off,
 466                 .cpu_on = psci_0_2_cpu_on,
 467                 .migrate = psci_0_2_migrate,
 468                 .affinity_info = psci_affinity_info,
 469                 .migrate_info_type = psci_migrate_info_type,
 470         };
 471
 472         arm_pm_restart = psci_sys_reset;
 473
 474         pm_power_off = psci_sys_poweroff;
 475 }
 476
 477 /*
 478  * Probe function for PSCI firmware versions >= 0.2
 479  */
 480 static int __init psci_probe(void)
 481 {
 482         u32 ver = psci_0_2_get_version();
 483
 484         pr_info("PSCIv%d.%d detected in firmware.\n",
 485                         PSCI_VERSION_MAJOR(ver),
 486                         PSCI_VERSION_MINOR(ver));
 487
 488         if (PSCI_VERSION_MAJOR(ver) == 0 && PSCI_VERSION_MINOR(ver) < 2) {
 489                 pr_err("Conflicting PSCI version detected.\n");
 490                 return -EINVAL;
 491         }
 492
 493         psci_0_2_set_functions();
 494
 495         psci_init_migrate();
 496
 497         if (PSCI_VERSION_MAJOR(ver) >= 1) {
 498                 psci_init_smccc();
 499                 psci_init_cpu_suspend();
 500                 psci_init_system_suspend();
 501                 psci_init_system_reset2();
 502                 kvm_init_hyp_services();
 503         }
 504
 505         return 0;
 506 }
 507
 508 typedef int (*psci_initcall_t)(const struct device_node *);
 509
 510 /*
 511  * PSCI init function for PSCI versions >=0.2
 512  *
 513  * Probe based on PSCI PSCI_VERSION function
 514  */
 515 static int __init psci_0_2_init(struct device_node *np)
 516 {
 517         int err;
 518
 519         err = get_set_conduit_method(np);
 520         if (err)
 521                 return err;
 522
 523         /*
 524          * Starting with v0.2, the PSCI specification introduced a call
 525          * (PSCI_VERSION) that allows probing the firmware version, so
 526          * that PSCI function IDs and version specific initialization
 527          * can be carried out according to the specific version reported
 528          * by firmware
 529          */
 530         return psci_probe();
 531 }
 532
 533 /*
 534  * PSCI < v0.2 get PSCI Function IDs via DT.
 535  */
 536 static int __init psci_0_1_init(struct device_node *np)
 537 {
 538         u32 id;
 539         int err;
 540
 541         err = get_set_conduit_method(np);
 542         if (err)
 543                 return err;
 544
 545         pr_info("Using PSCI v0.1 Function IDs from DT\n");
 546
 547         psci_ops.get_version = psci_0_1_get_version;
 548
 549         if (!of_property_read_u32(np, "cpu_suspend", &id)) {
 550                 psci_0_1_function_ids.cpu_suspend = id;
 551                 psci_ops.cpu_suspend = psci_0_1_cpu_suspend;
 552         }
 553
 554         if (!of_property_read_u32(np, "cpu_off", &id)) {
 555                 psci_0_1_function_ids.cpu_off = id;
 556                 psci_ops.cpu_off = psci_0_1_cpu_off;
 557         }
 558
 559         if (!of_property_read_u32(np, "cpu_on", &id)) {
 560                 psci_0_1_function_ids.cpu_on = id;
 561                 psci_ops.cpu_on = psci_0_1_cpu_on;
 562         }
 563
 564         if (!of_property_read_u32(np, "migrate", &id)) {
 565                 psci_0_1_function_ids.migrate = id;
 566                 psci_ops.migrate = psci_0_1_migrate;
 567         }
 568
 569         return 0;
 570 }
 571
 572 static int __init psci_1_0_init(struct device_node *np)
 573 {
 574         int err;
 575
 576         err = psci_0_2_init(np);
 577         if (err)
 578                 return err;
 579
 580         if (psci_has_osi_support()) {
 581                 pr_info("OSI mode supported.\n");
 582
 583                 /* Default to PC mode. */
 584                 psci_set_osi_mode(false);
 585         }
 586
 587         return 0;
 588 }
 589
 590 static const struct of_device_id psci_of_match[] __initconst = {
 591         { .compatible = "arm,psci",     .data = psci_0_1_init},
 592         { .compatible = "arm,psci-0.2", .data = psci_0_2_init},
 593         { .compatible = "arm,psci-1.0", .data = psci_1_0_init},
 594         {},
 595 };
 596
 597 int __init psci_dt_init(void)
 598 {
 599         struct device_node *np;
 600         const struct of_device_id *matched_np;
 601         psci_initcall_t init_fn;
 602         int ret;
 603
 604         np = of_find_matching_node_and_match(NULL, psci_of_match, &matched_np);
 605
 606         if (!np || !of_device_is_available(np))
 607                 return -ENODEV;
 608
 609         init_fn = (psci_initcall_t)matched_np->data;
 610         ret = init_fn(np);
 611
 612         of_node_put(np);
 613         return ret;
 614 }
 615
 616 #ifdef CONFIG_ACPI
 617 /*
 618  * We use PSCI 0.2+ when ACPI is deployed on ARM64 and it's
 619  * explicitly clarified in SBBR
 620  */
 621 int __init psci_acpi_init(void)
 622 {
 623         if (!acpi_psci_present()) {
 624                 pr_info("is not implemented in ACPI.\n");
 625                 return -EOPNOTSUPP;
 626         }
 627
 628         pr_info("probing for conduit method from ACPI.\n");
 629
 630         if (acpi_psci_use_hvc())
 631                 set_conduit(SMCCC_CONDUIT_HVC);
 632         else
 633                 set_conduit(SMCCC_CONDUIT_SMC);
 634
 635         return psci_probe();
 636 }
 637 #endif