ipc4: notification: Add support for data process error notification

Provide a structure and function to initiate notification of an error
reported by the module's data processing function.

Signed-off-by: Adrian Warecki <adrian.warecki@intel.com>

Author: softwarecki

src/include/ipc4/notification.h

@@ -25,6 +25,7 @@
 
 #include <stdint.h>
 #include <ipc/header.h>
+#include <sof/ipc/msg.h>
 #include <sof/compiler_attributes.h>
 
 /* ipc4 notification msg */
@@ -229,6 +230,18 @@ static inline void ipc4_notification_watchdog_init(struct ipc4_watchdog_timeout_
 	notif->primary.r.msg_tgt = SOF_IPC4_MESSAGE_TARGET_FW_GEN_MSG;
 }
 
+/**
+ * \brief This notification is sent by a shim of module instance on error raised by data processing
+ * function.
+ *
+ * In case of 3rd party IP error_code is set to its native error code returned by the 3rd party
+ * library.
+ */
+struct ipc4_process_data_error_event_data {
+	/* Error code returned by data processing function */
+	uint32_t error_code;
+};
+
 /**
  * \brief Input data payload is reserved field in parent technical spec which can be easily
  * extendable if needed by specific resource event types in the future. For backward compatibility
@@ -237,6 +250,8 @@ static inline void ipc4_notification_watchdog_init(struct ipc4_watchdog_timeout_
 union ipc4_resource_event_data {
 	/* Raw data */
 	uint32_t dws[6];
+	/* Process Data Error Data (res type = MODULE_INSTANCE) */
+	struct ipc4_process_data_error_event_data process_data_error;
 };
 
 struct ipc4_resource_event_data_notification {
@@ -254,4 +269,9 @@ struct ipc4_resource_event_data_notification {
 	union ipc4_resource_event_data event_data;
 } __packed __aligned(8);
 
+#define IPC4_RESOURCE_EVENT_SIZE	sizeof(struct ipc4_resource_event_data_notification)
+
+void process_data_error_notif_msg_init(struct ipc_msg *msg, uint32_t resource_id,
+				       uint32_t error_code);
+
 #endif /* __IPC4_NOTIFICATION_H__ */

src/ipc/ipc4/notification.c

@@ -11,7 +11,6 @@
 #include <stdbool.h>
 #include <ipc4/notification.h>
 
-#if CONFIG_XRUN_NOTIFICATIONS_ENABLE
 static void resource_notif_header_init(struct ipc_msg *msg)
 {
 	struct ipc4_resource_event_data_notification *notif_data = msg->tx_data;
@@ -25,6 +24,7 @@ static void resource_notif_header_init(struct ipc_msg *msg)
 	memset(&notif_data->event_data, 0, sizeof(notif_data->event_data));
 }
 
+#if CONFIG_XRUN_NOTIFICATIONS_ENABLE
 void xrun_notif_msg_init(struct ipc_msg *msg_xrun, uint32_t resource_id, uint32_t event_type)
 {
 	struct ipc4_resource_event_data_notification *notif_data = msg_xrun->tx_data;
@@ -35,3 +35,15 @@ void xrun_notif_msg_init(struct ipc_msg *msg_xrun, uint32_t resource_id, uint32_
 	notif_data->resource_type = SOF_IPC4_GATEWAY;
 }
 #endif
+
+void process_data_error_notif_msg_init(struct ipc_msg *msg, uint32_t resource_id,
+				       uint32_t error_code)
+{
+	struct ipc4_resource_event_data_notification *notif_data = msg->tx_data;
+
+	resource_notif_header_init(msg);
+	notif_data->resource_id = resource_id;
+	notif_data->event_type = SOF_IPC4_PROCESS_DATA_ERROR;
+	notif_data->resource_type = SOF_IPC4_MODULE_INSTANCE;
+	notif_data->event_data.process_data_error.error_code = error_code;
+}