# Summary

[OpenTitan](./doc/introduction.md)

# Hardware

- [Introduction](./hw/README.md)

- [Top Earlgrey](./hw/top_earlgrey/README.md)
  - [Datasheet](./hw/top_earlgrey/doc/specification.md)
  - [Design](./hw/top_earlgrey/doc/design/README.md)
  - [Design Verification](./hw/top_earlgrey/dv/README.md)
  - [Analog Sensor Top](./hw/top_earlgrey/ip/ast/README.md)
  - [Alert Handler](./hw/top_earlgrey/ip_autogen/alert_handler/README.md)
    - [Design Verification](./hw/top_earlgrey/ip_autogen/alert_handler/dv/README.md)
    - [Checklist](./hw/top_earlgrey/ip_autogen/alert_handler/doc/checklist.md)
  - [Interrupt Controller](./hw/top_earlgrey/ip_autogen/rv_plic/README.md)
    - [Design Verification](./hw/top_earlgrey/ip_autogen/rv_plic/doc/dv/README.md)
    - [Checklist](./hw/top_earlgrey/ip_autogen/rv_plic/doc/checklist.md)
  - [Sensor Control](./hw/top_earlgrey/ip/sensor_ctrl/README.md)
    - [Checklist](./hw/top_earlgrey/ip/sensor_ctrl/doc/checklist.md)
  - [TL-UL Checklist](./hw/top_earlgrey/ip/xbar/doc/checklist.md)
  - [Pinmux Targets](./hw/top_earlgrey/ip/pinmux/doc/autogen/targets.md)
    - [ASIC Target Pinout and Pinmux Connectivity](./hw/top_earlgrey/ip/pinmux/doc/autogen/pinout_asic.md)
    - [CW310 Target Pinout and Pinmux Connectivity](./hw/top_earlgrey/ip/pinmux/doc/autogen/pinout_cw310.md)
    - [NEXYSVIDEO Target Pinout and Pinmux Connectivity](./hw/top_earlgrey/ip/pinmux/doc/autogen/pinout_nexysvideo.md)

- [Cores](./hw/doc/cores.md)
  - [Ibex RISC-V Core Wrapper](./hw/ip/rv_core_ibex/README.md)
    - [Design Verification](./hw/ip/rv_core_ibex/dv/README.md)
    - [Checklist](./hw/ip/rv_core_ibex/doc/checklist.md)
  - [OTBN](./hw/ip/otbn/README.md)
    - [Developer Guide](./hw/ip/otbn/doc/developer-guide.md)
    - [ISA Guide](./hw/ip/otbn/doc/isa.md)
    - [Design Verification](./hw/ip/otbn/dv/README.md)
      - [Random Instruction Generator](./hw/ip/otbn/dv/rig/README.md)
        - [Internals](./hw/ip/otbn/dv/rig/rig/README.md)
        - [Configuration](./hw/ip/otbn/dv/rig/rig/configs/README.md)
      - [memutil wrapper](./hw/ip/otbn/dv/memutil/README.md)
      - [OTBN Simulation Software](./hw/ip/otbn/dv/otbnsim/README.md)
      - [Tracer](./hw/ip/otbn/dv/tracer/README.md)
      - [Formal Masking Verification Using Alma](./hw/ip/otbn/pre_sca/alma/README.md)
    - [Functional Coverage](./hw/ip/otbn/dv/doc/fcov.md)
    - [Checklist](./hw/ip/otbn/doc/checklist.md)

