drivers/pm/reboot.c

// SPDX-License-Identifier: (GPL-2.0+ OR MIT)
/*
 * Copyright (c) 2019 Amlogic, Inc. All rights reserved.
 */

#include <linux/delay.h>
#include <linux/err.h>
#include <linux/init.h>
#include <linux/kernel.h>
#include <linux/io.h>
#include <linux/of.h>
#include <linux/platform_device.h>
#include <linux/module.h>
#include <linux/reboot.h>

#include <asm/system_misc.h>

#include <linux/amlogic/iomap.h>
#include <linux/amlogic/cpu_version.h>
#include <linux/amlogic/iomap.h>
#include <linux/amlogic/reboot.h>
//#include <asm/compiler.h>
#include <linux/kdebug.h>
#include <linux/arm-smccc.h>
#include <linux/panic_notifier.h>
#include <linux/syscore_ops.h>
#include <linux/cpu.h>
#include <linux/highmem.h>

#if IS_ENABLED(CONFIG_AMLOGIC_DEBUG)
#include <linux/amlogic/gki_module.h>
#endif

static void __iomem *reboot_reason_vaddr;
static u32 psci_function_id_restart;
static u32 psci_function_id_poweroff;
static char *kernel_panic;
/* Represents if it can support reboot reason extension - */
/* which can support up to 128 kind of reboot reasons */
static bool support_reboot_reason_ext;

static struct class *sticky_reg_cls;
static char *sticky_reg_dev = "sticky_reg";
static unsigned int *sticky_reg0;
static unsigned int *sticky_reg1;
#define SYSCTRL_STICKY_REG5  ((0x00b5 << 2) + 0xfe005800)
static unsigned int  *delay_reg;

#ifdef CONFIG_MMC_TS_STORE_REBOOT_REASON
extern int mmc_ts_set(const char *key, const char *value);
static struct notifier_block reboot_notifier;
#endif

static struct reboot_reason_str reboot_reason_name[MESON_MAX_REBOOT] = {
	[MESON_COLD_REBOOT] = { .name = "cold reboot" },
	[MESON_NORMAL_BOOT] = { .name = "normal boot" },
	[MESON_FACTORY_RESET_REBOOT] = { .name = "factory reset reboot" },
	[MESON_UPDATE_REBOOT] = { .name = "update reboot" },
	[MESON_FASTBOOT_REBOOT] = { .name = "fastboot reboot" },
	[MESON_UBOOT_SUSPEND] = { .name = "uboot suspend" },
	[MESON_HIBERNATE] = { .name = "hibernate" },
	[MESON_BOOTLOADER_REBOOT] = { .name = "bootloader reboot" },
	[MESON_RPMBP_REBOOT] = { .name = "rpmbp reboot" },
	[MESON_QUIESCENT_REBOOT] = { .name = "quiescent reboot" },
	[MESON_RESCUEPARTY_REBOOT] = { .name = "rescueparty reboot" },
	[MESON_KERNEL_PANIC] = { .name = "kernel panic" },
	[MESON_RECOVERY_QUIESCENT_REBOOT] = {
		.name = "recovery quiescent reboot" },
	[MESON_FFV_REBOOT] = { .name = "ffv reboot" },
};

#if IS_ENABLED(CONFIG_AMLOGIC_DEBUG)
static unsigned int scramble_reg;
module_param(scramble_reg, uint, 0644);

static int scramble_reg_setup(char *buf)
{
	if (!buf)
		return -EINVAL;

	if (kstrtouint(buf, 16, &scramble_reg)) {
		pr_err("!scramble_reg error: %s, scramble_reg=%x\n", buf, scramble_reg);
		return -EINVAL;
	}

	pr_info("scramble_reg=%x\n", scramble_reg);

	return 0;
}
__setup("scramble_reg=", scramble_reg_setup);

/*
 * scramble_clear_preserve() will clear scramble_reg bit0,
 * this will cause fresh ddr data after reboot
 */
static void scramble_clear_preserve(void)
{
	void __iomem *vaddr;
	unsigned int val;

	if (scramble_reg) {
		vaddr = ioremap(scramble_reg, 4);
		if (!vaddr)
			return;

		val = readl(vaddr);
		val = val & (~0x1);
		writel(val, vaddr);

		iounmap(vaddr);
		pr_info("clear STARTUP_KEY_PRESERVE bit0, no request to preserve REE Scramble Key\n");
	}
}
#endif

static u32 get_reboot_reason_val(void)
{
	u32 value;
	u32 reboot_reason_val;

	if (!reboot_reason_vaddr) {
		pr_err("%s: reboot_reason_vaddr is NULL!\n", __func__);
		return 0;
	}

	value = readl(reboot_reason_vaddr);
	if (support_reboot_reason_ext)
		reboot_reason_val = (value >> 12) & 0xff;
	else
		reboot_reason_val = (value >> 12) & 0xf;

	return reboot_reason_val;
}

