axi-uartlite 0.1.1

LogiCORE AXI UART Lite v2.0 driver
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

//! # Raw register module

/// RX FIFO register.
#[bitbybit::bitfield(u32)]
pub struct RxFifo {
    /// Data which can be read.
    #[bits(0..=7, r)]
    pub data: u8,
}

/// TX FIFO register.
#[bitbybit::bitfield(u32)]
pub struct TxFifo {
    /// Data to be transmitted.
    #[bits(0..=7, w)]
    pub data: u8,
}

/// Status register.
#[bitbybit::bitfield(u32)]
pub struct Status {
    /// Parity error bit.
    #[bit(7, r)]
    pub parity_error: bool,
    /// Frame error bit.
    #[bit(6, r)]
    pub frame_error: bool,
    /// Overrun error bit.
    #[bit(5, r)]
    pub overrun_error: bool,
    /// Interrupt enabled bit.
    #[bit(4, r)]
    pub intr_enabled: bool,
    /// TX FIFO full.
    #[bit(3, r)]
    pub tx_fifo_full: bool,
    /// TX FIFO empty.
    #[bit(2, r)]
    pub tx_fifo_empty: bool,
    /// RX FIFO full.
    #[bit(1, r)]
    pub rx_fifo_full: bool,
    /// RX FIFO contains valid data.
    #[bit(0, r)]
    pub rx_fifo_valid_data: bool,
}

/// Control register.
#[bitbybit::bitfield(u32, default = 0x0)]
pub struct Control {
    /// Enable interrupt bit.
    #[bit(4, w)]
    enable_interrupt: bool,
    /// Reset RX FIFO.
    #[bit(1, w)]
    reset_rx_fifo: bool,
    /// Reset TX FIFO.
    #[bit(0, w)]
    reset_tx_fifo: bool,
}

/// AXI UARTLITE register block definition.
#[derive(derive_mmio::Mmio)]
#[repr(C)]
pub struct Registers {
    #[mmio(PureRead)]
    rx_fifo: RxFifo,
    tx_fifo: TxFifo,
    #[mmio(PureRead)]
    stat_reg: Status,
    ctrl_reg: Control,
}