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