wolfBoot/docs
Brett Nicholas a3af00114b Improve docs for USER_XXX variables to clarify intent 2025-12-10 07:43:32 +01:00
..
png
API.md Add docs for NSC APIs and update H5 option bytes 2025-10-29 15:02:58 +01:00
CMake.md Minor docs update, code review changes, script modifications. 2025-11-24 13:04:06 -08:00
HAL.md Peer review fixes. Added new WOLFBOOT_RESTORE_CLOCK option 2025-11-19 11:11:28 +01:00
Loader.md Adds `factory_wstage1.bin` option to include first stage loader. Fix test-app verbose issue. 2023-04-21 16:41:00 +02:00
PQ.md Improve docs, add targets and tests per https://github.com/wolfSSL/wolfBoot/pull/598#pullrequestreview-3492319645 2025-11-21 17:54:14 -08:00
README.md Improve docs, add targets and tests per https://github.com/wolfSSL/wolfBoot/pull/598#pullrequestreview-3492319645 2025-11-21 17:54:14 -08:00
Renesas.md Added Renesas RX TSIP encrypted updates support using AES CTR. Requires https://github.com/wolfSSL/wolfssl/pull/8854 2025-06-16 19:05:49 +02:00
STM32-TZ.md Various STM32 TrustZone improvements 2025-11-20 18:00:55 +01:00
Signing.md Improve docs for USER_XXX variables to clarify intent 2025-12-10 07:43:32 +01:00
TPM.md Fixes to properly support TPM policy with more than one PCR. 2024-09-10 20:53:10 +02:00
Targets.md nRF5340 TrustZone port 2025-11-25 03:01:03 +01:00
Windows.md CMake Improvements 2025-11-18 17:44:43 -08:00
ata_security.md fixup! docs: add ATA security documentation 2024-05-08 09:32:03 +02:00
azure_keyvault.md Minor doc fixes. 2024-07-03 11:48:17 -07:00
compile.md Improve docs for USER_XXX variables to clarify intent 2025-12-10 07:43:32 +01:00
encrypted_partitions.md Added ENCRYPT_CACHE= config option 2025-02-12 10:48:23 +01:00
firmware_image.md - Infineon TC3xx support 2024-07-31 09:22:31 +02:00
firmware_update.md Add wolfHSM cert chain verification for ECC and RSA 2025-05-27 15:42:59 -06:00
flash-OTP.md Fixes for STM32H5 TrustZone and PKCS11 store 2025-10-10 19:42:20 +02:00
flash_partitions.md * Added support for RX65N and RX72N with native Makefile and RX ELF GCC compiler. 2024-07-17 06:08:31 +02:00
keystore.md Improve docs for USER_XXX variables to clarify intent 2025-12-10 07:43:32 +01:00
lib.md Implement filesystem-based partition state access and CLI tools 2025-10-30 16:31:27 +01:00
measured_boot.md Initial support for NXP LS1028A. Booting into OCRAM app. Updates to ARMv8 startup. 2024-12-02 19:41:26 +01:00
remote_flash.md
wolfHSM.md Fixes for unused variables. Also repaired STM32WB55 build with PKA 2025-11-20 18:26:58 +01: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.
  • 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.
  • 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.
  • 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.