Move the definitions defined for User Manager protocol from UserCredential.h to UserM...

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

diff --git a/MdePkg/Include/Protocol/Dhcp6.h b/MdePkg/Include/Protocol/Dhcp6.h
index ba3c93278a44d79a7d17e8459f830c16c2ad6093..3f12f3894c51954bffb40f6a0faafe33492f1ef6 100644 (file)
--- a/MdePkg/Include/Protocol/Dhcp6.h
+++ b/MdePkg/Include/Protocol/Dhcp6.h
@@ -2,14 +2,17 @@
   UEFI Dynamic Host Configuration Protocol 6 Definition, which is used to get IPv6\r
   addresses and other configuration parameters from DHCPv6 servers.\r
 \r
-Copyright (c) 2008 - 2009, 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
+  Copyright (c) 2008 - 2009, 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
+  @par Revision Reference:          \r
+  This Protocol is introduced in UEFI Specification 2.2\r
 \r
 **/\r
 \r
@@ -141,21 +144,31 @@ typedef enum {
 #define EFI_DHCP6_IA_TYPE_TA   4\r
 \r
 #pragma pack(1)\r
+///\r
+/// EFI_DHCP6_PACKET_OPTION\r
+/// defines the format of the DHCPv6 option, See RFC 3315 for more information.\r
+/// This data structure is used to reference option data that is packed in the DHCPv6 packet. \r
+///\r
 typedef struct {\r
   ///\r
-  /// The DHCPv6 option code.\r
+  /// The DHCPv6 option code, stored in network order.\r
   ///\r
   UINT16                       OpCode;\r
   ///\r
-  /// Length of the DHCPv6 option data. From the first byte to the last byte of the Data field.\r
+  /// Length of the DHCPv6 option data, stored in network order.\r
+  /// From the first byte to the last byte of the Data field.\r
   ///\r
   UINT16                       OpLen;\r
   ///\r
-  /// The data for the DHCPv6 option.\r
+  /// The data for the DHCPv6 option, stored in network order.\r
   ///\r
   UINT8                        Data[1];\r
 } EFI_DHCP6_PACKET_OPTION;\r
 \r
+///\r
+/// EFI_DHCP6_HEADER\r
+/// defines the format of the DHCPv6 header. See RFC 3315 for more information. \r
+///\r
 typedef struct{\r
   ///\r
   /// The DHCPv6 transaction ID.\r
@@ -167,6 +180,10 @@ typedef struct{
   UINT32                       TransactionId:24;\r
 } EFI_DHCP6_HEADER;\r
 \r
+///\r
+/// EFI_DHCP6_PACKET \r
+/// defines the format of the DHCPv6 packet. See RFC 3315 for more information.\r
+///\r
 typedef struct {\r
   ///\r
   /// Size of the EFI_DHCP6_PACKET buffer.\r