[mirror_ubuntu-jammy-kernel.git] / drivers / soc / qcom / smd-rpm.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 * Copyright (c) 2015, Sony Mobile Communications AB.
 * Copyright (c) 2012-2013, The Linux Foundation. All rights reserved.
 */

#include <linux/module.h>
#include <linux/platform_device.h>
#include <linux/of_platform.h>
#include <linux/io.h>
#include <linux/interrupt.h>
#include <linux/slab.h>

#include <linux/rpmsg.h>
#include <linux/soc/qcom/smd-rpm.h>

#define RPM_REQUEST_TIMEOUT     (5 * HZ)

/**
 * struct qcom_smd_rpm - state of the rpm device driver
 * @rpm_channel:	reference to the smd channel
 * @icc:		interconnect proxy device
 * @ack:		completion for acks
 * @lock:		mutual exclusion around the send/complete pair
 * @ack_status:		result of the rpm request
 */
struct qcom_smd_rpm {
	struct rpmsg_endpoint *rpm_channel;
	struct platform_device *icc;
	struct device *dev;

	struct completion ack;
	struct mutex lock;
	int ack_status;
};

/**
 * struct qcom_rpm_header - header for all rpm requests and responses
 * @service_type:	identifier of the service
 * @length:		length of the payload
 */
struct qcom_rpm_header {
	__le32 service_type;
	__le32 length;
};

/**
 * struct qcom_rpm_request - request message to the rpm
 * @msg_id:	identifier of the outgoing message
 * @flags:	active/sleep state flags
 * @type:	resource type
 * @id:		resource id
 * @data_len:	length of the payload following this header
 */
struct qcom_rpm_request {
	__le32 msg_id;
	__le32 flags;
	__le32 type;
	__le32 id;
	__le32 data_len;
};

/**
 * struct qcom_rpm_message - response message from the rpm
 * @msg_type:	indicator of the type of message
 * @length:	the size of this message, including the message header
 * @msg_id:	message id
 * @message:	textual message from the rpm
 *
 * Multiple of these messages can be stacked in an rpm message.
 */
struct qcom_rpm_message {
	__le32 msg_type;
	__le32 length;
	union {
		__le32 msg_id;
		u8 message[0];
	};
};

#define RPM_SERVICE_TYPE_REQUEST	0x00716572 /* "req\0" */

#define RPM_MSG_TYPE_ERR		0x00727265 /* "err\0" */
#define RPM_MSG_TYPE_MSG_ID		0x2367736d /* "msg#" */

/**
 * qcom_rpm_smd_write - write @buf to @type:@id
 * @rpm:	rpm handle
 * @type:	resource type
 * @id:		resource identifier
 * @buf:	the data to be written
 * @count:	number of bytes in @buf
 */
int qcom_rpm_smd_write(struct qcom_smd_rpm *rpm,
		       int state,
		       u32 type, u32 id,
		       void *buf,
		       size_t count)
{
	static unsigned msg_id = 1;
	int left;
	int ret;
	struct {
		struct qcom_rpm_header hdr;
		struct qcom_rpm_request req;
		u8 payload[];
	} *pkt;
	size_t size = sizeof(*pkt) + count;

	/* SMD packets to the RPM may not exceed 256 bytes */
	if (WARN_ON(size >= 256))
		return -EINVAL;

	pkt = kmalloc(size, GFP_KERNEL);
	if (!pkt)
		return -ENOMEM;

	mutex_lock(&rpm->lock);

	pkt->hdr.service_type = cpu_to_le32(RPM_SERVICE_TYPE_REQUEST);
	pkt->hdr.length = cpu_to_le32(sizeof(struct qcom_rpm_request) + count);

	pkt->req.msg_id = cpu_to_le32(msg_id++);
	pkt->req.flags = cpu_to_le32(state);
	pkt->req.type = cpu_to_le32(type);
	pkt->req.id = cpu_to_le32(id);
	pkt->req.data_len = cpu_to_le32(count);
	memcpy(pkt->payload, buf, count);

	ret = rpmsg_send(rpm->rpm_channel, pkt, size);
	if (ret)
		goto out;

	left = wait_for_completion_timeout(&rpm->ack, RPM_REQUEST_TIMEOUT);
	if (!left)
		ret = -ETIMEDOUT;
	else
		ret = rpm->ack_status;

out:
	kfree(pkt);
	mutex_unlock(&rpm->lock);
	return ret;
}
EXPORT_SYMBOL(qcom_rpm_smd_write);

