[englishbreakfast] Don't run topgen as generator

Previously, we ran `util/topgen-fusesoc.py` twice as FuseSoC generator;
the script produces a number of core files specific for the English
Breakfast toplevel on the fly (files similar to the ones we check in for
Earl Grey).

Running this script as FuseSoC generator had the beauty of hiding it
from the developer; running fusesoc was sufficient to generate the files
and use them.

However, there's also a downside: All cores (i.e. all files ending in
`*.core`) which are produced by the script or subprocesses of the script
are automatically made a dependency (in FuseSoC terms) of
top_englishbreakfast.

With upcoming changes, topgen will produce not only cores which can
actually be synthesized, but also cores referencing unsynthesizable DV
code. This code cannot be made a dependency of top_englishbreakfast, or
the build fails (e.g. due to Verilator or Vivado being unable to read
the language constructs in those files).

With this change, the user trying to simulator or synthesize the English
Breakfast toplevel has to first call `util/topgen-fusesoc.py`, which
will produce the same files it produced before, and put them into the
`build/top_englishbreakfast-autogen` folder. The cores in this folder
are available for FuseSoC to pick if needed, but not automatically added
as dependency.

The actual dependencies that top_englishbreakfast and other IP cores
need are then listed in `topgen.core` and `topgen-reg-only.core`, where
the generator was called previously.

All of this is a stop-gap for the transition period until we have ipgen
fully hooked up.

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