]>
Commit | Line | Data |
---|---|---|
d1f95000 | 1 | /** @file\r |
c311f86b | 2 | \r |
3 | This file defines the EFI IPv4 (Internet Protocol version 4)\r | |
4 | Protocol interface. It is split into the following three main\r | |
5 | sections:\r | |
6 | - EFI IPv4 Service Binding Protocol\r | |
7 | - EFI IPv4 Variable\r | |
8 | - EFI IPv4 Protocol The EFI IPv4 Protocol provides basic\r | |
9 | network IPv4 packet I/O services, which includes support for\r | |
10 | a subset of the Internet Control Message Protocol (ICMP) and\r | |
11 | may include support for the Internet Group Management\r | |
12 | Protocol (IGMP).\r | |
13 | \r | |
4ca9b6c4 | 14 | Copyright (c) 2006 - 2008, Intel Corporation \r |
d1f95000 | 15 | All rights reserved. This program and the accompanying materials \r |
16 | are licensed and made available under the terms and conditions of the BSD License \r | |
17 | which accompanies this distribution. The full text of the license may be found at \r | |
18 | http://opensource.org/licenses/bsd-license.php \r | |
19 | \r | |
20 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
21 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
22 | \r | |
d1f95000 | 23 | **/\r |
24 | \r | |
25 | #ifndef __EFI_IP4_PROTOCOL_H__\r | |
26 | #define __EFI_IP4_PROTOCOL_H__\r | |
27 | \r | |
28 | #include <Protocol/ManagedNetwork.h>\r | |
29 | \r | |
30 | #define EFI_IP4_SERVICE_BINDING_PROTOCOL_GUID \\r | |
31 | { \\r | |
32 | 0xc51711e7, 0xb4bf, 0x404a, {0xbf, 0xb8, 0x0a, 0x04, 0x8e, 0xf1, 0xff, 0xe4 } \\r | |
33 | }\r | |
34 | \r | |
35 | #define EFI_IP4_PROTOCOL_GUID \\r | |
36 | { \\r | |
37 | 0x41d94cd2, 0x35b6, 0x455a, {0x82, 0x58, 0xd4, 0xe5, 0x13, 0x34, 0xaa, 0xdd } \\r | |
38 | }\r | |
39 | \r | |
40 | typedef struct _EFI_IP4_PROTOCOL EFI_IP4_PROTOCOL;\r | |
41 | \r | |
42 | typedef struct {\r | |
43 | EFI_HANDLE InstanceHandle;\r | |
44 | EFI_IPv4_ADDRESS Ip4Address;\r | |
45 | EFI_IPv4_ADDRESS SubnetMask;\r | |
46 | } EFI_IP4_ADDRESS_PAIR; \r | |
47 | \r | |
48 | typedef struct {\r | |
49 | EFI_HANDLE DriverHandle;\r | |
50 | UINT32 AddressCount;\r | |
51 | EFI_IP4_ADDRESS_PAIR AddressPairs[1];\r | |
52 | } EFI_IP4_VARIABLE_DATA;\r | |
53 | \r | |
54 | typedef struct {\r | |
55 | UINT8 DefaultProtocol;\r | |
56 | BOOLEAN AcceptAnyProtocol;\r | |
57 | BOOLEAN AcceptIcmpErrors;\r | |
58 | BOOLEAN AcceptBroadcast;\r | |
59 | BOOLEAN AcceptPromiscuous;\r | |
60 | BOOLEAN UseDefaultAddress;\r | |
61 | EFI_IPv4_ADDRESS StationAddress;\r | |
62 | EFI_IPv4_ADDRESS SubnetMask;\r | |
63 | UINT8 TypeOfService;\r | |
64 | UINT8 TimeToLive;\r | |
65 | BOOLEAN DoNotFragment;\r | |
66 | BOOLEAN RawData;\r | |
67 | UINT32 ReceiveTimeout;\r | |
68 | UINT32 TransmitTimeout;\r | |
69 | } EFI_IP4_CONFIG_DATA;\r | |
70 | \r | |
71 | \r | |
72 | typedef struct {\r | |
73 | EFI_IPv4_ADDRESS SubnetAddress;\r | |
74 | EFI_IPv4_ADDRESS SubnetMask;\r | |
75 | EFI_IPv4_ADDRESS GatewayAddress;\r | |
76 | } EFI_IP4_ROUTE_TABLE;\r | |
77 | \r | |
78 | typedef struct {\r | |
79 | UINT8 Type;\r | |
80 | UINT8 Code;\r | |
81 | } EFI_IP4_ICMP_TYPE;\r | |
82 | \r | |
83 | typedef struct {\r | |
84 | BOOLEAN IsStarted;\r | |
85 | EFI_IP4_CONFIG_DATA ConfigData;\r | |
86 | BOOLEAN IsConfigured;\r | |
87 | UINT32 GroupCount;\r | |
88 | EFI_IPv4_ADDRESS *GroupTable;\r | |
89 | UINT32 RouteCount;\r | |
90 | EFI_IP4_ROUTE_TABLE *RouteTable;\r | |
91 | UINT32 IcmpTypeCount;\r | |
92 | EFI_IP4_ICMP_TYPE *IcmpTypeList;\r | |
93 | } EFI_IP4_MODE_DATA;\r | |
94 | \r | |
95 | #pragma pack(1)\r | |
96 | \r | |
97 | typedef struct {\r | |
d1f95000 | 98 | UINT8 HeaderLength:4;\r |
99 | UINT8 Version:4;\r | |
d1f95000 | 100 | UINT8 TypeOfService;\r |
101 | UINT16 TotalLength;\r | |
102 | UINT16 Identification;\r | |
103 | UINT16 Fragmentation;\r | |
104 | UINT8 TimeToLive;\r | |
105 | UINT8 Protocol;\r | |
106 | UINT16 Checksum;\r | |
107 | EFI_IPv4_ADDRESS SourceAddress;\r | |
108 | EFI_IPv4_ADDRESS DestinationAddress;\r | |
109 | } EFI_IP4_HEADER;\r | |
110 | #pragma pack()\r | |
111 | \r | |
112 | \r | |
113 | typedef struct {\r | |
114 | UINT32 FragmentLength;\r | |
115 | VOID *FragmentBuffer;\r | |
116 | } EFI_IP4_FRAGMENT_DATA;\r | |
117 | \r | |
118 | \r | |
119 | typedef struct {\r | |
120 | EFI_TIME TimeStamp;\r | |
121 | EFI_EVENT RecycleSignal;\r | |
122 | UINT32 HeaderLength;\r | |
123 | EFI_IP4_HEADER *Header;\r | |
124 | UINT32 OptionsLength;\r | |
125 | VOID *Options;\r | |
126 | UINT32 DataLength;\r | |
127 | UINT32 FragmentCount;\r | |
128 | EFI_IP4_FRAGMENT_DATA FragmentTable[1];\r | |
129 | } EFI_IP4_RECEIVE_DATA;\r | |
130 | \r | |
131 | \r | |
132 | typedef struct {\r | |
133 | EFI_IPv4_ADDRESS SourceAddress;\r | |
134 | EFI_IPv4_ADDRESS GatewayAddress;\r | |
135 | UINT8 Protocol;\r | |
136 | UINT8 TypeOfService;\r | |
137 | UINT8 TimeToLive;\r | |
138 | BOOLEAN DoNotFragment;\r | |
139 | } EFI_IP4_OVERRIDE_DATA;\r | |
140 | \r | |
141 | typedef struct {\r | |
142 | EFI_IPv4_ADDRESS DestinationAddress;\r | |
143 | EFI_IP4_OVERRIDE_DATA *OverrideData; //OPTIONAL\r | |
144 | UINT32 OptionsLength; //OPTIONAL\r | |
145 | VOID *OptionsBuffer; //OPTIONAL\r | |
146 | UINT32 TotalDataLength;\r | |
147 | UINT32 FragmentCount;\r | |
148 | EFI_IP4_FRAGMENT_DATA FragmentTable[1];\r | |
149 | } EFI_IP4_TRANSMIT_DATA;\r | |
150 | \r | |
151 | typedef struct {\r | |
152 | EFI_EVENT Event;\r | |
153 | EFI_STATUS Status;\r | |
154 | union {\r | |
155 | EFI_IP4_RECEIVE_DATA *RxData;\r | |
156 | EFI_IP4_TRANSMIT_DATA *TxData;\r | |
157 | } Packet;\r | |
158 | } EFI_IP4_COMPLETION_TOKEN;\r | |
159 | \r | |
160 | /**\r | |
161 | Gets the current operational settings for this instance of the EFI IPv4 Protocol driver.\r | |
83497f5d | 162 | \r |
163 | The GetModeData() function returns the current operational mode data for this\r | |
164 | driver instance. The data fields in EFI_IP4_MODE_DATA are read only. This\r | |
165 | function is used optionally to retrieve the operational mode data of underlying\r | |
166 | networks or drivers.\r | |
d1f95000 | 167 | \r |
168 | @param This Pointer to the EFI_IP4_PROTOCOL instance.\r | |
169 | @param Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure.\r | |
170 | @param MnpConfigData Pointer to the managed network configuration data structure.\r | |
4ca9b6c4 | 171 | @param SnpModeData Pointer to the simple network mode data structure.\r |
d1f95000 | 172 | \r |
173 | @retval EFI_SUCCESS The operation completed successfully.\r | |
174 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
175 | @retval EFI_OUT_OF_RESOURCES The required mode data could not be allocated.\r | |
176 | \r | |
177 | **/\r | |
178 | typedef\r | |
179 | EFI_STATUS\r | |
8b13229b | 180 | (EFIAPI *EFI_IP4_GET_MODE_DATA)(\r |
d1f95000 | 181 | IN CONST EFI_IP4_PROTOCOL *This,\r |
182 | OUT EFI_IP4_MODE_DATA *Ip4ModeData OPTIONAL,\r | |
183 | OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL,\r | |
184 | OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL\r | |
ed66e1bc | 185 | ); \r |
d1f95000 | 186 | \r |
187 | /**\r | |
188 | Assigns an IPv4 address and subnet mask to this EFI IPv4 Protocol driver instance.\r | |
83497f5d | 189 | \r |
190 | The Configure() function is used to set, change, or reset the operational\r | |
191 | parameters and filter settings for this EFI IPv4 Protocol instance. Until these\r | |
192 | parameters have been set, no network traffic can be sent or received by this\r | |
193 | instance. Once the parameters have been reset (by calling this function with\r | |
194 | IpConfigData set to NULL), no more traffic can be sent or received until these\r | |
195 | parameters have been set again. Each EFI IPv4 Protocol instance can be started\r | |
196 | and stopped independently of each other by enabling or disabling their receive\r | |
197 | filter settings with the Configure() function.\r | |
198 | \r | |
199 | When IpConfigData.UseDefaultAddress is set to FALSE, the new station address will\r | |
200 | be appended as an alias address into the addresses list in the EFI IPv4 Protocol\r | |
201 | driver. While set to TRUE, Configure() will trigger the EFI_IP4_CONFIG_PROTOCOL\r | |
202 | to retrieve the default IPv4 address if it is not available yet. Clients could\r | |
203 | frequently call GetModeData() to check the status to ensure that the default IPv4\r | |
204 | address is ready.\r | |
205 | \r | |
206 | If operational parameters are reset or changed, any pending transmit and receive\r | |
207 | requests will be cancelled. Their completion token status will be set to EFI_ABORTED\r | |
208 | and their events will be signaled.\r | |
d1f95000 | 209 | \r |
210 | @param This Pointer to the EFI_IP4_PROTOCOL instance.\r | |
211 | @param IpConfigData Pointer to the EFI IPv4 Protocol configuration data structure.\r | |
212 | \r | |
213 | @retval EFI_SUCCESS The driver instance was successfully opened.\r | |
214 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r | |
215 | RARP, etc.) is not finished yet.\r | |
216 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
217 | @retval EFI_UNSUPPORTED One or more of the following conditions is TRUE:\r | |
218 | A configuration protocol (DHCP, BOOTP, RARP, etc.) could\r | |
219 | not be located when clients choose to use the default IPv4\r | |
220 | address. This EFI IPv4 Protocol implementation does not\r | |
221 | support this requested filter or timeout setting.\r | |
222 | @retval EFI_OUT_OF_RESOURCES The EFI IPv4 Protocol driver instance data could not be allocated.\r | |
223 | @retval EFI_ALREADY_STARTED The interface is already open and must be stopped before the\r | |
224 | IPv4 address or subnet mask can be changed. The interface must\r | |
225 | also be stopped when switching to/from raw packet mode.\r | |
226 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI IPv4\r | |
4ca9b6c4 | 227 | Protocol driver instance is not opened.\r |
d1f95000 | 228 | \r |
229 | **/\r | |
230 | typedef \r | |
231 | EFI_STATUS\r | |
8b13229b | 232 | (EFIAPI *EFI_IP4_CONFIGURE)(\r |
d1f95000 | 233 | IN EFI_IP4_PROTOCOL *This,\r |
234 | IN EFI_IP4_CONFIG_DATA *IpConfigData OPTIONAL\r | |
ed66e1bc | 235 | ); \r |
d1f95000 | 236 | \r |
237 | /**\r | |
238 | Joins and leaves multicast groups.\r | |
83497f5d | 239 | \r |
240 | The Groups() function is used to join and leave multicast group sessions. Joining\r | |
241 | a group will enable reception of matching multicast packets. Leaving a group will\r | |
242 | disable the multicast packet reception.\r | |
243 | \r | |
244 | If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left.\r | |
d1f95000 | 245 | \r |
246 | @param This Pointer to the EFI_IP4_PROTOCOL instance.\r | |
247 | @param JoinFlag Set to TRUE to join the multicast group session and FALSE to leave.\r | |
248 | @param GroupAddress Pointer to the IPv4 multicast address.\r | |
249 | \r | |
250 | @retval EFI_SUCCESS The operation completed successfully.\r | |
251 | @retval EFI_INVALID_PARAMETER One or more of the following is TRUE:\r | |
252 | - This is NULL.\r | |
253 | - JoinFlag is TRUE and GroupAddress is NULL.\r | |
254 | - GroupAddress is not NULL and *GroupAddress is\r | |
255 | not a multicast IPv4 address.\r | |
256 | @retval EFI_NOT_STARTED This instance has not been started.\r | |
257 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r | |
258 | RARP, etc.) is not finished yet.\r | |
259 | @retval EFI_OUT_OF_RESOURCES System resources could not be allocated.\r | |
260 | @retval EFI_UNSUPPORTED This EFI IPv4 Protocol implementation does not support multicast groups.\r | |
261 | @retval EFI_ALREADY_STARTED The group address is already in the group table (when\r | |
262 | JoinFlag is TRUE).\r | |
263 | @retval EFI_NOT_FOUND The group address is not in the group table (when JoinFlag is FALSE).\r | |
264 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r | |
265 | \r | |
266 | **/\r | |
267 | typedef \r | |
268 | EFI_STATUS\r | |
8b13229b | 269 | (EFIAPI *EFI_IP4_GROUPS)(\r |
d1f95000 | 270 | IN EFI_IP4_PROTOCOL *This,\r |
271 | IN BOOLEAN JoinFlag,\r | |
272 | IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL\r | |
ed66e1bc | 273 | ); \r |
d1f95000 | 274 | \r |
275 | /**\r | |
276 | Adds and deletes routing table entries.\r | |
277 | \r | |
83497f5d | 278 | The Routes() function adds a route to or deletes a route from the routing table.\r |
279 | \r | |
280 | Routes are determined by comparing the SubnetAddress with the destination IPv4\r | |
281 | address arithmetically AND-ed with the SubnetMask. The gateway address must be\r | |
282 | on the same subnet as the configured station address.\r | |
283 | \r | |
284 | The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0.\r | |
285 | The default route matches all destination IPv4 addresses that do not match any\r | |
286 | other routes.\r | |
287 | \r | |
288 | A GatewayAddress that is zero is a nonroute. Packets are sent to the destination\r | |
289 | IP address if it can be found in the ARP cache or on the local subnet. One automatic\r | |
290 | nonroute entry will be inserted into the routing table for outgoing packets that\r | |
291 | are addressed to a local subnet (gateway address of 0.0.0.0).\r | |
292 | \r | |
293 | Each EFI IPv4 Protocol instance has its own independent routing table. Those EFI\r | |
294 | IPv4 Protocol instances that use the default IPv4 address will also have copies\r | |
295 | of the routing table that was provided by the EFI_IP4_CONFIG_PROTOCOL, and these\r | |
296 | copies will be updated whenever the EIF IPv4 Protocol driver reconfigures its\r | |
297 | instances. As a result, client modification to the routing table will be lost.\r | |
298 | \r | |
d1f95000 | 299 | @param This Pointer to the EFI_IP4_PROTOCOL instance.\r |
300 | @param DeleteRoute Set to TRUE to delete this route from the routing table. Set to\r | |
301 | FALSE to add this route to the routing table. SubnetAddress\r | |
302 | and SubnetMask are used as the key to each route entry.\r | |
303 | @param SubnetAddress The address of the subnet that needs to be routed.\r | |
304 | @param SubnetMask The subnet mask of SubnetAddress.\r | |
305 | @param GatewayAddress The unicast gateway IPv4 address for this route.\r | |
306 | \r | |
307 | @retval EFI_SUCCESS The operation completed successfully.\r | |
308 | @retval EFI_NOT_STARTED The driver instance has not been started.\r | |
309 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r | |
310 | RARP, etc.) is not finished yet.\r | |
311 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
312 | - This is NULL.\r | |
313 | - SubnetAddress is NULL.\r | |
314 | - SubnetMask is NULL.\r | |
315 | - GatewayAddress is NULL.\r | |
316 | - *SubnetAddress is not a valid subnet address.\r | |
317 | - *SubnetMask is not a valid subnet mask.\r | |
318 | - *GatewayAddress is not a valid unicast IPv4 address.\r | |
319 | @retval EFI_OUT_OF_RESOURCES Could not add the entry to the routing table.\r | |
320 | @retval EFI_NOT_FOUND This route is not in the routing table (when DeleteRoute is TRUE).\r | |
321 | @retval EFI_ACCESS_DENIED The route is already defined in the routing table (when\r | |
322 | DeleteRoute is FALSE).\r | |
323 | \r | |
324 | **/\r | |
325 | typedef \r | |
326 | EFI_STATUS\r | |
8b13229b | 327 | (EFIAPI *EFI_IP4_ROUTES)(\r |
d1f95000 | 328 | IN EFI_IP4_PROTOCOL *This,\r |
329 | IN BOOLEAN DeleteRoute,\r | |
330 | IN EFI_IPv4_ADDRESS *SubnetAddress,\r | |
331 | IN EFI_IPv4_ADDRESS *SubnetMask,\r | |
332 | IN EFI_IPv4_ADDRESS *GatewayAddress \r | |
ed66e1bc | 333 | ); \r |
d1f95000 | 334 | \r |
335 | /**\r | |
336 | Places outgoing data packets into the transmit queue.\r | |
337 | \r | |
83497f5d | 338 | The Transmit() function places a sending request in the transmit queue of this\r |
339 | EFI IPv4 Protocol instance. Whenever the packet in the token is sent out or some\r | |
340 | errors occur, the event in the token will be signaled and the status is updated.\r | |
341 | \r | |
d1f95000 | 342 | @param This Pointer to the EFI_IP4_PROTOCOL instance.\r |
343 | @param Token Pointer to the transmit token.\r | |
344 | \r | |
345 | @retval EFI_SUCCESS The data has been queued for transmission.\r | |
346 | @retval EFI_NOT_STARTED This instance has not been started.\r | |
347 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r | |
348 | RARP, etc.) is not finished yet.\r | |
349 | @retval EFI_INVALID_PARAMETER One or more pameters are invalid.\r | |
350 | @retval EFI_ACCESS_DENIED The transmit completion token with the same Token.Event\r | |
351 | was already in the transmit queue.\r | |
352 | @retval EFI_NOT_READY The completion token could not be queued because the transmit\r | |
353 | queue is full. \r | |
354 | @retval EFI_NOT_FOUND Not route is found to destination address.\r | |
355 | @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data.\r | |
356 | @retval EFI_BUFFER_TOO_SMALL Token.Packet.TxData.TotalDataLength is too\r | |
357 | short to transmit.\r | |
358 | @retval EFI_BAD_BUFFER_SIZE The length of the IPv4 header + option length + total data length is\r | |
359 | greater than MTU (or greater than the maximum packet size if\r | |
360 | Token.Packet.TxData.OverrideData.\r | |
361 | DoNotFragment is TRUE.)\r | |
362 | \r | |
363 | **/\r | |
364 | typedef \r | |
365 | EFI_STATUS\r | |
8b13229b | 366 | (EFIAPI *EFI_IP4_TRANSMIT)(\r |
d1f95000 | 367 | IN EFI_IP4_PROTOCOL *This,\r |
368 | IN EFI_IP4_COMPLETION_TOKEN *Token\r | |
ed66e1bc | 369 | ); \r |
d1f95000 | 370 | \r |
371 | /**\r | |
372 | Places a receiving request into the receiving queue.\r | |
83497f5d | 373 | \r |
374 | The Receive() function places a completion token into the receive packet queue.\r | |
375 | This function is always asynchronous.\r | |
376 | \r | |
377 | The Token.Event field in the completion token must be filled in by the caller\r | |
378 | and cannot be NULL. When the receive operation completes, the EFI IPv4 Protocol\r | |
379 | driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event\r | |
380 | is signaled.\r | |
d1f95000 | 381 | \r |
382 | @param This Pointer to the EFI_IP4_PROTOCOL instance.\r | |
383 | @param Token Pointer to a token that is associated with the receive data descriptor.\r | |
384 | \r | |
385 | @retval EFI_SUCCESS The receive completion token was cached.\r | |
386 | @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r | |
387 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, RARP, etc.)\r | |
388 | is not finished yet.\r | |
389 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
390 | - This is NULL.\r | |
391 | - Token is NULL.\r | |
392 | - Token.Event is NULL.\r | |
393 | @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system\r | |
394 | resources (usually memory).\r | |
395 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r | |
396 | The EFI IPv4 Protocol instance has been reset to startup defaults.\r | |
397 | EFI_ACCESS_DENIED The receive completion token with the same Token.Event was already\r | |
398 | in the receive queue.\r | |
399 | @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full.\r | |
400 | @retval EFI_ICMP_ERROR An ICMP error packet was received.\r | |
401 | \r | |
402 | **/\r | |
403 | typedef \r | |
404 | EFI_STATUS\r | |
8b13229b | 405 | (EFIAPI *EFI_IP4_RECEIVE)(\r |
d1f95000 | 406 | IN EFI_IP4_PROTOCOL *This,\r |
407 | IN EFI_IP4_COMPLETION_TOKEN *Token\r | |
ed66e1bc | 408 | ); \r |
d1f95000 | 409 | \r |
410 | /**\r | |
411 | Abort an asynchronous transmit or receive request.\r | |
83497f5d | 412 | \r |
413 | The Cancel() function is used to abort a pending transmit or receive request.\r | |
414 | If the token is in the transmit or receive request queues, after calling this\r | |
415 | function, Token->Status will be set to EFI_ABORTED and then Token->Event will\r | |
416 | be signaled. If the token is not in one of the queues, which usually means the\r | |
417 | asynchronous operation has completed, this function will not signal the token\r | |
418 | and EFI_NOT_FOUND is returned.\r | |
d1f95000 | 419 | \r |
420 | @param This Pointer to the EFI_IP4_PROTOCOL instance.\r | |
421 | @param Token Pointer to a token that has been issued by\r | |
422 | EFI_IP4_PROTOCOL.Transmit() or\r | |
423 | EFI_IP4_PROTOCOL.Receive(). If NULL, all pending\r | |
424 | tokens are aborted. Type EFI_IP4_COMPLETION_TOKEN is\r | |
425 | defined in EFI_IP4_PROTOCOL.Transmit().\r | |
426 | \r | |
427 | @retval EFI_SUCCESS The asynchronous I/O request was aborted and\r | |
428 | Token.->Event was signaled. When Token is NULL, all\r | |
429 | pending requests were aborted and their events were signaled.\r | |
430 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
431 | @retval EFI_NOT_STARTED This instance has not been started.\r | |
432 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r | |
433 | RARP, etc.) is not finished yet.\r | |
434 | @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O request was\r | |
435 | not found in the transmit or receive queue. It has either completed\r | |
436 | or was not issued by Transmit() and Receive().\r | |
437 | \r | |
438 | **/\r | |
439 | typedef\r | |
440 | EFI_STATUS\r | |
8b13229b | 441 | (EFIAPI *EFI_IP4_CANCEL)(\r |
d1f95000 | 442 | IN EFI_IP4_PROTOCOL *This,\r |
443 | IN EFI_IP4_COMPLETION_TOKEN *Token OPTIONAL\r | |
ed66e1bc | 444 | ); \r |
d1f95000 | 445 | \r |
446 | /**\r | |
447 | Polls for incoming data packets and processes outgoing data packets.\r | |
83497f5d | 448 | \r |
449 | The Poll() function polls for incoming data packets and processes outgoing data\r | |
450 | packets. Network drivers and applications can call the EFI_IP4_PROTOCOL.Poll()\r | |
451 | function to increase the rate that data packets are moved between the communications\r | |
452 | device and the transmit and receive queues.\r | |
453 | \r | |
454 | In some systems the periodic timer event may not poll the underlying communications\r | |
455 | device fast enough to transmit and/or receive all data packets without missing\r | |
456 | incoming packets or dropping outgoing packets. Drivers and applications that are\r | |
457 | experiencing packet loss should try calling the EFI_IP4_PROTOCOL.Poll() function\r | |
458 | more often.\r | |
d1f95000 | 459 | \r |
460 | @param This Pointer to the EFI_IP4_PROTOCOL instance.\r | |
461 | \r | |
462 | @retval EFI_SUCCESS Incoming or outgoing data was processed.\r | |
463 | @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r | |
464 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r | |
465 | RARP, etc.) is not finished yet.\r | |
466 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
467 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r | |
468 | @retval EFI_NOT_READY No incoming or outgoing data is processed.\r | |
469 | @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue.\r | |
470 | Consider increasing the polling rate.\r | |
471 | \r | |
472 | **/\r | |
473 | typedef \r | |
474 | EFI_STATUS\r | |
8b13229b | 475 | (EFIAPI *EFI_IP4_POLL)(\r |
d1f95000 | 476 | IN EFI_IP4_PROTOCOL *This\r |
ed66e1bc | 477 | ); \r |
d1f95000 | 478 | \r |
44717a39 | 479 | ///\r |
480 | /// The EFI IPv4 Protocol implements a simple packet-oriented interface that can be \r | |
481 | /// used by drivers, daemons, and applications to transmit and receive network packets.\r | |
482 | ///\r | |
d1f95000 | 483 | struct _EFI_IP4_PROTOCOL {\r |
484 | EFI_IP4_GET_MODE_DATA GetModeData;\r | |
485 | EFI_IP4_CONFIGURE Configure;\r | |
486 | EFI_IP4_GROUPS Groups;\r | |
487 | EFI_IP4_ROUTES Routes;\r | |
488 | EFI_IP4_TRANSMIT Transmit;\r | |
489 | EFI_IP4_RECEIVE Receive;\r | |
490 | EFI_IP4_CANCEL Cancel;\r | |
491 | EFI_IP4_POLL Poll;\r | |
492 | };\r | |
493 | \r | |
494 | extern EFI_GUID gEfiIp4ServiceBindingProtocolGuid;\r | |
495 | extern EFI_GUID gEfiIp4ProtocolGuid;\r | |
496 | \r | |
497 | #endif\r |