MdePkg/Library/UefiDevicePathLib/DevicePathUtilities.c File Reference


Functions

BOOLEAN EFIAPI IsDevicePathValid (IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath, IN UINTN MaxSize)
UINT8 EFIAPI DevicePathType (IN CONST VOID *Node)
UINT8 EFIAPI DevicePathSubType (IN CONST VOID *Node)
UINTN EFIAPI DevicePathNodeLength (IN CONST VOID *Node)
EFI_DEVICE_PATH_PROTOCOL *EFIAPI NextDevicePathNode (IN CONST VOID *Node)
BOOLEAN EFIAPI IsDevicePathEndType (IN CONST VOID *Node)
BOOLEAN EFIAPI IsDevicePathEnd (IN CONST VOID *Node)
BOOLEAN EFIAPI IsDevicePathEndInstance (IN CONST VOID *Node)
UINT16 EFIAPI SetDevicePathNodeLength (IN OUT VOID *Node, IN UINTN Length)
VOID EFIAPI SetDevicePathEndNode (OUT VOID *Node)
UINTN EFIAPI UefiDevicePathLibGetDevicePathSize (IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath)
EFI_DEVICE_PATH_PROTOCOL *EFIAPI UefiDevicePathLibDuplicateDevicePath (IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath)
EFI_DEVICE_PATH_PROTOCOL *EFIAPI UefiDevicePathLibAppendDevicePath (IN CONST EFI_DEVICE_PATH_PROTOCOL *FirstDevicePath, IN CONST EFI_DEVICE_PATH_PROTOCOL *SecondDevicePath)
EFI_DEVICE_PATH_PROTOCOL *EFIAPI UefiDevicePathLibAppendDevicePathNode (IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath, IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePathNode)
EFI_DEVICE_PATH_PROTOCOL *EFIAPI UefiDevicePathLibAppendDevicePathInstance (IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath, IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePathInstance)
EFI_DEVICE_PATH_PROTOCOL *EFIAPI UefiDevicePathLibGetNextDevicePathInstance (IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath, OUT UINTN *Size)
EFI_DEVICE_PATH_PROTOCOL *EFIAPI UefiDevicePathLibCreateDeviceNode (IN UINT8 NodeType, IN UINT8 NodeSubType, IN UINT16 NodeLength)
BOOLEAN EFIAPI UefiDevicePathLibIsDevicePathMultiInstance (IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath)
EFI_DEVICE_PATH_PROTOCOL *EFIAPI DevicePathFromHandle (IN EFI_HANDLE Handle)
EFI_DEVICE_PATH_PROTOCOL *EFIAPI FileDevicePath (IN EFI_HANDLE Device, IN CONST CHAR16 *FileName)

Variables

GLOBAL_REMOVE_IF_UNREFERENCED
CONST EFI_DEVICE_PATH_PROTOCOL 
mUefiDevicePathLibEndDevicePath

Detailed Description

Device Path services. The thing to remember is device paths are built out of nodes. The device path is terminated by an end node that is length sizeof(EFI_DEVICE_PATH_PROTOCOL). That would be why there is sizeof(EFI_DEVICE_PATH_PROTOCOL) all over this file.

The only place where multi-instance device paths are supported is in environment varibles. Multi-instance device paths should never be placed on a Handle.

Copyright (c) 2006 - 2014, Intel Corporation. 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.


Function Documentation

EFI_DEVICE_PATH_PROTOCOL* EFIAPI DevicePathFromHandle ( IN EFI_HANDLE  Handle  ) 

Retrieves the device path protocol from a handle.

This function returns the device path protocol from the handle specified by Handle. If Handle is NULL or Handle does not contain a device path protocol, then NULL is returned.

Parameters:
Handle The handle from which to retrieve the device path protocol.
Returns:
The device path protocol from the handle specified by Handle.

References EFI_ERROR, gBS, gEfiDevicePathProtocolGuid, EFI_BOOT_SERVICES::HandleProtocol, NULL, and VOID.

UINTN EFIAPI DevicePathNodeLength ( IN CONST VOID *  Node  ) 

Returns the 16-bit Length field of a device path node.

Returns the 16-bit Length field of the device path node specified by Node. Node is not required to be aligned on a 16-bit boundary, so it is recommended that a function such as ReadUnaligned16() be used to extract the contents of the Length field.

If Node is NULL, then ASSERT().

