more progress on UART read

c/uart_sim_device.c

@@ -6,6 +6,7 @@
 #include <stdbool.h>
 
 static volatile bool ctrl_c_received = false;
+static char last_char = '\0';
 
 void sigint_handler(int sig_num) {
     ctrl_c_received = true;
@@ -37,8 +38,10 @@ void restore_terminal() {
 }
 
 char get_char_from_terminal() {
-    char c = getchar();
-    return c;
+    if (is_char_available()) {
+        last_char = getchar();  // Update last_char if new character is available
+    }
+    return last_char;  // Return the last available character (or '\0' initially)
 }
 
 void write_char_to_terminal(char chr) {

hs/Bus.hs

@@ -30,6 +30,8 @@ alignCheck addr SizeQuadWord   = addr `mod` 16 == 0
 (ramStart, ramEnd) = (0x80000000 :: Addr, ramStart + (bytesInRam - 1))
 (uartStart, uartEnd) = (0x10000000 :: Addr, uartStart + 7)
 
+-- reading/writing from/to UART is implemented as reading/writing
+-- from/to STDIO, so we need IO.
 read :: Request -> Peripherals -> IO ReadResponse
 read (Request addr size) peripherals
   | not (alignCheck addr size) = return $ ReadResponse $ Error UnAligned
@@ -40,15 +42,3 @@ read (Request addr size) peripherals
       ramAddrNoOffset = addr - ramStart
       ramAddr :: RamAddr
       ramAddr = resize ramAddrNoOffset
-
-  -- | (addr > ramStart) && (addr < ramEnd) = return $ ReadResponse $ Peripherals.Ram.read addr size (ram peripherals)
---   | addr >= numBytesInRam      = ReadError UnMapped
---     case size of
---       SizeByte       -> BusByte $ fromIntegral $ extractByte (ramRead 0)
---       SizeHalfWord   -> BusHalfWord $ fromIntegral $ (ramRead 0 `shiftL` 8) .|. ramRead 1
---       SizeWord       -> BusWord $ fromIntegral $ concatReads [0..3]
---       SizeDoubleWord -> BusDoubleWord $ fromIntegral $ concatReads [0..7]
---       SizeQuadWord   -> BusQuadWord $ fromIntegral $ concatReads [0..15]
---   where
---     ramRead offset = Peripherals.Ram.read (ram peripherals) (fromIntegral (addr + offset))
---     concatReads offsets = foldl (\acc o -> (acc `shiftL` 8) .|. ramRead o) 0 offsets

hs/Fetch.hs

@@ -6,6 +6,11 @@ module Fetch(
   FetchResult(..)) where
 
 import Clash.Prelude
+    ( Eq((==)),
+      KnownNat,
+      Bool(False, True),
+      (!!),
+      Bits(shiftR, (.&.)) )
 import Types(Mem, Addr, Insn)
 import Util(endianSwapWord)
 

hs/Machine.hs

@@ -24,7 +24,7 @@ data PrivilegeLevel
 
 data Peripherals = Peripherals
   {
-      ram :: Ram
+      ram  :: Ram
   }
   deriving (Generic, Show, Eq, NFDataX)
 

hs/Peripherals/Ram.hs

@@ -21,10 +21,7 @@ import qualified Clash.Sized.Vector as Vec
 import Types(Addr,
              Byte, HalfWord, FullWord, DoubleWord, QuadWord)
 import BusTypes(
-    BusError(..),
     TransactionSize(..),
-    Request(..),
-    BusResponse(..),
     BusVal(..),
     ReadResponse(..),
     WriteResponse(..)
@@ -129,6 +126,3 @@ populateVectorFromInt32 ls v = Vec.fromList adjustedLs
     adjustedLs = fromIntegral <$> adjustLength vecLen ls
     adjustLength :: Int -> [Int32] -> [Int32]
     adjustLength n xs = P.take n (xs P.++ P.repeat 0)
-
-
-

hs/Peripherals/Setup.hs

@@ -3,7 +3,7 @@ module Peripherals.Setup (
   ) where
 
 import Prelude
-import Peripherals.UartCFFI(initTerminal, restoreTerminal)
+import Peripherals.UartCFFI(initTerminal)
 import Peripherals.Ram (initRamFromFile, Ram)
 import Control.Exception (try)
 import System.IO.Error (ioeGetErrorString)

hs/Peripherals/Uart.hs

@@ -0,0 +1,61 @@
+module Peripherals.Uart (read) where
+
+import Clash.Prelude hiding (read)
+import Types (Byte)
+import Data.Char (ord)
+
+import Peripherals.UartCFFI (
+    initTerminal,
+    restoreTerminal,
+    getCharFromTerminal,
+    writeCharToTerminal,
+    isCharAvailable,
+    setupSigintHandler,
+    wasCtrlCReceived
+  )
+
+import BusTypes (
+    TransactionSize(..),
+    BusVal(..),
+    ReadResponse(..),
+    WriteResponse(..)
+  )
+
+-- based on a 16550 UART which has an address space of 8 bytes
+type UartAddr = Unsigned 3
+
+-- Receiver Buffer Register address (commonly 0x0 for 16550 UART)
+rbrAddr :: UartAddr
+rbrAddr = 0x0
+
+-- Line Status Register address
+lsrAddr :: UartAddr
+lsrAddr = 0x5
+
+-- Helper function to convert Byte to BusVal based on TransactionSize
+busValFromByte :: TransactionSize -> Byte -> BusVal
+busValFromByte size val = case size of
+  SizeByte       -> BusByte val
+  SizeHalfWord   -> BusHalfWord (resize val)
+  SizeFullWord   -> BusFullWord (resize val)
+  SizeDoubleWord -> BusDoubleWord (resize val)
+  SizeQuadWord   -> BusQuadWord (resize val)
+
+-- Reads a character from the terminal (RBR equivalent)
+buildRBR :: IO Byte
+buildRBR = do
+  c <- getCharFromTerminal
+  return $ fromIntegral (ord c)  -- Convert Char to Byte
+
+-- Reads the Line Status Register (LSR) to check character availability
+buildLSR :: IO Byte
+buildLSR = do
+  char_available <- isCharAvailable
+  return $ fromIntegral char_available
+
+-- Updated 'read' function to handle RBR and LSR reads
+read :: TransactionSize -> UartAddr -> IO BusVal
+read size addr
+  | addr == rbrAddr = busValFromByte size <$> buildRBR
+  | addr == lsrAddr = busValFromByte size <$> buildLSR
+  | otherwise       = return $ busValFromByte size 0x00

hs/Simulation.hs

@@ -8,7 +8,6 @@ module Simulation(Args(..), simulation, Simulation(..)) where
 import qualified Prelude as P
 import Peripherals.Setup(setupPeripherals, InitializedPeripherals(..))
 import Peripherals.Teardown(teardownPeripherals)
-import Text.Printf (printf)
 import Clash.Prelude
 import Machine(
   Machine(..),
@@ -17,12 +16,8 @@ import Machine(
   machineInit, RISCVCPU (RISCVCPU))
 import Fetch(fetchInstruction, FetchResult (Instruction, Misaligned))
 import Isa.Decode(decode)
-import Isa.Forms(Opcode(..))
-import Peripherals.UartCFFI(writeCharToTerminal)
-import Control.Concurrent (threadDelay)
 
 import Debug.Trace
-import Types (Mem, Addr)
 
 data Args = Args {
     firmware :: FilePath
@@ -64,9 +59,6 @@ simulationLoop :: Int -> Machine -> IO [Machine]
 simulationLoop 0 state = return [state]
 simulationLoop n state = do
   let newState = machine' state
-  -- later use this to display writes from machine to its
-  -- uart peripheral
-  -- writeCharToTerminal 'a'
   rest <- simulationLoop (n - 1) newState
   return (state : rest)
 

rv_formal.cabal

@@ -90,6 +90,7 @@ library
     Isa.Decode,
     Isa.Forms,
     Peripherals.Ram,
+    Peripherals.Uart,
     Peripherals.UartCFFI,
     Peripherals.Setup,
     Peripherals.Teardown,