Additional Resources

The following documents are available across the Caliptra project repositories. Links point to the version-appropriate reference when available.

Hardware

• VeeR EL2 Programmer's Reference Manual — Latest documentation for the VeeR EL2 core
• Caliptra Subsystem Overview — Required dependencies, env variables, repository overview, simulation flow and regression tests
• TileLink-UL Bus Specification — Bus specification for comportable devices
• TileLink-UL Protocol Checker — Protocol checked description for the TileLink-UL bus
• TileLink-UL XBAR DV — TileLink-UL bus testing overview
• Power Manager Theory of Operation — Overview of Power Manager's functionality
• Power Manager Programmer's Guide
• OTP Controller Field Descriptions — Description of fields stored in the OTP memory
• OTP Controller Memory Map
• OTP Controller Registers
• OTP Controller Partitions — Description of OTP partition attributes
• OTP Controller Digests
• Analog Sensor Top Technical Specification
• Analog Sensor Top Interface Signals
• Caliptra Hands-On Guide — Required dependencies, env variables, repository overview, simulation flow and regression tests for caliptra-rtl
• UART HWIP Technical Specification — Specification, overview of the functionality and a programmer's guide
• Internal Registers for caliptra-rtl — Latest register description for caliptra-rtl components
• FV ECC Block Overview
• JTAG DPI module for OpenOCD remote_bitbang driver — Overview of a JTAG over DPI library
• UART DV — UART testing overview
• ECC — ECC proofs
• SHA256 — SHA256 testing overview
• SHA512 — SHA512 testing overview
• SHA512_MASKED — SHA512_MASKED testing overview
• HMAC — HMAC testing overview
• DOE — DOE testing overview
• HMAC DRBG — HMAC DRGB testing overview
• Adam's Bridge Hardware Specification
• Adam's Bridge Hands-On Guide — Required dependencies, env variables, repository overview, simulation flow and regression tests
• Threat Model for Securing Adams Bridge Against Side-Channel Attacks
• Caliptra — Readme of the Caliptra project
• Hardware Release Process

Software

• Caliptra firmware and software — Directory structure, building and testing for caliptra-sw
• Caliptra FMC Test Coverage — Description of FMC test cases
• Caliptra Runtime Firmware Test Coverage — Describes test cases
• Caliptra ROM Errors — Fatal and non-fatal error codes description
• Caliptra ROM Thread Model — Overview of rules to ensure minimal possibility of security issues
• Caliptra ROM Test Coverage — Describes test cases
• Generating Register Definitions — Instructions for generating register definitions from caliptra-rtl
• Emulator for Caliptra — Emulator's class and state diagrams
• Caliptra C API - libcaliptra
• Caliptra C API Examples — Example on how to interact with the Caliptra API and adapt it to the desired target
• Caliptra C API Examples - hwmodel — Example implementation of libcaliptra's hardware interface
• Caliptra Error Codes — Describes where Caliptra error codes are defined
• C and Rust bindings for Caliptra RTL (verilated) — Building and running C and Rust bindings for a verilated model of caliptra-rtl
• Caliptra Core FPGA Guide — Guide for building and running caliptra-rtl on an FPGA
• Caliptra Subsystem FPGA Guide — Guide for building and running caliptra-ss on an FPGA
• Caliptra SW Tests
• FIPS Functional Test Suite — Overview of the test suite and available test cases
• Caliptra DPE — General overview of Caliptra DPE
• Caliptra DPE Verification Tests — Description of DPE tests
• Caliptra DPE Simulator — Overview of the DPE simulator
• Caliptra MCU firmware and software — Overview of caliptra-mcu-sw

Integration

• Caliptra Checklist and Evaluation Methodology
• Power Manager Checklist
• UART Checklist

Release Notes

• Release Notes - Caliptra Subsystem
• Release Notes - Caliptra RTL
• Release Notes - Adam's Bridge
• Release Notes - VeeR EL2

Tools

• fuse_ctrl Partitions Generator — A script for generation of configurable blocks for the fuse_ctrl instantiation
• Caliptra fpga-boss — Helper utility used for running Caliptra firmware on ZCU104 FPGA
• Caliptra GitHub GCP Runner Infrastructure — Overview of the CI runner architecture
• file-header-fix — Utility used to ensure that all files have proper copyright headers

Governance

• Contributing to Caliptra — Guidelines for contributing to the project
• Workgroup Charter for Caliptra — A formal charter of the Caliptra CHIPS Alliance Workgroup
• Caliptra Project Security Incident Response
• Caliptra Technical Advisory Committee (TAC) Members
• Caliptra Security Assessment Report
• Caliptra Trademark Usage Policy
• Caliptra Trademark Audit Process
• Caliptra Compliant Brand Guidelines
• GitHub Rules
• Caliptra Release Checklist — Describes the release creation process
• Caliptra 2.0 Branching Strategy — Branch naming convention