wasefire-board-api 0.10.0

// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! UART interface.

use derive_where::derive_where;

use crate::{Error, Id, Support};

/// UART event.
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[derive_where(Debug, PartialEq, Eq)]
pub struct Event<B: crate::Api + ?Sized> {
    /// The UART that triggered the event.
    pub uart: Id<crate::Uart<B>>,

    /// Whether the UART may be ready for read or write.
    pub direction: Direction,
}

/// Whether it might be possible to read or write.
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq, PartialOrd, Ord)]
pub enum Direction {
    /// There might be data to read.
    ///
    /// This is only guaranteed to be triggered after a short read.
    Read,

    /// It might be possible to write data.
    ///
    /// This is only guaranteed to be triggered after a short write.
    Write,
}

impl<B: crate::Api> From<Event<B>> for crate::Event<B> {
    fn from(event: Event<B>) -> Self {
        crate::Event::Uart(event)
    }
}

/// UART interface.
pub trait Api: Support<usize> + Send {
    /// Sets the baudrate of a stopped UART.
    fn set_baudrate(uart: Id<Self>, baudrate: usize) -> Result<(), Error>;

    /// Starts a UART.
    fn start(uart: Id<Self>) -> Result<(), Error>;

    /// Stops a UART.
    fn stop(uart: Id<Self>) -> Result<(), Error>;

    /// Reads from a UART into a buffer.
    ///
    /// Returns the number of bytes read. It could be zero if there's nothing to read.
    fn read(uart: Id<Self>, output: &mut [u8]) -> Result<usize, Error>;

    /// Writes from a buffer to a UART.
    ///
    /// Returns the number of bytes written. It could be zero if the other side is not ready.
    fn write(uart: Id<Self>, input: &[u8]) -> Result<usize, Error>;

    /// Enables a given event to be triggered.
    fn enable(uart: Id<Self>, direction: Direction) -> Result<(), Error>;

    /// Disables a given event from being triggered.
    fn disable(uart: Id<Self>, direction: Direction) -> Result<(), Error>;
}