Provides library functions to construct and parse UEFI Device Paths.\r
\r
This library provides defines, macros, and functions to help create and parse \r
- EFI_DEVICE_PATH_PROTOCOL structures. The macros that help create and parse device \r
- path nodes make use of the ReadUnaligned16() and WriteUnaligned16() functions from \r
- the Base Library, so this library class has an implied dependency on the Base Library.\r
+ EFI_DEVICE_PATH_PROTOCOL structures.\r
\r
-Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
-All rights reserved. This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php.\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
#ifndef __DEVICE_PATH_LIB_H__\r
#define __DEVICE_PATH_LIB_H__\r
\r
-#include <Library/BaseLib.h>\r
-\r
#define END_DEVICE_PATH_LENGTH (sizeof (EFI_DEVICE_PATH_PROTOCOL))\r
\r
/**\r
- Macro that returns the Type field of a device path node.\r
+ Returns the Type field of a device path node.\r
\r
Returns the Type field of the device path node specified by Node.\r
\r
+ If Node is NULL, then ASSERT().\r
+\r
@param Node A pointer to a device path node data structure.\r
\r
@return The Type field of the device path node specified by Node.\r
\r
**/\r
-#define DevicePathType(Node) (((EFI_DEVICE_PATH_PROTOCOL *)(Node))->Type)\r
+UINT8\r
+EFIAPI\r
+DevicePathType (\r
+ IN CONST VOID *Node\r
+ );\r
\r
/**\r
- Macro that returns the SubType field of a device path node.\r
+ Returns the SubType field of a device path node.\r
\r
Returns the SubType field of the device path node specified by Node.\r
\r
+ If Node is NULL, then ASSERT().\r
+\r
@param Node A pointer to a device path node data structure.\r
\r
@return The SubType field of the device path node specified by Node.\r
\r
**/\r
-#define DevicePathSubType(Node) (((EFI_DEVICE_PATH_PROTOCOL *)(Node))->SubType)\r
+UINT8\r
+EFIAPI\r
+DevicePathSubType (\r
+ IN CONST VOID *Node\r
+ );\r
\r
/**\r
- Macro that returns the 16-bit Length field of a device path node.\r
+ Returns the 16-bit Length field of a device path node.\r
\r
- Returns the 16-bit Length field of the device path node specified by Node.\r
+ Returns the 16-bit Length field of the device path node specified by Node. \r
+ Node is not required to be aligned on a 16-bit boundary, so it is recommended\r
+ that a function such as ReadUnaligned16() be used to extract the contents of \r
+ the Length field.\r
+\r
+ If Node is NULL, then ASSERT().\r
\r
@param Node A pointer to a device path node data structure.\r
\r
@return The 16-bit Length field of the device path node specified by Node.\r
\r
**/\r
-#define DevicePathNodeLength(Node) ReadUnaligned16 ((UINT16 *)&((EFI_DEVICE_PATH_PROTOCOL *)(Node))->Length[0])\r
+UINTN\r
+EFIAPI\r
+DevicePathNodeLength (\r
+ IN CONST VOID *Node\r
+ );\r
\r
/**\r
- Macro that returns a pointer to the next node in a device path.\r
+ Returns a pointer to the next node in a device path.\r
\r
Returns a pointer to the device path node that follows the device path node specified by Node.\r
\r
+ If Node is NULL, then ASSERT().\r
+\r
@param Node A pointer to a device path node data structure.\r
\r
@return a pointer to the device path node that follows the device path node specified by Node.\r
\r
**/\r
-#define NextDevicePathNode(Node) ((EFI_DEVICE_PATH_PROTOCOL *)((UINT8 *)(Node) + DevicePathNodeLength(Node)))\r
+EFI_DEVICE_PATH_PROTOCOL *\r
+EFIAPI\r
+NextDevicePathNode (\r
+ IN CONST VOID *Node\r
+ );\r
\r
/**\r
- Macro that determines if a device path node is an end node of a device path.\r
- This includes nodes that are the end of a device path instance and nodes that are the end of an entire device path.\r
+ Determines if a device path node is an end node of a device path.\r
+ This includes nodes that are the end of a device path instance and nodes that \r
+ are the end of an entire device path.\r
\r
Determines if the device path node specified by Node is an end node of a device path. \r
This includes nodes that are the end of a device path instance and nodes that are the \r
end of an entire device path. If Node represents an end node of a device path, \r
then TRUE is returned. Otherwise, FALSE is returned.\r
\r
+ If Node is NULL, then ASSERT().\r
+\r
@param Node A pointer to a device path node data structure.\r
\r
@retval TRUE The device path node specified by Node is an end node of a device path.\r
@retval FALSE The device path node specified by Node is not an end node of a device path.\r
\r
**/\r
-#define IsDevicePathEndType(Node) ((DevicePathType (Node) & 0x7f) == END_DEVICE_PATH_TYPE)\r
+BOOLEAN\r
+EFIAPI\r
+IsDevicePathEndType (\r
+ IN CONST VOID *Node\r
+ );\r
\r
/**\r
- Macro that determines if a device path node is an end node of an entire device path.\r
+ Determines if a device path node is an end node of an entire device path.\r
\r
Determines if a device path node specified by Node is an end node of an entire device path.\r
If Node represents the end of an entire device path, then TRUE is returned. Otherwise, FALSE is returned.\r
\r
+ If Node is NULL, then ASSERT().\r
+\r
@param Node A pointer to a device path node data structure.\r
\r
@retval TRUE The device path node specified by Node is the end of an entire device path.\r
@retval FALSE The device path node specified by Node is not the end of an entire device path.\r
\r
**/\r
-#define IsDevicePathEnd(Node) (IsDevicePathEndType (Node) && DevicePathSubType(Node) == END_ENTIRE_DEVICE_PATH_SUBTYPE)\r
+BOOLEAN\r
+EFIAPI\r
+IsDevicePathEnd (\r
+ IN CONST VOID *Node\r
+ );\r
\r
/**\r
- Macro that determines if a device path node is an end node of a device path instance.\r
+ Determines if a device path node is an end node of a device path instance.\r
\r
Determines if a device path node specified by Node is an end node of a device path instance.\r
If Node represents the end of a device path instance, then TRUE is returned. Otherwise, FALSE is returned.\r
\r
+ If Node is NULL, then ASSERT().\r
+\r
@param Node A pointer to a device path node data structure.\r
\r
@retval TRUE The device path node specified by Node is the end of a device path instance.\r
@retval FALSE The device path node specified by Node is not the end of a device path instance.\r
\r
**/\r
-#define IsDevicePathEndInstance(Node) (IsDevicePathEndType (Node) && DevicePathSubType(Node) == END_INSTANCE_DEVICE_PATH_SUBTYPE)\r
+BOOLEAN\r
+EFIAPI\r
+IsDevicePathEndInstance (\r
+ IN CONST VOID *Node\r
+ );\r
\r
/**\r
- Macro that sets the length, in bytes, of a device path node.\r
+ Sets the length, in bytes, of a device path node.\r
\r
- Sets the length of the device path node specified by Node to the value specified by Length. Length is returned.\r
+ Sets the length of the device path node specified by Node to the value specified \r
+ by NodeLength. NodeLength is returned. Node is not required to be aligned on \r
+ a 16-bit boundary, so it is recommended that a function such as WriteUnaligned16()\r
+ be used to set the contents of the Length field.\r
+\r
+ If Node is NULL, then ASSERT().\r
+ If NodeLength >= 0x10000, then ASSERT().\r
\r
@param Node A pointer to a device path node data structure.\r
@param Length The length, in bytes, of the device path node.\r
@return Length\r
\r
**/\r
-#define SetDevicePathNodeLength(Node,NodeLength) WriteUnaligned16 ((UINT16 *)&((EFI_DEVICE_PATH_PROTOCOL *)(Node))->Length[0], (UINT16)(NodeLength))\r
+UINT16\r
+EFIAPI\r
+SetDevicePathNodeLength (\r
+ IN OUT VOID *Node,\r
+ IN UINTN Length\r
+ );\r
\r
/**\r
- Macro that fills in all the fields of a device path node that is the end of an entire device path.\r
+ Fills in all the fields of a device path node that is the end of an entire device path.\r
+\r
+ Fills in all the fields of a device path node specified by Node so Node represents \r
+ the end of an entire device path. The Type field of Node is set to \r
+ END_DEVICE_PATH_TYPE, the SubType field of Node is set to \r
+ END_ENTIRE_DEVICE_PATH_SUBTYPE, and the Length field of Node is set to \r
+ END_DEVICE_PATH_LENGTH. Node is not required to be aligned on a 16-bit boundary, \r
+ so it is recommended that a function such as WriteUnaligned16() be used to set \r
+ the contents of the Length field. \r
\r
- Fills in all the fields of a device path node specified by Node so Node represents the end of an entire device path.\r
+ If Node is NULL, then ASSERT(). \r
\r
@param Node A pointer to a device path node data structure.\r
\r
**/\r
-#define SetDevicePathEndNode(Node) { \\r
- DevicePathType (Node) = END_DEVICE_PATH_TYPE; \\r
- DevicePathSubType (Node) = END_ENTIRE_DEVICE_PATH_SUBTYPE; \\r
- SetDevicePathNodeLength ((Node), END_DEVICE_PATH_LENGTH); \\r
- }\r
+VOID\r
+EFIAPI\r
+SetDevicePathEndNode (\r
+ OUT VOID *Node\r
+ );\r
\r
/**\r
Returns the size of a device path in bytes.\r
\r
@param DevicePath A pointer to a device path data structure.\r
\r
- @retval 0 If DevicePath is NULL.\r
+ @retval 0 DevicePath is NULL.\r
@retval Others The size of a device path in bytes.\r
\r
**/\r
\r
@param DevicePath A pointer to a device path data structure.\r
\r
- @retval NULL If DevicePath is NULL.\r
+ @retval NULL DevicePath is NULL.\r
@retval Others A pointer to the duplicated device path.\r
\r
**/\r
@param DevicePath A pointer to a device path data structure.\r
@param DevicePathNode A pointer to a single device path node.\r
\r
- @retval NULL If there is not enough memory for the new device path.\r
+ @retval NULL There is not enough memory for the new device path.\r
@retval Others A pointer to the new device path if success.\r
A copy of DevicePathNode followed by an end-of-device-path node \r
if both FirstDevicePath and SecondDevicePath are NULL.\r
@param DevicePath A pointer to a device path data structure.\r
\r
@retval TRUE DevicePath is multi-instance.\r
- @retval FALSE DevicePath is not multi-instance or DevicePath is NULL.\r
+ @retval FALSE DevicePath is not multi-instance, or DevicePath is NULL.\r
\r
**/\r
BOOLEAN\r
projects / mirror_edk2.git / blobdiff