[mirror_ubuntu-jammy-kernel.git] / drivers / firmware / psci / psci.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 *
 * Copyright (C) 2015 ARM Limited
 */

#define pr_fmt(fmt) "psci: " fmt

#include <linux/acpi.h>
#include <linux/arm-smccc.h>
#include <linux/cpuidle.h>
#include <linux/errno.h>
#include <linux/linkage.h>
#include <linux/of.h>
#include <linux/pm.h>
#include <linux/printk.h>
#include <linux/psci.h>
#include <linux/reboot.h>
#include <linux/slab.h>
#include <linux/suspend.h>

#include <uapi/linux/psci.h>

#include <asm/cpuidle.h>
#include <asm/cputype.h>
#include <asm/hypervisor.h>
#include <asm/system_misc.h>
#include <asm/smp_plat.h>
#include <asm/suspend.h>

/*
 * While a 64-bit OS can make calls with SMC32 calling conventions, for some
 * calls it is necessary to use SMC64 to pass or return 64-bit values.
 * For such calls PSCI_FN_NATIVE(version, name) will choose the appropriate
 * (native-width) function ID.
 */
#ifdef CONFIG_64BIT
#define PSCI_FN_NATIVE(version, name)	PSCI_##version##_FN64_##name
#else
#define PSCI_FN_NATIVE(version, name)	PSCI_##version##_FN_##name
#endif

/*
 * The CPU any Trusted OS is resident on. The trusted OS may reject CPU_OFF
 * calls to its resident CPU, so we must avoid issuing those. We never migrate
 * a Trusted OS even if it claims to be capable of migration -- doing so will
 * require cooperation with a Trusted OS driver.
 */
static int resident_cpu = -1;
struct psci_operations psci_ops;
static enum arm_smccc_conduit psci_conduit = SMCCC_CONDUIT_NONE;

bool psci_tos_resident_on(int cpu)
{
	return cpu == resident_cpu;
}

typedef unsigned long (psci_fn)(unsigned long, unsigned long,
				unsigned long, unsigned long);
static psci_fn *invoke_psci_fn;

static struct psci_0_1_function_ids psci_0_1_function_ids;

struct psci_0_1_function_ids get_psci_0_1_function_ids(void)
{
	return psci_0_1_function_ids;
}

#define PSCI_0_2_POWER_STATE_MASK		\
				(PSCI_0_2_POWER_STATE_ID_MASK | \
				PSCI_0_2_POWER_STATE_TYPE_MASK | \
				PSCI_0_2_POWER_STATE_AFFL_MASK)

#define PSCI_1_0_EXT_POWER_STATE_MASK		\
				(PSCI_1_0_EXT_POWER_STATE_ID_MASK | \
				PSCI_1_0_EXT_POWER_STATE_TYPE_MASK)

static u32 psci_cpu_suspend_feature;
static bool psci_system_reset2_supported;

static inline bool psci_has_ext_power_state(void)
{
	return psci_cpu_suspend_feature &
				PSCI_1_0_FEATURES_CPU_SUSPEND_PF_MASK;
}

bool psci_has_osi_support(void)
{
	return psci_cpu_suspend_feature & PSCI_1_0_OS_INITIATED;
}

static inline bool psci_power_state_loses_context(u32 state)
{
	const u32 mask = psci_has_ext_power_state() ?
					PSCI_1_0_EXT_POWER_STATE_TYPE_MASK :
					PSCI_0_2_POWER_STATE_TYPE_MASK;

	return state & mask;
}

bool psci_power_state_is_valid(u32 state)
{
	const u32 valid_mask = psci_has_ext_power_state() ?
			       PSCI_1_0_EXT_POWER_STATE_MASK :
			       PSCI_0_2_POWER_STATE_MASK;

	return !(state & ~valid_mask);
}

static unsigned long __invoke_psci_fn_hvc(unsigned long function_id,
			unsigned long arg0, unsigned long arg1,
			unsigned long arg2)
{
	struct arm_smccc_res res;

	arm_smccc_hvc(function_id, arg0, arg1, arg2, 0, 0, 0, 0, &res);
	return res.a0;
}

static unsigned long __invoke_psci_fn_smc(unsigned long function_id,
			unsigned long arg0, unsigned long arg1,
			unsigned long arg2)
{
	struct arm_smccc_res res;

	arm_smccc_smc(function_id, arg0, arg1, arg2, 0, 0, 0, 0, &res);
	return res.a0;
}

static int psci_to_linux_errno(int errno)
{
	switch (errno) {
	case PSCI_RET_SUCCESS:
		return 0;
	case PSCI_RET_NOT_SUPPORTED:
		return -EOPNOTSUPP;
	case PSCI_RET_INVALID_PARAMS:
	case PSCI_RET_INVALID_ADDRESS:
		return -EINVAL;
	case PSCI_RET_DENIED:
		return -EPERM;
	}

	return -EINVAL;
}

static u32 psci_0_1_get_version(void)
{
	return PSCI_VERSION(0, 1);
}

static u32 psci_0_2_get_version(void)
{
	return invoke_psci_fn(PSCI_0_2_FN_PSCI_VERSION, 0, 0, 0);
}

int psci_set_osi_mode(bool enable)
{
	unsigned long suspend_mode;
	int err;

	suspend_mode = enable ? PSCI_1_0_SUSPEND_MODE_OSI :
			PSCI_1_0_SUSPEND_MODE_PC;

	err = invoke_psci_fn(PSCI_1_0_FN_SET_SUSPEND_MODE, suspend_mode, 0, 0);
	return psci_to_linux_errno(err);
}

static int __psci_cpu_suspend(u32 fn, u32 state, unsigned long entry_point)
{
	int err;

	err = invoke_psci_fn(fn, state, entry_point, 0);
	return psci_to_linux_errno(err);
}

static int psci_0_1_cpu_suspend(u32 state, unsigned long entry_point)
{
	return __psci_cpu_suspend(psci_0_1_function_ids.cpu_suspend,
				  state, entry_point);
}

