[−][src]Struct gd32vf103xx_hal::serial::Serial
Serial abstraction
Methods
impl<PINS> Serial<USART0, PINS>
[src]
USART0 functions
The behaviour of the functions is equal for all three USARTs. Except that they are using the corresponding USART hardware and pins.
pub fn usart0(usart: USART0, pins: PINS, config: Config, clocks: Clocks) -> Self where
PINS: Pins<USART0>,
[src]
PINS: Pins<USART0>,
Configures the serial interface and creates the interface struct.
Bps
is the baud rate of the interface.
Clocks
passes information about the current frequencies of
the clocks. The existence of the struct ensures that the
clock settings are fixed.
The serial
struct takes ownership over the USARTX
device
registers and the specified PINS
MAPR
and APBX
are register handles which are passed for
configuration. (MAPR
is used to map the USART to the
corresponding pins. APBX
is used to reset the USART.)
pub fn listen(&mut self, event: Event)
[src]
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)
[src]
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) -> (USART0, PINS)
[src]
Returns ownership of the borrowed register handles
pub fn split(self) -> (Tx<USART0>, Rx<USART0>)
[src]
Separates the serial struct into separate channel objects for sending (Tx) and receiving (Rx)
impl<PINS> Serial<USART1, PINS>
[src]
USART1 functions
The behaviour of the functions is equal for all three USARTs. Except that they are using the corresponding USART hardware and pins.
pub fn usart1(usart: USART1, pins: PINS, config: Config, clocks: Clocks) -> Self where
PINS: Pins<USART1>,
[src]
PINS: Pins<USART1>,
Configures the serial interface and creates the interface struct.
Bps
is the baud rate of the interface.
Clocks
passes information about the current frequencies of
the clocks. The existence of the struct ensures that the
clock settings are fixed.
The serial
struct takes ownership over the USARTX
device
registers and the specified PINS
MAPR
and APBX
are register handles which are passed for
configuration. (MAPR
is used to map the USART to the
corresponding pins. APBX
is used to reset the USART.)
pub fn listen(&mut self, event: Event)
[src]
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)
[src]
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) -> (USART1, PINS)
[src]
Returns ownership of the borrowed register handles
pub fn split(self) -> (Tx<USART1>, Rx<USART1>)
[src]
Separates the serial struct into separate channel objects for sending (Tx) and receiving (Rx)
impl<PINS> Serial<USART2, PINS>
[src]
USART2 functions
The behaviour of the functions is equal for all three USARTs. Except that they are using the corresponding USART hardware and pins.
pub fn usart2(usart: USART2, pins: PINS, config: Config, clocks: Clocks) -> Self where
PINS: Pins<USART2>,
[src]
PINS: Pins<USART2>,
Configures the serial interface and creates the interface struct.
Bps
is the baud rate of the interface.
Clocks
passes information about the current frequencies of
the clocks. The existence of the struct ensures that the
clock settings are fixed.
The serial
struct takes ownership over the USARTX
device
registers and the specified PINS
MAPR
and APBX
are register handles which are passed for
configuration. (MAPR
is used to map the USART to the
corresponding pins. APBX
is used to reset the USART.)
pub fn listen(&mut self, event: Event)
[src]
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)
[src]
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) -> (USART2, PINS)
[src]
Returns ownership of the borrowed register handles
pub fn split(self) -> (Tx<USART2>, Rx<USART2>)
[src]
Separates the serial struct into separate channel objects for sending (Tx) and receiving (Rx)
Auto Trait Implementations
impl<USART, PINS> Unpin for Serial<USART, PINS> where
PINS: Unpin,
USART: Unpin,
PINS: Unpin,
USART: Unpin,
impl<USART, PINS> Send for Serial<USART, PINS> where
PINS: Send,
USART: Send,
PINS: Send,
USART: Send,
impl<USART, PINS> Sync for Serial<USART, PINS> where
PINS: Sync,
USART: Sync,
PINS: Sync,
USART: Sync,
Blanket Implementations
impl<T> From<T> for T
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = !
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,