sync comments, fix function header, rename variable name to follow coding style.

[mirror_edk2.git] / MdeModulePkg / Universal / Network / Ip4ConfigDxe / Ip4Config.h

diff --git a/MdeModulePkg/Universal/Network/Ip4ConfigDxe/Ip4Config.h b/MdeModulePkg/Universal/Network/Ip4ConfigDxe/Ip4Config.h
index 55629447afe06d39abe3835c96edf72e0708146b..46e9f890d58bfc07f65729cbb4db5f8981736483 100644 (file)
--- a/MdeModulePkg/Universal/Network/Ip4ConfigDxe/Ip4Config.h
+++ b/MdeModulePkg/Universal/Network/Ip4ConfigDxe/Ip4Config.h
@@ -1,6 +1,6 @@
 /** @file\r
 \r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+Copyright (c) 2006 - 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
@@ -26,7 +26,7 @@ Abstract:
 #include <PiDxe.h>\r
 \r
 #include <Protocol/Dhcp4.h>\r
-#include <Protocol/IP4Config.h>\r
+#include <Protocol/Ip4Config.h>\r
 #include <Protocol/ManagedNetwork.h>\r
 \r
 #include <Library/DebugLib.h>\r
@@ -42,18 +42,20 @@ Abstract:
 \r
 typedef struct _IP4_CONFIG_INSTANCE IP4_CONFIG_INSTANCE;\r
 \r
-enum {\r
+typedef enum {\r
   IP4_CONFIG_STATE_IDLE         = 0,\r
   IP4_CONFIG_STATE_STARTED,\r
-  IP4_CONFIG_STATE_CONFIGURED,\r
+  IP4_CONFIG_STATE_CONFIGURED\r
+} IP4_CONFIG_STATE;\r
 \r
-  IP4_PROTO_ICMP                = 0x01,\r
-  IP4_CONFIG_INSTANCE_SIGNATURE = EFI_SIGNATURE_32 ('I', 'P', '4', 'C'),\r
+#define IP4_PROTO_ICMP                 0x01\r
+#define IP4_CONFIG_INSTANCE_SIGNATURE  EFI_SIGNATURE_32 ('I', 'P', '4', 'C')\r
 \r
+typedef enum {\r
   DHCP_TAG_PARA_LIST            = 55,\r
   DHCP_TAG_NETMASK              = 1,\r
   DHCP_TAG_ROUTER               = 3\r
-};\r
+} DHCP_TAGS;\r
 \r
 //\r
 // Configure the DHCP to request the routers and netmask\r
@@ -121,11 +123,27 @@ extern IP4_CONFIG_INSTANCE           *mIp4ConfigNicList[MAX_IP4_CONFIG_IN_VARIAB
 extern EFI_IP4_CONFIG_PROTOCOL       mIp4ConfigProtocolTemplate;\r
 extern EFI_NIC_IP4_CONFIG_PROTOCOL   mNicIp4ConfigProtocolTemplate;\r
 \r
+/**\r
+  Release all the DHCP related resources.\r
+\r
+  @param  This                   The IP4 configure instance\r
+\r
+  @return None\r
+\r
+**/\r
 VOID\r
 Ip4ConfigCleanDhcp4 (\r
   IN IP4_CONFIG_INSTANCE        *This\r
   );\r
 \r
+/**\r
+  Clean up all the configuration parameters.\r
+\r
+  @param  Instance               The IP4 configure instance\r
+\r
+  @return None\r
+\r
+**/\r
 VOID\r
 Ip4ConfigCleanConfig (\r
   IN IP4_CONFIG_INSTANCE        *Instance\r