SUMMARY.md

Summary

OpenTitan

Getting Started

• Getting Started

• Workflows

  • Design Verification
  • Formal Verification
  • Building (and Testing) Software
  • Building Documentation
  • Using OpenOCD

• Tools Setup

  • FPGA Setup
  • Verilator Setup
  • Installing Vivado

Hardware

• Introduction

• Top Earlgrey

  • Datasheet
  • Design
  • Design Verification
    • Chip Testplan
  • Analog Sensor Top
    • Interfaces
  • Alert Handler
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Interface and Registers
    • Device Interface Functions
    • Checklist
  • Interrupt Controller
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Interface and Registers
    • Device Interface Functions
    • Checklist
  • Sensor Control
    • Theory of Operation
    • Programmer's Guide
    • Interface and Registers
    • Device Interface Functions
    • Checklist
  • TL-UL Checklist
  • Pinmux Targets
    • ASIC Target Pinout and Pinmux Connectivity
    • CW310 Target Pinout and Pinmux Connectivity

• Cores

  • Ibex RISC-V Core Wrapper
    • Theory of Operation
    • Design Verification
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Checklist
  • OTBN
    • Theory of Operation
    • Developing OTBN
    • ISA Guide
    • Design Verification
      • Random Instruction Generator
        • Internals
        • Configuration
      • memutil wrapper
      • OTBN Simulation Software
      • Tracer
      • Formal Masking Verification Using Alma
    • Functional Coverage
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Checklist

• Hardware IP Blocks

  • Analog to Digital Converter Control
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Checklist
  • AES
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Device Interface Functions
    • Checklist
  • AON Timer
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Device Interface Functions
    • Checklist
  • Clock Manager
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Device Interface Functions
    • Checklist
  • CSRNG
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Device Interface Functions
    • Checklist
  • EDN
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Device Interface Functions
    • Checklist
  • Entropy Source
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Device Interface Functions
    • Checklist
  • Flash Controller
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Device Interface Functions
    • Checklist
  • GPIO
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Device Interface Functions
    • Checklist
  • HMAC
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Device Interface Functions
    • Checklist
  • I2C
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Device Interface Functions
    • Checklist
  • Key Manager
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Device Interface Functions
    • Checklist
  • KMAC
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Device Interface Functions
    • Checklist
  • Life Cycle Controller
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Device Interface Functions
    • Checklist
  • OTP Controller
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Device Interface Functions
    • Checklist
  • Pattern Generator
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Device Interface Functions
    • Checklist
  • Pinmux
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Device Interface Functions
    • Checklist
  • Pulse Width Modulator
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Device Interface Functions
    • Checklist
  • Power Management
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Device Interface Functions
    • Checklist
  • ROM Control
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Device Interface Functions
    • Checklist
  • Reset Manager
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Device Interface Functions
    • Checklist
  • RISC-V Debug Manager
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Checklist
  • SPI Device
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Device Interface Functions
    • Checklist
  • SPI Host
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Device Interface Functions
    • Checklist
  • SRAM Controller
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Device Interface Functions
    • Checklist
  • System Reset Controller
    • Theory of Operation
    • Design Verification
      • Testplan
    • Hardware Interfaces
    • Registers
    • Device Interface Functions
    • Checklist
  • Timer
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Device Interface Functions
    • Checklist
  • TL-UL Bus
    • Design Verification
      • Testplan
      • Protocol Checker
  • UART
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Hardware Interfaces
    • Registers
    • Device Interface Functions
    • Checklist
  • USB 2.0
    • Theory of Operation
    • Design Verification
      • Testplan
    • Programmer's Guide
    • Suspending and Resuming
    • Hardware Interfaces
    • Registers
    • Device Interface Functions
    • Checklist
  • lowRISC Hardware Primitives
    • Two Input Clock
    • Flash Wrapper
    • Keccak Permutation
    • Linear Feedback Shift Register
    • Packer
    • Packer FIFO
    • Present Scrambler
    • Prince Scrambler
    • SRAM Scrambler
    • Pseudo Random Number Generator

• Common SystemVerilog and UVM Components

  • ALERT_ESC Agent
  • Bus Params Package
  • Comportable IP Testbench Architecture
  • Common Interfaces
  • CSR Utils
  • CSRNG Agent
  • DV Library Classes
  • DV Utils
  • FLASH_PHY_PRIM Agent
  • I2C Agent
  • JTAG Agent
  • JTAG DMI Agent
  • JTAG RISCV Agent
  • KEY_SIDELOAD Agent
  • KMAC_APP Agent
  • Memory Backdoor Scoreboard
  • Memory Backdoor Utility
  • Memory Model
  • PATTGEN Agent
  • PUSH_PULL Agent
  • PWM Monitor
  • RNG Agent
  • Scoreboard
  • Simulation SRAM
  • SPI Agent
  • String Utils
  • Test Vectors
  • Tile Link Agent
  • UART Agent
  • USB20 Agent

