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/acpi.h>
17 #include <linux/arm-smccc.h>
18 #include <linux/cpuidle.h>
19 #include <linux/errno.h>
20 #include <linux/linkage.h>
23 #include <linux/printk.h>
24 #include <linux/psci.h>
25 #include <linux/reboot.h>
26 #include <linux/slab.h>
27 #include <linux/suspend.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 = {
63 .conduit = PSCI_CONDUIT_NONE,
64 .smccc_version = SMCCC_VERSION_1_0,
67 typedef unsigned long (psci_fn)(unsigned long, unsigned long,
68 unsigned long, unsigned long);
69 static psci_fn *invoke_psci_fn;
79 static u32 psci_function_id[PSCI_FN_MAX];
81 #define PSCI_0_2_POWER_STATE_MASK \
82 (PSCI_0_2_POWER_STATE_ID_MASK | \
83 PSCI_0_2_POWER_STATE_TYPE_MASK | \
84 PSCI_0_2_POWER_STATE_AFFL_MASK)
86 #define PSCI_1_0_EXT_POWER_STATE_MASK \
87 (PSCI_1_0_EXT_POWER_STATE_ID_MASK | \
88 PSCI_1_0_EXT_POWER_STATE_TYPE_MASK)
90 static u32 psci_cpu_suspend_feature;
91 static bool psci_system_reset2_supported;
93 static inline bool psci_has_ext_power_state(void)
95 return psci_cpu_suspend_feature &
96 PSCI_1_0_FEATURES_CPU_SUSPEND_PF_MASK;
99 static inline bool psci_has_osi_support(void)
101 return psci_cpu_suspend_feature & PSCI_1_0_OS_INITIATED;
104 static inline bool psci_power_state_loses_context(u32 state)
106 const u32 mask = psci_has_ext_power_state() ?
107 PSCI_1_0_EXT_POWER_STATE_TYPE_MASK :
108 PSCI_0_2_POWER_STATE_TYPE_MASK;
113 static inline bool psci_power_state_is_valid(u32 state)
115 const u32 valid_mask = psci_has_ext_power_state() ?
116 PSCI_1_0_EXT_POWER_STATE_MASK :
117 PSCI_0_2_POWER_STATE_MASK;
119 return !(state & ~valid_mask);
122 static unsigned long __invoke_psci_fn_hvc(unsigned long function_id,
123 unsigned long arg0, unsigned long arg1,
126 struct arm_smccc_res res;
128 arm_smccc_hvc(function_id, arg0, arg1, arg2, 0, 0, 0, 0, &res);
132 static unsigned long __invoke_psci_fn_smc(unsigned long function_id,
133 unsigned long arg0, unsigned long arg1,
136 struct arm_smccc_res res;
138 arm_smccc_smc(function_id, arg0, arg1, arg2, 0, 0, 0, 0, &res);
142 static int psci_to_linux_errno(int errno)
145 case PSCI_RET_SUCCESS:
147 case PSCI_RET_NOT_SUPPORTED:
149 case PSCI_RET_INVALID_PARAMS:
150 case PSCI_RET_INVALID_ADDRESS:
152 case PSCI_RET_DENIED:
159 static u32 psci_get_version(void)
161 return invoke_psci_fn(PSCI_0_2_FN_PSCI_VERSION, 0, 0, 0);
164 static int psci_cpu_suspend(u32 state, unsigned long entry_point)
169 fn = psci_function_id[PSCI_FN_CPU_SUSPEND];
170 err = invoke_psci_fn(fn, state, entry_point, 0);
171 return psci_to_linux_errno(err);
174 static int psci_cpu_off(u32 state)
179 fn = psci_function_id[PSCI_FN_CPU_OFF];
180 err = invoke_psci_fn(fn, state, 0, 0);
181 return psci_to_linux_errno(err);
184 static int psci_cpu_on(unsigned long cpuid, unsigned long entry_point)
189 fn = psci_function_id[PSCI_FN_CPU_ON];
190 err = invoke_psci_fn(fn, cpuid, entry_point, 0);
191 return psci_to_linux_errno(err);
194 static int psci_migrate(unsigned long cpuid)
199 fn = psci_function_id[PSCI_FN_MIGRATE];
200 err = invoke_psci_fn(fn, cpuid, 0, 0);
201 return psci_to_linux_errno(err);
204 static int psci_affinity_info(unsigned long target_affinity,
205 unsigned long lowest_affinity_level)
207 return invoke_psci_fn(PSCI_FN_NATIVE(0_2, AFFINITY_INFO),
208 target_affinity, lowest_affinity_level, 0);
211 static int psci_migrate_info_type(void)
213 return invoke_psci_fn(PSCI_0_2_FN_MIGRATE_INFO_TYPE, 0, 0, 0);
216 static unsigned long psci_migrate_info_up_cpu(void)
218 return invoke_psci_fn(PSCI_FN_NATIVE(0_2, MIGRATE_INFO_UP_CPU),
222 static void set_conduit(enum psci_conduit conduit)
225 case PSCI_CONDUIT_HVC:
226 invoke_psci_fn = __invoke_psci_fn_hvc;
228 case PSCI_CONDUIT_SMC:
229 invoke_psci_fn = __invoke_psci_fn_smc;
232 WARN(1, "Unexpected PSCI conduit %d\n", conduit);
235 psci_ops.conduit = conduit;
238 static int get_set_conduit_method(struct device_node *np)
242 pr_info("probing for conduit method from DT.\n");
244 if (of_property_read_string(np, "method", &method)) {
245 pr_warn("missing \"method\" property\n");
249 if (!strcmp("hvc", method)) {
250 set_conduit(PSCI_CONDUIT_HVC);
251 } else if (!strcmp("smc", method)) {
252 set_conduit(PSCI_CONDUIT_SMC);
254 pr_warn("invalid \"method\" property: %s\n", method);
260 static void psci_sys_reset(enum reboot_mode reboot_mode, const char *cmd)
262 if ((reboot_mode == REBOOT_WARM || reboot_mode == REBOOT_SOFT) &&
263 psci_system_reset2_supported) {
265 * reset_type[31] = 0 (architectural)
266 * reset_type[30:0] = 0 (SYSTEM_WARM_RESET)
267 * cookie = 0 (ignored by the implementation)
269 invoke_psci_fn(PSCI_FN_NATIVE(1_1, SYSTEM_RESET2), 0, 0, 0);
271 invoke_psci_fn(PSCI_0_2_FN_SYSTEM_RESET, 0, 0, 0);
275 static void psci_sys_poweroff(void)
277 invoke_psci_fn(PSCI_0_2_FN_SYSTEM_OFF, 0, 0, 0);
280 static int __init psci_features(u32 psci_func_id)
282 return invoke_psci_fn(PSCI_1_0_FN_PSCI_FEATURES,
286 #ifdef CONFIG_CPU_IDLE
287 static DEFINE_PER_CPU_READ_MOSTLY(u32 *, psci_power_state);
289 static int psci_dt_parse_state_node(struct device_node *np, u32 *state)
291 int err = of_property_read_u32(np, "arm,psci-suspend-param", state);
294 pr_warn("%pOF missing arm,psci-suspend-param property\n", np);
298 if (!psci_power_state_is_valid(*state)) {
299 pr_warn("Invalid PSCI power state %#x\n", *state);
306 static int psci_dt_cpu_init_idle(struct device_node *cpu_node, int cpu)
308 int i, ret = 0, count = 0;
310 struct device_node *state_node;
312 /* Count idle states */
313 while ((state_node = of_parse_phandle(cpu_node, "cpu-idle-states",
316 of_node_put(state_node);
322 psci_states = kcalloc(count, sizeof(*psci_states), GFP_KERNEL);
326 for (i = 0; i < count; i++) {
327 state_node = of_parse_phandle(cpu_node, "cpu-idle-states", i);
328 ret = psci_dt_parse_state_node(state_node, &psci_states[i]);
329 of_node_put(state_node);
334 pr_debug("psci-power-state %#x index %d\n", psci_states[i], i);
337 /* Idle states parsed correctly, initialize per-cpu pointer */
338 per_cpu(psci_power_state, cpu) = psci_states;
347 #include <acpi/processor.h>
349 static int __maybe_unused psci_acpi_cpu_init_idle(unsigned int cpu)
353 struct acpi_lpi_state *lpi;
354 struct acpi_processor *pr = per_cpu(processors, cpu);
356 if (unlikely(!pr || !pr->flags.has_lpi))
359 count = pr->power.count - 1;
363 psci_states = kcalloc(count, sizeof(*psci_states), GFP_KERNEL);
367 for (i = 0; i < count; i++) {
370 lpi = &pr->power.lpi_states[i + 1];
372 * Only bits[31:0] represent a PSCI power_state while
373 * bits[63:32] must be 0x0 as per ARM ACPI FFH Specification
375 state = lpi->address;
376 if (!psci_power_state_is_valid(state)) {
377 pr_warn("Invalid PSCI power state %#x\n", state);
381 psci_states[i] = state;
383 /* Idle states parsed correctly, initialize per-cpu pointer */
384 per_cpu(psci_power_state, cpu) = psci_states;
388 static int __maybe_unused psci_acpi_cpu_init_idle(unsigned int cpu)
394 int psci_cpu_init_idle(unsigned int cpu)
396 struct device_node *cpu_node;
400 * If the PSCI cpu_suspend function hook has not been initialized
401 * idle states must not be enabled, so bail out
403 if (!psci_ops.cpu_suspend)
407 return psci_acpi_cpu_init_idle(cpu);
409 cpu_node = of_get_cpu_node(cpu, NULL);
413 ret = psci_dt_cpu_init_idle(cpu_node, cpu);
415 of_node_put(cpu_node);
420 static int psci_suspend_finisher(unsigned long index)
422 u32 *state = __this_cpu_read(psci_power_state);
424 return psci_ops.cpu_suspend(state[index - 1],
425 __pa_symbol(cpu_resume));
428 int psci_cpu_suspend_enter(unsigned long index)
431 u32 *state = __this_cpu_read(psci_power_state);
433 * idle state index 0 corresponds to wfi, should never be called
434 * from the cpu_suspend operations
436 if (WARN_ON_ONCE(!index))
439 if (!psci_power_state_loses_context(state[index - 1]))
440 ret = psci_ops.cpu_suspend(state[index - 1], 0);
442 ret = cpu_suspend(index, psci_suspend_finisher);
447 /* ARM specific CPU idle operations */
449 static const struct cpuidle_ops psci_cpuidle_ops __initconst = {
450 .suspend = psci_cpu_suspend_enter,
451 .init = psci_dt_cpu_init_idle,
454 CPUIDLE_METHOD_OF_DECLARE(psci, "psci", &psci_cpuidle_ops);
458 static int psci_system_suspend(unsigned long unused)
460 return invoke_psci_fn(PSCI_FN_NATIVE(1_0, SYSTEM_SUSPEND),
461 __pa_symbol(cpu_resume), 0, 0);
464 static int psci_system_suspend_enter(suspend_state_t state)
466 return cpu_suspend(0, psci_system_suspend);
469 static const struct platform_suspend_ops psci_suspend_ops = {
470 .valid = suspend_valid_only_mem,
471 .enter = psci_system_suspend_enter,
474 static void __init psci_init_system_reset2(void)
478 ret = psci_features(PSCI_FN_NATIVE(1_1, SYSTEM_RESET2));
480 if (ret != PSCI_RET_NOT_SUPPORTED)
481 psci_system_reset2_supported = true;
484 static void __init psci_init_system_suspend(void)
488 if (!IS_ENABLED(CONFIG_SUSPEND))
491 ret = psci_features(PSCI_FN_NATIVE(1_0, SYSTEM_SUSPEND));
493 if (ret != PSCI_RET_NOT_SUPPORTED)
494 suspend_set_ops(&psci_suspend_ops);
497 static void __init psci_init_cpu_suspend(void)
499 int feature = psci_features(psci_function_id[PSCI_FN_CPU_SUSPEND]);
501 if (feature != PSCI_RET_NOT_SUPPORTED)
502 psci_cpu_suspend_feature = feature;
506 * Detect the presence of a resident Trusted OS which may cause CPU_OFF to
507 * return DENIED (which would be fatal).
509 static void __init psci_init_migrate(void)
514 type = psci_ops.migrate_info_type();
516 if (type == PSCI_0_2_TOS_MP) {
517 pr_info("Trusted OS migration not required\n");
521 if (type == PSCI_RET_NOT_SUPPORTED) {
522 pr_info("MIGRATE_INFO_TYPE not supported.\n");
526 if (type != PSCI_0_2_TOS_UP_MIGRATE &&
527 type != PSCI_0_2_TOS_UP_NO_MIGRATE) {
528 pr_err("MIGRATE_INFO_TYPE returned unknown type (%d)\n", type);
532 cpuid = psci_migrate_info_up_cpu();
533 if (cpuid & ~MPIDR_HWID_BITMASK) {
534 pr_warn("MIGRATE_INFO_UP_CPU reported invalid physical ID (0x%lx)\n",
539 cpu = get_logical_index(cpuid);
540 resident_cpu = cpu >= 0 ? cpu : -1;
542 pr_info("Trusted OS resident on physical CPU 0x%lx\n", cpuid);
545 static void __init psci_init_smccc(void)
547 u32 ver = ARM_SMCCC_VERSION_1_0;
550 feature = psci_features(ARM_SMCCC_VERSION_FUNC_ID);
552 if (feature != PSCI_RET_NOT_SUPPORTED) {
554 ret = invoke_psci_fn(ARM_SMCCC_VERSION_FUNC_ID, 0, 0, 0);
555 if (ret == ARM_SMCCC_VERSION_1_1) {
556 psci_ops.smccc_version = SMCCC_VERSION_1_1;
562 * Conveniently, the SMCCC and PSCI versions are encoded the
563 * same way. No, this isn't accidental.
565 pr_info("SMC Calling Convention v%d.%d\n",
566 PSCI_VERSION_MAJOR(ver), PSCI_VERSION_MINOR(ver));
570 static void __init psci_0_2_set_functions(void)
572 pr_info("Using standard PSCI v0.2 function IDs\n");
573 psci_ops.get_version = psci_get_version;
575 psci_function_id[PSCI_FN_CPU_SUSPEND] =
576 PSCI_FN_NATIVE(0_2, CPU_SUSPEND);
577 psci_ops.cpu_suspend = psci_cpu_suspend;
579 psci_function_id[PSCI_FN_CPU_OFF] = PSCI_0_2_FN_CPU_OFF;
580 psci_ops.cpu_off = psci_cpu_off;
582 psci_function_id[PSCI_FN_CPU_ON] = PSCI_FN_NATIVE(0_2, CPU_ON);
583 psci_ops.cpu_on = psci_cpu_on;
585 psci_function_id[PSCI_FN_MIGRATE] = PSCI_FN_NATIVE(0_2, MIGRATE);
586 psci_ops.migrate = psci_migrate;
588 psci_ops.affinity_info = psci_affinity_info;
590 psci_ops.migrate_info_type = psci_migrate_info_type;
592 arm_pm_restart = psci_sys_reset;
594 pm_power_off = psci_sys_poweroff;
598 * Probe function for PSCI firmware versions >= 0.2
600 static int __init psci_probe(void)
602 u32 ver = psci_get_version();
604 pr_info("PSCIv%d.%d detected in firmware.\n",
605 PSCI_VERSION_MAJOR(ver),
606 PSCI_VERSION_MINOR(ver));
608 if (PSCI_VERSION_MAJOR(ver) == 0 && PSCI_VERSION_MINOR(ver) < 2) {
609 pr_err("Conflicting PSCI version detected.\n");
613 psci_0_2_set_functions();
617 if (PSCI_VERSION_MAJOR(ver) >= 1) {
619 psci_init_cpu_suspend();
620 psci_init_system_suspend();
621 psci_init_system_reset2();
627 typedef int (*psci_initcall_t)(const struct device_node *);
630 * PSCI init function for PSCI versions >=0.2
632 * Probe based on PSCI PSCI_VERSION function
634 static int __init psci_0_2_init(struct device_node *np)
638 err = get_set_conduit_method(np);
643 * Starting with v0.2, the PSCI specification introduced a call
644 * (PSCI_VERSION) that allows probing the firmware version, so
645 * that PSCI function IDs and version specific initialization
646 * can be carried out according to the specific version reported
653 * PSCI < v0.2 get PSCI Function IDs via DT.
655 static int __init psci_0_1_init(struct device_node *np)
660 err = get_set_conduit_method(np);
664 pr_info("Using PSCI v0.1 Function IDs from DT\n");
666 if (!of_property_read_u32(np, "cpu_suspend", &id)) {
667 psci_function_id[PSCI_FN_CPU_SUSPEND] = id;
668 psci_ops.cpu_suspend = psci_cpu_suspend;
671 if (!of_property_read_u32(np, "cpu_off", &id)) {
672 psci_function_id[PSCI_FN_CPU_OFF] = id;
673 psci_ops.cpu_off = psci_cpu_off;
676 if (!of_property_read_u32(np, "cpu_on", &id)) {
677 psci_function_id[PSCI_FN_CPU_ON] = id;
678 psci_ops.cpu_on = psci_cpu_on;
681 if (!of_property_read_u32(np, "migrate", &id)) {
682 psci_function_id[PSCI_FN_MIGRATE] = id;
683 psci_ops.migrate = psci_migrate;
689 static int __init psci_1_0_init(struct device_node *np)
693 err = psci_0_2_init(np);
697 if (psci_has_osi_support())
698 pr_info("OSI mode supported.\n");
703 static const struct of_device_id psci_of_match[] __initconst = {
704 { .compatible = "arm,psci", .data = psci_0_1_init},
705 { .compatible = "arm,psci-0.2", .data = psci_0_2_init},
706 { .compatible = "arm,psci-1.0", .data = psci_1_0_init},
710 int __init psci_dt_init(void)
712 struct device_node *np;
713 const struct of_device_id *matched_np;
714 psci_initcall_t init_fn;
717 np = of_find_matching_node_and_match(NULL, psci_of_match, &matched_np);
719 if (!np || !of_device_is_available(np))
722 init_fn = (psci_initcall_t)matched_np->data;
731 * We use PSCI 0.2+ when ACPI is deployed on ARM64 and it's
732 * explicitly clarified in SBBR
734 int __init psci_acpi_init(void)
736 if (!acpi_psci_present()) {
737 pr_info("is not implemented in ACPI.\n");
741 pr_info("probing for conduit method from ACPI.\n");
743 if (acpi_psci_use_hvc())
744 set_conduit(PSCI_CONDUIT_HVC);
746 set_conduit(PSCI_CONDUIT_SMC);