Roll back check in r15180 which caused the shell always returns EFI_ABORTED no matter...
[mirror_edk2.git] / ShellPkg / Application / Shell / ShellProtocol.h
1 /** @file
2 Member functions of EFI_SHELL_PROTOCOL and functions for creation,
3 manipulation, and initialization of EFI_SHELL_PROTOCOL.
4
5 (C) Copyright 2014, Hewlett-Packard Development Company, L.P.
6 Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
11
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
14
15 **/
16
17 #ifndef _SHELL_PROTOCOL_HEADER_
18 #define _SHELL_PROTOCOL_HEADER_
19
20 #include "Shell.h"
21
22 typedef struct {
23 LIST_ENTRY Link;
24 EFI_SHELL_PROTOCOL *Interface;
25 EFI_HANDLE Handle;
26 } SHELL_PROTOCOL_HANDLE_LIST;
27
28 // flags values...
29 #define SHELL_MAP_FLAGS_CONSIST BIT1
30
31 /**
32 Function to create and install on the current handle.
33
34 Will overwrite any existing ShellProtocols in the system to be sure that
35 the current shell is in control.
36
37 This must be removed via calling CleanUpShellProtocol().
38
39 @param[in, out] NewShell The pointer to the pointer to the structure
40 to install.
41
42 @retval EFI_SUCCESS The operation was successful.
43 @return An error from LocateHandle, CreateEvent, or other core function.
44 **/
45 EFI_STATUS
46 EFIAPI
47 CreatePopulateInstallShellProtocol (
48 IN OUT EFI_SHELL_PROTOCOL **NewShell
49 );
50
51 /**
52 Opposite of CreatePopulateInstallShellProtocol.
53
54 Free all memory and restore the system to the state it was in before calling
55 CreatePopulateInstallShellProtocol.
56
57 @param[in, out] NewShell The pointer to the new shell protocol structure.
58
59 @retval EFI_SUCCESS The operation was successful.
60 **/
61 EFI_STATUS
62 EFIAPI
63 CleanUpShellProtocol (
64 IN OUT EFI_SHELL_PROTOCOL *NewShell
65 );
66
67 /**
68 This function creates a mapping for a device path.
69
70 @param DevicePath Points to the device path. If this is NULL and Mapping points to a valid mapping,
71 then the mapping will be deleted.
72 @param Mapping Points to the NULL-terminated mapping for the device path. Must end with a ':'
73
74 @retval EFI_SUCCESS Mapping created or deleted successfully.
75 @retval EFI_NO_MAPPING There is no handle that corresponds exactly to DevicePath. See the
76 boot service function LocateDevicePath().
77 @retval EFI_ACCESS_DENIED The mapping is a built-in alias.
78 @retval EFI_INVALID_PARAMETER Mapping was NULL
79 @retval EFI_INVALID_PARAMETER Mapping did not end with a ':'
80 @retval EFI_INVALID_PARAMETER DevicePath was not pointing at a device that had a SIMPLE_FILE_SYSTEM_PROTOCOL installed.
81 @retval EFI_NOT_FOUND There was no mapping found to delete
82 @retval EFI_OUT_OF_RESOURCES Memory allocation failed
83 **/
84 EFI_STATUS
85 EFIAPI
86 EfiShellSetMap(
87 IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath OPTIONAL,
88 IN CONST CHAR16 *Mapping
89 );
90
91 /**
92 Gets the device path from the mapping.
93
94 This function gets the device path associated with a mapping.
95
96 @param Mapping A pointer to the mapping
97
98 @retval !=NULL Pointer to the device path that corresponds to the
99 device mapping. The returned pointer does not need
100 to be freed.
101 @retval NULL There is no device path associated with the
102 specified mapping.
103 **/
104 CONST EFI_DEVICE_PATH_PROTOCOL *
105 EFIAPI
106 EfiShellGetDevicePathFromMap(
107 IN CONST CHAR16 *Mapping
108 );
109
110 /**
111 Gets the mapping that most closely matches the device path.
112
113 This function gets the mapping which corresponds to the device path *DevicePath. If
114 there is no exact match, then the mapping which most closely matches *DevicePath
115 is returned, and *DevicePath is updated to point to the remaining portion of the
116 device path. If there is an exact match, the mapping is returned and *DevicePath
117 points to the end-of-device-path node.
118
119 @param DevicePath On entry, points to a device path pointer. On
120 exit, updates the pointer to point to the
121 portion of the device path after the mapping.
122
123 @retval NULL No mapping was found.
124 @return !=NULL Pointer to NULL-terminated mapping. The buffer
125 is callee allocated and should be freed by the caller.
126 **/
127 CONST CHAR16 *
128 EFIAPI
129 EfiShellGetMapFromDevicePath(
130 IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath
131 );
132
133 /**
134 Converts a device path to a file system-style path.
135
136 This function converts a device path to a file system path by replacing part, or all, of
137 the device path with the file-system mapping. If there are more than one application
138 file system mappings, the one that most closely matches Path will be used.
139
140 @param Path The pointer to the device path
141
142 @retval NULL the device path could not be found.
143 @return all The pointer of the NULL-terminated file path. The path
144 is callee-allocated and should be freed by the caller.
145 **/
146 CHAR16 *
147 EFIAPI
148 EfiShellGetFilePathFromDevicePath(
149 IN CONST EFI_DEVICE_PATH_PROTOCOL *Path
150 );
151
152 /**
153 Converts a file system style name to a device path.
154
155 This function converts a file system style name to a device path, by replacing any
156 mapping references to the associated device path.
157
158 @param Path the pointer to the path
159
160 @return all The pointer of the file path. The file path is callee
161 allocated and should be freed by the caller.
162 **/
163 EFI_DEVICE_PATH_PROTOCOL *
164 EFIAPI
165 EfiShellGetDevicePathFromFilePath(
166 IN CONST CHAR16 *Path
167 );
168
169 /**
170 Gets the name of the device specified by the device handle.
171
172 This function gets the user-readable name of the device specified by the device
173 handle. If no user-readable name could be generated, then *BestDeviceName will be
174 NULL and EFI_NOT_FOUND will be returned.
175
176 If EFI_DEVICE_NAME_USE_COMPONENT_NAME is set, then the function will return the
177 device's name using the EFI_COMPONENT_NAME2_PROTOCOL, if present on
178 DeviceHandle.
179
180 If EFI_DEVICE_NAME_USE_DEVICE_PATH is set, then the function will return the
181 device's name using the EFI_DEVICE_PATH_PROTOCOL, if present on DeviceHandle.
182 If both EFI_DEVICE_NAME_USE_COMPONENT_NAME and
183 EFI_DEVICE_NAME_USE_DEVICE_PATH are set, then
184 EFI_DEVICE_NAME_USE_COMPONENT_NAME will have higher priority.
185
186 @param DeviceHandle The handle of the device.
187 @param Flags Determines the possible sources of component names.
188 Valid bits are:
189 EFI_DEVICE_NAME_USE_COMPONENT_NAME
190 EFI_DEVICE_NAME_USE_DEVICE_PATH
191 @param Language A pointer to the language specified for the device
192 name, in the same format as described in the UEFI
193 specification, Appendix M
194 @param BestDeviceName On return, points to the callee-allocated NULL-
195 terminated name of the device. If no device name
196 could be found, points to NULL. The name must be
197 freed by the caller...
198
199 @retval EFI_SUCCESS Get the name successfully.
200 @retval EFI_NOT_FOUND Fail to get the device name.
201 @retval EFI_INVALID_PARAMETER Flags did not have a valid bit set.
202 @retval EFI_INVALID_PARAMETER BestDeviceName was NULL
203 @retval EFI_INVALID_PARAMETER DeviceHandle was NULL
204 **/
205 EFI_STATUS
206 EFIAPI
207 EfiShellGetDeviceName(
208 IN EFI_HANDLE DeviceHandle,
209 IN EFI_SHELL_DEVICE_NAME_FLAGS Flags,
210 IN CHAR8 *Language,
211 OUT CHAR16 **BestDeviceName
212 );
213
214 /**
215 Opens the root directory of a device on a handle
216
217 This function opens the root directory of a device and returns a file handle to it.
218
219 @param DeviceHandle The handle of the device that contains the volume.
220 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
221 device.
222
223 @retval EFI_SUCCESS Root opened successfully.
224 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
225 could not be opened.
226 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
227 @retval EFI_DEVICE_ERROR The device had an error
228 **/
229 EFI_STATUS
230 EFIAPI
231 EfiShellOpenRootByHandle(
232 IN EFI_HANDLE DeviceHandle,
233 OUT SHELL_FILE_HANDLE *FileHandle
234 );
235
236 /**
237 Opens the root directory of a device.
238
239 This function opens the root directory of a device and returns a file handle to it.
240
241 @param DevicePath Points to the device path corresponding to the device where the
242 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL is installed.
243 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
244 device.
245
246 @retval EFI_SUCCESS Root opened successfully.
247 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
248 could not be opened.
249 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
250 @retval EFI_DEVICE_ERROR The device had an error
251 **/
252 EFI_STATUS
253 EFIAPI
254 EfiShellOpenRoot(
255 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,
256 OUT SHELL_FILE_HANDLE *FileHandle
257 );
258
259 /**
260 Returns whether any script files are currently being processed.
261
262 @retval TRUE There is at least one script file active.
263 @retval FALSE No script files are active now.
264
265 **/
266 BOOLEAN
267 EFIAPI
268 EfiShellBatchIsActive (
269 VOID
270 );
271
272 /**
273 Worker function to open a file based on a device path. this will open the root
274 of the volume and then traverse down to the file itself.
275
276 @param DevicePath2 Device Path of the file
277 @param FileHandle Pointer to the file upon a successful return
278 @param OpenMode mode to open file in.
279 @param Attributes the File Attributes to use when creating a new file
280
281 @retval EFI_SUCCESS the file is open and FileHandle is valid
282 @retval EFI_UNSUPPORTED the device path cotained non-path elements
283 @retval other an error ocurred.
284 **/
285 EFI_STATUS
286 EFIAPI
287 InternalOpenFileDevicePath(
288 IN OUT EFI_DEVICE_PATH_PROTOCOL *DevicePath2,
289 OUT SHELL_FILE_HANDLE *FileHandle,
290 IN UINT64 OpenMode,
291 IN UINT64 Attributes OPTIONAL
292 );
293
294 /**
295 Creates a file or directory by name.
296
297 This function creates an empty new file or directory with the specified attributes and
298 returns the new file's handle. If the file already exists and is read-only, then
299 EFI_INVALID_PARAMETER will be returned.
300
301 If the file already existed, it is truncated and its attributes updated. If the file is
302 created successfully, the FileHandle is the file's handle, else, the FileHandle is NULL.
303
304 If the file name begins with >v, then the file handle which is returned refers to the
305 shell environment variable with the specified name. If the shell environment variable
306 already exists and is non-volatile then EFI_INVALID_PARAMETER is returned.
307
308 @param FileName Pointer to NULL-terminated file path
309 @param FileAttribs The new file's attrbiutes. the different attributes are
310 described in EFI_FILE_PROTOCOL.Open().
311 @param FileHandle On return, points to the created file handle or directory's handle
312
313 @retval EFI_SUCCESS The file was opened. FileHandle points to the new file's handle.
314 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
315 @retval EFI_UNSUPPORTED could not open the file path
316 @retval EFI_NOT_FOUND the specified file could not be found on the devide, or could not
317 file the file system on the device.
318 @retval EFI_NO_MEDIA the device has no medium.
319 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
320 longer supported.
321 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
322 the DirName.
323 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
324 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
325 when the media is write-protected.
326 @retval EFI_ACCESS_DENIED The service denied access to the file.
327 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file.
328 @retval EFI_VOLUME_FULL The volume is full.
329 **/
330 EFI_STATUS
331 EFIAPI
332 EfiShellCreateFile(
333 IN CONST CHAR16 *FileName,
334 IN UINT64 FileAttribs,
335 OUT SHELL_FILE_HANDLE *FileHandle
336 );
337
338 /**
339 Opens a file or a directory by file name.
340
341 This function opens the specified file in the specified OpenMode and returns a file
342 handle.
343 If the file name begins with >v, then the file handle which is returned refers to the
344 shell environment variable with the specified name. If the shell environment variable
345 exists, is non-volatile and the OpenMode indicates EFI_FILE_MODE_WRITE, then
346 EFI_INVALID_PARAMETER is returned.
347
348 If the file name is >i, then the file handle which is returned refers to the standard
349 input. If the OpenMode indicates EFI_FILE_MODE_WRITE, then EFI_INVALID_PARAMETER
350 is returned.
351
352 If the file name is >o, then the file handle which is returned refers to the standard
353 output. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
354 is returned.
355
356 If the file name is >e, then the file handle which is returned refers to the standard
357 error. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
358 is returned.
359
360 If the file name is NUL, then the file handle that is returned refers to the standard NUL
361 file. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER is
362 returned.
363
364 If return EFI_SUCCESS, the FileHandle is the opened file's handle, else, the
365 FileHandle is NULL.
366
367 @param FileName Points to the NULL-terminated UCS-2 encoded file name.
368 @param FileHandle On return, points to the file handle.
369 @param OpenMode File open mode. Either EFI_FILE_MODE_READ or
370 EFI_FILE_MODE_WRITE from section 12.4 of the UEFI
371 Specification.
372 @retval EFI_SUCCESS The file was opened. FileHandle has the opened file's handle.
373 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value. FileHandle is NULL.
374 @retval EFI_UNSUPPORTED Could not open the file path. FileHandle is NULL.
375 @retval EFI_NOT_FOUND The specified file could not be found on the device or the file
376 system could not be found on the device. FileHandle is NULL.
377 @retval EFI_NO_MEDIA The device has no medium. FileHandle is NULL.
378 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
379 longer supported. FileHandle is NULL.
380 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
381 the FileName. FileHandle is NULL.
382 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted. FileHandle is NULL.
383 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
384 when the media is write-protected. FileHandle is NULL.
385 @retval EFI_ACCESS_DENIED The service denied access to the file. FileHandle is NULL.
386 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file. FileHandle
387 is NULL.
388 @retval EFI_VOLUME_FULL The volume is full. FileHandle is NULL.
389 **/
390 EFI_STATUS
391 EFIAPI
392 EfiShellOpenFileByName(
393 IN CONST CHAR16 *FileName,
394 OUT SHELL_FILE_HANDLE *FileHandle,
395 IN UINT64 OpenMode
396 );
397
398 /**
399 Deletes the file specified by the file name.
400
401 This function deletes a file.
402
403 @param FileName Points to the NULL-terminated file name.
404
405 @retval EFI_SUCCESS The file was closed and deleted, and the handle was closed.
406 @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.
407 @sa EfiShellCreateFile
408 @sa FileHandleDelete
409 **/
410 EFI_STATUS
411 EFIAPI
412 EfiShellDeleteFileByName(
413 IN CONST CHAR16 *FileName
414 );
415
416 /**
417 Disables the page break output mode.
418 **/
419 VOID
420 EFIAPI
421 EfiShellDisablePageBreak (
422 VOID
423 );
424
425 /**
426 Enables the page break output mode.
427 **/
428 VOID
429 EFIAPI
430 EfiShellEnablePageBreak (
431 VOID
432 );
433
434 /**
435 internal worker function to run a command via Device Path
436
437 @param ParentImageHandle A handle of the image that is executing the specified
438 command line.
439 @param DevicePath device path of the file to execute
440 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
441 containing the command line. If NULL then the command-
442 line will be empty.
443 @param Environment Points to a NULL-terminated array of environment
444 variables with the format 'x=y', where x is the
445 environment variable name and y is the value. If this
446 is NULL, then the current shell environment is used.
447 @param[out] StartImageStatus Returned status from gBS->StartImage.
448
449 @retval EFI_SUCCESS The command executed successfully. The status code
450 returned by the command is pointed to by StatusCode.
451 @retval EFI_INVALID_PARAMETER The parameters are invalid.
452 @retval EFI_OUT_OF_RESOURCES Out of resources.
453 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
454 **/
455 EFI_STATUS
456 EFIAPI
457 InternalShellExecuteDevicePath(
458 IN CONST EFI_HANDLE *ParentImageHandle,
459 IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,
460 IN CONST CHAR16 *CommandLine OPTIONAL,
461 IN CONST CHAR16 **Environment OPTIONAL,
462 OUT EFI_STATUS *StartImageStatus OPTIONAL
463 );
464
465 /**
466 Execute the command line.
467
468 This function creates a nested instance of the shell and executes the specified
469 command (CommandLine) with the specified environment (Environment). Upon return,
470 the status code returned by the specified command is placed in StatusCode.
471
472 If Environment is NULL, then the current environment is used and all changes made
473 by the commands executed will be reflected in the current environment. If the
474 Environment is non-NULL, then the changes made will be discarded.
475
476 The CommandLine is executed from the current working directory on the current
477 device.
478
479 @param ParentImageHandle A handle of the image that is executing the specified
480 command line.
481 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
482 containing the command line. If NULL then the command-
483 line will be empty.
484 @param Environment Points to a NULL-terminated array of environment
485 variables with the format 'x=y', where x is the
486 environment variable name and y is the value. If this
487 is NULL, then the current shell environment is used.
488 @param StatusCode Points to the status code returned by the command.
489
490 @retval EFI_SUCCESS The command executed successfully. The status code
491 returned by the command is pointed to by StatusCode.
492 @retval EFI_INVALID_PARAMETER The parameters are invalid.
493 @retval EFI_OUT_OF_RESOURCES Out of resources.
494 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
495 **/
496 EFI_STATUS
497 EFIAPI
498 EfiShellExecute(
499 IN EFI_HANDLE *ParentImageHandle,
500 IN CHAR16 *CommandLine OPTIONAL,
501 IN CHAR16 **Environment OPTIONAL,
502 OUT EFI_STATUS *StatusCode OPTIONAL
503 );
504
505 /**
506 Utility cleanup function for EFI_SHELL_FILE_INFO objects.
507
508 1) frees all pointers (non-NULL)
509 2) Closes the SHELL_FILE_HANDLE
510
511 @param FileListNode pointer to the list node to free
512 **/
513 VOID
514 EFIAPI
515 FreeShellFileInfoNode(
516 IN EFI_SHELL_FILE_INFO *FileListNode
517 );
518
519 /**
520 Frees the file list.
521
522 This function cleans up the file list and any related data structures. It has no
523 impact on the files themselves.
524
525 @param FileList The file list to free. Type EFI_SHELL_FILE_INFO is
526 defined in OpenFileList()
527
528 @retval EFI_SUCCESS Free the file list successfully.
529 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
530 **/
531 EFI_STATUS
532 EFIAPI
533 EfiShellFreeFileList(
534 IN EFI_SHELL_FILE_INFO **FileList
535 );
536
537 /**
538 Deletes the duplicate file names files in the given file list.
539
540 This function deletes the reduplicate files in the given file list.
541
542 @param FileList A pointer to the first entry in the file list.
543
544 @retval EFI_SUCCESS Always success.
545 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
546 **/
547 EFI_STATUS
548 EFIAPI
549 EfiShellRemoveDupInFileList(
550 IN EFI_SHELL_FILE_INFO **FileList
551 );
552
553 /**
554 Allocates and populates a EFI_SHELL_FILE_INFO structure. if any memory operation
555 failed it will return NULL.
556
557 @param[in] BasePath the Path to prepend onto filename for FullPath
558 @param[in] Status Status member initial value.
559 @param[in] FileName FileName member initial value.
560 @param[in] Handle Handle member initial value.
561 @param[in] Info Info struct to copy.
562
563 **/
564 EFI_SHELL_FILE_INFO *
565 EFIAPI
566 CreateAndPopulateShellFileInfo(
567 IN CONST CHAR16 *BasePath,
568 IN CONST EFI_STATUS Status,
569 IN CONST CHAR16 *FileName,
570 IN CONST SHELL_FILE_HANDLE Handle,
571 IN CONST EFI_FILE_INFO *Info
572 );
573
574 /**
575 Find all files in a specified directory.
576
577 @param FileDirHandle Handle of the directory to search.
578 @param FileList On return, points to the list of files in the directory
579 or NULL if there are no files in the directory.
580
581 @retval EFI_SUCCESS File information was returned successfully.
582 @retval EFI_VOLUME_CORRUPTED The file system structures have been corrupted.
583 @retval EFI_DEVICE_ERROR The device reported an error.
584 @retval EFI_NO_MEDIA The device media is not present.
585 @retval EFI_INVALID_PARAMETER The FileDirHandle was not a directory.
586 **/
587 EFI_STATUS
588 EFIAPI
589 EfiShellFindFilesInDir(
590 IN SHELL_FILE_HANDLE FileDirHandle,
591 OUT EFI_SHELL_FILE_INFO **FileList
592 );
593
594 /**
595 Find files that match a specified pattern.
596
597 This function searches for all files and directories that match the specified
598 FilePattern. The FilePattern can contain wild-card characters. The resulting file
599 information is placed in the file list FileList.
600
601 Wildcards are processed
602 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1.
603
604 The files in the file list are not opened. The OpenMode field is set to 0 and the FileInfo
605 field is set to NULL.
606
607 if *FileList is not NULL then it must be a pre-existing and properly initialized list.
608
609 @param FilePattern Points to a NULL-terminated shell file path, including wildcards.
610 @param FileList On return, points to the start of a file list containing the names
611 of all matching files or else points to NULL if no matching files
612 were found. only on a EFI_SUCCESS return will; this be non-NULL.
613
614 @retval EFI_SUCCESS Files found. FileList is a valid list.
615 @retval EFI_NOT_FOUND No files found.
616 @retval EFI_NO_MEDIA The device has no media
617 @retval EFI_DEVICE_ERROR The device reported an error
618 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
619 **/
620 EFI_STATUS
621 EFIAPI
622 EfiShellFindFiles(
623 IN CONST CHAR16 *FilePattern,
624 OUT EFI_SHELL_FILE_INFO **FileList
625 );
626
627 /**
628 Opens the files that match the path specified.
629
630 This function opens all of the files specified by Path. Wildcards are processed
631 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each
632 matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.
633
634 @param Path A pointer to the path string.
635 @param OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or
636 EFI_FILE_MODE_WRITE.
637 @param FileList Points to the start of a list of files opened.
638
639 @retval EFI_SUCCESS Create the file list successfully.
640 @return Others Can't create the file list.
641 **/
642 EFI_STATUS
643 EFIAPI
644 EfiShellOpenFileList(
645 IN CHAR16 *Path,
646 IN UINT64 OpenMode,
647 IN OUT EFI_SHELL_FILE_INFO **FileList
648 );
649
650 /**
651 Gets the environment variable.
652
653 This function returns the current value of the specified environment variable.
654
655 @param Name A pointer to the environment variable name
656
657 @retval !=NULL The environment variable's value. The returned
658 pointer does not need to be freed by the caller.
659 @retval NULL The environment variable doesn't exist.
660 **/
661 CONST CHAR16 *
662 EFIAPI
663 EfiShellGetEnv(
664 IN CONST CHAR16 *Name
665 );
666
667 /**
668 Sets the environment variable.
669
670 This function changes the current value of the specified environment variable. If the
671 environment variable exists and the Value is an empty string, then the environment
672 variable is deleted. If the environment variable exists and the Value is not an empty
673 string, then the value of the environment variable is changed. If the environment
674 variable does not exist and the Value is an empty string, there is no action. If the
675 environment variable does not exist and the Value is a non-empty string, then the
676 environment variable is created and assigned the specified value.
677
678 For a description of volatile and non-volatile environment variables, see UEFI Shell
679 2.0 specification section 3.6.1.
680
681 @param Name Points to the NULL-terminated environment variable name.
682 @param Value Points to the NULL-terminated environment variable value. If the value is an
683 empty string then the environment variable is deleted.
684 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
685
686 @retval EFI_SUCCESS The environment variable was successfully updated.
687 **/
688 EFI_STATUS
689 EFIAPI
690 EfiShellSetEnv(
691 IN CONST CHAR16 *Name,
692 IN CONST CHAR16 *Value,
693 IN BOOLEAN Volatile
694 );
695
696 /**
697 Returns the current directory on the specified device.
698
699 If FileSystemMapping is NULL, it returns the current working directory. If the
700 FileSystemMapping is not NULL, it returns the current directory associated with the
701 FileSystemMapping. In both cases, the returned name includes the file system
702 mapping (i.e. fs0:\current-dir).
703
704 @param FileSystemMapping A pointer to the file system mapping. If NULL,
705 then the current working directory is returned.
706
707 @retval !=NULL The current directory.
708 @retval NULL Current directory does not exist.
709 **/
710 CONST CHAR16 *
711 EFIAPI
712 EfiShellGetCurDir(
713 IN CONST CHAR16 *FileSystemMapping OPTIONAL
714 );
715
716 /**
717 Changes the current directory on the specified device.
718
719 If the FileSystem is NULL, and the directory Dir does not contain a file system's
720 mapped name, this function changes the current working directory. If FileSystem is
721 NULL and the directory Dir contains a mapped name, then the current file system and
722 the current directory on that file system are changed.
723
724 If FileSystem is not NULL, and Dir is NULL, then this changes the current working file
725 system.
726
727 If FileSystem is not NULL and Dir is not NULL, then this function changes the current
728 directory on the specified file system.
729
730 If the current working directory or the current working file system is changed then the
731 %cwd% environment variable will be updated
732
733 @param FileSystem A pointer to the file system's mapped name. If NULL, then the current working
734 directory is changed.
735 @param Dir Points to the NULL-terminated directory on the device specified by FileSystem.
736
737 @retval EFI_SUCCESS The operation was sucessful
738 **/
739 EFI_STATUS
740 EFIAPI
741 EfiShellSetCurDir(
742 IN CONST CHAR16 *FileSystem OPTIONAL,
743 IN CONST CHAR16 *Dir
744 );
745
746 /**
747 Return help information about a specific command.
748
749 This function returns the help information for the specified command. The help text
750 can be internal to the shell or can be from a UEFI Shell manual page.
751
752 If Sections is specified, then each section name listed will be compared in a casesensitive
753 manner, to the section names described in Appendix B. If the section exists,
754 it will be appended to the returned help text. If the section does not exist, no
755 information will be returned. If Sections is NULL, then all help text information
756 available will be returned.
757
758 @param Command Points to the NULL-terminated UEFI Shell command name.
759 @param Sections Points to the NULL-terminated comma-delimited
760 section names to return. If NULL, then all
761 sections will be returned.
762 @param HelpText On return, points to a callee-allocated buffer
763 containing all specified help text.
764
765 @retval EFI_SUCCESS The help text was returned.
766 @retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the
767 returned help text.
768 @retval EFI_INVALID_PARAMETER HelpText is NULL
769 @retval EFI_NOT_FOUND There is no help text available for Command.
770 **/
771 EFI_STATUS
772 EFIAPI
773 EfiShellGetHelpText(
774 IN CONST CHAR16 *Command,
775 IN CONST CHAR16 *Sections OPTIONAL,
776 OUT CHAR16 **HelpText
777 );
778
779 /**
780 Gets the enable status of the page break output mode.
781
782 User can use this function to determine current page break mode.
783
784 @retval TRUE The page break output mode is enabled
785 @retval FALSE The page break output mode is disabled
786 **/
787 BOOLEAN
788 EFIAPI
789 EfiShellGetPageBreak(
790 VOID
791 );
792
793 /**
794 Judges whether the active shell is the root shell.
795
796 This function makes the user to know that whether the active Shell is the root shell.
797
798 @retval TRUE The active Shell is the root Shell.
799 @retval FALSE The active Shell is NOT the root Shell.
800 **/
801 BOOLEAN
802 EFIAPI
803 EfiShellIsRootShell(
804 VOID
805 );
806
807 /**
808 This function returns the command associated with a alias or a list of all
809 alias'.
810
811 @param[in] Command Points to the NULL-terminated shell alias.
812 If this parameter is NULL, then all
813 aliases will be returned in ReturnedData.
814 @param[out] Volatile upon return of a single command if TRUE indicates
815 this is stored in a volatile fashion. FALSE otherwise.
816 @return If Alias is not NULL, it will return a pointer to
817 the NULL-terminated command for that alias.
818 If Alias is NULL, ReturnedData points to a ';'
819 delimited list of alias (e.g.
820 ReturnedData = "dir;del;copy;mfp") that is NULL-terminated.
821 @retval NULL an error ocurred
822 @retval NULL Alias was not a valid Alias
823 **/
824 CONST CHAR16 *
825 EFIAPI
826 EfiShellGetAlias(
827 IN CONST CHAR16 *Command,
828 OUT BOOLEAN *Volatile OPTIONAL
829 );
830
831 /**
832 Changes a shell command alias.
833
834 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
835
836 this function does not check for built in alias'.
837
838 @param[in] Command Points to the NULL-terminated shell command or existing alias.
839 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
840 Command refers to an alias, that alias will be deleted.
841 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
842 Alias being set will be stored in a non-volatile fashion.
843
844 @retval EFI_SUCCESS Alias created or deleted successfully.
845 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
846 **/
847 EFI_STATUS
848 EFIAPI
849 InternalSetAlias(
850 IN CONST CHAR16 *Command,
851 IN CONST CHAR16 *Alias OPTIONAL,
852 IN BOOLEAN Volatile
853 );
854
855 /**
856 Changes a shell command alias.
857
858 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
859
860
861 @param[in] Command Points to the NULL-terminated shell command or existing alias.
862 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
863 Command refers to an alias, that alias will be deleted.
864 @param[in] Replace If TRUE and the alias already exists, then the existing alias will be replaced. If
865 FALSE and the alias already exists, then the existing alias is unchanged and
866 EFI_ACCESS_DENIED is returned.
867 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
868 Alias being set will be stored in a non-volatile fashion.
869
870 @retval EFI_SUCCESS Alias created or deleted successfully.
871 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
872 @retval EFI_ACCESS_DENIED The alias is a built-in alias or already existed and Replace was set to
873 FALSE.
874 **/
875 EFI_STATUS
876 EFIAPI
877 EfiShellSetAlias(
878 IN CONST CHAR16 *Command,
879 IN CONST CHAR16 *Alias OPTIONAL,
880 IN BOOLEAN Replace,
881 IN BOOLEAN Volatile
882 );
883
884 /**
885 Utility cleanup function for EFI_SHELL_FILE_INFO objects.
886
887 1) frees all pointers (non-NULL)
888 2) Closes the SHELL_FILE_HANDLE
889
890 @param FileListNode pointer to the list node to free
891 **/
892 VOID
893 EFIAPI
894 InternalFreeShellFileInfoNode(
895 IN EFI_SHELL_FILE_INFO *FileListNode
896 );
897
898 /**
899 Internal variable setting function. Allows for setting of the read only variables.
900
901 @param Name Points to the NULL-terminated environment variable name.
902 @param Value Points to the NULL-terminated environment variable value. If the value is an
903 empty string then the environment variable is deleted.
904 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
905
906 @retval EFI_SUCCESS The environment variable was successfully updated.
907 **/
908 EFI_STATUS
909 EFIAPI
910 InternalEfiShellSetEnv(
911 IN CONST CHAR16 *Name,
912 IN CONST CHAR16 *Value,
913 IN BOOLEAN Volatile
914 );
915
916 /**
917 Function to start monitoring for CTRL-C using SimpleTextInputEx. This
918 feature's enabled state was not known when the shell initially launched.
919
920 @retval EFI_SUCCESS The feature is enabled.
921 @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available.
922 **/
923 EFI_STATUS
924 EFIAPI
925 InernalEfiShellStartMonitor(
926 VOID
927 );
928
929 /**
930 Notification function for keystrokes.
931
932 @param[in] KeyData The key that was pressed.
933
934 @retval EFI_SUCCESS The operation was successful.
935 **/
936 EFI_STATUS
937 EFIAPI
938 NotificationFunction(
939 IN EFI_KEY_DATA *KeyData
940 );
941 #endif //_SHELL_PROTOCOL_HEADER_
942