[linux-block.git] / drivers / char / ipmi / ipmi_powernv.c

// SPDX-License-Identifier: GPL-2.0+
/*
 * PowerNV OPAL IPMI driver
 *
 * Copyright 2014 IBM Corp.
 */

#define pr_fmt(fmt)        "ipmi-powernv: " fmt

#include <linux/ipmi_smi.h>
#include <linux/list.h>
#include <linux/module.h>
#include <linux/of.h>
#include <linux/of_irq.h>
#include <linux/interrupt.h>

#include <asm/opal.h>


struct ipmi_smi_powernv {
	u64			interface_id;
	struct ipmi_smi		*intf;
	unsigned int		irq;

	/**
	 * We assume that there can only be one outstanding request, so
	 * keep the pending message in cur_msg. We protect this from concurrent
	 * updates through send & recv calls, (and consequently opal_msg, which
	 * is in-use when cur_msg is set) with msg_lock
	 */
	spinlock_t		msg_lock;
	struct ipmi_smi_msg	*cur_msg;
	struct opal_ipmi_msg	*opal_msg;
};

static int ipmi_powernv_start_processing(void *send_info, struct ipmi_smi *intf)
{
	struct ipmi_smi_powernv *smi = send_info;

	smi->intf = intf;
	return 0;
}

static void send_error_reply(struct ipmi_smi_powernv *smi,
		struct ipmi_smi_msg *msg, u8 completion_code)
{
	msg->rsp[0] = msg->data[0] | 0x4;
	msg->rsp[1] = msg->data[1];
	msg->rsp[2] = completion_code;
	msg->rsp_size = 3;
	ipmi_smi_msg_received(smi->intf, msg);
}

static void ipmi_powernv_send(void *send_info, struct ipmi_smi_msg *msg)
{
	struct ipmi_smi_powernv *smi = send_info;
	struct opal_ipmi_msg *opal_msg;
	unsigned long flags;
	int comp, rc;
	size_t size;

	/* ensure data_len will fit in the opal_ipmi_msg buffer... */
	if (msg->data_size > IPMI_MAX_MSG_LENGTH) {
		comp = IPMI_REQ_LEN_EXCEEDED_ERR;
		goto err;
	}

	/* ... and that we at least have netfn and cmd bytes */
	if (msg->data_size < 2) {
		comp = IPMI_REQ_LEN_INVALID_ERR;
		goto err;
	}

	spin_lock_irqsave(&smi->msg_lock, flags);

	if (smi->cur_msg) {
		comp = IPMI_NODE_BUSY_ERR;
		goto err_unlock;
	}

	/* format our data for the OPAL API */
	opal_msg = smi->opal_msg;
	opal_msg->version = OPAL_IPMI_MSG_FORMAT_VERSION_1;
	opal_msg->netfn = msg->data[0];
	opal_msg->cmd = msg->data[1];
	if (msg->data_size > 2)
		memcpy(opal_msg->data, msg->data + 2, msg->data_size - 2);

	/* data_size already includes the netfn and cmd bytes */
	size = sizeof(*opal_msg) + msg->data_size - 2;

	pr_devel("%s: opal_ipmi_send(0x%llx, %p, %ld)\n", __func__,
			smi->interface_id, opal_msg, size);
	rc = opal_ipmi_send(smi->interface_id, opal_msg, size);
	pr_devel("%s:  -> %d\n", __func__, rc);

	if (!rc) {
		smi->cur_msg = msg;
		spin_unlock_irqrestore(&smi->msg_lock, flags);
		return;
	}

	comp = IPMI_ERR_UNSPECIFIED;
err_unlock:
	spin_unlock_irqrestore(&smi->msg_lock, flags);
err:
	send_error_reply(smi, msg, comp);
}

