Struct stm32_hal2::usart::Usart

pub struct Usart<R> {
    pub regs: R,
    /* private fields */
}

Represents the USART peripheral, for serial communications.

Fields

regs: R

Implementations

impl<R> Usart<R>where
    R: Deref<Target = RegisterBlock> + RccPeriph + BaudPeriph,

pub fn new(regs: R, baud: u32, config: UsartConfig, clock_cfg: &Clocks) -> Self

Initialize a U[s]ART peripheral, including configuration register writes, and enabling and resetting its RCC peripheral clock. baud is the baud rate, in bytes-per-second.

pub fn set_baud(&mut self, baud: u32, clock_cfg: &Clocks)

Set the BAUD rate. Called during init, and can be called later to change BAUD during program execution.

pub fn write(&mut self, data: &[u8])

Transmit data, as a sequence of u8. See L44 RM, section 38.5.2: “Character transmission procedure”

pub fn read(&mut self, buf: &mut [u8])

Receive data into a u8 buffer. See L44 RM, section 38.5.3: “Character reception procedure”

pub fn read_one(&mut self) -> u8

Read a single word, without confirming if it’s ready. This is useful in async concepts, when you know word is ready to be read.

pub unsafe fn write_dma<D>(
    &mut self,
    buf: &[u8],
    channel: DmaChannel,
    channel_cfg: ChannelCfg,
    dma: &mut Dma<D>
)where
    D: Deref<Target = RegisterBlock>,

Transmit data using DMA. (L44 RM, section 38.5.15) Note that the channel argument is only used on F3 and L4.

pub unsafe fn read_dma<D>(
    &mut self,
    buf: &mut [u8],
    channel: DmaChannel,
    channel_cfg: ChannelCfg,
    dma: &mut Dma<D>
)where
    D: Deref<Target = RegisterBlock>,

Receive data using DMA. (L44 RM, section 38.5.15; G4 RM section 37.5.19. Note that the channel argument is only used on F3 and L4.

pub fn flush(&self)

Flush the transmit buffer.

pub fn enable_interrupt(&mut self, interrupt: UsartInterrupt)

Enable a specific type of interrupt.

pub fn clear_interrupt(&mut self, interrupt: UsartInterrupt)

Clears the interrupt pending flag for a specific type of interrupt.

Trait Implementations

impl<R> Read<u8> for Usart<R>where
    R: Deref<Target = RegisterBlock> + RccPeriph + BaudPeriph,

type Error = Error

Read error

fn read(&mut self) -> Result<u8, Error>

Reads a single word from the serial interface

impl<R> Write<u8> for Usart<R>where
    R: Deref<Target = RegisterBlock> + RccPeriph + BaudPeriph,

type Error = Error

Write error

fn write(&mut self, word: u8) -> Result<(), Error>

Writes a single word to the serial interface

fn flush(&mut self) -> Result<(), Error>

Ensures that none of the previously written words are still buffered

impl<R> Write<u8> for Usart<R>where
    R: Deref<Target = RegisterBlock> + RccPeriph + BaudPeriph,

type Error = Error

The type of error that can occur when writing

fn bwrite_all(&mut self, buffer: &[u8]) -> Result<(), Error>

Writes a slice, blocking until everything has been written

fn bflush(&mut self) -> Result<(), Error>

Block until the serial interface has sent all buffered words