Skip to content

Commit bd98af8

Browse files
will-v-pilurch
andauthored
Apply suggestions from code review
Co-authored-by: Andrew Scheller <lurch@durge.org> Co-authored-by: will-v-pi <108662275+will-v-pi@users.noreply.github.com>
1 parent 00af391 commit bd98af8

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

universal/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ for the purposes of these examples:
1111
allowing RP2040 and RP2350 (Arm & RISC-V) to run from identical flash contents.
1212
- A **Universal UF2** is multiple individual `.uf2` files with different family IDs
1313
concatenated together to create a single `.uf2` file. When dragged & dropped onto a device,
14-
only the file with a family ID corresponding to that device will be loaded onto it, and the
15-
rest of the files will be ignored.
14+
only the portion of the file with a family ID corresponding to that device will be processed, and the
15+
rest of the file will be ignored.
1616

1717
A **Universal Binary** can be packaged into a UF2 file for loading onto a device. However,
1818
as there isn't a common family ID between RP2040 and RP2350, you would have to package it into a **Universal UF2** with two copies (using `rp2040` and `absolute` family IDs), thus creating a **Universal UF2** of a **Universal Binary**.
@@ -29,7 +29,7 @@ Universal binaries must be recognised by both the RP2040 and RP2350 bootroms. Th
2929
- In addition to the RP2350 `IMAGE_DEF` item, this embedded block contains a
3030
`ROLLING_WINDOW_DELTA` item to translate this binary to the start of flash for execution
3131
- RP2350 RISC-V binary containing an embedded block
32-
- Same as the Arm one
32+
- Ditto
3333

3434
All of the embedded blocks are linked into one big block loop.
3535

@@ -38,18 +38,18 @@ These are then booted by the respective bootroms:
3838
RP2040 has no support for embedded blocks.
3939
- **RP2350** - sees the block loop and parses it to find the correct embedded block to boot
4040
from (Arm vs RISC-V). It then translates the flash address according to the
41-
`ROLLING_WINDOW_DELTA` so that the binary containing that embedded block is at the start of the
41+
`ROLLING_WINDOW_DELTA` so that the binary containing that embedded block appears at the start of the
4242
flash address space, and executes from there.
4343

44-
For no_flash binaries the RP2040 boot2 is omitted as the bootrom just executes from the start
44+
For no_flash binaries the RP2040 boot2 is omitted as the RP2040 bootrom just executes from the start
4545
of SRAM, and instead of `ROLLING_WINDOW_DELTA` items the RP2350 binaries use `LOAD_MAP` items,
4646
to copy the code in SRAM to the correct location for execution rather than using address
4747
translation.
4848

4949
## How you should use them
5050

51-
For most use cases, **Universal UF2s** are the best option to use. They will only load into
52-
flash the code that runs on that device. The [blink_universal](blink_universal) example uses a
51+
For most use cases, **Universal UF2s** are the best option to use. They will only load the
52+
code that runs on that device into flash. The [blink_universal](blink_universal) example uses a
5353
Universal UF2 for that reason, as the Wi-Fi firmware is quite large. **Universal Binaries**
5454
are only currently useful when the commonality of having a single `.bin` file for programming
5555
outweighs the disadvantage of the extra flash usage.

universal/blink_universal/blink_universal.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313
#endif
1414

1515
enum BOARD_TYPE {
16-
BOARD_TYPE_PICO,
17-
BOARD_TYPE_PICO_W,
16+
BOARD_TYPE_PICO, // Pico-series board
17+
BOARD_TYPE_PICO_W, // Pico W-series board
1818
BOARD_TYPE_UNKNOWN,
1919
};
2020

0 commit comments

Comments
 (0)