Parameters:
Node A pointer to a device path node data structure.
Returns:
The 16-bit Length field of the device path node specified by Node.

References ASSERT, NULL, and ReadUnaligned16().

UINT8 EFIAPI DevicePathSubType ( IN CONST VOID *  Node  ) 

Returns the SubType field of a device path node.

Returns the SubType field of the device path node specified by Node.

If Node is NULL, then ASSERT().

Parameters:
Node A pointer to a device path node data structure.
Returns:
The SubType field of the device path node specified by Node.

References ASSERT, and NULL.

UINT8 EFIAPI DevicePathType ( IN CONST VOID *  Node  ) 

Returns the Type field of a device path node.

Returns the Type field of the device path node specified by Node.

If Node is NULL, then ASSERT().

Parameters:
Node A pointer to a device path node data structure.
Returns:
The Type field of the device path node specified by Node.

References ASSERT, and NULL.

EFI_DEVICE_PATH_PROTOCOL* EFIAPI FileDevicePath ( IN EFI_HANDLE  Device,
IN CONST CHAR16 FileName 
)

Allocates a device path for a file and appends it to an existing device path.

If Device is a valid device handle that contains a device path protocol, then a device path for the file specified by FileName is allocated and appended to the device path associated with the handle Device. The allocated device path is returned. If Device is NULL or Device is a handle that does not support the device path protocol, then a device path containing a single device path node for the file specified by FileName is allocated and returned. The memory for the new device path is allocated from EFI boot services memory. It is the responsibility of the caller to free the memory allocated.

If FileName is NULL, then ASSERT(). If FileName is not aligned on a 16-bit boundary, then ASSERT().

Parameters:
Device A pointer to a device handle. This parameter is optional and may be NULL.
FileName A pointer to a Null-terminated Unicode string.
Returns:
The allocated device path.

References AllocatePool(), AppendDevicePath(), CopyMem(), DevicePathFromHandle(), END_DEVICE_PATH_LENGTH, FileDevicePath(), FreePool(), FILEPATH_DEVICE_PATH::Header, MEDIA_DEVICE_PATH, MEDIA_FILEPATH_DP, NextDevicePathNode(), NULL, FILEPATH_DEVICE_PATH::PathName, SetDevicePathEndNode(), SetDevicePathNodeLength(), SIZE_OF_FILEPATH_DEVICE_PATH, StrSize(), EFI_DEVICE_PATH_PROTOCOL::SubType, and EFI_DEVICE_PATH_PROTOCOL::Type.

BOOLEAN EFIAPI IsDevicePathEnd ( IN CONST VOID *  Node  ) 

Determines if a device path node is an end node of an entire device path.

Determines if a device path node specified by Node is an end node of an entire device path. If Node represents the end of an entire device path, then TRUE is returned. Otherwise, FALSE is returned.

If Node is NULL, then ASSERT().

Parameters:
Node A pointer to a device path node data structure.
Return values:
TRUE The device path node specified by Node is the end of an entire device path.
FALSE The device path node specified by Node is not the end of an entire device path.

References ASSERT, DevicePathSubType(), END_ENTIRE_DEVICE_PATH_SUBTYPE, IsDevicePathEndType(), and NULL.

BOOLEAN EFIAPI IsDevicePathEndInstance ( IN CONST VOID *  Node  ) 

Determines if a device path node is an end node of a device path instance.

Determines if a device path node specified by Node is an end node of a device path instance. If Node represents the end of a device path instance, then TRUE is returned. Otherwise, FALSE is returned.

If Node is NULL, then ASSERT().

Parameters:
Node A pointer to a device path node data structure.
Return values:
TRUE The device path node specified by Node is the end of a device path instance.
FALSE The device path node specified by Node is not the end of a device path instance.

References ASSERT, DevicePathSubType(), END_INSTANCE_DEVICE_PATH_SUBTYPE, IsDevicePathEndType(), and NULL.

BOOLEAN EFIAPI IsDevicePathEndType ( IN CONST VOID *  Node  ) 

Determines if a device path node is an end node of a device path. This includes nodes that are the end of a device path instance and nodes that are the end of an entire device path.

Determines if the device path node specified by Node is an end node of a device path. This includes nodes that are the end of a device path instance and nodes that are the end of an entire device path. If Node represents an end node of a device path, then TRUE is returned. Otherwise, FALSE is returned.

