Skip to content

Commit 1f4659b

Browse files
tamasan238danielinux
authored andcommitted
fix links
1 parent 844a36a commit 1f4659b

File tree

9 files changed

+36
-36
lines changed

9 files changed

+36
-36
lines changed

wolfBoot/src/appendix01.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ DISK_LOCK_PASSWORD=hardcoded_password
2121
If the ATA disk has no password set, the disk will be locked with the password provided at the first boot.
2222

2323
## Unlocking the Disk with a TPM-Sealed Secret
24-
wolfBoot allows to seal secret safely in the TPM in a way that it can be unsealed only under specific conditions. Please refer to files TPM.md and measured_boot.md for more information.
24+
wolfBoot allows to seal secret safely in the TPM in a way that it can be unsealed only under specific conditions. Please refer to [Appendix M](appendix13.md) and [Appendix G](appendix07.md)for more information.
2525
If the options `WOLFBOOT_TPM_SEAL` and `DISK_LOCK` are enabled, wolfBoot will use a TPM sealed secret as the password to unlock the disk. The following options controls the sealing and unsealing of the secret:
2626

2727
| Option | Description |

wolfBoot/src/appendix02.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ the keystore.
3030
## Signing the firmware image for wolfBoot
3131

3232
The signing operation using any external HSM is performed through three-steps,
33-
as described in the relevant section in [Signing.md](signing.md).
33+
as described in the relevant section in [Appendix B](appendix02.md).
3434
In this section we describe the procedure to sign the firmware image using Azure key vault.
3535

3636

wolfBoot/src/appendix10.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@
33
Platforms Supported:
44

