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

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

Data Structures
struct	EFI_IP6_CONFIG_INTERFACE_INFO
	EFI_IP6_CONFIG_INTERFACE_INFO describes the operational state of the interface this EFI IPv6 Configuration Protocol instance manages. More...

struct	EFI_IP6_CONFIG_INTERFACE_ID
	EFI_IP6_CONFIG_INTERFACE_ID describes the 64-bit interface ID. More...

struct	EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS
	EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS describes the number of consecutive Neighbor Solicitation messages sent while performing Duplicate Address Detection on a tentative address. More...

struct	EFI_IP6_CONFIG_MANUAL_ADDRESS
	EFI_IP6_CONFIG_MANUAL_ADDRESS is used to set the station address information for the EFI IPv6 network stack manually when the policy is Ip6ConfigPolicyManual. More...

struct	_EFI_IP6_CONFIG_PROTOCOL
	The EFI_IP6_CONFIG_PROTOCOL provides the mechanism to set and get various types of configurations for the EFI IPv6 network stack. More...

Macros
#define	EFI_IP6_CONFIG_PROTOCOL_GUID

Typedefs
typedef struct _EFI_IP6_CONFIG_PROTOCOL	EFI_IP6_CONFIG_PROTOCOL

typedef EFI_STATUS(EFIAPI *	EFI_IP6_CONFIG_SET_DATA) (IN EFI_IP6_CONFIG_PROTOCOL This, IN EFI_IP6_CONFIG_DATA_TYPE DataType, IN UINTN DataSize, IN VOID Data)
	Set the configuration for the EFI IPv6 network stack running on the communication device this EFI IPv6 Configuration Protocol instance manages. More...

typedef EFI_STATUS(EFIAPI *	EFI_IP6_CONFIG_GET_DATA) (IN EFI_IP6_CONFIG_PROTOCOL This, IN EFI_IP6_CONFIG_DATA_TYPE DataType, IN OUT UINTN DataSize, IN VOID *Data OPTIONAL)
	Get the configuration data for the EFI IPv6 network stack running on the communication device this EFI IPv6 Configuration Protocol instance manages. More...