static int qcom_smd_rpm_callback(struct rpmsg_device *rpdev,
				 void *data,
				 int count,
				 void *priv,
				 u32 addr)
{
	const struct qcom_rpm_header *hdr = data;
	size_t hdr_length = le32_to_cpu(hdr->length);
	const struct qcom_rpm_message *msg;
	struct qcom_smd_rpm *rpm = dev_get_drvdata(&rpdev->dev);
	const u8 *buf = data + sizeof(struct qcom_rpm_header);
	const u8 *end = buf + hdr_length;
	char msgbuf[32];
	int status = 0;
	u32 len, msg_length;

	if (le32_to_cpu(hdr->service_type) != RPM_SERVICE_TYPE_REQUEST ||
	    hdr_length < sizeof(struct qcom_rpm_message)) {
		dev_err(rpm->dev, "invalid request\n");
		return 0;
	}

	while (buf < end) {
		msg = (struct qcom_rpm_message *)buf;
		msg_length = le32_to_cpu(msg->length);
		switch (le32_to_cpu(msg->msg_type)) {
		case RPM_MSG_TYPE_MSG_ID:
			break;
		case RPM_MSG_TYPE_ERR:
			len = min_t(u32, ALIGN(msg_length, 4), sizeof(msgbuf));
			memcpy_fromio(msgbuf, msg->message, len);
			msgbuf[len - 1] = 0;

			if (!strcmp(msgbuf, "resource does not exist"))
				status = -ENXIO;
			else
				status = -EINVAL;
			break;
		}

		buf = PTR_ALIGN(buf + 2 * sizeof(u32) + msg_length, 4);
	}

	rpm->ack_status = status;
	complete(&rpm->ack);
	return 0;
}

static int qcom_smd_rpm_probe(struct rpmsg_device *rpdev)
{
	struct qcom_smd_rpm *rpm;
	int ret;

	rpm = devm_kzalloc(&rpdev->dev, sizeof(*rpm), GFP_KERNEL);
	if (!rpm)
		return -ENOMEM;

	mutex_init(&rpm->lock);
	init_completion(&rpm->ack);

	rpm->dev = &rpdev->dev;
	rpm->rpm_channel = rpdev->ept;
	dev_set_drvdata(&rpdev->dev, rpm);

	rpm->icc = platform_device_register_data(&rpdev->dev, "icc_smd_rpm", -1,
						 NULL, 0);
	if (IS_ERR(rpm->icc))
		return PTR_ERR(rpm->icc);

	ret = of_platform_populate(rpdev->dev.of_node, NULL, NULL, &rpdev->dev);
	if (ret)
		platform_device_unregister(rpm->icc);

	return ret;
}

static void qcom_smd_rpm_remove(struct rpmsg_device *rpdev)
{
	struct qcom_smd_rpm *rpm = dev_get_drvdata(&rpdev->dev);

	platform_device_unregister(rpm->icc);
	of_platform_depopulate(&rpdev->dev);
}

static const struct of_device_id qcom_smd_rpm_of_match[] = {
	{ .compatible = "qcom,rpm-apq8084" },
	{ .compatible = "qcom,rpm-msm8916" },
	{ .compatible = "qcom,rpm-msm8974" },
	{ .compatible = "qcom,rpm-msm8976" },
	{ .compatible = "qcom,rpm-msm8996" },
	{ .compatible = "qcom,rpm-msm8998" },
	{ .compatible = "qcom,rpm-sdm660" },
	{ .compatible = "qcom,rpm-qcs404" },
	{}
};
MODULE_DEVICE_TABLE(of, qcom_smd_rpm_of_match);

static struct rpmsg_driver qcom_smd_rpm_driver = {
	.probe = qcom_smd_rpm_probe,
	.remove = qcom_smd_rpm_remove,
	.callback = qcom_smd_rpm_callback,
	.drv  = {
		.name  = "qcom_smd_rpm",
		.of_match_table = qcom_smd_rpm_of_match,
	},
};

