wolfBoot/docs
David Garske 80a186f5c5
Merge pull request #953 from bigbrett/tc3-port-tweaks
Monolithic self-update version check + TC3xx/wolfHSM changes
2026-10-30 10:47:03 -07:00
..
png
…
API.md
…
Agilex5.md Add Agilex 5 FCS and wolfBoot integration 2026-10-15 10:25:33 -07:00
CMake.md
…
DICE.md address PR 918 review: TOUCH_LINES AES, finish ESP256 migration in docs 2026-10-01 17:20:43 +02:00
FIPS.md Peer review fixes (thanks Jack) 2026-08-24 12:47:34 +02:00
HAL.md Update docs and comment cleanup 2026-10-27 16:46:40 +01:00
Loader.md
…
MCXN947-DICE.md
…
PQ.md
…
PolarFire.md PolarFire SoC: boot the HSS replacement from eMMC and QSPI into DDR 2026-10-28 21:06:08 -07:00
README.md PolarFire SoC: consolidate the documentation into docs/PolarFire.md with a quick start 2026-10-27 16:06:05 -07:00
Renesas.md Add RX71M CC-RX e2 studio projects 2026-10-29 07:01:54 +01:00
SBOM.md sbom: drop nested wolfcrypt CPE 2026-09-24 13:10:18 +02:00
STM32-TZ.md
…
Signing.md keytools: allow linking against an installed wolfSSL 2026-10-20 16:01:23 +02:00
TPM.md tpm: add a TIS-over-I2C transport and a generic I2C driver interface 2026-10-06 18:14:10 +02:00
Targets.md Add RX71M CC-RX e2 studio projects 2026-10-29 07:01:54 +01:00
Windows.md
…
ata_security.md
…
azure_keyvault.md
…
compile.md Merge pull request #953 from bigbrett/tc3-port-tweaks 2026-10-30 10:47:03 -07:00
encrypted_partitions.md PolarFire SoC: consolidate the documentation into docs/PolarFire.md with a quick start 2026-10-27 16:06:05 -07:00
firmware_image.md
…
firmware_update.md self-update: check self-header version in monolithic mode 2026-10-27 09:09:21 -07:00
flash-OTP.md
…
flash_partitions.md Refuse partitions too small for the trailer, add STM32F4 custom trailer (#937) 2026-10-28 14:35:31 +01:00
fwTPM.md Document the STM32H5 fwTPM secure RAM budget and stack reservation 2026-09-17 13:06:11 +02:00
hooks.md hooks: add pre-boot hook, DTB accessor and FDT alias/reg helpers 2026-09-21 18:10:09 +02:00
keystore.md PolarFire SoC: consolidate the documentation into docs/PolarFire.md with a quick start 2026-10-27 16:06:05 -07:00
lib.md static library docs 2026-09-01 09:19:36 -06:00
measured_boot.md
…
remote_flash.md
…
secure_app_handoff.md Add an MCXN947 secure application handoff config with m33mu tests 2026-10-23 18:27:33 +01:00
wolfHAL.md Rename board.h to wolfHAL_board.h 2026-09-22 15:29:32 +02:00
wolfHSM.md Merge pull request #953 from bigbrett/tc3-port-tweaks 2026-10-30 10:47:03 -07:00

README.md

wolfBoot Docs and Platform-Specific Details

See also: wolfBoot Product Overview and wolfBoot Manual.

  • API.md - Overview of wolfBoot public APIs and how to use them.
  • ata_security.md - ATA security features (lock/unlock, passwords) and wolfBoot integration.
  • azure_keyvault.md - Using Azure Key Vault for key management and signing with wolfBoot.
  • CMake.md - CMake-based build setup, presets, toolchains, and tips for building wolfBoot.
  • compile.md - How to build/compile wolfBoot (toolchains, options, typical steps).
  • encrypted_partitions.md - Creating and managing encrypted firmware/data partitions.
  • firmware_image.md - wolfBoot firmware image format, layout, and metadata.
  • firmware_update.md - Update flow: slots, verification, rollback, and recovery.
  • FIPS.md - Building wolfBoot with the wolfCrypt FIPS 140-3 module: approved algorithms, DRBG entropy, and in-core integrity sealing.
  • flash-OTP.md - Using One-Time Programmable (OTP) regions in flash for secure data.
  • flash_partitions.md - Flash partitioning schemes and configuration guidance.
  • HAL.md - Hardware Abstraction Layer notes and porting considerations.
  • hooks.md - User-defined hooks for injecting custom logic into the wolfBoot boot process.
  • keystore.md - Keystore design, key storage, and access strategies.
  • lib.md - Using wolfBoot as a library and linking/integration guidance.
  • Loader.md - Loader/secondary stage behavior and handoff to application.
  • measured_boot.md - Measured boot concepts and recording measurements (e.g., PCRs).
  • png/ - Folder of images/diagrams referenced by the documentation.
  • PolarFire.md - Microchip PolarFire SoC: quick start, boot configurations, sNVM/PUF key storage, SBI vendor extension, boot mode 2.
  • PQ.md - Post-quantum algorithms and PQC support in wolfBoot.
  • README.md - Overview and index of the documentation set.
  • remote_flash.md - Working with external/remote flash (SPI/QSPI, mapping, access).
  • Renesas.md - Notes and specifics for Renesas platforms/ports.
  • Signing.md - Keys, signatures, and the image signing workflow.
  • STM32-TZ.md - STM32 TrustZone (Armv8-M) setup and usage with wolfBoot.
  • STM32.md - STM32 platform notes, options, and integration tips.
  • Targets.md - Supported targets and platform-specific configuration.
  • TPM.md - TPM integration, measured boot, and attestation flows.
  • wolfHSM.md - Integrating wolfHSM with wolfBoot for secure key operations.