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 enum arm_smccc_conduit arm_smccc_1_1_get_conduit(void)
69 if (psci_ops.smccc_version < SMCCC_VERSION_1_1)
70 return SMCCC_CONDUIT_NONE;
72 switch (psci_ops.conduit) {
73 case PSCI_CONDUIT_SMC:
74 return SMCCC_CONDUIT_SMC;
75 case PSCI_CONDUIT_HVC:
76 return SMCCC_CONDUIT_HVC;
78 return SMCCC_CONDUIT_NONE;
82 typedef unsigned long (psci_fn)(unsigned long, unsigned long,
83 unsigned long, unsigned long);
84 static psci_fn *invoke_psci_fn;
94 static u32 psci_function_id[PSCI_FN_MAX];
96 #define PSCI_0_2_POWER_STATE_MASK \
97 (PSCI_0_2_POWER_STATE_ID_MASK | \
98 PSCI_0_2_POWER_STATE_TYPE_MASK | \
99 PSCI_0_2_POWER_STATE_AFFL_MASK)
101 #define PSCI_1_0_EXT_POWER_STATE_MASK \
102 (PSCI_1_0_EXT_POWER_STATE_ID_MASK | \
103 PSCI_1_0_EXT_POWER_STATE_TYPE_MASK)
105 static u32 psci_cpu_suspend_feature;
107 static inline bool psci_has_ext_power_state(void)
109 return psci_cpu_suspend_feature &
110 PSCI_1_0_FEATURES_CPU_SUSPEND_PF_MASK;
113 static inline bool psci_power_state_loses_context(u32 state)
115 const u32 mask = psci_has_ext_power_state() ?
116 PSCI_1_0_EXT_POWER_STATE_TYPE_MASK :
117 PSCI_0_2_POWER_STATE_TYPE_MASK;
122 static inline bool psci_power_state_is_valid(u32 state)
124 const u32 valid_mask = psci_has_ext_power_state() ?
125 PSCI_1_0_EXT_POWER_STATE_MASK :
126 PSCI_0_2_POWER_STATE_MASK;
128 return !(state & ~valid_mask);
131 static unsigned long __invoke_psci_fn_hvc(unsigned long function_id,
132 unsigned long arg0, unsigned long arg1,
135 struct arm_smccc_res res;
137 arm_smccc_hvc(function_id, arg0, arg1, arg2, 0, 0, 0, 0, &res);
141 static unsigned long __invoke_psci_fn_smc(unsigned long function_id,
142 unsigned long arg0, unsigned long arg1,
145 struct arm_smccc_res res;
147 arm_smccc_smc(function_id, arg0, arg1, arg2, 0, 0, 0, 0, &res);
151 static int psci_to_linux_errno(int errno)
154 case PSCI_RET_SUCCESS:
156 case PSCI_RET_NOT_SUPPORTED:
158 case PSCI_RET_INVALID_PARAMS:
159 case PSCI_RET_INVALID_ADDRESS:
161 case PSCI_RET_DENIED:
168 static u32 psci_get_version(void)
170 return invoke_psci_fn(PSCI_0_2_FN_PSCI_VERSION, 0, 0, 0);
173 static int psci_cpu_suspend(u32 state, unsigned long entry_point)
178 fn = psci_function_id[PSCI_FN_CPU_SUSPEND];
179 err = invoke_psci_fn(fn, state, entry_point, 0);
180 return psci_to_linux_errno(err);
183 static int psci_cpu_off(u32 state)
188 fn = psci_function_id[PSCI_FN_CPU_OFF];
189 err = invoke_psci_fn(fn, state, 0, 0);
190 return psci_to_linux_errno(err);
193 static int psci_cpu_on(unsigned long cpuid, unsigned long entry_point)
198 fn = psci_function_id[PSCI_FN_CPU_ON];
199 err = invoke_psci_fn(fn, cpuid, entry_point, 0);
200 return psci_to_linux_errno(err);
203 static int psci_migrate(unsigned long cpuid)
208 fn = psci_function_id[PSCI_FN_MIGRATE];
209 err = invoke_psci_fn(fn, cpuid, 0, 0);
210 return psci_to_linux_errno(err);
213 static int psci_affinity_info(unsigned long target_affinity,
214 unsigned long lowest_affinity_level)
216 return invoke_psci_fn(PSCI_FN_NATIVE(0_2, AFFINITY_INFO),
217 target_affinity, lowest_affinity_level, 0);
220 static int psci_migrate_info_type(void)
222 return invoke_psci_fn(PSCI_0_2_FN_MIGRATE_INFO_TYPE, 0, 0, 0);
225 static unsigned long psci_migrate_info_up_cpu(void)
227 return invoke_psci_fn(PSCI_FN_NATIVE(0_2, MIGRATE_INFO_UP_CPU),
231 static void set_conduit(enum psci_conduit conduit)
234 case PSCI_CONDUIT_HVC:
235 invoke_psci_fn = __invoke_psci_fn_hvc;
237 case PSCI_CONDUIT_SMC:
238 invoke_psci_fn = __invoke_psci_fn_smc;
241 WARN(1, "Unexpected PSCI conduit %d\n", conduit);
244 psci_ops.conduit = conduit;
247 static int get_set_conduit_method(struct device_node *np)
251 pr_info("probing for conduit method from DT.\n");
253 if (of_property_read_string(np, "method", &method)) {
254 pr_warn("missing \"method\" property\n");
258 if (!strcmp("hvc", method)) {
259 set_conduit(PSCI_CONDUIT_HVC);
260 } else if (!strcmp("smc", method)) {
261 set_conduit(PSCI_CONDUIT_SMC);
263 pr_warn("invalid \"method\" property: %s\n", method);
269 static void psci_sys_reset(enum reboot_mode reboot_mode, const char *cmd)
271 invoke_psci_fn(PSCI_0_2_FN_SYSTEM_RESET, 0, 0, 0);
274 static void psci_sys_poweroff(void)
276 invoke_psci_fn(PSCI_0_2_FN_SYSTEM_OFF, 0, 0, 0);
279 static int __init psci_features(u32 psci_func_id)
281 return invoke_psci_fn(PSCI_1_0_FN_PSCI_FEATURES,
285 #ifdef CONFIG_CPU_IDLE
286 static DEFINE_PER_CPU_READ_MOSTLY(u32 *, psci_power_state);
288 static int psci_dt_cpu_init_idle(struct device_node *cpu_node, int cpu)
290 int i, ret, count = 0;
292 struct device_node *state_node;
294 /* Count idle states */
295 while ((state_node = of_parse_phandle(cpu_node, "cpu-idle-states",
298 of_node_put(state_node);
304 psci_states = kcalloc(count, sizeof(*psci_states), GFP_KERNEL);
308 for (i = 0; i < count; i++) {
311 state_node = of_parse_phandle(cpu_node, "cpu-idle-states", i);
313 ret = of_property_read_u32(state_node,
314 "arm,psci-suspend-param",
317 pr_warn(" * %pOF missing arm,psci-suspend-param property\n",
319 of_node_put(state_node);
323 of_node_put(state_node);
324 pr_debug("psci-power-state %#x index %d\n", state, i);
325 if (!psci_power_state_is_valid(state)) {
326 pr_warn("Invalid PSCI power state %#x\n", state);
330 psci_states[i] = state;
332 /* Idle states parsed correctly, initialize per-cpu pointer */
333 per_cpu(psci_power_state, cpu) = psci_states;
342 #include <acpi/processor.h>
344 static int __maybe_unused psci_acpi_cpu_init_idle(unsigned int cpu)
348 struct acpi_lpi_state *lpi;
349 struct acpi_processor *pr = per_cpu(processors, cpu);
351 if (unlikely(!pr || !pr->flags.has_lpi))
354 count = pr->power.count - 1;
358 psci_states = kcalloc(count, sizeof(*psci_states), GFP_KERNEL);
362 for (i = 0; i < count; i++) {
365 lpi = &pr->power.lpi_states[i + 1];
367 * Only bits[31:0] represent a PSCI power_state while
368 * bits[63:32] must be 0x0 as per ARM ACPI FFH Specification
370 state = lpi->address;
371 if (!psci_power_state_is_valid(state)) {
372 pr_warn("Invalid PSCI power state %#x\n", state);
376 psci_states[i] = state;
378 /* Idle states parsed correctly, initialize per-cpu pointer */
379 per_cpu(psci_power_state, cpu) = psci_states;
383 static int __maybe_unused psci_acpi_cpu_init_idle(unsigned int cpu)
389 int psci_cpu_init_idle(unsigned int cpu)
391 struct device_node *cpu_node;
395 * If the PSCI cpu_suspend function hook has not been initialized
396 * idle states must not be enabled, so bail out
398 if (!psci_ops.cpu_suspend)
402 return psci_acpi_cpu_init_idle(cpu);
404 cpu_node = of_get_cpu_node(cpu, NULL);
408 ret = psci_dt_cpu_init_idle(cpu_node, cpu);
410 of_node_put(cpu_node);
415 static int psci_suspend_finisher(unsigned long index)
417 u32 *state = __this_cpu_read(psci_power_state);
419 return psci_ops.cpu_suspend(state[index - 1],
420 __pa_symbol(cpu_resume));
423 int psci_cpu_suspend_enter(unsigned long index)
426 u32 *state = __this_cpu_read(psci_power_state);
428 * idle state index 0 corresponds to wfi, should never be called
429 * from the cpu_suspend operations
431 if (WARN_ON_ONCE(!index))
434 if (!psci_power_state_loses_context(state[index - 1]))
435 ret = psci_ops.cpu_suspend(state[index - 1], 0);
437 ret = cpu_suspend(index, psci_suspend_finisher);
442 /* ARM specific CPU idle operations */
444 static const struct cpuidle_ops psci_cpuidle_ops __initconst = {
445 .suspend = psci_cpu_suspend_enter,
446 .init = psci_dt_cpu_init_idle,
449 CPUIDLE_METHOD_OF_DECLARE(psci, "psci", &psci_cpuidle_ops);
453 static int psci_system_suspend(unsigned long unused)
455 return invoke_psci_fn(PSCI_FN_NATIVE(1_0, SYSTEM_SUSPEND),
456 __pa_symbol(cpu_resume), 0, 0);
459 static int psci_system_suspend_enter(suspend_state_t state)
461 return cpu_suspend(0, psci_system_suspend);
464 static const struct platform_suspend_ops psci_suspend_ops = {
465 .valid = suspend_valid_only_mem,
466 .enter = psci_system_suspend_enter,
469 static void __init psci_init_system_suspend(void)
473 if (!IS_ENABLED(CONFIG_SUSPEND))
476 ret = psci_features(PSCI_FN_NATIVE(1_0, SYSTEM_SUSPEND));
478 if (ret != PSCI_RET_NOT_SUPPORTED)
479 suspend_set_ops(&psci_suspend_ops);
482 static void __init psci_init_cpu_suspend(void)
484 int feature = psci_features(psci_function_id[PSCI_FN_CPU_SUSPEND]);
486 if (feature != PSCI_RET_NOT_SUPPORTED)
487 psci_cpu_suspend_feature = feature;
491 * Detect the presence of a resident Trusted OS which may cause CPU_OFF to
492 * return DENIED (which would be fatal).
494 static void __init psci_init_migrate(void)
499 type = psci_ops.migrate_info_type();
501 if (type == PSCI_0_2_TOS_MP) {
502 pr_info("Trusted OS migration not required\n");
506 if (type == PSCI_RET_NOT_SUPPORTED) {
507 pr_info("MIGRATE_INFO_TYPE not supported.\n");
511 if (type != PSCI_0_2_TOS_UP_MIGRATE &&
512 type != PSCI_0_2_TOS_UP_NO_MIGRATE) {
513 pr_err("MIGRATE_INFO_TYPE returned unknown type (%d)\n", type);
517 cpuid = psci_migrate_info_up_cpu();
518 if (cpuid & ~MPIDR_HWID_BITMASK) {
519 pr_warn("MIGRATE_INFO_UP_CPU reported invalid physical ID (0x%lx)\n",
524 cpu = get_logical_index(cpuid);
525 resident_cpu = cpu >= 0 ? cpu : -1;
527 pr_info("Trusted OS resident on physical CPU 0x%lx\n", cpuid);
530 static void __init psci_init_smccc(void)
532 u32 ver = ARM_SMCCC_VERSION_1_0;
535 feature = psci_features(ARM_SMCCC_VERSION_FUNC_ID);
537 if (feature != PSCI_RET_NOT_SUPPORTED) {
539 ret = invoke_psci_fn(ARM_SMCCC_VERSION_FUNC_ID, 0, 0, 0);
540 if (ret == ARM_SMCCC_VERSION_1_1) {
541 psci_ops.smccc_version = SMCCC_VERSION_1_1;
547 * Conveniently, the SMCCC and PSCI versions are encoded the
548 * same way. No, this isn't accidental.
550 pr_info("SMC Calling Convention v%d.%d\n",
551 PSCI_VERSION_MAJOR(ver), PSCI_VERSION_MINOR(ver));
555 static void __init psci_0_2_set_functions(void)
557 pr_info("Using standard PSCI v0.2 function IDs\n");
558 psci_ops.get_version = psci_get_version;
560 psci_function_id[PSCI_FN_CPU_SUSPEND] =
561 PSCI_FN_NATIVE(0_2, CPU_SUSPEND);
562 psci_ops.cpu_suspend = psci_cpu_suspend;
564 psci_function_id[PSCI_FN_CPU_OFF] = PSCI_0_2_FN_CPU_OFF;
565 psci_ops.cpu_off = psci_cpu_off;
567 psci_function_id[PSCI_FN_CPU_ON] = PSCI_FN_NATIVE(0_2, CPU_ON);
568 psci_ops.cpu_on = psci_cpu_on;
570 psci_function_id[PSCI_FN_MIGRATE] = PSCI_FN_NATIVE(0_2, MIGRATE);
571 psci_ops.migrate = psci_migrate;
573 psci_ops.affinity_info = psci_affinity_info;
575 psci_ops.migrate_info_type = psci_migrate_info_type;
577 arm_pm_restart = psci_sys_reset;
579 pm_power_off = psci_sys_poweroff;
583 * Probe function for PSCI firmware versions >= 0.2
585 static int __init psci_probe(void)
587 u32 ver = psci_get_version();
589 pr_info("PSCIv%d.%d detected in firmware.\n",
590 PSCI_VERSION_MAJOR(ver),
591 PSCI_VERSION_MINOR(ver));
593 if (PSCI_VERSION_MAJOR(ver) == 0 && PSCI_VERSION_MINOR(ver) < 2) {
594 pr_err("Conflicting PSCI version detected.\n");
598 psci_0_2_set_functions();
602 if (PSCI_VERSION_MAJOR(ver) >= 1) {
604 psci_init_cpu_suspend();
605 psci_init_system_suspend();
611 typedef int (*psci_initcall_t)(const struct device_node *);
614 * PSCI init function for PSCI versions >=0.2
616 * Probe based on PSCI PSCI_VERSION function
618 static int __init psci_0_2_init(struct device_node *np)
622 err = get_set_conduit_method(np);
627 * Starting with v0.2, the PSCI specification introduced a call
628 * (PSCI_VERSION) that allows probing the firmware version, so
629 * that PSCI function IDs and version specific initialization
630 * can be carried out according to the specific version reported
641 * PSCI < v0.2 get PSCI Function IDs via DT.
643 static int __init psci_0_1_init(struct device_node *np)
648 err = get_set_conduit_method(np);
653 pr_info("Using PSCI v0.1 Function IDs from DT\n");
655 if (!of_property_read_u32(np, "cpu_suspend", &id)) {
656 psci_function_id[PSCI_FN_CPU_SUSPEND] = id;
657 psci_ops.cpu_suspend = psci_cpu_suspend;
660 if (!of_property_read_u32(np, "cpu_off", &id)) {
661 psci_function_id[PSCI_FN_CPU_OFF] = id;
662 psci_ops.cpu_off = psci_cpu_off;
665 if (!of_property_read_u32(np, "cpu_on", &id)) {
666 psci_function_id[PSCI_FN_CPU_ON] = id;
667 psci_ops.cpu_on = psci_cpu_on;
670 if (!of_property_read_u32(np, "migrate", &id)) {
671 psci_function_id[PSCI_FN_MIGRATE] = id;
672 psci_ops.migrate = psci_migrate;
680 static const struct of_device_id psci_of_match[] __initconst = {
681 { .compatible = "arm,psci", .data = psci_0_1_init},
682 { .compatible = "arm,psci-0.2", .data = psci_0_2_init},
683 { .compatible = "arm,psci-1.0", .data = psci_0_2_init},
687 int __init psci_dt_init(void)
689 struct device_node *np;
690 const struct of_device_id *matched_np;
691 psci_initcall_t init_fn;
693 np = of_find_matching_node_and_match(NULL, psci_of_match, &matched_np);
695 if (!np || !of_device_is_available(np))
698 init_fn = (psci_initcall_t)matched_np->data;
704 * We use PSCI 0.2+ when ACPI is deployed on ARM64 and it's
705 * explicitly clarified in SBBR
707 int __init psci_acpi_init(void)
709 if (!acpi_psci_present()) {
710 pr_info("is not implemented in ACPI.\n");
714 pr_info("probing for conduit method from ACPI.\n");
716 if (acpi_psci_use_hvc())
717 set_conduit(PSCI_CONDUIT_HVC);
719 set_conduit(PSCI_CONDUIT_SMC);