[dv doc] prototype implmentation of hjson testplan

- added sample hjson testplan (util/testplanner/examples)
  - can import 'common' testplans
  - specifies planned tests with ability to set actual written tests
- added sample regression results hjson file (util/testplanner/examples)
- added testplanner.py script (and associated utils)
  - parse testplan hjson into a data structure
  - parse regr result if available into another data structure
  - annotate testplan with regr results

- updated lowrisc_renderer.py script to be able to expand teststplan
  data structure into a table inline within the dv plan doc
15 files changed
tree: 573ca2ece34bf7ad65f6d5ae53ce0335c9351aab
  1. .github/
  2. ci/
  3. doc/
  4. hw/
  5. sw/
  6. test/
  7. util/
  8. .clang-format
  9. .gitignore
  10. .style.yapf
  11. azure-pipelines.yml
  12. CONTRIBUTING.md
  13. index.md
  14. LICENSE
  15. meson.build
  16. meson_init.sh
  17. meson_options.txt
  18. python-requirements.txt
  19. README.md
  20. sitemap.md
  21. toolchain.txt
README.md

OpenTitan

This repository contains hardware, software and utilities written as part of the OpenTitan project. It is structured as monolithic repository, or “monorepo”, where all components live in one repository.

Documentation

The project contains comprehensive documentation of all IPs and tools. You can either access it online or build it locally by following the steps below.

  1. Ensure that you have the required Python modules installed (to be executed in the repository root):
$ sudo apt install python3 python3-pip
$ pip3 install --user -r python-requirements.txt
  1. Execute the build script:
$ ./util/build_docs.py --preview

This compiles the documentation into ./opentitan-docs and starts a local server, which allows you to access the documentation at http://127.0.0.1:5500.

How to contribute

Have a look at CONTRIBUTING.md for guidelines how to contribute code to this repository.

Licensing

Unless otherwise noted, everything in this repository is covered by the Apache License, Version 2.0 (see LICENSE for full text).