- [Hardware IP Blocks](./hw/ip/README.md)
  - [Analog to Digital Converter Control](./hw/ip/adc_ctrl/README.md)
    - [Design Verification](./hw/ip/adc_ctrl/dv/README.md)
    - [Checklist](./hw/ip/adc_ctrl/doc/checklist.md)
  - [AES](./hw/ip/aes/README.md)
    - [Design Verification](./hw/ip/aes/dv/README.md)
    - [Checklist](./hw/ip/aes/doc/checklist.md)
  - [AON Timer](./hw/ip/aon_timer/README.md)
    - [Design Verification](./hw/ip/aon_timer/dv/README.md)
    - [Checklist](./hw/ip/aon_timer/doc/checklist.md)
  - [Clock Manager](./hw/ip/clkmgr/README.md)
    - [Design Verification](./hw/ip/clkmgr/dv/README.md)
    - [Checklist](./hw/ip/clkmgr/doc/checklist.md)
  - [CSRNG](./hw/ip/csrng/README.md)
    - [Design Verification](./hw/ip/csrng/dv/README.md)
    - [Checklist](./hw/ip/csrng/doc/checklist.md)
  - [EDN](./hw/ip/edn/README.md)
    - [Design Verification](./hw/ip/edn/dv/README.md)
    - [Checklist](./hw/ip/edn/doc/checklist.md)
  - [Entropy Source](./hw/ip/entropy_src/README.md)
    - [Design Verification](./hw/ip/entropy_src/dv/README.md)
    - [Checklist](./hw/ip/entropy_src/doc/checklist.md)
  - [Flash Controller](./hw/ip/flash_ctrl/README.md)
    - [Design Verification](./hw/ip/flash_ctrl/dv/README.md)
    - [Checklist](./hw/ip/flash_ctrl/doc/checklist.md)
  - [GPIO](./hw/ip/gpio/README.md)
    - [Design Verification](./hw/ip/gpio/dv/README.md)
    - [Checklist](./hw/ip/gpio/doc/checklist.md)
  - [HMAC](./hw/ip/hmac/README.md)
    - [Design Verification](./hw/ip/hmac/dv/README.md)
    - [Checklist](./hw/ip/hmac/doc/checklist.md)
  - [I2C](./hw/ip/i2c/README.md)
    - [Design Verification](./hw/ip/i2c/dv/README.md)
    - [Checklist](./hw/ip/i2c/doc/checklist.md)
  - [Key Manager](./hw/ip/keymgr/README.md)
    - [Design Verification](./hw/ip/keymgr/dv/README.md)
    - [Checklist](./hw/ip/keymgr/doc/checklist.md)
  - [KMAC](./hw/ip/kmac/README.md)
    - [Design Verification](./hw/ip/kmac/dv/README.md)
    - [Checklist](./hw/ip/kmac/doc/checklist.md)
  - [Life Cycle Controller](./hw/ip/lc_ctrl/README.md)
    - [Design Verification](./hw/ip/lc_ctrl/dv/README.md)
    - [Checklist](./hw/ip/lc_ctrl/doc/checklist.md)
  - [OTP Controller](./hw/ip/otp_ctrl/README.md)
    - [Design Verification](./hw/ip/otp_ctrl/dv/README.md)
    - [Checklist](./hw/ip/otp_ctrl/doc/checklist.md)
  - [Pattern Generator](./hw/ip/pattgen/README.md)
    - [Design Verification](./hw/ip/pattgen/dv/README.md)
    - [Checklist](./hw/ip/pattgen/doc/checklist.md)
  - [Pinmux](./hw/ip/pinmux/README.md)
    - [Design Verification](./hw/ip/pinmux/doc/dv/README.md)
    - [Checklist](./hw/ip/pinmux/doc/checklist.md)
  - [Pulse Width Modulator](./hw/ip/pwm/README.md)
    - [Design Verification](./hw/ip/pwm/dv/README.md)
    - [Checklist](./hw/ip/pwm/doc/checklist.md)
  - [Power Management](./hw/ip/pwrmgr/README.md)
    - [Design Verification](./hw/ip/pwrmgr/dv/README.md)
    - [Checklist](./hw/ip/pwrmgr/doc/checklist.md)
  - [ROM Control](./hw/ip/rom_ctrl/README.md)
    - [Design Verification](./hw/ip/rom_ctrl/dv/README.md)
    - [Checklist](./hw/ip/rom_ctrl/doc/checklist.md)
  - [Reset Manager](./hw/ip/rstmgr/README.md)
    - [Design Verification](./hw/ip/rstmgr/dv/README.md)
    - [Checklist](./hw/ip/rstmgr/doc/checklist.md)
  - [RISC-V Debug Manager](./hw/ip/rv_dm/README.md)
    - [Design Verification](./hw/ip/rv_dm/dv/README.md)
    - [Checklist](./hw/ip/rv_dm/doc/checklist.md)
  - [SPI Device](./hw/ip/spi_device/README.md)
    - [Design Verification](./hw/ip/spi_device/dv/README.md)
    - [Checklist](./hw/ip/spi_device/doc/checklist.md)
  - [SPI Host](./hw/ip/spi_host/README.md)
    - [Design Verification](./hw/ip/spi_host/dv/README.md)
    - [Checklist](./hw/ip/spi_host/doc/checklist.md)
  - [SRAM Controller](./hw/ip/sram_ctrl/README.md)
    - [Design Verification](./hw/ip/sram_ctrl/dv/README.md)
    - [Checklist](./hw/ip/sram_ctrl/doc/checklist.md)
  - [System Reset Controller](./hw/ip/sysrst_ctrl/README.md)
    - [Design Verification](./hw/ip/sysrst_ctrl/dv/README.md)
    - [Checklist](./hw/ip/sysrst_ctrl/doc/checklist.md)
  - [Timer](./hw/ip/rv_timer/README.md)
    - [Design Verification](./hw/ip/rv_timer/dv/README.md)
    - [Checklist](./hw/ip/rv_timer/doc/checklist.md)
  - [TL-UL Bus](./hw/ip/tlul/README.md)
    - [Design Verification](./hw/ip/tlul/doc/dv/README.md)
      - [Protocol Checker](./hw/ip/tlul/doc/TlulProtocolChecker.md)
  - [UART](./hw/ip/uart/README.md)
    - [Design Verification](./hw/ip/uart/dv/README.md)
    - [Checklist](./hw/ip/uart/doc/checklist.md)
  - [USB 2.0](./hw/ip/usbdev/README.md)
    - [Design Verification](./hw/ip/usbdev/dv/README.md)
    - [Suspending and Resuming](./hw/ip/usbdev/doc/wake_resume.md)
    - [Checklist](./hw/ip/usbdev/doc/checklist.md)
  - [lowRISC Hardware Primitives](./hw/ip/prim/README.md)
    - [Two Input Clock](./hw/ip/prim/doc/prim_clock_gp_mux2.md)
    - [Flash Wrapper](./hw/ip/prim/doc/prim_flash.md)
    - [Keccak Permutation](./hw/ip/prim/doc/prim_keccak.md)
    - [Linear Feedback Shift Register](./hw/ip/prim/doc/prim_lfsr.md)
    - [Packer](./hw/ip/prim/doc/prim_packer.md)
    - [Packer FIFO](./hw/ip/prim/doc/prim_packer_fifo.md)
    - [Present Scrambler](./hw/ip/prim/doc/prim_present.md)
    - [Prince Scrambler](./hw/ip/prim/doc/prim_prince.md)
    - [SRAM Scrambler](./hw/ip/prim/doc/prim_ram_1p_scr.md)
    - [Pseudo Random Number Generator](./hw/ip/prim/doc/prim_xoshiro256pp.md)

