starting uart and refactoring

src/lib/board.rs

@@ -1,18 +1,64 @@
-use crate::gpio::ports::{setup_gpio_port, Port, PortOptions, UsablePort};
+//! Data sheet: https://www.ti.com/lit/ds/spms376e/spms376e.pdf
 
-pub struct UsableBoard;
-impl UsableBoard {
-    pub fn setup_gpio_port(&mut self, port: Port, options: PortOptions) -> UsablePort {
-        setup_gpio_port(port, options)
+use core::arch::asm;
+
+use crate::gpio::ports::{
+    setup_port as setup_gpio_port, GPIOPortOptions, Port as GPIOPort, UsablePort as UsableGPIOPort,
+};
+use crate::uart::{
+    setup_port as setup_uart_port, Port as UARTPort, PortOptions as UARTPortOptions,
+    UsablePort as UsableUARTPort,
+};
+
+/// The board
+///
+/// Houses memory addresses of registers
+#[derive(Clone, Copy)]
+pub struct Board;
+
+impl Board {
+    /// Page 231 of data sheet
+    const fn base(&self) -> u32 {
+        0x400F_E000
     }
 
-    // TODO: have a no_op function here if so desired
+    /// The memory address of the GPIO Run mode clock gating control (RCGCGPIO) register for this port
+    ///
+    /// Page 340 of data sheet
+    pub(crate) const fn gpio_run_mode_clock_gate_control(&self) -> *mut u32 {
+        const OFFSET: u32 = 0x608;
+        (self.base() + OFFSET) as *mut u32
+    }
 
-    // TODO: check page 704 for timers
-    // TODO: impl Drop trait so that tasks all run before the main function ends?
-    // TODO: examine page 670 for when (if) I do interrupts
+    pub(crate) const fn run_mode_clock_gate_control_1(&self) -> *mut u32 {
+        const OFFSET: u32 = 0x104;
+        (self.base() + OFFSET) as *mut u32
+    }
+}
+
+/// A setup version of the board that GPIO and UART ports (TODO: say more features when I make those) can be set up on
+pub struct UsableBoard {
+    board: Board,
+}
+
+impl UsableBoard {
+    fn no_op(&self) {
+        unsafe {
+            asm!("nop");
+        }
+    }
+}
+
+impl UsableBoard {
+    pub fn setup_gpio_port(&mut self, port: GPIOPort, options: GPIOPortOptions) -> UsableGPIOPort {
+        setup_gpio_port(self.board, port, options)
+    }
+
+    pub fn setup_uart_port(&mut self, port: UARTPort, options: UARTPortOptions) -> UsableUARTPort {
+        setup_uart_port(self.board, port, options, &|| self.no_op())
+    }
 }
 
 pub fn setup_board() -> UsableBoard {
-    UsableBoard
+    UsableBoard { board: Board }
 }