4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/** @file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI ARP Protocol Definition
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The EFI ARP Service Binding Protocol is used to locate EFI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ARP Protocol drivers to create and destroy child of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync driver to communicate with other host using ARP protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The EFI ARP Protocol provides services to map IP network
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync address to hardware address used by a data link protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials are licensed and made available under
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncthe terms and conditions of the BSD License that accompanies this distribution.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThe full text of the license may be found at
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 @par Revision Reference:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This Protocol was introduced in UEFI Specification 2.0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#ifndef __EFI_ARP_PROTOCOL_H__
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define __EFI_ARP_PROTOCOL_H__
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_ARP_SERVICE_BINDING_PROTOCOL_GUID \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync { \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0xf44c00ee, 0x1f2c, 0x4a00, {0xaa, 0x9, 0x1c, 0x9f, 0x3e, 0x8, 0x0, 0xa3 } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_ARP_PROTOCOL_GUID \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync { \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0xf4b427bb, 0xba21, 0x4f16, {0xbc, 0x4e, 0x43, 0xe4, 0x16, 0xab, 0x61, 0x9c } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_ARP_PROTOCOL EFI_ARP_PROTOCOL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Length in bytes of this entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 Size;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set to TRUE if this entry is a "deny" entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set to FALSE if this entry is a "normal" entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BOOLEAN DenyFlag;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set to TRUE if this entry will not time out.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set to FALSE if this entry will time out.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BOOLEAN StaticFlag;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// 16-bit ARP hardware identifier number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT16 HwAddressType;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// 16-bit protocol type number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT16 SwAddressType;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The length of the hardware address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 HwAddressLength;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The length of the protocol address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 SwAddressLength;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_ARP_FIND_DATA;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// 16-bit protocol type number in host byte order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT16 SwAddressType;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The length in bytes of the station's protocol address to register.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 SwAddressLength;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The pointer to the first byte of the protocol address to register. For
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// example, if SwAddressType is 0x0800 (IP), then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// StationAddress points to the first byte of this station's IP
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// address stored in network byte order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync VOID *StationAddress;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The timeout value in 100-ns units that is associated with each
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// new dynamic ARP cache entry. If it is set to zero, the value is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// implementation-specific.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 EntryTimeOut;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The number of retries before a MAC address is resolved. If it is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// set to zero, the value is implementation-specific.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 RetryCount;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The timeout value in 100-ns units that is used to wait for the ARP
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// reply packet or the timeout value between two retries. Set to zero
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// to use implementation-specific value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 RetryTimeOut;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_ARP_CONFIG_DATA;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is used to assign a station address to the ARP cache for this instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the ARP driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Each ARP instance has one station address. The EFI_ARP_PROTOCOL driver will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync respond to ARP requests that match this registered station address. A call to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this function with the ConfigData field set to NULL will reset this ARP instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Once a protocol type and station address have been assigned to this ARP instance,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync all the following ARP functions will use this information. Attempting to change
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the protocol type or station address to a configured ARP instance will result in errors.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_ARP_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ConfigData The pointer to the EFI_ARP_CONFIG_DATA structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The new station address was successfully
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync registered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * SwAddressLength is zero when ConfigData is not NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * StationAddress is NULL when ConfigData is not NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The SwAddressType, SwAddressLength, or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync StationAddress is different from the one that is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync already registered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Storage for the new StationAddress could not be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync(EFIAPI *EFI_ARP_CONFIGURE)(
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_ARP_PROTOCOL *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_ARP_CONFIG_DATA *ConfigData OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is used to insert entries into the ARP cache.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ARP cache entries are typically inserted and updated by network protocol drivers
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync as network traffic is processed. Most ARP cache entries will time out and be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync deleted if the network traffic stops. ARP cache entries that were inserted
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by the Add() function may be static (will not time out) or dynamic (will time out).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Default ARP cache timeout values are not covered in most network protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specifications (although RFC 1122 comes pretty close) and will only be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync discussed in general terms in this specification. The timeout values that are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync used in the EFI Sample Implementation should be used only as a guideline.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Final product implementations of the EFI network stack should be tuned for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync their expected network environments.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Pointer to the EFI_ARP_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DenyFlag Set to TRUE if this entry is a deny entry. Set to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FALSE if this entry is a normal entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param TargetSwAddress Pointer to a protocol address to add (or deny).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync May be set to NULL if DenyFlag is TRUE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param TargetHwAddress Pointer to a hardware address to add (or deny).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync May be set to NULL if DenyFlag is TRUE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param TimeoutValue Time in 100-ns units that this entry will remain
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in the ARP cache. A value of zero means that the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync entry is permanent. A nonzero value will override
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the one given by Configure() if the entry to be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync added is a dynamic entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Overwrite If TRUE, the matching cache entry will be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync overwritten with the supplied parameters. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FALSE, EFI_ACCESS_DENIED is returned if the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync corresponding cache entry already exists.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The entry has been added or updated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * DenyFlag is FALSE and TargetHwAddress is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * DenyFlag is FALSE and TargetSwAddress is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * TargetHwAddress is NULL and TargetSwAddress is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Neither TargetSwAddress nor TargetHwAddress are NULL when DenyFlag is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TRUE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The new ARP cache entry could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The ARP cache entry already exists and Overwrite
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is not true.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The ARP driver instance has not been configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync(EFIAPI *EFI_ARP_ADD)(
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_ARP_PROTOCOL *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN BOOLEAN DenyFlag,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VOID *TargetSwAddress OPTIONAL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VOID *TargetHwAddress OPTIONAL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT32 TimeoutValue,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN BOOLEAN Overwrite
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function searches the ARP cache for matching entries and allocates a buffer into
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which those entries are copied.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The first part of the allocated buffer is EFI_ARP_FIND_DATA, following which
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are protocol address pairs and hardware address pairs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync When finding a specific protocol address (BySwAddress is TRUE and AddressBuffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is not NULL), the ARP cache timeout for the found entry is reset if Refresh is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync set to TRUE. If the found ARP cache entry is a permanent entry, it is not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync affected by Refresh.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_ARP_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BySwAddress Set to TRUE to look for matching software protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync addresses. Set to FALSE to look for matching
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync hardware protocol addresses.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param AddressBuffer The pointer to the address buffer. Set to NULL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to match all addresses.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param EntryLength The size of an entry in the entries buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param EntryCount The number of ARP cache entries that are found by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the specified criteria.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Entries The pointer to the buffer that will receive the ARP
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync cache entries.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Refresh Set to TRUE to refresh the timeout value of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync matching ARP cache entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The requested ARP cache entries were copied into
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is NULL. Both EntryCount and EntryLength are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NULL, when Refresh is FALSE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND No matching entries were found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The ARP driver instance has not been configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync(EFIAPI *EFI_ARP_FIND)(
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_ARP_PROTOCOL *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN BOOLEAN BySwAddress,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VOID *AddressBuffer OPTIONAL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT32 *EntryLength OPTIONAL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT32 *EntryCount OPTIONAL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT EFI_ARP_FIND_DATA **Entries OPTIONAL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN BOOLEAN Refresh
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function removes specified ARP cache entries.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_ARP_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BySwAddress Set to TRUE to delete matching protocol addresses.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Set to FALSE to delete matching hardware
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync addresses.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param AddressBuffer The pointer to the address buffer that is used as a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync key to look for the cache entry. Set to NULL to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync delete all entries.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The entry was removed from the ARP cache.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The specified deletion key was not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The ARP driver instance has not been configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync(EFIAPI *EFI_ARP_DELETE)(
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_ARP_PROTOCOL *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN BOOLEAN BySwAddress,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VOID *AddressBuffer OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function delete all dynamic entries from the ARP cache that match the specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync software protocol type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_ARP_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The cache has been flushed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND There are no matching dynamic cache entries.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The ARP driver instance has not been configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync(EFIAPI *EFI_ARP_FLUSH)(
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_ARP_PROTOCOL *This
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function tries to resolve the TargetSwAddress and optionally returns a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TargetHwAddress if it already exists in the ARP cache.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_ARP_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param TargetSwAddress The pointer to the protocol address to resolve.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ResolvedEvent The pointer to the event that will be signaled when
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the address is resolved or some error occurs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param TargetHwAddress The pointer to the buffer for the resolved hardware
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync address in network byte order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The data is copied from the ARP cache into the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TargetHwAddress buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is NULL. TargetHwAddress is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The requested address is not present in the normal
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ARP cache but is present in the deny address list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Outgoing traffic to that address is forbidden.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The ARP driver instance has not been configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY The request has been started and is not finished.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync(EFIAPI *EFI_ARP_REQUEST)(
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_ARP_PROTOCOL *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VOID *TargetSwAddress OPTIONAL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_EVENT ResolvedEvent OPTIONAL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT VOID *TargetHwAddress
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function aborts the previous ARP request (identified by This, TargetSwAddress
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and ResolvedEvent) that is issued by EFI_ARP_PROTOCOL.Request().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the request is in the internal ARP request queue, the request is aborted
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync immediately and its ResolvedEvent is signaled. Only an asynchronous address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync request needs to be canceled. If TargeSwAddress and ResolveEvent are both
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NULL, all the pending asynchronous requests that have been issued by This
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync instance will be cancelled and their corresponding events will be signaled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_ARP_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param TargetSwAddress The pointer to the protocol address in previous
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync request session.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ResolvedEvent Pointer to the event that is used as the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync notification event in previous request session.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The pending request session(s) is/are aborted and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync corresponding event(s) is/are signaled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is NULL. TargetSwAddress is not NULL and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ResolvedEvent is NULL. TargetSwAddress is NULL and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ResolvedEvent is not NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The ARP driver instance has not been configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The request is not issued by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_ARP_PROTOCOL.Request().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync(EFIAPI *EFI_ARP_CANCEL)(
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_ARP_PROTOCOL *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VOID *TargetSwAddress OPTIONAL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_EVENT ResolvedEvent OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// ARP is used to resolve local network protocol addresses into
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// network hardware addresses.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncstruct _EFI_ARP_PROTOCOL {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_ARP_CONFIGURE Configure;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_ARP_ADD Add;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_ARP_FIND Find;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_ARP_DELETE Delete;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_ARP_FLUSH Flush;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_ARP_REQUEST Request;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_ARP_CANCEL Cancel;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync};
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncextern EFI_GUID gEfiArpServiceBindingProtocolGuid;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncextern EFI_GUID gEfiArpProtocolGuid;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#endif