Struct gd32vf103xx_hal::serial::Serial

pub struct Serial<USART, TX, RX> { /* fields omitted */ }

Serial abstraction

Implementations

impl<USART: UsartX, TX, RX> Serial<USART, TX, RX>

pub fn new<PINS>(
    usart: USART,
    pins: PINS,
    config: Config,
    afio: &mut Afio,
    rcu: &mut Rcu
) -> Self where
    PINS: Pins<USART, Tx = TX, Rx = RX>, 

Configures the serial interface and creates the interface struct.

pins is a tuple specifying transmit and receive pins. Current mode of these pins does not matter, as they are reconfigured during USART initialization.

config holds UART configuration such as the baud rate of the interface.

The Serial struct takes ownership over the USARTx device registers and the specified PINS

afio and rcu are register handles which are passed for configuration. (afio is used to map the USART to the corresponding pins. rcu is used to reset the USART.)

pub fn listen(&mut self, event: Event)

Starts listening to the USART by enabling the Received data ready to be read (RXNE) interrupt and Transmit data register empty (TXE) interrupt

pub fn unlisten(&mut self, event: Event)

Stops listening to the USART by disabling the Received data ready to be read (RXNE) interrupt and Transmit data register empty (TXE) interrupt

pub fn release(self) -> (USART, TX, RX)

Returns ownership of the borrowed register handles

pub fn split(self) -> (Tx<USART>, Rx<USART>)

Separates the serial struct into separate channel objects for sending (Tx) and receiving (Rx)