static int psci_0_2_cpu_suspend(u32 state, unsigned long entry_point)
{
	return __psci_cpu_suspend(PSCI_FN_NATIVE(0_2, CPU_SUSPEND),
				  state, entry_point);
}

static int __psci_cpu_off(u32 fn, u32 state)
{
	int err;

	err = invoke_psci_fn(fn, state, 0, 0);
	return psci_to_linux_errno(err);
}

static int psci_0_1_cpu_off(u32 state)
{
	return __psci_cpu_off(psci_0_1_function_ids.cpu_off, state);
}

static int psci_0_2_cpu_off(u32 state)
{
	return __psci_cpu_off(PSCI_0_2_FN_CPU_OFF, state);
}

static int __psci_cpu_on(u32 fn, unsigned long cpuid, unsigned long entry_point)
{
	int err;

	err = invoke_psci_fn(fn, cpuid, entry_point, 0);
	return psci_to_linux_errno(err);
}

static int psci_0_1_cpu_on(unsigned long cpuid, unsigned long entry_point)
{
	return __psci_cpu_on(psci_0_1_function_ids.cpu_on, cpuid, entry_point);
}

static int psci_0_2_cpu_on(unsigned long cpuid, unsigned long entry_point)
{
	return __psci_cpu_on(PSCI_FN_NATIVE(0_2, CPU_ON), cpuid, entry_point);
}

static int __psci_migrate(u32 fn, unsigned long cpuid)
{
	int err;

	err = invoke_psci_fn(fn, cpuid, 0, 0);
	return psci_to_linux_errno(err);
}

static int psci_0_1_migrate(unsigned long cpuid)
{
	return __psci_migrate(psci_0_1_function_ids.migrate, cpuid);
}

static int psci_0_2_migrate(unsigned long cpuid)
{
	return __psci_migrate(PSCI_FN_NATIVE(0_2, MIGRATE), cpuid);
}

static int psci_affinity_info(unsigned long target_affinity,
		unsigned long lowest_affinity_level)
{
	return invoke_psci_fn(PSCI_FN_NATIVE(0_2, AFFINITY_INFO),
			      target_affinity, lowest_affinity_level, 0);
}

static int psci_migrate_info_type(void)
{
	return invoke_psci_fn(PSCI_0_2_FN_MIGRATE_INFO_TYPE, 0, 0, 0);
}

static unsigned long psci_migrate_info_up_cpu(void)
{
	return invoke_psci_fn(PSCI_FN_NATIVE(0_2, MIGRATE_INFO_UP_CPU),
			      0, 0, 0);
}

static void set_conduit(enum arm_smccc_conduit conduit)
{
	switch (conduit) {
	case SMCCC_CONDUIT_HVC:
		invoke_psci_fn = __invoke_psci_fn_hvc;
		break;
	case SMCCC_CONDUIT_SMC:
		invoke_psci_fn = __invoke_psci_fn_smc;
		break;
	default:
		WARN(1, "Unexpected PSCI conduit %d\n", conduit);
	}

	psci_conduit = conduit;
}

static int get_set_conduit_method(struct device_node *np)
{
	const char *method;

	pr_info("probing for conduit method from DT.\n");

	if (of_property_read_string(np, "method", &method)) {
		pr_warn("missing \"method\" property\n");
		return -ENXIO;
	}

	if (!strcmp("hvc", method)) {
		set_conduit(SMCCC_CONDUIT_HVC);
	} else if (!strcmp("smc", method)) {
		set_conduit(SMCCC_CONDUIT_SMC);
	} else {
		pr_warn("invalid \"method\" property: %s\n", method);
		return -EINVAL;
	}
	return 0;
}

static int psci_sys_reset(struct notifier_block *nb, unsigned long action,
			  void *data)
{
	if ((reboot_mode == REBOOT_WARM || reboot_mode == REBOOT_SOFT) &&
	    psci_system_reset2_supported) {
		/*
		 * reset_type[31] = 0 (architectural)
		 * reset_type[30:0] = 0 (SYSTEM_WARM_RESET)
		 * cookie = 0 (ignored by the implementation)
		 */
		invoke_psci_fn(PSCI_FN_NATIVE(1_1, SYSTEM_RESET2), 0, 0, 0);
	} else {
		invoke_psci_fn(PSCI_0_2_FN_SYSTEM_RESET, 0, 0, 0);
	}

	return NOTIFY_DONE;
}

static struct notifier_block psci_sys_reset_nb = {
	.notifier_call = psci_sys_reset,
	.priority = 129,
};

static void psci_sys_poweroff(void)
{
	invoke_psci_fn(PSCI_0_2_FN_SYSTEM_OFF, 0, 0, 0);
}

static int __init psci_features(u32 psci_func_id)
{
	return invoke_psci_fn(PSCI_1_0_FN_PSCI_FEATURES,
			      psci_func_id, 0, 0);
}

#ifdef CONFIG_CPU_IDLE
static int psci_suspend_finisher(unsigned long state)
{
	u32 power_state = state;
	phys_addr_t pa_cpu_resume = __pa_symbol(function_nocfi(cpu_resume));

	return psci_ops.cpu_suspend(power_state, pa_cpu_resume);
}

int psci_cpu_suspend_enter(u32 state)
{
	int ret;

	if (!psci_power_state_loses_context(state)) {
		struct arm_cpuidle_irq_context context;

		arm_cpuidle_save_irq_context(&context);
		ret = psci_ops.cpu_suspend(state, 0);
		arm_cpuidle_restore_irq_context(&context);
	} else {
		ret = cpu_suspend(state, psci_suspend_finisher);
	}

	return ret;
}
#endif

static int psci_system_suspend(unsigned long unused)
{
	phys_addr_t pa_cpu_resume = __pa_symbol(function_nocfi(cpu_resume));

	return invoke_psci_fn(PSCI_FN_NATIVE(1_0, SYSTEM_SUSPEND),
			      pa_cpu_resume, 0, 0);
}

static int psci_system_suspend_enter(suspend_state_t state)
{
	return cpu_suspend(0, psci_system_suspend);
}