If Node is NULL, then ASSERT().

Parameters:
Node A pointer to a device path node data structure.
Return values:
TRUE The device path node specified by Node is an end node of a device path.
FALSE The device path node specified by Node is not an end node of a device path.

References ASSERT, DevicePathType(), END_DEVICE_PATH_TYPE, and NULL.

BOOLEAN EFIAPI IsDevicePathValid ( IN CONST EFI_DEVICE_PATH_PROTOCOL DevicePath,
IN UINTN  MaxSize 
)

Determine whether a given device path is valid. If DevicePath is NULL, then ASSERT().

Parameters:
DevicePath A pointer to a device path data structure.
MaxSize The maximum size of the device path data structure.
Return values:
TRUE DevicePath is valid.
FALSE The length of any node node in the DevicePath is less than sizeof (EFI_DEVICE_PATH_PROTOCOL).
FALSE If MaxSize is not zero, the size of the DevicePath exceeds MaxSize.
FALSE If PcdMaximumDevicePathNodeCount is not zero, the node count of the DevicePath exceeds PcdMaximumDevicePathNodeCount.

References ASSERT, DevicePathNodeLength(), END_DEVICE_PATH_LENGTH, FALSE, IsDevicePathEnd(), NextDevicePathNode(), NULL, and PcdGet32.

EFI_DEVICE_PATH_PROTOCOL* EFIAPI NextDevicePathNode ( IN CONST VOID *  Node  ) 

Returns a pointer to the next node in a device path.

Returns a pointer to the device path node that follows the device path node specified by Node.

If Node is NULL, then ASSERT().

Parameters:
Node A pointer to a device path node data structure.
Returns:
a pointer to the device path node that follows the device path node specified by Node.

References ASSERT, DevicePathNodeLength(), and NULL.

VOID EFIAPI SetDevicePathEndNode ( OUT VOID *  Node  ) 

Fills in all the fields of a device path node that is the end of an entire device path.

Fills in all the fields of a device path node specified by Node so Node represents the end of an entire device path. The Type field of Node is set to END_DEVICE_PATH_TYPE, the SubType field of Node is set to END_ENTIRE_DEVICE_PATH_SUBTYPE, and the Length field of Node is set to END_DEVICE_PATH_LENGTH. Node is not required to be aligned on a 16-bit boundary, so it is recommended that a function such as WriteUnaligned16() be used to set the contents of the Length field.

If Node is NULL, then ASSERT().

Parameters:
Node A pointer to a device path node data structure.

References ASSERT, CopyMem(), mUefiDevicePathLibEndDevicePath, and NULL.

UINT16 EFIAPI SetDevicePathNodeLength ( IN OUT VOID *  Node,
IN UINTN  Length 
)

Sets the length, in bytes, of a device path node.

Sets the length of the device path node specified by Node to the value specified by NodeLength. NodeLength is returned. Node is not required to be aligned on a 16-bit boundary, so it is recommended that a function such as WriteUnaligned16() be used to set the contents of the Length field.

If Node is NULL, then ASSERT(). If NodeLength >= SIZE_64KB, then ASSERT(). If NodeLength < sizeof (EFI_DEVICE_PATH_PROTOCOL), then ASSERT().

Parameters:
Node A pointer to a device path node data structure.
Length The length, in bytes, of the device path node.
Returns:
Length

References ASSERT, NULL, SIZE_64KB, and WriteUnaligned16().

EFI_DEVICE_PATH_PROTOCOL* EFIAPI UefiDevicePathLibAppendDevicePath ( IN CONST EFI_DEVICE_PATH_PROTOCOL FirstDevicePath,
IN CONST EFI_DEVICE_PATH_PROTOCOL SecondDevicePath 
)

Creates a new device path by appending a second device path to a first device path.

This function creates a new device path by appending a copy of SecondDevicePath to a copy of FirstDevicePath in a newly allocated buffer. Only the end-of-device-path device node from SecondDevicePath is retained. The newly created device path is returned. If FirstDevicePath is NULL, then it is ignored, and a duplicate of SecondDevicePath is returned. If SecondDevicePath is NULL, then it is ignored, and a duplicate of FirstDevicePath is returned. If both FirstDevicePath and SecondDevicePath are NULL, then a copy of an end-of-device-path is returned.

If there is not enough memory for the newly allocated buffer, then NULL is returned. The memory for the new device path is allocated from EFI boot services memory. It is the responsibility of the caller to free the memory allocated.

