Merge pull request #11 from jamesmunns/james/impl-clocks

Implement initial `clock` driver.

This PR introduces an initial two-phase clock driver system:

1. The first stage is responsible for initializing the core/system clocks at the time of `embassy_mcxa::init()`
2. The second stage is done on creation of peripherals

This work is limited to currently used clocks and peripherals, but has room for expansion for later peripherals. This model is based on the preliminary refactoring performed for the `embassy-imxrt` crate.

1 files changed, 13 insertions, 45 deletions

diff --git a/examples/src/lib.rs b/examples/src/lib.rs
index cf4194559..4bb334da5 100644
--- a/examples/src/lib.rs
+++ b/examples/src/lib.rs
@@ -1,63 +1,31 @@
 #![no_std]
+#![allow(clippy::missing_safety_doc)]
 
 //! Shared board-specific helpers for the FRDM-MCXA276 examples.
 //! These live with the examples so the HAL stays generic.
 
-use hal::{clocks, pins, reset};
+use hal::{clocks, pins};
 use {defmt_rtt as _, embassy_mcxa as hal, panic_probe as _};
 
 /// Initialize clocks and pin muxing for UART2 debug console.
 /// Safe to call multiple times; writes are idempotent for our use.
-///
-/// # Safety
-///
-/// Called only once to initialize the peripheral
-#[allow(dead_code)]
-pub unsafe fn init_uart2(p: &hal::pac::Peripherals) {
-    clocks::ensure_frolf_running(p);
-    clocks::enable_uart2_port2(p);
-    reset::release_reset_port2(p);
-    reset::release_reset_lpuart2(p);
+pub unsafe fn init_uart2_pins(_p: &hal::pac::Peripherals) {
+    // NOTE: Lpuart has been updated to properly enable + reset its own clocks.
+    // GPIO has not.
+    _ = clocks::enable_and_reset::<hal::peripherals::PORT2>(&clocks::periph_helpers::NoConfig);
     pins::configure_uart2_pins_port2();
-    clocks::select_uart2_clock(p);
 }
 
 /// Initialize clocks for the LED GPIO/PORT used by the blink example.
-///
-/// # Safety
-///
-/// Called only once to initialize the peripheral
-#[allow(dead_code)]
-pub unsafe fn init_led(p: &hal::pac::Peripherals) {
-    clocks::enable_led_port(p);
-    reset::release_reset_gpio3(p);
-    reset::release_reset_port3(p);
-}
-
-/// Initialize clocks for OSTIMER0 (1 MHz source).
-///
-/// # Safety
-///
-/// Called only once to initialize the peripheral
-#[allow(dead_code)]
-pub unsafe fn init_ostimer0(p: &hal::pac::Peripherals) {
-    clocks::ensure_frolf_running(p);
-    clocks::enable_ostimer0(p);
-    reset::release_reset_ostimer0(p);
-    clocks::select_ostimer0_clock_1m(p);
+pub unsafe fn init_led_gpio_clocks(_p: &hal::pac::Peripherals) {
+    _ = clocks::enable_and_reset::<hal::peripherals::PORT3>(&clocks::periph_helpers::NoConfig);
+    _ = clocks::enable_and_reset::<hal::peripherals::GPIO3>(&clocks::periph_helpers::NoConfig);
 }
 
 /// Initialize clocks and pin muxing for ADC.
-///
-/// # Safety
-///
-/// Called only once to initialize the peripheral
-#[allow(dead_code)]
-pub unsafe fn init_adc(p: &hal::pac::Peripherals) {
-    clocks::ensure_frolf_running(p);
-    clocks::enable_adc(p);
-    reset::release_reset_port1(p);
-    reset::release_reset_adc1(p);
+pub unsafe fn init_adc_pins(_p: &hal::pac::Peripherals) {
+    // NOTE: Lpuart has been updated to properly enable + reset its own clocks.
+    // GPIO has not.
+    _ = clocks::enable_and_reset::<hal::peripherals::PORT1>(&clocks::periph_helpers::NoConfig);
     pins::configure_adc_pins();
-    clocks::select_adc_clock(p);
 }