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/errno.h>
  17 #include <linux/linkage.h>
  18 #include <linux/of.h>
  19 #include <linux/pm.h>
  20 #include <linux/printk.h>
  21 #include <linux/psci.h>
  22 #include <linux/reboot.h>
  23 #include <linux/suspend.h>
  24 #include <linux/regulator/machine.h>
  25
  26 #include <uapi/linux/psci.h>
  27
  28 #include <asm/cputype.h>
  29 #include <asm/system_misc.h>
  30 #include <asm/smp_plat.h>
  31 #include <asm/suspend.h>
  32
  33 /*
  34  * While a 64-bit OS can make calls with SMC32 calling conventions, for some
  35  * calls it is necessary to use SMC64 to pass or return 64-bit values.
  36  * For such calls PSCI_FN_NATIVE(version, name) will choose the appropriate
  37  * (native-width) function ID.
  38  */
  39 #ifdef CONFIG_64BIT
  40 #define PSCI_FN_NATIVE(version, name)   PSCI_##version##_FN64_##name
  41 #else
  42 #define PSCI_FN_NATIVE(version, name)   PSCI_##version##_FN_##name
  43 #endif
  44
  45 /*
  46  * The CPU any Trusted OS is resident on. The trusted OS may reject CPU_OFF
  47  * calls to its resident CPU, so we must avoid issuing those. We never migrate
  48  * a Trusted OS even if it claims to be capable of migration -- doing so will
  49  * require cooperation with a Trusted OS driver.
  50  */
  51 static int resident_cpu = -1;
  52
  53 bool psci_tos_resident_on(int cpu)
  54 {
  55         return cpu == resident_cpu;
  56 }
  57
  58 struct psci_operations psci_ops;
  59
  60 typedef unsigned long (psci_fn)(unsigned long, unsigned long,
  61                                 unsigned long, unsigned long);
  62 asmlinkage psci_fn __invoke_psci_fn_hvc;
  63 asmlinkage psci_fn __invoke_psci_fn_smc;
  64 static psci_fn *invoke_psci_fn;
  65
  66 enum psci_function {
  67         PSCI_FN_CPU_SUSPEND,
  68         PSCI_FN_CPU_ON,
  69         PSCI_FN_CPU_OFF,
  70         PSCI_FN_MIGRATE,
  71         PSCI_FN_MAX,
  72 };
  73
  74 static u32 psci_function_id[PSCI_FN_MAX];
  75
  76 #define PSCI_0_2_POWER_STATE_MASK               \
  77                                 (PSCI_0_2_POWER_STATE_ID_MASK | \
  78                                 PSCI_0_2_POWER_STATE_TYPE_MASK | \
  79                                 PSCI_0_2_POWER_STATE_AFFL_MASK)
  80
  81 #define PSCI_1_0_EXT_POWER_STATE_MASK           \
  82                                 (PSCI_1_0_EXT_POWER_STATE_ID_MASK | \
  83                                 PSCI_1_0_EXT_POWER_STATE_TYPE_MASK)
  84
  85 static u32 psci_cpu_suspend_feature;
  86
  87 static inline bool psci_has_ext_power_state(void)
  88 {
  89         return psci_cpu_suspend_feature &
  90                                 PSCI_1_0_FEATURES_CPU_SUSPEND_PF_MASK;
  91 }
  92
  93 bool psci_power_state_loses_context(u32 state)
  94 {
  95         const u32 mask = psci_has_ext_power_state() ?
  96                                         PSCI_1_0_EXT_POWER_STATE_TYPE_MASK :
  97                                         PSCI_0_2_POWER_STATE_TYPE_MASK;
  98
  99         return state & mask;
 100 }
 101
 102 bool psci_power_state_is_valid(u32 state)
 103 {
 104         const u32 valid_mask = psci_has_ext_power_state() ?
 105                                PSCI_1_0_EXT_POWER_STATE_MASK :
 106                                PSCI_0_2_POWER_STATE_MASK;
 107
 108         return !(state & ~valid_mask);
 109 }
 110
 111 static int psci_to_linux_errno(int errno)
 112 {
 113         switch (errno) {
 114         case PSCI_RET_SUCCESS:
 115                 return 0;
 116         case PSCI_RET_NOT_SUPPORTED:
 117                 return -EOPNOTSUPP;
 118         case PSCI_RET_INVALID_PARAMS:
 119         case PSCI_RET_INVALID_ADDRESS:
 120                 return -EINVAL;
 121         case PSCI_RET_DENIED:
 122                 return -EPERM;
 123         };
 124
 125         return -EINVAL;
 126 }
 127
 128 static u32 psci_get_version(void)
 129 {
 130         return invoke_psci_fn(PSCI_0_2_FN_PSCI_VERSION, 0, 0, 0);
 131 }
 132
 133 static int psci_cpu_suspend(u32 state, unsigned long entry_point)
 134 {
 135         int err;
 136         u32 fn;
 137
 138         fn = psci_function_id[PSCI_FN_CPU_SUSPEND];
 139         err = invoke_psci_fn(fn, state, entry_point, 0);
 140         return psci_to_linux_errno(err);
 141 }
 142
 143 static int psci_cpu_off(u32 state)
 144 {
 145         int err;
 146         u32 fn;
 147
 148         fn = psci_function_id[PSCI_FN_CPU_OFF];
 149         err = invoke_psci_fn(fn, state, 0, 0);
 150         return psci_to_linux_errno(err);
 151 }
 152
 153 static int psci_cpu_on(unsigned long cpuid, unsigned long entry_point)
 154 {
 155         int err;
 156         u32 fn;
 157
 158         fn = psci_function_id[PSCI_FN_CPU_ON];
 159         err = invoke_psci_fn(fn, cpuid, entry_point, 0);
 160         return psci_to_linux_errno(err);
 161 }
 162
 163 static int psci_migrate(unsigned long cpuid)
 164 {
 165         int err;
 166         u32 fn;
 167
 168         fn = psci_function_id[PSCI_FN_MIGRATE];
 169         err = invoke_psci_fn(fn, cpuid, 0, 0);
 170         return psci_to_linux_errno(err);
 171 }
 172
 173 static int psci_affinity_info(unsigned long target_affinity,
 174                 unsigned long lowest_affinity_level)
 175 {
 176         return invoke_psci_fn(PSCI_FN_NATIVE(0_2, AFFINITY_INFO),
 177                               target_affinity, lowest_affinity_level, 0);
 178 }
 179
 180 static int psci_migrate_info_type(void)
 181 {
 182         return invoke_psci_fn(PSCI_0_2_FN_MIGRATE_INFO_TYPE, 0, 0, 0);
 183 }
 184
 185 static unsigned long psci_migrate_info_up_cpu(void)
 186 {
 187         return invoke_psci_fn(PSCI_FN_NATIVE(0_2, MIGRATE_INFO_UP_CPU),
 188                               0, 0, 0);
 189 }
 190
 191 static int get_set_conduit_method(struct device_node *np)
 192 {
 193         const char *method;
 194
 195         pr_info("probing for conduit method from DT.\n");
 196
 197         if (of_property_read_string(np, "method", &method)) {
 198                 pr_warn("missing \"method\" property\n");
 199                 return -ENXIO;
 200         }
 201
 202         if (!strcmp("hvc", method)) {
 203                 invoke_psci_fn = __invoke_psci_fn_hvc;
 204         } else if (!strcmp("smc", method)) {
 205                 invoke_psci_fn = __invoke_psci_fn_smc;
 206         } else {
 207                 pr_warn("invalid \"method\" property: %s\n", method);
 208                 return -EINVAL;
 209         }
 210         return 0;
 211 }
 212
 213 static void psci_sys_reset(enum reboot_mode reboot_mode, const char *cmd)
 214 {
 215         invoke_psci_fn(PSCI_0_2_FN_SYSTEM_RESET, 0, 0, 0);
 216 }
 217
 218 static void psci_sys_poweroff(void)
 219 {
 220         invoke_psci_fn(PSCI_0_2_FN_SYSTEM_OFF, 0, 0, 0);
 221 }
 222
 223 static int __init psci_features(u32 psci_func_id)
 224 {
 225         return invoke_psci_fn(PSCI_1_0_FN_PSCI_FEATURES,
 226                               psci_func_id, 0, 0);
 227 }
 228
 229 static int psci_system_suspend(unsigned long unused)
 230 {
 231         return invoke_psci_fn(PSCI_FN_NATIVE(1_0, SYSTEM_SUSPEND),
 232                               virt_to_phys(cpu_resume), 0, 0);
 233 }
 234
 235 static int psci_system_suspend_enter(suspend_state_t state)
 236 {
 237         return cpu_suspend(0, psci_system_suspend);
 238 }
 239
 240 static int psci_system_suspend_prepare(void)
 241 {
 242         return regulator_suspend_prepare(PM_SUSPEND_MEM);
 243 }
 244
 245 static void psci_system_suspend_finish(void)
 246 {
 247         int ret;
 248
 249         ret = regulator_suspend_finish();
 250         if (ret < 0)
 251                 pr_warn("regulator_suspend_finish failed (%d)\n", ret);
 252 }
 253
 254 static const struct platform_suspend_ops psci_suspend_ops = {
 255         .valid          = suspend_valid_only_mem,
 256         .enter          = psci_system_suspend_enter,
 257         .prepare        = psci_system_suspend_prepare,
 258         .finish         = psci_system_suspend_finish,
 259 };
 260
 261 static void __init psci_init_system_suspend(void)
 262 {
 263         int ret;
 264
 265         if (!IS_ENABLED(CONFIG_SUSPEND))
 266                 return;
 267
 268         ret = psci_features(PSCI_FN_NATIVE(1_0, SYSTEM_SUSPEND));
 269
 270         if (ret != PSCI_RET_NOT_SUPPORTED)
 271                 suspend_set_ops(&psci_suspend_ops);
 272 }
 273
 274 static void __init psci_init_cpu_suspend(void)
 275 {
 276         int feature = psci_features(psci_function_id[PSCI_FN_CPU_SUSPEND]);
 277
 278         if (feature != PSCI_RET_NOT_SUPPORTED)
 279                 psci_cpu_suspend_feature = feature;
 280 }
 281
 282 /*
 283  * Detect the presence of a resident Trusted OS which may cause CPU_OFF to
 284  * return DENIED (which would be fatal).
 285  */
 286 static void __init psci_init_migrate(void)
 287 {
 288         unsigned long cpuid;
 289         int type, cpu = -1;
 290
 291         type = psci_ops.migrate_info_type();
 292
 293         if (type == PSCI_0_2_TOS_MP) {
 294                 pr_info("Trusted OS migration not required\n");
 295                 return;
 296         }
 297
 298         if (type == PSCI_RET_NOT_SUPPORTED) {
 299                 pr_info("MIGRATE_INFO_TYPE not supported.\n");
 300                 return;
 301         }
 302
 303         if (type != PSCI_0_2_TOS_UP_MIGRATE &&
 304             type != PSCI_0_2_TOS_UP_NO_MIGRATE) {
 305                 pr_err("MIGRATE_INFO_TYPE returned unknown type (%d)\n", type);
 306                 return;
 307         }
 308
 309         cpuid = psci_migrate_info_up_cpu();
 310         if (cpuid & ~MPIDR_HWID_BITMASK) {
 311                 pr_warn("MIGRATE_INFO_UP_CPU reported invalid physical ID (0x%lx)\n",
 312                         cpuid);
 313                 return;
 314         }
 315
 316         cpu = get_logical_index(cpuid);
 317         resident_cpu = cpu >= 0 ? cpu : -1;
 318
 319         pr_info("Trusted OS resident on physical CPU 0x%lx\n", cpuid);
 320 }
 321
 322 static void __init psci_0_2_set_functions(void)
 323 {
 324         pr_info("Using standard PSCI v0.2 function IDs\n");
 325         psci_function_id[PSCI_FN_CPU_SUSPEND] =
 326                                         PSCI_FN_NATIVE(0_2, CPU_SUSPEND);
 327         psci_ops.cpu_suspend = psci_cpu_suspend;
 328
 329         psci_function_id[PSCI_FN_CPU_OFF] = PSCI_0_2_FN_CPU_OFF;
 330         psci_ops.cpu_off = psci_cpu_off;
 331
 332         psci_function_id[PSCI_FN_CPU_ON] = PSCI_FN_NATIVE(0_2, CPU_ON);
 333         psci_ops.cpu_on = psci_cpu_on;
 334
 335         psci_function_id[PSCI_FN_MIGRATE] = PSCI_FN_NATIVE(0_2, MIGRATE);
 336         psci_ops.migrate = psci_migrate;
 337
 338         psci_ops.affinity_info = psci_affinity_info;
 339
 340         psci_ops.migrate_info_type = psci_migrate_info_type;
 341
 342         arm_pm_restart = psci_sys_reset;
 343
 344         pm_power_off = psci_sys_poweroff;
 345 }
 346
 347 /*
 348  * Probe function for PSCI firmware versions >= 0.2
 349  */
 350 static int __init psci_probe(void)
 351 {
 352         u32 ver = psci_get_version();
 353
 354         pr_info("PSCIv%d.%d detected in firmware.\n",
 355                         PSCI_VERSION_MAJOR(ver),
 356                         PSCI_VERSION_MINOR(ver));
 357
 358         if (PSCI_VERSION_MAJOR(ver) == 0 && PSCI_VERSION_MINOR(ver) < 2) {
 359                 pr_err("Conflicting PSCI version detected.\n");
 360                 return -EINVAL;
 361         }
 362
 363         psci_0_2_set_functions();
 364
 365         psci_init_migrate();
 366
 367         if (PSCI_VERSION_MAJOR(ver) >= 1) {
 368                 psci_init_cpu_suspend();
 369                 psci_init_system_suspend();
 370         }
 371
 372         return 0;
 373 }
 374
 375 typedef int (*psci_initcall_t)(const struct device_node *);
 376
 377 /*
 378  * PSCI init function for PSCI versions >=0.2
 379  *
 380  * Probe based on PSCI PSCI_VERSION function
 381  */
 382 static int __init psci_0_2_init(struct device_node *np)
 383 {
 384         int err;
 385
 386         err = get_set_conduit_method(np);
 387
 388         if (err)
 389                 goto out_put_node;
 390         /*
 391          * Starting with v0.2, the PSCI specification introduced a call
 392          * (PSCI_VERSION) that allows probing the firmware version, so
 393          * that PSCI function IDs and version specific initialization
 394          * can be carried out according to the specific version reported
 395          * by firmware
 396          */
 397         err = psci_probe();
 398
 399 out_put_node:
 400         of_node_put(np);
 401         return err;
 402 }
 403
 404 /*
 405  * PSCI < v0.2 get PSCI Function IDs via DT.
 406  */
 407 static int __init psci_0_1_init(struct device_node *np)
 408 {
 409         u32 id;
 410         int err;
 411
 412         err = get_set_conduit_method(np);
 413
 414         if (err)
 415                 goto out_put_node;
 416
 417         pr_info("Using PSCI v0.1 Function IDs from DT\n");
 418
 419         if (!of_property_read_u32(np, "cpu_suspend", &id)) {
 420                 psci_function_id[PSCI_FN_CPU_SUSPEND] = id;
 421                 psci_ops.cpu_suspend = psci_cpu_suspend;
 422         }
 423
 424         if (!of_property_read_u32(np, "cpu_off", &id)) {
 425                 psci_function_id[PSCI_FN_CPU_OFF] = id;
 426                 psci_ops.cpu_off = psci_cpu_off;
 427         }
 428
 429         if (!of_property_read_u32(np, "cpu_on", &id)) {
 430                 psci_function_id[PSCI_FN_CPU_ON] = id;
 431                 psci_ops.cpu_on = psci_cpu_on;
 432         }
 433
 434         if (!of_property_read_u32(np, "migrate", &id)) {
 435                 psci_function_id[PSCI_FN_MIGRATE] = id;
 436                 psci_ops.migrate = psci_migrate;
 437         }
 438
 439 out_put_node:
 440         of_node_put(np);
 441         return err;
 442 }
 443
 444 static const struct of_device_id const psci_of_match[] __initconst = {
 445         { .compatible = "arm,psci",     .data = psci_0_1_init},
 446         { .compatible = "arm,psci-0.2", .data = psci_0_2_init},
 447         { .compatible = "arm,psci-1.0", .data = psci_0_2_init},
 448         {},
 449 };
 450
 451 int __init psci_dt_init(void)
 452 {
 453         struct device_node *np;
 454         const struct of_device_id *matched_np;
 455         psci_initcall_t init_fn;
 456
 457         np = of_find_matching_node_and_match(NULL, psci_of_match, &matched_np);
 458
 459         if (!np)
 460                 return -ENODEV;
 461
 462         init_fn = (psci_initcall_t)matched_np->data;
 463         return init_fn(np);
 464 }
 465
 466 #ifdef CONFIG_ACPI
 467 /*
 468  * We use PSCI 0.2+ when ACPI is deployed on ARM64 and it's
 469  * explicitly clarified in SBBR
 470  */
 471 int __init psci_acpi_init(void)
 472 {
 473         if (!acpi_psci_present()) {
 474                 pr_info("is not implemented in ACPI.\n");
 475                 return -EOPNOTSUPP;
 476         }
 477
 478         pr_info("probing for conduit method from ACPI.\n");
 479
 480         if (acpi_psci_use_hvc())
 481                 invoke_psci_fn = __invoke_psci_fn_hvc;
 482         else
 483                 invoke_psci_fn = __invoke_psci_fn_smc;
 484
 485         return psci_probe();
 486 }
 487 #endif