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

// SPDX-License-Identifier: GPL-2.0-only
/*
 * Amlogic Secure Monitor driver
 *
 * Copyright (C) 2016 Endless Mobile, Inc.
 * Author: Carlo Caione <carlo@endlessm.com>
 */

#define pr_fmt(fmt) "meson-sm: " fmt

#include <linux/arm-smccc.h>
#include <linux/bug.h>
#include <linux/io.h>
#include <linux/module.h>
#include <linux/of.h>
#include <linux/of_device.h>
#include <linux/platform_device.h>
#include <linux/printk.h>
#include <linux/types.h>
#include <linux/sizes.h>
 #include <linux/slab.h>

#include <linux/firmware/meson/meson_sm.h>

struct meson_sm_cmd {
	unsigned int index;
	u32 smc_id;
};
#define CMD(d, s) { .index = (d), .smc_id = (s), }

struct meson_sm_chip {
	unsigned int shmem_size;
	u32 cmd_shmem_in_base;
	u32 cmd_shmem_out_base;
	struct meson_sm_cmd cmd[];
};

struct meson_sm_chip gxbb_chip = {
	.shmem_size		= SZ_4K,
	.cmd_shmem_in_base	= 0x82000020,
	.cmd_shmem_out_base	= 0x82000021,
	.cmd = {
		CMD(SM_EFUSE_READ,	0x82000030),
		CMD(SM_EFUSE_WRITE,	0x82000031),
		CMD(SM_EFUSE_USER_MAX,	0x82000033),
		CMD(SM_GET_CHIP_ID,	0x82000044),
		{ /* sentinel */ },
	},
};

struct meson_sm_firmware {
	const struct meson_sm_chip *chip;
	void __iomem *sm_shmem_in_base;
	void __iomem *sm_shmem_out_base;
};

static struct meson_sm_firmware fw;

static u32 meson_sm_get_cmd(const struct meson_sm_chip *chip,
			    unsigned int cmd_index)
{
	const struct meson_sm_cmd *cmd = chip->cmd;

	while (cmd->smc_id && cmd->index != cmd_index)
		cmd++;

	return cmd->smc_id;
}

static u32 __meson_sm_call(u32 cmd, u32 arg0, u32 arg1, u32 arg2,
			   u32 arg3, u32 arg4)
{
	struct arm_smccc_res res;

	arm_smccc_smc(cmd, arg0, arg1, arg2, arg3, arg4, 0, 0, &res);
	return res.a0;
}

static void __iomem *meson_sm_map_shmem(u32 cmd_shmem, unsigned int size)
{
	u32 sm_phy_base;

	sm_phy_base = __meson_sm_call(cmd_shmem, 0, 0, 0, 0, 0);
	if (!sm_phy_base)
		return 0;

	return ioremap_cache(sm_phy_base, size);
}

/**
 * meson_sm_call - generic SMC32 call to the secure-monitor
 *
 * @cmd_index:	Index of the SMC32 function ID
 * @ret:	Returned value
 * @arg0:	SMC32 Argument 0
 * @arg1:	SMC32 Argument 1
 * @arg2:	SMC32 Argument 2
 * @arg3:	SMC32 Argument 3
 * @arg4:	SMC32 Argument 4
 *
 * Return:	0 on success, a negative value on error
 */
int meson_sm_call(unsigned int cmd_index, u32 *ret, u32 arg0,
		  u32 arg1, u32 arg2, u32 arg3, u32 arg4)
{
	u32 cmd, lret;

	if (!fw.chip)
		return -ENOENT;

	cmd = meson_sm_get_cmd(fw.chip, cmd_index);
	if (!cmd)
		return -EINVAL;

	lret = __meson_sm_call(cmd, arg0, arg1, arg2, arg3, arg4);

	if (ret)
		*ret = lret;

	return 0;
}
EXPORT_SYMBOL(meson_sm_call);

/**
 * meson_sm_call_read - retrieve data from secure-monitor
 *
 * @buffer:	Buffer to store the retrieved data
 * @bsize:	Size of the buffer
 * @cmd_index:	Index of the SMC32 function ID
 * @arg0:	SMC32 Argument 0
 * @arg1:	SMC32 Argument 1
 * @arg2:	SMC32 Argument 2
 * @arg3:	SMC32 Argument 3
 * @arg4:	SMC32 Argument 4
 *
 * Return:	size of read data on success, a negative value on error
 *		When 0 is returned there is no guarantee about the amount of
 *		data read and bsize bytes are copied in buffer.
 */
