4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/** @file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This file provides a definition of the EFI IPv6 Configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2008 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncare licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncwhich accompanies this distribution. The full text of the license may be found at<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynchttp://opensource.org/licenses/bsd-license.php
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
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
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#ifndef __EFI_IP6CONFIG_PROTOCOL_H__
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define __EFI_IP6CONFIG_PROTOCOL_H__
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Protocol/Ip6.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_IP6_CONFIG_PROTOCOL_GUID \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync { \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0x937fe521, 0x95ae, 0x4d1a, {0x89, 0x29, 0x48, 0xbc, 0xd9, 0x0a, 0xd3, 0x1a } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_IP6_CONFIG_PROTOCOL EFI_IP6_CONFIG_PROTOCOL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IP6_CONFIG_DATA_TYPE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The interface information of the communication
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// device this EFI IPv6 Configuration Protocol instance manages.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This type of data is read only.The corresponding Data is of type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_IP6_CONFIG_INTERFACE_INFO.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Ip6ConfigDataTypeInterfaceInfo,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The alternative interface ID for the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// communication device this EFI IPv6 Configuration Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// instance manages if the link local IPv6 address generated from
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the interfaced ID based on the default source the EFI IPv6
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Protocol uses is a duplicate address. The length of the interface
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// ID is 64 bit. The corresponding Data is of type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_IP6_CONFIG_INTERFACE_ID.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Ip6ConfigDataTypeAltInterfaceId,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The general configuration policy for the EFI IPv6 network
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// stack running on the communication device this EFI IPv6
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Configuration Protocol instance manages. The policy will affect
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// other configuration settings. The corresponding Data is of type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_IP6_CONFIG_POLICY.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Ip6ConfigDataTypePolicy,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The number of consecutive
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Neighbor Solicitation messages sent while performing Duplicate
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Address Detection on a tentative address. A value of zero
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// indicates that Duplicate Address Detection will not be performed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// on tentative addresses. The corresponding Data is of type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Ip6ConfigDataTypeDupAddrDetectTransmits,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The station addresses set manually for the EFI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// IPv6 network stack. It is only configurable when the policy is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Ip6ConfigPolicyManual. The corresponding Data is a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// pointer to an array of EFI_IPv6_ADDRESS instances.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Ip6ConfigDataTypeManualAddress,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The gateway addresses set manually for the EFI IPv6
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// network stack running on the communication device this EFI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// IPv6 Configuration Protocol manages. It is not configurable when
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the policy is Ip6ConfigPolicyAutomatic. The gateway
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// addresses must be unicast IPv6 addresses. The corresponding
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Data is a pointer to an array of EFI_IPv6_ADDRESS instances.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Ip6ConfigDataTypeGateway,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The DNS server list for the EFI IPv6 network stack
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// running on the communication device this EFI IPv6
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Configuration Protocol manages. It is not configurable when the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// policy is Ip6ConfigPolicyAutomatic.The DNS server
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// addresses must be unicast IPv6 addresses. The corresponding
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Data is a pointer to an array of EFI_IPv6_ADDRESS instances.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Ip6ConfigDataTypeDnsServer,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The number of this enumeration memebers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Ip6ConfigDataTypeMaximum
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IP6_CONFIG_DATA_TYPE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IP6_CONFIG_INTERFACE_INFO
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// describes the operational state of the interface this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI IPv6 Configuration Protocol instance manages.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The name of the interface. It is a NULL-terminated string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHAR16 Name[32];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The interface type of the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 IfType;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The size, in bytes, of the network interface's hardware address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 HwAddressSize;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The hardware address for the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_MAC_ADDRESS HwAddress;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of EFI_IP6_ADDRESS_INFO structures pointed to by AddressInfo.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 AddressInfoCount;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Pointer to an array of EFI_IP6_ADDRESS_INFO instances
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// which contain the local IPv6 addresses and the corresponding
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// prefix length information. Set to NULL if AddressInfoCount
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// is zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IP6_ADDRESS_INFO *AddressInfo;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of route table entries in the following RouteTable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 RouteCount;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The route table of the IPv6 network stack runs on this interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set to NULL if RouteCount is zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IP6_ROUTE_TABLE *RouteTable;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IP6_CONFIG_INTERFACE_INFO;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IP6_CONFIG_INTERFACE_ID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// describes the 64-bit interface ID.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 Id[8];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IP6_CONFIG_INTERFACE_ID;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IP6_CONFIG_POLICY
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// defines the general configuration policy the EFI IPv6
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Configuration Protocol supports.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Under this policy, the IpI6ConfigDataTypeManualAddress,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Ip6ConfigDataTypeGateway and Ip6ConfigDataTypeDnsServer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// configuration data are required to be set manually.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The EFI IPv6 Protocol will get all required configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// such as address, prefix and gateway settings from the EFI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// IPv6 Configuration protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Ip6ConfigPolicyManual,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Under this policy, the IpI6ConfigDataTypeManualAddress,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Ip6ConfigDataTypeGateway and Ip6ConfigDataTypeDnsServer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// configuration data are not allowed to set via SetData().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// All of these configurations are retrieved from some auto
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// configuration mechanism.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The EFI IPv6 Protocol will use the IPv6 stateless address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// autoconfiguration mechanism and/or the IPv6 stateful address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// autoconfiguration mechanism described in the related RFCs to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// get address and other configuration information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Ip6ConfigPolicyAutomatic
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IP6_CONFIG_POLICY;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// describes the number of consecutive Neighbor Solicitation messages sent
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// while performing Duplicate Address Detection on a tentative address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The default value for a newly detected communication device is 1.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 DupAddrDetectTransmits; ///< The number of consecutive Neighbor Solicitation messages sent.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IP6_CONFIG_MANUAL_ADDRESS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// is used to set the station address information for the EFI IPv6 network
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// stack manually when the policy is Ip6ConfigPolicyManual.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPv6_ADDRESS Address; ///< The IPv6 unicast address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BOOLEAN IsAnycast; ///< Set to TRUE if Address is anycast.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 PrefixLength; ///< The length, in bits, of the prefix associated with this Address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IP6_CONFIG_MANUAL_ADDRESS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Set the configuration for the EFI IPv6 network stack running on the communication
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync device this EFI IPv6 Configuration Protocol instance manages.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is used to set the configuration data of type DataType for the EFI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IPv6 network stack running on the communication device this EFI IPv6 Configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Protocol instance manages.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The DataSize is used to calculate the count of structure instances in the Data for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync some DataType that multiple structure instances are allowed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is always non-blocking. When setting some type of configuration data,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync an asynchronous process is invoked to check the correctness of the data, such as
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync doing Duplicate Address Detection on the manually set local IPv6 addresses.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_NOT_READY is returned immediately to indicate that such an asynchronous process
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is invoked and the process is not finished yet. The caller willing to get the result
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the asynchronous process is required to call RegisterDataNotify() to register an
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync event on the specified configuration data. Once the event is signaled, the caller
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync can call GetData() to get back the configuration data in order to know the result.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync For other types of configuration data that do not require an asynchronous configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync process, the result of the operation is immediately returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_IP6_CONFIG_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DataType The type of data to set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DataSize Size of the buffer pointed to by Data in bytes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Data The data buffer to set. The type of the data buffer is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync associated with the DataType.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The specified configuration data for the EFI IPv6
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync network stack is set successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the following are TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Data is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - One or more fields in Data do not match the requirement of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync data type indicated by DataType.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_WRITE_PROTECTED The specified configuration data is read-only or the specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configuration data can not be set under the current policy
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED Another set operation on the specified configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync data is already in process.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY An asynchronous process is invoked to set the specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configuration data and the process is not finished yet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync indicated by DataType.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED This DataType is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected system error or network error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync(EFIAPI *EFI_IP6_CONFIG_SET_DATA)(
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_IP6_CONFIG_PROTOCOL *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_IP6_CONFIG_DATA_TYPE DataType,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINTN DataSize,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VOID *Data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Get the configuration data for the EFI IPv6 network stack running on the communication
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync device this EFI IPv6 Configuration Protocol instance manages.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns the configuration data of type DataType for the EFI IPv6 network
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync stack running on the communication device this EFI IPv6 Configuration Protocol instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync manages.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The caller is responsible for allocating the buffer used to return the specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configuration data and the required size will be returned to the caller if the size of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the buffer is too small.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_NOT_READY is returned if the specified configuration data is not ready due to an
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync already in progress asynchronous configuration process. The caller can call RegisterDataNotify()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to register an event on the specified configuration data. Once the asynchronous configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync process is finished, the event will be signaled and a subsequent GetData() call will return
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the specified configuration data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_IP6_CONFIG_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DataType The type of data to get.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in,out] DataSize On input, in bytes, the size of Data. On output, in bytes, the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync size of buffer required to store the specified configuration data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Data The data buffer in which the configuration data is returned. The
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync type of the data buffer is associated with the DataType.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The specified configuration data is got successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the followings are TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - DataSize is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Data is NULL if *DataSize is not zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL The size of Data is too small for the specified configuration data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and the required size is returned in DataSize.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY The specified configuration data is not ready due to an already in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync progress asynchronous configuration process.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The specified configuration data is not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync(EFIAPI *EFI_IP6_CONFIG_GET_DATA)(
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_IP6_CONFIG_PROTOCOL *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_IP6_CONFIG_DATA_TYPE DataType,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT UINTN *DataSize,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VOID *Data OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Register an event that is to be signaled whenever a configuration process on the specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configuration data is done.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function registers an event that is to be signaled whenever a configuration process
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync on the specified configuration data is done. An event can be registered for different DataType
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync simultaneously and the caller is responsible for determining which type of configuration data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync causes the signaling of the event in such case.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_IP6_CONFIG_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DataType The type of data to unregister the event for.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Event The event to register.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The notification event for the specified configuration data is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync registered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER This is NULL or Event is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The configuration data type specified by DataType is not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The Event is already registered for the DataType.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync(EFIAPI *EFI_IP6_CONFIG_REGISTER_NOTIFY)(
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_IP6_CONFIG_PROTOCOL *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_IP6_CONFIG_DATA_TYPE DataType,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_EVENT Event
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Remove a previously registered event for the specified configuration data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function removes a previously registered event for the specified configuration data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_IP6_CONFIG_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DataType The type of data to remove the previously registered event for.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Event The event to unregister.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The event registered for the specified configuration data is removed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER This is NULL or Event is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The Event has not been registered for the specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DataType.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync(EFIAPI *EFI_IP6_CONFIG_UNREGISTER_NOTIFY)(
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_IP6_CONFIG_PROTOCOL *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_IP6_CONFIG_DATA_TYPE DataType,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_EVENT Event
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The EFI_IP6_CONFIG_PROTOCOL provides the mechanism to set and get various
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// types of configurations for the EFI IPv6 network stack.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncstruct _EFI_IP6_CONFIG_PROTOCOL {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IP6_CONFIG_SET_DATA SetData;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IP6_CONFIG_GET_DATA GetData;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IP6_CONFIG_REGISTER_NOTIFY RegisterDataNotify;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IP6_CONFIG_UNREGISTER_NOTIFY UnregisterDataNotify;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync};
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncextern EFI_GUID gEfiIp6ConfigProtocolGuid;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#endif
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync