]>
Commit | Line | Data |
---|---|---|
94b17fa1 | 1 | /** @file\r |
941b3569 | 2 | EFI Shell protocol as defined in the UEFI Shell 2.0 specification including errata.\r |
94b17fa1 | 3 | \r |
c011b6c9 | 4 | (C) Copyright 2014 Hewlett-Packard Development Company, L.P.<BR>\r |
fbd2dfad | 5 | Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>\r |
1e6e84c7 | 6 | This program and the accompanying materials\r |
7 | are licensed and made available under the terms and conditions of the BSD License\r | |
8 | which accompanies this distribution. The full text of the license may be found at\r | |
9 | http://opensource.org/licenses/bsd-license.php\r | |
10 | \r | |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
94b17fa1 | 13 | \r |
14 | **/\r | |
15 | \r | |
16 | #ifndef __EFI_SHELL_PROTOCOL__\r | |
17 | #define __EFI_SHELL_PROTOCOL__\r | |
18 | \r | |
a405b86d | 19 | #include <ShellBase.h>\r |
94b17fa1 | 20 | #include <Guid/FileInfo.h>\r |
21 | \r | |
22 | #define EFI_SHELL_PROTOCOL_GUID \\r | |
23 | { \\r | |
24 | 0x6302d008, 0x7f9b, 0x4f30, { 0x87, 0xac, 0x60, 0xc9, 0xfe, 0xf5, 0xda, 0x4e } \\r | |
25 | }\r | |
26 | \r | |
d2b4564b | 27 | // replaced EFI_LIST_ENTRY with LIST_ENTRY for simplicity.\r |
28 | // they are identical outside of the name.\r | |
94b17fa1 | 29 | typedef struct {\r |
a405b86d | 30 | LIST_ENTRY Link; ///< Linked list members.\r |
31 | EFI_STATUS Status; ///< Status of opening the file. Valid only if Handle != NULL.\r | |
32 | CONST CHAR16 *FullName; ///< Fully qualified filename.\r | |
33 | CONST CHAR16 *FileName; ///< name of this file.\r | |
34 | SHELL_FILE_HANDLE Handle; ///< Handle for interacting with the opened file or NULL if closed.\r | |
35 | EFI_FILE_INFO *Info; ///< Pointer to the FileInfo struct for this file or NULL.\r | |
94b17fa1 | 36 | } EFI_SHELL_FILE_INFO;\r |
a31bd33c | 37 | \r |
94b17fa1 | 38 | /**\r |
39 | Returns whether any script files are currently being processed.\r | |
40 | \r | |
41 | @retval TRUE There is at least one script file active.\r | |
42 | @retval FALSE No script files are active now.\r | |
43 | \r | |
44 | **/\r | |
45 | typedef\r | |
46 | BOOLEAN\r | |
47 | (EFIAPI *EFI_SHELL_BATCH_IS_ACTIVE) (\r | |
48 | VOID\r | |
49 | );\r | |
50 | \r | |
51 | /**\r | |
52 | Closes the file handle.\r | |
53 | \r | |
1e6e84c7 | 54 | This function closes a specified file handle. All 'dirty' cached file data is\r |
55 | flushed to the device, and the file is closed. In all cases, the handle is\r | |
94b17fa1 | 56 | closed.\r |
57 | \r | |
1e6e84c7 | 58 | @param[in] FileHandle The file handle to be closed.\r |
94b17fa1 | 59 | \r |
a31bd33c | 60 | @retval EFI_SUCCESS The file closed sucessfully.\r |
94b17fa1 | 61 | **/\r |
62 | typedef\r | |
63 | EFI_STATUS\r | |
64 | (EFIAPI *EFI_SHELL_CLOSE_FILE)(\r | |
a405b86d | 65 | IN SHELL_FILE_HANDLE FileHandle\r |
94b17fa1 | 66 | );\r |
67 | \r | |
68 | /**\r | |
69 | Creates a file or directory by name.\r | |
70 | \r | |
71 | This function creates an empty new file or directory with the specified attributes and\r | |
72 | returns the new file's handle. If the file already exists and is read-only, then\r | |
73 | EFI_INVALID_PARAMETER will be returned.\r | |
1e6e84c7 | 74 | \r |
94b17fa1 | 75 | If the file already existed, it is truncated and its attributes updated. If the file is\r |
76 | created successfully, the FileHandle is the file's handle, else, the FileHandle is NULL.\r | |
1e6e84c7 | 77 | \r |
94b17fa1 | 78 | If the file name begins with >v, then the file handle which is returned refers to the\r |
79 | shell environment variable with the specified name. If the shell environment variable\r | |
80 | already exists and is non-volatile then EFI_INVALID_PARAMETER is returned.\r | |
81 | \r | |
1e6e84c7 | 82 | @param[in] FileName Pointer to NULL-terminated file path.\r |
a405b86d | 83 | @param[in] FileAttribs The new file's attrbiutes. The different attributes are\r |
a31bd33c | 84 | described in EFI_FILE_PROTOCOL.Open().\r |
a405b86d | 85 | @param[out] FileHandle On return, points to the created file handle or directory's handle.\r |
94b17fa1 | 86 | \r |
a31bd33c | 87 | @retval EFI_SUCCESS The file was opened. FileHandle points to the new file's handle.\r |
94b17fa1 | 88 | @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r |
1e6e84c7 | 89 | @retval EFI_UNSUPPORTED The file path could not be opened.\r |
a31bd33c | 90 | @retval EFI_NOT_FOUND The specified file could not be found on the device, or could not\r |
91 | file the file system on the device.\r | |
92 | @retval EFI_NO_MEDIA The device has no medium.\r | |
93 | @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no\r | |
94 | longer supported.\r | |
95 | @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according\r | |
96 | the DirName.\r | |
97 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
98 | @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write\r | |
99 | when the media is write-protected.\r | |
100 | @retval EFI_ACCESS_DENIED The service denied access to the file.\r | |
101 | @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file.\r | |
102 | @retval EFI_VOLUME_FULL The volume is full.\r | |
94b17fa1 | 103 | **/\r |
104 | typedef\r | |
105 | EFI_STATUS\r | |
106 | (EFIAPI *EFI_SHELL_CREATE_FILE)(\r | |
a405b86d | 107 | IN CONST CHAR16 *FileName,\r |
108 | IN UINT64 FileAttribs,\r | |
109 | OUT SHELL_FILE_HANDLE *FileHandle\r | |
94b17fa1 | 110 | );\r |
111 | \r | |
112 | /**\r | |
113 | Deletes the file specified by the file handle.\r | |
114 | \r | |
115 | This function closes and deletes a file. In all cases, the file handle is closed. If the file\r | |
116 | cannot be deleted, the warning code EFI_WARN_DELETE_FAILURE is returned, but the\r | |
117 | handle is still closed.\r | |
118 | \r | |
941b3569 | 119 | @param[in] FileHandle The file handle to delete.\r |
94b17fa1 | 120 | \r |
1e6e84c7 | 121 | @retval EFI_SUCCESS The file was closed and deleted and the handle was closed.\r |
94b17fa1 | 122 | @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.\r |
123 | **/\r | |
124 | typedef\r | |
125 | EFI_STATUS\r | |
126 | (EFIAPI *EFI_SHELL_DELETE_FILE)(\r | |
a405b86d | 127 | IN SHELL_FILE_HANDLE FileHandle\r |
94b17fa1 | 128 | );\r |
129 | \r | |
130 | /**\r | |
131 | Deletes the file specified by the file name.\r | |
132 | \r | |
133 | This function deletes a file.\r | |
134 | \r | |
1e6e84c7 | 135 | @param[in] FileName Points to the NULL-terminated file name.\r |
94b17fa1 | 136 | \r |
1e6e84c7 | 137 | @retval EFI_SUCCESS The file was deleted.\r |
94b17fa1 | 138 | @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.\r |
139 | **/\r | |
140 | typedef\r | |
141 | EFI_STATUS\r | |
142 | (EFIAPI *EFI_SHELL_DELETE_FILE_BY_NAME)(\r | |
143 | IN CONST CHAR16 *FileName\r | |
144 | );\r | |
145 | \r | |
146 | /**\r | |
147 | Disables the page break output mode.\r | |
148 | **/\r | |
149 | typedef\r | |
150 | VOID\r | |
151 | (EFIAPI *EFI_SHELL_DISABLE_PAGE_BREAK) (\r | |
1e6e84c7 | 152 | VOID\r |
153 | );\r | |
94b17fa1 | 154 | \r |
155 | /**\r | |
156 | Enables the page break output mode.\r | |
157 | **/\r | |
158 | typedef\r | |
159 | VOID\r | |
160 | (EFIAPI *EFI_SHELL_ENABLE_PAGE_BREAK) (\r | |
1e6e84c7 | 161 | VOID\r |
162 | );\r | |
94b17fa1 | 163 | \r |
164 | /**\r | |
165 | Execute the command line.\r | |
166 | \r | |
167 | This function creates a nested instance of the shell and executes the specified\r | |
168 | command (CommandLine) with the specified environment (Environment). Upon return,\r | |
169 | the status code returned by the specified command is placed in StatusCode.\r | |
1e6e84c7 | 170 | \r |
94b17fa1 | 171 | If Environment is NULL, then the current environment is used and all changes made\r |
172 | by the commands executed will be reflected in the current environment. If the\r | |
173 | Environment is non-NULL, then the changes made will be discarded.\r | |
1e6e84c7 | 174 | \r |
94b17fa1 | 175 | The CommandLine is executed from the current working directory on the current\r |
176 | device.\r | |
177 | \r | |
1e6e84c7 | 178 | @param[in] ParentImageHandle A handle of the image that is executing the specified\r |
179 | command line.\r | |
180 | @param[in] CommandLine Points to the NULL-terminated UCS-2 encoded string\r | |
941b3569 | 181 | containing the command line. If NULL then the command-\r |
182 | line will be empty.\r | |
1e6e84c7 | 183 | @param[in] Environment Points to a NULL-terminated array of environment\r |
184 | variables with the format 'x=y', where x is the\r | |
941b3569 | 185 | environment variable name and y is the value. If this\r |
186 | is NULL, then the current shell environment is used.\r | |
187 | @param[out] ErrorCode Points to the status code returned by the command.\r | |
188 | \r | |
1e6e84c7 | 189 | @retval EFI_SUCCESS The command executed successfully. The status code\r |
941b3569 | 190 | returned by the command is pointed to by StatusCode.\r |
94b17fa1 | 191 | @retval EFI_INVALID_PARAMETER The parameters are invalid.\r |
941b3569 | 192 | @retval EFI_OUT_OF_RESOURCES Out of resources.\r |
193 | @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.\r | |
94b17fa1 | 194 | **/\r |
195 | typedef\r | |
196 | EFI_STATUS\r | |
197 | (EFIAPI *EFI_SHELL_EXECUTE) (\r | |
a405b86d | 198 | IN EFI_HANDLE *ParentImageHandle,\r |
199 | IN CHAR16 *CommandLine OPTIONAL,\r | |
200 | IN CHAR16 **Environment OPTIONAL,\r | |
201 | OUT EFI_STATUS *StatusCode OPTIONAL\r | |
94b17fa1 | 202 | );\r |
203 | \r | |
204 | /**\r | |
205 | Find files that match a specified pattern.\r | |
206 | \r | |
207 | This function searches for all files and directories that match the specified\r | |
208 | FilePattern. The FilePattern can contain wild-card characters. The resulting file\r | |
209 | information is placed in the file list FileList.\r | |
210 | \r | |
211 | The files in the file list are not opened. The OpenMode field is set to 0 and the FileInfo\r | |
212 | field is set to NULL.\r | |
213 | \r | |
1e6e84c7 | 214 | @param[in] FilePattern Points to a NULL-terminated shell file path, including wildcards.\r |
215 | @param[out] FileList On return, points to the start of a file list containing the names\r | |
216 | of all matching files or else points to NULL if no matching files\r | |
941b3569 | 217 | were found.\r |
94b17fa1 | 218 | \r |
941b3569 | 219 | @retval EFI_SUCCESS Files found.\r |
220 | @retval EFI_NOT_FOUND No files found.\r | |
a31bd33c | 221 | @retval EFI_NO_MEDIA The device has no media.\r |
222 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
223 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
94b17fa1 | 224 | **/\r |
225 | typedef\r | |
226 | EFI_STATUS\r | |
227 | (EFIAPI *EFI_SHELL_FIND_FILES)(\r | |
a405b86d | 228 | IN CONST CHAR16 *FilePattern,\r |
229 | OUT EFI_SHELL_FILE_INFO **FileList\r | |
94b17fa1 | 230 | );\r |
231 | \r | |
232 | /**\r | |
233 | Find all files in a specified directory.\r | |
234 | \r | |
941b3569 | 235 | @param[in] FileDirHandle Handle of the directory to search.\r |
1e6e84c7 | 236 | @param[out] FileList On return, points to the list of files in the directory\r |
941b3569 | 237 | or NULL if there are no files in the directory.\r |
94b17fa1 | 238 | \r |
941b3569 | 239 | @retval EFI_SUCCESS File information was returned successfully.\r |
240 | @retval EFI_VOLUME_CORRUPTED The file system structures have been corrupted.\r | |
241 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
242 | @retval EFI_NO_MEDIA The device media is not present.\r | |
94b17fa1 | 243 | **/\r |
244 | typedef\r | |
245 | EFI_STATUS\r | |
246 | (EFIAPI *EFI_SHELL_FIND_FILES_IN_DIR)(\r | |
a405b86d | 247 | IN SHELL_FILE_HANDLE FileDirHandle,\r |
248 | OUT EFI_SHELL_FILE_INFO **FileList\r | |
94b17fa1 | 249 | );\r |
250 | \r | |
251 | /**\r | |
a31bd33c | 252 | Flushes data back to a device.\r |
1e6e84c7 | 253 | \r |
94b17fa1 | 254 | This function flushes all modified data associated with a file to a device.\r |
255 | \r | |
1e6e84c7 | 256 | @param[in] FileHandle The handle of the file to flush.\r |
94b17fa1 | 257 | \r |
258 | @retval EFI_SUCCESS The data was flushed.\r | |
259 | @retval EFI_NO_MEDIA The device has no medium.\r | |
260 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
261 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
262 | @retval EFI_WRITE_PROTECTED The file or medium is write-protected.\r | |
263 | @retval EFI_ACCESS_DENIED The file was opened read-only.\r | |
264 | @retval EFI_VOLUME_FULL The volume is full.\r | |
265 | **/\r | |
266 | typedef\r | |
267 | EFI_STATUS\r | |
268 | (EFIAPI *EFI_SHELL_FLUSH_FILE)(\r | |
a405b86d | 269 | IN SHELL_FILE_HANDLE FileHandle\r |
94b17fa1 | 270 | );\r |
271 | \r | |
272 | /**\r | |
273 | Frees the file list.\r | |
1e6e84c7 | 274 | \r |
94b17fa1 | 275 | This function cleans up the file list and any related data structures. It has no\r |
276 | impact on the files themselves.\r | |
277 | \r | |
1e6e84c7 | 278 | @param[in] FileList The file list to free. Type EFI_SHELL_FILE_INFO is\r |
279 | defined in OpenFileList().\r | |
94b17fa1 | 280 | \r |
281 | @retval EFI_SUCCESS Free the file list successfully.\r | |
282 | **/\r | |
283 | typedef\r | |
284 | EFI_STATUS\r | |
285 | (EFIAPI *EFI_SHELL_FREE_FILE_LIST) (\r | |
286 | IN EFI_SHELL_FILE_INFO **FileList\r | |
287 | );\r | |
288 | \r | |
289 | /**\r | |
290 | Returns the current directory on the specified device.\r | |
291 | \r | |
292 | If FileSystemMapping is NULL, it returns the current working directory. If the\r | |
293 | FileSystemMapping is not NULL, it returns the current directory associated with the\r | |
294 | FileSystemMapping. In both cases, the returned name includes the file system\r | |
295 | mapping (i.e. fs0:\current-dir).\r | |
296 | \r | |
fbd2dfad QS |
297 | Note that the current directory string should exclude the tailing backslash character.\r |
298 | \r | |
1e6e84c7 | 299 | @param[in] FileSystemMapping A pointer to the file system mapping. If NULL,\r |
94b17fa1 | 300 | then the current working directory is returned.\r |
1e6e84c7 | 301 | \r |
94b17fa1 | 302 | @retval !=NULL The current directory.\r |
303 | @retval NULL Current directory does not exist.\r | |
304 | **/\r | |
305 | typedef\r | |
306 | CONST CHAR16 *\r | |
307 | (EFIAPI *EFI_SHELL_GET_CUR_DIR) (\r | |
308 | IN CONST CHAR16 *FileSystemMapping OPTIONAL\r | |
309 | );\r | |
310 | \r | |
311 | typedef UINT32 EFI_SHELL_DEVICE_NAME_FLAGS;\r | |
312 | #define EFI_DEVICE_NAME_USE_COMPONENT_NAME 0x00000001\r | |
313 | #define EFI_DEVICE_NAME_USE_DEVICE_PATH 0x00000002\r | |
a31bd33c | 314 | \r |
94b17fa1 | 315 | /**\r |
316 | Gets the name of the device specified by the device handle.\r | |
317 | \r | |
318 | This function gets the user-readable name of the device specified by the device\r | |
319 | handle. If no user-readable name could be generated, then *BestDeviceName will be\r | |
320 | NULL and EFI_NOT_FOUND will be returned.\r | |
321 | \r | |
d2b4564b | 322 | If EFI_DEVICE_NAME_USE_COMPONENT_NAME is set, then the function will return the\r |
69817bf8 | 323 | device's name using the EFI_COMPONENT_NAME2_PROTOCOL, if present on\r |
d2b4564b | 324 | DeviceHandle.\r |
325 | \r | |
326 | If EFI_DEVICE_NAME_USE_DEVICE_PATH is set, then the function will return the\r | |
69817bf8 | 327 | device's name using the EFI_DEVICE_PATH_PROTOCOL, if present on DeviceHandle.\r |
d2b4564b | 328 | If both EFI_DEVICE_NAME_USE_COMPONENT_NAME and\r |
329 | EFI_DEVICE_NAME_USE_DEVICE_PATH are set, then\r | |
330 | EFI_DEVICE_NAME_USE_COMPONENT_NAME will have higher priority.\r | |
331 | \r | |
941b3569 | 332 | @param[in] DeviceHandle The handle of the device.\r |
1e6e84c7 | 333 | @param[in] Flags Determines the possible sources of component names.\r |
334 | @param[in] Language A pointer to the language specified for the device\r | |
335 | name, in the same format as described in the UEFI\r | |
a31bd33c | 336 | specification, Appendix M.\r |
1e6e84c7 | 337 | @param[out] BestDeviceName On return, points to the callee-allocated NULL-\r |
338 | terminated name of the device. If no device name\r | |
339 | could be found, points to NULL. The name must be\r | |
94b17fa1 | 340 | freed by the caller...\r |
341 | \r | |
342 | @retval EFI_SUCCESS Get the name successfully.\r | |
343 | @retval EFI_NOT_FOUND Fail to get the device name.\r | |
344 | **/\r | |
345 | typedef\r | |
346 | EFI_STATUS\r | |
e26d7b59 | 347 | (EFIAPI *EFI_SHELL_GET_DEVICE_NAME) (\r |
a405b86d | 348 | IN EFI_HANDLE DeviceHandle,\r |
349 | IN EFI_SHELL_DEVICE_NAME_FLAGS Flags,\r | |
350 | IN CHAR8 *Language,\r | |
351 | OUT CHAR16 **BestDeviceName\r | |
94b17fa1 | 352 | );\r |
353 | \r | |
354 | /**\r | |
355 | Gets the device path from the mapping.\r | |
356 | \r | |
357 | This function gets the device path associated with a mapping.\r | |
358 | \r | |
941b3569 | 359 | @param[in] Mapping A pointer to the mapping\r |
94b17fa1 | 360 | \r |
1e6e84c7 | 361 | @retval !=NULL Pointer to the device path that corresponds to the\r |
362 | device mapping. The returned pointer does not need\r | |
94b17fa1 | 363 | to be freed.\r |
1e6e84c7 | 364 | @retval NULL There is no device path associated with the\r |
94b17fa1 | 365 | specified mapping.\r |
366 | **/\r | |
367 | typedef\r | |
368 | CONST EFI_DEVICE_PATH_PROTOCOL *\r | |
369 | (EFIAPI *EFI_SHELL_GET_DEVICE_PATH_FROM_MAP) (\r | |
370 | IN CONST CHAR16 *Mapping\r | |
371 | );\r | |
372 | \r | |
373 | /**\r | |
374 | Converts a file system style name to a device path.\r | |
375 | \r | |
376 | This function converts a file system style name to a device path, by replacing any\r | |
377 | mapping references to the associated device path.\r | |
378 | \r | |
a31bd33c | 379 | @param[in] Path The pointer to the path.\r |
94b17fa1 | 380 | \r |
1e6e84c7 | 381 | @return The pointer of the file path. The file path is callee\r |
94b17fa1 | 382 | allocated and should be freed by the caller.\r |
383 | **/\r | |
384 | typedef\r | |
385 | EFI_DEVICE_PATH_PROTOCOL *\r | |
386 | (EFIAPI *EFI_SHELL_GET_DEVICE_PATH_FROM_FILE_PATH) (\r | |
387 | IN CONST CHAR16 *Path\r | |
388 | );\r | |
389 | \r | |
390 | /**\r | |
941b3569 | 391 | Gets either a single or list of environment variables.\r |
392 | \r | |
1e6e84c7 | 393 | If name is not NULL then this function returns the current value of the specified\r |
941b3569 | 394 | environment variable.\r |
94b17fa1 | 395 | \r |
1e6e84c7 | 396 | If Name is NULL than a list of all environment variable names is returned. Each a\r |
941b3569 | 397 | NULL terminated string with a double NULL terminating the list.\r |
94b17fa1 | 398 | \r |
1e6e84c7 | 399 | @param[in] Name A pointer to the environment variable name. If\r |
400 | Name is NULL, then the function will return all\r | |
401 | of the defined shell environment variables. In\r | |
402 | the case where multiple environment variables are\r | |
403 | being returned, each variable will be terminated by\r | |
404 | a NULL, and the list will be terminated by a double\r | |
941b3569 | 405 | NULL.\r |
94b17fa1 | 406 | \r |
1e6e84c7 | 407 | @return A pointer to the returned string.\r |
941b3569 | 408 | The returned pointer does not need to be freed by the caller.\r |
409 | \r | |
1e6e84c7 | 410 | @retval NULL The environment variable doesn't exist or there are\r |
941b3569 | 411 | no environment variables.\r |
94b17fa1 | 412 | **/\r |
413 | typedef\r | |
414 | CONST CHAR16 *\r | |
415 | (EFIAPI *EFI_SHELL_GET_ENV) (\r | |
941b3569 | 416 | IN CONST CHAR16 *Name OPTIONAL\r |
94b17fa1 | 417 | );\r |
418 | \r | |
044ea4e5 JC |
419 | /**\r |
420 | Gets the environment variable and Attributes, or list of environment variables. Can be \r | |
421 | used instead of GetEnv().\r | |
422 | \r | |
423 | This function returns the current value of the specified environment variable and\r | |
424 | the Attributes. If no variable name was specified, then all of the known\r | |
425 | variables will be returned.\r | |
426 | \r | |
427 | @param[in] Name A pointer to the environment variable name. If Name is NULL,\r | |
428 | then the function will return all of the defined shell \r | |
429 | environment variables. In the case where multiple environment\r | |
430 | variables are being returned, each variable will be terminated \r | |
431 | by a NULL, and the list will be terminated by a double NULL.\r | |
432 | @param[out] Attributes If not NULL, a pointer to the returned attributes bitmask for\r | |
433 | the environment variable. In the case where Name is NULL, and\r | |
434 | multiple environment variables are being returned, Attributes\r | |
435 | is undefined.\r | |
436 | \r | |
f5ba4007 QS |
437 | @retval NULL The environment variable doesn't exist. \r |
438 | @return The environment variable's value. The returned pointer does not \r | |
044ea4e5 JC |
439 | need to be freed by the caller. \r |
440 | **/\r | |
441 | typedef\r | |
442 | CONST CHAR16 *\r | |
443 | (EFIAPI *EFI_SHELL_GET_ENV_EX) (\r | |
444 | IN CONST CHAR16 *Name,\r | |
445 | OUT UINT32 *Attributes OPTIONAL\r | |
446 | );\r | |
447 | \r | |
94b17fa1 | 448 | /**\r |
449 | Gets the file information from an open file handle.\r | |
450 | \r | |
451 | This function allocates a buffer to store the file's information. It's the caller's\r | |
452 | responsibility to free the buffer.\r | |
453 | \r | |
a31bd33c | 454 | @param[in] FileHandle A File Handle.\r |
94b17fa1 | 455 | \r |
1e6e84c7 | 456 | @retval NULL Cannot get the file info.\r |
457 | @return A pointer to a buffer with file information.\r | |
94b17fa1 | 458 | **/\r |
459 | typedef\r | |
460 | EFI_FILE_INFO *\r | |
461 | (EFIAPI *EFI_SHELL_GET_FILE_INFO)(\r | |
a405b86d | 462 | IN SHELL_FILE_HANDLE FileHandle\r |
94b17fa1 | 463 | );\r |
464 | \r | |
465 | /**\r | |
466 | Converts a device path to a file system-style path.\r | |
467 | \r | |
468 | This function converts a device path to a file system path by replacing part, or all, of\r | |
469 | the device path with the file-system mapping. If there are more than one application\r | |
470 | file system mappings, the one that most closely matches Path will be used.\r | |
471 | \r | |
1e6e84c7 | 472 | @param[in] Path The pointer to the device path.\r |
94b17fa1 | 473 | \r |
1e6e84c7 | 474 | @return The pointer of the NULL-terminated file path. The path\r |
94b17fa1 | 475 | is callee-allocated and should be freed by the caller.\r |
476 | **/\r | |
477 | typedef\r | |
478 | CHAR16 *\r | |
479 | (EFIAPI *EFI_SHELL_GET_FILE_PATH_FROM_DEVICE_PATH) (\r | |
480 | IN CONST EFI_DEVICE_PATH_PROTOCOL *Path\r | |
481 | );\r | |
482 | \r | |
483 | /**\r | |
a31bd33c | 484 | Gets a file's current position.\r |
94b17fa1 | 485 | \r |
486 | This function returns the current file position for the file handle. For directories, the\r | |
487 | current file position has no meaning outside of the file system driver and as such, the\r | |
488 | operation is not supported.\r | |
489 | \r | |
941b3569 | 490 | @param[in] FileHandle The file handle on which to get the current position.\r |
1e6e84c7 | 491 | @param[out] Position Byte position from the start of the file.\r |
94b17fa1 | 492 | \r |
493 | @retval EFI_SUCCESS Data was accessed.\r | |
494 | @retval EFI_UNSUPPORTED The request is not valid on open directories.\r | |
495 | **/\r | |
496 | typedef\r | |
497 | EFI_STATUS\r | |
498 | (EFIAPI *EFI_SHELL_GET_FILE_POSITION)(\r | |
a405b86d | 499 | IN SHELL_FILE_HANDLE FileHandle,\r |
94b17fa1 | 500 | OUT UINT64 *Position\r |
501 | );\r | |
502 | \r | |
503 | /**\r | |
504 | Gets the size of a file.\r | |
505 | \r | |
506 | This function returns the size of the file specified by FileHandle.\r | |
507 | \r | |
941b3569 | 508 | @param[in] FileHandle The handle of the file.\r |
509 | @param[out] Size The size of this file.\r | |
94b17fa1 | 510 | \r |
511 | @retval EFI_SUCCESS Get the file's size.\r | |
512 | @retval EFI_DEVICE_ERROR Can't access the file.\r | |
513 | **/\r | |
514 | typedef\r | |
515 | EFI_STATUS\r | |
516 | (EFIAPI *EFI_SHELL_GET_FILE_SIZE)(\r | |
a405b86d | 517 | IN SHELL_FILE_HANDLE FileHandle,\r |
94b17fa1 | 518 | OUT UINT64 *Size\r |
519 | );\r | |
520 | \r | |
044ea4e5 JC |
521 | /**\r |
522 | Get the GUID value from a human readable name.\r | |
523 | \r | |
524 | If GuidName is a known GUID name, then update Guid to have the correct value for\r | |
525 | that GUID.\r | |
526 | \r | |
527 | This function is only available when the major and minor versions in the\r | |
528 | EfiShellProtocol are greater than or equal to 2 and 1, respectively.\r | |
529 | \r | |
530 | @param[in] GuidName A pointer to the localized name for the GUID being queried.\r | |
531 | @param[out] Guid A pointer to the GUID structure to be filled in.\r | |
532 | \r | |
533 | @retval EFI_SUCCESS The operation was successful.\r | |
534 | @retval EFI_INVALID_PARAMETER Guid was NULL.\r | |
535 | @retval EFI_INVALID_PARAMETER GuidName was NULL.\r | |
536 | @retval EFI_NOT_FOUND GuidName is not a known GUID Name.\r | |
537 | **/\r | |
538 | typedef\r | |
539 | EFI_STATUS\r | |
540 | (EFIAPI *EFI_SHELL_GET_GUID_FROM_NAME)(\r | |
541 | IN CONST CHAR16 *GuidName,\r | |
542 | OUT EFI_GUID *Guid\r | |
543 | );\r | |
544 | \r | |
545 | /**\r | |
546 | Get the human readable name for a GUID from the value.\r | |
547 | \r | |
548 | If Guid is assigned a name, then update *GuidName to point to the name. The callee\r | |
549 | should not modify the value.\r | |
550 | \r | |
551 | This function is only available when the major and minor versions in the\r | |
552 | EfiShellProtocol are greater than or equal to 2 and 1, respectively.\r | |
553 | \r | |
554 | @param[in] Guid A pointer to the GUID being queried.\r | |
555 | @param[out] GuidName A pointer to a pointer the localized to name for the GUID being requested\r | |
556 | \r | |
557 | @retval EFI_SUCCESS The operation was successful.\r | |
558 | @retval EFI_INVALID_PARAMETER Guid was NULL.\r | |
559 | @retval EFI_INVALID_PARAMETER GuidName was NULL.\r | |
560 | @retval EFI_NOT_FOUND Guid is not assigned a name.\r | |
561 | **/\r | |
562 | typedef\r | |
563 | EFI_STATUS\r | |
564 | (EFIAPI *EFI_SHELL_GET_GUID_NAME)(\r | |
565 | IN CONST EFI_GUID *Guid,\r | |
566 | OUT CONST CHAR16 **GuidName\r | |
567 | );\r | |
568 | \r | |
94b17fa1 | 569 | /**\r |
570 | Return help information about a specific command.\r | |
571 | \r | |
572 | This function returns the help information for the specified command. The help text\r | |
573 | can be internal to the shell or can be from a UEFI Shell manual page.\r | |
1e6e84c7 | 574 | \r |
94b17fa1 | 575 | If Sections is specified, then each section name listed will be compared in a casesensitive\r |
576 | manner, to the section names described in Appendix B. If the section exists,\r | |
577 | it will be appended to the returned help text. If the section does not exist, no\r | |
578 | information will be returned. If Sections is NULL, then all help text information\r | |
579 | available will be returned.\r | |
580 | \r | |
1e6e84c7 | 581 | @param[in] Command Points to the NULL-terminated UEFI Shell command name.\r |
582 | @param[in] Sections Points to the NULL-terminated comma-delimited\r | |
583 | section names to return. If NULL, then all\r | |
94b17fa1 | 584 | sections will be returned.\r |
1e6e84c7 | 585 | @param[out] HelpText On return, points to a callee-allocated buffer\r |
94b17fa1 | 586 | containing all specified help text.\r |
587 | \r | |
588 | @retval EFI_SUCCESS The help text was returned.\r | |
1e6e84c7 | 589 | @retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the\r |
94b17fa1 | 590 | returned help text.\r |
a31bd33c | 591 | @retval EFI_INVALID_PARAMETER HelpText is NULL.\r |
94b17fa1 | 592 | @retval EFI_NOT_FOUND There is no help text available for Command.\r |
593 | **/\r | |
594 | typedef\r | |
595 | EFI_STATUS\r | |
596 | (EFIAPI *EFI_SHELL_GET_HELP_TEXT) (\r | |
597 | IN CONST CHAR16 *Command,\r | |
b1f95a06 | 598 | IN CONST CHAR16 *Sections OPTIONAL,\r |
94b17fa1 | 599 | OUT CHAR16 **HelpText\r |
600 | );\r | |
601 | \r | |
602 | /**\r | |
941b3569 | 603 | Gets the mapping(s) that most closely matches the device path.\r |
94b17fa1 | 604 | \r |
605 | This function gets the mapping which corresponds to the device path *DevicePath. If\r | |
606 | there is no exact match, then the mapping which most closely matches *DevicePath\r | |
607 | is returned, and *DevicePath is updated to point to the remaining portion of the\r | |
608 | device path. If there is an exact match, the mapping is returned and *DevicePath\r | |
609 | points to the end-of-device-path node.\r | |
610 | \r | |
1e6e84c7 | 611 | If there are multiple map names they will be semi-colon seperated in the\r |
941b3569 | 612 | NULL-terminated string.\r |
613 | \r | |
4ff7e37b ED |
614 | @param[in, out] DevicePath On entry, points to a device path pointer. On\r |
615 | exit, updates the pointer to point to the\r | |
616 | portion of the device path after the mapping.\r | |
94b17fa1 | 617 | \r |
618 | @retval NULL No mapping was found.\r | |
1e6e84c7 | 619 | @retval !=NULL Pointer to NULL-terminated mapping. The buffer\r |
94b17fa1 | 620 | is callee allocated and should be freed by the caller.\r |
621 | **/\r | |
622 | typedef\r | |
623 | CONST CHAR16 *\r | |
624 | (EFIAPI *EFI_SHELL_GET_MAP_FROM_DEVICE_PATH) (\r | |
625 | IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath\r | |
626 | );\r | |
627 | \r | |
628 | /**\r | |
629 | Gets the enable status of the page break output mode.\r | |
630 | \r | |
631 | User can use this function to determine current page break mode.\r | |
632 | \r | |
a31bd33c | 633 | @retval TRUE The page break output mode is enabled.\r |
634 | @retval FALSE The page break output mode is disabled.\r | |
94b17fa1 | 635 | **/\r |
636 | typedef\r | |
637 | BOOLEAN\r | |
638 | (EFIAPI *EFI_SHELL_GET_PAGE_BREAK) (\r | |
639 | VOID\r | |
640 | );\r | |
641 | \r | |
642 | /**\r | |
643 | Judges whether the active shell is the root shell.\r | |
644 | \r | |
645 | This function makes the user to know that whether the active Shell is the root shell.\r | |
646 | \r | |
647 | @retval TRUE The active Shell is the root Shell.\r | |
648 | @retval FALSE The active Shell is NOT the root Shell.\r | |
649 | **/\r | |
650 | typedef\r | |
651 | BOOLEAN\r | |
652 | (EFIAPI *EFI_SHELL_IS_ROOT_SHELL) (\r | |
653 | VOID\r | |
654 | );\r | |
655 | \r | |
656 | /**\r | |
657 | Opens a file or a directory by file name.\r | |
658 | \r | |
659 | This function opens the specified file in the specified OpenMode and returns a file\r | |
660 | handle.\r | |
1e6e84c7 | 661 | If the file name begins with '>v', then the file handle which is returned refers to the\r |
94b17fa1 | 662 | shell environment variable with the specified name. If the shell environment variable\r |
663 | exists, is non-volatile and the OpenMode indicates EFI_FILE_MODE_WRITE, then\r | |
664 | EFI_INVALID_PARAMETER is returned.\r | |
665 | \r | |
1e6e84c7 | 666 | If the file name is '>i', then the file handle which is returned refers to the standard\r |
94b17fa1 | 667 | input. If the OpenMode indicates EFI_FILE_MODE_WRITE, then EFI_INVALID_PARAMETER\r |
668 | is returned.\r | |
669 | \r | |
1e6e84c7 | 670 | If the file name is '>o', then the file handle which is returned refers to the standard\r |
94b17fa1 | 671 | output. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER\r |
672 | is returned.\r | |
673 | \r | |
1e6e84c7 | 674 | If the file name is '>e', then the file handle which is returned refers to the standard\r |
94b17fa1 | 675 | error. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER\r |
676 | is returned.\r | |
677 | \r | |
1e6e84c7 | 678 | If the file name is 'NUL', then the file handle that is returned refers to the standard NUL\r |
94b17fa1 | 679 | file. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER is\r |
680 | returned.\r | |
681 | \r | |
682 | If return EFI_SUCCESS, the FileHandle is the opened file's handle, else, the\r | |
683 | FileHandle is NULL.\r | |
684 | \r | |
1e6e84c7 | 685 | @param[in] FileName Points to the NULL-terminated UCS-2 encoded file name.\r |
941b3569 | 686 | @param[out] FileHandle On return, points to the file handle.\r |
1e6e84c7 | 687 | @param[in] OpenMode File open mode. Either EFI_FILE_MODE_READ or\r |
688 | EFI_FILE_MODE_WRITE from section 12.4 of the UEFI\r | |
94b17fa1 | 689 | Specification.\r |
690 | @retval EFI_SUCCESS The file was opened. FileHandle has the opened file's handle.\r | |
691 | @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value. FileHandle is NULL.\r | |
692 | @retval EFI_UNSUPPORTED Could not open the file path. FileHandle is NULL.\r | |
693 | @retval EFI_NOT_FOUND The specified file could not be found on the device or the file\r | |
694 | system could not be found on the device. FileHandle is NULL.\r | |
695 | @retval EFI_NO_MEDIA The device has no medium. FileHandle is NULL.\r | |
696 | @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no\r | |
697 | longer supported. FileHandle is NULL.\r | |
698 | @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according\r | |
699 | the FileName. FileHandle is NULL.\r | |
700 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted. FileHandle is NULL.\r | |
701 | @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write\r | |
702 | when the media is write-protected. FileHandle is NULL.\r | |
703 | @retval EFI_ACCESS_DENIED The service denied access to the file. FileHandle is NULL.\r | |
704 | @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file. FileHandle\r | |
705 | is NULL.\r | |
706 | @retval EFI_VOLUME_FULL The volume is full. FileHandle is NULL.\r | |
707 | **/\r | |
708 | typedef\r | |
709 | EFI_STATUS\r | |
710 | (EFIAPI *EFI_SHELL_OPEN_FILE_BY_NAME) (\r | |
711 | IN CONST CHAR16 *FileName,\r | |
a405b86d | 712 | OUT SHELL_FILE_HANDLE *FileHandle,\r |
94b17fa1 | 713 | IN UINT64 OpenMode\r |
714 | );\r | |
715 | \r | |
716 | /**\r | |
717 | Opens the files that match the path specified.\r | |
718 | \r | |
719 | This function opens all of the files specified by Path. Wildcards are processed\r | |
1e6e84c7 | 720 | according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each\r |
94b17fa1 | 721 | matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.\r |
722 | \r | |
4ff7e37b ED |
723 | @param[in] Path A pointer to the path string.\r |
724 | @param[in] OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or\r | |
725 | EFI_FILE_MODE_WRITE.\r | |
726 | @param[in, out] FileList Points to the start of a list of files opened.\r | |
94b17fa1 | 727 | \r |
728 | @retval EFI_SUCCESS Create the file list successfully.\r | |
a31bd33c | 729 | @return Can't create the file list.\r |
94b17fa1 | 730 | **/\r |
731 | typedef\r | |
732 | EFI_STATUS\r | |
733 | (EFIAPI *EFI_SHELL_OPEN_FILE_LIST) (\r | |
734 | IN CHAR16 *Path,\r | |
735 | IN UINT64 OpenMode,\r | |
736 | IN OUT EFI_SHELL_FILE_INFO **FileList\r | |
737 | );\r | |
738 | \r | |
739 | /**\r | |
740 | Opens the root directory of a device.\r | |
741 | \r | |
742 | This function opens the root directory of a device and returns a file handle to it.\r | |
743 | \r | |
941b3569 | 744 | @param[in] DevicePath Points to the device path corresponding to the device where the\r |
94b17fa1 | 745 | EFI_SIMPLE_FILE_SYSTEM_PROTOCOL is installed.\r |
941b3569 | 746 | @param[out] FileHandle On exit, points to the file handle corresponding to the root directory on the\r |
94b17fa1 | 747 | device.\r |
748 | \r | |
749 | @retval EFI_SUCCESS Root opened successfully.\r | |
750 | @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory\r | |
751 | could not be opened.\r | |
752 | @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.\r | |
a31bd33c | 753 | @retval EFI_DEVICE_ERROR The device had an error.\r |
94b17fa1 | 754 | **/\r |
755 | typedef\r | |
756 | EFI_STATUS\r | |
757 | (EFIAPI *EFI_SHELL_OPEN_ROOT)(\r | |
758 | IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r | |
a405b86d | 759 | OUT SHELL_FILE_HANDLE *FileHandle\r |
94b17fa1 | 760 | );\r |
761 | \r | |
762 | /**\r | |
a31bd33c | 763 | Opens the root directory of a device on a handle.\r |
94b17fa1 | 764 | \r |
765 | This function opens the root directory of a device and returns a file handle to it.\r | |
766 | \r | |
941b3569 | 767 | @param[in] DeviceHandle The handle of the device that contains the volume.\r |
768 | @param[out] FileHandle On exit, points to the file handle corresponding to the root directory on the\r | |
94b17fa1 | 769 | device.\r |
770 | \r | |
771 | @retval EFI_SUCCESS Root opened successfully.\r | |
772 | @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory\r | |
773 | could not be opened.\r | |
774 | @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.\r | |
a31bd33c | 775 | @retval EFI_DEVICE_ERROR The device had an error.\r |
94b17fa1 | 776 | **/\r |
777 | typedef\r | |
778 | EFI_STATUS\r | |
779 | (EFIAPI *EFI_SHELL_OPEN_ROOT_BY_HANDLE)(\r | |
780 | IN EFI_HANDLE DeviceHandle,\r | |
a405b86d | 781 | OUT SHELL_FILE_HANDLE *FileHandle\r |
94b17fa1 | 782 | );\r |
783 | \r | |
784 | /**\r | |
785 | Reads data from the file.\r | |
786 | \r | |
787 | If FileHandle is not a directory, the function reads the requested number of bytes\r | |
788 | from the file at the file's current position and returns them in Buffer. If the read goes\r | |
789 | beyond the end of the file, the read length is truncated to the end of the file. The file's\r | |
790 | current position is increased by the number of bytes returned.\r | |
791 | If FileHandle is a directory, then an error is returned.\r | |
792 | \r | |
4ff7e37b ED |
793 | @param[in] FileHandle The opened file handle for read.\r |
794 | @param[in] ReadSize On input, the size of Buffer, in bytes. On output, the amount of data read.\r | |
795 | @param[in, out] Buffer The buffer in which data is read.\r | |
94b17fa1 | 796 | \r |
797 | @retval EFI_SUCCESS Data was read.\r | |
a31bd33c | 798 | @retval EFI_NO_MEDIA The device has no media.\r |
799 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
800 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
801 | @retval EFI_BUFFER_TO_SMALL Buffer is too small. ReadSize contains required size.\r | |
94b17fa1 | 802 | **/\r |
803 | typedef\r | |
804 | EFI_STATUS\r | |
805 | (EFIAPI *EFI_SHELL_READ_FILE) (\r | |
a405b86d | 806 | IN SHELL_FILE_HANDLE FileHandle,\r |
94b17fa1 | 807 | IN OUT UINTN *ReadSize,\r |
941b3569 | 808 | IN OUT VOID *Buffer\r |
94b17fa1 | 809 | );\r |
810 | \r | |
044ea4e5 JC |
811 | /**\r |
812 | Register a GUID and a localized human readable name for it.\r | |
813 | \r | |
814 | If Guid is not assigned a name, then assign GuidName to Guid. This list of GUID\r | |
815 | names must be used whenever a shell command outputs GUID information.\r | |
816 | \r | |
817 | This function is only available when the major and minor versions in the\r | |
818 | EfiShellProtocol are greater than or equal to 2 and 1, respectively.\r | |
819 | \r | |
820 | @param[in] Guid A pointer to the GUID being registered.\r | |
821 | @param[in] GuidName A pointer to the localized name for the GUID being registered.\r | |
822 | \r | |
823 | @retval EFI_SUCCESS The operation was successful.\r | |
824 | @retval EFI_INVALID_PARAMETER Guid was NULL.\r | |
825 | @retval EFI_INVALID_PARAMETER GuidName was NULL.\r | |
826 | @retval EFI_ACCESS_DENIED Guid already is assigned a name.\r | |
827 | **/\r | |
828 | typedef\r | |
829 | EFI_STATUS\r | |
830 | (EFIAPI *EFI_SHELL_REGISTER_GUID_NAME)(\r | |
831 | IN CONST EFI_GUID *Guid,\r | |
832 | IN CONST CHAR16 *GuidName\r | |
833 | );\r | |
834 | \r | |
94b17fa1 | 835 | /**\r |
836 | Deletes the duplicate file names files in the given file list.\r | |
837 | \r | |
941b3569 | 838 | @param[in] FileList A pointer to the first entry in the file list.\r |
94b17fa1 | 839 | \r |
840 | @retval EFI_SUCCESS Always success.\r | |
841 | **/\r | |
842 | typedef\r | |
843 | EFI_STATUS\r | |
844 | (EFIAPI *EFI_SHELL_REMOVE_DUP_IN_FILE_LIST) (\r | |
845 | IN EFI_SHELL_FILE_INFO **FileList\r | |
846 | );\r | |
847 | \r | |
848 | /**\r | |
849 | Changes a shell command alias.\r | |
850 | \r | |
851 | This function creates an alias for a shell command.\r | |
852 | \r | |
1e6e84c7 | 853 | @param[in] Command Points to the NULL-terminated shell command or existing alias.\r |
854 | @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and\r | |
94b17fa1 | 855 | Command refers to an alias, that alias will be deleted.\r |
941b3569 | 856 | @param[in] Replace If TRUE and the alias already exists, then the existing alias will be replaced. If\r |
94b17fa1 | 857 | FALSE and the alias already exists, then the existing alias is unchanged and\r |
858 | EFI_ACCESS_DENIED is returned.\r | |
1e6e84c7 | 859 | @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the\r |
941b3569 | 860 | Alias being set will be stored in a non-volatile fashion.\r |
94b17fa1 | 861 | \r |
862 | @retval EFI_SUCCESS Alias created or deleted successfully.\r | |
863 | @retval EFI_ACCESS_DENIED The alias is a built-in alias or already existed and Replace was set to\r | |
864 | FALSE.\r | |
865 | **/\r | |
866 | typedef\r | |
867 | EFI_STATUS\r | |
868 | (EFIAPI *EFI_SHELL_SET_ALIAS)(\r | |
869 | IN CONST CHAR16 *Command,\r | |
870 | IN CONST CHAR16 *Alias,\r | |
941b3569 | 871 | IN BOOLEAN Replace,\r |
872 | IN BOOLEAN Volatile\r | |
873 | );\r | |
874 | \r | |
875 | /**\r | |
369d5f2e | 876 | This function returns the command associated with a alias or a list of all\r |
877 | alias'.\r | |
941b3569 | 878 | \r |
1e6e84c7 | 879 | @param[in] Alias Points to the NULL-terminated shell alias.\r |
880 | If this parameter is NULL, then all\r | |
941b3569 | 881 | aliases will be returned in ReturnedData.\r |
a31bd33c | 882 | @param[out] Volatile Upon return of a single command if TRUE indicates\r |
369d5f2e | 883 | this is stored in a volatile fashion. FALSE otherwise.\r |
1e6e84c7 | 884 | @return If Alias is not NULL, it will return a pointer to\r |
885 | the NULL-terminated command for that alias.\r | |
886 | If Alias is NULL, ReturnedData points to a ';'\r | |
887 | delimited list of alias (e.g.\r | |
888 | ReturnedData = "dir;del;copy;mfp") that is NULL-terminated.\r | |
36a9d672 | 889 | @retval NULL An error ocurred.\r |
a31bd33c | 890 | @retval NULL Alias was not a valid Alias.\r |
941b3569 | 891 | **/\r |
1e6e84c7 | 892 | typedef\r |
ea109f6b | 893 | CONST CHAR16 *\r |
941b3569 | 894 | (EFIAPI *EFI_SHELL_GET_ALIAS)(\r |
369d5f2e | 895 | IN CONST CHAR16 *Alias,\r |
896 | OUT BOOLEAN *Volatile OPTIONAL\r | |
94b17fa1 | 897 | );\r |
898 | \r | |
899 | /**\r | |
900 | Changes the current directory on the specified device.\r | |
901 | \r | |
902 | If the FileSystem is NULL, and the directory Dir does not contain a file system's\r | |
903 | mapped name, this function changes the current working directory. If FileSystem is\r | |
904 | NULL and the directory Dir contains a mapped name, then the current file system and\r | |
905 | the current directory on that file system are changed.\r | |
906 | \r | |
907 | If FileSystem is not NULL, and Dir is NULL, then this changes the current working file\r | |
908 | system.\r | |
909 | \r | |
910 | If FileSystem is not NULL and Dir is not NULL, then this function changes the current\r | |
911 | directory on the specified file system.\r | |
912 | \r | |
913 | If the current working directory or the current working file system is changed then the\r | |
1e6e84c7 | 914 | %cwd% environment variable will be updated.\r |
94b17fa1 | 915 | \r |
941b3569 | 916 | @param[in] FileSystem A pointer to the file system's mapped name. If NULL, then the current working\r |
94b17fa1 | 917 | directory is changed.\r |
1e6e84c7 | 918 | @param[in] Dir Points to the NULL-terminated directory on the device specified by FileSystem.\r |
94b17fa1 | 919 | \r |
94b17fa1 | 920 | @retval NULL Current directory does not exist.\r |
1e6e84c7 | 921 | @return The current directory.\r |
94b17fa1 | 922 | **/\r |
923 | typedef\r | |
924 | EFI_STATUS\r | |
925 | (EFIAPI *EFI_SHELL_SET_CUR_DIR) (\r | |
926 | IN CONST CHAR16 *FileSystem OPTIONAL,\r | |
927 | IN CONST CHAR16 *Dir\r | |
928 | );\r | |
929 | \r | |
930 | /**\r | |
931 | Sets the environment variable.\r | |
932 | \r | |
933 | This function changes the current value of the specified environment variable. If the\r | |
934 | environment variable exists and the Value is an empty string, then the environment\r | |
935 | variable is deleted. If the environment variable exists and the Value is not an empty\r | |
936 | string, then the value of the environment variable is changed. If the environment\r | |
937 | variable does not exist and the Value is an empty string, there is no action. If the\r | |
938 | environment variable does not exist and the Value is a non-empty string, then the\r | |
939 | environment variable is created and assigned the specified value.\r | |
1e6e84c7 | 940 | \r |
941 | For a description of volatile and non-volatile environment variables, see UEFI Shell\r | |
94b17fa1 | 942 | 2.0 specification section 3.6.1.\r |
943 | \r | |
1e6e84c7 | 944 | @param[in] Name Points to the NULL-terminated environment variable name.\r |
945 | @param[in] Value Points to the NULL-terminated environment variable value. If the value is an\r | |
94b17fa1 | 946 | empty string then the environment variable is deleted.\r |
125c2cf4 | 947 | @param[in] Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).\r |
94b17fa1 | 948 | \r |
949 | @retval EFI_SUCCESS The environment variable was successfully updated.\r | |
950 | **/\r | |
951 | typedef\r | |
952 | EFI_STATUS\r | |
953 | (EFIAPI *EFI_SHELL_SET_ENV) (\r | |
954 | IN CONST CHAR16 *Name,\r | |
955 | IN CONST CHAR16 *Value,\r | |
956 | IN BOOLEAN Volatile\r | |
957 | );\r | |
958 | \r | |
959 | /**\r | |
960 | Sets the file information to an opened file handle.\r | |
961 | \r | |
1e6e84c7 | 962 | This function changes file information. All file information in the EFI_FILE_INFO\r |
963 | struct will be updated to the passed in data.\r | |
94b17fa1 | 964 | \r |
1e6e84c7 | 965 | @param[in] FileHandle A file handle.\r |
a31bd33c | 966 | @param[in] FileInfo Points to new file information.\r |
94b17fa1 | 967 | \r |
968 | @retval EFI_SUCCESS The information was set.\r | |
969 | @retval EFI_NO_MEDIA The device has no medium.\r | |
970 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
971 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
972 | @retval EFI_WRITE_PROTECTED The file or medium is write-protected.\r | |
973 | @retval EFI_ACCESS_DENIED The file was opened read-only.\r | |
974 | @retval EFI_VOLUME_FULL The volume is full.\r | |
975 | @retval EFI_BAD_BUFFER_SIZE BufferSize is smaller than the size of EFI_FILE_INFO.\r | |
976 | **/\r | |
977 | typedef\r | |
978 | EFI_STATUS\r | |
979 | (EFIAPI *EFI_SHELL_SET_FILE_INFO)(\r | |
a405b86d | 980 | IN SHELL_FILE_HANDLE FileHandle,\r |
94b17fa1 | 981 | IN CONST EFI_FILE_INFO *FileInfo\r |
982 | );\r | |
983 | \r | |
984 | /**\r | |
a31bd33c | 985 | Sets a file's current position.\r |
94b17fa1 | 986 | \r |
987 | This function sets the current file position for the handle to the position supplied. With\r | |
988 | the exception of seeking to position 0xFFFFFFFFFFFFFFFF, only absolute positioning is\r | |
989 | supported, and seeking past the end of the file is allowed (a subsequent write would\r | |
990 | grow the file). Seeking to position 0xFFFFFFFFFFFFFFFF causes the current position\r | |
991 | to be set to the end of the file.\r | |
992 | \r | |
a31bd33c | 993 | @param[in] FileHandle The file handle on which requested position will be set.\r |
994 | @param[in] Position Byte position from the start of the file.\r | |
94b17fa1 | 995 | \r |
996 | @retval EFI_SUCCESS Data was written.\r | |
997 | @retval EFI_UNSUPPORTED The seek request for nonzero is not valid on open directories.\r | |
998 | **/\r | |
999 | typedef\r | |
1000 | EFI_STATUS\r | |
1001 | (EFIAPI *EFI_SHELL_SET_FILE_POSITION)(\r | |
a405b86d | 1002 | IN SHELL_FILE_HANDLE FileHandle,\r |
94b17fa1 | 1003 | IN UINT64 Position\r |
1004 | );\r | |
1005 | \r | |
1006 | /**\r | |
1007 | This function creates a mapping for a device path.\r | |
1008 | \r | |
a31bd33c | 1009 | @param[in] DevicePath Points to the device path. If this is NULL and Mapping points to a valid mapping,\r |
94b17fa1 | 1010 | then the mapping will be deleted.\r |
1e6e84c7 | 1011 | @param[in] Mapping Points to the NULL-terminated mapping for the device path.\r |
94b17fa1 | 1012 | \r |
1013 | @retval EFI_SUCCESS Mapping created or deleted successfully.\r | |
1014 | @retval EFI_NO_MAPPING There is no handle that corresponds exactly to DevicePath. See the\r | |
1015 | boot service function LocateDevicePath().\r | |
1016 | @retval EFI_ACCESS_DENIED The mapping is a built-in alias.\r | |
1017 | **/\r | |
1018 | typedef\r | |
1019 | EFI_STATUS\r | |
1020 | (EFIAPI *EFI_SHELL_SET_MAP)(\r | |
1021 | IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r | |
1022 | IN CONST CHAR16 *Mapping\r | |
1023 | );\r | |
1024 | \r | |
1025 | /**\r | |
1026 | Writes data to the file.\r | |
1027 | \r | |
1028 | This function writes the specified number of bytes to the file at the current file position.\r | |
1029 | The current file position is advanced the actual number of bytes written, which is\r | |
1030 | returned in BufferSize. Partial writes only occur when there has been a data error\r | |
1031 | during the write attempt (such as "volume space full"). The file automatically grows to\r | |
1032 | hold the data, if required.\r | |
1033 | \r | |
1034 | Direct writes to opened directories are not supported.\r | |
1035 | \r | |
4ff7e37b ED |
1036 | @param[in] FileHandle The opened file handle for writing.\r |
1037 | @param[in, out] BufferSize On input, size of Buffer.\r | |
1038 | @param[in] Buffer The buffer in which data to write.\r | |
94b17fa1 | 1039 | \r |
a31bd33c | 1040 | @retval EFI_SUCCESS Data was written.\r |
1041 | @retval EFI_UNSUPPORTED Writes to open directory are not supported.\r | |
1042 | @retval EFI_NO_MEDIA The device has no media.\r | |
1043 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
1044 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
1045 | @retval EFI_WRITE_PROTECTED The device is write-protected.\r | |
1046 | @retval EFI_ACCESS_DENIED The file was open for read only.\r | |
1047 | @retval EFI_VOLUME_FULL The volume is full.\r | |
94b17fa1 | 1048 | **/\r |
1049 | typedef\r | |
1050 | EFI_STATUS\r | |
1051 | (EFIAPI *EFI_SHELL_WRITE_FILE)(\r | |
a405b86d | 1052 | IN SHELL_FILE_HANDLE FileHandle,\r |
08d7f8e8 | 1053 | IN OUT UINTN *BufferSize,\r |
1054 | IN VOID *Buffer\r | |
94b17fa1 | 1055 | );\r |
1056 | \r | |
044ea4e5 | 1057 | //\r |
838b31a6 CP |
1058 | // EFI_SHELL_PROTOCOL has been updated since UEFI Shell Spec 2.0\r |
1059 | // Usage of this protocol will require version checking before attempting\r | |
1060 | // to use any new members. There is no need to check the version for\r | |
1061 | // members that existed in UEFI Shell Spec 2.0.\r | |
1062 | //\r | |
1063 | // Update below for any future UEFI Shell spec changes to this protocol.\r | |
044ea4e5 | 1064 | //\r |
838b31a6 CP |
1065 | // Check EFI_SHELL_PROTOCOL MajorVersion and MinorVersion:\r |
1066 | // if ((2 == gEfiShellProtocol->MajorVersion) &&\r | |
1067 | // (0 == gEfiShellProtocol->MinorVersion)) {\r | |
1068 | // //\r | |
1069 | // // Cannot call:\r | |
1070 | // // RegisterGuidName - UEFI Shell 2.1\r | |
1071 | // // GetGuidName - UEFI Shell 2.1\r | |
1072 | // // GetGuidFromName - UEFI Shell 2.1\r | |
1073 | // // GetEnvEx - UEFI Shell 2.1\r | |
1074 | // //\r | |
1075 | // } else {\r | |
1076 | // //\r | |
1077 | // // Can use all members\r | |
1078 | // //\r | |
1079 | // }\r | |
1080 | //\r | |
1081 | typedef struct _EFI_SHELL_PROTOCOL {\r | |
044ea4e5 JC |
1082 | EFI_SHELL_EXECUTE Execute;\r |
1083 | EFI_SHELL_GET_ENV GetEnv;\r | |
1084 | EFI_SHELL_SET_ENV SetEnv;\r | |
1085 | EFI_SHELL_GET_ALIAS GetAlias;\r | |
1086 | EFI_SHELL_SET_ALIAS SetAlias;\r | |
1087 | EFI_SHELL_GET_HELP_TEXT GetHelpText;\r | |
1088 | EFI_SHELL_GET_DEVICE_PATH_FROM_MAP GetDevicePathFromMap;\r | |
1089 | EFI_SHELL_GET_MAP_FROM_DEVICE_PATH GetMapFromDevicePath;\r | |
1090 | EFI_SHELL_GET_DEVICE_PATH_FROM_FILE_PATH GetDevicePathFromFilePath;\r | |
1091 | EFI_SHELL_GET_FILE_PATH_FROM_DEVICE_PATH GetFilePathFromDevicePath;\r | |
1092 | EFI_SHELL_SET_MAP SetMap;\r | |
1093 | EFI_SHELL_GET_CUR_DIR GetCurDir;\r | |
1094 | EFI_SHELL_SET_CUR_DIR SetCurDir;\r | |
1095 | EFI_SHELL_OPEN_FILE_LIST OpenFileList;\r | |
1096 | EFI_SHELL_FREE_FILE_LIST FreeFileList;\r | |
1097 | EFI_SHELL_REMOVE_DUP_IN_FILE_LIST RemoveDupInFileList;\r | |
1098 | EFI_SHELL_BATCH_IS_ACTIVE BatchIsActive;\r | |
1099 | EFI_SHELL_IS_ROOT_SHELL IsRootShell;\r | |
1100 | EFI_SHELL_ENABLE_PAGE_BREAK EnablePageBreak;\r | |
1101 | EFI_SHELL_DISABLE_PAGE_BREAK DisablePageBreak;\r | |
1102 | EFI_SHELL_GET_PAGE_BREAK GetPageBreak;\r | |
1103 | EFI_SHELL_GET_DEVICE_NAME GetDeviceName;\r | |
1104 | EFI_SHELL_GET_FILE_INFO GetFileInfo;\r | |
1105 | EFI_SHELL_SET_FILE_INFO SetFileInfo;\r | |
1106 | EFI_SHELL_OPEN_FILE_BY_NAME OpenFileByName;\r | |
1107 | EFI_SHELL_CLOSE_FILE CloseFile;\r | |
1108 | EFI_SHELL_CREATE_FILE CreateFile;\r | |
1109 | EFI_SHELL_READ_FILE ReadFile;\r | |
1110 | EFI_SHELL_WRITE_FILE WriteFile;\r | |
1111 | EFI_SHELL_DELETE_FILE DeleteFile;\r | |
1112 | EFI_SHELL_DELETE_FILE_BY_NAME DeleteFileByName;\r | |
1113 | EFI_SHELL_GET_FILE_POSITION GetFilePosition;\r | |
1114 | EFI_SHELL_SET_FILE_POSITION SetFilePosition;\r | |
1115 | EFI_SHELL_FLUSH_FILE FlushFile;\r | |
1116 | EFI_SHELL_FIND_FILES FindFiles;\r | |
1117 | EFI_SHELL_FIND_FILES_IN_DIR FindFilesInDir;\r | |
1118 | EFI_SHELL_GET_FILE_SIZE GetFileSize;\r | |
1119 | EFI_SHELL_OPEN_ROOT OpenRoot;\r | |
1120 | EFI_SHELL_OPEN_ROOT_BY_HANDLE OpenRootByHandle;\r | |
1121 | EFI_EVENT ExecutionBreak;\r | |
1122 | UINT32 MajorVersion;\r | |
1123 | UINT32 MinorVersion;\r | |
1124 | // Added for Shell 2.1\r | |
838b31a6 CP |
1125 | EFI_SHELL_REGISTER_GUID_NAME RegisterGuidName;\r |
1126 | EFI_SHELL_GET_GUID_NAME GetGuidName;\r | |
1127 | EFI_SHELL_GET_GUID_FROM_NAME GetGuidFromName;\r | |
1128 | EFI_SHELL_GET_ENV_EX GetEnvEx;\r | |
1129 | } EFI_SHELL_PROTOCOL;\r | |
044ea4e5 | 1130 | \r |
94b17fa1 | 1131 | extern EFI_GUID gEfiShellProtocolGuid;\r |
1132 | \r | |
d2b4564b | 1133 | enum ShellVersion {\r |
1134 | SHELL_MAJOR_VERSION = 2,\r | |
044ea4e5 | 1135 | SHELL_MINOR_VERSION = 1\r |
d2b4564b | 1136 | };\r |
1137 | \r | |
94b17fa1 | 1138 | #endif\r |