iPXE
Data Structures | Defines | Typedefs | Functions | Variables
Ip4Config.h File Reference

This file provides a definition of the EFI IPv4 Configuration Protocol. More...

#include <ipxe/efi/Protocol/Ip4.h>

Go to the source code of this file.

Data Structures

struct  EFI_IP4_IPCONFIG_DATA
 EFI_IP4_IPCONFIG_DATA contains the minimum IPv4 configuration data that is needed to start basic network communication. More...
struct  _EFI_IP4_CONFIG_PROTOCOL
 The EFI_IP4_CONFIG_PROTOCOL driver performs platform-dependent and policy-dependent configurations for the EFI IPv4 Protocol driver. More...

Defines

#define EFI_IP4_CONFIG_PROTOCOL_GUID
#define IP4_CONFIG_VARIABLE_ATTRIBUTES   (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS)

Typedefs

typedef struct
_EFI_IP4_CONFIG_PROTOCOL 
EFI_IP4_CONFIG_PROTOCOL
typedef EFI_STATUS(EFIAPIEFI_IP4_CONFIG_START )(IN EFI_IP4_CONFIG_PROTOCOL *This, IN EFI_EVENT DoneEvent, IN EFI_EVENT ReconfigEvent)
 Starts running the configuration policy for the EFI IPv4 Protocol driver.
typedef EFI_STATUS(EFIAPIEFI_IP4_CONFIG_STOP )(IN EFI_IP4_CONFIG_PROTOCOL *This)
 Stops running the configuration policy for the EFI IPv4 Protocol driver.
typedef EFI_STATUS(EFIAPIEFI_IP4_CONFIG_GET_DATA )(IN EFI_IP4_CONFIG_PROTOCOL *This, IN OUT UINTN *IpConfigDataSize, OUT EFI_IP4_IPCONFIG_DATA *IpConfigData OPTIONAL)
 Returns the default configuration data (if any) for the EFI IPv4 Protocol driver.

Functions

 FILE_LICENCE (BSD3)

Variables

EFI_GUID gEfiIp4ConfigProtocolGuid

Detailed Description

This file provides a definition of the EFI IPv4 Configuration Protocol.

Copyright (c) 2006 - 2014, 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 that accompanies this distribution. The full text of the license may be found at 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.

Revision Reference:
This Protocol is introduced in UEFI Specification 2.0.

Definition in file Ip4Config.h.


Define Documentation

Value:
{ \
    0x3b95aa31, 0x3793, 0x434b, {0x86, 0x67, 0xc8, 0x07, 0x08, 0x92, 0xe0, 0x5e } \
  }

Definition at line 25 of file Ip4Config.h.

Definition at line 32 of file Ip4Config.h.


Typedef Documentation

Definition at line 30 of file Ip4Config.h.

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

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. Note that 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.

Parameters:
ThisThe pointer to the EFI_IP4_CONFIG_PROTOCOL instance.
DoneEventEvent that will be signaled when the EFI IPv4 Protocol driver configuration policy completes execution. This event must be of type EVT_NOTIFY_SIGNAL.
ReconfigEventEvent that will be signaled when the EFI IPv4 Protocol driver configuration needs to be updated. This event must be of type EVT_NOTIFY_SIGNAL.
Return values:
EFI_SUCCESSThe configuration policy for the EFI IPv4 Protocol driver is now running.
EFI_INVALID_PARAMETEROne or more of the following parameters is NULL: This DoneEvent ReconfigEvent
EFI_OUT_OF_RESOURCESRequired system resources could not be allocated.
EFI_ALREADY_STARTEDThe configuration policy for the EFI IPv4 Protocol driver was already started.
EFI_DEVICE_ERRORAn unexpected system error or network error occurred.
EFI_UNSUPPORTEDThis interface does not support the EFI IPv4 Protocol driver configuration.

Definition at line 112 of file Ip4Config.h.

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

The Stop() function stops the configuration policy for the EFI IPv4 Protocol driver. All configuration data will be lost after calling Stop().

Parameters:
ThisThe pointer to the EFI_IP4_CONFIG_PROTOCOL instance.
Return values:
EFI_SUCCESSThe configuration policy for the EFI IPv4 Protocol driver has been stopped.
EFI_INVALID_PARAMETERThis is NULL.
EFI_NOT_STARTEDThe configuration policy for the EFI IPv4 Protocol driver was not started.

Definition at line 135 of file Ip4Config.h.

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

The GetData() function returns the current configuration data for the EFI IPv4 Protocol driver after the configuration policy has completed.

Parameters:
ThisThe pointer to the EFI_IP4_CONFIG_PROTOCOL instance.
IpConfigDataSizeOn input, the size of the IpConfigData buffer. On output, the count of bytes that were written into the IpConfigData buffer.
IpConfigDataThe pointer to the EFI IPv4 Configuration Protocol driver configuration data structure. Type EFI_IP4_IPCONFIG_DATA is defined in "Related Definitions" below.
Return values:
EFI_SUCCESSThe EFI IPv4 Protocol driver configuration has been returned.
EFI_INVALID_PARAMETERThis is NULL.
EFI_NOT_STARTEDThe configuration policy for the EFI IPv4 Protocol driver is not running.
EFI_NOT_READYEFI IPv4 Protocol driver configuration is still running.
EFI_ABORTEDEFI IPv4 Protocol driver configuration could not complete.
EFI_BUFFER_TOO_SMALL*IpConfigDataSize is smaller than the configuration data buffer or IpConfigData is NULL.

Definition at line 166 of file Ip4Config.h.


Function Documentation

FILE_LICENCE ( BSD3  )

Variable Documentation