static int ipmi_powernv_recv(struct ipmi_smi_powernv *smi)
{
	struct opal_ipmi_msg *opal_msg;
	struct ipmi_smi_msg *msg;
	unsigned long flags;
	uint64_t size;
	int rc;

	pr_devel("%s: opal_ipmi_recv(%llx, msg, sz)\n", __func__,
			smi->interface_id);

	spin_lock_irqsave(&smi->msg_lock, flags);

	if (!smi->cur_msg) {
		spin_unlock_irqrestore(&smi->msg_lock, flags);
		pr_warn("no current message?\n");
		return 0;
	}

	msg = smi->cur_msg;
	opal_msg = smi->opal_msg;

	size = cpu_to_be64(sizeof(*opal_msg) + IPMI_MAX_MSG_LENGTH);

	rc = opal_ipmi_recv(smi->interface_id,
			opal_msg,
			&size);
	size = be64_to_cpu(size);
	pr_devel("%s:   -> %d (size %lld)\n", __func__,
			rc, rc == 0 ? size : 0);
	if (rc) {
		/* If came via the poll, and response was not yet ready */
		if (rc == OPAL_EMPTY) {
			spin_unlock_irqrestore(&smi->msg_lock, flags);
			return 0;
		}

		smi->cur_msg = NULL;
		spin_unlock_irqrestore(&smi->msg_lock, flags);
		send_error_reply(smi, msg, IPMI_ERR_UNSPECIFIED);
		return 0;
	}

	if (size < sizeof(*opal_msg)) {
		spin_unlock_irqrestore(&smi->msg_lock, flags);
		pr_warn("unexpected IPMI message size %lld\n", size);
		return 0;
	}

	if (opal_msg->version != OPAL_IPMI_MSG_FORMAT_VERSION_1) {
		spin_unlock_irqrestore(&smi->msg_lock, flags);
		pr_warn("unexpected IPMI message format (version %d)\n",
				opal_msg->version);
		return 0;
	}

	msg->rsp[0] = opal_msg->netfn;
	msg->rsp[1] = opal_msg->cmd;
	if (size > sizeof(*opal_msg))
		memcpy(&msg->rsp[2], opal_msg->data, size - sizeof(*opal_msg));
	msg->rsp_size = 2 + size - sizeof(*opal_msg);

	smi->cur_msg = NULL;
	spin_unlock_irqrestore(&smi->msg_lock, flags);
	ipmi_smi_msg_received(smi->intf, msg);
	return 0;
}

static void ipmi_powernv_request_events(void *send_info)
{
}

static void ipmi_powernv_set_run_to_completion(void *send_info,
		bool run_to_completion)
{
}

static void ipmi_powernv_poll(void *send_info)
{
	struct ipmi_smi_powernv *smi = send_info;

	ipmi_powernv_recv(smi);
}

static const struct ipmi_smi_handlers ipmi_powernv_smi_handlers = {
	.owner			= THIS_MODULE,
	.start_processing	= ipmi_powernv_start_processing,
	.sender			= ipmi_powernv_send,
	.request_events		= ipmi_powernv_request_events,
	.set_run_to_completion	= ipmi_powernv_set_run_to_completion,
	.poll			= ipmi_powernv_poll,
};

static irqreturn_t ipmi_opal_event(int irq, void *data)
{
	struct ipmi_smi_powernv *smi = data;

	ipmi_powernv_recv(smi);
	return IRQ_HANDLED;
}

