UEFI Command Flags
UEFI Diagnostics processes flags in two steps. In the first step, the flags that
appear before any command (but after udiag) are parsed and
treated as the setting flags for the command that follows. In the second step, the
flags that follow a command are used to override the setting for the command
only.
Note -
Use the -l (log file) flag only as a default setting flag.
Use other flags only as command-specific flags. Use them as default settings
only when it is appropriate to do so.
|
|
|
|
-h, -help
|
|
Displays command help information.
|
|
-v, -V
|
|
Mutually exclusive flags that specify the amount of
information commands may output. -v is
verbose and -V is very verbose.
|
|
-w
|
<byte_size>
|
Specifies access size in bytes to register and memory
locations. <byte_size> must be one
of 1, 2,
4, or 8. The
default size is 8.
|
|
-pc
|
<n>
|
Repeats a command until <n>
passes are reached. The default is
1.
|
|
-ec
|
<n>
|
Repeats a command until <n>
errors are reached. The default is
1.
|
|
-time
|
<n>
|
Limits run to <n> seconds. The
default is 0, which indicates no
limit.
|
|
-l
|
<log_file>
|
Copies all console outputs to
<log_file>.
log_file must be in the format
of:
<volume>:<hierarchical_file_name>
Where: hierarchical_file_name =
[\<file_or_folder_name>]+
For example:
FS0:\>udiag system info -l
fs0:\system.info
|
|
-s
|
<begin>
|
Specifies a generic 64-bit hexadecimal number that is
command-specific. For example, memory tests use it as the lowest
address of a memory range to test.
|
|
-e
|
<end>
|
Specifies a generic 64-bit hexadecimal number that is
command-specific. For example, memory tests use it as the
highest address of a memory range to test
plus one byte.
|
|
-np
|
<n> | all
|
Specifies the number of application processors (APs) to use.
The literal all specifies to use all
enabled processors.
|
|
-ap
|
<n> ['<n>]*
|
Specifies one or more specific APs to use. The processor
number 0 is reserved for the boot strap
processor (BSP) and must not be used with this flag.
All APs are numbered from 1 through the maximum enabled
processors.
To find the relationship between the AP number with the socket
number, type:
udiag system acpi
For example, -ap 5f'1'10 allocates
processors 5f,
1 and
10 to a command. Memory
tests, for example, allocate the APs in the listed order to the
sub-blocks in a test range sequentially starting with the lowest
addressed sub-block. A typical application is to generate as
much cross traffic on socket interconnects by assigning
processors far from their sub-blocks.
|
|
When entering CLI commands, note the following rules:
-
Most commands support the -hv, -n,
-v, -V, -pc,
and -ec flags.
-
Application processors-capable commands support the -np
and -ap flags.
-
Long running tests such as memory and
storage support the -time
flag.
-
The suffix * (for example, [<n>]*) after the
right bracket indicates 0 or more repeated options.
-
The suffix + (for example,
[\<file_or_folder_name>]+) after the right
bracket indicates 1 or more repeated options.