ipc4: notification: Add filtering feature

Adding a handler for retrieving info about the IPC4 notification mask out
of the LargeConfig. The notification mask is then used for filtering IPC4
notifications sent by the FW.

This feature allows muting notifications of a given kind to enhance
readability of logs during debugging. Also, this feature enhances
reliability of certain tests run on FPGA-based setups where the FW
notifications are too overwhelming for those setups.

Signed-off-by: Wojciech Jablonski <wojciech.jablonski@intel.com>

Author: wjablon1

src/audio/base_fw.c

@@ -11,6 +11,7 @@
 #include <ipc4/base_fw_vendor.h>
 #include <ipc4/pipeline.h>
 #include <ipc4/logging.h>
+#include <ipc4/notification.h>
 #include <ipc/topology.h>
 #include <ipc/compress_params.h>
 #include <sof_versions.h>
@@ -696,6 +697,17 @@ __cold static int basefw_get_large_config(struct comp_dev *dev, uint32_t param_i
 						data_offset, data);
 };
 
+__cold static int basefw_notification_mask_info(const void *data)
+{
+	const struct ipc4_notification_mask_info *mask_info = data;
+
+	assert_can_be_cold();
+
+	ipc4_update_notification_mask(mask_info->ntfy_mask, mask_info->enabled_mask);
+
+	return IPC4_SUCCESS;
+}
+
 __cold static int basefw_astate_table(void)
 {
 	assert_can_be_cold();
@@ -757,6 +769,8 @@ __cold static int basefw_set_large_config(struct comp_dev *dev, uint32_t param_i
 	assert_can_be_cold();
 
 	switch (param_id) {
+	case IPC4_NOTIFICATION_MASK:
+		return basefw_notification_mask_info(data);
 	case IPC4_ASTATE_TABLE:
 		return basefw_astate_table();
 	case IPC4_DMA_CONTROL:

src/include/ipc4/notification.h

@@ -295,5 +295,6 @@ bool send_gateway_xrun_notif_msg(uint32_t resource_id, enum sof_ipc_stream_direc
 
 void send_mixer_underrun_notif_msg(uint32_t resource_id, uint32_t eos_flag, uint32_t data_mixed,
 				   uint32_t expected_data_mixed);
+void ipc4_update_notification_mask(uint32_t ntfy_mask, uint32_t enabled_mask);
 
 #endif /* __IPC4_NOTIFICATION_H__ */

src/ipc/ipc4/notification.c

@@ -14,11 +14,38 @@
 
 #include <rtos/symbol.h>
 
+static uint32_t notification_mask = 0xFFFFFFFF;
+
+static bool is_notif_filtered_out(uint32_t event_type)
+{
+	uint32_t notif_idx;
+
+	switch (event_type) {
+	case SOF_IPC4_GATEWAY_UNDERRUN_DETECTED:
+		notif_idx = IPC4_UNDERRUN_AT_GATEWAY_NOTIFICATION_MASK_IDX;
+		break;
+	case SOF_IPC4_MIXER_UNDERRUN_DETECTED:
+		notif_idx = IPC4_UNDERRUN_AT_MIXER_NOTIFICATION_MASK_IDX;
+		break;
+	case SOF_IPC4_GATEWAY_OVERRUN_DETECTED:
+		notif_idx = IPC4_OVERRUN_AT_GATEWAY_NOTIFICATION_MASK_IDX;
+		break;
+	default:
+		return false;
+	}
+
+	return (notification_mask & BIT(notif_idx)) == 0;
+}
+
 static bool send_resource_notif(uint32_t resource_id, uint32_t event_type, uint32_t resource_type,
 				void *data, uint32_t data_size)
 {
-	struct ipc_msg *msg = ipc_notification_pool_get(IPC4_RESOURCE_EVENT_SIZE);
+	struct ipc_msg *msg;
+
+	if (is_notif_filtered_out(event_type))
+		return true; //silently ignore
 
+	msg = ipc_notification_pool_get(IPC4_RESOURCE_EVENT_SIZE);
 	if (!msg)
 		return false;
 
@@ -59,6 +86,12 @@ static enum sof_ipc4_resource_event_type dir_to_xrun_event(enum sof_ipc_stream_d
 						  SOF_IPC4_GATEWAY_OVERRUN_DETECTED;
 }
 
+void ipc4_update_notification_mask(uint32_t ntfy_mask, uint32_t enabled_mask)
+{
+	notification_mask &= enabled_mask | (~ntfy_mask);
+	notification_mask |= enabled_mask & ntfy_mask;
+}
+
 bool send_copier_gateway_xrun_notif_msg(uint32_t pipeline_id, enum sof_ipc_stream_direction dir)
 {
 	return send_resource_notif(pipeline_id, dir_to_xrun_event(dir), SOF_IPC4_PIPELINE, NULL,