Skip to content

Commit 64381fc

Browse files
committed
EXAMPLES: Move advanced examples to a separate file
Signed-off-by: Daniel Schaefer <dhs@frame.work>
1 parent 5b10d0f commit 64381fc

File tree

2 files changed

+79
-40
lines changed

2 files changed

+79
-40
lines changed

EXAMPLES.md

Lines changed: 1 addition & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -544,43 +544,4 @@ It's not controlled by the EC, use https://keyboard.frame.work.
544544

545545
Mostly for debugging firmware.
546546

547-
### Check EFI Resource Table
548-
549-
On Framework Desktop:
550-
551-
```
552-
> sudo framework_tool --esrt
553-
ESRT Table
554-
ResourceCount: 1
555-
ResourceCountMax: 1
556-
ResourceVersion: 1
557-
ESRT Entry 0
558-
GUID: EB68DBAE-3AEF-5077-92AE-9016D1F0C856
559-
GUID: DesktopAmdAi300Bios
560-
Type: SystemFirmware
561-
Version: 0x204 (516)
562-
Min FW Version: 0x100 (256)
563-
Capsule Flags: 0x0
564-
Last Attempt Version: 0x108 (264)
565-
Last Attempt Status: Success
566-
```
567-
568-
## Flashing EC firmware
569-
570-
**IMPORTANT** Flashing EC firmware yourself is not recommended. It may render
571-
your hardware unbootable. Please update your firmware using the official BIOS
572-
update methods (Windows .exe, LVFS/FWUPD, EFI updater)!
573-
574-
This command has not been thoroughly tested on all Framework Computer systems
575-
576-
```
577-
# Simulate flashing RW (to see which blocks are updated)
578-
> framework_tool --flash-rw-ec ec.bin --dry-run
579-
580-
# Actually flash RW
581-
> framework_tool --flash-rw-ec ec.bin
582-
583-
# Boot into EC RW firmware (will crash your OS and reboot immediately)
584-
# EC will boot back into RO if the system turned off for 30s
585-
> framework_tool --reboot-ec jump-rw
586-
```
547+
See [EXAMPLES_ADVANCED.md](EXAMPLES_ADVANCED.md)

EXAMPLES_ADVANCED.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Advanced debugging
2+
3+
## PD
4+
5+
### Check PD state
6+
7+
Example on Framework 13 AMD Ryzen AI 300
8+
```
9+
> sudo framework_tool.exe --pd-info
10+
Left / Ports 01
11+
Silicon ID: 0x3580
12+
Mode: MainFw
13+
Flash Row Size: 256 B
14+
Bootloader Version: Base: 3.6.0.009, App: 0.0.01
15+
FW1 (Backup) Version: Base: 3.7.0.197, App: 0.0.0B
16+
FW2 (Main) Version: Base: 3.7.0.197, App: 0.0.0B
17+
Right / Ports 23
18+
Silicon ID: 0x3580
19+
Mode: MainFw
20+
Flash Row Size: 256 B
21+
Bootloader Version: Base: 3.6.0.009, App: 0.0.01
22+
FW1 (Backup) Version: Base: 3.7.0.197, App: 0.0.0B
23+
FW2 (Main) Version: Base: 3.7.0.197, App: 0.0.0B
24+
```
25+
26+
### Disable/enable/reset PD
27+
28+
```
29+
# Disable all ports on PD 0
30+
> sudo framework_tool --pd-disable 0
31+
32+
# Reset PD 0 (enables all ports again)
33+
> sudo framework_tool --pd-reset 0
34+
35+
# Or enable all ports on PD 0 without resetting it
36+
> sudo framework_tool --pd-enable 0
37+
```
38+
39+
### Check EFI Resource Table
40+
41+
On Framework Desktop:
42+
43+
```
44+
> sudo framework_tool --esrt
45+
ESRT Table
46+
ResourceCount: 1
47+
ResourceCountMax: 1
48+
ResourceVersion: 1
49+
ESRT Entry 0
50+
GUID: EB68DBAE-3AEF-5077-92AE-9016D1F0C856
51+
GUID: DesktopAmdAi300Bios
52+
Type: SystemFirmware
53+
Version: 0x204 (516)
54+
Min FW Version: 0x100 (256)
55+
Capsule Flags: 0x0
56+
Last Attempt Version: 0x108 (264)
57+
Last Attempt Status: Success
58+
```
59+
60+
## Flashing EC firmware
61+
62+
**IMPORTANT** Flashing EC firmware yourself is not recommended. It may render
63+
your hardware unbootable. Please update your firmware using the official BIOS
64+
update methods (Windows .exe, LVFS/FWUPD, EFI updater)!
65+
66+
This command has not been thoroughly tested on all Framework Computer systems
67+
68+
```
69+
# Simulate flashing RW (to see which blocks are updated)
70+
> framework_tool --flash-rw-ec ec.bin --dry-run
71+
72+
# Actually flash RW
73+
> framework_tool --flash-rw-ec ec.bin
74+
75+
# Boot into EC RW firmware (will crash your OS and reboot immediately)
76+
# EC will boot back into RO if the system turned off for 30s
77+
> framework_tool --reboot-ec jump-rw
78+
```

0 commit comments

Comments
 (0)