[sw] Redesign MMIO and Bitfield Library

This commit lays the groundwork described in #2203 for updating the MMIO
library to split the concerns of volatile access (now the duty of the
MMIO library) and bitfield manipulation (now the duty of the bitfield
library).

For the moment, this commit has left in (without warnings) the
deprecated MMIO functions, but has reimplemented them entirely in terms
of the bitfield library.

The bitfield library has also been changed. There is a clearer split
between describing the data field or bit to be changed separately from
what to change it to; and various functions have been renamed to the
`<module>_<noun>_<verb>` convention. In particular, the verb used for
updating a field or bit is "write" (as in "overwrite"), rather than
"set", because set can mean "set this field to all ones" or "set this
bit to one" (respectively). So we have moved to using "read"/"write" as
the verbs everywhere.

This change has caused a lot of changes in the existing DIFs. I have not
yet marked the deprecated functions as `__attribute__((deprecated))`
because it causes a lot of build warning noise. This will happen in a
follow-up commit.

Closes #2203.

Signed-off-by: Sam Elliott <selliott@lowrisc.org>
8 files changed
tree: bb7e66a85f9f0dbcd3c9ca348decaa7bc99fab41
  1. .github/
  2. ci/
  3. doc/
  4. hw/
  5. site/
  6. sw/
  7. test/
  8. util/
  9. .clang-format
  10. .dockerignore
  11. .flake8
  12. .gitignore
  13. .style.yapf
  14. _index.md
  15. apt-requirements.txt
  16. azure-pipelines.yml
  17. check_tool_requirements.core
  18. CLA
  19. COMMITTERS
  20. CONTRIBUTING.md
  21. LICENSE
  22. meson.build
  23. meson_init.sh
  24. meson_options.txt
  25. python-requirements.txt
  26. README.md
  27. tool_requirements.py
  28. 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 access it online at docs.opentitan.org.

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).