static int __init qcom_smd_rpm_init(void)
{
	return register_rpmsg_driver(&qcom_smd_rpm_driver);
}
arch_initcall(qcom_smd_rpm_init);

static void __exit qcom_smd_rpm_exit(void)
{
	unregister_rpmsg_driver(&qcom_smd_rpm_driver);
}
module_exit(qcom_smd_rpm_exit);

MODULE_AUTHOR("Bjorn Andersson <bjorn.andersson@sonymobile.com>");
MODULE_DESCRIPTION("Qualcomm SMD backed RPM driver");
MODULE_LICENSE("GPL v2");
Commit	Line	Data
97fb5e8d	1	// SPDX-License-Identifier: GPL-2.0-only
936f14cf BA	2	/*
	3	* Copyright (c) 2015, Sony Mobile Communications AB.
	4	* Copyright (c) 2012-2013, The Linux Foundation. All rights reserved.
936f14cf BA	5	*/
	6
	7	#include <linux/module.h>
	8	#include <linux/platform_device.h>
	9	#include <linux/of_platform.h>
	10	#include <linux/io.h>
	11	#include <linux/interrupt.h>
50e1b29b	12	#include <linux/slab.h>
936f14cf	13
5052de8d	14	#include <linux/rpmsg.h>
936f14cf BA	15	#include <linux/soc/qcom/smd-rpm.h>
	16
	17	#define RPM_REQUEST_TIMEOUT (5 * HZ)
	18
	19	/**
	20	* struct qcom_smd_rpm - state of the rpm device driver
	21	* @rpm_channel: reference to the smd channel
66e6a633	22	* @icc: interconnect proxy device
936f14cf BA	23	* @ack: completion for acks
	24	* @lock: mutual exclusion around the send/complete pair
	25	* @ack_status: result of the rpm request
	26	*/
	27	struct qcom_smd_rpm {
5052de8d	28	struct rpmsg_endpoint *rpm_channel;
66e6a633	29	struct platform_device *icc;
b853cb96	30	struct device *dev;
936f14cf BA	31
	32	struct completion ack;
	33	struct mutex lock;
	34	int ack_status;
	35	};
	36
	37	/**
	38	* struct qcom_rpm_header - header for all rpm requests and responses
	39	* @service_type: identifier of the service
	40	* @length: length of the payload
	41	*/
	42	struct qcom_rpm_header {
30b7ea5e SB	43	__le32 service_type;
30b7ea5e SB	44	__le32 length;
936f14cf BA	45	};
	46
	47	/**
	48	* struct qcom_rpm_request - request message to the rpm
	49	* @msg_id: identifier of the outgoing message
	50	* @flags: active/sleep state flags
	51	* @type: resource type
	52	* @id: resource id
	53	* @data_len: length of the payload following this header
	54	*/
	55	struct qcom_rpm_request {
30b7ea5e SB	56	__le32 msg_id;
	57	__le32 flags;
	58	__le32 type;
	59	__le32 id;
	60	__le32 data_len;
936f14cf BA	61	};
	62
	63	/**
	64	* struct qcom_rpm_message - response message from the rpm
	65	* @msg_type: indicator of the type of message
	66	* @length: the size of this message, including the message header
	67	* @msg_id: message id
	68	* @message: textual message from the rpm
	69	*
	70	* Multiple of these messages can be stacked in an rpm message.
	71	*/
	72	struct qcom_rpm_message {
30b7ea5e SB	73	__le32 msg_type;
30b7ea5e SB	74	__le32 length;
936f14cf	75	union {
30b7ea5e	76	__le32 msg_id;
936f14cf BA	77	u8 message[0];
	78	};
	79	};
	80
	81	#define RPM_SERVICE_TYPE_REQUEST 0x00716572 /* "req\0" */
	82
	83	#define RPM_MSG_TYPE_ERR 0x00727265 /* "err\0" */
	84	#define RPM_MSG_TYPE_MSG_ID 0x2367736d /* "msg#" */
	85
	86	/**
	87	* qcom_rpm_smd_write - write @buf to @type:@id
	88	* @rpm: rpm handle
	89	* @type: resource type
	90	* @id: resource identifier
	91	* @buf: the data to be written
	92	* @count: number of bytes in @buf
	93	*/
	94	int qcom_rpm_smd_write(struct qcom_smd_rpm *rpm,
	95	int state,
	96	u32 type, u32 id,
	97	void *buf,
	98	size_t count)
	99	{
	100	static unsigned msg_id = 1;
	101	int left;
	102	int ret;
936f14cf BA	103	struct {
	104	struct qcom_rpm_header hdr;
	105	struct qcom_rpm_request req;
50e1b29b SB	106	u8 payload[];
	107	} *pkt;
	108	size_t size = sizeof(*pkt) + count;
936f14cf BA	109
936f14cf BA	110	/* SMD packets to the RPM may not exceed 256 bytes */
50e1b29b	111	if (WARN_ON(size >= 256))
936f14cf BA	112	return -EINVAL;
936f14cf BA	113
50e1b29b SB	114	pkt = kmalloc(size, GFP_KERNEL);
	115	if (!pkt)
	116	return -ENOMEM;
	117
936f14cf BA	118	mutex_lock(&rpm->lock);
936f14cf BA	119
30b7ea5e SB	120	pkt->hdr.service_type = cpu_to_le32(RPM_SERVICE_TYPE_REQUEST);
30b7ea5e SB	121	pkt->hdr.length = cpu_to_le32(sizeof(struct qcom_rpm_request) + count);
936f14cf	122
30b7ea5e	123	pkt->req.msg_id = cpu_to_le32(msg_id++);
a8ddd1b9	124	pkt->req.flags = cpu_to_le32(state);
30b7ea5e SB	125	pkt->req.type = cpu_to_le32(type);
	126	pkt->req.id = cpu_to_le32(id);
	127	pkt->req.data_len = cpu_to_le32(count);
50e1b29b	128	memcpy(pkt->payload, buf, count);
936f14cf	129
5052de8d	130	ret = rpmsg_send(rpm->rpm_channel, pkt, size);
936f14cf BA	131	if (ret)
	132	goto out;
	133
	134	left = wait_for_completion_timeout(&rpm->ack, RPM_REQUEST_TIMEOUT);
	135	if (!left)
	136	ret = -ETIMEDOUT;
	137	else
	138	ret = rpm->ack_status;
	139
	140	out:
50e1b29b	141	kfree(pkt);
936f14cf BA	142	mutex_unlock(&rpm->lock);
	143	return ret;
	144	}
	145	EXPORT_SYMBOL(qcom_rpm_smd_write);
	146
