update file header

[mirror_edk2.git] / MdeModulePkg / Universal / Network / IScsiDxe / IScsiDhcp.h

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDhcp.h b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDhcp.h
index 92b303976e0a9826ffde9b9614f21b9f7a203eba..75bc7a16732ce5441c8bb8a0845d961470b46134 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDhcp.h
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDhcp.h
@@ -1,4 +1,5 @@
-/*++\r
+/** @file\r
+  Data structure for DHCP support\r
 \r
 Copyright (c) 2004 - 2008, Intel Corporation\r
 All rights reserved. This program and the accompanying materials\r
@@ -14,8 +15,9 @@ Module Name:
   IScsiDhcp.h\r
 \r
 Abstract:\r
+  The header file of IScsiDhcp.c\r
 \r
---*/\r
+**/\r
 \r
 #ifndef _ISCSI_DHCP_H_\r
 #define _ISCSI_DHCP_H_\r
@@ -45,6 +47,24 @@ typedef struct _ISCSI_ROOT_PATH_FIELD {
   UINT8 Len;\r
 } ISCSI_ROOT_PATH_FIELD;\r
 \r
+/**\r
+  Parse the DHCP ACK to get the address configuration and DNS information.\r
+  \r
+  @param  Image[in]             The handle of the driver image.\r
+\r
+  @param  Controller[in]        The handle of the controller;\r
+\r
+  @param  ConfigData[in]        The session configuration data.\r
+\r
+  @retval EFI_SUCCESS           The DNS information is got from the DHCP ACK.\r
+\r
+  @retval EFI_NO_MAPPING        DHCP failed to acquire address and other information.\r
+\r
+  @retval EFI_INVALID_PARAMETER The DHCP ACK's DNS option is mal-formatted.\r
+\r
+  @retval EFI_DEVICE_ERROR      Some unexpected error happened.\r
+\r
+**/\r
 EFI_STATUS\r
 IScsiDoDhcp (\r
   IN EFI_HANDLE                 Image,\r