1// /** 2// 3// (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR> 4// (C) Copyright 2012-2015 Hewlett-Packard Development Company, L.P.<BR> 5// Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.<BR> 6// This program and the accompanying materials 7// are licensed and made available under the terms and conditions of the BSD License 8// which accompanies this distribution. The full text of the license may be found at 9// http://opensource.org/licenses/bsd-license.php. 10// 11// THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, 12// WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. 13// 14// Module Name: 15// 16// UefiShellDriver1CommandsLib.uni 17// 18// Abstract: 19// 20// String definitions for UEFI Shell 2.0 driver1 profile commands 21// 22// 23// **/ 24 25/=# 26 27#langdef en-US "english" 28 29#string STR_GEN_PROBLEM #language en-US "%H%s%N: Unknown flag - '%H%s%N'\r\n" 30#string STR_GEN_PROBLEM_VAL #language en-US "%H%s%N: Bad value - '%H%s%N' for flag - '%H%s%N'\r\n" 31#string STR_GEN_PARAM_INV #language en-US "%H%s%N: Invalid argument - '%H%s%N'\r\n" 32#string STR_GEN_TOO_FEW #language en-US "%H%s%N: Too few arguments\r\n" 33#string STR_GEN_TOO_MANY #language en-US "%H%s%N: Too many arguments\r\n" 34#string STR_GEN_INV_HANDLE #language en-US "%H%s%N: Handle - '%H%s%N' not found\r\n" 35#string STR_GEN_PARAM_CONFLICT #language en-US "%H%s%N: Flags conflict with - '%H%s%N' and '%H%s%N'\r\n" 36#string STR_GEN_NO_VALUE #language en-US "%H%s%N: Missing argument for flag - '%H%s%N'\r\n" 37#string STR_GEN_HANDLE_NOT #language en-US "%H%s%N: Handle [%H%02x%N] is not a valid %s\r\n" 38#string STR_GEN_HANDLE_REQ #language en-US "%H%s%N: Handle required with the specified options\r\n" 39#string STR_GEN_PROTOCOL_NF #language en-US "%H%s%N: The protocol '%H%s%N' is required and not found (%g)\r\n" 40#string STR_GEN_FIND_FAIL #language en-US "%H%s%N: File not found - '%H%s%N'\r\n" 41#string STR_GEN_FILE_EXIST #language en-US "%H%s%N: File already exists - '%H%s%N'\r\n" 42#string STR_GEN_FILE_OPEN_FAIL #language en-US "%H%s%N: Cannot open file - '%H%s%N'\r\n" 43#string STR_FILE_WRITE_FAIL #language en-US "%H%s%N: Write file error - '%H%s%N'\r\n" 44#string STR_FILE_READ_FAIL #language en-US "%H%s%N: Read file error - '%H%s%N'\r\n" 45#string STR_GEN_OUT_MEM #language en-US "%H%s%N: Memory allocation was not successful\r\n" 46#string STR_GEN_UEFI_FUNC_ERROR #language en-US "%H%s%N: UEFI function '%H%s%N' returned an incorrect value for: %s (%x)\r\n" 47#string STR_GEN_UEFI_FUNC_WARN #language en-US "%H%s%N: UEFI function '%H%s%N' returned: %r\r\n" 48#string STR_GEN_SFO_HEADER #language en-US "ShellCommand,"%s"\r\n" 49 50#string STR_DRVDIAG_HEADER #language en-US "%EAvailable Diagnostics%N.\r\n" 51#string STR_DRVDIAG_DRIVER_HEADER #language en-US "Driver [%H%02x%N]: " 52#string STR_DRVDIAG_DRIVER_NO_HANDLES #language en-US "No controller handles found.\r\n" 53 54#string STR_HANDLE_RESULT #language en-US "%H%s%N - Handle [%H%02x%N] Result %r.\r\n" 55#string STR_3P_RESULT #language en-US "%H%s%N - (%H%02x%N,%H%02x%N,%H%02x%N) Result %r.\r\n" 56#string STR_CONNECT_NONE #language en-US "%HConnect%N No drivers could be connected.\r\n" 57 58#string STR_DRVCFG_NONE_FOUND #language en-US "%HDrvCfg%N No configurable devices were found.\r\n" 59#string STR_DRVCFG_COMP #language en-US "%HDrvCfg%N - operation complete.\r\n" 60#string STR_DRVCFG_DONE_HII #language en-US "Handle[%H%02x%N] successfully updated from file.\r\n" 61#string STR_DRVCFG_LINE_HII #language en-US "Handle[%H%02x%N] HII Config Access\r\n" 62#string STR_DRVCFG_ALL_LANG #language en-US "Driver[%H%02x%N] Ctrl[--] Lang[%H%a%N] Driver Configuration" 63#string STR_DRVCFG_CTRL_LANG #language en-US "Driver[%H%02x%N] Ctrl[%H%02x%N] Lang[%H%a%N] Driver Configuration" 64#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" 65#string STR_DRVCFG_RESTART_S #language en-US "Restart %s\r\n" 66#string STR_DRVCFG_STOP #language en-US "Stop Controller\n" 67#string STR_DRVCFG_ENTER_S #language en-US "\nPress [ENTER] to %s" 68#string STR_DRVCFG_NONE #language en-US "None\n" 69#string STR_DRVCFG_CTLR_S #language en-US "Controller %s\n" 70#string STR_DRVCFG_FORCE_D #language en-US "Force Default Configuration to DefaultType %08x\n" 71#string STR_DRVCFG_VALIDATE #language en-US "Validate Configuration Options\n" 72#string STR_DRVCFG_SET #language en-US "Set Configuration Options\n" 73#string STR_DRVCFG_NOT_SUPPORT #language en-US "Handle [%H%02x%N] does not support configuration.\n" 74#string STR_DRVCFG_OPTIONS_SET #language en-US " - Options set. Action Required is " 75#string STR_DRVCFG_NOT_SET #language en-US " - Options not set. Status = %r\n" 76#string STR_DRVCFG_DEF_FORCED #language en-US " - Defaults forced. Action Required is " 77#string STR_DRVCFG_FORCE_FAILED #language en-US " - Force of defaults failed. Status = %r\n" 78#string STR_DRVCFG_OPTIONS_VALID #language en-US " - Options valid\n" 79#string STR_DRVCFG_OPTIONS_INV #language en-US " - Options not valid. Status = %r\n" 80#string STR_DRVCFG_IN_FILE_NF #language en-US "DevicePath '%B%s%N' from file not found in HII DB. Skipped.\r\n" 81 82 83#string STR_DEVICES_HEADER_LINES #language en-US "%N" 84" T D\r\n" 85" Y C I\r\n" 86" P F A\r\n" 87"CTRL E G G #P #D #C Device Name\r\n" 88"==== = = = == == === =========================================================\r\n" 89#string STR_DEVICES_ITEM_LINE #language en-US "%H%4x%N %1c %1c %1c %2d %2d %3d %s\r\n" 90#string STR_DEVICES_ITEM_LINE_SFO #language en-US "DevicesInfo,"%x","%c","%c","%c","%d","%d","%d","%s"\r\n" 91 92#string STR_DRIVERS_HEADER_LINES #language en-US "%N" 93" T D\r\n" 94" Y C I\r\n" 95" P F A\r\n" 96"DRV VERSION E G G #D #C DRIVER NAME IMAGE PATH\r\n" 97"=== ======== = = = === === =================================== ==========\r\n" 98#string STR_DRIVERS_ITEM_LINE #language en-US "%H%3x%N %08x %1c %1c %1c %3d %3d %-35s %s\r\n" 99#string STR_DRIVERS_ITEM_LINE_SFO #language en-US "DriversInfo,"%x","%x","%c","%c","%c","%d","%d","%s","%s"\r\n" 100 101#string STR_DH_NO_GUID_FOUND #language en-US "Protocol ID '%s' could not be identified.\r\n" 102#string STR_DH_SFO_OUTPUT #language en-US "%s, %s, %H%02x%N, %s, &s\r\n" 103#string STR_DH_OUTPUT #language en-US "%H%02x%N: %s\r\n" 104#string STR_DH_OUTPUT_SINGLE #language en-US "%H%02x%N: %x\r\n%s" 105#string STR_DH_OUTPUT_SFO #language en-US "%s, %s, %s, %H%02x%N, %s, %s\r\n" 106#string STR_DH_OUTPUT_DRIVER1 #language en-US " Controller Name : %B%s%N\r\n" 107#string STR_DH_OUTPUT_DRIVER2 #language en-US " Device Path : %B%s%N\r\n" 108 " Controller Type : %B%s%N\r\n" 109 " Configuration : %B%s%N\r\n" 110 " Diagnostics : %B%s%N\r\n" 111#string STR_DH_OUTPUT_DRIVER3 #language en-US " Managed by : %B%s%N\r\n" 112#string STR_DH_OUTPUT_DRIVER4A #language en-US " Drv[%H%02x%N] : Image(%B%s%N)r\n" 113#string STR_DH_OUTPUT_DRIVER4B #language en-US " Drv[%H%02x%N] : %B%s%N\r\n" 114#string STR_DH_OUTPUT_DRIVER5 #language en-US " Parent Controllers : %B%s%N\r\n" 115#string STR_DH_OUTPUT_DRIVER5B #language en-US " Parent[%H%02x%N] : %B%s%N\r\n" 116#string STR_DH_OUTPUT_DRIVER6 #language en-US " Child Controllers : %B%s%N\r\n" 117#string STR_DH_OUTPUT_DRIVER6B #language en-US " Child[%H%02x%N] : %B%s%N\r\n" 118#string STR_DH_OUTPUT_DRIVER7 #language en-US " Driver Name : %B%s%N\r\n" 119#string STR_DH_OUTPUT_DRIVER7B #language en-US " Driver Image Name : %B%s%N\r\n" 120#string STR_DH_OUTPUT_DRIVER8 #language en-US " Driver Version : %B%08x%N\r\n" 121 " Driver Type : %B%s%N\r\n" 122 " Configuration : %B%s%N\r\n" 123 " Diagnostics : %B%s%N\r\n" 124#string STR_DH_OUTPUT_DRIVER9 #language en-US " Managing : %B%s%N\r\n" 125#string STR_DH_OUTPUT_DRIVER9B #language en-US " Ctrl[%H%02x%N] : %B%s%N\r\n" 126 127#string STR_DEV_TREE_OUTPUT #language en-US "Ctrl[%H%02x%N] %s\r\n" 128 129#string STR_UNLOAD_CONF #language en-US "%HUnload%N - Handle [%H%02x%N]. [y/n]?\r\n" 130#string STR_UNLOAD_VERBOSE #language en-US "" 131"Handle [%H%02x%N] (%08x)\r\n" 132" Image (%08x)\r\n" 133" ParentHandle..: %08x\r\n" 134" SystemTable...: %08x\r\n" 135" DeviceHandle..: %08x\r\n" 136" FilePath......: %s\r\n" 137" PDBFileName...: %a\r\n" 138" ImageBase.....: %08x\r\n" 139" ImageSize.....: %Ld\r\n" 140" CodeType......: %s\r\n" 141" DataType......: %s\r\n" 142 143#string STR_OPENINFO_HEADER_LINE #language en-US "Handle %H%02x%N (%H%0p%N)\r\n" 144#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" 145#string STR_OPENINFO_MIN_LINE #language en-US " Drv[%H%02x%N] Ctrl[ ] Cnt(%H%02x%N) %H%s Image%N(%s)\r\n" 146 147#string STR_DRV_DIAG_ITEM_LINE #language en-US " Drv[%H%02x%N] Ctrl[%H%02x%N] Child[%H%02x%N]\r\n" 148 149#string STR_GET_HELP_DRVCFG #language en-US "" 150".TH drvcfg 0 "configure a UEFI driver."\r\n" 151".SH NAME\r\n" 152"Invokes the driver configuration.\r\n" 153".SH SYNOPSIS\r\n" 154" \r\n" 155"DRVCFG [-l XXX] [-c] [-f <Type>|-v|-s] \r\n" 156" [DriverHandle [DeviceHandle [ChildHandle]]] [-i filename] [-o filename]\r\n" 157".SH OPTIONS\r\n" 158" \r\n" 159" -c - Configures all child devices.\r\n" 160" -l - Configures using the ISO 3066 language specified by XXX.\r\n" 161" -f - Forces defaults.\r\n" 162" -v - Validates options.\r\n" 163" -s - Sets options.\r\n" 164" -i - Receives configuration updates from an input file.\r\n" 165" -o - Exports the settings of the specified driver instance to a\r\n" 166" file.\r\n" 167" Type - Specifies the type of default configuration options to force on the\r\n" 168" controller.\r\n" 169" 0 - Standard Defaults.\r\n" 170" 1 - Manufacturing Defaults.\r\n" 171" 2 - Safe Defaults.\r\n" 172" 4000-FFFF - Custom Defaults.\r\n" 173" DriverHandle - Specifies the the handle of the driver to configure.\r\n" 174" DeviceHandle - Specifies the handle of a device that the DriverHandle is managing.\r\n" 175" ChildHandle - Specifies the handle of a device that is a child of the DeviceHandle. \r\n" 176".SH DESCRIPTION\r\n" 177" \r\n" 178"NOTES:\r\n" 179" 1. Default Type:\r\n" 180" 0 - Safe Defaults. Places a controller in a safe configuration with\r\n" 181" the greatest probability of functioning correctly in a platform.\r\n" 182" 1 - Manufacturing Defaults. Optional type that places the controller in\r\n" 183" a configuration suitable for a manufacturing and test environment.\r\n" 184" 2 - Custom Defaults. Optional type that places the controller in a\r\n" 185" custom configuration.\r\n" 186" 3 - Performance Defaults. Optional type that places the controller in a\r\n" 187" configuration that maximizes the controller's performance in a \r\n" 188" platform. \r\n" 189" Other Value - Depends on the driver's implementation.\r\n" 190".SH EXAMPLES\r\n" 191" \r\n" 192"EXAMPLES:\r\n" 193" * To display the list of devices that are available for configuration:\r\n" 194" Shell> drvcfg\r\n" 195" \r\n" 196" * To display the list of devices and child devices that are available for\r\n" 197" configuration:\r\n" 198" Shell> drvcfg -c\r\n" 199" \r\n" 200" * To force defaults on all devices:\r\n" 201" Shell> drvcfg -f 0\r\n" 202" \r\n" 203" * To force defaults on all devices that are managed by driver 0x17:\r\n" 204" Shell> drvcfg -f 0 17\r\n" 205" \r\n" 206" * To force defaults on device 0x28 that is managed by driver 0x17:\r\n" 207" Shell> drvcfg -f 0 17 28\r\n" 208" \r\n" 209" * To force defaults on all child devices of device 0x28 that is managed by\r\n" 210" driver 0x17:\r\n" 211" Shell> drvcfg -f 0 17 28 -c\r\n" 212" \r\n" 213" * To force defaults on child device 0x30 of device 0x28 that is managed by\r\n" 214" driver 0x17:\r\n" 215" Shell> drvcfg -f 0 17 28 30\r\n" 216" \r\n" 217" * To validate options on all devices:\r\n" 218" Shell> drvcfg -v\r\n" 219" \r\n" 220" * To validate options on all devices that are managed by driver 0x17:\r\n" 221" Shell> drvcfg -v 17\r\n" 222" \r\n" 223" * To validate options on device 0x28 that is managed by driver 0x17:\r\n" 224" Shell> drvcfg -v 17 28\r\n" 225" \r\n" 226" * To validate options on all child devices of device 0x28 that is managed by\r\n" 227" driver 0x17:\r\n" 228" Shell> drvcfg -v 17 28 -c\r\n" 229" \r\n" 230" * To validate options on child device 0x30 of device 0x28 that is managed by\r\n" 231" driver 0x17:\r\n" 232" Shell> drvcfg -v 17 28 30\r\n" 233" \r\n" 234" * To set options on device 0x28 that is managed by driver 0x17: \r\n" 235" Shell> drvcfg -s 17 28\r\n" 236" \r\n" 237" * To set options on child device 0x30 of device 0x28 that is managed by\r\n" 238" driver 0x17:\r\n" 239" Shell> drvcfg -s 17 28 30\r\n" 240" \r\n" 241" * To set options on device 0x28 that is managed by driver 0x17 in English:\r\n" 242" Shell> drvcfg -s 17 28 -l eng\r\n" 243" \r\n" 244" * To set options on device 0x28 that is managed by driver 0x17 in Spanish:\r\n" 245" Shell> drvcfg -s 17 28 -l spa\r\n" 246".SH RETURNVALUES\r\n" 247" \r\n" 248"RETURN VALUES:\r\n" 249" SHELL_SUCCESS The action was completed as requested.\r\n" 250" SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n" 251" violation.\r\n" 252" SHELL_UNSUPPORTED The action as requested was unsupported.\r\n" 253" SHELL_INVALID_PARAMETER One of the passed in parameters was incorrectly\r\n" 254" formatted or its value was out of bounds.\r\n" 255 256#string STR_GET_HELP_DRIVERS #language en-US "" 257".TH drivers 0 "display a list of drivers"\r\n" 258".SH NAME\r\n" 259"Displays the UEFI driver list.\r\n" 260".SH SYNOPSIS\r\n" 261" \r\n" 262"DRIVERS [-l XXX] [-sfo] \r\n" 263".SH OPTIONS\r\n" 264" \r\n" 265" -l - Displays drivers using the specified language (e.g. ISO 639-2) \r\n" 266" -sfo - Displays information as described in Standard-Format Output.\r\n" 267".SH DESCRIPTION\r\n" 268" \r\n" 269"NOTES:\r\n" 270" 1. This command displays a list of information for drivers that follow the\r\n" 271" UEFI Driver Model in the UEFI environment. The list includes:\r\n" 272" DRV - The handle number of the UEFI driver.\r\n" 273" VERSION - The version number of the UEFI driver.\r\n" 274" TYPE - The driver type:\r\n" 275" [B] - Bus Driver\r\n" 276" [D] - Device Driver\r\n" 277" CFG - Driver supports the Driver Configuration Protocol.\r\n" 278" DIAG - Driver supports the Driver Diagnostics Protocol.\r\n" 279" #D - The number of devices that this driver is managing.\r\n" 280" #C - The number of child devices that this driver has produced.\r\n" 281" DRIVER NAME - The name of the driver from the Component Name Protocol.\r\n" 282" IMAGE PATH - The file path from which the driver was loaded.\r\n" 283".SH EXAMPLES\r\n" 284" \r\n" 285"EXAMPLES:\r\n" 286" * To display the list:\r\n" 287" Shell> drivers\r\n" 288".SH RETURNVALUES\r\n" 289" \r\n" 290"RETURN VALUES:\r\n" 291" SHELL_SUCCESS The action was completed as requested.\r\n" 292" SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n" 293" violation.\r\n" 294" SHELL_INVALID_PARAMETER One of the passed in parameters was incorrectly\r\n" 295" formatted or its value was out of bounds.\r\n" 296 297#string STR_GET_HELP_DISCONNECT #language en-US "" 298".TH disconnect 0 "disconnect a driver"\r\n" 299".SH NAME\r\n" 300"Disconnects one or more drivers from the specified devices. \r\n" 301".SH SYNOPSIS\r\n" 302" \r\n" 303"DISCONNECT DeviceHandle [DriverHandle [ChildHandle]] \r\n" 304"DISCONNECT [-r] [-nc] \r\n" 305".SH OPTIONS\r\n" 306" \r\n" 307"NOTES:\r\n" 308" -r - Disconnects all drivers from all devices, then reconnect\r\n" 309" consoles.\r\n" 310" -nc - Do not reconnect the console devices.\r\n" 311" DeviceHandle - Specifies a device handle (a hexadecimal number). If not\r\n" 312" specified, then disconnect DriverHandle.\r\n" 313" DriverHandle - Specifies a driver handle (a hexadecimal number).\r\n" 314" ChildHandle - Specifies a child handle of a device (a hexadecimal number).\r\n" 315" If not specified, then all child handles of DeviceHandle are\r\n" 316" disconnected.\r\n" 317".SH DESCRIPTION\r\n" 318" \r\n" 319"NOTES:\r\n" 320" 1. If the 'DriverHandle' parameter is not specified, the default is to\r\n" 321" disconnect 'DeviceHandle'.\r\n" 322" 2. If the 'ChildHandle' parameter is not specified, the default is to\r\n" 323" disconnect all child handles of the 'DeviceHandle'.\r\n" 324" 3. If the '-r' option is specified, all consoles and drivers will be\r\n" 325" disconnected from all devices in the system, then consoles are\r\n" 326" reconnected. If the '-nc' option is also spcified, then console devices\r\n" 327" are not reconnected.\r\n" 328" 4. This command does not support output redirection.\r\n" 329".SH EXAMPLES\r\n" 330" \r\n" 331"EXAMPLES:\r\n" 332" * To disconnect all drivers from all devices, then reconnect console\r\n" 333" devices:\r\n" 334" Shell> disconnect -r\r\n" 335" \r\n" 336" * To disconnect all drivers from all devices, including console devices:\r\n" 337" Shell> disconnect -r -nc\r\n" 338" \r\n" 339" * To disconnect all drivers from device 0x28:\r\n" 340" fs0:\> disconnect 28\r\n" 341" \r\n" 342" * To disconnect driver 0x17 from device 0x28:\r\n" 343" fs0:\> disconnect 28 17\r\n" 344" \r\n" 345" * To disconnect driver 0x17 from controlling the child 0x32 of device 0x28:\r\n" 346" fs0:\> disconnect 28 17 32\r\n" 347".SH RETURNVALUES\r\n" 348" \r\n" 349"RETURN VALUES:\r\n" 350" SHELL_SUCCESS The action was completed as requested.\r\n" 351" SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n" 352" violation.\r\n" 353" SHELL_INVALID_PARAMETER One of the passed in parameters was incorrectly\r\n" 354" formatted or its value was out of bounds.\r\n" 355 356#string STR_GET_HELP_DH #language en-US "" 357".TH dh 0 "displays list of handles"\r\n" 358".SH NAME\r\n" 359"Displays the device handles in the UEFI environment. \r\n" 360".SH SYNOPSIS\r\n" 361" \r\n" 362"DH [-l <lang>] [handle | -p <prot_id>] [-d] [-v] \r\n" 363".SH OPTIONS\r\n" 364" \r\n" 365" -p - Dumps all handles of a protocol specified by the GUID.\r\n" 366" -d - Dumps UEFI Driver Model-related information.\r\n" 367" -l - Dumps information using the language codes (e.g. ISO 639-2).\r\n" 368" -sfo - Displays information as described in Standard-Format Output.\r\n" 369" -v - Dumps verbose information about a specific handle.\r\n" 370" handle - Specifies a handle to dump information about (a hexadecimal number).\r\n" 371" If not present, then all information will be dumped.\r\n" 372".SH DESCRIPTION\r\n" 373" \r\n" 374"NOTES:\r\n" 375" 1. When neither 'handle' nor 'prot_id' is specified, a list of all the\r\n" 376" device handles in the UEFI environment is displayed. \r\n" 377" 2. The '-d' option displays UEFI Driver Model related information including\r\n" 378" parent handles, child handles, all drivers installed on the handle, etc.\r\n" 379" 3. The '-v' option displays verbose information for the specified handle\r\n" 380" including all the protocols on the handle and their details.\r\n" 381" 4. If the '-p' option is specified, all handles containing the specified\r\n" 382" protocol will be displayed. Otherwise, the 'handle' parameter has to be\r\n" 383" specified for display. In this case, the '-d' option will be enabled\r\n" 384" automatically if the '-v' option is not specified.\r\n" 385".SH EXAMPLES\r\n" 386" \r\n" 387"EXAMPLES:\r\n" 388" * To display all handles and display one screen at a time:\r\n" 389" Shell> dh -b\r\n" 390" \r\n" 391" * To display the detailed information on handle 0x30:\r\n" 392" Shell> dh 30\r\n" 393" \r\n" 394" * To display all handles with 'diskio' protocol:\r\n" 395" Shell> dh -p diskio\r\n" 396" \r\n" 397" * To display all handles with 'Image' protocol and break when the screen is\r\n" 398" full:\r\n" 399" Shell> dh -p Image -b\r\n" 400".SH RETURNVALUES\r\n" 401" \r\n" 402"RETURN VALUES:\r\n" 403" SHELL_SUCCESS The action was completed as requested.\r\n" 404" SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n" 405" violation.\r\n" 406" SHELL_INVALID_PARAMETER One of the passed in parameters was incorrectly\r\n" 407" formatted or its value was out of bounds.\r\n" 408 409#string STR_GET_HELP_DEVTREE #language en-US "" 410".TH devtree 0 "display device tree"\r\n" 411".SH NAME\r\n" 412"Displays the UEFI Driver Model compliant device tree.\r\n" 413".SH SYNOPSIS\r\n" 414" \r\n" 415"DEVTREE [-b] [-d] [-l XXX] [DeviceHandle] \r\n" 416".SH OPTIONS\r\n" 417" \r\n" 418" -b - Displays one screen at a time.\r\n" 419" -d - Displays the device tree using device paths.\r\n" 420" -l - Displays the device tree using the specified language.\r\n" 421" DeviceHandle - Displays the device tree below a certain handle.\r\n" 422".SH DESCRIPTION\r\n" 423" \r\n" 424"NOTES:\r\n" 425" 1. This command prints a tree of devices that are being managed by drivers\r\n" 426" that follow the UEFI Driver Model. By default, the devices are printed in\r\n" 427" device names that are retrieved from the Component Name Protocol.\r\n" 428" 2. If the option -d is specified, the device paths will be printed instead.\r\n" 429".SH EXAMPLES\r\n" 430" \r\n" 431"EXAMPLES:\r\n" 432" * To display the tree of all devices compliant with the UEFI Driver Model:\r\n" 433" Shell> devtree\r\n" 434" \r\n" 435" * To display the tree of all devices below device 28 compliant with the UEFI\r\n" 436" Driver Model:\r\n" 437" Shell> devtree 28\r\n" 438" \r\n" 439" * To display the tree of all devices compliant with the UEFI Driver Model\r\n" 440" one screen at a time:\r\n" 441" Shell> devtree -b\r\n" 442" \r\n" 443 444#string STR_GET_HELP_DEVICES #language en-US "" 445".TH devices 0 "display a list of devices"\r\n" 446".SH NAME\r\n" 447"Displays the list of devices managed by UEFI drivers. \r\n" 448".SH SYNOPSIS\r\n" 449" \r\n" 450"DEVICES [-b] [-l XXX] [-sfo] \r\n" 451".SH OPTIONS\r\n" 452" \r\n" 453" -b - Display one screen at a time\r\n" 454" -l XXX - Display devices using the specified ISO 639-2 language\r\n" 455" -sfo - Displays information as described in Standard-Format Output.\r\n" 456".SH DESCRIPTION\r\n" 457" \r\n" 458"NOTES:\r\n" 459" 1. The command prints a list of devices that are being managed by drivers\r\n" 460" that follow the UEFI Driver Model.\r\n" 461" 2. Display Format:\r\n" 462" CTRL - The handle number of the UEFI device\r\n" 463" TYPE - The device type:\r\n" 464" [R] - Root Controller\r\n" 465" [B] - Bus Controller\r\n" 466" [D] - Device Controller\r\n" 467" CFG - A managing driver supports the Driver Configuration\r\n" 468" Protocol. Yes if 'Y' or 'X'; No if 'N' or '-'.\r\n" 469" DIAG - A managing driver supports the Driver Diagnostics\r\n" 470" Protocol. Yes if 'Y' or 'X'; No if 'N' or '-'.\r\n" 471" #P - The number of parent controllers for this device\r\n" 472" #D - The number of drivers managing the device\r\n" 473" #C - The number of child controllers produced by this device\r\n" 474" DEVICE NAME - The name of the device from the Component Name Protocol\r\n" 475".SH EXAMPLES\r\n" 476" \r\n" 477"EXAMPLES:\r\n" 478" * To display all devices compliant with the UEFI Driver Model:\r\n" 479" Shell> devices\r\n" 480" \r\n" 481 482#string STR_GET_HELP_CONNECT #language en-US "" 483".TH connect 0 "connect a driver"\r\n" 484".SH NAME\r\n" 485"Binds a driver to a specific device and starts the driver. \r\n" 486".SH SYNOPSIS\r\n" 487" \r\n" 488"CONNECT [[DeviceHandle] [DriverHandle] | [-c] | [-r]] \r\n" 489".SH OPTIONS\r\n" 490" \r\n" 491" -c - Connects console devices\r\n" 492" -r - Connects recursively\r\n" 493" DeviceHandle - Specifies a device handle in hexadecimal format.\r\n" 494" DriverHandle - Specifies a driver handle in hexadecimal format.\r\n" 495".SH DESCRIPTION\r\n" 496" \r\n" 497"NOTES:\r\n" 498" 1. If no 'DeviceHandle' parameter is specified, all device handles in the\r\n" 499" current system will be the default.\r\n" 500" 2. If no 'DriverHandle' parameter is specified, all matched drivers will be\r\n" 501" bound to the specified device.\r\n" 502" 3. If 'DriverHandle' parameter is provided, the specified driver will have\r\n" 503" highest priority on connecting the device(s).\r\n" 504" 4. If the '-c' option is specified, only console devices described in the\r\n" 505" UEFI Shell environment variables and related devices will be connected.\r\n" 506" 5. If the '-r' option is specified, the command will recursively scan all\r\n" 507" handles and check to see if any loaded or embedded driver can match the\r\n" 508" specified device. If so, the driver will be bound to the device.\r\n" 509" Additionally, if more device handles are created during the binding, \r\n" 510" these handles will also be checked to see if a matching driver can bind\r\n" 511" to these devices as well. The process is repeated until no more drivers\r\n" 512" are able to connect to any devices. However, without the option, the\r\n" 513" newly created device handles will not be further bound to any\r\n" 514" drivers.\r\n" 515" 6. If only a single handle is specified and the handle has an\r\n" 516" EFI_DRIVER_BINDING_PROTOCOL on it, then the handle is assumed to be a\r\n" 517" driver handle. Otherwise, it is assumed to be a device handle.\r\n" 518" 7. If no parameters are specified, then the command will attempt to bind\r\n" 519" all proper drivers to all devices without recursion. Each connection\r\n" 520" status will be displayed.\r\n" 521" 8. Output redirection is not supported for 'connect -r' usage.\r\n" 522".SH EXAMPLES\r\n" 523" \r\n" 524"EXAMPLES:\r\n" 525" * To connect all drivers to all devices recursively:\r\n" 526" Shell> connect -r\r\n" 527" \r\n" 528" * To display all connections:\r\n" 529" Shell> connect\r\n" 530" \r\n" 531" * To connect drivers with 0x17 as highest priority to all the devices they\r\n" 532" can manage:\r\n" 533" Shell> connect 17\r\n" 534" \r\n" 535" * To connect all possible drivers to device 0x19:\r\n" 536" Shell> connect 19\r\n" 537" \r\n" 538" * To connect drivers with 0x17 as highest priority to device 0x19 they can\r\n" 539" manage:\r\n" 540" Shell> connect 19 17\r\n" 541" \r\n" 542" * To connect console devices described in the UEFI Shell environment\r\n" 543" variables:\r\n" 544" Shell> connect -c\r\n" 545".SH RETURNVALUES\r\n" 546" \r\n" 547"RETURN VALUES:\r\n" 548" SHELL_SUCCESS The action was completed as requested.\r\n" 549" SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n" 550" violation.\r\n" 551" SHELL_INVALID_PARAMETER One of the passed in parameters was incorrectly\r\n" 552" formatted or its value was out of bounds.\r\n" 553 554#string STR_GET_HELP_OPENINFO #language en-US "" 555".TH openinfo 0 "display info about a handle."\r\n" 556".SH NAME\r\n" 557"Displays the protocols and agents associated with a handle. \r\n" 558".SH SYNOPSIS\r\n" 559" \r\n" 560"OPENINFO Handle [-b] \r\n" 561".SH OPTIONS\r\n" 562" \r\n" 563" -b - Displays one screen at a time.\r\n" 564" Handle - Displays open protocol information for the specified handle.\r\n" 565".SH DESCRIPTION\r\n" 566" \r\n" 567"NOTES:\r\n" 568" 1. This command is used to display the open protocols on a given handle.\r\n" 569".SH EXAMPLES\r\n" 570" \r\n" 571"EXAMPLES:\r\n" 572" * To show open protocols on handle 0x23:\r\n" 573" Shell> openinfo 23\r\n" 574" \r\n" 575 576#string STR_GET_HELP_DRVDIAG #language en-US "" 577".TH drvdiag 0 "diagnose a driver"\r\n" 578".SH NAME\r\n" 579"Invokes the Driver Diagnostics Protocol. \r\n" 580".SH SYNOPSIS\r\n" 581" \r\n" 582"DRVDIAG [-c] [-l XXX] [-s|-e|-m] [DriverHandle [DeviceHandle [ChildHandle]]] \r\n" 583".SH OPTIONS\r\n" 584" \r\n" 585" -c - Diagnoses all child devices.\r\n" 586" -l - Diagnoses using the ISO 639-2 language specified by XXX.\r\n" 587" -s - Runs diagnostics in standard mode.\r\n" 588" -e - Runs diagnostics in extended mode.\r\n" 589" -m - Runs diagnostics in manufacturing mode.\r\n" 590" DriverHandle - Specifies the handle of the driver to diagnose.\r\n" 591" DeviceHandle - Specifies the handle of a device that DriverHandle is managing.\r\n" 592" ChildHandle - Specifies the handle of a device that is a child of DeviceHandle.\r\n" 593".SH DESCRIPTION\r\n" 594" \r\n" 595"NOTES:\r\n" 596" 1. This command invokes the Driver Diagnostics Protocol.\r\n" 597".SH EXAMPLES\r\n" 598" \r\n" 599"EXAMPLES:\r\n" 600" * To display the list of devices that are available for diagnostics:\r\n" 601" Shell> drvdiag\r\n" 602" \r\n" 603" * To display the list of devices and child devices that are available for\r\n" 604" diagnostics:\r\n" 605" Shell> drvdiag -c\r\n" 606" \r\n" 607" * To run diagnostics in standard mode on all devices:\r\n" 608" Shell> drvdiag -s\r\n" 609" \r\n" 610" * To run diagnostics in standard mode on all devices in English:\r\n" 611" Shell> drvdiag -s -l eng\r\n" 612" \r\n" 613" * To run diagnostics in standard mode on all devices in Spanish:\r\n" 614" Shell> drvdiag -s -l spa\r\n" 615" \r\n" 616" * To run diagnostics in standard mode on all devices and child devices:\r\n" 617" Shell> drvdiag -s -c\r\n" 618" \r\n" 619" * To run diagnostics in extended mode on all devices:\r\n" 620" Shell> drvdiag -e\r\n" 621" \r\n" 622" * To run diagnostics in manufacturing mode on all devices:\r\n" 623" Shell> drvdiag -m\r\n" 624" \r\n" 625" * To run diagnostics in standard mode on all devices managed by driver 0x17:\r\n" 626" Shell> drvdiag -s 17\r\n" 627" \r\n" 628" * To run diagnostics in standard mode on device 0x28 managed by driver 0x17:\r\n" 629" Shell> drvdiag -s 17 28\r\n" 630" \r\n" 631" * To run diagnostics in standard mode on all child devices of device 0x28\r\n" 632" managed by driver 0x17:\r\n" 633" Shell> drvdiag -s 17 28 -c\r\n" 634" \r\n" 635" * To run diagnostics in standard mode on child device 0x30 of device 0x28\r\n" 636" managed by driver 0x17:\r\n" 637" Shell> drvdiag -s 17 28 30\r\n" 638".SH RETURNVALUES\r\n" 639" \r\n" 640"RETURN VALUES:\r\n" 641" SHELL_SUCCESS The action was completed as requested.\r\n" 642" SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n" 643" violation.\r\n" 644" SHELL_INVALID_PARAMETER One of the passed in parameters was incorrectly\r\n" 645" formatted or its value was out of bounds.\r\n" 646 647#string STR_GET_HELP_RECONNECT #language en-US "" 648".TH reconnect 0 "reconnect drivers"\r\n" 649".SH NAME\r\n" 650"Reconnects drivers to the specific device. \r\n" 651".SH SYNOPSIS\r\n" 652" \r\n" 653"RECONNECT DeviceHandle [DriverHandle [ChildHandle]]\r\n" 654"RECONNECT -r \r\n" 655".SH OPTIONS\r\n" 656" \r\n" 657" -r - Reconnects drivers to all devices.\r\n" 658" DeviceHandle - Specifies a device handle (a hexadecimal number).\r\n" 659" DriverHandle - Specifies a driver handle (a hexadecimal number). If not specified, all\r\n" 660" drivers on the specified device will be reconnected. \r\n" 661" ChildHandle - Specifies the child handle of device (a hexadecimal number). If not\r\n" 662" specified, then all child handles of the specified device are\r\n" 663" reconnected.\r\n" 664".SH DESCRIPTION\r\n" 665" \r\n" 666"NOTES:\r\n" 667" 1. This command reconnects drivers to the specific device. It will first\r\n" 668" disconnect the specified driver from the specified device and then connect\r\n" 669" the driver to the device recursively.\r\n" 670" 2. If the -r option is used, then all drivers will be reconnected to all\r\n" 671" devices. Any drivers that are bound to any devices will be disconnected\r\n" 672" first and then connected recursively.\r\n" 673" 3. See the connect and disconnect commands for more details. \r\n" 674".SH EXAMPLES\r\n" 675" \r\n" 676"EXAMPLES:\r\n" 677" * To reconnect all drivers to all devices:\r\n" 678" Shell> reconnect -r\r\n" 679" \r\n" 680" * To reconnect all drivers to device 0x28:\r\n" 681" fs0:\> reconnect 28\r\n" 682" \r\n" 683" * To disconnect 0x17 from 0x28 then reconnect drivers with 0x17 as highest\r\n" 684" priority to device 0x28:\r\n" 685" fs0:\> reconnect 28 17\r\n" 686" \r\n" 687" * To disconnect 0x17 from 0x28 destroying child 0x32 then reconnect drivers\r\n" 688" with 0x17 as highest priority to device 0x28\r\n" 689" fs0:\> reconnect 28 17 32\r\n" 690".SH RETURNVALUES\r\n" 691" \r\n" 692"RETURN VALUES:\r\n" 693" SHELL_SUCCESS The action was completed as requested.\r\n" 694" SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n" 695" violation.\r\n" 696" SHELL_INVALID_PARAMETER One of the passed in parameters was incorrectly\r\n" 697" formatted or its value was out of bounds.\r\n" 698 699#string STR_GET_HELP_UNLOAD #language en-US "" 700".TH unload 0 "unload a driver"\r\n" 701".SH NAME\r\n" 702"Unloads a driver image that was already loaded. \r\n" 703".SH SYNOPSIS\r\n" 704" \r\n" 705"UNLOAD [-n] [-v|-verbose] Handle \r\n" 706".SH OPTIONS\r\n" 707" \r\n" 708" -n - Skips all prompts during unloading, so that it can be used\r\n" 709" in a script file.\r\n" 710" -v, -verbose - Dumps verbose status information before the image is unloaded.\r\n" 711" Handle - Specifies the handle of driver to unload, always taken as hexadecimal number.\r\n" 712".SH DESCRIPTION\r\n" 713" \r\n" 714"NOTES:\r\n" 715" 1. The '-n' option can be used to skip all prompts during unloading.\r\n" 716" 2. If the '-v' option is specified, verbose image information will be\r\n" 717" displayed before the image is unloaded.\r\n" 718" 3. Only drivers that support unloading can be successfully unloaded.\r\n" 719" 4. Use the 'LOAD' command to load a driver.\r\n" 720".SH EXAMPLES\r\n" 721" \r\n" 722"EXAMPLES:\r\n" 723" * To find the handle for the UEFI driver image to unload:\r\n" 724" Shell> dh -b\r\n" 725" \r\n" 726" * To unload the UEFI driver image with handle 27:\r\n" 727" Shell> unload 27\r\n" 728".SH RETURNVALUES\r\n" 729" \r\n" 730"RETURN VALUES:\r\n" 731" SHELL_SUCCESS The action was completed as requested.\r\n" 732" SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n" 733" violation.\r\n" 734" SHELL_INVALID_PARAMETER One of the passed in parameters was incorrectly\r\n" 735" formatted or its value was out of bounds.\r\n" 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753