- Generated on Fri Nov 15 2024 18:01:35 for TianoCore EDK2 by
1.9.6
|
TianoCore EDK2 master
|
#include <Protocol/Ip4.h>Go to the source code of this file.
Data Structures | |
| struct | EFI_IP4_CONFIG2_INTERFACE_INFO |
| struct | EFI_IP4_CONFIG2_MANUAL_ADDRESS |
| struct | _EFI_IP4_CONFIG2_PROTOCOL |
Macros | |
| #define | EFI_IP4_CONFIG2_PROTOCOL_GUID |
| #define | EFI_IP4_CONFIG2_INTERFACE_INFO_NAME_SIZE 32 |
Typedefs | |
| typedef struct _EFI_IP4_CONFIG2_PROTOCOL | EFI_IP4_CONFIG2_PROTOCOL |
| typedef EFI_STATUS(EFIAPI * | EFI_IP4_CONFIG2_SET_DATA) (IN EFI_IP4_CONFIG2_PROTOCOL *This, IN EFI_IP4_CONFIG2_DATA_TYPE DataType, IN UINTN DataSize, IN VOID *Data) |
| typedef EFI_STATUS(EFIAPI * | EFI_IP4_CONFIG2_GET_DATA) (IN EFI_IP4_CONFIG2_PROTOCOL *This, IN EFI_IP4_CONFIG2_DATA_TYPE DataType, IN OUT UINTN *DataSize, IN VOID *Data OPTIONAL) |
| typedef EFI_STATUS(EFIAPI * | EFI_IP4_CONFIG2_REGISTER_NOTIFY) (IN EFI_IP4_CONFIG2_PROTOCOL *This, IN EFI_IP4_CONFIG2_DATA_TYPE DataType, IN EFI_EVENT Event) |
| typedef EFI_STATUS(EFIAPI * | EFI_IP4_CONFIG2_UNREGISTER_NOTIFY) (IN EFI_IP4_CONFIG2_PROTOCOL *This, IN EFI_IP4_CONFIG2_DATA_TYPE DataType, IN EFI_EVENT Event) |
Enumerations | |
| enum | EFI_IP4_CONFIG2_DATA_TYPE { Ip4Config2DataTypeInterfaceInfo , Ip4Config2DataTypePolicy , Ip4Config2DataTypeManualAddress , Ip4Config2DataTypeGateway , Ip4Config2DataTypeDnsServer , Ip4Config2DataTypeMaximum } |
| enum | EFI_IP4_CONFIG2_POLICY { Ip4Config2PolicyStatic , Ip4Config2PolicyDhcp , Ip4Config2PolicyMax } |
Variables | |
| EFI_GUID | gEfiIp4Config2ProtocolGuid |
This file provides a definition of the EFI IPv4 Configuration II Protocol.
Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
Definition in file Ip4Config2.h.
| #define EFI_IP4_CONFIG2_INTERFACE_INFO_NAME_SIZE 32 |
EFI_IP4_CONFIG2_INTERFACE_INFO related definitions
Definition at line 81 of file Ip4Config2.h.
| #define EFI_IP4_CONFIG2_PROTOCOL_GUID |
Definition at line 18 of file Ip4Config2.h.
| typedef EFI_STATUS(EFIAPI * EFI_IP4_CONFIG2_GET_DATA) (IN EFI_IP4_CONFIG2_PROTOCOL *This, IN EFI_IP4_CONFIG2_DATA_TYPE DataType, IN OUT UINTN *DataSize, IN VOID *Data OPTIONAL) |
Get the configuration data for the EFI IPv4 network stack running on the communication device this EFI IPv4 Configuration II Protocol instance manages.
This function returns the configuration data of type DataType for the EFI IPv4 network stack running on the communication device this EFI IPv4 Configuration II Protocol instance manages. The caller is responsible for allocating the buffer usedto return the specified configuration data and the required size will be returned to the caller if the size of the buffer is too small. EFI_NOT_READY is returned if the specified configuration data is not ready due to an already in progress asynchronous configuration process. The caller can call RegisterDataNotify() to register an event on the specified configuration data. Once the asynchronous configuration process is finished, the event will be signaled and a subsequent GetData() call will return the specified configuration data.
| [in] | This | Pointer to the EFI_IP4_CONFIG2_PROTOCOL instance. |
| [in] | DataType | The type of data to get. |
| [out] | DataSize | On input, in bytes, the size of Data. On output, in bytes, the size of buffer required to store the specified configuration data. |
| [in] | Data | The data buffer in which the configuration data is returned. The type of the data buffer is associated with the DataType. Ignored if DataSize is 0. |
| EFI_SUCCESS | The specified configuration data is got successfully. |
| EFI_INVALID_PARAMETER | One or more of the followings are TRUE: This is NULL. DataSize is NULL. Data is NULL if *DataSizeis not zero. |
| EFI_BUFFER_TOO_SMALL | The size of Data is too small for the specified configuration data and the required size is returned in DataSize. |
| EFI_NOT_READY | The specified configuration data is not ready due to an already in progress asynchronous configuration process. |
| EFI_NOT_FOUND | The specified configuration data is not found. |
Definition at line 244 of file Ip4Config2.h.
| typedef struct _EFI_IP4_CONFIG2_PROTOCOL EFI_IP4_CONFIG2_PROTOCOL |
Definition at line 23 of file Ip4Config2.h.
| typedef EFI_STATUS(EFIAPI * EFI_IP4_CONFIG2_REGISTER_NOTIFY) (IN EFI_IP4_CONFIG2_PROTOCOL *This, IN EFI_IP4_CONFIG2_DATA_TYPE DataType, IN EFI_EVENT Event) |
Register an event that is to be signaled whenever a configuration process on the specified configuration data is done.
This function registers an event that is to be signaled whenever a configuration process on the specified configuration data is done. An event can be registered for different DataType simultaneously and the caller is responsible for determining which type of configuration data causes the signaling of the event in such case.
| [in] | This | Pointer to the EFI_IP4_CONFIG2_PROTOCOL instance. |
| [in] | DataType | The type of data to unregister the event for. |
| [in] | Event | The event to register. |
| EFI_SUCCESS | The notification event for the specified configuration data is registered. |
| EFI_INVALID_PARAMETER | This is NULL or Event is NULL. |
| EFI_UNSUPPORTED | The configuration data type specified by DataType is not supported. |
| EFI_OUT_OF_RESOURCES | Required system resources could not be allocated. |
| EFI_ACCESS_DENIED | The Event is already registered for the DataType. |
Definition at line 273 of file Ip4Config2.h.
| typedef EFI_STATUS(EFIAPI * EFI_IP4_CONFIG2_SET_DATA) (IN EFI_IP4_CONFIG2_PROTOCOL *This, IN EFI_IP4_CONFIG2_DATA_TYPE DataType, IN UINTN DataSize, IN VOID *Data) |
Set the configuration for the EFI IPv4 network stack running on the communication device this EFI IPv4 Configuration II Protocol instance manages.
This function is used to set the configuration data of type DataType for the EFI IPv4 network stack running on the communication device this EFI IPv4 Configuration II Protocol instance manages. The successfully configured data is valid after system reset or power-off. The DataSize is used to calculate the count of structure instances in the Data for some DataType that multiple structure instances are allowed. This function is always non-blocking. When setting some typeof configuration data, an asynchronous process is invoked to check the correctness of the data, such as doing address conflict detection on the manually set local IPv4 address. EFI_NOT_READY is returned immediately to indicate that such an asynchronous process is invoked and the process is not finished yet. The caller willing to get the result of the asynchronous process is required to call RegisterDataNotify() to register an event on the specified configuration data. Once the event is signaled, the caller can call GetData()to get back the configuration data in order to know the result. For other types of configuration data that do not require an asynchronous configuration process, the result of the operation is immediately returned.
| [in] | This | Pointer to the EFI_IP4_CONFIG2_PROTOCOL instance. |
| [in] | DataType | The type of data to set. |
| [in] | DataSize | Size of the buffer pointed to by Data in bytes. |
| [in] | Data | The data buffer to set. The type ofthe data buffer is associated with the DataType. |
| EFI_SUCCESS | The specified configuration data for the EFI IPv4 network stack is set successfully. |
| EFI_INVALID_PARAMETER | One or more of the following are TRUE: This is NULL. One or more fields in Data and DataSize do not match the requirement of the data type indicated by DataType. |
| EFI_WRITE_PROTECTED | The specified configuration data is read-only or the specified configuration data can not be set under the current policy. |
| EFI_ACCESS_DENIED | Another set operation on the specified configuration data is already in process. |
| EFI_NOT_READY | An asynchronous process is invoked to set the specified configuration data and the process is not finished yet. |
| EFI_BAD_BUFFER_SIZE | The DataSize does not match the size of the type indicated by DataType. |
| EFI_UNSUPPORTED | This DataType is not supported. |
| EFI_OUT_OF_RESOURCES | Required system resources could not be allocated. |
| EFI_DEVICE_ERROR | An unexpected system error or network error occurred. |
Definition at line 202 of file Ip4Config2.h.
| typedef EFI_STATUS(EFIAPI * EFI_IP4_CONFIG2_UNREGISTER_NOTIFY) (IN EFI_IP4_CONFIG2_PROTOCOL *This, IN EFI_IP4_CONFIG2_DATA_TYPE DataType, IN EFI_EVENT Event) |
Remove a previously registered event for the specified configuration data.
This function removes a previously registeredevent for the specified configuration data.
| [in] | This | Pointer to the EFI_IP4_CONFIG2_PROTOCOL instance. |
| [in] | DataType | The type of data to remove the previously registered event for. |
| [in] | Event | The event to unregister. |
| EFI_SUCCESS | The event registered for the specified configuration data is removed. |
| EFI_INVALID_PARAMETER | This is NULL or Event is NULL. |
| EFI_NOT_FOUND | The Eventhas not been registered for the specified DataType. |
Definition at line 294 of file Ip4Config2.h.
EFI_IP4_CONFIG2_DATA_TYPE
| Enumerator | |
|---|---|
| Ip4Config2DataTypeInterfaceInfo | The interface information of the communication device this EFI IPv4 Configuration II Protocol instance manages. This type of data is read only. The corresponding Data is of type EFI_IP4_CONFIG2_INTERFACE_INFO. |
| Ip4Config2DataTypePolicy | The general configuration policy for the EFI IPv4 network stack running on the communication device this EFI IPv4 Configuration II Protocol instance manages. The policy will affect other configuration settings. The corresponding Data is of type EFI_IP4_CONFIG2_POLICY. |
| Ip4Config2DataTypeManualAddress | The station addresses set manually for the EFI IPv4 network stack. It is only configurable when the policy is Ip4Config2PolicyStatic. The corresponding Data is of type EFI_IP4_CONFIG2_MANUAL_ADDRESS. When DataSize is 0 and Data is NULL, the existing configuration is cleared from the EFI IPv4 Configuration II Protocol instance. |
| Ip4Config2DataTypeGateway | The gateway addresses set manually for the EFI IPv4 network stack running on the communication device this EFI IPv4 Configuration II Protocol manages. It is not configurable when the policy is Ip4Config2PolicyDhcp. The gateway addresses must be unicast IPv4 addresses. The corresponding Data is a pointer to an array of EFI_IPv4_ADDRESS instances. When DataSize is 0 and Data is NULL, the existing configuration is cleared from the EFI IPv4 Configuration II Protocol instance. |
| Ip4Config2DataTypeDnsServer | The DNS server list for the EFI IPv4 network stack running on the communication device this EFI IPv4 Configuration II Protocol manages. It is not configurable when the policy is Ip4Config2PolicyDhcp. The DNS server addresses must be unicast IPv4 addresses. The corresponding Data is a pointer to an array of EFI_IPv4_ADDRESS instances. When DataSize is 0 and Data is NULL, the existing configuration is cleared from the EFI IPv4 Configuration II Protocol instance. |
Definition at line 28 of file Ip4Config2.h.
EFI_IP4_CONFIG2_POLICY
Definition at line 127 of file Ip4Config2.h.
1.9.6