Commit 61c9f03e authored by Peng Fan's avatar Peng Fan Committed by Sudeep Holla
Browse files

firmware: arm_scmi: Add initial support for i.MX MISC protocol 



i.MX95 System Manager(SM) firmware includes a SCMI vendor protocol, SCMI
MISC protocol which includes controls that are misc settings/actions that
must be exposed from the SM to agents. They are device specific and are
usually define to access bit fields in various mix block control modules,
IOMUX_GPR, and other General Purpose registers, Control Status Registers
owned by the SM.

Reviewed-by: default avatarCristian Marussi <cristian.marussi@arm.com>
Signed-off-by: default avatarPeng Fan <peng.fan@nxp.com>
Message-Id: <20240823-imx95-bbm-misc-v2-v8-3-e600ed9e9271@nxp.com>
Signed-off-by: default avatarSudeep Holla <sudeep.holla@arm.com>
parent 41845541

drivers/firmware/arm_scmi/vendors/imx/Kconfig

+10 −0
Original line number Diff line number Diff line
@@ -12,4 +12,14 @@ config IMX_SCMI_BBM_EXT 
	  To compile this driver as a module, choose M here: the

	  module will be called imx-sm-bbm.



config IMX_SCMI_MISC_EXT

	tristate "i.MX SCMI MISC EXTENSION"

	depends on ARM_SCMI_PROTOCOL || (COMPILE_TEST && OF)

	default y if ARCH_MXC

	help

	  This enables i.MX System MISC control logic such as gpio expander

	  wakeup



	  To compile this driver as a module, choose M here: the

	  module will be called imx-sm-misc.

endmenu

drivers/firmware/arm_scmi/vendors/imx/Makefile

+1 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: GPL-2.0-only

obj-$(CONFIG_IMX_SCMI_BBM_EXT) += imx-sm-bbm.o

obj-$(CONFIG_IMX_SCMI_MISC_EXT) += imx-sm-misc.o

drivers/firmware/arm_scmi/vendors/imx/imx-sm-misc.c

0 → 100644
+318 −0
Original line number Diff line number Diff line 
// SPDX-License-Identifier: GPL-2.0

/*

 * System control and Management Interface (SCMI) NXP MISC Protocol

 *

 * Copyright 2024 NXP

 */



#define pr_fmt(fmt) "SCMI Notifications MISC - " fmt



#include <linux/bits.h>

#include <linux/io.h>

#include <linux/module.h>

#include <linux/of.h>

#include <linux/platform_device.h>

#include <linux/scmi_protocol.h>

#include <linux/scmi_imx_protocol.h>



#include "../../protocols.h"

#include "../../notify.h"



#define SCMI_PROTOCOL_SUPPORTED_VERSION		0x10000



#define MAX_MISC_CTRL_SOURCES			GENMASK(15, 0)



enum scmi_imx_misc_protocol_cmd {

	SCMI_IMX_MISC_CTRL_SET	= 0x3,

	SCMI_IMX_MISC_CTRL_GET	= 0x4,

	SCMI_IMX_MISC_CTRL_NOTIFY = 0x8,

};



struct scmi_imx_misc_info {

	u32 version;

	u32 nr_dev_ctrl;

	u32 nr_brd_ctrl;

	u32 nr_reason;

};



struct scmi_msg_imx_misc_protocol_attributes {

	__le32 attributes;

};



#define GET_BRD_CTRLS_NR(x)	le32_get_bits((x), GENMASK(31, 24))

#define GET_REASONS_NR(x)	le32_get_bits((x), GENMASK(23, 16))

#define GET_DEV_CTRLS_NR(x)	le32_get_bits((x), GENMASK(15, 0))

#define BRD_CTRL_START_ID	BIT(15)



struct scmi_imx_misc_ctrl_set_in {

	__le32 id;

	__le32 num;

	__le32 value[];

};



struct scmi_imx_misc_ctrl_notify_in {

	__le32 ctrl_id;

	__le32 flags;

};



struct scmi_imx_misc_ctrl_notify_payld {

	__le32 ctrl_id;

	__le32 flags;

};



struct scmi_imx_misc_ctrl_get_out {

	__le32 num;

	__le32 val[];

};



static int scmi_imx_misc_attributes_get(const struct scmi_protocol_handle *ph,

					struct scmi_imx_misc_info *mi)

{

	int ret;

	struct scmi_xfer *t;

	struct scmi_msg_imx_misc_protocol_attributes *attr;



	ret = ph->xops->xfer_get_init(ph, PROTOCOL_ATTRIBUTES, 0,

				      sizeof(*attr), &t);

	if (ret)

		return ret;



	attr = t->rx.buf;



	ret = ph->xops->do_xfer(ph, t);

	if (!ret) {

		mi->nr_dev_ctrl = GET_DEV_CTRLS_NR(attr->attributes);

		mi->nr_brd_ctrl = GET_BRD_CTRLS_NR(attr->attributes);

		mi->nr_reason = GET_REASONS_NR(attr->attributes);

		dev_info(ph->dev, "i.MX MISC NUM DEV CTRL: %d, NUM BRD CTRL: %d,NUM Reason: %d\n",

			 mi->nr_dev_ctrl, mi->nr_brd_ctrl, mi->nr_reason);

	}