static int ipmi_powernv_probe(struct platform_device *pdev)
{
	struct ipmi_smi_powernv *ipmi;
	struct device *dev;
	u32 prop;
	int rc;

	if (!pdev || !pdev->dev.of_node)
		return -ENODEV;

	dev = &pdev->dev;

	ipmi = devm_kzalloc(dev, sizeof(*ipmi), GFP_KERNEL);
	if (!ipmi)
		return -ENOMEM;

	spin_lock_init(&ipmi->msg_lock);

	rc = of_property_read_u32(dev->of_node, "ibm,ipmi-interface-id",
			&prop);
	if (rc) {
		dev_warn(dev, "No interface ID property\n");
		goto err_free;
	}
	ipmi->interface_id = prop;

	rc = of_property_read_u32(dev->of_node, "interrupts", &prop);
	if (rc) {
		dev_warn(dev, "No interrupts property\n");
		goto err_free;
	}

	ipmi->irq = irq_of_parse_and_map(dev->of_node, 0);
	if (!ipmi->irq) {
		dev_info(dev, "Unable to map irq from device tree\n");
		ipmi->irq = opal_event_request(prop);
	}

	rc = request_irq(ipmi->irq, ipmi_opal_event, IRQ_TYPE_LEVEL_HIGH,
			 "opal-ipmi", ipmi);
	if (rc) {
		dev_warn(dev, "Unable to request irq\n");
		goto err_dispose;
	}

	ipmi->opal_msg = devm_kmalloc(dev,
			sizeof(*ipmi->opal_msg) + IPMI_MAX_MSG_LENGTH,
			GFP_KERNEL);
	if (!ipmi->opal_msg) {
		rc = -ENOMEM;
		goto err_unregister;
	}

	rc = ipmi_register_smi(&ipmi_powernv_smi_handlers, ipmi, dev, 0);
	if (rc) {
		dev_warn(dev, "IPMI SMI registration failed (%d)\n", rc);
		goto err_free_msg;
	}

	dev_set_drvdata(dev, ipmi);
	return 0;

err_free_msg:
	devm_kfree(dev, ipmi->opal_msg);
err_unregister:
	free_irq(ipmi->irq, ipmi);
err_dispose:
	irq_dispose_mapping(ipmi->irq);
err_free:
	devm_kfree(dev, ipmi);
	return rc;
}

static void ipmi_powernv_remove(struct platform_device *pdev)
{
	struct ipmi_smi_powernv *smi = dev_get_drvdata(&pdev->dev);

	ipmi_unregister_smi(smi->intf);
	free_irq(smi->irq, smi);
	irq_dispose_mapping(smi->irq);
}

static const struct of_device_id ipmi_powernv_match[] = {
	{ .compatible = "ibm,opal-ipmi" },
	{ },
};


static struct platform_driver powernv_ipmi_driver = {
	.driver = {
		.name		= "ipmi-powernv",
		.of_match_table	= ipmi_powernv_match,
	},
	.probe	= ipmi_powernv_probe,
	.remove_new = ipmi_powernv_remove,
};


module_platform_driver(powernv_ipmi_driver);

MODULE_DEVICE_TABLE(of, ipmi_powernv_match);
MODULE_DESCRIPTION("powernv IPMI driver");
MODULE_AUTHOR("Jeremy Kerr <jk@ozlabs.org>");
MODULE_LICENSE("GPL");
Commit	Line	Data
243ac210	1	// SPDX-License-Identifier: GPL-2.0+
6a11e5c6 JK	2	/*
	3	* PowerNV OPAL IPMI driver
	4	*
	5	* Copyright 2014 IBM Corp.
6a11e5c6 JK	6	*/
	7
	8	#define pr_fmt(fmt) "ipmi-powernv: " fmt
	9
	10	#include <linux/ipmi_smi.h>
	11	#include <linux/list.h>
	12	#include <linux/module.h>
	13	#include <linux/of.h>
dce143c3 AP	14	#include <linux/of_irq.h>
dce143c3 AP	15	#include <linux/interrupt.h>
6a11e5c6 JK	16
	17	#include <asm/opal.h>
	18
	19
	20	struct ipmi_smi_powernv {
	21	u64 interface_id;
4a758c92	22	struct ipmi_smi *intf;
dce143c3	23	unsigned int irq;
6a11e5c6 JK	24
	25	/**
	26	* We assume that there can only be one outstanding request, so
	27	* keep the pending message in cur_msg. We protect this from concurrent
	28	* updates through send & recv calls, (and consequently opal_msg, which
	29	* is in-use when cur_msg is set) with msg_lock
	30	*/
	31	spinlock_t msg_lock;
	32	struct ipmi_smi_msg *cur_msg;
	33	struct opal_ipmi_msg *opal_msg;
	34	};
	35
