|
iPXE
|
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... | |
Macros | |
| #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(EFIAPI * | EFI_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. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_IP4_CONFIG_STOP) (IN EFI_IP4_CONFIG_PROTOCOL *This) |
| Stops running the configuration policy for the EFI IPv4 Protocol driver. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_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. More... | |
Functions | |
| FILE_LICENCE (BSD2_PATENT) | |
Variables | |
| EFI_GUID | gEfiIp4ConfigProtocolGuid |
This file provides a definition of the EFI IPv4 Configuration Protocol.
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
Definition in file Ip4Config.h.
| #define EFI_IP4_CONFIG_PROTOCOL_GUID |
Definition at line 20 of file Ip4Config.h.
| #define IP4_CONFIG_VARIABLE_ATTRIBUTES (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS) |
Definition at line 27 of file Ip4Config.h.
| typedef struct _EFI_IP4_CONFIG_PROTOCOL EFI_IP4_CONFIG_PROTOCOL |
Definition at line 25 of file Ip4Config.h.
| typedef EFI_STATUS(EFIAPI * EFI_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.
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.
| This | The pointer to the EFI_IP4_CONFIG_PROTOCOL instance. |
| 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. |
| 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. |
| EFI_SUCCESS | The configuration policy for the EFI IPv4 Protocol driver is now running. |
| EFI_INVALID_PARAMETER | One or more of the following parameters is NULL: This DoneEvent ReconfigEvent |
| EFI_OUT_OF_RESOURCES | Required system resources could not be allocated. |
| EFI_ALREADY_STARTED | The configuration policy for the EFI IPv4 Protocol driver was already started. |
| EFI_DEVICE_ERROR | An unexpected system error or network error occurred. |
| EFI_UNSUPPORTED | This interface does not support the EFI IPv4 Protocol driver configuration. |
Definition at line 106 of file Ip4Config.h.
| typedef EFI_STATUS(EFIAPI * EFI_IP4_CONFIG_STOP) (IN EFI_IP4_CONFIG_PROTOCOL *This) |
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().
| This | The pointer to the EFI_IP4_CONFIG_PROTOCOL instance. |
| EFI_SUCCESS | The configuration policy for the EFI IPv4 Protocol driver has been stopped. |
| EFI_INVALID_PARAMETER | This is NULL. |
| EFI_NOT_STARTED | The configuration policy for the EFI IPv4 Protocol driver was not started. |
Definition at line 129 of file Ip4Config.h.
| typedef EFI_STATUS(EFIAPI * EFI_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.
The GetData() function returns the current configuration data for the EFI IPv4 Protocol driver after the configuration policy has completed.
| This | The pointer to the EFI_IP4_CONFIG_PROTOCOL instance. |
| IpConfigDataSize | On input, the size of the IpConfigData buffer. On output, the count of bytes that were written into the IpConfigData buffer. |
| IpConfigData | The pointer to the EFI IPv4 Configuration Protocol driver configuration data structure. Type EFI_IP4_IPCONFIG_DATA is defined in "Related Definitions" below. |
| EFI_SUCCESS | The EFI IPv4 Protocol driver configuration has been returned. |
| EFI_INVALID_PARAMETER | This is NULL. |
| EFI_NOT_STARTED | The configuration policy for the EFI IPv4 Protocol driver is not running. |
| EFI_NOT_READY | EFI IPv4 Protocol driver configuration is still running. |
| EFI_ABORTED | EFI 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 160 of file Ip4Config.h.
| FILE_LICENCE | ( | BSD2_PATENT | ) |
| EFI_GUID gEfiIp4ConfigProtocolGuid |
1.8.15