static const struct platform_suspend_ops psci_suspend_ops = {
	.valid          = suspend_valid_only_mem,
	.enter          = psci_system_suspend_enter,
};

static void __init psci_init_system_reset2(void)
{
	int ret;

	ret = psci_features(PSCI_FN_NATIVE(1_1, SYSTEM_RESET2));

	if (ret != PSCI_RET_NOT_SUPPORTED)
		psci_system_reset2_supported = true;
}

static void __init psci_init_system_suspend(void)
{
	int ret;

	if (!IS_ENABLED(CONFIG_SUSPEND))
		return;

	ret = psci_features(PSCI_FN_NATIVE(1_0, SYSTEM_SUSPEND));

	if (ret != PSCI_RET_NOT_SUPPORTED)
		suspend_set_ops(&psci_suspend_ops);
}

static void __init psci_init_cpu_suspend(void)
{
	int feature = psci_features(PSCI_FN_NATIVE(0_2, CPU_SUSPEND));

	if (feature != PSCI_RET_NOT_SUPPORTED)
		psci_cpu_suspend_feature = feature;
}

/*
 * Detect the presence of a resident Trusted OS which may cause CPU_OFF to
 * return DENIED (which would be fatal).
 */
static void __init psci_init_migrate(void)
{
	unsigned long cpuid;
	int type, cpu = -1;

	type = psci_ops.migrate_info_type();

	if (type == PSCI_0_2_TOS_MP) {
		pr_info("Trusted OS migration not required\n");
		return;
	}

	if (type == PSCI_RET_NOT_SUPPORTED) {
		pr_info("MIGRATE_INFO_TYPE not supported.\n");
		return;
	}

	if (type != PSCI_0_2_TOS_UP_MIGRATE &&
	    type != PSCI_0_2_TOS_UP_NO_MIGRATE) {
		pr_err("MIGRATE_INFO_TYPE returned unknown type (%d)\n", type);
		return;
	}

	cpuid = psci_migrate_info_up_cpu();
	if (cpuid & ~MPIDR_HWID_BITMASK) {
		pr_warn("MIGRATE_INFO_UP_CPU reported invalid physical ID (0x%lx)\n",
			cpuid);
		return;
	}

	cpu = get_logical_index(cpuid);
	resident_cpu = cpu >= 0 ? cpu : -1;

	pr_info("Trusted OS resident on physical CPU 0x%lx\n", cpuid);
}

static void __init psci_init_smccc(void)
{
	u32 ver = ARM_SMCCC_VERSION_1_0;
	int feature;

	feature = psci_features(ARM_SMCCC_VERSION_FUNC_ID);

	if (feature != PSCI_RET_NOT_SUPPORTED) {
		u32 ret;
		ret = invoke_psci_fn(ARM_SMCCC_VERSION_FUNC_ID, 0, 0, 0);
		if (ret >= ARM_SMCCC_VERSION_1_1) {
			arm_smccc_version_init(ret, psci_conduit);
			ver = ret;
		}
	}

	/*
	 * Conveniently, the SMCCC and PSCI versions are encoded the
	 * same way. No, this isn't accidental.
	 */
	pr_info("SMC Calling Convention v%d.%d\n",
		PSCI_VERSION_MAJOR(ver), PSCI_VERSION_MINOR(ver));

}

static void __init psci_0_2_set_functions(void)
{
	pr_info("Using standard PSCI v0.2 function IDs\n");

	psci_ops = (struct psci_operations){
		.get_version = psci_0_2_get_version,
		.cpu_suspend = psci_0_2_cpu_suspend,
		.cpu_off = psci_0_2_cpu_off,
		.cpu_on = psci_0_2_cpu_on,
		.migrate = psci_0_2_migrate,
		.affinity_info = psci_affinity_info,
		.migrate_info_type = psci_migrate_info_type,
	};

	register_restart_handler(&psci_sys_reset_nb);

	pm_power_off = psci_sys_poweroff;
}

/*
 * Probe function for PSCI firmware versions >= 0.2
 */
static int __init psci_probe(void)
{
	u32 ver = psci_0_2_get_version();

	pr_info("PSCIv%d.%d detected in firmware.\n",
			PSCI_VERSION_MAJOR(ver),
			PSCI_VERSION_MINOR(ver));

	if (PSCI_VERSION_MAJOR(ver) == 0 && PSCI_VERSION_MINOR(ver) < 2) {
		pr_err("Conflicting PSCI version detected.\n");
		return -EINVAL;
	}

	psci_0_2_set_functions();

	psci_init_migrate();

	if (PSCI_VERSION_MAJOR(ver) >= 1) {
		psci_init_smccc();
		psci_init_cpu_suspend();
		psci_init_system_suspend();
		psci_init_system_reset2();
		kvm_init_hyp_services();
	}

	return 0;
}

typedef int (*psci_initcall_t)(const struct device_node *);

/*
 * PSCI init function for PSCI versions >=0.2
 *
 * Probe based on PSCI PSCI_VERSION function
 */
static int __init psci_0_2_init(struct device_node *np)
{
	int err;

	err = get_set_conduit_method(np);
	if (err)
		return err;

	/*
	 * Starting with v0.2, the PSCI specification introduced a call
	 * (PSCI_VERSION) that allows probing the firmware version, so
	 * that PSCI function IDs and version specific initialization
	 * can be carried out according to the specific version reported
	 * by firmware
	 */
	return psci_probe();
}

/*
 * PSCI < v0.2 get PSCI Function IDs via DT.
 */
static int __init psci_0_1_init(struct device_node *np)
{
	u32 id;
	int err;

	err = get_set_conduit_method(np);
	if (err)
		return err;

	pr_info("Using PSCI v0.1 Function IDs from DT\n");

	psci_ops.get_version = psci_0_1_get_version;

	if (!of_property_read_u32(np, "cpu_suspend", &id)) {
		psci_0_1_function_ids.cpu_suspend = id;
		psci_ops.cpu_suspend = psci_0_1_cpu_suspend;
	}

	if (!of_property_read_u32(np, "cpu_off", &id)) {
		psci_0_1_function_ids.cpu_off = id;
		psci_ops.cpu_off = psci_0_1_cpu_off;
	}

	if (!of_property_read_u32(np, "cpu_on", &id)) {
		psci_0_1_function_ids.cpu_on = id;
		psci_ops.cpu_on = psci_0_1_cpu_on;
	}

	if (!of_property_read_u32(np, "migrate", &id)) {
		psci_0_1_function_ids.migrate = id;
		psci_ops.migrate = psci_0_1_migrate;
	}

	return 0;
}

