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