use imxrt_ral as ral;

use ral::{flexio, Valid};

mod dma;
mod driver;
mod flexio_configurator;
mod idle_timer_finished_watcher;
mod interleaved_pixels;
mod interrupt_handler;
mod maybe_own;
mod preprocessed_pixels;

use crate::Pins;

pub use preprocessed_pixels::PreprocessedPixels;

use self::{idle_timer_finished_watcher::IdleTimerFinishedWatcher, maybe_own::MaybeOwn};

/// A WS2812 Neopixel LED Strip driver based on the i.MX RT FlexIO module
pub struct WS2812Driver<const N: u8, const L: usize, PINS: Pins<N, L>>
where
    flexio::Instance<N>: Valid,
{
    _pins: PINS,
    inner: MaybeOwn<InterruptHandlerData<N>>,
}

/// The result of [WS2812Driver::write_dma()][WS2812Driver::write_dma].
pub struct WriteDmaResult<R> {
    /// The result of the concurrent function
    pub result: R,
    /// True if the concurrent function took longer than writing the
    /// data to the LED strips. This might indicate a render lag.
    pub lagged: bool,
}

/// Static memory required by the [`WS2812Driver::take_interrupt_handler`] function.
///
/// For RTIC 2, it is recommended to have this allocated by the `#[init]` macro, like so:
///
/// ```rust
/// #[init(local = [
///     ws2812_data: Option<ws2812_flexio::InterruptHandlerData<2>> = None
/// ])]
/// fn init(cx: init::Context) -> (Shared, Local) {
///     // ...
/// }
/// ```
pub struct InterruptHandlerData<const N: u8> {
    finished_watcher: IdleTimerFinishedWatcher<N>,
}

/// An interrupt handler that signals to the driver
/// that an interrupt happened.
///
/// For correct functionality of [`WS2812Driver::write_dma`] in
/// waker-based async runtimes (like RTIC 2), it is required to invoke the
/// [`InterruptHandler::on_interrupt`] function every time an interrupt
/// of the associated FlexIO peripheral happens.
pub struct InterruptHandler<const N: u8> {
    data: &'static InterruptHandlerData<N>,
}