Skip to content

ASoC: SOF: ipc4: Add decoder for RESOURCE_EVENT notifications from fi… #5842

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ujfalusi wants to merge 1 commit into
base: topic/sof-dev
Choose a base branch
from
+136 −1
Open

ASoC: SOF: ipc4: Add decoder for RESOURCE_EVENT notifications from fi… #5842

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 52 additions & 1 deletion include/sound/sof/ipc4/header.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -537,12 +537,63 @@ enum sof_ipc4_notification_type {
SOF_IPC4_NOTIFY_TYPE_LAST,
};

enum sof_ipc4_resource_type {
SOF_IPC4_MODULE_INSTANCE,
SOF_IPC4_PIPELINE,
SOF_IPC4_GATEWAY,
SOF_IPC4_EDF_TASK,
SOF_IPC4_INVALID_RESOURCE_TYPE,
};
Comment on lines +541 to +546

@ujfalusi ujfalusi Jul 15, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, enums are enums.


enum sof_ipc4_event_type {
/* Underrun detected by the Mixer */
SOF_IPC4_MIXER_UNDERRUN_DETECTED = 1,
/* Error caught during data processing */
SOF_IPC4_PROCESS_DATA_ERROR = 3,
/* Underrun detected by gateway. */
SOF_IPC4_GATEWAY_UNDERRUN_DETECTED = 6,
/* Overrun detected by gateway */
SOF_IPC4_GATEWAY_OVERRUN_DETECTED,
};

/**
* struct sof_ipc4_process_data_error_event_data - process data error event payload
* @error_code: Error code returned by data processing function
*/
struct sof_ipc4_process_data_error_event_data {
uint32_t error_code;
};

/**
* struct sof_ipc4_mixer_underrun_event_data - mixer underrun event payload
* @eos_flag: Indicates EndOfStream
* @data_mixed: Data processed by module (in bytes)
* @expected_data_mixed: Expected data to be processed (in bytes)
*/
struct sof_ipc4_mixer_underrun_event_data {
uint32_t eos_flag;
uint32_t data_mixed;
uint32_t expected_data_mixed;
};

/**
* union sof_ipc4_resource_event_data - resource event specific payload
* @dws: Raw event data payload as six dwords
* @process_data_error: SOF_IPC4_PROCESS_DATA_ERROR payload
* @mixer_underrun: SOF_IPC4_MIXER_UNDERRUN_DETECTED payload
*/
union sof_ipc4_resource_event_data {
uint32_t dws[6];
struct sof_ipc4_process_data_error_event_data process_data_error;
struct sof_ipc4_mixer_underrun_event_data mixer_underrun;
};

struct sof_ipc4_notify_resource_data {
uint32_t resource_type;
uint32_t resource_id;
uint32_t event_type;
uint32_t reserved;
uint32_t data[6];
union sof_ipc4_resource_event_data data;
} __packed __aligned(4);

/*
Expand Down
84 changes: 84 additions & 0 deletions sound/soc/sof/ipc4.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,6 +290,89 @@ static void sof_ipc4_dump_payload(struct snd_sof_dev *sdev,
16, 4, ipc_data, size, false);
}

static const char *sof_ipc4_resource_type_str(u32 type)
{
switch (type) {
case SOF_IPC4_MODULE_INSTANCE:
return "resource: MODULE_INSTANCE";
case SOF_IPC4_PIPELINE:
return "resource: PIPELINE";
case SOF_IPC4_GATEWAY:
return "resource: GATEWAY";
case SOF_IPC4_EDF_TASK:
return "resource: EDF_TASK";
case SOF_IPC4_INVALID_RESOURCE_TYPE:
return "Resource is invalid";
default:
return "Unknown resource type";
}
}

static const char *sof_ipc4_resource_event_type_str(u32 event_type)
{
switch (event_type) {
case SOF_IPC4_MIXER_UNDERRUN_DETECTED:
return "event: MIXER_UNDERRUN_DETECTED";
case SOF_IPC4_PROCESS_DATA_ERROR:
return "event: PROCESS_DATA_ERROR";
case SOF_IPC4_GATEWAY_UNDERRUN_DETECTED:
return "event: GATEWAY_UNDERRUN_DETECTED";
case SOF_IPC4_GATEWAY_OVERRUN_DETECTED:
return "event: GATEWAY_OVERRUN_DETECTED";
default:
return "Unknown event type";
}
}

static void sof_ipc4_resource_event_handler(struct snd_sof_dev *sdev,
struct sof_ipc4_msg *ipc4_msg)
{
struct sof_ipc4_notify_resource_data *data = ipc4_msg->data_ptr;

/* Print event details */
switch (data->event_type) {
case SOF_IPC4_MIXER_UNDERRUN_DETECTED:
dev_dbg(sdev->dev, "%s (%u): eos %u, mixed %u, expected %u\n",
sof_ipc4_resource_event_type_str(data->event_type),
data->event_type, data->data.mixer_underrun.eos_flag,
data->data.mixer_underrun.data_mixed,
data->data.mixer_underrun.expected_data_mixed);
break;
case SOF_IPC4_PROCESS_DATA_ERROR:
dev_dbg(sdev->dev, "%s (%u): error_code %#x\n",
sof_ipc4_resource_event_type_str(data->event_type),
data->event_type, data->data.process_data_error.error_code);
break;
case SOF_IPC4_GATEWAY_UNDERRUN_DETECTED:
case SOF_IPC4_GATEWAY_OVERRUN_DETECTED:
dev_dbg(sdev->dev, "%s (%u)\n",
sof_ipc4_resource_event_type_str(data->event_type),
data->event_type);
break;
default:
dev_dbg(sdev->dev, "%s (%u): raw dws %#x %#x %#x %#x %#x %#x\n",
sof_ipc4_resource_event_type_str(data->event_type),
data->event_type,
data->data.dws[0], data->data.dws[1], data->data.dws[2],
data->data.dws[3], data->data.dws[4], data->data.dws[5]);
break;
}

/* Print resource details */
if (data->resource_type == SOF_IPC4_MODULE_INSTANCE) {
u32 module_id = SOF_IPC4_MOD_ID_GET(data->resource_id);
u32 instance_id = SOF_IPC4_MOD_INSTANCE_GET(data->resource_id);

dev_dbg(sdev->dev, "%s (%u), module_id %u, instance_id %u\n",
sof_ipc4_resource_type_str(data->resource_type),
data->resource_type, module_id, instance_id);
} else if (data->resource_type != SOF_IPC4_INVALID_RESOURCE_TYPE) {
dev_dbg(sdev->dev, "%s (%u), id %u\n",
sof_ipc4_resource_type_str(data->resource_type),
data->resource_type, data->resource_id);
}
Comment on lines +369 to +373

@ujfalusi ujfalusi Jul 15, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't agree, this is on purpose, if needed one can enable the payload dump for full information.
The resource is invalid, not in use, it carries no information.

}

static int sof_ipc4_get_reply(struct snd_sof_dev *sdev)
{
struct snd_sof_ipc_msg *msg = sdev->msg;
Expand Down Expand Up @@ -740,6 +823,7 @@ static void sof_ipc4_rx_msg(struct snd_sof_dev *sdev)
break;
case SOF_IPC4_NOTIFY_RESOURCE_EVENT:
data_size = sizeof(struct sof_ipc4_notify_resource_data);
handler_func = sof_ipc4_resource_event_handler;
break;
case SOF_IPC4_NOTIFY_LOG_BUFFER_STATUS:
sof_ipc4_mtrace_update_pos(sdev, SOF_IPC4_LOG_CORE_GET(ipc4_msg->primary));
Expand Down
Loading