Skip to content

Commit bf12a61

Browse files
authored
Update README.md
To reflect recent change to block device firmware storage
1 parent b00f6fa commit bf12a61

File tree

1 file changed

+28
-8
lines changed

1 file changed

+28
-8
lines changed

README.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@ User **must** set in `mbed_app.json`:
2323
1. `firmware_metadata_header_address`, Offset at which the metadata header of the active firmware is written. **Must align to flash erase boundary**
2424
1. `firmware_metadata_header_size`, Size of the active metadata header region. The application starts at `firmware_metadata_header_address + firmware_metadata_header_size`. **Must align to vector table size boundary and flash erase boundary**
2525
1. `update-client.application-details`, This is the same as `firmware_metadata_header_address` but needs to be configured to allow the dependency module of bootloader to pick up this configuration.
26+
1. `update-client.storage-address`, The offset from the begining of sd block device where the firmware candidates are stored.
27+
1. `update-client.storage-size`, total size on the block device reserved for firmware storage
28+
29+
All these configurations must be set the same in the mbed cloud client when compiling the corresponding application for successful update operation.
2630

2731
User **may** set in `mbed_app.json`:
2832
1. `MAX_COPY_RETRIES`, The number of retries after a failed copy attempt.
@@ -67,13 +71,29 @@ User **may** set in `mbed_app.json`:
6771

6872
## External Storage
6973

70-
The firmware update candidates are currently stored on an external sd card with a FAT32 file system. The expected folder structure is as follows:
74+
The firmware update candidates are currently stored on an external sd card. The firmware is stored sequencially on the block device. The expected layout is as follows:
7175
```
72-
SDRoot
73-
+-- firmware
74-
  +-- header_0.bin
75-
+-- firmware_0.bin
76-
+-- header_1.bin
77-
+-- firmware_1.bin
78-
+-- ...
76+
+--------------------------+<-+ End of SD card block device
77+
| |
78+
+--------------------------+<-+ update-client.storage-size + update-client.storage-address
79+
| |
80+
   +--------------------------+
81+
   |                         |
82+
| Firmware Candidate 1 |
83+
| |
84+
+--------------------------+
85+
| Firmware Candidate 1 |
86+
| Metadata Header |
87+
+--------------------------+
88+
| |
89+
+--------------------------+
90+
   |                         |
91+
| Firmware Candidate 0 |
92+
| |
93+
+--------------------------+
94+
| Firmware Candidate 0 |
95+
| Metadata Header |
96+
+--------------------------+ <-+ update-client.storage-address
97+
| |
98+
+--------------------------+ <-+ Start of SD card block device (ie 0x0)
7999
```

0 commit comments

Comments
 (0)