IPC4 error code corrections#10808
Open
wjablon1 wants to merge 4 commits into
Open
Conversation
wjablon1
requested review from
abonislawski,
Copilot,
serhiy-katsyuba-intel,
softwarecki and
tmleman
wjablon1
requested review from
dbaluta,
kv2019i,
lbetlej,
lgirdwood,
mmaka1 and
plbossart
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request updates IPC4 reply/status handling to better match IPC4 protocol expectations, mainly by correcting error codes returned from IPC4 module and BaseFW-related handlers to improve compliance and re-enable shared reference-firmware tests.
Changes:
- Replace several uses of
IPC4_MOD_INVALID_IDwithIPC4_INVALID_RESOURCE_IDin IPC4 module config/large-config paths. - Add explicit validation that the BaseFW module only supports instance
0(for large-config get). - Adjust module-message default handling to return
IPC4_UNKNOWN_MESSAGE_TYPEfor unknown commands, and explicitly mark some module commands asIPC4_UNAVAILABLE.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
src/ipc/ipc4/handler-user.c |
Updates module-message error/status returns and adds BaseFW instance validation for large-config get. |
src/audio/base_fw_intel.c |
Changes default error code returned by Intel BaseFW vendor get-large-config handler. |
Comment on lines
819
to
+824
| } else { | ||
| drv = ipc4_get_comp_drv(config->primary.r.module_id); | ||
| } | ||
|
|
||
| if (!drv) | ||
| return IPC4_MOD_INVALID_ID; | ||
| return IPC4_INVALID_RESOURCE_ID; |
Comment on lines
1179
to
+1184
| } else { | ||
| drv = ipc4_get_comp_drv(config.primary.r.module_id); | ||
| } | ||
|
|
||
| if (!drv) | ||
| return IPC4_MOD_INVALID_ID; | ||
| return IPC4_INVALID_RESOURCE_ID; |
| extended_param_id.full = param_id; | ||
|
|
||
| uint32_t ret = IPC4_ERROR_INVALID_PARAM; | ||
| uint32_t ret = IPC4_INVALID_REQUEST; |
serhiy-katsyuba-intel
approved these changes
May 26, 2026
tmleman
reviewed
May 26, 2026
Comment on lines
+1279
to
+1280
| case SOF_IPC4_MOD_SET_DX: | ||
| case SOF_IPC4_MOD_SET_D0IX: |
Contributor
There was a problem hiding this comment.
What about this change? You didn't mention it in the commit message.
Contributor
Author
There was a problem hiding this comment.
Those messages are known but unsupported. Hence they had to be moved here so that they don’t fall into the UNKNOWN_MESSAGE_TYPE default case (because the default error code has changed).
Contributor
There was a problem hiding this comment.
They are supported but are handled in handler-kernel.c. This won't cause an error and can probably stay, it's just a bit misleading.
Contributor
Author
There was a problem hiding this comment.
You are right. I will fix this. Thanks!
softwarecki
approved these changes
May 26, 2026
Improve IPC4 protocol adherence by return IPC4_UNKNOWN_MESSAGE_TYPE for unsupported module IPCs instead of reporting them as IPC4_UNAVAILABLE Signed-off-by: Wojciech Jablonski <wojciech.jablonski@intel.com>
Error code INVALID_PARAM is more generic and shall be used when a supported operation contains an invalid value in its data structure. For unsupported operations, INVALID_REQUEST shall be used instead. Signed-off-by: Wojciech Jablonski <wojciech.jablonski@intel.com>
In the context of Config Get/Set, when the target module instance cannot be resolved, FW should report INVALID_RESOURCE_ID. MOD_INVALID_ID should be reserved for other module-related IPCs. Signed-off-by: Wojciech Jablonski <wojciech.jablonski@intel.com>
Only 0th instance of BaseFW module is available. Report an error for any other instance Signed-off-by: Wojciech Jablonski <wojciech.jablonski@intel.com>
wjablon1
force-pushed
the
ipc_err_code_fix
branch
from
8326009 to
f15a1c1
Compare
Member
Contributor
tmleman
approved these changes
May 26, 2026
abonislawski
approved these changes
May 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
These commits correct a bunch of error codes to improve compliance with the IPC4 protocol. This allows me to re-enable older tests that are shared with the reference firmware. Some of the fixes seem sound, while others seem more arbitrary, especially the change from MOD_INVALID_ID to INVALID_RESOURCE_ID. Those may reflect the reference firmware's design or implementation rather than an intentional protocol decision. Therefore, if any of these changes are unacceptable or incompatible with the driver, please let me know. I will try to address those issues elsewhere.