Parameters:
FirstDevicePath A pointer to a device path data structure.
SecondDevicePath A pointer to a device path data structure.
Return values:
NULL If there is not enough memory for the newly allocated buffer.
NULL If FirstDevicePath or SecondDevicePath is invalid.
Others A pointer to the new device path if success. Or a copy an end-of-device-path if both FirstDevicePath and SecondDevicePath are NULL.

References AllocatePool(), CopyMem(), DuplicateDevicePath(), END_DEVICE_PATH_LENGTH, GetDevicePathSize(), IsDevicePathValid(), mUefiDevicePathLibEndDevicePath, and NULL.

Referenced by AppendDevicePath().

EFI_DEVICE_PATH_PROTOCOL* EFIAPI UefiDevicePathLibAppendDevicePathInstance ( IN CONST EFI_DEVICE_PATH_PROTOCOL DevicePath,
IN CONST EFI_DEVICE_PATH_PROTOCOL DevicePathInstance 
)

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

This function creates a new device path by appending a copy of the device path instance specified by DevicePathInstance to a copy of the device path specified by DevicePath in a allocated buffer. The end-of-device-path device node is moved after the end of the appended device path instance and a new end-of-device-path-instance node is inserted between. If DevicePath is NULL, then a copy if DevicePathInstance is returned. If DevicePathInstance is NULL, then NULL is returned. If DevicePath or DevicePathInstance is invalid, then NULL is returned. If there is not enough memory to allocate space for the new device path, then NULL is returned. The memory is allocated from EFI boot services memory. It is the responsibility of the caller to free the memory allocated.

Parameters:
DevicePath A pointer to a device path data structure.
DevicePathInstance A pointer to a device path instance.
Returns:
A pointer to the new device path.

References AllocatePool(), CopyMem(), DuplicateDevicePath(), END_INSTANCE_DEVICE_PATH_SUBTYPE, GetDevicePathSize(), IsDevicePathEnd(), IsDevicePathValid(), NextDevicePathNode(), NULL, and EFI_DEVICE_PATH_PROTOCOL::SubType.

Referenced by AppendDevicePathInstance().

EFI_DEVICE_PATH_PROTOCOL* EFIAPI UefiDevicePathLibAppendDevicePathNode ( IN CONST EFI_DEVICE_PATH_PROTOCOL DevicePath,
IN CONST EFI_DEVICE_PATH_PROTOCOL DevicePathNode 
)

Creates a new path by appending the device node to the device path.

This function creates a new device path by appending a copy of the device node specified by DevicePathNode to a copy of the device path specified by DevicePath in an allocated buffer. The end-of-device-path device node is moved after the end of the appended device node. If DevicePathNode is NULL then a copy of DevicePath is returned. If DevicePath is NULL then a copy of DevicePathNode, followed by an end-of-device path device node is returned. If both DevicePathNode and DevicePath are NULL then a copy of an end-of-device-path device node is returned. If there is not enough memory to allocate space for the new device path, then NULL is returned. The memory is allocated from EFI boot services memory. It is the responsibility of the caller to free the memory allocated.

Parameters:
DevicePath A pointer to a device path data structure.
DevicePathNode A pointer to a single device path node.
Return values:
NULL If there is not enough memory for the new device path.
Others A pointer to the new device path if success. A copy of DevicePathNode followed by an end-of-device-path node if both FirstDevicePath and SecondDevicePath are NULL. A copy of an end-of-device-path node if both FirstDevicePath and SecondDevicePath are NULL.

References AllocatePool(), AppendDevicePath(), CopyMem(), DevicePathNodeLength(), DuplicateDevicePath(), END_DEVICE_PATH_LENGTH, FreePool(), mUefiDevicePathLibEndDevicePath, NextDevicePathNode(), NULL, and SetDevicePathEndNode().

Referenced by AppendDevicePathNode().

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

Creates a device node.

This function creates a new device node in a newly allocated buffer of size NodeLength and initializes the device path node header with NodeType and NodeSubType. The new device path node is returned. If NodeLength is smaller than a device path header, then NULL is returned. If there is not enough memory to allocate space for the new device path, then NULL is returned. The memory is allocated from EFI boot services memory. It is the responsibility of the caller to free the memory allocated.