static int __init psci_1_0_init(struct device_node *np)
{
	int err;

	err = psci_0_2_init(np);
	if (err)
		return err;

	if (psci_has_osi_support()) {
		pr_info("OSI mode supported.\n");

		/* Default to PC mode. */
		psci_set_osi_mode(false);
	}

	return 0;
}

static const struct of_device_id psci_of_match[] __initconst = {
	{ .compatible = "arm,psci",	.data = psci_0_1_init},
	{ .compatible = "arm,psci-0.2",	.data = psci_0_2_init},
	{ .compatible = "arm,psci-1.0",	.data = psci_1_0_init},
	{},
};

int __init psci_dt_init(void)
{
	struct device_node *np;
	const struct of_device_id *matched_np;
	psci_initcall_t init_fn;
	int ret;

	np = of_find_matching_node_and_match(NULL, psci_of_match, &matched_np);

	if (!np || !of_device_is_available(np))
		return -ENODEV;

	init_fn = (psci_initcall_t)matched_np->data;
	ret = init_fn(np);

	of_node_put(np);
	return ret;
}

#ifdef CONFIG_ACPI
/*
 * We use PSCI 0.2+ when ACPI is deployed on ARM64 and it's
 * explicitly clarified in SBBR
 */
int __init psci_acpi_init(void)
{
	if (!acpi_psci_present()) {
		pr_info("is not implemented in ACPI.\n");
		return -EOPNOTSUPP;
	}

	pr_info("probing for conduit method from ACPI.\n");

	if (acpi_psci_use_hvc())
		set_conduit(SMCCC_CONDUIT_HVC);
	else
		set_conduit(SMCCC_CONDUIT_SMC);

	return psci_probe();
}
#endif
Commit	Line	Data
1802d0be	1	// SPDX-License-Identifier: GPL-2.0-only
bff60792	2	/*
bff60792 MR	3	*
	4	* Copyright (C) 2015 ARM Limited
	5	*/
	6
	7	#define pr_fmt(fmt) "psci: " fmt
	8
c2a25c14	9	#include <linux/acpi.h>
e679660d	10	#include <linux/arm-smccc.h>
8b6f2499	11	#include <linux/cpuidle.h>
bff60792 MR	12	#include <linux/errno.h>
	13	#include <linux/linkage.h>
	14	#include <linux/of.h>
	15	#include <linux/pm.h>
	16	#include <linux/printk.h>
	17	#include <linux/psci.h>
	18	#include <linux/reboot.h>
8b6f2499	19	#include <linux/slab.h>
faf7ec4a	20	#include <linux/suspend.h>
bff60792 MR	21
	22	#include <uapi/linux/psci.h>
	23
8b6f2499	24	#include <asm/cpuidle.h>
bff60792	25	#include <asm/cputype.h>
6e085e0a	26	#include <asm/hypervisor.h>
bff60792 MR	27	#include <asm/system_misc.h>
bff60792 MR	28	#include <asm/smp_plat.h>
faf7ec4a	29	#include <asm/suspend.h>
bff60792	30
5211df00 MR	31	/*
5211df00 MR	32	* While a 64-bit OS can make calls with SMC32 calling conventions, for some
029180b1 SH	33	* calls it is necessary to use SMC64 to pass or return 64-bit values.
	34	* For such calls PSCI_FN_NATIVE(version, name) will choose the appropriate
	35	* (native-width) function ID.
5211df00 MR	36	*/
5211df00 MR	37	#ifdef CONFIG_64BIT
029180b1	38	#define PSCI_FN_NATIVE(version, name) PSCI_##version##_FN64_##name
5211df00	39	#else
029180b1	40	#define PSCI_FN_NATIVE(version, name) PSCI_##version##_FN_##name
5211df00 MR	41	#endif
5211df00 MR	42
bff60792 MR	43	/*
	44	* The CPU any Trusted OS is resident on. The trusted OS may reject CPU_OFF
	45	* calls to its resident CPU, so we must avoid issuing those. We never migrate
	46	* a Trusted OS even if it claims to be capable of migration -- doing so will
	47	* require cooperation with a Trusted OS driver.
	48	*/
	49	static int resident_cpu = -1;
f2ae9706 SH	50	struct psci_operations psci_ops;
f2ae9706 SH	51	static enum arm_smccc_conduit psci_conduit = SMCCC_CONDUIT_NONE;
bff60792 MR	52
	53	bool psci_tos_resident_on(int cpu)
	54	{
	55	return cpu == resident_cpu;
	56	}
	57
bff60792 MR	58	typedef unsigned long (psci_fn)(unsigned long, unsigned long,
bff60792 MR	59	unsigned long, unsigned long);
bff60792 MR	60	static psci_fn *invoke_psci_fn;
bff60792 MR	61
82ac62d1	62	static struct psci_0_1_function_ids psci_0_1_function_ids;
bff60792	63
6df3e144 DB	64	struct psci_0_1_function_ids get_psci_0_1_function_ids(void)
	65	{
	66	return psci_0_1_function_ids;
	67	}
	68
068654c2 LP	69	#define PSCI_0_2_POWER_STATE_MASK \
	70	(PSCI_0_2_POWER_STATE_ID_MASK \| \
	71	PSCI_0_2_POWER_STATE_TYPE_MASK \| \
	72	PSCI_0_2_POWER_STATE_AFFL_MASK)
	73
a5c00bb2 LP	74	#define PSCI_1_0_EXT_POWER_STATE_MASK \
	75	(PSCI_1_0_EXT_POWER_STATE_ID_MASK \| \
	76	PSCI_1_0_EXT_POWER_STATE_TYPE_MASK)
	77
	78	static u32 psci_cpu_suspend_feature;