4a758c92	36	static int ipmi_powernv_start_processing(void send_info, struct ipmi_smi intf)
6a11e5c6 JK	37	{
	38	struct ipmi_smi_powernv *smi = send_info;
	39
	40	smi->intf = intf;
	41	return 0;
	42	}
	43
	44	static void send_error_reply(struct ipmi_smi_powernv *smi,
	45	struct ipmi_smi_msg *msg, u8 completion_code)
	46	{
	47	msg->rsp[0] = msg->data[0] \| 0x4;
	48	msg->rsp[1] = msg->data[1];
	49	msg->rsp[2] = completion_code;
	50	msg->rsp_size = 3;
	51	ipmi_smi_msg_received(smi->intf, msg);
	52	}
	53
	54	static void ipmi_powernv_send(void send_info, struct ipmi_smi_msg msg)
	55	{
	56	struct ipmi_smi_powernv *smi = send_info;
	57	struct opal_ipmi_msg *opal_msg;
	58	unsigned long flags;
	59	int comp, rc;
	60	size_t size;
	61
	62	/* ensure data_len will fit in the opal_ipmi_msg buffer... */
	63	if (msg->data_size > IPMI_MAX_MSG_LENGTH) {
	64	comp = IPMI_REQ_LEN_EXCEEDED_ERR;
	65	goto err;
	66	}
	67
	68	/* ... and that we at least have netfn and cmd bytes */
	69	if (msg->data_size < 2) {
	70	comp = IPMI_REQ_LEN_INVALID_ERR;
	71	goto err;
	72	}
	73
	74	spin_lock_irqsave(&smi->msg_lock, flags);
	75
	76	if (smi->cur_msg) {
	77	comp = IPMI_NODE_BUSY_ERR;
	78	goto err_unlock;
	79	}
	80
	81	/* format our data for the OPAL API */
	82	opal_msg = smi->opal_msg;
	83	opal_msg->version = OPAL_IPMI_MSG_FORMAT_VERSION_1;
	84	opal_msg->netfn = msg->data[0];
	85	opal_msg->cmd = msg->data[1];
	86	if (msg->data_size > 2)
	87	memcpy(opal_msg->data, msg->data + 2, msg->data_size - 2);
	88
	89	/* data_size already includes the netfn and cmd bytes */
	90	size = sizeof(*opal_msg) + msg->data_size - 2;
	91
	92	pr_devel("%s: opal_ipmi_send(0x%llx, %p, %ld)\n", __func__,
	93	smi->interface_id, opal_msg, size);
	94	rc = opal_ipmi_send(smi->interface_id, opal_msg, size);
	95	pr_devel("%s: -> %d\n", __func__, rc);
	96
	97	if (!rc) {
	98	smi->cur_msg = msg;
	99	spin_unlock_irqrestore(&smi->msg_lock, flags);
	100	return;
101	}
102
103	comp = IPMI_ERR_UNSPECIFIED;
104	err_unlock:
105	spin_unlock_irqrestore(&smi->msg_lock, flags);
106	err:
107	send_error_reply(smi, msg, comp);
108	}
109
110	static int ipmi_powernv_recv(struct ipmi_smi_powernv *smi)
111	{
112	struct opal_ipmi_msg *opal_msg;
113	struct ipmi_smi_msg *msg;
114	unsigned long flags;
115	uint64_t size;
116	int rc;
117
118	pr_devel("%s: opal_ipmi_recv(%llx, msg, sz)\n", __func__,
119	smi->interface_id);
120
121	spin_lock_irqsave(&smi->msg_lock, flags);
122
123	if (!smi->cur_msg) {
ad1ed2a9	124	spin_unlock_irqrestore(&smi->msg_lock, flags);
6a11e5c6 JK	125	pr_warn("no current message?\n");
	126	return 0;
	127	}
	128
	129	msg = smi->cur_msg;
	130	opal_msg = smi->opal_msg;
	131
	132	size = cpu_to_be64(sizeof(*opal_msg) + IPMI_MAX_MSG_LENGTH);
	133
	134	rc = opal_ipmi_recv(smi->interface_id,
	135	opal_msg,
	136	&size);
	137	size = be64_to_cpu(size);
	138	pr_devel("%s: -> %d (size %lld)\n", __func__,
	139	rc, rc == 0 ? size : 0);
	140	if (rc) {
cca85f19 NG	141	/* If came via the poll, and response was not yet ready */
	142	if (rc == OPAL_EMPTY) {
	143	spin_unlock_irqrestore(&smi->msg_lock, flags);
	144	return 0;
	145	}
	146
	147	smi->cur_msg = NULL;
6a11e5c6	148	spin_unlock_irqrestore(&smi->msg_lock, flags);
cca85f19	149	send_error_reply(smi, msg, IPMI_ERR_UNSPECIFIED);
6a11e5c6 JK	150	return 0;
	151	}
	152
	153	if (size < sizeof(*opal_msg)) {
	154	spin_unlock_irqrestore(&smi->msg_lock, flags);
	155	pr_warn("unexpected IPMI message size %lld\n", size);
	156	return 0;
	157	}
	158
	159	if (opal_msg->version != OPAL_IPMI_MSG_FORMAT_VERSION_1) {
	160	spin_unlock_irqrestore(&smi->msg_lock, flags);
	161	pr_warn("unexpected IPMI message format (version %d)\n",
	162	opal_msg->version);
	163	return 0;
	164	}
	165
	166	msg->rsp[0] = opal_msg->netfn;
	167	msg->rsp[1] = opal_msg->cmd;
	168	if (size > sizeof(*opal_msg))
	169	memcpy(&msg->rsp[2], opal_msg->data, size - sizeof(*opal_msg));
	170	msg->rsp_size = 2 + size - sizeof(*opal_msg);
	171
	172	smi->cur_msg = NULL;
	173	spin_unlock_irqrestore(&smi->msg_lock, flags);
	174	ipmi_smi_msg_received(smi->intf, msg);
	175	return 0;
	176	}
	177
	178	static void ipmi_powernv_request_events(void *send_info)
	179	{
	180	}
	181
	182	static void ipmi_powernv_set_run_to_completion(void *send_info,
	183	bool run_to_completion)
	184	{
	185	}
	186
	187	static void ipmi_powernv_poll(void *send_info)
	188	{
	189	struct ipmi_smi_powernv *smi = send_info;
	190
	191	ipmi_powernv_recv(smi);
	192	}
	193