- [Common SystemVerilog and UVM Components](./hw/dv/sv/README.md)
  - [ALERT_ESC Agent](./hw/dv/sv/alert_esc_agent/README.md)
  - [Bus Params Package](./hw/dv/sv/bus_params_pkg/README.md)
  - [Comportable IP Testbench Architecture](./hw/dv/sv/cip_lib/README.md)
  - [Common Interfaces](./hw/dv/sv/common_ifs/README.md)
  - [CSR Utils](./hw/dv/sv/csr_utils/README.md)
  - [CSRNG Agent](./hw/dv/sv/csrng_agent/README.md)
  - [DV Library Classes](./hw/dv/sv/dv_lib/README.md)
  - [DV Utils](./hw/dv/sv/dv_utils/README.md)
  - [FLASH_PHY_PRIM Agent](./hw/dv/sv/flash_phy_prim_agent/README.md)
  - [I2C Agent](./hw/dv/sv/i2c_agent/README.md)
  - [JTAG Agent](./hw/dv/sv/jtag_agent/README.md)
  - [JTAG DMI Agent](./hw/dv/sv/jtag_dmi_agent/README.md)
  - [JTAG RISCV Agent](./hw/dv/sv/jtag_riscv_agent/README.md)
  - [KEY_SIDELOAD Agent](./hw/dv/sv/key_sideload_agent/README.md)
  - [KMAC_APP Agent](./hw/dv/sv/kmac_app_agent/README.md)
  - [Memory Backdoor Scoreboard](./hw/dv/sv/mem_bkdr_scb/README.md)
  - [Memory Backdoor Utility](./hw/dv/sv/mem_bkdr_util/README.md)
  - [Memory Model](./hw/dv/sv/mem_model/README.md)
  - [PATTGEN Agent](./hw/dv/sv/pattgen_agent/README.md)
  - [PUSH_PULL Agent](./hw/dv/sv/push_pull_agent/README.md)
  - [PWM Monitor](./hw/dv/sv/pwm_monitor/README.md)
  - [RNG Agent](./hw/dv/sv/rng_agent/README.md)
  - [Scoreboard](./hw/dv/sv/scoreboard/README.md)
  - [Simulation SRAM](./hw/dv/sv/sim_sram/README.md)
  - [SPI Agent](./hw/dv/sv/spi_agent/README.md)
  - [String Utils](./hw/dv/sv/str_utils/README.md)
  - [Test Vectors](./hw/dv/sv/test_vectors/README.md)
  - [Tile Link Agent](./hw/dv/sv/tl_agent/README.md)
  - [UART Agent](./hw/dv/sv/uart_agent/README.md)
  - [USB20 Agent](./hw/dv/sv/usb20_agent/README.md)