u32 get_reboot_reason(void)
{
	u32 reboot_reason;
	u32 reboot_reason_val;

	reboot_reason_val = get_reboot_reason_val();

	if (support_reboot_reason_ext)
		reboot_reason = reboot_reason_val & 0x7f;
	else
		reboot_reason = reboot_reason_val & 0xf;

	return reboot_reason;
}
EXPORT_SYMBOL_GPL(get_reboot_reason);

static u32 parse_reason(const char *cmd)
{
	u32 reboot_reason = MESON_NORMAL_BOOT;
	u32 delay_time;

	if (cmd) {
		if (strcmp(cmd, "recovery") == 0 ||
		    strcmp(cmd, "factory_reset") == 0)
			reboot_reason = MESON_FACTORY_RESET_REBOOT;
		else if (strcmp(cmd, "cold_boot") == 0)
			reboot_reason = MESON_COLD_REBOOT;
		else if (strcmp(cmd, "update") == 0)
			reboot_reason = MESON_UPDATE_REBOOT;
		else if (strcmp(cmd, "fastboot") == 0)
			reboot_reason = MESON_FASTBOOT_REBOOT;
		else if (strcmp(cmd, "bootloader") == 0 ||
			strcmp(cmd, "dm-verity device corrupted") == 0)
			reboot_reason = MESON_BOOTLOADER_REBOOT;
		else if (strcmp(cmd, "rpmbp") == 0)
			reboot_reason = MESON_RPMBP_REBOOT;
		else if (strcmp(cmd, "rescueparty") == 0)
			reboot_reason = MESON_RESCUEPARTY_REBOOT;
		else if (strcmp(cmd, "uboot_suspend") == 0)
			reboot_reason = MESON_UBOOT_SUSPEND;
		else if (strcmp(cmd, "quiescent") == 0 ||
			strcmp(cmd, "userrequested,recovery,quiescent") == 0 ||
			strcmp(cmd, "reboot-ab-update,quiescent") == 0 ||
			strcmp(cmd, "unattended,ota_update,quiescent") == 0 ||
			strcmp(cmd, ",quiescent") == 0)
			reboot_reason = MESON_QUIESCENT_REBOOT;
		else if (strcmp(cmd, "recovery,quiescent") == 0 ||
			 strcmp(cmd, "factory_reset,quiescent") == 0 ||
			 strcmp(cmd, "quiescent,recovery") == 0 ||
			 strcmp(cmd, "quiescent,factory_reset") == 0)
			reboot_reason = MESON_RECOVERY_QUIESCENT_REBOOT;
		else if (strcmp(cmd, "ffv_reboot") == 0)
			reboot_reason = MESON_FFV_REBOOT;
		else if (strncmp(cmd, "delayed_boot", 12) == 0) {
			/* MESON_DELAYED_REBOOT
			 * workaround for compatible Kernel 4.19
			 */
			reboot_reason = MESON_FFV_REBOOT;
			if (sscanf(cmd, "delayed_boot_%d", &delay_time) != 1)
				delay_time = 0;
			delay_reg = (unsigned int *)ioremap(SYSCTRL_STICKY_REG5, 4);
			writel(delay_time, delay_reg);
		}
	} else {
		if (kernel_panic) {
			if (strcmp(kernel_panic, "kernel_panic") == 0) {
				reboot_reason = MESON_KERNEL_PANIC;
#ifdef CONFIG_MMC_TS_STORE_REBOOT_REASON
				mmc_ts_set("reboot_mode", "kernel_panic");
#endif
			}
		}
	}

	pr_info("reboot reason = %d, %s\n", reboot_reason,
			reboot_reason_name[reboot_reason].name);

	return reboot_reason;
}

#ifdef CONFIG_MMC_TS_STORE_REBOOT_REASON
/*
 * BCB (boot control block) support
 * Handle reboot command and save the reboot reason to fts
 */
static int bcb_reason_reboot_hook(struct notifier_block *notifier,
				unsigned long code, void *cmd)
{
	u32 reboot_reason;

	if (code == SYS_POWER_OFF) {
		if (psci_function_id_poweroff == 0x84000009)
			mmc_ts_set("reboot_mode", "normal");
		else
			mmc_ts_set("reboot_mode", "poweroff");

	} else if (code == SYS_RESTART) {
		reboot_reason = parse_reason(cmd);
		if (reboot_reason == MESON_NORMAL_BOOT)
			mmc_ts_set("reboot_mode", "normal");
		else
			mmc_ts_set("reboot_mode", cmd);
	}

	return NOTIFY_DONE;
}
#endif

