| commit | d834c70d722f78db728704e3d3632dad05d71543 | [log] [tgz] |
|---|---|---|
| author | Sam Elliott <selliott@lowrisc.org> | Wed Feb 12 11:18:47 2020 +0000 |
| committer | Philipp Wagner <mail@philipp-wagner.com> | Wed Feb 12 11:55:40 2020 +0000 |
| tree | c79a999b83c5bd49c822db682a9b5d716efdcb9e | |
| parent | 84dcd026cbd3b67819635eecaa09ca0e0c764295 [diff] |
[doc] Document Top Earlgrey Parameterisations At the moment, we only have one top level (top_earlgrey) and therefore only one parameterisation of various peripherals (alert handler, pinmux, PLIC). The docs, until today, have been generated from the "default" parameterisations, which have not matched the top earlgrey parameterisations, which has made writing software against the hardware difficult and error-prone. This commit changes the docs to use the earlgrey parameterisations, and documents the parameterisations in the parameter tables. Should we gain other top levels, we should revisit how this is generated, but we knew that already, and this makes the software developers lives much easier. Closes #1068, #1496 Signed-off-by: Sam Elliott <selliott@lowrisc.org>
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.
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.
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.
$ sudo apt install curl python3 python3-pip $ pip3 install --user -r python-requirements.txt
$ ./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.
Have a look at CONTRIBUTING for guidelines on how to contribute code to this repository.
Unless otherwise noted, everything in this repository is covered by the Apache License, Version 2.0 (see LICENSE for full text).