blob: 9385fd848344babb62f3c95ea63401fd791746e8 (
plain)
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
|
/** @file
String definitions for the PRM Information UEFI shell application.
Copyright (C) Microsoft Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
*/
#langdef en-US "English"
//
// Parameter error messages
//
#string STR_PRMINFO_DISCOVERY_FAILED #language en-US "%H%s%N: PRM module discovery failed.\r\n"
#string STR_PRMINFO_GEN_PROBLEM #language en-US "%H%s%N: Unknown flag - '%H%s%N'\r\n"
#string STR_PRMINFO_GUID_INV #language en-US "%H%s%N: Invalid GUID - '%H%s%N'\r\n"
#string STR_PRMINFO_HANDLER_NOT_FOUND #language en-US "%H%s%N: PRM Handler not found - '%H{%g}%N'\r\n"
#string STR_PRMINFO_MISSING_OPTION #language en-US "%H%s%N: Missing option '%H%s%N' required by flag - '%H%s%N'\r\n"
#string STR_PRMINFO_NO_ARG #language en-US "%H%s%N: An argument must be provided, try "-?" for help.\n"
#string STR_PRMINFO_NO_VALUE #language en-US "%H%s%N: Missing argument for flag - '%H%s%N'\r\n"
#string STR_PRMINFO_PARAM_INV #language en-US "%H%s%N: Invalid argument - '%H%s%N', try "-?" for help.\r\n"
#string STR_PRMINFO_TOO_MANY #language en-US "%H%s%N: Too many arguments.\r\n"
//
// Application informational messages
//
#string STR_PRMINFO_HANDLER_COUNT #language en-US " Handler Count: %d\r\n"
#string STR_PRMINFO_HANDLER_EXEC_TIME #language en-US " Execution Time: "
#string STR_PRMINFO_HANDLER_GUID #language en-US " Handler GUID: %g\r\n"
#string STR_PRMINFO_HANDLER_NAME #language en-US " Handler Name: %a\r\n"
#string STR_PRMINFO_HANDLER_NAME_HL #language en-US " Handler Name: %H%a%N\r\n"
#string STR_PRMINFO_HANDLER_PA #language en-US " Handler Physical Address: 0x%016x\r\n"
#string STR_PRMINFO_HANDLER_ERR_STATUS #language en-US " Return Status: %E%r%N\r\n"
#string STR_PRMINFO_HANDLER_SUCC_STATUS #language en-US " Return Status: %V%r%N\r\n"
#string STR_PRMINFO_HANDLERS_FOUND #language en-US " %d PRM handlers found.\r\n"
#string STR_PRMINFO_LINE_BREAK #language en-US "\r\n"
#string STR_PRMINFO_LIST_TITLE #language en-US "PRM Modules and Handlers:\r\n"
#string STR_PRMINFO_MODULE_GUID #language en-US "Module GUID: %g\r\n"
#string STR_PRMINFO_MODULE_NAME #language en-US "Module Name: %a\r\n"
#string STR_PRMINFO_MODULE_VERSION #language en-US "Module Version: %02d.%02d\r\n\r\n"
#string STR_PRMINFO_MODULES_FOUND #language en-US " %d PRM modules found.\r\n"
#string STR_PRMINFO_NO_MMIO_RANGES #language en-US " No runtime MMIO ranges used by this module.\r\n"
#string STR_PRMINFO_NO_STATIC_BUFFER #language en-US " This handler does not define a static data buffer.\r\n\r\n"
#string STR_PRMINFO_RUNTIME_MMIO_COUNT #language en-US " Runtime MMIO Range Count: %d\r\n"
#string STR_PRMINFO_RUNTIME_MMIO_INFO #language en-US " [%d]: Physical Base Address = 0x%016x\r\n Virtual Base Address = 0x%016x\r\n Length = 0x%x\r\n"
#string STR_PRMINFO_STATIC_DATA_BUFFER #language en-US " Static Data Buffer: 0x%016x\r\n"
#string STR_PRMINFO_UNKNOWN #language en-US "Unknown"
#string STR_PRMINFO_USECS #language en-US "%H%ld.%ld microseconds%N"
#string STR_PRMINFO_NANO_SECS #language en-US "%H%ld nanoseconds%N"
#string STR_PRMINFO_SECS #language en-US "%H%ld.%ld%ld%ld seconds%N"
#string STR_PRMINFO_MILLI_SECS #language en-US "%H%ld.%ld%ld milliseconds%N"
//
// Application error messages
//
#string STR_PRMINFO_HANDLER_PA_ERROR #language en-US " An ERROR (%r) occurred determining the handler physical address.\r\n"
#string STR_PRMINFO_HELP #language en-US ""
".TH PrmInfo 0 "Display and test Platform Runtime Mechanism (PRM) modules."\r\n"
".SH NAME:\r\n"
"Display and test Platform Runtime Mechanism (PRM) modules.\r\n"
".SH SYNOPSIS\r\n"
"\r\n"
"PRMINFO [[-?] | [-b] [-l] [-r] [-t (guid | all)]]\r\n"
".SH OPTIONS\r\n"
" \r\n"
" -? - Show help.\r\n"
" -b - Displays one screen of output at a time.\r\n"
" -l - Display a list of installed PRM modules and handlers.\r\n"
" -t - Call a given PRM handler by the specified GUID.\r\n"
" guid - A 32 digit GUID string with hyphen separation with no enclosing\r\n"
" character such as braces.\r\n"
" Example: 00000000-0000-0000-0000-000000000000\r\n"
" all - The string 'all' indicating all PRM handlers should be called\r\n"
" in order discovered.\r\n"
".SH DESCRIPTION\r\n"
" \r\n"
" This program is provided to allow examination of the Platform Runtime\r\n"
" Mechanism (PRM) configuration present on the current system. In addition,\r\n"
" the application contains some lightweight tests to verify that the firmware\r\n"
" set up the PRM information that will be conveyed to the loaded operating\r\n"
" system correctly.\r\n"
" \r\n"
" Default behavior is to display the content of all the PRM modules and\r\n"
" handlers currently installed (equivalent to the -l argument). To facilitate\r\n"
" debugging and verifying correct implementation of the PRM infrastructure\r\n"
" and PRM modules in a given firmware, the application can also call a\r\n"
" given PRM handler and perform basic validation of the PRMT ACPI table\r\n"
" to confirm it satisfies the basic constraints required for the table\r\n"
" in the PRM Specification.\r\n"
" \r\n"
"NOTES:\r\n"
" 1. Calling PRM handlers from this application:\r\n"
" - The user should exercise caution when calling PRM handlers in the\r\n"
" pre-OS environment. The PRM author may have only considered\r\n"
" execution within the context of OS runtime."
"\r\n"
" - The application will not perform any manipulation of PRM handler\r\n"
" parameter buffers prior to calling the handler.\r\n"
"\r\n"
" - This feature is intended to provide a quick method to exercise\r\n"
" PRM code without loading a full OS that is PRM aware and to perform\r\n"
" testing of PRM code that is aware it will be executed in such an\r\n"
" environment. It is not recommended to call PRM handlers on a\r\n"
" production system if you are not fully aware of how the PRM handler\r\n"
" behaves and any side effect(s) it might have on the system.\r\n"
".SH STANDARDS\r\n"
" \r\n"
"STANDARDS:\r\n"
" Platform Runtime Mechanism (PRM) is currently in a draft state and the\r\n"
" specification is not yet publicly available. A reference to the publicly\r\n"
" available document will replace this text when it is available.\r\n"
".SH EXAMPLES\r\n"
" \r\n"
"EXAMPLES:\r\n"
" * To display a list of the installed PRM modules and PRM handlers:\r\n"
" fs0:\> prminfo -l\r\n"
" \r\n"
" * To validate the installed PRMT ACPI table:\r\n"
" fs0:\> prminfo -r\r\n"
" \r\n"
" * To call a PRM handler by GUID:\r\n"
" fs0:\> prminfo -t e1466081-7562-430f-896b-b0e523dc335a\r\n"
" \r\n"
" * To call all of the PRM handlers discovered on the system:\r\n"
" fs0:\> prminfo -t all\r\n"
".SH RETURNVALUES\r\n"
" \r\n"
"RETURN VALUES:\r\n"
" SHELL_SUCCESS Data was displayed as requested.\r\n"
" SHELL_INVALID_PARAMETER The operation failed.\r\n"
" \r\n"
|
