4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This file provides a definition of the EFI IPv4 Configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials are licensed and made available under
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncthe terms and conditions of the BSD License that accompanies this distribution.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThe full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @par Revision Reference:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This Protocol is introduced in UEFI Specification 2.0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0x3b95aa31, 0x3793, 0x434b, {0x86, 0x67, 0xc8, 0x07, 0x08, 0x92, 0xe0, 0x5e } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_IP4_CONFIG_PROTOCOL EFI_IP4_CONFIG_PROTOCOL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IP4_IPCONFIG_DATA contains the minimum IPv4 configuration data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// that is needed to start basic network communication. The StationAddress
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// and SubnetMask must be a valid unicast IP address and subnet mask.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// If RouteTableSize is not zero, then RouteTable contains a properly
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// formatted routing table for the StationAddress/SubnetMask, with the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// last entry in the table being the default route.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Default station IP address, stored in network byte order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Default subnet mask, stored in network byte order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of entries in the following RouteTable. May be zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Default routing table data (stored in network byte order).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Ignored if RouteTableSize is zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Starts running the configuration policy for the EFI IPv4 Protocol driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Start() function is called to determine and to begin the platform
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configuration policy by the EFI IPv4 Protocol driver. This determination may
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be as simple as returning EFI_UNSUPPORTED if there is no EFI IPv4 Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync driver configuration policy. It may be as involved as loading some defaults
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync from nonvolatile storage, downloading dynamic data from a DHCP server, and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync checking permissions with a site policy server.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Starting the configuration policy is just the beginning. It may finish almost
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync instantly or it may take several minutes before it fails to retrieve configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information from one or more servers. Once the policy is started, drivers
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync should use the DoneEvent parameter to determine when the configuration policy
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync has completed. EFI_IP4_CONFIG_PROTOCOL.GetData() must then be called to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync determine if the configuration succeeded or failed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Until the configuration completes successfully, EFI IPv4 Protocol driver instances
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync that are attempting to use default configurations must return EFI_NO_MAPPING.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Once the configuration is complete, the EFI IPv4 Configuration Protocol driver
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync signals DoneEvent. The configuration may need to be updated in the future.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Note that in this case the EFI IPv4 Configuration Protocol driver must signal
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ReconfigEvent, and all EFI IPv4 Protocol driver instances that are using default
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configurations must return EFI_NO_MAPPING until the configuration policy has
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync been rerun.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_IP4_CONFIG_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DoneEvent Event that will be signaled when the EFI IPv4
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Protocol driver configuration policy completes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync execution. This event must be of type EVT_NOTIFY_SIGNAL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ReconfigEvent Event that will be signaled when the EFI IPv4
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Protocol driver configuration needs to be updated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This event must be of type EVT_NOTIFY_SIGNAL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The configuration policy for the EFI IPv4 Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync driver is now running.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the following parameters is NULL:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ReconfigEvent
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ALREADY_STARTED The configuration policy for the EFI IPv4 Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync driver was already started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected system error or network error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED This interface does not support the EFI IPv4 Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync driver configuration.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Stops running the configuration policy for the EFI IPv4 Protocol driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Stop() function stops the configuration policy for the EFI IPv4 Protocol driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync All configuration data will be lost after calling Stop().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_IP4_CONFIG_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The configuration policy for the EFI IPv4 Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync driver has been stopped.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The configuration policy for the EFI IPv4 Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync driver was not started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns the default configuration data (if any) for the EFI IPv4 Protocol driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The GetData() function returns the current configuration data for the EFI IPv4
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Protocol driver after the configuration policy has completed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_IP4_CONFIG_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param IpConfigDataSize On input, the size of the IpConfigData buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync On output, the count of bytes that were written
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync into the IpConfigData buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param IpConfigData The pointer to the EFI IPv4 Configuration Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync driver configuration data structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Type EFI_IP4_IPCONFIG_DATA is defined in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync "Related Definitions" below.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The EFI IPv4 Protocol driver configuration has been returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The configuration policy for the EFI IPv4 Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync driver is not running.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY EFI IPv4 Protocol driver configuration is still running.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ABORTED EFI IPv4 Protocol driver configuration could not complete.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL *IpConfigDataSize is smaller than the configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync data buffer or IpConfigData is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The EFI_IP4_CONFIG_PROTOCOL driver performs platform-dependent and policy-dependent
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// configurations for the EFI IPv4 Protocol driver.