ariel_os_nrf/
lib.rs

1//! Items specific to the Nordic Semiconductor nRF MCUs.
2
3#![no_std]
4#![cfg_attr(nightly, feature(doc_cfg))]
5#![deny(missing_docs)]
6
7pub mod gpio;
8
9mod irqs;
10
11#[doc(hidden)]
12pub mod peripheral {
13    pub use embassy_nrf::Peri;
14}
15
16#[cfg(feature = "ble")]
17#[doc(hidden)]
18pub mod ble;
19
20#[cfg(feature = "external-interrupts")]
21#[doc(hidden)]
22pub mod extint_registry;
23
24#[cfg(feature = "hwrng")]
25#[doc(hidden)]
26pub mod hwrng;
27
28#[cfg(feature = "i2c")]
29pub mod i2c;
30
31#[doc(hidden)]
32pub mod identity;
33
34#[cfg(feature = "nrf91-modem")]
35#[doc(hidden)]
36pub mod modem;
37
38#[cfg(feature = "spi")]
39pub mod spi;
40
41#[cfg(feature = "uart")]
42pub mod uart;
43
44#[cfg(feature = "storage")]
45#[doc(hidden)]
46pub mod storage;
47
48#[cfg(feature = "usb")]
49#[doc(hidden)]
50pub mod usb;
51
52#[cfg(feature = "executor-interrupt")]
53#[doc(hidden)]
54pub use embassy_executor::InterruptExecutor as Executor;
55
56#[cfg(feature = "executor-interrupt")]
57#[cfg(context = "nrf51")]
58ariel_os_embassy_common::executor_swi!(SWI0);
59
60#[cfg(feature = "executor-interrupt")]
61#[cfg(context = "nrf52")]
62ariel_os_embassy_common::executor_swi!(EGU0_SWI0);
63
64#[cfg(feature = "executor-interrupt")]
65#[cfg(any(context = "nrf53", context = "nrf91"))]
66ariel_os_embassy_common::executor_swi!(EGU0);
67
68use embassy_nrf::{Peri, PeripheralType, config::Config};
69
70#[doc(hidden)]
71pub use embassy_nrf::{OptionalPeripherals, interrupt};
72
73pub use embassy_nrf::peripherals;
74
75#[cfg(feature = "executor-interrupt")]
76#[doc(hidden)]
77pub static EXECUTOR: Executor = Executor::new();
78
79#[doc(hidden)]
80pub trait IntoPeripheral<'a, T: PeripheralType>: private::Sealed {
81    fn into_hal_peripheral(self) -> Peri<'a, T>;
82}
83
84impl<T: PeripheralType> private::Sealed for Peri<'_, T> {}
85
86#[doc(hidden)]
87impl<'a, T: PeripheralType> IntoPeripheral<'a, T> for Peri<'a, T> {
88    fn into_hal_peripheral(self) -> Peri<'a, T> {
89        self
90    }
91}
92
93mod private {
94    pub trait Sealed {}
95}
96
97#[doc(hidden)]
98#[must_use]
99pub fn init() -> OptionalPeripherals {
100    enable_flash_cache();
101
102    let peripherals = embassy_nrf::init(Config::default());
103    OptionalPeripherals::from(peripherals)
104}
105
106fn enable_flash_cache() {
107    // (no flash cache on nrf51)
108    cfg_if::cfg_if! {
109        if #[cfg(any(
110                context = "nrf52",
111                context = "nrf5340-net",
112                context = "nrf91"
113            ))] {
114            embassy_nrf::pac::NVMC
115                .icachecnf()
116                .write(|w| w.set_cacheen(true));
117        }
118        else if #[cfg(context = "nrf5340-app")] {
119            embassy_nrf::pac::CACHE_S
120                .enable().write(|w| w.set_enable(true));
121        }
122    }
123}