Skip to content

drivers: clock_control: clock_control_on is blocking #20710

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 1 commit into from
Dec 9, 2019
Merged

drivers: clock_control: clock_control_on is blocking #20710

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
26 changes: 17 additions & 9 deletions include/drivers/clock_control.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,10 +102,17 @@ struct clock_control_driver_api {
};

/**
* @brief Enable the clock of a sub-system controlled by the device
* @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
* @brief Enable a clock controlled by the device
*
* On success, the clock is enabled and ready when this function
* returns. This function may sleep, and thus can only be called from
* thread context.
*
* Use @ref clock_control_async_on() for non-blocking operation.
*
* @param dev Device structure whose driver controls the clock.
* @param sys Opaque data representing the clock.
Copy link
Contributor

@nordic-krch nordic-krch Nov 15, 2019

Choose a reason for hiding this comment

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

It's not clear what it is actually. It's probably something that is vendor dependent.

Copy link
Contributor Author

@mbolivar mbolivar Nov 19, 2019

Choose a reason for hiding this comment

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

I don't understand this comment. That's what "opaque data" means, no?

Copy link
Contributor Author

@mbolivar mbolivar Nov 19, 2019

Choose a reason for hiding this comment

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

I've updated the clock disable comment to use the same language

* @return 0 on success, negative errno on failure.
*/
static inline int clock_control_on(struct device *dev,
clock_control_subsys_t sys)
Expand All @@ -117,13 +124,14 @@ static inline int clock_control_on(struct device *dev,
}

/**
* @brief Disable the clock of a sub-system controlled by the device.
* @brief Disable a clock controlled by the device
*
* Function is non-blocking and can be called from any context.
* This function is non-blocking and can be called from any context.
* On success, the clock is disabled when this function returns.
*
* @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
* @param dev Device structure whose driver controls the clock
* @param sys Opaque data representing the clock
* @return 0 on success, negative errno on failure.
*/
static inline int clock_control_off(struct device *dev,
clock_control_subsys_t sys)
Expand Down