Feature/document and streamline rcc interface #241
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.
Added documentation based on review of RCC section of reference manual
Simplified existence tokens and ensure that they can't be created outside of the HAL.
Interface Question:
From reading the reference manual, it's not clear to me that applying a clock configuration "freezes" it.
If the RCC config is mutable, then maybe the freeze terminology and statement that the existence of a
Clocks
struct indicates that the clocks cannot be further modified should be reconsidered?If the RCC config is fixed somehow once it's applied, maybe it might make sense to remove the
clock_src
function from theConfig
implementation, as you only get a config by specifying a src to begin with.