1 // SPDX-License-Identifier: GPL-2.0-only
4 * Copyright (C) 2015 ARM Limited
7 #define pr_fmt(fmt) "psci: " fmt
9 #include <linux/acpi.h>
10 #include <linux/arm-smccc.h>
11 #include <linux/cpuidle.h>
12 #include <linux/debugfs.h>
13 #include <linux/errno.h>
14 #include <linux/linkage.h>
17 #include <linux/printk.h>
18 #include <linux/psci.h>
19 #include <linux/reboot.h>
20 #include <linux/slab.h>
21 #include <linux/suspend.h>
23 #include <uapi/linux/psci.h>
25 #include <asm/cpuidle.h>
26 #include <asm/cputype.h>
27 #include <asm/hypervisor.h>
28 #include <asm/system_misc.h>
29 #include <asm/smp_plat.h>
30 #include <asm/suspend.h>
33 * While a 64-bit OS can make calls with SMC32 calling conventions, for some
34 * calls it is necessary to use SMC64 to pass or return 64-bit values.
35 * For such calls PSCI_FN_NATIVE(version, name) will choose the appropriate
36 * (native-width) function ID.
39 #define PSCI_FN_NATIVE(version, name) PSCI_##version##_FN64_##name
41 #define PSCI_FN_NATIVE(version, name) PSCI_##version##_FN_##name
45 * The CPU any Trusted OS is resident on. The trusted OS may reject CPU_OFF
46 * calls to its resident CPU, so we must avoid issuing those. We never migrate
47 * a Trusted OS even if it claims to be capable of migration -- doing so will
48 * require cooperation with a Trusted OS driver.
50 static int resident_cpu = -1;
51 struct psci_operations psci_ops;
52 static enum arm_smccc_conduit psci_conduit = SMCCC_CONDUIT_NONE;
54 bool psci_tos_resident_on(int cpu)
56 return cpu == resident_cpu;
59 typedef unsigned long (psci_fn)(unsigned long, unsigned long,
60 unsigned long, unsigned long);
61 static psci_fn *invoke_psci_fn;
63 static struct psci_0_1_function_ids psci_0_1_function_ids;
65 struct psci_0_1_function_ids get_psci_0_1_function_ids(void)
67 return psci_0_1_function_ids;
70 #define PSCI_0_2_POWER_STATE_MASK \
71 (PSCI_0_2_POWER_STATE_ID_MASK | \
72 PSCI_0_2_POWER_STATE_TYPE_MASK | \
73 PSCI_0_2_POWER_STATE_AFFL_MASK)
75 #define PSCI_1_0_EXT_POWER_STATE_MASK \
76 (PSCI_1_0_EXT_POWER_STATE_ID_MASK | \
77 PSCI_1_0_EXT_POWER_STATE_TYPE_MASK)
79 static u32 psci_cpu_suspend_feature;
80 static bool psci_system_reset2_supported;
82 static inline bool psci_has_ext_power_state(void)
84 return psci_cpu_suspend_feature &
85 PSCI_1_0_FEATURES_CPU_SUSPEND_PF_MASK;
88 bool psci_has_osi_support(void)
90 return psci_cpu_suspend_feature & PSCI_1_0_OS_INITIATED;
93 static inline bool psci_power_state_loses_context(u32 state)
95 const u32 mask = psci_has_ext_power_state() ?
96 PSCI_1_0_EXT_POWER_STATE_TYPE_MASK :
97 PSCI_0_2_POWER_STATE_TYPE_MASK;
102 bool psci_power_state_is_valid(u32 state)
104 const u32 valid_mask = psci_has_ext_power_state() ?
105 PSCI_1_0_EXT_POWER_STATE_MASK :
106 PSCI_0_2_POWER_STATE_MASK;
108 return !(state & ~valid_mask);
111 static __always_inline unsigned long
112 __invoke_psci_fn_hvc(unsigned long function_id,
113 unsigned long arg0, unsigned long arg1,
116 struct arm_smccc_res res;
118 arm_smccc_hvc(function_id, arg0, arg1, arg2, 0, 0, 0, 0, &res);
122 static __always_inline unsigned long
123 __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 __always_inline 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_0_1_get_version(void)
152 return PSCI_VERSION(0, 1);
155 static u32 psci_0_2_get_version(void)
157 return invoke_psci_fn(PSCI_0_2_FN_PSCI_VERSION, 0, 0, 0);
160 int psci_set_osi_mode(bool enable)
162 unsigned long suspend_mode;
165 suspend_mode = enable ? PSCI_1_0_SUSPEND_MODE_OSI :
166 PSCI_1_0_SUSPEND_MODE_PC;
168 err = invoke_psci_fn(PSCI_1_0_FN_SET_SUSPEND_MODE, suspend_mode, 0, 0);
170 pr_info(FW_BUG "failed to set %s mode: %d\n",
171 enable ? "OSI" : "PC", err);
172 return psci_to_linux_errno(err);
175 static __always_inline int
176 __psci_cpu_suspend(u32 fn, u32 state, unsigned long entry_point)
180 err = invoke_psci_fn(fn, state, entry_point, 0);
181 return psci_to_linux_errno(err);
184 static __always_inline int
185 psci_0_1_cpu_suspend(u32 state, unsigned long entry_point)
187 return __psci_cpu_suspend(psci_0_1_function_ids.cpu_suspend,
191 static __always_inline int
192 psci_0_2_cpu_suspend(u32 state, unsigned long entry_point)
194 return __psci_cpu_suspend(PSCI_FN_NATIVE(0_2, CPU_SUSPEND),
198 static int __psci_cpu_off(u32 fn, u32 state)
202 err = invoke_psci_fn(fn, state, 0, 0);
203 return psci_to_linux_errno(err);
206 static int psci_0_1_cpu_off(u32 state)
208 return __psci_cpu_off(psci_0_1_function_ids.cpu_off, state);
211 static int psci_0_2_cpu_off(u32 state)
213 return __psci_cpu_off(PSCI_0_2_FN_CPU_OFF, state);
216 static int __psci_cpu_on(u32 fn, unsigned long cpuid, unsigned long entry_point)
220 err = invoke_psci_fn(fn, cpuid, entry_point, 0);
221 return psci_to_linux_errno(err);
224 static int psci_0_1_cpu_on(unsigned long cpuid, unsigned long entry_point)
226 return __psci_cpu_on(psci_0_1_function_ids.cpu_on, cpuid, entry_point);
229 static int psci_0_2_cpu_on(unsigned long cpuid, unsigned long entry_point)
231 return __psci_cpu_on(PSCI_FN_NATIVE(0_2, CPU_ON), cpuid, entry_point);
234 static int __psci_migrate(u32 fn, unsigned long cpuid)
238 err = invoke_psci_fn(fn, cpuid, 0, 0);
239 return psci_to_linux_errno(err);
242 static int psci_0_1_migrate(unsigned long cpuid)
244 return __psci_migrate(psci_0_1_function_ids.migrate, cpuid);
247 static int psci_0_2_migrate(unsigned long cpuid)
249 return __psci_migrate(PSCI_FN_NATIVE(0_2, MIGRATE), cpuid);
252 static int psci_affinity_info(unsigned long target_affinity,
253 unsigned long lowest_affinity_level)
255 return invoke_psci_fn(PSCI_FN_NATIVE(0_2, AFFINITY_INFO),
256 target_affinity, lowest_affinity_level, 0);
259 static int psci_migrate_info_type(void)
261 return invoke_psci_fn(PSCI_0_2_FN_MIGRATE_INFO_TYPE, 0, 0, 0);
264 static unsigned long psci_migrate_info_up_cpu(void)
266 return invoke_psci_fn(PSCI_FN_NATIVE(0_2, MIGRATE_INFO_UP_CPU),
270 static void set_conduit(enum arm_smccc_conduit conduit)
273 case SMCCC_CONDUIT_HVC:
274 invoke_psci_fn = __invoke_psci_fn_hvc;
276 case SMCCC_CONDUIT_SMC:
277 invoke_psci_fn = __invoke_psci_fn_smc;
280 WARN(1, "Unexpected PSCI conduit %d\n", conduit);
283 psci_conduit = conduit;
286 static int get_set_conduit_method(const struct device_node *np)
290 pr_info("probing for conduit method from DT.\n");
292 if (of_property_read_string(np, "method", &method)) {
293 pr_warn("missing \"method\" property\n");
297 if (!strcmp("hvc", method)) {
298 set_conduit(SMCCC_CONDUIT_HVC);
299 } else if (!strcmp("smc", method)) {
300 set_conduit(SMCCC_CONDUIT_SMC);
302 pr_warn("invalid \"method\" property: %s\n", method);
308 static int psci_sys_reset(struct notifier_block *nb, unsigned long action,
311 if ((reboot_mode == REBOOT_WARM || reboot_mode == REBOOT_SOFT) &&
312 psci_system_reset2_supported) {
314 * reset_type[31] = 0 (architectural)
315 * reset_type[30:0] = 0 (SYSTEM_WARM_RESET)
316 * cookie = 0 (ignored by the implementation)
318 invoke_psci_fn(PSCI_FN_NATIVE(1_1, SYSTEM_RESET2), 0, 0, 0);
320 invoke_psci_fn(PSCI_0_2_FN_SYSTEM_RESET, 0, 0, 0);
326 static struct notifier_block psci_sys_reset_nb = {
327 .notifier_call = psci_sys_reset,
331 static void psci_sys_poweroff(void)
333 invoke_psci_fn(PSCI_0_2_FN_SYSTEM_OFF, 0, 0, 0);
336 static int psci_features(u32 psci_func_id)
338 return invoke_psci_fn(PSCI_1_0_FN_PSCI_FEATURES,
342 #ifdef CONFIG_DEBUG_FS
344 #define PSCI_ID(ver, _name) \
345 { .fn = PSCI_##ver##_FN_##_name, .name = #_name, }
346 #define PSCI_ID_NATIVE(ver, _name) \
347 { .fn = PSCI_FN_NATIVE(ver, _name), .name = #_name, }
349 /* A table of all optional functions */
350 static const struct {
354 PSCI_ID_NATIVE(0_2, MIGRATE),
355 PSCI_ID(0_2, MIGRATE_INFO_TYPE),
356 PSCI_ID_NATIVE(0_2, MIGRATE_INFO_UP_CPU),
357 PSCI_ID(1_0, CPU_FREEZE),
358 PSCI_ID_NATIVE(1_0, CPU_DEFAULT_SUSPEND),
359 PSCI_ID_NATIVE(1_0, NODE_HW_STATE),
360 PSCI_ID_NATIVE(1_0, SYSTEM_SUSPEND),
361 PSCI_ID(1_0, SET_SUSPEND_MODE),
362 PSCI_ID_NATIVE(1_0, STAT_RESIDENCY),
363 PSCI_ID_NATIVE(1_0, STAT_COUNT),
364 PSCI_ID_NATIVE(1_1, SYSTEM_RESET2),
365 PSCI_ID(1_1, MEM_PROTECT),
366 PSCI_ID_NATIVE(1_1, MEM_PROTECT_CHECK_RANGE),
369 static int psci_debugfs_read(struct seq_file *s, void *data)
371 int feature, type, i;
374 ver = psci_ops.get_version();
375 seq_printf(s, "PSCIv%d.%d\n",
376 PSCI_VERSION_MAJOR(ver),
377 PSCI_VERSION_MINOR(ver));
379 /* PSCI_FEATURES is available only starting from 1.0 */
380 if (PSCI_VERSION_MAJOR(ver) < 1)
383 feature = psci_features(ARM_SMCCC_VERSION_FUNC_ID);
384 if (feature != PSCI_RET_NOT_SUPPORTED) {
385 ver = invoke_psci_fn(ARM_SMCCC_VERSION_FUNC_ID, 0, 0, 0);
386 seq_printf(s, "SMC Calling Convention v%d.%d\n",
387 PSCI_VERSION_MAJOR(ver),
388 PSCI_VERSION_MINOR(ver));
390 seq_puts(s, "SMC Calling Convention v1.0 is assumed\n");
393 feature = psci_features(PSCI_FN_NATIVE(0_2, CPU_SUSPEND));
395 seq_printf(s, "PSCI_FEATURES(CPU_SUSPEND) error (%d)\n", feature);
397 seq_printf(s, "OSI is %ssupported\n",
398 (feature & BIT(0)) ? "" : "not ");
399 seq_printf(s, "%s StateID format is used\n",
400 (feature & BIT(1)) ? "Extended" : "Original");
403 type = psci_ops.migrate_info_type();
404 if (type == PSCI_0_2_TOS_UP_MIGRATE ||
405 type == PSCI_0_2_TOS_UP_NO_MIGRATE) {
408 seq_printf(s, "Trusted OS %smigrate capable\n",
409 type == PSCI_0_2_TOS_UP_NO_MIGRATE ? "not " : "");
410 cpuid = psci_migrate_info_up_cpu();
411 seq_printf(s, "Trusted OS resident on physical CPU 0x%lx (#%d)\n",
412 cpuid, resident_cpu);
413 } else if (type == PSCI_0_2_TOS_MP) {
414 seq_puts(s, "Trusted OS migration not required\n");
416 if (type != PSCI_RET_NOT_SUPPORTED)
417 seq_printf(s, "MIGRATE_INFO_TYPE returned unknown type (%d)\n", type);
420 for (i = 0; i < ARRAY_SIZE(psci_fn_ids); i++) {
421 feature = psci_features(psci_fn_ids[i].fn);
422 if (feature == PSCI_RET_NOT_SUPPORTED)
425 seq_printf(s, "PSCI_FEATURES(%s) error (%d)\n",
426 psci_fn_ids[i].name, feature);
428 seq_printf(s, "%s is supported\n", psci_fn_ids[i].name);
434 static int psci_debugfs_open(struct inode *inode, struct file *f)
436 return single_open(f, psci_debugfs_read, NULL);
439 static const struct file_operations psci_debugfs_ops = {
440 .owner = THIS_MODULE,
441 .open = psci_debugfs_open,
442 .release = single_release,
447 static int __init psci_debugfs_init(void)
449 if (!invoke_psci_fn || !psci_ops.get_version)
452 return PTR_ERR_OR_ZERO(debugfs_create_file("psci", 0444, NULL, NULL,
455 late_initcall(psci_debugfs_init)
458 #ifdef CONFIG_CPU_IDLE
459 static noinstr int psci_suspend_finisher(unsigned long state)
461 u32 power_state = state;
462 phys_addr_t pa_cpu_resume;
464 pa_cpu_resume = __pa_symbol_nodebug((unsigned long)cpu_resume);
466 return psci_ops.cpu_suspend(power_state, pa_cpu_resume);
469 int psci_cpu_suspend_enter(u32 state)
473 if (!psci_power_state_loses_context(state)) {
474 struct arm_cpuidle_irq_context context;
477 arm_cpuidle_save_irq_context(&context);
478 ret = psci_ops.cpu_suspend(state, 0);
479 arm_cpuidle_restore_irq_context(&context);
483 * ARM64 cpu_suspend() wants to do ct_cpuidle_*() itself.
485 if (!IS_ENABLED(CONFIG_ARM64))
488 ret = cpu_suspend(state, psci_suspend_finisher);
490 if (!IS_ENABLED(CONFIG_ARM64))
498 static int psci_system_suspend(unsigned long unused)
500 phys_addr_t pa_cpu_resume = __pa_symbol(cpu_resume);
502 return invoke_psci_fn(PSCI_FN_NATIVE(1_0, SYSTEM_SUSPEND),
503 pa_cpu_resume, 0, 0);
506 static int psci_system_suspend_enter(suspend_state_t state)
508 return cpu_suspend(0, psci_system_suspend);
511 static const struct platform_suspend_ops psci_suspend_ops = {
512 .valid = suspend_valid_only_mem,
513 .enter = psci_system_suspend_enter,
516 static void __init psci_init_system_reset2(void)
520 ret = psci_features(PSCI_FN_NATIVE(1_1, SYSTEM_RESET2));
522 if (ret != PSCI_RET_NOT_SUPPORTED)
523 psci_system_reset2_supported = true;
526 static void __init psci_init_system_suspend(void)
530 if (!IS_ENABLED(CONFIG_SUSPEND))
533 ret = psci_features(PSCI_FN_NATIVE(1_0, SYSTEM_SUSPEND));
535 if (ret != PSCI_RET_NOT_SUPPORTED)
536 suspend_set_ops(&psci_suspend_ops);
539 static void __init psci_init_cpu_suspend(void)
541 int feature = psci_features(PSCI_FN_NATIVE(0_2, CPU_SUSPEND));
543 if (feature != PSCI_RET_NOT_SUPPORTED)
544 psci_cpu_suspend_feature = feature;
548 * Detect the presence of a resident Trusted OS which may cause CPU_OFF to
549 * return DENIED (which would be fatal).
551 static void __init psci_init_migrate(void)
556 type = psci_ops.migrate_info_type();
558 if (type == PSCI_0_2_TOS_MP) {
559 pr_info("Trusted OS migration not required\n");
563 if (type == PSCI_RET_NOT_SUPPORTED) {
564 pr_info("MIGRATE_INFO_TYPE not supported.\n");
568 if (type != PSCI_0_2_TOS_UP_MIGRATE &&
569 type != PSCI_0_2_TOS_UP_NO_MIGRATE) {
570 pr_err("MIGRATE_INFO_TYPE returned unknown type (%d)\n", type);
574 cpuid = psci_migrate_info_up_cpu();
575 if (cpuid & ~MPIDR_HWID_BITMASK) {
576 pr_warn("MIGRATE_INFO_UP_CPU reported invalid physical ID (0x%lx)\n",
581 cpu = get_logical_index(cpuid);
582 resident_cpu = cpu >= 0 ? cpu : -1;
584 pr_info("Trusted OS resident on physical CPU 0x%lx\n", cpuid);
587 static void __init psci_init_smccc(void)
589 u32 ver = ARM_SMCCC_VERSION_1_0;
592 feature = psci_features(ARM_SMCCC_VERSION_FUNC_ID);
594 if (feature != PSCI_RET_NOT_SUPPORTED) {
596 ret = invoke_psci_fn(ARM_SMCCC_VERSION_FUNC_ID, 0, 0, 0);
597 if (ret >= ARM_SMCCC_VERSION_1_1) {
598 arm_smccc_version_init(ret, psci_conduit);
604 * Conveniently, the SMCCC and PSCI versions are encoded the
605 * same way. No, this isn't accidental.
607 pr_info("SMC Calling Convention v%d.%d\n",
608 PSCI_VERSION_MAJOR(ver), PSCI_VERSION_MINOR(ver));
612 static void __init psci_0_2_set_functions(void)
614 pr_info("Using standard PSCI v0.2 function IDs\n");
616 psci_ops = (struct psci_operations){
617 .get_version = psci_0_2_get_version,
618 .cpu_suspend = psci_0_2_cpu_suspend,
619 .cpu_off = psci_0_2_cpu_off,
620 .cpu_on = psci_0_2_cpu_on,
621 .migrate = psci_0_2_migrate,
622 .affinity_info = psci_affinity_info,
623 .migrate_info_type = psci_migrate_info_type,
626 register_restart_handler(&psci_sys_reset_nb);
628 pm_power_off = psci_sys_poweroff;
632 * Probe function for PSCI firmware versions >= 0.2
634 static int __init psci_probe(void)
636 u32 ver = psci_0_2_get_version();
638 pr_info("PSCIv%d.%d detected in firmware.\n",
639 PSCI_VERSION_MAJOR(ver),
640 PSCI_VERSION_MINOR(ver));
642 if (PSCI_VERSION_MAJOR(ver) == 0 && PSCI_VERSION_MINOR(ver) < 2) {
643 pr_err("Conflicting PSCI version detected.\n");
647 psci_0_2_set_functions();
651 if (PSCI_VERSION_MAJOR(ver) >= 1) {
653 psci_init_cpu_suspend();
654 psci_init_system_suspend();
655 psci_init_system_reset2();
656 kvm_init_hyp_services();
662 typedef int (*psci_initcall_t)(const struct device_node *);
665 * PSCI init function for PSCI versions >=0.2
667 * Probe based on PSCI PSCI_VERSION function
669 static int __init psci_0_2_init(const struct device_node *np)
673 err = get_set_conduit_method(np);
678 * Starting with v0.2, the PSCI specification introduced a call
679 * (PSCI_VERSION) that allows probing the firmware version, so
680 * that PSCI function IDs and version specific initialization
681 * can be carried out according to the specific version reported
688 * PSCI < v0.2 get PSCI Function IDs via DT.
690 static int __init psci_0_1_init(const struct device_node *np)
695 err = get_set_conduit_method(np);
699 pr_info("Using PSCI v0.1 Function IDs from DT\n");
701 psci_ops.get_version = psci_0_1_get_version;
703 if (!of_property_read_u32(np, "cpu_suspend", &id)) {
704 psci_0_1_function_ids.cpu_suspend = id;
705 psci_ops.cpu_suspend = psci_0_1_cpu_suspend;
708 if (!of_property_read_u32(np, "cpu_off", &id)) {
709 psci_0_1_function_ids.cpu_off = id;
710 psci_ops.cpu_off = psci_0_1_cpu_off;
713 if (!of_property_read_u32(np, "cpu_on", &id)) {
714 psci_0_1_function_ids.cpu_on = id;
715 psci_ops.cpu_on = psci_0_1_cpu_on;
718 if (!of_property_read_u32(np, "migrate", &id)) {
719 psci_0_1_function_ids.migrate = id;
720 psci_ops.migrate = psci_0_1_migrate;
726 static int __init psci_1_0_init(const struct device_node *np)
730 err = psci_0_2_init(np);
734 if (psci_has_osi_support()) {
735 pr_info("OSI mode supported.\n");
737 /* Default to PC mode. */
738 psci_set_osi_mode(false);
744 static const struct of_device_id psci_of_match[] __initconst = {
745 { .compatible = "arm,psci", .data = psci_0_1_init},
746 { .compatible = "arm,psci-0.2", .data = psci_0_2_init},
747 { .compatible = "arm,psci-1.0", .data = psci_1_0_init},
751 int __init psci_dt_init(void)
753 struct device_node *np;
754 const struct of_device_id *matched_np;
755 psci_initcall_t init_fn;
758 np = of_find_matching_node_and_match(NULL, psci_of_match, &matched_np);
760 if (!np || !of_device_is_available(np))
763 init_fn = (psci_initcall_t)matched_np->data;
772 * We use PSCI 0.2+ when ACPI is deployed on ARM64 and it's
773 * explicitly clarified in SBBR
775 int __init psci_acpi_init(void)
777 if (!acpi_psci_present()) {
778 pr_info("is not implemented in ACPI.\n");
782 pr_info("probing for conduit method from ACPI.\n");
784 if (acpi_psci_use_hvc())
785 set_conduit(SMCCC_CONDUIT_HVC);
787 set_conduit(SMCCC_CONDUIT_SMC);