diff --git a/README.md b/README.md index 7e4f6dfb965bd61fb78c59f76d92de99b9178c6c..a187598617e3b0c5135aa43c8c760353ebf5a2c1 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,17 @@ The core of the SoC is NanoSoC. This is an example, configurable system that is The expansion region is able to instantiate an accelerator_subsystem by default. This means that anyone using NanoSoC as a platform for accelerator experimentation will need to build an `accelerator_subsystem` rtl module. + +### htmlgen design visualisation +--- +A tool is provided to generate an html documentation tree to traverse and explore the design hierarchy: + +`htmlgen -f $SOCLABS_PROJECT_DIR/flist/project/top.flist` +or + `htmlgen` +populates the html/top/build/ directiory. Open `nanosoc_tb.html` to explore from the testbench down in to the design. + + ### Accelerator Subsystem --- `accelerator_subsystem` can either directly contain an accelerator (or multiple) or can instantiate accelerator wrappers which in turn instantiate accelerators. diff --git a/flist/project/accelerator.flist b/flist/project/accelerator.flist index 2bf1f3cca8cefb5be849d385cfaed848cf9b789a..2166f19484e22e37ea462156c7efa1967fbf7d53 100644 --- a/flist/project/accelerator.flist +++ b/flist/project/accelerator.flist @@ -14,10 +14,10 @@ // ============= Accelerator Module search path ============= // ! Point this to your Accelerator RTL -+incdir+$(ACCELERATOR_DIR)/src/rtl +//+incdir+$(ACCELERATOR_DIR)/src/rtl // ! Point this to your Wrapper RTL -$(SOCLABS_PROJECT_DIR)/wrapper/src/soclabs_ahb_aes128_ctrl.v +///$(SOCLABS_PROJECT_DIR)/wrapper/src/soclabs_ahb_aes128_ctrl.v // ! Point this to your Subsystem RTL -$(SOCLABS_PROJECT_DIR)/system/src/accelerator_subsystem.v \ No newline at end of file +///$(SOCLABS_PROJECT_DIR)/system/src/accelerator_subsystem.v