[bazel] Restructure `opentitan_binary` and `opentitan_functest` macros

Verilator simulations can take as input either a scrambled VMEM file or
an ELF file to load the simulated flash memory with. However, the
existing signing tool, can only sign BIN files, and BIN files can only
be converted to VMEM files (since ELF section header info is lost).
Therefore, in order to run Verilator simulations with signed flash
images, for mask ROM testing, the bazel `opentitan_binary` macro must
be able to convert singed BIN files into scrambled VMEM files.

Currently, the `opentitan_binary` macro is used to generate both ROM and
flash images for simulations, since the simulated ROM takes as input a
scrambled VMEM file, that can be generated from an ELF file (so the
same macro could generate ELFs for either ROM or flash, and if the image
was destined for ROM, it could just be processed further).

Unfortunately, the scrambled VMEM format used for ROM, is different from
that used for flash (i.e., 32 vs. 64 bit words), and, using the
same bazel macro (i.e., `opentitan_binary`) to generate two different
scrambled VMEM files (one for ROM and one for flash) adds too much
complexity to the macro.

Therefore, this commit, brakes the original `opentitan_binary` macro
intro three macros, to simplify the implementation of each, while
maximizing code reuse. These include:

1. `opentitan_binary`: a macro used to generate ".elf", ".bin", and
   ".dis" files for RV32I targets,
2. `opentitan_rom_binary`: a macro that invokes `opentitan_binary`
   under the hood, and then translates the resulting ".elf" into a
   scrambled 32-bit VMEM file (required for ROM), and
3. `opentitan_flash_binary`: a macro that invokes `opentitan_binary`
   under the hood, and then (optionally) signs, and translates the
   resulting ".bin" files into scrambled 64-bit VMEM files (required
   for flash).

This fixes #10876, and enables running `opentitan_functest`s with mask
ROM (and test ROM) on both Verilator and CW310 hardware targets.

Signed-off-by: Timothy Trippel <ttrippel@google.com>
9 files changed
tree: f3be57956eaf35dcb9f52d07bfc7e4879c5e0be8
  1. .github/
  2. ci/
  3. doc/
  4. hw/
  5. rules/
  6. site/
  7. sw/
  8. test/
  9. third_party/
  10. util/
  11. .bazelignore
  12. .bazelrc
  13. .bazelversion
  14. .clang-format
  15. .dockerignore
  16. .flake8
  17. .gitignore
  18. .style.yapf
  19. .svlint.toml
  20. .svls.toml
  21. _index.md
  22. apt-requirements.txt
  23. azure-pipelines.yml
  24. BUILD.bazel
  25. check_tool_requirements.core
  26. CLA
  27. COMMITTERS
  28. CONTRIBUTING.md
  29. LICENSE
  30. meson-config.txt
  31. meson.build
  32. meson_init.sh
  33. meson_options.txt
  34. python-requirements.txt
  35. README.md
  36. tool_requirements.py
  37. toolchain.txt
  38. topgen-reg-only.core
  39. topgen.core
  40. WORKSPACE
  41. yum-requirements.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 access it online at docs.opentitan.org.

How to contribute

Have a look at CONTRIBUTING and our documentation on project organization and processes 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).