	ph->xops->xfer_put(ph, t);



	return ret;

}



static int scmi_imx_misc_ctrl_validate_id(const struct scmi_protocol_handle *ph,

					  u32 ctrl_id)

{

	struct scmi_imx_misc_info *mi = ph->get_priv(ph);



	/*

	 * [0,      BRD_CTRL_START_ID) is for Dev Ctrl which is SOC related

	 * [BRD_CTRL_START_ID, 0xffff) is for Board Ctrl which is board related

	 */

	if (ctrl_id < BRD_CTRL_START_ID && ctrl_id > mi->nr_dev_ctrl)

		return -EINVAL;

	if (ctrl_id >= BRD_CTRL_START_ID + mi->nr_brd_ctrl)

		return -EINVAL;



	return 0;

}



static int scmi_imx_misc_ctrl_notify(const struct scmi_protocol_handle *ph,

				     u32 ctrl_id, u32 evt_id, u32 flags)

{

	struct scmi_imx_misc_ctrl_notify_in *in;

	struct scmi_xfer *t;

	int ret;



	ret = scmi_imx_misc_ctrl_validate_id(ph, ctrl_id);

	if (ret)

		return ret;



	ret = ph->xops->xfer_get_init(ph, SCMI_IMX_MISC_CTRL_NOTIFY,

				      sizeof(*in), 0, &t);

	if (ret)

		return ret;



	in = t->tx.buf;

	in->ctrl_id = cpu_to_le32(ctrl_id);

	in->flags = cpu_to_le32(flags);



	ret = ph->xops->do_xfer(ph, t);



	ph->xops->xfer_put(ph, t);



	return ret;

}



static int

scmi_imx_misc_ctrl_set_notify_enabled(const struct scmi_protocol_handle *ph,

				      u8 evt_id, u32 src_id, bool enable)

{

	int ret;



	/* misc_ctrl_req_notify is for enablement */

	if (enable)

		return 0;



	ret = scmi_imx_misc_ctrl_notify(ph, src_id, evt_id, 0);

	if (ret)

		dev_err(ph->dev, "FAIL_ENABLED - evt[%X] src[%d] - ret:%d\n",

			evt_id, src_id, ret);



	return ret;

}



static void *

scmi_imx_misc_ctrl_fill_custom_report(const struct scmi_protocol_handle *ph,

				      u8 evt_id, ktime_t timestamp,

				      const void *payld, size_t payld_sz,

				      void *report, u32 *src_id)

{

	const struct scmi_imx_misc_ctrl_notify_payld *p = payld;

	struct scmi_imx_misc_ctrl_notify_report *r = report;



	if (sizeof(*p) != payld_sz)

		return NULL;



	r->timestamp = timestamp;

	r->ctrl_id = le32_to_cpu(p->ctrl_id);

	r->flags = le32_to_cpu(p->flags);

	if (src_id)

		*src_id = r->ctrl_id;

	dev_dbg(ph->dev, "%s: ctrl_id: %d flags: %d\n", __func__,

		r->ctrl_id, r->flags);



	return r;

}



static const struct scmi_event_ops scmi_imx_misc_event_ops = {

	.set_notify_enabled = scmi_imx_misc_ctrl_set_notify_enabled,

	.fill_custom_report = scmi_imx_misc_ctrl_fill_custom_report,

};



static const struct scmi_event scmi_imx_misc_events[] = {

	{

		.id = SCMI_EVENT_IMX_MISC_CONTROL,

		.max_payld_sz = sizeof(struct scmi_imx_misc_ctrl_notify_payld),

		.max_report_sz = sizeof(struct scmi_imx_misc_ctrl_notify_report),

	},

};



static struct scmi_protocol_events scmi_imx_misc_protocol_events = {

	.queue_sz = SCMI_PROTO_QUEUE_SZ,

	.ops = &scmi_imx_misc_event_ops,

	.evts = scmi_imx_misc_events,

	.num_events = ARRAY_SIZE(scmi_imx_misc_events),

	.num_sources = MAX_MISC_CTRL_SOURCES,

};



static int scmi_imx_misc_ctrl_get(const struct scmi_protocol_handle *ph,

				  u32 ctrl_id, u32 *num, u32 *val)

{

	struct scmi_imx_misc_ctrl_get_out *out;

	struct scmi_xfer *t;

	int ret, i;

	int max_msg_size = ph->hops->get_max_msg_size(ph);

	int max_num = (max_msg_size - sizeof(*out)) / sizeof(__le32);



	ret = scmi_imx_misc_ctrl_validate_id(ph, ctrl_id);

	if (ret)

		return ret;



	ret = ph->xops->xfer_get_init(ph, SCMI_IMX_MISC_CTRL_GET, sizeof(u32),

				      0, &t);

	if (ret)

		return ret;



	put_unaligned_le32(ctrl_id, t->tx.buf);

	ret = ph->xops->do_xfer(ph, t);

	if (!ret) {

		out = t->rx.buf;

		*num = le32_to_cpu(out->num);



		if (*num >= max_num ||

		    *num * sizeof(__le32) > t->rx.len - sizeof(__le32)) {

			ph->xops->xfer_put(ph, t);

			return -EINVAL;

		}



		for (i = 0; i < *num; i++)

			val[i] = le32_to_cpu(out->val[i]);

	}



	ph->xops->xfer_put(ph, t);



	return ret;

}