int meson_sm_call_read(void *buffer, unsigned int bsize, unsigned int cmd_index,
		       u32 arg0, u32 arg1, u32 arg2, u32 arg3, u32 arg4)
{
	u32 size;
	int ret;

	if (!fw.chip)
		return -ENOENT;

	if (!fw.chip->cmd_shmem_out_base)
		return -EINVAL;

	if (bsize > fw.chip->shmem_size)
		return -EINVAL;

	if (meson_sm_call(cmd_index, &size, arg0, arg1, arg2, arg3, arg4) < 0)
		return -EINVAL;

	if (size > bsize)
		return -EINVAL;

	ret = size;

	if (!size)
		size = bsize;

	if (buffer)
		memcpy(buffer, fw.sm_shmem_out_base, size);

	return ret;
}
EXPORT_SYMBOL(meson_sm_call_read);

/**
 * meson_sm_call_write - send data to secure-monitor
 *
 * @buffer:	Buffer containing data to send
 * @size:	Size of the data to send
 * @cmd_index:	Index of the SMC32 function ID
 * @arg0:	SMC32 Argument 0
 * @arg1:	SMC32 Argument 1
 * @arg2:	SMC32 Argument 2
 * @arg3:	SMC32 Argument 3
 * @arg4:	SMC32 Argument 4
 *
 * Return:	size of sent data on success, a negative value on error
 */
int meson_sm_call_write(void *buffer, unsigned int size, unsigned int cmd_index,
			u32 arg0, u32 arg1, u32 arg2, u32 arg3, u32 arg4)
{
	u32 written;

	if (!fw.chip)
		return -ENOENT;

	if (size > fw.chip->shmem_size)
		return -EINVAL;

	if (!fw.chip->cmd_shmem_in_base)
		return -EINVAL;

	memcpy(fw.sm_shmem_in_base, buffer, size);

	if (meson_sm_call(cmd_index, &written, arg0, arg1, arg2, arg3, arg4) < 0)
		return -EINVAL;

	if (!written)
		return -EINVAL;

	return written;
}
EXPORT_SYMBOL(meson_sm_call_write);

#define SM_CHIP_ID_LENGTH	119
#define SM_CHIP_ID_OFFSET	4
#define SM_CHIP_ID_SIZE		12

static ssize_t serial_show(struct device *dev, struct device_attribute *attr,
			 char *buf)
{
	uint8_t *id_buf;
	int ret;

	id_buf = kmalloc(SM_CHIP_ID_LENGTH, GFP_KERNEL);
	if (!id_buf)
		return -ENOMEM;

	ret = meson_sm_call_read(id_buf, SM_CHIP_ID_LENGTH, SM_GET_CHIP_ID,
				 0, 0, 0, 0, 0);
	if (ret < 0) {
		kfree(id_buf);
		return ret;
	}

	ret = sprintf(buf, "%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x\n",
			id_buf[SM_CHIP_ID_OFFSET + 0],
			id_buf[SM_CHIP_ID_OFFSET + 1],
			id_buf[SM_CHIP_ID_OFFSET + 2],
			id_buf[SM_CHIP_ID_OFFSET + 3],
			id_buf[SM_CHIP_ID_OFFSET + 4],
			id_buf[SM_CHIP_ID_OFFSET + 5],
			id_buf[SM_CHIP_ID_OFFSET + 6],
			id_buf[SM_CHIP_ID_OFFSET + 7],
			id_buf[SM_CHIP_ID_OFFSET + 8],
			id_buf[SM_CHIP_ID_OFFSET + 9],
			id_buf[SM_CHIP_ID_OFFSET + 10],
			id_buf[SM_CHIP_ID_OFFSET + 11]);

	kfree(id_buf);

	return ret;
}

static DEVICE_ATTR_RO(serial);

static struct attribute *meson_sm_sysfs_attributes[] = {
	&dev_attr_serial.attr,
	NULL,
};

static const struct attribute_group meson_sm_sysfs_attr_group = {
	.attrs = meson_sm_sysfs_attributes,
};

static const struct of_device_id meson_sm_ids[] = {
	{ .compatible = "amlogic,meson-gxbb-sm", .data = &gxbb_chip },
	{ /* sentinel */ },
};

