drivers: clock_control: Clarify allowed calling context of API functions #20814
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…nc_on Description of clock_control_async_on contained information about delayed start which is not supported by this function call. Signed-off-by: Krzysztof Chruscinski <[email protected]>
nordic-krch
added
bug
nordic-krch
requested review from
anangl,
mbolivar,
nashif,
pabigot and
tbursztyka
nordic-krch
requested review from
MaureenHelm,
carlescufi and
galak
as code owners
|
All checks are passing now. Tip: The bot edits this comment instead of posting a new one, so you can check the comment's history to see earlier messages. |
nordic-krch
force-pushed
the
fix_clock_control_async_on_dox
branch
from
df722e7 to
c18edf1
Compare
tbursztyka
approved these changes
Nov 20, 2019
anangl
approved these changes
Nov 20, 2019
carlescufi
approved these changes
Nov 20, 2019
Member
|
@nordic-krch can you please fix the gitlint issue? |
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]>
nordic-krch
force-pushed
the
fix_clock_control_async_on_dox
branch
from
c18edf1 to
3048a87
Compare
Contributor
Author
|
@carlescufi done. |
mbolivar
approved these changes
Nov 20, 2019
Contributor
mbolivar
left a comment
mbolivar
left a comment
There was a problem hiding this comment.
The suggested changes would be more correct grammatically, but I'm OK with this as is.
| * @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. |
Contributor
There was a problem hiding this comment.
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. |
| * 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. |
Contributor
There was a problem hiding this comment.
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. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Clarified that clock_control_off and clock_control_async_on can be called from any context since they are non-blocking.
Additionally, fixed:
drivers: clock_control: Remove false description of clock_control_async_on
Description of clock_control_async_on contained information about
delayed start which is not supported by this function call.
Given that #20710 (comment), I've updated function descriptions to explicitly state that they can be called from any context.