| 1 | // /**
|
|---|
| 2 | //
|
|---|
| 3 | // Copyright (c) 2014, 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 | // UefiBcfgCommandsLib.uni
|
|---|
| 16 | //
|
|---|
| 17 | // Abstract:
|
|---|
| 18 | //
|
|---|
| 19 | // String definitions for UEFI Shell 2.0 BCFG command
|
|---|
| 20 | //
|
|---|
| 21 | //
|
|---|
| 22 | // **/
|
|---|
| 23 |
|
|---|
| 24 | /=#
|
|---|
| 25 |
|
|---|
| 26 | #langdef en-US "english"
|
|---|
| 27 |
|
|---|
| 28 | #string STR_GEN_NO_MEM #language en-US "%EError. %NMemory is not available.\r\n"
|
|---|
| 29 | #string STR_GEN_PROBLEM #language en-US "%EError. %NThe argument '%B%s%N' is incorrect.\r\n"
|
|---|
| 30 | #string STR_GEN_PROBLEM_VAL #language en-US "%EError. %NThe argument '%B%s%N' has incorrect value.\r\n"
|
|---|
| 31 | #string STR_GEN_NO_DRIVER_BOOT #language en-US "%EError. %NDriver or Boot must be selected.\r\n"
|
|---|
| 32 | #string STR_GEN_BOOT_ONLY #language en-US "%EError. %NBoot must be selected for hot key options.\r\n"
|
|---|
| 33 | #string STR_GEN_TOO_FEW #language en-US "%EError. %NToo few arguments specified.\r\n"
|
|---|
| 34 | #string STR_GEN_TOO_MANY #language en-US "%EError. %NToo many arguments specified.\r\n"
|
|---|
| 35 | #string STR_GEN_FILE_OPEN_FAIL #language en-US "%EError. %NThe file '%B%s%N' did not open.\r\n"
|
|---|
| 36 | #string STR_GEN_FIND_FAIL #language en-US "%EError. %NThe file '%B%s%N' could not be found.\r\n"
|
|---|
| 37 | #string STR_GEN_OUT_MEM #language en-US "%EError. %NMemory allocation was not successful.\r\n"
|
|---|
| 38 | #string STR_BCFG_WRITE_FAIL #language en-US "%EError. %NUnable to write to '%B%s%N' (%r).\r\n"
|
|---|
| 39 | #string STR_BCFG_READ_FAIL #language en-US "%EError. %NUnable to read from '%B%s%N' (%r).\r\n"
|
|---|
| 40 | #string STR_BCFG_HANDLE #language en-US "%EError. %NThe handle [%H%02x%N] does not have DevicePath.\r\n"
|
|---|
| 41 | #string STR_BCFG_FILE #language en-US "%EError. %NThe file '%B%s%N' matches multiple files.\r\n"
|
|---|
| 42 | #string STR_BCFG_FILE_OPEN #language en-US "%EError. %NThe file '%B%s%N' did not open: %r.\r\n"
|
|---|
| 43 | #string STR_BCFG_FILE_DP #language en-US "%EError. %NThe file '%B%s%N' could not convert to DevPath.\r\n"
|
|---|
| 44 | #string STR_BCFG_TARGET_NF #language en-US "%EError. %NCould not find unused target index.\r\n"
|
|---|
| 45 | #string STR_BCFG_TARGET #language en-US "%NTarget = %04x.\r\n"
|
|---|
| 46 | #string STR_BCFG_SET_VAR_FAIL #language en-US "%EError. %NUnable to set %s: %r.\r\n"
|
|---|
| 47 | #string STR_BCFG_VAR_NO_NUM #language en-US "%EError. %NCannot create Key#### variable: All the numbers from 0x0000 - 0xFFFF have been used.\r\n"
|
|---|
| 48 | #string STR_BCFG_NUMB_RANGE #language en-US "%EError. %NNumbers must be under %d.\r\n"
|
|---|
| 49 | #string STR_BCFG_NONE #language en-US "%EError. %NNo options found.\r\n"
|
|---|
| 50 |
|
|---|
| 51 | #string STR_BCFG_LOCATION_RANGE #language en-US "%EError. %Ntarget location must be <= %d.\r\n"
|
|---|
| 52 | #string STR_BCFG_LOAD_OPTIONS #language en-US "Option: %B%02x%N. Variable: %B%-11s%N\r\n"
|
|---|
| 53 | " Desc - %s\r\n"
|
|---|
| 54 | " DevPath - %s\r\n"
|
|---|
| 55 | " Optional- %c\r\n"
|
|---|
| 56 | #string STR_GET_HELP_BCFG #language en-US ""
|
|---|
| 57 | ".TH bcfg 0 "configure boot and driver"\r\n"
|
|---|
| 58 | ".SH NAME\r\n"
|
|---|
| 59 | "Manages the boot and driver options that are stored in NVRAM.\r\n"
|
|---|
| 60 | ".SH SYNOPSIS\r\n"
|
|---|
| 61 | " \r\n"
|
|---|
| 62 | "BCFG driver|boot [dump [-v]] [add # file "desc"] [addp # file "desc"] \r\n"
|
|---|
| 63 | " [addh # handle "desc"] [rm #] [mv # #] \r\n"
|
|---|
| 64 | " [-opt # [[filename]|["data"]] | \r\n"
|
|---|
| 65 | " [KeyData <ScanCode UnicodeChar>]]\r\n"
|
|---|
| 66 | ".SH OPTIONS\r\n"
|
|---|
| 67 | " \r\n"
|
|---|
| 68 | " -v - Displays the option list with extra info including the optional\r\n"
|
|---|
| 69 | " data.\r\n"
|
|---|
| 70 | " -opt - Displays or modifies the optional data associated with a \r\n"
|
|---|
| 71 | " driver or boot option. Followed either by the file name of the\r\n"
|
|---|
| 72 | " file which contains the binary data to be associated with the\r\n"
|
|---|
| 73 | " driver or boot option optional data or else the quote\r\n"
|
|---|
| 74 | " delimited data which will be associated with the driver or\r\n"
|
|---|
| 75 | " boot option optional data.\r\n"
|
|---|
| 76 | " driver - Displays or modifies the driver option list.\r\n"
|
|---|
| 77 | " boot - Displays or modifies the boot option list.\r\n"
|
|---|
| 78 | " dump - Displays the option list.\r\n"
|
|---|
| 79 | " add - Adds an option. The # is the number of options to add in\r\n"
|
|---|
| 80 | " hexadecimal. The file name of the UEFI application/driver for\r\n"
|
|---|
| 81 | " the option. The quoted parameter is the description of the\r\n"
|
|---|
| 82 | " option being added.\r\n"
|
|---|
| 83 | " addh - Adds an option that refers to the driver specified by handle.\r\n"
|
|---|
| 84 | " The # is the number of options to add, in hexadecimal. The\r\n"
|
|---|
| 85 | " handle is the driver handle, in hexadecimal. The device path\r\n"
|
|---|
| 86 | " for the option is retrieved from the handle. The quoted\r\n"
|
|---|
| 87 | " parameter is the description of the option being added.\r\n"
|
|---|
| 88 | " addp - Adds an option that refers to a specific file. Only the portion\r\n"
|
|---|
| 89 | " of the device path starting with the hard drive partition is\r\n"
|
|---|
| 90 | " placed in the option. The # is the number of options to add,\r\n"
|
|---|
| 91 | " in hexadecimal. The quoted parameter is the description of the\r\n"
|
|---|
| 92 | " option being added.\r\n"
|
|---|
| 93 | " rm - Removes an option. The parameter lists the number of the options\r\n"
|
|---|
| 94 | " to remove in hexadecimal.\r\n"
|
|---|
| 95 | " mv - Moves an option. The first numeric parameter is the number of\r\n"
|
|---|
| 96 | " the option to move in hexadecimal. The second numeric parameter\r\n"
|
|---|
| 97 | " is the new number of the option being moved.\r\n"
|
|---|
| 98 | " KeyData - Specifies the packed value associated with a hot-key.\r\n"
|
|---|
| 99 | " ScanCode - Specifies the UEFI-defined scan code portion of the\r\n"
|
|---|
| 100 | " EFI_INPUT_KEY instruction. This value is directly associated\r\n"
|
|---|
| 101 | " with the preceding KeyData value. When one instance of this\r\n"
|
|---|
| 102 | " parameter has a non-zero value, the paired UnicodeChar value\r\n"
|
|---|
| 103 | " will have a zero-based value.\r\n"
|
|---|
| 104 | " UnicodeChar - Specifies the Unicode value for the character associated with\r\n"
|
|---|
| 105 | " the preceding KeyData value. When one instance of this\r\n"
|
|---|
| 106 | " parameter has a non-zero value, the paired ScanCode value\r\n"
|
|---|
| 107 | " will have a zero-based value.\r\n"
|
|---|
| 108 | ".SH DESCRIPTION\r\n"
|
|---|
| 109 | " \r\n"
|
|---|
| 110 | "NOTES:\r\n"
|
|---|
| 111 | " 1. Manages the boot and driver options stored in NVRAM.\r\n"
|
|---|
| 112 | " 2. This command can display the Boot#### or Driver#### environment variables\r\n"
|
|---|
| 113 | " by using the dump option.\r\n"
|
|---|
| 114 | " 3. The add option can be used to add a new Boot#### or Driver#### \r\n"
|
|---|
| 115 | " environment variable.\r\n"
|
|---|
| 116 | " 4. The rm option can be used to delete a Boot#### or Driver#### \r\n"
|
|---|
| 117 | " environment variable, and finally, then mv option can be used to reorder\r\n"
|
|---|
| 118 | " the Boot#### and Driver#### environment variables.\r\n"
|
|---|
| 119 | " 5. The add, rm, and mv options also update the BootOrder or DriverOrder\r\n"
|
|---|
| 120 | " environment variables as appropriate.\r\n"
|
|---|
| 121 | ".SH EXAMPLES\r\n"
|
|---|
| 122 | " \r\n"
|
|---|
| 123 | "EXAMPLES:\r\n"
|
|---|
| 124 | " * To display driver options:\r\n"
|
|---|
| 125 | " Shell> bcfg driver dump\r\n"
|
|---|
| 126 | " \r\n"
|
|---|
| 127 | " * To display boot options:\r\n"
|
|---|
| 128 | " Shell> bcfg boot dump\r\n"
|
|---|
| 129 | " \r\n"
|
|---|
| 130 | " * To display verbosely of boot options:\r\n"
|
|---|
| 131 | " Shell> bcfg boot dump -v\r\n"
|
|---|
| 132 | " \r\n"
|
|---|
| 133 | " * To add a driver option #5\r\n"
|
|---|
| 134 | " Shell> bcfg driver add 5 mydriver.efi "My Driver"\r\n"
|
|---|
| 135 | " \r\n"
|
|---|
| 136 | " * To add a boot option #3\r\n"
|
|---|
| 137 | " Shell> bcfg boot add 3 osloader.efi "My OS"\r\n"
|
|---|
| 138 | " \r\n"
|
|---|
| 139 | " * To remove boot option #3\r\n"
|
|---|
| 140 | " Shell> bcfg boot rm 3\r\n"
|
|---|
| 141 | " \r\n"
|
|---|
| 142 | " * To move boot option #3 to boot option #7\r\n"
|
|---|
| 143 | " Shell> bcfg boot mv 3 7\r\n"
|
|---|
| 144 | " \r\n"
|
|---|
| 145 | " * To assign a CTRL-B hot-key to boot option #3.\r\n"
|
|---|
| 146 | " Shell> bcfg boot -opt 3 0x40000200 0 0x42\r\n"
|
|---|
| 147 | ".SH RETURNVALUES\r\n"
|
|---|
| 148 | " \r\n"
|
|---|
| 149 | "RETURN VALUES:\r\n"
|
|---|
| 150 | " SHELL_SUCCESS The action was completed as requested.\r\n"
|
|---|
| 151 | " SHELL_NOT_FOUND The requested option was not found.\r\n"
|
|---|
| 152 | " SHELL_INVALID_PARAMETER One of the passed in parameters was incorrectly\r\n"
|
|---|
| 153 | " formatted or its value was out of bounds.\r\n"
|
|---|
| 154 | " SHELL_UNSUPPORTED The action as requested was unsupported.\r\n"
|
|---|
| 155 | " SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n"
|
|---|
| 156 | " violation.\r\n"
|
|---|
| 157 | " SHELL_OUT_OF_RESOURCES There was insufficient free space for the request\r\n"
|
|---|
| 158 | " to be completed.\r\n"
|
|---|
| 159 |
|
|---|
