Caliptra Documentation
Comprehensive documentation covering all aspects of Caliptra - from hardware specifications to software guides and integration instructions.
Caliptra
Caliptra: A Datacenter System on a Chip (SoC) Root of Trust (RoT)
Project background
Caliptra
Readme of the Caliptra project
Contributing to Caliptra
Guidelines for contributing to the project
Hardware Release Process
OCP L.O.C.K Specification
Layered Open-source Cryptographic Key management specification. This is an optional feature for Caliptra Subsystem 2.1+.
Caliptra Subsystem
Caliptra Subsystem Overview
Required dependencies, env variables, repository overview, simulation flow and regression tests
Caliptra Subsystem Hardware Specification
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 RTL
Caliptra Hardware Specification
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
VeeR EL2 RISC-V Core
I3C Core
Adam's Bridge
Caliptra SW
Caliptra firmware and software
Directory structure, building and testing for caliptra-sw
Caliptra FMC Specification
Caliptra FMC Test Coverage
Description of FMC test cases
Caliptra Runtime Firmware Specification
Overview of the runtime firmware
Caliptra Runtime Firmware Test Coverage
Describes test cases
Caliptra ROM Specification
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
SOC Manifest
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 FPGA Guide
Guide for building and running caliptra-rtl on an FPGA
Caliptra SW Tests
FIPS Functional Test Suite
Overview of the test suite and available test cases
Caliptra MCU SW
Caliptra MCU firmware and software
Overview of caliptra-mcu-sw
Caliptra MCU Firmware Documentation
Latest documentation for caliptra-mcu-sw
Security Protocol and Data Model (SPDM)
Description of the Security Protocol and Data Model used for secure communication between hardware components
Reference ROM Specification
Specification of the reference ROM, which gets executed when the MCU starts
Runtime Specification
Overview of the MCU runtime firmware architecture
Image Loading
Overview of Image Loading component, providing support for loading and verifying SoC images
Firmware Update
Overview of the firmware update procedure
libtock
README of Caliptra's for of libtock
Tock fork of ufmt
SPI Flash Layout
Platform Level Data Model (PLDM)
Description of the Platform Level Data Model, which is used for communication between management controllers and managed devices
PLDM Update Package
Describes the package format used for Caliptra streaming boot and firmware updates
MCTP Stack
Overview of the MCTP protocol and API
Caliptra Manufacturer Control Unit (MCU) Firmware and SDK
Overview of MCU's features
Flash Controller
Overview of the flash controller stack and its API
Caliptra DPE
Caliptra
Caliptra Subsystem
Caliptra Subsystem Integration Specification
Integration specification for the Caliptra Subsystem
Power Manager Checklist
Caliptra RTL
Caliptra
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 RTL
Caliptra SW
Caliptra Subsystem
Caliptra SW
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