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 bool psci_power_state_loses_context(u32 state)
  79 {
  80         return state & PSCI_0_2_POWER_STATE_TYPE_MASK;
  81 }
  82
  83 bool psci_power_state_is_valid(u32 state)
  84 {
  85         return !(state & ~PSCI_0_2_POWER_STATE_MASK);
  86 }
  87
  88 static int psci_to_linux_errno(int errno)
  89 {
  90         switch (errno) {
  91         case PSCI_RET_SUCCESS:
  92                 return 0;
  93         case PSCI_RET_NOT_SUPPORTED:
  94                 return -EOPNOTSUPP;
  95         case PSCI_RET_INVALID_PARAMS:
  96         case PSCI_RET_INVALID_ADDRESS:
  97                 return -EINVAL;
  98         case PSCI_RET_DENIED:
  99                 return -EPERM;
 100         };
 101
 102         return -EINVAL;
 103 }
 104
 105 static u32 psci_get_version(void)
 106 {
 107         return invoke_psci_fn(PSCI_0_2_FN_PSCI_VERSION, 0, 0, 0);
 108 }
 109
 110 static int psci_cpu_suspend(u32 state, unsigned long entry_point)
 111 {
 112         int err;
 113         u32 fn;
 114
 115         fn = psci_function_id[PSCI_FN_CPU_SUSPEND];
 116         err = invoke_psci_fn(fn, state, entry_point, 0);
 117         return psci_to_linux_errno(err);
 118 }
 119
 120 static int psci_cpu_off(u32 state)
 121 {
 122         int err;
 123         u32 fn;
 124
 125         fn = psci_function_id[PSCI_FN_CPU_OFF];
 126         err = invoke_psci_fn(fn, state, 0, 0);
 127         return psci_to_linux_errno(err);
 128 }
 129
 130 static int psci_cpu_on(unsigned long cpuid, unsigned long entry_point)
 131 {
 132         int err;
 133         u32 fn;
 134
 135         fn = psci_function_id[PSCI_FN_CPU_ON];
 136         err = invoke_psci_fn(fn, cpuid, entry_point, 0);
 137         return psci_to_linux_errno(err);
 138 }
 139
 140 static int psci_migrate(unsigned long cpuid)
 141 {
 142         int err;
 143         u32 fn;
 144
 145         fn = psci_function_id[PSCI_FN_MIGRATE];
 146         err = invoke_psci_fn(fn, cpuid, 0, 0);
 147         return psci_to_linux_errno(err);
 148 }
 149
 150 static int psci_affinity_info(unsigned long target_affinity,
 151                 unsigned long lowest_affinity_level)
 152 {
 153         return invoke_psci_fn(PSCI_0_2_FN_NATIVE(AFFINITY_INFO),
 154                               target_affinity, lowest_affinity_level, 0);
 155 }
 156
 157 static int psci_migrate_info_type(void)
 158 {
 159         return invoke_psci_fn(PSCI_0_2_FN_MIGRATE_INFO_TYPE, 0, 0, 0);
 160 }
 161
 162 static unsigned long psci_migrate_info_up_cpu(void)
 163 {
 164         return invoke_psci_fn(PSCI_0_2_FN_NATIVE(MIGRATE_INFO_UP_CPU),
 165                               0, 0, 0);
 166 }
 167
 168 static int get_set_conduit_method(struct device_node *np)
 169 {
 170         const char *method;
 171
 172         pr_info("probing for conduit method from DT.\n");
 173
 174         if (of_property_read_string(np, "method", &method)) {
 175                 pr_warn("missing \"method\" property\n");
 176                 return -ENXIO;
 177         }
 178
 179         if (!strcmp("hvc", method)) {
 180                 invoke_psci_fn = __invoke_psci_fn_hvc;
 181         } else if (!strcmp("smc", method)) {
 182                 invoke_psci_fn = __invoke_psci_fn_smc;
 183         } else {
 184                 pr_warn("invalid \"method\" property: %s\n", method);
 185                 return -EINVAL;
 186         }
 187         return 0;
 188 }
 189
 190 static void psci_sys_reset(enum reboot_mode reboot_mode, const char *cmd)
 191 {
 192         invoke_psci_fn(PSCI_0_2_FN_SYSTEM_RESET, 0, 0, 0);
 193 }
 194
 195 static void psci_sys_poweroff(void)
 196 {
 197         invoke_psci_fn(PSCI_0_2_FN_SYSTEM_OFF, 0, 0, 0);
 198 }
 199
 200 /*
 201  * Detect the presence of a resident Trusted OS which may cause CPU_OFF to
 202  * return DENIED (which would be fatal).
 203  */
 204 static void __init psci_init_migrate(void)
 205 {
 206         unsigned long cpuid;
 207         int type, cpu = -1;
 208
 209         type = psci_ops.migrate_info_type();
 210
 211         if (type == PSCI_0_2_TOS_MP) {
 212                 pr_info("Trusted OS migration not required\n");
 213                 return;
 214         }
 215
 216         if (type == PSCI_RET_NOT_SUPPORTED) {
 217                 pr_info("MIGRATE_INFO_TYPE not supported.\n");
 218                 return;
 219         }
 220
 221         if (type != PSCI_0_2_TOS_UP_MIGRATE &&
 222             type != PSCI_0_2_TOS_UP_NO_MIGRATE) {
 223                 pr_err("MIGRATE_INFO_TYPE returned unknown type (%d)\n", type);
 224                 return;
 225         }
 226
 227         cpuid = psci_migrate_info_up_cpu();
 228         if (cpuid & ~MPIDR_HWID_BITMASK) {
 229                 pr_warn("MIGRATE_INFO_UP_CPU reported invalid physical ID (0x%lx)\n",
 230                         cpuid);
 231                 return;
 232         }
 233
 234         cpu = get_logical_index(cpuid);
 235         resident_cpu = cpu >= 0 ? cpu : -1;
 236
 237         pr_info("Trusted OS resident on physical CPU 0x%lx\n", cpuid);
 238 }
 239
 240 static void __init psci_0_2_set_functions(void)
 241 {
 242         pr_info("Using standard PSCI v0.2 function IDs\n");
 243         psci_function_id[PSCI_FN_CPU_SUSPEND] = PSCI_0_2_FN_NATIVE(CPU_SUSPEND);
 244         psci_ops.cpu_suspend = psci_cpu_suspend;
 245
 246         psci_function_id[PSCI_FN_CPU_OFF] = PSCI_0_2_FN_CPU_OFF;
 247         psci_ops.cpu_off = psci_cpu_off;
 248
 249         psci_function_id[PSCI_FN_CPU_ON] = PSCI_0_2_FN_NATIVE(CPU_ON);
 250         psci_ops.cpu_on = psci_cpu_on;
 251
 252         psci_function_id[PSCI_FN_MIGRATE] = PSCI_0_2_FN_NATIVE(MIGRATE);
 253         psci_ops.migrate = psci_migrate;
 254
 255         psci_ops.affinity_info = psci_affinity_info;
 256
 257         psci_ops.migrate_info_type = psci_migrate_info_type;
 258
 259         arm_pm_restart = psci_sys_reset;
 260
 261         pm_power_off = psci_sys_poweroff;
 262 }
 263
 264 /*
 265  * Probe function for PSCI firmware versions >= 0.2
 266  */
 267 static int __init psci_probe(void)
 268 {
 269         u32 ver = psci_get_version();
 270
 271         pr_info("PSCIv%d.%d detected in firmware.\n",
 272                         PSCI_VERSION_MAJOR(ver),
 273                         PSCI_VERSION_MINOR(ver));
 274
 275         if (PSCI_VERSION_MAJOR(ver) == 0 && PSCI_VERSION_MINOR(ver) < 2) {
 276                 pr_err("Conflicting PSCI version detected.\n");
 277                 return -EINVAL;
 278         }
 279
 280         psci_0_2_set_functions();
 281
 282         psci_init_migrate();
 283
 284         return 0;
 285 }
 286
 287 typedef int (*psci_initcall_t)(const struct device_node *);
 288
 289 /*
 290  * PSCI init function for PSCI versions >=0.2
 291  *
 292  * Probe based on PSCI PSCI_VERSION function
 293  */
 294 static int __init psci_0_2_init(struct device_node *np)
 295 {
 296         int err;
 297
 298         err = get_set_conduit_method(np);
 299
 300         if (err)
 301                 goto out_put_node;
 302         /*
 303          * Starting with v0.2, the PSCI specification introduced a call
 304          * (PSCI_VERSION) that allows probing the firmware version, so
 305          * that PSCI function IDs and version specific initialization
 306          * can be carried out according to the specific version reported
 307          * by firmware
 308          */
 309         err = psci_probe();
 310
 311 out_put_node:
 312         of_node_put(np);
 313         return err;
 314 }
 315
 316 /*
 317  * PSCI < v0.2 get PSCI Function IDs via DT.
 318  */
 319 static int __init psci_0_1_init(struct device_node *np)
 320 {
 321         u32 id;
 322         int err;
 323
 324         err = get_set_conduit_method(np);
 325
 326         if (err)
 327                 goto out_put_node;
 328
 329         pr_info("Using PSCI v0.1 Function IDs from DT\n");
 330
 331         if (!of_property_read_u32(np, "cpu_suspend", &id)) {
 332                 psci_function_id[PSCI_FN_CPU_SUSPEND] = id;
 333                 psci_ops.cpu_suspend = psci_cpu_suspend;
 334         }
 335
 336         if (!of_property_read_u32(np, "cpu_off", &id)) {
 337                 psci_function_id[PSCI_FN_CPU_OFF] = id;
 338                 psci_ops.cpu_off = psci_cpu_off;
 339         }
 340
 341         if (!of_property_read_u32(np, "cpu_on", &id)) {
 342                 psci_function_id[PSCI_FN_CPU_ON] = id;
 343                 psci_ops.cpu_on = psci_cpu_on;
 344         }
 345
 346         if (!of_property_read_u32(np, "migrate", &id)) {
 347                 psci_function_id[PSCI_FN_MIGRATE] = id;
 348                 psci_ops.migrate = psci_migrate;
 349         }
 350
 351 out_put_node:
 352         of_node_put(np);
 353         return err;
 354 }
 355
 356 static const struct of_device_id const psci_of_match[] __initconst = {
 357         { .compatible = "arm,psci",     .data = psci_0_1_init},
 358         { .compatible = "arm,psci-0.2", .data = psci_0_2_init},
 359         {},
 360 };
 361
 362 int __init psci_dt_init(void)
 363 {
 364         struct device_node *np;
 365         const struct of_device_id *matched_np;
 366         psci_initcall_t init_fn;
 367
 368         np = of_find_matching_node_and_match(NULL, psci_of_match, &matched_np);
 369
 370         if (!np)
 371                 return -ENODEV;
 372
 373         init_fn = (psci_initcall_t)matched_np->data;
 374         return init_fn(np);
 375 }
 376
 377 #ifdef CONFIG_ACPI
 378 /*
 379  * We use PSCI 0.2+ when ACPI is deployed on ARM64 and it's
 380  * explicitly clarified in SBBR
 381  */
 382 int __init psci_acpi_init(void)
 383 {
 384         if (!acpi_psci_present()) {
 385                 pr_info("is not implemented in ACPI.\n");
 386                 return -EOPNOTSUPP;
 387         }
 388
 389         pr_info("probing for conduit method from ACPI.\n");
 390
 391         if (acpi_psci_use_hvc())
 392                 invoke_psci_fn = __invoke_psci_fn_hvc;
 393         else
 394                 invoke_psci_fn = __invoke_psci_fn_smc;
 395
 396         return psci_probe();
 397 }
 398 #endif