michaelh/zephyr
1
0
Fork 0
Code Releases Activity

drivers: clock_control: Clarify allowed calling context of API calls

Browse source 
Clarified that clock_control_off and clock_control_async_on can be
called from any context since they are non-blocking.

Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
This commit is contained in:
Krzysztof Chruscinski 2019-11-20 09:07:12 +01:00 • committed by Carles Cufí
commit 16ba258052
1 changed files with 5 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

6
include/drivers/clock_control.h
View file

@ -117,7 +117,10 @@ static inline int clock_control_on(struct device *dev,
} }
/** /**
* @brief Disable the clock of a sub-system controlled by the device * @brief Disable the clock of a sub-system controlled by the device.
*
* Function is non-blocking and can be called from any context.
*
* @param dev Pointer to the device structure for the clock controller driver * @param dev Pointer to the device structure for the clock controller driver
* instance * instance
* @param sys A pointer to an opaque data representing the sub-system * @param sys A pointer to an opaque data representing the sub-system
@ -134,6 +137,7 @@ static inline int clock_control_off(struct device *dev,
/** /**
* @brief Request clock to start with notification when clock has been started. * @brief Request clock to start with notification when clock has been started.
* *
* Function is non-blocking and can be called from any context.
* When clock is already running user callback will be called from the context * When clock is already running user callback will be called from the context
* of the function call else it is called from other context (e.g. clock * of the function call else it is called from other context (e.g. clock
* interrupt). * interrupt).