audio: dai-zephyr: minor cleanup of xrun handling code #10479
Conversation
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
Some minor improvements to make the xrun handling code easier to follow. The current implementation is checking for DAI DMA overrun/underrun conditions both at start of a copy callback (using data from DMA driver dma_get_status()), as well as at end of copy callback (using dma_reload()). There is also two separate mechanisms to report xruns, one specific to IPC4 (CONFIG_XRUN_NOTIFICATIONS_ENABLE) and one common method using component.h interface (comp_underrun() and comp_underrun()). Add documentation to the xrun helper functions and rename dai_report_xrun() to dai_report_reload_xrun() to better reflect the actual implementation. Signed-off-by: Kai Vehmanen <[email protected]>
kv2019i
requested review from
Copilot,
jsarha,
lyakh,
ranj063,
serhiy-katsyuba-intel and
softwarecki
kv2019i
requested review from
dbaluta,
lbetlej,
lgirdwood,
mmaka1 and
plbossart
as code owners
There was a problem hiding this comment.
Pull request overview
This PR improves the readability and documentation of xrun (overrun/underrun) handling code in the DAI Zephyr driver. The changes clarify that xrun detection occurs at two points: during status checks via dma_get_status() and after reload attempts via dma_reload().
Changes:
- Added comprehensive documentation to xrun detection and reporting helper functions
- Renamed
dai_report_xrun()todai_report_reload_xrun()to clarify it handles reload-specific xrun reporting - Updated all call sites to use the new function name
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
serhiy-katsyuba-intel
approved these changes
Jan 12, 2026
softwarecki
approved these changes
Jan 12, 2026
tmleman
approved these changes
Jan 12, 2026
lgirdwood
approved these changes
Jan 12, 2026
lyakh
reviewed
Jan 13, 2026
| * Report xrun occurrence after DAI DMA driver reports | ||
| * an error for a reload attempt of 'bytes' of data. | ||
| * | ||
| * See also xrun detection done in dai_get_status(). |
Collaborator
There was a problem hiding this comment.
would it also make sense to explain a bit more what comp_underrun() and comp_overrun() do? Their comments aren't particularly enlightening either:
Called by the component device when underrun is detected.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
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.
Some minor improvements to make the xrun handling code easier to follow. The current implementation is checking for DAI DMA overrun/underrun conditions both at start of a copy callback (using data from DMA driver dma_get_status()), as well as at end of copy callback (using dma_reload()). There is also two separate mechanisms to report xruns, one specific to IPC4 (CONFIG_XRUN_NOTIFICATIONS_ENABLE) and one common method using component.h interface (comp_underrun() and comp_underrun()).
Add documentation to the xrun helper functions and rename dai_report_xrun() to dai_report_reload_xrun() to better reflect the actual implementation.