]> git.proxmox.com Git - mirror_edk2.git/blame_incremental - MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Impl.c
projects / mirror_edk2.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
MdeModulePkg: Update Ip4Dxe driver to support Ip4Config2 protocol,
[mirror_edk2.git] / MdeModulePkg / Universal / Network / Ip4Dxe / Ip4Impl.c
... / ...
CommitLineData
1/** @file\r
2\r
3Copyright (c) 2005 - 2015, Intel Corporation. All rights reserved.<BR>\r
4This program and the accompanying materials\r
5are licensed and made available under the terms and conditions of the BSD License\r
6which accompanies this distribution. The full text of the license may be found at\r
7http://opensource.org/licenses/bsd-license.php\r
8\r
9THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
10WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
11\r
12**/\r
13\r
14#include "Ip4Impl.h"\r
15\r
16EFI_IPSEC2_PROTOCOL *mIpSec = NULL;\r
17\r
18/**\r
19 Gets the current operational settings for this instance of the EFI IPv4 Protocol driver.\r
20\r
21 The GetModeData() function returns the current operational mode data for this\r
22 driver instance. The data fields in EFI_IP4_MODE_DATA are read only. This\r
23 function is used optionally to retrieve the operational mode data of underlying\r
24 networks or drivers.\r
25\r
26 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
27 @param[out] Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure.\r
28 @param[out] MnpConfigData Pointer to the managed network configuration data structure.\r
29 @param[out] SnpModeData Pointer to the simple network mode data structure.\r
30\r
31 @retval EFI_SUCCESS The operation completed successfully.\r
32 @retval EFI_INVALID_PARAMETER This is NULL.\r
33 @retval EFI_OUT_OF_RESOURCES The required mode data could not be allocated.\r
34\r
35**/\r
36EFI_STATUS\r
37EFIAPI\r
38EfiIp4GetModeData (\r
39 IN CONST EFI_IP4_PROTOCOL *This,\r
40 OUT EFI_IP4_MODE_DATA *Ip4ModeData OPTIONAL,\r
41 OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL,\r
42 OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL\r
43 );\r
44\r
45/**\r
46 Assigns an IPv4 address and subnet mask to this EFI IPv4 Protocol driver instance.\r
47\r
48 The Configure() function is used to set, change, or reset the operational\r
49 parameters and filter settings for this EFI IPv4 Protocol instance. Until these\r
50 parameters have been set, no network traffic can be sent or received by this\r
51 instance. Once the parameters have been reset (by calling this function with\r
52 IpConfigData set to NULL), no more traffic can be sent or received until these\r
53 parameters have been set again. Each EFI IPv4 Protocol instance can be started\r
54 and stopped independently of each other by enabling or disabling their receive\r
55 filter settings with the Configure() function.\r
56\r
57 When IpConfigData.UseDefaultAddress is set to FALSE, the new station address will\r
58 be appended as an alias address into the addresses list in the EFI IPv4 Protocol\r
59 driver. While set to TRUE, Configure() will trigger the EFI_IP4_CONFIG_PROTOCOL\r
60 to retrieve the default IPv4 address if it is not available yet. Clients could\r
61 frequently call GetModeData() to check the status to ensure that the default IPv4\r
62 address is ready.\r
63\r
64 If operational parameters are reset or changed, any pending transmit and receive\r
65 requests will be cancelled. Their completion token status will be set to EFI_ABORTED\r
66 and their events will be signaled.\r
67\r
68 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
69 @param[in] IpConfigData Pointer to the EFI IPv4 Protocol configuration data structure.\r
70\r
71 @retval EFI_SUCCESS The driver instance was successfully opened.\r
72 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
73 RARP, etc.) is not finished yet.\r
74 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
75 @retval EFI_UNSUPPORTED One or more of the following conditions is TRUE:\r
76 A configuration protocol (DHCP, BOOTP, RARP, etc.) could\r
77 not be located when clients choose to use the default IPv4\r
78 address. This EFI IPv4 Protocol implementation does not\r
79 support this requested filter or timeout setting.\r
80 @retval EFI_OUT_OF_RESOURCES The EFI IPv4 Protocol driver instance data could not be allocated.\r
81 @retval EFI_ALREADY_STARTED The interface is already open and must be stopped before the\r
82 IPv4 address or subnet mask can be changed. The interface must\r
83 also be stopped when switching to/from raw packet mode.\r
84 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI IPv4\r
85 Protocol driver instance is not opened.\r
86\r
87**/\r
88EFI_STATUS\r
89EFIAPI\r
90EfiIp4Configure (\r
91 IN EFI_IP4_PROTOCOL *This,\r
92 IN EFI_IP4_CONFIG_DATA *IpConfigData OPTIONAL\r
93 );\r
94\r
95/**\r
96 Joins and leaves multicast groups.\r
97\r
98 The Groups() function is used to join and leave multicast group sessions. Joining\r
99 a group will enable reception of matching multicast packets. Leaving a group will\r
100 disable the multicast packet reception.\r
101\r
102 If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left.\r
103\r
104 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
105 @param[in] JoinFlag Set to TRUE to join the multicast group session and FALSE to leave.\r
106 @param[in] GroupAddress Pointer to the IPv4 multicast address.\r
107\r
108 @retval EFI_SUCCESS The operation completed successfully.\r
109 @retval EFI_INVALID_PARAMETER One or more of the following is TRUE:\r
110 - This is NULL.\r
111 - JoinFlag is TRUE and GroupAddress is NULL.\r
112 - GroupAddress is not NULL and *GroupAddress is\r
113 not a multicast IPv4 address.\r
114 @retval EFI_NOT_STARTED This instance has not been started.\r
115 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
116 RARP, etc.) is not finished yet.\r
117 @retval EFI_OUT_OF_RESOURCES System resources could not be allocated.\r
118 @retval EFI_UNSUPPORTED This EFI IPv4 Protocol implementation does not support multicast groups.\r
119 @retval EFI_ALREADY_STARTED The group address is already in the group table (when\r
120 JoinFlag is TRUE).\r
121 @retval EFI_NOT_FOUND The group address is not in the group table (when JoinFlag is FALSE).\r
122 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
123\r
124**/\r
125EFI_STATUS\r
126EFIAPI\r
127EfiIp4Groups (\r
128 IN EFI_IP4_PROTOCOL *This,\r
129 IN BOOLEAN JoinFlag,\r
130 IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL\r
131 );\r
132\r
133/**\r
134 Adds and deletes routing table entries.\r
135\r
136 The Routes() function adds a route to or deletes a route from the routing table.\r
137\r
138 Routes are determined by comparing the SubnetAddress with the destination IPv4\r
139 address arithmetically AND-ed with the SubnetMask. The gateway address must be\r
140 on the same subnet as the configured station address.\r
141\r
142 The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0.\r
143 The default route matches all destination IPv4 addresses that do not match any\r
144 other routes.\r
145\r
146 A GatewayAddress that is zero is a nonroute. Packets are sent to the destination\r
147 IP address if it can be found in the ARP cache or on the local subnet. One automatic\r
148 nonroute entry will be inserted into the routing table for outgoing packets that\r
149 are addressed to a local subnet (gateway address of 0.0.0.0).\r
150\r
151 Each EFI IPv4 Protocol instance has its own independent routing table. Those EFI\r
152 IPv4 Protocol instances that use the default IPv4 address will also have copies\r
153 of the routing table that was provided by the EFI_IP4_CONFIG_PROTOCOL, and these\r
154 copies will be updated whenever the EIF IPv4 Protocol driver reconfigures its\r
155 instances. As a result, client modification to the routing table will be lost.\r
156\r
157 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
158 @param[in] DeleteRoute Set to TRUE to delete this route from the routing table. Set to\r
159 FALSE to add this route to the routing table. SubnetAddress\r
160 and SubnetMask are used as the key to each route entry.\r
161 @param[in] SubnetAddress The address of the subnet that needs to be routed.\r
162 @param[in] SubnetMask The subnet mask of SubnetAddress.\r
163 @param[in] GatewayAddress The unicast gateway IPv4 address for this route.\r
164\r
165 @retval EFI_SUCCESS The operation completed successfully.\r
166 @retval EFI_NOT_STARTED The driver instance has not been started.\r
167 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
168 RARP, etc.) is not finished yet.\r
169 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
170 - This is NULL.\r
171 - SubnetAddress is NULL.\r
172 - SubnetMask is NULL.\r
173 - GatewayAddress is NULL.\r
174 - *SubnetAddress is not a valid subnet address.\r
175 - *SubnetMask is not a valid subnet mask.\r
176 - *GatewayAddress is not a valid unicast IPv4 address.\r
177 @retval EFI_OUT_OF_RESOURCES Could not add the entry to the routing table.\r
178 @retval EFI_NOT_FOUND This route is not in the routing table (when DeleteRoute is TRUE).\r
179 @retval EFI_ACCESS_DENIED The route is already defined in the routing table (when\r
180 DeleteRoute is FALSE).\r
181\r
182**/\r
183EFI_STATUS\r
184EFIAPI\r
185EfiIp4Routes (\r
186 IN EFI_IP4_PROTOCOL *This,\r
187 IN BOOLEAN DeleteRoute,\r
188 IN EFI_IPv4_ADDRESS *SubnetAddress,\r
189 IN EFI_IPv4_ADDRESS *SubnetMask,\r
190 IN EFI_IPv4_ADDRESS *GatewayAddress\r
191 );\r
192\r
193/**\r
194 Places outgoing data packets into the transmit queue.\r
195\r
196 The Transmit() function places a sending request in the transmit queue of this\r
197 EFI IPv4 Protocol instance. Whenever the packet in the token is sent out or some\r
198 errors occur, the event in the token will be signaled and the status is updated.\r
199\r
200 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
201 @param[in] Token Pointer to the transmit token.\r
202\r
203 @retval EFI_SUCCESS The data has been queued for transmission.\r
204 @retval EFI_NOT_STARTED This instance has not been started.\r
205 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
206 RARP, etc.) is not finished yet.\r
207 @retval EFI_INVALID_PARAMETER One or more pameters are invalid.\r
208 @retval EFI_ACCESS_DENIED The transmit completion token with the same Token.Event\r
209 was already in the transmit queue.\r
210 @retval EFI_NOT_READY The completion token could not be queued because the transmit\r
211 queue is full.\r
212 @retval EFI_NOT_FOUND Not route is found to destination address.\r
213 @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data.\r
214 @retval EFI_BUFFER_TOO_SMALL Token.Packet.TxData.TotalDataLength is too\r
215 short to transmit.\r
216 @retval EFI_BAD_BUFFER_SIZE The length of the IPv4 header + option length + total data length is\r
217 greater than MTU (or greater than the maximum packet size if\r
218 Token.Packet.TxData.OverrideData.\r
219 DoNotFragment is TRUE.)\r
220\r
221**/\r
222EFI_STATUS\r
223EFIAPI\r
224EfiIp4Transmit (\r
225 IN EFI_IP4_PROTOCOL *This,\r
226 IN EFI_IP4_COMPLETION_TOKEN *Token\r
227 );\r
228\r
229/**\r
230 Places a receiving request into the receiving queue.\r
231\r
232 The Receive() function places a completion token into the receive packet queue.\r
233 This function is always asynchronous.\r
234\r
235 The Token.Event field in the completion token must be filled in by the caller\r
236 and cannot be NULL. When the receive operation completes, the EFI IPv4 Protocol\r
237 driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event\r
238 is signaled.\r
239\r
240 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
241 @param[in] Token Pointer to a token that is associated with the receive data descriptor.\r
242\r
243 @retval EFI_SUCCESS The receive completion token was cached.\r
244 @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r
245 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, RARP, etc.)\r
246 is not finished yet.\r
247 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
248 - This is NULL.\r
249 - Token is NULL.\r
250 - Token.Event is NULL.\r
251 @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system\r
252 resources (usually memory).\r
253 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
254 The EFI IPv4 Protocol instance has been reset to startup defaults.\r
255 EFI_ACCESS_DENIED The receive completion token with the same Token.Event was already\r
256 in the receive queue.\r
257 @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full.\r
258 @retval EFI_ICMP_ERROR An ICMP error packet was received.\r
259\r
260**/\r
261EFI_STATUS\r
262EFIAPI\r
263EfiIp4Receive (\r
264 IN EFI_IP4_PROTOCOL *This,\r
265 IN EFI_IP4_COMPLETION_TOKEN *Token\r
266 );\r
267\r
268/**\r
269 Abort an asynchronous transmit or receive request.\r
270\r
271 The Cancel() function is used to abort a pending transmit or receive request.\r
272 If the token is in the transmit or receive request queues, after calling this\r
273 function, Token->Status will be set to EFI_ABORTED and then Token->Event will\r
274 be signaled. If the token is not in one of the queues, which usually means the\r
275 asynchronous operation has completed, this function will not signal the token\r
276 and EFI_NOT_FOUND is returned.\r
277\r
278 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
279 @param[in] Token Pointer to a token that has been issued by\r
280 EFI_IP4_PROTOCOL.Transmit() or\r
281 EFI_IP4_PROTOCOL.Receive(). If NULL, all pending\r
282 tokens are aborted. Type EFI_IP4_COMPLETION_TOKEN is\r
283 defined in EFI_IP4_PROTOCOL.Transmit().\r
284\r
285 @retval EFI_SUCCESS The asynchronous I/O request was aborted and\r
286 Token.->Event was signaled. When Token is NULL, all\r
287 pending requests were aborted and their events were signaled.\r
288 @retval EFI_INVALID_PARAMETER This is NULL.\r
289 @retval EFI_NOT_STARTED This instance has not been started.\r
290 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
291 RARP, etc.) is not finished yet.\r
292 @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O request was\r
293 not found in the transmit or receive queue. It has either completed\r
294 or was not issued by Transmit() and Receive().\r
295\r
296**/\r
297EFI_STATUS\r
298EFIAPI\r
299EfiIp4Cancel (\r
300 IN EFI_IP4_PROTOCOL *This,\r
301 IN EFI_IP4_COMPLETION_TOKEN *Token OPTIONAL\r
302 );\r
303\r
304/**\r
305 Polls for incoming data packets and processes outgoing data packets.\r
306\r
307 The Poll() function polls for incoming data packets and processes outgoing data\r
308 packets. Network drivers and applications can call the EFI_IP4_PROTOCOL.Poll()\r
309 function to increase the rate that data packets are moved between the communications\r
310 device and the transmit and receive queues.\r
311\r
312 In some systems the periodic timer event may not poll the underlying communications\r
313 device fast enough to transmit and/or receive all data packets without missing\r
314 incoming packets or dropping outgoing packets. Drivers and applications that are\r
315 experiencing packet loss should try calling the EFI_IP4_PROTOCOL.Poll() function\r
316 more often.\r
317\r
318 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
319\r
320 @retval EFI_SUCCESS Incoming or outgoing data was processed.\r
321 @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r
322 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
323 RARP, etc.) is not finished yet.\r
324 @retval EFI_INVALID_PARAMETER This is NULL.\r
325 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
326 @retval EFI_NOT_READY No incoming or outgoing data is processed.\r
327 @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue.\r
328 Consider increasing the polling rate.\r
329\r
330**/\r
331EFI_STATUS\r
332EFIAPI\r
333EfiIp4Poll (\r
334 IN EFI_IP4_PROTOCOL *This\r
335 );\r
336\r
337EFI_IP4_PROTOCOL\r
338mEfiIp4ProtocolTemplete = {\r
339 EfiIp4GetModeData,\r
340 EfiIp4Configure,\r
341 EfiIp4Groups,\r
342 EfiIp4Routes,\r
343 EfiIp4Transmit,\r
344 EfiIp4Receive,\r
345 EfiIp4Cancel,\r
346 EfiIp4Poll\r
347};\r
348\r
349/**\r
350 Gets the current operational settings for this instance of the EFI IPv4 Protocol driver.\r
351\r
352 The GetModeData() function returns the current operational mode data for this\r
353 driver instance. The data fields in EFI_IP4_MODE_DATA are read only. This\r
354 function is used optionally to retrieve the operational mode data of underlying\r
355 networks or drivers.\r
356\r
357 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
358 @param[out] Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure.\r
359 @param[out] MnpConfigData Pointer to the managed network configuration data structure.\r
360 @param[out] SnpModeData Pointer to the simple network mode data structure.\r
361\r
362 @retval EFI_SUCCESS The operation completed successfully.\r
363 @retval EFI_INVALID_PARAMETER This is NULL.\r
364 @retval EFI_OUT_OF_RESOURCES The required mode data could not be allocated.\r
365\r
366**/\r
367EFI_STATUS\r
368EFIAPI\r
369EfiIp4GetModeData (\r
370 IN CONST EFI_IP4_PROTOCOL *This,\r
371 OUT EFI_IP4_MODE_DATA *Ip4ModeData OPTIONAL,\r
372 OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL,\r
373 OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL\r
374 )\r
375{\r
376 IP4_PROTOCOL *IpInstance;\r
377 IP4_SERVICE *IpSb;\r
378 EFI_IP4_CONFIG_DATA *Config;\r
379 EFI_STATUS Status;\r
380 EFI_TPL OldTpl;\r
381 IP4_ADDR Ip;\r
382\r
383 if (This == NULL) {\r
384 return EFI_INVALID_PARAMETER;\r
385 }\r
386\r
387 OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
388 IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r
389 IpSb = IpInstance->Service;\r
390\r
391 if (Ip4ModeData != NULL) {\r
392 //\r
393 // IsStarted is "whether the EfiIp4Configure has been called".\r
394 // IsConfigured is "whether the station address has been configured"\r
395 //\r
396 Ip4ModeData->IsStarted = (BOOLEAN)(IpInstance->State == IP4_STATE_CONFIGED);\r
397 CopyMem (&Ip4ModeData->ConfigData, &IpInstance->ConfigData, sizeof (Ip4ModeData->ConfigData));\r
398 Ip4ModeData->IsConfigured = FALSE;\r
399\r
400 Ip4ModeData->GroupCount = IpInstance->GroupCount;\r
401 Ip4ModeData->GroupTable = (EFI_IPv4_ADDRESS *) IpInstance->Groups;\r
402\r
403 Ip4ModeData->IcmpTypeCount = 23;\r
404 Ip4ModeData->IcmpTypeList = mIp4SupportedIcmp;\r
405\r
406 Ip4ModeData->RouteTable = NULL;\r
407 Ip4ModeData->RouteCount = 0;\r
408\r
409 Ip4ModeData->MaxPacketSize = IpSb->MaxPacketSize;\r
410\r
411 //\r
412 // return the current station address for this IP child. So,\r
413 // the user can get the default address through this. Some\r
414 // application wants to know it station address even it is\r
415 // using the default one, such as a ftp server.\r
416 //\r
417 if (Ip4ModeData->IsStarted) {\r
418 Config = &Ip4ModeData->ConfigData;\r
419\r
420 Ip = HTONL (IpInstance->Interface->Ip);\r
421 CopyMem (&Config->StationAddress, &Ip, sizeof (EFI_IPv4_ADDRESS));\r
422\r
423 Ip = HTONL (IpInstance->Interface->SubnetMask);\r
424 CopyMem (&Config->SubnetMask, &Ip, sizeof (EFI_IPv4_ADDRESS));\r
425\r
426 Ip4ModeData->IsConfigured = IpInstance->Interface->Configured;\r
427\r
428 //\r
429 // Build a EFI route table for user from the internal route table.\r
430 //\r
431 Status = Ip4BuildEfiRouteTable (IpInstance);\r
432\r
433 if (EFI_ERROR (Status)) {\r
434 gBS->RestoreTPL (OldTpl);\r
435 return Status;\r
436 }\r
437\r
438 Ip4ModeData->RouteTable = IpInstance->EfiRouteTable;\r
439 Ip4ModeData->RouteCount = IpInstance->EfiRouteCount;\r
440 }\r
441 }\r
442\r
443 //\r
444 // Get fresh mode data from MNP, since underlying media status may change\r
445 //\r
446 Status = IpSb->Mnp->GetModeData (IpSb->Mnp, MnpConfigData, SnpModeData);\r
447\r
448 gBS->RestoreTPL (OldTpl);\r
449 return Status;\r
450}\r
451\r
452\r
453/**\r
454 Config the MNP parameter used by IP. The IP driver use one MNP\r
455 child to transmit/receive frames. By default, it configures MNP\r
456 to receive unicast/multicast/broadcast. And it will enable/disable\r
457 the promiscous receive according to whether there is IP child\r
458 enable that or not. If Force is FALSE, it will iterate through\r
459 all the IP children to check whether the promiscuous receive\r
460 setting has been changed. If it hasn't been changed, it won't\r
461 reconfigure the MNP. If Force is TRUE, the MNP is configured no\r
462 matter whether that is changed or not.\r
463\r
464 @param[in] IpSb The IP4 service instance that is to be changed.\r
465 @param[in] Force Force the configuration or not.\r
466\r
467 @retval EFI_SUCCESS The MNP is successfully configured/reconfigured.\r
468 @retval Others Configuration failed.\r
469\r
470**/\r
471EFI_STATUS\r
472Ip4ServiceConfigMnp (\r
473 IN IP4_SERVICE *IpSb,\r
474 IN BOOLEAN Force\r
475 )\r
476{\r
477 LIST_ENTRY *Entry;\r
478 LIST_ENTRY *ProtoEntry;\r
479 IP4_INTERFACE *IpIf;\r
480 IP4_PROTOCOL *IpInstance;\r
481 BOOLEAN Reconfig;\r
482 BOOLEAN PromiscReceive;\r
483 EFI_STATUS Status;\r
484\r
485 Reconfig = FALSE;\r
486 PromiscReceive = FALSE;\r
487\r
488 if (!Force) {\r
489 //\r
490 // Iterate through the IP children to check whether promiscuous\r
491 // receive setting has been changed. Update the interface's receive\r
492 // filter also.\r
493 //\r
494 NET_LIST_FOR_EACH (Entry, &IpSb->Interfaces) {\r
495\r
496 IpIf = NET_LIST_USER_STRUCT (Entry, IP4_INTERFACE, Link);\r
497 IpIf->PromiscRecv = FALSE;\r
498\r
499 NET_LIST_FOR_EACH (ProtoEntry, &IpIf->IpInstances) {\r
500 IpInstance = NET_LIST_USER_STRUCT (ProtoEntry, IP4_PROTOCOL, AddrLink);\r
501\r
502 if (IpInstance->ConfigData.AcceptPromiscuous) {\r
503 IpIf->PromiscRecv = TRUE;\r
504 PromiscReceive = TRUE;\r
505 }\r
506 }\r
507 }\r
508\r
509 //\r
510 // If promiscuous receive isn't changed, it isn't necessary to reconfigure.\r
511 //\r
512 if (PromiscReceive == IpSb->MnpConfigData.EnablePromiscuousReceive) {\r
513 return EFI_SUCCESS;\r
514 }\r
515\r
516 Reconfig = TRUE;\r
517 IpSb->MnpConfigData.EnablePromiscuousReceive = PromiscReceive;\r
518 }\r
519\r
520 Status = IpSb->Mnp->Configure (IpSb->Mnp, &IpSb->MnpConfigData);\r
521\r
522 //\r
523 // recover the original configuration if failed to set the configure.\r
524 //\r
525 if (EFI_ERROR (Status) && Reconfig) {\r
526 IpSb->MnpConfigData.EnablePromiscuousReceive = (BOOLEAN) !PromiscReceive;\r
527 }\r
528\r
529 return Status;\r
530}\r
531\r
532\r
533/**\r
534 Intiialize the IP4_PROTOCOL structure to the unconfigured states.\r
535\r
536 @param IpSb The IP4 service instance.\r
537 @param IpInstance The IP4 child instance.\r
538\r
539**/\r
540VOID\r
541Ip4InitProtocol (\r
542 IN IP4_SERVICE *IpSb,\r
543 IN OUT IP4_PROTOCOL *IpInstance\r
544 )\r
545{\r
546 ASSERT ((IpSb != NULL) && (IpInstance != NULL));\r
547\r
548 ZeroMem (IpInstance, sizeof (IP4_PROTOCOL));\r
549\r
550 IpInstance->Signature = IP4_PROTOCOL_SIGNATURE;\r
551 CopyMem (&IpInstance->Ip4Proto, &mEfiIp4ProtocolTemplete, sizeof (IpInstance->Ip4Proto));\r
552 IpInstance->State = IP4_STATE_UNCONFIGED;\r
553 IpInstance->Service = IpSb;\r
554\r
555 InitializeListHead (&IpInstance->Link);\r
556 NetMapInit (&IpInstance->RxTokens);\r
557 NetMapInit (&IpInstance->TxTokens);\r
558 InitializeListHead (&IpInstance->Received);\r
559 InitializeListHead (&IpInstance->Delivered);\r
560 InitializeListHead (&IpInstance->AddrLink);\r
561\r
562 EfiInitializeLock (&IpInstance->RecycleLock, TPL_NOTIFY);\r
563}\r
564\r
565\r
566\r
567/**\r
568 Configure the IP4 child. If the child is already configured,\r
569 change the configuration parameter. Otherwise configure it\r
570 for the first time. The caller should validate the configuration\r
571 before deliver them to it. It also don't do configure NULL.\r
572\r
573 @param[in, out] IpInstance The IP4 child to configure.\r
574 @param[in] Config The configure data.\r
575\r
576 @retval EFI_SUCCESS The IP4 child is successfully configured.\r
577 @retval EFI_DEVICE_ERROR Failed to free the pending transive or to\r
578 configure underlying MNP or other errors.\r
579 @retval EFI_NO_MAPPING The IP4 child is configured to use default\r
580 address, but the default address hasn't been\r
581 configured. The IP4 child doesn't need to be\r
582 reconfigured when default address is configured.\r
583 @retval EFI_OUT_OF_RESOURCES No more memory space is available.\r
584 @retval other Other error occurs.\r
585\r
586**/\r
587EFI_STATUS\r
588Ip4ConfigProtocol (\r
589 IN OUT IP4_PROTOCOL *IpInstance,\r
590 IN EFI_IP4_CONFIG_DATA *Config\r
591 )\r
592{\r
593 IP4_SERVICE *IpSb;\r
594 IP4_INTERFACE *IpIf;\r
595 EFI_STATUS Status;\r
596 IP4_ADDR Ip;\r
597 IP4_ADDR Netmask;\r
598 EFI_ARP_PROTOCOL *Arp;\r
599\r
600 IpSb = IpInstance->Service;\r
601\r
602 //\r
603 // User is changing packet filters. It must be stopped\r
604 // before the station address can be changed.\r
605 //\r
606 if (IpInstance->State == IP4_STATE_CONFIGED) {\r
607 //\r
608 // Cancel all the pending transmit/receive from upper layer\r
609 //\r
610 Status = Ip4Cancel (IpInstance, NULL);\r
611\r
612 if (EFI_ERROR (Status)) {\r
613 return EFI_DEVICE_ERROR;\r
614 }\r
615\r
616 CopyMem (&IpInstance->ConfigData, Config, sizeof (IpInstance->ConfigData));\r
617 return EFI_SUCCESS;\r
618 }\r
619\r
620 //\r
621 // Configure a fresh IP4 protocol instance. Create a route table.\r
622 // Each IP child has its own route table, which may point to the\r
623 // default table if it is using default address.\r
624 //\r
625 Status = EFI_OUT_OF_RESOURCES;\r
626 IpInstance->RouteTable = Ip4CreateRouteTable ();\r
627\r
628 if (IpInstance->RouteTable == NULL) {\r
629 return Status;\r
630 }\r
631\r
632 //\r
633 // Set up the interface.\r
634 //\r
635 CopyMem (&Ip, &Config->StationAddress, sizeof (IP4_ADDR));\r
636 CopyMem (&Netmask, &Config->SubnetMask, sizeof (IP4_ADDR));\r
637\r
638 Ip = NTOHL (Ip);\r
639 Netmask = NTOHL (Netmask);\r
640\r
641 if (!Config->UseDefaultAddress) {\r
642 //\r
643 // Find whether there is already an interface with the same\r
644 // station address. All the instances with the same station\r
645 // address shares one interface.\r
646 //\r
647 IpIf = Ip4FindStationAddress (IpSb, Ip, Netmask);\r
648\r
649 if (IpIf != NULL) {\r
650 NET_GET_REF (IpIf);\r
651\r
652 } else {\r
653 IpIf = Ip4CreateInterface (IpSb->Mnp, IpSb->Controller, IpSb->Image);\r
654\r
655 if (IpIf == NULL) {\r
656 goto ON_ERROR;\r
657 }\r
658\r
659 Status = Ip4SetAddress (IpIf, Ip, Netmask);\r
660\r
661 if (EFI_ERROR (Status)) {\r
662 Status = EFI_DEVICE_ERROR;\r
663 Ip4FreeInterface (IpIf, IpInstance);\r
664 goto ON_ERROR;\r
665 }\r
666\r
667 InsertTailList (&IpSb->Interfaces, &IpIf->Link);\r
668 }\r
669\r
670 //\r
671 // Add a route to this connected network in the route table\r
672 //\r
673 Ip4AddRoute (IpInstance->RouteTable, Ip, Netmask, IP4_ALLZERO_ADDRESS);\r
674\r
675 } else {\r
676 //\r
677 // Use the default address. If the default configuration hasn't\r
678 // been started, start it.\r
679 //\r
680 if (IpSb->State == IP4_SERVICE_UNSTARTED) {\r
681 Status = EFI_NO_MAPPING;\r
682 goto ON_ERROR;\r
683 }\r
684\r
685 IpIf = IpSb->DefaultInterface;\r
686 NET_GET_REF (IpSb->DefaultInterface);\r
687\r
688 //\r
689 // If default address is used, so is the default route table.\r
690 // Any route set by the instance has the precedence over the\r
691 // routes in the default route table. Link the default table\r
692 // after the instance's table. Routing will search the local\r
693 // table first.\r
694 //\r
695 NET_GET_REF (IpSb->DefaultRouteTable);\r
696 IpInstance->RouteTable->Next = IpSb->DefaultRouteTable;\r
697 }\r
698\r
699 IpInstance->Interface = IpIf;\r
700 if (IpIf->Arp != NULL) {\r
701 Arp = NULL;\r
702 Status = gBS->OpenProtocol (\r
703 IpIf->ArpHandle,\r
704 &gEfiArpProtocolGuid,\r
705 (VOID **) &Arp,\r
706 gIp4DriverBinding.DriverBindingHandle,\r
707 IpInstance->Handle,\r
708 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
709 );\r
710 if (EFI_ERROR (Status)) {\r
711 goto ON_ERROR;\r
712 }\r
713 }\r
714 InsertTailList (&IpIf->IpInstances, &IpInstance->AddrLink);\r
715\r
716 CopyMem (&IpInstance->ConfigData, Config, sizeof (IpInstance->ConfigData));\r
717 IpInstance->State = IP4_STATE_CONFIGED;\r
718\r
719 //\r
720 // Although EFI_NO_MAPPING is an error code, the IP child has been\r
721 // successfully configured and doesn't need reconfiguration when\r
722 // default address is acquired.\r
723 //\r
724 if (Config->UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) {\r
725 return EFI_NO_MAPPING;\r
726 }\r
727\r
728 return EFI_SUCCESS;\r
729\r
730ON_ERROR:\r
731 Ip4FreeRouteTable (IpInstance->RouteTable);\r
732 IpInstance->RouteTable = NULL;\r
733 return Status;\r
734}\r
735\r
736\r
737/**\r
738 Clean up the IP4 child, release all the resources used by it.\r
739\r
740 @param[in] IpInstance The IP4 child to clean up.\r
741\r
742 @retval EFI_SUCCESS The IP4 child is cleaned up.\r
743 @retval EFI_DEVICE_ERROR Some resources failed to be released.\r
744\r
745**/\r
746EFI_STATUS\r
747Ip4CleanProtocol (\r
748 IN IP4_PROTOCOL *IpInstance\r
749 )\r
750{\r
751 if (EFI_ERROR (Ip4Cancel (IpInstance, NULL))) {\r
752 return EFI_DEVICE_ERROR;\r
753 }\r
754\r
755 if (EFI_ERROR (Ip4Groups (IpInstance, FALSE, NULL))) {\r
756 return EFI_DEVICE_ERROR;\r
757 }\r
758\r
759 //\r
760 // Some packets haven't been recycled. It is because either the\r
761 // user forgets to recycle the packets, or because the callback\r
762 // hasn't been called. Just leave it alone.\r
763 //\r
764 if (!IsListEmpty (&IpInstance->Delivered)) {\r
765 ;\r
766 }\r
767\r
768 if (IpInstance->Interface != NULL) {\r
769 RemoveEntryList (&IpInstance->AddrLink);\r
770 if (IpInstance->Interface->Arp != NULL) {\r
771 gBS->CloseProtocol (\r
772 IpInstance->Interface->ArpHandle,\r
773 &gEfiArpProtocolGuid,\r
774 gIp4DriverBinding.DriverBindingHandle,\r
775 IpInstance->Handle\r
776 );\r
777 }\r
778 Ip4FreeInterface (IpInstance->Interface, IpInstance);\r
779 IpInstance->Interface = NULL;\r
780 }\r
781\r
782 if (IpInstance->RouteTable != NULL) {\r
783 if (IpInstance->RouteTable->Next != NULL) {\r
784 Ip4FreeRouteTable (IpInstance->RouteTable->Next);\r
785 }\r
786\r
787 Ip4FreeRouteTable (IpInstance->RouteTable);\r
788 IpInstance->RouteTable = NULL;\r
789 }\r
790\r
791 if (IpInstance->EfiRouteTable != NULL) {\r
792 FreePool (IpInstance->EfiRouteTable);\r
793 IpInstance->EfiRouteTable = NULL;\r
794 IpInstance->EfiRouteCount = 0;\r
795 }\r
796\r
797 if (IpInstance->Groups != NULL) {\r
798 FreePool (IpInstance->Groups);\r
799 IpInstance->Groups = NULL;\r
800 IpInstance->GroupCount = 0;\r
801 }\r
802\r
803 NetMapClean (&IpInstance->TxTokens);\r
804\r
805 NetMapClean (&IpInstance->RxTokens);\r
806\r
807 return EFI_SUCCESS;\r
808}\r
809\r
810\r
811/**\r
812 Validate that Ip/Netmask pair is OK to be used as station\r
813 address. Only continuous netmasks are supported. and check\r
814 that StationAddress is a unicast address on the newtwork.\r
815\r
816 @param[in] Ip The IP address to validate.\r
817 @param[in] Netmask The netmaks of the IP.\r
818\r
819 @retval TRUE The Ip/Netmask pair is valid.\r
820 @retval FALSE The Ip/Netmask pair is invalid.\r
821\r
822**/\r
823BOOLEAN\r
824Ip4StationAddressValid (\r
825 IN IP4_ADDR Ip,\r
826 IN IP4_ADDR Netmask\r
827 )\r
828{\r
829 IP4_ADDR NetBrdcastMask;\r
830 INTN Len;\r
831 INTN Type;\r
832\r
833 //\r
834 // Only support the station address with 0.0.0.0/0 to enable DHCP client.\r
835 //\r
836 if (Netmask == IP4_ALLZERO_ADDRESS) {\r
837 return (BOOLEAN) (Ip == IP4_ALLZERO_ADDRESS);\r
838 }\r
839\r
840 //\r
841 // Only support the continuous net masks\r
842 //\r
843 if ((Len = NetGetMaskLength (Netmask)) == IP4_MASK_NUM) {\r
844 return FALSE;\r
845 }\r
846\r
847 //\r
848 // Station address can't be class D or class E address\r
849 //\r
850 if ((Type = NetGetIpClass (Ip)) > IP4_ADDR_CLASSC) {\r
851 return FALSE;\r
852 }\r
853\r
854 //\r
855 // Station address can't be subnet broadcast/net broadcast address\r
856 //\r
857 if ((Ip == (Ip & Netmask)) || (Ip == (Ip | ~Netmask))) {\r
858 return FALSE;\r
859 }\r
860\r
861 NetBrdcastMask = gIp4AllMasks[MIN (Len, Type << 3)];\r
862\r
863 if (Ip == (Ip | ~NetBrdcastMask)) {\r
864 return FALSE;\r
865 }\r
866\r
867 return TRUE;\r
868}\r
869\r
870\r
871/**\r
872 Assigns an IPv4 address and subnet mask to this EFI IPv4 Protocol driver instance.\r
873\r
874 The Configure() function is used to set, change, or reset the operational\r
875 parameters and filter settings for this EFI IPv4 Protocol instance. Until these\r
876 parameters have been set, no network traffic can be sent or received by this\r
877 instance. Once the parameters have been reset (by calling this function with\r
878 IpConfigData set to NULL), no more traffic can be sent or received until these\r
879 parameters have been set again. Each EFI IPv4 Protocol instance can be started\r
880 and stopped independently of each other by enabling or disabling their receive\r
881 filter settings with the Configure() function.\r
882\r
883 When IpConfigData.UseDefaultAddress is set to FALSE, the new station address will\r
884 be appended as an alias address into the addresses list in the EFI IPv4 Protocol\r
885 driver. While set to TRUE, Configure() will trigger the EFI_IP4_CONFIG_PROTOCOL\r
886 to retrieve the default IPv4 address if it is not available yet. Clients could\r
887 frequently call GetModeData() to check the status to ensure that the default IPv4\r
888 address is ready.\r
889\r
890 If operational parameters are reset or changed, any pending transmit and receive\r
891 requests will be cancelled. Their completion token status will be set to EFI_ABORTED\r
892 and their events will be signaled.\r
893\r
894 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
895 @param[in] IpConfigData Pointer to the EFI IPv4 Protocol configuration data structure.\r
896\r
897 @retval EFI_SUCCESS The driver instance was successfully opened.\r
898 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
899 RARP, etc.) is not finished yet.\r
900 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
901 @retval EFI_UNSUPPORTED One or more of the following conditions is TRUE:\r
902 A configuration protocol (DHCP, BOOTP, RARP, etc.) could\r
903 not be located when clients choose to use the default IPv4\r
904 address. This EFI IPv4 Protocol implementation does not\r
905 support this requested filter or timeout setting.\r
906 @retval EFI_OUT_OF_RESOURCES The EFI IPv4 Protocol driver instance data could not be allocated.\r
907 @retval EFI_ALREADY_STARTED The interface is already open and must be stopped before the\r
908 IPv4 address or subnet mask can be changed. The interface must\r
909 also be stopped when switching to/from raw packet mode.\r
910 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI IPv4\r
911 Protocol driver instance is not opened.\r
912\r
913**/\r
914EFI_STATUS\r
915EFIAPI\r
916EfiIp4Configure (\r
917 IN EFI_IP4_PROTOCOL *This,\r
918 IN EFI_IP4_CONFIG_DATA *IpConfigData OPTIONAL\r
919 )\r
920{\r
921 IP4_PROTOCOL *IpInstance;\r
922 EFI_IP4_CONFIG_DATA *Current;\r
923 EFI_TPL OldTpl;\r
924 EFI_STATUS Status;\r
925 BOOLEAN AddrOk;\r
926 IP4_ADDR IpAddress;\r
927 IP4_ADDR SubnetMask;\r
928\r
929 //\r
930 // First, validate the parameters\r
931 //\r
932 if (This == NULL) {\r
933 return EFI_INVALID_PARAMETER;\r
934 }\r
935\r
936 IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r
937 OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
938\r
939 //\r
940 // Validate the configuration first.\r
941 //\r
942 if (IpConfigData != NULL) {\r
943\r
944 CopyMem (&IpAddress, &IpConfigData->StationAddress, sizeof (IP4_ADDR));\r
945 CopyMem (&SubnetMask, &IpConfigData->SubnetMask, sizeof (IP4_ADDR));\r
946\r
947 IpAddress = NTOHL (IpAddress);\r
948 SubnetMask = NTOHL (SubnetMask);\r
949\r
950 //\r
951 // Check whether the station address is a valid unicast address\r
952 //\r
953 if (!IpConfigData->UseDefaultAddress) {\r
954 AddrOk = Ip4StationAddressValid (IpAddress, SubnetMask);\r
955\r
956 if (!AddrOk) {\r
957 Status = EFI_INVALID_PARAMETER;\r
958 goto ON_EXIT;\r
959 }\r
960 }\r
961\r
962 //\r
963 // User can only update packet filters when already configured.\r
964 // If it wants to change the station address, it must configure(NULL)\r
965 // the instance first.\r
966 //\r
967 if (IpInstance->State == IP4_STATE_CONFIGED) {\r
968 Current = &IpInstance->ConfigData;\r
969\r
970 if (Current->UseDefaultAddress != IpConfigData->UseDefaultAddress) {\r
971 Status = EFI_ALREADY_STARTED;\r
972 goto ON_EXIT;\r
973 }\r
974\r
975 if (!Current->UseDefaultAddress &&\r
976 (!EFI_IP4_EQUAL (&Current->StationAddress, &IpConfigData->StationAddress) ||\r
977 !EFI_IP4_EQUAL (&Current->SubnetMask, &IpConfigData->SubnetMask))) {\r
978 Status = EFI_ALREADY_STARTED;\r
979 goto ON_EXIT;\r
980 }\r
981\r
982 if (Current->UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) {\r
983 Status = EFI_NO_MAPPING;\r
984 goto ON_EXIT;\r
985 }\r
986 }\r
987 }\r
988\r
989 //\r
990 // Configure the instance or clean it up.\r
991 //\r
992 if (IpConfigData != NULL) {\r
993 Status = Ip4ConfigProtocol (IpInstance, IpConfigData);\r
994 } else {\r
995 Status = Ip4CleanProtocol (IpInstance);\r
996\r
997 //\r
998 // Don't change the state if it is DESTROY, consider the following\r
999 // valid sequence: Mnp is unloaded-->Ip Stopped-->Udp Stopped,\r
1000 // Configure (ThisIp, NULL). If the state is changed to UNCONFIGED,\r
1001 // the unload fails miserably.\r
1002 //\r
1003 if (IpInstance->State == IP4_STATE_CONFIGED) {\r
1004 IpInstance->State = IP4_STATE_UNCONFIGED;\r
1005 }\r
1006 }\r
1007\r
1008 //\r
1009 // Update the MNP's configure data. Ip4ServiceConfigMnp will check\r
1010 // whether it is necessary to reconfigure the MNP.\r
1011 //\r
1012 Ip4ServiceConfigMnp (IpInstance->Service, FALSE);\r
1013\r
1014ON_EXIT:\r
1015 gBS->RestoreTPL (OldTpl);\r
1016 return Status;\r
1017\r
1018}\r
1019\r
1020\r
1021/**\r
1022 Change the IP4 child's multicast setting. The caller\r
1023 should make sure that the parameters is valid.\r
1024\r
1025 @param[in] IpInstance The IP4 child to change the setting.\r
1026 @param[in] JoinFlag TRUE to join the group, otherwise leave it.\r
1027 @param[in] GroupAddress The target group address.\r
1028\r
1029 @retval EFI_ALREADY_STARTED Want to join the group, but already a member of it.\r
1030 @retval EFI_OUT_OF_RESOURCES Failed to allocate some resources.\r
1031 @retval EFI_DEVICE_ERROR Failed to set the group configuraton.\r
1032 @retval EFI_SUCCESS Successfully updated the group setting.\r
1033 @retval EFI_NOT_FOUND Try to leave the group which it isn't a member.\r
1034\r
1035**/\r
1036EFI_STATUS\r
1037Ip4Groups (\r
1038 IN IP4_PROTOCOL *IpInstance,\r
1039 IN BOOLEAN JoinFlag,\r
1040 IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL\r
1041 )\r
1042{\r
1043 IP4_ADDR *Members;\r
1044 IP4_ADDR Group;\r
1045 UINT32 Index;\r
1046\r
1047 //\r
1048 // Add it to the instance's Groups, and join the group by IGMP.\r
1049 // IpInstance->Groups is in network byte order. IGMP operates in\r
1050 // host byte order\r
1051 //\r
1052 if (JoinFlag) {\r
1053 //\r
1054 // When JoinFlag is TRUE, GroupAddress shouldn't be NULL.\r
1055 //\r
1056 ASSERT (GroupAddress != NULL);\r
1057 CopyMem (&Group, GroupAddress, sizeof (IP4_ADDR));\r
1058\r
1059 for (Index = 0; Index < IpInstance->GroupCount; Index++) {\r
1060 if (IpInstance->Groups[Index] == Group) {\r
1061 return EFI_ALREADY_STARTED;\r
1062 }\r
1063 }\r
1064\r
1065 Members = Ip4CombineGroups (IpInstance->Groups, IpInstance->GroupCount, Group);\r
1066\r
1067 if (Members == NULL) {\r
1068 return EFI_OUT_OF_RESOURCES;\r
1069 }\r
1070\r
1071 if (EFI_ERROR (Ip4JoinGroup (IpInstance, NTOHL (Group)))) {\r
1072 FreePool (Members);\r
1073 return EFI_DEVICE_ERROR;\r
1074 }\r
1075\r
1076 if (IpInstance->Groups != NULL) {\r
1077 FreePool (IpInstance->Groups);\r
1078 }\r
1079\r
1080 IpInstance->Groups = Members;\r
1081 IpInstance->GroupCount++;\r
1082\r
1083 return EFI_SUCCESS;\r
1084 }\r
1085\r
1086 //\r
1087 // Leave the group. Leave all the groups if GroupAddress is NULL.\r
1088 // Must iterate from the end to the beginning because the GroupCount\r
1089 // is decreamented each time an address is removed..\r
1090 //\r
1091 for (Index = IpInstance->GroupCount; Index > 0 ; Index--) {\r
1092 Group = IpInstance->Groups[Index - 1];\r
1093\r
1094 if ((GroupAddress == NULL) || EFI_IP4_EQUAL (&Group, GroupAddress)) {\r
1095 if (EFI_ERROR (Ip4LeaveGroup (IpInstance, NTOHL (Group)))) {\r
1096 return EFI_DEVICE_ERROR;\r
1097 }\r
1098\r
1099 Ip4RemoveGroupAddr (IpInstance->Groups, IpInstance->GroupCount, Group);\r
1100 IpInstance->GroupCount--;\r
1101\r
1102 if (IpInstance->GroupCount == 0) {\r
1103 ASSERT (Index == 1);\r
1104\r
1105 FreePool (IpInstance->Groups);\r
1106 IpInstance->Groups = NULL;\r
1107 }\r
1108\r
1109 if (GroupAddress != NULL) {\r
1110 return EFI_SUCCESS;\r
1111 }\r
1112 }\r
1113 }\r
1114\r
1115 return ((GroupAddress != NULL) ? EFI_NOT_FOUND : EFI_SUCCESS);\r
1116}\r
1117\r
1118\r
1119/**\r
1120 Joins and leaves multicast groups.\r
1121\r
1122 The Groups() function is used to join and leave multicast group sessions. Joining\r
1123 a group will enable reception of matching multicast packets. Leaving a group will\r
1124 disable the multicast packet reception.\r
1125\r
1126 If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left.\r
1127\r
1128 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
1129 @param[in] JoinFlag Set to TRUE to join the multicast group session and FALSE to leave.\r
1130 @param[in] GroupAddress Pointer to the IPv4 multicast address.\r
1131\r
1132 @retval EFI_SUCCESS The operation completed successfully.\r
1133 @retval EFI_INVALID_PARAMETER One or more of the following is TRUE:\r
1134 - This is NULL.\r
1135 - JoinFlag is TRUE and GroupAddress is NULL.\r
1136 - GroupAddress is not NULL and *GroupAddress is\r
1137 not a multicast IPv4 address.\r
1138 @retval EFI_NOT_STARTED This instance has not been started.\r
1139 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
1140 RARP, etc.) is not finished yet.\r
1141 @retval EFI_OUT_OF_RESOURCES System resources could not be allocated.\r
1142 @retval EFI_UNSUPPORTED This EFI IPv4 Protocol implementation does not support multicast groups.\r
1143 @retval EFI_ALREADY_STARTED The group address is already in the group table (when\r
1144 JoinFlag is TRUE).\r
1145 @retval EFI_NOT_FOUND The group address is not in the group table (when JoinFlag is FALSE).\r
1146 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
1147\r
1148**/\r
1149EFI_STATUS\r
1150EFIAPI\r
1151EfiIp4Groups (\r
1152 IN EFI_IP4_PROTOCOL *This,\r
1153 IN BOOLEAN JoinFlag,\r
1154 IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL\r
1155 )\r
1156{\r
1157 IP4_PROTOCOL *IpInstance;\r
1158 EFI_STATUS Status;\r
1159 EFI_TPL OldTpl;\r
1160 IP4_ADDR McastIp;\r
1161\r
1162 if ((This == NULL) || (JoinFlag && (GroupAddress == NULL))) {\r
1163 return EFI_INVALID_PARAMETER;\r
1164 }\r
1165\r
1166 if (GroupAddress != NULL) {\r
1167 CopyMem (&McastIp, GroupAddress, sizeof (IP4_ADDR));\r
1168\r
1169 if (!IP4_IS_MULTICAST (NTOHL (McastIp))) {\r
1170 return EFI_INVALID_PARAMETER;\r
1171 }\r
1172 }\r
1173\r
1174 IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r
1175 OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
1176\r
1177 if (IpInstance->State != IP4_STATE_CONFIGED) {\r
1178 Status = EFI_NOT_STARTED;\r
1179 goto ON_EXIT;\r
1180 }\r
1181\r
1182 if (IpInstance->ConfigData.UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) {\r
1183 Status = EFI_NO_MAPPING;\r
1184 goto ON_EXIT;\r
1185 }\r
1186\r
1187 Status = Ip4Groups (IpInstance, JoinFlag, GroupAddress);\r
1188\r
1189ON_EXIT:\r
1190 gBS->RestoreTPL (OldTpl);\r
1191 return Status;\r
1192}\r
1193\r
1194\r
1195/**\r
1196 Adds and deletes routing table entries.\r
1197\r
1198 The Routes() function adds a route to or deletes a route from the routing table.\r
1199\r
1200 Routes are determined by comparing the SubnetAddress with the destination IPv4\r
1201 address arithmetically AND-ed with the SubnetMask. The gateway address must be\r
1202 on the same subnet as the configured station address.\r
1203\r
1204 The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0.\r
1205 The default route matches all destination IPv4 addresses that do not match any\r
1206 other routes.\r
1207\r
1208 A GatewayAddress that is zero is a nonroute. Packets are sent to the destination\r
1209 IP address if it can be found in the ARP cache or on the local subnet. One automatic\r
1210 nonroute entry will be inserted into the routing table for outgoing packets that\r
1211 are addressed to a local subnet (gateway address of 0.0.0.0).\r
1212\r
1213 Each EFI IPv4 Protocol instance has its own independent routing table. Those EFI\r
1214 IPv4 Protocol instances that use the default IPv4 address will also have copies\r
1215 of the routing table that was provided by the EFI_IP4_CONFIG_PROTOCOL, and these\r
1216 copies will be updated whenever the EIF IPv4 Protocol driver reconfigures its\r
1217 instances. As a result, client modification to the routing table will be lost.\r
1218\r
1219 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
1220 @param[in] DeleteRoute Set to TRUE to delete this route from the routing table. Set to\r
1221 FALSE to add this route to the routing table. SubnetAddress\r
1222 and SubnetMask are used as the key to each route entry.\r
1223 @param[in] SubnetAddress The address of the subnet that needs to be routed.\r
1224 @param[in] SubnetMask The subnet mask of SubnetAddress.\r
1225 @param[in] GatewayAddress The unicast gateway IPv4 address for this route.\r
1226\r
1227 @retval EFI_SUCCESS The operation completed successfully.\r
1228 @retval EFI_NOT_STARTED The driver instance has not been started.\r
1229 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
1230 RARP, etc.) is not finished yet.\r
1231 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
1232 - This is NULL.\r
1233 - SubnetAddress is NULL.\r
1234 - SubnetMask is NULL.\r
1235 - GatewayAddress is NULL.\r
1236 - *SubnetAddress is not a valid subnet address.\r
1237 - *SubnetMask is not a valid subnet mask.\r
1238 - *GatewayAddress is not a valid unicast IPv4 address.\r
1239 @retval EFI_OUT_OF_RESOURCES Could not add the entry to the routing table.\r
1240 @retval EFI_NOT_FOUND This route is not in the routing table (when DeleteRoute is TRUE).\r
1241 @retval EFI_ACCESS_DENIED The route is already defined in the routing table (when\r
1242 DeleteRoute is FALSE).\r
1243\r
1244**/\r
1245EFI_STATUS\r
1246EFIAPI\r
1247EfiIp4Routes (\r
1248 IN EFI_IP4_PROTOCOL *This,\r
1249 IN BOOLEAN DeleteRoute,\r
1250 IN EFI_IPv4_ADDRESS *SubnetAddress,\r
1251 IN EFI_IPv4_ADDRESS *SubnetMask,\r
1252 IN EFI_IPv4_ADDRESS *GatewayAddress\r
1253 )\r
1254{\r
1255 IP4_PROTOCOL *IpInstance;\r
1256 IP4_INTERFACE *IpIf;\r
1257 IP4_ADDR Dest;\r
1258 IP4_ADDR Netmask;\r
1259 IP4_ADDR Nexthop;\r
1260 EFI_STATUS Status;\r
1261 EFI_TPL OldTpl;\r
1262\r
1263 //\r
1264 // First, validate the parameters\r
1265 //\r
1266 if ((This == NULL) || (SubnetAddress == NULL) ||\r
1267 (SubnetMask == NULL) || (GatewayAddress == NULL)) {\r
1268 return EFI_INVALID_PARAMETER;\r
1269 }\r
1270\r
1271 IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r
1272 OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
1273\r
1274 if (IpInstance->State != IP4_STATE_CONFIGED) {\r
1275 Status = EFI_NOT_STARTED;\r
1276 goto ON_EXIT;\r
1277 }\r
1278\r
1279 if (IpInstance->ConfigData.UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) {\r
1280 Status = EFI_NO_MAPPING;\r
1281 goto ON_EXIT;\r
1282 }\r
1283\r
1284 CopyMem (&Dest, SubnetAddress, sizeof (IP4_ADDR));\r
1285 CopyMem (&Netmask, SubnetMask, sizeof (IP4_ADDR));\r
1286 CopyMem (&Nexthop, GatewayAddress, sizeof (IP4_ADDR));\r
1287\r
1288 Dest = NTOHL (Dest);\r
1289 Netmask = NTOHL (Netmask);\r
1290 Nexthop = NTOHL (Nexthop);\r
1291\r
1292 IpIf = IpInstance->Interface;\r
1293\r
1294 if (!IP4_IS_VALID_NETMASK (Netmask)) {\r
1295 Status = EFI_INVALID_PARAMETER;\r
1296 goto ON_EXIT;\r
1297 }\r
1298\r
1299 //\r
1300 // the gateway address must be a unicast on the connected network if not zero.\r
1301 //\r
1302 if ((Nexthop != IP4_ALLZERO_ADDRESS) &&\r
1303 (!IP4_NET_EQUAL (Nexthop, IpIf->Ip, IpIf->SubnetMask) ||\r
1304 IP4_IS_BROADCAST (Ip4GetNetCast (Nexthop, IpIf)))) {\r
1305\r
1306 Status = EFI_INVALID_PARAMETER;\r
1307 goto ON_EXIT;\r
1308 }\r
1309\r
1310 if (DeleteRoute) {\r
1311 Status = Ip4DelRoute (IpInstance->RouteTable, Dest, Netmask, Nexthop);\r
1312 } else {\r
1313 Status = Ip4AddRoute (IpInstance->RouteTable, Dest, Netmask, Nexthop);\r
1314 }\r
1315\r
1316ON_EXIT:\r
1317 gBS->RestoreTPL (OldTpl);\r
1318 return Status;\r
1319}\r
1320\r
1321\r
1322/**\r
1323 Check whether the user's token or event has already\r
1324 been enqueued on IP4's list.\r
1325\r
1326 @param[in] Map The container of either user's transmit or receive\r
1327 token.\r
1328 @param[in] Item Current item to check against.\r
1329 @param[in] Context The Token to check againist.\r
1330\r
1331 @retval EFI_ACCESS_DENIED The token or event has already been enqueued in IP.\r
1332 @retval EFI_SUCCESS The current item isn't the same token/event as the\r
1333 context.\r
1334\r
1335**/\r
1336EFI_STATUS\r
1337EFIAPI\r
1338Ip4TokenExist (\r
1339 IN NET_MAP *Map,\r
1340 IN NET_MAP_ITEM *Item,\r
1341 IN VOID *Context\r
1342 )\r
1343{\r
1344 EFI_IP4_COMPLETION_TOKEN *Token;\r
1345 EFI_IP4_COMPLETION_TOKEN *TokenInItem;\r
1346\r
1347 Token = (EFI_IP4_COMPLETION_TOKEN *) Context;\r
1348 TokenInItem = (EFI_IP4_COMPLETION_TOKEN *) Item->Key;\r
1349\r
1350 if ((Token == TokenInItem) || (Token->Event == TokenInItem->Event)) {\r
1351 return EFI_ACCESS_DENIED;\r
1352 }\r
1353\r
1354 return EFI_SUCCESS;\r
1355}\r
1356\r
1357/**\r
1358 Validate the user's token against current station address.\r
1359\r
1360 @param[in] Token User's token to validate.\r
1361 @param[in] IpIf The IP4 child's interface.\r
1362 @param[in] RawData Set to TRUE to send unformatted packets.\r
1363\r
1364 @retval EFI_INVALID_PARAMETER Some parameters are invalid.\r
1365 @retval EFI_BAD_BUFFER_SIZE The user's option/data is too long.\r
1366 @retval EFI_SUCCESS The token is valid.\r
1367\r
1368**/\r
1369EFI_STATUS\r
1370Ip4TxTokenValid (\r
1371 IN EFI_IP4_COMPLETION_TOKEN *Token,\r
1372 IN IP4_INTERFACE *IpIf,\r
1373 IN BOOLEAN RawData\r
1374 )\r
1375{\r
1376 EFI_IP4_TRANSMIT_DATA *TxData;\r
1377 EFI_IP4_OVERRIDE_DATA *Override;\r
1378 IP4_ADDR Src;\r
1379 IP4_ADDR Gateway;\r
1380 UINT32 Offset;\r
1381 UINT32 Index;\r
1382 UINT32 HeadLen;\r
1383\r
1384 if ((Token == NULL) || (Token->Event == NULL) || (Token->Packet.TxData == NULL)) {\r
1385 return EFI_INVALID_PARAMETER;\r
1386 }\r
1387\r
1388 TxData = Token->Packet.TxData;\r
1389\r
1390 //\r
1391 // Check the fragment table: no empty fragment, and length isn't bogus.\r
1392 //\r
1393 if ((TxData->TotalDataLength == 0) || (TxData->FragmentCount == 0)) {\r
1394 return EFI_INVALID_PARAMETER;\r
1395 }\r
1396\r
1397 Offset = TxData->TotalDataLength;\r
1398\r
1399 if (Offset > IP4_MAX_PACKET_SIZE) {\r
1400 return EFI_BAD_BUFFER_SIZE;\r
1401 }\r
1402\r
1403 for (Index = 0; Index < TxData->FragmentCount; Index++) {\r
1404 if ((TxData->FragmentTable[Index].FragmentBuffer == NULL) ||\r
1405 (TxData->FragmentTable[Index].FragmentLength == 0)) {\r
1406\r
1407 return EFI_INVALID_PARAMETER;\r
1408 }\r
1409\r
1410 Offset -= TxData->FragmentTable[Index].FragmentLength;\r
1411 }\r
1412\r
1413 if (Offset != 0) {\r
1414 return EFI_INVALID_PARAMETER;\r
1415 }\r
1416\r
1417 //\r
1418 // NOTE that OptionsLength/OptionsBuffer/OverrideData are ignored if RawData\r
1419 // is TRUE.\r
1420 //\r
1421 if (RawData) {\r
1422 return EFI_SUCCESS;\r
1423 }\r
1424\r
1425 //\r
1426 // Check the IP options: no more than 40 bytes and format is OK\r
1427 //\r
1428 if (TxData->OptionsLength != 0) {\r
1429 if ((TxData->OptionsLength > 40) || (TxData->OptionsBuffer == NULL)) {\r
1430 return EFI_INVALID_PARAMETER;\r
1431 }\r
1432\r
1433 if (!Ip4OptionIsValid (TxData->OptionsBuffer, TxData->OptionsLength, FALSE)) {\r
1434 return EFI_INVALID_PARAMETER;\r
1435 }\r
1436 }\r
1437\r
1438 //\r
1439 // Check the source and gateway: they must be a valid unicast.\r
1440 // Gateway must also be on the connected network.\r
1441 //\r
1442 if (TxData->OverrideData != NULL) {\r
1443 Override = TxData->OverrideData;\r
1444\r
1445 CopyMem (&Src, &Override->SourceAddress, sizeof (IP4_ADDR));\r
1446 CopyMem (&Gateway, &Override->GatewayAddress, sizeof (IP4_ADDR));\r
1447\r
1448 Src = NTOHL (Src);\r
1449 Gateway = NTOHL (Gateway);\r
1450\r
1451 if ((NetGetIpClass (Src) > IP4_ADDR_CLASSC) ||\r
1452 (Src == IP4_ALLONE_ADDRESS) ||\r
1453 IP4_IS_BROADCAST (Ip4GetNetCast (Src, IpIf))) {\r
1454\r
1455 return EFI_INVALID_PARAMETER;\r
1456 }\r
1457\r
1458 //\r
1459 // If gateway isn't zero, it must be a unicast address, and\r
1460 // on the connected network.\r
1461 //\r
1462 if ((Gateway != IP4_ALLZERO_ADDRESS) &&\r
1463 ((NetGetIpClass (Gateway) > IP4_ADDR_CLASSC) ||\r
1464 !IP4_NET_EQUAL (Gateway, IpIf->Ip, IpIf->SubnetMask) ||\r
1465 IP4_IS_BROADCAST (Ip4GetNetCast (Gateway, IpIf)))) {\r
1466\r
1467 return EFI_INVALID_PARAMETER;\r
1468 }\r
1469 }\r
1470\r
1471 //\r
1472 // Check the packet length: Head length and packet length all has a limit\r
1473 //\r
1474 HeadLen = sizeof (IP4_HEAD) + ((TxData->OptionsLength + 3) &~0x03);\r
1475\r
1476 if ((HeadLen > IP4_MAX_HEADLEN) ||\r
1477 (TxData->TotalDataLength + HeadLen > IP4_MAX_PACKET_SIZE)) {\r
1478\r
1479 return EFI_BAD_BUFFER_SIZE;\r
1480 }\r
1481\r
1482 return EFI_SUCCESS;\r
1483}\r
1484\r
1485\r
1486/**\r
1487 The callback function for the net buffer which wraps the user's\r
1488 transmit token. Although it seems this function is pretty simple,\r
1489 there are some subtle things.\r
1490 When user requests the IP to transmit a packet by passing it a\r
1491 token, the token is wrapped in an IP4_TXTOKEN_WRAP and the data\r
1492 is wrapped in an net buffer. the net buffer's Free function is\r
1493 set to Ip4FreeTxToken. The Token and token wrap are added to the\r
1494 IP child's TxToken map. Then the buffer is passed to Ip4Output for\r
1495 transmission. If something error happened before that, the buffer\r
1496 is freed, which in turn will free the token wrap. The wrap may\r
1497 have been added to the TxToken map or not, and the user's event\r
1498 shouldn't be fired because we are still in the EfiIp4Transmit. If\r
1499 the buffer has been sent by Ip4Output, it should be removed from\r
1500 the TxToken map and user's event signaled. The token wrap and buffer\r
1501 are bound together. Check the comments in Ip4Output for information\r
1502 about IP fragmentation.\r
1503\r
1504 @param[in] Context The token's wrap.\r
1505\r
1506**/\r
1507VOID\r
1508EFIAPI\r
1509Ip4FreeTxToken (\r
1510 IN VOID *Context\r
1511 )\r
1512{\r
1513 IP4_TXTOKEN_WRAP *Wrap;\r
1514 NET_MAP_ITEM *Item;\r
1515\r
1516 Wrap = (IP4_TXTOKEN_WRAP *) Context;\r
1517\r
1518 //\r
1519 // Signal IpSecRecycleEvent to inform IPsec free the memory\r
1520 //\r
1521 if (Wrap->IpSecRecycleSignal != NULL) {\r
1522 gBS->SignalEvent (Wrap->IpSecRecycleSignal);\r
1523 }\r
1524\r
1525 //\r
1526 // Find the token in the instance's map. EfiIp4Transmit put the\r
1527 // token to the map. If that failed, NetMapFindKey will return NULL.\r
1528 //\r
1529 Item = NetMapFindKey (&Wrap->IpInstance->TxTokens, Wrap->Token);\r
1530\r
1531 if (Item != NULL) {\r
1532 NetMapRemoveItem (&Wrap->IpInstance->TxTokens, Item, NULL);\r
1533 }\r
1534\r
1535 if (Wrap->Sent) {\r
1536 gBS->SignalEvent (Wrap->Token->Event);\r
1537\r
1538 //\r
1539 // Dispatch the DPC queued by the NotifyFunction of Token->Event.\r
1540 //\r
1541 DispatchDpc ();\r
1542 }\r
1543\r
1544 FreePool (Wrap);\r
1545}\r
1546\r
1547\r
1548/**\r
1549 The callback function to Ip4Output to update the transmit status.\r
1550\r
1551 @param Ip4Instance The Ip4Instance that request the transmit.\r
1552 @param Packet The user's transmit request.\r
1553 @param IoStatus The result of the transmission.\r
1554 @param Flag Not used during transmission.\r
1555 @param Context The token's wrap.\r
1556\r
1557**/\r
1558VOID\r
1559Ip4OnPacketSent (\r
1560 IP4_PROTOCOL *Ip4Instance,\r
1561 NET_BUF *Packet,\r
1562 EFI_STATUS IoStatus,\r
1563 UINT32 Flag,\r
1564 VOID *Context\r
1565 )\r
1566{\r
1567 IP4_TXTOKEN_WRAP *Wrap;\r
1568\r
1569 //\r
1570 // This is the transmission request from upper layer,\r
1571 // not the IP4 driver itself.\r
1572 //\r
1573 ASSERT (Ip4Instance != NULL);\r
1574\r
1575 //\r
1576 // The first fragment of the packet has been sent. Update\r
1577 // the token's status. That is, if fragmented, the transmit's\r
1578 // status is the first fragment's status. The Wrap will be\r
1579 // release when all the fragments are release. Check the comments\r
1580 // in Ip4FreeTxToken and Ip4Output for information.\r
1581 //\r
1582 Wrap = (IP4_TXTOKEN_WRAP *) Context;\r
1583 Wrap->Token->Status = IoStatus;\r
1584\r
1585 NetbufFree (Wrap->Packet);\r
1586}\r
1587\r
1588\r
1589/**\r
1590 Places outgoing data packets into the transmit queue.\r
1591\r
1592 The Transmit() function places a sending request in the transmit queue of this\r
1593 EFI IPv4 Protocol instance. Whenever the packet in the token is sent out or some\r
1594 errors occur, the event in the token will be signaled and the status is updated.\r
1595\r
1596 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
1597 @param[in] Token Pointer to the transmit token.\r
1598\r
1599 @retval EFI_SUCCESS The data has been queued for transmission.\r
1600 @retval EFI_NOT_STARTED This instance has not been started.\r
1601 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
1602 RARP, etc.) is not finished yet.\r
1603 @retval EFI_INVALID_PARAMETER One or more pameters are invalid.\r
1604 @retval EFI_ACCESS_DENIED The transmit completion token with the same Token.Event\r
1605 was already in the transmit queue.\r
1606 @retval EFI_NOT_READY The completion token could not be queued because the transmit\r
1607 queue is full.\r
1608 @retval EFI_NOT_FOUND Not route is found to destination address.\r
1609 @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data.\r
1610 @retval EFI_BUFFER_TOO_SMALL Token.Packet.TxData.TotalDataLength is too\r
1611 short to transmit.\r
1612 @retval EFI_BAD_BUFFER_SIZE The length of the IPv4 header + option length + total data length is\r
1613 greater than MTU (or greater than the maximum packet size if\r
1614 Token.Packet.TxData.OverrideData.\r
1615 DoNotFragment is TRUE).\r
1616\r
1617**/\r
1618EFI_STATUS\r
1619EFIAPI\r
1620EfiIp4Transmit (\r
1621 IN EFI_IP4_PROTOCOL *This,\r
1622 IN EFI_IP4_COMPLETION_TOKEN *Token\r
1623 )\r
1624{\r
1625 IP4_SERVICE *IpSb;\r
1626 IP4_PROTOCOL *IpInstance;\r
1627 IP4_INTERFACE *IpIf;\r
1628 IP4_TXTOKEN_WRAP *Wrap;\r
1629 EFI_IP4_TRANSMIT_DATA *TxData;\r
1630 EFI_IP4_CONFIG_DATA *Config;\r
1631 EFI_IP4_OVERRIDE_DATA *Override;\r
1632 IP4_HEAD Head;\r
1633 IP4_ADDR GateWay;\r
1634 EFI_STATUS Status;\r
1635 EFI_TPL OldTpl;\r
1636 BOOLEAN DontFragment;\r
1637 UINT32 HeadLen;\r
1638 UINT8 RawHdrLen;\r
1639 UINT32 OptionsLength;\r
1640 UINT8 *OptionsBuffer;\r
1641 VOID *FirstFragment;\r
1642\r
1643 if (This == NULL) {\r
1644 return EFI_INVALID_PARAMETER;\r
1645 }\r
1646\r
1647 IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r
1648\r
1649 if (IpInstance->State != IP4_STATE_CONFIGED) {\r
1650 return EFI_NOT_STARTED;\r
1651 }\r
1652\r
1653 OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
1654\r
1655 IpSb = IpInstance->Service;\r
1656 IpIf = IpInstance->Interface;\r
1657 Config = &IpInstance->ConfigData;\r
1658\r
1659 if (Config->UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) {\r
1660 Status = EFI_NO_MAPPING;\r
1661 goto ON_EXIT;\r
1662 }\r
1663\r
1664 //\r
1665 // make sure that token is properly formated\r
1666 //\r
1667 Status = Ip4TxTokenValid (Token, IpIf, Config->RawData);\r
1668\r
1669 if (EFI_ERROR (Status)) {\r
1670 goto ON_EXIT;\r
1671 }\r
1672\r
1673 //\r
1674 // Check whether the token or signal already existed.\r
1675 //\r
1676 if (EFI_ERROR (NetMapIterate (&IpInstance->TxTokens, Ip4TokenExist, Token))) {\r
1677 Status = EFI_ACCESS_DENIED;\r
1678 goto ON_EXIT;\r
1679 }\r
1680\r
1681 //\r
1682 // Build the IP header, need to fill in the Tos, TotalLen, Id,\r
1683 // fragment, Ttl, protocol, Src, and Dst.\r
1684 //\r
1685 TxData = Token->Packet.TxData;\r
1686\r
1687 FirstFragment = NULL;\r
1688\r
1689 if (Config->RawData) {\r
1690 //\r
1691 // When RawData is TRUE, first buffer in FragmentTable points to a raw\r
1692 // IPv4 fragment including IPv4 header and options.\r
1693 //\r
1694 FirstFragment = TxData->FragmentTable[0].FragmentBuffer;\r
1695 CopyMem (&RawHdrLen, FirstFragment, sizeof (UINT8));\r
1696\r
1697 RawHdrLen = (UINT8) (RawHdrLen & 0x0f);\r
1698 if (RawHdrLen < 5) {\r
1699 Status = EFI_INVALID_PARAMETER;\r
1700 goto ON_EXIT;\r
1701 }\r
1702\r
1703 RawHdrLen = (UINT8) (RawHdrLen << 2);\r
1704 \r
1705 CopyMem (&Head, FirstFragment, IP4_MIN_HEADLEN);\r
1706\r
1707 Ip4NtohHead (&Head);\r
1708 HeadLen = 0;\r
1709 DontFragment = IP4_DO_NOT_FRAGMENT (Head.Fragment);\r
1710\r
1711 if (!DontFragment) {\r
1712 Status = EFI_INVALID_PARAMETER;\r
1713 goto ON_EXIT;\r
1714 }\r
1715\r
1716 GateWay = IP4_ALLZERO_ADDRESS;\r
1717\r
1718 //\r
1719 // Get IPv4 options from first fragment.\r
1720 //\r
1721 if (RawHdrLen == IP4_MIN_HEADLEN) {\r
1722 OptionsLength = 0;\r
1723 OptionsBuffer = NULL;\r
1724 } else {\r
1725 OptionsLength = RawHdrLen - IP4_MIN_HEADLEN;\r
1726 OptionsBuffer = (UINT8 *) FirstFragment + IP4_MIN_HEADLEN;\r
1727 }\r
1728\r
1729 //\r
1730 // Trim off IPv4 header and options from first fragment.\r
1731 //\r
1732 TxData->FragmentTable[0].FragmentBuffer = (UINT8 *) FirstFragment + RawHdrLen;\r
1733 TxData->FragmentTable[0].FragmentLength = TxData->FragmentTable[0].FragmentLength - RawHdrLen;\r
1734 } else {\r
1735 CopyMem (&Head.Dst, &TxData->DestinationAddress, sizeof (IP4_ADDR));\r
1736 Head.Dst = NTOHL (Head.Dst);\r
1737\r
1738 if (TxData->OverrideData != NULL) {\r
1739 Override = TxData->OverrideData;\r
1740 Head.Protocol = Override->Protocol;\r
1741 Head.Tos = Override->TypeOfService;\r
1742 Head.Ttl = Override->TimeToLive;\r
1743 DontFragment = Override->DoNotFragment;\r
1744\r
1745 CopyMem (&Head.Src, &Override->SourceAddress, sizeof (IP4_ADDR));\r
1746 CopyMem (&GateWay, &Override->GatewayAddress, sizeof (IP4_ADDR));\r
1747\r
1748 Head.Src = NTOHL (Head.Src);\r
1749 GateWay = NTOHL (GateWay);\r
1750 } else {\r
1751 Head.Src = IpIf->Ip;\r
1752 GateWay = IP4_ALLZERO_ADDRESS;\r
1753 Head.Protocol = Config->DefaultProtocol;\r
1754 Head.Tos = Config->TypeOfService;\r
1755 Head.Ttl = Config->TimeToLive;\r
1756 DontFragment = Config->DoNotFragment;\r
1757 }\r
1758\r
1759 Head.Fragment = IP4_HEAD_FRAGMENT_FIELD (DontFragment, FALSE, 0);\r
1760 HeadLen = (TxData->OptionsLength + 3) & (~0x03);\r
1761\r
1762 OptionsLength = TxData->OptionsLength;\r
1763 OptionsBuffer = (UINT8 *) (TxData->OptionsBuffer);\r
1764 }\r
1765\r
1766 //\r
1767 // If don't fragment and fragment needed, return error\r
1768 //\r
1769 if (DontFragment && (TxData->TotalDataLength + HeadLen > IpSb->MaxPacketSize)) {\r
1770 Status = EFI_BAD_BUFFER_SIZE;\r
1771 goto ON_EXIT;\r
1772 }\r
1773\r
1774 //\r
1775 // OK, it survives all the validation check. Wrap the token in\r
1776 // a IP4_TXTOKEN_WRAP and the data in a netbuf\r
1777 //\r
1778 Status = EFI_OUT_OF_RESOURCES;\r
1779 Wrap = AllocateZeroPool (sizeof (IP4_TXTOKEN_WRAP));\r
1780 if (Wrap == NULL) {\r
1781 goto ON_EXIT;\r
1782 }\r
1783\r
1784 Wrap->IpInstance = IpInstance;\r
1785 Wrap->Token = Token;\r
1786 Wrap->Sent = FALSE;\r
1787 Wrap->Life = IP4_US_TO_SEC (Config->TransmitTimeout);\r
1788 Wrap->Packet = NetbufFromExt (\r
1789 (NET_FRAGMENT *) TxData->FragmentTable,\r
1790 TxData->FragmentCount,\r
1791 IP4_MAX_HEADLEN,\r
1792 0,\r
1793 Ip4FreeTxToken,\r
1794 Wrap\r
1795 );\r
1796\r
1797 if (Wrap->Packet == NULL) {\r
1798 FreePool (Wrap);\r
1799 goto ON_EXIT;\r
1800 }\r
1801\r
1802 Token->Status = EFI_NOT_READY;\r
1803\r
1804 if (EFI_ERROR (NetMapInsertTail (&IpInstance->TxTokens, Token, Wrap))) {\r
1805 //\r
1806 // NetbufFree will call Ip4FreeTxToken, which in turn will\r
1807 // free the IP4_TXTOKEN_WRAP. Now, the token wrap hasn't been\r
1808 // enqueued.\r
1809 //\r
1810 if (Config->RawData) {\r
1811 //\r
1812 // Restore pointer of first fragment in RawData mode.\r
1813 //\r
1814 TxData->FragmentTable[0].FragmentBuffer = (UINT8 *) FirstFragment;\r
1815 }\r
1816\r
1817 NetbufFree (Wrap->Packet);\r
1818 goto ON_EXIT;\r
1819 }\r
1820\r
1821 //\r
1822 // Mark the packet sent before output it. Mark it not sent again if the\r
1823 // returned status is not EFI_SUCCESS;\r
1824 //\r
1825 Wrap->Sent = TRUE;\r
1826\r
1827 Status = Ip4Output (\r
1828 IpSb,\r
1829 IpInstance,\r
1830 Wrap->Packet,\r
1831 &Head,\r
1832 OptionsBuffer,\r
1833 OptionsLength,\r
1834 GateWay,\r
1835 Ip4OnPacketSent,\r
1836 Wrap\r
1837 );\r
1838\r
1839 if (EFI_ERROR (Status)) {\r
1840 Wrap->Sent = FALSE;\r
1841\r
1842 if (Config->RawData) {\r
1843 //\r
1844 // Restore pointer of first fragment in RawData mode.\r
1845 //\r
1846 TxData->FragmentTable[0].FragmentBuffer = (UINT8 *) FirstFragment;\r
1847 }\r
1848\r
1849 NetbufFree (Wrap->Packet);\r
1850 }\r
1851\r
1852 if (Config->RawData) {\r
1853 //\r
1854 // Restore pointer of first fragment in RawData mode.\r
1855 //\r
1856 TxData->FragmentTable[0].FragmentBuffer = (UINT8 *) FirstFragment;\r
1857 }\r
1858\r
1859ON_EXIT:\r
1860 gBS->RestoreTPL (OldTpl);\r
1861 return Status;\r
1862}\r
1863\r
1864\r
1865/**\r
1866 Places a receiving request into the receiving queue.\r
1867\r
1868 The Receive() function places a completion token into the receive packet queue.\r
1869 This function is always asynchronous.\r
1870\r
1871 The Token.Event field in the completion token must be filled in by the caller\r
1872 and cannot be NULL. When the receive operation completes, the EFI IPv4 Protocol\r
1873 driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event\r
1874 is signaled.\r
1875\r
1876 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
1877 @param[in] Token Pointer to a token that is associated with the receive data descriptor.\r
1878\r
1879 @retval EFI_SUCCESS The receive completion token was cached.\r
1880 @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r
1881 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, RARP, etc.)\r
1882 is not finished yet.\r
1883 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
1884 - This is NULL.\r
1885 - Token is NULL.\r
1886 - Token.Event is NULL.\r
1887 @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system\r
1888 resources (usually memory).\r
1889 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
1890 The EFI IPv4 Protocol instance has been reset to startup defaults.\r
1891 EFI_ACCESS_DENIED The receive completion token with the same Token.Event was already\r
1892 in the receive queue.\r
1893 @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full.\r
1894 @retval EFI_ICMP_ERROR An ICMP error packet was received.\r
1895\r
1896**/\r
1897EFI_STATUS\r
1898EFIAPI\r
1899EfiIp4Receive (\r
1900 IN EFI_IP4_PROTOCOL *This,\r
1901 IN EFI_IP4_COMPLETION_TOKEN *Token\r
1902 )\r
1903{\r
1904 IP4_PROTOCOL *IpInstance;\r
1905 EFI_STATUS Status;\r
1906 EFI_TPL OldTpl;\r
1907\r
1908 //\r
1909 // First validate the parameters\r
1910 //\r
1911 if ((This == NULL) || (Token == NULL) || (Token->Event == NULL)) {\r
1912 return EFI_INVALID_PARAMETER;\r
1913 }\r
1914\r
1915 IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r
1916\r
1917 OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
1918\r
1919 if (IpInstance->State != IP4_STATE_CONFIGED) {\r
1920 Status = EFI_NOT_STARTED;\r
1921 goto ON_EXIT;\r
1922 }\r
1923\r
1924 //\r
1925 // Check whether the toke is already on the receive queue.\r
1926 //\r
1927 Status = NetMapIterate (&IpInstance->RxTokens, Ip4TokenExist, Token);\r
1928\r
1929 if (EFI_ERROR (Status)) {\r
1930 Status = EFI_ACCESS_DENIED;\r
1931 goto ON_EXIT;\r
1932 }\r
1933\r
1934 //\r
1935 // Queue the token then check whether there is pending received packet.\r
1936 //\r
1937 Status = NetMapInsertTail (&IpInstance->RxTokens, Token, NULL);\r
1938\r
1939 if (EFI_ERROR (Status)) {\r
1940 goto ON_EXIT;\r
1941 }\r
1942\r
1943 Status = Ip4InstanceDeliverPacket (IpInstance);\r
1944\r
1945 //\r
1946 // Dispatch the DPC queued by the NotifyFunction of this instane's receive\r
1947 // event.\r
1948 //\r
1949 DispatchDpc ();\r
1950\r
1951ON_EXIT:\r
1952 gBS->RestoreTPL (OldTpl);\r
1953 return Status;\r
1954}\r
1955\r
1956\r
1957/**\r
1958 Cancel the transmitted but not recycled packet. If a matching\r
1959 token is found, it will call Ip4CancelPacket to cancel the\r
1960 packet. Ip4CancelPacket will cancel all the fragments of the\r
1961 packet. When all the fragments are freed, the IP4_TXTOKEN_WRAP\r
1962 will be deleted from the Map, and user's event signalled.\r
1963 Because Ip4CancelPacket and other functions are all called in\r
1964 line, so, after Ip4CancelPacket returns, the Item has been freed.\r
1965\r
1966 @param[in] Map The IP4 child's transmit queue.\r
1967 @param[in] Item The current transmitted packet to test.\r
1968 @param[in] Context The user's token to cancel.\r
1969\r
1970 @retval EFI_SUCCESS Continue to check the next Item.\r
1971 @retval EFI_ABORTED The user's Token (Token != NULL) is cancelled.\r
1972\r
1973**/\r
1974EFI_STATUS\r
1975EFIAPI\r
1976Ip4CancelTxTokens (\r
1977 IN NET_MAP *Map,\r
1978 IN NET_MAP_ITEM *Item,\r
1979 IN VOID *Context\r
1980 )\r
1981{\r
1982 EFI_IP4_COMPLETION_TOKEN *Token;\r
1983 IP4_TXTOKEN_WRAP *Wrap;\r
1984\r
1985 Token = (EFI_IP4_COMPLETION_TOKEN *) Context;\r
1986\r
1987 //\r
1988 // Return EFI_SUCCESS to check the next item in the map if\r
1989 // this one doesn't match.\r
1990 //\r
1991 if ((Token != NULL) && (Token != Item->Key)) {\r
1992 return EFI_SUCCESS;\r
1993 }\r
1994\r
1995 Wrap = (IP4_TXTOKEN_WRAP *) Item->Value;\r
1996 ASSERT (Wrap != NULL);\r
1997\r
1998 //\r
1999 // Don't access the Item, Wrap and Token's members after this point.\r
2000 // Item and wrap has been freed. And we no longer own the Token.\r
2001 //\r
2002 Ip4CancelPacket (Wrap->IpInstance->Interface, Wrap->Packet, EFI_ABORTED);\r
2003\r
2004 //\r
2005 // If only one item is to be cancel, return EFI_ABORTED to stop\r
2006 // iterating the map any more.\r
2007 //\r
2008 if (Token != NULL) {\r
2009 return EFI_ABORTED;\r
2010 }\r
2011\r
2012 return EFI_SUCCESS;\r
2013}\r
2014\r
2015\r
2016/**\r
2017 Cancel the receive request. This is quiet simple, because\r
2018 it is only enqueued in our local receive map.\r
2019\r
2020 @param[in] Map The IP4 child's receive queue.\r
2021 @param[in] Item Current receive request to cancel.\r
2022 @param[in] Context The user's token to cancel.\r
2023\r
2024 @retval EFI_SUCCESS Continue to check the next receive request on the\r
2025 queue.\r
2026 @retval EFI_ABORTED The user's token (token != NULL) has been\r
2027 cancelled.\r
2028\r
2029**/\r
2030EFI_STATUS\r
2031EFIAPI\r
2032Ip4CancelRxTokens (\r
2033 IN NET_MAP *Map,\r
2034 IN NET_MAP_ITEM *Item,\r
2035 IN VOID *Context\r
2036 )\r
2037{\r
2038 EFI_IP4_COMPLETION_TOKEN *Token;\r
2039 EFI_IP4_COMPLETION_TOKEN *This;\r
2040\r
2041 Token = (EFI_IP4_COMPLETION_TOKEN *) Context;\r
2042 This = Item->Key;\r
2043\r
2044 if ((Token != NULL) && (Token != This)) {\r
2045 return EFI_SUCCESS;\r
2046 }\r
2047\r
2048 NetMapRemoveItem (Map, Item, NULL);\r
2049\r
2050 This->Status = EFI_ABORTED;\r
2051 This->Packet.RxData = NULL;\r
2052 gBS->SignalEvent (This->Event);\r
2053\r
2054 if (Token != NULL) {\r
2055 return EFI_ABORTED;\r
2056 }\r
2057\r
2058 return EFI_SUCCESS;\r
2059}\r
2060\r
2061\r
2062/**\r
2063 Cancel the user's receive/transmit request.\r
2064\r
2065 @param[in] IpInstance The IP4 child.\r
2066 @param[in] Token The token to cancel. If NULL, all token will be\r
2067 cancelled.\r
2068\r
2069 @retval EFI_SUCCESS The token is cancelled.\r
2070 @retval EFI_NOT_FOUND The token isn't found on either the\r
2071 transmit/receive queue.\r
2072 @retval EFI_DEVICE_ERROR Not all token is cancelled when Token is NULL.\r
2073\r
2074**/\r
2075EFI_STATUS\r
2076Ip4Cancel (\r
2077 IN IP4_PROTOCOL *IpInstance,\r
2078 IN EFI_IP4_COMPLETION_TOKEN *Token OPTIONAL\r
2079 )\r
2080{\r
2081 EFI_STATUS Status;\r
2082\r
2083 //\r
2084 // First check the transmitted packet. Ip4CancelTxTokens returns\r
2085 // EFI_ABORTED to mean that the token has been cancelled when\r
2086 // token != NULL. So, return EFI_SUCCESS for this condition.\r
2087 //\r
2088 Status = NetMapIterate (&IpInstance->TxTokens, Ip4CancelTxTokens, Token);\r
2089\r
2090 if (EFI_ERROR (Status)) {\r
2091 if ((Token != NULL) && (Status == EFI_ABORTED)) {\r
2092 return EFI_SUCCESS;\r
2093 }\r
2094\r
2095 return Status;\r
2096 }\r
2097\r
2098 //\r
2099 // Check the receive queue. Ip4CancelRxTokens also returns EFI_ABORT\r
2100 // for Token!=NULL and it is cancelled.\r
2101 //\r
2102 Status = NetMapIterate (&IpInstance->RxTokens, Ip4CancelRxTokens, Token);\r
2103 //\r
2104 // Dispatch the DPCs queued by the NotifyFunction of the canceled rx token's\r
2105 // events.\r
2106 //\r
2107 DispatchDpc ();\r
2108 if (EFI_ERROR (Status)) {\r
2109 if ((Token != NULL) && (Status == EFI_ABORTED)) {\r
2110 return EFI_SUCCESS;\r
2111 }\r
2112\r
2113 return Status;\r
2114 }\r
2115\r
2116 //\r
2117 // OK, if the Token is found when Token != NULL, the NetMapIterate\r
2118 // will return EFI_ABORTED, which has been interrupted as EFI_SUCCESS.\r
2119 //\r
2120 if (Token != NULL) {\r
2121 return EFI_NOT_FOUND;\r
2122 }\r
2123\r
2124 //\r
2125 // If Token == NULL, cancel all the tokens. return error if no\r
2126 // all of them are cancelled.\r
2127 //\r
2128 if (!NetMapIsEmpty (&IpInstance->TxTokens) ||\r
2129 !NetMapIsEmpty (&IpInstance->RxTokens)) {\r
2130\r
2131 return EFI_DEVICE_ERROR;\r
2132 }\r
2133\r
2134 return EFI_SUCCESS;\r
2135}\r
2136\r
2137\r
2138/**\r
2139 Abort an asynchronous transmit or receive request.\r
2140\r
2141 The Cancel() function is used to abort a pending transmit or receive request.\r
2142 If the token is in the transmit or receive request queues, after calling this\r
2143 function, Token->Status will be set to EFI_ABORTED and then Token->Event will\r
2144 be signaled. If the token is not in one of the queues, which usually means the\r
2145 asynchronous operation has completed, this function will not signal the token\r
2146 and EFI_NOT_FOUND is returned.\r
2147\r
2148 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
2149 @param[in] Token Pointer to a token that has been issued by\r
2150 EFI_IP4_PROTOCOL.Transmit() or\r
2151 EFI_IP4_PROTOCOL.Receive(). If NULL, all pending\r
2152 tokens are aborted. Type EFI_IP4_COMPLETION_TOKEN is\r
2153 defined in EFI_IP4_PROTOCOL.Transmit().\r
2154\r
2155 @retval EFI_SUCCESS The asynchronous I/O request was aborted and\r
2156 Token.->Event was signaled. When Token is NULL, all\r
2157 pending requests were aborted and their events were signaled.\r
2158 @retval EFI_INVALID_PARAMETER This is NULL.\r
2159 @retval EFI_NOT_STARTED This instance has not been started.\r
2160 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
2161 RARP, etc.) is not finished yet.\r
2162 @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O request was\r
2163 not found in the transmit or receive queue. It has either completed\r
2164 or was not issued by Transmit() and Receive().\r
2165\r
2166**/\r
2167EFI_STATUS\r
2168EFIAPI\r
2169EfiIp4Cancel (\r
2170 IN EFI_IP4_PROTOCOL *This,\r
2171 IN EFI_IP4_COMPLETION_TOKEN *Token OPTIONAL\r
2172 )\r
2173{\r
2174 IP4_PROTOCOL *IpInstance;\r
2175 EFI_STATUS Status;\r
2176 EFI_TPL OldTpl;\r
2177\r
2178 if (This == NULL) {\r
2179 return EFI_INVALID_PARAMETER;\r
2180 }\r
2181\r
2182 IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r
2183\r
2184 OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
2185\r
2186 if (IpInstance->State != IP4_STATE_CONFIGED) {\r
2187 Status = EFI_NOT_STARTED;\r
2188 goto ON_EXIT;\r
2189 }\r
2190\r
2191 if (IpInstance->ConfigData.UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) {\r
2192 Status = EFI_NO_MAPPING;\r
2193 goto ON_EXIT;\r
2194 }\r
2195\r
2196 Status = Ip4Cancel (IpInstance, Token);\r
2197\r
2198ON_EXIT:\r
2199 gBS->RestoreTPL (OldTpl);\r
2200 return Status;\r
2201}\r
2202\r
2203\r
2204/**\r
2205 Polls for incoming data packets and processes outgoing data packets.\r
2206\r
2207 The Poll() function polls for incoming data packets and processes outgoing data\r
2208 packets. Network drivers and applications can call the EFI_IP4_PROTOCOL.Poll()\r
2209 function to increase the rate that data packets are moved between the communications\r
2210 device and the transmit and receive queues.\r
2211\r
2212 In some systems the periodic timer event may not poll the underlying communications\r
2213 device fast enough to transmit and/or receive all data packets without missing\r
2214 incoming packets or dropping outgoing packets. Drivers and applications that are\r
2215 experiencing packet loss should try calling the EFI_IP4_PROTOCOL.Poll() function\r
2216 more often.\r
2217\r
2218 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
2219\r
2220 @retval EFI_SUCCESS Incoming or outgoing data was processed.\r
2221 @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r
2222 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
2223 RARP, etc.) is not finished yet.\r
2224 @retval EFI_INVALID_PARAMETER This is NULL.\r
2225 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
2226 @retval EFI_NOT_READY No incoming or outgoing data is processed.\r
2227 @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue.\r
2228 Consider increasing the polling rate.\r
2229\r
2230**/\r
2231EFI_STATUS\r
2232EFIAPI\r
2233EfiIp4Poll (\r
2234 IN EFI_IP4_PROTOCOL *This\r
2235 )\r
2236{\r
2237 IP4_PROTOCOL *IpInstance;\r
2238 EFI_MANAGED_NETWORK_PROTOCOL *Mnp;\r
2239\r
2240 if (This == NULL) {\r
2241 return EFI_INVALID_PARAMETER;\r
2242 }\r
2243\r
2244 IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r
2245\r
2246 if (IpInstance->State == IP4_STATE_UNCONFIGED) {\r
2247 return EFI_NOT_STARTED;\r
2248 }\r
2249\r
2250 Mnp = IpInstance->Service->Mnp;\r
2251\r
2252 //\r
2253 // Don't lock the Poll function to enable the deliver of\r
2254 // the packet polled up.\r
2255 //\r
2256 return Mnp->Poll (Mnp);\r
2257}\r
2258\r
2259/**\r
2260 Decrease the life of the transmitted packets. If it is\r
2261 decreased to zero, cancel the packet. This function is\r
2262 called by Ip4PacketTimerTicking which time out both the\r
2263 received-but-not-delivered and transmitted-but-not-recycle\r
2264 packets.\r
2265\r
2266 @param[in] Map The IP4 child's transmit map.\r
2267 @param[in] Item Current transmitted packet.\r
2268 @param[in] Context Not used.\r
2269\r
2270 @retval EFI_SUCCESS Always returns EFI_SUCCESS.\r
2271\r
2272**/\r
2273EFI_STATUS\r
2274EFIAPI\r
2275Ip4SentPacketTicking (\r
2276 IN NET_MAP *Map,\r
2277 IN NET_MAP_ITEM *Item,\r
2278 IN VOID *Context\r
2279 )\r
2280{\r
2281 IP4_TXTOKEN_WRAP *Wrap;\r
2282\r
2283 Wrap = (IP4_TXTOKEN_WRAP *) Item->Value;\r
2284 ASSERT (Wrap != NULL);\r
2285\r
2286 if ((Wrap->Life > 0) && (--Wrap->Life == 0)) {\r
2287 Ip4CancelPacket (Wrap->IpInstance->Interface, Wrap->Packet, EFI_ABORTED);\r
2288 }\r
2289\r
2290 return EFI_SUCCESS;\r
2291}\r
2292\r
2293\r
2294/**\r
2295 The heart beat timer of IP4 service instance. It times out\r
2296 all of its IP4 children's received-but-not-delivered and\r
2297 transmitted-but-not-recycle packets, and provides time input\r
2298 for its IGMP protocol.\r
2299\r
2300 @param[in] Event The IP4 service instance's heart beat timer.\r
2301 @param[in] Context The IP4 service instance.\r
2302\r
2303**/\r
2304VOID\r
2305EFIAPI\r
2306Ip4TimerTicking (\r
2307 IN EFI_EVENT Event,\r
2308 IN VOID *Context\r
2309 )\r
2310{\r
2311 IP4_SERVICE *IpSb;\r
2312\r
2313 IpSb = (IP4_SERVICE *) Context;\r
2314 NET_CHECK_SIGNATURE (IpSb, IP4_SERVICE_SIGNATURE);\r
2315\r
2316 Ip4PacketTimerTicking (IpSb);\r
2317 Ip4IgmpTicking (IpSb);\r
2318}\r
EFI Development Kit II mirror for PVE