Skip to content

Commit b9fca1d

Browse files
committed
Fixed documentation relative paths
1 parent 836cfbc commit b9fca1d

2 files changed

Lines changed: 9 additions & 9 deletions

File tree

docs/firmware_image.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ to guarantee that the entry point of the actual firmware is stored on the flash
2020
a 256-Bytes aligned address. This ensures that the bootloader can relocate the vector table before
2121
chain-loading the firmware the interrupt continue to work properly after the boot is complete.
2222

23-
![Image header](docs/png/image_header.png)
23+
![Image header](png/image_header.png)
2424

2525
*The image header is stored at the beginning of the slot and the actual firmware image starts 256 Bytes after it*
2626

@@ -35,7 +35,7 @@ respectively containing:
3535

3636
These three fields are required by the bootloader to verify the integrity and the origin of the firmware image.
3737

38-
![Image trailers](docs/png/image_tlv.png)
38+
![Image trailers](png/image_tlv.png)
3939

4040
*The trailer of a signed firmware contains a TLV header and three TLV records that are used by the bootloader to verify the image*
4141

docs/flash_partitions.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ bootloader erases all the flash sectors before storing a firmware image.
1111

1212
The flash memory of the target is partitioned into the following areas:
1313

14-
- Bootloader partition, at the beginning of the flash
15-
- Primary slot (boot partition) starting at address `FLASH_AREA_IMAGE_0_OFFSET`
16-
- Secondary slot (upgrade partition) starting at address `FLASH_AREA_IMAGE_1_OFFSET`
17-
- Scratch space (swap partition) starting at address `FLASH_AREA_IMAGE_SCRATCH_OFFSET`
14+
- Bootloader partition, at the beginning of the flash
15+
- Primary slot (boot partition) starting at address `FLASH_AREA_IMAGE_0_OFFSET`
16+
- Secondary slot (upgrade partition) starting at address `FLASH_AREA_IMAGE_1_OFFSET`
17+
- Scratch space (swap partition) starting at address `FLASH_AREA_IMAGE_SCRATCH_OFFSET`
1818

1919
A proper partitioning configuration must be set up for the specific use, by setting
20-
the values for offsets and sizes in [include/target.h](include/target.h).
20+
the values for offsets and sizes in [include/target.h](../include/target.h).
2121

2222
### Bootloader partition
2323

@@ -54,14 +54,14 @@ configuration in `target.h`:
5454

5555
which results in the following partition configuration:
5656

57-
![example partitions](docs/png/example_partitions.png)
57+
![example partitions](png/example_partitions.png)
5858

5959
This configuration demonstrates one of the possible layouts, with the slots
6060
aligned to the beginning of the physical sector on the flash.
6161

6262
The entry point for all the runnable firmware images on this target will be `0x20100`,
6363
256 Bytes after the beginning of the first flash partition. This is due to the presence
6464
of the firmware image header at the beginning of the partition, as explained more in details
65-
in [Firmware image](docs/firmware_image.md)
65+
in [Firmware image](firmware_image.md)
6666

6767

0 commit comments

Comments
 (0)