EfiShellEnvironment2.h

Go to the documentation of this file.

 
#ifndef _SHELL_ENVIRONMENT_2_PROTOCOL_H_
#define _SHELL_ENVIRONMENT_2_PROTOCOL_H_
 
#define DEFAULT_INIT_ROW  1
#define DEFAULT_AUTO_LF   FALSE
 
typedef
VOID
(EFIAPI *SHELLENV_DUMP_PROTOCOL_INFO)(
  IN EFI_HANDLE                   Handle,
  IN VOID                         *Interface
  );
 
typedef
EFI_STATUS
(EFIAPI *SHELLENV_INTERNAL_COMMAND)(
  IN EFI_HANDLE                   ImageHandle,
  IN EFI_SYSTEM_TABLE             *SystemTable
  );
 
typedef
EFI_STATUS
(EFIAPI *SHELLCMD_GET_LINE_HELP)(
  IN OUT CHAR16                 **Str
  );
 
typedef struct {
  UINT32                      Signature;          
  LIST_ENTRY                  Link;               
  EFI_STATUS                  Status;             
 
  EFI_FILE_HANDLE             Parent;             
  UINT64                      OpenMode;           
  CHAR16                      *ParentName;        
  EFI_DEVICE_PATH_PROTOCOL    *ParentDevicePath;  
 
  CHAR16                      *FullName;          
  CHAR16                      *FileName;          
 
  EFI_FILE_HANDLE             Handle;             
  EFI_FILE_INFO               *Info;              
} SHELL_FILE_ARG;
 
#define SHELL_FILE_ARG_SIGNATURE  SIGNATURE_32 ('g', 'r', 'a', 'f')
 
#define SHELL_ENVIRONMENT_PROTOCOL_GUID \
  { \
    0x47c7b221, 0xc42a, 0x11d2, {0x8e, 0x57, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b} \
  }
 
#define EFI_SE_EXT_SIGNATURE_GUID \
  { \
    0xd2c18636, 0x40e5, 0x4eb5, {0xa3, 0x1b, 0x36, 0x69, 0x5f, 0xd4, 0x2c, 0x87} \
  }
 
#define EFI_SHELL_MAJOR_VER  0x00000001 
#define EFI_SHELL_MINOR_VER  0x00000000 
 
typedef
EFI_STATUS
(EFIAPI *SHELLENV_EXECUTE)(
  IN EFI_HANDLE   *ParentImageHandle,
  IN CHAR16       *CommandLine,
  IN BOOLEAN      DebugOutput
  );
 
typedef
CHAR16 *
(EFIAPI *SHELLENV_GET_ENV)(
  IN CHAR16 *Name
  );
 
typedef
CHAR16 *
(EFIAPI *SHELLENV_GET_MAP)(
  IN CHAR16 *Name
  );
 
typedef
EFI_STATUS
(EFIAPI *SHELLENV_ADD_CMD)(
  IN SHELLENV_INTERNAL_COMMAND    Handler,
  IN CHAR16                       *Cmd,
  IN SHELLCMD_GET_LINE_HELP       GetLineHelp
  );
 
typedef
VOID
(EFIAPI *SHELLENV_ADD_PROT)(
  IN EFI_GUID                     *Protocol,
  IN SHELLENV_DUMP_PROTOCOL_INFO  DumpToken OPTIONAL,
  IN SHELLENV_DUMP_PROTOCOL_INFO  DumpInfo OPTIONAL,
  IN CHAR16                       *IdString
  );
 
typedef
CHAR16 *
(EFIAPI *SHELLENV_GET_PROT)(
  IN EFI_GUID *Protocol,
  IN BOOLEAN GenId
  );
 
typedef
CHAR16 *
(EFIAPI *SHELLENV_CUR_DIR)(
  IN CHAR16 *DeviceName OPTIONAL
  );
typedef
EFI_STATUS
(EFIAPI *SHELLENV_FILE_META_ARG)(
  IN CHAR16               *Arg,
  IN OUT LIST_ENTRY       *ListHead
  );
 
typedef
EFI_STATUS
(EFIAPI *SHELLENV_FREE_FILE_LIST)(
  IN OUT LIST_ENTRY       *ListHead
  );
 
typedef
EFI_SHELL_INTERFACE *
(EFIAPI *SHELLENV_NEW_SHELL)(
  IN EFI_HANDLE ImageHandle
  );
 
typedef
BOOLEAN
(EFIAPI *SHELLENV_BATCH_IS_ACTIVE)(
  VOID
  );
 
typedef
VOID
(EFIAPI *SHELLENV_FREE_RESOURCES)(
  VOID
  );
 
typedef
VOID
(EFIAPI *SHELLENV_ENABLE_PAGE_BREAK)(
  IN INT32      StartRow,
  IN BOOLEAN    AutoWrap
  );
 