static int __init meson_sm_probe(struct platform_device *pdev)
{
	const struct meson_sm_chip *chip;

	chip = of_match_device(meson_sm_ids, &pdev->dev)->data;

	if (chip->cmd_shmem_in_base) {
		fw.sm_shmem_in_base = meson_sm_map_shmem(chip->cmd_shmem_in_base,
							 chip->shmem_size);
		if (WARN_ON(!fw.sm_shmem_in_base))
			goto out;
	}

	if (chip->cmd_shmem_out_base) {
		fw.sm_shmem_out_base = meson_sm_map_shmem(chip->cmd_shmem_out_base,
							  chip->shmem_size);
		if (WARN_ON(!fw.sm_shmem_out_base))
			goto out_in_base;
	}

	fw.chip = chip;
	pr_info("secure-monitor enabled\n");

	if (sysfs_create_group(&pdev->dev.kobj, &meson_sm_sysfs_attr_group))
		goto out_in_base;

	return 0;

out_in_base:
	iounmap(fw.sm_shmem_in_base);
out:
	return -EINVAL;
}

static struct platform_driver meson_sm_driver = {
	.driver = {
		.name = "meson-sm",
		.of_match_table = of_match_ptr(meson_sm_ids),
	},
};
module_platform_driver_probe(meson_sm_driver, meson_sm_probe);
Commit	Line	Data
3c910ecb	1	// SPDX-License-Identifier: GPL-2.0-only
2c4ddb21 CC	2	/*
	3	* Amlogic Secure Monitor driver
	4	*
	5	* Copyright (C) 2016 Endless Mobile, Inc.
	6	* Author: Carlo Caione <carlo@endlessm.com>
2c4ddb21 CC	7	*/
	8
	9	#define pr_fmt(fmt) "meson-sm: " fmt
	10
	11	#include <linux/arm-smccc.h>
	12	#include <linux/bug.h>
	13	#include <linux/io.h>
e0270c80	14	#include <linux/module.h>
2c4ddb21 CC	15	#include <linux/of.h>
2c4ddb21 CC	16	#include <linux/of_device.h>
e0270c80	17	#include <linux/platform_device.h>
2c4ddb21 CC	18	#include <linux/printk.h>
	19	#include <linux/types.h>
	20	#include <linux/sizes.h>