4302e381	79	static bool psci_system_reset2_supported;
a5c00bb2 LP	80
	81	static inline bool psci_has_ext_power_state(void)
	82	{
	83	return psci_cpu_suspend_feature &
	84	PSCI_1_0_FEATURES_CPU_SUSPEND_PF_MASK;
	85	}
	86
49fdcd75	87	bool psci_has_osi_support(void)
60dd1ead UH	88	{
	89	return psci_cpu_suspend_feature & PSCI_1_0_OS_INITIATED;
	90	}
	91
2b9cf189	92	static inline bool psci_power_state_loses_context(u32 state)
068654c2	93	{
a5c00bb2 LP	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;
	97
	98	return state & mask;
068654c2 LP	99	}
068654c2 LP	100
9ffeb6d0	101	bool psci_power_state_is_valid(u32 state)
068654c2	102	{
a5c00bb2 LP	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;
	106
	107	return !(state & ~valid_mask);
068654c2 LP	108	}
068654c2 LP	109
e679660d JW	110	static unsigned long __invoke_psci_fn_hvc(unsigned long function_id,
	111	unsigned long arg0, unsigned long arg1,
	112	unsigned long arg2)
	113	{
	114	struct arm_smccc_res res;
	115
	116	arm_smccc_hvc(function_id, arg0, arg1, arg2, 0, 0, 0, 0, &res);
	117	return res.a0;
	118	}
	119
	120	static unsigned long __invoke_psci_fn_smc(unsigned long function_id,
	121	unsigned long arg0, unsigned long arg1,
	122	unsigned long arg2)
	123	{
	124	struct arm_smccc_res res;
	125
	126	arm_smccc_smc(function_id, arg0, arg1, arg2, 0, 0, 0, 0, &res);
	127	return res.a0;
	128	}
	129
bff60792 MR	130	static int psci_to_linux_errno(int errno)
	131	{
	132	switch (errno) {
	133	case PSCI_RET_SUCCESS:
	134	return 0;
	135	case PSCI_RET_NOT_SUPPORTED:
	136	return -EOPNOTSUPP;
	137	case PSCI_RET_INVALID_PARAMS:
2217d7c6	138	case PSCI_RET_INVALID_ADDRESS:
bff60792 MR	139	return -EINVAL;
	140	case PSCI_RET_DENIED:
	141	return -EPERM;
9b924f4f	142	}
bff60792 MR	143
	144	return -EINVAL;
	145	}
	146
e6dd9d89 DB	147	static u32 psci_0_1_get_version(void)
	148	{
	149	return PSCI_VERSION(0, 1);
	150	}
	151
	152	static u32 psci_0_2_get_version(void)
bff60792 MR	153	{
	154	return invoke_psci_fn(PSCI_0_2_FN_PSCI_VERSION, 0, 0, 0);
	155	}
	156
10942019	157	int psci_set_osi_mode(bool enable)
49fdcd75	158	{
10942019	159	unsigned long suspend_mode;
49fdcd75 UH	160	int err;
49fdcd75 UH	161
10942019 UH	162	suspend_mode = enable ? PSCI_1_0_SUSPEND_MODE_OSI :
	163	PSCI_1_0_SUSPEND_MODE_PC;
	164
	165	err = invoke_psci_fn(PSCI_1_0_FN_SET_SUSPEND_MODE, suspend_mode, 0, 0);
49fdcd75 UH	166	return psci_to_linux_errno(err);
	167	}
	168
0bc7474f	169	static int __psci_cpu_suspend(u32 fn, u32 state, unsigned long entry_point)
bff60792 MR	170	{
bff60792 MR	171	int err;
bff60792	172
bff60792 MR	173	err = invoke_psci_fn(fn, state, entry_point, 0);
	174	return psci_to_linux_errno(err);
	175	}
	176
0bc7474f DB	177	static int psci_0_1_cpu_suspend(u32 state, unsigned long entry_point)
0bc7474f DB	178	{
82ac62d1	179	return __psci_cpu_suspend(psci_0_1_function_ids.cpu_suspend,
0bc7474f DB	180	state, entry_point);
	181	}
	182
	183	static int psci_0_2_cpu_suspend(u32 state, unsigned long entry_point)
	184	{
	185	return __psci_cpu_suspend(PSCI_FN_NATIVE(0_2, CPU_SUSPEND),
	186	state, entry_point);
	187	}
	188
	189	static int __psci_cpu_off(u32 fn, u32 state)
bff60792 MR	190	{
bff60792 MR	191	int err;
bff60792	192
bff60792 MR	193	err = invoke_psci_fn(fn, state, 0, 0);
	194	return psci_to_linux_errno(err);
	195	}
	196
0bc7474f DB	197	static int psci_0_1_cpu_off(u32 state)
0bc7474f DB	198	{
82ac62d1	199	return __psci_cpu_off(psci_0_1_function_ids.cpu_off, state);
0bc7474f DB	200	}
	201
	202	static int psci_0_2_cpu_off(u32 state)
	203	{
	204	return __psci_cpu_off(PSCI_0_2_FN_CPU_OFF, state);
	205	}
	206
	207	static int __psci_cpu_on(u32 fn, unsigned long cpuid, unsigned long entry_point)
bff60792 MR	208	{
bff60792 MR	209	int err;
bff60792	210
bff60792 MR	211	err = invoke_psci_fn(fn, cpuid, entry_point, 0);
	212	return psci_to_linux_errno(err);
	213	}
	214
0bc7474f DB	215	static int psci_0_1_cpu_on(unsigned long cpuid, unsigned long entry_point)
0bc7474f DB	216	{
82ac62d1	217	return __psci_cpu_on(psci_0_1_function_ids.cpu_on, cpuid, entry_point);
0bc7474f DB	218	}
	219
	220	static int psci_0_2_cpu_on(unsigned long cpuid, unsigned long entry_point)
	221	{
	222	return __psci_cpu_on(PSCI_FN_NATIVE(0_2, CPU_ON), cpuid, entry_point);
	223	}
	224
	225	static int __psci_migrate(u32 fn, unsigned long cpuid)
