tree: de1af02820ab7b0dfdd6018641e25e1451c7c980 [path history] [tgz]
  1. autogen_testutils/
  2. container/
  3. coverage/
  4. dashboard/
  5. design/
  6. device_sw_utils/
  7. difgen/
  8. doc/
  9. doxygen/
  10. dvsim/
  11. example/
  12. fpga/
  13. fpvgen/
  14. git/
  15. i2csvg/
  16. ipgen/
  17. make_new_dif/
  18. openocd/
  19. reggen/
  20. serialize/
  21. test_reggen/
  22. tlgen/
  23. topgen/
  24. uvmdvgen/
  25. autogen_banner.py
  26. autogen_testutils.py
  27. BUILD
  28. build_consts.sh
  29. build_docs.py
  30. check_dif_statuses.py
  31. check_tool_requirements.py
  32. diff_generated_util_output.py
  33. dvsim_test_runner.sh
  34. fix_include_guard.py
  35. fix_trailing_whitespace.py
  36. fpvgen.py
  37. generate_compilation_db.py
  38. generate_compilation_db_test.py
  39. get-toolchain.py
  40. get_workspace_status.sh
  41. i2csvg.py
  42. ipgen.py
  43. lint_commits.py
  44. lintpy.py
  45. lowrisc_misc-linters.lock.hjson
  46. lowrisc_misc-linters.vendor.hjson
  47. make_new_dif.py
  48. opentitan_functest_runner.sh
  49. otbn_build.py
  50. prep-bazel-airgapped-build.sh
  51. README.md
  52. regtool.py
  53. rom_chip_info.py
  54. run-rustfmt.sh
  55. run_manual_tests.py
  56. syn_yosys.sh
  57. tlgen.py
  58. topgen-fusesoc.py
  59. topgen.py
  60. vendor.py
  61. verible-format-allowlist.txt
  62. verible-format.py
util/README.md

title: “Reference Manuals”

  • [Comportability Definition and Specification]({{< relref “comportability_specification” >}})
  • [Device Interface Function (DIF) Specification]({{< relref “device_interface_functions” >}})
  • Tool Guides
    • [Topgen Tool]({{< relref “topgen_tool” >}}): Describes topgen.py and its Hjson format source. Used to generate rtl and validation files for top specific modules such as PLIC, Pinmux and crossbar.
    • [Register Tool]({{< relref “register_tool” >}}): Describes regtool.py and its Hjson format source. Used to generate documentation, rtl, header files and validation files for IP Registers and toplevel.
    • [Ipgen Tool]({{< relref “ipgen_tool” >}}): Describes ipgen.py and its Hjson control file. Used to generate IP blocks from IP templates.
    • [Crossbar Tool]({{< relref “crossbar_tool” >}}): Describes tlgen.py and its Hjson format source. Used to generate self-documentation, rtl files of the crossbars at the toplevel.
    • [Vendor-In Tool]({{< relref “vendor_in_tool” >}}): Describes util/vendor.py and its Hjson control file. Used to pull a local copy of code maintained in other upstream repositories and apply local patch sets.
  • [FPGA Reference Manual]({{< relref “ref_manual_fpga.md” >}})
  • [OpenTitan Continuous Integration]({{< relref “continuous_integration.md” >}})