typedef
VOID
(EFIAPI *SHELLENV_DISABLE_PAGE_BREAK)(
  VOID
  );
 
typedef
BOOLEAN
(EFIAPI *SHELLENV_GET_PAGE_BREAK)(
  VOID
  );
 
typedef
VOID
(EFIAPI *SHELLENV_SET_KEY_FILTER)(
  IN UINT32      KeyFilter
  );
 
typedef
UINT32
(EFIAPI *SHELLENV_GET_KEY_FILTER)(
  VOID
  );
 
typedef
BOOLEAN
(EFIAPI *SHELLENV_GET_EXECUTION_BREAK)(
  VOID
  );
 
typedef
VOID
(EFIAPI *SHELLENV_INCREMENT_SHELL_NESTING_LEVEL)(
  VOID
  );
 
typedef
VOID
(EFIAPI *SHELLENV_DECREMENT_SHELL_NESTING_LEVEL)(
  VOID
  );
 
typedef
BOOLEAN
(EFIAPI *SHELLENV_IS_ROOT_SHELL)(
  VOID
  );
 
typedef
VOID
(EFIAPI *SHELLENV_CLOSE_CONSOLE_PROXY)(
  IN     EFI_HANDLE                       ConInHandle,
  IN OUT EFI_SIMPLE_TEXT_INPUT_PROTOCOL   **ConIn,
  IN     EFI_HANDLE                       ConOutHandle,
  IN OUT EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  **ConOut
  );
 
//
// declarations of handle enumerator
//
 
typedef
VOID
(EFIAPI *INIT_HANDLE_ENUMERATOR)(
  VOID
  );
 
typedef
EFI_STATUS
(EFIAPI *NEXT_HANDLE)(
  IN OUT EFI_HANDLE             **Handle
  );
 
typedef
EFI_STATUS
(EFIAPI *SKIP_HANDLE)(
  IN UINTN                   SkipNum
  );
 
typedef
UINTN
(EFIAPI *RESET_HANDLE_ENUMERATOR)(
  IN UINTN                  EnumIndex
  );
 
typedef
VOID
(EFIAPI *CLOSE_HANDLE_ENUMERATOR)(
  VOID
  );
 
typedef
UINTN
(EFIAPI *GET_NUM)(
  VOID
  );
 
typedef struct {
  INIT_HANDLE_ENUMERATOR     Init;   
  NEXT_HANDLE                Next;   
  SKIP_HANDLE                Skip;   
  RESET_HANDLE_ENUMERATOR    Reset;  
  CLOSE_HANDLE_ENUMERATOR    Close;  
  GET_NUM                    GetNum; 
} HANDLE_ENUMERATOR;
 
#define PROTOCOL_INFO_SIGNATURE  SIGNATURE_32 ('s', 'p', 'i', 'n')
 
typedef struct {
  UINTN                          Signature; 
  LIST_ENTRY                     Link;      
  //
  // The parsing info for the protocol.
  //
  EFI_GUID                       ProtocolId; 
  CHAR16                         *IdString;  
  SHELLENV_DUMP_PROTOCOL_INFO    DumpToken;  
  SHELLENV_DUMP_PROTOCOL_INFO    DumpInfo;   
  //
  // Patabase info on which handles are supporting this protocol.
  //
  UINTN                          NoHandles; 
  EFI_HANDLE                     *Handles;  
} PROTOCOL_INFO;
 
//
// Declarations of protocol info enumerator.
//
 
typedef
VOID
(EFIAPI *INIT_PROTOCOL_INFO_ENUMERATOR)(
  VOID
  );
 
typedef
EFI_STATUS
(EFIAPI *NEXT_PROTOCOL_INFO)(
  IN OUT PROTOCOL_INFO            **ProtocolInfo
  );
 
typedef
EFI_STATUS
(EFIAPI *SKIP_PROTOCOL_INFO)(
  IN UINTN                         SkipNum
  );
 
typedef
VOID
(EFIAPI *RESET_PROTOCOL_INFO_ENUMERATOR)(
  VOID
  );
 
typedef
VOID
(EFIAPI *CLOSE_PROTOCOL_INFO_ENUMERATOR)(
  VOID
  );
 
typedef struct {
  INIT_PROTOCOL_INFO_ENUMERATOR     Init;  
  NEXT_PROTOCOL_INFO                Next;  
  SKIP_PROTOCOL_INFO                Skip;  
  RESET_PROTOCOL_INFO_ENUMERATOR    Reset; 
  CLOSE_PROTOCOL_INFO_ENUMERATOR    Close; 
} PROTOCOL_INFO_ENUMERATOR;
 
