diff --git a/esp-wifi/src/common_adapter/mod.rs b/esp-wifi/src/common_adapter/mod.rs index 303185db647..7a5b19aa5e6 100644 --- a/esp-wifi/src/common_adapter/mod.rs +++ b/esp-wifi/src/common_adapter/mod.rs @@ -31,13 +31,13 @@ pub(crate) static mut RANDOM_GENERATOR: Option = None; pub(crate) static mut RADIO_CLOCKS: Option = None; -pub fn init_rng(rng: Rng) { +pub(crate) fn init_rng(rng: Rng) { unsafe { crate::common_adapter::RANDOM_GENERATOR = Some(core::mem::transmute(rng)); } } -pub fn init_radio_clock_control(rcc: RadioClockControl) { +pub(crate) fn init_radio_clock_control(rcc: RadioClockControl) { unsafe { crate::common_adapter::RADIO_CLOCKS = Some(core::mem::transmute(rcc)); } diff --git a/esp-wifi/src/lib.rs b/esp-wifi/src/lib.rs index 673306fd8e1..8e619ebb44e 100644 --- a/esp-wifi/src/lib.rs +++ b/esp-wifi/src/lib.rs @@ -4,6 +4,7 @@ #![feature(linkage)] #![cfg_attr(feature = "async", feature(async_fn_in_trait))] #![cfg_attr(feature = "async", allow(incomplete_features))] +#![doc = include_str!("../../README.md")] // MUST be the first module mod fmt; @@ -82,12 +83,13 @@ pub mod tasks; pub(crate) mod memory_fence; -pub use critical_section; +use critical_section; use timer::{get_systimer_count, TICKS_PER_SECOND}; #[cfg(all(feature = "embedded-svc", feature = "wifi"))] pub mod wifi_interface; +/// Return the current systimer time in milliseconds pub fn current_millis() -> u64 { get_systimer_count() / (TICKS_PER_SECOND / 1000) } @@ -117,6 +119,7 @@ const DEFAULT_TICK_RATE_HZ: u32 = 100; #[derive(Debug)] #[cfg_attr(feature = "defmt", derive(defmt::Format))] #[toml_cfg::toml_config] +/// Tunable parameters for the WiFi driver struct Config { #[default(5)] rx_queue_size: usize, @@ -174,10 +177,12 @@ pub type EspWifiTimer = hal::timer::Timer for InitializationError { } } +/// Enable verbose logging within the WiFi driver +/// Does nothing unless the `wifi-logs` feature is enabled. pub fn wifi_set_log_verbose() { #[cfg(feature = "wifi-logs")] unsafe { @@ -365,11 +372,7 @@ pub fn wifi_set_log_verbose() { } } -pub fn init_buffer() { - // nothing anymore for now -} - -pub fn init_clocks() { +fn init_clocks() { unsafe { unwrap!(RADIO_CLOCKS.as_mut()).init_clocks(); }