0001 .TH "PFRUT" "8" "October 2021" "pfrut 1.0" ""
0002 .hy
0003 .SH Name
0004 .PP
0005 pfrut \- Platform Firmware Runtime Update and Telemetry tool
0006 .SH SYNOPSIS
0007 .PP
0008 \f[B]pfrut\f[R] [\f[I]Options\f[R]]
0009 .SH DESCRIPTION
0010 .PP
0011 The PFRUT(Platform Firmware Runtime Update and Telemetry) kernel interface is designed
0012 to
0013 .PD 0
0014 .P
0015 .PD
0016 interact with the platform firmware interface defined in the
0017 .PD 0
0018 .P
0019 .PD
0020 Management Mode Firmware Runtime
0021 Update (https://uefi.org/sites/default/files/resources/Intel_MM_OS_Interface_Spec_Rev100.pdf)
0022 .PD 0
0023 .P
0024 .PD
0025 \f[B]pfrut\f[R] is the tool to interact with the kernel interface.
0026 .PD 0
0027 .P
0028 .PD
0029 .SH OPTIONS
0030 .TP
0031 .B \f[B]\-h\f[R], \f[B]\-\-help\f[R]
0032 Display helper information.
0033 .TP
0034 .B \f[B]\-l\f[R], \f[B]\-\-load\f[R]
0035 Load the capsule file into the system.
0036 To be more specific, the capsule file will be copied to the
0037 communication buffer.
0038 .TP
0039 .B \f[B]\-s\f[R], \f[B]\-\-stage\f[R]
0040 Stage the capsule image from communication buffer into Management Mode
0041 and perform authentication.
0042 .TP
0043 .B \f[B]\-a\f[R], \f[B]\-\-activate\f[R]
0044 Activate a previous staged capsule image.
0045 .TP
0046 .B \f[B]\-u\f[R], \f[B]\-\-update\f[R]
0047 Perform both stage and activation actions.
0048 .TP
0049 .B \f[B]\-q\f[R], \f[B]\-\-query\f[R]
0050 Query the update capability.
0051 .TP
0052 .B \f[B]\-d\f[R], \f[B]\-\-setrev\f[R]
0053 Set the revision ID of code injection/driver update.
0054 .TP
0055 .B \f[B]\-D\f[R], \f[B]\-\-setrevlog\f[R]
0056 Set the revision ID of telemetry.
0057 .TP
0058 .B \f[B]\-G\f[R], \f[B]\-\-getloginfo\f[R]
0059 Get telemetry log information and print it out.
0060 .TP
0061 .B \f[B]\-T\f[R], \f[B]\-\-type\f[R]
0062 Set the telemetry log data type.
0063 .TP
0064 .B \f[B]\-L\f[R], \f[B]\-\-level\f[R]
0065 Set the telemetry log level.
0066 .TP
0067 .B \f[B]\-R\f[R], \f[B]\-\-read\f[R]
0068 Read all the telemetry data and print it out.
0069 .SH EXAMPLES
0070 .PP
0071 \f[B]pfrut \-G\f[R]
0072 .PP
0073 log_level:4
0074 .PD 0
0075 .P
0076 .PD
0077 log_type:0
0078 .PD 0
0079 .P
0080 .PD
0081 log_revid:2
0082 .PD 0
0083 .P
0084 .PD
0085 max_data_size:65536
0086 .PD 0
0087 .P
0088 .PD
0089 chunk1_size:0
0090 .PD 0
0091 .P
0092 .PD
0093 chunk2_size:1401
0094 .PD 0
0095 .P
0096 .PD
0097 rollover_cnt:0
0098 .PD 0
0099 .P
0100 .PD
0101 reset_cnt:4
0102 .PP
0103 \f[B]pfru \-q\f[R]
0104 .PP
0105 code injection image type:794bf8b2\-6e7b\-454e\-885f\-3fb9bb185402
0106 .PD 0
0107 .P
0108 .PD
0109 fw_version:0
0110 .PD 0
0111 .P
0112 .PD
0113 code_rt_version:1
0114 .PD 0
0115 .P
0116 .PD
0117 driver update image type:0e5f0b14\-f849\-7945\-ad81\-bc7b6d2bb245
0118 .PD 0
0119 .P
0120 .PD
0121 drv_rt_version:0
0122 .PD 0
0123 .P
0124 .PD
0125 drv_svn:0
0126 .PD 0
0127 .P
0128 .PD
0129 platform id:39214663\-b1a8\-4eaa\-9024\-f2bb53ea4723
0130 .PD 0
0131 .P
0132 .PD
0133 oem id:a36db54f\-ea2a\-e14e\-b7c4\-b5780e51ba3d
0134 .PP
0135 \f[B]pfrut \-l yours.cap \-u \-T 1 \-L 4\f[R]
0136 .SH AUTHORS
0137 Chen Yu.
