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.
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.
11 * Copyright (C) 2015 ARM Limited
14 #define pr_fmt(fmt) "psci: " fmt
16 #include <linux/arm-smccc.h>
17 #include <linux/cpuidle.h>
18 #include <linux/errno.h>
19 #include <linux/linkage.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>
29 #include <uapi/linux/psci.h>
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>
38 * While a 64-bit OS can make calls with SMC32 calling conventions, for some
39 * calls it is necessary to use SMC64 to pass or return 64-bit values.
40 * For such calls PSCI_FN_NATIVE(version, name) will choose the appropriate
41 * (native-width) function ID.
44 #define PSCI_FN_NATIVE(version, name) PSCI_##version##_FN64_##name
46 #define PSCI_FN_NATIVE(version, name) PSCI_##version##_FN_##name
50 * The CPU any Trusted OS is resident on. The trusted OS may reject CPU_OFF
51 * calls to its resident CPU, so we must avoid issuing those. We never migrate
52 * a Trusted OS even if it claims to be capable of migration -- doing so will
53 * require cooperation with a Trusted OS driver.
55 static int resident_cpu = -1;
57 bool psci_tos_resident_on(int cpu)
59 return cpu == resident_cpu;
62 struct psci_operations psci_ops;
64 typedef unsigned long (psci_fn)(unsigned long, unsigned long,
65 unsigned long, unsigned long);
66 static psci_fn *invoke_psci_fn;
76 static u32 psci_function_id[PSCI_FN_MAX];
78 #define PSCI_0_2_POWER_STATE_MASK \
79 (PSCI_0_2_POWER_STATE_ID_MASK | \
80 PSCI_0_2_POWER_STATE_TYPE_MASK | \
81 PSCI_0_2_POWER_STATE_AFFL_MASK)
83 #define PSCI_1_0_EXT_POWER_STATE_MASK \
84 (PSCI_1_0_EXT_POWER_STATE_ID_MASK | \
85 PSCI_1_0_EXT_POWER_STATE_TYPE_MASK)
87 static u32 psci_cpu_suspend_feature;
89 static inline bool psci_has_ext_power_state(void)
91 return psci_cpu_suspend_feature &
92 PSCI_1_0_FEATURES_CPU_SUSPEND_PF_MASK;
95 bool psci_power_state_loses_context(u32 state)
97 const u32 mask = psci_has_ext_power_state() ?
98 PSCI_1_0_EXT_POWER_STATE_TYPE_MASK :
99 PSCI_0_2_POWER_STATE_TYPE_MASK;
104 bool psci_power_state_is_valid(u32 state)
106 const u32 valid_mask = psci_has_ext_power_state() ?
107 PSCI_1_0_EXT_POWER_STATE_MASK :
108 PSCI_0_2_POWER_STATE_MASK;
110 return !(state & ~valid_mask);
113 static unsigned long __invoke_psci_fn_hvc(unsigned long function_id,
114 unsigned long arg0, unsigned long arg1,
117 struct arm_smccc_res res;
119 arm_smccc_hvc(function_id, arg0, arg1, arg2, 0, 0, 0, 0, &res);
123 static unsigned long __invoke_psci_fn_smc(unsigned long function_id,
124 unsigned long arg0, unsigned long arg1,
127 struct arm_smccc_res res;
129 arm_smccc_smc(function_id, arg0, arg1, arg2, 0, 0, 0, 0, &res);
133 static int psci_to_linux_errno(int errno)
136 case PSCI_RET_SUCCESS:
138 case PSCI_RET_NOT_SUPPORTED:
140 case PSCI_RET_INVALID_PARAMS:
141 case PSCI_RET_INVALID_ADDRESS:
143 case PSCI_RET_DENIED:
150 static u32 psci_get_version(void)
152 return invoke_psci_fn(PSCI_0_2_FN_PSCI_VERSION, 0, 0, 0);
155 static int psci_cpu_suspend(u32 state, unsigned long entry_point)
160 fn = psci_function_id[PSCI_FN_CPU_SUSPEND];
161 err = invoke_psci_fn(fn, state, entry_point, 0);
162 return psci_to_linux_errno(err);
165 static int psci_cpu_off(u32 state)
170 fn = psci_function_id[PSCI_FN_CPU_OFF];
171 err = invoke_psci_fn(fn, state, 0, 0);
172 return psci_to_linux_errno(err);
175 static int psci_cpu_on(unsigned long cpuid, unsigned long entry_point)
180 fn = psci_function_id[PSCI_FN_CPU_ON];
181 err = invoke_psci_fn(fn, cpuid, entry_point, 0);
182 return psci_to_linux_errno(err);
185 static int psci_migrate(unsigned long cpuid)
190 fn = psci_function_id[PSCI_FN_MIGRATE];
191 err = invoke_psci_fn(fn, cpuid, 0, 0);
192 return psci_to_linux_errno(err);
195 static int psci_affinity_info(unsigned long target_affinity,
196 unsigned long lowest_affinity_level)
198 return invoke_psci_fn(PSCI_FN_NATIVE(0_2, AFFINITY_INFO),
199 target_affinity, lowest_affinity_level, 0);
202 static int psci_migrate_info_type(void)
204 return invoke_psci_fn(PSCI_0_2_FN_MIGRATE_INFO_TYPE, 0, 0, 0);
207 static unsigned long psci_migrate_info_up_cpu(void)
209 return invoke_psci_fn(PSCI_FN_NATIVE(0_2, MIGRATE_INFO_UP_CPU),
213 static int get_set_conduit_method(struct device_node *np)
217 pr_info("probing for conduit method from DT.\n");
219 if (of_property_read_string(np, "method", &method)) {
220 pr_warn("missing \"method\" property\n");
224 if (!strcmp("hvc", method)) {
225 invoke_psci_fn = __invoke_psci_fn_hvc;
226 } else if (!strcmp("smc", method)) {
227 invoke_psci_fn = __invoke_psci_fn_smc;
229 pr_warn("invalid \"method\" property: %s\n", method);
235 static void psci_sys_reset(enum reboot_mode reboot_mode, const char *cmd)
237 invoke_psci_fn(PSCI_0_2_FN_SYSTEM_RESET, 0, 0, 0);
240 static void psci_sys_poweroff(void)
242 invoke_psci_fn(PSCI_0_2_FN_SYSTEM_OFF, 0, 0, 0);
245 static int __init psci_features(u32 psci_func_id)
247 return invoke_psci_fn(PSCI_1_0_FN_PSCI_FEATURES,
251 #ifdef CONFIG_CPU_IDLE
252 static DEFINE_PER_CPU_READ_MOSTLY(u32 *, psci_power_state);
254 static int psci_dt_cpu_init_idle(struct device_node *cpu_node, int cpu)
256 int i, ret, count = 0;
258 struct device_node *state_node;
261 * If the PSCI cpu_suspend function hook has not been initialized
262 * idle states must not be enabled, so bail out
264 if (!psci_ops.cpu_suspend)
267 /* Count idle states */
268 while ((state_node = of_parse_phandle(cpu_node, "cpu-idle-states",
271 of_node_put(state_node);
277 psci_states = kcalloc(count, sizeof(*psci_states), GFP_KERNEL);
281 for (i = 0; i < count; i++) {
284 state_node = of_parse_phandle(cpu_node, "cpu-idle-states", i);
286 ret = of_property_read_u32(state_node,
287 "arm,psci-suspend-param",
290 pr_warn(" * %s missing arm,psci-suspend-param property\n",
291 state_node->full_name);
292 of_node_put(state_node);
296 of_node_put(state_node);
297 pr_debug("psci-power-state %#x index %d\n", state, i);
298 if (!psci_power_state_is_valid(state)) {
299 pr_warn("Invalid PSCI power state %#x\n", state);
303 psci_states[i] = state;
305 /* Idle states parsed correctly, initialize per-cpu pointer */
306 per_cpu(psci_power_state, cpu) = psci_states;
314 int psci_cpu_init_idle(unsigned int cpu)
316 struct device_node *cpu_node;
319 cpu_node = of_get_cpu_node(cpu, NULL);
323 ret = psci_dt_cpu_init_idle(cpu_node, cpu);
325 of_node_put(cpu_node);
330 static int psci_suspend_finisher(unsigned long index)
332 u32 *state = __this_cpu_read(psci_power_state);
334 return psci_ops.cpu_suspend(state[index - 1],
335 virt_to_phys(cpu_resume));
338 int psci_cpu_suspend_enter(unsigned long index)
341 u32 *state = __this_cpu_read(psci_power_state);
343 * idle state index 0 corresponds to wfi, should never be called
344 * from the cpu_suspend operations
346 if (WARN_ON_ONCE(!index))
349 if (!psci_power_state_loses_context(state[index - 1]))
350 ret = psci_ops.cpu_suspend(state[index - 1], 0);
352 ret = cpu_suspend(index, psci_suspend_finisher);
357 /* ARM specific CPU idle operations */
359 static struct cpuidle_ops psci_cpuidle_ops __initdata = {
360 .suspend = psci_cpu_suspend_enter,
361 .init = psci_dt_cpu_init_idle,
364 CPUIDLE_METHOD_OF_DECLARE(psci, "arm,psci", &psci_cpuidle_ops);
368 static int psci_system_suspend(unsigned long unused)
370 return invoke_psci_fn(PSCI_FN_NATIVE(1_0, SYSTEM_SUSPEND),
371 virt_to_phys(cpu_resume), 0, 0);
374 static int psci_system_suspend_enter(suspend_state_t state)
376 return cpu_suspend(0, psci_system_suspend);
379 static int psci_system_suspend_prepare(void)
381 return regulator_suspend_prepare(PM_SUSPEND_MEM);
384 static void psci_system_suspend_finish(void)
388 ret = regulator_suspend_finish();
390 pr_warn("regulator_suspend_finish failed (%d)\n", ret);
393 static const struct platform_suspend_ops psci_suspend_ops = {
394 .valid = suspend_valid_only_mem,
395 .enter = psci_system_suspend_enter,
396 .prepare = psci_system_suspend_prepare,
397 .finish = psci_system_suspend_finish,
400 static void __init psci_init_system_suspend(void)
404 if (!IS_ENABLED(CONFIG_SUSPEND))
407 ret = psci_features(PSCI_FN_NATIVE(1_0, SYSTEM_SUSPEND));
409 if (ret != PSCI_RET_NOT_SUPPORTED)
410 suspend_set_ops(&psci_suspend_ops);
413 static void __init psci_init_cpu_suspend(void)
415 int feature = psci_features(psci_function_id[PSCI_FN_CPU_SUSPEND]);
417 if (feature != PSCI_RET_NOT_SUPPORTED)
418 psci_cpu_suspend_feature = feature;
422 * Detect the presence of a resident Trusted OS which may cause CPU_OFF to
423 * return DENIED (which would be fatal).
425 static void __init psci_init_migrate(void)
430 type = psci_ops.migrate_info_type();
432 if (type == PSCI_0_2_TOS_MP) {
433 pr_info("Trusted OS migration not required\n");
437 if (type == PSCI_RET_NOT_SUPPORTED) {
438 pr_info("MIGRATE_INFO_TYPE not supported.\n");
442 if (type != PSCI_0_2_TOS_UP_MIGRATE &&
443 type != PSCI_0_2_TOS_UP_NO_MIGRATE) {
444 pr_err("MIGRATE_INFO_TYPE returned unknown type (%d)\n", type);
448 cpuid = psci_migrate_info_up_cpu();
449 if (cpuid & ~MPIDR_HWID_BITMASK) {
450 pr_warn("MIGRATE_INFO_UP_CPU reported invalid physical ID (0x%lx)\n",
455 cpu = get_logical_index(cpuid);
456 resident_cpu = cpu >= 0 ? cpu : -1;
458 pr_info("Trusted OS resident on physical CPU 0x%lx\n", cpuid);
461 static void __init psci_0_2_set_functions(void)
463 pr_info("Using standard PSCI v0.2 function IDs\n");
464 psci_function_id[PSCI_FN_CPU_SUSPEND] =
465 PSCI_FN_NATIVE(0_2, CPU_SUSPEND);
466 psci_ops.cpu_suspend = psci_cpu_suspend;
468 psci_function_id[PSCI_FN_CPU_OFF] = PSCI_0_2_FN_CPU_OFF;
469 psci_ops.cpu_off = psci_cpu_off;
471 psci_function_id[PSCI_FN_CPU_ON] = PSCI_FN_NATIVE(0_2, CPU_ON);
472 psci_ops.cpu_on = psci_cpu_on;
474 psci_function_id[PSCI_FN_MIGRATE] = PSCI_FN_NATIVE(0_2, MIGRATE);
475 psci_ops.migrate = psci_migrate;
477 psci_ops.affinity_info = psci_affinity_info;
479 psci_ops.migrate_info_type = psci_migrate_info_type;
481 arm_pm_restart = psci_sys_reset;
483 pm_power_off = psci_sys_poweroff;
487 * Probe function for PSCI firmware versions >= 0.2
489 static int __init psci_probe(void)
491 u32 ver = psci_get_version();
493 pr_info("PSCIv%d.%d detected in firmware.\n",
494 PSCI_VERSION_MAJOR(ver),
495 PSCI_VERSION_MINOR(ver));
497 if (PSCI_VERSION_MAJOR(ver) == 0 && PSCI_VERSION_MINOR(ver) < 2) {
498 pr_err("Conflicting PSCI version detected.\n");
502 psci_0_2_set_functions();
506 if (PSCI_VERSION_MAJOR(ver) >= 1) {
507 psci_init_cpu_suspend();
508 psci_init_system_suspend();
514 typedef int (*psci_initcall_t)(const struct device_node *);
517 * PSCI init function for PSCI versions >=0.2
519 * Probe based on PSCI PSCI_VERSION function
521 static int __init psci_0_2_init(struct device_node *np)
525 err = get_set_conduit_method(np);
530 * Starting with v0.2, the PSCI specification introduced a call
531 * (PSCI_VERSION) that allows probing the firmware version, so
532 * that PSCI function IDs and version specific initialization
533 * can be carried out according to the specific version reported
544 * PSCI < v0.2 get PSCI Function IDs via DT.
546 static int __init psci_0_1_init(struct device_node *np)
551 err = get_set_conduit_method(np);
556 pr_info("Using PSCI v0.1 Function IDs from DT\n");
558 if (!of_property_read_u32(np, "cpu_suspend", &id)) {
559 psci_function_id[PSCI_FN_CPU_SUSPEND] = id;
560 psci_ops.cpu_suspend = psci_cpu_suspend;
563 if (!of_property_read_u32(np, "cpu_off", &id)) {
564 psci_function_id[PSCI_FN_CPU_OFF] = id;
565 psci_ops.cpu_off = psci_cpu_off;
568 if (!of_property_read_u32(np, "cpu_on", &id)) {
569 psci_function_id[PSCI_FN_CPU_ON] = id;
570 psci_ops.cpu_on = psci_cpu_on;
573 if (!of_property_read_u32(np, "migrate", &id)) {
574 psci_function_id[PSCI_FN_MIGRATE] = id;
575 psci_ops.migrate = psci_migrate;
583 static const struct of_device_id const psci_of_match[] __initconst = {
584 { .compatible = "arm,psci", .data = psci_0_1_init},
585 { .compatible = "arm,psci-0.2", .data = psci_0_2_init},
586 { .compatible = "arm,psci-1.0", .data = psci_0_2_init},
590 int __init psci_dt_init(void)
592 struct device_node *np;
593 const struct of_device_id *matched_np;
594 psci_initcall_t init_fn;
596 np = of_find_matching_node_and_match(NULL, psci_of_match, &matched_np);
601 init_fn = (psci_initcall_t)matched_np->data;
607 * We use PSCI 0.2+ when ACPI is deployed on ARM64 and it's
608 * explicitly clarified in SBBR
610 int __init psci_acpi_init(void)
612 if (!acpi_psci_present()) {
613 pr_info("is not implemented in ACPI.\n");
617 pr_info("probing for conduit method from ACPI.\n");
619 if (acpi_psci_use_hvc())
620 invoke_psci_fn = __invoke_psci_fn_hvc;
622 invoke_psci_fn = __invoke_psci_fn_smc;