db3b7e13	194	static const struct ipmi_smi_handlers ipmi_powernv_smi_handlers = {
6a11e5c6 JK	195	.owner = THIS_MODULE,
	196	.start_processing = ipmi_powernv_start_processing,
	197	.sender = ipmi_powernv_send,
	198	.request_events = ipmi_powernv_request_events,
	199	.set_run_to_completion = ipmi_powernv_set_run_to_completion,
	200	.poll = ipmi_powernv_poll,
	201	};
	202
dce143c3	203	static irqreturn_t ipmi_opal_event(int irq, void *data)
6a11e5c6	204	{
dce143c3	205	struct ipmi_smi_powernv *smi = data;
6a11e5c6	206
dce143c3 AP	207	ipmi_powernv_recv(smi);
dce143c3 AP	208	return IRQ_HANDLED;
6a11e5c6 JK	209	}
	210
	211	static int ipmi_powernv_probe(struct platform_device *pdev)
	212	{
	213	struct ipmi_smi_powernv *ipmi;
	214	struct device *dev;
	215	u32 prop;
	216	int rc;
	217
	218	if (!pdev \|\| !pdev->dev.of_node)
	219	return -ENODEV;
	220
	221	dev = &pdev->dev;
	222
	223	ipmi = devm_kzalloc(dev, sizeof(*ipmi), GFP_KERNEL);
	224	if (!ipmi)
	225	return -ENOMEM;
	226
	227	spin_lock_init(&ipmi->msg_lock);
	228
	229	rc = of_property_read_u32(dev->of_node, "ibm,ipmi-interface-id",
	230	&prop);
	231	if (rc) {
	232	dev_warn(dev, "No interface ID property\n");
	233	goto err_free;
	234	}
	235	ipmi->interface_id = prop;
	236
	237	rc = of_property_read_u32(dev->of_node, "interrupts", &prop);
	238	if (rc) {
	239	dev_warn(dev, "No interrupts property\n");
	240	goto err_free;
	241	}
	242
dce143c3 AP	243	ipmi->irq = irq_of_parse_and_map(dev->of_node, 0);
	244	if (!ipmi->irq) {
	245	dev_info(dev, "Unable to map irq from device tree\n");
	246	ipmi->irq = opal_event_request(prop);
	247	}
6a11e5c6	248
e749d328 WY	249	rc = request_irq(ipmi->irq, ipmi_opal_event, IRQ_TYPE_LEVEL_HIGH,
	250	"opal-ipmi", ipmi);
	251	if (rc) {
dce143c3 AP	252	dev_warn(dev, "Unable to request irq\n");
dce143c3 AP	253	goto err_dispose;
6a11e5c6 JK	254	}
	255
	256	ipmi->opal_msg = devm_kmalloc(dev,
	257	sizeof(*ipmi->opal_msg) + IPMI_MAX_MSG_LENGTH,
	258	GFP_KERNEL);
	259	if (!ipmi->opal_msg) {
	260	rc = -ENOMEM;
	261	goto err_unregister;
	262	}
	263
1e5058ea	264	rc = ipmi_register_smi(&ipmi_powernv_smi_handlers, ipmi, dev, 0);
6a11e5c6 JK	265	if (rc) {
	266	dev_warn(dev, "IPMI SMI registration failed (%d)\n", rc);
	267	goto err_free_msg;
	268	}
	269
	270	dev_set_drvdata(dev, ipmi);
	271	return 0;
	272
	273	err_free_msg:
	274	devm_kfree(dev, ipmi->opal_msg);
	275	err_unregister:
dce143c3 AP	276	free_irq(ipmi->irq, ipmi);
	277	err_dispose:
	278	irq_dispose_mapping(ipmi->irq);
6a11e5c6 JK	279	err_free:
	280	devm_kfree(dev, ipmi);
	281	return rc;
	282	}
	283
