DevicePathUtilities.h File Reference

Data Structures
struct	EFI_DEVICE_PATH_UTILITIES_PROTOCOL

Macros
#define	EFI_DEVICE_PATH_UTILITIES_PROTOCOL_GUID

Typedefs
typedef UINTN(EFIAPI *	EFI_DEVICE_PATH_UTILS_GET_DEVICE_PATH_SIZE )(IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath)
typedef EFI_DEVICE_PATH_PROTOCOL *(EFIAPI *	EFI_DEVICE_PATH_UTILS_DUP_DEVICE_PATH )(IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath)
typedef EFI_DEVICE_PATH_PROTOCOL *(EFIAPI *	EFI_DEVICE_PATH_UTILS_APPEND_PATH )(IN CONST EFI_DEVICE_PATH_PROTOCOL *Src1, IN CONST EFI_DEVICE_PATH_PROTOCOL *Src2)
typedef EFI_DEVICE_PATH_PROTOCOL *(EFIAPI *	EFI_DEVICE_PATH_UTILS_APPEND_NODE )(IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath, IN CONST EFI_DEVICE_PATH_PROTOCOL *DeviceNode)
typedef EFI_DEVICE_PATH_PROTOCOL *(EFIAPI *	EFI_DEVICE_PATH_UTILS_APPEND_INSTANCE )(IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath, IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePathInstance)
typedef EFI_DEVICE_PATH_PROTOCOL *(EFIAPI *	EFI_DEVICE_PATH_UTILS_GET_NEXT_INSTANCE )(IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePathInstance, OUT UINTN *DevicePathInstanceSize)
typedef EFI_DEVICE_PATH_PROTOCOL *(EFIAPI *	EFI_DEVICE_PATH_UTILS_CREATE_NODE )(IN UINT8 NodeType, IN UINT8 NodeSubType, IN UINT16 NodeLength)
typedef BOOLEAN(EFIAPI *	EFI_DEVICE_PATH_UTILS_IS_MULTI_INSTANCE )(IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath)

Variables
EFI_GUID	gEfiDevicePathUtilitiesProtocolGuid

Detailed Description

EFI_DEVICE_PATH_UTILITIES_PROTOCOL as defined in UEFI 2.0. Use to create and manipulate device paths and device nodes.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Macro Definition Documentation

#define EFI_DEVICE_PATH_UTILITIES_PROTOCOL_GUID

Value:

{ \
    0x379be4e, 0xd706, 0x437d, {0xb0, 0x37, 0xed, 0xb8, 0x2f, 0xb7, 0x72, 0xa4 } \
  }

Device Path Utilities protocol

Typedef Documentation

typedef EFI_DEVICE_PATH_PROTOCOL*(EFIAPI * EFI_DEVICE_PATH_UTILS_APPEND_INSTANCE)(IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath, IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePathInstance)

Creates a new path by appending the specified device path instance to the specified device path.

Parameters

DevicePath	Points to the device path. If NULL, then ignored.
DevicePathInstance	Points to the device path instance.

Return values

Pointer	A pointer to the newly created device path
NULL	Memory could not be allocated or DevicePathInstance is NULL.

typedef EFI_DEVICE_PATH_PROTOCOL*(EFIAPI * EFI_DEVICE_PATH_UTILS_APPEND_NODE)(IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath, IN CONST EFI_DEVICE_PATH_PROTOCOL *DeviceNode)

Creates a new path by appending the device node to the device path. If DeviceNode is NULL then a copy of DevicePath is returned. If DevicePath is NULL then a copy of DeviceNode, followed by an end-of-device path device node is returned. If both DeviceNode and DevicePath are NULL then a copy of an end-of-device-path device node is returned.

Parameters

DevicePath	Points to the device path.
DeviceNode	Points to the device node.

Return values

Pointer	A pointer to the allocated device node.
NULL	There was insufficient memory.

typedef EFI_DEVICE_PATH_PROTOCOL*(EFIAPI * EFI_DEVICE_PATH_UTILS_APPEND_PATH)(IN CONST EFI_DEVICE_PATH_PROTOCOL *Src1, IN CONST EFI_DEVICE_PATH_PROTOCOL *Src2)

Create a new path by appending the second device path to the first. If Src1 is NULL and Src2 is non-NULL, then a duplicate of Src2 is returned. If Src1 is non-NULL and Src2 is NULL, then a duplicate of Src1 is returned. If Src1 and Src2 are both NULL, then a copy of an end-of-device-path is returned.

Parameters

Src1	Points to the first device path.
Src2	Points to the second device path.

Return values

Pointer	A pointer to the newly created device path.
NULL	Memory could not be allocated

typedef EFI_DEVICE_PATH_PROTOCOL*(EFIAPI * EFI_DEVICE_PATH_UTILS_CREATE_NODE)(IN UINT8 NodeType, IN UINT8 NodeSubType, IN UINT16 NodeLength)

Creates a device node

Parameters

NodeType	NodeType is the device node type (EFI_DEVICE_PATH.Type) for the new device node.
NodeSubType	NodeSubType is the device node sub-type EFI_DEVICE_PATH.SubType) for the new device node.
NodeLength	NodeLength is the length of the device node (EFI_DEVICE_PATH.Length) for the new device node.

Return values

Pointer	A pointer to the newly created device node.
NULL	NodeLength is less than the size of the header or there was insufficient memory.

typedef EFI_DEVICE_PATH_PROTOCOL*(EFIAPI * EFI_DEVICE_PATH_UTILS_DUP_DEVICE_PATH)(IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath)

Create a duplicate of the specified path.

Parameters

DevicePath

Points to the source EFI device path.

Return values

Pointer	A pointer to the duplicate device path.
NULL	insufficient memory or DevicePath is NULL

typedef UINTN(EFIAPI * EFI_DEVICE_PATH_UTILS_GET_DEVICE_PATH_SIZE)(IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath)

Returns the size of the device path, in bytes.

Parameters

DevicePath

Points to the start of the EFI device path.

Returns

Size Size of the specified device path, in bytes, including the end-of-path tag.

Return values

0	DevicePath is NULL

typedef EFI_DEVICE_PATH_PROTOCOL*(EFIAPI * EFI_DEVICE_PATH_UTILS_GET_NEXT_INSTANCE)(IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePathInstance, OUT UINTN *DevicePathInstanceSize)

Creates a copy of the current device path instance and returns a pointer to the next device path instance.

Parameters

DevicePathInstance	On input, this holds the pointer to the current device path instance. On output, this holds the pointer to the next device path instance or NULL if there are no more device path instances in the device path.
DevicePathInstanceSize	On output, this holds the size of the device path instance, in bytes or zero, if DevicePathInstance is NULL. If NULL, then the instance size is not output.

Return values

Pointer	A pointer to the copy of the current device path instance.
NULL	DevicePathInstace was NULL on entry or there was insufficient memory.

typedef BOOLEAN(EFIAPI * EFI_DEVICE_PATH_UTILS_IS_MULTI_INSTANCE)(IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath)

Returns whether a device path is multi-instance.

Parameters

DevicePath

Points to the device path. If NULL, then ignored.

Return values

TRUE	The device path has more than one instance
FALSE	The device path is empty or contains only a single instance.

Variable Documentation

EFI_GUID gEfiDevicePathUtilitiesProtocolGuid