]> 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: Remove trailing white space
[mirror_edk2.git] / MdeModulePkg / Universal / Network / Ip4Dxe / Ip4Impl.c
... / ...
CommitLineData
1/** @file\r
2\r
3Copyright (c) 2005 - 2018, 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->InDestroy = FALSE;\r
554 IpInstance->Service = IpSb;\r
555\r
556 InitializeListHead (&IpInstance->Link);\r
557 NetMapInit (&IpInstance->RxTokens);\r
558 NetMapInit (&IpInstance->TxTokens);\r
559 InitializeListHead (&IpInstance->Received);\r
560 InitializeListHead (&IpInstance->Delivered);\r
561 InitializeListHead (&IpInstance->AddrLink);\r
562\r
563 EfiInitializeLock (&IpInstance->RecycleLock, TPL_NOTIFY);\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 EFI_IP4_CONFIG2_PROTOCOL *Ip4Config2;\r
600 EFI_IP4_CONFIG2_POLICY Policy;\r
601\r
602 IpSb = IpInstance->Service;\r
603\r
604 Ip4Config2 = NULL;\r
605\r
606 //\r
607 // User is changing packet filters. It must be stopped\r
608 // before the station address can be changed.\r
609 //\r
610 if (IpInstance->State == IP4_STATE_CONFIGED) {\r
611 //\r
612 // Cancel all the pending transmit/receive from upper layer\r
613 //\r
614 Status = Ip4Cancel (IpInstance, NULL);\r
615\r
616 if (EFI_ERROR (Status)) {\r
617 return EFI_DEVICE_ERROR;\r
618 }\r
619\r
620 CopyMem (&IpInstance->ConfigData, Config, sizeof (IpInstance->ConfigData));\r
621 return EFI_SUCCESS;\r
622 }\r
623\r
624 //\r
625 // Configure a fresh IP4 protocol instance. Create a route table.\r
626 // Each IP child has its own route table, which may point to the\r
627 // default table if it is using default address.\r
628 //\r
629 Status = EFI_OUT_OF_RESOURCES;\r
630 IpInstance->RouteTable = Ip4CreateRouteTable ();\r
631\r
632 if (IpInstance->RouteTable == NULL) {\r
633 return Status;\r
634 }\r
635\r
636 //\r
637 // Set up the interface.\r
638 //\r
639 CopyMem (&Ip, &Config->StationAddress, sizeof (IP4_ADDR));\r
640 CopyMem (&Netmask, &Config->SubnetMask, sizeof (IP4_ADDR));\r
641\r
642 Ip = NTOHL (Ip);\r
643 Netmask = NTOHL (Netmask);\r
644\r
645 if (!Config->UseDefaultAddress) {\r
646 //\r
647 // Find whether there is already an interface with the same\r
648 // station address. All the instances with the same station\r
649 // address shares one interface.\r
650 //\r
651 IpIf = Ip4FindStationAddress (IpSb, Ip, Netmask);\r
652\r
653 if (IpIf != NULL) {\r
654 NET_GET_REF (IpIf);\r
655\r
656 } else {\r
657 IpIf = Ip4CreateInterface (IpSb->Mnp, IpSb->Controller, IpSb->Image);\r
658\r
659 if (IpIf == NULL) {\r
660 goto ON_ERROR;\r
661 }\r
662\r
663 Status = Ip4SetAddress (IpIf, Ip, Netmask);\r
664\r
665 if (EFI_ERROR (Status)) {\r
666 Status = EFI_DEVICE_ERROR;\r
667 Ip4FreeInterface (IpIf, IpInstance);\r
668 goto ON_ERROR;\r
669 }\r
670\r
671 InsertTailList (&IpSb->Interfaces, &IpIf->Link);\r
672 }\r
673\r
674 //\r
675 // Add a route to this connected network in the route table\r
676 //\r
677 Ip4AddRoute (IpInstance->RouteTable, Ip, Netmask, IP4_ALLZERO_ADDRESS);\r
678\r
679 } else {\r
680 //\r
681 // Use the default address. Check the state.\r
682 //\r
683 if (IpSb->State == IP4_SERVICE_UNSTARTED) {\r
684 //\r
685 // Trigger the EFI_IP4_CONFIG2_PROTOCOL to retrieve the\r
686 // default IPv4 address if it is not available yet.\r
687 //\r
688 Policy = IpSb->Ip4Config2Instance.Policy;\r
689 if (Policy != Ip4Config2PolicyDhcp) {\r
690 Ip4Config2 = &IpSb->Ip4Config2Instance.Ip4Config2;\r
691 Policy = Ip4Config2PolicyDhcp;\r
692 Status= Ip4Config2->SetData (\r
693 Ip4Config2,\r
694 Ip4Config2DataTypePolicy,\r
695 sizeof (EFI_IP4_CONFIG2_POLICY),\r
696 &Policy\r
697 );\r
698 if (EFI_ERROR (Status)) {\r
699 goto ON_ERROR;\r
700 }\r
701 }\r
702 }\r
703\r
704 IpIf = IpSb->DefaultInterface;\r
705 NET_GET_REF (IpSb->DefaultInterface);\r
706\r
707 //\r
708 // If default address is used, so is the default route table.\r
709 // Any route set by the instance has the precedence over the\r
710 // routes in the default route table. Link the default table\r
711 // after the instance's table. Routing will search the local\r
712 // table first.\r
713 //\r
714 NET_GET_REF (IpSb->DefaultRouteTable);\r
715 IpInstance->RouteTable->Next = IpSb->DefaultRouteTable;\r
716 }\r
717\r
718 IpInstance->Interface = IpIf;\r
719 if (IpIf->Arp != NULL) {\r
720 Arp = NULL;\r
721 Status = gBS->OpenProtocol (\r
722 IpIf->ArpHandle,\r
723 &gEfiArpProtocolGuid,\r
724 (VOID **) &Arp,\r
725 gIp4DriverBinding.DriverBindingHandle,\r
726 IpInstance->Handle,\r
727 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
728 );\r
729 if (EFI_ERROR (Status)) {\r
730 Ip4FreeInterface (IpIf, IpInstance);\r
731 goto ON_ERROR;\r
732 }\r
733 }\r
734 InsertTailList (&IpIf->IpInstances, &IpInstance->AddrLink);\r
735\r
736 CopyMem (&IpInstance->ConfigData, Config, sizeof (IpInstance->ConfigData));\r
737 IpInstance->State = IP4_STATE_CONFIGED;\r
738\r
739 //\r
740 // Although EFI_NO_MAPPING is an error code, the IP child has been\r
741 // successfully configured and doesn't need reconfiguration when\r
742 // default address is acquired.\r
743 //\r
744 if (Config->UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) {\r
745 return EFI_NO_MAPPING;\r
746 }\r
747\r
748 return EFI_SUCCESS;\r
749\r
750ON_ERROR:\r
751 Ip4FreeRouteTable (IpInstance->RouteTable);\r
752 IpInstance->RouteTable = NULL;\r
753 return Status;\r
754}\r
755\r
756\r
757/**\r
758 Clean up the IP4 child, release all the resources used by it.\r
759\r
760 @param[in] IpInstance The IP4 child to clean up.\r
761\r
762 @retval EFI_SUCCESS The IP4 child is cleaned up.\r
763 @retval EFI_DEVICE_ERROR Some resources failed to be released.\r
764\r
765**/\r
766EFI_STATUS\r
767Ip4CleanProtocol (\r
768 IN IP4_PROTOCOL *IpInstance\r
769 )\r
770{\r
771 if (EFI_ERROR (Ip4Cancel (IpInstance, NULL))) {\r
772 return EFI_DEVICE_ERROR;\r
773 }\r
774\r
775 if (EFI_ERROR (Ip4Groups (IpInstance, FALSE, NULL))) {\r
776 return EFI_DEVICE_ERROR;\r
777 }\r
778\r
779 //\r
780 // Some packets haven't been recycled. It is because either the\r
781 // user forgets to recycle the packets, or because the callback\r
782 // hasn't been called. Just leave it alone.\r
783 //\r
784 if (!IsListEmpty (&IpInstance->Delivered)) {\r
785 ;\r
786 }\r
787\r
788 if (IpInstance->Interface != NULL) {\r
789 RemoveEntryList (&IpInstance->AddrLink);\r
790 if (IpInstance->Interface->Arp != NULL) {\r
791 gBS->CloseProtocol (\r
792 IpInstance->Interface->ArpHandle,\r
793 &gEfiArpProtocolGuid,\r
794 gIp4DriverBinding.DriverBindingHandle,\r
795 IpInstance->Handle\r
796 );\r
797 }\r
798 Ip4FreeInterface (IpInstance->Interface, IpInstance);\r
799 IpInstance->Interface = NULL;\r
800 }\r
801\r
802 if (IpInstance->RouteTable != NULL) {\r
803 if (IpInstance->RouteTable->Next != NULL) {\r
804 Ip4FreeRouteTable (IpInstance->RouteTable->Next);\r
805 }\r
806\r
807 Ip4FreeRouteTable (IpInstance->RouteTable);\r
808 IpInstance->RouteTable = NULL;\r
809 }\r
810\r
811 if (IpInstance->EfiRouteTable != NULL) {\r
812 FreePool (IpInstance->EfiRouteTable);\r
813 IpInstance->EfiRouteTable = NULL;\r
814 IpInstance->EfiRouteCount = 0;\r
815 }\r
816\r
817 if (IpInstance->Groups != NULL) {\r
818 FreePool (IpInstance->Groups);\r
819 IpInstance->Groups = NULL;\r
820 IpInstance->GroupCount = 0;\r
821 }\r
822\r
823 NetMapClean (&IpInstance->TxTokens);\r
824\r
825 NetMapClean (&IpInstance->RxTokens);\r
826\r
827 return EFI_SUCCESS;\r
828}\r
829\r
830\r
831/**\r
832 Assigns an IPv4 address and subnet mask to this EFI IPv4 Protocol driver instance.\r
833\r
834 The Configure() function is used to set, change, or reset the operational\r
835 parameters and filter settings for this EFI IPv4 Protocol instance. Until these\r
836 parameters have been set, no network traffic can be sent or received by this\r
837 instance. Once the parameters have been reset (by calling this function with\r
838 IpConfigData set to NULL), no more traffic can be sent or received until these\r
839 parameters have been set again. Each EFI IPv4 Protocol instance can be started\r
840 and stopped independently of each other by enabling or disabling their receive\r
841 filter settings with the Configure() function.\r
842\r
843 When IpConfigData.UseDefaultAddress is set to FALSE, the new station address will\r
844 be appended as an alias address into the addresses list in the EFI IPv4 Protocol\r
845 driver. While set to TRUE, Configure() will trigger the EFI_IP4_CONFIG_PROTOCOL\r
846 to retrieve the default IPv4 address if it is not available yet. Clients could\r
847 frequently call GetModeData() to check the status to ensure that the default IPv4\r
848 address is ready.\r
849\r
850 If operational parameters are reset or changed, any pending transmit and receive\r
851 requests will be cancelled. Their completion token status will be set to EFI_ABORTED\r
852 and their events will be signaled.\r
853\r
854 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
855 @param[in] IpConfigData Pointer to the EFI IPv4 Protocol configuration data structure.\r
856\r
857 @retval EFI_SUCCESS The driver instance was successfully opened.\r
858 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
859 RARP, etc.) is not finished yet.\r
860 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
861 @retval EFI_UNSUPPORTED One or more of the following conditions is TRUE:\r
862 A configuration protocol (DHCP, BOOTP, RARP, etc.) could\r
863 not be located when clients choose to use the default IPv4\r
864 address. This EFI IPv4 Protocol implementation does not\r
865 support this requested filter or timeout setting.\r
866 @retval EFI_OUT_OF_RESOURCES The EFI IPv4 Protocol driver instance data could not be allocated.\r
867 @retval EFI_ALREADY_STARTED The interface is already open and must be stopped before the\r
868 IPv4 address or subnet mask can be changed. The interface must\r
869 also be stopped when switching to/from raw packet mode.\r
870 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI IPv4\r
871 Protocol driver instance is not opened.\r
872\r
873**/\r
874EFI_STATUS\r
875EFIAPI\r
876EfiIp4Configure (\r
877 IN EFI_IP4_PROTOCOL *This,\r
878 IN EFI_IP4_CONFIG_DATA *IpConfigData OPTIONAL\r
879 )\r
880{\r
881 IP4_PROTOCOL *IpInstance;\r
882 EFI_IP4_CONFIG_DATA *Current;\r
883 EFI_TPL OldTpl;\r
884 EFI_STATUS Status;\r
885 BOOLEAN AddrOk;\r
886 IP4_ADDR IpAddress;\r
887 IP4_ADDR SubnetMask;\r
888\r
889 //\r
890 // First, validate the parameters\r
891 //\r
892 if (This == NULL) {\r
893 return EFI_INVALID_PARAMETER;\r
894 }\r
895\r
896 IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r
897 OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
898\r
899 //\r
900 // Validate the configuration first.\r
901 //\r
902 if (IpConfigData != NULL) {\r
903\r
904 CopyMem (&IpAddress, &IpConfigData->StationAddress, sizeof (IP4_ADDR));\r
905 CopyMem (&SubnetMask, &IpConfigData->SubnetMask, sizeof (IP4_ADDR));\r
906\r
907 IpAddress = NTOHL (IpAddress);\r
908 SubnetMask = NTOHL (SubnetMask);\r
909\r
910 //\r
911 // Check whether the station address is a valid unicast address\r
912 //\r
913 if (!IpConfigData->UseDefaultAddress) {\r
914 AddrOk = Ip4StationAddressValid (IpAddress, SubnetMask);\r
915\r
916 if (!AddrOk) {\r
917 Status = EFI_INVALID_PARAMETER;\r
918 goto ON_EXIT;\r
919 }\r
920 }\r
921\r
922 //\r
923 // User can only update packet filters when already configured.\r
924 // If it wants to change the station address, it must configure(NULL)\r
925 // the instance first.\r
926 //\r
927 if (IpInstance->State == IP4_STATE_CONFIGED) {\r
928 Current = &IpInstance->ConfigData;\r
929\r
930 if (Current->UseDefaultAddress != IpConfigData->UseDefaultAddress) {\r
931 Status = EFI_ALREADY_STARTED;\r
932 goto ON_EXIT;\r
933 }\r
934\r
935 if (!Current->UseDefaultAddress &&\r
936 (!EFI_IP4_EQUAL (&Current->StationAddress, &IpConfigData->StationAddress) ||\r
937 !EFI_IP4_EQUAL (&Current->SubnetMask, &IpConfigData->SubnetMask))) {\r
938 Status = EFI_ALREADY_STARTED;\r
939 goto ON_EXIT;\r
940 }\r
941\r
942 if (Current->UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) {\r
943 Status = EFI_NO_MAPPING;\r
944 goto ON_EXIT;\r
945 }\r
946 }\r
947 }\r
948\r
949 //\r
950 // Configure the instance or clean it up.\r
951 //\r
952 if (IpConfigData != NULL) {\r
953 Status = Ip4ConfigProtocol (IpInstance, IpConfigData);\r
954 } else {\r
955 Status = Ip4CleanProtocol (IpInstance);\r
956\r
957 //\r
958 // Consider the following valid sequence: Mnp is unloaded-->Ip Stopped-->Udp Stopped,\r
959 // Configure (ThisIp, NULL). If the state is changed to UNCONFIGED,\r
960 // the unload fails miserably.\r
961 //\r
962 if (IpInstance->State == IP4_STATE_CONFIGED) {\r
963 IpInstance->State = IP4_STATE_UNCONFIGED;\r
964 }\r
965 }\r
966\r
967 //\r
968 // Update the MNP's configure data. Ip4ServiceConfigMnp will check\r
969 // whether it is necessary to reconfigure the MNP.\r
970 //\r
971 Ip4ServiceConfigMnp (IpInstance->Service, FALSE);\r
972\r
973ON_EXIT:\r
974 gBS->RestoreTPL (OldTpl);\r
975 return Status;\r
976\r
977}\r
978\r
979\r
980/**\r
981 Change the IP4 child's multicast setting. The caller\r
982 should make sure that the parameters is valid.\r
983\r
984 @param[in] IpInstance The IP4 child to change the setting.\r
985 @param[in] JoinFlag TRUE to join the group, otherwise leave it.\r
986 @param[in] GroupAddress The target group address.\r
987\r
988 @retval EFI_ALREADY_STARTED Want to join the group, but already a member of it.\r
989 @retval EFI_OUT_OF_RESOURCES Failed to allocate some resources.\r
990 @retval EFI_DEVICE_ERROR Failed to set the group configuraton.\r
991 @retval EFI_SUCCESS Successfully updated the group setting.\r
992 @retval EFI_NOT_FOUND Try to leave the group which it isn't a member.\r
993\r
994**/\r
995EFI_STATUS\r
996Ip4Groups (\r
997 IN IP4_PROTOCOL *IpInstance,\r
998 IN BOOLEAN JoinFlag,\r
999 IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL\r
1000 )\r
1001{\r
1002 IP4_ADDR *Members;\r
1003 IP4_ADDR Group;\r
1004 UINT32 Index;\r
1005\r
1006 //\r
1007 // Add it to the instance's Groups, and join the group by IGMP.\r
1008 // IpInstance->Groups is in network byte order. IGMP operates in\r
1009 // host byte order\r
1010 //\r
1011 if (JoinFlag) {\r
1012 //\r
1013 // When JoinFlag is TRUE, GroupAddress shouldn't be NULL.\r
1014 //\r
1015 ASSERT (GroupAddress != NULL);\r
1016 CopyMem (&Group, GroupAddress, sizeof (IP4_ADDR));\r
1017\r
1018 for (Index = 0; Index < IpInstance->GroupCount; Index++) {\r
1019 if (IpInstance->Groups[Index] == Group) {\r
1020 return EFI_ALREADY_STARTED;\r
1021 }\r
1022 }\r
1023\r
1024 Members = Ip4CombineGroups (IpInstance->Groups, IpInstance->GroupCount, Group);\r
1025\r
1026 if (Members == NULL) {\r
1027 return EFI_OUT_OF_RESOURCES;\r
1028 }\r
1029\r
1030 if (EFI_ERROR (Ip4JoinGroup (IpInstance, NTOHL (Group)))) {\r
1031 FreePool (Members);\r
1032 return EFI_DEVICE_ERROR;\r
1033 }\r
1034\r
1035 if (IpInstance->Groups != NULL) {\r
1036 FreePool (IpInstance->Groups);\r
1037 }\r
1038\r
1039 IpInstance->Groups = Members;\r
1040 IpInstance->GroupCount++;\r
1041\r
1042 return EFI_SUCCESS;\r
1043 }\r
1044\r
1045 //\r
1046 // Leave the group. Leave all the groups if GroupAddress is NULL.\r
1047 // Must iterate from the end to the beginning because the GroupCount\r
1048 // is decreamented each time an address is removed..\r
1049 //\r
1050 for (Index = IpInstance->GroupCount; Index > 0 ; Index--) {\r
1051 ASSERT (IpInstance->Groups != NULL);\r
1052 Group = IpInstance->Groups[Index - 1];\r
1053 if ((GroupAddress == NULL) || EFI_IP4_EQUAL (&Group, GroupAddress)) {\r
1054 if (EFI_ERROR (Ip4LeaveGroup (IpInstance, NTOHL (Group)))) {\r
1055 return EFI_DEVICE_ERROR;\r
1056 }\r
1057\r
1058 Ip4RemoveGroupAddr (IpInstance->Groups, IpInstance->GroupCount, Group);\r
1059 IpInstance->GroupCount--;\r
1060\r
1061 if (IpInstance->GroupCount == 0) {\r
1062 ASSERT (Index == 1);\r
1063\r
1064 FreePool (IpInstance->Groups);\r
1065 IpInstance->Groups = NULL;\r
1066 }\r
1067\r
1068 if (GroupAddress != NULL) {\r
1069 return EFI_SUCCESS;\r
1070 }\r
1071 }\r
1072 }\r
1073\r
1074 return ((GroupAddress != NULL) ? EFI_NOT_FOUND : EFI_SUCCESS);\r
1075}\r
1076\r
1077\r
1078/**\r
1079 Joins and leaves multicast groups.\r
1080\r
1081 The Groups() function is used to join and leave multicast group sessions. Joining\r
1082 a group will enable reception of matching multicast packets. Leaving a group will\r
1083 disable the multicast packet reception.\r
1084\r
1085 If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left.\r
1086\r
1087 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
1088 @param[in] JoinFlag Set to TRUE to join the multicast group session and FALSE to leave.\r
1089 @param[in] GroupAddress Pointer to the IPv4 multicast address.\r
1090\r
1091 @retval EFI_SUCCESS The operation completed successfully.\r
1092 @retval EFI_INVALID_PARAMETER One or more of the following is TRUE:\r
1093 - This is NULL.\r
1094 - JoinFlag is TRUE and GroupAddress is NULL.\r
1095 - GroupAddress is not NULL and *GroupAddress is\r
1096 not a multicast IPv4 address.\r
1097 @retval EFI_NOT_STARTED This instance has not been started.\r
1098 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
1099 RARP, etc.) is not finished yet.\r
1100 @retval EFI_OUT_OF_RESOURCES System resources could not be allocated.\r
1101 @retval EFI_UNSUPPORTED This EFI IPv4 Protocol implementation does not support multicast groups.\r
1102 @retval EFI_ALREADY_STARTED The group address is already in the group table (when\r
1103 JoinFlag is TRUE).\r
1104 @retval EFI_NOT_FOUND The group address is not in the group table (when JoinFlag is FALSE).\r
1105 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
1106\r
1107**/\r
1108EFI_STATUS\r
1109EFIAPI\r
1110EfiIp4Groups (\r
1111 IN EFI_IP4_PROTOCOL *This,\r
1112 IN BOOLEAN JoinFlag,\r
1113 IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL\r
1114 )\r
1115{\r
1116 IP4_PROTOCOL *IpInstance;\r
1117 EFI_STATUS Status;\r
1118 EFI_TPL OldTpl;\r
1119 IP4_ADDR McastIp;\r
1120\r
1121 if ((This == NULL) || (JoinFlag && (GroupAddress == NULL))) {\r
1122 return EFI_INVALID_PARAMETER;\r
1123 }\r
1124\r
1125 if (GroupAddress != NULL) {\r
1126 CopyMem (&McastIp, GroupAddress, sizeof (IP4_ADDR));\r
1127\r
1128 if (!IP4_IS_MULTICAST (NTOHL (McastIp))) {\r
1129 return EFI_INVALID_PARAMETER;\r
1130 }\r
1131 }\r
1132\r
1133 IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r
1134 OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
1135\r
1136 if (IpInstance->State != IP4_STATE_CONFIGED) {\r
1137 Status = EFI_NOT_STARTED;\r
1138 goto ON_EXIT;\r
1139 }\r
1140\r
1141 if (IpInstance->ConfigData.UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) {\r
1142 Status = EFI_NO_MAPPING;\r
1143 goto ON_EXIT;\r
1144 }\r
1145\r
1146 Status = Ip4Groups (IpInstance, JoinFlag, GroupAddress);\r
1147\r
1148ON_EXIT:\r
1149 gBS->RestoreTPL (OldTpl);\r
1150 return Status;\r
1151}\r
1152\r
1153\r
1154/**\r
1155 Adds and deletes routing table entries.\r
1156\r
1157 The Routes() function adds a route to or deletes a route from the routing table.\r
1158\r
1159 Routes are determined by comparing the SubnetAddress with the destination IPv4\r
1160 address arithmetically AND-ed with the SubnetMask. The gateway address must be\r
1161 on the same subnet as the configured station address.\r
1162\r
1163 The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0.\r
1164 The default route matches all destination IPv4 addresses that do not match any\r
1165 other routes.\r
1166\r
1167 A GatewayAddress that is zero is a nonroute. Packets are sent to the destination\r
1168 IP address if it can be found in the ARP cache or on the local subnet. One automatic\r
1169 nonroute entry will be inserted into the routing table for outgoing packets that\r
1170 are addressed to a local subnet (gateway address of 0.0.0.0).\r
1171\r
1172 Each EFI IPv4 Protocol instance has its own independent routing table. Those EFI\r
1173 IPv4 Protocol instances that use the default IPv4 address will also have copies\r
1174 of the routing table that was provided by the EFI_IP4_CONFIG_PROTOCOL, and these\r
1175 copies will be updated whenever the EIF IPv4 Protocol driver reconfigures its\r
1176 instances. As a result, client modification to the routing table will be lost.\r
1177\r
1178 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
1179 @param[in] DeleteRoute Set to TRUE to delete this route from the routing table. Set to\r
1180 FALSE to add this route to the routing table. SubnetAddress\r
1181 and SubnetMask are used as the key to each route entry.\r
1182 @param[in] SubnetAddress The address of the subnet that needs to be routed.\r
1183 @param[in] SubnetMask The subnet mask of SubnetAddress.\r
1184 @param[in] GatewayAddress The unicast gateway IPv4 address for this route.\r
1185\r
1186 @retval EFI_SUCCESS The operation completed successfully.\r
1187 @retval EFI_NOT_STARTED The driver instance has not been started.\r
1188 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
1189 RARP, etc.) is not finished yet.\r
1190 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
1191 - This is NULL.\r
1192 - SubnetAddress is NULL.\r
1193 - SubnetMask is NULL.\r
1194 - GatewayAddress is NULL.\r
1195 - *SubnetAddress is not a valid subnet address.\r
1196 - *SubnetMask is not a valid subnet mask.\r
1197 - *GatewayAddress is not a valid unicast IPv4 address.\r
1198 @retval EFI_OUT_OF_RESOURCES Could not add the entry to the routing table.\r
1199 @retval EFI_NOT_FOUND This route is not in the routing table (when DeleteRoute is TRUE).\r
1200 @retval EFI_ACCESS_DENIED The route is already defined in the routing table (when\r
1201 DeleteRoute is FALSE).\r
1202\r
1203**/\r
1204EFI_STATUS\r
1205EFIAPI\r
1206EfiIp4Routes (\r
1207 IN EFI_IP4_PROTOCOL *This,\r
1208 IN BOOLEAN DeleteRoute,\r
1209 IN EFI_IPv4_ADDRESS *SubnetAddress,\r
1210 IN EFI_IPv4_ADDRESS *SubnetMask,\r
1211 IN EFI_IPv4_ADDRESS *GatewayAddress\r
1212 )\r
1213{\r
1214 IP4_PROTOCOL *IpInstance;\r
1215 IP4_INTERFACE *IpIf;\r
1216 IP4_ADDR Dest;\r
1217 IP4_ADDR Netmask;\r
1218 IP4_ADDR Nexthop;\r
1219 EFI_STATUS Status;\r
1220 EFI_TPL OldTpl;\r
1221\r
1222 //\r
1223 // First, validate the parameters\r
1224 //\r
1225 if ((This == NULL) || (SubnetAddress == NULL) ||\r
1226 (SubnetMask == NULL) || (GatewayAddress == NULL)) {\r
1227 return EFI_INVALID_PARAMETER;\r
1228 }\r
1229\r
1230 IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r
1231 OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
1232\r
1233 if (IpInstance->State != IP4_STATE_CONFIGED) {\r
1234 Status = EFI_NOT_STARTED;\r
1235 goto ON_EXIT;\r
1236 }\r
1237\r
1238 if (IpInstance->ConfigData.UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) {\r
1239 Status = EFI_NO_MAPPING;\r
1240 goto ON_EXIT;\r
1241 }\r
1242\r
1243 CopyMem (&Dest, SubnetAddress, sizeof (IP4_ADDR));\r
1244 CopyMem (&Netmask, SubnetMask, sizeof (IP4_ADDR));\r
1245 CopyMem (&Nexthop, GatewayAddress, sizeof (IP4_ADDR));\r
1246\r
1247 Dest = NTOHL (Dest);\r
1248 Netmask = NTOHL (Netmask);\r
1249 Nexthop = NTOHL (Nexthop);\r
1250\r
1251 IpIf = IpInstance->Interface;\r
1252\r
1253 if (!IP4_IS_VALID_NETMASK (Netmask)) {\r
1254 Status = EFI_INVALID_PARAMETER;\r
1255 goto ON_EXIT;\r
1256 }\r
1257\r
1258 //\r
1259 // the gateway address must be a unicast on the connected network if not zero.\r
1260 //\r
1261 if ((Nexthop != IP4_ALLZERO_ADDRESS) &&\r
1262 ((IpIf->SubnetMask != IP4_ALLONE_ADDRESS && !IP4_NET_EQUAL (Nexthop, IpIf->Ip, IpIf->SubnetMask)) ||\r
1263 IP4_IS_BROADCAST (Ip4GetNetCast (Nexthop, IpIf)))) {\r
1264\r
1265 Status = EFI_INVALID_PARAMETER;\r
1266 goto ON_EXIT;\r
1267 }\r
1268\r
1269 if (DeleteRoute) {\r
1270 Status = Ip4DelRoute (IpInstance->RouteTable, Dest, Netmask, Nexthop);\r
1271 } else {\r
1272 Status = Ip4AddRoute (IpInstance->RouteTable, Dest, Netmask, Nexthop);\r
1273 }\r
1274\r
1275ON_EXIT:\r
1276 gBS->RestoreTPL (OldTpl);\r
1277 return Status;\r
1278}\r
1279\r
1280\r
1281/**\r
1282 Check whether the user's token or event has already\r
1283 been enqueued on IP4's list.\r
1284\r
1285 @param[in] Map The container of either user's transmit or receive\r
1286 token.\r
1287 @param[in] Item Current item to check against.\r
1288 @param[in] Context The Token to check againist.\r
1289\r
1290 @retval EFI_ACCESS_DENIED The token or event has already been enqueued in IP.\r
1291 @retval EFI_SUCCESS The current item isn't the same token/event as the\r
1292 context.\r
1293\r
1294**/\r
1295EFI_STATUS\r
1296EFIAPI\r
1297Ip4TokenExist (\r
1298 IN NET_MAP *Map,\r
1299 IN NET_MAP_ITEM *Item,\r
1300 IN VOID *Context\r
1301 )\r
1302{\r
1303 EFI_IP4_COMPLETION_TOKEN *Token;\r
1304 EFI_IP4_COMPLETION_TOKEN *TokenInItem;\r
1305\r
1306 Token = (EFI_IP4_COMPLETION_TOKEN *) Context;\r
1307 TokenInItem = (EFI_IP4_COMPLETION_TOKEN *) Item->Key;\r
1308\r
1309 if ((Token == TokenInItem) || (Token->Event == TokenInItem->Event)) {\r
1310 return EFI_ACCESS_DENIED;\r
1311 }\r
1312\r
1313 return EFI_SUCCESS;\r
1314}\r
1315\r
1316/**\r
1317 Validate the user's token against current station address.\r
1318\r
1319 @param[in] Token User's token to validate.\r
1320 @param[in] IpIf The IP4 child's interface.\r
1321 @param[in] RawData Set to TRUE to send unformatted packets.\r
1322\r
1323 @retval EFI_INVALID_PARAMETER Some parameters are invalid.\r
1324 @retval EFI_BAD_BUFFER_SIZE The user's option/data is too long.\r
1325 @retval EFI_SUCCESS The token is valid.\r
1326\r
1327**/\r
1328EFI_STATUS\r
1329Ip4TxTokenValid (\r
1330 IN EFI_IP4_COMPLETION_TOKEN *Token,\r
1331 IN IP4_INTERFACE *IpIf,\r
1332 IN BOOLEAN RawData\r
1333 )\r
1334{\r
1335 EFI_IP4_TRANSMIT_DATA *TxData;\r
1336 EFI_IP4_OVERRIDE_DATA *Override;\r
1337 IP4_ADDR Src;\r
1338 IP4_ADDR Gateway;\r
1339 UINT32 Offset;\r
1340 UINT32 Index;\r
1341 UINT32 HeadLen;\r
1342\r
1343 if ((Token == NULL) || (Token->Event == NULL) || (Token->Packet.TxData == NULL)) {\r
1344 return EFI_INVALID_PARAMETER;\r
1345 }\r
1346\r
1347 TxData = Token->Packet.TxData;\r
1348\r
1349 //\r
1350 // Check the fragment table: no empty fragment, and length isn't bogus.\r
1351 //\r
1352 if ((TxData->TotalDataLength == 0) || (TxData->FragmentCount == 0)) {\r
1353 return EFI_INVALID_PARAMETER;\r
1354 }\r
1355\r
1356 Offset = TxData->TotalDataLength;\r
1357\r
1358 if (Offset > IP4_MAX_PACKET_SIZE) {\r
1359 return EFI_BAD_BUFFER_SIZE;\r
1360 }\r
1361\r
1362 for (Index = 0; Index < TxData->FragmentCount; Index++) {\r
1363 if ((TxData->FragmentTable[Index].FragmentBuffer == NULL) ||\r
1364 (TxData->FragmentTable[Index].FragmentLength == 0)) {\r
1365\r
1366 return EFI_INVALID_PARAMETER;\r
1367 }\r
1368\r
1369 Offset -= TxData->FragmentTable[Index].FragmentLength;\r
1370 }\r
1371\r
1372 if (Offset != 0) {\r
1373 return EFI_INVALID_PARAMETER;\r
1374 }\r
1375\r
1376 //\r
1377 // NOTE that OptionsLength/OptionsBuffer/OverrideData are ignored if RawData\r
1378 // is TRUE.\r
1379 //\r
1380 if (RawData) {\r
1381 return EFI_SUCCESS;\r
1382 }\r
1383\r
1384 //\r
1385 // Check the IP options: no more than 40 bytes and format is OK\r
1386 //\r
1387 if (TxData->OptionsLength != 0) {\r
1388 if ((TxData->OptionsLength > 40) || (TxData->OptionsBuffer == NULL)) {\r
1389 return EFI_INVALID_PARAMETER;\r
1390 }\r
1391\r
1392 if (!Ip4OptionIsValid (TxData->OptionsBuffer, TxData->OptionsLength, FALSE)) {\r
1393 return EFI_INVALID_PARAMETER;\r
1394 }\r
1395 }\r
1396\r
1397 //\r
1398 // Check the source and gateway: they must be a valid unicast.\r
1399 // Gateway must also be on the connected network.\r
1400 //\r
1401 if (TxData->OverrideData != NULL) {\r
1402 Override = TxData->OverrideData;\r
1403\r
1404 CopyMem (&Src, &Override->SourceAddress, sizeof (IP4_ADDR));\r
1405 CopyMem (&Gateway, &Override->GatewayAddress, sizeof (IP4_ADDR));\r
1406\r
1407 Src = NTOHL (Src);\r
1408 Gateway = NTOHL (Gateway);\r
1409\r
1410 if ((NetGetIpClass (Src) > IP4_ADDR_CLASSC) ||\r
1411 (Src == IP4_ALLONE_ADDRESS) ||\r
1412 IP4_IS_BROADCAST (Ip4GetNetCast (Src, IpIf))) {\r
1413\r
1414 return EFI_INVALID_PARAMETER;\r
1415 }\r
1416\r
1417 //\r
1418 // If gateway isn't zero, it must be a unicast address, and\r
1419 // on the connected network.\r
1420 //\r
1421 if ((Gateway != IP4_ALLZERO_ADDRESS) &&\r
1422 ((NetGetIpClass (Gateway) > IP4_ADDR_CLASSC) ||\r
1423 !IP4_NET_EQUAL (Gateway, IpIf->Ip, IpIf->SubnetMask) ||\r
1424 IP4_IS_BROADCAST (Ip4GetNetCast (Gateway, IpIf)))) {\r
1425\r
1426 return EFI_INVALID_PARAMETER;\r
1427 }\r
1428 }\r
1429\r
1430 //\r
1431 // Check the packet length: Head length and packet length all has a limit\r
1432 //\r
1433 HeadLen = sizeof (IP4_HEAD) + ((TxData->OptionsLength + 3) &~0x03);\r
1434\r
1435 if ((HeadLen > IP4_MAX_HEADLEN) ||\r
1436 (TxData->TotalDataLength + HeadLen > IP4_MAX_PACKET_SIZE)) {\r
1437\r
1438 return EFI_BAD_BUFFER_SIZE;\r
1439 }\r
1440\r
1441 return EFI_SUCCESS;\r
1442}\r
1443\r
1444\r
1445/**\r
1446 The callback function for the net buffer which wraps the user's\r
1447 transmit token. Although it seems this function is pretty simple,\r
1448 there are some subtle things.\r
1449 When user requests the IP to transmit a packet by passing it a\r
1450 token, the token is wrapped in an IP4_TXTOKEN_WRAP and the data\r
1451 is wrapped in an net buffer. the net buffer's Free function is\r
1452 set to Ip4FreeTxToken. The Token and token wrap are added to the\r
1453 IP child's TxToken map. Then the buffer is passed to Ip4Output for\r
1454 transmission. If something error happened before that, the buffer\r
1455 is freed, which in turn will free the token wrap. The wrap may\r
1456 have been added to the TxToken map or not, and the user's event\r
1457 shouldn't be fired because we are still in the EfiIp4Transmit. If\r
1458 the buffer has been sent by Ip4Output, it should be removed from\r
1459 the TxToken map and user's event signaled. The token wrap and buffer\r
1460 are bound together. Check the comments in Ip4Output for information\r
1461 about IP fragmentation.\r
1462\r
1463 @param[in] Context The token's wrap.\r
1464\r
1465**/\r
1466VOID\r
1467EFIAPI\r
1468Ip4FreeTxToken (\r
1469 IN VOID *Context\r
1470 )\r
1471{\r
1472 IP4_TXTOKEN_WRAP *Wrap;\r
1473 NET_MAP_ITEM *Item;\r
1474\r
1475 Wrap = (IP4_TXTOKEN_WRAP *) Context;\r
1476\r
1477 //\r
1478 // Signal IpSecRecycleEvent to inform IPsec free the memory\r
1479 //\r
1480 if (Wrap->IpSecRecycleSignal != NULL) {\r
1481 gBS->SignalEvent (Wrap->IpSecRecycleSignal);\r
1482 }\r
1483\r
1484 //\r
1485 // Find the token in the instance's map. EfiIp4Transmit put the\r
1486 // token to the map. If that failed, NetMapFindKey will return NULL.\r
1487 //\r
1488 Item = NetMapFindKey (&Wrap->IpInstance->TxTokens, Wrap->Token);\r
1489\r
1490 if (Item != NULL) {\r
1491 NetMapRemoveItem (&Wrap->IpInstance->TxTokens, Item, NULL);\r
1492 }\r
1493\r
1494 if (Wrap->Sent) {\r
1495 gBS->SignalEvent (Wrap->Token->Event);\r
1496\r
1497 //\r
1498 // Dispatch the DPC queued by the NotifyFunction of Token->Event.\r
1499 //\r
1500 DispatchDpc ();\r
1501 }\r
1502\r
1503 FreePool (Wrap);\r
1504}\r
1505\r
1506\r
1507/**\r
1508 The callback function to Ip4Output to update the transmit status.\r
1509\r
1510 @param Ip4Instance The Ip4Instance that request the transmit.\r
1511 @param Packet The user's transmit request.\r
1512 @param IoStatus The result of the transmission.\r
1513 @param Flag Not used during transmission.\r
1514 @param Context The token's wrap.\r
1515\r
1516**/\r
1517VOID\r
1518Ip4OnPacketSent (\r
1519 IP4_PROTOCOL *Ip4Instance,\r
1520 NET_BUF *Packet,\r
1521 EFI_STATUS IoStatus,\r
1522 UINT32 Flag,\r
1523 VOID *Context\r
1524 )\r
1525{\r
1526 IP4_TXTOKEN_WRAP *Wrap;\r
1527\r
1528 //\r
1529 // This is the transmission request from upper layer,\r
1530 // not the IP4 driver itself.\r
1531 //\r
1532 ASSERT (Ip4Instance != NULL);\r
1533\r
1534 //\r
1535 // The first fragment of the packet has been sent. Update\r
1536 // the token's status. That is, if fragmented, the transmit's\r
1537 // status is the first fragment's status. The Wrap will be\r
1538 // release when all the fragments are release. Check the comments\r
1539 // in Ip4FreeTxToken and Ip4Output for information.\r
1540 //\r
1541 Wrap = (IP4_TXTOKEN_WRAP *) Context;\r
1542 Wrap->Token->Status = IoStatus;\r
1543\r
1544 NetbufFree (Wrap->Packet);\r
1545}\r
1546\r
1547\r
1548/**\r
1549 Places outgoing data packets into the transmit queue.\r
1550\r
1551 The Transmit() function places a sending request in the transmit queue of this\r
1552 EFI IPv4 Protocol instance. Whenever the packet in the token is sent out or some\r
1553 errors occur, the event in the token will be signaled and the status is updated.\r
1554\r
1555 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
1556 @param[in] Token Pointer to the transmit token.\r
1557\r
1558 @retval EFI_SUCCESS The data has been queued for transmission.\r
1559 @retval EFI_NOT_STARTED This instance has not been started.\r
1560 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
1561 RARP, etc.) is not finished yet.\r
1562 @retval EFI_INVALID_PARAMETER One or more pameters are invalid.\r
1563 @retval EFI_ACCESS_DENIED The transmit completion token with the same Token.Event\r
1564 was already in the transmit queue.\r
1565 @retval EFI_NOT_READY The completion token could not be queued because the transmit\r
1566 queue is full.\r
1567 @retval EFI_NOT_FOUND Not route is found to destination address.\r
1568 @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data.\r
1569 @retval EFI_BUFFER_TOO_SMALL Token.Packet.TxData.TotalDataLength is too\r
1570 short to transmit.\r
1571 @retval EFI_BAD_BUFFER_SIZE The length of the IPv4 header + option length + total data length is\r
1572 greater than MTU (or greater than the maximum packet size if\r
1573 Token.Packet.TxData.OverrideData.\r
1574 DoNotFragment is TRUE).\r
1575\r
1576**/\r
1577EFI_STATUS\r
1578EFIAPI\r
1579EfiIp4Transmit (\r
1580 IN EFI_IP4_PROTOCOL *This,\r
1581 IN EFI_IP4_COMPLETION_TOKEN *Token\r
1582 )\r
1583{\r
1584 IP4_SERVICE *IpSb;\r
1585 IP4_PROTOCOL *IpInstance;\r
1586 IP4_INTERFACE *IpIf;\r
1587 IP4_TXTOKEN_WRAP *Wrap;\r
1588 EFI_IP4_TRANSMIT_DATA *TxData;\r
1589 EFI_IP4_CONFIG_DATA *Config;\r
1590 EFI_IP4_OVERRIDE_DATA *Override;\r
1591 IP4_HEAD Head;\r
1592 IP4_ADDR GateWay;\r
1593 EFI_STATUS Status;\r
1594 EFI_TPL OldTpl;\r
1595 BOOLEAN DontFragment;\r
1596 UINT32 HeadLen;\r
1597 UINT8 RawHdrLen;\r
1598 UINT32 OptionsLength;\r
1599 UINT8 *OptionsBuffer;\r
1600 VOID *FirstFragment;\r
1601\r
1602 if (This == NULL) {\r
1603 return EFI_INVALID_PARAMETER;\r
1604 }\r
1605\r
1606 IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r
1607\r
1608 if (IpInstance->State != IP4_STATE_CONFIGED) {\r
1609 return EFI_NOT_STARTED;\r
1610 }\r
1611\r
1612 OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
1613\r
1614 IpSb = IpInstance->Service;\r
1615 IpIf = IpInstance->Interface;\r
1616 Config = &IpInstance->ConfigData;\r
1617\r
1618 if (Config->UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) {\r
1619 Status = EFI_NO_MAPPING;\r
1620 goto ON_EXIT;\r
1621 }\r
1622\r
1623 //\r
1624 // make sure that token is properly formated\r
1625 //\r
1626 Status = Ip4TxTokenValid (Token, IpIf, Config->RawData);\r
1627\r
1628 if (EFI_ERROR (Status)) {\r
1629 goto ON_EXIT;\r
1630 }\r
1631\r
1632 //\r
1633 // Check whether the token or signal already existed.\r
1634 //\r
1635 if (EFI_ERROR (NetMapIterate (&IpInstance->TxTokens, Ip4TokenExist, Token))) {\r
1636 Status = EFI_ACCESS_DENIED;\r
1637 goto ON_EXIT;\r
1638 }\r
1639\r
1640 //\r
1641 // Build the IP header, need to fill in the Tos, TotalLen, Id,\r
1642 // fragment, Ttl, protocol, Src, and Dst.\r
1643 //\r
1644 TxData = Token->Packet.TxData;\r
1645\r
1646 FirstFragment = NULL;\r
1647\r
1648 if (Config->RawData) {\r
1649 //\r
1650 // When RawData is TRUE, first buffer in FragmentTable points to a raw\r
1651 // IPv4 fragment including IPv4 header and options.\r
1652 //\r
1653 FirstFragment = TxData->FragmentTable[0].FragmentBuffer;\r
1654 CopyMem (&RawHdrLen, FirstFragment, sizeof (UINT8));\r
1655\r
1656 RawHdrLen = (UINT8) (RawHdrLen & 0x0f);\r
1657 if (RawHdrLen < 5) {\r
1658 Status = EFI_INVALID_PARAMETER;\r
1659 goto ON_EXIT;\r
1660 }\r
1661\r
1662 RawHdrLen = (UINT8) (RawHdrLen << 2);\r
1663\r
1664 CopyMem (&Head, FirstFragment, IP4_MIN_HEADLEN);\r
1665\r
1666 Ip4NtohHead (&Head);\r
1667 HeadLen = 0;\r
1668 DontFragment = IP4_DO_NOT_FRAGMENT (Head.Fragment);\r
1669\r
1670 if (!DontFragment) {\r
1671 Status = EFI_INVALID_PARAMETER;\r
1672 goto ON_EXIT;\r
1673 }\r
1674\r
1675 GateWay = IP4_ALLZERO_ADDRESS;\r
1676\r
1677 //\r
1678 // Get IPv4 options from first fragment.\r
1679 //\r
1680 if (RawHdrLen == IP4_MIN_HEADLEN) {\r
1681 OptionsLength = 0;\r
1682 OptionsBuffer = NULL;\r
1683 } else {\r
1684 OptionsLength = RawHdrLen - IP4_MIN_HEADLEN;\r
1685 OptionsBuffer = (UINT8 *) FirstFragment + IP4_MIN_HEADLEN;\r
1686 }\r
1687\r
1688 //\r
1689 // Trim off IPv4 header and options from first fragment.\r
1690 //\r
1691 TxData->FragmentTable[0].FragmentBuffer = (UINT8 *) FirstFragment + RawHdrLen;\r
1692 TxData->FragmentTable[0].FragmentLength = TxData->FragmentTable[0].FragmentLength - RawHdrLen;\r
1693 } else {\r
1694 CopyMem (&Head.Dst, &TxData->DestinationAddress, sizeof (IP4_ADDR));\r
1695 Head.Dst = NTOHL (Head.Dst);\r
1696\r
1697 if (TxData->OverrideData != NULL) {\r
1698 Override = TxData->OverrideData;\r
1699 Head.Protocol = Override->Protocol;\r
1700 Head.Tos = Override->TypeOfService;\r
1701 Head.Ttl = Override->TimeToLive;\r
1702 DontFragment = Override->DoNotFragment;\r
1703\r
1704 CopyMem (&Head.Src, &Override->SourceAddress, sizeof (IP4_ADDR));\r
1705 CopyMem (&GateWay, &Override->GatewayAddress, sizeof (IP4_ADDR));\r
1706\r
1707 Head.Src = NTOHL (Head.Src);\r
1708 GateWay = NTOHL (GateWay);\r
1709 } else {\r
1710 Head.Src = IpIf->Ip;\r
1711 GateWay = IP4_ALLZERO_ADDRESS;\r
1712 Head.Protocol = Config->DefaultProtocol;\r
1713 Head.Tos = Config->TypeOfService;\r
1714 Head.Ttl = Config->TimeToLive;\r
1715 DontFragment = Config->DoNotFragment;\r
1716 }\r
1717\r
1718 Head.Fragment = IP4_HEAD_FRAGMENT_FIELD (DontFragment, FALSE, 0);\r
1719 HeadLen = (TxData->OptionsLength + 3) & (~0x03);\r
1720\r
1721 OptionsLength = TxData->OptionsLength;\r
1722 OptionsBuffer = (UINT8 *) (TxData->OptionsBuffer);\r
1723 }\r
1724\r
1725 //\r
1726 // If don't fragment and fragment needed, return error\r
1727 //\r
1728 if (DontFragment && (TxData->TotalDataLength + HeadLen > IpSb->MaxPacketSize)) {\r
1729 Status = EFI_BAD_BUFFER_SIZE;\r
1730 goto ON_EXIT;\r
1731 }\r
1732\r
1733 //\r
1734 // OK, it survives all the validation check. Wrap the token in\r
1735 // a IP4_TXTOKEN_WRAP and the data in a netbuf\r
1736 //\r
1737 Status = EFI_OUT_OF_RESOURCES;\r
1738 Wrap = AllocateZeroPool (sizeof (IP4_TXTOKEN_WRAP));\r
1739 if (Wrap == NULL) {\r
1740 goto ON_EXIT;\r
1741 }\r
1742\r
1743 Wrap->IpInstance = IpInstance;\r
1744 Wrap->Token = Token;\r
1745 Wrap->Sent = FALSE;\r
1746 Wrap->Life = IP4_US_TO_SEC (Config->TransmitTimeout);\r
1747 Wrap->Packet = NetbufFromExt (\r
1748 (NET_FRAGMENT *) TxData->FragmentTable,\r
1749 TxData->FragmentCount,\r
1750 IP4_MAX_HEADLEN,\r
1751 0,\r
1752 Ip4FreeTxToken,\r
1753 Wrap\r
1754 );\r
1755\r
1756 if (Wrap->Packet == NULL) {\r
1757 FreePool (Wrap);\r
1758 goto ON_EXIT;\r
1759 }\r
1760\r
1761 Token->Status = EFI_NOT_READY;\r
1762\r
1763 if (EFI_ERROR (NetMapInsertTail (&IpInstance->TxTokens, Token, Wrap))) {\r
1764 //\r
1765 // NetbufFree will call Ip4FreeTxToken, which in turn will\r
1766 // free the IP4_TXTOKEN_WRAP. Now, the token wrap hasn't been\r
1767 // enqueued.\r
1768 //\r
1769 if (Config->RawData) {\r
1770 //\r
1771 // Restore pointer of first fragment in RawData mode.\r
1772 //\r
1773 TxData->FragmentTable[0].FragmentBuffer = (UINT8 *) FirstFragment;\r
1774 }\r
1775\r
1776 NetbufFree (Wrap->Packet);\r
1777 goto ON_EXIT;\r
1778 }\r
1779\r
1780 //\r
1781 // Mark the packet sent before output it. Mark it not sent again if the\r
1782 // returned status is not EFI_SUCCESS;\r
1783 //\r
1784 Wrap->Sent = TRUE;\r
1785\r
1786 Status = Ip4Output (\r
1787 IpSb,\r
1788 IpInstance,\r
1789 Wrap->Packet,\r
1790 &Head,\r
1791 OptionsBuffer,\r
1792 OptionsLength,\r
1793 GateWay,\r
1794 Ip4OnPacketSent,\r
1795 Wrap\r
1796 );\r
1797\r
1798 if (EFI_ERROR (Status)) {\r
1799 Wrap->Sent = FALSE;\r
1800\r
1801 if (Config->RawData) {\r
1802 //\r
1803 // Restore pointer of first fragment in RawData mode.\r
1804 //\r
1805 TxData->FragmentTable[0].FragmentBuffer = (UINT8 *) FirstFragment;\r
1806 }\r
1807\r
1808 NetbufFree (Wrap->Packet);\r
1809 }\r
1810\r
1811 if (Config->RawData) {\r
1812 //\r
1813 // Restore pointer of first fragment in RawData mode.\r
1814 //\r
1815 TxData->FragmentTable[0].FragmentBuffer = (UINT8 *) FirstFragment;\r
1816 }\r
1817\r
1818ON_EXIT:\r
1819 gBS->RestoreTPL (OldTpl);\r
1820 return Status;\r
1821}\r
1822\r
1823\r
1824/**\r
1825 Places a receiving request into the receiving queue.\r
1826\r
1827 The Receive() function places a completion token into the receive packet queue.\r
1828 This function is always asynchronous.\r
1829\r
1830 The Token.Event field in the completion token must be filled in by the caller\r
1831 and cannot be NULL. When the receive operation completes, the EFI IPv4 Protocol\r
1832 driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event\r
1833 is signaled.\r
1834\r
1835 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
1836 @param[in] Token Pointer to a token that is associated with the receive data descriptor.\r
1837\r
1838 @retval EFI_SUCCESS The receive completion token was cached.\r
1839 @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r
1840 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, RARP, etc.)\r
1841 is not finished yet.\r
1842 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
1843 - This is NULL.\r
1844 - Token is NULL.\r
1845 - Token.Event is NULL.\r
1846 @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system\r
1847 resources (usually memory).\r
1848 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
1849 The EFI IPv4 Protocol instance has been reset to startup defaults.\r
1850 EFI_ACCESS_DENIED The receive completion token with the same Token.Event was already\r
1851 in the receive queue.\r
1852 @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full.\r
1853 @retval EFI_ICMP_ERROR An ICMP error packet was received.\r
1854\r
1855**/\r
1856EFI_STATUS\r
1857EFIAPI\r
1858EfiIp4Receive (\r
1859 IN EFI_IP4_PROTOCOL *This,\r
1860 IN EFI_IP4_COMPLETION_TOKEN *Token\r
1861 )\r
1862{\r
1863 IP4_PROTOCOL *IpInstance;\r
1864 EFI_STATUS Status;\r
1865 EFI_TPL OldTpl;\r
1866\r
1867 //\r
1868 // First validate the parameters\r
1869 //\r
1870 if ((This == NULL) || (Token == NULL) || (Token->Event == NULL)) {\r
1871 return EFI_INVALID_PARAMETER;\r
1872 }\r
1873\r
1874 IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r
1875\r
1876 OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
1877\r
1878 if (IpInstance->State != IP4_STATE_CONFIGED) {\r
1879 Status = EFI_NOT_STARTED;\r
1880 goto ON_EXIT;\r
1881 }\r
1882\r
1883 //\r
1884 // Check whether the toke is already on the receive queue.\r
1885 //\r
1886 Status = NetMapIterate (&IpInstance->RxTokens, Ip4TokenExist, Token);\r
1887\r
1888 if (EFI_ERROR (Status)) {\r
1889 Status = EFI_ACCESS_DENIED;\r
1890 goto ON_EXIT;\r
1891 }\r
1892\r
1893 //\r
1894 // Queue the token then check whether there is pending received packet.\r
1895 //\r
1896 Status = NetMapInsertTail (&IpInstance->RxTokens, Token, NULL);\r
1897\r
1898 if (EFI_ERROR (Status)) {\r
1899 goto ON_EXIT;\r
1900 }\r
1901\r
1902 Status = Ip4InstanceDeliverPacket (IpInstance);\r
1903\r
1904 //\r
1905 // Dispatch the DPC queued by the NotifyFunction of this instane's receive\r
1906 // event.\r
1907 //\r
1908 DispatchDpc ();\r
1909\r
1910ON_EXIT:\r
1911 gBS->RestoreTPL (OldTpl);\r
1912 return Status;\r
1913}\r
1914\r
1915\r
1916/**\r
1917 Cancel the transmitted but not recycled packet. If a matching\r
1918 token is found, it will call Ip4CancelPacket to cancel the\r
1919 packet. Ip4CancelPacket will cancel all the fragments of the\r
1920 packet. When all the fragments are freed, the IP4_TXTOKEN_WRAP\r
1921 will be deleted from the Map, and user's event signalled.\r
1922 Because Ip4CancelPacket and other functions are all called in\r
1923 line, so, after Ip4CancelPacket returns, the Item has been freed.\r
1924\r
1925 @param[in] Map The IP4 child's transmit queue.\r
1926 @param[in] Item The current transmitted packet to test.\r
1927 @param[in] Context The user's token to cancel.\r
1928\r
1929 @retval EFI_SUCCESS Continue to check the next Item.\r
1930 @retval EFI_ABORTED The user's Token (Token != NULL) is cancelled.\r
1931\r
1932**/\r
1933EFI_STATUS\r
1934EFIAPI\r
1935Ip4CancelTxTokens (\r
1936 IN NET_MAP *Map,\r
1937 IN NET_MAP_ITEM *Item,\r
1938 IN VOID *Context\r
1939 )\r
1940{\r
1941 EFI_IP4_COMPLETION_TOKEN *Token;\r
1942 IP4_TXTOKEN_WRAP *Wrap;\r
1943\r
1944 Token = (EFI_IP4_COMPLETION_TOKEN *) Context;\r
1945\r
1946 //\r
1947 // Return EFI_SUCCESS to check the next item in the map if\r
1948 // this one doesn't match.\r
1949 //\r
1950 if ((Token != NULL) && (Token != Item->Key)) {\r
1951 return EFI_SUCCESS;\r
1952 }\r
1953\r
1954 Wrap = (IP4_TXTOKEN_WRAP *) Item->Value;\r
1955 ASSERT (Wrap != NULL);\r
1956\r
1957 //\r
1958 // Don't access the Item, Wrap and Token's members after this point.\r
1959 // Item and wrap has been freed. And we no longer own the Token.\r
1960 //\r
1961 Ip4CancelPacket (Wrap->IpInstance->Interface, Wrap->Packet, EFI_ABORTED);\r
1962\r
1963 //\r
1964 // If only one item is to be cancel, return EFI_ABORTED to stop\r
1965 // iterating the map any more.\r
1966 //\r
1967 if (Token != NULL) {\r
1968 return EFI_ABORTED;\r
1969 }\r
1970\r
1971 return EFI_SUCCESS;\r
1972}\r
1973\r
1974\r
1975/**\r
1976 Cancel the receive request. This is quiet simple, because\r
1977 it is only enqueued in our local receive map.\r
1978\r
1979 @param[in] Map The IP4 child's receive queue.\r
1980 @param[in] Item Current receive request to cancel.\r
1981 @param[in] Context The user's token to cancel.\r
1982\r
1983 @retval EFI_SUCCESS Continue to check the next receive request on the\r
1984 queue.\r
1985 @retval EFI_ABORTED The user's token (token != NULL) has been\r
1986 cancelled.\r
1987\r
1988**/\r
1989EFI_STATUS\r
1990EFIAPI\r
1991Ip4CancelRxTokens (\r
1992 IN NET_MAP *Map,\r
1993 IN NET_MAP_ITEM *Item,\r
1994 IN VOID *Context\r
1995 )\r
1996{\r
1997 EFI_IP4_COMPLETION_TOKEN *Token;\r
1998 EFI_IP4_COMPLETION_TOKEN *This;\r
1999\r
2000 Token = (EFI_IP4_COMPLETION_TOKEN *) Context;\r
2001 This = Item->Key;\r
2002\r
2003 if ((Token != NULL) && (Token != This)) {\r
2004 return EFI_SUCCESS;\r
2005 }\r
2006\r
2007 NetMapRemoveItem (Map, Item, NULL);\r
2008\r
2009 This->Status = EFI_ABORTED;\r
2010 This->Packet.RxData = NULL;\r
2011 gBS->SignalEvent (This->Event);\r
2012\r
2013 if (Token != NULL) {\r
2014 return EFI_ABORTED;\r
2015 }\r
2016\r
2017 return EFI_SUCCESS;\r
2018}\r
2019\r
2020\r
2021/**\r
2022 Cancel the user's receive/transmit request.\r
2023\r
2024 @param[in] IpInstance The IP4 child.\r
2025 @param[in] Token The token to cancel. If NULL, all token will be\r
2026 cancelled.\r
2027\r
2028 @retval EFI_SUCCESS The token is cancelled.\r
2029 @retval EFI_NOT_FOUND The token isn't found on either the\r
2030 transmit/receive queue.\r
2031 @retval EFI_DEVICE_ERROR Not all token is cancelled when Token is NULL.\r
2032\r
2033**/\r
2034EFI_STATUS\r
2035Ip4Cancel (\r
2036 IN IP4_PROTOCOL *IpInstance,\r
2037 IN EFI_IP4_COMPLETION_TOKEN *Token OPTIONAL\r
2038 )\r
2039{\r
2040 EFI_STATUS Status;\r
2041\r
2042 //\r
2043 // First check the transmitted packet. Ip4CancelTxTokens returns\r
2044 // EFI_ABORTED to mean that the token has been cancelled when\r
2045 // token != NULL. So, return EFI_SUCCESS for this condition.\r
2046 //\r
2047 Status = NetMapIterate (&IpInstance->TxTokens, Ip4CancelTxTokens, Token);\r
2048\r
2049 if (EFI_ERROR (Status)) {\r
2050 if ((Token != NULL) && (Status == EFI_ABORTED)) {\r
2051 return EFI_SUCCESS;\r
2052 }\r
2053\r
2054 return Status;\r
2055 }\r
2056\r
2057 //\r
2058 // Check the receive queue. Ip4CancelRxTokens also returns EFI_ABORT\r
2059 // for Token!=NULL and it is cancelled.\r
2060 //\r
2061 Status = NetMapIterate (&IpInstance->RxTokens, Ip4CancelRxTokens, Token);\r
2062 //\r
2063 // Dispatch the DPCs queued by the NotifyFunction of the canceled rx token's\r
2064 // events.\r
2065 //\r
2066 DispatchDpc ();\r
2067 if (EFI_ERROR (Status)) {\r
2068 if ((Token != NULL) && (Status == EFI_ABORTED)) {\r
2069 return EFI_SUCCESS;\r
2070 }\r
2071\r
2072 return Status;\r
2073 }\r
2074\r
2075 //\r
2076 // OK, if the Token is found when Token != NULL, the NetMapIterate\r
2077 // will return EFI_ABORTED, which has been interrupted as EFI_SUCCESS.\r
2078 //\r
2079 if (Token != NULL) {\r
2080 return EFI_NOT_FOUND;\r
2081 }\r
2082\r
2083 //\r
2084 // If Token == NULL, cancel all the tokens. return error if no\r
2085 // all of them are cancelled.\r
2086 //\r
2087 if (!NetMapIsEmpty (&IpInstance->TxTokens) ||\r
2088 !NetMapIsEmpty (&IpInstance->RxTokens)) {\r
2089\r
2090 return EFI_DEVICE_ERROR;\r
2091 }\r
2092\r
2093 return EFI_SUCCESS;\r
2094}\r
2095\r
2096\r
2097/**\r
2098 Abort an asynchronous transmit or receive request.\r
2099\r
2100 The Cancel() function is used to abort a pending transmit or receive request.\r
2101 If the token is in the transmit or receive request queues, after calling this\r
2102 function, Token->Status will be set to EFI_ABORTED and then Token->Event will\r
2103 be signaled. If the token is not in one of the queues, which usually means the\r
2104 asynchronous operation has completed, this function will not signal the token\r
2105 and EFI_NOT_FOUND is returned.\r
2106\r
2107 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
2108 @param[in] Token Pointer to a token that has been issued by\r
2109 EFI_IP4_PROTOCOL.Transmit() or\r
2110 EFI_IP4_PROTOCOL.Receive(). If NULL, all pending\r
2111 tokens are aborted. Type EFI_IP4_COMPLETION_TOKEN is\r
2112 defined in EFI_IP4_PROTOCOL.Transmit().\r
2113\r
2114 @retval EFI_SUCCESS The asynchronous I/O request was aborted and\r
2115 Token.->Event was signaled. When Token is NULL, all\r
2116 pending requests were aborted and their events were signaled.\r
2117 @retval EFI_INVALID_PARAMETER This is NULL.\r
2118 @retval EFI_NOT_STARTED This instance has not been started.\r
2119 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
2120 RARP, etc.) is not finished yet.\r
2121 @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O request was\r
2122 not found in the transmit or receive queue. It has either completed\r
2123 or was not issued by Transmit() and Receive().\r
2124\r
2125**/\r
2126EFI_STATUS\r
2127EFIAPI\r
2128EfiIp4Cancel (\r
2129 IN EFI_IP4_PROTOCOL *This,\r
2130 IN EFI_IP4_COMPLETION_TOKEN *Token OPTIONAL\r
2131 )\r
2132{\r
2133 IP4_PROTOCOL *IpInstance;\r
2134 EFI_STATUS Status;\r
2135 EFI_TPL OldTpl;\r
2136\r
2137 if (This == NULL) {\r
2138 return EFI_INVALID_PARAMETER;\r
2139 }\r
2140\r
2141 IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r
2142\r
2143 OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
2144\r
2145 if (IpInstance->State != IP4_STATE_CONFIGED) {\r
2146 Status = EFI_NOT_STARTED;\r
2147 goto ON_EXIT;\r
2148 }\r
2149\r
2150 if (IpInstance->ConfigData.UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) {\r
2151 Status = EFI_NO_MAPPING;\r
2152 goto ON_EXIT;\r
2153 }\r
2154\r
2155 Status = Ip4Cancel (IpInstance, Token);\r
2156\r
2157ON_EXIT:\r
2158 gBS->RestoreTPL (OldTpl);\r
2159 return Status;\r
2160}\r
2161\r
2162\r
2163/**\r
2164 Polls for incoming data packets and processes outgoing data packets.\r
2165\r
2166 The Poll() function polls for incoming data packets and processes outgoing data\r
2167 packets. Network drivers and applications can call the EFI_IP4_PROTOCOL.Poll()\r
2168 function to increase the rate that data packets are moved between the communications\r
2169 device and the transmit and receive queues.\r
2170\r
2171 In some systems the periodic timer event may not poll the underlying communications\r
2172 device fast enough to transmit and/or receive all data packets without missing\r
2173 incoming packets or dropping outgoing packets. Drivers and applications that are\r
2174 experiencing packet loss should try calling the EFI_IP4_PROTOCOL.Poll() function\r
2175 more often.\r
2176\r
2177 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
2178\r
2179 @retval EFI_SUCCESS Incoming or outgoing data was processed.\r
2180 @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r
2181 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
2182 RARP, etc.) is not finished yet.\r
2183 @retval EFI_INVALID_PARAMETER This is NULL.\r
2184 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
2185 @retval EFI_NOT_READY No incoming or outgoing data is processed.\r
2186 @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue.\r
2187 Consider increasing the polling rate.\r
2188\r
2189**/\r
2190EFI_STATUS\r
2191EFIAPI\r
2192EfiIp4Poll (\r
2193 IN EFI_IP4_PROTOCOL *This\r
2194 )\r
2195{\r
2196 IP4_PROTOCOL *IpInstance;\r
2197 EFI_MANAGED_NETWORK_PROTOCOL *Mnp;\r
2198\r
2199 if (This == NULL) {\r
2200 return EFI_INVALID_PARAMETER;\r
2201 }\r
2202\r
2203 IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r
2204\r
2205 if (IpInstance->State == IP4_STATE_UNCONFIGED) {\r
2206 return EFI_NOT_STARTED;\r
2207 }\r
2208\r
2209 Mnp = IpInstance->Service->Mnp;\r
2210\r
2211 //\r
2212 // Don't lock the Poll function to enable the deliver of\r
2213 // the packet polled up.\r
2214 //\r
2215 return Mnp->Poll (Mnp);\r
2216}\r
2217\r
2218/**\r
2219 Decrease the life of the transmitted packets. If it is\r
2220 decreased to zero, cancel the packet. This function is\r
2221 called by Ip4PacketTimerTicking which time out both the\r
2222 received-but-not-delivered and transmitted-but-not-recycle\r
2223 packets.\r
2224\r
2225 @param[in] Map The IP4 child's transmit map.\r
2226 @param[in] Item Current transmitted packet.\r
2227 @param[in] Context Not used.\r
2228\r
2229 @retval EFI_SUCCESS Always returns EFI_SUCCESS.\r
2230\r
2231**/\r
2232EFI_STATUS\r
2233EFIAPI\r
2234Ip4SentPacketTicking (\r
2235 IN NET_MAP *Map,\r
2236 IN NET_MAP_ITEM *Item,\r
2237 IN VOID *Context\r
2238 )\r
2239{\r
2240 IP4_TXTOKEN_WRAP *Wrap;\r
2241\r
2242 Wrap = (IP4_TXTOKEN_WRAP *) Item->Value;\r
2243 ASSERT (Wrap != NULL);\r
2244\r
2245 if ((Wrap->Life > 0) && (--Wrap->Life == 0)) {\r
2246 Ip4CancelPacket (Wrap->IpInstance->Interface, Wrap->Packet, EFI_ABORTED);\r
2247 }\r
2248\r
2249 return EFI_SUCCESS;\r
2250}\r
2251\r
2252/**\r
2253 This heart beat timer of IP4 service instance times out all of its IP4 children's\r
2254 received-but-not-delivered and transmitted-but-not-recycle packets, and provides\r
2255 time input for its IGMP protocol.\r
2256\r
2257 @param[in] Event The IP4 service instance's heart beat timer.\r
2258 @param[in] Context The IP4 service instance.\r
2259\r
2260**/\r
2261VOID\r
2262EFIAPI\r
2263Ip4TimerTicking (\r
2264 IN EFI_EVENT Event,\r
2265 IN VOID *Context\r
2266 )\r
2267{\r
2268 IP4_SERVICE *IpSb;\r
2269\r
2270 IpSb = (IP4_SERVICE *) Context;\r
2271 NET_CHECK_SIGNATURE (IpSb, IP4_SERVICE_SIGNATURE);\r
2272\r
2273 Ip4PacketTimerTicking (IpSb);\r
2274 Ip4IgmpTicking (IpSb);\r
2275}\r
2276\r
2277/**\r
2278 This dedicated timer is used to poll underlying network media status. In case\r
2279 of cable swap or wireless network switch, a new round auto configuration will\r
2280 be initiated. The timer will signal the IP4 to run DHCP configuration again.\r
2281 IP4 driver will free old IP address related resource, such as route table and\r
2282 Interface, then initiate a DHCP process to acquire new IP, eventually create\r
2283 route table for new IP address.\r
2284\r
2285 @param[in] Event The IP4 service instance's heart beat timer.\r
2286 @param[in] Context The IP4 service instance.\r
2287\r
2288**/\r
2289VOID\r
2290EFIAPI\r
2291Ip4TimerReconfigChecking (\r
2292 IN EFI_EVENT Event,\r
2293 IN VOID *Context\r
2294 )\r
2295{\r
2296 IP4_SERVICE *IpSb;\r
2297 BOOLEAN OldMediaPresent;\r
2298 EFI_STATUS Status;\r
2299 EFI_SIMPLE_NETWORK_MODE SnpModeData;\r
2300\r
2301 IpSb = (IP4_SERVICE *) Context;\r
2302 NET_CHECK_SIGNATURE (IpSb, IP4_SERVICE_SIGNATURE);\r
2303\r
2304 OldMediaPresent = IpSb->MediaPresent;\r
2305\r
2306 //\r
2307 // Get fresh mode data from MNP, since underlying media status may change.\r
2308 // Here, it needs to mention that the MediaPresent can also be checked even if\r
2309 // EFI_NOT_STARTED returned while this MNP child driver instance isn't configured.\r
2310 //\r
2311 Status = IpSb->Mnp->GetModeData (IpSb->Mnp, NULL, &SnpModeData);\r
2312 if (EFI_ERROR (Status) && (Status != EFI_NOT_STARTED)) {\r
2313 return;\r
2314 }\r
2315\r
2316 IpSb->MediaPresent = SnpModeData.MediaPresent;\r
2317 //\r
2318 // Media transimit Unpresent to Present means new link movement is detected.\r
2319 //\r
2320 if (!OldMediaPresent && IpSb->MediaPresent && (IpSb->Ip4Config2Instance.Policy == Ip4Config2PolicyDhcp)) {\r
2321 //\r
2322 // Signal the IP4 to run the dhcp configuration again. IP4 driver will free\r
2323 // old IP address related resource, such as route table and Interface, then\r
2324 // initiate a DHCP round to acquire new IP, eventually\r
2325 // create route table for new IP address.\r
2326 //\r
2327 if (IpSb->ReconfigEvent != NULL) {\r
2328 Status = gBS->SignalEvent (IpSb->ReconfigEvent);\r
2329 DispatchDpc ();\r
2330 }\r
2331 }\r
2332}\r
EFI Development Kit II mirror for PVE