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