diff options
| author | Michael Kubacki <michael.kubacki@microsoft.com> | 2020-06-10 11:06:07 -0700 |
|---|---|---|
| committer | mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> | 2022-04-05 00:42:38 +0000 |
| commit | 4348c72ad0328fcf8ef37930cf51a5dbc2388038 (patch) | |
| tree | e3b1e938c5f9b6c1c00ac0fb0eefa2fe0726211c /PrmPkg/Readme.md | |
| parent | 6b7dde7cdd1649e59e228535a29aa8d80761a1ba (diff) | |
| download | edk2-4348c72ad0328fcf8ef37930cf51a5dbc2388038.tar.gz edk2-4348c72ad0328fcf8ef37930cf51a5dbc2388038.tar.bz2 edk2-4348c72ad0328fcf8ef37930cf51a5dbc2388038.zip | |
PrmPkg/Application/PrmInfo: Add initial application
Adds a new UEFI application called "PrmInfo" that allows a user
to display and test Platform Runtime Mechanism (PRM) modules.
Execute the application help command for detailed usage
instructions and examples of how to use the application:
"PrmInfo -?"
This application is intended to be helpful during PRM enabling
by allowing the user to:
1. Confirm that their firmware port of the PRM infrastructure
implemented in this package is functioning correctly.
2. Quickly get information about what PRM modules and handlers
are present on a given system.
3. Quickly test PRM handlers without booting to a fully featured
operating system.
4. Develop and exercise PRM handlers prior to the availability of
an operating system that is PRM aware.
Adds a brief section to Readme.md about the PrmInfo UEFI application
with a link to allow the reader to find more information about the
application if interested.
Cc: Andrew Fish <afish@apple.com>
Cc: Kang Gao <kang.gao@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Michael Kubacki <michael.kubacki@microsoft.com>
Cc: Leif Lindholm <leif@nuviainc.com>
Cc: Benjamin You <benjamin.you@intel.com>
Cc: Liu Yun <yun.y.liu@intel.com>
Cc: Ankit Sinha <ankit.sinha@intel.com>
Cc: Nate DeSimone <nathaniel.l.desimone@intel.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
Acked-by: Michael D Kinney <michael.d.kinney@intel.com>
Acked-by: Liming Gao <gaoliming@byosoft.com.cn>
Acked-by: Leif Lindholm <quic_llindhol@quicinc.com>
Reviewed-by: Ankit Sinha <ankit.sinha@intel.com>
Diffstat (limited to 'PrmPkg/Readme.md')
| -rw-r--r-- | PrmPkg/Readme.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/PrmPkg/Readme.md b/PrmPkg/Readme.md index b79cb66c47..2a8a40c924 100644 --- a/PrmPkg/Readme.md +++ b/PrmPkg/Readme.md @@ -118,6 +118,25 @@ maintained in PrmPkg. It is intended to only contain PRM infrastructure code and that infrastructure. The PrmPkg is meant to be used as-is by firmware that supports PRM. Any shortcomings that
prevent the package from being used as-is should be addressed directly in PrmPkg.
+## PRM Information UEFI Application
+A UEFI application is provided in this package called "PrmInfo" that allows a user to display and test PRM
+modules on their system.
+
+[Link to application source code](PrmPkg/Application/PrmInfo).
+
+This application is intended to be helpful during PRM enabling by allowing the user to:
+ 1. Confirm that their firmware port of the PRM infrastructure implemented in this package is functioning correctly.
+ 2. Quickly get information about what PRM modules and handlers that are present on a given system.
+ 3. Quickly test PRM handlers without booting into a full operating system.
+ 4. Develop and exercise PRM handlers prior to the availability of an operating system that is PRM aware.
+
+Execute the application help command for detailed usage instructions and examples of how to use the application: \
+ ``PrmInfo -?``
+
+*Example Usage:*
+
+
+
## PRM Module
> __*Note*__: You can find simple examples of PRM modules in the Samples directory of this package.
|