Code Scrub for Protocol and Ppi Definition

[mirror_edk2.git] / MdePkg / Include / Protocol / Arp.h

diff --git a/MdePkg/Include/Protocol/Arp.h b/MdePkg/Include/Protocol/Arp.h
index 33e86dc8cedb59fee019aceb313fbd36ef543e0c..9527ad51af24fc710109b7a8af750cc14d157fbf 100644 (file)
--- a/MdePkg/Include/Protocol/Arp.h
+++ b/MdePkg/Include/Protocol/Arp.h
@@ -10,7 +10,7 @@
   address to hardware address used by a data link protocol.\r
   \r
   \r
-  Copyright (c) 2006, 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
@@ -59,8 +59,8 @@ typedef struct {
 /**\r
   Assigns a station address (protocol type and network address) to this instance of the ARP cache.\r
 \r
-  @param  This                   A pointer to the EFI_ARP_PROTOCOL instance.\r
-  @param  ConfigData             A pointer to the EFI_ARP_CONFIG_DATA structure.Buffer\r
+  @param  This                  A pointer to the EFI_ARP_PROTOCOL instance.\r
+  @param  ConfigData            A pointer to the EFI_ARP_CONFIG_DATA structure.Buffer\r
 \r
   @retval EFI_SUCCESS           The new station address was successfully registered.\r
   @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
@@ -93,10 +93,14 @@ EFI_STATUS
                           nonzero value will override the one given by Configure() if\r
                           the entry to be added is dynamic entry.\r
   @param  Overwrite       If TRUE, the matching cache entry will be overwritten with the\r
-                          supplied parameters. If FALSE, EFI_ACCESS_DENIED\r
+                          supplied parameters. If FALSE, EFI_ACCESS_DENIED is returned \r
+                          if the 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 TargetHwAddress is NULL.\r
+                                DenyFlag is FALSE and TargetSwAddress is NULL. TargetHwAddress is NULL and TargetSwAddress is NULL. \r
+                                Both TargetSwAddress and TargetHwAddress are not NULL when DenyFlag is 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 is not true.\r
   @retval EFI_NOT_STARTED       The ARP driver instance has not been configured.\r
@@ -132,6 +136,8 @@ EFI_STATUS
 \r
   @retval EFI_SUCCESS           The requested ARP cache entries were copied into 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 NULL, \r
+                                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
@@ -177,7 +183,7 @@ EFI_STATUS
 /**\r
   Removes all dynamic ARP cache entries that were added by this interface.\r
 \r
-  @param  This                   A pointer to the EFI_ARP_PROTOCOL instance.\r
+  @param  This                  A 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
@@ -251,6 +257,33 @@ EFI_STATUS
   )\r
 ;  \r
 \r
+/**\r
+  @par Protocol Description:\r
+  ARP is used to resolve local network protocol addresses into \r
+  network hardware addresses.\r
+\r
+  @param Configure\r
+  Adds a new station address (protocol type and network address) to the ARP cache.\r
+  \r
+  @param Add\r
+  Manually inserts an entry to the ARP cache for administrative purpose.\r
+\r
+  @param Find\r
+  Locates one or more entries in the ARP cache.\r
+\r
+  @param Delete\r
+  Removes an entry from the ARP cache.\r
+  \r
+  @param Flush\r
+  Removes all dynamic ARP cache entries of a specified protocol type.\r
+  \r
+  @param Request\r
+  Starts an ARP request session.\r
+  \r
+  @param Cancel\r
+  Abort previous ARP request session.\r
+\r
+**/\r
 struct _EFI_ARP_PROTOCOL {\r
   EFI_ARP_CONFIGURE         Configure;\r
   EFI_ARP_ADD               Add;\r