]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Option.h
synced function header
[mirror_edk2.git] / MdeModulePkg / Universal / Network / Dhcp4Dxe / Dhcp4Option.h
index fe62e55085f270fc219233b2fe08a67715df89e4..74d84b3f8148f2558b12c523170be8a1f6a503ea 100644 (file)
@@ -239,13 +239,13 @@ EFI_STATUS
   @param  Context                The opaque parameter for Check\r
 \r
   @retval EFI_SUCCESS            The DHCP packet's options are well formated\r
-  @retval Others                 The DHCP packet's options are not well formated\r
+  @retval EFI_INVALID_PARAMETER  The DHCP packet's options are not well formated\r
 \r
 **/\r
 EFI_STATUS\r
 DhcpIterateOptions (\r
   IN  EFI_DHCP4_PACKET      *Packet,\r
-  IN  DHCP_CHECK_OPTION     Check,          OPTIONAL\r
+  IN  DHCP_CHECK_OPTION     Check,        OPTIONAL\r
   IN  VOID                  *Context\r
   );\r
 \r
@@ -264,7 +264,7 @@ DhcpIterateOptions (
 EFI_STATUS\r
 DhcpValidateOptions (\r
   IN  EFI_DHCP4_PACKET      *Packet,\r
-  OUT DHCP_PARAMETER        **Para          OPTIONAL\r
+  OUT DHCP_PARAMETER        **Para       OPTIONAL\r
   );\r
 \r
 /**\r
@@ -277,7 +277,7 @@ DhcpValidateOptions (
   as a UINT8. It then iterates the DHCP packet to get data length of\r
   each option by calling DhcpIterOptions with DhcpGetOptionLen. Now, it\r
   knows the number of present options and their length. It allocates a\r
-  array of DHCP_OPTION and a continous buffer after the array to put\r
+  array of DHCP_OPTION and a continuous buffer after the array to put\r
   all the options' data. Each option's data is pointed to by the Data\r
   field in DHCP_OPTION structure. At last, it call DhcpIterateOptions\r
   with DhcpFillOption to fill each option's data to its position in the\r
@@ -315,10 +315,10 @@ DhcpParseOption (
 **/\r
 UINT8 *\r
 DhcpAppendOption (\r
-  IN UINT8                  *Buf,\r
-  IN UINT8                  Tag,\r
-  IN UINT16                 DataLen,\r
-  IN UINT8                  *Data\r
+  OUT UINT8                  *Buf,\r
+  IN  UINT8                  Tag,\r
+  IN  UINT16                 DataLen,\r
+  IN  UINT8                  *Data\r
   );\r
 \r
 /**\r
@@ -334,17 +334,18 @@ DhcpAppendOption (
                                  function.\r
 \r
   @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory\r
+  @retval EFI_INVALID_PARAMETER  The options in SeekPacket are mal-formated\r
   @retval EFI_SUCCESS            The packet is build.\r
 \r
 **/\r
 EFI_STATUS\r
 DhcpBuild (\r
-  IN  EFI_DHCP4_PACKET         *SeedPacket,\r
-  IN  UINT32                   DeleteCount,\r
-  IN  UINT8                    *DeleteList OPTIONAL,\r
-  IN  UINT32                   AppendCount,\r
-  IN  EFI_DHCP4_PACKET_OPTION  *AppendList[] OPTIONAL,\r
-  OUT EFI_DHCP4_PACKET         **NewPacket\r
+  IN  EFI_DHCP4_PACKET        *SeedPacket,\r
+  IN  UINT32                  DeleteCount,\r
+  IN  UINT8                   *DeleteList     OPTIONAL,\r
+  IN  UINT32                  AppendCount,\r
+  IN  EFI_DHCP4_PACKET_OPTION *AppendList[]   OPTIONAL,\r
+  OUT EFI_DHCP4_PACKET        **NewPacket\r
   );\r
 \r
 #endif\r