bff60792 MR	226	{
bff60792 MR	227	int err;
bff60792	228
bff60792 MR	229	err = invoke_psci_fn(fn, cpuid, 0, 0);
	230	return psci_to_linux_errno(err);
	231	}
	232
0bc7474f DB	233	static int psci_0_1_migrate(unsigned long cpuid)
0bc7474f DB	234	{
82ac62d1	235	return __psci_migrate(psci_0_1_function_ids.migrate, cpuid);
0bc7474f DB	236	}
	237
	238	static int psci_0_2_migrate(unsigned long cpuid)
	239	{
	240	return __psci_migrate(PSCI_FN_NATIVE(0_2, MIGRATE), cpuid);
	241	}
	242
bff60792 MR	243	static int psci_affinity_info(unsigned long target_affinity,
	244	unsigned long lowest_affinity_level)
	245	{
029180b1	246	return invoke_psci_fn(PSCI_FN_NATIVE(0_2, AFFINITY_INFO),
5211df00	247	target_affinity, lowest_affinity_level, 0);
bff60792 MR	248	}
	249
	250	static int psci_migrate_info_type(void)
	251	{
	252	return invoke_psci_fn(PSCI_0_2_FN_MIGRATE_INFO_TYPE, 0, 0, 0);
	253	}
	254
	255	static unsigned long psci_migrate_info_up_cpu(void)
	256	{
029180b1	257	return invoke_psci_fn(PSCI_FN_NATIVE(0_2, MIGRATE_INFO_UP_CPU),
5211df00	258	0, 0, 0);
bff60792 MR	259	}
bff60792 MR	260
a5520eac	261	static void set_conduit(enum arm_smccc_conduit conduit)
09a8d6d4 MZ	262	{
09a8d6d4 MZ	263	switch (conduit) {
a5520eac	264	case SMCCC_CONDUIT_HVC:
09a8d6d4 MZ	265	invoke_psci_fn = __invoke_psci_fn_hvc;
09a8d6d4 MZ	266	break;
a5520eac	267	case SMCCC_CONDUIT_SMC:
09a8d6d4 MZ	268	invoke_psci_fn = __invoke_psci_fn_smc;
	269	break;
	270	default:
	271	WARN(1, "Unexpected PSCI conduit %d\n", conduit);
	272	}
	273
f2ae9706	274	psci_conduit = conduit;
09a8d6d4 MZ	275	}
09a8d6d4 MZ	276
bff60792 MR	277	static int get_set_conduit_method(struct device_node *np)
	278	{
	279	const char *method;
	280
	281	pr_info("probing for conduit method from DT.\n");
	282
	283	if (of_property_read_string(np, "method", &method)) {
	284	pr_warn("missing \"method\" property\n");
	285	return -ENXIO;
	286	}
	287
	288	if (!strcmp("hvc", method)) {
a5520eac	289	set_conduit(SMCCC_CONDUIT_HVC);
bff60792	290	} else if (!strcmp("smc", method)) {
a5520eac	291	set_conduit(SMCCC_CONDUIT_SMC);
bff60792 MR	292	} else {
	293	pr_warn("invalid \"method\" property: %s\n", method);
	294	return -EINVAL;
	295	}
	296	return 0;
	297	}
	298
2bb565bb GR	299	static int psci_sys_reset(struct notifier_block *nb, unsigned long action,
2bb565bb GR	300	void *data)
bff60792	301	{
4302e381 SH	302	if ((reboot_mode == REBOOT_WARM \|\| reboot_mode == REBOOT_SOFT) &&
	303	psci_system_reset2_supported) {
	304	/*
	305	* reset_type[31] = 0 (architectural)
	306	* reset_type[30:0] = 0 (SYSTEM_WARM_RESET)
	307	* cookie = 0 (ignored by the implementation)
	308	*/
	309	invoke_psci_fn(PSCI_FN_NATIVE(1_1, SYSTEM_RESET2), 0, 0, 0);
	310	} else {
	311	invoke_psci_fn(PSCI_0_2_FN_SYSTEM_RESET, 0, 0, 0);
	312	}
2bb565bb GR	313
2bb565bb GR	314	return NOTIFY_DONE;
bff60792 MR	315	}
bff60792 MR	316
2bb565bb GR	317	static struct notifier_block psci_sys_reset_nb = {
	318	.notifier_call = psci_sys_reset,
	319	.priority = 129,
	320	};
	321
bff60792 MR	322	static void psci_sys_poweroff(void)
	323	{
	324	invoke_psci_fn(PSCI_0_2_FN_SYSTEM_OFF, 0, 0, 0);
	325	}
	326
5f004e0c LP	327	static int __init psci_features(u32 psci_func_id)
	328	{
	329	return invoke_psci_fn(PSCI_1_0_FN_PSCI_FEATURES,
	330	psci_func_id, 0, 0);
	331	}
	332
8b6f2499	333	#ifdef CONFIG_CPU_IDLE
9ffeb6d0	334	static int psci_suspend_finisher(unsigned long state)
0865d20c	335	{
9ffeb6d0	336	u32 power_state = state;
167d0da2	337	phys_addr_t pa_cpu_resume = __pa_symbol(function_nocfi(cpu_resume));
0865d20c	338
167d0da2	339	return psci_ops.cpu_suspend(power_state, pa_cpu_resume);
0865d20c UH	340	}
0865d20c UH	341
9ffeb6d0	342	int psci_cpu_suspend_enter(u32 state)
8b6f2499 LP	343	{
8b6f2499 LP	344	int ret;
8b6f2499	345
c9223b61 MZ	346	if (!psci_power_state_loses_context(state)) {
	347	struct arm_cpuidle_irq_context context;
	348
	349	arm_cpuidle_save_irq_context(&context);
9ffeb6d0	350	ret = psci_ops.cpu_suspend(state, 0);
c9223b61 MZ	351	arm_cpuidle_restore_irq_context(&context);
c9223b61 MZ	352	} else {
9ffeb6d0	353	ret = cpu_suspend(state, psci_suspend_finisher);
c9223b61	354	}
8b6f2499 LP	355
	356	return ret;
	357	}
