2 Defines for EFI shell environment 2 ported to EDK II build environment. (no spec)
4 Copyright (c) 2005 - 2010, Intel Corporation<BR>
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
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.
16 #if !defined (_SHELL_ENVIRONMENT_2_PROTOCOL_H_)
17 #define _SHELL_ENVIRONMENT_2_PROTOCOL_H_
19 #define DEFAULT_INIT_ROW 1
20 #define DEFAULT_AUTO_LF FALSE
23 This function is a prototype for a function that dumps information on a protocol
24 to a given location. The location is dependant on the implementation. This is
25 used when programatically adding shell commands.
27 @param Handle The handle the protocol is on.
28 @param Interface The interface to the protocol.
33 (EFIAPI
*SHELLENV_DUMP_PROTOCOL_INFO
) (
39 This function is a prototype for each command internal to the EFI shell
40 implementation. The specific command depends on the implementation. This is
41 used when programatically adding shell commands.
43 @param ImageHandle The handle to the binary shell.
44 @param SystemTable Pointer to the system table.
46 @retval EFI_SUCCESS The command ran to completion
47 @retval other An error ocurred. Any error is possible
48 depending on the implementation of the shell
54 (EFIAPI
*SHELLENV_INTERNAL_COMMAND
) (
55 IN EFI_HANDLE ImageHandle
,
56 IN EFI_SYSTEM_TABLE
*SystemTable
60 This function is a prototype for one that gets a help string for a given command.
61 This is used when programatically adding shell commands. Upon successful return
62 the memory allocated is up to the caller to free.
64 @param Str Pointer to pointer to string to display for help.
66 @retval EFI_SUCCESS The help string is in the parameter Str.
71 (EFIAPI
*SHELLCMD_GET_LINE_HELP
) (
76 Structure returned from functions that open multiple files.
79 UINT32 Signature
; ///< SHELL_FILE_ARG_SIGNATURE
80 LIST_ENTRY Link
; ///< Linked list helper
81 EFI_STATUS Status
; ///< File's status
83 EFI_FILE_HANDLE Parent
; ///< What is the Parent file of this file
84 UINT64 OpenMode
; ///< How was the file opened
85 CHAR16
*ParentName
; ///< String representation of parent
86 EFI_DEVICE_PATH_PROTOCOL
*ParentDevicePath
; ///< DevicePath for Parent
88 CHAR16
*FullName
; ///< Path and file name for this file
89 CHAR16
*FileName
; ///< File name for this file
91 EFI_FILE_HANDLE Handle
; ///< Handle to this file
92 EFI_FILE_INFO
*Info
; ///< Pointer to file info for this file
95 /// Signature for SHELL_FILE_ARG
96 #define SHELL_FILE_ARG_SIGNATURE SIGNATURE_32 ('g', 'r', 'a', 'f')
99 GUID for the shell environment2 and shell environment.
101 #define SHELL_ENVIRONMENT_PROTOCOL_GUID \
103 0x47c7b221, 0xc42a, 0x11d2, {0x8e, 0x57, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b} \
107 GUID for the shell environment2 extension (main GUID above).
109 #define EFI_SE_EXT_SIGNATURE_GUID \
111 0xd2c18636, 0x40e5, 0x4eb5, {0xa3, 0x1b, 0x36, 0x69, 0x5f, 0xd4, 0x2c, 0x87} \
114 #define EFI_SHELL_MAJOR_VER 0x00000001 ///< Major version of the EFI_SHELL_ENVIRONMENT2
115 #define EFI_SHELL_MINOR_VER 0x00000000 ///< Minor version of the EFI_SHELL_ENVIRONMENT2
118 Execute a command line
120 This function will run the CommandLine. This includes loading any required images,
121 parsing any requires scripts, and it DebugOutput is TRUE printing errors
122 encountered directly to the screen.
124 @param ParentImageHandle Handle of image executing this operation.
125 @param CommandLine The string command line to execute.
126 @param DebugOutput TRUE indicates that errors should be printed directly.
127 FALSE supresses error messages.
129 @retval EFI_SUCCESS The command line executed and completed.
130 @retval EFI_ABORTED The operation did not complete due to abort.
131 @retval EFI_INVALID_PARAMETER A parameter did not have a valid value.
132 @retval EFI_OUT_OF_RESOURCES A required memory allocation failed.
138 (EFIAPI
*SHELLENV_EXECUTE
) (
139 IN EFI_HANDLE
*ParentImageHandle
,
140 IN CHAR16
*CommandLine
,
141 IN BOOLEAN DebugOutput
145 This function returns a shell environment variable value.
147 @param Name Pointer to the string with the shell environment
150 @retval NULL The shell environment variable's value could not be found.
151 @retval !NULL The value of the shell environment variable Name.
156 (EFIAPI
*SHELLENV_GET_ENV
) (
161 This function returns a shell environment map value.
163 @param Name Pointer to the string with the shell environment
166 @retval NULL The shell environment map's value could not be found.
167 @retval !NULL The value of the shell environment map Name.
172 (EFIAPI
*SHELLENV_GET_MAP
) (
177 This function will add an internal command to the shell interface.
179 This will allocate all required memory, put the new command on the command
180 list in the correct location.
182 @param Handler The handler function to call when the command gets called.
183 @param CmdStr The command name.
184 @param GetLineHelp Function to call of get help for this command.
186 @retval EFI_SUCCESS The command is now part of the command list.
187 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
188 @sa SHELLENV_INTERNAL_COMMAND
189 @sa SHELLCMD_GET_LINE_HELP
193 (EFIAPI
*SHELLENV_ADD_CMD
) (
194 IN SHELLENV_INTERNAL_COMMAND Handler
,
196 IN SHELLCMD_GET_LINE_HELP GetLineHelp
200 Internal interface to add protocol handlers.
202 This function is for internal shell use only. This is how protocol handlers are added.
203 This will get the current protocol info and add the new info or update existing info
204 and then resave the info.
206 @param SaveId Save this change as an EFI variable.
207 @param Protocol The protocol's GUID.
208 @param DumpToken The function pointer to dump token function or
210 @param DumpInfo The function pointer to dump infomation function
212 @param IdString The english name of the protocol.
216 (EFIAPI
*SHELLENV_ADD_PROT
) (
217 IN EFI_GUID
*Protocol
,
218 IN SHELLENV_DUMP_PROTOCOL_INFO DumpToken OPTIONAL
,
219 IN SHELLENV_DUMP_PROTOCOL_INFO DumpInfo OPTIONAL
,
224 This function finds a protocol handle by a GUID.
226 This function will check for already known protocols by GUID and if one is
227 found it will return the name of that protocol. If no name is found and
228 GenId is TRUE it will generate ths string.
230 @param Protocol The GUID of the protocol to look for.
231 @param GenId Whether to generate a name string if its not found.
233 @return !NULL The Name of the protocol.
234 @retval NULL The Name was not found and GenId was not TRUE.
238 (EFIAPI
*SHELLENV_GET_PROT
) (
239 IN EFI_GUID
*Protocol
,
244 This function returns the current directory on a given device.
246 If DeviceName is specified, then return the current shell directory on that
247 device. If DeviceName is NULL, then return the current directory on the
248 current device. The caller us responsible to free the returned string when
251 @param DeviceName The name of the device to get the current
252 directory on or NULL for current device.
254 @return The current directory on the current or specified device.
259 (EFIAPI
*SHELLENV_CUR_DIR
) (
260 IN CHAR16
*DeviceName OPTIONAL
264 This function will open a group of files that match the Arg path, including
265 support for wildcard characters ('?' and '*') in the Arg path. If there are
266 any wildcard characters in the path this function will find any and all files
267 that match the wildcards. The return is a double linked list based on the
268 LIST_ENTRY linked list structure. Use this in conjunction with the
269 SHELL_FILE_ARG_SIGNATURE to get the SHELL_FILE_ARG structures that are returned.
270 The memory allocated by the callee for this list is freed by making a call to
271 SHELLENV_FREE_FILE_LIST.
273 @param Arg Pointer Path to files to open.
274 @param ListHead Pointer to allocated and initialized list head
275 upon which to append all the opened file structures.
277 @retval EFI_SUCCESS 1 or more files was opened and a struct of each file's
278 information was appended to ListHead.
279 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
280 @retval EFI_NOT_FOUND No matching files could be found.
281 @sa SHELLENV_FREE_FILE_LIST
284 (EFIAPI
*SHELLENV_FILE_META_ARG
) (
286 IN OUT LIST_ENTRY
*ListHead
290 This frees all of the nodes under the ListHead, but not ListHead itself.
292 @param ListHead Pointer to list to free all nodes of.
294 @retval EFI_SUCCESS always returned.
298 (EFIAPI
*SHELLENV_FREE_FILE_LIST
) (
299 IN OUT LIST_ENTRY
*ListHead
303 This function creates a new instance of the ShellInterface protocol for use on
306 This function is for internal shell usage. This will allocate and then populate
307 EFI_SHELL_INTERFACE protocol. It is the caller's responsibility to free the
310 @param ImageHandle The handle which will use the new ShellInterface
313 @return the newly allocated shell interface protocol.
318 (EFIAPI
*SHELLENV_NEW_SHELL
) (
319 IN EFI_HANDLE ImageHandle
323 This function determins whether a script file is currently being processed.
325 A script file (.nsh file) can contain a series of commands and this is useful to
326 know for some shell commands whether they are being run manually or as part of a
329 @retval TRUE A script file is being processed.
330 @retval FALSE A script file is not being processed.
334 (EFIAPI
*SHELLENV_BATCH_IS_ACTIVE
) (
339 This is an internal shell function to free any and all allocated resources.
340 This should be called just closing the shell.
344 (EFIAPI
*SHELLENV_FREE_RESOURCES
) (
349 This function enables the page break mode.
351 This mode causes the output to pause after each complete screen to enable a
352 user to more easily read it. If AutoWrap is TRUE then rows with too many
353 characters will be chopped and divided into 2 rows. If FALSE then rows with
354 too many characters may not be fully visible to the user on the screen.
356 @param StartRow The row number to start this on.
357 @param AutoWrap Whether to auto wrap rows that are too long.
361 (EFIAPI
*SHELLENV_ENABLE_PAGE_BREAK
) (
367 This function disables the page break mode.
369 Tisabling this causes the output to print out exactly as coded with no breaks
374 (EFIAPI
*SHELLENV_DISABLE_PAGE_BREAK
) (
379 Get the status of the page break output mode.
381 @retval FALSE Page break output mode is not enabled.
382 @retval TRUE Page break output mode is enabled.
386 (EFIAPI
*SHELLENV_GET_PAGE_BREAK
) (
391 This function sets the keys to filter for for the console in. The valid
394 #define EFI_OUTPUT_SCROLL 0x00000001
395 #define EFI_OUTPUT_PAUSE 0x00000002
396 #define EFI_EXECUTION_BREAK 0x00000004
398 @param KeyFilter The new key filter to use.
402 (EFIAPI
*SHELLENV_SET_KEY_FILTER
) (
407 This function gets the keys to filter for for the console in.
409 The valid values to get are:
410 #define EFI_OUTPUT_SCROLL 0x00000001
411 #define EFI_OUTPUT_PAUSE 0x00000002
412 #define EFI_EXECUTION_BREAK 0x00000004
414 @retval the current filter mask.
418 (EFIAPI
*SHELLENV_GET_KEY_FILTER
) (
423 This function determins if the shell application should break.
425 This is used to inform a shell application that a break condition has been
426 initiated. Long loops should check this to prevent delays to the break.
428 @retval TRUE A break has been signaled. the application
429 should exit with EFI_ABORTED as soon as possible.
430 @retval FALSE Continue as normal.
434 (EFIAPI
*SHELLENV_GET_EXECUTION_BREAK
) (
439 This is an internal-shell function used to increment the shell nesting level.
444 (EFIAPI
*SHELLENV_INCREMENT_SHELL_NESTING_LEVEL
) (
449 This is an internal-shell function used to decrement the shell nesting level.
453 (EFIAPI
*SHELLENV_DECREMENT_SHELL_NESTING_LEVEL
) (
458 This function determins if the caller is running under the root shell.
460 @retval TRUE The caller is running under the root shell.
461 @retval FALSE The caller is not running under the root shell.
466 (EFIAPI
*SHELLENV_IS_ROOT_SHELL
) (
471 Close the console proxy to restore the original console.
473 This is an internal shell function to handle shell cascading. It restores the
474 original set of console protocols.
476 @param ConInHandle The handle of ConIn.
477 @param ConIn Pointer to the location to return the pointer to
478 the original console input.
479 @param ConOutHandle The handle of ConOut
480 @param ConOut Pointer to the location to return the pointer to
481 the original console output.
485 (EFIAPI
*SHELLENV_CLOSE_CONSOLE_PROXY
) (
486 IN EFI_HANDLE ConInHandle
,
487 IN OUT EFI_SIMPLE_TEXT_INPUT_PROTOCOL
**ConIn
,
488 IN EFI_HANDLE ConOutHandle
,
489 IN OUT EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
**ConOut
493 // declarations of handle enumerator
496 For ease of use the shell maps handle #'s to short numbers.
497 This is only done on request for various internal commands and the references
498 are immediately freed when the internal command completes.
502 (EFIAPI
*INIT_HANDLE_ENUMERATOR
) (
507 This is an internal shell function to enumerate the handle database.
509 This function gets the next handle in the handle database. If no handles are
510 found EFI_NOT_FOUND is returned. If the previous Handle was the last handle
511 it is set to NULL before returning.
513 This must be called after INIT_HANDLE_ENUMERATOR and before CLOSE_HANDLE_ENUMERATOR.
515 @param Handle Pointer to pointer to Handle. Will be set
516 on a sucessful return.
518 @retval EFI_SUCCESS The next handle in the handle database is *Handle.
519 @retval EFI_NOT_FOUND There is not another handle.
523 (EFIAPI
*NEXT_HANDLE
) (
524 IN OUT EFI_HANDLE
**Handle
528 This is an internal shell function to enumerate the handle database.
530 This function skips the next SkipNum handles in the handle database. If there
531 are not enough handles left to skip that many EFI_ACCESS_DENIED is returned and
532 no skip is performed.
534 This must be called after INIT_HANDLE_ENUMERATOR and before CLOSE_HANDLE_ENUMERATOR.
536 @param SkipNum how many handles to skip
538 @retval EFI_SUCCESS the next handle in the handle database is *Handle
539 @retval EFI_ACCESS_DENIED there are not SkipNum handles left in the database
543 (EFIAPI
*SKIP_HANDLE
) (
548 This is an internal shell function to enumerate the handle database.
550 This function resets the the handle database so that NEXT_HANDLE and SKIP_HANDLE
551 will start from EnumIndex on the next call.
553 This must be called after INIT_HANDLE_ENUMERATOR and before CLOSE_HANDLE_ENUMERATOR.
555 @param EnumIndex Where to start.
557 @return the number of handles either read out or skipped before this reset.
561 (EFIAPI
*RESET_HANDLE_ENUMERATOR
) (
566 This is an internal shell function to enumerate the handle database.
568 This must be called after INIT_HANDLE_ENUMERATOR.
570 This function releases all memory and resources associated with the handle database.
571 Tfter this no other handle enumerator functions except INIT_HANDLE_ENUMERATOR will
576 (EFIAPI
*CLOSE_HANDLE_ENUMERATOR
) (
581 This is an internal shell function to enumerate the handle database.
583 This function returns the number of handles in the handle database.
585 This must be called after INIT_HANDLE_ENUMERATOR and before CLOSE_HANDLE_ENUMERATOR.
587 @return the number of handles in the handle database.
596 Handle Enumerator structure.
599 INIT_HANDLE_ENUMERATOR Init
; ///< Pointer to INIT_HANDLE_ENUMERATOR function.
600 NEXT_HANDLE Next
; ///< Pointer to NEXT_HANDLE function.
601 SKIP_HANDLE Skip
; ///< Pointer to SKIP_HANDLE function.
602 RESET_HANDLE_ENUMERATOR Reset
; ///< Pointer to RESET_HANDLE_ENUMERATOR function.
603 CLOSE_HANDLE_ENUMERATOR Close
; ///< Pointer to CLOSE_HANDLE_ENUMERATOR function.
604 GET_NUM GetNum
; ///< Pointer to GET_NUM function.
608 Signature for the PROTOCOL_INFO structure.
610 #define PROTOCOL_INFO_SIGNATURE SIGNATURE_32 ('s', 'p', 'i', 'n')
613 PROTOCOL_INFO structure for protocol enumerator functions.
616 UINTN Signature
; ///< PROTOCOL_INFO_SIGNATURE.
617 LIST_ENTRY Link
; ///< Standard lined list helper member.
619 // The parsing info for the protocol.
621 EFI_GUID ProtocolId
; ///< GUID for the protocol.
622 CHAR16
*IdString
; ///< Name of the protocol.
623 SHELLENV_DUMP_PROTOCOL_INFO DumpToken
; ///< Pointer to DumpToken function for the protocol.
624 SHELLENV_DUMP_PROTOCOL_INFO DumpInfo
; ///< Pointer to DumpInfo function for the protocol.
626 // Patabase info on which handles are supporting this protocol.
628 UINTN NoHandles
; ///< How many handles produce this protocol.
629 EFI_HANDLE
*Handles
; ///< The array of handles.
634 // Declarations of protocol info enumerator.
637 This is an internal shell function to initialize the protocol enumerator.
639 This must be called before NEXT_PROTOCOL_INFO, SKIP_PROTOCOL_INFO,
640 RESET_PROTOCOL_INFO_ENUMERATOR, and CLOSE_PROTOCOL_INFO_ENUMERATOR are
645 (EFIAPI
*INIT_PROTOCOL_INFO_ENUMERATOR
) (
650 This function is an internal shell function for enumeration of protocols.
652 This functiol will return the next protocol in the list. If this is called
653 immediately after initialization it will return the first. If this is called
654 immediately after reset it will return the protocol first again.
656 This cannot be called after CLOSE_PROTOCOL_INFO_ENUMERATOR, but it must be
657 called after INIT_PROTOCOL_INFO_ENUMERATOR.
659 @param ProtocolInfo Pointer to pointer to protocol information structure.
661 @retval EFI_SUCCESS The next protocol's information was sucessfully returned.
662 @retval NULL There are no more protocols.
666 (EFIAPI
*NEXT_PROTOCOL_INFO
) (
667 IN OUT PROTOCOL_INFO
**ProtocolInfo
671 This function is an internal shell function for enumeration of protocols.
673 This cannot be called after CLOSE_PROTOCOL_INFO_ENUMERATOR, but it must be
674 called after INIT_PROTOCOL_INFO_ENUMERATOR.
676 This function does nothing and always returns EFI_SUCCESS.
678 @retval EFI_SUCCESS always returned (see above).
682 (EFIAPI
*SKIP_PROTOCOL_INFO
) (
687 This function is an internal shell function for enumeration of protocols.
689 This cannot be called after CLOSE_PROTOCOL_INFO_ENUMERATOR, but it must be
690 called after INIT_PROTOCOL_INFO_ENUMERATOR.
692 This function resets the list of protocols such that the next one in the
693 list is the begining of the list.
697 (EFIAPI
*RESET_PROTOCOL_INFO_ENUMERATOR
) (
703 This function is an internal shell function for enumeration of protocols.
705 This must be called after INIT_PROTOCOL_INFO_ENUMERATOR. After this call
706 no protocol enumerator calls except INIT_PROTOCOL_INFO_ENUMERATOR may be made.
708 This function frees any memory or resources associated with the protocol
713 (EFIAPI
*CLOSE_PROTOCOL_INFO_ENUMERATOR
) (
718 Protocol enumerator structure of function pointers.
721 INIT_PROTOCOL_INFO_ENUMERATOR Init
; ///< Pointer to INIT_PROTOCOL_INFO_ENUMERATOR function.
722 NEXT_PROTOCOL_INFO Next
; ///< Pointer to NEXT_PROTOCOL_INFO function.
723 SKIP_PROTOCOL_INFO Skip
; ///< Pointer to SKIP_PROTOCOL_INFO function.
724 RESET_PROTOCOL_INFO_ENUMERATOR Reset
; ///< Pointer to RESET_PROTOCOL_INFO_ENUMERATOR function.
725 CLOSE_PROTOCOL_INFO_ENUMERATOR Close
; ///< Pointer to CLOSE_PROTOCOL_INFO_ENUMERATOR function.
726 } PROTOCOL_INFO_ENUMERATOR
;
729 This function is used to retrieve a user-friendly display name for a handle.
731 If UseComponentName is TRUE then the component name protocol for this device
732 or it's parent device (if required) will be used to obtain the name of the
733 device. If UseDevicePath is TRUE it will get the human readable device path
734 and return that. If both are TRUE it will try to use component name first
735 and device path if that fails.
737 It will use either ComponentName or ComponentName2 protocol, depending on
740 This function will furthur verify whether the handle in question produced either
741 EFI_DRIVER_CONFIGRATION_PROTOCOL or EFI_DRIVER_CONFIGURATION2_PROTOCOL and also
742 whether the handle in question produced either EFI_DRIVER_DIAGNOSTICS_PROTOCOL or
743 EFI_DRIVER_DIAGNOSTICS2_PROTOCOL.
745 Upon sucessful return the memory for *BestDeviceName is up to the caller to free.
747 @param DeviceHandle The device handle whose name is desired.
748 @param UseComponentName Whether to use the ComponentName protocol at all.
749 @param UseDevicePath Whether to use the DevicePath protocol at all.
750 @param Language Pointer to language string to use.
751 @param BestDeviceName Pointer to pointer to string allocated with the name.
752 @param ConfigurationStatus Pointer to status for opening a Configuration protocol.
753 @param DiagnosticsStatus Pointer to status for opening a Diagnostics protocol.
754 @param Display Whether to Print this out to default Print location.
755 @param Indent How many characters to indent the printing.
757 @retval EFI_SUCCESS This function always returns EFI_SUCCESS.
761 (EFIAPI
*GET_DEVICE_NAME
) (
762 EFI_HANDLE DeviceHandle
,
763 BOOLEAN UseComponentName
,
764 BOOLEAN UseDevicePath
,
766 CHAR16
**BestDeviceName
,
767 EFI_STATUS
*ConfigurationStatus
,
768 EFI_STATUS
*DiagnosticsStatus
,
773 #define EFI_SHELL_COMPATIBLE_MODE_VER L"1.1.1" ///< string for lowest version this shell supports
774 #define EFI_SHELL_ENHANCED_MODE_VER L"1.1.2" ///< string for highest version this shell supports
777 This function gets the shell mode as stored in the shell environment
778 "efishellmode". It will not fail.
780 @param Mode Returns a string representing one of the
781 2 supported modes of the shell.
783 @retval EFI_SUCCESS This function always returns success.
787 (EFIAPI
*GET_SHELL_MODE
) (
792 Convert a file system style name to a device path.
794 This function will convert a shell path name to a Device Path Protocol path.
795 This function will allocate any required memory for this operation and it
796 is the responsibility of the caller to free that memory when no longer required.
798 If anything prevents the complete conversion free any allocated memory and
801 @retval !NULL A pointer to the callee allocated Device Path.
802 @retval NULL The operation could not be completed.
805 EFI_DEVICE_PATH_PROTOCOL
*
806 (EFIAPI
*SHELLENV_NAME_TO_PATH
) (
811 Converts a device path into a file system map name.
813 If DevPath is NULL, then ASSERT.
815 This function looks through the shell environment map for a map whose device
816 path matches the DevPath parameter. If one is found the Name is returned via
817 Name parameter. If sucessful the caller must free the memory allocated for
820 This function will use the internal lock to prevent changes to the map during
821 the lookup operation.
823 @param DevPath The device path to search for a name for.
824 @param ConsistMapping What state to verify map flag VAR_ID_CONSIST.
825 @param Name On sucessful return the name of that device path.
827 @retval EFI_SUCCESS The DevPath was found and the name returned
829 @retval EFI_OUT_OF_RESOURCES A required memory allocation failed.
830 @retval EFI_UNSUPPORTED The DevPath was not found in the map.
834 (EFIAPI
*SHELLENV_GET_FS_NAME
) (
835 IN EFI_DEVICE_PATH_PROTOCOL
* DevPath
,
836 IN BOOLEAN ConsistMapping
,
841 This function will open a group of files that match the Arg path, but will not
842 support the wildcard characters ('?' and '*') in the Arg path. If there are
843 any wildcard characters in the path this function will return
844 EFI_INVALID_PARAMETER. The return is a double linked list based on the
845 LIST_ENTRY linked list structure. Use this in conjunction with the
846 SHELL_FILE_ARG_SIGNATURE to get the SHELL_FILE_ARG structures that are returned.
847 The memory allocated by the callee for this list is freed by making a call to
848 SHELLENV_FREE_FILE_LIST.
850 @param Arg Pointer Path to files to open.
851 @param ListHead Pointer to allocated and initialized list head
852 upon which to append all the opened file structures.
854 @retval EFI_SUCCESS 1 or more files was opened and a struct of each file's
855 information was appended to ListHead.
856 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
857 @retval EFI_NOT_FOUND No matching files could be found.
858 @sa SHELLENV_FREE_FILE_LIST
862 (EFIAPI
*SHELLENV_FILE_META_ARG_NO_WILDCARD
) (
864 IN OUT LIST_ENTRY
*ListHead
868 This function removes duplicate file listings from lists.
870 This is a function for use with SHELLENV_FILE_META_ARG_NO_WILDCARD and
871 SHELLENV_FILE_META_ARG. This function will verify that there are no duplicate
872 files in the list of returned files. Any file listed twice will have one of its
875 @param ListHead Pointer to linked list head that was returned from
876 SHELLENV_FILE_META_ARG_NO_WILDCARD or
877 SHELLENV_FILE_META_ARG.
879 @retval EFI_SUCCESS This function always returns success.
884 (EFIAPI
*SHELLENV_DEL_DUP_FILE
) (
885 IN LIST_ENTRY
* ListHead
889 Converts a File System map name to a device path.
891 if DevPath is NULL, then ASSERT().
893 This function looks through the shell environment map for a map whose Name
894 matches the Name parameter. If one is found the device path pointer is
895 updated to point to that file systems device path. The caller should not
896 free the memory from that device path.
898 This function will use the internal lock to prevent changes to the map during
899 the lookup operation.
901 @param Name Pointer to NULL terminated UNICODE string of the
903 @param DevPath Pointer to pointer to DevicePath. only valid on
906 @retval EFI_SUCCESS The conversion was successful and the device
908 @retval EFI_NOT_FOUND The file system could not be found in the map.
912 (EFIAPI
*SHELLENV_GET_FS_DEVICE_PATH
) (
914 OUT EFI_DEVICE_PATH_PROTOCOL
**DevPath
917 /// EFI_SHELL_ENVIRONMENT2 protocol structure.
919 SHELLENV_EXECUTE Execute
;
920 SHELLENV_GET_ENV GetEnv
;
921 SHELLENV_GET_MAP GetMap
;
922 SHELLENV_ADD_CMD AddCmd
;
923 SHELLENV_ADD_PROT AddProt
;
924 SHELLENV_GET_PROT GetProt
;
925 SHELLENV_CUR_DIR CurDir
;
926 SHELLENV_FILE_META_ARG FileMetaArg
;
927 SHELLENV_FREE_FILE_LIST FreeFileList
;
930 // The following services are only used by the shell itself.
932 SHELLENV_NEW_SHELL NewShell
;
933 SHELLENV_BATCH_IS_ACTIVE BatchIsActive
;
935 SHELLENV_FREE_RESOURCES FreeResources
;
938 // GUID to differentiate ShellEnvironment2 from ShellEnvironment.
942 // Major Version grows if shell environment interface has been changes.
946 SHELLENV_ENABLE_PAGE_BREAK EnablePageBreak
;
947 SHELLENV_DISABLE_PAGE_BREAK DisablePageBreak
;
948 SHELLENV_GET_PAGE_BREAK GetPageBreak
;
950 SHELLENV_SET_KEY_FILTER SetKeyFilter
;
951 SHELLENV_GET_KEY_FILTER GetKeyFilter
;
953 SHELLENV_GET_EXECUTION_BREAK GetExecutionBreak
;
954 SHELLENV_INCREMENT_SHELL_NESTING_LEVEL IncrementShellNestingLevel
;
955 SHELLENV_DECREMENT_SHELL_NESTING_LEVEL DecrementShellNestingLevel
;
956 SHELLENV_IS_ROOT_SHELL IsRootShell
;
958 SHELLENV_CLOSE_CONSOLE_PROXY CloseConsoleProxy
;
959 HANDLE_ENUMERATOR HandleEnumerator
;
960 PROTOCOL_INFO_ENUMERATOR ProtocolInfoEnumerator
;
961 GET_DEVICE_NAME GetDeviceName
;
962 GET_SHELL_MODE GetShellMode
;
963 SHELLENV_NAME_TO_PATH NameToPath
;
964 SHELLENV_GET_FS_NAME GetFsName
;
965 SHELLENV_FILE_META_ARG_NO_WILDCARD FileMetaArgNoWildCard
;
966 SHELLENV_DEL_DUP_FILE DelDupFileArg
;
967 SHELLENV_GET_FS_DEVICE_PATH GetFsDevicePath
;
968 } EFI_SHELL_ENVIRONMENT2
;
970 extern EFI_GUID gEfiShellEnvironment2Guid
;
971 extern EFI_GUID gEfiShellEnvironment2ExtGuid
;
973 #endif // _SHELL_ENVIRONMENT_2_PROTOCOL_H_