code scrub ArpDxe
[mirror_edk2.git] / MdePkg / Include / Protocol / Arp.h
1 /** @file  \r
2   EFI ARP Protocol Definition\r
3   \r
4   The EFI ARP Service Binding Protocol is used to locate EFI\r
5   ARP Protocol drivers to create and destroy child of the\r
6   driver to communicate with other host using ARP protocol.\r
7   The EFI ARP Protocol provides services to map IP network\r
8   address to hardware address used by a data link protocol.\r
9   \r
10 Copyright (c) 2006 - 2008, Intel Corporation.<BR>                                                         \r
11 All rights reserved. This program and the accompanying materials                          \r
12 are licensed and made available under the terms and conditions of the BSD License         \r
13 which accompanies this distribution.  The full text of the license may be found at<BR>        \r
14 http://opensource.org/licenses/bsd-license.php                                            \r
15   \r
16 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
17 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
18   \r
19 **/\r
20 \r
21 #ifndef __EFI_ARP_PROTOCOL_H__\r
22 #define __EFI_ARP_PROTOCOL_H__\r
23 \r
24 #define EFI_ARP_SERVICE_BINDING_PROTOCOL_GUID \\r
25   { \\r
26     0xf44c00ee, 0x1f2c, 0x4a00, {0xaa, 0x9, 0x1c, 0x9f, 0x3e, 0x8, 0x0, 0xa3 } \\r
27   }\r
28 \r
29 #define EFI_ARP_PROTOCOL_GUID \\r
30   { \\r
31     0xf4b427bb, 0xba21, 0x4f16, {0xbc, 0x4e, 0x43, 0xe4, 0x16, 0xab, 0x61, 0x9c } \\r
32   }\r
33 \r
34 typedef struct _EFI_ARP_PROTOCOL EFI_ARP_PROTOCOL;\r
35 \r
36 typedef struct {\r
37   ///\r
38   /// Length in bytes of this entry.\r
39   ///\r
40   UINT32                      Size;\r
41 \r
42   ///\r
43   /// Set to TRUE if this entry is a "deny" entry.\r
44   /// Set to FALSE if this entry is a "normal" entry.\r
45   ///\r
46   BOOLEAN                     DenyFlag;\r
47 \r
48   ///\r
49   /// Set to TRUE if this entry will not time out.\r
50   /// Set to FALSE if this entry will time out.\r
51   ///\r
52   BOOLEAN                     StaticFlag;\r
53 \r
54   ///\r
55   /// 16-bit ARP hardware identifier number.\r
56   ///\r
57   UINT16                      HwAddressType;\r
58 \r
59   ///\r
60   /// 16-bit protocol type number.\r
61   ///\r
62   UINT16                      SwAddressType;\r
63 \r
64   ///\r
65   /// Length of the hardware address.\r
66   ///\r
67   UINT8                       HwAddressLength;\r
68 \r
69   ///\r
70   /// Length of the protocol address.\r
71   ///\r
72   UINT8                       SwAddressLength;\r
73 } EFI_ARP_FIND_DATA;\r
74 \r
75 typedef struct {\r
76   ///\r
77   /// 16-bit protocol type number in host byte order.\r
78   ///\r
79   UINT16                    SwAddressType;\r
80 \r
81   ///\r
82   /// Length in bytes of the station's protocol address to register.\r
83   ///\r
84   UINT8                     SwAddressLength;\r
85 \r
86   ///\r
87   /// Pointer to the first byte of the protocol address to register. For\r
88   /// example, if SwAddressType is 0x0800 (IP), then\r
89   /// StationAddress points to the first byte of this station's IP\r
90   /// address stored in network byte order.\r
91   ///\r
92   VOID                      *StationAddress;\r
93 \r
94   ///\r
95   /// The timeout value in 100-ns units that is associated with each\r
96   /// new dynamic ARP cache entry. If it is set to zero, the value is\r
97   /// implementation-specific.\r
98   ///\r
99   UINT32                    EntryTimeOut;\r
100 \r
101   ///\r
102   /// The number of retries before a MAC address is resolved. If it is\r
103   /// set to zero, the value is implementation-specific.\r
104   ///\r
105   UINT32                    RetryCount;\r
106 \r
107   ///\r
108   /// The timeout value in 100-ns units that is used to wait for the ARP\r
109   /// reply packet or the timeout value between two retries. Set to zero\r
110   /// to use implementation-specific value.\r
111   ///\r
112   UINT32                    RetryTimeOut;\r
113 } EFI_ARP_CONFIG_DATA;\r
114 \r
115 \r
116 /**\r
117   This function is used to assign a station address to the ARP cache for this instance\r
118   of the ARP driver.\r
119   \r
120   Each ARP instance has one station address. The EFI_ARP_PROTOCOL driver will \r
121   respond to ARP requests that match this registered station address. A call to \r
122   this function with the ConfigData field set to NULL will reset this ARP instance.\r
123   \r
124   Once a protocol type and station address have been assigned to this ARP instance, \r
125   all the following ARP functions will use this information. Attempting to change \r
126   the protocol type or station address to a configured ARP instance will result in errors.\r
127 \r
128   @param  This                   Pointer to the EFI_ARP_PROTOCOL instance.\r
129   @param  ConfigData             Pointer to the EFI_ARP_CONFIG_DATA structure.\r
130 \r
131   @retval EFI_SUCCESS            The new station address was successfully\r
132                                  registered.\r
133   @retval EFI_INVALID_PARAMETER  One or more of the following conditions is TRUE:\r
134                                  This is NULL. SwAddressLength is zero when\r
135                                  ConfigData is not NULL. StationAddress is NULL\r
136                                  when ConfigData is not NULL.\r
137   @retval EFI_ACCESS_DENIED      The SwAddressType, SwAddressLength, or\r
138                                  StationAddress is different from the one that is\r
139                                  already registered.\r
140   @retval EFI_OUT_OF_RESOURCES   Storage for the new StationAddress could not be\r
141                                  allocated.\r
142 \r
143 **/\r
144 typedef \r
145 EFI_STATUS\r
146 (EFIAPI *EFI_ARP_CONFIGURE)(\r
147   IN EFI_ARP_PROTOCOL       *This,\r
148   IN EFI_ARP_CONFIG_DATA    *ConfigData   OPTIONAL\r
149   );  \r
150 \r
151 /**\r
152   This function is used to insert entries into the ARP cache.\r
153 \r
154   ARP cache entries are typically inserted and updated by network protocol drivers \r
155   as network traffic is processed. Most ARP cache entries will time out and be \r
156   deleted if the network traffic stops. ARP cache entries that were inserted \r
157   by the Add() function may be static (will not time out) or dynamic (will time out).\r
158   Default ARP cache timeout values are not covered in most network protocol \r
159   specifications (although RFC 1122 comes pretty close) and will only be \r
160   discussed in general in this specification. The timeout values that are \r
161   used in the EFI Sample Implementation should be used only as a guideline. \r
162   Final product implementations of the EFI network stack should be tuned for \r
163   their expected network environments.\r
164   \r
165   @param  This                   Pointer to the EFI_ARP_PROTOCOL instance.\r
166   @param  DenyFlag               Set to TRUE if this entry is a deny entry. Set to\r
167                                  FALSE if this  entry is a normal entry.\r
168   @param  TargetSwAddress        Pointer to a protocol address to add (or deny).\r
169                                  May be set to NULL if DenyFlag is TRUE.\r
170   @param  TargetHwAddress        Pointer to a hardware address to add (or deny).\r
171                                  May be set to NULL if DenyFlag is TRUE.\r
172   @param  TimeoutValue           Time in 100-ns units that this entry will remain\r
173                                  in the ARP cache. A value of zero means that the\r
174                                  entry is permanent. A nonzero value will override\r
175                                  the one given by Configure() if the entry to be\r
176                                  added is a dynamic entry.\r
177   @param  Overwrite              If TRUE, the matching cache entry will be\r
178                                  overwritten with the supplied parameters. If\r
179                                  FALSE, EFI_ACCESS_DENIED is returned if the\r
180                                  corresponding cache entry already exists.\r
181 \r
182   @retval EFI_SUCCESS            The entry has been added or updated.\r
183   @retval EFI_INVALID_PARAMETER  One or more of the following conditions is TRUE:\r
184                                  This is NULL. DenyFlag is FALSE and\r
185                                  TargetHwAddress is NULL. DenyFlag is FALSE and\r
186                                  TargetSwAddress is NULL. TargetHwAddress is NULL\r
187                                  and TargetSwAddress is NULL. Both TargetSwAddress\r
188                                  and TargetHwAddress are not NULL when DenyFlag is\r
189                                  TRUE.\r
190   @retval EFI_OUT_OF_RESOURCES   The new ARP cache entry could not be allocated.\r
191   @retval EFI_ACCESS_DENIED      The ARP cache entry already exists and Overwrite\r
192                                  is not true.\r
193   @retval EFI_NOT_STARTED        The ARP driver instance has not been configured.\r
194 \r
195 **/\r
196 typedef\r
197 EFI_STATUS\r
198 (EFIAPI *EFI_ARP_ADD)(\r
199   IN EFI_ARP_PROTOCOL       *This,\r
200   IN BOOLEAN                DenyFlag,\r
201   IN VOID                   *TargetSwAddress  OPTIONAL,\r
202   IN VOID                   *TargetHwAddress  OPTIONAL,\r
203   IN UINT32                 TimeoutValue,\r
204   IN BOOLEAN                Overwrite\r
205   );  \r
206 \r
207 /**\r
208   This function searches the ARP cache for matching entries and allocates a buffer into\r
209   which those entries are copied.\r
210   \r
211   The first part of the allocated buffer is EFI_ARP_FIND_DATA, following which \r
212   are protocol address pairs and hardware address pairs.\r
213   When finding a specific protocol address (BySwAddress is TRUE and AddressBuffer \r
214   is not NULL), the ARP cache timeout for the found entry is reset if Refresh is \r
215   set to TRUE. If the found ARP cache entry is a permanent entry, it is not \r
216   affected by Refresh.\r
217   \r
218   @param  This                   Pointer to the EFI_ARP_PROTOCOL instance.\r
219   @param  BySwAddress            Set to TRUE to look for matching software protocol\r
220                                  addresses. Set to FALSE to look for matching\r
221                                  hardware protocol addresses.\r
222   @param  AddressBuffer          Pointer to address buffer. Set to NULL to match\r
223                                  all addresses.\r
224   @param  EntryLength            The size of an entry in the entries buffer.\r
225   @param  EntryCount             The number of ARP cache entries that are found by\r
226                                  the specified criteria.\r
227   @param  Entries                Pointer to the buffer that will receive the ARP\r
228                                  cache entries.\r
229   @param  Refresh                Set to TRUE to refresh the timeout value of the\r
230                                  matching ARP cache entry.\r
231 \r
232   @retval EFI_SUCCESS            The requested ARP cache entries were copied into\r
233                                  the buffer.\r
234   @retval EFI_INVALID_PARAMETER  One or more of the following conditions is TRUE:\r
235                                  This is NULL. Both EntryCount and EntryLength are\r
236                                  NULL, when Refresh is FALSE.\r
237   @retval EFI_NOT_FOUND          No matching entries were found.\r
238   @retval EFI_NOT_STARTED        The ARP driver instance has not been configured.\r
239 \r
240 **/\r
241 typedef \r
242 EFI_STATUS\r
243 (EFIAPI *EFI_ARP_FIND)(\r
244   IN EFI_ARP_PROTOCOL       *This,\r
245   IN BOOLEAN                BySwAddress,\r
246   IN VOID                   *AddressBuffer    OPTIONAL,\r
247   OUT UINT32                *EntryLength      OPTIONAL,\r
248   OUT UINT32                *EntryCount       OPTIONAL,\r
249   OUT EFI_ARP_FIND_DATA     **Entries         OPTIONAL,\r
250   IN BOOLEAN                Refresh\r
251   );  \r
252 \r
253 \r
254 /**\r
255   This function removes specified ARP cache entries.\r
256 \r
257   @param  This                   Pointer to the EFI_ARP_PROTOCOL instance.\r
258   @param  BySwAddress            Set to TRUE to delete matching protocol addresses.\r
259                                  Set to FALSE to delete matching hardware\r
260                                  addresses.\r
261   @param  AddressBuffer          Pointer to the address buffer that is used as a\r
262                                  key to look for the cache entry. Set to NULL to\r
263                                  delete all entries.\r
264 \r
265   @retval EFI_SUCCESS            The entry was removed from the ARP cache.\r
266   @retval EFI_INVALID_PARAMETER  This is NULL.\r
267   @retval EFI_NOT_FOUND          The specified deletion key was not found.\r
268   @retval EFI_NOT_STARTED        The ARP driver instance has not been configured.\r
269 \r
270 **/\r
271 typedef\r
272 EFI_STATUS\r
273 (EFIAPI *EFI_ARP_DELETE)(\r
274   IN EFI_ARP_PROTOCOL       *This,\r
275   IN BOOLEAN                BySwAddress,\r
276   IN VOID                   *AddressBuffer   OPTIONAL\r
277   );  \r
278 \r
279 /**\r
280   This function delete all dynamic entries from the ARP cache that match the specified\r
281   software protocol type.\r
282 \r
283   @param  This                   Pointer to the EFI_ARP_PROTOCOL instance.\r
284 \r
285   @retval EFI_SUCCESS            The cache has been flushed.\r
286   @retval EFI_INVALID_PARAMETER  This is NULL.\r
287   @retval EFI_NOT_FOUND          There are no matching dynamic cache entries.\r
288   @retval EFI_NOT_STARTED        The ARP driver instance has not been configured.\r
289 \r
290 **/\r
291 typedef\r
292 EFI_STATUS\r
293 (EFIAPI *EFI_ARP_FLUSH)(\r
294   IN EFI_ARP_PROTOCOL       *This\r
295   );  \r
296 \r
297 /**\r
298   This function tries to resolve the TargetSwAddress and optionally returns a\r
299   TargetHwAddress if it already exists in the ARP cache.\r
300 \r
301   @param  This                   Pointer to the EFI_ARP_PROTOCOL instance.\r
302   @param  TargetSwAddress        Pointer to the protocol address to resolve.\r
303   @param  ResolvedEvent          Pointer to the event that will be signaled when\r
304                                  the address is resolved or some error occurs.\r
305   @param  TargetHwAddress        Pointer to the buffer for the resolved hardware\r
306                                  address in network byte order.\r
307 \r
308   @retval EFI_SUCCESS            The data is copied from the ARP cache into the\r
309                                  TargetHwAddress buffer.\r
310   @retval EFI_INVALID_PARAMETER  One or more of the following conditions is TRUE:\r
311                                  This is NULL. TargetHwAddress is NULL.\r
312   @retval EFI_ACCESS_DENIED      The requested address is not present in the normal\r
313                                  ARP cache but is present in the deny address list.\r
314                                  Outgoing traffic to that address is forbidden.\r
315   @retval EFI_NOT_STARTED        The ARP driver instance has not been configured.\r
316   @retval EFI_NOT_READY          The request has been started and is not finished.\r
317 \r
318 **/\r
319 typedef\r
320 EFI_STATUS\r
321 (EFIAPI *EFI_ARP_REQUEST)(\r
322   IN EFI_ARP_PROTOCOL       *This, \r
323   IN VOID                   *TargetSwAddress  OPTIONAL,\r
324   IN EFI_EVENT              ResolvedEvent     OPTIONAL,\r
325   OUT VOID                  *TargetHwAddress  \r
326   );  \r
327 \r
328 /**\r
329   This function aborts the previous ARP request (identified by This,  TargetSwAddress\r
330   and ResolvedEvent) that is issued by EFI_ARP_PROTOCOL.Request().\r
331   \r
332   If the request is in the internal ARP request queue, the request is aborted \r
333   immediately and its ResolvedEvent is signaled. Only an asynchronous address \r
334   request needs to be canceled. If TargeSwAddress and ResolveEvent are both \r
335   NULL, all the pending asynchronous requests that have been issued by This \r
336   instance will be cancelled and their corresponding events will be signaled.\r
337   \r
338   @param  This                   Pointer to the EFI_ARP_PROTOCOL instance.\r
339   @param  TargetSwAddress        Pointer to the protocol address in previous\r
340                                  request session.\r
341   @param  ResolvedEvent          Pointer to the event that is used as the\r
342                                  notification event in previous request session.\r
343 \r
344   @retval EFI_SUCCESS            The pending request session(s) is/are aborted and\r
345                                  corresponding event(s) is/are signaled.\r
346   @retval EFI_INVALID_PARAMETER  One or more of the following conditions is TRUE:\r
347                                  This is NULL. TargetSwAddress is not NULL and\r
348                                  ResolvedEvent is NULL. TargetSwAddress is NULL and\r
349                                  ResolvedEvent is not NULL.\r
350   @retval EFI_NOT_STARTED        The ARP driver instance has not been configured.\r
351   @retval EFI_NOT_FOUND          The request is not issued by\r
352                                  EFI_ARP_PROTOCOL.Request().\r
353 \r
354 \r
355 **/\r
356 typedef\r
357 EFI_STATUS\r
358 (EFIAPI *EFI_ARP_CANCEL)(\r
359   IN EFI_ARP_PROTOCOL       *This, \r
360   IN VOID                   *TargetSwAddress  OPTIONAL,\r
361   IN EFI_EVENT              ResolvedEvent     OPTIONAL\r
362   );  \r
363 \r
364 ///\r
365 /// ARP is used to resolve local network protocol addresses into \r
366 /// network hardware addresses.\r
367 ///\r
368 struct _EFI_ARP_PROTOCOL {\r
369   EFI_ARP_CONFIGURE         Configure;\r
370   EFI_ARP_ADD               Add;\r
371   EFI_ARP_FIND              Find;\r
372   EFI_ARP_DELETE            Delete;\r
373   EFI_ARP_FLUSH             Flush;\r
374   EFI_ARP_REQUEST           Request;\r
375   EFI_ARP_CANCEL            Cancel;\r
376 };\r
377 \r
378 \r
379 extern EFI_GUID gEfiArpServiceBindingProtocolGuid;\r
380 extern EFI_GUID gEfiArpProtocolGuid;\r
381 \r
382 #endif\r