Software

• Introduction

• Build Software

• Device Software

  • Device Libraries
    • DIF Library
      • ADC Checklist
      • AES Checklist
      • Alert Handler Checklist
      • Always-On Timer Checklist
      • Clock Manager Checklist
      • CSRNG Checklist
      • EDN Checklist
      • Entropy Source Checklist
      • Flash Controller Checklist
      • GPIO Checklist
      • HMAC Checklist
      • I2C Checklist
      • Key Manager Checklist
      • KMAC Checklist
      • Lifecycle Checklist
      • OTBN Checklist
      • OTP Controller Checklist
      • Pattern Generator Checklist
      • Pin Multiplexer Checklist
      • PWM Checklist
      • Power Manager Checklist
      • ROM Checklist
      • Reset Manager Checklist
      • RV Core Ibex Checklist
      • PLIC Checklist
      • RV Timer Checklist
      • Sensor Controller Checklist
      • SPI Device Checklist
      • SPI Host Checklist
      • SRAM Controller Checklist
      • System Reset Controller Checklist
      • UART Checklist
      • USB Checklist
    • Top-Level Test Libraries
      • On-Device Test Framework
    • OpenTitan Standard Library
      • Freestanding C Headers
  • Silicon Creator Software
    • Manufacturing Firmware
      • Test Plan
    • ROM
      • ROM Specification
      • Bootstrap
      • Memory Protection
      • E2E tests
      • Signing Keys
      • Signature Verification
      • Test Plan
      • Signoff Test Plan
      • Shutdown Specification
    • Manifest Format
  • Top-Level Tests
    • Manufacturer Test Hooks
    • Crypto Library Tests

• Host Software

  • Hardware Security Module (HSM) tool
    • Requirements
  • OpenTitanLib
  • OpenTitanSession
  • OpenTitanTool
  • TPM2 Test Server

Tooling

• Tools Overview

• Design-Related Tooling

• dvsim

  • Design Document
  • Testplanner
  • Glossary

• fpvgen: Initial FPV Testbench Generation

• reggen & regtool: Register Generator

  • Setup and use of regtool

• ralgen: FuseSoC UVM RAL Generator

• uvmdvgen: Initial Testbench Auto-generation

• tlgen: Crossbar Generation

• ipgen: Generate IP Blocks from IP Templates

• topgen: Top Generator

• vendor: Vendoring In Tool

• i2csvg: Generate SVGs of I2C Commands

Contributing

• Contributing

  • Detailed Contribution Guide
  • Directory Structure
  • Contributing to Documentation
    • An Example IP Block's Documentation
  • Continuous Intergration
  • Top-Level Design and Targets
  • GitHub Notes
  • Bazel Notes
  • Using the Container

• Contributing to Hardware

  • Comportability
  • Hardware Design
  • Design Methodology
  • Vendoring in Hardware
  • Linting
  • Synthesis Flow

• Contributing to Verification

  • Verification Methodology
  • Security Countermeasure Verification Framework
  • Assertions

• Contributing to Software

  • Device Interface Functions
  • Writing and Building Software for OTBN

• Style Guides

  • HJSON
  • Python
  • C & C++
  • Markdown
  • RISC-V Assembly
  • OTBN Assembly
  • Guidance for Volatile

• Developing on an FPGA

  • Get a Board
  • FPGA Reference Manual
  • Debugging with an ILA

Project Governance

• Introduction
• Committers
• RFC Process
• Generalized Priority Definitions
• OpenTitan Technical Committee
• Hardware Development Stages
• Signoff Checklist

Security

• Security

• Cryptography Library

  • API Documentation

• Implementation Guidelines

  • Secure Hardware Design Guidelines

• Logical Security Model

• Security Model Specification

  • Device Attestation
  • Device Life Cycle
  • Device Provisioning
  • Firmware Update
  • Identities and Root Keys
  • Ownership Transfer
  • Secure Boot

• Lightweight Threat Model

Use Cases

• Use Cases
• Platform Integrity Module
• Trusted Platform Module
• Universal 2nd-Factor Security Key

Rust for C Developers

• Rust for Embedded C Programmers

Appendix

• Glossary