# Software
- [Introduction](./sw/README.md)
- [Build Software](./sw/doc/build_software.md)

- [Device Software](./sw/device/README.md)
  - [Device Libraries](./sw/device/lib/README.md)
    - [DIF Library](./sw/device/lib/dif/README.md)
      - [ADC Checklist](sw/device/lib/dif/dif_adc_ctrl.md)
      - [AES Checklist](sw/device/lib/dif/dif_aes.md)
      - [Alert Handler Checklist](sw/device/lib/dif/dif_alert_handler.md)
      - [Always-On Timer Checklist](sw/device/lib/dif/dif_aon_timer.md)
      - [Clock Manager Checklist](sw/device/lib/dif/dif_clkmgr.md)
      - [CSRNG Checklist](sw/device/lib/dif/dif_csrng.md)
      - [EDN Checklist](sw/device/lib/dif/dif_edn.md)
      - [Entropy Source Checklist](sw/device/lib/dif/dif_entropy_src.md)
      - [Flash Controller Checklist](sw/device/lib/dif/dif_flash_ctrl.md)
      - [GPIO Checklist](sw/device/lib/dif/dif_gpio.md)
      - [HMAC Checklist](sw/device/lib/dif/dif_hmac.md)
      - [I2C Checklist](sw/device/lib/dif/dif_i2c.md)
      - [Key Manager Checklist](sw/device/lib/dif/dif_keymgr.md)
      - [KMAC Checklist](sw/device/lib/dif/dif_kmac.md)
      - [Lifecycle Checklist](sw/device/lib/dif/dif_lc_ctrl.md)
      - [OTBN Checklist](sw/device/lib/dif/dif_otbn.md)
      - [OTP Controller Checklist](sw/device/lib/dif/dif_otp_ctrl.md)
      - [Pattern Generator Checklist](sw/device/lib/dif/dif_pattgen.md)
      - [Pin Multiplexer Checklist](sw/device/lib/dif/dif_pinmux.md)
      - [PWM Checklist](sw/device/lib/dif/dif_pwm.md)
      - [Power Manager Checklist](sw/device/lib/dif/dif_pwrmgr.md)
      - [ROM Checklist](sw/device/lib/dif/dif_rom_ctrl.md)
      - [Reset Manager Checklist](sw/device/lib/dif/dif_rstmgr.md)
      - [RV Core Ibex Checklist](sw/device/lib/dif/dif_rv_core_ibex.md)
      - [PLIC Checklist](sw/device/lib/dif/dif_rv_plic.md)
      - [RV Timer Checklist](sw/device/lib/dif/dif_rv_timer.md)
      - [Sensor Controller Checklist](sw/device/lib/dif/dif_sensor_ctrl.md)
      - [SPI Device Checklist](sw/device/lib/dif/dif_spi_device.md)
      - [SPI Host Checklist](sw/device/lib/dif/dif_spi_host.md)
      - [SRAM Controller Checklist](sw/device/lib/dif/dif_sram_ctrl.md)
      - [System Reset Controller Checklist](sw/device/lib/dif/dif_sysrst_ctrl.md)
      - [UART Checklist](sw/device/lib/dif/dif_uart.md)
      - [USB Checklist](sw/device/lib/dif/dif_usbdev.md)
    - [Top-Level Test Libraries](./sw/device/lib/testing/README.md)
      - [On-Device Test Framework](./sw/device/lib/testing/test_framework/README.md)
    - [OpenTitan Standard Library](./sw/device/lib/base/README.md)
        - [Freestanding C Headers](./sw/device/lib/base/freestanding/README.md)
  - [Silicon Creator Software](./sw/device/silicon_creator/README.md)
    - [Manufacturing Firmware](./sw/device/silicon_creator/manuf/README.md)
    - [ROM](./sw/device/silicon_creator/rom/README.md)
      - [Memory Protection](./sw/device/silicon_creator/rom/doc/memory_protection.md)
      - [Signing Keys](./sw/device/silicon_creator/rom/keys/README.md)
    - [Manifest Format](./sw/device/silicon_creator/rom_ext/doc/manifest.md)
  - [Top-Level Tests](./sw/device/tests/README.md)
    - [Manufacturer Test Hooks](./sw/device/tests/closed_source/README.md)
    - [Crypto Library Tests](./sw/device/tests/crypto/README.md)

