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