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