- [Host Software](./sw/host/README.md)


# Tooling

- [Tools Overview](./util/README.md)
- [Design-Related Tooling](./util/design/README.md)

- [dvsim: Testplanner](./util/dvsim/README.md)
- [fpvgen: Initial FPV Testbench Generation](./util/fpvgen/README.md)
- [reggen & regtool: Register Generator](./util/reggen/README.md)
  - [Setup and use of regtool](./util/reggen/doc/setup_and_use.md)

- [ralgen: FuseSoC UVM RAL Generator](./hw/dv/tools/ralgen/README.md)
- [uvmdvgen: Initial Testbench Auto-generation](./util/uvmdvgen/README.md)
- [tlgen: Crossbar Generation](./util/tlgen/README.md)
- [ipgen: Generate IP Blocks from IP Templates](./util/ipgen/README.md)
- [topgen: Top Generator](./util/topgen/README.md)
- [vendor: Vendoring In Tool](./util/doc/vendor.md)
- [i2csvg: Generate SVGs of I2C Commands](./util/i2csvg/README.md)


# Contributing

- [Contributing](./doc/contributing/README.md)
  - [Detailed Contribution Guide](./doc/contributing/detailed_contribution_guide/README.md)
  - [Directory Structure](./doc/contributing/directory_structure.md)
  - [Continueous Intergration](./doc/contributing/ci/README.md)
  - [Top-Level Design and Targets](./doc/contributing/system_list.md)
  - [GitHub Notes](./doc/contributing/github_notes.md)
  - [Bazel Notes](./doc/contributing/bazel_notes.md)
  - [Using the Container](./util/container/README.md)

