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