Skip to content

component: doxygen: add more content around prepare() and reset(). #3789

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
Jan 27, 2021
Merged

component: doxygen: add more content around prepare() and reset(). #3789

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
8 changes: 8 additions & 0 deletions src/include/sof/audio/component.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,12 +311,20 @@ struct comp_ops {
/**
* Prepares component after params are set.
* @param dev Component device.
*
* Prepare should be used to get the component ready for starting
* processing after it's hw_params are known or after an XRUN.
*/
int (*prepare)(struct comp_dev *dev);

/**
* Resets component.
* @param dev Component device.
*
* Resets the component state and any hw_params to default component
* state. Should also free any resources acquired during hw_params.
* TODO: Some components are not compliant here wrt reset(). Fix this
* in v1.8.
*/
int (*reset)(struct comp_dev *dev);

Expand Down