- [Contributing to Hardware]()
  - [Comportability](./doc/contributing/hw/comportability/README.md)
  - [Hardware Design](./doc/contributing/hw/design.md)
  - [Design Methodology](./doc/contributing/hw/methodology.md)
  - [Vendoring in Hardware](./doc/contributing/hw/vendor.md)
  - [Linting](./hw/lint/README.md)
  - [Synthesis Flow](./hw/syn/README.md)

- [Contributing to Verification]()
  - [Verification Methodology](./doc/contributing/dv/methodology/README.md)
  - [Security Countermeasure Verification Framework](./doc/contributing/dv/sec_cm_dv_framework/README.md)
  - [Assertions](./hw/formal/README.md)

- [Contributing to Software]()
  - [Device Interface Functions](./doc/contributing/sw/device_interface_functions.md)
  - [Writing and Building Software for OTBN](./doc/contributing/sw/otbn_sw.md)

- [Style Guides](./doc/contributing/style_guides/README.md)
  - [HJSON](./doc/contributing/style_guides/hjson_usage_style.md)
  - [Python](./doc/contributing/style_guides/python_coding_style.md)
  - [C & C++](./doc/contributing/style_guides/c_cpp_coding_style.md)
  - [Markdown](./doc/contributing/style_guides/markdown_usage_style.md)
  - [RISC-V Assembly](./doc/contributing/style_guides/asm_coding_style.md)
  - [OTBN Assembly](./doc/contributing/style_guides/otbn_style_guide.md)
  - [Guidance for Volatile](./doc/contributing/style_guides/guidance_for_volatile.md)

- [Developing on an FPGA]()
  - [Get a Board](./doc/contributing/fpga/get_a_board.md)
  - [FPGA Reference Manual](./doc/contributing/fpga/ref_manual_fpga.md)

# Project Governance

- [Introduction](./doc/project_governance/README.md)
- [Committers](./doc/project_governance/committers.md)
- [RFC Process](./doc/project_governance/rfc_process.md)
- [Generalized Priority Definitions](./doc/project_governance/priority_definitions.md)
- [OpenTitan Technical Committee](./doc/project_governance/technical_committee.md)
- [Hardware Development Stages](./doc/project_governance/development_stages.md)
- [Signoff Checklist](./doc/project_governance/checklist/README.md)

# Security

- [Security](./doc/security/README.md)
- [Implementation Guidelines](./doc/security/implementation_guidelines/README.md)
  - [Secure Hardware Design Guidelines](./doc/security/implementation_guidelines/hardware/README.md)

- [Logical Security Model](./doc/security/logical_security_model/README.md)
- [Security Model Specification](./doc/security/specs/README.md)
  - [Device Attestation](./doc/security/specs/attestation/README.md)
  - [Device Life Cycle](./doc/security/specs/device_life_cycle/README.md)
  - [Device Provisioning](./doc/security/specs/device_provisioning/README.md)
  - [Firmware Update](./doc/security/specs/firmware_update/README.md)
  - [Identities and Root Keys](./doc/security/specs/identities_and_root_keys/README.md)
  - [Ownership Transfer](./doc/security/specs/ownership_transfer/README.md)
  - [Secure Boot](./doc/security/specs/secure_boot/README.md)

- [Lightweight Threat Model](./doc/security/threat_model/README.md)

# Use Cases

- [Use Cases](./doc/use_cases/README.md)
- [Platform Integrity Module](./doc/use_cases/platform_integrity_module/README.md)
- [Trusted Platform Module](./doc/use_cases/tpm/README.md)
- [Universal 2nd-Factor Security Key](./doc/use_cases/u2f/README.md)


# Rust for C Developers

- [Rust for Embedded C Programmers](./doc/rust_for_c_devs.md)