[dif_uart] Introduce UART DIF library

This change introduces an UART DIF, a low level library for UART
hardware manipulation. The set of functions in this library can be
used in an ISR context, as well as normal execution context (It is up
to the higher level driver or OS to guard against the race conditions).

The init function is responsible for initialising the UART state,
which must be passed to all other DIF API.

This change is written to RFC #1043, and fixes issue #1076

Limitations:
* Implementation expects that only one thread of execution exclusively
  owns the hardware resource. This is a subject to implementation in a
  higher level driver, or OS.
* Implementation does not protect against race conditions that can
  occur between the ISR context and normal execution context. This
  responsibility also lies on a higher level driver or OS.

Current state:
* Fundamental API has been introduced, which should be sufficient for an UART
  driver needs, however it may be evolved and extended. For example, private
  user data could be added to the state structure.
* This API is largely untested

Signed-off-by: Silvestrs Timofejevs <silvestrst@lowrisc.org>
3 files changed
tree: d43ac5a2a27886e4bc1d6e54205f004c5b94e61b
  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).