[sw, base] Introduce a MMIO access library

This change introduces a library of functions for explicitly manipulating
volatile MMIO memory (comparable to Rust's read_volatile and write_volatile).
This allows us to:
- Track volatile access somewhat better, rather than just casting
  integers into pointers all over the place.
- Better-control the implementation of volatile reads and writes. If we
  decide we don't trust the compiler's lowering, we can provide our own
  inline-assembly implementation.

This API potentially could be revised in future to handle non-atomic R-M-W
operations differently.

Signed-off-by: Miguel Young de la Sota <mcyoung@google.com>
3 files changed
tree: 9fd73ee2dffac3dcac01afd09a08b02c861c392a
  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. apt-requirements.txt
  14. azure-pipelines.yml
  15. CLA
  16. COMMITTERS
  17. CONTRIBUTING.md
  18. LICENSE
  19. meson.build
  20. meson_init.sh
  21. meson_options.txt
  22. python-requirements.txt
  23. README.md
  24. 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 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).