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
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164

// SPDX-License-Identifier: AGPL-3.0-or-later
// Copyright 2020 Branan Riley <me@branan.info>

//! The UART

use super::super::Fe310G002;
use crate::{register::Register, sync::Flag};
use bit_field::BitField;
use core::{marker::PhantomData, sync::atomic::Ordering};

#[repr(C)]
struct UartRegs {
    txdata: Register<u32>,
    rxdata: Register<u32>,
    txctrl: Register<u32>,
    rxctrl: Register<u32>,
    ie: Register<u32>,
    ip: Register<u32>,
    div: Register<u32>,
}

/// A UART
pub struct Uart<M, T, R, const N: usize> {
    regs: &'static mut UartRegs,
    tx: T,
    rx: R,
    mcu: PhantomData<M>,
}

/// A GPIO pin which can be used as a UART tansmit pin
pub trait UartTx<M, const N: usize>: Unpin {}

/// A GPIO pin which can be used as a UART ecieve pin
pub trait UartRx<M, const N: usize>: Unpin {}

static LOCKS: [Flag; 2] = [Flag::new(false), Flag::new(false)];

impl Uart<Fe310G002, (), (), 0> {
    /// Get UART instance 0
    pub fn get() -> Option<Self> {
        unsafe { Self::do_get(0x1001_3000) }
    }
}

impl Uart<Fe310G002, (), (), 1> {
    /// Get UARt instance 1
    pub fn get() -> Option<Self> {
        unsafe { Self::do_get(0x1002_3000) }
    }
}

impl<M, const N: usize> Uart<M, (), (), N> {
    unsafe fn do_get(addr: usize) -> Option<Self> {
        if LOCKS[N].swap(true, Ordering::Acquire) {
            None
        } else {
            Some(Self {
                regs: &mut *(addr as *mut _),
                tx: (),
                rx: (),
                mcu: PhantomData,
            })
        }
    }

    /// Set the UART divisor
    ///
    /// The Uart is clocked at CPU_FREQ/div. If the UART is used as a
    /// reciever, this value must be at least 16.
    pub fn set_divisor(&mut self, div: usize) {
        assert!(div >= 1);
        self.regs.div.write(div as u32 - 1);
    }
}

impl<M, T, const N: usize> Uart<M, T, (), N> {
    /// Enable this UART as a reciever
    pub fn enable_rx<R: UartRx<M, N>>(self, rx: R) -> Uart<M, T, R, N> {
        self.regs.txctrl.update(|rxctrl| {
            rxctrl.set_bit(0, true);
        });
        Uart {
            regs: self.regs,
            tx: self.tx,
            rx,
            mcu: self.mcu,
        }
    }
}

impl<M, R, const N: usize> Uart<M, (), R, N> {
    /// Enable this UART as a transmitter
    pub fn enable_tx<T: UartTx<M, N>>(self, tx: T) -> Uart<M, T, R, N> {
        self.regs.txctrl.update(|txctrl| {
            txctrl.set_bit(0, true);
        });
        Uart {
            regs: self.regs,
            tx,
            rx: self.rx,
            mcu: self.mcu,
        }
    }
}

impl<M, T, R: UartRx<M, N>, const N: usize> Uart<M, T, R, N> {
    /// Read a byte from the UART.
    ///
    /// Retuns `None` if no data is available to be read
    pub fn read_data(&mut self) -> Option<u8> {
        let data = self.regs.rxdata.read();
        if data.get_bit(31) {
            None
        } else {
            Some(data.get_bits(0..8) as u8)
        }
    }

    /// Enable the UART to interrupt the CPU when the recieve FIFO is
    /// above the watermark.
    pub fn enable_rx_intr(&mut self) {
        self.regs.ie.update(|ie| {
            ie.set_bit(1, true);
        });
    }
}

impl<M, T: UartTx<M, N>, R, const N: usize> Uart<M, T, R, N> {
    /// Write a byte to the UART
    ///
    /// Returns `None` if the byte cannot be written
    pub fn write_data(&mut self, data: u8) -> Option<()> {
        if self.regs.txdata.read().get_bit(31) {
            None
        } else {
            self.regs.txdata.write(data as u32);
            Some(())
        }
    }

    /// Enable the UART to interrupt the CPU when the transmit FIFO is
    /// below the watermark.
    pub fn enable_tx_intr(&mut self) {
        self.regs.ie.update(|ie| {
            ie.set_bit(0, true);
        });
    }
}

impl<M, T, R, const N: usize> Uart<M, T, R, N> {
    /// Set the FIFO interrupt watermarks. Both the TX and RX
    /// watermarks must be in the range `0..8`.
    pub fn set_watermarks(&mut self, tx: u32, rx: u32) {
        assert!(tx <= 7);
        assert!(rx <= 7);

        self.regs.txctrl.update(|txctrl| {
            txctrl.set_bits(16..19, tx);
        });
        self.regs.rxctrl.update(|rxctrl| {
            rxctrl.set_bits(16..19, rx);
        });
    }
}