ShellPkg/Library/UefiShellDriver1CommandsLib/UefiShellDriver1CommandsLib.uni

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