typedef
EFI_STATUS
(EFIAPI *GET_DEVICE_NAME)(
  IN EFI_HANDLE  DeviceHandle,
  IN BOOLEAN     UseComponentName,
  IN BOOLEAN     UseDevicePath,
  IN CHAR8       *Language,
  IN OUT CHAR16  **BestDeviceName,
  OUT EFI_STATUS *ConfigurationStatus,
  OUT EFI_STATUS *DiagnosticsStatus,
  IN BOOLEAN     Display,
  IN UINTN       Indent
  );
 
#define EFI_SHELL_COMPATIBLE_MODE_VER  L"1.1.1" 
#define EFI_SHELL_ENHANCED_MODE_VER    L"1.1.2" 
 
typedef
EFI_STATUS
(EFIAPI *GET_SHELL_MODE)(
  OUT CHAR16     **Mode
  );
 
typedef
EFI_DEVICE_PATH_PROTOCOL *
(EFIAPI *SHELLENV_NAME_TO_PATH)(
  IN CHAR16 *Path
  );
 
typedef
EFI_STATUS
(EFIAPI *SHELLENV_GET_FS_NAME)(
  IN EFI_DEVICE_PATH_PROTOCOL     *DevPath,
  IN BOOLEAN                      ConsistMapping,
  OUT CHAR16                      **Name
  );
 
typedef
EFI_STATUS
(EFIAPI *SHELLENV_FILE_META_ARG_NO_WILDCARD)(
  IN CHAR16               *Arg,
  IN OUT LIST_ENTRY       *ListHead
  );
 
typedef
EFI_STATUS
(EFIAPI *SHELLENV_DEL_DUP_FILE)(
  IN LIST_ENTRY   *ListHead
  );
 
typedef
EFI_STATUS
(EFIAPI *SHELLENV_GET_FS_DEVICE_PATH)(
  IN CHAR16                        *Name,
  OUT EFI_DEVICE_PATH_PROTOCOL     **DevPath
  );
 
typedef struct {
  SHELLENV_EXECUTE                          Execute;
  SHELLENV_GET_ENV                          GetEnv;
  SHELLENV_GET_MAP                          GetMap;
  SHELLENV_ADD_CMD                          AddCmd;
  SHELLENV_ADD_PROT                         AddProt;
  SHELLENV_GET_PROT                         GetProt;
  SHELLENV_CUR_DIR                          CurDir;
  SHELLENV_FILE_META_ARG                    FileMetaArg;
  SHELLENV_FREE_FILE_LIST                   FreeFileList;
 
  //
  // The following services are only used by the shell itself.
  //
  SHELLENV_NEW_SHELL                        NewShell;
  SHELLENV_BATCH_IS_ACTIVE                  BatchIsActive;
 
  SHELLENV_FREE_RESOURCES                   FreeResources;
 
  //
  // GUID to differentiate ShellEnvironment2 from ShellEnvironment.
  //
  EFI_GUID                                  SESGuid;
  //
  // Major Version grows if shell environment interface has been changes.
  //
  UINT32                                    MajorVersion;
  UINT32                                    MinorVersion;
  SHELLENV_ENABLE_PAGE_BREAK                EnablePageBreak;
  SHELLENV_DISABLE_PAGE_BREAK               DisablePageBreak;
  SHELLENV_GET_PAGE_BREAK                   GetPageBreak;
 
  SHELLENV_SET_KEY_FILTER                   SetKeyFilter;
  SHELLENV_GET_KEY_FILTER                   GetKeyFilter;
 
  SHELLENV_GET_EXECUTION_BREAK              GetExecutionBreak;
  SHELLENV_INCREMENT_SHELL_NESTING_LEVEL    IncrementShellNestingLevel;
  SHELLENV_DECREMENT_SHELL_NESTING_LEVEL    DecrementShellNestingLevel;
  SHELLENV_IS_ROOT_SHELL                    IsRootShell;
 
  SHELLENV_CLOSE_CONSOLE_PROXY              CloseConsoleProxy;
  HANDLE_ENUMERATOR                         HandleEnumerator;
  PROTOCOL_INFO_ENUMERATOR                  ProtocolInfoEnumerator;
  GET_DEVICE_NAME                           GetDeviceName;
  GET_SHELL_MODE                            GetShellMode;
  SHELLENV_NAME_TO_PATH                     NameToPath;
  SHELLENV_GET_FS_NAME                      GetFsName;
  SHELLENV_FILE_META_ARG_NO_WILDCARD        FileMetaArgNoWildCard;
  SHELLENV_DEL_DUP_FILE                     DelDupFileArg;
  SHELLENV_GET_FS_DEVICE_PATH               GetFsDevicePath;
} EFI_SHELL_ENVIRONMENT2;
 
extern EFI_GUID  gEfiShellEnvironment2Guid;
extern EFI_GUID  gEfiShellEnvironment2ExtGuid;
 
#endif // _SHELL_ENVIRONMENT_2_PROTOCOL_H_