stm32: more docs.

This commit is contained in:
Dario Nieuwenhuis
2023-12-19 00:05:54 +01:00
parent 138318f611
commit 49534cd405
23 changed files with 55 additions and 6 deletions

View File

@ -354,7 +354,11 @@ unsafe fn uicr_write_masked(address: *mut u32, value: u32, mask: u32) -> WriteRe
WriteResult::Written
}
/// Initialize peripherals with the provided configuration. This should only be called once at startup.
/// Initialize the `embassy-nrf` HAL with the provided configuration.
///
/// This returns the peripheral singletons that can be used for creating drivers.
///
/// This should only be called once at startup, otherwise it panics.
pub fn init(config: config::Config) -> Peripherals {
// Do this first, so that it panics if user is calling `init` a second time
// before doing anything important.