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>
37 #ifdef CONFIG_FIQ_DEBUGGER_EL3_TO_EL1
38 #include <linux/rockchip/rockchip_sip.h>
42 * While a 64-bit OS can make calls with SMC32 calling conventions, for some
43 * calls it is necessary to use SMC64 to pass or return 64-bit values.
44 * For such calls PSCI_FN_NATIVE(version, name) will choose the appropriate
45 * (native-width) function ID.
48 #define PSCI_FN_NATIVE(version, name) PSCI_##version##_FN64_##name
50 #define PSCI_FN_NATIVE(version, name) PSCI_##version##_FN_##name
54 * The CPU any Trusted OS is resident on. The trusted OS may reject CPU_OFF
55 * calls to its resident CPU, so we must avoid issuing those. We never migrate
56 * a Trusted OS even if it claims to be capable of migration -- doing so will
57 * require cooperation with a Trusted OS driver.
59 static int resident_cpu = -1;
61 bool psci_tos_resident_on(int cpu)
63 return cpu == resident_cpu;
66 struct psci_operations psci_ops;
68 typedef unsigned long (psci_fn)(unsigned long, unsigned long,
69 unsigned long, unsigned long);
70 static psci_fn *invoke_psci_fn;
80 static u32 psci_function_id[PSCI_FN_MAX];
82 #define PSCI_0_2_POWER_STATE_MASK \
83 (PSCI_0_2_POWER_STATE_ID_MASK | \
84 PSCI_0_2_POWER_STATE_TYPE_MASK | \
85 PSCI_0_2_POWER_STATE_AFFL_MASK)
87 #define PSCI_1_0_EXT_POWER_STATE_MASK \
88 (PSCI_1_0_EXT_POWER_STATE_ID_MASK | \
89 PSCI_1_0_EXT_POWER_STATE_TYPE_MASK)
91 static u32 psci_cpu_suspend_feature;
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 bool psci_power_state_loses_context(u32 state)
101 const u32 mask = psci_has_ext_power_state() ?
102 PSCI_1_0_EXT_POWER_STATE_TYPE_MASK :
103 PSCI_0_2_POWER_STATE_TYPE_MASK;
108 bool psci_power_state_is_valid(u32 state)
110 const u32 valid_mask = psci_has_ext_power_state() ?
111 PSCI_1_0_EXT_POWER_STATE_MASK :
112 PSCI_0_2_POWER_STATE_MASK;
114 return !(state & ~valid_mask);
117 static unsigned long __invoke_psci_fn_hvc(unsigned long function_id,
118 unsigned long arg0, unsigned long arg1,
121 struct arm_smccc_res res;
123 arm_smccc_hvc(function_id, arg0, arg1, arg2, 0, 0, 0, 0, &res);
127 static unsigned long __invoke_psci_fn_smc(unsigned long function_id,
128 unsigned long arg0, unsigned long arg1,
131 struct arm_smccc_res res;
133 arm_smccc_smc(function_id, arg0, arg1, arg2, 0, 0, 0, 0, &res);
137 static int psci_to_linux_errno(int errno)
140 case PSCI_RET_SUCCESS:
142 case PSCI_RET_NOT_SUPPORTED:
144 case PSCI_RET_INVALID_PARAMS:
145 case PSCI_RET_INVALID_ADDRESS:
147 case PSCI_RET_DENIED:
154 static u32 psci_get_version(void)
156 return invoke_psci_fn(PSCI_0_2_FN_PSCI_VERSION, 0, 0, 0);
159 static int psci_cpu_suspend(u32 state, unsigned long entry_point)
164 fn = psci_function_id[PSCI_FN_CPU_SUSPEND];
165 err = invoke_psci_fn(fn, state, entry_point, 0);
166 return psci_to_linux_errno(err);
169 static int psci_cpu_off(u32 state)
174 fn = psci_function_id[PSCI_FN_CPU_OFF];
175 err = invoke_psci_fn(fn, state, 0, 0);
176 return psci_to_linux_errno(err);
179 static int psci_cpu_on(unsigned long cpuid, unsigned long entry_point)
184 fn = psci_function_id[PSCI_FN_CPU_ON];
185 err = invoke_psci_fn(fn, cpuid, entry_point, 0);
186 return psci_to_linux_errno(err);
189 static int psci_migrate(unsigned long cpuid)
194 fn = psci_function_id[PSCI_FN_MIGRATE];
195 err = invoke_psci_fn(fn, cpuid, 0, 0);
196 return psci_to_linux_errno(err);
199 static int psci_affinity_info(unsigned long target_affinity,
200 unsigned long lowest_affinity_level)
202 return invoke_psci_fn(PSCI_FN_NATIVE(0_2, AFFINITY_INFO),
203 target_affinity, lowest_affinity_level, 0);
206 static int psci_migrate_info_type(void)
208 return invoke_psci_fn(PSCI_0_2_FN_MIGRATE_INFO_TYPE, 0, 0, 0);
211 static unsigned long psci_migrate_info_up_cpu(void)
213 return invoke_psci_fn(PSCI_FN_NATIVE(0_2, MIGRATE_INFO_UP_CPU),
217 static int get_set_conduit_method(struct device_node *np)
221 pr_info("probing for conduit method from DT.\n");
223 if (of_property_read_string(np, "method", &method)) {
224 pr_warn("missing \"method\" property\n");
228 if (!strcmp("hvc", method)) {
229 invoke_psci_fn = __invoke_psci_fn_hvc;
230 } else if (!strcmp("smc", method)) {
231 invoke_psci_fn = __invoke_psci_fn_smc;
233 pr_warn("invalid \"method\" property: %s\n", method);
239 static void psci_sys_reset(enum reboot_mode reboot_mode, const char *cmd)
241 invoke_psci_fn(PSCI_0_2_FN_SYSTEM_RESET, 0, 0, 0);
244 static void psci_sys_poweroff(void)
246 invoke_psci_fn(PSCI_0_2_FN_SYSTEM_OFF, 0, 0, 0);
249 static int __init psci_features(u32 psci_func_id)
251 return invoke_psci_fn(PSCI_1_0_FN_PSCI_FEATURES,
255 #ifdef CONFIG_CPU_IDLE
256 static DEFINE_PER_CPU_READ_MOSTLY(u32 *, psci_power_state);
258 static int psci_dt_cpu_init_idle(struct device_node *cpu_node, int cpu)
260 int i, ret, count = 0;
262 struct device_node *state_node;
265 * If the PSCI cpu_suspend function hook has not been initialized
266 * idle states must not be enabled, so bail out
268 if (!psci_ops.cpu_suspend)
271 /* Count idle states */
272 while ((state_node = of_parse_phandle(cpu_node, "cpu-idle-states",
275 of_node_put(state_node);
281 psci_states = kcalloc(count, sizeof(*psci_states), GFP_KERNEL);
285 for (i = 0; i < count; i++) {
288 state_node = of_parse_phandle(cpu_node, "cpu-idle-states", i);
290 ret = of_property_read_u32(state_node,
291 "arm,psci-suspend-param",
294 pr_warn(" * %s missing arm,psci-suspend-param property\n",
295 state_node->full_name);
296 of_node_put(state_node);
300 of_node_put(state_node);
301 pr_debug("psci-power-state %#x index %d\n", state, i);
302 if (!psci_power_state_is_valid(state)) {
303 pr_warn("Invalid PSCI power state %#x\n", state);
307 psci_states[i] = state;
309 /* Idle states parsed correctly, initialize per-cpu pointer */
310 per_cpu(psci_power_state, cpu) = psci_states;
318 int psci_cpu_init_idle(unsigned int cpu)
320 struct device_node *cpu_node;
323 cpu_node = of_get_cpu_node(cpu, NULL);
327 ret = psci_dt_cpu_init_idle(cpu_node, cpu);
329 of_node_put(cpu_node);
334 static int psci_suspend_finisher(unsigned long index)
336 u32 *state = __this_cpu_read(psci_power_state);
338 return psci_ops.cpu_suspend(state[index - 1],
339 virt_to_phys(cpu_resume));
342 int psci_cpu_suspend_enter(unsigned long index)
345 u32 *state = __this_cpu_read(psci_power_state);
347 * idle state index 0 corresponds to wfi, should never be called
348 * from the cpu_suspend operations
350 if (WARN_ON_ONCE(!index))
353 if (!psci_power_state_loses_context(state[index - 1]))
354 ret = psci_ops.cpu_suspend(state[index - 1], 0);
356 ret = cpu_suspend(index, psci_suspend_finisher);
358 #ifdef CONFIG_FIQ_DEBUGGER_EL3_TO_EL1
364 /* ARM specific CPU idle operations */
366 static struct cpuidle_ops psci_cpuidle_ops __initdata = {
367 .suspend = psci_cpu_suspend_enter,
368 .init = psci_dt_cpu_init_idle,
371 CPUIDLE_METHOD_OF_DECLARE(psci, "arm,psci", &psci_cpuidle_ops);
375 static int psci_system_suspend(unsigned long unused)
377 return invoke_psci_fn(PSCI_FN_NATIVE(1_0, SYSTEM_SUSPEND),
378 virt_to_phys(cpu_resume), 0, 0);
381 static int psci_system_suspend_enter(suspend_state_t state)
383 return cpu_suspend(0, psci_system_suspend);
386 static int psci_system_suspend_prepare(void)
388 return regulator_suspend_prepare(PM_SUSPEND_MEM);
391 static void psci_system_suspend_finish(void)
395 ret = regulator_suspend_finish();
397 pr_warn("regulator_suspend_finish failed (%d)\n", ret);
400 static const struct platform_suspend_ops psci_suspend_ops = {
401 .valid = suspend_valid_only_mem,
402 .enter = psci_system_suspend_enter,
403 .prepare = psci_system_suspend_prepare,
404 .finish = psci_system_suspend_finish,
407 static void __init psci_init_system_suspend(void)
411 if (!IS_ENABLED(CONFIG_SUSPEND))
414 ret = psci_features(PSCI_FN_NATIVE(1_0, SYSTEM_SUSPEND));
416 if (ret != PSCI_RET_NOT_SUPPORTED)
417 suspend_set_ops(&psci_suspend_ops);
420 static void __init psci_init_cpu_suspend(void)
422 int feature = psci_features(psci_function_id[PSCI_FN_CPU_SUSPEND]);
424 if (feature != PSCI_RET_NOT_SUPPORTED)
425 psci_cpu_suspend_feature = feature;
429 * Detect the presence of a resident Trusted OS which may cause CPU_OFF to
430 * return DENIED (which would be fatal).
432 static void __init psci_init_migrate(void)
437 type = psci_ops.migrate_info_type();
439 if (type == PSCI_0_2_TOS_MP) {
440 pr_info("Trusted OS migration not required\n");
444 if (type == PSCI_RET_NOT_SUPPORTED) {
445 pr_info("MIGRATE_INFO_TYPE not supported.\n");
449 if (type != PSCI_0_2_TOS_UP_MIGRATE &&
450 type != PSCI_0_2_TOS_UP_NO_MIGRATE) {
451 pr_err("MIGRATE_INFO_TYPE returned unknown type (%d)\n", type);
455 cpuid = psci_migrate_info_up_cpu();
456 if (cpuid & ~MPIDR_HWID_BITMASK) {
457 pr_warn("MIGRATE_INFO_UP_CPU reported invalid physical ID (0x%lx)\n",
462 cpu = get_logical_index(cpuid);
463 resident_cpu = cpu >= 0 ? cpu : -1;
465 pr_info("Trusted OS resident on physical CPU 0x%lx\n", cpuid);
468 static void __init psci_0_2_set_functions(void)
470 pr_info("Using standard PSCI v0.2 function IDs\n");
471 psci_function_id[PSCI_FN_CPU_SUSPEND] =
472 PSCI_FN_NATIVE(0_2, CPU_SUSPEND);
473 psci_ops.cpu_suspend = psci_cpu_suspend;
475 psci_function_id[PSCI_FN_CPU_OFF] = PSCI_0_2_FN_CPU_OFF;
476 psci_ops.cpu_off = psci_cpu_off;
478 psci_function_id[PSCI_FN_CPU_ON] = PSCI_FN_NATIVE(0_2, CPU_ON);
479 psci_ops.cpu_on = psci_cpu_on;
481 psci_function_id[PSCI_FN_MIGRATE] = PSCI_FN_NATIVE(0_2, MIGRATE);
482 psci_ops.migrate = psci_migrate;
484 psci_ops.affinity_info = psci_affinity_info;
486 psci_ops.migrate_info_type = psci_migrate_info_type;
488 arm_pm_restart = psci_sys_reset;
490 pm_power_off = psci_sys_poweroff;
494 * Probe function for PSCI firmware versions >= 0.2
496 static int __init psci_probe(void)
498 u32 ver = psci_get_version();
500 pr_info("PSCIv%d.%d detected in firmware.\n",
501 PSCI_VERSION_MAJOR(ver),
502 PSCI_VERSION_MINOR(ver));
504 if (PSCI_VERSION_MAJOR(ver) == 0 && PSCI_VERSION_MINOR(ver) < 2) {
505 pr_err("Conflicting PSCI version detected.\n");
509 psci_0_2_set_functions();
513 if (PSCI_VERSION_MAJOR(ver) >= 1) {
514 psci_init_cpu_suspend();
515 psci_init_system_suspend();
521 typedef int (*psci_initcall_t)(const struct device_node *);
524 * PSCI init function for PSCI versions >=0.2
526 * Probe based on PSCI PSCI_VERSION function
528 static int __init psci_0_2_init(struct device_node *np)
532 err = get_set_conduit_method(np);
537 * Starting with v0.2, the PSCI specification introduced a call
538 * (PSCI_VERSION) that allows probing the firmware version, so
539 * that PSCI function IDs and version specific initialization
540 * can be carried out according to the specific version reported
551 * PSCI < v0.2 get PSCI Function IDs via DT.
553 static int __init psci_0_1_init(struct device_node *np)
558 err = get_set_conduit_method(np);
563 pr_info("Using PSCI v0.1 Function IDs from DT\n");
565 if (!of_property_read_u32(np, "cpu_suspend", &id)) {
566 psci_function_id[PSCI_FN_CPU_SUSPEND] = id;
567 psci_ops.cpu_suspend = psci_cpu_suspend;
570 if (!of_property_read_u32(np, "cpu_off", &id)) {
571 psci_function_id[PSCI_FN_CPU_OFF] = id;
572 psci_ops.cpu_off = psci_cpu_off;
575 if (!of_property_read_u32(np, "cpu_on", &id)) {
576 psci_function_id[PSCI_FN_CPU_ON] = id;
577 psci_ops.cpu_on = psci_cpu_on;
580 if (!of_property_read_u32(np, "migrate", &id)) {
581 psci_function_id[PSCI_FN_MIGRATE] = id;
582 psci_ops.migrate = psci_migrate;
590 static const struct of_device_id const psci_of_match[] __initconst = {
591 { .compatible = "arm,psci", .data = psci_0_1_init},
592 { .compatible = "arm,psci-0.2", .data = psci_0_2_init},
593 { .compatible = "arm,psci-1.0", .data = psci_0_2_init},
597 int __init psci_dt_init(void)
599 struct device_node *np;
600 const struct of_device_id *matched_np;
601 psci_initcall_t init_fn;
603 np = of_find_matching_node_and_match(NULL, psci_of_match, &matched_np);
608 init_fn = (psci_initcall_t)matched_np->data;
614 * We use PSCI 0.2+ when ACPI is deployed on ARM64 and it's
615 * explicitly clarified in SBBR
617 int __init psci_acpi_init(void)
619 if (!acpi_psci_present()) {
620 pr_info("is not implemented in ACPI.\n");
624 pr_info("probing for conduit method from ACPI.\n");
626 if (acpi_psci_use_hvc())
627 invoke_psci_fn = __invoke_psci_fn_hvc;
629 invoke_psci_fn = __invoke_psci_fn_smc;