MdePkg/Include/Protocol/Arp.h

   1 /** @file
   2
   3   EFI ARP Protocol Definition
   4
   5   The EFI ARP Service Binding Protocol is used to locate EFI
   6   ARP Protocol drivers to create and destroy child of the
   7   driver to communicate with other host using ARP protocol.
   8
   9   The EFI ARP Protocol provides services to map IP network
  10   address to hardware address used by a data link protocol.
  11
  12
  13   Copyright (c) 2006 - 2008, Intel Corporation
  14   All rights reserved. This program and the accompanying materials
  15   are licensed and made available under the terms and conditions of the BSD License
  16   which accompanies this distribution.  The full text of the license may be found at
  17   http://opensource.org/licenses/bsd-license.php
  18
  19   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  20   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  21
  22 **/
  23
  24 #ifndef __EFI_ARP_PROTOCOL_H__
  25 #define __EFI_ARP_PROTOCOL_H__
  26
  27 #define EFI_ARP_SERVICE_BINDING_PROTOCOL_GUID \
  28   { \
  29     0xf44c00ee, 0x1f2c, 0x4a00, {0xaa, 0x9, 0x1c, 0x9f, 0x3e, 0x8, 0x0, 0xa3 } \
  30   }
  31
  32 #define EFI_ARP_PROTOCOL_GUID \
  33   { \
  34     0xf4b427bb, 0xba21, 0x4f16, {0xbc, 0x4e, 0x43, 0xe4, 0x16, 0xab, 0x61, 0x9c } \
  35   }
  36
  37 typedef struct _EFI_ARP_PROTOCOL EFI_ARP_PROTOCOL;
  38
  39 typedef struct {
  40 UINT32                      Size;
  41 BOOLEAN                     DenyFlag;
  42 BOOLEAN                     StaticFlag;
  43 UINT16                      HwAddressType;
  44 UINT16                      SwAddressType;
  45 UINT8                       HwAddressLength;
  46 UINT8                       SwAddressLength;
  47 } EFI_ARP_FIND_DATA;
  48
  49 typedef struct {
  50   UINT16                    SwAddressType;      // Host byte order
  51   UINT8                     SwAddressLength;
  52   VOID                      *StationAddress;    // Network byte order
  53   UINT32                    EntryTimeOut;
  54   UINT32                    RetryCount;
  55   UINT32                    RetryTimeOut;
  56 } EFI_ARP_CONFIG_DATA;
  57
  58
  59 /**
  60   Assigns a station address (protocol type and network address) to this instance of the ARP cache.
  61
  62   @param  This                  A pointer to the EFI_ARP_PROTOCOL instance.
  63   @param  ConfigData            A pointer to the EFI_ARP_CONFIG_DATA structure.Buffer
  64
  65   @retval EFI_SUCCESS           The new station address was successfully registered.
  66   @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
  67   @retval EFI_ACCESS_DENIED     The SwAddressType, SwAddressLength, or
  68                                 StationAddress is different from the one that is already
  69                                 registered.
  70   @retval EFI_OUT_OF_RESOURCES  Storage for the new StationAddress could not be allocated.
  71
  72 **/
  73 typedef
  74 EFI_STATUS
  75 (EFIAPI *EFI_ARP_CONFIGURE)(
  76   IN EFI_ARP_PROTOCOL       *This,
  77   IN EFI_ARP_CONFIG_DATA    *ConfigData   OPTIONAL
  78   )
  79 ;
  80
  81 /**
  82   Inserts an entry to the ARP cache.
  83
  84   @param  This            A pointer to the EFI_ARP_PROTOCOL instance.
  85   @param  DenyFlag        Set to TRUE if this entry is a "deny" entry. Set to FALSE if this
  86                           entry is a "normal" entry.
  87   @param  TargetSwAddress Pointer to a protocol address to add (or deny). May be set to
  88                           NULL if DenyFlag is TRUE.
  89   @param  TargetHwAddress Pointer to a hardware address to add (or deny). May be set to
  90                           NULL if DenyFlag is TRUE.
  91   @param  TimeoutValue    Time in 100-ns units that this entry will remain in the ARP
  92                           cache. A value of zero means that the entry is permanent. A
  93                           nonzero value will override the one given by Configure() if
  94                           the entry to be added is dynamic entry.
  95   @param  Overwrite       If TRUE, the matching cache entry will be overwritten with the
  96                           supplied parameters. If FALSE, EFI_ACCESS_DENIED is returned
  97                           if the corresponding cache entry already exists.
  98
  99   @retval EFI_SUCCESS           The entry has been added or updated.
 100   @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
 101                                 This is NULL. DenyFlag is FALSE and TargetHwAddress is NULL.
 102                                 DenyFlag is FALSE and TargetSwAddress is NULL. TargetHwAddress is NULL and TargetSwAddress is NULL.
 103                                 Both TargetSwAddress and TargetHwAddress are not NULL when DenyFlag is TRUE.
 104   @retval EFI_OUT_OF_RESOURCES  The new ARP cache entry could not be allocated.
 105   @retval EFI_ACCESS_DENIED     The ARP cache entry already exists and Overwrite is not true.
 106   @retval EFI_NOT_STARTED       The ARP driver instance has not been configured.
 107
 108 **/
 109 typedef
 110 EFI_STATUS
 111 (EFIAPI *EFI_ARP_ADD)(
 112   IN EFI_ARP_PROTOCOL       *This,
 113   IN BOOLEAN                DenyFlag,
 114   IN VOID                   *TargetSwAddress  OPTIONAL,
 115   IN VOID                   *TargetHwAddress  OPTIONAL,
 116   IN UINT32                 TimeoutValue,
 117   IN BOOLEAN                Overwrite
 118   )
 119 ;
 120
 121 /**
 122   Locates one or more entries in the ARP cache.
 123
 124   @param  This            A pointer to the EFI_ARP_PROTOCOL instance.
 125   @param  BySwAddress     Set to TRUE to look for matching software protocol addresses.
 126                           Set to FALSE to look for matching hardware protocol addresses.
 127   @param  AddressBuffer   Pointer to address buffer. Set to NULL to match all addresses.
 128   @param  EntryLength     The size of an entry in the entries buffer. To keep the
 129                           EFI_ARP_FIND_DATA structure properly aligned, this field
 130                           may be longer than sizeof(EFI_ARP_FIND_DATA) plus
 131                           the length of the software and hardware addresses.
 132   @param  EntryCount      The number of ARP cache entries that are found by the specified criteria.
 133   @param  Entries         Pointer to the buffer that will receive the ARP cache entries.
 134   @param  Refresh         Set to TRUE to refresh the timeout value of the matching ARP
 135                           cache entry.
 136
 137   @retval EFI_SUCCESS           The requested ARP cache entries were copied into the buffer.
 138   @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
 139                                 This is NULL. Both EntryCount and EntryLength are NULL,
 140                                 when Refresh is FALSE.
 141   @retval EFI_NOT_FOUND         No matching entries were found.
 142   @retval EFI_NOT_STARTED       The ARP driver instance has not been configured.
 143
 144 **/
 145 typedef
 146 EFI_STATUS
 147 (EFIAPI *EFI_ARP_FIND)(
 148   IN EFI_ARP_PROTOCOL       *This,
 149   IN BOOLEAN                BySwAddress,
 150   IN VOID                   *AddressBuffer    OPTIONAL,
 151   OUT UINT32                *EntryLength      OPTIONAL,
 152   OUT UINT32                *EntryCount       OPTIONAL,
 153   OUT EFI_ARP_FIND_DATA     **Entries         OPTIONAL,
 154   IN BOOLEAN                Refresh
 155   )
 156 ;
 157
 158
 159 /**
 160   Removes entries from the ARP cache.
 161
 162   @param  This          A pointer to the EFI_ARP_PROTOCOL instance.
 163   @param  BySwAddress   Set to TRUE to delete matching protocol addresses.
 164                         Set to FALSE to delete matching hardware addresses.
 165   @param  AddressBuffer Pointer to the address buffer that is used as a key to look for the
 166                         cache entry. Set to NULL to delete all entries.
 167
 168   @retval EFI_SUCCESS           The entry was removed from the ARP cache.
 169   @retval EFI_INVALID_PARAMETER This is NULL.
 170   @retval EFI_NOT_FOUND         The specified deletion key was not found.
 171   @retval EFI_NOT_STARTED       The ARP driver instance has not been configured.
 172
 173 **/
 174 typedef
 175 EFI_STATUS
 176 (EFIAPI *EFI_ARP_DELETE)(
 177   IN EFI_ARP_PROTOCOL       *This,
 178   IN BOOLEAN                BySwAddress,
 179   IN VOID                   *AddressBuffer   OPTIONAL
 180   )
 181 ;
 182
 183 /**
 184   Removes all dynamic ARP cache entries that were added by this interface.
 185
 186   @param  This                  A pointer to the EFI_ARP_PROTOCOL instance.
 187
 188   @retval EFI_SUCCESS           The cache has been flushed.
 189   @retval EFI_INVALID_PARAMETER This is NULL.
 190   @retval EFI_NOT_FOUND         There are no matching dynamic cache entries.
 191   @retval EFI_NOT_STARTED       The ARP driver instance has not been configured.
 192
 193 **/
 194 typedef
 195 EFI_STATUS
 196 (EFIAPI *EFI_ARP_FLUSH)(
 197   IN EFI_ARP_PROTOCOL       *This
 198   )
 199 ;
 200
 201 /**
 202   Starts an ARP request session.
 203
 204   @param  This            A pointer to the EFI_ARP_PROTOCOL instance.
 205   @param  TargetSwAddress Pointer to the protocol address to resolve.
 206   @param  ResolvedEvent   Pointer to the event that will be signaled when the address is
 207                           resolved or some error occurs.
 208   @param  TargetHwAddress Pointer to the buffer for the resolved hardware address in
 209                           network byte order. The buffer must be large enough to hold the
 210                           resulting hardware address. TargetHwAddress must not be
 211                           NULL.
 212
 213   @retval EFI_SUCCESS           The data was copied from the ARP cache into the
 214                                 TargetHwAddress buffer.
 215   @retval EFI_INVALID_PARAMETER This or TargetHwAddress is NULL.
 216   @retval EFI_ACCESS_DENIED     The requested address is not present in the normal ARP cache but
 217                                 is present in the deny address list. Outgoing traffic to that address is
 218                                 forbidden.
 219   @retval EFI_NOT_STARTED       The ARP driver instance has not been configured.
 220   @retval EFI_NOT_READY         The request has been started and is not finished.
 221   @retval EFI_UNSUPPORTED       The requested conversion is not supported in this implementation or
 222                                 configuration.
 223
 224 **/
 225 typedef
 226 EFI_STATUS
 227 (EFIAPI *EFI_ARP_REQUEST)(
 228   IN EFI_ARP_PROTOCOL       *This,
 229   IN VOID                   *TargetSwAddress  OPTIONAL,
 230   IN EFI_EVENT              ResolvedEvent     OPTIONAL,
 231   OUT VOID                  *TargetHwAddress
 232   )
 233 ;
 234
 235 /**
 236   Cancels an ARP request session.
 237
 238   @param  This            A pointer to the EFI_ARP_PROTOCOL instance.
 239   @param  TargetSwAddress Pointer to the protocol address in previous request session.
 240   @param  ResolvedEvent   Pointer to the event that is used as the notification event in
 241                           previous request session.
 242
 243   @retval EFI_SUCCESS           The pending request session(s) is/are aborted and corresponding
 244                                 event(s) is/are signaled.
 245   @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
 246   @retval EFI_NOT_STARTED       The ARP driver instance has not been configured.
 247   @retval EFI_NOT_FOUND         The request is not issued by
 248                                 EFI_ARP_PROTOCOL.Request().
 249
 250 **/
 251 typedef
 252 EFI_STATUS
 253 (EFIAPI *EFI_ARP_CANCEL)(
 254   IN EFI_ARP_PROTOCOL       *This,
 255   IN VOID                   *TargetSwAddress  OPTIONAL,
 256   IN EFI_EVENT              ResolvedEvent     OPTIONAL
 257   )
 258 ;
 259
 260 /**
 261   @par Protocol Description:
 262   ARP is used to resolve local network protocol addresses into
 263   network hardware addresses.
 264
 265   @param Configure
 266   Adds a new station address (protocol type and network address) to the ARP cache.
 267
 268   @param Add
 269   Manually inserts an entry to the ARP cache for administrative purpose.
 270
 271   @param Find
 272   Locates one or more entries in the ARP cache.
 273
 274   @param Delete
 275   Removes an entry from the ARP cache.
 276
 277   @param Flush
 278   Removes all dynamic ARP cache entries of a specified protocol type.
 279
 280   @param Request
 281   Starts an ARP request session.
 282
 283   @param Cancel
 284   Abort previous ARP request session.
 285
 286 **/
 287 struct _EFI_ARP_PROTOCOL {
 288   EFI_ARP_CONFIGURE         Configure;
 289   EFI_ARP_ADD               Add;
 290   EFI_ARP_FIND              Find;
 291   EFI_ARP_DELETE            Delete;
 292   EFI_ARP_FLUSH             Flush;
 293   EFI_ARP_REQUEST           Request;
 294   EFI_ARP_CANCEL            Cancel;
 295 };
 296
 297
 298 extern EFI_GUID gEfiArpServiceBindingProtocolGuid;
 299 extern EFI_GUID gEfiArpProtocolGuid;
 300
 301 #endif