Verilator devel

.gitignore

@@ -26,7 +26,8 @@ hardware/src/system.v
 hardware/testbench/system_tb.v
 
 #simulation
-hardware/simulation/*/*
+hardware/simulation/*
+!hardware/simulation/verilog_tb
 !hardware/simulation/simulation.mk
 !hardware/simulation/*/Makefile
 !hardware/simulation/*/test.expected
@@ -49,6 +50,7 @@ hardware/fpga/*/*/*
 hardware/asic/*/*
 !hardware/asic/asic.mk
 !hardware/asic/*/Makefile
+!hardware/asic/*/*.tcl
 !hardware/asic/*/*.sh
 !hardware/asic/*/verilog
 !hardware/asic/*/synscript.tcl

.gitmodules

@@ -1,12 +1,15 @@
 [submodule "submodules/UART"]
 	path = submodules/UART
 	url = [email protected]:IObundle/iob-uart.git
-[submodule "submodules/CPU"]
-	path = submodules/CPU
-	url = [email protected]:IObundle/iob-picorv32.git
 [submodule "submodules/CACHE"]
 	path = submodules/CACHE
 	url = [email protected]:IObundle/iob-cache.git
+[submodule "submodules/PICORV32"]
+	path = submodules/PICORV32
+	url = [email protected]:IObundle/iob-picorv32.git
+[submodule "submodules/AXI"]
+	path = submodules/AXI
+	url = [email protected]:IObundle/iob-axi.git
 [submodule "submodules/MEM"]
 	path = submodules/MEM
 	url = [email protected]:IObundle/iob-mem.git

Makefile

@@ -13,10 +13,8 @@ include ./config.mk
 	test-doc test-doc-clean\
 	test test-clean\
 	clean clean-all\
-	corename
+	debug
 
-corename:
-	@echo "IOb-SoC"
 #
 # SIMULATE RTL
 #
@@ -124,9 +122,11 @@ test-fpga-clean:
 
 test-asic:
 	make asic-test ASIC_NODE=umc130
+	make asic-test ASIC_NODE=skywater
 
 test-asic-clean:
 	make asic-clean ASIC_NODE=umc130
+	make asic-clean ASIC_NODE=skywater
 
 test-doc:
 	make fpga-clean-all
@@ -152,3 +152,8 @@ clean:
 	make doc-clean
 
 clean-all: test-clean
+
+
+debug:
+	@echo $(UART_DIR)
+	@echo $(CACHE_DIR)

README.md

@@ -48,17 +48,18 @@ hopefully, each variable is explained by a comment.
 The various simulators, FPGA compilers and FPGA boards may run locally or
 remotely. For running a tool remotely, you need to set two environmental
 variables: the server logical name and the server user name. Consider placing
-these settings in your .bashrc file, so that they apply to every session.
+these settings in your `.bashrc` file, so that they apply to every session.
 
 
 ### Set up the remote simulator server
 
 Using open-source simulator Icarus Verilog as an example, note that in
 `hardware/simulation/icarus/Makefile`, the variable for the server logical name,
-SIM\_SERVER, is set to IVSIM\_SERVER, and the variable for the user name,
-SIM\_USER, is set to IVSIM_USER. If you do not set these variables the simulator
-will run locally. To run the simulator on server *mysimserver.myorg.com* as
-user *ivsimuser*, set the following environmental variables beforehand:
+`SIM\_SERVER`, is set to `IVSIM\_SERVER`, and the variable for the user name,
+`SIM\_USER`, is set to `IVSIM_USER`. If you do not set these variables the 
+simulator will run locally. To run the simulator on server 
+*mysimserver.myorg.com* as user *ivsimuser*, set the following environmental 
+variables beforehand:
 
 ```
 export IVSIM_SERVER=ivsimserver.myorg.com
@@ -69,11 +70,11 @@ export IVSIM_USER=ivsimuser
 
 Using the CYCLONEV-GT-DK board as an example, note that in
 `hardware/fpga/quartus/CYCLONEV-GT-DK/Makefile` the variable for the FPGA tool
-server logical name, FPGA\_SERVER, is set to QUARTUS\_SERVER, and the variable
-for the user name, FPGA\_USER, is set to QUARTUS\_USER; the variable for the
-board server, BOARD\_SERVER, is set to CYC5\_SERVER, and the variable for the
-board user, BOARD\_USER, is set to CYC5_USER. As in the previous example, set
-these variables as follows:
+server logical name, `FPGA\_SERVER`, is set to `QUARTUS\_SERVER`, and the 
+variable for the user name, `FPGA\_USER`, is set to `QUARTUS\_USER`; the 
+variable for the board server, `BOARD\_SERVER`, is set to `CYC5\_SERVER`, and 
+the variable for the board user, `BOARD\_USER`, is set to `CYC5_USER`. As in the 
+previous example, set these variables as follows:
 
 ```
 export QUARTUS_SERVER=quartusserver.myorg.com
@@ -85,9 +86,9 @@ export CYC5_USER=cyc5username
 ### Set up the remote ASIC toolchain server
 
 For example, in `hardware/asic/umc130/Makefile`, the variable for the server
-logical name, ASIC\_SERVER, is set to CADENCE\_SERVER, and the variable for the
-user name ASIC\_USER is set to CADENCE\_USER. Hence, you need to set the latter
-variables as in the following example:
+logical name, `ASIC\_SERVER`, is set to `CADENCE\_SERVER`, and the variable for 
+the user name `ASIC\_USER` is set to `CADENCE\_USER`. Hence, you need to set the 
+latter variables as in the following example:
 
 ```
 export CADENCE_SERVER=cadenceserver.myorg.com
@@ -133,9 +134,10 @@ make sim-clean [SIMULATOR=<simulator directory name>]
 For more details, read the Makefile in each simulator directory. The Makefile
 includes the Makefile segment `simulation.mk`, which contains statements that
 apply to any simulator. In turn, `simulation.mk` includes the Makefile segment
-`config.mk`, which contains main system parameters. The Makefile in the
-simulator's directory, with the segments recursively included as described, is
-construed as a single large Makefile.
+`hardware.mk`, which contains targets common to all hardware tools. The 
+`hardware.mk` includes `config.mk`,  which contains main system parameters. The
+Makefile in the simulator's directory, with the segments recursively included as
+described, is construed as a single large Makefile.
 
 ## Emulate the system on PC 
 
@@ -190,13 +192,13 @@ make fpga-run [BOARD=<board directory name>] [<control parameters>]
 The FPGA is loaded with the configuration bitstream before running. However,
 this step is skipped if the bitstream checksum matches that of the last loaded
 bitstream, kept in file `/tmp/<board directory name>.load`. If, for some reason,
-the run gets stuck, you may interrupt it with Ctr-C. Then, you may try again
-forcing the bitstream to be reloaded using control parameter FORCE=1.
+the run gets stuck, you may interrupt it with `Ctr-C`. Then, you may try again
+forcing the bitstream to be reloaded using control parameter `FORCE=1`.
 
 If many users are trying to run the same FPGA board they will be queued in file
 `/tmp/<board directory name>.queue`. Users will orderly load their bitstream
-onto the board and start running it. After a successful run or Ctr-C interrupt,
-the user is de-queued.
+onto the board and start running it. After a successful run or `Ctr-C` 
+interrupt, the user is de-queued.
 
 
 To clean the FPGA compilation generated files, type
@@ -208,7 +210,7 @@ make fpga-clean [BOARD=<board directory name>]
 
 To compile documents, the LaTeX document preparation software must be
 installed. Each document that can be compiled has a build directory under the
-`document`directory. Currently there are two document build directories:
+`document` directory. Currently there are two document build directories:
 `presentation` and `pb` (product brief). The document to build is specified by
 the DOC control parameter. To compile the document, type:
 ```
@@ -242,7 +244,7 @@ resides in the same directory; if they differ, the test fails; otherwise, it
 passes.
 
 To run the series of simulation tests on all the simulators listed in the
-SIM\_LIST variable, type:
+`SIM\_LIST` variable, type:
 
 ```
 make test-all-simulators [SIM_LIST="<simulator directory list>"]
@@ -260,7 +262,7 @@ make clean-all-simulators
 
 ### Board test
 
-To compile and run a series of board tests on the board selected by the BOARD
+To compile and run a series of board tests on the board selected by the `BOARD`
 variable, type:
 
 ```
@@ -272,7 +274,7 @@ directory. The `test.log` file is compared with the `test.expected` file, which
 resides in the same directory; if they differ, the test fails; otherwise, it
 passes.
 
-To run the series of board tests on all the boards listed in the BOARD\_LIST
+To run the series of board tests on all the boards listed in the `BOARD\_LIST`
 variable, type:
 
 ```
@@ -289,7 +291,7 @@ make clean-all-boards
 ### ASIC test
 
 To compile and run a series of ASIC tests on the ASIC technology node selected
-by the ASIC\_NODE variable, type:
+by the `ASIC\_NODE` variable, type:
 
 ```
 make test-asic [ASIC_NODE=<ASIC technology node directory name>]
@@ -300,7 +302,7 @@ is compared to file `hardware/asic/<ASIC technology node name>/test.expected`;
 if they differ, the test is aborted.
 
 To run the series of ASIC tests on all the ASIC technology nodes listed in the
-ASIC\_NODE\_LIST variable, type:
+`ASIC\_NODE\_LIST` variable, type:
 
 ```
 make test-all-asics [ASIC_NODE_LIST="<ASIC technology node directory name list>"]
@@ -315,7 +317,7 @@ make clean-all-asics
 
 ### Documentation test
 
-To compile and test the document selected by the DOC, variable, type:
+To compile and test the document selected by the `DOC`, variable, type:
 
 ```
 make test-doc [DOC=<document directory name>]
@@ -324,7 +326,7 @@ make test-doc [DOC=<document directory name>]
 The resulting Latex .aux file is compared with a known-good .aux file. If the
 match the test passes; otherwise it fails.
 
-To test all documents listed in the DOC\_LIST variable, type:
+To test all documents listed in the `DOC\_LIST` variable, type:
 
 ```
 make test-all-docs [DOC_LIST="<document directory name list>"]
@@ -389,5 +391,5 @@ This will take a while. After it is done, type:
 export PATH=$PATH:/path/to/riscv/bin
 ```
 
-The above command should be added to your ~/.bashrc file, so that
+The above command should be added to your `~/.bashrc` file, so that
 you do not have to type it on every session.

config.mk

@@ -4,6 +4,8 @@
 #
 ######################################################################
 
+IOBSOC_NAME:=IOBSOC
+
 #
 # PRIMARY PARAMETERS: CAN BE CHANGED BY USERS OR OVERRIDEN BY ENV VARS
 #
@@ -62,6 +64,8 @@ ASIC_NODE ?=umc130
 #default document to compile
 DOC ?= pb
 
+#IOB LIBRARY
+UART_HW_DIR:=$(UART_DIR)/hardware
 
 ####################################################################
 # DERIVED FROM PRIMARY PARAMETERS: DO NOT CHANGE BELOW THIS POINT
@@ -81,6 +85,14 @@ ifeq ($(INIT_MEM),1)
 DEFINE+=$(defmacro)INIT_MEM
 endif
 
+#submodule paths
+PICORV32_DIR=$(ROOT_DIR)/submodules/PICORV32
+CACHE_DIR=$(ROOT_DIR)/submodules/CACHE
+UART_DIR=$(ROOT_DIR)/submodules/UART
+LIB_DIR=$(ROOT_DIR)/submodules/LIB
+MEM_DIR=$(ROOT_DIR)/submodules/MEM
+AXI_DIR=$(ROOT_DIR)/submodules/AXI
+
 #sw paths
 SW_DIR:=$(ROOT_DIR)/software
 PC_DIR:=$(SW_DIR)/pc-emul
@@ -96,22 +108,13 @@ BOARD_DIR ?=$(shell find hardware -name $(BOARD))
 
 #doc paths
 DOC_DIR=$(ROOT_DIR)/document/$(DOC)
-TEX_DIR=$(UART_DIR)/submodules/TEX
-INTERCON_DIR=$(UART_DIR)/submodules/INTERCON
-
-#submodule paths
-SUBMODULES_DIR=$(ROOT_DIR)/submodules
-SUBMODULES=
-SUBMODULE_DIRS=$(shell ls $(SUBMODULES_DIR))
-$(foreach d, $(SUBMODULE_DIRS), $(eval TMP=$(shell make -C $(SUBMODULES_DIR)/$d corename | grep -v make)) $(eval SUBMODULES+=$(TMP)) $(eval $(TMP)_DIR ?=$(SUBMODULES_DIR)/$d))
 
 #define macros
 DEFINE+=$(defmacro)BOOTROM_ADDR_W=$(BOOTROM_ADDR_W)
 DEFINE+=$(defmacro)SRAM_ADDR_W=$(SRAM_ADDR_W)
 DEFINE+=$(defmacro)FIRM_ADDR_W=$(FIRM_ADDR_W)
 DEFINE+=$(defmacro)DCACHE_ADDR_W=$(DCACHE_ADDR_W)
-
-DEFINE+=$(defmacro)N_SLAVES=$(N_SLAVES)
+DEFINE+=$(defmacro)N_SLAVES=$(N_SLAVES) #peripherals
 
 #address selection bits
 E:=31 #extra memory bit
@@ -127,8 +130,10 @@ DEFINE+=$(defmacro)E=$E
 DEFINE+=$(defmacro)P=$P
 DEFINE+=$(defmacro)B=$B
 
-N_SLAVES:=0
+#PERIPHERAL IDs
 #assign sequential numbers to peripheral names used as variables
+#that define their base address in the software and instance name in the hardware
+N_SLAVES:=0
 $(foreach p, $(PERIPHERALS), $(eval $p=$(N_SLAVES)) $(eval N_SLAVES:=$(shell expr $(N_SLAVES) \+ 1)))
 $(foreach p, $(PERIPHERALS), $(eval DEFINE+=$(defmacro)$p=$($p)))
 

document/document.mk

@@ -12,7 +12,7 @@ CORE_DIR:=$(ROOT_DIR)
 BDTAB=0
 SWREGS=0
 
-include $(TEX_DIR)/document/document.mk
+include $(LIB_DIR)/document/document.mk
 
 
 test: clean all

document/presentation/presentation.expected

@@ -43,8 +43,10 @@
 \@writefile{nav}{\defcounter {refsection}{0}\relax }\@writefile{nav}{\headcommand {\beamer@framepages {9}{9}}}
 \@writefile{nav}{\defcounter {refsection}{0}\relax }\@writefile{nav}{\headcommand {\slideentry {0}{0}{10}{10/10}{}{0}}}
 \@writefile{nav}{\defcounter {refsection}{0}\relax }\@writefile{nav}{\headcommand {\beamer@framepages {10}{10}}}
-\@writefile{nav}{\headcommand {\beamer@partpages {1}{10}}}
-\@writefile{nav}{\headcommand {\beamer@subsectionpages {1}{10}}}
-\@writefile{nav}{\headcommand {\beamer@sectionpages {1}{10}}}
-\@writefile{nav}{\headcommand {\beamer@documentpages {10}}}
-\@writefile{nav}{\headcommand {\gdef \inserttotalframenumber {10}}}
+\@writefile{nav}{\defcounter {refsection}{0}\relax }\@writefile{nav}{\headcommand {\slideentry {0}{0}{11}{11/11}{}{0}}}
+\@writefile{nav}{\defcounter {refsection}{0}\relax }\@writefile{nav}{\headcommand {\beamer@framepages {11}{11}}}
+\@writefile{nav}{\headcommand {\beamer@partpages {1}{11}}}
+\@writefile{nav}{\headcommand {\beamer@subsectionpages {1}{11}}}
+\@writefile{nav}{\headcommand {\beamer@sectionpages {1}{11}}}
+\@writefile{nav}{\headcommand {\beamer@documentpages {11}}}
+\@writefile{nav}{\headcommand {\gdef \inserttotalframenumber {11}}}

document/presentation/presentation.tex

@@ -111,6 +111,17 @@
     {\tt \tiny git submodule update ----init ----recursive}
   \item Add the Timer IP core to the list of peripherals in the {\tt ./config.mk} file:\\
     {\tt PERIPHERALS:=UART {\em TIMER}}
+  \item Include the Timer IP core {\tt hardware.mk} file in {\tt ./hardware.mk} file:\\
+    {\tt \tiny include \$(TIMER\_DIR)/hardware/hardware.mk}
+  \item Include the Timer IP core {\tt embedded.mk} file in {\tt ./firmware/Makefile} file:\\
+    {\tt \tiny include \$(TIMER\_DIR)/software/embedded/embedded.mk}
+  \end{itemize}
+\end{frame}
+
+\begin{frame}{Instantiate an IP core in your SoC}
+  \begin{itemize}
+  \item Include the Timer IP core {\tt pc.mk} file in {\tt ./pc-emul/Makefile} file:\\
+    {\tt \tiny include \$(TIMER\_DIR)/software/pc-emul/pc.mk}
   \item An IP core can be integrated into IOb-SoC if it provides the following files:
     \begin{itemize}
     \item CORE\_REPO/hardware/hardware.mk

hardware/asic/asic.mk

@@ -62,7 +62,7 @@ test3:
 clean-remote: hw-clean
 ifneq ($(ASIC_SERVER),)
 	ssh $(ASIC_USER)@$(ASIC_SERVER) "if [ ! -d $(REMOTE_ROOT_DIR) ]; then mkdir -p $(REMOTE_ROOT_DIR); fi"
-	rsync -avz --delete --exclude .git $(ROOT_DIR) $(ASIC_USER)@$(ASIC_SERVER):$(REMOTE_ROOT_DIR)
+	rsync -avz --delete --force --exclude .git $(ROOT_DIR) $(ASIC_USER)@$(ASIC_SERVER):$(REMOTE_ROOT_DIR)
 	ssh $(ASIC_USER)@$(ASIC_SERVER) 'cd $(REMOTE_ROOT_DIR)/hardware/asic/$(ASIC_NODE); make clean'
 endif
 
@@ -71,7 +71,7 @@ clean-testlog:
 	@rm -f test.log
 ifneq ($(ASIC_SERVER),)
 	ssh $(ASIC_USER)@$(ASIC_SERVER) "if [ ! -d $(REMOTE_ROOT_DIR) ]; then mkdir -p $(REMOTE_ROOT_DIR); fi"
-	rsync -avz --delete --exclude .git $(ROOT_DIR) $(ASIC_USER)@$(ASIC_SERVER):$(REMOTE_ROOT_DIR)
+	rsync -avz --delete --force --exclude .git $(ROOT_DIR) $(ASIC_USER)@$(ASIC_SERVER):$(REMOTE_ROOT_DIR)
 	ssh $(ASIC_USER)@$(ASIC_SERVER) 'cd $(REMOTE_ROOT_DIR)/hardware/asic/$(ASIC_NODE); make $@'
 endif