26edd74f	284	static void ipmi_powernv_remove(struct platform_device *pdev)
6a11e5c6 JK	285	{
	286	struct ipmi_smi_powernv *smi = dev_get_drvdata(&pdev->dev);
	287
	288	ipmi_unregister_smi(smi->intf);
dce143c3 AP	289	free_irq(smi->irq, smi);
dce143c3 AP	290	irq_dispose_mapping(smi->irq);
6a11e5c6 JK	291	}
	292
	293	static const struct of_device_id ipmi_powernv_match[] = {
	294	{ .compatible = "ibm,opal-ipmi" },
	295	{ },
	296	};
	297
	298
	299	static struct platform_driver powernv_ipmi_driver = {
	300	.driver = {
	301	.name = "ipmi-powernv",
6a11e5c6 JK	302	.of_match_table = ipmi_powernv_match,
	303	},
	304	.probe = ipmi_powernv_probe,
26edd74f	305	.remove_new = ipmi_powernv_remove,
6a11e5c6 JK	306	};
	307
	308
	309	module_platform_driver(powernv_ipmi_driver);
	310
	311	MODULE_DEVICE_TABLE(of, ipmi_powernv_match);
	312	MODULE_DESCRIPTION("powernv IPMI driver");
	313	MODULE_AUTHOR("Jeremy Kerr <jk@ozlabs.org>");
	314	MODULE_LICENSE("GPL");