| commit | a6ee5d824321e7a9f1ff7d8027b9485f4a1ad1d5 | [log] [tgz] |
|---|---|---|
| author | Martin Lueker-Boden <martin.lueker-boden@wdc.com> | Fri Nov 22 17:33:20 2019 -0800 |
| committer | tjaychen <timothytim@google.com> | Mon Jan 27 10:47:19 2020 -0800 |
| tree | 0b78ec4d9911c0e94538d0d93e10485914183477 | |
| parent | e232b454baf13ab3a6b3040fc3e9eb99145dec08 [diff] |
[doc] Initial I2C doc, redux in public repo. Translation to Markdown of https://docs.google.com/document/d/1xVGRX7c5jhQyrJ__iubYD2NmKRO7NlXYuspthZIfvfI Minor changes from Google Doc: Elaboration of timing registers. Removal of incomplete section on START, STOP, transmit and read sequences. Removal of section headers related to incompete programmer's manual section (future PR). New to this PR: -Includes minor style guide comments from #686. -Hugofied. -Line wrapping sorted out Update 2019-11-22: - Responses to Reviews by @imphil and @sjgitty Nov. 22, 2019 Signed-off-by: Martin Lueker-Boden <martin.lueker-boden@wdc.com> Update 2020-01-10: Maybe changes in response to Dec 3. reviews. Signed-off-by: Martin Lueker-Boden <martin.lueker-boden@wdc.com>
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).
