firmware: Provide new device instantiation macro

Again removing the prio parameter.

And switching the unique macro call in drivers.

Signed-off-by: Tomasz Bursztyka <[email protected]>

Author: tbursztyka

drivers/clock_control/clock_control_arm_scmi.c

@@ -97,6 +97,5 @@ static int scmi_clock_init(const struct device *dev)
 
 static struct scmi_clock_data data;
 
-DT_INST_SCMI_PROTOCOL_DEFINE(0, &scmi_clock_init, NULL, &data, NULL,
-			     PRE_KERNEL_1, CONFIG_CLOCK_CONTROL_INIT_PRIORITY,
-			     &scmi_clock_api);
+SCMI_PROTOCOL_INSTANCE_FROM_DT_INST(0, &scmi_clock_init, NULL, &data, NULL,
+			     PRE_KERNEL_1, &scmi_clock_api);

drivers/firmware/scmi/mailbox.c

@@ -111,6 +111,4 @@ static struct scmi_transport_api scmi_mbox_api = {
 	.channel_is_free = scmi_mbox_channel_is_free,
 };
 
-DT_INST_SCMI_MAILBOX_DEFINE(0, PRE_KERNEL_1,
-			    CONFIG_ARM_SCMI_TRANSPORT_INIT_PRIORITY,
-			    &scmi_mbox_api);
+SCMI_MAILBOX_INSTANCE_FROM_DT_INST(0, PRE_KERNEL_1, &scmi_mbox_api);

drivers/firmware/scmi/mailbox.h

@@ -98,12 +98,12 @@
  *	2) Creates aforementioned structures for the base protocol
  *	(identified by the `scmi` node)
  *
- *	3) "registers" the driver via `DT_INST_SCMI_TRANSPORT_DEFINE()`.
+ *	3) "registers" the driver via `SCMI_TRANSPORT_INSTANCE_FROM_DT_INST()`.
  */
-#define DT_INST_SCMI_MAILBOX_DEFINE(inst, level, prio, api)			\
+#define SCMI_MAILBOX_INSTANCE_FROM_DT_INST(inst, level, api)			\
 	DT_INST_FOREACH_CHILD_STATUS_OKAY(inst, SCMI_MBOX_PROTO_CHAN_DEFINE)	\
 	DT_INST_SCMI_MBOX_BASE_CHAN_DEFINE(inst)				\
-	DT_INST_SCMI_TRANSPORT_DEFINE(inst, NULL, NULL, NULL, level, prio, api)
+	SCMI_TRANSPORT_INSTANCE_FROM_DT_INST(inst, NULL, NULL, NULL, level, api)
 
 struct scmi_mbox_channel {
 	/* SHMEM area bound to the channel */

include/zephyr/drivers/firmware/scmi/util.h

@@ -183,6 +183,23 @@
 	DEVICE_DT_INST_DEFINE(inst, &scmi_core_transport_init,			\
 			      pm, data, config, level, prio, api)
 
+/**
+ * @brief Define an SCMI transport driver
+ *
+ * This is merely a wrapper over DEVICE_INSTANCE_FROM_DT_INST(), but is
+ * required since transport layer drivers are not allowed to place
+ * their own init() function in the init section. Instead, transport
+ * layer drivers place the scmi_core_transport_init() function in the
+ * init section, which, in turn, will call the transport layer driver
+ * init() function. This is required because the SCMI core needs to
+ * perform channel binding and setup during the transport layer driver's
+ * initialization.
+ */
+#define SCMI_TRANSPORT_INSTANCE_FROM_DT_INST(inst, pm, data, config,	\
+					     level, api)		\
+	DEVICE_INSTANCE_FROM_DT_INST(inst, &scmi_core_transport_init,	\
+				     pm, data, config, level, api)
+
 /**
  * @brief Define an SCMI protocol
  *
@@ -216,6 +233,39 @@
 			 &SCMI_PROTOCOL_NAME(DT_REG_ADDR_RAW(node_id)),		\
 					     config, level, prio, api)
 
+/**
+ * @brief Define an SCMI protocol
+ *
+ * This macro performs three important functions:
+ *	1) It defines a `struct scmi_protocol`, which is
+ *	needed by all protocol drivers to work with the SCMI API.
+ *
+ *	2) It declares the static channels bound to the protocol.
+ *	This is only applicable if the transport layer driver
+ *	supports static channels.
+ *
+ *	3) It creates a `struct device` a sets the `data` field
+ *	to the newly defined `struct scmi_protocol`. This is
+ *	needed because the protocol driver needs to work with the
+ *	SCMI API **and** the subsystem API.
+ *
+ * @param node_id protocol node identifier
+ * @param init_fn pointer to protocol's initialization function
+ * @param api pointer to protocol's subsystem API
+ * @param pm pointer to the protocol's power management resources
+ * @param data pointer to protocol's private data
+ * @param config pointer to protocol's private constant data
+ * @param level protocol initialization level
+ * @param api pointer to driver's api
+ */
+#define SCMI_PROTOCOL_INSTANCE(node_id, init_fn, pm, data, config,		\
+			       level, api)					\
+	DT_SCMI_TRANSPORT_CHANNELS_DECLARE(node_id)				\
+	DT_SCMI_PROTOCOL_DATA_DEFINE(node_id, DT_REG_ADDR(node_id), data);	\
+	DEVICE_INSTANCE(node_id, init_fn, pm,					\
+			&SCMI_PROTOCOL_NAME(DT_REG_ADDR(node_id)),		\
+			config, level, api)
+
 /**
  * @brief Just like DT_SCMI_PROTOCOL_DEFINE(), but uses an instance
  * of a `DT_DRV_COMPAT` compatible instead of a node identifier
@@ -233,6 +283,15 @@
 				     level, prio, api)				\
 	DT_SCMI_PROTOCOL_DEFINE(DT_INST(inst, DT_DRV_COMPAT), init_fn, pm,	\
 				data, config, level, prio, api)
+/**
+ * @brief Just like SCMI_PROTOCOL_INSTANCE(), but uses an instance
+ * of a `DT_DRV_COMPAT` compatible instead of a node identifier
+ *
+ * @param inst instance number
+ * @param ... Other parameters as expected by SCMI_PROTOCOL_INSTANCE
+ */
+#define SCMI_PROTOCOL_INSTANCE_FROM_DT_INST(inst, ...)			\
+	SCMI_PROTOCOL_INSTANCE(DT_INST(inst, DT_DRV_COMPAT), __VA_ARGS__)
 
 /**
  * @brief Define an SCMI protocol with no device