Parameters:
NodeType The device node type for the new device node.
NodeSubType The device node sub-type for the new device node.
NodeLength The length of the new device node.
Returns:
The new device path.

References AllocateZeroPool(), NULL, SetDevicePathNodeLength(), EFI_DEVICE_PATH_PROTOCOL::SubType, and EFI_DEVICE_PATH_PROTOCOL::Type.

Referenced by CreateDeviceNode().

EFI_DEVICE_PATH_PROTOCOL* EFIAPI UefiDevicePathLibDuplicateDevicePath ( IN CONST EFI_DEVICE_PATH_PROTOCOL DevicePath  ) 

Creates a new copy of an existing device path.

This function allocates space for a new copy of the device path specified by DevicePath. If DevicePath is NULL, then NULL is returned. If the memory is successfully allocated, then the contents of DevicePath are copied to the newly allocated buffer, and a pointer to that buffer is returned. Otherwise, NULL is returned. The memory for the new device path is allocated from EFI boot services memory. It is the responsibility of the caller to free the memory allocated.

Parameters:
DevicePath A pointer to a device path data structure.
Return values:
NULL DevicePath is NULL or invalid.
Others A pointer to the duplicated device path.

References AllocateCopyPool(), GetDevicePathSize(), and NULL.

Referenced by DuplicateDevicePath().

UINTN EFIAPI UefiDevicePathLibGetDevicePathSize ( IN CONST EFI_DEVICE_PATH_PROTOCOL DevicePath  ) 

Returns the size of a device path in bytes.

This function returns the size, in bytes, of the device path data structure specified by DevicePath including the end of device path node. If DevicePath is NULL or invalid, then 0 is returned.

Parameters:
DevicePath A pointer to a device path data structure.
Return values:
0 If DevicePath is NULL or invalid.
Others The size of a device path in bytes.

References CONST, DevicePathNodeLength(), IsDevicePathEnd(), IsDevicePathValid(), NextDevicePathNode(), and NULL.

Referenced by GetDevicePathSize().

EFI_DEVICE_PATH_PROTOCOL* EFIAPI UefiDevicePathLibGetNextDevicePathInstance ( IN OUT EFI_DEVICE_PATH_PROTOCOL **  DevicePath,
OUT UINTN *  Size 
)

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

This function creates a copy of the current device path instance. It also updates DevicePath to point to the next device path instance in the device path (or NULL if no more) and updates Size to hold the size of the device path instance copy. If DevicePath is NULL, then NULL is returned. If DevicePath points to a invalid device path, then NULL is returned. If there is not enough memory to allocate space for the new device path, then NULL is returned. The memory is allocated from EFI boot services memory. It is the responsibility of the caller to free the memory allocated. If Size is NULL, then ASSERT().

Parameters:
DevicePath 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 pointer to a device path data structure.
Size On output, this holds the size of the device path instance, in bytes or zero, if DevicePath is NULL.
Returns:
A pointer to the current device path instance.

References ASSERT, DevicePathSubType(), DuplicateDevicePath(), END_ENTIRE_DEVICE_PATH_SUBTYPE, IsDevicePathEndType(), IsDevicePathValid(), NextDevicePathNode(), NULL, and EFI_DEVICE_PATH_PROTOCOL::SubType.

Referenced by GetNextDevicePathInstance().

BOOLEAN EFIAPI UefiDevicePathLibIsDevicePathMultiInstance ( IN CONST EFI_DEVICE_PATH_PROTOCOL DevicePath  ) 

Determines if a device path is single or multi-instance.

This function returns TRUE if the device path specified by DevicePath is multi-instance. Otherwise, FALSE is returned. If DevicePath is NULL or invalid, then FALSE is returned.

Parameters:
DevicePath A pointer to a device path data structure.
Return values:
TRUE DevicePath is multi-instance.
FALSE DevicePath is not multi-instance, or DevicePath is NULL or invalid.

References CONST, FALSE, IsDevicePathEnd(), IsDevicePathEndInstance(), IsDevicePathValid(), NextDevicePathNode(), NULL, and TRUE.

Referenced by IsDevicePathMultiInstance().


Variable Documentation

GLOBAL_REMOVE_IF_UNREFERENCED CONST EFI_DEVICE_PATH_PROTOCOL mUefiDevicePathLibEndDevicePath


Generated on Thu Sep 24 23:14:24 2015 for MdePkg[ALL] by  doxygen 1.5.7.1