Struct cntrlr::hw::mcu::kinetis::peripheral::uart::Uart

pub struct Uart<M, T, R, const N: usize> { /* fields omitted */ }

The handle to a UART

Implementations

impl<M, const N: usize> Uart<M, (), (), N>

pub fn set_divisor(&mut self, divisor: usize)

Set the Uart divisor.

The UART divider has 13 regular bits and 5 fractional bits, for a total of 18 bits. Bits above bit 17 will be ignored.

The final baud rate is 1/16th the rate selected by the divider

impl<M, R, const N: usize> Uart<M, (), R, N>

pub fn enable_tx<T>(self, tx: T) -> Uart<M, T, R, N> where
    T: UartTx<M, N>, 

Enable this UART for transmitting.

Once enabled for transmit, the baud rate and wire format cannot be changed.

impl<M, T, const N: usize> Uart<M, T, (), N>

pub fn enable_rx<R>(self, rx: R) -> Uart<M, T, R, N> where
    R: UartRx<M, N>, 

Enable this UART for recieving.

Once enabled for recieve, the baud rate and wire format cannot be changed.

impl<M, T, R: UartRx<M, N>, const N: usize> Uart<M, T, R, N>

pub fn read_data(&mut self) -> Option<u8>

Read a byte from the UART.

Returns None if there is no data to be read.

pub fn enable_rx_intr(&mut self)

Enable the UART to interupt when a byte is recieved.

pub fn disable_rx(self) -> (Uart<M, T, (), N>, R)

Disable this UART for recieving.

impl<M, T: UartTx<M, N>, R, const N: usize> Uart<M, T, R, N>

pub fn write_data(&mut self, data: u8) -> Option<()>

Send a byte to the UART.

If the UART is not ready, behavior is unspecified.

pub fn is_transmit_complete(&self) -> bool

Check if the UART has transmitted all bytes in the FIFO

pub fn enable_tx_intr(&mut self)

Enable the UART to interrupt when it is ready to transmit a byte.

pub fn enable_complete_intr(&mut self)

Enable the UART to interrupt when it has completed trasmitting all buffered bytes

pub fn disable_tx(self) -> (Uart<M, (), R, N>, T)

Disable this uart for transmitting

impl<M, T, R, const N: usize> Uart<M, T, R, N> where
    Uart<M, T, R, N>: Fifo, 

pub fn enable_tx_fifo(&mut self, depth: u8, watermark: u8)

Enable the transmit FIFO and set its watermark

See the chip documentation for valid values.

pub fn enable_rx_fifo(&mut self, depth: u8, watermark: u8)

Enable the recieve FIFO and set its watermark

See the chip documentation for valid values.

Trait Implementations

impl<T, R> Fifo for Uart<Mk20Dx128, T, R, 0>

pub const DEPTH: u8

The maximum FIFO depth for this UART instance.

impl<T, R> Fifo for Uart<Mk20Dx128, T, R, 1>

pub const DEPTH: u8

The maximum FIFO depth for this UART instance.

impl<T, R> Fifo for Uart<Mk64Fx512, T, R, 4>

pub const DEPTH: u8

The maximum FIFO depth for this UART instance.

impl<T, R> Fifo for Uart<Mk64Fx512, T, R, 5>

pub const DEPTH: u8

The maximum FIFO depth for this UART instance.

impl<T, R> Fifo for Uart<Mk66Fx1M0, T, R, 0>

pub const DEPTH: u8

The maximum FIFO depth for this UART instance.

impl<T, R> Fifo for Uart<Mk66Fx1M0, T, R, 1>

pub const DEPTH: u8

The maximum FIFO depth for this UART instance.

impl<T, R> Fifo for Uart<Mk66Fx1M0, T, R, 2>

pub const DEPTH: u8

The maximum FIFO depth for this UART instance.

impl<T, R> Fifo for Uart<Mk66Fx1M0, T, R, 3>

pub const DEPTH: u8

The maximum FIFO depth for this UART instance.

impl<T, R> Fifo for Uart<Mk66Fx1M0, T, R, 4>

pub const DEPTH: u8

The maximum FIFO depth for this UART instance.

impl<T, R> Fifo for Uart<Mk20Dx128, T, R, 2>

pub const DEPTH: u8

The maximum FIFO depth for this UART instance.

impl<T, R> Fifo for Uart<Mk20Dx256, T, R, 0>

pub const DEPTH: u8

The maximum FIFO depth for this UART instance.

impl<T, R> Fifo for Uart<Mk20Dx256, T, R, 1>

pub const DEPTH: u8

The maximum FIFO depth for this UART instance.

impl<T, R> Fifo for Uart<Mk20Dx256, T, R, 2>

pub const DEPTH: u8

The maximum FIFO depth for this UART instance.

impl<T, R> Fifo for Uart<Mk64Fx512, T, R, 0>

pub const DEPTH: u8

The maximum FIFO depth for this UART instance.

impl<T, R> Fifo for Uart<Mk64Fx512, T, R, 1>

pub const DEPTH: u8

The maximum FIFO depth for this UART instance.

impl<T, R> Fifo for Uart<Mk64Fx512, T, R, 2>

pub const DEPTH: u8

The maximum FIFO depth for this UART instance.

impl<T, R> Fifo for Uart<Mk64Fx512, T, R, 3>

pub const DEPTH: u8

The maximum FIFO depth for this UART instance.

impl Peripheral<Mk20Dx128> for Uart<Mk20Dx128, (), (), 0>

