OcBootEntry.h

Go to the documentation of this file.

 
#ifndef OC_BOOT_ENTRY_PROTOCOL_H
#define OC_BOOT_ENTRY_PROTOCOL_H
 
#include <Uefi.h>
#include <Library/OcBootManagementLib.h>
 
#include <Protocol/SimpleFileSystem.h>
 
#define OC_BOOT_ENTRY_PROTOCOL_GUID                                                 \
  {                                                                                 \
    0x8604716E, 0xADD4, 0x45B4, { 0x84, 0x95, 0x08, 0xE3, 0x6D, 0x49, 0x7F, 0x4F }  \
  }
 
#define OC_BOOT_ENTRY_PROTOCOL_REVISION  6
 
typedef struct OC_BOOT_ENTRY_PROTOCOL_ OC_BOOT_ENTRY_PROTOCOL;
 
typedef
EFI_STATUS
(EFIAPI *OC_BOOT_ENTRY_PROTOCOL_GET_ENTRIES)(
  IN OUT         OC_PICKER_CONTEXT        *PickerContext,
  IN     CONST EFI_HANDLE               Device OPTIONAL,
  OUT       OC_PICKER_ENTRY          **Entries,
  OUT       UINTN                    *NumEntries
  );
 
typedef
VOID
(EFIAPI *OC_BOOT_ENTRY_PROTOCOL_FREE_ENTRIES)(
  IN           OC_PICKER_ENTRY          **Entries,
  IN           UINTN                    NumEntries
  );
 
typedef
CHAR8 *
(EFIAPI *OC_BOOT_ENTRY_PROTOCOL_CHECK_HOTKEYS)(
  IN OUT OC_PICKER_CONTEXT  *Context,
  IN UINTN               NumKeys,
  IN APPLE_MODIFIER_MAP  Modifiers,
  IN APPLE_KEY_CODE      *Keys
  );
 
typedef
BOOLEAN
(EFIAPI *OC_CONSUME_ENTRY_PROTOCOL_ACTION)(
  IN OUT OC_PICKER_CONTEXT  *PickerContext,
  IN EFI_HANDLE             BootEntryProtocolHandle,
  IN OC_BOOT_ENTRY_PROTOCOL *BootEntryProtocol,
  IN VOID                   *Context
  );
 
VOID
OcConsumeBootEntryProtocol (
  IN OUT  OC_PICKER_CONTEXT                 *PickerContext,
  IN      EFI_HANDLE                        *EntryProtocolHandles,
  IN      UINTN                             EntryProtocolHandleCount,
  IN      OC_CONSUME_ENTRY_PROTOCOL_ACTION  Action,
  IN      VOID                              *Context
  );
 
struct OC_BOOT_ENTRY_PROTOCOL_ {
  //
  // Protocol revision.
  //
  UINTN                                   Revision;
  //
  // Get boot entries. Optional.
  //
  OC_BOOT_ENTRY_PROTOCOL_GET_ENTRIES      GetBootEntries;
  //
  // Free boot entries.
  // Optional, NULL may set here by a protocol provider if the returned
  // entries are in statically allocated memory and do not need freeing.
  //
  OC_BOOT_ENTRY_PROTOCOL_FREE_ENTRIES     FreeBootEntries;
  //
  // Hotkey action. Optional.
  //
  OC_BOOT_ENTRY_PROTOCOL_CHECK_HOTKEYS    CheckHotKeys;
};
 
extern EFI_GUID  gOcBootEntryProtocolGuid;
 
#endif // OC_BOOT_ENTRY_PROTOCOL_H