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 73f1a8d27ce0010c08f81c4cce1b5e1b6baafeee..75bc7a16732ce5441c8bb8a0845d961470b46134 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDhcp.h
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDhcp.h
@@ -1,6 +1,7 @@
-/*++\r
+/** @file\r
+  Data structure for DHCP support\r
 \r
-Copyright (c) 2004 - 2007, Intel Corporation\r
+Copyright (c) 2004 - 2008, 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
@@ -14,13 +15,14 @@ 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
 \r
-#include <protocol/Dhcp4.h>\r
+#include <Protocol/Dhcp4.h>\r
 \r
 #define DHCP4_TAG_PARA_LIST             55\r
 #define DHCP4_TAG_NETMASK               1\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