[reggen] Register to have typedef struct

In transition to the parameterized multireg #47, now each register has
its own struct packed type, which is named as
`module_reg2hw/hw2reg_regname_reg/mreg_t`. It creates mane typedef
inside the register package file but the overal reg2hw and hw2reg
structures are cleaner.

It gives more flexibility to transition to register interface from the
struct. The interface should consider the number of registers, not the
fields names.

There's still TODOs in this change.

1.  The field name function call `get_basename()` doesn't work properly
    with field having digits in its name. For instance, alert_handler
    has `en_e0` to `en_e3` in CLASSD_CTRL register, and the function
    chops the digit and returns `en_e` only, which creates an error.
2.  Handling the multi register and normal register is not standardized.
    The functions defined in `util/reggen/data.py` are specific for
    multireg type. It should be commonly used regardless of the register
    type.
3.  `util/topgen/lib.py` could be useful if it is moved to its own
    module. The functions inside lib.py can be used in any generator for
    RTLs.

This is related to #606 #270 #47

Signed-off-by: Eunchan Kim <eunchan@opentitan.org>
3 files changed
tree: bc59415c4919259a47cd15d5ac15e6e44c3f892c
  1. .github/
  2. ci/
  3. doc/
  4. hw/
  5. site/
  6. sw/
  7. test/
  8. util/
  9. .clang-format
  10. .gitignore
  11. .style.yapf
  12. _index.md
  13. azure-pipelines.yml
  14. CLA
  15. COMMITTERS
  16. CONTRIBUTING.md
  17. LICENSE
  18. meson.build
  19. meson_init.sh
  20. meson_options.txt
  21. python-requirements.txt
  22. README.md
  23. 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 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 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).