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