8000 stm32/mboot/README: Fix some typos, describe bootloader and fwupdate.py. · devmonkZA/micropython@0bb6b63 · GitHub
[go: up one dir, main page]

Skip to content

Commit 0bb6b63

Browse files
committed
stm32/mboot/README: Fix some typos, describe bootloader and fwupdate.py.
1 parent 66bcb55 commit 0bb6b63

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

ports/stm32/mboot/README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,14 @@ How to use
4646

4747
This assumes that the board declares and defines the relevant SPI flash
4848
configuration structs, eg in the board-specific bdev.c file. The
49-
`MBOOT_SPIFLASH2_LAYOUT` string will be seen by the USB DFU utility and
49+
`MBOOT_SPIFLASH_LAYOUT` string will be seen by the USB DFU utility and
5050
must describe the SPI flash layout. Note that the number of pages in
5151
this layout description (the `64` above) cannot be larger than 99 (it
5252
must fit in two digits) so the reported page size (the `32Kg` above)
5353
must be made large enough so the number of pages fits in two digits.
5454
Alternatively the layout can specify multiple sections like
5555
`32*16Kg,32*16Kg`, in which case `MBOOT_SPIFLASH_ERASE_BLOCKS_PER_PAGE`
56-
must be changed to `16 / 4` to match tho `16Kg` value.
56+
must be changed to `16 / 4` to match the `16Kg` value.
5757

5858
Mboot supports up to two external SPI flash devices. To configure the
5959
second one use the same configuration names as above but with
@@ -115,6 +115,10 @@ The last element in the data sequence must be the end element:
115115

116116
* END: type=1, len=0
117117

118+
Note: MicroPython's `machine.bootloader()` function performs steps 1-4
119+
above, and also accepts an optional bytes argument as additional data to
120+
pass through to Mboot.
121+
118122
Loading firmware from a filesystem
119123
----------------------------------
120124

@@ -130,6 +134,9 @@ are located and what filename to program. The elements to use are:
130134

131135
The firmware to load must be a gzip'd DfuSe file (.dfu.gz).
132136

137+
The provided fwupdate.py script contains helper functions to call into Mboot
138+
with the correct data, and also to update Mboot itself.
139+
133140
Example: Mboot on PYBv1.x
134141
-------------------------
135142

0 commit comments

Comments
 (0)
0