Un-publish crate::rcc::Config::get_clocks #438
Merged
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
The existence of a crate::rcc::Clocks value is supposed to assert that
the MCU clocks have been configured and that they cannot be changed
anymore. That works by consuming the only instance of CFGR in the
corresponding function and then returning a Clocks value.
However, having crate::rcc::config::Config::get_clocks public implies
that external code can, at any time, generate a Clocks value: by simply
constructing a Config instance (all fields are public) and calling the
function.
```rust
#![no_std]
#![no_main]
use panic_halt as _;
use stm32f1xx_hal as hal;
use cortex_m_rt::entry;
#[entry]
fn main() -> ! {
let clocks: hal::rcc::Clocks = hal::rcc::Config{
hse: Some(8000000),
pllmul: Some(8),
hpre: hal::rcc::HPre::DIV1,
ppre1: hal::rcc::PPre::DIV2,
ppre2: hal::rcc::PPre::DIV1,
adcpre: hal::rcc::AdcPre::DIV8,
usbpre: hal::rcc::UsbPre::DIV1,
}.get_clocks();
loop{}
}
```
This is a breaking change, obviously, but there are no non-breaking
alternatives.
Fixes stm32-rs#437.
horazont
force-pushed
the
fix/pub-get_clocks
branch
from
1a0750b to
4909f29
Compare
burrbull
approved these changes
Aug 28, 2022
|
bors r+ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The existence of a crate::rcc::Clocks value is supposed to assert that
the MCU clocks have been configured and that they cannot be changed
anymore. That works by consuming the only instance of CFGR in the
corresponding function and then returning a Clocks value.
However, having crate::rcc::config::Config::get_clocks public implies
that external code can, at any time, generate a Clocks value: by simply
constructing a Config instance (all fields are public) and calling the
function.
This is a breaking change, obviously, but there are no non-breaking
alternatives.
Fixes #437.