Scrubbed some code for Ip4ConfigDxe.

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

1 files changed, 90 insertions, 47 deletions

diff --git a/MdePkg/Include/Protocol/Ip4Config.h b/MdePkg/Include/Protocol/Ip4Config.h
index d195ba7e66..ac04db3fc2 100644
--- a/MdePkg/Include/Protocol/Ip4Config.h
+++ b/MdePkg/Include/Protocol/Ip4Config.h
@@ -1,16 +1,15 @@
 /** @file

-

   This file provides a definition of the EFI IPv4 Configuration

   Protocol.

 

-  Copyright (c) 2006 - 2008, Intel Corporation

-  All rights reserved. This program and the accompanying materials

-  are licensed and made available under the terms and conditions of the BSD License

-  which accompanies this distribution.  The full text of the license may be found at

-  http://opensource.org/licenses/bsd-license.php

+Copyright (c) 2006 - 2008, Intel Corporation.<BR>

+All rights reserved. This program and the accompanying materials

+are licensed and made available under the terms and conditions of the BSD License

+which accompanies this distribution.  The full text of the license may be found at<BR>

+http://opensource.org/licenses/bsd-license.php

 

-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 

 **/

 #ifndef __EFI_IP4CONFIG_PROTOCOL_H__

@@ -29,6 +28,14 @@ typedef struct _EFI_IP4_CONFIG_PROTOCOL EFI_IP4_CONFIG_PROTOCOL;
         (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | \

          EFI_VARIABLE_RUNTIME_ACCESS)

 

+///

+/// EFI_IP4_IPCONFIG_DATA contains the minimum IPv4 configuration data 

+/// that is needed to start basic network communication. The StationAddress 

+/// and SubnetMask must be a valid unicast IP address and subnet mask.

+/// If RouteTableSize is not zero, then RouteTable contains a properly 

+/// formatted routing table for the StationAddress/SubnetMask, with the 

+/// last entry in the table being the default route.

