Skip to content

Commit 20a290a

Browse files
committed
docs: add status command section and link to HARDWARE.md
Signed-off-by: Vincent Jardin <vjardin@free.fr>
1 parent 10e504f commit 20a290a

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,7 @@ To find which COM port the device is using, open Device Manager and look under
142142
Usage: radfu <command> [options] [file]
143143
144144
Commands:
145+
status Show comprehensive device status with ASCII diagram
145146
info Show device and memory information
146147
read <file> Read flash memory to file
147148
write <file> Write file to flash memory
@@ -178,6 +179,7 @@ Options:
178179
-V, --version Show version
179180
180181
Examples:
182+
radfu status
181183
radfu info
182184
radfu read -a 0x0 -s 0x10000 firmware.bin
183185
radfu write -b 1000000 -a 0x0 -v firmware.bin
@@ -188,6 +190,18 @@ Examples:
188190
radfu -u -p /dev/ttyUSB0 info
189191
```
190192

193+
## Device Status
194+
195+
The `radfu status` command provides a comprehensive overview of the device including
196+
memory layout, flash usage, security configuration, and warnings for unsecured devices.
197+
See [HARDWARE.md](HARDWARE.md) for complete output example and board documentation.
198+
199+
The bar symbols indicate protection status:
200+
- ``/`` - Used/empty blocks without protection
201+
- ``/`` - BPS (Block Protection Setting) protected blocks
202+
- ``/`` - PBPS (Permanent Block Protection) - cannot be revoked
203+
- `S`/`N` - TrustZone Secure/NSC regions
204+
191205
## Protocol Exploration
192206

193207
The `raw` command allows sending arbitrary bootloader commands for protocol analysis:
@@ -428,6 +442,7 @@ ls /dev/ttyACM*
428442

429443
### Board Documentation
430444

445+
- [HARDWARE.md](HARDWARE.md) - EK-RA4M2 board layout, pin connections, and wiring diagrams
431446
- [EK-RA4M2 v1 User's Manual](https://www.renesas.com/en/document/man/ek-ra4m2-v1-users-manual) - See page 28 for J16 jumper details
432447

433448
## UART Mode
@@ -522,4 +537,4 @@ No proprietary source code or confidential material is included. See LEGAL.md fo
522537

523538
AGPL-3.0-or-later
524539

525-
Copyright (C) Vincent Jardin <vjardin@free.fr> Free Mobile 2025
540+
Copyright (C) Vincent Jardin <vjardin@free.fr> Free Mobile 2025-2026

0 commit comments

Comments
 (0)