pub const GATE: (usize, usize)

The clock gate that controls this peripheral

pub unsafe fn new(gate: Gate) -> Self

Get the instance of this peripheral, gated by gate.

impl Peripheral<Mk20Dx128> for Uart<Mk20Dx128, (), (), 1>

pub const GATE: (usize, usize)

The clock gate that controls this peripheral

pub unsafe fn new(gate: Gate) -> Self

Get the instance of this peripheral, gated by gate.

impl Peripheral<Mk20Dx128> for Uart<Mk20Dx128, (), (), 2>

pub const GATE: (usize, usize)

The clock gate that controls this peripheral

pub unsafe fn new(gate: Gate) -> Self

Get the instance of this peripheral, gated by gate.

impl Peripheral<Mk20Dx256> for Uart<Mk20Dx256, (), (), 0>

pub const GATE: (usize, usize)

The clock gate that controls this peripheral

pub unsafe fn new(gate: Gate) -> Self

Get the instance of this peripheral, gated by gate.

impl Peripheral<Mk20Dx256> for Uart<Mk20Dx256, (), (), 1>

pub const GATE: (usize, usize)

The clock gate that controls this peripheral

pub unsafe fn new(gate: Gate) -> Self

Get the instance of this peripheral, gated by gate.

impl Peripheral<Mk20Dx256> for Uart<Mk20Dx256, (), (), 2>

pub const GATE: (usize, usize)

The clock gate that controls this peripheral

pub unsafe fn new(gate: Gate) -> Self

Get the instance of this peripheral, gated by gate.

impl Peripheral<Mk64Fx512> for Uart<Mk64Fx512, (), (), 0>

pub const GATE: (usize, usize)

The clock gate that controls this peripheral

pub unsafe fn new(gate: Gate) -> Self

Get the instance of this peripheral, gated by gate.

impl Peripheral<Mk64Fx512> for Uart<Mk64Fx512, (), (), 1>

pub const GATE: (usize, usize)

The clock gate that controls this peripheral

pub unsafe fn new(gate: Gate) -> Self

Get the instance of this peripheral, gated by gate.

impl Peripheral<Mk64Fx512> for Uart<Mk64Fx512, (), (), 2>

pub const GATE: (usize, usize)

The clock gate that controls this peripheral

pub unsafe fn new(gate: Gate) -> Self

Get the instance of this peripheral, gated by gate.

impl Peripheral<Mk64Fx512> for Uart<Mk64Fx512, (), (), 3>

pub const GATE: (usize, usize)

The clock gate that controls this peripheral

pub unsafe fn new(gate: Gate) -> Self

Get the instance of this peripheral, gated by gate.

impl Peripheral<Mk64Fx512> for Uart<Mk64Fx512, (), (), 4>

pub const GATE: (usize, usize)

The clock gate that controls this peripheral

pub unsafe fn new(gate: Gate) -> Self

Get the instance of this peripheral, gated by gate.

impl Peripheral<Mk64Fx512> for Uart<Mk64Fx512, (), (), 5>

pub const GATE: (usize, usize)

The clock gate that controls this peripheral

pub unsafe fn new(gate: Gate) -> Self

Get the instance of this peripheral, gated by gate.

impl Peripheral<Mk66Fx1M0> for Uart<Mk66Fx1M0, (), (), 0>

pub const GATE: (usize, usize)

The clock gate that controls this peripheral

pub unsafe fn new(gate: Gate) -> Self

Get the instance of this peripheral, gated by gate.

impl Peripheral<Mk66Fx1M0> for Uart<Mk66Fx1M0, (), (), 1>

pub const GATE: (usize, usize)

The clock gate that controls this peripheral

pub unsafe fn new(gate: Gate) -> Self

Get the instance of this peripheral, gated by gate.

impl Peripheral<Mk66Fx1M0> for Uart<Mk66Fx1M0, (), (), 2>

pub const GATE: (usize, usize)

The clock gate that controls this peripheral

pub unsafe fn new(gate: Gate) -> Self

Get the instance of this peripheral, gated by gate.

impl Peripheral<Mk66Fx1M0> for Uart<Mk66Fx1M0, (), (), 3>

pub const GATE: (usize, usize)

The clock gate that controls this peripheral

pub unsafe fn new(gate: Gate) -> Self

Get the instance of this peripheral, gated by gate.

impl Peripheral<Mk66Fx1M0> for Uart<Mk66Fx1M0, (), (), 4>

pub const GATE: (usize, usize)

The clock gate that controls this peripheral

pub unsafe fn new(gate: Gate) -> Self

Get the instance of this peripheral, gated by gate.

impl Peripheral<Mkl26Z64> for Uart<Mkl26Z64, (), (), 0>

pub const GATE: (usize, usize)

The clock gate that controls this peripheral

pub unsafe fn new(gate: Gate) -> Self

Get the instance of this peripheral, gated by gate.

impl Peripheral<Mkl26Z64> for Uart<Mkl26Z64, (), (), 1>

pub const GATE: (usize, usize)

The clock gate that controls this peripheral

pub unsafe fn new(gate: Gate) -> Self

Get the instance of this peripheral, gated by gate.

impl Peripheral<Mkl26Z64> for Uart<Mkl26Z64, (), (), 2>

pub const GATE: (usize, usize)

The clock gate that controls this peripheral

pub unsafe fn new(gate: Gate) -> Self

Get the instance of this peripheral, gated by gate.