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