MdePkg FirmwareManagement.h: Fix typo EFI_SECURITY_VIOLATIO

[mirror_edk2.git] / MdePkg / Include / Protocol / DevicePathUtilities.h

diff --git a/MdePkg/Include/Protocol/DevicePathUtilities.h b/MdePkg/Include/Protocol/DevicePathUtilities.h
index cf247d24ba31b6ee4641cd8d341487db3bfc0b5e..72ea8da0171c2eb3e1725c2f2e8808a03b5223ff 100644 (file)
--- a/MdePkg/Include/Protocol/DevicePathUtilities.h
+++ b/MdePkg/Include/Protocol/DevicePathUtilities.h
@@ -2,8 +2,8 @@
   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 - 2008, Intel Corporation                                                         \r
-  All rights reserved. This program and the accompanying materials                          \r
+  Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+  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
@@ -16,9 +16,6 @@
 #ifndef __DEVICE_PATH_UTILITIES_PROTOCOL_H__\r
 #define __DEVICE_PATH_UTILITIES_PROTOCOL_H__\r
 \r
-\r
-#include <Protocol/DevicePath.h>\r
-\r
 ///\r
 /// Device Path Utilities protocol\r
 ///\r
@@ -32,7 +29,8 @@
 \r
   @param  DevicePath Points to the start of the EFI device path.\r
 \r
-  @retval Size       Size of the specified device path, in bytes, including the end-of-path tag.\r
+  @return Size  Size of the specified device path, in bytes, including the end-of-path tag.\r
+  @retval 0     DevicePath is NULL   \r
 \r
 **/\r
 typedef\r
@@ -48,7 +46,7 @@ UINTN
   @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
+  @retval NULL       insufficient memory or DevicePath is NULL\r
 \r
 **/\r
 typedef\r
@@ -59,13 +57,15 @@ EFI_DEVICE_PATH_PROTOCOL*
 \r
 /**\r
   Create a new path by appending the second device path to the first.\r
+  If Src1 is NULL and Src2 is non-NULL, then a duplicate of Src2 is returned. \r
+  If Src1 is non-NULL and Src2 is NULL, then a duplicate of Src1 is returned.\r
+  If Src1 and Src2 are both NULL, then a copy of an end-of-device-path is returned.\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
+  @param  Src1 Points to the first device path.\r
+  @param  Src2 Points to the second device path.\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
@@ -77,13 +77,15 @@ EFI_DEVICE_PATH_PROTOCOL*
   \r
 /**\r
   Creates a new path by appending the device node to the device path.\r
+  If DeviceNode is NULL then a copy of DevicePath is returned. \r
+  If DevicePath is NULL then a copy of DeviceNode, followed by an end-of-device path device node is returned.\r
+  If both DeviceNode and DevicePath are NULL then a copy of an end-of-device-path device node is returned.\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
+  @retval NULL       There was insufficient memory.\r
 \r
 **/\r
 typedef\r
@@ -119,7 +121,8 @@ EFI_DEVICE_PATH_PROTOCOL*
                                  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
+                                 in bytes or zero, if DevicePathInstance is NULL.\r
+                                 If NULL, then the instance size is not output.\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
@@ -149,7 +152,7 @@ EFI_DEVICE_PATH_PROTOCOL*
 **/\r
 typedef\r
 EFI_DEVICE_PATH_PROTOCOL*\r
-(EFIAPI *EFI_DEVICE_PATH_CREATE_NODE)(\r
+(EFIAPI *EFI_DEVICE_PATH_UTILS_CREATE_NODE)(\r
   IN UINT8                          NodeType,\r
   IN UINT8                          NodeSubType,\r
   IN UINT16                         NodeLength\r
@@ -181,7 +184,7 @@ typedef struct {
   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_UTILS_CREATE_NODE          CreateDeviceNode;\r
 } EFI_DEVICE_PATH_UTILITIES_PROTOCOL;\r
 \r
 extern EFI_GUID gEfiDevicePathUtilitiesProtocolGuid; \r