5052de8d BA	147	static int qcom_smd_rpm_callback(struct rpmsg_device *rpdev,
	148	void *data,
	149	int count,
	150	void *priv,
	151	u32 addr)
936f14cf BA	152	{
936f14cf BA	153	const struct qcom_rpm_header *hdr = data;
30b7ea5e	154	size_t hdr_length = le32_to_cpu(hdr->length);
936f14cf	155	const struct qcom_rpm_message *msg;
5052de8d	156	struct qcom_smd_rpm *rpm = dev_get_drvdata(&rpdev->dev);
936f14cf	157	const u8 *buf = data + sizeof(struct qcom_rpm_header);
30b7ea5e	158	const u8 *end = buf + hdr_length;
936f14cf BA	159	char msgbuf[32];
936f14cf BA	160	int status = 0;
30b7ea5e	161	u32 len, msg_length;
936f14cf	162
30b7ea5e SB	163	if (le32_to_cpu(hdr->service_type) != RPM_SERVICE_TYPE_REQUEST \|\|
30b7ea5e SB	164	hdr_length < sizeof(struct qcom_rpm_message)) {
b853cb96	165	dev_err(rpm->dev, "invalid request\n");
936f14cf BA	166	return 0;
	167	}
	168
	169	while (buf < end) {
	170	msg = (struct qcom_rpm_message *)buf;
30b7ea5e SB	171	msg_length = le32_to_cpu(msg->length);
30b7ea5e SB	172	switch (le32_to_cpu(msg->msg_type)) {
936f14cf BA	173	case RPM_MSG_TYPE_MSG_ID:
	174	break;
	175	case RPM_MSG_TYPE_ERR:
30b7ea5e	176	len = min_t(u32, ALIGN(msg_length, 4), sizeof(msgbuf));
936f14cf BA	177	memcpy_fromio(msgbuf, msg->message, len);
	178	msgbuf[len - 1] = 0;
	179
	180	if (!strcmp(msgbuf, "resource does not exist"))
	181	status = -ENXIO;
	182	else
	183	status = -EINVAL;
	184	break;
	185	}
	186
30b7ea5e	187	buf = PTR_ALIGN(buf + 2 * sizeof(u32) + msg_length, 4);
936f14cf BA	188	}
	189
	190	rpm->ack_status = status;
	191	complete(&rpm->ack);
	192	return 0;
	193	}
	194