+///

 typedef struct {

   ///

   /// Default station IP address, stored in network byte order.

@@ -44,6 +51,7 @@ typedef struct {
   UINT32                       RouteTableSize;

   ///

   /// Default routing table data (stored in network byte order).

+  /// Ignored if RouteTableSize is zero.

   ///

   EFI_IP4_ROUTE_TABLE          *RouteTable;

 } EFI_IP4_IPCONFIG_DATA;

@@ -51,24 +59,48 @@ typedef struct {
 

 /**

   Starts running the configuration policy for the EFI IPv4 Protocol driver.

-

-  @param  This          Pointer to the EFI_IP4_CONFIG_PROTOCOL instance.

-  @param  DoneEvent     Event that will be signaled when the EFI IPv4 Protocol driver

-                        configuration policy completes execution. This event must be of

-                        type EVT_NOTIFY_SIGNAL.

-  @param  ReconfigEvent Event that will be signaled when the EFI IPv4 Protocol driver

-                        configuration needs to be updated. This event must be of type

-                        EVT_NOTIFY_SIGNAL.

-

-  @retval EFI_SUCCESS           The configuration policy for the EFI IPv4 Protocol driver is now

-                                running.

-  @retval EFI_INVALID_PARAMETER This, DoneEvent, or ReconfigEvent is NULL.

-  @retval EFI_OUT_OF_RESOURCES  Required system resources could not be allocated.

-  @retval EFI_ALREADY_STARTED   The configuration policy for the EFI IPv4 Protocol driver was

-                                already started.

-  @retval EFI_DEVICE_ERROR      An unexpected system error or network error occurred.

-  @retval EFI_UNSUPPORTED       This interface does not support the EFI IPv4 Protocol driver

-                                 configuration.

+  

+  The Start() function is called to determine and to begin the platform 

+  configuration policy by the EFI IPv4 Protocol driver. This determination may 

+  be as simple as returning EFI_UNSUPPORTED if there is no EFI IPv4 Protocol 

+  driver configuration policy. It may be as involved as loading some defaults 

+  from nonvolatile storage, downloading dynamic data from a DHCP server, and 

+  checking permissions with a site policy server.

+  Starting the configuration policy is just the beginning. It may finish almost 

+  instantly or it may take several minutes before it fails to retrieve configuration 

+  information from one or more servers. Once the policy is started, drivers 

+  should use the DoneEvent parameter to determine when the configuration policy 

+  has completed. EFI_IP4_CONFIG_PROTOCOL.GetData() must then be called to 

+  determine if the configuration succeeded or failed.

+  Until the configuration completes successfully, EFI IPv4 Protocol driver instances 

+  that are attempting to use default configurations must return EFI_NO_MAPPING.

+  Once the configuration is complete, the EFI IPv4 Configuration Protocol driver 

+  signals DoneEvent. The configuration may need to be updated in the future, 

+  however; in this case, the EFI IPv4 Configuration Protocol driver must signal 

+  ReconfigEvent, and all EFI IPv4 Protocol driver instances that are using default 

+  configurations must return EFI_NO_MAPPING until the configuration policy has 

+  been rerun.

+

+  @param  This                   Pointer to the EFI_IP4_CONFIG_PROTOCOL instance.

+  @param  DoneEvent              Event that will be signaled when the EFI IPv4 

+                                 Protocol driver configuration policy completes 

+                                 execution. This event must be of type EVT_NOTIFY_SIGNAL.

+  @param  ReconfigEvent          Event that will be signaled when the EFI IPv4 

+                                 Protocol driver configuration needs to be updated. 

+                                 This event must be of type EVT_NOTIFY_SIGNAL.

+  

+  @retval EFI_SUCCESS            The configuration policy for the EFI IPv4 Protocol 

+                                 driver is now running.

+  @retval EFI_INVALID_PARAMETER  One or more of the following parameters is NULL:

+                                  This

+                                  DoneEvent

+                                  ReconfigEvent

+  @retval EFI_OUT_OF_RESOURCES   Required system resources could not be allocated.

+  @retval EFI_ALREADY_STARTED    The configuration policy for the EFI IPv4 Protocol 

+                                 driver was already started.

+  @retval EFI_DEVICE_ERROR       An unexpected system error or network error occurred.

+  @retval EFI_UNSUPPORTED        This interface does not support the EFI IPv4 Protocol 

+                                 driver configuration.

 

 **/

 typedef

@@ -81,13 +113,18 @@ EFI_STATUS
 

 /**

   Stops running the configuration policy for the EFI IPv4 Protocol driver.

-

-  @param  This Pointer to the EFI_IP4_CONFIG_PROTOCOL instance.

-

-  @retval EFI_SUCCESS           The configuration policy for the EFI IPv4 Protocol driver has been stopped.

-  @retval EFI_INVALID_PARAMETER This is NULL.

-  @retval EFI_NOT_STARTED       The configuration policy for the EFI IPv4 Protocol driver was not started.

-

+  

+  The Stop() function stops the configuration policy for the EFI IPv4 Protocol driver. 

+  All configuration data will be lost after calling Stop().

+

+  @param  This                   Pointer to the EFI_IP4_CONFIG_PROTOCOL instance.

+

+  @retval EFI_SUCCESS            The configuration policy for the EFI IPv4 Protocol 

+                                 driver has been stopped.

+  @retval EFI_INVALID_PARAMETER  This is NULL.

+  @retval EFI_NOT_STARTED        The configuration policy for the EFI IPv4 Protocol 

+                                 driver was not started.

+  

 **/

 typedef

 EFI_STATUS

@@ -98,20 +135,26 @@ EFI_STATUS
 /**

   Returns the default configuration data (if any) for the EFI IPv4 Protocol driver.

 

-  @param  This             Pointer to the EFI_IP4_CONFIG_PROTOCOL instance.

-  @param  IpConfigDataSize On input, the size of the IpConfigData buffer.

-                           On output, the count of bytes that were written into the IpConfigData buffer.

-  @param  IpConfigData     Pointer to the EFI IPv4 Configuration Protocol driver

-                           configuration data structure.

-

-  @retval EFI_SUCCESS           The EFI IPv4 Protocol driver configuration has been returned.

-  @retval EFI_INVALID_PARAMETER This is NULL.

-  @retval EFI_NOT_STARTED       The configuration policy for the EFI IPv4 Protocol driver is not

-                                running.

-  @retval EFI_NOT_READY         EFI IPv4 Protocol driver configuration is still running.

-  @retval EFI_ABORTED           EFI IPv4 Protocol driver configuration could not complete.

-  @retval EFI_BUFFER_TOO_SMALL  *IpConfigDataSize is smaller than the configuration data

-                                buffer or IpConfigData is NULL.

+  The GetData() function returns the current configuration data for the EFI IPv4 

+  Protocol driver after the configuration policy has completed.

+  

+  @param  This                   Pointer to the EFI_IP4_CONFIG_PROTOCOL instance.

+  @param  IpConfigDataSize       On input, the size of the IpConfigData buffer. 

+                                 On output, the count of bytes that were written 

+                                 into the IpConfigData buffer.

+  @param  IpConfigData           Pointer to the EFI IPv4 Configuration Protocol 

+                                 driver configuration data structure. 

+                                 Type EFI_IP4_IPCONFIG_DATA is defined in 

+                                 "Related Definitions" below.

+

+  @retval EFI_SUCCESS            The EFI IPv4 Protocol driver configuration has been returned.

+  @retval EFI_INVALID_PARAMETER  This is NULL.

+  @retval EFI_NOT_STARTED        The configuration policy for the EFI IPv4 Protocol 

+                                 driver is not running.

+  @retval EFI_NOT_READY EFI      IPv4 Protocol driver configuration is still running.

+  @retval EFI_ABORTED EFI        IPv4 Protocol driver configuration could not complete.

+  @retval EFI_BUFFER_TOO_SMALL   *IpConfigDataSize is smaller than the configuration 

+                                 data buffer or IpConfigData is NULL.

 

 **/

 typedef