DevicePathPropertyDatabase.h File Reference

Go to the source code of this file.

Data Structures
struct	EFI_DEVICE_PATH_PROPERTY_DATA
	The structure defining the header of a Device Path Property. More...
struct	EFI_DEVICE_PATH_PROPERTY_BUFFER_NODE_HDR
	The node header structure. More...
struct	EFI_DEVICE_PATH_PROPERTY_BUFFER_NODE
	The structure defining the header of a Device Property node. More...
struct	EFI_DEVICE_PATH_PROPERTY_BUFFER
	The structure defining the header of a Device Property Buffer. More...
struct	EFI_DEVICE_PATH_PROPERTY_DATABASE_PROTOCOL
	The structure exposed by the EFI_DEVICE_PATH_PROPERTY_DATABASE_PROTOCOL. More...

Macros
#define	EFI_DEVICE_PATH_PROPERTY_DATABASE_PROTOCOL_REVISION   0x00010000
#define	EFI_DEVICE_PATH_PROPERTY_DATABASE_PROTOCOL_GUID
	The GUID of the EFI_DEVICE_PATH_PROPERTY_DATABASE_PROTOCOL.

Typedefs
typedef struct EFI_DEVICE_PATH_PROPERTY_DATABASE_PROTOCOL	EFI_DEVICE_PATH_PROPERTY_DATABASE_PROTOCOL
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)
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)
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)
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)

Variables
EFI_GUID	gEfiDevicePathPropertyDatabaseProtocolGuid

Detailed Description

Copyright (C) 2014 - 2017, Download-Fritz. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Definition in file DevicePathPropertyDatabase.h.

Macro Definition Documentation

EFI_DEVICE_PATH_PROPERTY_DATABASE_PROTOCOL_GUID

#define EFI_DEVICE_PATH_PROPERTY_DATABASE_PROTOCOL_GUID

Value:

  { 0x91BD12FE, 0xF6C3, 0x44FB,                           \
    { 0xA5, 0xB7, 0x51, 0x22, 0xAB, 0x30, 0x3A, 0xE0 } }

The GUID of the EFI_DEVICE_PATH_PROPERTY_DATABASE_PROTOCOL.

Definition at line 66 of file DevicePathPropertyDatabase.h.

EFI_DEVICE_PATH_PROPERTY_DATABASE_PROTOCOL_REVISION

#define EFI_DEVICE_PATH_PROPERTY_DATABASE_PROTOCOL_REVISION   0x00010000

Definition at line 17 of file DevicePathPropertyDatabase.h.

Typedef Documentation

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)

Locates a device property in the database and returns its value into Value.

Parameters

[in]	This	Protocol instance pointer.
[in]	DevicePath	The device path of the device to get the property of.
[in]	Name	The Name of the requested property.
[out]	Value	The Buffer allocated by the caller to return the value of the property into.
[in,out]	Size	On input the size of the allocated Value Buffer. On output the size required to fill the Buffer.

Return values

EFI_BUFFER_TOO_SMALL	The memory required to return the value exceeds the size of the allocated Buffer. The required size to complete the operation has been returned into Size.
EFI_NOT_FOUND	The given device path does not have a property with the specified Name.
EFI_SUCCESS	The operation completed successfully.

Definition at line 96 of file DevicePathPropertyDatabase.h.

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)

Returns a Buffer of all device properties into Buffer.

Parameters

[in]	This	Protocol instance pointer.
[out]	Buffer	The Buffer allocated by the caller to return the property Buffer into.
[in,out]	Size	On input the size of the allocated Buffer. On output the size required to fill the Buffer.

Return values

EFI_BUFFER_TOO_SMALL	The memory required to return the value exceeds the size of the allocated Buffer. The required size to complete the operation has been returned into Size.
EFI_SUCCESS	The operation completed successfully.

Definition at line 166 of file DevicePathPropertyDatabase.h.

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)

Removes the sepcified property from the given device path.

Parameters

[in]	This	Protocol instance pointer.
[in]	DevicePath	The device path of the device to set the property of.
[in]	Name	The Name of the desired property.

Return values

EFI_NOT_FOUND	The given device path does not have a property with the specified Name.
EFI_SUCCESS	The operation completed successfully.

Definition at line 142 of file DevicePathPropertyDatabase.h.

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)

Sets the sepcified property of the given device path to the provided Value.

Parameters

[in]	This	Protocol instance pointer.
[in]	DevicePath	The device path of the device to set the property of.
[in]	Name	The Name of the desired property.
[in]	Value	The Buffer holding the value to set the property to.
[out]	Size	The size of the Value Buffer.

Return values

EFI_OUT_OF_RESOURCES	The memory necessary to complete the operation could not be allocated.
EFI_SUCCESS	The operation completed successfully.

Definition at line 120 of file DevicePathPropertyDatabase.h.

EFI_DEVICE_PATH_PROPERTY_DATABASE_PROTOCOL

typedef struct EFI_DEVICE_PATH_PROPERTY_DATABASE_PROTOCOL EFI_DEVICE_PATH_PROPERTY_DATABASE_PROTOCOL

Definition at line 72 of file DevicePathPropertyDatabase.h.

Variable Documentation

gEfiDevicePathPropertyDatabaseProtocolGuid

EFI_GUID gEfiDevicePathPropertyDatabaseProtocolGuid

extern