55
- Renesas RZ (RZN2L) (RSIP)
6-
- [docs/Targets.md#renesas-rzn2l](/docs/Targets.md#renesas-rzn2l)
7-
- [IDE/Renesas/e2studio/RZN2L/Readme.md](/IDE/Renesas/e2studio/RZN2L/Readme.md)
8-
- [IDE/Renesas/e2studio/RZN2L/Readme_wRSIP.md](/IDE/Renesas/e2studio/RZN2L/Readme_wRSIP.md)
6+
- [chapter03.md#renesas-rzn2l](chapter03.md#renesas-rzn2l)
7+
- IDE/Renesas/e2studio/RZN2L/Readme.md
8+
- IDE/Renesas/e2studio/RZN2L/Readme_wRSIP.md
99
- Renesas RA (RA6M4) (SCE)
10-
- [docs/Targets.md#renesas-ra6m4](/docs/Targets.md#renesas-ra6m4)
11-
- [IDE/Renesas/e2studio/RA6M4/Readme.md](/IDE/Renesas/e2studio/RA6M4/Readme.md)
12-
- [IDE/Renesas/e2studio/RA6M4/Readme_withSCE.md](/IDE/Renesas/e2studio/RA6M4/Readme_withSCE.md)
10+
- [chapter03.md#renesas-ra6m4](chapter03.md#renesas-ra6m4)
11+
- IDE/Renesas/e2studio/RA6M4/Readme.md
12+
- IDE/Renesas/e2studio/RA6M4/Readme_withSCE.md
1313
- Renesas RX (RX65N/RX72N) (TSIP)
14-
- [docs/Targets.md#renesas-rx72n](/docs/Targets.md#renesas-rx72n)
15-
- [IDE/Renesas/e2studio/RX72N/Readme.md](/IDE/Renesas/e2studio/RX72N/Readme.md)
16-
- [IDE/Renesas/e2studio/RX72N/Readme_withTSIP.md](/IDE/Renesas/e2studio/RX72N/Readme_withTSIP.md)
14+
- [chapter03.md#renesas-rx72n](chapter03.md#renesas-rx72n)
15+
- IDE/Renesas/e2studio/RX72N/Readme.md
16+
- IDE/Renesas/e2studio/RX72N/Readme_withTSIP.md
1717

1818
All of the Renesas examples support using e2Studio.
1919
The Renesas RX parts support using wolfBoot Makefile's with the rx-elf-gcc cross-compiler and example .config files.

wolfBoot/src/appendix11.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ The files generate by the keygen tool is the following:
6161
- A binary file `keystore.img` that can be used to provision the public keys through an alternative storage
6262
- The private key, for each `-g` option provided from command line
6363

64-
For more information about the keystore mechanism, see [keystore.md](@@@need to change here@@@).
64+
For more information about the keystore mechanism, see [Appendix D](appendix04.md).
6565

6666

6767
### Sign tool
@@ -283,4 +283,4 @@ tools/bin-assemble/bin-assemble factory.bin 0x0 wolfboot.bin \
283283

284284
### Signing Firmware with Azure Key Vault
285285

286-
See [docs/azure_keyvault.md](@@@need to change here@@@).
286+
See [Appendix B](appendix02.md).

wolfBoot/src/appendix13.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ In wolfBoot we support TPM based root of trust, sealing/unsealing, cryptographic
1212
| `WOLFBOOT_TPM_KEYSTORE_NV_BASE=0x` | `WOLFBOOT_TPM_KEYSTORE_NV_BASE=0x` | NV index in platform range 0x1400000 - 0x17FFFFF. |
1313
| `WOLFBOOT_TPM_KEYSTORE_AUTH=secret` | `WOLFBOOT_TPM_KEYSTORE_AUTH` | Password for NV access |
1414
| `MEASURED_BOOT=1` | `WOLFBOOT_MEASURED_BOOT` | Enable measured boot. Extend PCR with wolfBoot hash. |
15-
| `MEASURED_PCR_A=16` | `WOLFBOOT_MEASURED_PCR_A=16` | The PCR index to use. See [docs/measured_boot.md](/docs/measured_boot.md). |
15+
| `MEASURED_PCR_A=16` | `WOLFBOOT_MEASURED_PCR_A=16` | The PCR index to use. See [Appendix G](appendix07.md). |
1616
| `WOLFBOOT_TPM_SEAL=1` | `WOLFBOOT_TPM_SEAL` | Enables support for sealing/unsealing based on PCR policy signed externally. |
1717
| `WOLFBOOT_TPM_SEAL_NV_BASE=0x01400300` | `WOLFBOOT_TPM_SEAL_NV_BASE` | To override the default sealed blob storage location in the platform hierarchy. |
1818
| `WOLFBOOT_TPM_SEAL_AUTH=secret` | `WOLFBOOT_TPM_SEAL_AUTH` | Password for sealing/unsealing secrets, if omitted the PCR policy will be used |

wolfBoot/src/chapter02.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ Note: if you are using an external FLASH (e.g. SPI) in combination with a flash
222222
### Using One-time programmable (OTP) flash as keystore
223223

224224
By default, keys are directly incorporated in the firmware image. To store the keys in a separate, one-time programmable (OTP) flash memory, use the `FLASH_OTP_KEYSTORE=1` option.
225-
For more information, see [/docs/OTP-keystore.md](@@@need to change here@@@).
225+
For more information, see [Appendix C](appendix03.md).
226226

227227
### Prefer multi-sector flash erase operations
228228

wolfBoot/src/chapter03.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ non-secure callables (NSC).
168168

169169
The example configuration for this scenario is available in `/config/examples/stm32l5-wolfcrypt-tz.config`.
170170

171-
For more information, see [/docs/STM32-TZ.md](@@@need to change here@@@).
171+
For more information, see [Appendix L](appendix12.md).
172172

173173

174174
### Scenario 3: Trustzone Disabled, using DUAL BANK
@@ -316,9 +316,9 @@ This option can be enabled with the `WOLFCRYPT_TZ=1` and `WOLFCRYPT_TZ_PKCS11=1`
316316
options in your configuration. This enables a PKCS11 accessible from NS domain via
317317
non-secure callables (NSC).
318318

319-
The example configuration for this scenario is available in [/config/examples/stm32u5-wolfcrypt-tz.config](/config/examples/stm32u5-wolfcrypt-tz.config).
319+
The example configuration for this scenario is available in `/config/examples/stm32u5-wolfcrypt-tz.config`.
320320

321-
For more information, see [/docs/STM32-TZ.md](/docs/STM32-TZ.md).
321+
For more information, see [Appendix L](appendix12.md).
322322

323323

324324
### Scenario 3: TrustZone Disabled (DUAL BANK mode)
@@ -535,9 +535,9 @@ with RSA2048:
535535

536536
### Building STM32C0
537537

538-
Reference configuration files (see [config/examples/stm32c0.config](/config/examples/stm32c0.config),
539-
[config/examples/stm32c0-rsa2048.config](/config/examples/stm32c0-rsa2048.config) and
540-
[config/examples/stm32c0-lms-8-10-1.config](/config/examples/stm32c0-lms-8-10-1.config)).
538+
Reference configuration files (see `config/examples/stm32c0.config`,
539+
`config/examples/stm32c0-rsa2048.config` and
540+
`config/examples/stm32c0-lms-8-10-1.config`).
541541

542542
You can copy one of these to wolfBoot root as `.config`: `cp ./config/examples/stm32c0.config .config`.
543543
To build you can use `make`.
@@ -868,7 +868,7 @@ through different scenarios.
868868
Additionally, wolfBoot can be compiled with `FLASH_OTP_KEYSTORE` option, to store
869869
the public key(s) used for firmware authentication into a dedicated, one-time
870870
programmable flash area that can be write protected.
871-
For more information, see [/docs/flash-OTP.md](/docs/flash-OTP.md).
871+
For more information, see [Appendix C](appendix03.md).
872872

873873
### Scenario 1: TrustZone enabled, staging non-secure application
874874

@@ -880,7 +880,7 @@ SRAM memories into two parts:
880880
- the first 256KB are used by wolfboot running in secure mode and the secure application
881881
- the remaining available space is used for non-secure application and update partition
882882

883-
The example configuration for this scenario is available in [/config/examples/stm32h5.config](/config/examples/stm32h5.config).
883+
The example configuration for this scenario is available in `/config/examples/stm32h5.config`.
884884

885885
#### How to use it
886886

@@ -897,7 +897,7 @@ The example configuration for this scenario is available in [/config/examples/st
897897
- flash the application image to the non-secure partition:
898898
`STM32_Programmer_CLI -c port=swd -d test-app/image_v1_signed.bin 0x08040000`
899899

900-
For a full list of all the option bytes tested with this configuration, refer to [STM32-TZ.md](/docs/STM32-TZ.md).
900+
For a full list of all the option bytes tested with this configuration, refer to [Appendix L](appendix12.md).
901901

902902
### Scenario 2: TrustZone Enabled, wolfCrypt as secure engine for NS applications
903903

@@ -908,9 +908,9 @@ This option can be enabled with the `WOLFCRYPT_TZ=1` and `WOLFCRYPT_TZ_PKCS11=1`
908908
options in your configuration. This enables a PKCS11 accessible from NS domain via
909909
non-secure callables (NSC).
910910

911-
The example configuration for this scenario is available in [/config/examples/stm32h5-tz.config](/config/examples/stm32h5-tz.config).
911+
The example configuration for this scenario is available in `/config/examples/stm32h5-tz.config`.
912912

913-
For more information, see [/docs/STM32-TZ.md](/docs/STM32-TZ.md).
913+
For more information, see [Appendix L](appendix12.md).
914914

915915
### Scenario 3: DUALBANK mode
916916

@@ -1366,7 +1366,7 @@ tested with MpLab IDE v. 6.20.
13661366
The example application can be used to update the firmware over USB.
13671367

13681368
More details about building the example projects can be found in the
1369-
[IDE/MPLAB](/IDE/MPLAB) directory in this repository.
1369+
`IDE/MPLAB` directory in this repository.
13701370

13711371

13721372
### Uploading the bootloader and the firmware image
@@ -1999,7 +1999,7 @@ c
19991999

20002000
## TI Hercules TMS570LC435
20012001

2002-
See [/config/examples/ti-tms570lc435.config](/config/examples/ti-tms570lc435.config) for example configuration.
2002+
See `/config/examples/ti-tms570lc435.config` for example configuration.
20032003

20042004

20052005

@@ -2166,7 +2166,7 @@ With RX GCC path or or custom cross compiler directly:
21662166
OR
21672167
`make RX_GCC_PATH="~/toolchains/gcc_8.3.0.202311_rx_elf"`
21682168

2169-
TSIP: To enable TSIP use `make PKA=1`. See [docs/Renesas.md](docs/Renesas.md) for details.
2169+
TSIP: To enable TSIP use `make PKA=1`. See [Appendix J](appendix10.md) for details.
21702170

21712171
### Flashing Renesas RX65N
21722172

@@ -2202,7 +2202,7 @@ Create a new "Renesas Debug" project. Choose the "E2 Lite" emulator and the buil
22022202

22032203
Tested on the RX72N ENVISION KIT (HMI development kit for IoT systems). This includes an onboard E2 Lite emulator.
22042204

2205-
The Renesas RX72N is supported either natively with "make" or through e2Studio. If using e2Studio see [Readme.md](../IDE/Renesas/e2studio/RX72N/Readme.md).
2205+
The Renesas RX72N is supported either natively with "make" or through e2Studio. If using e2Studio see `/IDE/Renesas/e2studio/RX72N/Readme.md`.
22062206

22072207
Default UART Serial on SCI2 at P12-RXD2 P13-TXD2. Use USB on CN8 to attach a Virtual USB COM port. This feaure is enabled with `DEBUG_UART=1`.
22082208

@@ -2280,7 +2280,7 @@ OR
22802280
`make RX_GCC_PATH="~/toolchains/gcc_8.3.0.202311_rx_elf"`
22812281

22822282

2283-
TSIP: To enable TSIP use `make PKA=1`. See [docs/Renesas.md](@@@need to change here@@@) for details.
2283+
TSIP: To enable TSIP use `make PKA=1`. See [Appendix J](appendix10.md) for details.
22842284

22852285
### Flashing Renesas RX72N
22862286

@@ -2747,7 +2747,7 @@ IMAGE=test-app/image.elf SIGN=--ecc384 tools/scripts/x86_fsp/qemu/make_hd.sh
27472747
./tools/scripts/x86_fsp/qemu/qemu.sh -t
27482748
```
27492749

2750-
For more advanced uses of TPM, please check [TPM.md](@@@need to change here@@@) to configure wolfBoot
2750+
For more advanced uses of TPM, please check [Appendix M](appendix13.md) to configure wolfBoot
27512751
according to your secure boot strategy.
27522752

27532753
### Running on Kontron VX3060-S2

wolfBoot/src/chapter06.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -440,7 +440,7 @@ The custom fields are identified by a 16-bit tag, and their size is indicated by
440440

441441
At runtime, the values stored in the manifest header can be accessed using the `wolfBoot_find_header` function.
442442

443-
The syntax for `--custom-tlv` option is also documented in [docs/Signing.md](@@@need to change here@@@/docs/Signing.md#adding-custom-fields-to-the-manifest-header).
443+
The syntax for `--custom-tlv` option is also documented in [Appendix H](appendix08.md).
444444

445445
#### Image header: Example
446446

@@ -635,7 +635,7 @@ Consider implementing these three functions based on the provided examples if yo
635635

636636
On the remote system hosting the external partition image for the target, a simple protocol can be implemented on top of UART messages to serve flash-access specific calls.
637637

638-
An example uart-flash-server daemon, designed to run on a GNU/Linux host and emulate the external partition with a local file on the filesystem, is available in [tools/uart-flash-server](tools/uart-flash-server).
638+
An example uart-flash-server daemon, designed to run on a GNU/Linux host and emulate the external partition with a local file on the filesystem, is available in `tools/uart-flash-server`.
639639

640640

641641
### External flash update mechanism

wolfBoot/src/chapter07.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
- Equip the application with the [wolfBoot library](chapter06.md#application-interface-for-interactions-with-the-bootloader) to interact with the bootloader
1010
- [Configure and compile](chapter02.md#compiling-wolfboot) a bootable image with a single "make" command
1111
- For help signing firmware see [wolfBoot Signing](chapter06.md#signing)
12-
- For enabling measured boot see [wolfBoot measured boot](chapter06.md#measured-boot)
12+
- For enabling measured boot see [wolfBoot measured boot](chapter06.md)
1313

1414
## Examples provided
1515

@@ -28,7 +28,7 @@ The factory image can be flashed to the target device. It contains the bootloade
2828

2929
The `sign.py` tool transforms a bootable firmware image to comply with the firmware image format required by the bootloader.
3030

31-
For detailed information about the firmware image format, see [Firmware image](chapter06.md#firmware-image)
31+
For detailed information about the firmware image format, see [Firmware image](chapter06.md)
3232

3333
For detailed information about the configuration options for the target system, see [Compiling wolfBoot](chapter02.md#compiling-wolfboot)
3434

0 commit comments

Comments
 (0)