2 Defines for EFI shell environment 2 ported to EDK II build environment. (no spec)
4 Copyright (c) 2005 - 2010, Intel Corporation. All rights reserved.<BR>
5 SPDX-License-Identifier: BSD-2-Clause-Patent
9 #ifndef _SHELL_ENVIRONMENT_2_PROTOCOL_H_
10 #define _SHELL_ENVIRONMENT_2_PROTOCOL_H_
12 #define DEFAULT_INIT_ROW 1
13 #define DEFAULT_AUTO_LF FALSE
16 This function is a prototype for a function that dumps information on a protocol
17 to a given location. The location is dependant on the implementation. This is
18 used when programatically adding shell commands.
20 @param[in] Handle The handle the protocol is on.
21 @param[in] Interface The interface to the protocol.
26 (EFIAPI
*SHELLENV_DUMP_PROTOCOL_INFO
)(
32 This function is a prototype for each command internal to the EFI shell
33 implementation. The specific command depends on the implementation. This is
34 used when programatically adding shell commands.
36 @param[in] ImageHandle The handle to the binary shell.
37 @param[in] SystemTable The pointer to the system table.
39 @retval EFI_SUCCESS The command completed.
40 @retval other An error occurred. Any error is possible
41 depending on the implementation of the shell
47 (EFIAPI
*SHELLENV_INTERNAL_COMMAND
)(
48 IN EFI_HANDLE ImageHandle
,
49 IN EFI_SYSTEM_TABLE
*SystemTable
53 This function is a prototype for one that gets a help string for a given command.
54 This is used when programatically adding shell commands. Upon successful return
55 the memory allocated is up to the caller to free.
57 @param[in, out] Str Pointer to pointer to string to display for help.
59 @retval EFI_SUCCESS The help string is in the parameter Str.
64 (EFIAPI
*SHELLCMD_GET_LINE_HELP
)(
69 Structure returned from functions that open multiple files.
72 UINT32 Signature
; ///< SHELL_FILE_ARG_SIGNATURE.
73 LIST_ENTRY Link
; ///< Linked list helper.
74 EFI_STATUS Status
; ///< File's status.
76 EFI_FILE_HANDLE Parent
; ///< What is the Parent file of this file.
77 UINT64 OpenMode
; ///< How was the file opened.
78 CHAR16
*ParentName
; ///< String representation of parent.
79 EFI_DEVICE_PATH_PROTOCOL
*ParentDevicePath
; ///< DevicePath for Parent.
81 CHAR16
*FullName
; ///< Path and file name for this file.
82 CHAR16
*FileName
; ///< File name for this file.
84 EFI_FILE_HANDLE Handle
; ///< Handle to this file.
85 EFI_FILE_INFO
*Info
; ///< Pointer to file info for this file.
88 /// Signature for SHELL_FILE_ARG.
89 #define SHELL_FILE_ARG_SIGNATURE SIGNATURE_32 ('g', 'r', 'a', 'f')
92 GUID for the shell environment2 and shell environment.
94 #define SHELL_ENVIRONMENT_PROTOCOL_GUID \
96 0x47c7b221, 0xc42a, 0x11d2, {0x8e, 0x57, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b} \
100 GUID for the shell environment2 extension (main GUID above).
102 #define EFI_SE_EXT_SIGNATURE_GUID \
104 0xd2c18636, 0x40e5, 0x4eb5, {0xa3, 0x1b, 0x36, 0x69, 0x5f, 0xd4, 0x2c, 0x87} \
107 #define EFI_SHELL_MAJOR_VER 0x00000001 ///< Major version of the EFI_SHELL_ENVIRONMENT2.
108 #define EFI_SHELL_MINOR_VER 0x00000000 ///< Minor version of the EFI_SHELL_ENVIRONMENT2.
111 Execute a command line.
113 This function will run the CommandLine. This includes loading any required images,
114 parsing any requires scripts, and if DebugOutput is TRUE printing errors
115 encountered directly to the screen.
117 @param[in] ParentImageHandle Handle of the image executing this operation.
118 @param[in] CommandLine The string command line to execute.
119 @param[in] DebugOutput TRUE indicates that errors should be printed directly.
120 FALSE suppresses error messages.
122 @retval EFI_SUCCESS The command line executed and completed.
123 @retval EFI_ABORTED The operation aborted.
124 @retval EFI_INVALID_PARAMETER A parameter did not have a valid value.
125 @retval EFI_OUT_OF_RESOURCES A required memory allocation failed.
131 (EFIAPI
*SHELLENV_EXECUTE
)(
132 IN EFI_HANDLE
*ParentImageHandle
,
133 IN CHAR16
*CommandLine
,
134 IN BOOLEAN DebugOutput
138 This function returns a shell environment variable value.
140 @param[in] Name The pointer to the string with the shell environment
143 @retval NULL The shell environment variable's value could not be found.
144 @retval !=NULL The value of the shell environment variable Name.
149 (EFIAPI
*SHELLENV_GET_ENV
)(
154 This function returns a shell environment map value.
156 @param[in] Name The pointer to the string with the shell environment
159 @retval NULL The shell environment map's value could not be found.
160 @retval !=NULL The value of the shell environment map Name.
165 (EFIAPI
*SHELLENV_GET_MAP
)(
170 This function will add an internal command to the shell interface.
172 This will allocate all required memory, put the new command on the command
173 list in the correct location.
175 @param[in] Handler The handler function to call when the command gets called.
176 @param[in] Cmd The command name.
177 @param[in] GetLineHelp The function to call of type "get help" for this command.
179 @retval EFI_SUCCESS The command is now part of the command list.
180 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
181 @sa SHELLENV_INTERNAL_COMMAND
182 @sa SHELLCMD_GET_LINE_HELP
186 (EFIAPI
*SHELLENV_ADD_CMD
)(
187 IN SHELLENV_INTERNAL_COMMAND Handler
,
189 IN SHELLCMD_GET_LINE_HELP GetLineHelp
193 Internal interface to add protocol handlers.
195 This function is for internal shell use only. This is how protocol handlers are added.
196 This will get the current protocol info and add the new info or update existing info
197 and then resave the info.
199 @param[in] Protocol The pointer to the protocol's GUID.
200 @param[in] DumpToken The function pointer to dump token function or
202 @param[in] DumpInfo The function pointer to dump infomation function
204 @param[in] IdString The English name of the protocol.
208 (EFIAPI
*SHELLENV_ADD_PROT
)(
209 IN EFI_GUID
*Protocol
,
210 IN SHELLENV_DUMP_PROTOCOL_INFO DumpToken OPTIONAL
,
211 IN SHELLENV_DUMP_PROTOCOL_INFO DumpInfo OPTIONAL
,
216 This function finds a protocol handle by a GUID.
218 This function will check for already known protocols by GUID and if one is
219 found it will return the name of that protocol. If no name is found and
220 GenId is TRUE it will generate ths string.
222 @param[in] Protocol The GUID of the protocol to look for.
223 @param[in] GenId Whether to generate a name string if it is not found.
225 @return !NULL The Name of the protocol.
226 @retval NULL The Name was not found, and GenId was not TRUE.
230 (EFIAPI
*SHELLENV_GET_PROT
)(
231 IN EFI_GUID
*Protocol
,
236 This function returns a string array containing the current directory on
239 If DeviceName is specified, then return the current shell directory on that
240 device. If DeviceName is NULL, then return the current directory on the
241 current device. The caller us responsible to free the returned string when
244 @param[in] DeviceName The name of the device to get the current
245 directory on, or NULL for current device.
247 @return String array with the current directory on the current or specified device.
252 (EFIAPI
*SHELLENV_CUR_DIR
)(
253 IN CHAR16
*DeviceName OPTIONAL
257 This function will open a group of files that match the Arg path, including
258 support for wildcard characters ('?' and '*') in the Arg path. If there are
259 any wildcard characters in the path this function will find any and all files
260 that match the wildcards. It returns a double linked list based on the
261 LIST_ENTRY linked list structure. Use this in conjunction with the
262 SHELL_FILE_ARG_SIGNATURE to get the SHELL_FILE_ARG structures that are returned.
263 The memory allocated by the callee for this list is freed by making a call to
264 SHELLENV_FREE_FILE_LIST.
266 @param[in] Arg The pointer Path to files to open.
267 @param[in, out] ListHead The pointer to the allocated and initialized list head
268 upon which to append all opened file structures.
270 @retval EFI_SUCCESS One or more files was opened and a struct of each file's
271 information was appended to ListHead.
272 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
273 @retval EFI_NOT_FOUND No matching files could be found.
274 @sa SHELLENV_FREE_FILE_LIST
277 (EFIAPI
*SHELLENV_FILE_META_ARG
)(
279 IN OUT LIST_ENTRY
*ListHead
283 This frees all of the nodes under the ListHead, but not ListHead itself.
285 @param[in, out] ListHead Pointer to list to free all nodes of.
287 @retval EFI_SUCCESS This function always returns EFI_SUCCESS.
291 (EFIAPI
*SHELLENV_FREE_FILE_LIST
)(
292 IN OUT LIST_ENTRY
*ListHead
296 This function creates a new instance of the ShellInterface protocol for use on
299 This function is for internal shell usage. This will allocate and then populate
300 EFI_SHELL_INTERFACE protocol. It is the caller's responsibility to free the
303 @param[in] ImageHandle The handle which will use the new ShellInterface
306 @return The newly allocated shell interface protocol.
310 EFI_SHELL_INTERFACE
*
311 (EFIAPI
*SHELLENV_NEW_SHELL
)(
312 IN EFI_HANDLE ImageHandle
316 This function determines whether a script file is currently being processed.
318 A script file (.nsh file) can contain a series of commands and this is useful to
319 know for some shell commands whether they are being run manually or as part of a
322 @retval TRUE A script file is being processed.
323 @retval FALSE A script file is not being processed.
327 (EFIAPI
*SHELLENV_BATCH_IS_ACTIVE
)(
332 This is an internal shell function to free any and all allocated resources.
333 This should be called immediately prior to closing the shell.
337 (EFIAPI
*SHELLENV_FREE_RESOURCES
)(
342 This function enables the page break mode.
344 This mode causes the output to pause after each complete screen to enable a
345 user to more easily read it. If AutoWrap is TRUE, then rows with too many
346 characters will be chopped and divided into 2 rows. If FALSE, then rows with
347 too many characters may not be fully visible to the user on the screen.
349 @param[in] StartRow The row number to start this on.
350 @param[in] AutoWrap Whether to auto wrap rows that are too long.
354 (EFIAPI
*SHELLENV_ENABLE_PAGE_BREAK
)(
360 This function disables the page break mode.
362 Disabling this causes the output to print out exactly as coded, with no breaks
367 (EFIAPI
*SHELLENV_DISABLE_PAGE_BREAK
)(
372 Get the status of the page break output mode.
374 @retval FALSE Page break output mode is not enabled.
375 @retval TRUE Page break output mode is enabled.
379 (EFIAPI
*SHELLENV_GET_PAGE_BREAK
)(
384 This function sets the keys to filter for for the console in. The valid
387 #define EFI_OUTPUT_SCROLL 0x00000001
388 #define EFI_OUTPUT_PAUSE 0x00000002
389 #define EFI_EXECUTION_BREAK 0x00000004
391 @param[in] KeyFilter The new key filter to use.
395 (EFIAPI
*SHELLENV_SET_KEY_FILTER
)(
400 This function gets the keys to filter for for the console in.
402 The valid values to get are:
403 #define EFI_OUTPUT_SCROLL 0x00000001
404 #define EFI_OUTPUT_PAUSE 0x00000002
405 #define EFI_EXECUTION_BREAK 0x00000004
407 @retval The current filter mask.
411 (EFIAPI
*SHELLENV_GET_KEY_FILTER
)(
416 This function determines if the shell application should break.
418 This is used to inform a shell application that a break condition has been
419 initiated. Long loops should check this to prevent delays to the break.
421 @retval TRUE A break has been signaled. The application
422 should exit with EFI_ABORTED as soon as possible.
423 @retval FALSE Continue as normal.
427 (EFIAPI
*SHELLENV_GET_EXECUTION_BREAK
)(
432 This is an internal shell function used to increment the shell nesting level.
437 (EFIAPI
*SHELLENV_INCREMENT_SHELL_NESTING_LEVEL
)(
442 This is an internal shell function used to decrement the shell nesting level.
446 (EFIAPI
*SHELLENV_DECREMENT_SHELL_NESTING_LEVEL
)(
451 This function determines if the caller is running under the root shell.
453 @retval TRUE The caller is running under the root shell.
454 @retval FALSE The caller is not running under the root shell.
459 (EFIAPI
*SHELLENV_IS_ROOT_SHELL
)(
464 Close the console proxy to restore the original console.
466 This is an internal shell function to handle shell cascading. It restores the
467 original set of console protocols.
469 @param[in] ConInHandle The handle of ConIn.
470 @param[in, out] ConIn The pointer to the location to return the pointer to
471 the original console input.
472 @param[in] ConOutHandle The handle of ConOut
473 @param[in, out] ConOut The pointer to the location to return the pointer to
474 the original console output.
478 (EFIAPI
*SHELLENV_CLOSE_CONSOLE_PROXY
)(
479 IN EFI_HANDLE ConInHandle
,
480 IN OUT EFI_SIMPLE_TEXT_INPUT_PROTOCOL
**ConIn
,
481 IN EFI_HANDLE ConOutHandle
,
482 IN OUT EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
**ConOut
486 // declarations of handle enumerator
490 For ease of use the shell maps handle #'s to short numbers.
491 This is only done on request for various internal commands and the references
492 are immediately freed when the internal command completes.
496 (EFIAPI
*INIT_HANDLE_ENUMERATOR
)(
501 This is an internal shell function to enumerate the handle database.
503 This function gets the next handle in the handle database. If no handles are
504 found, EFI_NOT_FOUND is returned. If the previous Handle was the last handle,
505 it is set to NULL before returning.
507 This must be called after INIT_HANDLE_ENUMERATOR and before CLOSE_HANDLE_ENUMERATOR.
509 @param[in, out] Handle The pointer to pointer to Handle. It is set
510 on a sucessful return.
512 @retval EFI_SUCCESS The next handle in the handle database is *Handle.
513 @retval EFI_NOT_FOUND There is not another handle.
517 (EFIAPI
*NEXT_HANDLE
)(
518 IN OUT EFI_HANDLE
**Handle
522 This is an internal shell function to enumerate the handle database.
524 This function skips the next SkipNum handles in the handle database. If there
525 are not enough handles left to skip that many EFI_ACCESS_DENIED is returned and
526 no skip is performed.
528 This must be called after INIT_HANDLE_ENUMERATOR and before CLOSE_HANDLE_ENUMERATOR.
530 @param[in] SkipNum How many handles to skip
532 @retval EFI_SUCCESS The next handle in the handle database is *Handle
533 @retval EFI_ACCESS_DENIED There are not SkipNum handles left in the database
537 (EFIAPI
*SKIP_HANDLE
)(
542 This is an internal shell function to enumerate the handle database.
544 This function resets the the handle database so that NEXT_HANDLE and SKIP_HANDLE
545 will start from EnumIndex on the next call.
547 This must be called after INIT_HANDLE_ENUMERATOR and before CLOSE_HANDLE_ENUMERATOR.
549 @param[in] EnumIndex Where to start.
551 @return The number of handles either read out or skipped before this reset.
555 (EFIAPI
*RESET_HANDLE_ENUMERATOR
)(
560 This is an internal shell function to enumerate the handle database.
562 This must be called after INIT_HANDLE_ENUMERATOR.
564 This function releases all memory and resources associated with the handle database.
565 After this no other handle enumerator functions except INIT_HANDLE_ENUMERATOR will
570 (EFIAPI
*CLOSE_HANDLE_ENUMERATOR
)(
575 This is an internal shell function to enumerate the handle database.
577 This function returns the number of handles in the handle database.
579 This must be called after INIT_HANDLE_ENUMERATOR and before CLOSE_HANDLE_ENUMERATOR.
581 @return The number of handles in the handle database.
590 Handle Enumerator structure.
593 INIT_HANDLE_ENUMERATOR Init
; ///< The pointer to INIT_HANDLE_ENUMERATOR function.
594 NEXT_HANDLE Next
; ///< The pointer to NEXT_HANDLE function.
595 SKIP_HANDLE Skip
; ///< The pointer to SKIP_HANDLE function.
596 RESET_HANDLE_ENUMERATOR Reset
; ///< The pointer to RESET_HANDLE_ENUMERATOR function.
597 CLOSE_HANDLE_ENUMERATOR Close
; ///< The pointer to CLOSE_HANDLE_ENUMERATOR function.
598 GET_NUM GetNum
; ///< The pointer to GET_NUM function.
602 Signature for the PROTOCOL_INFO structure.
604 #define PROTOCOL_INFO_SIGNATURE SIGNATURE_32 ('s', 'p', 'i', 'n')
607 PROTOCOL_INFO structure for protocol enumerator functions.
610 UINTN Signature
; ///< PROTOCOL_INFO_SIGNATURE.
611 LIST_ENTRY Link
; ///< Standard linked list helper member.
613 // The parsing info for the protocol.
615 EFI_GUID ProtocolId
; ///< The GUID for the protocol.
616 CHAR16
*IdString
; ///< The name of the protocol.
617 SHELLENV_DUMP_PROTOCOL_INFO DumpToken
; ///< The pointer to DumpToken function for the protocol.
618 SHELLENV_DUMP_PROTOCOL_INFO DumpInfo
; ///< The pointer to DumpInfo function for the protocol.
620 // Patabase info on which handles are supporting this protocol.
622 UINTN NoHandles
; ///< The number of handles producing this protocol.
623 EFI_HANDLE
*Handles
; ///< The array of handles.
627 // Declarations of protocol info enumerator.
631 This is an internal shell function to initialize the protocol enumerator.
633 This must be called before NEXT_PROTOCOL_INFO, SKIP_PROTOCOL_INFO,
634 RESET_PROTOCOL_INFO_ENUMERATOR, and CLOSE_PROTOCOL_INFO_ENUMERATOR are
639 (EFIAPI
*INIT_PROTOCOL_INFO_ENUMERATOR
)(
644 This function is an internal shell function for enumeration of protocols.
646 This function returns the next protocol on the list. If this is called
647 immediately after initialization, it will return the first protocol on the list.
648 If this is called immediately after reset, it will return the first protocol again.
650 This cannot be called after CLOSE_PROTOCOL_INFO_ENUMERATOR, but it must be
651 called after INIT_PROTOCOL_INFO_ENUMERATOR.
653 @param[in, out] ProtocolInfo The pointer to pointer to protocol information structure.
655 @retval EFI_SUCCESS The next protocol's information was sucessfully returned.
656 @retval NULL There are no more protocols.
660 (EFIAPI
*NEXT_PROTOCOL_INFO
)(
661 IN OUT PROTOCOL_INFO
**ProtocolInfo
665 This function is an internal shell function for enumeration of protocols.
667 This cannot be called after CLOSE_PROTOCOL_INFO_ENUMERATOR, but it must be
668 called after INIT_PROTOCOL_INFO_ENUMERATOR.
670 This function does nothing and always returns EFI_SUCCESS.
672 @retval EFI_SUCCESS Always returned (see above).
676 (EFIAPI
*SKIP_PROTOCOL_INFO
)(
681 This function is an internal shell function for enumeration of protocols.
683 This cannot be called after CLOSE_PROTOCOL_INFO_ENUMERATOR, but it must be
684 called after INIT_PROTOCOL_INFO_ENUMERATOR.
686 This function resets the list of protocols such that the next one in the
687 list is the begining of the list.
691 (EFIAPI
*RESET_PROTOCOL_INFO_ENUMERATOR
)(
696 This function is an internal shell function for enumeration of protocols.
698 This must be called after INIT_PROTOCOL_INFO_ENUMERATOR. After this call
699 no protocol enumerator calls except INIT_PROTOCOL_INFO_ENUMERATOR may be made.
701 This function frees any memory or resources associated with the protocol
706 (EFIAPI
*CLOSE_PROTOCOL_INFO_ENUMERATOR
)(
711 Protocol enumerator structure of function pointers.
714 INIT_PROTOCOL_INFO_ENUMERATOR Init
; ///< The pointer to INIT_PROTOCOL_INFO_ENUMERATOR function.
715 NEXT_PROTOCOL_INFO Next
; ///< The pointer to NEXT_PROTOCOL_INFO function.
716 SKIP_PROTOCOL_INFO Skip
; ///< The pointer to SKIP_PROTOCOL_INFO function.
717 RESET_PROTOCOL_INFO_ENUMERATOR Reset
; ///< The pointer to RESET_PROTOCOL_INFO_ENUMERATOR function.
718 CLOSE_PROTOCOL_INFO_ENUMERATOR Close
; ///< The pointer to CLOSE_PROTOCOL_INFO_ENUMERATOR function.
719 } PROTOCOL_INFO_ENUMERATOR
;
722 This function is used to retrieve a user-friendly display name for a handle.
724 If UseComponentName is TRUE then the component name protocol for this device
725 or it's parent device (if required) will be used to obtain the name of the
726 device. If UseDevicePath is TRUE it will get the human readable device path
727 and return that. If both are TRUE it will try to use component name first
728 and device path if that fails.
730 It will use either ComponentName or ComponentName2 protocol, depending on
733 This function will furthur verify whether the handle in question produced either
734 EFI_DRIVER_CONFIGRATION_PROTOCOL or EFI_DRIVER_CONFIGURATION2_PROTOCOL and also
735 whether the handle in question produced either EFI_DRIVER_DIAGNOSTICS_PROTOCOL or
736 EFI_DRIVER_DIAGNOSTICS2_PROTOCOL.
738 Upon successful return, the memory for *BestDeviceName is up to the caller to free.
740 @param[in] DeviceHandle The device handle whose name is desired.
741 @param[in] UseComponentName Whether to use the ComponentName protocol at all.
742 @param[in] UseDevicePath Whether to use the DevicePath protocol at all.
743 @param[in] Language The pointer to the language string to use.
744 @param[in, out] BestDeviceName The pointer to pointer to string allocated with the name.
745 @param[out] ConfigurationStatus The pointer to status for opening a Configuration protocol.
746 @param[out] DiagnosticsStatus The pointer to status for opening a Diagnostics protocol.
747 @param[in] Display Whether to Print this out to default Print location.
748 @param[in] Indent How many characters to indent the printing.
750 @retval EFI_SUCCESS This function always returns EFI_SUCCESS.
754 (EFIAPI
*GET_DEVICE_NAME
)(
755 IN EFI_HANDLE DeviceHandle
,
756 IN BOOLEAN UseComponentName
,
757 IN BOOLEAN UseDevicePath
,
759 IN OUT CHAR16
**BestDeviceName
,
760 OUT EFI_STATUS
*ConfigurationStatus
,
761 OUT EFI_STATUS
*DiagnosticsStatus
,
766 #define EFI_SHELL_COMPATIBLE_MODE_VER L"1.1.1" ///< The string for lowest version this shell supports.
767 #define EFI_SHELL_ENHANCED_MODE_VER L"1.1.2" ///< The string for highest version this shell supports.
770 This function gets the shell mode as stored in the shell environment
771 "efishellmode". It will not fail.
773 @param[out] Mode Returns a string representing one of the
774 2 supported modes of the shell.
776 @retval EFI_SUCCESS This function always returns success.
780 (EFIAPI
*GET_SHELL_MODE
)(
785 Convert a file system style name to a device path.
787 This function will convert a shell path name to a Device Path Protocol path.
788 This function will allocate any required memory for this operation and it
789 is the responsibility of the caller to free that memory when no longer required.
791 If anything prevents the complete conversion free any allocated memory and
794 @param[in] Path The path to convert.
796 @retval !NULL A pointer to the callee allocated Device Path.
797 @retval NULL The operation could not be completed.
800 EFI_DEVICE_PATH_PROTOCOL
*
801 (EFIAPI
*SHELLENV_NAME_TO_PATH
)(
806 Converts a device path into a file system map name.
808 If DevPath is NULL, then ASSERT.
810 This function looks through the shell environment map for a map whose device
811 path matches the DevPath parameter. If one is found the Name is returned via
812 Name parameter. If sucessful the caller must free the memory allocated for
815 This function will use the internal lock to prevent changes to the map during
816 the lookup operation.
818 @param[in] DevPath The device path to search for a name for.
819 @param[in] ConsistMapping What state to verify map flag VAR_ID_CONSIST.
820 @param[out] Name On sucessful return the name of that device path.
822 @retval EFI_SUCCESS The DevPath was found and the name returned
824 @retval EFI_OUT_OF_RESOURCES A required memory allocation failed.
825 @retval EFI_UNSUPPORTED The DevPath was not found in the map.
829 (EFIAPI
*SHELLENV_GET_FS_NAME
)(
830 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
,
831 IN BOOLEAN ConsistMapping
,
836 This function will open a group of files that match the Arg path, but will not
837 support the wildcard characters ('?' and '*') in the Arg path. If there are
838 any wildcard characters in the path this function will return
839 EFI_INVALID_PARAMETER. The return is a double linked list based on the
840 LIST_ENTRY linked list structure. Use this in conjunction with the
841 SHELL_FILE_ARG_SIGNATURE to get the SHELL_FILE_ARG structures that are returned.
842 The memory allocated by the callee for this list is freed by making a call to
843 SHELLENV_FREE_FILE_LIST.
845 @param[in] Arg The pointer to the path of the files to be opened.
846 @param[in, out] ListHead The pointer to allocated and initialized list head
847 upon which to append all the opened file structures.
849 @retval EFI_SUCCESS One or more files was opened and a struct of each file's
850 information was appended to ListHead.
851 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
852 @retval EFI_NOT_FOUND No matching files could be found.
853 @sa SHELLENV_FREE_FILE_LIST
857 (EFIAPI
*SHELLENV_FILE_META_ARG_NO_WILDCARD
)(
859 IN OUT LIST_ENTRY
*ListHead
863 This function removes duplicate file listings from lists.
865 This is a function for use with SHELLENV_FILE_META_ARG_NO_WILDCARD and
866 SHELLENV_FILE_META_ARG. This function will verify that there are no duplicate
867 files in the list of returned files. Any file listed twice will have one of its
870 @param[in] ListHead The pointer to linked list head that was returned from
871 SHELLENV_FILE_META_ARG_NO_WILDCARD or
872 SHELLENV_FILE_META_ARG.
874 @retval EFI_SUCCESS This function always returns success.
879 (EFIAPI
*SHELLENV_DEL_DUP_FILE
)(
880 IN LIST_ENTRY
*ListHead
884 Converts a File System map name to a device path.
886 If DevPath is NULL, then ASSERT().
888 This function looks through the shell environment map for a map whose Name
889 matches the Name parameter. If one is found, the device path pointer is
890 updated to point to that file systems device path. The caller should not
891 free the memory from that device path.
893 This function will use the internal lock to prevent changes to the map during
894 the lookup operation.
896 @param[in] Name The pointer to the NULL terminated UNICODE string of the
898 @param[out] DevPath The pointer to pointer to DevicePath. Only valid on
901 @retval EFI_SUCCESS The conversion was successful, and the device
903 @retval EFI_NOT_FOUND The file system could not be found in the map.
907 (EFIAPI
*SHELLENV_GET_FS_DEVICE_PATH
)(
909 OUT EFI_DEVICE_PATH_PROTOCOL
**DevPath
912 /// EFI_SHELL_ENVIRONMENT2 protocol structure.
914 SHELLENV_EXECUTE Execute
;
915 SHELLENV_GET_ENV GetEnv
;
916 SHELLENV_GET_MAP GetMap
;
917 SHELLENV_ADD_CMD AddCmd
;
918 SHELLENV_ADD_PROT AddProt
;
919 SHELLENV_GET_PROT GetProt
;
920 SHELLENV_CUR_DIR CurDir
;
921 SHELLENV_FILE_META_ARG FileMetaArg
;
922 SHELLENV_FREE_FILE_LIST FreeFileList
;
925 // The following services are only used by the shell itself.
927 SHELLENV_NEW_SHELL NewShell
;
928 SHELLENV_BATCH_IS_ACTIVE BatchIsActive
;
930 SHELLENV_FREE_RESOURCES FreeResources
;
933 // GUID to differentiate ShellEnvironment2 from ShellEnvironment.
937 // Major Version grows if shell environment interface has been changes.
941 SHELLENV_ENABLE_PAGE_BREAK EnablePageBreak
;
942 SHELLENV_DISABLE_PAGE_BREAK DisablePageBreak
;
943 SHELLENV_GET_PAGE_BREAK GetPageBreak
;
945 SHELLENV_SET_KEY_FILTER SetKeyFilter
;
946 SHELLENV_GET_KEY_FILTER GetKeyFilter
;
948 SHELLENV_GET_EXECUTION_BREAK GetExecutionBreak
;
949 SHELLENV_INCREMENT_SHELL_NESTING_LEVEL IncrementShellNestingLevel
;
950 SHELLENV_DECREMENT_SHELL_NESTING_LEVEL DecrementShellNestingLevel
;
951 SHELLENV_IS_ROOT_SHELL IsRootShell
;
953 SHELLENV_CLOSE_CONSOLE_PROXY CloseConsoleProxy
;
954 HANDLE_ENUMERATOR HandleEnumerator
;
955 PROTOCOL_INFO_ENUMERATOR ProtocolInfoEnumerator
;
956 GET_DEVICE_NAME GetDeviceName
;
957 GET_SHELL_MODE GetShellMode
;
958 SHELLENV_NAME_TO_PATH NameToPath
;
959 SHELLENV_GET_FS_NAME GetFsName
;
960 SHELLENV_FILE_META_ARG_NO_WILDCARD FileMetaArgNoWildCard
;
961 SHELLENV_DEL_DUP_FILE DelDupFileArg
;
962 SHELLENV_GET_FS_DEVICE_PATH GetFsDevicePath
;
963 } EFI_SHELL_ENVIRONMENT2
;
965 extern EFI_GUID gEfiShellEnvironment2Guid
;
966 extern EFI_GUID gEfiShellEnvironment2ExtGuid
;
968 #endif // _SHELL_ENVIRONMENT_2_PROTOCOL_H_