static noinline int __invoke_psci_fn_smc(u64 function_id, u64 arg0, u64 arg1,
					 u64 arg2)
{
	struct arm_smccc_res res;

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

void meson_smc_restart(u64 function_id, u64 reboot_reason)
{
	__invoke_psci_fn_smc(function_id,
			     reboot_reason, 0, 0);
}

void meson_common_restart(char mode, const char *cmd)
{
	u32 reboot_reason = parse_reason(cmd);

#if IS_ENABLED(CONFIG_AMLOGIC_DEBUG)
	if (reboot_reason != MESON_KERNEL_PANIC)
		scramble_clear_preserve();
#endif

	if (psci_function_id_restart)
		meson_smc_restart((u64)psci_function_id_restart,
				  (u64)reboot_reason);
}

static int do_aml_restart(struct notifier_block *nb, unsigned long reboot_mode,
			  void *cmd)
{
	meson_common_restart(reboot_mode, cmd);

	return NOTIFY_DONE;
}

static void do_aml_poweroff(void)
{
	/* TODO: Add poweroff capability */
	__invoke_psci_fn_smc(0x82000042, 1, 0, 0);
	/* change poweroff to reset */
	if (psci_function_id_poweroff == 0x84000009)
		__invoke_psci_fn_smc(psci_function_id_poweroff,
				MESON_NORMAL_BOOT, 0, 0);
	else
		__invoke_psci_fn_smc(psci_function_id_poweroff,
				0, 0, 0);
}

static int panic_notify(struct notifier_block *self,
			unsigned long cmd, void *ptr)
{
	kernel_panic = "kernel_panic";

	return NOTIFY_DONE;
}

static struct notifier_block panic_notifier = {
	.notifier_call	= panic_notify,
};

ssize_t reboot_reason_show(struct device *dev,
			   struct device_attribute *attr, char *buf)
{
	unsigned int len;
	u32 reboot_reason;
	u32 reboot_reason_reg;

	reboot_reason_reg = get_reboot_reason_val();
	reboot_reason = get_reboot_reason();
	len = sprintf(buf, "reg val: 0x%x\nreboot reason = %d, %s\n",
			reboot_reason_reg, reboot_reason,
			reboot_reason_name[reboot_reason].name);

	return len;
}

static DEVICE_ATTR_RO(reboot_reason);

static ssize_t reset_test_store(struct device *dev,
			   struct device_attribute *attr,  const char *buf, size_t count)
{
	char s[64] = {0};
	u32 reason, i = 0;

	if (count > 64) {
		pr_err("%s: Error: string length %u is over maximum limits 64\n",
		       __func__, (u32)count);
		return -EINVAL;
	}

	while (*buf != '\n')
		s[i++] = *buf++;
	reason = parse_reason(s);

	pr_info("[%s %d]%s reset, reboot reason:%u\n", __func__, __LINE__, s, reason);
	do_aml_restart(NULL, 0, (void *)s);

	return count;
}

static DEVICE_ATTR_WO(reset_test);

static void disable_non_bootcpu_shutdown(void)
{
	int error = 0, cpu, primary = 0;

	if (!cpu_online(primary))
		primary = cpumask_first(cpu_online_mask);

	cpu_hotplug_enable();

	for_each_online_cpu(cpu) {
		if (cpu == primary)
			continue;

		error = remove_cpu(cpu);
		if (error) {
			pr_err("Error taking CPU%d down: %d\n", cpu, error);
			break;
		}
	}

	if (!error)
		WARN_ON(num_online_cpus() > 1);
	else
		pr_err("Non-boot CPUs are not disabled\n");

	cpu_hotplug_disable();
}

static struct syscore_ops disable_non_bootcpu_syscore_ops = {
	.shutdown		= disable_non_bootcpu_shutdown,
};

static int __init reboot_pm_init_ops(void)
{
	register_syscore_ops(&disable_non_bootcpu_syscore_ops);
	return 0;
}

static struct notifier_block aml_restart_nb = {
	.notifier_call = do_aml_restart,
	.priority = 130,
};

static ssize_t sticky_reg_show(struct device *parent,
			 struct device_attribute *attr, char *buf)
{
	int ret = 0;
	unsigned int reg0_val;
	unsigned int reg1_val;

	if (sticky_reg0 != 0 && sticky_reg1 != 0) {
		reg0_val = readl(sticky_reg0);
		reg1_val = readl(sticky_reg1);
		ret = sprintf(buf, "sticky_reg0=0x%x, sticky_reg1=0x%x\n",
				reg0_val, reg1_val);

	} else {
		ret = sprintf(buf, "invalid sticky register\n");
	}

	return ret;
}

static ssize_t sticky_reg_store(struct device *parent,
		struct device_attribute *attr, const char *buf, size_t size)
{
	long val;

	if (kstrtoul(buf, 10, &val))
		return 0;

	if (val == 0) {
		if (sticky_reg0 != 0 && sticky_reg1 != 0) {
			writel(0x0, sticky_reg0);
			writel(0x0, sticky_reg1);
		}
	}

	return size;
}

static DEVICE_ATTR_RW(sticky_reg);

static struct attribute *sticky_reg_attrs[] = {
	&dev_attr_sticky_reg.attr,
	NULL,
};
ATTRIBUTE_GROUPS(sticky_reg);

static int aml_restart_probe(struct platform_device *pdev)
{
	u32 id;
	int ret;
	unsigned int reg;

	if (!of_property_read_u32(pdev->dev.of_node, "sys_reset", &id)) {
		psci_function_id_restart = id;
		register_restart_handler(&aml_restart_nb);
		ret = device_create_file(&pdev->dev, &dev_attr_reset_test);
		if (ret != 0)
			pr_err("%s, device create file failed, ret = %d!\n",
			       __func__, ret);
	}

	if (!of_property_read_u32(pdev->dev.of_node, "sys_poweroff", &id)) {
		psci_function_id_poweroff = id;
		pm_power_off = do_aml_poweroff;
	}

	/* SYSCTRL_STICKY_REG6 */
	if (!of_property_read_u32(pdev->dev.of_node, "sticky_reg0", &reg))
		sticky_reg0 = (unsigned int *)ioremap(reg, 4);

	/* SYSCTRL_STICKY_REG7 */
	if (!of_property_read_u32(pdev->dev.of_node, "sticky_reg1", &reg))
		sticky_reg1 = (unsigned int *)ioremap(reg, 4);

	sticky_reg_cls = kzalloc(sizeof(*sticky_reg_cls), GFP_KERNEL);
	if (!sticky_reg_cls)
		return -1;

	sticky_reg_cls->name = sticky_reg_dev;
	sticky_reg_cls->class_groups = sticky_reg_groups;
	if (class_register(sticky_reg_cls) < 0) {
		pr_err("failed to class_reg for sticky reg\n");
		return -1;
	}

	reboot_reason_vaddr = devm_platform_ioremap_resource(pdev, 0);
	if (!IS_ERR(reboot_reason_vaddr)) {
		ret = device_create_file(&pdev->dev, &dev_attr_reboot_reason);
		if (ret != 0)
			pr_err("%s, device create file failed, ret = %d!\n",
			       __func__, ret);

		support_reboot_reason_ext = of_property_read_bool(pdev->dev.of_node,
				"extend_reboot_reason");
	}

	if (of_property_read_bool(pdev->dev.of_node,
					"dis_nb_cpus_in_shutdown")) {
		pr_debug("Enable disable_nonboot_cpus in syscore shutdown.\n");
		reboot_pm_init_ops();
	}

	ret = register_die_notifier(&panic_notifier);
	if (ret != 0) {
		pr_err("%s,register die notifier failed,ret =%d!\n",
		       __func__, ret);
		return ret;
	}

	/* Register a call for panic conditions. */
	ret = atomic_notifier_chain_register(&panic_notifier_list,
					     &panic_notifier);
	if (ret != 0) {
		pr_err("%s,register panic notifier failed,ret =%d!\n",
		       __func__, ret);
		return ret;
	}
	return 0;
}

static const struct of_device_id of_aml_restart_match[] = {
	{ .compatible = "aml, reboot", },
	{},
};
MODULE_DEVICE_TABLE(of, of_aml_restart_match);

static struct platform_driver aml_restart_driver = {
	.probe = aml_restart_probe,
	.driver = {
		.name = "aml-restart",
		.of_match_table = of_match_ptr(of_aml_restart_match),
	},
};

int __init reboot_init(void)
{
	int rc;

#ifdef CONFIG_MMC_TS_STORE_REBOOT_REASON
	reboot_notifier.notifier_call = bcb_reason_reboot_hook;
	rc = register_reboot_notifier(&reboot_notifier);
	if (rc) {
		pr_err("cannot register reboot notifier (err=%d)\n", rc);
		return rc;
	}
#endif

	rc = platform_driver_register(&aml_restart_driver);
	if (rc) {
		pr_err("cannot register platform driver (err=%d)\n", rc);
#ifdef CONFIG_MMC_TS_STORE_REBOOT_REASON
		unregister_reboot_notifier(&reboot_notifier);
		reboot_notifier.notifier_call = NULL;
#endif
	}

	return rc;
}

void __exit reboot_exit(void)
{
	platform_driver_unregister(&aml_restart_driver);

#ifdef CONFIG_MMC_TS_STORE_REBOOT_REASON
	unregister_reboot_notifier(&reboot_notifier);
	reboot_notifier.notifier_call = NULL;
#endif
}