0789724f	21	#include <linux/slab.h>
2c4ddb21 CC	22
	23	#include <linux/firmware/meson/meson_sm.h>
	24
	25	struct meson_sm_cmd {
	26	unsigned int index;
	27	u32 smc_id;
	28	};
	29	#define CMD(d, s) { .index = (d), .smc_id = (s), }
	30
	31	struct meson_sm_chip {
	32	unsigned int shmem_size;
	33	u32 cmd_shmem_in_base;
	34	u32 cmd_shmem_out_base;
	35	struct meson_sm_cmd cmd[];
	36	};
	37
	38	struct meson_sm_chip gxbb_chip = {
	39	.shmem_size = SZ_4K,
	40	.cmd_shmem_in_base = 0x82000020,
	41	.cmd_shmem_out_base = 0x82000021,
	42	.cmd = {
	43	CMD(SM_EFUSE_READ, 0x82000030),
	44	CMD(SM_EFUSE_WRITE, 0x82000031),
	45	CMD(SM_EFUSE_USER_MAX, 0x82000033),
0789724f	46	CMD(SM_GET_CHIP_ID, 0x82000044),
2c4ddb21 CC	47	{ /* sentinel */ },
	48	},
	49	};
	50
	51	struct meson_sm_firmware {
	52	const struct meson_sm_chip *chip;
	53	void __iomem *sm_shmem_in_base;
	54	void __iomem *sm_shmem_out_base;
	55	};
	56
	57	static struct meson_sm_firmware fw;
	58
	59	static u32 meson_sm_get_cmd(const struct meson_sm_chip *chip,
	60	unsigned int cmd_index)
	61	{
	62	const struct meson_sm_cmd *cmd = chip->cmd;
	63
	64	while (cmd->smc_id && cmd->index != cmd_index)
	65	cmd++;
	66
	67	return cmd->smc_id;
	68	}
	69
	70	static u32 __meson_sm_call(u32 cmd, u32 arg0, u32 arg1, u32 arg2,
	71	u32 arg3, u32 arg4)
	72	{
	73	struct arm_smccc_res res;
	74
	75	arm_smccc_smc(cmd, arg0, arg1, arg2, arg3, arg4, 0, 0, &res);
	76	return res.a0;
	77	}
	78
	79	static void __iomem *meson_sm_map_shmem(u32 cmd_shmem, unsigned int size)
	80	{
	81	u32 sm_phy_base;
	82
	83	sm_phy_base = __meson_sm_call(cmd_shmem, 0, 0, 0, 0, 0);
	84	if (!sm_phy_base)
	85	return 0;
	86
	87	return ioremap_cache(sm_phy_base, size);
	88	}
	89
	90	/**
	91	* meson_sm_call - generic SMC32 call to the secure-monitor
	92	*
	93	* @cmd_index: Index of the SMC32 function ID
	94	* @ret: Returned value
	95	* @arg0: SMC32 Argument 0
	96	* @arg1: SMC32 Argument 1
	97	* @arg2: SMC32 Argument 2
	98	* @arg3: SMC32 Argument 3
	99	* @arg4: SMC32 Argument 4
	100	*
	101	* Return: 0 on success, a negative value on error
	102	*/
	103	int meson_sm_call(unsigned int cmd_index, u32 *ret, u32 arg0,
	104	u32 arg1, u32 arg2, u32 arg3, u32 arg4)
	105	{
	106	u32 cmd, lret;
	107
	108	if (!fw.chip)
	109	return -ENOENT;
	110
111	cmd = meson_sm_get_cmd(fw.chip, cmd_index);
112	if (!cmd)
113	return -EINVAL;
114
115	lret = __meson_sm_call(cmd, arg0, arg1, arg2, arg3, arg4);
116
117	if (ret)
118	*ret = lret;
119
120	return 0;
121	}
122	EXPORT_SYMBOL(meson_sm_call);
123
124	/**
125	* meson_sm_call_read - retrieve data from secure-monitor
126	*
127	* @buffer: Buffer to store the retrieved data
83e007a0	128	* @bsize: Size of the buffer
2c4ddb21 CC	129	* @cmd_index: Index of the SMC32 function ID
	130	* @arg0: SMC32 Argument 0
	131	* @arg1: SMC32 Argument 1
	132	* @arg2: SMC32 Argument 2
	133	* @arg3: SMC32 Argument 3
	134	* @arg4: SMC32 Argument 4
	135	*
	136	* Return: size of read data on success, a negative value on error
7a9bc330 CC	137	* When 0 is returned there is no guarantee about the amount of
7a9bc330 CC	138	* data read and bsize bytes are copied in buffer.
2c4ddb21	139	*/
83e007a0 CC	140	int meson_sm_call_read(void *buffer, unsigned int bsize, unsigned int cmd_index,
83e007a0 CC	141	u32 arg0, u32 arg1, u32 arg2, u32 arg3, u32 arg4)
2c4ddb21 CC	142	{
2c4ddb21 CC	143	u32 size;
7a9bc330	144	int ret;
2c4ddb21 CC	145
	146	if (!fw.chip)
	147	return -ENOENT;
	148
	149	if (!fw.chip->cmd_shmem_out_base)
	150	return -EINVAL;
	151
83e007a0 CC	152	if (bsize > fw.chip->shmem_size)
	153	return -EINVAL;
	154
2c4ddb21 CC	155	if (meson_sm_call(cmd_index, &size, arg0, arg1, arg2, arg3, arg4) < 0)
	156	return -EINVAL;
	157
7a9bc330	158	if (size > bsize)
2c4ddb21 CC	159	return -EINVAL;
2c4ddb21 CC	160
7a9bc330 CC	161	ret = size;
	162
	163	if (!size)
	164	size = bsize;
	165
2c4ddb21 CC	166	if (buffer)
	167	memcpy(buffer, fw.sm_shmem_out_base, size);
	168
7a9bc330	169	return ret;
2c4ddb21 CC	170	}
	171	EXPORT_SYMBOL(meson_sm_call_read);
	172
	173	/**
	174	* meson_sm_call_write - send data to secure-monitor
	175	*
	176	* @buffer: Buffer containing data to send
	177	* @size: Size of the data to send
	178	* @cmd_index: Index of the SMC32 function ID
	179	* @arg0: SMC32 Argument 0
	180	* @arg1: SMC32 Argument 1
	181	* @arg2: SMC32 Argument 2
	182	* @arg3: SMC32 Argument 3
	183	* @arg4: SMC32 Argument 4
	184	*
	185	* Return: size of sent data on success, a negative value on error
	186	*/
	187	int meson_sm_call_write(void *buffer, unsigned int size, unsigned int cmd_index,
	188	u32 arg0, u32 arg1, u32 arg2, u32 arg3, u32 arg4)
	189	{
	190	u32 written;
	191
	192	if (!fw.chip)
	193	return -ENOENT;
	194
	195	if (size > fw.chip->shmem_size)
	196	return -EINVAL;
	197
	198	if (!fw.chip->cmd_shmem_in_base)
	199	return -EINVAL;
	200
	201	memcpy(fw.sm_shmem_in_base, buffer, size);
	202
	203	if (meson_sm_call(cmd_index, &written, arg0, arg1, arg2, arg3, arg4) < 0)
	204	return -EINVAL;
	205
	206	if (!written)
	207	return -EINVAL;
	208
	209	return written;
	210	}
	211	EXPORT_SYMBOL(meson_sm_call_write);
	212
