drivers/firmware/psci.c

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