typedef EFI_STATUS(EFIAPI *	EFI_IP6_CONFIG_REGISTER_NOTIFY) (IN EFI_IP6_CONFIG_PROTOCOL *This, IN EFI_IP6_CONFIG_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. More...

typedef EFI_STATUS(EFIAPI *	EFI_IP6_CONFIG_UNREGISTER_NOTIFY) (IN EFI_IP6_CONFIG_PROTOCOL *This, IN EFI_IP6_CONFIG_DATA_TYPE DataType, IN EFI_EVENT Event)
	Remove a previously registered event for the specified configuration data. More...

Enumerations
enum	EFI_IP6_CONFIG_DATA_TYPE { Ip6ConfigDataTypeInterfaceInfo, Ip6ConfigDataTypeAltInterfaceId, Ip6ConfigDataTypePolicy, Ip6ConfigDataTypeDupAddrDetectTransmits, Ip6ConfigDataTypeManualAddress, Ip6ConfigDataTypeGateway, Ip6ConfigDataTypeDnsServer, Ip6ConfigDataTypeMaximum }
	EFI_IP6_CONFIG_DATA_TYPE. More...

enum	EFI_IP6_CONFIG_POLICY { Ip6ConfigPolicyManual, Ip6ConfigPolicyAutomatic }
	EFI_IP6_CONFIG_POLICY defines the general configuration policy the EFI IPv6 Configuration Protocol supports. More...

Functions
	FILE_LICENCE (BSD2_PATENT)

Variables
EFI_GUID	gEfiIp6ConfigProtocolGuid

Detailed Description

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

Copyright (c) 2008 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file Ip6Config.h.

Macro Definition Documentation

◆ EFI_IP6_CONFIG_PROTOCOL_GUID

#define EFI_IP6_CONFIG_PROTOCOL_GUID

Value:

{ \
    0x937fe521, 0x95ae, 0x4d1a, {0x89, 0x29, 0x48, 0xbc, 0xd9, 0x0a, 0xd3, 0x1a } \
  }

Definition at line 17 of file Ip6Config.h.

Typedef Documentation

◆ EFI_IP6_CONFIG_PROTOCOL

typedef struct _EFI_IP6_CONFIG_PROTOCOL EFI_IP6_CONFIG_PROTOCOL

Definition at line 22 of file Ip6Config.h.

◆ EFI_IP6_CONFIG_SET_DATA

typedef EFI_STATUS(EFIAPI * EFI_IP6_CONFIG_SET_DATA) (IN EFI_IP6_CONFIG_PROTOCOL *This, IN EFI_IP6_CONFIG_DATA_TYPE DataType, IN UINTN DataSize, IN VOID *Data)

Set the configuration for the EFI IPv6 network stack running on the communication device this EFI IPv6 Configuration Protocol instance manages.

This function is used to set the configuration data of type DataType for the EFI IPv6 network stack running on the communication device this EFI IPv6 Configuration Protocol instance manages.

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 type of configuration data, an asynchronous process is invoked to check the correctness of the data, such as doing Duplicate Address Detection on the manually set local IPv6 addresses. 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.

Parameters

[in]	This	Pointer to the EFI_IP6_CONFIG_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 of the data buffer is associated with the DataType.

Return values

EFI_SUCCESS	The specified configuration data for the EFI IPv6 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 250 of file Ip6Config.h.

◆ EFI_IP6_CONFIG_GET_DATA

typedef EFI_STATUS(EFIAPI * EFI_IP6_CONFIG_GET_DATA) (IN EFI_IP6_CONFIG_PROTOCOL *This, IN EFI_IP6_CONFIG_DATA_TYPE DataType, IN OUT UINTN *DataSize, IN VOID *Data OPTIONAL)

Get the configuration data for the EFI IPv6 network stack running on the communication device this EFI IPv6 Configuration Protocol instance manages.

This function returns the configuration data of type DataType for the EFI IPv6 network stack running on the communication device this EFI IPv6 Configuration Protocol instance manages.

The caller is responsible for allocating the buffer used to 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.

Parameters

[in]	This	Pointer to the EFI_IP6_CONFIG_PROTOCOL instance.
[in]	DataType	The type of data to get.
[in,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.

Return values

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 *DataSize is 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 296 of file Ip6Config.h.

◆ EFI_IP6_CONFIG_REGISTER_NOTIFY

typedef EFI_STATUS(EFIAPI * EFI_IP6_CONFIG_REGISTER_NOTIFY) (IN EFI_IP6_CONFIG_PROTOCOL *This, IN EFI_IP6_CONFIG_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.

Parameters

[in]	This	Pointer to the EFI_IP6_CONFIG_PROTOCOL instance.
[in]	DataType	The type of data to unregister the event for.
[in]	Event	The event to register.

Return values

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 327 of file Ip6Config.h.

◆ EFI_IP6_CONFIG_UNREGISTER_NOTIFY

typedef EFI_STATUS(EFIAPI * EFI_IP6_CONFIG_UNREGISTER_NOTIFY) (IN EFI_IP6_CONFIG_PROTOCOL *This, IN EFI_IP6_CONFIG_DATA_TYPE DataType, IN EFI_EVENT Event)

Remove a previously registered event for the specified configuration data.

This function removes a previously registered event for the specified configuration data.

Parameters

[in]	This	Pointer to the EFI_IP6_CONFIG_PROTOCOL instance.
[in]	DataType	The type of data to remove the previously registered event for.
[in]	Event	The event to unregister.

Return values

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 Event has not been registered for the specified DataType.

Definition at line 350 of file Ip6Config.h.

Enumeration Type Documentation

◆ EFI_IP6_CONFIG_DATA_TYPE

enum EFI_IP6_CONFIG_DATA_TYPE

EFI_IP6_CONFIG_DATA_TYPE.

Enumerator
Ip6ConfigDataTypeInterfaceInfo	The interface information of the communication device this EFI IPv6 Configuration Protocol instance manages. This type of data is read only.The corresponding Data is of type EFI_IP6_CONFIG_INTERFACE_INFO.
Ip6ConfigDataTypeAltInterfaceId	The alternative interface ID for the communication device this EFI IPv6 Configuration Protocol instance manages if the link local IPv6 address generated from the interfaced ID based on the default source the EFI IPv6 Protocol uses is a duplicate address. The length of the interface ID is 64 bit. The corresponding Data is of type EFI_IP6_CONFIG_INTERFACE_ID.
Ip6ConfigDataTypePolicy	The general configuration policy for the EFI IPv6 network stack running on the communication device this EFI IPv6 Configuration Protocol instance manages. The policy will affect other configuration settings. The corresponding Data is of type EFI_IP6_CONFIG_POLICY.
Ip6ConfigDataTypeDupAddrDetectTransmits	The number of consecutive Neighbor Solicitation messages sent while performing Duplicate Address Detection on a tentative address. A value of zero indicates that Duplicate Address Detection will not be performed on tentative addresses. The corresponding Data is of type EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS.
Ip6ConfigDataTypeManualAddress	The station addresses set manually for the EFI IPv6 network stack. It is only configurable when the policy is Ip6ConfigPolicyManual. The corresponding Data is a pointer to an array of EFI_IPv6_ADDRESS instances. When DataSize is 0 and Data is NULL, the existing configuration is cleared from the EFI IPv6 Configuration Protocol instance.
Ip6ConfigDataTypeGateway	The gateway addresses set manually for the EFI IPv6 network stack running on the communication device this EFI IPv6 Configuration Protocol manages. It is not configurable when the policy is Ip6ConfigPolicyAutomatic. The gateway addresses must be unicast IPv6 addresses. The corresponding Data is a pointer to an array of EFI_IPv6_ADDRESS instances. When DataSize is 0 and Data is NULL, the existing configuration is cleared from the EFI IPv6 Configuration Protocol instance.
Ip6ConfigDataTypeDnsServer	The DNS server list for the EFI IPv6 network stack running on the communication device this EFI IPv6 Configuration Protocol manages. It is not configurable when the policy is Ip6ConfigPolicyAutomatic.The DNS server addresses must be unicast IPv6 addresses. The corresponding Data is a pointer to an array of EFI_IPv6_ADDRESS instances. When DataSize is 0 and Data is NULL, the existing configuration is cleared from the EFI IPv6 Configuration Protocol instance.
Ip6ConfigDataTypeMaximum	The number of this enumeration memebers.

Definition at line 27 of file Ip6Config.h.

              {
   ///
   /// The interface information of the communication
   /// device this EFI IPv6 Configuration Protocol instance manages.
   /// This type of data is read only.The corresponding Data is of type
   /// EFI_IP6_CONFIG_INTERFACE_INFO.
   ///
   Ip6ConfigDataTypeInterfaceInfo,
   ///
   /// The alternative interface ID for the
   /// communication device this EFI IPv6 Configuration Protocol
   /// instance manages if the link local IPv6 address generated from
   /// the interfaced ID based on the default source the EFI IPv6
   /// Protocol uses is a duplicate address. The length of the interface
   /// ID is 64 bit. The corresponding Data is of type
   /// EFI_IP6_CONFIG_INTERFACE_ID.
   ///
   Ip6ConfigDataTypeAltInterfaceId,
   ///
   /// The general configuration policy for the EFI IPv6 network
   /// stack running on the communication device this EFI IPv6
   /// Configuration Protocol instance manages. The policy will affect
   /// other configuration settings. The corresponding Data is of type
   /// EFI_IP6_CONFIG_POLICY.
   ///
   Ip6ConfigDataTypePolicy,
   ///
   /// The number of consecutive
   /// Neighbor Solicitation messages sent while performing Duplicate
   /// Address Detection on a tentative address. A value of zero
   /// indicates that Duplicate Address Detection will not be performed
   /// on tentative addresses. The corresponding Data is of type
   /// EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS.
   ///
   Ip6ConfigDataTypeDupAddrDetectTransmits,
   ///
   /// The station addresses set manually for the EFI
   /// IPv6 network stack. It is only configurable when the policy is
   /// Ip6ConfigPolicyManual. The corresponding Data is a
   /// pointer to an array of EFI_IPv6_ADDRESS instances. When
   /// DataSize is 0 and Data is NULL, the existing configuration
   /// is cleared from the EFI IPv6 Configuration Protocol instance.
   ///
   Ip6ConfigDataTypeManualAddress,
   ///
   /// The gateway addresses set manually for the EFI IPv6
   /// network stack running on the communication device this EFI
   /// IPv6 Configuration Protocol manages. It is not configurable when
   /// the policy is Ip6ConfigPolicyAutomatic. The gateway
   /// addresses must be unicast IPv6 addresses. The corresponding
   /// Data is a pointer to an array of EFI_IPv6_ADDRESS instances.
   /// When DataSize is 0 and Data is NULL, the existing configuration
   /// is cleared from the EFI IPv6 Configuration Protocol instance.
   ///
   Ip6ConfigDataTypeGateway,
   ///
   /// The DNS server list for the EFI IPv6 network stack
   /// running on the communication device this EFI IPv6
   /// Configuration Protocol manages. It is not configurable when the
   /// policy is Ip6ConfigPolicyAutomatic.The DNS server
   /// addresses must be unicast IPv6 addresses. The corresponding
   /// Data is a pointer to an array of EFI_IPv6_ADDRESS instances.
   /// When DataSize is 0 and Data is NULL, the existing configuration
   /// is cleared from the EFI IPv6 Configuration Protocol instance.
   ///
   Ip6ConfigDataTypeDnsServer,
   ///
   /// The number of this enumeration memebers.
   ///
   Ip6ConfigDataTypeMaximum
 } EFI_IP6_CONFIG_DATA_TYPE;

◆ EFI_IP6_CONFIG_POLICY

enum EFI_IP6_CONFIG_POLICY

EFI_IP6_CONFIG_POLICY defines the general configuration policy the EFI IPv6 Configuration Protocol supports.

Enumerator

Ip6ConfigPolicyManual

Under this policy, the IpI6ConfigDataTypeManualAddress, Ip6ConfigDataTypeGateway and Ip6ConfigDataTypeDnsServer configuration data are required to be set manually.

The EFI IPv6 Protocol will get all required configuration such as address, prefix and gateway settings from the EFI IPv6 Configuration protocol.

Ip6ConfigPolicyAutomatic

Under this policy, the IpI6ConfigDataTypeManualAddress, Ip6ConfigDataTypeGateway and Ip6ConfigDataTypeDnsServer configuration data are not allowed to set via SetData().

All of these configurations are retrieved from some auto configuration mechanism. The EFI IPv6 Protocol will use the IPv6 stateless address autoconfiguration mechanism and/or the IPv6 stateful address autoconfiguration mechanism described in the related RFCs to get address and other configuration information

Definition at line 156 of file Ip6Config.h.

              {
   ///
   /// Under this policy, the IpI6ConfigDataTypeManualAddress,
   /// Ip6ConfigDataTypeGateway and Ip6ConfigDataTypeDnsServer
   /// configuration data are required to be set manually.
   /// The EFI IPv6 Protocol will get all required configuration
   /// such as address, prefix and gateway settings from the EFI
   /// IPv6 Configuration protocol.
   ///
   Ip6ConfigPolicyManual,
   ///
   /// Under this policy, the IpI6ConfigDataTypeManualAddress,
   /// Ip6ConfigDataTypeGateway and Ip6ConfigDataTypeDnsServer
   /// configuration data are not allowed to set via SetData().
   /// All of these configurations are retrieved from some auto
   /// configuration mechanism.
   /// The EFI IPv6 Protocol will use the IPv6 stateless address
   /// autoconfiguration mechanism and/or the IPv6 stateful address
   /// autoconfiguration mechanism described in the related RFCs to
   /// get address and other configuration information
   ///
   Ip6ConfigPolicyAutomatic
 } EFI_IP6_CONFIG_POLICY;

Data Structures

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ EFI_IP6_CONFIG_PROTOCOL_GUID

Typedef Documentation

◆ EFI_IP6_CONFIG_PROTOCOL

◆ EFI_IP6_CONFIG_SET_DATA

◆ EFI_IP6_CONFIG_GET_DATA

◆ EFI_IP6_CONFIG_REGISTER_NOTIFY

◆ EFI_IP6_CONFIG_UNREGISTER_NOTIFY

Enumeration Type Documentation

◆ EFI_IP6_CONFIG_DATA_TYPE

◆ EFI_IP6_CONFIG_POLICY

Function Documentation

◆ FILE_LICENCE()

Variable Documentation

◆ gEfiIp6ConfigProtocolGuid