xref: /openbmc/linux/tools/power/acpi/man/pfrut.8 (revision 8931ddd8)
"PFRUT" "8" "October 2021" "pfrut 1.0" ""
Name

pfrut - Platform Firmware Runtime Update and Telemetry tool

SYNOPSIS

\f[B]pfrut\f[R] [\f[I]Options\f[R]]

DESCRIPTION

The PFRUT(Platform Firmware Runtime Update and Telemetry) kernel interface is designed to

0

interact with the platform firmware interface defined in the

0

Management Mode Firmware Runtime Update (https://uefi.org/sites/default/files/resources/Intel_MM_OS_Interface_Spec_Rev100.pdf)

0

\f[B]pfrut\f[R] is the tool to interact with the kernel interface.

0

OPTIONS

\f[B]-h\f[R], \f[B]--help\f[R] Display helper information.

\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.

\f[B]-s\f[R], \f[B]--stage\f[R] Stage the capsule image from communication buffer into Management Mode and perform authentication.

\f[B]-a\f[R], \f[B]--activate\f[R] Activate a previous staged capsule image.

\f[B]-u\f[R], \f[B]--update\f[R] Perform both stage and activation actions.

\f[B]-q\f[R], \f[B]--query\f[R] Query the update capability.

\f[B]-d\f[R], \f[B]--setrev\f[R] Set the revision ID of code injection/driver update.

\f[B]-D\f[R], \f[B]--setrevlog\f[R] Set the revision ID of telemetry.

\f[B]-G\f[R], \f[B]--getloginfo\f[R] Get telemetry log information and print it out.

\f[B]-T\f[R], \f[B]--type\f[R] Set the telemetry log data type.

\f[B]-L\f[R], \f[B]--level\f[R] Set the telemetry log level.

\f[B]-R\f[R], \f[B]--read\f[R] Read all the telemetry data and print it out.

EXAMPLES

\f[B]pfrut -G\f[R]

log_level:4

0

log_type:0

0

log_revid:2

0

max_data_size:65536

0

chunk1_size:0

0

chunk2_size:1401

0

rollover_cnt:0

0

reset_cnt:4

\f[B]pfru -q\f[R]

code injection image type:794bf8b2-6e7b-454e-885f-3fb9bb185402

0

fw_version:0

0

code_rt_version:1

0

driver update image type:0e5f0b14-f849-7945-ad81-bc7b6d2bb245

0

drv_rt_version:0

0

drv_svn:0

0

platform id:39214663-b1a8-4eaa-9024-f2bb53ea4723

0

oem id:a36db54f-ea2a-e14e-b7c4-b5780e51ba3d

\f[B]pfrut -l yours.cap -u -T 1 -L 4\f[R]

AUTHORS
Chen Yu.