138 lines
2.4 KiB
Groff
138 lines
2.4 KiB
Groff
|
.TH "PFRUT" "8" "October 2021" "pfrut 1.0" ""
|
||
|
|
.hy
|
||
|
|
.SH Name
|
||
|
|
.PP
|
||
|
|
pfrut \- Platform Firmware Runtime Update and Telemetry tool
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.PP
|
||
|
|
\f[B]pfrut\f[R] [\f[I]Options\f[R]]
|
||
|
|
.SH DESCRIPTION
|
||
|
|
.PP
|
||
|
|
The PFRUT(Platform Firmware Runtime Update and Telemetry) kernel interface is designed
|
||
|
|
to
|
||
|
|
.PD 0
|
||
|
|
.P
|
||
|
|
.PD
|
||
|
|
interact with the platform firmware interface defined in the
|
||
|
|
.PD 0
|
||
|
|
.P
|
||
|
|
.PD
|
||
|
|
Management Mode Firmware Runtime
|
||
|
|
Update (https://uefi.org/sites/default/files/resources/Intel_MM_OS_Interface_Spec_Rev100.pdf)
|
||
|
|
.PD 0
|
||
|
|
.P
|
||
|
|
.PD
|
||
|
|
\f[B]pfrut\f[R] is the tool to interact with the kernel interface.
|
||
|
|
.PD 0
|
||
|
|
.P
|
||
|
|
.PD
|
||
|
|
.SH OPTIONS
|
||
|
|
.TP
|
||
|
|
.B \f[B]\-h\f[R], \f[B]\-\-help\f[R]
|
||
|
|
Display helper information.
|
||
|
|
.TP
|
||
|
|
.B \f[B]\-l\f[R], \f[B]\-\-load\f[R]
|
||
|
|
Load the capsule file into the system.
|
||
|
|
To be more specific, the capsule file will be copied to the
|
||
|
|
communication buffer.
|
||
|
|
.TP
|
||
|
|
.B \f[B]\-s\f[R], \f[B]\-\-stage\f[R]
|
||
|
|
Stage the capsule image from communication buffer into Management Mode
|
||
|
|
and perform authentication.
|
||
|
|
.TP
|
||
|
|
.B \f[B]\-a\f[R], \f[B]\-\-activate\f[R]
|
||
|
|
Activate a previous staged capsule image.
|
||
|
|
.TP
|
||
|
|
.B \f[B]\-u\f[R], \f[B]\-\-update\f[R]
|
||
|
|
Perform both stage and activation actions.
|
||
|
|
.TP
|
||
|
|
.B \f[B]\-q\f[R], \f[B]\-\-query\f[R]
|
||
|
|
Query the update capability.
|
||
|
|
.TP
|
||
|
|
.B \f[B]\-d\f[R], \f[B]\-\-setrev\f[R]
|
||
|
|
Set the revision ID of code injection/driver update.
|
||
|
|
.TP
|
||
|
|
.B \f[B]\-D\f[R], \f[B]\-\-setrevlog\f[R]
|
||
|
|
Set the revision ID of telemetry.
|
||
|
|
.TP
|
||
|
|
.B \f[B]\-G\f[R], \f[B]\-\-getloginfo\f[R]
|
||
|
|
Get telemetry log information and print it out.
|
||
|
|
.TP
|
||
|
|
.B \f[B]\-T\f[R], \f[B]\-\-type\f[R]
|
||
|
|
Set the telemetry log data type.
|
||
|
|
.TP
|
||
|
|
.B \f[B]\-L\f[R], \f[B]\-\-level\f[R]
|
||
|
|
Set the telemetry log level.
|
||
|
|
.TP
|
||
|
|
.B \f[B]\-R\f[R], \f[B]\-\-read\f[R]
|
||
|
|
Read all the telemetry data and print it out.
|
||
|
|
.SH EXAMPLES
|
||
|
|
.PP
|
||
|
|
\f[B]pfrut \-G\f[R]
|
||
|
|
.PP
|
||
|
|
log_level:4
|
||
|
|
.PD 0
|
||
|
|
.P
|
||
|
|
.PD
|
||
|
|
log_type:0
|
||
|
|
.PD 0
|
||
|
|
.P
|
||
|
|
.PD
|
||
|
|
log_revid:2
|
||
|
|
.PD 0
|
||
|
|
.P
|
||
|
|
.PD
|
||
|
|
max_data_size:65536
|
||
|
|
.PD 0
|
||
|
|
.P
|
||
|
|
.PD
|
||
|
|
chunk1_size:0
|
||
|
|
.PD 0
|
||
|
|
.P
|
||
|
|
.PD
|
||
|
|
chunk2_size:1401
|
||
|
|
.PD 0
|
||
|
|
.P
|
||
|
|
.PD
|
||
|
|
rollover_cnt:0
|
||
|
|
.PD 0
|
||
|
|
.P
|
||
|
|
.PD
|
||
|
|
reset_cnt:4
|
||
|
|
.PP
|
||
|
|
\f[B]pfru \-q\f[R]
|
||
|
|
.PP
|
||
|
|
code injection image type:794bf8b2\-6e7b\-454e\-885f\-3fb9bb185402
|
||
|
|
.PD 0
|
||
|
|
.P
|
||
|
|
.PD
|
||
|
|
fw_version:0
|
||
|
|
.PD 0
|
||
|
|
.P
|
||
|
|
.PD
|
||
|
|
code_rt_version:1
|
||
|
|
.PD 0
|
||
|
|
.P
|
||
|
|
.PD
|
||
|
|
driver update image type:0e5f0b14\-f849\-7945\-ad81\-bc7b6d2bb245
|
||
|
|
.PD 0
|
||
|
|
.P
|
||
|
|
.PD
|
||
|
|
drv_rt_version:0
|
||
|
|
.PD 0
|
||
|
|
.P
|
||
|
|
.PD
|
||
|
|
drv_svn:0
|
||
|
|
.PD 0
|
||
|
|
.P
|
||
|
|
.PD
|
||
|
|
platform id:39214663\-b1a8\-4eaa\-9024\-f2bb53ea4723
|
||
|
|
.PD 0
|
||
|
|
.P
|
||
|
|
.PD
|
||
|
|
oem id:a36db54f\-ea2a\-e14e\-b7c4\-b5780e51ba3d
|
||
|
|
.PP
|
||
|
|
\f[B]pfrut \-l yours.cap \-u \-T 1 \-L 4\f[R]
|
||
|
|
.SH AUTHORS
|
||
|
|
Chen Yu.
|