8b6f2499 LP	358	#endif
8b6f2499 LP	359
faf7ec4a SH	360	static int psci_system_suspend(unsigned long unused)
faf7ec4a SH	361	{
167d0da2 ST	362	phys_addr_t pa_cpu_resume = __pa_symbol(function_nocfi(cpu_resume));
167d0da2 ST	363
faf7ec4a	364	return invoke_psci_fn(PSCI_FN_NATIVE(1_0, SYSTEM_SUSPEND),
167d0da2	365	pa_cpu_resume, 0, 0);
faf7ec4a SH	366	}
	367
	368	static int psci_system_suspend_enter(suspend_state_t state)
	369	{
	370	return cpu_suspend(0, psci_system_suspend);
	371	}
	372
	373	static const struct platform_suspend_ops psci_suspend_ops = {
	374	.valid = suspend_valid_only_mem,
	375	.enter = psci_system_suspend_enter,
	376	};
	377
4302e381 SH	378	static void __init psci_init_system_reset2(void)
	379	{
	380	int ret;
	381
	382	ret = psci_features(PSCI_FN_NATIVE(1_1, SYSTEM_RESET2));
	383
	384	if (ret != PSCI_RET_NOT_SUPPORTED)
	385	psci_system_reset2_supported = true;
	386	}
	387
faf7ec4a SH	388	static void __init psci_init_system_suspend(void)
	389	{
	390	int ret;
	391
	392	if (!IS_ENABLED(CONFIG_SUSPEND))
	393	return;
	394
	395	ret = psci_features(PSCI_FN_NATIVE(1_0, SYSTEM_SUSPEND));
	396
	397	if (ret != PSCI_RET_NOT_SUPPORTED)
	398	suspend_set_ops(&psci_suspend_ops);
	399	}
	400
a5c00bb2 LP	401	static void __init psci_init_cpu_suspend(void)
a5c00bb2 LP	402	{
0bc7474f	403	int feature = psci_features(PSCI_FN_NATIVE(0_2, CPU_SUSPEND));
a5c00bb2 LP	404
	405	if (feature != PSCI_RET_NOT_SUPPORTED)
	406	psci_cpu_suspend_feature = feature;
	407	}
	408
bff60792 MR	409	/*
	410	* Detect the presence of a resident Trusted OS which may cause CPU_OFF to
	411	* return DENIED (which would be fatal).
	412	*/
	413	static void __init psci_init_migrate(void)
	414	{
	415	unsigned long cpuid;
	416	int type, cpu = -1;
	417
	418	type = psci_ops.migrate_info_type();
	419
	420	if (type == PSCI_0_2_TOS_MP) {
	421	pr_info("Trusted OS migration not required\n");
	422	return;
	423	}
	424
	425	if (type == PSCI_RET_NOT_SUPPORTED) {
	426	pr_info("MIGRATE_INFO_TYPE not supported.\n");
	427	return;
	428	}
	429
	430	if (type != PSCI_0_2_TOS_UP_MIGRATE &&
	431	type != PSCI_0_2_TOS_UP_NO_MIGRATE) {
	432	pr_err("MIGRATE_INFO_TYPE returned unknown type (%d)\n", type);
	433	return;
	434	}
	435
	436	cpuid = psci_migrate_info_up_cpu();
	437	if (cpuid & ~MPIDR_HWID_BITMASK) {
	438	pr_warn("MIGRATE_INFO_UP_CPU reported invalid physical ID (0x%lx)\n",
	439	cpuid);
	440	return;
	441	}
	442
	443	cpu = get_logical_index(cpuid);
	444	resident_cpu = cpu >= 0 ? cpu : -1;
	445
	446	pr_info("Trusted OS resident on physical CPU 0x%lx\n", cpuid);
	447	}
	448
e78eef55 MZ	449	static void __init psci_init_smccc(void)
	450	{
	451	u32 ver = ARM_SMCCC_VERSION_1_0;
	452	int feature;
	453
	454	feature = psci_features(ARM_SMCCC_VERSION_FUNC_ID);
	455
	456	if (feature != PSCI_RET_NOT_SUPPORTED) {
	457	u32 ret;
	458	ret = invoke_psci_fn(ARM_SMCCC_VERSION_FUNC_ID, 0, 0, 0);
ad5a57df	459	if (ret >= ARM_SMCCC_VERSION_1_1) {
f2ae9706	460	arm_smccc_version_init(ret, psci_conduit);
e78eef55 MZ	461	ver = ret;
	462	}
	463	}
	464
	465	/*
	466	* Conveniently, the SMCCC and PSCI versions are encoded the
	467	* same way. No, this isn't accidental.
	468	*/
	469	pr_info("SMC Calling Convention v%d.%d\n",
	470	PSCI_VERSION_MAJOR(ver), PSCI_VERSION_MINOR(ver));
	471
	472	}
	473
