Skip to content
OpenTitan: Open source silicon root of trust
SystemVerilog Python C Smarty Makefile Emacs Lisp Other
Branch: master
Clone or download
lenary and asb [doc] Clarify installation checkout directories
It was not clear that the instructions for the GCC toolchain (option 2), OpenOCD and Verilator should be done in a directory outside the opentitan repository. This commit clarifies the instructions by adding notes about this.

Signed-off-by: Sam Elliott <selliott@lowrisc.org>
Latest commit 685449b Nov 12, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github [github] Minor update to default reviewers Nov 4, 2019
ci [test] Set up CI for the Verilator-based pytest. Nov 8, 2019
doc [doc] Clarify installation checkout directories Nov 12, 2019
hw [dv/hmac] fix_reset_corner_case Nov 11, 2019
site [doc] Compact HW Dashboard Nov 11, 2019
sw [sw] Add uart idle Nov 6, 2019
test [test] Minor updates to pytest usage Nov 7, 2019
util [doc] Compact HW Dashboard Nov 11, 2019
.clang-format Start of public OpenTitan development history Aug 31, 2019
.gitignore [hw/ip] Generate register headers manually Oct 25, 2019
.style.yapf Start of public OpenTitan development history Aug 31, 2019
CLA Add Contributor License Agreement Nov 5, 2019
COMMITTERS [COMMITTERS] Fix Scott's GitHub username Nov 5, 2019
CONTRIBUTING.md Add Contributor License Agreement Nov 5, 2019
LICENSE Start of public OpenTitan development history Aug 31, 2019
README.md [README] Don't require hugo to be installed Nov 5, 2019
_index.md [doc] Note the project license in root _index.md Nov 5, 2019
azure-pipelines.yml [ci] Render landing site as part of checks Nov 8, 2019
meson.build [top/earlgrey] Software Initialization Code Oct 31, 2019
meson_init.sh [sw] Deprecate Make in SW. Oct 30, 2019
meson_options.txt [sw] Add Meson as software build system Oct 9, 2019
python-requirements.txt Specify minimum version for mistletoe Oct 24, 2019
toolchain.txt [sw] Add Meson as software build system Oct 9, 2019

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 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).

You can’t perform that action at this time.