Add script to generate technology-dependent primitives on the fly

Some primitives are intended to be implemented in a technology-specific
way, e.g. differently for Xilinx or Altera FPGAs. Which implementation
is to be used can be specified at synthesis time. Target-specific
implementations are collected in "technology libraries", or "techlibs".
When writing code, only "abstract primitives" are used. These are then
implemented by a techlib.

Currently, all techlibs are part of the OpenTitan repository, and all
abstract primitives are hand-crafted. This commit adds a script to
auto-generate these abstract primitives. The script is to be used as
FuseSoC generator.

Note that the script currently is in a rather "rough" form. The
SystemVerilog "parsing" is done using a regex instead of a proper
parser, and speed isn't great either.

Signed-off-by: Philipp Wagner <phw@lowrisc.org>
5 files changed
tree: 392d574b74fef50c2ba936a439add434438a92e6
  1. .github/
  2. ci/
  3. doc/
  4. hw/
  5. site/
  6. sw/
  7. test/
  8. util/
  9. .clang-format
  10. .dockerignore
  11. .gitignore
  12. .style.yapf
  13. _index.md
  14. apt-requirements.txt
  15. azure-pipelines.yml
  16. check_tool_requirements.core
  17. CLA
  18. COMMITTERS
  19. CONTRIBUTING.md
  20. LICENSE
  21. meson.build
  22. meson_init.sh
  23. meson_options.txt
  24. python-requirements.txt
  25. README.md
  26. tool_requirements.py
  27. toolchain.txt
README.md

OpenTitan

OpenTitan logo

About the project

OpenTitan is an open source silicon Root of Trust (RoT) project. OpenTitan will make the silicon RoT design and implementation more transparent, trustworthy, and secure for enterprises, platform providers, and chip manufacturers. OpenTitan is administered by lowRISC CIC as a collaborative project to produce high quality, open IP for instantiation as a full-featured product. See the OpenTitan site and OpenTitan docs for more information about the project.

About this repository

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. It exists to enable collaboration across partners participating in the OpenTitan project.

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 curl 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 ./build/docs and starts a local server, which allows you to access the documentation at http://127.0.0.1:1313.

How to contribute

Have a look at CONTRIBUTING for guidelines on 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).