/** @file\r
\r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+Copyright (c) 2006 - 2008, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
\r
\r
#define ARP_ETHER_PROTO_TYPE 0x0806\r
-#define IPv4_ETHER_PROTO_TYPE 0x0800\r
-#define IPv6_ETHER_PROTO_TYPE 0x86DD\r
+#define IPV4_ETHER_PROTO_TYPE 0x0800\r
+#define IPV6_ETHER_PROTO_TYPE 0x86DD\r
\r
#define ARP_OPCODE_REQUEST 0x0001\r
#define ARP_OPCODE_REPLY 0x0002\r
LIST_ENTRY UserRequestList;\r
} ARP_CACHE_ENTRY;\r
\r
+/**\r
+ This function is used to assign a station address to the ARP cache for this instance\r
+ of the ARP driver. A call to this function with the ConfigData field set to NULL\r
+ will reset this ARP instance.\r
+\r
+ @param This Pointer to the EFI_ARP_PROTOCOL instance.\r
+ @param ConfigData Pointer to the EFI_ARP_CONFIG_DATA structure.\r
+\r
+ @retval EFI_SUCCESS The new station address was successfully\r
+ registered.\r
+ @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
+ This is NULL. SwAddressLength is zero when\r
+ ConfigData is not NULL. StationAddress is NULL\r
+ when ConfigData is not NULL.\r
+ @retval EFI_ACCESS_DENIED The SwAddressType, SwAddressLength, or\r
+ StationAddress is different from the one that is\r
+ already registered.\r
+ @retval EFI_OUT_OF_RESOURCES Storage for the new StationAddress could not be\r
+ allocated.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ArpConfigure (\r
IN EFI_ARP_CONFIG_DATA *ConfigData OPTIONAL\r
);\r
\r
+/**\r
+ This function is used to insert entries into the ARP cache.\r
+\r
+ @param This Pointer to the EFI_ARP_PROTOCOL instance.\r
+ @param DenyFlag Set to TRUE if this entry is a deny entry. Set to\r
+ FALSE if this entry is a normal entry.\r
+ @param TargetSwAddress Pointer to a protocol address to add (or deny).\r
+ May be set to NULL if DenyFlag is TRUE.\r
+ @param TargetHwAddress Pointer to a hardware address to add (or deny).\r
+ May be set to NULL if DenyFlag is TRUE.\r
+ @param TimeoutValue Time in 100-ns units that this entry will remain\r
+ in the ARP cache. A value of zero means that the\r
+ entry is permanent. A nonzero value will override\r
+ the one given by Configure() if the entry to be\r
+ added is a dynamic entry.\r
+ @param Overwrite If TRUE, the matching cache entry will be\r
+ overwritten with the supplied parameters. If\r
+ FALSE, EFI_ACCESS_DENIED is returned if the\r
+ corresponding cache entry already exists.\r
+\r
+ @retval EFI_SUCCESS The entry has been added or updated.\r
+ @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
+ This is NULL. DenyFlag is FALSE and\r
+ TargetHwAddress is NULL. DenyFlag is FALSE and\r
+ TargetSwAddress is NULL. TargetHwAddress is NULL\r
+ and TargetSwAddress is NULL. Both TargetSwAddress\r
+ and TargetHwAddress are not NULL when DenyFlag is\r
+ TRUE.\r
+ @retval EFI_OUT_OF_RESOURCES The new ARP cache entry could not be allocated.\r
+ @retval EFI_ACCESS_DENIED The ARP cache entry already exists and Overwrite\r
+ is not true.\r
+ @retval EFI_NOT_STARTED The ARP driver instance has not been configured.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ArpAdd (\r
IN BOOLEAN Overwrite\r
);\r
\r
+/**\r
+ This function searches the ARP cache for matching entries and allocates a buffer into\r
+ which those entries are copied.\r
+\r
+ @param This Pointer to the EFI_ARP_PROTOCOL instance.\r
+ @param BySwAddress Set to TRUE to look for matching software protocol\r
+ addresses. Set to FALSE to look for matching\r
+ hardware protocol addresses.\r
+ @param AddressBuffer Pointer to address buffer. Set to NULL to match\r
+ all addresses.\r
+ @param EntryLength The size of an entry in the entries buffer.\r
+ @param EntryCount The number of ARP cache entries that are found by\r
+ the specified criteria.\r
+ @param Entries Pointer to the buffer that will receive the ARP\r
+ cache entries.\r
+ @param Refresh Set to TRUE to refresh the timeout value of the\r
+ matching ARP cache entry.\r
+\r
+ @retval EFI_SUCCESS The requested ARP cache entries were copied into\r
+ the buffer.\r
+ @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
+ This is NULL. Both EntryCount and EntryLength are\r
+ NULL, when Refresh is FALSE.\r
+ @retval EFI_NOT_FOUND No matching entries were found.\r
+ @retval EFI_NOT_STARTED The ARP driver instance has not been configured.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ArpFind (\r
IN BOOLEAN Refresh\r
);\r
\r
+/**\r
+ This function removes specified ARP cache entries.\r
+\r
+ @param This Pointer to the EFI_ARP_PROTOCOL instance.\r
+ @param BySwAddress Set to TRUE to delete matching protocol addresses.\r
+ Set to FALSE to delete matching hardware\r
+ addresses.\r
+ @param AddressBuffer Pointer to the address buffer that is used as a\r
+ key to look for the cache entry. Set to NULL to\r
+ delete all entries.\r
+\r
+ @retval EFI_SUCCESS The entry was removed from the ARP cache.\r
+ @retval EFI_INVALID_PARAMETER This is NULL.\r
+ @retval EFI_NOT_FOUND The specified deletion key was not found.\r
+ @retval EFI_NOT_STARTED The ARP driver instance has not been configured.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ArpDelete (\r
IN VOID *AddressBuffer OPTIONAL\r
);\r
\r
+/**\r
+ This function delete all dynamic entries from the ARP cache that match the specified\r
+ software protocol type.\r
+\r
+ @param This Pointer to the EFI_ARP_PROTOCOL instance.\r
+\r
+ @retval EFI_SUCCESS The cache has been flushed.\r
+ @retval EFI_INVALID_PARAMETER This is NULL.\r
+ @retval EFI_NOT_FOUND There are no matching dynamic cache entries.\r
+ @retval EFI_NOT_STARTED The ARP driver instance has not been configured.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ArpFlush (\r
IN EFI_ARP_PROTOCOL *This\r
);\r
\r
+/**\r
+ This function tries to resolve the TargetSwAddress and optionally returns a\r
+ TargetHwAddress if it already exists in the ARP cache.\r
+\r
+ @param This Pointer to the EFI_ARP_PROTOCOL instance.\r
+ @param TargetSwAddress Pointer to the protocol address to resolve.\r
+ @param ResolvedEvent Pointer to the event that will be signaled when\r
+ the address is resolved or some error occurs.\r
+ @param TargetHwAddress Pointer to the buffer for the resolved hardware\r
+ address in network byte order.\r
+\r
+ @retval EFI_SUCCESS The data is copied from the ARP cache into the\r
+ TargetHwAddress buffer.\r
+ @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
+ This is NULL. TargetHwAddress is NULL.\r
+ @retval EFI_ACCESS_DENIED The requested address is not present in the normal\r
+ ARP cache but is present in the deny address list.\r
+ Outgoing traffic to that address is forbidden.\r
+ @retval EFI_NOT_STARTED The ARP driver instance has not been configured.\r
+ @retval EFI_NOT_READY The request has been started and is not finished.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ArpRequest (\r
OUT VOID *TargetHwAddress\r
);\r
\r
+/**\r
+ This function aborts the previous ARP request (identified by This, TargetSwAddress\r
+ and ResolvedEvent) that is issued by EFI_ARP_PROTOCOL.Request().\r
+\r
+ @param This Pointer to the EFI_ARP_PROTOCOL instance.\r
+ @param TargetSwAddress Pointer to the protocol address in previous\r
+ request session.\r
+ @param ResolvedEvent Pointer to the event that is used as the\r
+ notification event in previous request session.\r
+\r
+ @retval EFI_SUCCESS The pending request session(s) is/are aborted and\r
+ corresponding event(s) is/are signaled.\r
+ @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
+ This is NULL. TargetSwAddress is not NULL and\r
+ ResolvedEvent is NULL. TargetSwAddress is NULL and\r
+ ResolvedEvent is not NULL.\r
+ @retval EFI_NOT_STARTED The ARP driver instance has not been configured.\r
+ @retval EFI_NOT_FOUND The request is not issued by\r
+ EFI_ARP_PROTOCOL.Request().\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ArpCancel (\r
IN EFI_EVENT ResolvedEvent OPTIONAL\r
);\r
\r
+/**\r
+ Configure the instance using the ConfigData. ConfigData is already validated.\r
+\r
+ @param Instance Pointer to the instance context data to be\r
+ configured.\r
+ @param ConfigData Pointer to the configuration data used to\r
+ configure the instance.\r
+\r
+ @retval EFI_SUCCESS The instance is configured with the ConfigData.\r
+ @retval EFI_ACCESS_DENIED The instance is already configured and the\r
+ ConfigData tries to reset some unchangeable\r
+ fields.\r
+ @retval EFI_INVALID_PARAMETER The ConfigData provides a non-unicast IPv4 address\r
+ when the SwAddressType is IPv4.\r
+ @retval EFI_OUT_OF_RESOURCES The instance fails to configure due to memory\r
+ limitation.\r
+\r
+**/\r
EFI_STATUS\r
ArpConfigureInstance (\r
IN ARP_INSTANCE_DATA *Instance,\r
IN EFI_ARP_CONFIG_DATA *ConfigData OPTIONAL\r
);\r
\r
+/**\r
+ Find the CacheEntry, using ProtocolAddress or HardwareAddress or both, as the keyword,\r
+ in the DeniedCacheTable.\r
+\r
+ @param ArpService Pointer to the arp service context data.\r
+ @param ProtocolAddress Pointer to the protocol address.\r
+ @param HardwareAddress Pointer to the hardware address.\r
+\r
+ @return Pointer to the matched cache entry, if NULL no match is found.\r
+\r
+**/\r
ARP_CACHE_ENTRY *\r
ArpFindDeniedCacheEntry (\r
IN ARP_SERVICE_DATA *ArpService,\r
IN NET_ARP_ADDRESS *HardwareAddress OPTIONAL\r
);\r
\r
+/**\r
+ Find the CacheEntry which matches the requirements in the specified CacheTable.\r
+\r
+ @param CacheTable Pointer to the arp cache table.\r
+ @param StartEntry Pointer to the start entry this search begins with\r
+ in the cache table.\r
+ @param FindOpType The search type.\r
+ @param ProtocolAddress Pointer to the protocol address to match.\r
+ @param HardwareAddress Pointer to the hardware address to match.\r
+\r
+ @return Pointer to the matched arp cache entry, if NULL, no match is found.\r
+\r
+**/\r
ARP_CACHE_ENTRY *\r
ArpFindNextCacheEntryInTable (\r
IN LIST_ENTRY *CacheTable,\r
IN NET_ARP_ADDRESS *HardwareAddress OPTIONAL\r
);\r
\r
+/**\r
+ Allocate a cache entry and initialize it.\r
+\r
+ @param Instance Pointer to the instance context data.\r
+\r
+ @return Pointer to the new created cache entry.\r
+\r
+**/\r
ARP_CACHE_ENTRY *\r
ArpAllocCacheEntry (\r
IN ARP_INSTANCE_DATA *Instance\r
);\r
\r
+/**\r
+ Fill the addresses in the CacheEntry using the information passed in by\r
+ HwAddr and SwAddr.\r
+\r
+ @param CacheEntry Pointer to the cache entry.\r
+ @param HwAddr Pointer to the software address.\r
+ @param SwAddr Pointer to the hardware address.\r
+\r
+ @return None.\r
+\r
+**/\r
VOID\r
ArpFillAddressInCacheEntry (\r
IN ARP_CACHE_ENTRY *CacheEntry,\r
IN NET_ARP_ADDRESS *SwAddr OPTIONAL\r
);\r
\r
+/**\r
+ Turn the CacheEntry into the resolved status.\r
+\r
+ @param CacheEntry Pointer to the resolved cache entry.\r
+ @param Instance Pointer to the instance context data.\r
+ @param UserEvent Pointer to the UserEvent to notify.\r
+\r
+ @return The count of notifications sent to the instance.\r
+\r
+**/\r
UINTN\r
ArpAddressResolved (\r
IN ARP_CACHE_ENTRY *CacheEntry,\r
IN EFI_EVENT UserEvent OPTIONAL\r
);\r
\r
+/**\r
+ Delete cache entries in all the cache tables.\r
+\r
+ @param Instance Pointer to the instance context data.\r
+ @param BySwAddress Delete the cache entry by software address or by\r
+ hardware address.\r
+ @param AddressBuffer Pointer to the buffer containing the address to\r
+ match for the deletion.\r
+ @param Force This deletion is forced or not.\r
+\r
+ @return The count of the deleted cache entries.\r
+\r
+**/\r
UINTN\r
ArpDeleteCacheEntry (\r
IN ARP_INSTANCE_DATA *Instance,\r
IN BOOLEAN Force\r
);\r
\r
+/**\r
+ Send out an arp frame using the CachEntry and the ArpOpCode.\r
+\r
+ @param Instance Pointer to the instance context data.\r
+ @param CacheEntry Pointer to the configuration data used to\r
+ configure the instance.\r
+ @param ArpOpCode The opcode used to send out this Arp frame, either\r
+ request or reply.\r
+\r
+ @return None.\r
+\r
+**/\r
VOID\r
ArpSendFrame (\r
IN ARP_INSTANCE_DATA *Instance,\r
IN UINT16 ArpOpCode\r
);\r
\r
+/**\r
+ Initialize the instance context data.\r
+\r
+ @param ArpService Pointer to the arp service context data this\r
+ instance belongs to.\r
+ @param Instance Pointer to the instance context data.\r
+\r
+ @return None.\r
+\r
+**/\r
VOID\r
ArpInitInstance (\r
IN ARP_SERVICE_DATA *ArpService,\r
IN ARP_INSTANCE_DATA *Instance\r
);\r
\r
+/**\r
+ Process the Arp packets received from Mnp, the procedure conforms to RFC826.\r
+\r
+ @param Context Pointer to the context data registerd to the\r
+ Event.\r
+\r
+ @return None.\r
+\r
+**/\r
VOID\r
EFIAPI\r
ArpOnFrameRcvdDpc (\r
IN VOID *Context\r
);\r
\r
+/**\r
+ Queue ArpOnFrameRcvdDpc as a DPC at TPL_CALLBACK.\r
+\r
+ @param Event The Event this notify function registered to.\r
+ @param Context Pointer to the context data registerd to the\r
+ Event.\r
+\r
+ @return None.\r
+\r
+**/\r
VOID\r
EFIAPI\r
ArpOnFrameRcvd (\r
IN VOID *Context\r
);\r
\r
+/**\r
+ Process the already sent arp packets.\r
+\r
+ @param Context Pointer to the context data registerd to the\r
+ Event.\r
+\r
+ @return None.\r
+\r
+**/\r
VOID\r
EFIAPI\r
ArpOnFrameSentDpc (\r
IN VOID *Context\r
);\r
\r
+/**\r
+ Queue ArpOnFrameRcvdDpc as a DPC at TPL_CALLBACK.\r
+\r
+ @param Event The Event this notify function registered to.\r
+ @param Context Pointer to the context data registerd to the\r
+ Event.\r
+\r
+ @return None.\r
+\r
+**/\r
VOID\r
EFIAPI\r
ArpOnFrameSent (\r
IN VOID *Context\r
);\r
\r
+/**\r
+ Process the arp cache olding and drive the retrying arp requests.\r
+\r
+ @param Event The Event this notify function registered to.\r
+ @param Context Pointer to the context data registerd to the\r
+ Event.\r
+\r
+ @return None.\r
+\r
+**/\r
VOID\r
EFIAPI\r
ArpTimerHandler (\r
IN VOID *Context\r
);\r
\r
+/**\r
+ Cancel the arp request.\r
+\r
+ @param Instance Pointer to the instance context data.\r
+ @param TargetSwAddress Pointer to the buffer containing the target\r
+ software address to match the arp request.\r
+ @param UserEvent The user event used to notify this request\r
+ cancellation.\r
+\r
+ @return The count of the cancelled requests.\r
+\r
+**/\r
UINTN\r
ArpCancelRequest (\r
IN ARP_INSTANCE_DATA *Instance,\r
IN EFI_EVENT UserEvent OPTIONAL\r
);\r
\r
+/**\r
+ Find the cache entry in the cache table.\r
+\r
+ @param Instance Pointer to the instance context data.\r
+ @param BySwAddress Set to TRUE to look for matching software protocol\r
+ addresses. Set to FALSE to look for matching\r
+ hardware protocol addresses.\r
+ @param AddressBuffer Pointer to address buffer. Set to NULL to match\r
+ all addresses.\r
+ @param EntryLength The size of an entry in the entries buffer.\r
+ @param EntryCount The number of ARP cache entries that are found by\r
+ the specified criteria.\r
+ @param Entries Pointer to the buffer that will receive the ARP\r
+ cache entries.\r
+ @param Refresh Set to TRUE to refresh the timeout value of the\r
+ matching ARP cache entry.\r
+\r
+ @retval EFI_SUCCESS The requested ARP cache entries are copied into\r
+ the buffer.\r
+ @retval EFI_NOT_FOUND No matching entries found.\r
+ @retval EFI_OUT_OF_RESOURCE There is a memory allocation failure.\r
+\r
+**/\r
EFI_STATUS\r
ArpFindCacheEntry (\r
IN ARP_INSTANCE_DATA *Instance,\r
projects / mirror_edk2.git / blobdiff