Device Libraries
Overview
The OpenTitan repository contains device libraries which are used within our Reference Firmware Images, and can (and should) be used by other OpenTitan device software.
These are organised into the sw/device/lib directory.
sw/device/lib/basecontains the Base Libraries, including freestanding C library headers. The Base Libraries are simple libraries that can be used by any other OpenTitan device software libraries.sw/device/lib/difcontains the Device Interface Functions.sw/device/lib/archcontains the libraries to be used on specific device configurations (for instance FPGA, Simulation, etc.).sw/device/lib/runtimecontains general libraries for more advanced on-device functionality (including logging, printing, and interacting with the RISC-V core).sw/device/lib/testingcontains test library code. Test library code is any (reusable) code that could aid in the writing of smoke, IP integration, or system-level tests, that is a layer of above the DIFs. In other words, this code may make use of the DIFs to actuate the hardware, and chip-level test code may make use of this code to actuate the DIFs.
Documentation Index
-
arch: Device-specific Symbols
-
libbase: The OpenTitan Standard Library
-
Freestanding C Headers
-
Device Interface Functions
- The OpenTitan DIF Library
- AES DIF Checklist
- Alert handler DIF Checklist
- Always-On Timer DIF Checklist
- Clock manager DIF Checklist
- CSRNG DIF Checklist
- Entropy Distribution Network DIF Checklist
- Entropy Source DIF Checklist
- GPIO DIF Checklist
- HMAC DIF Checklist
- I2C DIF Checklist
- Key Manager DIF Checklist
- KMAC DIF Checklist
- Lifecycle controller DIF Checklist
- OTBN DIF Checklist
- OTP DIF Checklist
- Pin Multiplexer DIF Checklist
- Power Manager DIF Checklist
- Reset manager DIF Checklist
- PLIC DIF Checklist
- Timer DIF Checklist
- SPI Device DIF Checklist
- SRAM Controller DIF Checklist
- UART DIF Checklist
- USB Device DIF Checklist
-
libruntime: The OpenTitan Runtime Library
- Chip-Level Test Libraries