1. retired NicIp4ConfigProtocolGuid

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

diff --git a/MdeModulePkg/Universal/Network/Ip4ConfigDxe/NicIp4Variable.h b/MdeModulePkg/Universal/Network/Ip4ConfigDxe/NicIp4Variable.h
index 4b146274234e857881140f0bd5c2eb992ed70d2e..6a4e94193e983bf72a1f94697018c0d53cc5be23 100644 (file)
--- a/MdeModulePkg/Universal/Network/Ip4ConfigDxe/NicIp4Variable.h
+++ b/MdeModulePkg/Universal/Network/Ip4ConfigDxe/NicIp4Variable.h
@@ -1,30 +1,42 @@
 /** @file\r
+  Routines used to operate the Ip4 configure variable.\r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
+Copyright (c) 2006 - 2009, 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
+which accompanies this distribution.  The full text of the license may be found at<BR>\r
 http://opensource.org/licenses/bsd-license.php\r
 \r
 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
-  NicIp4Variable.h\r
-\r
-Abstract:\r
-\r
-  Routines used to operate the Ip4 configure variable\r
-\r
-\r
 **/\r
 \r
 #ifndef _NIC_IP4_VARIABLE_H_\r
 #define _NIC_IP4_VARIABLE_H_\r
 \r
-\r
-#include <Protocol/NicIp4Config.h>\r
+#include <Uefi.h>\r
+\r
+#include <Guid/NicIp4ConfigNvData.h>\r
+\r
+#include <Library/NetLib.h>\r
+#include <Library/DebugLib.h>\r
+#include <Library/BaseMemoryLib.h>\r
+#include <Library/MemoryAllocationLib.h>\r
+#include <Library/UefiBootServicesTableLib.h>\r
+#include <Library/UefiRuntimeServicesTableLib.h>\r
+\r
+///\r
+/// IP4_CONFIG_VARIABLE is the EFI variable to\r
+/// save the configuration. IP4_CONFIG_VARIABLE is\r
+/// of variable length.\r
+///\r
+typedef struct {\r
+  UINT32                    Len;        ///< Total length of the variable\r
+  UINT16                    CheckSum;   ///< CheckSum, the same as IP4 head checksum\r
+  UINT32                    Count;      ///< Number of NIC_IP4_CONFIG_INFO follows\r
+  NIC_IP4_CONFIG_INFO       ConfigInfo;\r
+} IP4_CONFIG_VARIABLE;\r
 \r
 //\r
 // Return the size of NIC_IP4_CONFIG_INFO and EFI_IP4_IPCONFIG_DATA.\r
@@ -83,7 +95,7 @@ Ip4ConfigReadVariable (
 **/\r
 EFI_STATUS\r
 Ip4ConfigWriteVariable (\r
-  IN IP4_CONFIG_VARIABLE    *Config       OPTIONAL\r
+  IN IP4_CONFIG_VARIABLE    *Config        OPTIONAL\r
   );\r
 \r
 /**\r
@@ -96,7 +108,7 @@ Ip4ConfigWriteVariable (
   @param  NicAddr      The interface address to check\r
 \r
   @return The point to the NIC's IP4 configure info if it is found\r
-  @return in the IP4 variable, otherwise NULL.\r
+          in the IP4 variable, otherwise NULL.\r
 \r
 **/\r
 NIC_IP4_CONFIG_INFO *\r
@@ -115,21 +127,31 @@ Ip4ConfigFindNicVariable (
   @param  Config       The new configuration parameter (NULL to remove the old)\r
 \r
   @return The new IP4_CONFIG_VARIABLE variable if the new variable has at\r
-  @return least one NIC configure and no EFI_OUT_OF_RESOURCES failure.\r
-  @return Return NULL either because failed to locate memory for new variable\r
-  @return or the only NIC configure is removed from the Variable.\r
+          least one NIC configure and no EFI_OUT_OF_RESOURCES failure.\r
+          Return NULL either because failed to locate memory for new variable\r
+          or the only NIC configure is removed from the Variable.\r
 \r
 **/\r
 IP4_CONFIG_VARIABLE *\r
 Ip4ConfigModifyVariable (\r
-  IN IP4_CONFIG_VARIABLE    *Variable,    OPTIONAL\r
+  IN IP4_CONFIG_VARIABLE    *Variable     OPTIONAL,\r
   IN NIC_ADDR               *NicAddr,\r
   IN NIC_IP4_CONFIG_INFO    *Config       OPTIONAL\r
   );\r
 \r
+/**\r
+  Fix the RouteTable pointer in an EFI_IP4_IPCONFIG_DATA structure. \r
+  \r
+  The pointer is set to be immediately follow the ConfigData if there're entries\r
+  in the RouteTable. Otherwise it is set to NULL.\r
+  \r
+  @param  ConfigData     The IP4 IP configure data.\r
+\r
+**/\r
 VOID\r
 Ip4ConfigFixRouteTablePointer (\r
-  IN EFI_IP4_IPCONFIG_DATA  *ConfigData\r
+  IN OUT EFI_IP4_IPCONFIG_DATA  *ConfigData\r
   );\r
 \r
 #endif\r
+\r