[Change summary]:

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

diff --git a/MdeModulePkg/Universal/Network/Ip4ConfigDxe/NicIp4Variable.c b/MdeModulePkg/Universal/Network/Ip4ConfigDxe/NicIp4Variable.c
index 65c2f840aa644b3534f70d656233494dcd251f8f..17709af10703caa1e50c8b3723c75184428f4579 100644 (file)
--- a/MdeModulePkg/Universal/Network/Ip4ConfigDxe/NicIp4Variable.c
+++ b/MdeModulePkg/Universal/Network/Ip4ConfigDxe/NicIp4Variable.c
@@ -1,33 +1,17 @@
 /** @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.c\r
-\r
-Abstract:\r
-\r
-  Routines used to operate the Ip4 configure variable\r
-\r
-\r
 **/\r
 \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
 #include "NicIp4Variable.h"\r
 \r
 \r
@@ -61,7 +45,7 @@ Ip4ConfigIsValid (
     Netmask = EFI_NTOHL (IpConfig->SubnetMask);\r
 \r
     if ((Netmask == 0) || !IP4_IS_VALID_NETMASK (Netmask) ||\r
-        (Station == 0) || !Ip4IsUnicast (Station, Netmask)) {\r
+        (Station == 0) || !NetIp4IsUnicast (Station, Netmask)) {\r
       return FALSE;\r
     }\r
 \r
@@ -73,7 +57,7 @@ Ip4ConfigIsValid (
       Gateway = EFI_NTOHL (IpConfig->RouteTable[Index].GatewayAddress);\r
 \r
       if ((Gateway != 0) && (!IP4_NET_EQUAL (Station, Gateway, Netmask) ||\r
-          !Ip4IsUnicast (Gateway, Netmask))) {\r
+          !NetIp4IsUnicast (Gateway, Netmask))) {\r
         return FALSE;\r
       }\r
     }\r
@@ -91,7 +75,7 @@ Ip4ConfigIsValid (
 \r
 \r
 /**\r
-  Read the ip4 configure variable from the EFI variable\r
+  Read the ip4 configure variable from the EFI variable.\r
 \r
   None\r
 \r
@@ -186,7 +170,7 @@ ON_ERROR:
 **/\r
 EFI_STATUS\r
 Ip4ConfigWriteVariable (\r
-  IN IP4_CONFIG_VARIABLE    * Config        OPTIONAL\r
+  IN IP4_CONFIG_VARIABLE    *Config        OPTIONAL\r
   )\r
 {\r
   EFI_STATUS                Status;\r
@@ -213,7 +197,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
@@ -270,14 +254,14 @@ 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
@@ -383,9 +367,18 @@ Ip4ConfigModifyVariable (
   return NewVar;\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
   //\r