nrf-hal-common 0.18.0

//! Implementation details of the nRF HAL crates. Don't use this directly, use one of the specific
//! HAL crates instead (`nrfXYZ-hal`).

#![doc(html_root_url = "https://docs.rs/nrf-hal-common/0.18.0")]
#![no_std]

#[cfg(feature = "rtic-monotonic")]
pub mod monotonic;

#[cfg(feature = "51")]
pub use nrf51_pac as pac;

#[cfg(feature = "52805")]
pub use nrf52805_pac as pac;

#[cfg(feature = "52810")]
pub use nrf52810_pac as pac;

#[cfg(feature = "52811")]
pub use nrf52811_pac as pac;

#[cfg(feature = "52832")]
pub use nrf52832_pac as pac;

#[cfg(feature = "52833")]
pub use nrf52833_pac as pac;

#[cfg(feature = "52840")]
pub use nrf52840_pac as pac;

#[cfg(feature = "5340-app")]
pub use nrf5340_app_pac as pac;

#[cfg(feature = "5340-net")]
pub use nrf5340_net_pac as pac;

#[cfg(feature = "9160")]
pub use nrf9160_pac as pac;

#[cfg(feature = "51")]
pub mod adc;
#[cfg(not(any(feature = "9160", feature = "5340-app")))]
pub mod ccm;
pub mod clocks;
#[cfg(not(any(
    feature = "51",
    feature = "52805",
    feature = "9160",
    feature = "5340-app",
    feature = "5340-net"
)))]
pub mod comp;
#[cfg(not(feature = "51"))]
pub mod delay;
#[cfg(not(any(feature = "9160", feature = "5340-app")))]
pub mod ecb;
pub mod gpio;
#[cfg(not(feature = "5340-app"))]
pub mod gpiote;
#[cfg(not(any(
    feature = "51",
    feature = "52805",
    feature = "52810",
    feature = "52811",
    feature = "5340-net"
)))]
pub mod i2s;
#[cfg(any(feature = "52833", feature = "52840"))]
pub mod ieee802154;
#[cfg(not(any(
    feature = "52805",
    feature = "52810",
    feature = "52811",
    feature = "9160",
    feature = "5340-app",
    feature = "5340-net"
)))]
pub mod lpcomp;
#[cfg(not(feature = "51"))]
pub mod nvmc;
#[cfg(not(any(feature = "9160", feature = "5340-app", feature = "5340-net")))]
pub mod ppi;
#[cfg(not(any(feature = "51", feature = "52805", feature = "5340-net")))]
pub mod pwm;
#[cfg(not(any(
    feature = "51",
    feature = "9160",
    feature = "5340-app",
    feature = "5340-net"
)))]
pub mod qdec;
#[cfg(not(any(feature = "9160", feature = "5340-app")))]
pub mod rng;
pub mod rtc;
#[cfg(not(any(feature = "51", feature = "5340-net")))]
pub mod saadc;
#[cfg(not(any(feature = "9160", feature = "5340-app", feature = "5340-net")))]
pub mod spi;
#[cfg(not(feature = "51"))]
pub mod spim;
#[cfg(not(feature = "51"))]
pub mod spis;
#[cfg(not(any(feature = "9160", feature = "5340-app")))]
pub mod temp;
pub mod time;
pub mod timer;
#[cfg(feature = "51")]
pub mod twi;
#[cfg(not(feature = "51"))]
pub mod twim;
#[cfg(not(feature = "51"))]
pub mod twis;
#[cfg(feature = "51")]
pub mod uart;
#[cfg(not(feature = "51"))]
pub mod uarte;
#[cfg(not(any(feature = "9160", feature = "5340-app", feature = "5340-net")))]
pub mod uicr;
#[cfg(feature = "nrf-usbd")]
pub mod usbd;
pub mod wdt;

pub mod prelude {
    #[cfg(not(any(feature = "9160", feature = "5340-app", feature = "5340-net")))]
    pub use crate::ppi::{ConfigurablePpi, Ppi};
    pub use crate::time::U32Ext;
}