bff60792 MR	474	static void __init psci_0_2_set_functions(void)
	475	{
	476	pr_info("Using standard PSCI v0.2 function IDs\n");
bff60792	477
0bc7474f DB	478	psci_ops = (struct psci_operations){
	479	.get_version = psci_0_2_get_version,
	480	.cpu_suspend = psci_0_2_cpu_suspend,
	481	.cpu_off = psci_0_2_cpu_off,
	482	.cpu_on = psci_0_2_cpu_on,
	483	.migrate = psci_0_2_migrate,
	484	.affinity_info = psci_affinity_info,
	485	.migrate_info_type = psci_migrate_info_type,
	486	};
bff60792	487
2bb565bb	488	register_restart_handler(&psci_sys_reset_nb);
bff60792 MR	489
	490	pm_power_off = psci_sys_poweroff;
	491	}
	492
	493	/*
	494	* Probe function for PSCI firmware versions >= 0.2
	495	*/
	496	static int __init psci_probe(void)
	497	{
e6dd9d89	498	u32 ver = psci_0_2_get_version();
bff60792 MR	499
	500	pr_info("PSCIv%d.%d detected in firmware.\n",
	501	PSCI_VERSION_MAJOR(ver),
	502	PSCI_VERSION_MINOR(ver));
	503
	504	if (PSCI_VERSION_MAJOR(ver) == 0 && PSCI_VERSION_MINOR(ver) < 2) {
	505	pr_err("Conflicting PSCI version detected.\n");
	506	return -EINVAL;
	507	}
	508
	509	psci_0_2_set_functions();
	510
	511	psci_init_migrate();
	512
79b04beb	513	if (PSCI_VERSION_MAJOR(ver) >= 1) {
e78eef55	514	psci_init_smccc();
79b04beb LP	515	psci_init_cpu_suspend();
79b04beb LP	516	psci_init_system_suspend();
4302e381	517	psci_init_system_reset2();
6e085e0a	518	kvm_init_hyp_services();
79b04beb	519	}
faf7ec4a	520
bff60792 MR	521	return 0;
	522	}
	523
	524	typedef int (psci_initcall_t)(const struct device_node );
	525
	526	/*
	527	* PSCI init function for PSCI versions >=0.2
	528	*
	529	* Probe based on PSCI PSCI_VERSION function
	530	*/
	531	static int __init psci_0_2_init(struct device_node *np)
	532	{
	533	int err;
	534
	535	err = get_set_conduit_method(np);
bff60792	536	if (err)
d036b5cf UH	537	return err;
d036b5cf UH	538
bff60792 MR	539	/*
	540	* Starting with v0.2, the PSCI specification introduced a call
	541	* (PSCI_VERSION) that allows probing the firmware version, so
	542	* that PSCI function IDs and version specific initialization
	543	* can be carried out according to the specific version reported
	544	* by firmware
	545	*/
d036b5cf	546	return psci_probe();
bff60792 MR	547	}
	548
	549	/*
	550	* PSCI < v0.2 get PSCI Function IDs via DT.
	551	*/
	552	static int __init psci_0_1_init(struct device_node *np)
	553	{
	554	u32 id;
	555	int err;
	556
	557	err = get_set_conduit_method(np);
bff60792	558	if (err)
d036b5cf	559	return err;
bff60792 MR	560
	561	pr_info("Using PSCI v0.1 Function IDs from DT\n");
	562
e6dd9d89 DB	563	psci_ops.get_version = psci_0_1_get_version;
e6dd9d89 DB	564
bff60792	565	if (!of_property_read_u32(np, "cpu_suspend", &id)) {
82ac62d1	566	psci_0_1_function_ids.cpu_suspend = id;
0bc7474f	567	psci_ops.cpu_suspend = psci_0_1_cpu_suspend;
bff60792 MR	568	}
	569
	570	if (!of_property_read_u32(np, "cpu_off", &id)) {
82ac62d1	571	psci_0_1_function_ids.cpu_off = id;
0bc7474f	572	psci_ops.cpu_off = psci_0_1_cpu_off;
bff60792 MR	573	}
	574
	575	if (!of_property_read_u32(np, "cpu_on", &id)) {
82ac62d1	576	psci_0_1_function_ids.cpu_on = id;
0bc7474f	577	psci_ops.cpu_on = psci_0_1_cpu_on;
bff60792 MR	578	}
	579
	580	if (!of_property_read_u32(np, "migrate", &id)) {
82ac62d1	581	psci_0_1_function_ids.migrate = id;
0bc7474f	582	psci_ops.migrate = psci_0_1_migrate;
bff60792 MR	583	}
bff60792 MR	584
d036b5cf	585	return 0;
bff60792 MR	586	}
bff60792 MR	587
60dd1ead UH	588	static int __init psci_1_0_init(struct device_node *np)
	589	{
	590	int err;
	591
	592	err = psci_0_2_init(np);
	593	if (err)
	594	return err;
	595
49fdcd75	596	if (psci_has_osi_support()) {
60dd1ead UH	597	pr_info("OSI mode supported.\n");
60dd1ead UH	598
49fdcd75	599	/* Default to PC mode. */
10942019	600	psci_set_osi_mode(false);
49fdcd75 UH	601	}
49fdcd75 UH	602
60dd1ead UH	603	return 0;
	604	}
	605
1d2d8de4	606	static const struct of_device_id psci_of_match[] __initconst = {
bff60792 MR	607	{ .compatible = "arm,psci", .data = psci_0_1_init},
bff60792 MR	608	{ .compatible = "arm,psci-0.2", .data = psci_0_2_init},
60dd1ead	609	{ .compatible = "arm,psci-1.0", .data = psci_1_0_init},
bff60792 MR	610	{},
	611	};
	612
	613	int __init psci_dt_init(void)
	614	{
	615	struct device_node *np;
	616	const struct of_device_id *matched_np;
	617	psci_initcall_t init_fn;
d036b5cf	618	int ret;
bff60792 MR	619
	620	np = of_find_matching_node_and_match(NULL, psci_of_match, &matched_np);
	621
d09a0011	622	if (!np \|\| !of_device_is_available(np))
bff60792 MR	623	return -ENODEV;
	624
	625	init_fn = (psci_initcall_t)matched_np->data;
d036b5cf UH	626	ret = init_fn(np);
	627
	628	of_node_put(np);
	629	return ret;
bff60792 MR	630	}
	631
	632	#ifdef CONFIG_ACPI
	633	/*
	634	* We use PSCI 0.2+ when ACPI is deployed on ARM64 and it's
	635	* explicitly clarified in SBBR
	636	*/
	637	int __init psci_acpi_init(void)
	638	{
	639	if (!acpi_psci_present()) {
	640	pr_info("is not implemented in ACPI.\n");
	641	return -EOPNOTSUPP;
	642	}
	643
	644	pr_info("probing for conduit method from ACPI.\n");
	645
	646	if (acpi_psci_use_hvc())
a5520eac	647	set_conduit(SMCCC_CONDUIT_HVC);
bff60792	648	else
a5520eac	649	set_conduit(SMCCC_CONDUIT_SMC);
bff60792 MR	650
	651	return psci_probe();
	652	}
	653	#endif