0789724f NA	213	#define SM_CHIP_ID_LENGTH 119
	214	#define SM_CHIP_ID_OFFSET 4
	215	#define SM_CHIP_ID_SIZE 12
	216
	217	static ssize_t serial_show(struct device dev, struct device_attribute attr,
	218	char *buf)
	219	{
	220	uint8_t *id_buf;
	221	int ret;
	222
	223	id_buf = kmalloc(SM_CHIP_ID_LENGTH, GFP_KERNEL);
	224	if (!id_buf)
	225	return -ENOMEM;
	226
	227	ret = meson_sm_call_read(id_buf, SM_CHIP_ID_LENGTH, SM_GET_CHIP_ID,
	228	0, 0, 0, 0, 0);
	229	if (ret < 0) {
	230	kfree(id_buf);
	231	return ret;
	232	}
	233
	234	ret = sprintf(buf, "%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x\n",
	235	id_buf[SM_CHIP_ID_OFFSET + 0],
	236	id_buf[SM_CHIP_ID_OFFSET + 1],
	237	id_buf[SM_CHIP_ID_OFFSET + 2],
	238	id_buf[SM_CHIP_ID_OFFSET + 3],
	239	id_buf[SM_CHIP_ID_OFFSET + 4],
	240	id_buf[SM_CHIP_ID_OFFSET + 5],
	241	id_buf[SM_CHIP_ID_OFFSET + 6],
	242	id_buf[SM_CHIP_ID_OFFSET + 7],
	243	id_buf[SM_CHIP_ID_OFFSET + 8],
	244	id_buf[SM_CHIP_ID_OFFSET + 9],
	245	id_buf[SM_CHIP_ID_OFFSET + 10],
	246	id_buf[SM_CHIP_ID_OFFSET + 11]);
	247
	248	kfree(id_buf);
	249
	250	return ret;
	251	}
	252
	253	static DEVICE_ATTR_RO(serial);
	254
	255	static struct attribute *meson_sm_sysfs_attributes[] = {
	256	&dev_attr_serial.attr,
	257	NULL,
	258	};
	259
	260	static const struct attribute_group meson_sm_sysfs_attr_group = {
	261	.attrs = meson_sm_sysfs_attributes,
	262	};
	263
2c4ddb21 CC	264	static const struct of_device_id meson_sm_ids[] = {
	265	{ .compatible = "amlogic,meson-gxbb-sm", .data = &gxbb_chip },
	266	{ /* sentinel */ },
	267	};
	268
e0270c80	269	static int __init meson_sm_probe(struct platform_device *pdev)
2c4ddb21 CC	270	{
2c4ddb21 CC	271	const struct meson_sm_chip *chip;
2c4ddb21	272
e0270c80	273	chip = of_match_device(meson_sm_ids, &pdev->dev)->data;
2c4ddb21 CC	274
	275	if (chip->cmd_shmem_in_base) {
	276	fw.sm_shmem_in_base = meson_sm_map_shmem(chip->cmd_shmem_in_base,
	277	chip->shmem_size);
	278	if (WARN_ON(!fw.sm_shmem_in_base))
	279	goto out;
	280	}
	281
	282	if (chip->cmd_shmem_out_base) {
	283	fw.sm_shmem_out_base = meson_sm_map_shmem(chip->cmd_shmem_out_base,
	284	chip->shmem_size);
	285	if (WARN_ON(!fw.sm_shmem_out_base))
	286	goto out_in_base;
	287	}
	288
	289	fw.chip = chip;
	290	pr_info("secure-monitor enabled\n");
	291
0789724f NA	292	if (sysfs_create_group(&pdev->dev.kobj, &meson_sm_sysfs_attr_group))
	293	goto out_in_base;
	294
2c4ddb21 CC	295	return 0;
	296
	297	out_in_base:
	298	iounmap(fw.sm_shmem_in_base);
	299	out:
	300	return -EINVAL;
	301	}
e0270c80 SH	302
	303	static struct platform_driver meson_sm_driver = {
	304	.driver = {
	305	.name = "meson-sm",
	306	.of_match_table = of_match_ptr(meson_sm_ids),
	307	},
	308	};
	309	module_platform_driver_probe(meson_sm_driver, meson_sm_probe);