From 6b56d9b3ca0f05ad50b93c3ada1f48b1ece52fe7 Mon Sep 17 00:00:00 2001 From: Liam Girdwood Date: Wed, 27 Jan 2021 15:17:21 +0000 Subject: [PATCH] component: doxygen: add more content around prepare() and reset(). Add some more usage context around prepare() and reset() for developers. Signed-off-by: Liam Girdwood --- src/include/sof/audio/component.h | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/include/sof/audio/component.h b/src/include/sof/audio/component.h index 303ff4f3f1cc..2e2be0e22ce5 100644 --- a/src/include/sof/audio/component.h +++ b/src/include/sof/audio/component.h @@ -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);