Skip to content

audio: cadence: add optional API error reporting #10604

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

Merged
lgirdwood merged 1 commit into from
Mar 12, 2026
Merged

audio: cadence: add optional API error reporting #10604

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
32 changes: 28 additions & 4 deletions src/audio/module_adapter/module/cadence.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -471,14 +471,32 @@ int cadence_codec_resolve_api_with_id(struct processing_module *mod, uint32_t co
return 0;
}

int cadence_codec_process_data(struct processing_module *mod)
static void cadence_store_api_error_code(struct comp_dev *dev,
XA_ERRORCODE *api_error_code,
int ret, const char *cmd_name)
{
if (!api_error_code)
return;

if (*api_error_code && *api_error_code != ret)
comp_dbg(dev, "overwriting api error code at %s: old %#x new %#x",
cmd_name, *api_error_code, ret);
Copy link

Copilot AI Mar 6, 2026

Choose a reason for hiding this comment

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

comp_dbg() uses %#x to print int values (ret and *api_error_code). In C this format expects an unsigned int, so this can trigger format warnings/UB for negative (high-bit-set) error codes. Consider casting to unsigned (or switching the stored type to an unsigned/UWORD32) when printing.

Suggested change
cmd_name, *api_error_code, ret);
cmd_name, (unsigned int)*api_error_code, (unsigned int)ret);

Copilot uses AI. Check for mistakes.
Copy link
Contributor Author

@ujfalusi ujfalusi Mar 6, 2026

Choose a reason for hiding this comment

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

well, the cadence codebase and defines are sloppy, this is what it is.
The error is described as bits (bit 31 - fatal, bit 11-14 class, etc), but defined as int.


*api_error_code = ret;
}

int cadence_codec_process_data(struct processing_module *mod,
XA_ERRORCODE *api_error_code)
{
struct cadence_codec_data *cd = module_get_private_data(mod);
struct module_data *codec = &mod->priv;
struct comp_dev *dev = mod->dev;
uint32_t done = 0;
int ret;

if (api_error_code)
*api_error_code = 0;

if (codec->mpd.eos_reached) {
codec->mpd.produced = 0;
codec->mpd.consumed = 0;
Expand All @@ -490,11 +508,13 @@ int cadence_codec_process_data(struct processing_module *mod)
/* Signal that the stream is expected to end anytime soon */
API_CALL(cd, XA_API_CMD_INPUT_OVER, 0, NULL, ret);
if (ret != LIB_NO_ERROR) {
if (api_error_code)
*api_error_code = ret;
Copy link
Collaborator

@lyakh lyakh Mar 10, 2026

Choose a reason for hiding this comment

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

not cadence_store_api_error_code()?

Copy link
Contributor Author

@ujfalusi ujfalusi Mar 10, 2026

Choose a reason for hiding this comment

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

No, as this is the first call which can generate return code, it will not override previous code.


if (LIB_IS_FATAL_ERROR(ret)) {
comp_err(dev, "input_over failed with error: %x", ret);
return ret;
}
comp_warn(dev, "input_over failed with nonfatal error: %x", ret);
}
}

Expand All @@ -506,20 +526,24 @@ int cadence_codec_process_data(struct processing_module *mod)

API_CALL(cd, XA_API_CMD_EXECUTE, XA_CMD_TYPE_DO_EXECUTE, NULL, ret);
if (ret != LIB_NO_ERROR) {
cadence_store_api_error_code(dev, api_error_code, ret,
"XA_API_CMD_EXECUTE_DO_EXECUTE");

if (LIB_IS_FATAL_ERROR(ret)) {
comp_err(dev, "processing failed with error: %x", ret);
return ret;
}
comp_warn(dev, "processing failed with nonfatal error: %x", ret);
Copy link
Contributor Author

@ujfalusi ujfalusi Mar 12, 2026

Choose a reason for hiding this comment

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

what if we instead just simply change the level to DBG for the non fatal codes?

Copy link
Contributor Author

@ujfalusi ujfalusi Mar 12, 2026

Choose a reason for hiding this comment

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

these codes are on the other hand are codec specific, the same reason code can mean completely different thing for mp3, ogg, flac, etc. Decoding is really not that simple.

Or, keep the prints as comp_dbg() and still have the ability to return the reason code if the caller wants to handle non fatal?

Copy link
Member

@lgirdwood lgirdwood Mar 12, 2026

Choose a reason for hiding this comment

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

Lets see how this works in practice, if we need more info we can add it later.

}

API_CALL(cd, XA_API_CMD_EXECUTE, XA_CMD_TYPE_DONE_QUERY, &done, ret);
if (ret != LIB_NO_ERROR) {
cadence_store_api_error_code(dev, api_error_code, ret,
"XA_API_CMD_EXECUTE_DONE_QUERY");

if (LIB_IS_FATAL_ERROR(ret)) {
comp_err(dev, "done query failed with error: %x", ret);
return ret;
}
comp_warn(dev, "done query failed with nonfatal error: %x", ret);
}

API_CALL(cd, XA_API_CMD_GET_OUTPUT_BYTES, 0, &codec->mpd.produced, ret);
Expand Down
2 changes: 1 addition & 1 deletion src/audio/module_adapter/module/cadence_ipc3.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ cadence_codec_process(struct processing_module *mod,

comp_dbg(dev, "cadence_codec_process() start");

ret = cadence_codec_process_data(mod);
ret = cadence_codec_process_data(mod, NULL);
if (ret)
return ret;

Expand Down
2 changes: 1 addition & 1 deletion src/audio/module_adapter/module/cadence_ipc4.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -465,7 +465,7 @@ static int cadence_codec_process(struct processing_module *mod, struct sof_sourc

comp_dbg(dev, "cadence_codec_process() start");

ret = cadence_codec_process_data(mod);
ret = cadence_codec_process_data(mod, NULL);
if (ret) {
source_release_data(sources[0], 0);
return ret;
Expand Down
3 changes: 2 additions & 1 deletion src/include/sof/audio/module_adapter/module/cadence.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,8 @@ int cadence_codec_set_configuration(struct processing_module *mod, uint32_t conf
int cadence_codec_resolve_api_with_id(struct processing_module *mod, uint32_t codec_id,
uint32_t direction);
int cadence_codec_apply_params(struct processing_module *mod, int size, void *data);
int cadence_codec_process_data(struct processing_module *mod);
int cadence_codec_process_data(struct processing_module *mod,
XA_ERRORCODE *api_error_code);
int cadence_codec_apply_config(struct processing_module *mod);
void cadence_codec_free_memory_tables(struct processing_module *mod);
int cadence_codec_init_memory_tables(struct processing_module *mod);
Expand Down
Loading