Skip to content

Commit 3048a87

Browse files
committed
drivers: clock_control: Clarify allowed calling context of API calls
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 <[email protected]>
1 parent 1d3bc28 commit 3048a87

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

include/drivers/clock_control.h

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,10 @@ static inline int clock_control_on(struct device *dev,
117117
}
118118

119119
/**
120-
* @brief Disable the clock of a sub-system controlled by the device
120+
* @brief Disable the clock of a sub-system controlled by the device.
121+
*
122+
* Function is non-blocking and can be called from any context.
123+
*
121124
* @param dev Pointer to the device structure for the clock controller driver
122125
* instance
123126
* @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,
134137
/**
135138
* @brief Request clock to start with notification when clock has been started.
136139
*
140+
* Function is non-blocking and can be called from any context.
137141
* When clock is already running user callback will be called from the context
138142
* of the function call else it is called from other context (e.g. clock
139143
* interrupt).

0 commit comments

Comments
 (0)