mirror of https://github.com/acidanthera/audk.git
631 lines
66 KiB
Plaintext
631 lines
66 KiB
Plaintext
// /**
|
|
//
|
|
// (C) Copyright 2012-2014, Hewlett-Packard Development Company, L.P.
|
|
// Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.<BR>
|
|
// This program and the accompanying materials
|
|
// are licensed and made available under the terms and conditions of the BSD License
|
|
// which accompanies this distribution. The full text of the license may be found at
|
|
// http://opensource.org/licenses/bsd-license.php.
|
|
//
|
|
// THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|
//
|
|
// Module Name:
|
|
//
|
|
// UefiShellDriver1CommandsLib.uni
|
|
//
|
|
// Abstract:
|
|
//
|
|
// String definitions for UEFI Shell 2.0 driver1 profile commands
|
|
//
|
|
//
|
|
// **/
|
|
|
|
/=#
|
|
|
|
#langdef en-US "english"
|
|
|
|
#string STR_GEN_PROBLEM #language en-US "%EError. %NThe argument '%B%s%N' is incorrect.\r\n"
|
|
#string STR_GEN_PROBLEM_VAL #language en-US "%EError. %NThe argument '%B%s%N' has incorrect value.\r\n"
|
|
#string STR_GEN_TOO_FEW #language en-US "%EError. %NToo few arguments specified.\r\n"
|
|
#string STR_GEN_TOO_MANY #language en-US "%EError. %NToo many arguments specified.\r\n"
|
|
#string STR_GEN_INV_HANDLE #language en-US "%EError. %NThe handle '%B%s%N' is incorrect.\r\n"
|
|
#string STR_GEN_PARAM_CONF #language en-US "%EError. %NParameter conflict, %s & %s.\r\n"
|
|
#string STR_GEN_NO_VALUE #language en-US "%EError. %NThe argument '%B%s%N' requires a value.\r\n"
|
|
#string STR_GEN_HANDLE_NOT #language en-US "%EError. %NThe handle [%H%02x%N] is not a valid %s.\r\n"
|
|
#string STR_GEN_HANDLE_REQ #language en-US "%EError. %NA handle is required with the specified options.\r\n"
|
|
#string STR_GEN_PROTOCOL_NF #language en-US "%EError. %NThe protocol '%B%s%N' was required and not found (%g).\r\n"
|
|
#string STR_GEN_FIND_FAIL #language en-US "%EError. %NThe file '%B%s%N' could not be found.\r\n"
|
|
#string STR_GEN_FILE_EXIST #language en-US "%EError. %NThe file '%B%s%N' already exists.\r\n"
|
|
#string STR_GEN_FILE_OPEN #language en-US "%EError. %NThe file '%B%s%N' did not open: %r.\r\n"
|
|
#string STR_FILE_WRITE_FAIL #language en-US "%EError. %NUnable to write file %s: %r.\r\n"
|
|
#string STR_FILE_READ_FAIL #language en-US "%EError. %NUnable to read file %s: %r.\r\n"
|
|
#string STR_GEN_OUT_MEM #language en-US "%EError. %NMemory allocation was not successful.\r\n"
|
|
#string STR_GEN_UEFI_FUNC_ERROR #language en-US "%EError. %NUEFI function '%B%s%N' returned: %r.\r\n"
|
|
#string STR_GEN_SFO_HEADER #language en-US "ShellCommand,"%s"\r\n"
|
|
|
|
#string STR_DRVDIAG_HEADER #language en-US "%EAvailable Diagnostics%N.\r\n"
|
|
#string STR_DRVDIAG_DRIVER_HEADER #language en-US "Driver [%H%02x%N]: "
|
|
#string STR_DRVDIAG_DRIVER_NO_HANDLES #language en-US "No controller handles found.\r\n"
|
|
|
|
#string STR_HANDLE_RESULT #language en-US "%H%s%N - Handle [%H%02x%N] Result %r.\r\n"
|
|
#string STR_3P_RESULT #language en-US "%H%s%N - (%H%02x%N,%H%02x%N,%H%02x%N) Result %r.\r\n"
|
|
#string STR_CONNECT_NONE #language en-US "%HConnect%N No drivers could be connected.\r\n"
|
|
|
|
#string STR_DRVCFG_NONE_FOUND #language en-US "%HDrvCfg%N No configurable devices were found.\r\n"
|
|
#string STR_DRVCFG_COMP #language en-US "%HDrvCfg%N - operation complete.\r\n"
|
|
#string STR_DRVCFG_DONE_HII #language en-US "Handle[%H%02x%N] successfully updated from file.\r\n"
|
|
#string STR_DRVCFG_LINE_HII #language en-US "Handle[%H%02x%N] HII Config Access\r\n"
|
|
#string STR_DRVCFG_ALL_LANG #language en-US "Driver[%H%02x%N] Ctrl[--] Lang[%H%a%N] Driver Configuration"
|
|
#string STR_DRVCFG_CTRL_LANG #language en-US "Driver[%H%02x%N] Ctrl[%H%02x%N] Lang[%H%a%N] Driver Configuration"
|
|
#string STR_DRVCFG_CHILD_LANG #language en-US "Driver[%H%02x%N] Ctrl[%H%02x%N] Child[%H%02x%N] Lang[%H%a%N] Driver Configuration"
|
|
#string STR_DRVCFG_RESTART_S #language en-US "Restart %s\r\n"
|
|
#string STR_DRVCFG_STOP #language en-US "Stop Controller\n"
|
|
#string STR_DRVCFG_ENTER_S #language en-US "\nPress [ENTER] to %s"
|
|
#string STR_DRVCFG_NONE #language en-US "None\n"
|
|
#string STR_DRVCFG_CTLR_S #language en-US "Controller %s\n"
|
|
#string STR_DRVCFG_FORCE_D #language en-US "Force Default Configuration to DefaultType %08x\n"
|
|
#string STR_DRVCFG_VALIDATE #language en-US "Validate Configuration Options\n"
|
|
#string STR_DRVCFG_SET #language en-US "Set Configuration Options\n"
|
|
#string STR_DRVCFG_NOT_SUPPORT #language en-US "Handle [%H%02x%N] does not support configuration.\n"
|
|
#string STR_DRVCFG_OPTIONS_SET #language en-US " - Options set. Action Required is "
|
|
#string STR_DRVCFG_NOT_SET #language en-US " - Options not set. Status = %r\n"
|
|
#string STR_DRVCFG_DEF_FORCED #language en-US " - Defaults forced. Action Required is "
|
|
#string STR_DRVCFG_FORCE_FAILED #language en-US " - Force of defaults failed. Status = %r\n"
|
|
#string STR_DRVCFG_OPTIONS_VALID #language en-US " - Options valid\n"
|
|
#string STR_DRVCFG_OPTIONS_INV #language en-US " - Options not valid. Status = %r\n"
|
|
#string STR_DRVCFG_IN_FILE_NF #language en-US "%EError. %NDevicePath '%B%s%N' from file not found in HII DB. Skipped.\r\n"
|
|
|
|
|
|
#string STR_DEVICES_HEADER_LINES #language en-US "%N C T D\r\n T Y C I\r\n R P F A\r\n L E G G #P #D #C Device Name%N\r\n == = = = == == == ===========================================================\r\n"
|
|
#string STR_DEVICES_ITEM_LINE #language en-US " %H%02x%N %1c %1c %1c % 2d % 2d % 2d %s\r\n"
|
|
#string STR_DEVICES_ITEM_LINE_SFO #language en-US "DevicesInfo, %H%02x%N, %1c, %1c, %1c, %2d, %2d, %2d, %s\r\n"
|
|
|
|
#string STR_DRIVERS_HEADER_LINES #language en-US "%N"
|
|
" T D\r\n"
|
|
" Y C I\r\n"
|
|
" P F A\r\n"
|
|
"DRV VERSION E G G #D #C DRIVER NAME IMAGE PATH\r\n"
|
|
"=== ======== = = = === === =================================== ==========\r\n"
|
|
#string STR_DRIVERS_ITEM_LINE #language en-US "%H%3x%N %08x %1c %1c %1c %3d %3d %-35s %s\r\n"
|
|
#string STR_DRIVERS_ITEM_LINE_SFO #language en-US "DriversInfo,"%x","%x","%c","%c","%c","%d","%d","%s","%s"\r\n"
|
|
|
|
#string STR_DH_NO_GUID_FOUND #language en-US "Protocol ID '%s' could not be identified.\r\n"
|
|
#string STR_DH_SFO_OUTPUT #language en-US "%s, %s, %H%02x%N, %s, &s\r\n"
|
|
#string STR_DH_OUTPUT #language en-US "%H%02x%N: %s\r\n"
|
|
#string STR_DH_OUTPUT_SINGLE #language en-US "%H%02x%N: %x\r\n%s"
|
|
#string STR_DH_OUTPUT_SFO #language en-US "%s, %s, %s, %H%02x%N, %s, %s\r\n"
|
|
#string STR_DH_OUTPUT_DRIVER1 #language en-US " Controller Name : %B%s%N\r\n"
|
|
#string STR_DH_OUTPUT_DRIVER2 #language en-US " Device Path : %B%s%N\r\n"
|
|
" Controller Type : %B%s%N\r\n"
|
|
" Configuration : %B%s%N\r\n"
|
|
" Diagnostics : %B%s%N\r\n"
|
|
#string STR_DH_OUTPUT_DRIVER3 #language en-US " Managed by : %B%s%N\r\n"
|
|
#string STR_DH_OUTPUT_DRIVER4A #language en-US " Drv[%H%02x%N] : Image(%B%s%N)r\n"
|
|
#string STR_DH_OUTPUT_DRIVER4B #language en-US " Drv[%H%02x%N] : %B%s%N\r\n"
|
|
#string STR_DH_OUTPUT_DRIVER5 #language en-US " Parent Controllers : %B%s%N\r\n"
|
|
#string STR_DH_OUTPUT_DRIVER5B #language en-US " Parent[%H%02x%N] : %B%s%N\r\n"
|
|
#string STR_DH_OUTPUT_DRIVER6 #language en-US " Child Controllers : %B%s%N\r\n"
|
|
#string STR_DH_OUTPUT_DRIVER6B #language en-US " Child[%H%02x%N] : %B%s%N\r\n"
|
|
#string STR_DH_OUTPUT_DRIVER7 #language en-US " Driver Name : %B%s%N\r\n"
|
|
#string STR_DH_OUTPUT_DRIVER7B #language en-US " Driver Image Name : %B%s%N\r\n"
|
|
#string STR_DH_OUTPUT_DRIVER8 #language en-US " Driver Version : %B%08x%N\r\n"
|
|
" Driver Type : %B%s%N\r\n"
|
|
" Configuration : %B%s%N\r\n"
|
|
" Diagnostics : %B%s%N\r\n"
|
|
#string STR_DH_OUTPUT_DRIVER9 #language en-US " Managing : %B%s%N\r\n"
|
|
#string STR_DH_OUTPUT_DRIVER9B #language en-US " Ctrl[%H%02x%N] : %B%s%N\r\n"
|
|
|
|
#string STR_DEV_TREE_OUTPUT #language en-US "Ctrl[%H%02x%N] %s\r\n"
|
|
|
|
#string STR_UNLOAD_CONF #language en-US "%HUnload%N - Handle [%H%02x%N]. [y/n]?\r\n"
|
|
#string STR_UNLOAD_VERBOSE #language en-US ""
|
|
"Handle [%H%02x%N] (%08x)\r\n"
|
|
" Image (%08x)\r\n"
|
|
" ParentHandle..: %08x\r\n"
|
|
" SystemTable...: %08x\r\n"
|
|
" DeviceHandle..: %08x\r\n"
|
|
" FilePath......: %s\r\n"
|
|
" PDBFileName...: %a\r\n"
|
|
" ImageBase.....: %08x\r\n"
|
|
" ImageSize.....: %Ld\r\n"
|
|
" CodeType......: %s\r\n"
|
|
" DataType......: %s\r\n"
|
|
|
|
#string STR_OPENINFO_HEADER_LINE #language en-US "Handle %H%02x%N (%H%0p%N)\r\n"
|
|
#string STR_OPENINFO_LINE #language en-US " Drv[%H%02x%N] Ctrl[%H%02x%N] Cnt(%H%02x%N) %H%s Image%N(%s)\r\n"
|
|
#string STR_OPENINFO_MIN_LINE #language en-US " Drv[%H%02x%N] Ctrl[ ] Cnt(%H%02x%N) %H%s Image%N(%s)\r\n"
|
|
|
|
#string STR_DRV_DIAG_ITEM_LINE #language en-US " Drv[%H%02x%N] Ctrl[%H%02x%N] Child[%H%02x%N]\r\n"
|
|
|
|
#string STR_GET_HELP_DRVCFG #language en-US ""
|
|
".TH drvcfg 0 "configure a UEFI driver."\r\n"
|
|
".SH NAME\r\n"
|
|
"Invokes the driver configuration.\r\n"
|
|
".SH SYNOPSIS\r\n"
|
|
"drvcfg [-l XXX] [-c] [-f <Type>|-v|-s] [DriverHandle [DeviceHandle [ChildHandle]]] [-i filename] [-o filename]\r\n"
|
|
".SH OPTIONS\r\n"
|
|
"Type\r\n"
|
|
" The type of default configuration options to force on the controller.\r\n"
|
|
" 0 - Standard Defaults.\r\n"
|
|
" 1 - Manufacturing Defaults.\r\n"
|
|
" 2 - Safe Defaults.\r\n"
|
|
" 4000-FFFF - Custom Defaults.\r\n"
|
|
"DriverHandle The handle of the driver to configure\r\n"
|
|
"DeviceHandle The handle of a device that DriverHandle is managing\r\n"
|
|
"ChildHandle The handle of a device that is a child of DeviceHandle \r\n"
|
|
"-c Configure all child devices\r\n"
|
|
"-l Configure using the ISO 3066 language specified by XXX\r\n"
|
|
"-f Force defaults\r\n"
|
|
"-v Validate options\r\n"
|
|
"-s Set options\r\n"
|
|
"-i Receive configuration updates from an input file\r\n"
|
|
"-o Export the settings of the specified driver instance to a file\r\n"
|
|
".SH DESCRIPTION\r\n"
|
|
"This command invokes the platform's Configuration infrastructure. The table below describes the values for the Type parameter. Other values depend on the driver's implementation."
|
|
".SH RETURNVALUES\r\n"
|
|
"SHELL_SUCCESS The action was completed as requested.\r\n"
|
|
"SHELL_SECURITY_VIOLATION This function was not performed due to a security violation\r\n"
|
|
"SHELL_UNSUPPORTED The action as requested was unsupported.\r\n"
|
|
"SHELL_INVALID_PARAMETER One of the passed in parameters was incorrectly formatted or its value was out of bounds.\r\n"
|
|
".SH EXAMPLES\r\n"
|
|
"To display the list of devices that are available for configuration:\r\n"
|
|
" Shell> drvcfg\r\n"
|
|
"\r\n"
|
|
"To display the list of devices and child devices that are available for configuration:\r\n"
|
|
" Shell> drvcfg -c\r\n"
|
|
"\r\n"
|
|
"To force defaults on all devices:\r\n"
|
|
" Shell> drvcfg -f 0\r\n"
|
|
"\r\n"
|
|
"To force defaults on all devices that are managed by driver 0x17:\r\n"
|
|
" Shell> drvcfg -f 0 17\r\n"
|
|
"\r\n"
|
|
"To force defaults on device 0x28 that is managed by driver 0x17:\r\n"
|
|
" Shell> drvcfg -f 0 17 28\r\n"
|
|
"\r\n"
|
|
"To force defaults on all child devices of device 0x28 that is managed by driver 0x17:\r\n"
|
|
" Shell> drvcfg -f 0 17 28 -c\r\n"
|
|
"\r\n"
|
|
"To force defaults on child device 0x30 of device 0x28 that is managed by driver 0x17:\r\n"
|
|
" Shell> drvcfg -f 0 17 28 30\r\n"
|
|
"\r\n"
|
|
"To validate options on all devices:\r\n"
|
|
" Shell> drvcfg -v\r\n"
|
|
"\r\n"
|
|
"To validate options on all devices that are managed by driver 0x17:\r\n"
|
|
" Shell> drvcfg -v 17\r\n"
|
|
"\r\n"
|
|
"To validate options on device 0x28 that is managed by driver 0x17:\r\n"
|
|
" Shell> drvcfg -v 17 28\r\n"
|
|
"\r\n"
|
|
"To validate options on all child devices of device 0x28 that is managed by driver 0x17:\r\n"
|
|
" Shell> drvcfg -v 17 28 -c\r\n"
|
|
"\r\n"
|
|
"To validate options on child device 0x30 of device 0x28 that is managed by driver 0x17:\r\n"
|
|
" Shell> drvcfg -v 17 28 30\r\n"
|
|
"\r\n"
|
|
"To set options on device 0x28 that is managed by driver 0x17: \r\n"
|
|
" Shell> drvcfg -s 17 28\r\n"
|
|
"\r\n"
|
|
"To set options on child device 0x30 of device 0x28 that is managed by driver 0x17:\r\n"
|
|
" Shell> drvcfg -s 17 28 30\r\n"
|
|
"\r\n"
|
|
"To set options on device 0x28 that is managed by driver 0x17 in English:\r\n"
|
|
" Shell> drvcfg -s 17 28 -l eng\r\n"
|
|
"\r\n"
|
|
"To set options on device 0x28 that is managed by driver 0x17 in Spanish:\r\n"
|
|
" Shell> drvcfg -s 17 28 -l spa\r\n"
|
|
"\r\n"
|
|
|
|
#string STR_GET_HELP_DRIVERS #language en-US ""
|
|
".TH drivers 0 "display a list of drivers"\r\n"
|
|
".SH NAME\r\n"
|
|
"Displays the UEFI driver list.\r\n"
|
|
".SH SYNOPSIS\r\n"
|
|
" \r\n"
|
|
"DRIVERS [-l XXX] [-sfo] \r\n"
|
|
".SH OPTIONS\r\n"
|
|
" \r\n"
|
|
" -l - Displays drivers using the specified language (e.g. ISO 639-2) \r\n"
|
|
" -sfo - Displays information as described in Standard-Format Output.\r\n"
|
|
".SH DESCRIPTION\r\n"
|
|
" \r\n"
|
|
"NOTES:\r\n"
|
|
" 1. This command displays a list of information for drivers that follow the\r\n"
|
|
" UEFI Driver Model in the UEFI environment. The list includes:\r\n"
|
|
" DRV - The handle number of the UEFI driver.\r\n"
|
|
" VERSION - The version number of the UEFI driver.\r\n"
|
|
" TYPE - The driver type:\r\n"
|
|
" [B] - Bus Driver\r\n"
|
|
" [D] - Device Driver\r\n"
|
|
" CFG - Driver supports the Driver Configuration Protocol.\r\n"
|
|
" DIAG - Driver supports the Driver Diagnostics Protocol.\r\n"
|
|
" #D - The number of devices that this driver is managing.\r\n"
|
|
" #C - The number of child devices that this driver has produced.\r\n"
|
|
" DRIVER NAME - The name of the driver from the Component Name Protocol.\r\n"
|
|
" IMAGE PATH - The file path from which the driver was loaded.\r\n"
|
|
".SH EXAMPLES\r\n"
|
|
" \r\n"
|
|
"EXAMPLES:\r\n"
|
|
" * To display the list:\r\n"
|
|
" Shell> drivers\r\n"
|
|
".SH RETURNVALUES\r\n"
|
|
" \r\n"
|
|
"RETURN VALUES:\r\n"
|
|
" SHELL_SUCCESS The action was completed as requested.\r\n"
|
|
" SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n"
|
|
" violation.\r\n"
|
|
" SHELL_INVALID_PARAMETER One of the passed in parameters was incorrectly\r\n"
|
|
" formatted or its value was out of bounds.\r\n"
|
|
|
|
#string STR_GET_HELP_DISCONNECT #language en-US ""
|
|
".TH disconnect 0 "disconnect a driver"\r\n"
|
|
".SH NAME\r\n"
|
|
"Disconnects one or more drivers from the specified devices. \r\n"
|
|
".SH SYNOPSIS\r\n"
|
|
"disconnect DeviceHandle [DriverHandle [ChildHandle]] [-r] \r\n"
|
|
".SH OPTIONS\r\n"
|
|
"DeviceHandle Device handle (a hexadecimal number). If not specified, then disconnect DriverHandle.\r\n"
|
|
"DriverHandle Driver handle (a hexadecimal number)\r\n"
|
|
"ChildHandle Child handle of a device (a hexadecimal number). If not specified, then all child handles of DeviceHandle will be disconnected.\r\n"
|
|
"-r Disconnect all drivers from all devices.\r\n"
|
|
".SH DESCRIPTION\r\n"
|
|
"This command disconnects one or more drivers from the specified devices. If the -r option is used, all drivers are disconnected from all devices in the system. The following example is the typical output from the help for this command.\r\n"
|
|
".SH RETURNVALUES\r\n"
|
|
"SHELL_SUCCESS The action was completed as requested.\r\n"
|
|
"SHELL_SECURITY_VIOLATION This function was not performed due to a security violation\r\n"
|
|
"SHELL_INVALID_PARAMETER One of the passed in parameters was incorrectly formatted or its value was out of bounds.\r\n"
|
|
".SH EXAMPLES\r\n"
|
|
" To disconnect all drivers from all devices:\r\n"
|
|
" Shell> disconnect -r\r\n"
|
|
"\r\n"
|
|
" To disconnect all drivers from device 0x28:\r\n"
|
|
" fs0:\> disconnect 28\r\n"
|
|
"\r\n"
|
|
" To disconnect driver 0x17 from device 0x28:\r\n"
|
|
" fs0:\> disconnect 28 17\r\n"
|
|
"\r\n"
|
|
" To disconnect driver 0x17 from controlling the child 0x32 of device 0x28\r\n"
|
|
" fs0:\> disconnect 28 17 32\r\n"
|
|
""\r\n"
|
|
|
|
#string STR_GET_HELP_DH #language en-US ""
|
|
".TH dh 0 "displays list of handles"\r\n"
|
|
".SH NAME\r\n"
|
|
"Displays the device handles in the UEFI environment. \r\n"
|
|
".SH SYNOPSIS\r\n"
|
|
"dh [-l <lang>] [handle | -p <prot_id>] [-d] [-v] \r\n"
|
|
".SH OPTIONS\r\n"
|
|
"handle Specific handle to dump information about (a hexadecimal number). If not present, then all information will be dumped.\r\n"
|
|
"-p Dumps all handles of a protocol specified by the GUID.\r\n"
|
|
"-d Dumps UEFI Driver Model-related information.\r\n"
|
|
"-l Dumps information using the language codes, as described in Appendix M of the UEFI specification.\r\n"
|
|
"-sfo Displays information as described in \"Standard-Format Output\" below.\r\n"
|
|
"-v, -verbose Dumps verbose information about a specific handle.\r\n"
|
|
".SH DESCRIPTION\r\n"
|
|
"This command displays the device handles in the EFI environment. If this command is used with a specific handle number, the details of all the protocols that are associated with that device handle are displayed. Otherwise, the -p option can be used to list the device handles that contain a specific protocol.\r\n"
|
|
"If neither -p or handle is specified, then all handles will be displayed.\r\n"
|
|
".SH RETURNVALUES\r\n"
|
|
"SHELL_SUCCESS The action was completed as requested.\r\n"
|
|
"SHELL_SECURITY_VIOLATION This function was not performed due to a security violation\r\n"
|
|
"SHELL_INVALID_PARAMETER One of the passed in parameters was incorrectly formatted or its value was out of bounds.\r\n"
|
|
".SH EXAMPLES\r\n"
|
|
"To display all handles and display one screen at a time:\r\n"
|
|
" Shell> dh -b\r\n"
|
|
" Handle dump\r\n"
|
|
" 1: Image(DXE Core)\r\n"
|
|
" 2: FwVol FwFileSys FwVolBlk DevPath(MemMap(11:1B50000-\r\n"
|
|
" 1D4FFC8))\r\n"
|
|
" 3: Image(Ebc)\r\n"
|
|
" 4: DevPath(MemMap(11:1CA0000-1CB0000))\r\n"
|
|
" 5: Image(WinNtThunk)\r\n"
|
|
" 6: WinNtThunk DevPath(..76F3-11D4-BCEA-0080C73C8881))\r\n"
|
|
" 7: Image(WinNtBusDriver) DriverBinding\r\n"
|
|
" ...\r\n"
|
|
"\r\n"
|
|
"To display the detailed information on handle 0x30:\r\n"
|
|
" Shell> dh 30\r\n"
|
|
" Handle 30 (01AF5308)\r\n"
|
|
" IsaIo\r\n"
|
|
" ROM Size......: 00000000\r\n"
|
|
" ROM Location..: 00000000\r\n"
|
|
" ISA Resource List :\r\n"
|
|
" IO : 000003F8-000003FF Attr : 00000000\r\n"
|
|
" INT : 00000004-00000000 Attr : 00000000\r\n"
|
|
" \r\n"
|
|
" dpath\r\n"
|
|
" PNP Device Path for PnP\r\n"
|
|
" HID A0341D0, UID 0x0\r\n"
|
|
" Hardware Device Path for PCI\r\n"
|
|
" PNP Device Path for PnP\r\n"
|
|
" HID 50141D0, UID 0\r\n"
|
|
" AsStr: 'Acpi(PNP0A03,0)/Pci(1F|0)/Acpi(PNP0501,0)'\r\n"
|
|
"\r\n"
|
|
"To display all handles with 'diskio' protocol:\r\n"
|
|
" Shell> dh -p diskio\r\n"
|
|
" Handle dump by protocol 'Diskio'\r\n"
|
|
" 15: DiskIo BlkIo DevPath(..i(3|1)/Ata(Secondary,Master))\r\n"
|
|
" 16: DiskIo BlkIo DevPath(..,1)/PCI(0|0)/Scsi(Pun0,Lun0))\r\n"
|
|
" 44: DiskIo BlkIo Fs DevPath(..ABD0-01C0-507B-9E5F8078F531))\r\n"
|
|
" ESP\r\n"
|
|
" 45: DiskIo BlkIo Fs DevPath(..i(Pun0,Lun0)/HD(Part4,SigG0))\r\n"
|
|
" ESP\r\n"
|
|
" 17: DiskIo BlkIo DevPath(..PCI(3|1)/Ata(Primary,Master))\r\n"
|
|
"\r\n"
|
|
"To display all handles with 'Image' protocol and break when the screen is full:\r\n"
|
|
" Shell> dh -p Image -b\r\n"
|
|
" Handle dump by protocol 'image'\r\n"
|
|
" 1: Image(DXE Core)\r\n"
|
|
" 5: Image(WinNtThunk)\r\n"
|
|
" 7: Image(WinNtBusDriver) DriverBinding\r\n"
|
|
" 8: Image(Metronome)\r\n"
|
|
" A: Image(IsaBus) DriverBinding\r\n"
|
|
" B: Image(WinNtConsole) DriverBinding\r\n"
|
|
"...\r\n"
|
|
"\r\n"
|
|
|
|
#string STR_GET_HELP_DEVTREE #language en-US ""
|
|
".TH devtree 0 "display device tree"\r\n"
|
|
".SH NAME\r\n"
|
|
"Displays the EFI Driver Model compliant device tree.\r\n"
|
|
".SH SYNOPSIS\r\n"
|
|
"devtree [-b] [-d] [-l XXX] [DeviceHandle] \r\n"
|
|
".SH OPTIONS\r\n"
|
|
"DeviceHandle Display device tree below a certain handle\r\n"
|
|
"-b Display one screen at a time\r\n"
|
|
"-d Display device tree using device paths\r\n"
|
|
"-l Display device tree using the specified language\r\n"
|
|
".SH DESCRIPTION\r\n"
|
|
"This command prints a tree of devices that are being managed by drivers that follow the UEFI Driver Model. By default, the devices are printed in device names that are retrieved from the Component Name Protocol. If the option -d is specified, the device paths will be printed instead.\r\n"
|
|
".SH EXAMPLES\r\n"\r\n"
|
|
" To display the tree of all devices compliant with the UEFI Driver Model:\r\n"
|
|
" Shell> devtree\r\n"
|
|
"\r\n"
|
|
" To display the tree of all devices below device 28 compliant with the UEFI Driver Model:\r\n"
|
|
" Shell> devtree 28\r\n"
|
|
"\r\n"
|
|
" To display the tree of all devices compliant with the UEFI Driver Model one screen at a time:\r\n"
|
|
" Shell> devtree -b\r\n"
|
|
"\r\n"
|
|
|
|
#string STR_GET_HELP_DEVICES #language en-US ""
|
|
".TH devices 0 "display a list of devices"\r\n"
|
|
".SH NAME\r\n"
|
|
"Displays the list of devices managed by UEFI drivers. \r\n"
|
|
".SH SYNOPSIS\r\n"
|
|
" \r\n"
|
|
"DEVICES [-b] [-l XXX] [-sfo] \r\n"
|
|
".SH OPTIONS\r\n"
|
|
" \r\n"
|
|
" -b - Display one screen at a time\r\n"
|
|
" -l XXX - Display devices using the specified ISO 639-2 language\r\n"
|
|
" -sfo - Displays information as described in Standard-Format Output.\r\n"
|
|
".SH DESCRIPTION\r\n"
|
|
" \r\n"
|
|
"NOTES:\r\n"
|
|
" 1. The command prints a list of devices that are being managed by drivers\r\n"
|
|
" that follow the UEFI Driver Model.\r\n"
|
|
" 2. Display Format:\r\n"
|
|
" CTRL - The handle number of the UEFI device\r\n"
|
|
" TYPE - The device type:\r\n"
|
|
" [R] - Root Controller\r\n"
|
|
" [B] - Bus Controller\r\n"
|
|
" [D] - Device Controller\r\n"
|
|
" CFG - A managing driver supports the Driver Configuration\r\n"
|
|
" Protocol\r\n"
|
|
" DIAG - A managing driver supports the Driver Diagnostics Protocol\r\n"
|
|
" #P - The number of parent controllers for this device\r\n"
|
|
" #D - The number of drivers managing the device\r\n"
|
|
" #C - The number of child controllers produced by this device\r\n"
|
|
" DEVICE NAME - The name of the device from the Component Name Protocol\r\n"
|
|
".SH EXAMPLES\r\n"
|
|
" \r\n"
|
|
"EXAMPLES:\r\n"
|
|
" * To display all devices compliant with the UEFI Driver Model:\r\n"
|
|
" Shell> devices\r\n"
|
|
" \r\n"
|
|
|
|
#string STR_GET_HELP_CONNECT #language en-US ""
|
|
".TH connect 0 "connect a driver"\r\n"
|
|
".SH NAME\r\n"
|
|
"Binds a driver to a specific device and starts the driver. \r\n"
|
|
".SH SYNOPSIS\r\n"
|
|
"connect [[DeviceHandle] [DriverHandle] | [-c] | [-r]] \r\n"
|
|
".SH OPTIONS\r\n"
|
|
"-r Recursively scan all handles and check to see if any loaded or embedded driver can match the specified device. If so, the driver will be bound to the device. Additionally, if more device handles are created during the binding, these handles will also be checked to see if a matching driver can bind to these devices as well. The process is repeated until no more drivers are able to connect to any devices. However, without the option, the newly created device handles will not be further bound to any drivers.\r\n"
|
|
"-c Connect console devices found in the EFI global variables (see UEFI specification, chapter 3)\r\n"
|
|
"DeviceHandle Device handle (a hexadecimal number). If not specified, then all device handles will be connected.\r\n"
|
|
"DriverHandle Driver handle (a hexadecimal number). If not specified, then all matching drivers will be bound to the specified device. If specified, then this driver will have the highest priority.\r\n"
|
|
".SH DESCRIPTION\r\n"
|
|
"This command binds a driver to a specific device and starts the driver. If the -r flag is used, then the connection is done recursively until no further connections between devices and drivers are made. If the -c flag is used, then the connect command will bind the proper drivers to the console devices that are described in the EFI environment variables. The example below shows the typical output from the verbose help for this command.\r\n"
|
|
"If only a single handle is specified and the handle has an EFI_DRIVER_BINDING_PROTOCOL on it, then the handle is assumed to be a driver handle. Otherwise, it is assumed to be a device handle.\r\n"
|
|
"If no parameters are specified, then the command will attempt to bind all proper drivers to all devices without recursion. Each connection status will be displayed.\r\n"
|
|
".SH RETURNVALUES\r\n"
|
|
"SHELL_SUCCESS The action was completed as requested.\r\n"
|
|
"SHELL_SECURITY_VIOLATION This function was not performed due to a security violation\r\n"
|
|
"SHELL_INVALID_PARAMETER One of the passed in parameters was incorrectly formatted or its value was out of bounds.\r\n"
|
|
".SH EXAMPLES\r\n"
|
|
" To connect all drivers to all devices recursively:\r\n"
|
|
" Shell> connect -r\r\n"
|
|
"\r\n"
|
|
" To display all connections:\r\n"
|
|
" Shell> connect\r\n"
|
|
" ConnectController(1) : Status = Success\r\n"
|
|
" ConnectController(2) : Status = Success\r\n"
|
|
" ConnectController(3) : Status = Success\r\n"
|
|
" ...\r\n"
|
|
" ConnectController(3D) : Status = Success\r\n"
|
|
"\r\n"
|
|
" To connect drivers with 0x17 as highest priority to all the devices they can manage:\r\n"
|
|
" Shell> connect 17\r\n"
|
|
"\r\n"
|
|
" To connect all possible drivers to device 0x19:\r\n"
|
|
" Shell> connect 19\r\n"
|
|
"\r\n"
|
|
" To connect drivers with 0x17 as highest priority to device 0x19 they can manage:\r\n"
|
|
" Shell> connect 19 17\r\n"
|
|
"\r\n"
|
|
" To connect console devices described in the UEFI Shell environment variables:\r\n"
|
|
" Shell> connect -c\r\n"
|
|
""\r\n"
|
|
|
|
#string STR_GET_HELP_OPENINFO #language en-US ""
|
|
".TH openinfo 0 "display info about a handle."\r\n"
|
|
".SH NAME\r\n"
|
|
"Displays the protocols and agents associated with a handle. \r\n"
|
|
".SH SYNOPSIS\r\n"
|
|
"openinfo Handle [-b] \r\n"
|
|
".SH OPTIONS\r\n"
|
|
"Handle Display open protocol information for specified handle\r\n"
|
|
"-b Display one screen at a time\r\n"
|
|
".SH DESCRIPTION\r\n"
|
|
"This command is used to display the open protocols on a given handle. The example below is typical output from help for this command.\r\n"
|
|
".SH EXAMPLES\r\n"
|
|
"To show open protocols on handle 0x23:\r\n"
|
|
" Shell> openinfo 23\r\n"
|
|
" Handle 23 (07DEE108)\r\n"
|
|
" PciRootBridgeIo\r\n"
|
|
" Drv[1D] Ctrl[23] Cnt(01) Driver Image(PciBus)\r\n"
|
|
" Drv[1D] Ctrl[28] Cnt(01) Child Image(PciBus)\r\n"
|
|
" Drv[1D] Ctrl[29] Cnt(01) Child Image(PciBus)\r\n"
|
|
" Drv[1D] Ctrl[2A] Cnt(01) Child Image(PciBus)\r\n"
|
|
" Drv[1D] Ctrl[2B] Cnt(01) Child Image(PciBus)\r\n"
|
|
" Drv[1D] Ctrl[2C] Cnt(01) Child Image(PciBus)\r\n"
|
|
" Drv[1D] Ctrl[2D] Cnt(01) Child Image(PciBus)\r\n"
|
|
" Drv[1D] Ctrl[2E] Cnt(01) Child Image(PciBus)\r\n"
|
|
" Drv[00] Ctrl[ ] Cnt(01) HandProt\r\n"
|
|
" dpath\r\n"
|
|
" Drv[1D] Ctrl[23] Cnt(01) Driver Image(PciBus)\r\n"
|
|
" Drv[00] Ctrl[ ] Cnt(0D) HandProt\r\n"
|
|
"\r\n"
|
|
|
|
#string STR_GET_HELP_DRVDIAG #language en-US ""
|
|
".TH drvdiag 0 "diagnose a driver"\r\n"
|
|
".SH NAME\r\n"
|
|
"Invokes the Driver Diagnostics Protocol. \r\n"
|
|
".SH SYNOPSIS\r\n"
|
|
"drvdiag [-c] [-l XXX] [-s|-e|-m] [DriverHandle [DeviceHandle [ChildHandle]]] \r\n"
|
|
".SH OPTIONS\r\n"
|
|
"DriverHandle The handle of the driver to diagnose\r\n"
|
|
"DeviceHandle The handle of a device that DriverHandle is managing\r\n"
|
|
"ChildHandle The handle of a device that is a child of DeviceHandle\r\n"
|
|
"-c Diagnose all child devices\r\n"
|
|
"-l Diagnose using the ISO 639-2 language specified by XXX\r\n"
|
|
"-s Run diagnostics in standard mode\r\n"
|
|
"-e Run diagnostics in extended mode\r\n"
|
|
"-m Run diagnostics in manufacturing mode\r\n"
|
|
".SH DESCRIPTION\r\n"
|
|
"This command invokes the Driver Diagnostics Protocol.\r\n"
|
|
".SH RETURNVALUES\r\n"
|
|
"SHELL_SUCCESS The action was completed as requested.\r\n"
|
|
"SHELL_SECURITY_VIOLATION This function was not performed due to a security violation\r\n"
|
|
"SHELL_INVALID_PARAMETER One of the passed in parameters was incorrectly formatted or its value was out of bounds.\r\n"
|
|
".SH EXAMPLES\r\n"
|
|
"To display the list of devices that are available for diagnostics:\r\n"
|
|
" Shell> drvdiag\r\n"
|
|
"\r\n"
|
|
"To display the list of devices and child devices that are available for diagnostics:\r\n"
|
|
" Shell> drvdiag -c\r\n"
|
|
"\r\n"
|
|
"To run diagnostics in standard mode on all devices:\r\n"
|
|
" Shell> drvdiag -s\r\n"
|
|
"\r\n"
|
|
"To run diagnostics in standard mode on all devices in English:\r\n"
|
|
" Shell> drvdiag -s -l eng\r\n"
|
|
"\r\n"
|
|
"To run diagnostics in standard mode on all devices in Spanish:\r\n"
|
|
" Shell> drvdiag -s -l spa\r\n"
|
|
"\r\n"
|
|
"To run diagnostics in standard mode on all devices and child devices:\r\n"
|
|
" Shell> drvdiag -s -c\r\n"
|
|
"\r\n"
|
|
"To run diagnostics in extended mode on all devices:\r\n"
|
|
" Shell> drvdiag -e\r\n"
|
|
"\r\n"
|
|
"To run diagnostics in manufacturing mode on all devices:\r\n"
|
|
" Shell> drvdiag -m\r\n"
|
|
"\r\n"
|
|
"To run diagnostics in standard mode on all devices managed by driver 0x17:\r\n"
|
|
" Shell> drvdiag -s 17\r\n"
|
|
"\r\n"
|
|
"To run diagnostics in standard mode on device 0x28 managed by driver 0x17:\r\n"
|
|
" Shell> drvdiag -s 17 28\r\n"
|
|
"\r\n"
|
|
"To run diagnostics in standard mode on all child devices of device 0x28 managed by driver 0x17:\r\n"
|
|
" Shell> drvdiag -s 17 28 -c\r\n"
|
|
"\r\n"
|
|
"To run diagnostics in standard mode on child device 0x30 of device 0x28 managed by driver 0x17:\r\n"
|
|
" Shell> drvdiag -s 17 28 30\r\n"
|
|
"\r\n"
|
|
|
|
#string STR_GET_HELP_RECONNECT #language en-US ""
|
|
".TH reconnect 0 "reconnect drivers"\r\n"
|
|
".SH NAME\r\n"
|
|
"Reconnects drivers to the specific device. \r\n"
|
|
".SH SYNOPSIS\r\n"
|
|
"reconnect DeviceHandle [DriverHandle [ChildHandle]]\r\n"
|
|
"reconnect -r \r\n"
|
|
".SH OPTIONS\r\n"
|
|
"DeviceHandle Device handle (a hexadecimal number)\r\n"
|
|
"DriverHandle Driver handle (a hexadecimal number). If not specified, all drivers on the specified device will be reconnected. \r\n"
|
|
"ChildHandle Child handle of device (a hexadecimal number). If not specified, then all child handles of the specified device will be reconnected.\r\n"
|
|
"-r Reconnect drivers to all devices.\r\n"
|
|
".SH DESCRIPTION\r\n"
|
|
"This command reconnects drivers to the specific device. It will first disconnect the specified driver from the specified device and then connect the driver to the device recursively.\r\n"
|
|
"If the -r option is used, then all drivers will be reconnected to all devices. Any drivers that are bound to any devices will be disconnected first and then connected recursively. See the connect and disconnect commands for more details. \r\n"
|
|
".SH RETURNVALUES\r\n"
|
|
"SHELL_SUCCESS The action was completed as requested.\r\n"
|
|
"SHELL_SECURITY_VIOLATION This function was not performed due to a security violation\r\n"
|
|
"SHELL_INVALID_PARAMETER One of the passed in parameters was incorrectly formatted or its value was out of bounds.\r\n"
|
|
".SH EXAMPLES\r\n"
|
|
"To reconnect all drivers to all devices:\r\n"
|
|
" Shell> reconnect -r\r\n"
|
|
"\r\n"
|
|
"To reconnect all drivers to device 0x28:\r\n"
|
|
" fs0:\> reconnect 28\r\n"
|
|
"\r\n"
|
|
"To disconnect 0x17 from 0x28 then reconnect drivers with 0x17 as highest priority to device 0x28:\r\n"
|
|
" fs0:\> reconnect 28 17\r\n"
|
|
"\r\n"
|
|
"To disconnect 0x17 from 0x28 destroying child 0x32 then reconnect drivers with 0x17 as highest priority to device 0x28\r\n"
|
|
" fs0:\> reconnect 28 17 32\r\n"
|
|
"\r\n"
|
|
|
|
#string STR_GET_HELP_UNLOAD #language en-US ""
|
|
".TH unload 0 "unload a driver"\r\n"
|
|
".SH NAME\r\n"
|
|
"Unloads a driver image that was already loaded. \r\n"
|
|
".SH SYNOPSIS\r\n"
|
|
"unload [-n] [-v|-verbose] Handle \r\n"
|
|
".SH OPTIONS\r\n"
|
|
"-n Skips all prompts during unloading, so that it can be used in a script file.\r\n"
|
|
"-v, -verbose Dump verbose status information before the image is unloaded.\r\n"
|
|
"Handle Handle of driver to unload, always taken as hexadecimal number\r\n"
|
|
".SH DESCRIPTION\r\n"
|
|
"This command unloads a driver image that was already loaded and which supports the unloading option (see EFI_LOADED_IMAGE_PROTOCOL's Unload() member.)\r\n"
|
|
".SH RETURNVALUES\r\n"
|
|
"SHELL_SUCCESS The action was completed as requested.\r\n"
|
|
"SHELL_SECURITY_VIOLATION This function was not performed due to a security violation\r\n"
|
|
"SHELL_INVALID_PARAMETER One of the passed in parameters was incorrectly formatted or its value was out of bounds.\r\n"
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|