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