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/errno.h>
18 #include <linux/linkage.h>
21 #include <linux/printk.h>
22 #include <linux/psci.h>
23 #include <linux/reboot.h>
24 #include <linux/suspend.h>
25 #include <linux/regulator/machine.h>
27 #include <uapi/linux/psci.h>
29 #include <asm/cputype.h>
30 #include <asm/system_misc.h>
31 #include <asm/smp_plat.h>
32 #include <asm/suspend.h>
35 * While a 64-bit OS can make calls with SMC32 calling conventions, for some
36 * calls it is necessary to use SMC64 to pass or return 64-bit values.
37 * For such calls PSCI_FN_NATIVE(version, name) will choose the appropriate
38 * (native-width) function ID.
41 #define PSCI_FN_NATIVE(version, name) PSCI_##version##_FN64_##name
43 #define PSCI_FN_NATIVE(version, name) PSCI_##version##_FN_##name
47 * The CPU any Trusted OS is resident on. The trusted OS may reject CPU_OFF
48 * calls to its resident CPU, so we must avoid issuing those. We never migrate
49 * a Trusted OS even if it claims to be capable of migration -- doing so will
50 * require cooperation with a Trusted OS driver.
52 static int resident_cpu = -1;
54 bool psci_tos_resident_on(int cpu)
56 return cpu == resident_cpu;
59 struct psci_operations psci_ops;
61 typedef unsigned long (psci_fn)(unsigned long, unsigned long,
62 unsigned long, unsigned long);
63 static psci_fn *invoke_psci_fn;
73 static u32 psci_function_id[PSCI_FN_MAX];
75 #define PSCI_0_2_POWER_STATE_MASK \
76 (PSCI_0_2_POWER_STATE_ID_MASK | \
77 PSCI_0_2_POWER_STATE_TYPE_MASK | \
78 PSCI_0_2_POWER_STATE_AFFL_MASK)
80 #define PSCI_1_0_EXT_POWER_STATE_MASK \
81 (PSCI_1_0_EXT_POWER_STATE_ID_MASK | \
82 PSCI_1_0_EXT_POWER_STATE_TYPE_MASK)
84 static u32 psci_cpu_suspend_feature;
86 static inline bool psci_has_ext_power_state(void)
88 return psci_cpu_suspend_feature &
89 PSCI_1_0_FEATURES_CPU_SUSPEND_PF_MASK;
92 bool psci_power_state_loses_context(u32 state)
94 const u32 mask = psci_has_ext_power_state() ?
95 PSCI_1_0_EXT_POWER_STATE_TYPE_MASK :
96 PSCI_0_2_POWER_STATE_TYPE_MASK;
101 bool psci_power_state_is_valid(u32 state)
103 const u32 valid_mask = psci_has_ext_power_state() ?
104 PSCI_1_0_EXT_POWER_STATE_MASK :
105 PSCI_0_2_POWER_STATE_MASK;
107 return !(state & ~valid_mask);
110 static unsigned long __invoke_psci_fn_hvc(unsigned long function_id,
111 unsigned long arg0, unsigned long arg1,
114 struct arm_smccc_res res;
116 arm_smccc_hvc(function_id, arg0, arg1, arg2, 0, 0, 0, 0, &res);
120 static unsigned long __invoke_psci_fn_smc(unsigned long function_id,
121 unsigned long arg0, unsigned long arg1,
124 struct arm_smccc_res res;
126 arm_smccc_smc(function_id, arg0, arg1, arg2, 0, 0, 0, 0, &res);
130 static int psci_to_linux_errno(int errno)
133 case PSCI_RET_SUCCESS:
135 case PSCI_RET_NOT_SUPPORTED:
137 case PSCI_RET_INVALID_PARAMS:
138 case PSCI_RET_INVALID_ADDRESS:
140 case PSCI_RET_DENIED:
147 static u32 psci_get_version(void)
149 return invoke_psci_fn(PSCI_0_2_FN_PSCI_VERSION, 0, 0, 0);
152 static int psci_cpu_suspend(u32 state, unsigned long entry_point)
157 fn = psci_function_id[PSCI_FN_CPU_SUSPEND];
158 err = invoke_psci_fn(fn, state, entry_point, 0);
159 return psci_to_linux_errno(err);
162 static int psci_cpu_off(u32 state)
167 fn = psci_function_id[PSCI_FN_CPU_OFF];
168 err = invoke_psci_fn(fn, state, 0, 0);
169 return psci_to_linux_errno(err);
172 static int psci_cpu_on(unsigned long cpuid, unsigned long entry_point)
177 fn = psci_function_id[PSCI_FN_CPU_ON];
178 err = invoke_psci_fn(fn, cpuid, entry_point, 0);
179 return psci_to_linux_errno(err);
182 static int psci_migrate(unsigned long cpuid)
187 fn = psci_function_id[PSCI_FN_MIGRATE];
188 err = invoke_psci_fn(fn, cpuid, 0, 0);
189 return psci_to_linux_errno(err);
192 static int psci_affinity_info(unsigned long target_affinity,
193 unsigned long lowest_affinity_level)
195 return invoke_psci_fn(PSCI_FN_NATIVE(0_2, AFFINITY_INFO),
196 target_affinity, lowest_affinity_level, 0);
199 static int psci_migrate_info_type(void)
201 return invoke_psci_fn(PSCI_0_2_FN_MIGRATE_INFO_TYPE, 0, 0, 0);
204 static unsigned long psci_migrate_info_up_cpu(void)
206 return invoke_psci_fn(PSCI_FN_NATIVE(0_2, MIGRATE_INFO_UP_CPU),
210 static int get_set_conduit_method(struct device_node *np)
214 pr_info("probing for conduit method from DT.\n");
216 if (of_property_read_string(np, "method", &method)) {
217 pr_warn("missing \"method\" property\n");
221 if (!strcmp("hvc", method)) {
222 invoke_psci_fn = __invoke_psci_fn_hvc;
223 } else if (!strcmp("smc", method)) {
224 invoke_psci_fn = __invoke_psci_fn_smc;
226 pr_warn("invalid \"method\" property: %s\n", method);
232 static void psci_sys_reset(enum reboot_mode reboot_mode, const char *cmd)
234 invoke_psci_fn(PSCI_0_2_FN_SYSTEM_RESET, 0, 0, 0);
237 static void psci_sys_poweroff(void)
239 invoke_psci_fn(PSCI_0_2_FN_SYSTEM_OFF, 0, 0, 0);
242 static int __init psci_features(u32 psci_func_id)
244 return invoke_psci_fn(PSCI_1_0_FN_PSCI_FEATURES,
248 static int psci_system_suspend(unsigned long unused)
250 return invoke_psci_fn(PSCI_FN_NATIVE(1_0, SYSTEM_SUSPEND),
251 virt_to_phys(cpu_resume), 0, 0);
254 static int psci_system_suspend_enter(suspend_state_t state)
256 return cpu_suspend(0, psci_system_suspend);
259 static int psci_system_suspend_prepare(void)
261 return regulator_suspend_prepare(PM_SUSPEND_MEM);
264 static void psci_system_suspend_finish(void)
268 ret = regulator_suspend_finish();
270 pr_warn("regulator_suspend_finish failed (%d)\n", ret);
273 static const struct platform_suspend_ops psci_suspend_ops = {
274 .valid = suspend_valid_only_mem,
275 .enter = psci_system_suspend_enter,
276 .prepare = psci_system_suspend_prepare,
277 .finish = psci_system_suspend_finish,
280 static void __init psci_init_system_suspend(void)
284 if (!IS_ENABLED(CONFIG_SUSPEND))
287 ret = psci_features(PSCI_FN_NATIVE(1_0, SYSTEM_SUSPEND));
289 if (ret != PSCI_RET_NOT_SUPPORTED)
290 suspend_set_ops(&psci_suspend_ops);
293 static void __init psci_init_cpu_suspend(void)
295 int feature = psci_features(psci_function_id[PSCI_FN_CPU_SUSPEND]);
297 if (feature != PSCI_RET_NOT_SUPPORTED)
298 psci_cpu_suspend_feature = feature;
302 * Detect the presence of a resident Trusted OS which may cause CPU_OFF to
303 * return DENIED (which would be fatal).
305 static void __init psci_init_migrate(void)
310 type = psci_ops.migrate_info_type();
312 if (type == PSCI_0_2_TOS_MP) {
313 pr_info("Trusted OS migration not required\n");
317 if (type == PSCI_RET_NOT_SUPPORTED) {
318 pr_info("MIGRATE_INFO_TYPE not supported.\n");
322 if (type != PSCI_0_2_TOS_UP_MIGRATE &&
323 type != PSCI_0_2_TOS_UP_NO_MIGRATE) {
324 pr_err("MIGRATE_INFO_TYPE returned unknown type (%d)\n", type);
328 cpuid = psci_migrate_info_up_cpu();
329 if (cpuid & ~MPIDR_HWID_BITMASK) {
330 pr_warn("MIGRATE_INFO_UP_CPU reported invalid physical ID (0x%lx)\n",
335 cpu = get_logical_index(cpuid);
336 resident_cpu = cpu >= 0 ? cpu : -1;
338 pr_info("Trusted OS resident on physical CPU 0x%lx\n", cpuid);
341 static void __init psci_0_2_set_functions(void)
343 pr_info("Using standard PSCI v0.2 function IDs\n");
344 psci_function_id[PSCI_FN_CPU_SUSPEND] =
345 PSCI_FN_NATIVE(0_2, CPU_SUSPEND);
346 psci_ops.cpu_suspend = psci_cpu_suspend;
348 psci_function_id[PSCI_FN_CPU_OFF] = PSCI_0_2_FN_CPU_OFF;
349 psci_ops.cpu_off = psci_cpu_off;
351 psci_function_id[PSCI_FN_CPU_ON] = PSCI_FN_NATIVE(0_2, CPU_ON);
352 psci_ops.cpu_on = psci_cpu_on;
354 psci_function_id[PSCI_FN_MIGRATE] = PSCI_FN_NATIVE(0_2, MIGRATE);
355 psci_ops.migrate = psci_migrate;
357 psci_ops.affinity_info = psci_affinity_info;
359 psci_ops.migrate_info_type = psci_migrate_info_type;
361 arm_pm_restart = psci_sys_reset;
363 pm_power_off = psci_sys_poweroff;
367 * Probe function for PSCI firmware versions >= 0.2
369 static int __init psci_probe(void)
371 u32 ver = psci_get_version();
373 pr_info("PSCIv%d.%d detected in firmware.\n",
374 PSCI_VERSION_MAJOR(ver),
375 PSCI_VERSION_MINOR(ver));
377 if (PSCI_VERSION_MAJOR(ver) == 0 && PSCI_VERSION_MINOR(ver) < 2) {
378 pr_err("Conflicting PSCI version detected.\n");
382 psci_0_2_set_functions();
386 if (PSCI_VERSION_MAJOR(ver) >= 1) {
387 psci_init_cpu_suspend();
388 psci_init_system_suspend();
394 typedef int (*psci_initcall_t)(const struct device_node *);
397 * PSCI init function for PSCI versions >=0.2
399 * Probe based on PSCI PSCI_VERSION function
401 static int __init psci_0_2_init(struct device_node *np)
405 err = get_set_conduit_method(np);
410 * Starting with v0.2, the PSCI specification introduced a call
411 * (PSCI_VERSION) that allows probing the firmware version, so
412 * that PSCI function IDs and version specific initialization
413 * can be carried out according to the specific version reported
424 * PSCI < v0.2 get PSCI Function IDs via DT.
426 static int __init psci_0_1_init(struct device_node *np)
431 err = get_set_conduit_method(np);
436 pr_info("Using PSCI v0.1 Function IDs from DT\n");
438 if (!of_property_read_u32(np, "cpu_suspend", &id)) {
439 psci_function_id[PSCI_FN_CPU_SUSPEND] = id;
440 psci_ops.cpu_suspend = psci_cpu_suspend;
443 if (!of_property_read_u32(np, "cpu_off", &id)) {
444 psci_function_id[PSCI_FN_CPU_OFF] = id;
445 psci_ops.cpu_off = psci_cpu_off;
448 if (!of_property_read_u32(np, "cpu_on", &id)) {
449 psci_function_id[PSCI_FN_CPU_ON] = id;
450 psci_ops.cpu_on = psci_cpu_on;
453 if (!of_property_read_u32(np, "migrate", &id)) {
454 psci_function_id[PSCI_FN_MIGRATE] = id;
455 psci_ops.migrate = psci_migrate;
463 static const struct of_device_id const psci_of_match[] __initconst = {
464 { .compatible = "arm,psci", .data = psci_0_1_init},
465 { .compatible = "arm,psci-0.2", .data = psci_0_2_init},
466 { .compatible = "arm,psci-1.0", .data = psci_0_2_init},
470 int __init psci_dt_init(void)
472 struct device_node *np;
473 const struct of_device_id *matched_np;
474 psci_initcall_t init_fn;
476 np = of_find_matching_node_and_match(NULL, psci_of_match, &matched_np);
481 init_fn = (psci_initcall_t)matched_np->data;
487 * We use PSCI 0.2+ when ACPI is deployed on ARM64 and it's
488 * explicitly clarified in SBBR
490 int __init psci_acpi_init(void)
492 if (!acpi_psci_present()) {
493 pr_info("is not implemented in ACPI.\n");
497 pr_info("probing for conduit method from ACPI.\n");
499 if (acpi_psci_use_hvc())
500 invoke_psci_fn = __invoke_psci_fn_hvc;
502 invoke_psci_fn = __invoke_psci_fn_smc;