Skip to content

Commit ba0bad0

Browse files
committed
docs: Move file analysis to advanced examples
Too low level for the main readme. Signed-off-by: Daniel Schaefer <dhs@frame.work>
1 parent 7114177 commit ba0bad0

2 files changed

Lines changed: 65 additions & 55 deletions

File tree

EXAMPLES_ADVANCED.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,3 +100,68 @@ Wrote 153 bytes to foo.bin
100100
# Update everything from a file
101101
> framework_tool --flash-gpu-descriptor-file pcie_4x2.bin
102102
```
103+
104+
## Analyzing binaries
105+
106+
### EC
107+
108+
Note that only since Framework 13 Intel Core Ultra (and later) the version number embedded in the ED binary is meaningful. As you can see below, in this example on Intel Core 12th/13th Gen (hx30) it's always 0.0.1.
109+
The commit hash though is accurate and reflects the git commit it was built from.
110+
111+
```
112+
> framework-tool --ec--bin ec.bin
113+
File
114+
Size: 524288 B
115+
Size: 512 KB
116+
EC
117+
Version: hx30_v0.0.1-7a61a89
118+
RollbackVer: 0
119+
Platform: hx30
120+
Version: 0.0.1
121+
Commit: 7a61a89
122+
Size: 2868 B
123+
Size: 2 KB
124+
```
125+
126+
### PD
127+
128+
```
129+
> framework_tool --pd-bin pd-0.1.14.bin
130+
File
131+
Size: 65536 B
132+
Size: 64 KB
133+
FW 1
134+
Silicon ID: 0x3000
135+
Version: 0.1.14
136+
Row size: 128 B
137+
Start Row: 22
138+
Rows: 95
139+
Size: 12160 B
140+
Size: 11 KB
141+
FW 2
142+
Silicon ID: 0x3000
143+
Version: 0.1.14
144+
Row size: 128 B
145+
Start Row: 118
146+
Rows: 381
147+
Size: 48768 B
148+
Size: 47 KB
149+
```
150+
151+
### UEFI Capsule
152+
153+
```
154+
> framework_tool --capsule retimer23.cap
155+
File
156+
Size: 2232676 B
157+
Size: 2180 KB
158+
Capsule Header
159+
Capsule GUID: (ba2e4e6e, 3b0c, 4f25, [8a,59,4c,55,3f,c8,6e,a2])
160+
Header size: 28 B
161+
Flags: 0x50000
162+
Persist across reset (0x10000)
163+
Initiate reset (0x40000)
164+
Capsule Size: 2232676 B
165+
Capsule Size: 2180 KB
166+
Type: Framework Retimer23 (Right)
167+
```

README.md

Lines changed: 0 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -205,61 +205,6 @@ Many actions require root. First build with cargo and then run the binary with s
205205
cargo build && sudo ./target/debug/framework_tool
206206
```
207207

208-
Dumping version information from firmware binaries:
209-
210-
```
211-
# Dumping PD FW Binary Information:
212-
> cargo run -q -- --pd-bin pd-0.1.14.bin
213-
File
214-
Size: 65536 B
215-
Size: 64 KB
216-
FW 1
217-
Silicon ID: 0x3000
218-
Version: 0.1.14
219-
Row size: 128 B
220-
Start Row: 22
221-
Rows: 95
222-
Size: 12160 B
223-
Size: 11 KB
224-
FW 2
225-
Silicon ID: 0x3000
226-
Version: 0.1.14
227-
Row size: 128 B
228-
Start Row: 118
229-
Rows: 381
230-
Size: 48768 B
231-
Size: 47 KB
232-
233-
# Dumping EC FW Binary Information
234-
> cargo run -q -- --ec--bin ec.bin
235-
File
236-
Size: 524288 B
237-
Size: 512 KB
238-
EC
239-
Version: hx30_v0.0.1-7a61a89
240-
RollbackVer: 0
241-
Platform: hx30
242-
Version: 0.0.1
243-
Commit: 7a61a89
244-
Size: 2868 B
245-
Size: 2 KB
246-
247-
# Dumping Capsule Binary Information:
248-
> cargo run -q -- --capsule retimer23.cap
249-
File
250-
Size: 2232676 B
251-
Size: 2180 KB
252-
Capsule Header
253-
Capsule GUID: (ba2e4e6e, 3b0c, 4f25, [8a,59,4c,55,3f,c8,6e,a2])
254-
Header size: 28 B
255-
Flags: 0x50000
256-
Persist across reset (0x10000)
257-
Initiate reset (0x40000)
258-
Capsule Size: 2232676 B
259-
Capsule Size: 2180 KB
260-
Type: Framework Retimer23 (Right)
261-
```
262-
263208
###### Running on Windows
264209

265210
On newly released systems since 2025 the Framework driver installer includes the EC driver.

0 commit comments

Comments
 (0)