Skip to content

drivers: clock_control: Clarify allowed calling context of API functions #20814

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
merged 2 commits into from
Nov 20, 2019
Merged

drivers: clock_control: Clarify allowed calling context of API functions #20814

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d3bc28
drivers: clock_control: Remove false description of clock_control_asy…
nordic-krch Nov 20, 2019
3048a87
drivers: clock_control: Clarify allowed calling context of API calls
nordic-krch Nov 20, 2019
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
9 changes: 5 additions & 4 deletions include/drivers/clock_control.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

@mbolivar mbolivar Nov 20, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Function is non-blocking and can be called from any context.
* This function is non-blocking, and can be called from any context.

*
* @param dev Pointer to the device structure for the clock controller driver
* instance
* @param sys A pointer to an opaque data representing the sub-system
Expand All @@ -134,9 +137,7 @@ static inline int clock_control_off(struct device *dev,
/**
* @brief Request clock to start with notification when clock has been started.
*
* User can request delayed start by providing exact information when clock
* should be ready. Driver ensures that clock is ready before requested time.
* It is the driver responsibility to take into account clock startup time.
* Function is non-blocking and can be called from any context.
Copy link
Contributor

@mbolivar mbolivar Nov 20, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Function is non-blocking and can be called from any context.
* This function is non-blocking, and can be called from any 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
* interrupt).
Expand Down