Skip to content

Commit 512df57

Browse files
committed
Add JSON schemas to the readme
1 parent 1f0df4b commit 512df57

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -763,7 +763,7 @@ Family ID 'rp2350-arm-s' can be downloaded in partition 0:
763763
### create
764764

765765
This command allows you to create partition tables, and additionally embed them into the block loop if ELF files (for example, for bootloaders).
766-
By default, all partition tables are hashed, and you can also sign them.
766+
By default, all partition tables are hashed, and you can also sign them. The schema for this JSON file is [here](json/schemas/partition-table-schema.json).
767767

768768
```text
769769
$ picotool help partition create
@@ -907,7 +907,7 @@ The `otp` commands are for interacting with the RP2350 OTP Memory. They are not
907907
Note that the OTP Memory is One-Time-Programmable, which means that once a bit has been changed from 0 to 1, it cannot be changed back.
908908
Therefore, caution should be used when using these commands, as they risk bricking your RP2350 device. For example, if you set SECURE_BOOT_ENABLE but don't set a boot key, and disable the PICOBOOT interface, then your device will be unusable.
909909

910-
For the `list`, `set`, `get` and `load` commands, you can define your own OTP layout in a JSON file and pass that in with the `-i` argument. These rows will be added to the default rows when parsing.
910+
For the `list`, `set`, `get` and `load` commands, you can define your own OTP layout in a JSON file and pass that in with the `-i` argument. These rows will be added to the default rows when parsing. The schema for this JSON file is [here](json/schemas/otp-contents-schema.json)
911911

912912
```text
913913
$ picotool help otp
@@ -952,7 +952,7 @@ $ picotool reboot
952952
### white-label
953953

954954
This command allows for OTP white-labelling, which sets the USB configuration used by the device in BOOTSEL mode.
955-
This can be configured from a JSON file, an example of which is in [sample-wl.json](sample-wl.json).
955+
This can be configured from a JSON file, an example of which is in [sample-wl.json](sample-wl.json). The schema for this JSON file is [here](json/schemas/whitelabel-schema.json)
956956

957957
```text
958958
$ picotool help otp white-label
@@ -1032,7 +1032,7 @@ Device Descriptor:
10321032
This command will run a binary on your device in order to set the OTP permissions, as these are not directly accessible from `picotool` on due to the default permissions settings required to fix errata XXX on RP2350.
10331033
Because it runs a binary, the binary needs to be sign it if secure boot is enabled. The binary will print what it is doing over uart, which
10341034
can be configured using the UART Configuration arguments. You can define your OTP permissions in a json file, an example of which
1035-
is in [sample-permissions.json](sample-permissions.json).
1035+
is in [sample-permissions.json](sample-permissions.json). The schema for this JSON file is [here](json/schemas/permissions-schema.json)
10361036

10371037
```text
10381038
$ picotool help otp permissions

0 commit comments

Comments
 (0)