Skip to content

Commit dc5e877

Browse files
committed
update readme
1 parent 29c1f62 commit dc5e877

File tree

1 file changed

+21
-31
lines changed

1 file changed

+21
-31
lines changed

README.md

Lines changed: 21 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -36,25 +36,26 @@ PICOTOOL:
3636
Tool for interacting with a RP2040 device in BOOTSEL mode, or with a RP2040 binary
3737
3838
SYNOPSYS:
39-
picotool info [-b] [-p] [-d] [-l] [-a] [--bus <bus>] [--address <addr>]
39+
picotool info [-b] [-p] [-d] [-l] [-a] [--bus <bus>] [--address <addr>] [-f] [-F]
4040
picotool info [-b] [-p] [-d] [-l] [-a] <filename> [-t <type>]
41-
picotool load [-v] [-r] <filename> [-t <type>] [--bus <bus>] [--address <addr>]
42-
picotool save [-p] [--bus <bus>] [--address <addr>] <filename> [-t <type>]
43-
picotool save -a [--bus <bus>] [--address <addr>] <filename> [-t <type>]
44-
picotool save -r <from> <to> [--bus <bus>] [--address <addr>] <filename> [-t <type>]
45-
picotool verify [--bus <bus>] [--address <addr>] <filename> [-t <type>] [-r <from> <to>]
46-
picotool reboot [-a] [-u] [--bus <bus>] [--address <addr>]
41+
picotool load [-v] [-x] <filename> [-t <type>] [-o <offset>] [--bus <bus>] [--address <addr>] [-f] [-F]
42+
picotool save [-p] [--bus <bus>] [--address <addr>] [-f] [-F] <filename> [-t <type>]
43+
picotool save -a [--bus <bus>] [--address <addr>] [-f] [-F] <filename> [-t <type>]
44+
picotool save -r <from> <to> [--bus <bus>] [--address <addr>] [-f] [-F] <filename> [-t <type>]
45+
picotool verify [--bus <bus>] [--address <addr>] [-f] [-F] <filename> [-t <type>] [-r <from> <to>] [-o <offset>]
46+
picotool reboot [-a] [-u] [--bus <bus>] [--address <addr>] [-f] [-F]
47+
picotool version [-s]
4748
picotool help [<cmd>]
4849
4950
COMMANDS:
50-
info Display information from the target device(s) or file.
51-
Without any arguments, this will display basic information for all connected RP2040 devices in
52-
BOOTSEL mode
53-
load Load the program / memory range stored in a file onto the device.
54-
save Save the program / memory stored in flash on the device to a file.
55-
verify Check that the device contents match those in the file.
56-
reboot Reboot the device
57-
help Show general help or help for a specific command
51+
info Display information from the target device(s) or file.
52+
Without any arguments, this will display basic information for all connected RP2040 devices in BOOTSEL mode
53+
load Load the program / memory range stored in a file onto the device.
54+
save Save the program / memory stored in flash on the device to a file.
55+
verify Check that the device contents match those in the file.
56+
reboot Reboot the device
57+
version Display picotool version
58+
help Show general help or help for a specific command
5859
5960
Use "picotool help <cmd>" for more info
6061
```
@@ -69,15 +70,14 @@ can find (See Binary Info section below). The info command is for reading this i
6970
The information can be either read from one or more connected RP2040 devices in BOOTSEL mode, or from
7071
a file. This file can be an ELF, a UF2 or a BIN file.
7172

72-
```asciidoc
73+
```text
7374
$ picotool help info
7475
INFO:
7576
Display information from the target device(s) or file.
76-
Without any arguments, this will display basic information for all connected RP2040 devices in USB boot
77-
mode
77+
Without any arguments, this will display basic information for all connected RP2040 devices in BOOTSEL mode
7878
7979
SYNOPSYS:
80-
picotool info [-b] [-p] [-d] [-l] [-a] [--bus <bus>] [--address <addr>]
80+
picotool info [-b] [-p] [-d] [-l] [-a] [--bus <bus>] [--address <addr>] [-f] [-F]
8181
picotool info [-b] [-p] [-d] [-l] [-a] <filename> [-t <type>]
8282
8383
OPTIONS:
@@ -105,7 +105,6 @@ TARGET SELECTION:
105105
-t <type>
106106
Specify file type (uf2 | elf | bin) explicitly, ignoring file extension
107107
```
108-
109108
e.g.
110109

111110
```text
@@ -247,11 +246,7 @@ Basic information includes
247246
- program features - this is a list built from individual strings in the binary, that can be displayed (e.g. we will have one for UART stdio and one for USB stdio) in the SDK
248247
- build attributes - this is a similar list of strings, for things pertaining to the binary itself (e.g. Debug Build)
249248

250-
Note it is my intention that things like MicroPython would include features for parts of the language/libraries they include.
251-
252-
This might not be as a feature string per se, but could be another aggregating list (features/attributes are well known)
253-
but we can add another piece of binary info to name a list attribute that aggregates strings with a particular tag, so you
254-
could trivially add "MicroPython libraries:" etc to the `picotool` output without changing the tool itself.
249+
The binary information is self-describing/extensible, so programs can include information picotool is not aware of (e.g. MicroPython includes a list of in-built libraries)
255250

256251
### Pins
257252

@@ -389,11 +384,6 @@ quotes, newlines etc you may have better luck defining via bi_decl in the code.
389384

390385
## Additional binary information/picotool features
391386

392-
### SDK version
393-
394-
Should add this; git revision in general is hard since the user may not have the SDK checked out from git, so we'll have to stick
395-
a version number in a header
396-
397387
### Block devices
398388

399389
MicroPython and CircuitPython, eventually the SDK and others may support one or more storage devices in flash. We already
@@ -433,7 +423,7 @@ enum {
433423
### USB device descriptors
434424

435425
Seems like tagging these might be nice (we just need to store the pointer to it assuming - as is often the case -
436-
the descriptor is just a linear chunk of memory) ... I assume there is a tool out there to prettyify such a thing if picotool dumps the descriptor
426+
the descriptor is just a linear chunk of memory) ... I assume there is a tool out there to prettify such a thing if picotool dumps the descriptor
437427
in binary.
438428

439429
### Issues

0 commit comments

Comments
 (0)