/// Length of Nordic EasyDMA differs for MCUs
pub mod target_constants {
    #[cfg(feature = "51")]
    pub const EASY_DMA_SIZE: usize = (1 << 8) - 1;
    #[cfg(feature = "52805")]
    pub const EASY_DMA_SIZE: usize = (1 << 14) - 1;
    #[cfg(feature = "52810")]
    pub const EASY_DMA_SIZE: usize = (1 << 10) - 1;
    #[cfg(feature = "52811")]
    pub const EASY_DMA_SIZE: usize = (1 << 14) - 1;
    #[cfg(feature = "52820")]
    pub const EASY_DMA_SIZE: usize = (1 << 15) - 1;
    #[cfg(feature = "52832")]
    pub const EASY_DMA_SIZE: usize = (1 << 8) - 1;
    #[cfg(feature = "52833")]
    pub const EASY_DMA_SIZE: usize = (1 << 16) - 1;
    #[cfg(feature = "52840")]
    pub const EASY_DMA_SIZE: usize = (1 << 16) - 1;
    #[cfg(any(feature = "5340-app", feature = "5340-net"))]
    pub const EASY_DMA_SIZE: usize = (1 << 16) - 1;
    #[cfg(feature = "9160")]
    pub const EASY_DMA_SIZE: usize = (1 << 12) - 1;

    // Limits for Easy DMA - it can only read from data ram
    pub const SRAM_LOWER: usize = 0x2000_0000;
    pub const SRAM_UPPER: usize = 0x3000_0000;

    #[cfg(any(
        feature = "51",
        feature = "52805",
        feature = "52810",
        feature = "52832"
    ))]
    pub const FORCE_COPY_BUFFER_SIZE: usize = 255;
    #[cfg(not(any(
        feature = "51",
        feature = "52805",
        feature = "52810",
        feature = "52832"
    )))]
    pub const FORCE_COPY_BUFFER_SIZE: usize = 1024;
    const _CHECK_FORCE_COPY_BUFFER_SIZE: usize = EASY_DMA_SIZE - FORCE_COPY_BUFFER_SIZE;
    // ERROR: FORCE_COPY_BUFFER_SIZE must be <= EASY_DMA_SIZE
}

/// Does this slice reside entirely within RAM?
pub(crate) fn slice_in_ram(slice: &[u8]) -> bool {
    let ptr = slice.as_ptr() as usize;
    ptr >= target_constants::SRAM_LOWER && (ptr + slice.len()) < target_constants::SRAM_UPPER
}

/// Return an error if slice is not in RAM.
#[cfg(not(feature = "51"))]
pub(crate) fn slice_in_ram_or<T>(slice: &[u8], err: T) -> Result<(), T> {
    if slice_in_ram(slice) {
        Ok(())
    } else {
        Err(err)
    }
}

/// A handy structure for converting rust slices into ptr and len pairs
/// for use with EasyDMA. Care must be taken to make sure mutability
/// guarantees are respected
#[cfg(not(feature = "51"))]
pub(crate) struct DmaSlice {
    ptr: u32,
    len: u32,
}

#[cfg(not(feature = "51"))]
impl DmaSlice {
    pub fn null() -> Self {
        Self { ptr: 0, len: 0 }
    }

    pub fn from_slice(slice: &[u8]) -> Self {
        Self {
            ptr: slice.as_ptr() as u32,
            len: slice.len() as u32,
        }
    }
}

pub use crate::clocks::Clocks;
#[cfg(not(feature = "51"))]
pub use crate::delay::Delay;
#[cfg(not(any(feature = "9160", feature = "5340-app")))]
pub use crate::rng::Rng;
pub use crate::rtc::Rtc;
pub use crate::timer::Timer;

#[cfg(feature = "51")]
pub use crate::adc::Adc;
#[cfg(not(any(feature = "51", feature = "5340-net")))]
pub use crate::saadc::Saadc;

#[cfg(feature = "51")]
pub use crate::spi::Spi;
#[cfg(not(feature = "51"))]
pub use crate::spim::Spim;

#[cfg(feature = "51")]
pub use crate::twi::Twi;
#[cfg(not(feature = "51"))]
pub use crate::twim::Twim;

#[cfg(feature = "51")]
pub use crate::uart::Uart;
#[cfg(not(feature = "51"))]
pub use crate::uarte::Uarte;