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
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
->Service
= IpSb
;
555 InitializeListHead (&IpInstance
->Link
);
556 NetMapInit (&IpInstance
->RxTokens
);
557 NetMapInit (&IpInstance
->TxTokens
);
558 InitializeListHead (&IpInstance
->Received
);
559 InitializeListHead (&IpInstance
->Delivered
);
560 InitializeListHead (&IpInstance
->AddrLink
);
562 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
;
600 IpSb
= IpInstance
->Service
;
603 // User is changing packet filters. It must be stopped
604 // before the station address can be changed.
606 if (IpInstance
->State
== IP4_STATE_CONFIGED
) {
608 // Cancel all the pending transmit/receive from upper layer
610 Status
= Ip4Cancel (IpInstance
, NULL
);
612 if (EFI_ERROR (Status
)) {
613 return EFI_DEVICE_ERROR
;
616 CopyMem (&IpInstance
->ConfigData
, Config
, sizeof (IpInstance
->ConfigData
));
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.
625 Status
= EFI_OUT_OF_RESOURCES
;
626 IpInstance
->RouteTable
= Ip4CreateRouteTable ();
628 if (IpInstance
->RouteTable
== NULL
) {
633 // Set up the interface.
635 CopyMem (&Ip
, &Config
->StationAddress
, sizeof (IP4_ADDR
));
636 CopyMem (&Netmask
, &Config
->SubnetMask
, sizeof (IP4_ADDR
));
639 Netmask
= NTOHL (Netmask
);
641 if (!Config
->UseDefaultAddress
) {
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.
647 IpIf
= Ip4FindStationAddress (IpSb
, Ip
, Netmask
);
653 IpIf
= Ip4CreateInterface (IpSb
->Mnp
, IpSb
->Controller
, IpSb
->Image
);
659 Status
= Ip4SetAddress (IpIf
, Ip
, Netmask
);
661 if (EFI_ERROR (Status
)) {
662 Status
= EFI_DEVICE_ERROR
;
663 Ip4FreeInterface (IpIf
, IpInstance
);
667 InsertTailList (&IpSb
->Interfaces
, &IpIf
->Link
);
671 // Add a route to this connected network in the route table
673 Ip4AddRoute (IpInstance
->RouteTable
, Ip
, Netmask
, IP4_ALLZERO_ADDRESS
);
677 // Use the default address. If the default configuration hasn't
678 // been started, start it.
680 if (IpSb
->State
== IP4_SERVICE_UNSTARTED
) {
681 Status
= Ip4StartAutoConfig (&IpSb
->Ip4Config2Instance
);
683 if (EFI_ERROR (Status
)) {
688 IpIf
= IpSb
->DefaultInterface
;
689 NET_GET_REF (IpSb
->DefaultInterface
);
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
698 NET_GET_REF (IpSb
->DefaultRouteTable
);
699 IpInstance
->RouteTable
->Next
= IpSb
->DefaultRouteTable
;
702 IpInstance
->Interface
= IpIf
;
703 if (IpIf
->Arp
!= NULL
) {
705 Status
= gBS
->OpenProtocol (
707 &gEfiArpProtocolGuid
,
709 gIp4DriverBinding
.DriverBindingHandle
,
711 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
713 if (EFI_ERROR (Status
)) {
717 InsertTailList (&IpIf
->IpInstances
, &IpInstance
->AddrLink
);
719 CopyMem (&IpInstance
->ConfigData
, Config
, sizeof (IpInstance
->ConfigData
));
720 IpInstance
->State
= IP4_STATE_CONFIGED
;
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.
727 if (Config
->UseDefaultAddress
&& IP4_NO_MAPPING (IpInstance
)) {
728 return EFI_NO_MAPPING
;
734 Ip4FreeRouteTable (IpInstance
->RouteTable
);
735 IpInstance
->RouteTable
= NULL
;
741 Clean up the IP4 child, release all the resources used by it.
743 @param[in] IpInstance The IP4 child to clean up.
745 @retval EFI_SUCCESS The IP4 child is cleaned up.
746 @retval EFI_DEVICE_ERROR Some resources failed to be released.
751 IN IP4_PROTOCOL
*IpInstance
754 if (EFI_ERROR (Ip4Cancel (IpInstance
, NULL
))) {
755 return EFI_DEVICE_ERROR
;
758 if (EFI_ERROR (Ip4Groups (IpInstance
, FALSE
, NULL
))) {
759 return EFI_DEVICE_ERROR
;
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.
767 if (!IsListEmpty (&IpInstance
->Delivered
)) {
771 if (IpInstance
->Interface
!= NULL
) {
772 RemoveEntryList (&IpInstance
->AddrLink
);
773 if (IpInstance
->Interface
->Arp
!= NULL
) {
775 IpInstance
->Interface
->ArpHandle
,
776 &gEfiArpProtocolGuid
,
777 gIp4DriverBinding
.DriverBindingHandle
,
781 Ip4FreeInterface (IpInstance
->Interface
, IpInstance
);
782 IpInstance
->Interface
= NULL
;
785 if (IpInstance
->RouteTable
!= NULL
) {
786 if (IpInstance
->RouteTable
->Next
!= NULL
) {
787 Ip4FreeRouteTable (IpInstance
->RouteTable
->Next
);
790 Ip4FreeRouteTable (IpInstance
->RouteTable
);
791 IpInstance
->RouteTable
= NULL
;
794 if (IpInstance
->EfiRouteTable
!= NULL
) {
795 FreePool (IpInstance
->EfiRouteTable
);
796 IpInstance
->EfiRouteTable
= NULL
;
797 IpInstance
->EfiRouteCount
= 0;
800 if (IpInstance
->Groups
!= NULL
) {
801 FreePool (IpInstance
->Groups
);
802 IpInstance
->Groups
= NULL
;
803 IpInstance
->GroupCount
= 0;
806 NetMapClean (&IpInstance
->TxTokens
);
808 NetMapClean (&IpInstance
->RxTokens
);
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.
819 @param[in] Ip The IP address to validate.
820 @param[in] Netmask The netmaks of the IP.
822 @retval TRUE The Ip/Netmask pair is valid.
823 @retval FALSE The Ip/Netmask pair is invalid.
827 Ip4StationAddressValid (
832 IP4_ADDR NetBrdcastMask
;
837 // Only support the station address with 0.0.0.0/0 to enable DHCP client.
839 if (Netmask
== IP4_ALLZERO_ADDRESS
) {
840 return (BOOLEAN
) (Ip
== IP4_ALLZERO_ADDRESS
);
844 // Only support the continuous net masks
846 if ((Len
= NetGetMaskLength (Netmask
)) == IP4_MASK_NUM
) {
851 // Station address can't be class D or class E address
853 if ((Type
= NetGetIpClass (Ip
)) > IP4_ADDR_CLASSC
) {
858 // Station address can't be subnet broadcast/net broadcast address
860 if ((Ip
== (Ip
& Netmask
)) || (Ip
== (Ip
| ~Netmask
))) {
864 NetBrdcastMask
= gIp4AllMasks
[MIN (Len
, Type
<< 3)];
866 if (Ip
== (Ip
| ~NetBrdcastMask
)) {
875 Assigns an IPv4 address and subnet mask to this EFI IPv4 Protocol driver instance.
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.
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
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.
897 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.
898 @param[in] IpConfigData Pointer to the EFI IPv4 Protocol configuration data structure.
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.
920 IN EFI_IP4_PROTOCOL
*This
,
921 IN EFI_IP4_CONFIG_DATA
*IpConfigData OPTIONAL
924 IP4_PROTOCOL
*IpInstance
;
925 EFI_IP4_CONFIG_DATA
*Current
;
933 // First, validate the parameters
936 return EFI_INVALID_PARAMETER
;
939 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
940 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
943 // Validate the configuration first.
945 if (IpConfigData
!= NULL
) {
947 CopyMem (&IpAddress
, &IpConfigData
->StationAddress
, sizeof (IP4_ADDR
));
948 CopyMem (&SubnetMask
, &IpConfigData
->SubnetMask
, sizeof (IP4_ADDR
));
950 IpAddress
= NTOHL (IpAddress
);
951 SubnetMask
= NTOHL (SubnetMask
);
954 // Check whether the station address is a valid unicast address
956 if (!IpConfigData
->UseDefaultAddress
) {
957 AddrOk
= Ip4StationAddressValid (IpAddress
, SubnetMask
);
960 Status
= EFI_INVALID_PARAMETER
;
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.
970 if (IpInstance
->State
== IP4_STATE_CONFIGED
) {
971 Current
= &IpInstance
->ConfigData
;
973 if (Current
->UseDefaultAddress
!= IpConfigData
->UseDefaultAddress
) {
974 Status
= EFI_ALREADY_STARTED
;
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
;
985 if (Current
->UseDefaultAddress
&& IP4_NO_MAPPING (IpInstance
)) {
986 Status
= EFI_NO_MAPPING
;
993 // Configure the instance or clean it up.
995 if (IpConfigData
!= NULL
) {
996 Status
= Ip4ConfigProtocol (IpInstance
, IpConfigData
);
998 Status
= Ip4CleanProtocol (IpInstance
);
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.
1006 if (IpInstance
->State
== IP4_STATE_CONFIGED
) {
1007 IpInstance
->State
= IP4_STATE_UNCONFIGED
;
1012 // Update the MNP's configure data. Ip4ServiceConfigMnp will check
1013 // whether it is necessary to reconfigure the MNP.
1015 Ip4ServiceConfigMnp (IpInstance
->Service
, FALSE
);
1018 gBS
->RestoreTPL (OldTpl
);
1025 Change the IP4 child's multicast setting. The caller
1026 should make sure that the parameters is valid.
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.
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.
1041 IN IP4_PROTOCOL
*IpInstance
,
1042 IN BOOLEAN JoinFlag
,
1043 IN EFI_IPv4_ADDRESS
*GroupAddress OPTIONAL
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
1057 // When JoinFlag is TRUE, GroupAddress shouldn't be NULL.
1059 ASSERT (GroupAddress
!= NULL
);
1060 CopyMem (&Group
, GroupAddress
, sizeof (IP4_ADDR
));
1062 for (Index
= 0; Index
< IpInstance
->GroupCount
; Index
++) {
1063 if (IpInstance
->Groups
[Index
] == Group
) {
1064 return EFI_ALREADY_STARTED
;
1068 Members
= Ip4CombineGroups (IpInstance
->Groups
, IpInstance
->GroupCount
, Group
);
1070 if (Members
== NULL
) {
1071 return EFI_OUT_OF_RESOURCES
;
1074 if (EFI_ERROR (Ip4JoinGroup (IpInstance
, NTOHL (Group
)))) {
1076 return EFI_DEVICE_ERROR
;
1079 if (IpInstance
->Groups
!= NULL
) {
1080 FreePool (IpInstance
->Groups
);
1083 IpInstance
->Groups
= Members
;
1084 IpInstance
->GroupCount
++;
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..
1094 for (Index
= IpInstance
->GroupCount
; Index
> 0 ; Index
--) {
1095 Group
= IpInstance
->Groups
[Index
- 1];
1097 if ((GroupAddress
== NULL
) || EFI_IP4_EQUAL (&Group
, GroupAddress
)) {
1098 if (EFI_ERROR (Ip4LeaveGroup (IpInstance
, NTOHL (Group
)))) {
1099 return EFI_DEVICE_ERROR
;
1102 Ip4RemoveGroupAddr (IpInstance
->Groups
, IpInstance
->GroupCount
, Group
);
1103 IpInstance
->GroupCount
--;
1105 if (IpInstance
->GroupCount
== 0) {
1106 ASSERT (Index
== 1);
1108 FreePool (IpInstance
->Groups
);
1109 IpInstance
->Groups
= NULL
;
1112 if (GroupAddress
!= NULL
) {
1118 return ((GroupAddress
!= NULL
) ? EFI_NOT_FOUND
: EFI_SUCCESS
);
1123 Joins and leaves multicast groups.
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.
1129 If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left.
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.
1135 @retval EFI_SUCCESS The operation completed successfully.
1136 @retval EFI_INVALID_PARAMETER One or more of the following is TRUE:
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
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.
1155 IN EFI_IP4_PROTOCOL
*This
,
1156 IN BOOLEAN JoinFlag
,
1157 IN EFI_IPv4_ADDRESS
*GroupAddress OPTIONAL
1160 IP4_PROTOCOL
*IpInstance
;
1165 if ((This
== NULL
) || (JoinFlag
&& (GroupAddress
== NULL
))) {
1166 return EFI_INVALID_PARAMETER
;
1169 if (GroupAddress
!= NULL
) {
1170 CopyMem (&McastIp
, GroupAddress
, sizeof (IP4_ADDR
));
1172 if (!IP4_IS_MULTICAST (NTOHL (McastIp
))) {
1173 return EFI_INVALID_PARAMETER
;
1177 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
1178 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1180 if (IpInstance
->State
!= IP4_STATE_CONFIGED
) {
1181 Status
= EFI_NOT_STARTED
;
1185 if (IpInstance
->ConfigData
.UseDefaultAddress
&& IP4_NO_MAPPING (IpInstance
)) {
1186 Status
= EFI_NO_MAPPING
;
1190 Status
= Ip4Groups (IpInstance
, JoinFlag
, GroupAddress
);
1193 gBS
->RestoreTPL (OldTpl
);
1199 Adds and deletes routing table entries.
1201 The Routes() function adds a route to or deletes a route from the routing table.
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.
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
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).
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.
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.
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:
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).
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
1258 IP4_PROTOCOL
*IpInstance
;
1259 IP4_INTERFACE
*IpIf
;
1267 // First, validate the parameters
1269 if ((This
== NULL
) || (SubnetAddress
== NULL
) ||
1270 (SubnetMask
== NULL
) || (GatewayAddress
== NULL
)) {
1271 return EFI_INVALID_PARAMETER
;
1274 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
1275 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1277 if (IpInstance
->State
!= IP4_STATE_CONFIGED
) {
1278 Status
= EFI_NOT_STARTED
;
1282 if (IpInstance
->ConfigData
.UseDefaultAddress
&& IP4_NO_MAPPING (IpInstance
)) {
1283 Status
= EFI_NO_MAPPING
;
1287 CopyMem (&Dest
, SubnetAddress
, sizeof (IP4_ADDR
));
1288 CopyMem (&Netmask
, SubnetMask
, sizeof (IP4_ADDR
));
1289 CopyMem (&Nexthop
, GatewayAddress
, sizeof (IP4_ADDR
));
1291 Dest
= NTOHL (Dest
);
1292 Netmask
= NTOHL (Netmask
);
1293 Nexthop
= NTOHL (Nexthop
);
1295 IpIf
= IpInstance
->Interface
;
1297 if (!IP4_IS_VALID_NETMASK (Netmask
)) {
1298 Status
= EFI_INVALID_PARAMETER
;
1303 // the gateway address must be a unicast on the connected network if not zero.
1305 if ((Nexthop
!= IP4_ALLZERO_ADDRESS
) &&
1306 (!IP4_NET_EQUAL (Nexthop
, IpIf
->Ip
, IpIf
->SubnetMask
) ||
1307 IP4_IS_BROADCAST (Ip4GetNetCast (Nexthop
, IpIf
)))) {
1309 Status
= EFI_INVALID_PARAMETER
;
1314 Status
= Ip4DelRoute (IpInstance
->RouteTable
, Dest
, Netmask
, Nexthop
);
1316 Status
= Ip4AddRoute (IpInstance
->RouteTable
, Dest
, Netmask
, Nexthop
);
1320 gBS
->RestoreTPL (OldTpl
);
1326 Check whether the user's token or event has already
1327 been enqueued on IP4's list.
1329 @param[in] Map The container of either user's transmit or receive
1331 @param[in] Item Current item to check against.
1332 @param[in] Context The Token to check againist.
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
1343 IN NET_MAP_ITEM
*Item
,
1347 EFI_IP4_COMPLETION_TOKEN
*Token
;
1348 EFI_IP4_COMPLETION_TOKEN
*TokenInItem
;
1350 Token
= (EFI_IP4_COMPLETION_TOKEN
*) Context
;
1351 TokenInItem
= (EFI_IP4_COMPLETION_TOKEN
*) Item
->Key
;
1353 if ((Token
== TokenInItem
) || (Token
->Event
== TokenInItem
->Event
)) {
1354 return EFI_ACCESS_DENIED
;
1361 Validate the user's token against current station address.
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.
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.
1374 IN EFI_IP4_COMPLETION_TOKEN
*Token
,
1375 IN IP4_INTERFACE
*IpIf
,
1379 EFI_IP4_TRANSMIT_DATA
*TxData
;
1380 EFI_IP4_OVERRIDE_DATA
*Override
;
1387 if ((Token
== NULL
) || (Token
->Event
== NULL
) || (Token
->Packet
.TxData
== NULL
)) {
1388 return EFI_INVALID_PARAMETER
;
1391 TxData
= Token
->Packet
.TxData
;
1394 // Check the fragment table: no empty fragment, and length isn't bogus.
1396 if ((TxData
->TotalDataLength
== 0) || (TxData
->FragmentCount
== 0)) {
1397 return EFI_INVALID_PARAMETER
;
1400 Offset
= TxData
->TotalDataLength
;
1402 if (Offset
> IP4_MAX_PACKET_SIZE
) {
1403 return EFI_BAD_BUFFER_SIZE
;
1406 for (Index
= 0; Index
< TxData
->FragmentCount
; Index
++) {
1407 if ((TxData
->FragmentTable
[Index
].FragmentBuffer
== NULL
) ||
1408 (TxData
->FragmentTable
[Index
].FragmentLength
== 0)) {
1410 return EFI_INVALID_PARAMETER
;
1413 Offset
-= TxData
->FragmentTable
[Index
].FragmentLength
;
1417 return EFI_INVALID_PARAMETER
;
1421 // NOTE that OptionsLength/OptionsBuffer/OverrideData are ignored if RawData
1429 // Check the IP options: no more than 40 bytes and format is OK
1431 if (TxData
->OptionsLength
!= 0) {
1432 if ((TxData
->OptionsLength
> 40) || (TxData
->OptionsBuffer
== NULL
)) {
1433 return EFI_INVALID_PARAMETER
;
1436 if (!Ip4OptionIsValid (TxData
->OptionsBuffer
, TxData
->OptionsLength
, FALSE
)) {
1437 return EFI_INVALID_PARAMETER
;
1442 // Check the source and gateway: they must be a valid unicast.
1443 // Gateway must also be on the connected network.
1445 if (TxData
->OverrideData
!= NULL
) {
1446 Override
= TxData
->OverrideData
;
1448 CopyMem (&Src
, &Override
->SourceAddress
, sizeof (IP4_ADDR
));
1449 CopyMem (&Gateway
, &Override
->GatewayAddress
, sizeof (IP4_ADDR
));
1452 Gateway
= NTOHL (Gateway
);
1454 if ((NetGetIpClass (Src
) > IP4_ADDR_CLASSC
) ||
1455 (Src
== IP4_ALLONE_ADDRESS
) ||
1456 IP4_IS_BROADCAST (Ip4GetNetCast (Src
, IpIf
))) {
1458 return EFI_INVALID_PARAMETER
;
1462 // If gateway isn't zero, it must be a unicast address, and
1463 // on the connected network.
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
)))) {
1470 return EFI_INVALID_PARAMETER
;
1475 // Check the packet length: Head length and packet length all has a limit
1477 HeadLen
= sizeof (IP4_HEAD
) + ((TxData
->OptionsLength
+ 3) &~0x03);
1479 if ((HeadLen
> IP4_MAX_HEADLEN
) ||
1480 (TxData
->TotalDataLength
+ HeadLen
> IP4_MAX_PACKET_SIZE
)) {
1482 return EFI_BAD_BUFFER_SIZE
;
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.
1507 @param[in] Context The token's wrap.
1516 IP4_TXTOKEN_WRAP
*Wrap
;
1519 Wrap
= (IP4_TXTOKEN_WRAP
*) Context
;
1522 // Signal IpSecRecycleEvent to inform IPsec free the memory
1524 if (Wrap
->IpSecRecycleSignal
!= NULL
) {
1525 gBS
->SignalEvent (Wrap
->IpSecRecycleSignal
);
1529 // Find the token in the instance's map. EfiIp4Transmit put the
1530 // token to the map. If that failed, NetMapFindKey will return NULL.
1532 Item
= NetMapFindKey (&Wrap
->IpInstance
->TxTokens
, Wrap
->Token
);
1535 NetMapRemoveItem (&Wrap
->IpInstance
->TxTokens
, Item
, NULL
);
1539 gBS
->SignalEvent (Wrap
->Token
->Event
);
1542 // Dispatch the DPC queued by the NotifyFunction of Token->Event.
1552 The callback function to Ip4Output to update the transmit status.
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.
1563 IP4_PROTOCOL
*Ip4Instance
,
1565 EFI_STATUS IoStatus
,
1570 IP4_TXTOKEN_WRAP
*Wrap
;
1573 // This is the transmission request from upper layer,
1574 // not the IP4 driver itself.
1576 ASSERT (Ip4Instance
!= NULL
);
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.
1585 Wrap
= (IP4_TXTOKEN_WRAP
*) Context
;
1586 Wrap
->Token
->Status
= IoStatus
;
1588 NetbufFree (Wrap
->Packet
);
1593 Places outgoing data packets into the transmit queue.
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.
1599 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.
1600 @param[in] Token Pointer to the transmit token.
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
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
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).
1624 IN EFI_IP4_PROTOCOL
*This
,
1625 IN EFI_IP4_COMPLETION_TOKEN
*Token
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
;
1639 BOOLEAN DontFragment
;
1642 UINT32 OptionsLength
;
1643 UINT8
*OptionsBuffer
;
1644 VOID
*FirstFragment
;
1647 return EFI_INVALID_PARAMETER
;
1650 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
1652 if (IpInstance
->State
!= IP4_STATE_CONFIGED
) {
1653 return EFI_NOT_STARTED
;
1656 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1658 IpSb
= IpInstance
->Service
;
1659 IpIf
= IpInstance
->Interface
;
1660 Config
= &IpInstance
->ConfigData
;
1662 if (Config
->UseDefaultAddress
&& IP4_NO_MAPPING (IpInstance
)) {
1663 Status
= EFI_NO_MAPPING
;
1668 // make sure that token is properly formated
1670 Status
= Ip4TxTokenValid (Token
, IpIf
, Config
->RawData
);
1672 if (EFI_ERROR (Status
)) {
1677 // Check whether the token or signal already existed.
1679 if (EFI_ERROR (NetMapIterate (&IpInstance
->TxTokens
, Ip4TokenExist
, Token
))) {
1680 Status
= EFI_ACCESS_DENIED
;
1685 // Build the IP header, need to fill in the Tos, TotalLen, Id,
1686 // fragment, Ttl, protocol, Src, and Dst.
1688 TxData
= Token
->Packet
.TxData
;
1690 FirstFragment
= NULL
;
1692 if (Config
->RawData
) {
1694 // When RawData is TRUE, first buffer in FragmentTable points to a raw
1695 // IPv4 fragment including IPv4 header and options.
1697 FirstFragment
= TxData
->FragmentTable
[0].FragmentBuffer
;
1698 CopyMem (&RawHdrLen
, FirstFragment
, sizeof (UINT8
));
1700 RawHdrLen
= (UINT8
) (RawHdrLen
& 0x0f);
1701 if (RawHdrLen
< 5) {
1702 Status
= EFI_INVALID_PARAMETER
;
1706 RawHdrLen
= (UINT8
) (RawHdrLen
<< 2);
1708 CopyMem (&Head
, FirstFragment
, IP4_MIN_HEADLEN
);
1710 Ip4NtohHead (&Head
);
1712 DontFragment
= IP4_DO_NOT_FRAGMENT (Head
.Fragment
);
1714 if (!DontFragment
) {
1715 Status
= EFI_INVALID_PARAMETER
;
1719 GateWay
= IP4_ALLZERO_ADDRESS
;
1722 // Get IPv4 options from first fragment.
1724 if (RawHdrLen
== IP4_MIN_HEADLEN
) {
1726 OptionsBuffer
= NULL
;
1728 OptionsLength
= RawHdrLen
- IP4_MIN_HEADLEN
;
1729 OptionsBuffer
= (UINT8
*) FirstFragment
+ IP4_MIN_HEADLEN
;
1733 // Trim off IPv4 header and options from first fragment.
1735 TxData
->FragmentTable
[0].FragmentBuffer
= (UINT8
*) FirstFragment
+ RawHdrLen
;
1736 TxData
->FragmentTable
[0].FragmentLength
= TxData
->FragmentTable
[0].FragmentLength
- RawHdrLen
;
1738 CopyMem (&Head
.Dst
, &TxData
->DestinationAddress
, sizeof (IP4_ADDR
));
1739 Head
.Dst
= NTOHL (Head
.Dst
);
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
;
1748 CopyMem (&Head
.Src
, &Override
->SourceAddress
, sizeof (IP4_ADDR
));
1749 CopyMem (&GateWay
, &Override
->GatewayAddress
, sizeof (IP4_ADDR
));
1751 Head
.Src
= NTOHL (Head
.Src
);
1752 GateWay
= NTOHL (GateWay
);
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
;
1762 Head
.Fragment
= IP4_HEAD_FRAGMENT_FIELD (DontFragment
, FALSE
, 0);
1763 HeadLen
= (TxData
->OptionsLength
+ 3) & (~0x03);
1765 OptionsLength
= TxData
->OptionsLength
;
1766 OptionsBuffer
= (UINT8
*) (TxData
->OptionsBuffer
);
1770 // If don't fragment and fragment needed, return error
1772 if (DontFragment
&& (TxData
->TotalDataLength
+ HeadLen
> IpSb
->MaxPacketSize
)) {
1773 Status
= EFI_BAD_BUFFER_SIZE
;
1778 // OK, it survives all the validation check. Wrap the token in
1779 // a IP4_TXTOKEN_WRAP and the data in a netbuf
1781 Status
= EFI_OUT_OF_RESOURCES
;
1782 Wrap
= AllocateZeroPool (sizeof (IP4_TXTOKEN_WRAP
));
1787 Wrap
->IpInstance
= IpInstance
;
1788 Wrap
->Token
= Token
;
1790 Wrap
->Life
= IP4_US_TO_SEC (Config
->TransmitTimeout
);
1791 Wrap
->Packet
= NetbufFromExt (
1792 (NET_FRAGMENT
*) TxData
->FragmentTable
,
1793 TxData
->FragmentCount
,
1800 if (Wrap
->Packet
== NULL
) {
1805 Token
->Status
= EFI_NOT_READY
;
1807 if (EFI_ERROR (NetMapInsertTail (&IpInstance
->TxTokens
, Token
, Wrap
))) {
1809 // NetbufFree will call Ip4FreeTxToken, which in turn will
1810 // free the IP4_TXTOKEN_WRAP. Now, the token wrap hasn't been
1813 if (Config
->RawData
) {
1815 // Restore pointer of first fragment in RawData mode.
1817 TxData
->FragmentTable
[0].FragmentBuffer
= (UINT8
*) FirstFragment
;
1820 NetbufFree (Wrap
->Packet
);
1825 // Mark the packet sent before output it. Mark it not sent again if the
1826 // returned status is not EFI_SUCCESS;
1830 Status
= Ip4Output (
1842 if (EFI_ERROR (Status
)) {
1845 if (Config
->RawData
) {
1847 // Restore pointer of first fragment in RawData mode.
1849 TxData
->FragmentTable
[0].FragmentBuffer
= (UINT8
*) FirstFragment
;
1852 NetbufFree (Wrap
->Packet
);
1855 if (Config
->RawData
) {
1857 // Restore pointer of first fragment in RawData mode.
1859 TxData
->FragmentTable
[0].FragmentBuffer
= (UINT8
*) FirstFragment
;
1863 gBS
->RestoreTPL (OldTpl
);
1869 Places a receiving request into the receiving queue.
1871 The Receive() function places a completion token into the receive packet queue.
1872 This function is always asynchronous.
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
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.
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:
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.
1903 IN EFI_IP4_PROTOCOL
*This
,
1904 IN EFI_IP4_COMPLETION_TOKEN
*Token
1907 IP4_PROTOCOL
*IpInstance
;
1912 // First validate the parameters
1914 if ((This
== NULL
) || (Token
== NULL
) || (Token
->Event
== NULL
)) {
1915 return EFI_INVALID_PARAMETER
;
1918 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
1920 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1922 if (IpInstance
->State
!= IP4_STATE_CONFIGED
) {
1923 Status
= EFI_NOT_STARTED
;
1928 // Check whether the toke is already on the receive queue.
1930 Status
= NetMapIterate (&IpInstance
->RxTokens
, Ip4TokenExist
, Token
);
1932 if (EFI_ERROR (Status
)) {
1933 Status
= EFI_ACCESS_DENIED
;
1938 // Queue the token then check whether there is pending received packet.
1940 Status
= NetMapInsertTail (&IpInstance
->RxTokens
, Token
, NULL
);
1942 if (EFI_ERROR (Status
)) {
1946 Status
= Ip4InstanceDeliverPacket (IpInstance
);
1949 // Dispatch the DPC queued by the NotifyFunction of this instane's receive
1955 gBS
->RestoreTPL (OldTpl
);
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.
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.
1973 @retval EFI_SUCCESS Continue to check the next Item.
1974 @retval EFI_ABORTED The user's Token (Token != NULL) is cancelled.
1981 IN NET_MAP_ITEM
*Item
,
1985 EFI_IP4_COMPLETION_TOKEN
*Token
;
1986 IP4_TXTOKEN_WRAP
*Wrap
;
1988 Token
= (EFI_IP4_COMPLETION_TOKEN
*) Context
;
1991 // Return EFI_SUCCESS to check the next item in the map if
1992 // this one doesn't match.
1994 if ((Token
!= NULL
) && (Token
!= Item
->Key
)) {
1998 Wrap
= (IP4_TXTOKEN_WRAP
*) Item
->Value
;
1999 ASSERT (Wrap
!= NULL
);
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.
2005 Ip4CancelPacket (Wrap
->IpInstance
->Interface
, Wrap
->Packet
, EFI_ABORTED
);
2008 // If only one item is to be cancel, return EFI_ABORTED to stop
2009 // iterating the map any more.
2011 if (Token
!= NULL
) {
2020 Cancel the receive request. This is quiet simple, because
2021 it is only enqueued in our local receive map.
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.
2027 @retval EFI_SUCCESS Continue to check the next receive request on the
2029 @retval EFI_ABORTED The user's token (token != NULL) has been
2037 IN NET_MAP_ITEM
*Item
,
2041 EFI_IP4_COMPLETION_TOKEN
*Token
;
2042 EFI_IP4_COMPLETION_TOKEN
*This
;
2044 Token
= (EFI_IP4_COMPLETION_TOKEN
*) Context
;
2047 if ((Token
!= NULL
) && (Token
!= This
)) {
2051 NetMapRemoveItem (Map
, Item
, NULL
);
2053 This
->Status
= EFI_ABORTED
;
2054 This
->Packet
.RxData
= NULL
;
2055 gBS
->SignalEvent (This
->Event
);
2057 if (Token
!= NULL
) {
2066 Cancel the user's receive/transmit request.
2068 @param[in] IpInstance The IP4 child.
2069 @param[in] Token The token to cancel. If NULL, all token will be
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.
2080 IN IP4_PROTOCOL
*IpInstance
,
2081 IN EFI_IP4_COMPLETION_TOKEN
*Token OPTIONAL
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.
2091 Status
= NetMapIterate (&IpInstance
->TxTokens
, Ip4CancelTxTokens
, Token
);
2093 if (EFI_ERROR (Status
)) {
2094 if ((Token
!= NULL
) && (Status
== EFI_ABORTED
)) {
2102 // Check the receive queue. Ip4CancelRxTokens also returns EFI_ABORT
2103 // for Token!=NULL and it is cancelled.
2105 Status
= NetMapIterate (&IpInstance
->RxTokens
, Ip4CancelRxTokens
, Token
);
2107 // Dispatch the DPCs queued by the NotifyFunction of the canceled rx token's
2111 if (EFI_ERROR (Status
)) {
2112 if ((Token
!= NULL
) && (Status
== EFI_ABORTED
)) {
2120 // OK, if the Token is found when Token != NULL, the NetMapIterate
2121 // will return EFI_ABORTED, which has been interrupted as EFI_SUCCESS.
2123 if (Token
!= NULL
) {
2124 return EFI_NOT_FOUND
;
2128 // If Token == NULL, cancel all the tokens. return error if no
2129 // all of them are cancelled.
2131 if (!NetMapIsEmpty (&IpInstance
->TxTokens
) ||
2132 !NetMapIsEmpty (&IpInstance
->RxTokens
)) {
2134 return EFI_DEVICE_ERROR
;
2142 Abort an asynchronous transmit or receive request.
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.
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().
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().
2173 IN EFI_IP4_PROTOCOL
*This
,
2174 IN EFI_IP4_COMPLETION_TOKEN
*Token OPTIONAL
2177 IP4_PROTOCOL
*IpInstance
;
2182 return EFI_INVALID_PARAMETER
;
2185 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
2187 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
2189 if (IpInstance
->State
!= IP4_STATE_CONFIGED
) {
2190 Status
= EFI_NOT_STARTED
;
2194 if (IpInstance
->ConfigData
.UseDefaultAddress
&& IP4_NO_MAPPING (IpInstance
)) {
2195 Status
= EFI_NO_MAPPING
;
2199 Status
= Ip4Cancel (IpInstance
, Token
);
2202 gBS
->RestoreTPL (OldTpl
);
2208 Polls for incoming data packets and processes outgoing data packets.
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.
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
2221 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.
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.
2237 IN EFI_IP4_PROTOCOL
*This
2240 IP4_PROTOCOL
*IpInstance
;
2241 EFI_MANAGED_NETWORK_PROTOCOL
*Mnp
;
2244 return EFI_INVALID_PARAMETER
;
2247 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
2249 if (IpInstance
->State
== IP4_STATE_UNCONFIGED
) {
2250 return EFI_NOT_STARTED
;
2253 Mnp
= IpInstance
->Service
->Mnp
;
2256 // Don't lock the Poll function to enable the deliver of
2257 // the packet polled up.
2259 return Mnp
->Poll (Mnp
);
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
2269 @param[in] Map The IP4 child's transmit map.
2270 @param[in] Item Current transmitted packet.
2271 @param[in] Context Not used.
2273 @retval EFI_SUCCESS Always returns EFI_SUCCESS.
2278 Ip4SentPacketTicking (
2280 IN NET_MAP_ITEM
*Item
,
2284 IP4_TXTOKEN_WRAP
*Wrap
;
2286 Wrap
= (IP4_TXTOKEN_WRAP
*) Item
->Value
;
2287 ASSERT (Wrap
!= NULL
);
2289 if ((Wrap
->Life
> 0) && (--Wrap
->Life
== 0)) {
2290 Ip4CancelPacket (Wrap
->IpInstance
->Interface
, Wrap
->Packet
, EFI_ABORTED
);
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.
2303 @param[in] Event The IP4 service instance's heart beat timer.
2304 @param[in] Context The IP4 service instance.
2316 IpSb
= (IP4_SERVICE
*) Context
;
2317 NET_CHECK_SIGNATURE (IpSb
, IP4_SERVICE_SIGNATURE
);
2319 Ip4PacketTimerTicking (IpSb
);
2320 Ip4IgmpTicking (IpSb
);