|
| typedef struct _EFI_ARP_PROTOCOL | EFI_ARP_PROTOCOL |
| |
| typedef EFI_STATUS(EFIAPI * | EFI_ARP_CONFIGURE) (IN EFI_ARP_PROTOCOL *This, IN EFI_ARP_CONFIG_DATA *ConfigData OPTIONAL) |
| |
| typedef EFI_STATUS(EFIAPI * | EFI_ARP_ADD) (IN EFI_ARP_PROTOCOL *This, IN BOOLEAN DenyFlag, IN VOID *TargetSwAddress OPTIONAL, IN VOID *TargetHwAddress OPTIONAL, IN UINT32 TimeoutValue, IN BOOLEAN Overwrite) |
| |
| typedef EFI_STATUS(EFIAPI * | EFI_ARP_FIND) (IN EFI_ARP_PROTOCOL *This, IN BOOLEAN BySwAddress, IN VOID *AddressBuffer OPTIONAL, OUT UINT32 *EntryLength OPTIONAL, OUT UINT32 *EntryCount OPTIONAL, OUT EFI_ARP_FIND_DATA **Entries OPTIONAL, IN BOOLEAN Refresh) |
| |
| typedef EFI_STATUS(EFIAPI * | EFI_ARP_DELETE) (IN EFI_ARP_PROTOCOL *This, IN BOOLEAN BySwAddress, IN VOID *AddressBuffer OPTIONAL) |
| |
| typedef EFI_STATUS(EFIAPI * | EFI_ARP_FLUSH) (IN EFI_ARP_PROTOCOL *This) |
| |
| typedef EFI_STATUS(EFIAPI * | EFI_ARP_REQUEST) (IN EFI_ARP_PROTOCOL *This, IN VOID *TargetSwAddress OPTIONAL, IN EFI_EVENT ResolvedEvent OPTIONAL, OUT VOID *TargetHwAddress) |
| |
| typedef EFI_STATUS(EFIAPI * | EFI_ARP_CANCEL) (IN EFI_ARP_PROTOCOL *This, IN VOID *TargetSwAddress OPTIONAL, IN EFI_EVENT ResolvedEvent OPTIONAL) |
| |
EFI ARP Protocol Definition
The EFI ARP Service Binding Protocol is used to locate EFI ARP Protocol drivers to create and destroy child of the driver to communicate with other host using ARP protocol. The EFI ARP Protocol provides services to map IP network address to hardware address used by a data link protocol.
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
- Revision Reference:
- This Protocol was introduced in UEFI Specification 2.0.
Definition in file Arp.h.
This function aborts the previous ARP request (identified by This, TargetSwAddress and ResolvedEvent) that is issued by EFI_ARP_PROTOCOL.Request().
If the request is in the internal ARP request queue, the request is aborted immediately and its ResolvedEvent is signaled. Only an asynchronous address request needs to be canceled. If TargeSwAddress and ResolveEvent are both NULL, all the pending asynchronous requests that have been issued by This instance will be cancelled and their corresponding events will be signaled.
- Parameters
-
| This | The pointer to the EFI_ARP_PROTOCOL instance. |
| TargetSwAddress | The pointer to the protocol address in previous request session. |
| ResolvedEvent | Pointer to the event that is used as the notification event in previous request session. |
- Return values
-
| EFI_SUCCESS | The pending request session(s) is/are aborted and corresponding event(s) is/are signaled. |
| EFI_INVALID_PARAMETER | One or more of the following conditions is TRUE: This is NULL. TargetSwAddress is not NULL and ResolvedEvent is NULL. TargetSwAddress is NULL and ResolvedEvent is not NULL. |
| EFI_NOT_STARTED | The ARP driver instance has not been configured. |
| EFI_NOT_FOUND | The request is not issued by EFI_ARP_PROTOCOL.Request(). |
Definition at line 352 of file Arp.h.
This function is used to assign a station address to the ARP cache for this instance of the ARP driver.
Each ARP instance has one station address. The EFI_ARP_PROTOCOL driver will respond to ARP requests that match this registered station address. A call to this function with the ConfigData field set to NULL will reset this ARP instance.
Once a protocol type and station address have been assigned to this ARP instance, all the following ARP functions will use this information. Attempting to change the protocol type or station address to a configured ARP instance will result in errors.
- Parameters
-
| This | The pointer to the EFI_ARP_PROTOCOL instance. |
| ConfigData | The pointer to the EFI_ARP_CONFIG_DATA structure. |
- Return values
-
| EFI_SUCCESS | The new station address was successfully registered. |
| EFI_INVALID_PARAMETER | One or more of the following conditions is TRUE: This is NULL. SwAddressLength is zero when ConfigData is not NULL. StationAddress is NULL when ConfigData is not NULL. |
| EFI_ACCESS_DENIED | The SwAddressType, SwAddressLength, or StationAddress is different from the one that is already registered. |
| EFI_OUT_OF_RESOURCES | Storage for the new StationAddress could not be allocated. |
Definition at line 141 of file Arp.h.
This function searches the ARP cache for matching entries and allocates a buffer into which those entries are copied.
The first part of the allocated buffer is EFI_ARP_FIND_DATA, following which are protocol address pairs and hardware address pairs. When finding a specific protocol address (BySwAddress is TRUE and AddressBuffer is not NULL), the ARP cache timeout for the found entry is reset if Refresh is set to TRUE. If the found ARP cache entry is a permanent entry, it is not affected by Refresh.
- Parameters
-
| This | The pointer to the EFI_ARP_PROTOCOL instance. |
| BySwAddress | Set to TRUE to look for matching software protocol addresses. Set to FALSE to look for matching hardware protocol addresses. |
| AddressBuffer | The pointer to the address buffer. Set to NULL to match all addresses. |
| EntryLength | The size of an entry in the entries buffer. |
| EntryCount | The number of ARP cache entries that are found by the specified criteria. |
| Entries | The pointer to the buffer that will receive the ARP cache entries. |
| Refresh | Set to TRUE to refresh the timeout value of the matching ARP cache entry. |
- Return values
-
| EFI_SUCCESS | The requested ARP cache entries were copied into the buffer. |
| EFI_INVALID_PARAMETER | One or more of the following conditions is TRUE: This is NULL. Both EntryCount and EntryLength are NULL, when Refresh is FALSE. |
| EFI_NOT_FOUND | No matching entries were found. |
| EFI_NOT_STARTED | The ARP driver instance has not been configured. |
Definition at line 238 of file Arp.h.
1.9.6