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
= EFI_NO_MAPPING
;
685 IpIf
= IpSb
->DefaultInterface
;
686 NET_GET_REF (IpSb
->DefaultInterface
);
689 // If default address is used, so is the default route table.
690 // Any route set by the instance has the precedence over the
691 // routes in the default route table. Link the default table
692 // after the instance's table. Routing will search the local
695 NET_GET_REF (IpSb
->DefaultRouteTable
);
696 IpInstance
->RouteTable
->Next
= IpSb
->DefaultRouteTable
;
699 IpInstance
->Interface
= IpIf
;
700 if (IpIf
->Arp
!= NULL
) {
702 Status
= gBS
->OpenProtocol (
704 &gEfiArpProtocolGuid
,
706 gIp4DriverBinding
.DriverBindingHandle
,
708 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
710 if (EFI_ERROR (Status
)) {
714 InsertTailList (&IpIf
->IpInstances
, &IpInstance
->AddrLink
);
716 CopyMem (&IpInstance
->ConfigData
, Config
, sizeof (IpInstance
->ConfigData
));
717 IpInstance
->State
= IP4_STATE_CONFIGED
;
720 // Although EFI_NO_MAPPING is an error code, the IP child has been
721 // successfully configured and doesn't need reconfiguration when
722 // default address is acquired.
724 if (Config
->UseDefaultAddress
&& IP4_NO_MAPPING (IpInstance
)) {
725 return EFI_NO_MAPPING
;
731 Ip4FreeRouteTable (IpInstance
->RouteTable
);
732 IpInstance
->RouteTable
= NULL
;
738 Clean up the IP4 child, release all the resources used by it.
740 @param[in] IpInstance The IP4 child to clean up.
742 @retval EFI_SUCCESS The IP4 child is cleaned up.
743 @retval EFI_DEVICE_ERROR Some resources failed to be released.
748 IN IP4_PROTOCOL
*IpInstance
751 if (EFI_ERROR (Ip4Cancel (IpInstance
, NULL
))) {
752 return EFI_DEVICE_ERROR
;
755 if (EFI_ERROR (Ip4Groups (IpInstance
, FALSE
, NULL
))) {
756 return EFI_DEVICE_ERROR
;
760 // Some packets haven't been recycled. It is because either the
761 // user forgets to recycle the packets, or because the callback
762 // hasn't been called. Just leave it alone.
764 if (!IsListEmpty (&IpInstance
->Delivered
)) {
768 if (IpInstance
->Interface
!= NULL
) {
769 RemoveEntryList (&IpInstance
->AddrLink
);
770 if (IpInstance
->Interface
->Arp
!= NULL
) {
772 IpInstance
->Interface
->ArpHandle
,
773 &gEfiArpProtocolGuid
,
774 gIp4DriverBinding
.DriverBindingHandle
,
778 Ip4FreeInterface (IpInstance
->Interface
, IpInstance
);
779 IpInstance
->Interface
= NULL
;
782 if (IpInstance
->RouteTable
!= NULL
) {
783 if (IpInstance
->RouteTable
->Next
!= NULL
) {
784 Ip4FreeRouteTable (IpInstance
->RouteTable
->Next
);
787 Ip4FreeRouteTable (IpInstance
->RouteTable
);
788 IpInstance
->RouteTable
= NULL
;
791 if (IpInstance
->EfiRouteTable
!= NULL
) {
792 FreePool (IpInstance
->EfiRouteTable
);
793 IpInstance
->EfiRouteTable
= NULL
;
794 IpInstance
->EfiRouteCount
= 0;
797 if (IpInstance
->Groups
!= NULL
) {
798 FreePool (IpInstance
->Groups
);
799 IpInstance
->Groups
= NULL
;
800 IpInstance
->GroupCount
= 0;
803 NetMapClean (&IpInstance
->TxTokens
);
805 NetMapClean (&IpInstance
->RxTokens
);
812 Validate that Ip/Netmask pair is OK to be used as station
813 address. Only continuous netmasks are supported. and check
814 that StationAddress is a unicast address on the newtwork.
816 @param[in] Ip The IP address to validate.
817 @param[in] Netmask The netmaks of the IP.
819 @retval TRUE The Ip/Netmask pair is valid.
820 @retval FALSE The Ip/Netmask pair is invalid.
824 Ip4StationAddressValid (
829 IP4_ADDR NetBrdcastMask
;
834 // Only support the station address with 0.0.0.0/0 to enable DHCP client.
836 if (Netmask
== IP4_ALLZERO_ADDRESS
) {
837 return (BOOLEAN
) (Ip
== IP4_ALLZERO_ADDRESS
);
841 // Only support the continuous net masks
843 if ((Len
= NetGetMaskLength (Netmask
)) == IP4_MASK_NUM
) {
848 // Station address can't be class D or class E address
850 if ((Type
= NetGetIpClass (Ip
)) > IP4_ADDR_CLASSC
) {
855 // Station address can't be subnet broadcast/net broadcast address
857 if ((Ip
== (Ip
& Netmask
)) || (Ip
== (Ip
| ~Netmask
))) {
861 NetBrdcastMask
= gIp4AllMasks
[MIN (Len
, Type
<< 3)];
863 if (Ip
== (Ip
| ~NetBrdcastMask
)) {
872 Assigns an IPv4 address and subnet mask to this EFI IPv4 Protocol driver instance.
874 The Configure() function is used to set, change, or reset the operational
875 parameters and filter settings for this EFI IPv4 Protocol instance. Until these
876 parameters have been set, no network traffic can be sent or received by this
877 instance. Once the parameters have been reset (by calling this function with
878 IpConfigData set to NULL), no more traffic can be sent or received until these
879 parameters have been set again. Each EFI IPv4 Protocol instance can be started
880 and stopped independently of each other by enabling or disabling their receive
881 filter settings with the Configure() function.
883 When IpConfigData.UseDefaultAddress is set to FALSE, the new station address will
884 be appended as an alias address into the addresses list in the EFI IPv4 Protocol
885 driver. While set to TRUE, Configure() will trigger the EFI_IP4_CONFIG_PROTOCOL
886 to retrieve the default IPv4 address if it is not available yet. Clients could
887 frequently call GetModeData() to check the status to ensure that the default IPv4
890 If operational parameters are reset or changed, any pending transmit and receive
891 requests will be cancelled. Their completion token status will be set to EFI_ABORTED
892 and their events will be signaled.
894 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.
895 @param[in] IpConfigData Pointer to the EFI IPv4 Protocol configuration data structure.
897 @retval EFI_SUCCESS The driver instance was successfully opened.
898 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
899 RARP, etc.) is not finished yet.
900 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
901 @retval EFI_UNSUPPORTED One or more of the following conditions is TRUE:
902 A configuration protocol (DHCP, BOOTP, RARP, etc.) could
903 not be located when clients choose to use the default IPv4
904 address. This EFI IPv4 Protocol implementation does not
905 support this requested filter or timeout setting.
906 @retval EFI_OUT_OF_RESOURCES The EFI IPv4 Protocol driver instance data could not be allocated.
907 @retval EFI_ALREADY_STARTED The interface is already open and must be stopped before the
908 IPv4 address or subnet mask can be changed. The interface must
909 also be stopped when switching to/from raw packet mode.
910 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI IPv4
911 Protocol driver instance is not opened.
917 IN EFI_IP4_PROTOCOL
*This
,
918 IN EFI_IP4_CONFIG_DATA
*IpConfigData OPTIONAL
921 IP4_PROTOCOL
*IpInstance
;
922 EFI_IP4_CONFIG_DATA
*Current
;
930 // First, validate the parameters
933 return EFI_INVALID_PARAMETER
;
936 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
937 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
940 // Validate the configuration first.
942 if (IpConfigData
!= NULL
) {
944 CopyMem (&IpAddress
, &IpConfigData
->StationAddress
, sizeof (IP4_ADDR
));
945 CopyMem (&SubnetMask
, &IpConfigData
->SubnetMask
, sizeof (IP4_ADDR
));
947 IpAddress
= NTOHL (IpAddress
);
948 SubnetMask
= NTOHL (SubnetMask
);
951 // Check whether the station address is a valid unicast address
953 if (!IpConfigData
->UseDefaultAddress
) {
954 AddrOk
= Ip4StationAddressValid (IpAddress
, SubnetMask
);
957 Status
= EFI_INVALID_PARAMETER
;
963 // User can only update packet filters when already configured.
964 // If it wants to change the station address, it must configure(NULL)
965 // the instance first.
967 if (IpInstance
->State
== IP4_STATE_CONFIGED
) {
968 Current
= &IpInstance
->ConfigData
;
970 if (Current
->UseDefaultAddress
!= IpConfigData
->UseDefaultAddress
) {
971 Status
= EFI_ALREADY_STARTED
;
975 if (!Current
->UseDefaultAddress
&&
976 (!EFI_IP4_EQUAL (&Current
->StationAddress
, &IpConfigData
->StationAddress
) ||
977 !EFI_IP4_EQUAL (&Current
->SubnetMask
, &IpConfigData
->SubnetMask
))) {
978 Status
= EFI_ALREADY_STARTED
;
982 if (Current
->UseDefaultAddress
&& IP4_NO_MAPPING (IpInstance
)) {
983 Status
= EFI_NO_MAPPING
;
990 // Configure the instance or clean it up.
992 if (IpConfigData
!= NULL
) {
993 Status
= Ip4ConfigProtocol (IpInstance
, IpConfigData
);
995 Status
= Ip4CleanProtocol (IpInstance
);
998 // Don't change the state if it is DESTROY, consider the following
999 // valid sequence: Mnp is unloaded-->Ip Stopped-->Udp Stopped,
1000 // Configure (ThisIp, NULL). If the state is changed to UNCONFIGED,
1001 // the unload fails miserably.
1003 if (IpInstance
->State
== IP4_STATE_CONFIGED
) {
1004 IpInstance
->State
= IP4_STATE_UNCONFIGED
;
1009 // Update the MNP's configure data. Ip4ServiceConfigMnp will check
1010 // whether it is necessary to reconfigure the MNP.
1012 Ip4ServiceConfigMnp (IpInstance
->Service
, FALSE
);
1015 gBS
->RestoreTPL (OldTpl
);
1022 Change the IP4 child's multicast setting. The caller
1023 should make sure that the parameters is valid.
1025 @param[in] IpInstance The IP4 child to change the setting.
1026 @param[in] JoinFlag TRUE to join the group, otherwise leave it.
1027 @param[in] GroupAddress The target group address.
1029 @retval EFI_ALREADY_STARTED Want to join the group, but already a member of it.
1030 @retval EFI_OUT_OF_RESOURCES Failed to allocate some resources.
1031 @retval EFI_DEVICE_ERROR Failed to set the group configuraton.
1032 @retval EFI_SUCCESS Successfully updated the group setting.
1033 @retval EFI_NOT_FOUND Try to leave the group which it isn't a member.
1038 IN IP4_PROTOCOL
*IpInstance
,
1039 IN BOOLEAN JoinFlag
,
1040 IN EFI_IPv4_ADDRESS
*GroupAddress OPTIONAL
1048 // Add it to the instance's Groups, and join the group by IGMP.
1049 // IpInstance->Groups is in network byte order. IGMP operates in
1054 // When JoinFlag is TRUE, GroupAddress shouldn't be NULL.
1056 ASSERT (GroupAddress
!= NULL
);
1057 CopyMem (&Group
, GroupAddress
, sizeof (IP4_ADDR
));
1059 for (Index
= 0; Index
< IpInstance
->GroupCount
; Index
++) {
1060 if (IpInstance
->Groups
[Index
] == Group
) {
1061 return EFI_ALREADY_STARTED
;
1065 Members
= Ip4CombineGroups (IpInstance
->Groups
, IpInstance
->GroupCount
, Group
);
1067 if (Members
== NULL
) {
1068 return EFI_OUT_OF_RESOURCES
;
1071 if (EFI_ERROR (Ip4JoinGroup (IpInstance
, NTOHL (Group
)))) {
1073 return EFI_DEVICE_ERROR
;
1076 if (IpInstance
->Groups
!= NULL
) {
1077 FreePool (IpInstance
->Groups
);
1080 IpInstance
->Groups
= Members
;
1081 IpInstance
->GroupCount
++;
1087 // Leave the group. Leave all the groups if GroupAddress is NULL.
1088 // Must iterate from the end to the beginning because the GroupCount
1089 // is decreamented each time an address is removed..
1091 for (Index
= IpInstance
->GroupCount
; Index
> 0 ; Index
--) {
1092 Group
= IpInstance
->Groups
[Index
- 1];
1094 if ((GroupAddress
== NULL
) || EFI_IP4_EQUAL (&Group
, GroupAddress
)) {
1095 if (EFI_ERROR (Ip4LeaveGroup (IpInstance
, NTOHL (Group
)))) {
1096 return EFI_DEVICE_ERROR
;
1099 Ip4RemoveGroupAddr (IpInstance
->Groups
, IpInstance
->GroupCount
, Group
);
1100 IpInstance
->GroupCount
--;
1102 if (IpInstance
->GroupCount
== 0) {
1103 ASSERT (Index
== 1);
1105 FreePool (IpInstance
->Groups
);
1106 IpInstance
->Groups
= NULL
;
1109 if (GroupAddress
!= NULL
) {
1115 return ((GroupAddress
!= NULL
) ? EFI_NOT_FOUND
: EFI_SUCCESS
);
1120 Joins and leaves multicast groups.
1122 The Groups() function is used to join and leave multicast group sessions. Joining
1123 a group will enable reception of matching multicast packets. Leaving a group will
1124 disable the multicast packet reception.
1126 If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left.
1128 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.
1129 @param[in] JoinFlag Set to TRUE to join the multicast group session and FALSE to leave.
1130 @param[in] GroupAddress Pointer to the IPv4 multicast address.
1132 @retval EFI_SUCCESS The operation completed successfully.
1133 @retval EFI_INVALID_PARAMETER One or more of the following is TRUE:
1135 - JoinFlag is TRUE and GroupAddress is NULL.
1136 - GroupAddress is not NULL and *GroupAddress is
1137 not a multicast IPv4 address.
1138 @retval EFI_NOT_STARTED This instance has not been started.
1139 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
1140 RARP, etc.) is not finished yet.
1141 @retval EFI_OUT_OF_RESOURCES System resources could not be allocated.
1142 @retval EFI_UNSUPPORTED This EFI IPv4 Protocol implementation does not support multicast groups.
1143 @retval EFI_ALREADY_STARTED The group address is already in the group table (when
1145 @retval EFI_NOT_FOUND The group address is not in the group table (when JoinFlag is FALSE).
1146 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
1152 IN EFI_IP4_PROTOCOL
*This
,
1153 IN BOOLEAN JoinFlag
,
1154 IN EFI_IPv4_ADDRESS
*GroupAddress OPTIONAL
1157 IP4_PROTOCOL
*IpInstance
;
1162 if ((This
== NULL
) || (JoinFlag
&& (GroupAddress
== NULL
))) {
1163 return EFI_INVALID_PARAMETER
;
1166 if (GroupAddress
!= NULL
) {
1167 CopyMem (&McastIp
, GroupAddress
, sizeof (IP4_ADDR
));
1169 if (!IP4_IS_MULTICAST (NTOHL (McastIp
))) {
1170 return EFI_INVALID_PARAMETER
;
1174 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
1175 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1177 if (IpInstance
->State
!= IP4_STATE_CONFIGED
) {
1178 Status
= EFI_NOT_STARTED
;
1182 if (IpInstance
->ConfigData
.UseDefaultAddress
&& IP4_NO_MAPPING (IpInstance
)) {
1183 Status
= EFI_NO_MAPPING
;
1187 Status
= Ip4Groups (IpInstance
, JoinFlag
, GroupAddress
);
1190 gBS
->RestoreTPL (OldTpl
);
1196 Adds and deletes routing table entries.
1198 The Routes() function adds a route to or deletes a route from the routing table.
1200 Routes are determined by comparing the SubnetAddress with the destination IPv4
1201 address arithmetically AND-ed with the SubnetMask. The gateway address must be
1202 on the same subnet as the configured station address.
1204 The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0.
1205 The default route matches all destination IPv4 addresses that do not match any
1208 A GatewayAddress that is zero is a nonroute. Packets are sent to the destination
1209 IP address if it can be found in the ARP cache or on the local subnet. One automatic
1210 nonroute entry will be inserted into the routing table for outgoing packets that
1211 are addressed to a local subnet (gateway address of 0.0.0.0).
1213 Each EFI IPv4 Protocol instance has its own independent routing table. Those EFI
1214 IPv4 Protocol instances that use the default IPv4 address will also have copies
1215 of the routing table that was provided by the EFI_IP4_CONFIG_PROTOCOL, and these
1216 copies will be updated whenever the EIF IPv4 Protocol driver reconfigures its
1217 instances. As a result, client modification to the routing table will be lost.
1219 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.
1220 @param[in] DeleteRoute Set to TRUE to delete this route from the routing table. Set to
1221 FALSE to add this route to the routing table. SubnetAddress
1222 and SubnetMask are used as the key to each route entry.
1223 @param[in] SubnetAddress The address of the subnet that needs to be routed.
1224 @param[in] SubnetMask The subnet mask of SubnetAddress.
1225 @param[in] GatewayAddress The unicast gateway IPv4 address for this route.
1227 @retval EFI_SUCCESS The operation completed successfully.
1228 @retval EFI_NOT_STARTED The driver instance has not been started.
1229 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
1230 RARP, etc.) is not finished yet.
1231 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
1233 - SubnetAddress is NULL.
1234 - SubnetMask is NULL.
1235 - GatewayAddress is NULL.
1236 - *SubnetAddress is not a valid subnet address.
1237 - *SubnetMask is not a valid subnet mask.
1238 - *GatewayAddress is not a valid unicast IPv4 address.
1239 @retval EFI_OUT_OF_RESOURCES Could not add the entry to the routing table.
1240 @retval EFI_NOT_FOUND This route is not in the routing table (when DeleteRoute is TRUE).
1241 @retval EFI_ACCESS_DENIED The route is already defined in the routing table (when
1242 DeleteRoute is FALSE).
1248 IN EFI_IP4_PROTOCOL
*This
,
1249 IN BOOLEAN DeleteRoute
,
1250 IN EFI_IPv4_ADDRESS
*SubnetAddress
,
1251 IN EFI_IPv4_ADDRESS
*SubnetMask
,
1252 IN EFI_IPv4_ADDRESS
*GatewayAddress
1255 IP4_PROTOCOL
*IpInstance
;
1256 IP4_INTERFACE
*IpIf
;
1264 // First, validate the parameters
1266 if ((This
== NULL
) || (SubnetAddress
== NULL
) ||
1267 (SubnetMask
== NULL
) || (GatewayAddress
== NULL
)) {
1268 return EFI_INVALID_PARAMETER
;
1271 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
1272 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1274 if (IpInstance
->State
!= IP4_STATE_CONFIGED
) {
1275 Status
= EFI_NOT_STARTED
;
1279 if (IpInstance
->ConfigData
.UseDefaultAddress
&& IP4_NO_MAPPING (IpInstance
)) {
1280 Status
= EFI_NO_MAPPING
;
1284 CopyMem (&Dest
, SubnetAddress
, sizeof (IP4_ADDR
));
1285 CopyMem (&Netmask
, SubnetMask
, sizeof (IP4_ADDR
));
1286 CopyMem (&Nexthop
, GatewayAddress
, sizeof (IP4_ADDR
));
1288 Dest
= NTOHL (Dest
);
1289 Netmask
= NTOHL (Netmask
);
1290 Nexthop
= NTOHL (Nexthop
);
1292 IpIf
= IpInstance
->Interface
;
1294 if (!IP4_IS_VALID_NETMASK (Netmask
)) {
1295 Status
= EFI_INVALID_PARAMETER
;
1300 // the gateway address must be a unicast on the connected network if not zero.
1302 if ((Nexthop
!= IP4_ALLZERO_ADDRESS
) &&
1303 (!IP4_NET_EQUAL (Nexthop
, IpIf
->Ip
, IpIf
->SubnetMask
) ||
1304 IP4_IS_BROADCAST (Ip4GetNetCast (Nexthop
, IpIf
)))) {
1306 Status
= EFI_INVALID_PARAMETER
;
1311 Status
= Ip4DelRoute (IpInstance
->RouteTable
, Dest
, Netmask
, Nexthop
);
1313 Status
= Ip4AddRoute (IpInstance
->RouteTable
, Dest
, Netmask
, Nexthop
);
1317 gBS
->RestoreTPL (OldTpl
);
1323 Check whether the user's token or event has already
1324 been enqueued on IP4's list.
1326 @param[in] Map The container of either user's transmit or receive
1328 @param[in] Item Current item to check against.
1329 @param[in] Context The Token to check againist.
1331 @retval EFI_ACCESS_DENIED The token or event has already been enqueued in IP.
1332 @retval EFI_SUCCESS The current item isn't the same token/event as the
1340 IN NET_MAP_ITEM
*Item
,
1344 EFI_IP4_COMPLETION_TOKEN
*Token
;
1345 EFI_IP4_COMPLETION_TOKEN
*TokenInItem
;
1347 Token
= (EFI_IP4_COMPLETION_TOKEN
*) Context
;
1348 TokenInItem
= (EFI_IP4_COMPLETION_TOKEN
*) Item
->Key
;
1350 if ((Token
== TokenInItem
) || (Token
->Event
== TokenInItem
->Event
)) {
1351 return EFI_ACCESS_DENIED
;
1358 Validate the user's token against current station address.
1360 @param[in] Token User's token to validate.
1361 @param[in] IpIf The IP4 child's interface.
1362 @param[in] RawData Set to TRUE to send unformatted packets.
1364 @retval EFI_INVALID_PARAMETER Some parameters are invalid.
1365 @retval EFI_BAD_BUFFER_SIZE The user's option/data is too long.
1366 @retval EFI_SUCCESS The token is valid.
1371 IN EFI_IP4_COMPLETION_TOKEN
*Token
,
1372 IN IP4_INTERFACE
*IpIf
,
1376 EFI_IP4_TRANSMIT_DATA
*TxData
;
1377 EFI_IP4_OVERRIDE_DATA
*Override
;
1384 if ((Token
== NULL
) || (Token
->Event
== NULL
) || (Token
->Packet
.TxData
== NULL
)) {
1385 return EFI_INVALID_PARAMETER
;
1388 TxData
= Token
->Packet
.TxData
;
1391 // Check the fragment table: no empty fragment, and length isn't bogus.
1393 if ((TxData
->TotalDataLength
== 0) || (TxData
->FragmentCount
== 0)) {
1394 return EFI_INVALID_PARAMETER
;
1397 Offset
= TxData
->TotalDataLength
;
1399 if (Offset
> IP4_MAX_PACKET_SIZE
) {
1400 return EFI_BAD_BUFFER_SIZE
;
1403 for (Index
= 0; Index
< TxData
->FragmentCount
; Index
++) {
1404 if ((TxData
->FragmentTable
[Index
].FragmentBuffer
== NULL
) ||
1405 (TxData
->FragmentTable
[Index
].FragmentLength
== 0)) {
1407 return EFI_INVALID_PARAMETER
;
1410 Offset
-= TxData
->FragmentTable
[Index
].FragmentLength
;
1414 return EFI_INVALID_PARAMETER
;
1418 // NOTE that OptionsLength/OptionsBuffer/OverrideData are ignored if RawData
1426 // Check the IP options: no more than 40 bytes and format is OK
1428 if (TxData
->OptionsLength
!= 0) {
1429 if ((TxData
->OptionsLength
> 40) || (TxData
->OptionsBuffer
== NULL
)) {
1430 return EFI_INVALID_PARAMETER
;
1433 if (!Ip4OptionIsValid (TxData
->OptionsBuffer
, TxData
->OptionsLength
, FALSE
)) {
1434 return EFI_INVALID_PARAMETER
;
1439 // Check the source and gateway: they must be a valid unicast.
1440 // Gateway must also be on the connected network.
1442 if (TxData
->OverrideData
!= NULL
) {
1443 Override
= TxData
->OverrideData
;
1445 CopyMem (&Src
, &Override
->SourceAddress
, sizeof (IP4_ADDR
));
1446 CopyMem (&Gateway
, &Override
->GatewayAddress
, sizeof (IP4_ADDR
));
1449 Gateway
= NTOHL (Gateway
);
1451 if ((NetGetIpClass (Src
) > IP4_ADDR_CLASSC
) ||
1452 (Src
== IP4_ALLONE_ADDRESS
) ||
1453 IP4_IS_BROADCAST (Ip4GetNetCast (Src
, IpIf
))) {
1455 return EFI_INVALID_PARAMETER
;
1459 // If gateway isn't zero, it must be a unicast address, and
1460 // on the connected network.
1462 if ((Gateway
!= IP4_ALLZERO_ADDRESS
) &&
1463 ((NetGetIpClass (Gateway
) > IP4_ADDR_CLASSC
) ||
1464 !IP4_NET_EQUAL (Gateway
, IpIf
->Ip
, IpIf
->SubnetMask
) ||
1465 IP4_IS_BROADCAST (Ip4GetNetCast (Gateway
, IpIf
)))) {
1467 return EFI_INVALID_PARAMETER
;
1472 // Check the packet length: Head length and packet length all has a limit
1474 HeadLen
= sizeof (IP4_HEAD
) + ((TxData
->OptionsLength
+ 3) &~0x03);
1476 if ((HeadLen
> IP4_MAX_HEADLEN
) ||
1477 (TxData
->TotalDataLength
+ HeadLen
> IP4_MAX_PACKET_SIZE
)) {
1479 return EFI_BAD_BUFFER_SIZE
;
1487 The callback function for the net buffer which wraps the user's
1488 transmit token. Although it seems this function is pretty simple,
1489 there are some subtle things.
1490 When user requests the IP to transmit a packet by passing it a
1491 token, the token is wrapped in an IP4_TXTOKEN_WRAP and the data
1492 is wrapped in an net buffer. the net buffer's Free function is
1493 set to Ip4FreeTxToken. The Token and token wrap are added to the
1494 IP child's TxToken map. Then the buffer is passed to Ip4Output for
1495 transmission. If something error happened before that, the buffer
1496 is freed, which in turn will free the token wrap. The wrap may
1497 have been added to the TxToken map or not, and the user's event
1498 shouldn't be fired because we are still in the EfiIp4Transmit. If
1499 the buffer has been sent by Ip4Output, it should be removed from
1500 the TxToken map and user's event signaled. The token wrap and buffer
1501 are bound together. Check the comments in Ip4Output for information
1502 about IP fragmentation.
1504 @param[in] Context The token's wrap.
1513 IP4_TXTOKEN_WRAP
*Wrap
;
1516 Wrap
= (IP4_TXTOKEN_WRAP
*) Context
;
1519 // Signal IpSecRecycleEvent to inform IPsec free the memory
1521 if (Wrap
->IpSecRecycleSignal
!= NULL
) {
1522 gBS
->SignalEvent (Wrap
->IpSecRecycleSignal
);
1526 // Find the token in the instance's map. EfiIp4Transmit put the
1527 // token to the map. If that failed, NetMapFindKey will return NULL.
1529 Item
= NetMapFindKey (&Wrap
->IpInstance
->TxTokens
, Wrap
->Token
);
1532 NetMapRemoveItem (&Wrap
->IpInstance
->TxTokens
, Item
, NULL
);
1536 gBS
->SignalEvent (Wrap
->Token
->Event
);
1539 // Dispatch the DPC queued by the NotifyFunction of Token->Event.
1549 The callback function to Ip4Output to update the transmit status.
1551 @param Ip4Instance The Ip4Instance that request the transmit.
1552 @param Packet The user's transmit request.
1553 @param IoStatus The result of the transmission.
1554 @param Flag Not used during transmission.
1555 @param Context The token's wrap.
1560 IP4_PROTOCOL
*Ip4Instance
,
1562 EFI_STATUS IoStatus
,
1567 IP4_TXTOKEN_WRAP
*Wrap
;
1570 // This is the transmission request from upper layer,
1571 // not the IP4 driver itself.
1573 ASSERT (Ip4Instance
!= NULL
);
1576 // The first fragment of the packet has been sent. Update
1577 // the token's status. That is, if fragmented, the transmit's
1578 // status is the first fragment's status. The Wrap will be
1579 // release when all the fragments are release. Check the comments
1580 // in Ip4FreeTxToken and Ip4Output for information.
1582 Wrap
= (IP4_TXTOKEN_WRAP
*) Context
;
1583 Wrap
->Token
->Status
= IoStatus
;
1585 NetbufFree (Wrap
->Packet
);
1590 Places outgoing data packets into the transmit queue.
1592 The Transmit() function places a sending request in the transmit queue of this
1593 EFI IPv4 Protocol instance. Whenever the packet in the token is sent out or some
1594 errors occur, the event in the token will be signaled and the status is updated.
1596 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.
1597 @param[in] Token Pointer to the transmit token.
1599 @retval EFI_SUCCESS The data has been queued for transmission.
1600 @retval EFI_NOT_STARTED This instance has not been started.
1601 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
1602 RARP, etc.) is not finished yet.
1603 @retval EFI_INVALID_PARAMETER One or more pameters are invalid.
1604 @retval EFI_ACCESS_DENIED The transmit completion token with the same Token.Event
1605 was already in the transmit queue.
1606 @retval EFI_NOT_READY The completion token could not be queued because the transmit
1608 @retval EFI_NOT_FOUND Not route is found to destination address.
1609 @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data.
1610 @retval EFI_BUFFER_TOO_SMALL Token.Packet.TxData.TotalDataLength is too
1612 @retval EFI_BAD_BUFFER_SIZE The length of the IPv4 header + option length + total data length is
1613 greater than MTU (or greater than the maximum packet size if
1614 Token.Packet.TxData.OverrideData.
1615 DoNotFragment is TRUE).
1621 IN EFI_IP4_PROTOCOL
*This
,
1622 IN EFI_IP4_COMPLETION_TOKEN
*Token
1626 IP4_PROTOCOL
*IpInstance
;
1627 IP4_INTERFACE
*IpIf
;
1628 IP4_TXTOKEN_WRAP
*Wrap
;
1629 EFI_IP4_TRANSMIT_DATA
*TxData
;
1630 EFI_IP4_CONFIG_DATA
*Config
;
1631 EFI_IP4_OVERRIDE_DATA
*Override
;
1636 BOOLEAN DontFragment
;
1639 UINT32 OptionsLength
;
1640 UINT8
*OptionsBuffer
;
1641 VOID
*FirstFragment
;
1644 return EFI_INVALID_PARAMETER
;
1647 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
1649 if (IpInstance
->State
!= IP4_STATE_CONFIGED
) {
1650 return EFI_NOT_STARTED
;
1653 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1655 IpSb
= IpInstance
->Service
;
1656 IpIf
= IpInstance
->Interface
;
1657 Config
= &IpInstance
->ConfigData
;
1659 if (Config
->UseDefaultAddress
&& IP4_NO_MAPPING (IpInstance
)) {
1660 Status
= EFI_NO_MAPPING
;
1665 // make sure that token is properly formated
1667 Status
= Ip4TxTokenValid (Token
, IpIf
, Config
->RawData
);
1669 if (EFI_ERROR (Status
)) {
1674 // Check whether the token or signal already existed.
1676 if (EFI_ERROR (NetMapIterate (&IpInstance
->TxTokens
, Ip4TokenExist
, Token
))) {
1677 Status
= EFI_ACCESS_DENIED
;
1682 // Build the IP header, need to fill in the Tos, TotalLen, Id,
1683 // fragment, Ttl, protocol, Src, and Dst.
1685 TxData
= Token
->Packet
.TxData
;
1687 FirstFragment
= NULL
;
1689 if (Config
->RawData
) {
1691 // When RawData is TRUE, first buffer in FragmentTable points to a raw
1692 // IPv4 fragment including IPv4 header and options.
1694 FirstFragment
= TxData
->FragmentTable
[0].FragmentBuffer
;
1695 CopyMem (&RawHdrLen
, FirstFragment
, sizeof (UINT8
));
1697 RawHdrLen
= (UINT8
) (RawHdrLen
& 0x0f);
1698 if (RawHdrLen
< 5) {
1699 Status
= EFI_INVALID_PARAMETER
;
1703 RawHdrLen
= (UINT8
) (RawHdrLen
<< 2);
1705 CopyMem (&Head
, FirstFragment
, IP4_MIN_HEADLEN
);
1707 Ip4NtohHead (&Head
);
1709 DontFragment
= IP4_DO_NOT_FRAGMENT (Head
.Fragment
);
1711 if (!DontFragment
) {
1712 Status
= EFI_INVALID_PARAMETER
;
1716 GateWay
= IP4_ALLZERO_ADDRESS
;
1719 // Get IPv4 options from first fragment.
1721 if (RawHdrLen
== IP4_MIN_HEADLEN
) {
1723 OptionsBuffer
= NULL
;
1725 OptionsLength
= RawHdrLen
- IP4_MIN_HEADLEN
;
1726 OptionsBuffer
= (UINT8
*) FirstFragment
+ IP4_MIN_HEADLEN
;
1730 // Trim off IPv4 header and options from first fragment.
1732 TxData
->FragmentTable
[0].FragmentBuffer
= (UINT8
*) FirstFragment
+ RawHdrLen
;
1733 TxData
->FragmentTable
[0].FragmentLength
= TxData
->FragmentTable
[0].FragmentLength
- RawHdrLen
;
1735 CopyMem (&Head
.Dst
, &TxData
->DestinationAddress
, sizeof (IP4_ADDR
));
1736 Head
.Dst
= NTOHL (Head
.Dst
);
1738 if (TxData
->OverrideData
!= NULL
) {
1739 Override
= TxData
->OverrideData
;
1740 Head
.Protocol
= Override
->Protocol
;
1741 Head
.Tos
= Override
->TypeOfService
;
1742 Head
.Ttl
= Override
->TimeToLive
;
1743 DontFragment
= Override
->DoNotFragment
;
1745 CopyMem (&Head
.Src
, &Override
->SourceAddress
, sizeof (IP4_ADDR
));
1746 CopyMem (&GateWay
, &Override
->GatewayAddress
, sizeof (IP4_ADDR
));
1748 Head
.Src
= NTOHL (Head
.Src
);
1749 GateWay
= NTOHL (GateWay
);
1751 Head
.Src
= IpIf
->Ip
;
1752 GateWay
= IP4_ALLZERO_ADDRESS
;
1753 Head
.Protocol
= Config
->DefaultProtocol
;
1754 Head
.Tos
= Config
->TypeOfService
;
1755 Head
.Ttl
= Config
->TimeToLive
;
1756 DontFragment
= Config
->DoNotFragment
;
1759 Head
.Fragment
= IP4_HEAD_FRAGMENT_FIELD (DontFragment
, FALSE
, 0);
1760 HeadLen
= (TxData
->OptionsLength
+ 3) & (~0x03);
1762 OptionsLength
= TxData
->OptionsLength
;
1763 OptionsBuffer
= (UINT8
*) (TxData
->OptionsBuffer
);
1767 // If don't fragment and fragment needed, return error
1769 if (DontFragment
&& (TxData
->TotalDataLength
+ HeadLen
> IpSb
->MaxPacketSize
)) {
1770 Status
= EFI_BAD_BUFFER_SIZE
;
1775 // OK, it survives all the validation check. Wrap the token in
1776 // a IP4_TXTOKEN_WRAP and the data in a netbuf
1778 Status
= EFI_OUT_OF_RESOURCES
;
1779 Wrap
= AllocateZeroPool (sizeof (IP4_TXTOKEN_WRAP
));
1784 Wrap
->IpInstance
= IpInstance
;
1785 Wrap
->Token
= Token
;
1787 Wrap
->Life
= IP4_US_TO_SEC (Config
->TransmitTimeout
);
1788 Wrap
->Packet
= NetbufFromExt (
1789 (NET_FRAGMENT
*) TxData
->FragmentTable
,
1790 TxData
->FragmentCount
,
1797 if (Wrap
->Packet
== NULL
) {
1802 Token
->Status
= EFI_NOT_READY
;
1804 if (EFI_ERROR (NetMapInsertTail (&IpInstance
->TxTokens
, Token
, Wrap
))) {
1806 // NetbufFree will call Ip4FreeTxToken, which in turn will
1807 // free the IP4_TXTOKEN_WRAP. Now, the token wrap hasn't been
1810 if (Config
->RawData
) {
1812 // Restore pointer of first fragment in RawData mode.
1814 TxData
->FragmentTable
[0].FragmentBuffer
= (UINT8
*) FirstFragment
;
1817 NetbufFree (Wrap
->Packet
);
1822 // Mark the packet sent before output it. Mark it not sent again if the
1823 // returned status is not EFI_SUCCESS;
1827 Status
= Ip4Output (
1839 if (EFI_ERROR (Status
)) {
1842 if (Config
->RawData
) {
1844 // Restore pointer of first fragment in RawData mode.
1846 TxData
->FragmentTable
[0].FragmentBuffer
= (UINT8
*) FirstFragment
;
1849 NetbufFree (Wrap
->Packet
);
1852 if (Config
->RawData
) {
1854 // Restore pointer of first fragment in RawData mode.
1856 TxData
->FragmentTable
[0].FragmentBuffer
= (UINT8
*) FirstFragment
;
1860 gBS
->RestoreTPL (OldTpl
);
1866 Places a receiving request into the receiving queue.
1868 The Receive() function places a completion token into the receive packet queue.
1869 This function is always asynchronous.
1871 The Token.Event field in the completion token must be filled in by the caller
1872 and cannot be NULL. When the receive operation completes, the EFI IPv4 Protocol
1873 driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event
1876 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.
1877 @param[in] Token Pointer to a token that is associated with the receive data descriptor.
1879 @retval EFI_SUCCESS The receive completion token was cached.
1880 @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.
1881 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, RARP, etc.)
1882 is not finished yet.
1883 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
1886 - Token.Event is NULL.
1887 @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system
1888 resources (usually memory).
1889 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
1890 The EFI IPv4 Protocol instance has been reset to startup defaults.
1891 EFI_ACCESS_DENIED The receive completion token with the same Token.Event was already
1892 in the receive queue.
1893 @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full.
1894 @retval EFI_ICMP_ERROR An ICMP error packet was received.
1900 IN EFI_IP4_PROTOCOL
*This
,
1901 IN EFI_IP4_COMPLETION_TOKEN
*Token
1904 IP4_PROTOCOL
*IpInstance
;
1909 // First validate the parameters
1911 if ((This
== NULL
) || (Token
== NULL
) || (Token
->Event
== NULL
)) {
1912 return EFI_INVALID_PARAMETER
;
1915 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
1917 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1919 if (IpInstance
->State
!= IP4_STATE_CONFIGED
) {
1920 Status
= EFI_NOT_STARTED
;
1925 // Check whether the toke is already on the receive queue.
1927 Status
= NetMapIterate (&IpInstance
->RxTokens
, Ip4TokenExist
, Token
);
1929 if (EFI_ERROR (Status
)) {
1930 Status
= EFI_ACCESS_DENIED
;
1935 // Queue the token then check whether there is pending received packet.
1937 Status
= NetMapInsertTail (&IpInstance
->RxTokens
, Token
, NULL
);
1939 if (EFI_ERROR (Status
)) {
1943 Status
= Ip4InstanceDeliverPacket (IpInstance
);
1946 // Dispatch the DPC queued by the NotifyFunction of this instane's receive
1952 gBS
->RestoreTPL (OldTpl
);
1958 Cancel the transmitted but not recycled packet. If a matching
1959 token is found, it will call Ip4CancelPacket to cancel the
1960 packet. Ip4CancelPacket will cancel all the fragments of the
1961 packet. When all the fragments are freed, the IP4_TXTOKEN_WRAP
1962 will be deleted from the Map, and user's event signalled.
1963 Because Ip4CancelPacket and other functions are all called in
1964 line, so, after Ip4CancelPacket returns, the Item has been freed.
1966 @param[in] Map The IP4 child's transmit queue.
1967 @param[in] Item The current transmitted packet to test.
1968 @param[in] Context The user's token to cancel.
1970 @retval EFI_SUCCESS Continue to check the next Item.
1971 @retval EFI_ABORTED The user's Token (Token != NULL) is cancelled.
1978 IN NET_MAP_ITEM
*Item
,
1982 EFI_IP4_COMPLETION_TOKEN
*Token
;
1983 IP4_TXTOKEN_WRAP
*Wrap
;
1985 Token
= (EFI_IP4_COMPLETION_TOKEN
*) Context
;
1988 // Return EFI_SUCCESS to check the next item in the map if
1989 // this one doesn't match.
1991 if ((Token
!= NULL
) && (Token
!= Item
->Key
)) {
1995 Wrap
= (IP4_TXTOKEN_WRAP
*) Item
->Value
;
1996 ASSERT (Wrap
!= NULL
);
1999 // Don't access the Item, Wrap and Token's members after this point.
2000 // Item and wrap has been freed. And we no longer own the Token.
2002 Ip4CancelPacket (Wrap
->IpInstance
->Interface
, Wrap
->Packet
, EFI_ABORTED
);
2005 // If only one item is to be cancel, return EFI_ABORTED to stop
2006 // iterating the map any more.
2008 if (Token
!= NULL
) {
2017 Cancel the receive request. This is quiet simple, because
2018 it is only enqueued in our local receive map.
2020 @param[in] Map The IP4 child's receive queue.
2021 @param[in] Item Current receive request to cancel.
2022 @param[in] Context The user's token to cancel.
2024 @retval EFI_SUCCESS Continue to check the next receive request on the
2026 @retval EFI_ABORTED The user's token (token != NULL) has been
2034 IN NET_MAP_ITEM
*Item
,
2038 EFI_IP4_COMPLETION_TOKEN
*Token
;
2039 EFI_IP4_COMPLETION_TOKEN
*This
;
2041 Token
= (EFI_IP4_COMPLETION_TOKEN
*) Context
;
2044 if ((Token
!= NULL
) && (Token
!= This
)) {
2048 NetMapRemoveItem (Map
, Item
, NULL
);
2050 This
->Status
= EFI_ABORTED
;
2051 This
->Packet
.RxData
= NULL
;
2052 gBS
->SignalEvent (This
->Event
);
2054 if (Token
!= NULL
) {
2063 Cancel the user's receive/transmit request.
2065 @param[in] IpInstance The IP4 child.
2066 @param[in] Token The token to cancel. If NULL, all token will be
2069 @retval EFI_SUCCESS The token is cancelled.
2070 @retval EFI_NOT_FOUND The token isn't found on either the
2071 transmit/receive queue.
2072 @retval EFI_DEVICE_ERROR Not all token is cancelled when Token is NULL.
2077 IN IP4_PROTOCOL
*IpInstance
,
2078 IN EFI_IP4_COMPLETION_TOKEN
*Token OPTIONAL
2084 // First check the transmitted packet. Ip4CancelTxTokens returns
2085 // EFI_ABORTED to mean that the token has been cancelled when
2086 // token != NULL. So, return EFI_SUCCESS for this condition.
2088 Status
= NetMapIterate (&IpInstance
->TxTokens
, Ip4CancelTxTokens
, Token
);
2090 if (EFI_ERROR (Status
)) {
2091 if ((Token
!= NULL
) && (Status
== EFI_ABORTED
)) {
2099 // Check the receive queue. Ip4CancelRxTokens also returns EFI_ABORT
2100 // for Token!=NULL and it is cancelled.
2102 Status
= NetMapIterate (&IpInstance
->RxTokens
, Ip4CancelRxTokens
, Token
);
2104 // Dispatch the DPCs queued by the NotifyFunction of the canceled rx token's
2108 if (EFI_ERROR (Status
)) {
2109 if ((Token
!= NULL
) && (Status
== EFI_ABORTED
)) {
2117 // OK, if the Token is found when Token != NULL, the NetMapIterate
2118 // will return EFI_ABORTED, which has been interrupted as EFI_SUCCESS.
2120 if (Token
!= NULL
) {
2121 return EFI_NOT_FOUND
;
2125 // If Token == NULL, cancel all the tokens. return error if no
2126 // all of them are cancelled.
2128 if (!NetMapIsEmpty (&IpInstance
->TxTokens
) ||
2129 !NetMapIsEmpty (&IpInstance
->RxTokens
)) {
2131 return EFI_DEVICE_ERROR
;
2139 Abort an asynchronous transmit or receive request.
2141 The Cancel() function is used to abort a pending transmit or receive request.
2142 If the token is in the transmit or receive request queues, after calling this
2143 function, Token->Status will be set to EFI_ABORTED and then Token->Event will
2144 be signaled. If the token is not in one of the queues, which usually means the
2145 asynchronous operation has completed, this function will not signal the token
2146 and EFI_NOT_FOUND is returned.
2148 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.
2149 @param[in] Token Pointer to a token that has been issued by
2150 EFI_IP4_PROTOCOL.Transmit() or
2151 EFI_IP4_PROTOCOL.Receive(). If NULL, all pending
2152 tokens are aborted. Type EFI_IP4_COMPLETION_TOKEN is
2153 defined in EFI_IP4_PROTOCOL.Transmit().
2155 @retval EFI_SUCCESS The asynchronous I/O request was aborted and
2156 Token.->Event was signaled. When Token is NULL, all
2157 pending requests were aborted and their events were signaled.
2158 @retval EFI_INVALID_PARAMETER This is NULL.
2159 @retval EFI_NOT_STARTED This instance has not been started.
2160 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
2161 RARP, etc.) is not finished yet.
2162 @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O request was
2163 not found in the transmit or receive queue. It has either completed
2164 or was not issued by Transmit() and Receive().
2170 IN EFI_IP4_PROTOCOL
*This
,
2171 IN EFI_IP4_COMPLETION_TOKEN
*Token OPTIONAL
2174 IP4_PROTOCOL
*IpInstance
;
2179 return EFI_INVALID_PARAMETER
;
2182 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
2184 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
2186 if (IpInstance
->State
!= IP4_STATE_CONFIGED
) {
2187 Status
= EFI_NOT_STARTED
;
2191 if (IpInstance
->ConfigData
.UseDefaultAddress
&& IP4_NO_MAPPING (IpInstance
)) {
2192 Status
= EFI_NO_MAPPING
;
2196 Status
= Ip4Cancel (IpInstance
, Token
);
2199 gBS
->RestoreTPL (OldTpl
);
2205 Polls for incoming data packets and processes outgoing data packets.
2207 The Poll() function polls for incoming data packets and processes outgoing data
2208 packets. Network drivers and applications can call the EFI_IP4_PROTOCOL.Poll()
2209 function to increase the rate that data packets are moved between the communications
2210 device and the transmit and receive queues.
2212 In some systems the periodic timer event may not poll the underlying communications
2213 device fast enough to transmit and/or receive all data packets without missing
2214 incoming packets or dropping outgoing packets. Drivers and applications that are
2215 experiencing packet loss should try calling the EFI_IP4_PROTOCOL.Poll() function
2218 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.
2220 @retval EFI_SUCCESS Incoming or outgoing data was processed.
2221 @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.
2222 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
2223 RARP, etc.) is not finished yet.
2224 @retval EFI_INVALID_PARAMETER This is NULL.
2225 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
2226 @retval EFI_NOT_READY No incoming or outgoing data is processed.
2227 @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue.
2228 Consider increasing the polling rate.
2234 IN EFI_IP4_PROTOCOL
*This
2237 IP4_PROTOCOL
*IpInstance
;
2238 EFI_MANAGED_NETWORK_PROTOCOL
*Mnp
;
2241 return EFI_INVALID_PARAMETER
;
2244 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
2246 if (IpInstance
->State
== IP4_STATE_UNCONFIGED
) {
2247 return EFI_NOT_STARTED
;
2250 Mnp
= IpInstance
->Service
->Mnp
;
2253 // Don't lock the Poll function to enable the deliver of
2254 // the packet polled up.
2256 return Mnp
->Poll (Mnp
);
2260 Decrease the life of the transmitted packets. If it is
2261 decreased to zero, cancel the packet. This function is
2262 called by Ip4PacketTimerTicking which time out both the
2263 received-but-not-delivered and transmitted-but-not-recycle
2266 @param[in] Map The IP4 child's transmit map.
2267 @param[in] Item Current transmitted packet.
2268 @param[in] Context Not used.
2270 @retval EFI_SUCCESS Always returns EFI_SUCCESS.
2275 Ip4SentPacketTicking (
2277 IN NET_MAP_ITEM
*Item
,
2281 IP4_TXTOKEN_WRAP
*Wrap
;
2283 Wrap
= (IP4_TXTOKEN_WRAP
*) Item
->Value
;
2284 ASSERT (Wrap
!= NULL
);
2286 if ((Wrap
->Life
> 0) && (--Wrap
->Life
== 0)) {
2287 Ip4CancelPacket (Wrap
->IpInstance
->Interface
, Wrap
->Packet
, EFI_ABORTED
);
2295 The heart beat timer of IP4 service instance. It times out
2296 all of its IP4 children's received-but-not-delivered and
2297 transmitted-but-not-recycle packets, and provides time input
2298 for its IGMP protocol.
2300 @param[in] Event The IP4 service instance's heart beat timer.
2301 @param[in] Context The IP4 service instance.
2313 IpSb
= (IP4_SERVICE
*) Context
;
2314 NET_CHECK_SIGNATURE (IpSb
, IP4_SERVICE_SIGNATURE
);
2316 Ip4PacketTimerTicking (IpSb
);
2317 Ip4IgmpTicking (IpSb
);