5052de8d	195	static int qcom_smd_rpm_probe(struct rpmsg_device *rpdev)
936f14cf BA	196	{
936f14cf BA	197	struct qcom_smd_rpm *rpm;
66e6a633	198	int ret;
936f14cf	199
5052de8d	200	rpm = devm_kzalloc(&rpdev->dev, sizeof(*rpm), GFP_KERNEL);
936f14cf BA	201	if (!rpm)
	202	return -ENOMEM;
	203
	204	mutex_init(&rpm->lock);
	205	init_completion(&rpm->ack);
	206
5052de8d BA	207	rpm->dev = &rpdev->dev;
	208	rpm->rpm_channel = rpdev->ept;
	209	dev_set_drvdata(&rpdev->dev, rpm);
936f14cf	210
66e6a633 GD	211	rpm->icc = platform_device_register_data(&rpdev->dev, "icc_smd_rpm", -1,
	212	NULL, 0);
	213	if (IS_ERR(rpm->icc))
	214	return PTR_ERR(rpm->icc);
	215
	216	ret = of_platform_populate(rpdev->dev.of_node, NULL, NULL, &rpdev->dev);
	217	if (ret)
	218	platform_device_unregister(rpm->icc);
	219
	220	return ret;
936f14cf BA	221	}
936f14cf BA	222
5052de8d	223	static void qcom_smd_rpm_remove(struct rpmsg_device *rpdev)
936f14cf	224	{
66e6a633 GD	225	struct qcom_smd_rpm *rpm = dev_get_drvdata(&rpdev->dev);
	226
	227	platform_device_unregister(rpm->icc);
5052de8d	228	of_platform_depopulate(&rpdev->dev);
936f14cf BA	229	}
	230
	231	static const struct of_device_id qcom_smd_rpm_of_match[] = {
1f0947fe AG	232	{ .compatible = "qcom,rpm-apq8084" },
1f0947fe AG	233	{ .compatible = "qcom,rpm-msm8916" },
936f14cf	234	{ .compatible = "qcom,rpm-msm8974" },
83a81c1b	235	{ .compatible = "qcom,rpm-msm8976" },
2b624250	236	{ .compatible = "qcom,rpm-msm8996" },
64bf6b26	237	{ .compatible = "qcom,rpm-msm8998" },
4e2256d3	238	{ .compatible = "qcom,rpm-sdm660" },
b7e38617	239	{ .compatible = "qcom,rpm-qcs404" },
936f14cf BA	240	{}
	241	};
	242	MODULE_DEVICE_TABLE(of, qcom_smd_rpm_of_match);
	243
5052de8d	244	static struct rpmsg_driver qcom_smd_rpm_driver = {
936f14cf BA	245	.probe = qcom_smd_rpm_probe,
	246	.remove = qcom_smd_rpm_remove,
	247	.callback = qcom_smd_rpm_callback,
5052de8d	248	.drv = {
936f14cf	249	.name = "qcom_smd_rpm",
936f14cf BA	250	.of_match_table = qcom_smd_rpm_of_match,
	251	},
	252	};
	253
	254	static int __init qcom_smd_rpm_init(void)
	255	{
5052de8d	256	return register_rpmsg_driver(&qcom_smd_rpm_driver);
936f14cf BA	257	}
	258	arch_initcall(qcom_smd_rpm_init);
	259
	260	static void __exit qcom_smd_rpm_exit(void)
	261	{
5052de8d	262	unregister_rpmsg_driver(&qcom_smd_rpm_driver);
936f14cf BA	263	}
	264	module_exit(qcom_smd_rpm_exit);
	265
	266	MODULE_AUTHOR("Bjorn Andersson <bjorn.andersson@sonymobile.com>");
	267	MODULE_DESCRIPTION("Qualcomm SMD backed RPM driver");
	268	MODULE_LICENSE("GPL v2");