update file header
authorywu21 <ywu21@6f19259b-4bc3-4df7-8a09-765794883524>
Wed, 10 Dec 2008 02:30:31 +0000 (02:30 +0000)
committerywu21 <ywu21@6f19259b-4bc3-4df7-8a09-765794883524>
Wed, 10 Dec 2008 02:30:31 +0000 (02:30 +0000)
update function header
update enum variable definition

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6946 6f19259b-4bc3-4df7-8a09-765794883524

MdeModulePkg/Universal/Network/IScsiDxe/IScsiDhcp.h

index 75bc7a1..1c7ad56 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
-  Data structure for DHCP support\r
+  The header file of IScsiDhcp.\r
 \r
-Copyright (c) 2004 - 2008, Intel Corporation\r
+Copyright (c) 2004 - 2008, Intel Corporation.<BR>\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
@@ -10,13 +10,6 @@ http://opensource.org/licenses/bsd-license.php
 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
-Module Name:\r
-\r
-  IScsiDhcp.h\r
-\r
-Abstract:\r
-  The header file of IScsiDhcp.c\r
-\r
 **/\r
 \r
 #ifndef _ISCSI_DHCP_H_\r
@@ -33,14 +26,14 @@ Abstract:
 #define ISCSI_ROOT_PATH_ID              "iscsi:"\r
 #define ISCSI_ROOT_PATH_FIELD_DELIMITER ':'\r
 \r
-enum {\r
+typedef enum {\r
   RP_FIELD_IDX_SERVERNAME = 0,\r
   RP_FIELD_IDX_PROTOCOL,\r
   RP_FIELD_IDX_PORT,\r
   RP_FIELD_IDX_LUN,\r
   RP_FIELD_IDX_TARGETNAME,\r
   RP_FIELD_IDX_MAX\r
-};\r
+} RP_FIELD_IDX;\r
 \r
 typedef struct _ISCSI_ROOT_PATH_FIELD {\r
   CHAR8 *Str;\r
@@ -50,20 +43,13 @@ typedef struct _ISCSI_ROOT_PATH_FIELD {
 /**\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
+  @param[in]   Image            The handle of the driver image.\r
+  @param[in]   Controller       The handle of the controller;\r
+  @param[in]   ConfigData       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
+  @retval EFI_OUT_OF_RESOURCES  Failed to allocate memory.\r
+  @retval Others                Some unexpected error happened.\r
 **/\r
 EFI_STATUS\r
 IScsiDoDhcp (\r