-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathframework_tool.1
More file actions
474 lines (461 loc) · 11.7 KB
/
Copy pathframework_tool.1
File metadata and controls
474 lines (461 loc) · 11.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.TH framework_tool 1 "framework_tool 0.6.5"
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.SH NAME
framework_tool \- Swiss army knife for Framework laptops
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.SH SYNOPSIS
\fBframework_tool\fR [\fB\-\-flash\-gpu\-descriptor\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-q\fR|\fB\-\-quiet\fR]... [\fB\-\-versions\fR] [\fB\-\-version\fR] [\fB\-\-features\fR] [\fB\-\-esrt\fR] [\fB\-\-device\fR] [\fB\-\-compare\-version\fR] [\fB\-\-power\fR] [\fB\-\-smartbattery\fR] [\fB\-\-smartbattery\-auth\fR] [\fB\-\-thermal\fR] [\fB\-\-thermalget\fR] [\fB\-\-thermalset\fR] [\fB\-\-sensors\fR] [\fB\-\-fansetduty\fR] [\fB\-\-fansetrpm\fR] [\fB\-\-autofanctrl\fR] [\fB\-\-pdports\fR] [\fB\-\-pdports\-chromebook\fR] [\fB\-\-info\fR] [\fB\-\-meinfo\fR] [\fB\-\-pd\-info\fR] [\fB\-\-pd\-reset\fR] [\fB\-\-pd\-disable\fR] [\fB\-\-pd\-enable\fR] [\fB\-\-dp\-hdmi\-info\fR] [\fB\-\-dp\-hdmi\-update\fR] [\fB\-\-audio\-card\-info\fR] [\fB\-\-privacy\fR] [\fB\-\-pd\-bin\fR] [\fB\-\-ec\-bin\fR] [\fB\-\-capsule\fR] [\fB\-\-dump\fR] [\fB\-\-h2o\-capsule\fR] [\fB\-\-dump\-ec\-flash\fR] [\fB\-\-flash\-full\-ec\fR] [\fB\-\-flash\-ec\fR] [\fB\-\-flash\-ro\-ec\fR] [\fB\-\-flash\-rw\-ec\fR] [\fB\-\-intrusion\fR] [\fB\-\-inputdeck\fR] [\fB\-\-inputdeck\-mode\fR] [\fB\-\-expansion\-bay\fR] [\fB\-\-charge\-limit\fR] [\fB\-\-charge\-current\-limit\fR] [\fB\-\-charge\-rate\-limit\fR] [\fB\-\-get\-gpio\fR] [\fB\-\-fp\-led\-level\fR] [\fB\-\-fp\-brightness\fR] [\fB\-\-kblight\fR] [\fB\-\-remap\-key\fR] [\fB\-\-rgbkbd\fR] [\fB\-\-tablet\-mode\fR] [\fB\-\-touchscreen\-enable\fR] [\fB\-\-haptic\-intensity\fR] [\fB\-\-click\-force\fR] [\fB\-\-stylus\-battery\fR] [\fB\-\-console\fR] [\fB\-\-reboot\-ec\fR] [\fB\-\-ec\-hib\-delay\fR] [\fB\-\-sysinfo\fR] [\fB\-\-uptimeinfo\fR] [\fB\-\-s0ix\-counter\fR] [\fB\-\-hello\fR] [\fB\-\-protoinfo\fR] [\fB\-\-switches\fR] [\fB\-\-port80read\fR] [\fB\-\-panicinfo\fR] [\fB\-\-hash\fR] [\fB\-\-driver\fR] [\fB\-\-pd\-addrs\fR] [\fB\-\-pd\-ports\fR] [\fB\-t\fR|\fB\-\-test\fR] [\fB\-\-test\-retimer\fR] [\fB\-\-boardid\fR] [\fB\-f\fR|\fB\-\-force\fR] [\fB\-\-dry\-run\fR] [\fB\-\-flash\-gpu\-descriptor\-file\fR] [\fB\-\-dump\-gpu\-descriptor\-file\fR] [\fB\-\-validate\-gpu\-descriptor\-file\fR] [\fB\-\-nvidia\fR] [\fB\-\-host\-command\fR] [\fB\-h\fR|\fB\-\-help\fR]
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.SH DESCRIPTION
framework_tool is a command\-line utility for interacting with Framework Computer laptops and desktops.
.PP
It communicates with the Embedded Controller (EC) to query firmware versions, battery and USB\-C status, thermal data, privacy and intrusion switches, and expansion card details. It can also adjust system settings and flash EC firmware.
.PP
Most operations require root privileges.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.SH OPTIONS
.TP
\fB\-\-flash\-gpu\-descriptor\fR
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Increase logging verbosity
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Decrease logging verbosity
.TP
\fB\-\-versions\fR
List current firmware versions
.TP
\fB\-\-version\fR
Show tool version information (Add \-vv for more details)
.TP
\fB\-\-features\fR
Show features support by the firmware
.TP
\fB\-\-esrt\fR
Display the UEFI ESRT table
.TP
\fB\-\-device\fR \fI<DEVICE>\fR
Device type to compare the \-\-compare\-version string against
.br
.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
bios
.IP \(bu 2
ec
.IP \(bu 2
pd0
.IP \(bu 2
pd1
.IP \(bu 2
rtm01
.IP \(bu 2
rtm23
.IP \(bu 2
ac\-left
.IP \(bu 2
ac\-right
.RE
.TP
\fB\-\-compare\-version\fR \fI<COMPARE_VERSION>\fR
Version to compare device firmware version with
.TP
\fB\-\-power\fR
Show current power status of battery and AC (Add \-vv for more details)
.TP
\fB\-\-smartbattery\fR [\fI<FILE>\fR]
Show detailed smart battery information, or load from dump file
.TP
\fB\-\-smartbattery\-auth\fR
Authenticate smart battery (requires unseal and auth keys)
.TP
\fB\-\-thermal\fR
Print thermal information (Temperatures and Fan speed)
.TP
\fB\-\-thermalget\fR
Print thermal thresholds of the temperature sensors
.TP
\fB\-\-thermalset\fR \fI<THERMALSET>...\fR
Set thermal thresholds of a sensor in degrees Celsius: <SENSOR> <WARN> [<HIGH> [<HALT> [<FAN_OFF> [<FAN_MAX>]]]] (\-1 keeps the current threshold, 0 disables it)
.TP
\fB\-\-sensors\fR
Print sensor information (ALS, G\-Sensor)
.TP
\fB\-\-fansetduty\fR [\fI<FANSETDUTY>...\fR]
Set fan duty cycle (0\-100%)
.TP
\fB\-\-fansetrpm\fR [\fI<FANSETRPM>...\fR]
Set fan RPM (limited by EC fan table max RPM)
.TP
\fB\-\-autofanctrl\fR [\fI<AUTOFANCTRL>\fR]
Turn on automatic fan speed control
.TP
\fB\-\-pdports\fR
Show USB\-C PD port state
.TP
\fB\-\-pdports\-chromebook\fR
Show PD port info (generic Chromium EC)
.TP
\fB\-\-info\fR
Show info from SMBIOS (Only on UEFI)
.TP
\fB\-\-meinfo\fR [\fI<MEINFO>\fR]
Show Intel ME information (from SMBIOS type 0xDB). Optionally provide a dmidecode binary dump file path
.TP
\fB\-\-pd\-info\fR
Show details about the PD controllers
.TP
\fB\-\-pd\-reset\fR \fI<PD_RESET>\fR
Reset a specific PD controller (for debugging only)
.TP
\fB\-\-pd\-disable\fR \fI<PD_DISABLE>\fR
Disable all ports on a specific PD controller (for debugging only)
.TP
\fB\-\-pd\-enable\fR \fI<PD_ENABLE>\fR
Enable all ports on a specific PD controller (for debugging only)
.TP
\fB\-\-dp\-hdmi\-info\fR
Show details about connected DP or HDMI Expansion Cards
.TP
\fB\-\-dp\-hdmi\-update\fR \fI<UPDATE_BIN>\fR
Update the DisplayPort or HDMI Expansion Card
.TP
\fB\-\-audio\-card\-info\fR
Show details about connected Audio Expansion Cards (Needs root privileges)
.TP
\fB\-\-privacy\fR
Show privacy switch statuses (camera and microphone)
.TP
\fB\-\-pd\-bin\fR \fI<PD_BIN>\fR
Parse versions from PD firmware binary file
.TP
\fB\-\-ec\-bin\fR \fI<EC_BIN>\fR
Parse versions from EC firmware binary file
.TP
\fB\-\-capsule\fR \fI<CAPSULE>\fR
Parse UEFI Capsule information from binary file
.TP
\fB\-\-dump\fR \fI<DUMP>\fR
Dump extracted UX capsule bitmap image to a file
.TP
\fB\-\-h2o\-capsule\fR \fI<H2O_CAPSULE>\fR
Parse UEFI Capsule information from binary file
.TP
\fB\-\-dump\-ec\-flash\fR \fI<DUMP_EC_FLASH>\fR
Dump EC flash contents
.TP
\fB\-\-flash\-full\-ec\fR \fI<FLASH_FULL_EC>\fR
Flash full EC flash with new firmware from file \- may render your hardware unbootable!
.TP
\fB\-\-flash\-ec\fR \fI<FLASH_EC>\fR
Flash EC (RO+RW) with new firmware from file \- may render your hardware unbootable!
.TP
\fB\-\-flash\-ro\-ec\fR \fI<FLASH_RO_EC>\fR
Flash EC with new RO firmware from file \- may render your hardware unbootable!
.TP
\fB\-\-flash\-rw\-ec\fR \fI<FLASH_RW_EC>\fR
Flash EC with new RW firmware from file
.TP
\fB\-\-intrusion\fR
Show status of intrusion switch
.TP
\fB\-\-inputdeck\fR
Show status of the input modules
.TP
\fB\-\-inputdeck\-mode\fR \fI<INPUTDECK_MODE>\fR
Set input deck power mode [possible values: auto, off, on, reset] (Laptop 12, 13, 16)
.br
.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
auto
.IP \(bu 2
off
.IP \(bu 2
on
.IP \(bu 2
reset
.RE
.TP
\fB\-\-expansion\-bay\fR
Show status of the expansion bay (Laptop 16 only)
.TP
\fB\-\-charge\-limit\fR [\fI<CHARGE_LIMIT>\fR]
Get or set max charge limit
.TP
\fB\-\-charge\-current\-limit\fR \fI<CHARGE_CURRENT_LIMIT>...\fR
Set max charge current limit
.TP
\fB\-\-charge\-rate\-limit\fR \fI<CHARGE_RATE_LIMIT>...\fR
Set max charge current limit
.TP
\fB\-\-get\-gpio\fR [\fI<GET_GPIO>\fR]
Get GPIO value by name or all, if no name provided
.TP
\fB\-\-fp\-led\-level\fR [\fI<FP_LED_LEVEL>\fR]
Get or set fingerprint LED brightness level
.br
.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
high
.IP \(bu 2
medium
.IP \(bu 2
low
.IP \(bu 2
ultra\-low
.IP \(bu 2
auto
.RE
.TP
\fB\-\-fp\-brightness\fR [\fI<FP_BRIGHTNESS>\fR]
Get or set fingerprint LED brightness percentage
.TP
\fB\-\-kblight\fR [\fI<KBLIGHT>\fR]
Set keyboard backlight percentage or get, if no value provided
.TP
\fB\-\-remap\-key\fR \fI<REMAP_KEY>...\fR
Remap a key by changing the scancode
.TP
\fB\-\-rgbkbd\fR \fI<START>\fR\fI \fR\fI<HEXCOLOR>...\fR
Set the color of <key> to <RGB>. Multiple colors for adjacent keys can be set at once. <key> <RGB> [<RGB> ...] Example: 0 0xFF000 0x00FF00 0x0000FF
.TP
\fB\-\-tablet\-mode\fR \fI<TABLET_MODE>\fR
Set tablet mode override
.br
.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
auto
.IP \(bu 2
tablet
.IP \(bu 2
laptop
.RE
.TP
\fB\-\-touchscreen\-enable\fR \fI<TOUCHSCREEN_ENABLE>\fR
Enable/disable touchscreen
.br
.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
true
.IP \(bu 2
false
.RE
.TP
\fB\-\-haptic\-intensity\fR \fI<INTENSITY>\fR
Set touchpad haptic feedback intensity
.br
.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
0
.IP \(bu 2
25
.IP \(bu 2
50
.IP \(bu 2
75
.IP \(bu 2
100
.RE
.TP
\fB\-\-click\-force\fR \fI<CLICK_FORCE>\fR
Set touchpad click force / sensitivity
.br
.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
low
.IP \(bu 2
medium
.IP \(bu 2
high
.RE
.TP
\fB\-\-stylus\-battery\fR
Check stylus battery level (USI 2.0 stylus only)
.TP
\fB\-\-console\fR \fI<CONSOLE>\fR
Get EC console, choose whether recent or to follow the output
.br
.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
recent
.IP \(bu 2
follow
.RE
.TP
\fB\-\-reboot\-ec\fR \fI<REBOOT_EC>\fR
Control EC RO/RW jump
.br
.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
reboot
.IP \(bu 2
jump\-ro
.IP \(bu 2
jump\-rw
.IP \(bu 2
cancel\-jump
.IP \(bu 2
disable\-jump
.RE
.TP
\fB\-\-ec\-hib\-delay\fR [\fI<EC_HIB_DELAY>\fR]
Get or set EC hibernate delay (S5 to G3)
.TP
\fB\-\-sysinfo\fR
Show system info (reset flags, current image, locked state)
.TP
\fB\-\-uptimeinfo\fR
.TP
\fB\-\-s0ix\-counter\fR
.TP
\fB\-\-hello\fR
Check basic communication with EC
.TP
\fB\-\-protoinfo\fR
Show EC host command protocol info
.TP
\fB\-\-switches\fR
Show current EC switch positions (lid, power button, ...)
.TP
\fB\-\-port80read\fR
Show history of port 80 writes (POST codes)
.TP
\fB\-\-panicinfo\fR
Show saved EC panic info
.TP
\fB\-\-hash\fR \fI<HASH>\fR
Hash a file of arbitrary data
.TP
\fB\-\-driver\fR \fI<DRIVER>\fR
Select which driver is used. By default portio is used
.br
.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
portio
.IP \(bu 2
cros\-ec
.IP \(bu 2
windows
.RE
.TP
\fB\-\-pd\-addrs\fR \fI<PD_ADDRS>...\fR
Specify I2C addresses of the PD chips (Advanced)
.TP
\fB\-\-pd\-ports\fR \fI<PD_PORTS>...\fR
Specify I2C ports of the PD chips (Advanced)
.TP
\fB\-t\fR, \fB\-\-test\fR
Run self\-test to check if interaction with EC is possible
.TP
\fB\-\-test\-retimer\fR
Run self\-test to check if interaction with retimers is possible
.TP
\fB\-\-boardid\fR
Print all board IDs
.TP
\fB\-f\fR, \fB\-\-force\fR
Force execution of an unsafe command \- may render your hardware unbootable!
.TP
\fB\-\-dry\-run\fR
Simulate execution of a command (e.g. \-\-flash\-ec)
.TP
\fB\-\-flash\-gpu\-descriptor\-file\fR \fI<FLASH_GPU_DESCRIPTOR_FILE>\fR
File to write to the gpu EEPROM
.TP
\fB\-\-dump\-gpu\-descriptor\-file\fR \fI<DUMP_GPU_DESCRIPTOR_FILE>\fR
File to dump the gpu EEPROM to
.TP
\fB\-\-validate\-gpu\-descriptor\-file\fR \fI<VALIDATE_GPU_DESCRIPTOR_FILE>\fR
File to validate the gpu EEPROM against
.TP
\fB\-\-nvidia\fR
Show NVIDIA GPU information (Laptop 16 only)
.TP
\fB\-\-host\-command\fR \fI<HOST_COMMAND>...\fR
Send an EC host command. Args: <CMD_ID> <VERSION> [DATA...]
.TP
\fB\-h\fR, \fB\-\-help\fR
Print help (see a summary with \*(Aq\-h\*(Aq)
.SH EXAMPLES
List all firmware versions:
.PP
.RS 4
.nf
# framework_tool \-\-versions
.fi
.RE
.PP
Show battery and AC status:
.PP
.RS 4
.nf
# framework_tool \-\-power
.fi
.RE
.PP
Get keyboard backlight level:
.PP
.RS 4
.nf
# framework_tool \-\-kblight
.fi
.RE
.PP
Set keyboard backlight to 50%:
.PP
.RS 4
.nf
# framework_tool \-\-kblight 50
.fi
.RE
.PP
Set battery charge limit to 80%:
.PP
.RS 4
.nf
# framework_tool \-\-charge\-limit 80
.fi
.RE
.PP
Parse version from EC firmware file:
.PP
.RS 4
.nf
$ framework_tool \-\-ec\-bin ec.bin
.fi
.RE
.PP
Flash EC RW firmware:
.PP
.RS 4
.nf
# framework_tool \-\-flash\-rw\-ec ec_rw.bin
.fi
.RE
.PP