static int scmi_imx_misc_ctrl_set(const struct scmi_protocol_handle *ph,

				  u32 ctrl_id, u32 num, u32 *val)

{

	struct scmi_imx_misc_ctrl_set_in *in;

	struct scmi_xfer *t;

	int ret, i;

	int max_msg_size = ph->hops->get_max_msg_size(ph);

	int max_num = (max_msg_size - sizeof(*in)) / sizeof(__le32);



	ret = scmi_imx_misc_ctrl_validate_id(ph, ctrl_id);

	if (ret)

		return ret;



	if (num > max_num)

		return -EINVAL;



	ret = ph->xops->xfer_get_init(ph, SCMI_IMX_MISC_CTRL_SET, sizeof(*in),

				      0, &t);

	if (ret)

		return ret;



	in = t->tx.buf;

	in->id = cpu_to_le32(ctrl_id);

	in->num = cpu_to_le32(num);

	for (i = 0; i < num; i++)

		in->value[i] = cpu_to_le32(val[i]);



	ret = ph->xops->do_xfer(ph, t);



	ph->xops->xfer_put(ph, t);



	return ret;

}



static const struct scmi_imx_misc_proto_ops scmi_imx_misc_proto_ops = {

	.misc_ctrl_set = scmi_imx_misc_ctrl_set,

	.misc_ctrl_get = scmi_imx_misc_ctrl_get,

	.misc_ctrl_req_notify = scmi_imx_misc_ctrl_notify,

};



static int scmi_imx_misc_protocol_init(const struct scmi_protocol_handle *ph)

{

	struct scmi_imx_misc_info *minfo;

	u32 version;

	int ret;



	ret = ph->xops->version_get(ph, &version);

	if (ret)

		return ret;



	dev_info(ph->dev, "NXP SM MISC Version %d.%d\n",

		 PROTOCOL_REV_MAJOR(version), PROTOCOL_REV_MINOR(version));



	minfo = devm_kzalloc(ph->dev, sizeof(*minfo), GFP_KERNEL);

	if (!minfo)

		return -ENOMEM;



	ret = scmi_imx_misc_attributes_get(ph, minfo);

	if (ret)

		return ret;



	return ph->set_priv(ph, minfo, version);

}



static const struct scmi_protocol scmi_imx_misc = {

	.id = SCMI_PROTOCOL_IMX_MISC,

	.owner = THIS_MODULE,

	.instance_init = &scmi_imx_misc_protocol_init,

	.ops = &scmi_imx_misc_proto_ops,

	.events = &scmi_imx_misc_protocol_events,

	.supported_version = SCMI_PROTOCOL_SUPPORTED_VERSION,

	.vendor_id = "NXP",

	.sub_vendor_id = "IMX",

};

module_scmi_protocol(scmi_imx_misc);



MODULE_DESCRIPTION("i.MX SCMI MISC driver");

MODULE_LICENSE("GPL");

include/linux/scmi_imx_protocol.h

+17 −0
Original line number Diff line number Diff line
@@ -15,6 +15,7 @@ 


enum scmi_nxp_protocol {

	SCMI_PROTOCOL_IMX_BBM = 0x81,

	SCMI_PROTOCOL_IMX_MISC = 0x84,

};



struct scmi_imx_bbm_proto_ops {
@@ -30,6 +31,7 @@ struct scmi_imx_bbm_proto_ops { 
enum scmi_nxp_notification_events {

	SCMI_EVENT_IMX_BBM_RTC = 0x0,

	SCMI_EVENT_IMX_BBM_BUTTON = 0x1,

	SCMI_EVENT_IMX_MISC_CONTROL = 0x0,

};



struct scmi_imx_bbm_notif_report {
@@ -39,4 +41,19 @@ struct scmi_imx_bbm_notif_report { 
	unsigned int		rtc_id;

	unsigned int		rtc_evt;

};



struct scmi_imx_misc_ctrl_notify_report {

	ktime_t			timestamp;

	unsigned int		ctrl_id;

	unsigned int		flags;

};



struct scmi_imx_misc_proto_ops {

	int (*misc_ctrl_set)(const struct scmi_protocol_handle *ph, u32 id,

			     u32 num, u32 *val);

	int (*misc_ctrl_get)(const struct scmi_protocol_handle *ph, u32 id,

			     u32 *num, u32 *val);

	int (*misc_ctrl_req_notify)(const struct scmi_protocol_handle *ph,

				    u32 ctrl_id, u32 evt_id, u32 flags);

};

#endif