commit | f5a20092ae74bed7364f48766b5e505d7710fb09 | [log] [tgz] |
---|---|---|
author | Sam Elliott <selliott@lowrisc.org> | Wed Nov 27 16:10:47 2019 +0000 |
committer | Alex Bradbury <asb@asbradbury.org> | Mon Dec 09 06:01:19 2019 -0800 |
tree | c92093396f56b1e053b1dbbd161c215356b6cac9 | |
parent | 680faef6af0e8cccefbffefa362080fdbcb133b4 [diff] |
[doc] Mandate C11 in the C/C++ Coding Style Guide This matches the C version available when C++14 was standardised. It is prudent to avoid nonstandard language extensions so that using different compilers is easier. The style guide now includes a short whitelist of allowed nonstandard extensions. The style guide now also includes a more comprehensive set of requirements and suggestions around builtin usage. 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).