3 Copyright (c) 2005 - 2018, 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
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.
16 EFI_IPSEC2_PROTOCOL
*mIpSec
= NULL
;
19 Gets the current operational settings for this instance of the EFI IPv4 Protocol driver.
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
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.
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.
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
46 Assigns an IPv4 address and subnet mask to this EFI IPv4 Protocol driver instance.
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.
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
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.
68 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.
69 @param[in] IpConfigData Pointer to the EFI IPv4 Protocol configuration data structure.
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.
91 IN EFI_IP4_PROTOCOL
*This
,
92 IN EFI_IP4_CONFIG_DATA
*IpConfigData OPTIONAL
96 Joins and leaves multicast groups.
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.
102 If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left.
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.
108 @retval EFI_SUCCESS The operation completed successfully.
109 @retval EFI_INVALID_PARAMETER One or more of the following is TRUE:
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
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.
128 IN EFI_IP4_PROTOCOL
*This
,
130 IN EFI_IPv4_ADDRESS
*GroupAddress OPTIONAL
134 Adds and deletes routing table entries.
136 The Routes() function adds a route to or deletes a route from the routing table.
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.
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
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).
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.
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.
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:
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).
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
194 Places outgoing data packets into the transmit queue.
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.
200 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.
201 @param[in] Token Pointer to the transmit token.
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
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
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.)
225 IN EFI_IP4_PROTOCOL
*This
,
226 IN EFI_IP4_COMPLETION_TOKEN
*Token
230 Places a receiving request into the receiving queue.
232 The Receive() function places a completion token into the receive packet queue.
233 This function is always asynchronous.
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
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.
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.)
247 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
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.
264 IN EFI_IP4_PROTOCOL
*This
,
265 IN EFI_IP4_COMPLETION_TOKEN
*Token
269 Abort an asynchronous transmit or receive request.
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.
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().
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().
300 IN EFI_IP4_PROTOCOL
*This
,
301 IN EFI_IP4_COMPLETION_TOKEN
*Token OPTIONAL
305 Polls for incoming data packets and processes outgoing data packets.
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.
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
318 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.
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.
334 IN EFI_IP4_PROTOCOL
*This
338 mEfiIp4ProtocolTemplete
= {
350 Gets the current operational settings for this instance of the EFI IPv4 Protocol driver.
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
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.
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.
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
376 IP4_PROTOCOL
*IpInstance
;
378 EFI_IP4_CONFIG_DATA
*Config
;
384 return EFI_INVALID_PARAMETER
;
387 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
388 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
389 IpSb
= IpInstance
->Service
;
391 if (Ip4ModeData
!= NULL
) {
393 // IsStarted is "whether the EfiIp4Configure has been called".
394 // IsConfigured is "whether the station address has been configured"
396 Ip4ModeData
->IsStarted
= (BOOLEAN
)(IpInstance
->State
== IP4_STATE_CONFIGED
);
397 CopyMem (&Ip4ModeData
->ConfigData
, &IpInstance
->ConfigData
, sizeof (Ip4ModeData
->ConfigData
));
398 Ip4ModeData
->IsConfigured
= FALSE
;
400 Ip4ModeData
->GroupCount
= IpInstance
->GroupCount
;
401 Ip4ModeData
->GroupTable
= (EFI_IPv4_ADDRESS
*) IpInstance
->Groups
;
403 Ip4ModeData
->IcmpTypeCount
= 23;
404 Ip4ModeData
->IcmpTypeList
= mIp4SupportedIcmp
;
406 Ip4ModeData
->RouteTable
= NULL
;
407 Ip4ModeData
->RouteCount
= 0;
409 Ip4ModeData
->MaxPacketSize
= IpSb
->MaxPacketSize
;
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.
417 if (Ip4ModeData
->IsStarted
) {
418 Config
= &Ip4ModeData
->ConfigData
;
420 Ip
= HTONL (IpInstance
->Interface
->Ip
);
421 CopyMem (&Config
->StationAddress
, &Ip
, sizeof (EFI_IPv4_ADDRESS
));
423 Ip
= HTONL (IpInstance
->Interface
->SubnetMask
);
424 CopyMem (&Config
->SubnetMask
, &Ip
, sizeof (EFI_IPv4_ADDRESS
));
426 Ip4ModeData
->IsConfigured
= IpInstance
->Interface
->Configured
;
429 // Build a EFI route table for user from the internal route table.
431 Status
= Ip4BuildEfiRouteTable (IpInstance
);
433 if (EFI_ERROR (Status
)) {
434 gBS
->RestoreTPL (OldTpl
);
438 Ip4ModeData
->RouteTable
= IpInstance
->EfiRouteTable
;
439 Ip4ModeData
->RouteCount
= IpInstance
->EfiRouteCount
;
444 // Get fresh mode data from MNP, since underlying media status may change
446 Status
= IpSb
->Mnp
->GetModeData (IpSb
->Mnp
, MnpConfigData
, SnpModeData
);
448 gBS
->RestoreTPL (OldTpl
);
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.
464 @param[in] IpSb The IP4 service instance that is to be changed.
465 @param[in] Force Force the configuration or not.
467 @retval EFI_SUCCESS The MNP is successfully configured/reconfigured.
468 @retval Others Configuration failed.
472 Ip4ServiceConfigMnp (
473 IN IP4_SERVICE
*IpSb
,
478 LIST_ENTRY
*ProtoEntry
;
480 IP4_PROTOCOL
*IpInstance
;
482 BOOLEAN PromiscReceive
;
486 PromiscReceive
= FALSE
;
490 // Iterate through the IP children to check whether promiscuous
491 // receive setting has been changed. Update the interface's receive
494 NET_LIST_FOR_EACH (Entry
, &IpSb
->Interfaces
) {
496 IpIf
= NET_LIST_USER_STRUCT (Entry
, IP4_INTERFACE
, Link
);
497 IpIf
->PromiscRecv
= FALSE
;
499 NET_LIST_FOR_EACH (ProtoEntry
, &IpIf
->IpInstances
) {
500 IpInstance
= NET_LIST_USER_STRUCT (ProtoEntry
, IP4_PROTOCOL
, AddrLink
);
502 if (IpInstance
->ConfigData
.AcceptPromiscuous
) {
503 IpIf
->PromiscRecv
= TRUE
;
504 PromiscReceive
= TRUE
;
510 // If promiscuous receive isn't changed, it isn't necessary to reconfigure.
512 if (PromiscReceive
== IpSb
->MnpConfigData
.EnablePromiscuousReceive
) {
517 IpSb
->MnpConfigData
.EnablePromiscuousReceive
= PromiscReceive
;
520 Status
= IpSb
->Mnp
->Configure (IpSb
->Mnp
, &IpSb
->MnpConfigData
);
523 // recover the original configuration if failed to set the configure.
525 if (EFI_ERROR (Status
) && Reconfig
) {
526 IpSb
->MnpConfigData
.EnablePromiscuousReceive
= (BOOLEAN
) !PromiscReceive
;
534 Intiialize the IP4_PROTOCOL structure to the unconfigured states.
536 @param IpSb The IP4 service instance.
537 @param IpInstance The IP4 child instance.
542 IN IP4_SERVICE
*IpSb
,
543 IN OUT IP4_PROTOCOL
*IpInstance
546 ASSERT ((IpSb
!= NULL
) && (IpInstance
!= NULL
));
548 ZeroMem (IpInstance
, sizeof (IP4_PROTOCOL
));
550 IpInstance
->Signature
= IP4_PROTOCOL_SIGNATURE
;
551 CopyMem (&IpInstance
->Ip4Proto
, &mEfiIp4ProtocolTemplete
, sizeof (IpInstance
->Ip4Proto
));
552 IpInstance
->State
= IP4_STATE_UNCONFIGED
;
553 IpInstance
->InDestroy
= FALSE
;
554 IpInstance
->Service
= IpSb
;
556 InitializeListHead (&IpInstance
->Link
);
557 NetMapInit (&IpInstance
->RxTokens
);
558 NetMapInit (&IpInstance
->TxTokens
);
559 InitializeListHead (&IpInstance
->Received
);
560 InitializeListHead (&IpInstance
->Delivered
);
561 InitializeListHead (&IpInstance
->AddrLink
);
563 EfiInitializeLock (&IpInstance
->RecycleLock
, TPL_NOTIFY
);
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.
573 @param[in, out] IpInstance The IP4 child to configure.
574 @param[in] Config The configure data.
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.
589 IN OUT IP4_PROTOCOL
*IpInstance
,
590 IN EFI_IP4_CONFIG_DATA
*Config
598 EFI_ARP_PROTOCOL
*Arp
;
599 EFI_IP4_CONFIG2_PROTOCOL
*Ip4Config2
;
600 EFI_IP4_CONFIG2_POLICY Policy
;
602 IpSb
= IpInstance
->Service
;
607 // User is changing packet filters. It must be stopped
608 // before the station address can be changed.
610 if (IpInstance
->State
== IP4_STATE_CONFIGED
) {
612 // Cancel all the pending transmit/receive from upper layer
614 Status
= Ip4Cancel (IpInstance
, NULL
);
616 if (EFI_ERROR (Status
)) {
617 return EFI_DEVICE_ERROR
;
620 CopyMem (&IpInstance
->ConfigData
, Config
, sizeof (IpInstance
->ConfigData
));
625 // Configure a fresh IP4 protocol instance. Create a route table.
626 // Each IP child has its own route table, which may point to the
627 // default table if it is using default address.
629 Status
= EFI_OUT_OF_RESOURCES
;
630 IpInstance
->RouteTable
= Ip4CreateRouteTable ();
632 if (IpInstance
->RouteTable
== NULL
) {
637 // Set up the interface.
639 CopyMem (&Ip
, &Config
->StationAddress
, sizeof (IP4_ADDR
));
640 CopyMem (&Netmask
, &Config
->SubnetMask
, sizeof (IP4_ADDR
));
643 Netmask
= NTOHL (Netmask
);
645 if (!Config
->UseDefaultAddress
) {
647 // Find whether there is already an interface with the same
648 // station address. All the instances with the same station
649 // address shares one interface.
651 IpIf
= Ip4FindStationAddress (IpSb
, Ip
, Netmask
);
657 IpIf
= Ip4CreateInterface (IpSb
->Mnp
, IpSb
->Controller
, IpSb
->Image
);
663 Status
= Ip4SetAddress (IpIf
, Ip
, Netmask
);
665 if (EFI_ERROR (Status
)) {
666 Status
= EFI_DEVICE_ERROR
;
667 Ip4FreeInterface (IpIf
, IpInstance
);
671 InsertTailList (&IpSb
->Interfaces
, &IpIf
->Link
);
675 // Add a route to this connected network in the route table
677 Ip4AddRoute (IpInstance
->RouteTable
, Ip
, Netmask
, IP4_ALLZERO_ADDRESS
);
681 // Use the default address. Check the state.
683 if (IpSb
->State
== IP4_SERVICE_UNSTARTED
) {
685 // Trigger the EFI_IP4_CONFIG2_PROTOCOL to retrieve the
686 // default IPv4 address if it is not available yet.
688 Policy
= IpSb
->Ip4Config2Instance
.Policy
;
689 if (Policy
!= Ip4Config2PolicyDhcp
) {
690 Ip4Config2
= &IpSb
->Ip4Config2Instance
.Ip4Config2
;
691 Policy
= Ip4Config2PolicyDhcp
;
692 Status
= Ip4Config2
->SetData (
694 Ip4Config2DataTypePolicy
,
695 sizeof (EFI_IP4_CONFIG2_POLICY
),
698 if (EFI_ERROR (Status
)) {
704 IpIf
= IpSb
->DefaultInterface
;
705 NET_GET_REF (IpSb
->DefaultInterface
);
708 // If default address is used, so is the default route table.
709 // Any route set by the instance has the precedence over the
710 // routes in the default route table. Link the default table
711 // after the instance's table. Routing will search the local
714 NET_GET_REF (IpSb
->DefaultRouteTable
);
715 IpInstance
->RouteTable
->Next
= IpSb
->DefaultRouteTable
;
718 IpInstance
->Interface
= IpIf
;
719 if (IpIf
->Arp
!= NULL
) {
721 Status
= gBS
->OpenProtocol (
723 &gEfiArpProtocolGuid
,
725 gIp4DriverBinding
.DriverBindingHandle
,
727 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
729 if (EFI_ERROR (Status
)) {
730 Ip4FreeInterface (IpIf
, IpInstance
);
734 InsertTailList (&IpIf
->IpInstances
, &IpInstance
->AddrLink
);
736 CopyMem (&IpInstance
->ConfigData
, Config
, sizeof (IpInstance
->ConfigData
));
737 IpInstance
->State
= IP4_STATE_CONFIGED
;
740 // Although EFI_NO_MAPPING is an error code, the IP child has been
741 // successfully configured and doesn't need reconfiguration when
742 // default address is acquired.
744 if (Config
->UseDefaultAddress
&& IP4_NO_MAPPING (IpInstance
)) {
745 return EFI_NO_MAPPING
;
751 Ip4FreeRouteTable (IpInstance
->RouteTable
);
752 IpInstance
->RouteTable
= NULL
;
758 Clean up the IP4 child, release all the resources used by it.
760 @param[in] IpInstance The IP4 child to clean up.
762 @retval EFI_SUCCESS The IP4 child is cleaned up.
763 @retval EFI_DEVICE_ERROR Some resources failed to be released.
768 IN IP4_PROTOCOL
*IpInstance
771 if (EFI_ERROR (Ip4Cancel (IpInstance
, NULL
))) {
772 return EFI_DEVICE_ERROR
;
775 if (EFI_ERROR (Ip4Groups (IpInstance
, FALSE
, NULL
))) {
776 return EFI_DEVICE_ERROR
;
780 // Some packets haven't been recycled. It is because either the
781 // user forgets to recycle the packets, or because the callback
782 // hasn't been called. Just leave it alone.
784 if (!IsListEmpty (&IpInstance
->Delivered
)) {
788 if (IpInstance
->Interface
!= NULL
) {
789 RemoveEntryList (&IpInstance
->AddrLink
);
790 if (IpInstance
->Interface
->Arp
!= NULL
) {
792 IpInstance
->Interface
->ArpHandle
,
793 &gEfiArpProtocolGuid
,
794 gIp4DriverBinding
.DriverBindingHandle
,
798 Ip4FreeInterface (IpInstance
->Interface
, IpInstance
);
799 IpInstance
->Interface
= NULL
;
802 if (IpInstance
->RouteTable
!= NULL
) {
803 if (IpInstance
->RouteTable
->Next
!= NULL
) {
804 Ip4FreeRouteTable (IpInstance
->RouteTable
->Next
);
807 Ip4FreeRouteTable (IpInstance
->RouteTable
);
808 IpInstance
->RouteTable
= NULL
;
811 if (IpInstance
->EfiRouteTable
!= NULL
) {
812 FreePool (IpInstance
->EfiRouteTable
);
813 IpInstance
->EfiRouteTable
= NULL
;
814 IpInstance
->EfiRouteCount
= 0;
817 if (IpInstance
->Groups
!= NULL
) {
818 FreePool (IpInstance
->Groups
);
819 IpInstance
->Groups
= NULL
;
820 IpInstance
->GroupCount
= 0;
823 NetMapClean (&IpInstance
->TxTokens
);
825 NetMapClean (&IpInstance
->RxTokens
);
832 Assigns an IPv4 address and subnet mask to this EFI IPv4 Protocol driver instance.
834 The Configure() function is used to set, change, or reset the operational
835 parameters and filter settings for this EFI IPv4 Protocol instance. Until these
836 parameters have been set, no network traffic can be sent or received by this
837 instance. Once the parameters have been reset (by calling this function with
838 IpConfigData set to NULL), no more traffic can be sent or received until these
839 parameters have been set again. Each EFI IPv4 Protocol instance can be started
840 and stopped independently of each other by enabling or disabling their receive
841 filter settings with the Configure() function.
843 When IpConfigData.UseDefaultAddress is set to FALSE, the new station address will
844 be appended as an alias address into the addresses list in the EFI IPv4 Protocol
845 driver. While set to TRUE, Configure() will trigger the EFI_IP4_CONFIG_PROTOCOL
846 to retrieve the default IPv4 address if it is not available yet. Clients could
847 frequently call GetModeData() to check the status to ensure that the default IPv4
850 If operational parameters are reset or changed, any pending transmit and receive
851 requests will be cancelled. Their completion token status will be set to EFI_ABORTED
852 and their events will be signaled.
854 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.
855 @param[in] IpConfigData Pointer to the EFI IPv4 Protocol configuration data structure.
857 @retval EFI_SUCCESS The driver instance was successfully opened.
858 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
859 RARP, etc.) is not finished yet.
860 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
861 @retval EFI_UNSUPPORTED One or more of the following conditions is TRUE:
862 A configuration protocol (DHCP, BOOTP, RARP, etc.) could
863 not be located when clients choose to use the default IPv4
864 address. This EFI IPv4 Protocol implementation does not
865 support this requested filter or timeout setting.
866 @retval EFI_OUT_OF_RESOURCES The EFI IPv4 Protocol driver instance data could not be allocated.
867 @retval EFI_ALREADY_STARTED The interface is already open and must be stopped before the
868 IPv4 address or subnet mask can be changed. The interface must
869 also be stopped when switching to/from raw packet mode.
870 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI IPv4
871 Protocol driver instance is not opened.
877 IN EFI_IP4_PROTOCOL
*This
,
878 IN EFI_IP4_CONFIG_DATA
*IpConfigData OPTIONAL
881 IP4_PROTOCOL
*IpInstance
;
882 EFI_IP4_CONFIG_DATA
*Current
;
890 // First, validate the parameters
893 return EFI_INVALID_PARAMETER
;
896 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
897 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
900 // Validate the configuration first.
902 if (IpConfigData
!= NULL
) {
904 CopyMem (&IpAddress
, &IpConfigData
->StationAddress
, sizeof (IP4_ADDR
));
905 CopyMem (&SubnetMask
, &IpConfigData
->SubnetMask
, sizeof (IP4_ADDR
));
907 IpAddress
= NTOHL (IpAddress
);
908 SubnetMask
= NTOHL (SubnetMask
);
911 // Check whether the station address is a valid unicast address
913 if (!IpConfigData
->UseDefaultAddress
) {
914 AddrOk
= Ip4StationAddressValid (IpAddress
, SubnetMask
);
917 Status
= EFI_INVALID_PARAMETER
;
923 // User can only update packet filters when already configured.
924 // If it wants to change the station address, it must configure(NULL)
925 // the instance first.
927 if (IpInstance
->State
== IP4_STATE_CONFIGED
) {
928 Current
= &IpInstance
->ConfigData
;
930 if (Current
->UseDefaultAddress
!= IpConfigData
->UseDefaultAddress
) {
931 Status
= EFI_ALREADY_STARTED
;
935 if (!Current
->UseDefaultAddress
&&
936 (!EFI_IP4_EQUAL (&Current
->StationAddress
, &IpConfigData
->StationAddress
) ||
937 !EFI_IP4_EQUAL (&Current
->SubnetMask
, &IpConfigData
->SubnetMask
))) {
938 Status
= EFI_ALREADY_STARTED
;
942 if (Current
->UseDefaultAddress
&& IP4_NO_MAPPING (IpInstance
)) {
943 Status
= EFI_NO_MAPPING
;
950 // Configure the instance or clean it up.
952 if (IpConfigData
!= NULL
) {
953 Status
= Ip4ConfigProtocol (IpInstance
, IpConfigData
);
955 Status
= Ip4CleanProtocol (IpInstance
);
958 // Consider the following valid sequence: Mnp is unloaded-->Ip Stopped-->Udp Stopped,
959 // Configure (ThisIp, NULL). If the state is changed to UNCONFIGED,
960 // the unload fails miserably.
962 if (IpInstance
->State
== IP4_STATE_CONFIGED
) {
963 IpInstance
->State
= IP4_STATE_UNCONFIGED
;
968 // Update the MNP's configure data. Ip4ServiceConfigMnp will check
969 // whether it is necessary to reconfigure the MNP.
971 Ip4ServiceConfigMnp (IpInstance
->Service
, FALSE
);
974 gBS
->RestoreTPL (OldTpl
);
981 Change the IP4 child's multicast setting. The caller
982 should make sure that the parameters is valid.
984 @param[in] IpInstance The IP4 child to change the setting.
985 @param[in] JoinFlag TRUE to join the group, otherwise leave it.
986 @param[in] GroupAddress The target group address.
988 @retval EFI_ALREADY_STARTED Want to join the group, but already a member of it.
989 @retval EFI_OUT_OF_RESOURCES Failed to allocate some resources.
990 @retval EFI_DEVICE_ERROR Failed to set the group configuraton.
991 @retval EFI_SUCCESS Successfully updated the group setting.
992 @retval EFI_NOT_FOUND Try to leave the group which it isn't a member.
997 IN IP4_PROTOCOL
*IpInstance
,
999 IN EFI_IPv4_ADDRESS
*GroupAddress OPTIONAL
1007 // Add it to the instance's Groups, and join the group by IGMP.
1008 // IpInstance->Groups is in network byte order. IGMP operates in
1013 // When JoinFlag is TRUE, GroupAddress shouldn't be NULL.
1015 ASSERT (GroupAddress
!= NULL
);
1016 CopyMem (&Group
, GroupAddress
, sizeof (IP4_ADDR
));
1018 for (Index
= 0; Index
< IpInstance
->GroupCount
; Index
++) {
1019 if (IpInstance
->Groups
[Index
] == Group
) {
1020 return EFI_ALREADY_STARTED
;
1024 Members
= Ip4CombineGroups (IpInstance
->Groups
, IpInstance
->GroupCount
, Group
);
1026 if (Members
== NULL
) {
1027 return EFI_OUT_OF_RESOURCES
;
1030 if (EFI_ERROR (Ip4JoinGroup (IpInstance
, NTOHL (Group
)))) {
1032 return EFI_DEVICE_ERROR
;
1035 if (IpInstance
->Groups
!= NULL
) {
1036 FreePool (IpInstance
->Groups
);
1039 IpInstance
->Groups
= Members
;
1040 IpInstance
->GroupCount
++;
1046 // Leave the group. Leave all the groups if GroupAddress is NULL.
1047 // Must iterate from the end to the beginning because the GroupCount
1048 // is decreamented each time an address is removed..
1050 for (Index
= IpInstance
->GroupCount
; Index
> 0 ; Index
--) {
1051 Group
= IpInstance
->Groups
[Index
- 1];
1053 if ((GroupAddress
== NULL
) || EFI_IP4_EQUAL (&Group
, GroupAddress
)) {
1054 if (EFI_ERROR (Ip4LeaveGroup (IpInstance
, NTOHL (Group
)))) {
1055 return EFI_DEVICE_ERROR
;
1058 Ip4RemoveGroupAddr (IpInstance
->Groups
, IpInstance
->GroupCount
, Group
);
1059 IpInstance
->GroupCount
--;
1061 if (IpInstance
->GroupCount
== 0) {
1062 ASSERT (Index
== 1);
1064 FreePool (IpInstance
->Groups
);
1065 IpInstance
->Groups
= NULL
;
1068 if (GroupAddress
!= NULL
) {
1074 return ((GroupAddress
!= NULL
) ? EFI_NOT_FOUND
: EFI_SUCCESS
);
1079 Joins and leaves multicast groups.
1081 The Groups() function is used to join and leave multicast group sessions. Joining
1082 a group will enable reception of matching multicast packets. Leaving a group will
1083 disable the multicast packet reception.
1085 If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left.
1087 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.
1088 @param[in] JoinFlag Set to TRUE to join the multicast group session and FALSE to leave.
1089 @param[in] GroupAddress Pointer to the IPv4 multicast address.
1091 @retval EFI_SUCCESS The operation completed successfully.
1092 @retval EFI_INVALID_PARAMETER One or more of the following is TRUE:
1094 - JoinFlag is TRUE and GroupAddress is NULL.
1095 - GroupAddress is not NULL and *GroupAddress is
1096 not a multicast IPv4 address.
1097 @retval EFI_NOT_STARTED This instance has not been started.
1098 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
1099 RARP, etc.) is not finished yet.
1100 @retval EFI_OUT_OF_RESOURCES System resources could not be allocated.
1101 @retval EFI_UNSUPPORTED This EFI IPv4 Protocol implementation does not support multicast groups.
1102 @retval EFI_ALREADY_STARTED The group address is already in the group table (when
1104 @retval EFI_NOT_FOUND The group address is not in the group table (when JoinFlag is FALSE).
1105 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
1111 IN EFI_IP4_PROTOCOL
*This
,
1112 IN BOOLEAN JoinFlag
,
1113 IN EFI_IPv4_ADDRESS
*GroupAddress OPTIONAL
1116 IP4_PROTOCOL
*IpInstance
;
1121 if ((This
== NULL
) || (JoinFlag
&& (GroupAddress
== NULL
))) {
1122 return EFI_INVALID_PARAMETER
;
1125 if (GroupAddress
!= NULL
) {
1126 CopyMem (&McastIp
, GroupAddress
, sizeof (IP4_ADDR
));
1128 if (!IP4_IS_MULTICAST (NTOHL (McastIp
))) {
1129 return EFI_INVALID_PARAMETER
;
1133 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
1134 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1136 if (IpInstance
->State
!= IP4_STATE_CONFIGED
) {
1137 Status
= EFI_NOT_STARTED
;
1141 if (IpInstance
->ConfigData
.UseDefaultAddress
&& IP4_NO_MAPPING (IpInstance
)) {
1142 Status
= EFI_NO_MAPPING
;
1146 Status
= Ip4Groups (IpInstance
, JoinFlag
, GroupAddress
);
1149 gBS
->RestoreTPL (OldTpl
);
1155 Adds and deletes routing table entries.
1157 The Routes() function adds a route to or deletes a route from the routing table.
1159 Routes are determined by comparing the SubnetAddress with the destination IPv4
1160 address arithmetically AND-ed with the SubnetMask. The gateway address must be
1161 on the same subnet as the configured station address.
1163 The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0.
1164 The default route matches all destination IPv4 addresses that do not match any
1167 A GatewayAddress that is zero is a nonroute. Packets are sent to the destination
1168 IP address if it can be found in the ARP cache or on the local subnet. One automatic
1169 nonroute entry will be inserted into the routing table for outgoing packets that
1170 are addressed to a local subnet (gateway address of 0.0.0.0).
1172 Each EFI IPv4 Protocol instance has its own independent routing table. Those EFI
1173 IPv4 Protocol instances that use the default IPv4 address will also have copies
1174 of the routing table that was provided by the EFI_IP4_CONFIG_PROTOCOL, and these
1175 copies will be updated whenever the EIF IPv4 Protocol driver reconfigures its
1176 instances. As a result, client modification to the routing table will be lost.
1178 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.
1179 @param[in] DeleteRoute Set to TRUE to delete this route from the routing table. Set to
1180 FALSE to add this route to the routing table. SubnetAddress
1181 and SubnetMask are used as the key to each route entry.
1182 @param[in] SubnetAddress The address of the subnet that needs to be routed.
1183 @param[in] SubnetMask The subnet mask of SubnetAddress.
1184 @param[in] GatewayAddress The unicast gateway IPv4 address for this route.
1186 @retval EFI_SUCCESS The operation completed successfully.
1187 @retval EFI_NOT_STARTED The driver instance has not been started.
1188 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
1189 RARP, etc.) is not finished yet.
1190 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
1192 - SubnetAddress is NULL.
1193 - SubnetMask is NULL.
1194 - GatewayAddress is NULL.
1195 - *SubnetAddress is not a valid subnet address.
1196 - *SubnetMask is not a valid subnet mask.
1197 - *GatewayAddress is not a valid unicast IPv4 address.
1198 @retval EFI_OUT_OF_RESOURCES Could not add the entry to the routing table.
1199 @retval EFI_NOT_FOUND This route is not in the routing table (when DeleteRoute is TRUE).
1200 @retval EFI_ACCESS_DENIED The route is already defined in the routing table (when
1201 DeleteRoute is FALSE).
1207 IN EFI_IP4_PROTOCOL
*This
,
1208 IN BOOLEAN DeleteRoute
,
1209 IN EFI_IPv4_ADDRESS
*SubnetAddress
,
1210 IN EFI_IPv4_ADDRESS
*SubnetMask
,
1211 IN EFI_IPv4_ADDRESS
*GatewayAddress
1214 IP4_PROTOCOL
*IpInstance
;
1215 IP4_INTERFACE
*IpIf
;
1223 // First, validate the parameters
1225 if ((This
== NULL
) || (SubnetAddress
== NULL
) ||
1226 (SubnetMask
== NULL
) || (GatewayAddress
== NULL
)) {
1227 return EFI_INVALID_PARAMETER
;
1230 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
1231 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1233 if (IpInstance
->State
!= IP4_STATE_CONFIGED
) {
1234 Status
= EFI_NOT_STARTED
;
1238 if (IpInstance
->ConfigData
.UseDefaultAddress
&& IP4_NO_MAPPING (IpInstance
)) {
1239 Status
= EFI_NO_MAPPING
;
1243 CopyMem (&Dest
, SubnetAddress
, sizeof (IP4_ADDR
));
1244 CopyMem (&Netmask
, SubnetMask
, sizeof (IP4_ADDR
));
1245 CopyMem (&Nexthop
, GatewayAddress
, sizeof (IP4_ADDR
));
1247 Dest
= NTOHL (Dest
);
1248 Netmask
= NTOHL (Netmask
);
1249 Nexthop
= NTOHL (Nexthop
);
1251 IpIf
= IpInstance
->Interface
;
1253 if (!IP4_IS_VALID_NETMASK (Netmask
)) {
1254 Status
= EFI_INVALID_PARAMETER
;
1259 // the gateway address must be a unicast on the connected network if not zero.
1261 if ((Nexthop
!= IP4_ALLZERO_ADDRESS
) &&
1262 (!IP4_NET_EQUAL (Nexthop
, IpIf
->Ip
, IpIf
->SubnetMask
) ||
1263 IP4_IS_BROADCAST (Ip4GetNetCast (Nexthop
, IpIf
)))) {
1265 Status
= EFI_INVALID_PARAMETER
;
1270 Status
= Ip4DelRoute (IpInstance
->RouteTable
, Dest
, Netmask
, Nexthop
);
1272 Status
= Ip4AddRoute (IpInstance
->RouteTable
, Dest
, Netmask
, Nexthop
);
1276 gBS
->RestoreTPL (OldTpl
);
1282 Check whether the user's token or event has already
1283 been enqueued on IP4's list.
1285 @param[in] Map The container of either user's transmit or receive
1287 @param[in] Item Current item to check against.
1288 @param[in] Context The Token to check againist.
1290 @retval EFI_ACCESS_DENIED The token or event has already been enqueued in IP.
1291 @retval EFI_SUCCESS The current item isn't the same token/event as the
1299 IN NET_MAP_ITEM
*Item
,
1303 EFI_IP4_COMPLETION_TOKEN
*Token
;
1304 EFI_IP4_COMPLETION_TOKEN
*TokenInItem
;
1306 Token
= (EFI_IP4_COMPLETION_TOKEN
*) Context
;
1307 TokenInItem
= (EFI_IP4_COMPLETION_TOKEN
*) Item
->Key
;
1309 if ((Token
== TokenInItem
) || (Token
->Event
== TokenInItem
->Event
)) {
1310 return EFI_ACCESS_DENIED
;
1317 Validate the user's token against current station address.
1319 @param[in] Token User's token to validate.
1320 @param[in] IpIf The IP4 child's interface.
1321 @param[in] RawData Set to TRUE to send unformatted packets.
1323 @retval EFI_INVALID_PARAMETER Some parameters are invalid.
1324 @retval EFI_BAD_BUFFER_SIZE The user's option/data is too long.
1325 @retval EFI_SUCCESS The token is valid.
1330 IN EFI_IP4_COMPLETION_TOKEN
*Token
,
1331 IN IP4_INTERFACE
*IpIf
,
1335 EFI_IP4_TRANSMIT_DATA
*TxData
;
1336 EFI_IP4_OVERRIDE_DATA
*Override
;
1343 if ((Token
== NULL
) || (Token
->Event
== NULL
) || (Token
->Packet
.TxData
== NULL
)) {
1344 return EFI_INVALID_PARAMETER
;
1347 TxData
= Token
->Packet
.TxData
;
1350 // Check the fragment table: no empty fragment, and length isn't bogus.
1352 if ((TxData
->TotalDataLength
== 0) || (TxData
->FragmentCount
== 0)) {
1353 return EFI_INVALID_PARAMETER
;
1356 Offset
= TxData
->TotalDataLength
;
1358 if (Offset
> IP4_MAX_PACKET_SIZE
) {
1359 return EFI_BAD_BUFFER_SIZE
;
1362 for (Index
= 0; Index
< TxData
->FragmentCount
; Index
++) {
1363 if ((TxData
->FragmentTable
[Index
].FragmentBuffer
== NULL
) ||
1364 (TxData
->FragmentTable
[Index
].FragmentLength
== 0)) {
1366 return EFI_INVALID_PARAMETER
;
1369 Offset
-= TxData
->FragmentTable
[Index
].FragmentLength
;
1373 return EFI_INVALID_PARAMETER
;
1377 // NOTE that OptionsLength/OptionsBuffer/OverrideData are ignored if RawData
1385 // Check the IP options: no more than 40 bytes and format is OK
1387 if (TxData
->OptionsLength
!= 0) {
1388 if ((TxData
->OptionsLength
> 40) || (TxData
->OptionsBuffer
== NULL
)) {
1389 return EFI_INVALID_PARAMETER
;
1392 if (!Ip4OptionIsValid (TxData
->OptionsBuffer
, TxData
->OptionsLength
, FALSE
)) {
1393 return EFI_INVALID_PARAMETER
;
1398 // Check the source and gateway: they must be a valid unicast.
1399 // Gateway must also be on the connected network.
1401 if (TxData
->OverrideData
!= NULL
) {
1402 Override
= TxData
->OverrideData
;
1404 CopyMem (&Src
, &Override
->SourceAddress
, sizeof (IP4_ADDR
));
1405 CopyMem (&Gateway
, &Override
->GatewayAddress
, sizeof (IP4_ADDR
));
1408 Gateway
= NTOHL (Gateway
);
1410 if ((NetGetIpClass (Src
) > IP4_ADDR_CLASSC
) ||
1411 (Src
== IP4_ALLONE_ADDRESS
) ||
1412 IP4_IS_BROADCAST (Ip4GetNetCast (Src
, IpIf
))) {
1414 return EFI_INVALID_PARAMETER
;
1418 // If gateway isn't zero, it must be a unicast address, and
1419 // on the connected network.
1421 if ((Gateway
!= IP4_ALLZERO_ADDRESS
) &&
1422 ((NetGetIpClass (Gateway
) > IP4_ADDR_CLASSC
) ||
1423 !IP4_NET_EQUAL (Gateway
, IpIf
->Ip
, IpIf
->SubnetMask
) ||
1424 IP4_IS_BROADCAST (Ip4GetNetCast (Gateway
, IpIf
)))) {
1426 return EFI_INVALID_PARAMETER
;
1431 // Check the packet length: Head length and packet length all has a limit
1433 HeadLen
= sizeof (IP4_HEAD
) + ((TxData
->OptionsLength
+ 3) &~0x03);
1435 if ((HeadLen
> IP4_MAX_HEADLEN
) ||
1436 (TxData
->TotalDataLength
+ HeadLen
> IP4_MAX_PACKET_SIZE
)) {
1438 return EFI_BAD_BUFFER_SIZE
;
1446 The callback function for the net buffer which wraps the user's
1447 transmit token. Although it seems this function is pretty simple,
1448 there are some subtle things.
1449 When user requests the IP to transmit a packet by passing it a
1450 token, the token is wrapped in an IP4_TXTOKEN_WRAP and the data
1451 is wrapped in an net buffer. the net buffer's Free function is
1452 set to Ip4FreeTxToken. The Token and token wrap are added to the
1453 IP child's TxToken map. Then the buffer is passed to Ip4Output for
1454 transmission. If something error happened before that, the buffer
1455 is freed, which in turn will free the token wrap. The wrap may
1456 have been added to the TxToken map or not, and the user's event
1457 shouldn't be fired because we are still in the EfiIp4Transmit. If
1458 the buffer has been sent by Ip4Output, it should be removed from
1459 the TxToken map and user's event signaled. The token wrap and buffer
1460 are bound together. Check the comments in Ip4Output for information
1461 about IP fragmentation.
1463 @param[in] Context The token's wrap.
1472 IP4_TXTOKEN_WRAP
*Wrap
;
1475 Wrap
= (IP4_TXTOKEN_WRAP
*) Context
;
1478 // Signal IpSecRecycleEvent to inform IPsec free the memory
1480 if (Wrap
->IpSecRecycleSignal
!= NULL
) {
1481 gBS
->SignalEvent (Wrap
->IpSecRecycleSignal
);
1485 // Find the token in the instance's map. EfiIp4Transmit put the
1486 // token to the map. If that failed, NetMapFindKey will return NULL.
1488 Item
= NetMapFindKey (&Wrap
->IpInstance
->TxTokens
, Wrap
->Token
);
1491 NetMapRemoveItem (&Wrap
->IpInstance
->TxTokens
, Item
, NULL
);
1495 gBS
->SignalEvent (Wrap
->Token
->Event
);
1498 // Dispatch the DPC queued by the NotifyFunction of Token->Event.
1508 The callback function to Ip4Output to update the transmit status.
1510 @param Ip4Instance The Ip4Instance that request the transmit.
1511 @param Packet The user's transmit request.
1512 @param IoStatus The result of the transmission.
1513 @param Flag Not used during transmission.
1514 @param Context The token's wrap.
1519 IP4_PROTOCOL
*Ip4Instance
,
1521 EFI_STATUS IoStatus
,
1526 IP4_TXTOKEN_WRAP
*Wrap
;
1529 // This is the transmission request from upper layer,
1530 // not the IP4 driver itself.
1532 ASSERT (Ip4Instance
!= NULL
);
1535 // The first fragment of the packet has been sent. Update
1536 // the token's status. That is, if fragmented, the transmit's
1537 // status is the first fragment's status. The Wrap will be
1538 // release when all the fragments are release. Check the comments
1539 // in Ip4FreeTxToken and Ip4Output for information.
1541 Wrap
= (IP4_TXTOKEN_WRAP
*) Context
;
1542 Wrap
->Token
->Status
= IoStatus
;
1544 NetbufFree (Wrap
->Packet
);
1549 Places outgoing data packets into the transmit queue.
1551 The Transmit() function places a sending request in the transmit queue of this
1552 EFI IPv4 Protocol instance. Whenever the packet in the token is sent out or some
1553 errors occur, the event in the token will be signaled and the status is updated.
1555 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.
1556 @param[in] Token Pointer to the transmit token.
1558 @retval EFI_SUCCESS The data has been queued for transmission.
1559 @retval EFI_NOT_STARTED This instance has not been started.
1560 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
1561 RARP, etc.) is not finished yet.
1562 @retval EFI_INVALID_PARAMETER One or more pameters are invalid.
1563 @retval EFI_ACCESS_DENIED The transmit completion token with the same Token.Event
1564 was already in the transmit queue.
1565 @retval EFI_NOT_READY The completion token could not be queued because the transmit
1567 @retval EFI_NOT_FOUND Not route is found to destination address.
1568 @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data.
1569 @retval EFI_BUFFER_TOO_SMALL Token.Packet.TxData.TotalDataLength is too
1571 @retval EFI_BAD_BUFFER_SIZE The length of the IPv4 header + option length + total data length is
1572 greater than MTU (or greater than the maximum packet size if
1573 Token.Packet.TxData.OverrideData.
1574 DoNotFragment is TRUE).
1580 IN EFI_IP4_PROTOCOL
*This
,
1581 IN EFI_IP4_COMPLETION_TOKEN
*Token
1585 IP4_PROTOCOL
*IpInstance
;
1586 IP4_INTERFACE
*IpIf
;
1587 IP4_TXTOKEN_WRAP
*Wrap
;
1588 EFI_IP4_TRANSMIT_DATA
*TxData
;
1589 EFI_IP4_CONFIG_DATA
*Config
;
1590 EFI_IP4_OVERRIDE_DATA
*Override
;
1595 BOOLEAN DontFragment
;
1598 UINT32 OptionsLength
;
1599 UINT8
*OptionsBuffer
;
1600 VOID
*FirstFragment
;
1603 return EFI_INVALID_PARAMETER
;
1606 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
1608 if (IpInstance
->State
!= IP4_STATE_CONFIGED
) {
1609 return EFI_NOT_STARTED
;
1612 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1614 IpSb
= IpInstance
->Service
;
1615 IpIf
= IpInstance
->Interface
;
1616 Config
= &IpInstance
->ConfigData
;
1618 if (Config
->UseDefaultAddress
&& IP4_NO_MAPPING (IpInstance
)) {
1619 Status
= EFI_NO_MAPPING
;
1624 // make sure that token is properly formated
1626 Status
= Ip4TxTokenValid (Token
, IpIf
, Config
->RawData
);
1628 if (EFI_ERROR (Status
)) {
1633 // Check whether the token or signal already existed.
1635 if (EFI_ERROR (NetMapIterate (&IpInstance
->TxTokens
, Ip4TokenExist
, Token
))) {
1636 Status
= EFI_ACCESS_DENIED
;
1641 // Build the IP header, need to fill in the Tos, TotalLen, Id,
1642 // fragment, Ttl, protocol, Src, and Dst.
1644 TxData
= Token
->Packet
.TxData
;
1646 FirstFragment
= NULL
;
1648 if (Config
->RawData
) {
1650 // When RawData is TRUE, first buffer in FragmentTable points to a raw
1651 // IPv4 fragment including IPv4 header and options.
1653 FirstFragment
= TxData
->FragmentTable
[0].FragmentBuffer
;
1654 CopyMem (&RawHdrLen
, FirstFragment
, sizeof (UINT8
));
1656 RawHdrLen
= (UINT8
) (RawHdrLen
& 0x0f);
1657 if (RawHdrLen
< 5) {
1658 Status
= EFI_INVALID_PARAMETER
;
1662 RawHdrLen
= (UINT8
) (RawHdrLen
<< 2);
1664 CopyMem (&Head
, FirstFragment
, IP4_MIN_HEADLEN
);
1666 Ip4NtohHead (&Head
);
1668 DontFragment
= IP4_DO_NOT_FRAGMENT (Head
.Fragment
);
1670 if (!DontFragment
) {
1671 Status
= EFI_INVALID_PARAMETER
;
1675 GateWay
= IP4_ALLZERO_ADDRESS
;
1678 // Get IPv4 options from first fragment.
1680 if (RawHdrLen
== IP4_MIN_HEADLEN
) {
1682 OptionsBuffer
= NULL
;
1684 OptionsLength
= RawHdrLen
- IP4_MIN_HEADLEN
;
1685 OptionsBuffer
= (UINT8
*) FirstFragment
+ IP4_MIN_HEADLEN
;
1689 // Trim off IPv4 header and options from first fragment.
1691 TxData
->FragmentTable
[0].FragmentBuffer
= (UINT8
*) FirstFragment
+ RawHdrLen
;
1692 TxData
->FragmentTable
[0].FragmentLength
= TxData
->FragmentTable
[0].FragmentLength
- RawHdrLen
;
1694 CopyMem (&Head
.Dst
, &TxData
->DestinationAddress
, sizeof (IP4_ADDR
));
1695 Head
.Dst
= NTOHL (Head
.Dst
);
1697 if (TxData
->OverrideData
!= NULL
) {
1698 Override
= TxData
->OverrideData
;
1699 Head
.Protocol
= Override
->Protocol
;
1700 Head
.Tos
= Override
->TypeOfService
;
1701 Head
.Ttl
= Override
->TimeToLive
;
1702 DontFragment
= Override
->DoNotFragment
;
1704 CopyMem (&Head
.Src
, &Override
->SourceAddress
, sizeof (IP4_ADDR
));
1705 CopyMem (&GateWay
, &Override
->GatewayAddress
, sizeof (IP4_ADDR
));
1707 Head
.Src
= NTOHL (Head
.Src
);
1708 GateWay
= NTOHL (GateWay
);
1710 Head
.Src
= IpIf
->Ip
;
1711 GateWay
= IP4_ALLZERO_ADDRESS
;
1712 Head
.Protocol
= Config
->DefaultProtocol
;
1713 Head
.Tos
= Config
->TypeOfService
;
1714 Head
.Ttl
= Config
->TimeToLive
;
1715 DontFragment
= Config
->DoNotFragment
;
1718 Head
.Fragment
= IP4_HEAD_FRAGMENT_FIELD (DontFragment
, FALSE
, 0);
1719 HeadLen
= (TxData
->OptionsLength
+ 3) & (~0x03);
1721 OptionsLength
= TxData
->OptionsLength
;
1722 OptionsBuffer
= (UINT8
*) (TxData
->OptionsBuffer
);
1726 // If don't fragment and fragment needed, return error
1728 if (DontFragment
&& (TxData
->TotalDataLength
+ HeadLen
> IpSb
->MaxPacketSize
)) {
1729 Status
= EFI_BAD_BUFFER_SIZE
;
1734 // OK, it survives all the validation check. Wrap the token in
1735 // a IP4_TXTOKEN_WRAP and the data in a netbuf
1737 Status
= EFI_OUT_OF_RESOURCES
;
1738 Wrap
= AllocateZeroPool (sizeof (IP4_TXTOKEN_WRAP
));
1743 Wrap
->IpInstance
= IpInstance
;
1744 Wrap
->Token
= Token
;
1746 Wrap
->Life
= IP4_US_TO_SEC (Config
->TransmitTimeout
);
1747 Wrap
->Packet
= NetbufFromExt (
1748 (NET_FRAGMENT
*) TxData
->FragmentTable
,
1749 TxData
->FragmentCount
,
1756 if (Wrap
->Packet
== NULL
) {
1761 Token
->Status
= EFI_NOT_READY
;
1763 if (EFI_ERROR (NetMapInsertTail (&IpInstance
->TxTokens
, Token
, Wrap
))) {
1765 // NetbufFree will call Ip4FreeTxToken, which in turn will
1766 // free the IP4_TXTOKEN_WRAP. Now, the token wrap hasn't been
1769 if (Config
->RawData
) {
1771 // Restore pointer of first fragment in RawData mode.
1773 TxData
->FragmentTable
[0].FragmentBuffer
= (UINT8
*) FirstFragment
;
1776 NetbufFree (Wrap
->Packet
);
1781 // Mark the packet sent before output it. Mark it not sent again if the
1782 // returned status is not EFI_SUCCESS;
1786 Status
= Ip4Output (
1798 if (EFI_ERROR (Status
)) {
1801 if (Config
->RawData
) {
1803 // Restore pointer of first fragment in RawData mode.
1805 TxData
->FragmentTable
[0].FragmentBuffer
= (UINT8
*) FirstFragment
;
1808 NetbufFree (Wrap
->Packet
);
1811 if (Config
->RawData
) {
1813 // Restore pointer of first fragment in RawData mode.
1815 TxData
->FragmentTable
[0].FragmentBuffer
= (UINT8
*) FirstFragment
;
1819 gBS
->RestoreTPL (OldTpl
);
1825 Places a receiving request into the receiving queue.
1827 The Receive() function places a completion token into the receive packet queue.
1828 This function is always asynchronous.
1830 The Token.Event field in the completion token must be filled in by the caller
1831 and cannot be NULL. When the receive operation completes, the EFI IPv4 Protocol
1832 driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event
1835 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.
1836 @param[in] Token Pointer to a token that is associated with the receive data descriptor.
1838 @retval EFI_SUCCESS The receive completion token was cached.
1839 @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.
1840 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, RARP, etc.)
1841 is not finished yet.
1842 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
1845 - Token.Event is NULL.
1846 @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system
1847 resources (usually memory).
1848 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
1849 The EFI IPv4 Protocol instance has been reset to startup defaults.
1850 EFI_ACCESS_DENIED The receive completion token with the same Token.Event was already
1851 in the receive queue.
1852 @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full.
1853 @retval EFI_ICMP_ERROR An ICMP error packet was received.
1859 IN EFI_IP4_PROTOCOL
*This
,
1860 IN EFI_IP4_COMPLETION_TOKEN
*Token
1863 IP4_PROTOCOL
*IpInstance
;
1868 // First validate the parameters
1870 if ((This
== NULL
) || (Token
== NULL
) || (Token
->Event
== NULL
)) {
1871 return EFI_INVALID_PARAMETER
;
1874 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
1876 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1878 if (IpInstance
->State
!= IP4_STATE_CONFIGED
) {
1879 Status
= EFI_NOT_STARTED
;
1884 // Check whether the toke is already on the receive queue.
1886 Status
= NetMapIterate (&IpInstance
->RxTokens
, Ip4TokenExist
, Token
);
1888 if (EFI_ERROR (Status
)) {
1889 Status
= EFI_ACCESS_DENIED
;
1894 // Queue the token then check whether there is pending received packet.
1896 Status
= NetMapInsertTail (&IpInstance
->RxTokens
, Token
, NULL
);
1898 if (EFI_ERROR (Status
)) {
1902 Status
= Ip4InstanceDeliverPacket (IpInstance
);
1905 // Dispatch the DPC queued by the NotifyFunction of this instane's receive
1911 gBS
->RestoreTPL (OldTpl
);
1917 Cancel the transmitted but not recycled packet. If a matching
1918 token is found, it will call Ip4CancelPacket to cancel the
1919 packet. Ip4CancelPacket will cancel all the fragments of the
1920 packet. When all the fragments are freed, the IP4_TXTOKEN_WRAP
1921 will be deleted from the Map, and user's event signalled.
1922 Because Ip4CancelPacket and other functions are all called in
1923 line, so, after Ip4CancelPacket returns, the Item has been freed.
1925 @param[in] Map The IP4 child's transmit queue.
1926 @param[in] Item The current transmitted packet to test.
1927 @param[in] Context The user's token to cancel.
1929 @retval EFI_SUCCESS Continue to check the next Item.
1930 @retval EFI_ABORTED The user's Token (Token != NULL) is cancelled.
1937 IN NET_MAP_ITEM
*Item
,
1941 EFI_IP4_COMPLETION_TOKEN
*Token
;
1942 IP4_TXTOKEN_WRAP
*Wrap
;
1944 Token
= (EFI_IP4_COMPLETION_TOKEN
*) Context
;
1947 // Return EFI_SUCCESS to check the next item in the map if
1948 // this one doesn't match.
1950 if ((Token
!= NULL
) && (Token
!= Item
->Key
)) {
1954 Wrap
= (IP4_TXTOKEN_WRAP
*) Item
->Value
;
1955 ASSERT (Wrap
!= NULL
);
1958 // Don't access the Item, Wrap and Token's members after this point.
1959 // Item and wrap has been freed. And we no longer own the Token.
1961 Ip4CancelPacket (Wrap
->IpInstance
->Interface
, Wrap
->Packet
, EFI_ABORTED
);
1964 // If only one item is to be cancel, return EFI_ABORTED to stop
1965 // iterating the map any more.
1967 if (Token
!= NULL
) {
1976 Cancel the receive request. This is quiet simple, because
1977 it is only enqueued in our local receive map.
1979 @param[in] Map The IP4 child's receive queue.
1980 @param[in] Item Current receive request to cancel.
1981 @param[in] Context The user's token to cancel.
1983 @retval EFI_SUCCESS Continue to check the next receive request on the
1985 @retval EFI_ABORTED The user's token (token != NULL) has been
1993 IN NET_MAP_ITEM
*Item
,
1997 EFI_IP4_COMPLETION_TOKEN
*Token
;
1998 EFI_IP4_COMPLETION_TOKEN
*This
;
2000 Token
= (EFI_IP4_COMPLETION_TOKEN
*) Context
;
2003 if ((Token
!= NULL
) && (Token
!= This
)) {
2007 NetMapRemoveItem (Map
, Item
, NULL
);
2009 This
->Status
= EFI_ABORTED
;
2010 This
->Packet
.RxData
= NULL
;
2011 gBS
->SignalEvent (This
->Event
);
2013 if (Token
!= NULL
) {
2022 Cancel the user's receive/transmit request.
2024 @param[in] IpInstance The IP4 child.
2025 @param[in] Token The token to cancel. If NULL, all token will be
2028 @retval EFI_SUCCESS The token is cancelled.
2029 @retval EFI_NOT_FOUND The token isn't found on either the
2030 transmit/receive queue.
2031 @retval EFI_DEVICE_ERROR Not all token is cancelled when Token is NULL.
2036 IN IP4_PROTOCOL
*IpInstance
,
2037 IN EFI_IP4_COMPLETION_TOKEN
*Token OPTIONAL
2043 // First check the transmitted packet. Ip4CancelTxTokens returns
2044 // EFI_ABORTED to mean that the token has been cancelled when
2045 // token != NULL. So, return EFI_SUCCESS for this condition.
2047 Status
= NetMapIterate (&IpInstance
->TxTokens
, Ip4CancelTxTokens
, Token
);
2049 if (EFI_ERROR (Status
)) {
2050 if ((Token
!= NULL
) && (Status
== EFI_ABORTED
)) {
2058 // Check the receive queue. Ip4CancelRxTokens also returns EFI_ABORT
2059 // for Token!=NULL and it is cancelled.
2061 Status
= NetMapIterate (&IpInstance
->RxTokens
, Ip4CancelRxTokens
, Token
);
2063 // Dispatch the DPCs queued by the NotifyFunction of the canceled rx token's
2067 if (EFI_ERROR (Status
)) {
2068 if ((Token
!= NULL
) && (Status
== EFI_ABORTED
)) {
2076 // OK, if the Token is found when Token != NULL, the NetMapIterate
2077 // will return EFI_ABORTED, which has been interrupted as EFI_SUCCESS.
2079 if (Token
!= NULL
) {
2080 return EFI_NOT_FOUND
;
2084 // If Token == NULL, cancel all the tokens. return error if no
2085 // all of them are cancelled.
2087 if (!NetMapIsEmpty (&IpInstance
->TxTokens
) ||
2088 !NetMapIsEmpty (&IpInstance
->RxTokens
)) {
2090 return EFI_DEVICE_ERROR
;
2098 Abort an asynchronous transmit or receive request.
2100 The Cancel() function is used to abort a pending transmit or receive request.
2101 If the token is in the transmit or receive request queues, after calling this
2102 function, Token->Status will be set to EFI_ABORTED and then Token->Event will
2103 be signaled. If the token is not in one of the queues, which usually means the
2104 asynchronous operation has completed, this function will not signal the token
2105 and EFI_NOT_FOUND is returned.
2107 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.
2108 @param[in] Token Pointer to a token that has been issued by
2109 EFI_IP4_PROTOCOL.Transmit() or
2110 EFI_IP4_PROTOCOL.Receive(). If NULL, all pending
2111 tokens are aborted. Type EFI_IP4_COMPLETION_TOKEN is
2112 defined in EFI_IP4_PROTOCOL.Transmit().
2114 @retval EFI_SUCCESS The asynchronous I/O request was aborted and
2115 Token.->Event was signaled. When Token is NULL, all
2116 pending requests were aborted and their events were signaled.
2117 @retval EFI_INVALID_PARAMETER This is NULL.
2118 @retval EFI_NOT_STARTED This instance has not been started.
2119 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
2120 RARP, etc.) is not finished yet.
2121 @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O request was
2122 not found in the transmit or receive queue. It has either completed
2123 or was not issued by Transmit() and Receive().
2129 IN EFI_IP4_PROTOCOL
*This
,
2130 IN EFI_IP4_COMPLETION_TOKEN
*Token OPTIONAL
2133 IP4_PROTOCOL
*IpInstance
;
2138 return EFI_INVALID_PARAMETER
;
2141 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
2143 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
2145 if (IpInstance
->State
!= IP4_STATE_CONFIGED
) {
2146 Status
= EFI_NOT_STARTED
;
2150 if (IpInstance
->ConfigData
.UseDefaultAddress
&& IP4_NO_MAPPING (IpInstance
)) {
2151 Status
= EFI_NO_MAPPING
;
2155 Status
= Ip4Cancel (IpInstance
, Token
);
2158 gBS
->RestoreTPL (OldTpl
);
2164 Polls for incoming data packets and processes outgoing data packets.
2166 The Poll() function polls for incoming data packets and processes outgoing data
2167 packets. Network drivers and applications can call the EFI_IP4_PROTOCOL.Poll()
2168 function to increase the rate that data packets are moved between the communications
2169 device and the transmit and receive queues.
2171 In some systems the periodic timer event may not poll the underlying communications
2172 device fast enough to transmit and/or receive all data packets without missing
2173 incoming packets or dropping outgoing packets. Drivers and applications that are
2174 experiencing packet loss should try calling the EFI_IP4_PROTOCOL.Poll() function
2177 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.
2179 @retval EFI_SUCCESS Incoming or outgoing data was processed.
2180 @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.
2181 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
2182 RARP, etc.) is not finished yet.
2183 @retval EFI_INVALID_PARAMETER This is NULL.
2184 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
2185 @retval EFI_NOT_READY No incoming or outgoing data is processed.
2186 @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue.
2187 Consider increasing the polling rate.
2193 IN EFI_IP4_PROTOCOL
*This
2196 IP4_PROTOCOL
*IpInstance
;
2197 EFI_MANAGED_NETWORK_PROTOCOL
*Mnp
;
2200 return EFI_INVALID_PARAMETER
;
2203 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
2205 if (IpInstance
->State
== IP4_STATE_UNCONFIGED
) {
2206 return EFI_NOT_STARTED
;
2209 Mnp
= IpInstance
->Service
->Mnp
;
2212 // Don't lock the Poll function to enable the deliver of
2213 // the packet polled up.
2215 return Mnp
->Poll (Mnp
);
2219 Decrease the life of the transmitted packets. If it is
2220 decreased to zero, cancel the packet. This function is
2221 called by Ip4PacketTimerTicking which time out both the
2222 received-but-not-delivered and transmitted-but-not-recycle
2225 @param[in] Map The IP4 child's transmit map.
2226 @param[in] Item Current transmitted packet.
2227 @param[in] Context Not used.
2229 @retval EFI_SUCCESS Always returns EFI_SUCCESS.
2234 Ip4SentPacketTicking (
2236 IN NET_MAP_ITEM
*Item
,
2240 IP4_TXTOKEN_WRAP
*Wrap
;
2242 Wrap
= (IP4_TXTOKEN_WRAP
*) Item
->Value
;
2243 ASSERT (Wrap
!= NULL
);
2245 if ((Wrap
->Life
> 0) && (--Wrap
->Life
== 0)) {
2246 Ip4CancelPacket (Wrap
->IpInstance
->Interface
, Wrap
->Packet
, EFI_ABORTED
);
2253 This heart beat timer of IP4 service instance times out all of its IP4 children's
2254 received-but-not-delivered and transmitted-but-not-recycle packets, and provides
2255 time input for its IGMP protocol.
2257 @param[in] Event The IP4 service instance's heart beat timer.
2258 @param[in] Context The IP4 service instance.
2270 IpSb
= (IP4_SERVICE
*) Context
;
2271 NET_CHECK_SIGNATURE (IpSb
, IP4_SERVICE_SIGNATURE
);
2273 Ip4PacketTimerTicking (IpSb
);
2274 Ip4IgmpTicking (IpSb
);
2278 This dedicated timer is used to poll underlying network media status. In case
2279 of cable swap or wireless network switch, a new round auto configuration will
2280 be initiated. The timer will signal the IP4 to run DHCP configuration again.
2281 IP4 driver will free old IP address related resource, such as route table and
2282 Interface, then initiate a DHCP process to acquire new IP, eventually create
2283 route table for new IP address.
2285 @param[in] Event The IP4 service instance's heart beat timer.
2286 @param[in] Context The IP4 service instance.
2291 Ip4TimerReconfigChecking (
2297 BOOLEAN OldMediaPresent
;
2299 EFI_SIMPLE_NETWORK_MODE SnpModeData
;
2301 IpSb
= (IP4_SERVICE
*) Context
;
2302 NET_CHECK_SIGNATURE (IpSb
, IP4_SERVICE_SIGNATURE
);
2304 OldMediaPresent
= IpSb
->MediaPresent
;
2307 // Get fresh mode data from MNP, since underlying media status may change.
2308 // Here, it needs to mention that the MediaPresent can also be checked even if
2309 // EFI_NOT_STARTED returned while this MNP child driver instance isn't configured.
2311 Status
= IpSb
->Mnp
->GetModeData (IpSb
->Mnp
, NULL
, &SnpModeData
);
2312 if (EFI_ERROR (Status
) && (Status
!= EFI_NOT_STARTED
)) {
2316 IpSb
->MediaPresent
= SnpModeData
.MediaPresent
;
2318 // Media transimit Unpresent to Present means new link movement is detected.
2320 if (!OldMediaPresent
&& IpSb
->MediaPresent
&& (IpSb
->Ip4Config2Instance
.Policy
== Ip4Config2PolicyDhcp
)) {
2322 // Signal the IP4 to run the dhcp configuration again. IP4 driver will free
2323 // old IP address related resource, such as route table and Interface, then
2324 // initiate a DHCP round to acquire new IP, eventually
2325 // create route table for new IP address.
2327 if (IpSb
->ReconfigEvent
!= NULL
) {
2328 Status
= gBS
->SignalEvent (IpSb
->ReconfigEvent
);