DevicePathPropertyDatabase.h

Go to the documentation of this file.

 
#ifndef DEVICE_PATH_PROPERTY_DATABASE_H
#define DEVICE_PATH_PROPERTY_DATABASE_H
 
// EFI_DEVICE_PATH_PROPERTY_DATABASE_PROTOCOL_REVISION
#define EFI_DEVICE_PATH_PROPERTY_DATABASE_PROTOCOL_REVISION  0x00010000
 
// Related definitions
 
// DEVICE_PATH_PROPERTY_DATA
typedef struct {
  UINT32    Size; 
  UINT8     Data[];
} EFI_DEVICE_PATH_PROPERTY_DATA;
 
// DEVICE_PATH_PROPERTY_BUFFER_NODE_HDR
typedef struct {
  UINT32    Size;               
  UINT32    NumberOfProperties; 
} EFI_DEVICE_PATH_PROPERTY_BUFFER_NODE_HDR;
 
// DEVICE_PATH_PROPERTY_BUFFER_NODE
typedef struct {
  EFI_DEVICE_PATH_PROPERTY_BUFFER_NODE_HDR    Hdr;
  EFI_DEVICE_PATH_PROTOCOL                    DevicePath;
 
  // EFI_DEVICE_PATH_PROPERTY_DATA Data;
} EFI_DEVICE_PATH_PROPERTY_BUFFER_NODE;
 
// DEVICE_PATH_PROPERTY_BUFFER
typedef struct {
  UINT32                                  Size;
  UINT32                                  Version;
  UINT32                                  NumberOfNodes;
  EFI_DEVICE_PATH_PROPERTY_BUFFER_NODE    Nodes[];
} EFI_DEVICE_PATH_PROPERTY_BUFFER;
 
// Protocol declaration
 
// EFI_DEVICE_PATH_PROPERTY_DATABASE_PROTOCOL_GUID
#define EFI_DEVICE_PATH_PROPERTY_DATABASE_PROTOCOL_GUID   \
  { 0x91BD12FE, 0xF6C3, 0x44FB,                           \
    { 0xA5, 0xB7, 0x51, 0x22, 0xAB, 0x30, 0x3A, 0xE0 } }
 
typedef
  struct EFI_DEVICE_PATH_PROPERTY_DATABASE_PROTOCOL
EFI_DEVICE_PATH_PROPERTY_DATABASE_PROTOCOL;
 
// DPP_DATABASE_GET_PROPERTY
 
typedef
EFI_STATUS
(EFIAPI *DPP_DATABASE_GET_PROPERTY)(
  IN     EFI_DEVICE_PATH_PROPERTY_DATABASE_PROTOCOL  *This,
  IN     EFI_DEVICE_PATH_PROTOCOL                    *DevicePath,
  IN     CONST CHAR16                                *Name,
  OUT    VOID                                        *Value OPTIONAL,
  IN OUT UINTN                                       *Size
  );
 
// DPP_DATABASE_SET_PROPERTY
 
typedef
EFI_STATUS
(EFIAPI *DPP_DATABASE_SET_PROPERTY)(
  IN EFI_DEVICE_PATH_PROPERTY_DATABASE_PROTOCOL  *This,
  IN EFI_DEVICE_PATH_PROTOCOL                    *DevicePath,
  IN CONST CHAR16                                *Name,
  IN VOID                                        *Value,
  IN UINTN                                       Size
  );
 
// DPP_DATABASE_REMOVE_PROPERTY
 
typedef
EFI_STATUS
(EFIAPI *DPP_DATABASE_REMOVE_PROPERTY)(
  IN EFI_DEVICE_PATH_PROPERTY_DATABASE_PROTOCOL  *This,
  IN EFI_DEVICE_PATH_PROTOCOL                    *DevicePath,
  IN CONST CHAR16                                *Name
  );
 
// DPP_DATABASE_GET_PROPERTY_BUFFER
 
typedef
EFI_STATUS
(EFIAPI *DPP_DATABASE_GET_PROPERTY_BUFFER)(
  IN     EFI_DEVICE_PATH_PROPERTY_DATABASE_PROTOCOL  *This,
  OUT    EFI_DEVICE_PATH_PROPERTY_BUFFER             *Buffer OPTIONAL,
  IN OUT UINTN                                       *Size
  );
 
// EFI_DEVICE_PATH_PROPERTY_DATABASE_PROTOCOL
struct EFI_DEVICE_PATH_PROPERTY_DATABASE_PROTOCOL {
  UINT64                              Revision;
 
  DPP_DATABASE_GET_PROPERTY           GetProperty;
 
  DPP_DATABASE_SET_PROPERTY           SetProperty;
 
  DPP_DATABASE_REMOVE_PROPERTY        RemoveProperty;
 
  DPP_DATABASE_GET_PROPERTY_BUFFER    GetPropertyBuffer;
};
 
// gEfiDevicePathPropertyDatabaseProtocolGuid
extern EFI_GUID  gEfiDevicePathPropertyDatabaseProtocolGuid;
 
#endif // DEVICE_PATH_PROPERTY_DATABASE_H