[hw/ip] Update references to data
All references which point to `doc` contain now `data`.
Fixes lowrisc/opentitan#256
diff --git a/hw/Makefile b/hw/Makefile
index aab067a..527d507 100644
--- a/hw/Makefile
+++ b/hw/Makefile
@@ -23,6 +23,7 @@
toolflags += -v
endif
+dir_hjson = data
ips_reg = $(addsuffix _reg, $(IPS))
@@ -33,18 +34,18 @@
regs: $(ips_reg)
$(ips_reg):
- if [ -f ${PRJ_DIR}/hw/ip/$(subst _reg,,$@)/doc/$(subst _reg,,$@).hjson ]; then \
- ${PRJ_DIR}/util/regtool.py -r ${PRJ_DIR}/hw/ip/$(subst _reg,,$@)/doc/$(subst _reg,,$@).hjson; \
+ if [ -f ${PRJ_DIR}/hw/ip/$(subst _reg,,$@)/$(dir_hjson)/$(subst _reg,,$@).hjson ]; then \
+ ${PRJ_DIR}/util/regtool.py -r ${PRJ_DIR}/hw/ip/$(subst _reg,,$@)/$(dir_hjson)/$(subst _reg,,$@).hjson; \
${PRJ_DIR}/util/regtool.py -D -o ${PRJ_DIR}/hw/ip/$(subst _reg,,$@)/sw/$(subst _reg,_regs,$@).h\
- ${PRJ_DIR}/hw/ip/$(subst _reg,,$@)/doc/$(subst _reg,,$@).hjson; \
+ ${PRJ_DIR}/hw/ip/$(subst _reg,,$@)/$(dir_hjson)/$(subst _reg,,$@).hjson; \
${PRJ_DIR}/util/regtool.py -s -t ${PRJ_DIR}/hw/ip/$(subst _reg,,$@)/dv/env \
- ${PRJ_DIR}/hw/ip/$(subst _reg,,$@)//doc/$(subst _reg,,$@).hjson; \
- else if [ -f ${PRJ_DIR}/hw/ip/$(subst _reg,,$@)/doc/$@.hjson ]; then \
- ${PRJ_DIR}/util/regtool.py -r ${PRJ_DIR}/hw/ip/$(subst _reg,,$@)/doc/$@.hjson; \
+ ${PRJ_DIR}/hw/ip/$(subst _reg,,$@)/$(dir_hjson)/$(subst _reg,,$@).hjson; \
+ else if [ -f ${PRJ_DIR}/hw/ip/$(subst _reg,,$@)/$(dir_hjson)/$@.hjson ]; then \
+ ${PRJ_DIR}/util/regtool.py -r ${PRJ_DIR}/hw/ip/$(subst _reg,,$@)/$(dir_hjson)/$@.hjson; \
${PRJ_DIR}/util/regtool.py -D -o ${PRJ_DIR}/hw/ip/$(subst _reg,,$@)/sw/$(subst _reg,_regs,$@).h \
- ${PRJ_DIR}/hw/ip/$(subst _reg,,$@)/doc/$@.hjson; \
+ ${PRJ_DIR}/hw/ip/$(subst _reg,,$@)/$(dir_hjson)/$@.hjson; \
${PRJ_DIR}/util/regtool.py -s -t ${PRJ_DIR}/hw/ip/$(subst _reg,,$@)/dv/env \
- ${PRJ_DIR}/hw/ip/$(subst _reg,,$@)//doc/$@.hjson; \
+ ${PRJ_DIR}/hw/ip/$(subst _reg,,$@)/$(dir_hjson)/$@.hjson; \
fi \
fi
diff --git a/hw/dv/tools/ral_gen.mk b/hw/dv/tools/ral_gen.mk
index be055fc..0609bda 100644
--- a/hw/dv/tools/ral_gen.mk
+++ b/hw/dv/tools/ral_gen.mk
@@ -6,5 +6,5 @@
# tool and options for generating the UVM RAL model
RAL_TOOL ?= ${PROJ_ROOT}/util/regtool.py
RAL_MODEL_DIR ?= ${DV_DIR}/env
-RAL_TOOL_OPTS += -s -t ${RAL_MODEL_DIR} ${DV_DIR}/../doc/${DUT_TOP}.hjson
+RAL_TOOL_OPTS += -s -t ${RAL_MODEL_DIR} ${DV_DIR}/../data/${DUT_TOP}.hjson
RAL_MODEL = ${RAL_MODEL_DIR}/${DUT_TOP}_reg_block.sv
diff --git a/hw/ip/aes/doc/aes.md b/hw/ip/aes/doc/aes.md
index a11b171..4b1df15 100644
--- a/hw/ip/aes/doc/aes.md
+++ b/hw/ip/aes/doc/aes.md
@@ -1,5 +1,5 @@
{{% lowrisc-doc-hdr AES HWIP Technical Specification }}
-{{% regfile aes.hjson}}
+{{% regfile ../data/aes.hjson}}
{{% section1 Overview }}
diff --git a/hw/ip/alert_handler/doc/alert_handler.md b/hw/ip/alert_handler/doc/alert_handler.md
index dce0c1a..3890998 100644
--- a/hw/ip/alert_handler/doc/alert_handler.md
+++ b/hw/ip/alert_handler/doc/alert_handler.md
@@ -1,5 +1,5 @@
{{% lowrisc-doc-hdr Alert Handler Technical Specification }}
-{{% regfile alert_handler.hjson }}
+{{% regfile ../data/alert_handler.hjson }}
{{% section1 Overview }}
diff --git a/hw/ip/flash_ctrl/doc/flash_ctrl.md b/hw/ip/flash_ctrl/doc/flash_ctrl.md
index e438317..e150c74 100644
--- a/hw/ip/flash_ctrl/doc/flash_ctrl.md
+++ b/hw/ip/flash_ctrl/doc/flash_ctrl.md
@@ -1,5 +1,5 @@
{{% lowrisc-doc-hdr Flash Controller HWIP Technical Specification }}
-{{% regfile flash_ctrl.hjson }}
+{{% regfile ../data/flash_ctrl.hjson }}
{{% toc 3 }}
{{% section1 Overview }}
diff --git a/hw/ip/gpio/doc/gpio.md b/hw/ip/gpio/doc/gpio.md
index 19bf289..655966e 100644
--- a/hw/ip/gpio/doc/gpio.md
+++ b/hw/ip/gpio/doc/gpio.md
@@ -1,5 +1,5 @@
{{% lowrisc-doc-hdr GPIO HWIP Technical Specification }}
-{{% regfile gpio.hjson }}
+{{% regfile ../data/gpio.hjson }}
{{% section1 Overview }}
diff --git a/hw/ip/hmac/doc/hmac.md b/hw/ip/hmac/doc/hmac.md
index de3a286..9b17a3e 100644
--- a/hw/ip/hmac/doc/hmac.md
+++ b/hw/ip/hmac/doc/hmac.md
@@ -1,5 +1,5 @@
{{% lowrisc-doc-hdr HMAC HWIP Technical Specification }}
-{{% regfile hmac.hjson }}
+{{% regfile ../data/hmac.hjson }}
{{% section1 Overview }}
diff --git a/hw/ip/padctrl/doc/padctrl.md b/hw/ip/padctrl/doc/padctrl.md
index 48b79a8..41be20c 100644
--- a/hw/ip/padctrl/doc/padctrl.md
+++ b/hw/ip/padctrl/doc/padctrl.md
@@ -1,5 +1,5 @@
{{% lowrisc-doc-hdr Padctrl Technical Specification }}
-{{% regfile padctrl.hjson }}
+{{% regfile ../data/padctrl.hjson }}
{{% section1 Overview }}
diff --git a/hw/ip/pinmux/doc/pinmux.md b/hw/ip/pinmux/doc/pinmux.md
index 1be8aad..1016401 100644
--- a/hw/ip/pinmux/doc/pinmux.md
+++ b/hw/ip/pinmux/doc/pinmux.md
@@ -1,5 +1,5 @@
{{% lowrisc-doc-hdr Pinmux Technical Specification }}
-{{% regfile pinmux.hjson }}
+{{% regfile ../data/pinmux.hjson }}
{{% section1 Overview }}
diff --git a/hw/ip/rv_plic/doc/rv_plic.md b/hw/ip/rv_plic/doc/rv_plic.md
index cb6643e..f121edf 100644
--- a/hw/ip/rv_plic/doc/rv_plic.md
+++ b/hw/ip/rv_plic/doc/rv_plic.md
@@ -1,5 +1,5 @@
{{% lowrisc-doc-hdr Interrupt Controller Technical Specification }}
-{{% regfile rv_plic.hjson }}
+{{% regfile ../data/rv_plic.hjson }}
{{% section1 Overview }}
diff --git a/hw/ip/rv_timer/doc/rv_timer.md b/hw/ip/rv_timer/doc/rv_timer.md
index 814ac21..ca83a9d 100644
--- a/hw/ip/rv_timer/doc/rv_timer.md
+++ b/hw/ip/rv_timer/doc/rv_timer.md
@@ -1,5 +1,5 @@
{{% lowrisc-doc-hdr Timer HWIP Technical Specification }}
-{{% regfile rv_timer.hjson }}
+{{% regfile ../data/rv_timer.hjson }}
{{% section1 Overview }}
diff --git a/hw/ip/spi_device/doc/spi_device.md b/hw/ip/spi_device/doc/spi_device.md
index 905a018..898daf5 100644
--- a/hw/ip/spi_device/doc/spi_device.md
+++ b/hw/ip/spi_device/doc/spi_device.md
@@ -1,5 +1,5 @@
{{% lowrisc-doc-hdr SPI Device HWIP Technical Specification }}
-{{% regfile spi_device.hjson }}
+{{% regfile ../data/spi_device.hjson }}
{{% section1 Overview }}
diff --git a/hw/ip/uart/doc/uart.md b/hw/ip/uart/doc/uart.md
index 70c723f..d1d7615 100644
--- a/hw/ip/uart/doc/uart.md
+++ b/hw/ip/uart/doc/uart.md
@@ -1,5 +1,5 @@
{{% lowrisc-doc-hdr UART HWIP Technical Specification }}
-{{% regfile uart.hjson}}
+{{% regfile ../data/uart.hjson}}
{{% section1 Overview }}
diff --git a/hw/ip/usbdev/doc/usbdev.md b/hw/ip/usbdev/doc/usbdev.md
index e88fcb3..720c74c 100644
--- a/hw/ip/usbdev/doc/usbdev.md
+++ b/hw/ip/usbdev/doc/usbdev.md
@@ -1,5 +1,5 @@
{{% lowrisc-doc-hdr Simple USB Full Speed Device IP Technical Specification }}
-{{% regfile usbdev.hjson }}
+{{% regfile ../data/usbdev.hjson }}
{{% section1 Overview }}
diff --git a/hw/ip/usbuart/doc/usbuart.md b/hw/ip/usbuart/doc/usbuart.md
index 13fec94..40b9651 100644
--- a/hw/ip/usbuart/doc/usbuart.md
+++ b/hw/ip/usbuart/doc/usbuart.md
@@ -1,5 +1,5 @@
{{% lowrisc-doc-hdr USB UART HWIP Technical Specification }}
-{{% regfile usbuart.hjson}}
+{{% regfile ../data/usbuart.hjson}}
{{% section1 Overview }}
diff --git a/hw/top_earlgrey/README.md b/hw/top_earlgrey/README.md
index 2b6cbcd..fdbf020 100644
--- a/hw/top_earlgrey/README.md
+++ b/hw/top_earlgrey/README.md
@@ -40,7 +40,7 @@
need to specify the list of peripherals, memories, crossbars, and the interrupts
in the configuration file. The tool then reads relavant information from the
each peripheral blocks' configuration. For instance, if `uart` module is used,
-the tool reads `hw/ip/uart/doc/uart{_reg}.hjson` and parses the information such
+the tool reads `hw/ip/uart/data/uart{_reg}.hjson` and parses the information such
as input/output, the size of its register space, and interrupts.
For the memories, the tool utilizes the `type` and instantiates relavant modules
diff --git a/meson.build b/meson.build
index acc8422..fd8e5aa 100644
--- a/meson.build
+++ b/meson.build
@@ -51,12 +51,12 @@
)
# TODO: Considering moving these into hw/ip directories.
-hw_ip_flash_ctrl_regs_h = gen_hw_hdr.process('hw/ip/flash_ctrl/doc/flash_ctrl.hjson')
-hw_ip_gpio_reg_h = gen_hw_hdr.process('hw/ip/gpio/doc/gpio.hjson')
-hw_ip_hmac_reg_h = gen_hw_hdr.process('hw/ip/hmac/doc/hmac.hjson')
-hw_ip_spi_device_reg_h = gen_hw_hdr.process('hw/ip/spi_device/doc/spi_device.hjson')
-hw_ip_rv_timer_reg_h = gen_hw_hdr.process('hw/ip/rv_timer/doc/rv_timer.hjson')
-hw_ip_uart_reg_h = gen_hw_hdr.process('hw/ip/uart/doc/uart.hjson')
-hw_ip_usbdev_reg_h = gen_hw_hdr.process('hw/ip/usbdev/doc/usbdev.hjson')
+hw_ip_flash_ctrl_regs_h = gen_hw_hdr.process('hw/ip/flash_ctrl/data/flash_ctrl.hjson')
+hw_ip_gpio_reg_h = gen_hw_hdr.process('hw/ip/gpio/data/gpio.hjson')
+hw_ip_hmac_reg_h = gen_hw_hdr.process('hw/ip/hmac/data/hmac.hjson')
+hw_ip_spi_device_reg_h = gen_hw_hdr.process('hw/ip/spi_device/data/spi_device.hjson')
+hw_ip_rv_timer_reg_h = gen_hw_hdr.process('hw/ip/rv_timer/data/rv_timer.hjson')
+hw_ip_uart_reg_h = gen_hw_hdr.process('hw/ip/uart/data/uart.hjson')
+hw_ip_usbdev_reg_h = gen_hw_hdr.process('hw/ip/usbdev/data/usbdev.hjson')
subdir('sw')
diff --git a/sw/rules.mk b/sw/rules.mk
index aa42f9f..6a56c50 100644
--- a/sw/rules.mk
+++ b/sw/rules.mk
@@ -114,10 +114,10 @@
$(CC) $(CFLAGS) -E -MMD -c $(INCS) -o $@ $<
# regtool
-$(LIB_BUILD_DIR)/%_regs.h: $(SW_ROOT_DIR)/../hw/ip/$$*/doc/$$*.hjson
+$(LIB_BUILD_DIR)/%_regs.h: $(SW_ROOT_DIR)/../hw/ip/$$*/data/$$*.hjson
$(REGTOOL) -D -o $@ $<
-$(LIB_BUILD_DIR)/%_regs.h: $(SW_ROOT_DIR)/../hw/ip/$$*/doc/$$*_regs.hjson
+$(LIB_BUILD_DIR)/%_regs.h: $(SW_ROOT_DIR)/../hw/ip/$$*/data/$$*_regs.hjson
$(REGTOOL) -D -o $@ $<
# chip_info
diff --git a/util/diff_generated_util_output.py b/util/diff_generated_util_output.py
index 4a0feab..c8f19df 100755
--- a/util/diff_generated_util_output.py
+++ b/util/diff_generated_util_output.py
@@ -40,9 +40,9 @@
["wave.html", False,
"./wavetool.py wavegen/examples/* > ", ""],
["uart_rtl", True,
- "./regtool.py -r -t ", " ../hw/ip/uart/doc/uart.hjson"],
+ "./regtool.py -r -t ", " ../hw/ip/uart/data/uart.hjson"],
["uart_dv", True,
- "./regtool.py -s -t ", " ../hw/ip/uart/doc/uart.hjson"],
+ "./regtool.py -s -t ", " ../hw/ip/uart/data/uart.hjson"],
# gp test multireg
["gp.html", False,
"./docgen.py docgen/examples/gp.md > ", ""],
@@ -64,11 +64,11 @@
"./docgen.py docgen/examples/badwen.md > ", ""],
# generating include define headers
["uart.h", False,
- "./regtool.py -D ../hw/ip/uart/doc/uart.hjson > ", ""],
+ "./regtool.py -D ../hw/ip/uart/data/uart.hjson > ", ""],
["gpio.h", False,
- "./regtool.py -D ../hw/ip/gpio/doc/gpio.hjson > ", ""],
+ "./regtool.py -D ../hw/ip/gpio/data/gpio.hjson > ", ""],
["spi_device.h", False,
- "./regtool.py -D ../hw/ip/spi_device/doc/spi_device.hjson > ", ""]
+ "./regtool.py -D ../hw/ip/spi_device/data/spi_device.hjson > ", ""]
] # yapf: disable
diff --git a/util/reggen/README.md b/util/reggen/README.md
index 06fd375..a3e5dd4 100644
--- a/util/reggen/README.md
+++ b/util/reggen/README.md
@@ -67,7 +67,7 @@
```
$ cd $REPO_TOP/util
$ mkdir /tmp/rtl
-$ ./regtool.py -r -t /tmp/rtl ../hw/ip/uart/doc/uart_reg.hjson
+$ ./regtool.py -r -t /tmp/rtl ../hw/ip/uart/data/uart_reg.hjson
```
Generate DV UVM class from register definition:
@@ -75,7 +75,7 @@
```console
$ cd $REPO_TOP/util
$ mkdir /tmp/dv
-$ ./regtool.py -s -t /tmp/dv ../hw/ip/uart/doc/uart_reg.hjson
+$ ./regtool.py -s -t /tmp/dv ../hw/ip/uart/data/uart_reg.hjson
```
If target directory is not specified, tool creates `{module}_regs.sv` file under
diff --git a/util/topgen.py b/util/topgen.py
index 3b3d085..64b38dd 100755
--- a/util/topgen.py
+++ b/util/topgen.py
@@ -105,7 +105,7 @@
# Generating IP top module script is not generalized yet.
# So, topgen reads template files from rv_plic directory directly.
# Next, if the ip top gen tool is placed in util/ we can import the library.
- tpl_path = out_path / '../ip/rv_plic/doc'
+ tpl_path = out_path / '../ip/rv_plic/data'
hjson_tpl_path = tpl_path / 'rv_plic.hjson.tpl'
rtl_tpl_path = tpl_path / 'rv_plic.sv.tpl'
diff --git a/util/topgen/lib.py b/util/topgen/lib.py
index 9463d76..c9526aa 100644
--- a/util/topgen/lib.py
+++ b/util/topgen/lib.py
@@ -24,9 +24,9 @@
def search_ips(ip_path): # return list of config files
# list the every hjson file
- p = ip_path.glob('*/doc/*.hjson')
+ p = ip_path.glob('*/data/*.hjson')
- # filter only ip_name/doc/ip_name{_reg|''}.hjson
+ # filter only ip_name/data/ip_name{_reg|''}.hjson
ips = [x for x in p if is_ipcfg(x)]
log.info("Filtered-in IP files: %s" % repr(ips))
