FileExplorer.h

Go to the documentation of this file.

 
#ifndef _FILE_EXPLORER_H_
#define _FILE_EXPLORER_H_
 
#include <PiDxe.h>
#include <Guid/FileSystemVolumeLabelInfo.h>
#include <Guid/FileInfo.h>
#include <Guid/MdeModuleHii.h>
 
#include <Protocol/HiiConfigAccess.h>
#include <Protocol/DevicePath.h>
#include <Protocol/SimpleFileSystem.h>
#include <Protocol/DevicePathToText.h>
#include <Protocol/FormBrowser2.h>
 
#include <Library/DebugLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/BaseLib.h>
#include <Library/UefiLib.h>
#include <Library/DevicePathLib.h>
#include <Library/FileExplorerLib.h>
#include <Library/HiiLib.h>
#include <Library/PrintLib.h>
 
#include "FormGuid.h"
 
#define FILE_EXPLORER_CALLBACK_DATA_SIGNATURE  SIGNATURE_32 ('f', 'e', 'c', 'k')
 
#pragma pack(1)
 
typedef struct {
  VENDOR_DEVICE_PATH          VendorDevicePath;
  EFI_DEVICE_PATH_PROTOCOL    End;
} HII_VENDOR_DEVICE_PATH;
 
#pragma pack()
 
typedef struct {
  EFI_HANDLE                  DeviceHandle;
  EFI_DEVICE_PATH_PROTOCOL    *DevicePath;
  EFI_FILE_HANDLE             FileHandle;
  UINT16                      *FileName;
 
  BOOLEAN                     IsRoot;
  BOOLEAN                     IsDir;
} FILE_CONTEXT;
 
typedef struct {
  UINTN            Signature;
  LIST_ENTRY       Link;
  UINT16           *DisplayString;
  UINT16           *HelpString;
  EFI_STRING_ID    DisplayStringToken;
  EFI_STRING_ID    HelpStringToken;
  VOID             *VariableContext;
} MENU_ENTRY;
 
typedef struct {
  UINTN         Signature;
  LIST_ENTRY    Head;
  UINTN         MenuNumber;
  BOOLEAN       Used;
} MENU_OPTION;
 
typedef struct {
  //
  // Shared callback data.
  //
  UINTN                             Signature;
 
  //
  // File explorer formset callback data.
  //
  EFI_HII_HANDLE                    FeHiiHandle;
  EFI_HANDLE                        FeDriverHandle;
  EFI_HII_CONFIG_ACCESS_PROTOCOL    FeConfigAccess;
  EFI_FORM_BROWSER2_PROTOCOL        *FormBrowser2;
  MENU_OPTION                       *FsOptionMenu;
  CHAR16                            *FileType;
  CHOOSE_HANDLER                    ChooseHandler;
  EFI_DEVICE_PATH_PROTOCOL          *RetDevicePath;
} FILE_EXPLORER_CALLBACK_DATA;
 
#define FILE_EXPLORER_PRIVATE_FROM_THIS(a)  CR (a, FILE_EXPLORER_CALLBACK_DATA, FeConfigAccess, FILE_EXPLORER_CALLBACK_DATA_SIGNATURE)
 
extern UINT8  FileExplorerVfrBin[];
 
#define MENU_OPTION_SIGNATURE  SIGNATURE_32 ('m', 'e', 'n', 'u')
#define MENU_ENTRY_SIGNATURE   SIGNATURE_32 ('e', 'n', 't', 'r')
 
#define MAX_CHAR                     480
#define FILE_OPTION_OFFSET           0x8000
#define FILE_OPTION_MASK             0x7FFF
#define QUESTION_ID_UPDATE_STEP      200
#define MAX_FILE_NAME_LEN            20
#define MAX_FOLDER_NAME_LEN          20
#define NEW_FILE_QUESTION_ID_BASE    0x5000;
#define NEW_FOLDER_QUESTION_ID_BASE  0x6000;
 
EFI_STATUS
EFIAPI
LibCallback (
  IN  CONST EFI_HII_CONFIG_ACCESS_PROTOCOL  *This,
  IN  EFI_BROWSER_ACTION                    Action,
  IN  EFI_QUESTION_ID                       QuestionId,
  IN  UINT8                                 Type,
  IN  EFI_IFR_TYPE_VALUE                    *Value,
  OUT EFI_BROWSER_ACTION_REQUEST            *ActionRequest
  );
 
EFI_STATUS
EFIAPI
LibExtractConfig (
  IN  CONST EFI_HII_CONFIG_ACCESS_PROTOCOL  *This,
  IN  CONST EFI_STRING                      Request,
  OUT EFI_STRING                            *Progress,
  OUT EFI_STRING                            *Results
  );
 
EFI_STATUS
EFIAPI
LibRouteConfig (
  IN  CONST EFI_HII_CONFIG_ACCESS_PROTOCOL  *This,
  IN  CONST EFI_STRING                      Configuration,
  OUT EFI_STRING                            *Progress
  );
 
EFI_STATUS
LibUpdateFileExplorer (
  IN UINT16  KeyValue
  );
 
VOID
LibGetDevicePath (
  IN UINT16  KeyValue
  );
 
#endif