UART peripheral

.devcontainer/Dockerfile

@@ -71,10 +71,10 @@ USER dev
 COPY --from=quartus /opt/quartus /opt/quartus
 ENV PATH="/opt/quartus/quartus/bin:${PATH}"
 
-# install cocotb
+# install cocotb and some other deps (for uart testing)
 USER dev
 RUN sudo apt update && sudo apt install -y python3 python3-pip libpython3-dev && \
-  pip3 install cocotb~=1.9
+  pip3 install cocotb~=1.9 cocotbext-uart pyserial
 
 # install svlint
 USER dev

.gitignore

@@ -1,3 +1,5 @@
+.idea/*
+
 *.vvp
 *.vcd
 
@@ -26,6 +28,10 @@ envs/de1-soc/quartus/*.qws
 envs/de1-soc/quartus/metrics/*
 !envs/de1-soc/quartus/metrics/.gitkeep
 
+cocotb_uart/__pycache__/
+cocotb_uart/sim_build/
+cocotb_uart/results.xml
+
 out/**
 !out/.gitkeep
 build/**

CONTRIBUTORS.md

@@ -22,4 +22,4 @@ Mihir Maringanti
 
 Marwan Ismail (marwannismail)
 
-Tony Zhu (RunzeZhu28)
+Tony Zhu (RunzeZhu28)

Dockerfile.ci

@@ -93,5 +93,10 @@ RUN mkdir -p /tmp/svlint && \
     sudo mv bin/* /usr/local/bin/ && \
     cd .. && rm -r /tmp/svlint
 
+# install cocotb and some other deps (for uart testing)
+USER dev
+RUN sudo apt update && sudo apt install -y python3 python3-pip libpython3-dev && \
+  pip3 install cocotb~=1.9 cocotbext-uart pyserial
+
 # CI needs priviledged access
 USER root

Dockerfile.riscv-toolchain

@@ -1,65 +1,65 @@
-FROM public.ecr.aws/lts/ubuntu:22.04_stable AS builder
-
-ARG DEBIAN_FRONTEND=noninteractive
-ARG KEYRING_PATH=/usr/share/keyrings
-ARG APT_SOURCES_PATH=/etc/apt/sources.list.d
-
-# update and upgrade
-RUN apt update && apt upgrade -y
-
-# install essentialls
-RUN apt update && \
-    apt install -y \
-    man make build-essential git zsh vim curl wget procps gnupg gnupg2 ca-certificates zip \
-    software-properties-common
-
-# unminimize the system
-RUN bash -c "yes | unminimize"
-
-# create dev sudo user
-RUN useradd --create-home dev && \
-    usermod --append --groups sudo dev && \
-    apt update && apt install -y sudo && \
-    echo '%sudo ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers
-
-# build riscv toolchain
-RUN sudo apt-get install -y \
-    autoconf automake autotools-dev curl python3 libmpc-dev libmpfr-dev libgmp-dev gawk \
-    build-essential bison flex texinfo gperf libtool patchutils bc zlib1g-dev libexpat-dev && \
-    cd /tmp && \
-    git clone --recursive https://github.com/riscv/riscv-gnu-toolchain.git && \
-    git clone --recursive https://github.com/riscv/riscv-opcodes.git && \
-    cd riscv-gnu-toolchain && \
-    ./configure --prefix=/opt/riscv --with-arch=rv32i --with-abi=ilp32 && \
-    sudo make
-
-# main image stage
-FROM public.ecr.aws/lts/ubuntu:22.04_stable
-
-ARG DEBIAN_FRONTEND=noninteractive
-ARG KEYRING_PATH=/usr/share/keyrings
-ARG APT_SOURCES_PATH=/etc/apt/sources.list.d
-
-# update and upgrade
-RUN apt update && apt upgrade -y
-
-# install essentialls
-RUN apt update && \
-    apt install -y \
-    man make build-essential git zsh vim curl wget procps gnupg gnupg2 ca-certificates zip \
-    software-properties-common
-
-# unminimize the system
-RUN bash -c "yes | unminimize"
-
-# create dev sudo user
-RUN useradd --create-home dev && \
-    usermod --append --groups sudo dev && \
-    apt update && apt install -y sudo && \
-    echo '%sudo ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers
-
-# get toolchain artifacts from builder stage
-COPY --from=builder /opt/riscv /opt/riscv
-ENV PATH="/opt/riscv/bin:${PATH}"
-
-USER dev
+FROM public.ecr.aws/lts/ubuntu:22.04_stable AS builder
+
+ARG DEBIAN_FRONTEND=noninteractive
+ARG KEYRING_PATH=/usr/share/keyrings
+ARG APT_SOURCES_PATH=/etc/apt/sources.list.d
+
+# update and upgrade
+RUN apt update && apt upgrade -y
+
+# install essentialls
+RUN apt update && \
+    apt install -y \
+    man make build-essential git zsh vim curl wget procps gnupg gnupg2 ca-certificates zip \
+    software-properties-common
+
+# unminimize the system
+RUN bash -c "yes | unminimize"
+
+# create dev sudo user
+RUN useradd --create-home dev && \
+    usermod --append --groups sudo dev && \
+    apt update && apt install -y sudo && \
+    echo '%sudo ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers
+
+# build riscv toolchain
+RUN sudo apt-get install -y \
+    autoconf automake autotools-dev curl python3 libmpc-dev libmpfr-dev libgmp-dev gawk \
+    build-essential bison flex texinfo gperf libtool patchutils bc zlib1g-dev libexpat-dev && \
+    cd /tmp && \
+    git clone --recursive https://github.com/riscv/riscv-gnu-toolchain.git && \
+    git clone --recursive https://github.com/riscv/riscv-opcodes.git && \
+    cd riscv-gnu-toolchain && \
+    ./configure --prefix=/opt/riscv --with-arch=rv32i --with-abi=ilp32 && \
+    sudo make
+
+# main image stage
+FROM public.ecr.aws/lts/ubuntu:22.04_stable
+
+ARG DEBIAN_FRONTEND=noninteractive
+ARG KEYRING_PATH=/usr/share/keyrings
+ARG APT_SOURCES_PATH=/etc/apt/sources.list.d
+
+# update and upgrade
+RUN apt update && apt upgrade -y
+
+# install essentialls
+RUN apt update && \
+    apt install -y \
+    man make build-essential git zsh vim curl wget procps gnupg gnupg2 ca-certificates zip \
+    software-properties-common
+
+# unminimize the system
+RUN bash -c "yes | unminimize"
+
+# create dev sudo user
+RUN useradd --create-home dev && \
+    usermod --append --groups sudo dev && \
+    apt update && apt install -y sudo && \
+    echo '%sudo ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers
+
+# get toolchain artifacts from builder stage
+COPY --from=builder /opt/riscv /opt/riscv
+ENV PATH="/opt/riscv/bin:${PATH}"
+
+USER dev

cocotb_uart/Makefile

@@ -0,0 +1,12 @@
+SIM           = icarus
+TOPLEVEL_LANG = verilog
+VERILOG_SOURCES = \
+	$(PWD)/../src/uart_rx.sv \
+	$(PWD)/../src/uart_tx.sv \
+	$(PWD)/../src/uart.sv \
+	$(PWD)/../src/uart_bus_master.sv \
+	$(PWD)/uart_top.sv
+TOPLEVEL      = uart_top
+MODULE = test_uart_master
+
+include $(shell cocotb-config --makefiles)/Makefile.sim

cocotb_uart/README.md

@@ -0,0 +1,26 @@
+# How to test uart
+
+## Requirements:
+
+Python 3.9+
+cocotb — pip install cocotb
+cocotbext-uart — pip install cocotbext-uart
+Icarus Verilog — brew install icarus-verilog on Mac
+
+In the cocotb_uart/ folder:
+
+## to run all tests:
+
+make SIM=icarus
+
+## to run a single test:
+
+make SIM=icarus COCOTB_TEST_FILTER=test_halt
+
+## What each test does:
+
+test_halt — sends HALT, verifies the DUT asserts hold_core
+test_wr32 — sends HALT then writes a word, verifies correct address and data appear on the bus
+test_load_and_run — full CLI flow: halt, load 20 program words, run. Mirrors cli option 1 in uart_cli.py. Takes ~30 seconds due to real baud-rate timing.
+test_rdreg — reads back a register value through the debug interface
+test_bad_checksum — verifies the DUT rejects a corrupted packet with STATUS_CHK