Google Git
Sign in
opensecura / 3p / lowrisc / opentitan / 06f7809388340a6da84f2225e6cfd00489960454
commit06f7809388340a6da84f2225e6cfd00489960454[log] [tgz]
authorPirmin Vogel <vogelpi@lowrisc.org>Sun Mar 15 21:32:25 2020 +0100
committerPirmin Vogel <vogelpi@lowrisc.org>Fri Apr 24 15:24:45 2020 +0200
tree7a9a12fc221a29068ee4eb5b8110cbb0c9b25400
parent2bc2f0106cd0793199b76f7763d6cad8669ed7d2 [diff]
[usb/doc] Revise documenation

This commits revises the documentation of the USB device to mainly:
- Add a note that the USB device is a comportable IP.
- Add references to the USB 2.0 specification where suitable.
- Harmonize spelling.
- Harmonize usage of terms describing the same thing (e.g. Available Buffer
  FIFO & AV FIFO, Received Buffer FIFO & Receive FIFO, buffer ID & buffer
  number)
- Add missing definitions of acronyms.
- Fix broken references to register descriptions.

Signed-off-by: Pirmin Vogel <vogelpi@lowrisc.org>
2 files changed
tree: 7a9a12fc221a29068ee4eb5b8110cbb0c9b25400
  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 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).