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
;
92 static inline bool psci_has_ext_power_state(void)
94 return psci_cpu_suspend_feature
&
95 PSCI_1_0_FEATURES_CPU_SUSPEND_PF_MASK
;
98 static inline bool psci_power_state_loses_context(u32 state
)
100 const u32 mask
= psci_has_ext_power_state() ?
101 PSCI_1_0_EXT_POWER_STATE_TYPE_MASK
:
102 PSCI_0_2_POWER_STATE_TYPE_MASK
;
107 static inline bool psci_power_state_is_valid(u32 state
)
109 const u32 valid_mask
= psci_has_ext_power_state() ?
110 PSCI_1_0_EXT_POWER_STATE_MASK
:
111 PSCI_0_2_POWER_STATE_MASK
;
113 return !(state
& ~valid_mask
);
116 static unsigned long __invoke_psci_fn_hvc(unsigned long function_id
,
117 unsigned long arg0
, unsigned long arg1
,
120 struct arm_smccc_res res
;
122 arm_smccc_hvc(function_id
, arg0
, arg1
, arg2
, 0, 0, 0, 0, &res
);
126 static unsigned long __invoke_psci_fn_smc(unsigned long function_id
,
127 unsigned long arg0
, unsigned long arg1
,
130 struct arm_smccc_res res
;
132 arm_smccc_smc(function_id
, arg0
, arg1
, arg2
, 0, 0, 0, 0, &res
);
136 static int psci_to_linux_errno(int errno
)
139 case PSCI_RET_SUCCESS
:
141 case PSCI_RET_NOT_SUPPORTED
:
143 case PSCI_RET_INVALID_PARAMS
:
144 case PSCI_RET_INVALID_ADDRESS
:
146 case PSCI_RET_DENIED
:
153 static u32
psci_get_version(void)
155 return invoke_psci_fn(PSCI_0_2_FN_PSCI_VERSION
, 0, 0, 0);
158 static int psci_cpu_suspend(u32 state
, unsigned long entry_point
)
163 fn
= psci_function_id
[PSCI_FN_CPU_SUSPEND
];
164 err
= invoke_psci_fn(fn
, state
, entry_point
, 0);
165 return psci_to_linux_errno(err
);
168 static int psci_cpu_off(u32 state
)
173 fn
= psci_function_id
[PSCI_FN_CPU_OFF
];
174 err
= invoke_psci_fn(fn
, state
, 0, 0);
175 return psci_to_linux_errno(err
);
178 static int psci_cpu_on(unsigned long cpuid
, unsigned long entry_point
)
183 fn
= psci_function_id
[PSCI_FN_CPU_ON
];
184 err
= invoke_psci_fn(fn
, cpuid
, entry_point
, 0);
185 return psci_to_linux_errno(err
);
188 static int psci_migrate(unsigned long cpuid
)
193 fn
= psci_function_id
[PSCI_FN_MIGRATE
];
194 err
= invoke_psci_fn(fn
, cpuid
, 0, 0);
195 return psci_to_linux_errno(err
);
198 static int psci_affinity_info(unsigned long target_affinity
,
199 unsigned long lowest_affinity_level
)
201 return invoke_psci_fn(PSCI_FN_NATIVE(0_2
, AFFINITY_INFO
),
202 target_affinity
, lowest_affinity_level
, 0);
205 static int psci_migrate_info_type(void)
207 return invoke_psci_fn(PSCI_0_2_FN_MIGRATE_INFO_TYPE
, 0, 0, 0);
210 static unsigned long psci_migrate_info_up_cpu(void)
212 return invoke_psci_fn(PSCI_FN_NATIVE(0_2
, MIGRATE_INFO_UP_CPU
),
216 static void set_conduit(enum psci_conduit conduit
)
219 case PSCI_CONDUIT_HVC
:
220 invoke_psci_fn
= __invoke_psci_fn_hvc
;
222 case PSCI_CONDUIT_SMC
:
223 invoke_psci_fn
= __invoke_psci_fn_smc
;
226 WARN(1, "Unexpected PSCI conduit %d\n", conduit
);
229 psci_ops
.conduit
= conduit
;
232 static int get_set_conduit_method(struct device_node
*np
)
236 pr_info("probing for conduit method from DT.\n");
238 if (of_property_read_string(np
, "method", &method
)) {
239 pr_warn("missing \"method\" property\n");
243 if (!strcmp("hvc", method
)) {
244 set_conduit(PSCI_CONDUIT_HVC
);
245 } else if (!strcmp("smc", method
)) {
246 set_conduit(PSCI_CONDUIT_SMC
);
248 pr_warn("invalid \"method\" property: %s\n", method
);
254 static void psci_sys_reset(enum reboot_mode reboot_mode
, const char *cmd
)
256 invoke_psci_fn(PSCI_0_2_FN_SYSTEM_RESET
, 0, 0, 0);
259 static void psci_sys_poweroff(void)
261 invoke_psci_fn(PSCI_0_2_FN_SYSTEM_OFF
, 0, 0, 0);
264 static int __init
psci_features(u32 psci_func_id
)
266 return invoke_psci_fn(PSCI_1_0_FN_PSCI_FEATURES
,
270 #ifdef CONFIG_CPU_IDLE
271 static DEFINE_PER_CPU_READ_MOSTLY(u32
*, psci_power_state
);
273 static int psci_dt_cpu_init_idle(struct device_node
*cpu_node
, int cpu
)
275 int i
, ret
, count
= 0;
277 struct device_node
*state_node
;
279 /* Count idle states */
280 while ((state_node
= of_parse_phandle(cpu_node
, "cpu-idle-states",
283 of_node_put(state_node
);
289 psci_states
= kcalloc(count
, sizeof(*psci_states
), GFP_KERNEL
);
293 for (i
= 0; i
< count
; i
++) {
296 state_node
= of_parse_phandle(cpu_node
, "cpu-idle-states", i
);
298 ret
= of_property_read_u32(state_node
,
299 "arm,psci-suspend-param",
302 pr_warn(" * %pOF missing arm,psci-suspend-param property\n",
304 of_node_put(state_node
);
308 of_node_put(state_node
);
309 pr_debug("psci-power-state %#x index %d\n", state
, i
);
310 if (!psci_power_state_is_valid(state
)) {
311 pr_warn("Invalid PSCI power state %#x\n", state
);
315 psci_states
[i
] = state
;
317 /* Idle states parsed correctly, initialize per-cpu pointer */
318 per_cpu(psci_power_state
, cpu
) = psci_states
;
327 #include <acpi/processor.h>
329 static int __maybe_unused
psci_acpi_cpu_init_idle(unsigned int cpu
)
333 struct acpi_lpi_state
*lpi
;
334 struct acpi_processor
*pr
= per_cpu(processors
, cpu
);
336 if (unlikely(!pr
|| !pr
->flags
.has_lpi
))
339 count
= pr
->power
.count
- 1;
343 psci_states
= kcalloc(count
, sizeof(*psci_states
), GFP_KERNEL
);
347 for (i
= 0; i
< count
; i
++) {
350 lpi
= &pr
->power
.lpi_states
[i
+ 1];
352 * Only bits[31:0] represent a PSCI power_state while
353 * bits[63:32] must be 0x0 as per ARM ACPI FFH Specification
355 state
= lpi
->address
;
356 if (!psci_power_state_is_valid(state
)) {
357 pr_warn("Invalid PSCI power state %#x\n", state
);
361 psci_states
[i
] = state
;
363 /* Idle states parsed correctly, initialize per-cpu pointer */
364 per_cpu(psci_power_state
, cpu
) = psci_states
;
368 static int __maybe_unused
psci_acpi_cpu_init_idle(unsigned int cpu
)
374 int psci_cpu_init_idle(unsigned int cpu
)
376 struct device_node
*cpu_node
;
380 * If the PSCI cpu_suspend function hook has not been initialized
381 * idle states must not be enabled, so bail out
383 if (!psci_ops
.cpu_suspend
)
387 return psci_acpi_cpu_init_idle(cpu
);
389 cpu_node
= of_get_cpu_node(cpu
, NULL
);
393 ret
= psci_dt_cpu_init_idle(cpu_node
, cpu
);
395 of_node_put(cpu_node
);
400 static int psci_suspend_finisher(unsigned long index
)
402 u32
*state
= __this_cpu_read(psci_power_state
);
404 return psci_ops
.cpu_suspend(state
[index
- 1],
405 __pa_symbol(cpu_resume
));
408 int psci_cpu_suspend_enter(unsigned long index
)
411 u32
*state
= __this_cpu_read(psci_power_state
);
413 * idle state index 0 corresponds to wfi, should never be called
414 * from the cpu_suspend operations
416 if (WARN_ON_ONCE(!index
))
419 if (!psci_power_state_loses_context(state
[index
- 1]))
420 ret
= psci_ops
.cpu_suspend(state
[index
- 1], 0);
422 ret
= cpu_suspend(index
, psci_suspend_finisher
);
427 /* ARM specific CPU idle operations */
429 static const struct cpuidle_ops psci_cpuidle_ops __initconst
= {
430 .suspend
= psci_cpu_suspend_enter
,
431 .init
= psci_dt_cpu_init_idle
,
434 CPUIDLE_METHOD_OF_DECLARE(psci
, "psci", &psci_cpuidle_ops
);
438 static int psci_system_suspend(unsigned long unused
)
440 return invoke_psci_fn(PSCI_FN_NATIVE(1_0
, SYSTEM_SUSPEND
),
441 __pa_symbol(cpu_resume
), 0, 0);
444 static int psci_system_suspend_enter(suspend_state_t state
)
446 return cpu_suspend(0, psci_system_suspend
);
449 static const struct platform_suspend_ops psci_suspend_ops
= {
450 .valid
= suspend_valid_only_mem
,
451 .enter
= psci_system_suspend_enter
,
454 static void __init
psci_init_system_suspend(void)
458 if (!IS_ENABLED(CONFIG_SUSPEND
))
461 ret
= psci_features(PSCI_FN_NATIVE(1_0
, SYSTEM_SUSPEND
));
463 if (ret
!= PSCI_RET_NOT_SUPPORTED
)
464 suspend_set_ops(&psci_suspend_ops
);
467 static void __init
psci_init_cpu_suspend(void)
469 int feature
= psci_features(psci_function_id
[PSCI_FN_CPU_SUSPEND
]);
471 if (feature
!= PSCI_RET_NOT_SUPPORTED
)
472 psci_cpu_suspend_feature
= feature
;
476 * Detect the presence of a resident Trusted OS which may cause CPU_OFF to
477 * return DENIED (which would be fatal).
479 static void __init
psci_init_migrate(void)
484 type
= psci_ops
.migrate_info_type();
486 if (type
== PSCI_0_2_TOS_MP
) {
487 pr_info("Trusted OS migration not required\n");
491 if (type
== PSCI_RET_NOT_SUPPORTED
) {
492 pr_info("MIGRATE_INFO_TYPE not supported.\n");
496 if (type
!= PSCI_0_2_TOS_UP_MIGRATE
&&
497 type
!= PSCI_0_2_TOS_UP_NO_MIGRATE
) {
498 pr_err("MIGRATE_INFO_TYPE returned unknown type (%d)\n", type
);
502 cpuid
= psci_migrate_info_up_cpu();
503 if (cpuid
& ~MPIDR_HWID_BITMASK
) {
504 pr_warn("MIGRATE_INFO_UP_CPU reported invalid physical ID (0x%lx)\n",
509 cpu
= get_logical_index(cpuid
);
510 resident_cpu
= cpu
>= 0 ? cpu
: -1;
512 pr_info("Trusted OS resident on physical CPU 0x%lx\n", cpuid
);
515 static void __init
psci_init_smccc(void)
517 u32 ver
= ARM_SMCCC_VERSION_1_0
;
520 feature
= psci_features(ARM_SMCCC_VERSION_FUNC_ID
);
522 if (feature
!= PSCI_RET_NOT_SUPPORTED
) {
524 ret
= invoke_psci_fn(ARM_SMCCC_VERSION_FUNC_ID
, 0, 0, 0);
525 if (ret
== ARM_SMCCC_VERSION_1_1
) {
526 psci_ops
.smccc_version
= SMCCC_VERSION_1_1
;
532 * Conveniently, the SMCCC and PSCI versions are encoded the
533 * same way. No, this isn't accidental.
535 pr_info("SMC Calling Convention v%d.%d\n",
536 PSCI_VERSION_MAJOR(ver
), PSCI_VERSION_MINOR(ver
));
540 static void __init
psci_0_2_set_functions(void)
542 pr_info("Using standard PSCI v0.2 function IDs\n");
543 psci_ops
.get_version
= psci_get_version
;
545 psci_function_id
[PSCI_FN_CPU_SUSPEND
] =
546 PSCI_FN_NATIVE(0_2
, CPU_SUSPEND
);
547 psci_ops
.cpu_suspend
= psci_cpu_suspend
;
549 psci_function_id
[PSCI_FN_CPU_OFF
] = PSCI_0_2_FN_CPU_OFF
;
550 psci_ops
.cpu_off
= psci_cpu_off
;
552 psci_function_id
[PSCI_FN_CPU_ON
] = PSCI_FN_NATIVE(0_2
, CPU_ON
);
553 psci_ops
.cpu_on
= psci_cpu_on
;
555 psci_function_id
[PSCI_FN_MIGRATE
] = PSCI_FN_NATIVE(0_2
, MIGRATE
);
556 psci_ops
.migrate
= psci_migrate
;
558 psci_ops
.affinity_info
= psci_affinity_info
;
560 psci_ops
.migrate_info_type
= psci_migrate_info_type
;
562 arm_pm_restart
= psci_sys_reset
;
564 pm_power_off
= psci_sys_poweroff
;
568 * Probe function for PSCI firmware versions >= 0.2
570 static int __init
psci_probe(void)
572 u32 ver
= psci_get_version();
574 pr_info("PSCIv%d.%d detected in firmware.\n",
575 PSCI_VERSION_MAJOR(ver
),
576 PSCI_VERSION_MINOR(ver
));
578 if (PSCI_VERSION_MAJOR(ver
) == 0 && PSCI_VERSION_MINOR(ver
) < 2) {
579 pr_err("Conflicting PSCI version detected.\n");
583 psci_0_2_set_functions();
587 if (PSCI_VERSION_MAJOR(ver
) >= 1) {
589 psci_init_cpu_suspend();
590 psci_init_system_suspend();
596 typedef int (*psci_initcall_t
)(const struct device_node
*);
599 * PSCI init function for PSCI versions >=0.2
601 * Probe based on PSCI PSCI_VERSION function
603 static int __init
psci_0_2_init(struct device_node
*np
)
607 err
= get_set_conduit_method(np
);
612 * Starting with v0.2, the PSCI specification introduced a call
613 * (PSCI_VERSION) that allows probing the firmware version, so
614 * that PSCI function IDs and version specific initialization
615 * can be carried out according to the specific version reported
626 * PSCI < v0.2 get PSCI Function IDs via DT.
628 static int __init
psci_0_1_init(struct device_node
*np
)
633 err
= get_set_conduit_method(np
);
638 pr_info("Using PSCI v0.1 Function IDs from DT\n");
640 if (!of_property_read_u32(np
, "cpu_suspend", &id
)) {
641 psci_function_id
[PSCI_FN_CPU_SUSPEND
] = id
;
642 psci_ops
.cpu_suspend
= psci_cpu_suspend
;
645 if (!of_property_read_u32(np
, "cpu_off", &id
)) {
646 psci_function_id
[PSCI_FN_CPU_OFF
] = id
;
647 psci_ops
.cpu_off
= psci_cpu_off
;
650 if (!of_property_read_u32(np
, "cpu_on", &id
)) {
651 psci_function_id
[PSCI_FN_CPU_ON
] = id
;
652 psci_ops
.cpu_on
= psci_cpu_on
;
655 if (!of_property_read_u32(np
, "migrate", &id
)) {
656 psci_function_id
[PSCI_FN_MIGRATE
] = id
;
657 psci_ops
.migrate
= psci_migrate
;
665 static const struct of_device_id psci_of_match
[] __initconst
= {
666 { .compatible
= "arm,psci", .data
= psci_0_1_init
},
667 { .compatible
= "arm,psci-0.2", .data
= psci_0_2_init
},
668 { .compatible
= "arm,psci-1.0", .data
= psci_0_2_init
},
672 int __init
psci_dt_init(void)
674 struct device_node
*np
;
675 const struct of_device_id
*matched_np
;
676 psci_initcall_t init_fn
;
678 np
= of_find_matching_node_and_match(NULL
, psci_of_match
, &matched_np
);
680 if (!np
|| !of_device_is_available(np
))
683 init_fn
= (psci_initcall_t
)matched_np
->data
;
689 * We use PSCI 0.2+ when ACPI is deployed on ARM64 and it's
690 * explicitly clarified in SBBR
692 int __init
psci_acpi_init(void)
694 if (!acpi_psci_present()) {
695 pr_info("is not implemented in ACPI.\n");
699 pr_info("probing for conduit method from ACPI.\n");
701 if (acpi_psci_use_hvc())
702 set_conduit(PSCI_CONDUIT_HVC
);
704 set_conduit(PSCI_CONDUIT_SMC
);