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