+++ /dev/null
-/** @file\r
- EFI_DEVICE_PATH_UTILITIES_PROTOCOL as defined in UEFI 2.0. \r
- Use to create and manipulate device paths and device nodes.\r
-\r
- Copyright (c) 2006, Intel Corporation \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
-\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
-\r
- Module Name: DevicePathUtilities.h\r
-\r
-**/\r
-\r
-#ifndef __DEVICE_PATH_UTILITIES_PROTOCOL_H__\r
-#define __DEVICE_PATH_UTILITIES_PROTOCOL_H__\r
-\r
-//\r
-// Device Path Utilities protocol\r
-//\r
-#define EFI_DEVICE_PATH_UTILITIES_PROTOCOL_GUID \\r
- { \\r
- 0x379be4e, 0xd706, 0x437d, {0xb0, 0x37, 0xed, 0xb8, 0x2f, 0xb7, 0x72, 0xa4 } \\r
- }\r
-\r
-/**\r
- Returns the size of the device path, in bytes.\r
-\r
- @param DevicePath Points to the start of the EFI device path.\r
-\r
- @revtal Size Size of the specified device path, in bytes, including the end-of-path tag.\r
-\r
-**/\r
-typedef\r
-UINTN\r
-(EFIAPI *EFI_DEVICE_PATH_UTILS_GET_DEVICE_PATH_SIZE) (\r
- IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
- )\r
-; \r
- \r
-\r
-/**\r
- Create a duplicate of the specified path.\r
-\r
- @param DevicePath Points to the source EFI device path.\r
-\r
- @retval Pointer A pointer to the duplicate device path.\r
- @retval NULL insufficient memory\r
-\r
-**/\r
-typedef\r
-EFI_DEVICE_PATH_PROTOCOL*\r
-(EFIAPI *EFI_DEVICE_PATH_UTILS_DUP_DEVICE_PATH) (\r
- IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
- )\r
-; \r
-\r
-/**\r
- Create a new path by appending the second device path to the first.\r
-\r
- @param Src1 Points to the first device path. If NULL, then it is ignored.\r
- @param Src2 Points to the second device path. If NULL, then it is ignored.\r
-\r
- @retval Pointer A pointer to the newly created device path.\r
- @retval NULL Memory could not be allocated\r
- or either DevicePath or DeviceNode is NULL.\r
-\r
-**/\r
-typedef\r
-EFI_DEVICE_PATH_PROTOCOL*\r
-(EFIAPI *EFI_DEVICE_PATH_UTILS_APPEND_PATH) (\r
- IN CONST EFI_DEVICE_PATH_PROTOCOL *Src1,\r
- IN CONST EFI_DEVICE_PATH_PROTOCOL *Src2\r
- )\r
-; \r
- \r
-/**\r
- Creates a new path by appending the device node to the device path.\r
-\r
- @param DevicePath Points to the device path.\r
- @param DeviceNode Points to the device node.\r
-\r
- @retval Pointer A pointer to the allocated device node.\r
- @retval NULL Memory could not be allocated\r
- or either DevicePath or DeviceNode is NULL.\r
-\r
-**/\r
-typedef\r
-EFI_DEVICE_PATH_PROTOCOL*\r
-(EFIAPI *EFI_DEVICE_PATH_UTILS_APPEND_NODE) (\r
- IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
- IN CONST EFI_DEVICE_PATH_PROTOCOL *DeviceNode\r
- )\r
-;\r
-\r
-/**\r
- Creates a new path by appending the specified device path instance to the specified device path.\r
-\r
- @param DevicePath Points to the device path. If NULL, then ignored.\r
- @param DevicePathInstance Points to the device path instance.\r
-\r
- @retval Pointer A pointer to the newly created device path\r
- @retval NULL Memory could not be allocated or DevicePathInstance is NULL.\r
-\r
-**/\r
-typedef\r
-EFI_DEVICE_PATH_PROTOCOL*\r
-(EFIAPI *EFI_DEVICE_PATH_UTILS_APPEND_INSTANCE) (\r
- IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
- IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePathInstance\r
- )\r
-; \r
-\r
-/**\r
- Creates a copy of the current device path instance and returns a pointer to the next device path\r
- instance.\r
-\r
- @param DevicePathInstance On input, this holds the pointer to the current device path\r
- instance. On output, this holds the pointer to the next\r
- device path instance or NULL if there are no more device\r
- path instances in the device path. \r
- @param DevicePathInstanceSize On output, this holds the size of the device path instance,\r
- in bytes or zero, if DevicePathInstance is zero.\r
-\r
- @retval Pointer A pointer to the copy of the current device path instance.\r
- @retval NULL DevicePathInstace was NULL on entry or there was insufficient memory.\r
-\r
-**/\r
-typedef\r
-EFI_DEVICE_PATH_PROTOCOL*\r
-(EFIAPI *EFI_DEVICE_PATH_UTILS_GET_NEXT_INSTANCE) (\r
- IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePathInstance,\r
- OUT UINTN *DevicePathInstanceSize\r
- )\r
-; \r
-\r
-/**\r
- Creates a device node\r
-\r
- @param NodeType NodeType is the device node type (EFI_DEVICE_PATH.Type) for\r
- the new device node.\r
- @param NodeSubType NodeSubType is the device node sub-type\r
- EFI_DEVICE_PATH.SubType) for the new device node.\r
- @param NodeLength NodeLength is the length of the device node\r
- (EFI_DEVICE_PATH.Length) for the new device node.\r
-\r
- @retval Pointer A pointer to the newly created device node.\r
- @retval NULL NodeLength is less than\r
- the size of the header or there was insufficient memory.\r
-\r
-**/\r
-typedef\r
-EFI_DEVICE_PATH_PROTOCOL*\r
-(EFIAPI *EFI_DEVICE_PATH_CREATE_NODE) (\r
- IN UINT8 NodeType,\r
- IN UINT8 NodeSubType,\r
- IN UINT16 NodeLength\r
-)\r
-; \r
-\r
-/**\r
- Returns whether a device path is multi-instance.\r
-\r
- @param DevicePath Points to the device path. If NULL, then ignored.\r
-\r
- @retval TRUE The device path has more than one instance\r
- @retval FALSE The device path is empty or contains only a single instance.\r
-\r
-**/\r
-typedef\r
-BOOLEAN\r
-(EFIAPI *EFI_DEVICE_PATH_UTILS_IS_MULTI_INSTANCE) (\r
- IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
- )\r
-; \r
- \r
-\r
-typedef struct {\r
- EFI_DEVICE_PATH_UTILS_GET_DEVICE_PATH_SIZE GetDevicePathSize;\r
- EFI_DEVICE_PATH_UTILS_DUP_DEVICE_PATH DuplicateDevicePath;\r
- EFI_DEVICE_PATH_UTILS_APPEND_PATH AppendDevicePath;\r
- EFI_DEVICE_PATH_UTILS_APPEND_NODE AppendDeviceNode;\r
- EFI_DEVICE_PATH_UTILS_APPEND_INSTANCE AppendDevicePathInstance;\r
- EFI_DEVICE_PATH_UTILS_GET_NEXT_INSTANCE GetNextDevicePathInstance;\r
- EFI_DEVICE_PATH_UTILS_IS_MULTI_INSTANCE IsDevicePathMultiInstance;\r
- EFI_DEVICE_PATH_CREATE_NODE CreateDeviceNode;\r
-} EFI_DEVICE_PATH_UTILITIES_PROTOCOL;\r
-\r
-extern EFI_GUID gEfiDevicePathUtilitiesProtocolGuid; \r
-\r
-#endif\r
projects / mirror_edk2.git / blobdiff