3 Copyright (c) 2005 - 2010, Intel Corporation.<BR>
4 All rights reserved. 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_IPSEC_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 The event handle for IP4 auto configuration. If IP is asked
535 to reconfigure the default address. The original default
536 interface and route table are removed as the default. If there
537 is active IP children using the default address, the interface
538 will remain valid until all the children have freed their
539 references. If IP is signalled when auto configuration is done,
540 it will configure the default interface and default route table
541 with the configuration information retrieved by IP4_CONFIGURE.
543 @param[in] Context The IP4 service binding instance.
548 Ip4AutoConfigCallBackDpc (
552 EFI_IP4_CONFIG_PROTOCOL
*Ip4Config
;
553 EFI_IP4_IPCONFIG_DATA
*Data
;
554 EFI_IP4_ROUTE_TABLE
*RouteEntry
;
556 IP4_ROUTE_TABLE
*RouteTable
;
561 IP4_ADDR StationAddress
;
563 IP4_ADDR SubnetAddress
;
564 IP4_ADDR GatewayAddress
;
566 IpSb
= (IP4_SERVICE
*) Context
;
567 NET_CHECK_SIGNATURE (IpSb
, IP4_SERVICE_SIGNATURE
);
569 Ip4Config
= IpSb
->Ip4Config
;
572 // IP is asked to do the reconfiguration. If the default interface
573 // has been configured, release the default interface and route
574 // table, then create a new one. If there are some IP children
575 // using it, the interface won't be physically freed until all the
576 // children have released their reference to it. Also remember to
577 // restart the receive on the default address. IP4 driver only receive
578 // frames on the default address, and when the default interface is
579 // freed, Ip4AcceptFrame won't be informed.
581 if (IpSb
->ActiveEvent
== IpSb
->ReconfigEvent
) {
583 if (IpSb
->DefaultInterface
->Configured
) {
584 IpIf
= Ip4CreateInterface (IpSb
->Mnp
, IpSb
->Controller
, IpSb
->Image
);
590 RouteTable
= Ip4CreateRouteTable ();
592 if (RouteTable
== NULL
) {
593 Ip4FreeInterface (IpIf
, NULL
);
597 Ip4CancelReceive (IpSb
->DefaultInterface
);
598 Ip4FreeInterface (IpSb
->DefaultInterface
, NULL
);
599 Ip4FreeRouteTable (IpSb
->DefaultRouteTable
);
601 IpSb
->DefaultInterface
= IpIf
;
602 InsertHeadList (&IpSb
->Interfaces
, &IpIf
->Link
);
604 IpSb
->DefaultRouteTable
= RouteTable
;
605 Ip4ReceiveFrame (IpIf
, NULL
, Ip4AccpetFrame
, IpSb
);
608 Ip4Config
->Stop (Ip4Config
);
609 Ip4Config
->Start (Ip4Config
, IpSb
->DoneEvent
, IpSb
->ReconfigEvent
);
614 // Get the configure data in two steps: get the length then the data.
618 if (Ip4Config
->GetData (Ip4Config
, &Len
, NULL
) != EFI_BUFFER_TOO_SMALL
) {
622 Data
= AllocatePool (Len
);
628 Status
= Ip4Config
->GetData (Ip4Config
, &Len
, Data
);
630 if (EFI_ERROR (Status
)) {
634 IpIf
= IpSb
->DefaultInterface
;
637 // If the default address has been configured don't change it.
638 // This is unlikely to happen if EFI_IP4_CONFIG protocol has
639 // informed us to reconfigure each time it wants to change the
640 // configuration parameters.
642 if (IpIf
->Configured
) {
647 // Set the default interface's address, then add a directed
648 // route for it, that is, the route whose nexthop is zero.
650 StationAddress
= EFI_NTOHL (Data
->StationAddress
);
651 SubnetMask
= EFI_NTOHL (Data
->SubnetMask
);
652 Status
= Ip4SetAddress (IpIf
, StationAddress
, SubnetMask
);
654 if (EFI_ERROR (Status
)) {
659 IpSb
->DefaultRouteTable
,
666 // Add routes returned by EFI_IP4_CONFIG protocol.
668 for (Index
= 0; Index
< Data
->RouteTableSize
; Index
++) {
669 RouteEntry
= &Data
->RouteTable
[Index
];
671 SubnetAddress
= EFI_NTOHL (RouteEntry
->SubnetAddress
);
672 SubnetMask
= EFI_NTOHL (RouteEntry
->SubnetMask
);
673 GatewayAddress
= EFI_NTOHL (RouteEntry
->GatewayAddress
);
674 Ip4AddRoute (IpSb
->DefaultRouteTable
, SubnetAddress
, SubnetMask
, GatewayAddress
);
677 IpSb
->State
= IP4_SERVICE_CONFIGED
;
679 Ip4SetVariableData (IpSb
);
686 Request Ip4AutoConfigCallBackDpc as a DPC at TPL_CALLBACK.
688 @param Event The event that is signalled.
689 @param Context The IP4 service binding instance.
694 Ip4AutoConfigCallBack (
701 IpSb
= (IP4_SERVICE
*) Context
;
702 IpSb
->ActiveEvent
= Event
;
705 // Request Ip4AutoConfigCallBackDpc as a DPC at TPL_CALLBACK
707 QueueDpc (TPL_CALLBACK
, Ip4AutoConfigCallBackDpc
, Context
);
712 Start the auto configuration for this IP service instance.
713 It will locates the EFI_IP4_CONFIG_PROTOCOL, then start the
716 @param[in] IpSb The IP4 service instance to configure
718 @retval EFI_SUCCESS The auto configuration is successfull started
719 @retval Others Failed to start auto configuration.
727 EFI_IP4_CONFIG_PROTOCOL
*Ip4Config
;
730 if (IpSb
->State
> IP4_SERVICE_UNSTARTED
) {
735 // Create the DoneEvent and ReconfigEvent to call EFI_IP4_CONFIG
737 Status
= gBS
->CreateEvent (
740 Ip4AutoConfigCallBack
,
745 if (EFI_ERROR (Status
)) {
749 Status
= gBS
->CreateEvent (
752 Ip4AutoConfigCallBack
,
757 if (EFI_ERROR (Status
)) {
758 goto CLOSE_DONE_EVENT
;
762 // Open the EFI_IP4_CONFIG protocol then start auto configure
764 Status
= gBS
->OpenProtocol (
766 &gEfiIp4ConfigProtocolGuid
,
767 (VOID
**) &Ip4Config
,
770 EFI_OPEN_PROTOCOL_BY_DRIVER
| EFI_OPEN_PROTOCOL_EXCLUSIVE
773 if (EFI_ERROR (Status
)) {
774 Status
= EFI_UNSUPPORTED
;
775 goto CLOSE_RECONFIG_EVENT
;
778 Status
= Ip4Config
->Start (Ip4Config
, IpSb
->DoneEvent
, IpSb
->ReconfigEvent
);
780 if (EFI_ERROR (Status
)) {
783 &gEfiIp4ConfigProtocolGuid
,
788 goto CLOSE_RECONFIG_EVENT
;
791 IpSb
->Ip4Config
= Ip4Config
;
792 IpSb
->State
= IP4_SERVICE_STARTED
;
795 CLOSE_RECONFIG_EVENT
:
796 gBS
->CloseEvent (IpSb
->ReconfigEvent
);
797 IpSb
->ReconfigEvent
= NULL
;
800 gBS
->CloseEvent (IpSb
->DoneEvent
);
801 IpSb
->DoneEvent
= NULL
;
808 Intiialize the IP4_PROTOCOL structure to the unconfigured states.
810 @param IpSb The IP4 service instance.
811 @param IpInstance The IP4 child instance.
816 IN IP4_SERVICE
*IpSb
,
817 IN OUT IP4_PROTOCOL
*IpInstance
820 ASSERT ((IpSb
!= NULL
) && (IpInstance
!= NULL
));
822 ZeroMem (IpInstance
, sizeof (IP4_PROTOCOL
));
824 IpInstance
->Signature
= IP4_PROTOCOL_SIGNATURE
;
825 CopyMem (&IpInstance
->Ip4Proto
, &mEfiIp4ProtocolTemplete
, sizeof (IpInstance
->Ip4Proto
));
826 IpInstance
->State
= IP4_STATE_UNCONFIGED
;
827 IpInstance
->Service
= IpSb
;
829 InitializeListHead (&IpInstance
->Link
);
830 NetMapInit (&IpInstance
->RxTokens
);
831 NetMapInit (&IpInstance
->TxTokens
);
832 InitializeListHead (&IpInstance
->Received
);
833 InitializeListHead (&IpInstance
->Delivered
);
834 InitializeListHead (&IpInstance
->AddrLink
);
836 EfiInitializeLock (&IpInstance
->RecycleLock
, TPL_NOTIFY
);
841 Configure the IP4 child. If the child is already configured,
842 change the configuration parameter. Otherwise configure it
843 for the first time. The caller should validate the configuration
844 before deliver them to it. It also don't do configure NULL.
846 @param[in, out] IpInstance The IP4 child to configure.
847 @param[in] Config The configure data.
849 @retval EFI_SUCCESS The IP4 child is successfully configured.
850 @retval EFI_DEVICE_ERROR Failed to free the pending transive or to
851 configure underlying MNP or other errors.
852 @retval EFI_NO_MAPPING The IP4 child is configured to use default
853 address, but the default address hasn't been
854 configured. The IP4 child doesn't need to be
855 reconfigured when default address is configured.
856 @retval EFI_OUT_OF_RESOURCES No more memory space is available.
857 @retval other Other error occurs.
862 IN OUT IP4_PROTOCOL
*IpInstance
,
863 IN EFI_IP4_CONFIG_DATA
*Config
872 IpSb
= IpInstance
->Service
;
875 // User is changing packet filters. It must be stopped
876 // before the station address can be changed.
878 if (IpInstance
->State
== IP4_STATE_CONFIGED
) {
880 // Cancel all the pending transmit/receive from upper layer
882 Status
= Ip4Cancel (IpInstance
, NULL
);
884 if (EFI_ERROR (Status
)) {
885 return EFI_DEVICE_ERROR
;
888 CopyMem (&IpInstance
->ConfigData
, Config
, sizeof (IpInstance
->ConfigData
));
893 // Configure a fresh IP4 protocol instance. Create a route table.
894 // Each IP child has its own route table, which may point to the
895 // default table if it is using default address.
897 Status
= EFI_OUT_OF_RESOURCES
;
898 IpInstance
->RouteTable
= Ip4CreateRouteTable ();
900 if (IpInstance
->RouteTable
== NULL
) {
905 // Set up the interface.
907 CopyMem (&Ip
, &Config
->StationAddress
, sizeof (IP4_ADDR
));
908 CopyMem (&Netmask
, &Config
->SubnetMask
, sizeof (IP4_ADDR
));
911 Netmask
= NTOHL (Netmask
);
913 if (!Config
->UseDefaultAddress
) {
915 // Find whether there is already an interface with the same
916 // station address. All the instances with the same station
917 // address shares one interface.
919 IpIf
= Ip4FindStationAddress (IpSb
, Ip
, Netmask
);
925 IpIf
= Ip4CreateInterface (IpSb
->Mnp
, IpSb
->Controller
, IpSb
->Image
);
931 Status
= Ip4SetAddress (IpIf
, Ip
, Netmask
);
933 if (EFI_ERROR (Status
)) {
934 Status
= EFI_DEVICE_ERROR
;
935 Ip4FreeInterface (IpIf
, IpInstance
);
939 InsertTailList (&IpSb
->Interfaces
, &IpIf
->Link
);
943 // Add a route to this connected network in the route table
945 Ip4AddRoute (IpInstance
->RouteTable
, Ip
, Netmask
, IP4_ALLZERO_ADDRESS
);
949 // Use the default address. If the default configuration hasn't
950 // been started, start it.
952 if (IpSb
->State
== IP4_SERVICE_UNSTARTED
) {
953 Status
= Ip4StartAutoConfig (IpSb
);
955 if (EFI_ERROR (Status
)) {
960 IpIf
= IpSb
->DefaultInterface
;
961 NET_GET_REF (IpSb
->DefaultInterface
);
964 // If default address is used, so is the default route table.
965 // Any route set by the instance has the precedence over the
966 // routes in the default route table. Link the default table
967 // after the instance's table. Routing will search the local
970 NET_GET_REF (IpSb
->DefaultRouteTable
);
971 IpInstance
->RouteTable
->Next
= IpSb
->DefaultRouteTable
;
974 IpInstance
->Interface
= IpIf
;
975 InsertTailList (&IpIf
->IpInstances
, &IpInstance
->AddrLink
);
977 CopyMem (&IpInstance
->ConfigData
, Config
, sizeof (IpInstance
->ConfigData
));
978 IpInstance
->State
= IP4_STATE_CONFIGED
;
981 // Although EFI_NO_MAPPING is an error code, the IP child has been
982 // successfully configured and doesn't need reconfiguration when
983 // default address is acquired.
985 if (Config
->UseDefaultAddress
&& IP4_NO_MAPPING (IpInstance
)) {
986 return EFI_NO_MAPPING
;
992 Ip4FreeRouteTable (IpInstance
->RouteTable
);
993 IpInstance
->RouteTable
= NULL
;
999 Clean up the IP4 child, release all the resources used by it.
1001 @param[in] IpInstance The IP4 child to clean up.
1003 @retval EFI_SUCCESS The IP4 child is cleaned up
1004 @retval EFI_DEVICE_ERROR Some resources failed to be released
1009 IN IP4_PROTOCOL
*IpInstance
1012 if (EFI_ERROR (Ip4Cancel (IpInstance
, NULL
))) {
1013 return EFI_DEVICE_ERROR
;
1016 if (EFI_ERROR (Ip4Groups (IpInstance
, FALSE
, NULL
))) {
1017 return EFI_DEVICE_ERROR
;
1021 // Some packets haven't been recycled. It is because either the
1022 // user forgets to recycle the packets, or because the callback
1023 // hasn't been called. Just leave it alone.
1025 if (!IsListEmpty (&IpInstance
->Delivered
)) {
1029 if (IpInstance
->Interface
!= NULL
) {
1030 RemoveEntryList (&IpInstance
->AddrLink
);
1031 Ip4FreeInterface (IpInstance
->Interface
, IpInstance
);
1032 IpInstance
->Interface
= NULL
;
1035 if (IpInstance
->RouteTable
!= NULL
) {
1036 if (IpInstance
->RouteTable
->Next
!= NULL
) {
1037 Ip4FreeRouteTable (IpInstance
->RouteTable
->Next
);
1040 Ip4FreeRouteTable (IpInstance
->RouteTable
);
1041 IpInstance
->RouteTable
= NULL
;
1044 if (IpInstance
->EfiRouteTable
!= NULL
) {
1045 FreePool (IpInstance
->EfiRouteTable
);
1046 IpInstance
->EfiRouteTable
= NULL
;
1047 IpInstance
->EfiRouteCount
= 0;
1050 if (IpInstance
->Groups
!= NULL
) {
1051 FreePool (IpInstance
->Groups
);
1052 IpInstance
->Groups
= NULL
;
1053 IpInstance
->GroupCount
= 0;
1056 NetMapClean (&IpInstance
->TxTokens
);
1058 NetMapClean (&IpInstance
->RxTokens
);
1065 Validate that Ip/Netmask pair is OK to be used as station
1066 address. Only continuous netmasks are supported. and check
1067 that StationAddress is a unicast address on the newtwork.
1069 @param[in] Ip The IP address to validate
1070 @param[in] Netmask The netmaks of the IP
1072 @retval TRUE The Ip/Netmask pair is valid
1073 @retval FALSE The Ip/Netmask pair is invalid
1077 Ip4StationAddressValid (
1082 IP4_ADDR NetBrdcastMask
;
1087 // Only support the station address with 0.0.0.0/0 to enable DHCP client.
1089 if (Netmask
== IP4_ALLZERO_ADDRESS
) {
1090 return (BOOLEAN
) (Ip
== IP4_ALLZERO_ADDRESS
);
1094 // Only support the continuous net masks
1096 if ((Len
= NetGetMaskLength (Netmask
)) == IP4_MASK_NUM
) {
1101 // Station address can't be class D or class E address
1103 if ((Type
= NetGetIpClass (Ip
)) > IP4_ADDR_CLASSC
) {
1108 // Station address can't be subnet broadcast/net broadcast address
1110 if ((Ip
== (Ip
& Netmask
)) || (Ip
== (Ip
| ~Netmask
))) {
1114 NetBrdcastMask
= gIp4AllMasks
[MIN (Len
, Type
<< 3)];
1116 if (Ip
== (Ip
| ~NetBrdcastMask
)) {
1125 Assigns an IPv4 address and subnet mask to this EFI IPv4 Protocol driver instance.
1127 The Configure() function is used to set, change, or reset the operational
1128 parameters and filter settings for this EFI IPv4 Protocol instance. Until these
1129 parameters have been set, no network traffic can be sent or received by this
1130 instance. Once the parameters have been reset (by calling this function with
1131 IpConfigData set to NULL), no more traffic can be sent or received until these
1132 parameters have been set again. Each EFI IPv4 Protocol instance can be started
1133 and stopped independently of each other by enabling or disabling their receive
1134 filter settings with the Configure() function.
1136 When IpConfigData.UseDefaultAddress is set to FALSE, the new station address will
1137 be appended as an alias address into the addresses list in the EFI IPv4 Protocol
1138 driver. While set to TRUE, Configure() will trigger the EFI_IP4_CONFIG_PROTOCOL
1139 to retrieve the default IPv4 address if it is not available yet. Clients could
1140 frequently call GetModeData() to check the status to ensure that the default IPv4
1143 If operational parameters are reset or changed, any pending transmit and receive
1144 requests will be cancelled. Their completion token status will be set to EFI_ABORTED
1145 and their events will be signaled.
1147 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.
1148 @param[in] IpConfigData Pointer to the EFI IPv4 Protocol configuration data structure.
1150 @retval EFI_SUCCESS The driver instance was successfully opened.
1151 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
1152 RARP, etc.) is not finished yet.
1153 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
1154 @retval EFI_UNSUPPORTED One or more of the following conditions is TRUE:
1155 A configuration protocol (DHCP, BOOTP, RARP, etc.) could
1156 not be located when clients choose to use the default IPv4
1157 address. This EFI IPv4 Protocol implementation does not
1158 support this requested filter or timeout setting.
1159 @retval EFI_OUT_OF_RESOURCES The EFI IPv4 Protocol driver instance data could not be allocated.
1160 @retval EFI_ALREADY_STARTED The interface is already open and must be stopped before the
1161 IPv4 address or subnet mask can be changed. The interface must
1162 also be stopped when switching to/from raw packet mode.
1163 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI IPv4
1164 Protocol driver instance is not opened.
1170 IN EFI_IP4_PROTOCOL
*This
,
1171 IN EFI_IP4_CONFIG_DATA
*IpConfigData OPTIONAL
1174 IP4_PROTOCOL
*IpInstance
;
1175 EFI_IP4_CONFIG_DATA
*Current
;
1180 IP4_ADDR SubnetMask
;
1183 // First, validate the parameters
1186 return EFI_INVALID_PARAMETER
;
1189 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
1190 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1193 // Validate the configuration first.
1195 if (IpConfigData
!= NULL
) {
1197 // This implementation doesn't support RawData
1199 if (IpConfigData
->RawData
) {
1200 Status
= EFI_UNSUPPORTED
;
1205 CopyMem (&IpAddress
, &IpConfigData
->StationAddress
, sizeof (IP4_ADDR
));
1206 CopyMem (&SubnetMask
, &IpConfigData
->SubnetMask
, sizeof (IP4_ADDR
));
1208 IpAddress
= NTOHL (IpAddress
);
1209 SubnetMask
= NTOHL (SubnetMask
);
1212 // Check whether the station address is a valid unicast address
1214 if (!IpConfigData
->UseDefaultAddress
) {
1215 AddrOk
= Ip4StationAddressValid (IpAddress
, SubnetMask
);
1218 Status
= EFI_INVALID_PARAMETER
;
1224 // User can only update packet filters when already configured.
1225 // If it wants to change the station address, it must configure(NULL)
1226 // the instance first.
1228 if (IpInstance
->State
== IP4_STATE_CONFIGED
) {
1229 Current
= &IpInstance
->ConfigData
;
1231 if (Current
->UseDefaultAddress
!= IpConfigData
->UseDefaultAddress
) {
1232 Status
= EFI_ALREADY_STARTED
;
1236 if (!Current
->UseDefaultAddress
&&
1237 (!EFI_IP4_EQUAL (&Current
->StationAddress
, &IpConfigData
->StationAddress
) ||
1238 !EFI_IP4_EQUAL (&Current
->SubnetMask
, &IpConfigData
->SubnetMask
))) {
1239 Status
= EFI_ALREADY_STARTED
;
1243 if (Current
->UseDefaultAddress
&& IP4_NO_MAPPING (IpInstance
)) {
1244 return EFI_NO_MAPPING
;
1250 // Configure the instance or clean it up.
1252 if (IpConfigData
!= NULL
) {
1253 Status
= Ip4ConfigProtocol (IpInstance
, IpConfigData
);
1255 Status
= Ip4CleanProtocol (IpInstance
);
1258 // Don't change the state if it is DESTORY, consider the following
1259 // valid sequence: Mnp is unloaded-->Ip Stopped-->Udp Stopped,
1260 // Configure (ThisIp, NULL). If the state is changed to UNCONFIGED,
1261 // the unload fails miserably.
1263 if (IpInstance
->State
== IP4_STATE_CONFIGED
) {
1264 IpInstance
->State
= IP4_STATE_UNCONFIGED
;
1269 // Update the MNP's configure data. Ip4ServiceConfigMnp will check
1270 // whether it is necessary to reconfigure the MNP.
1272 Ip4ServiceConfigMnp (IpInstance
->Service
, FALSE
);
1275 // Update the variable data.
1277 Ip4SetVariableData (IpInstance
->Service
);
1280 gBS
->RestoreTPL (OldTpl
);
1287 Change the IP4 child's multicast setting. The caller
1288 should make sure that the parameters is valid.
1290 @param[in] IpInstance The IP4 child to change the setting.
1291 @param[in] JoinFlag TRUE to join the group, otherwise leave it
1292 @param[in] GroupAddress The target group address
1294 @retval EFI_ALREADY_STARTED Want to join the group, but already a member of it
1295 @retval EFI_OUT_OF_RESOURCES Failed to allocate some resources.
1296 @retval EFI_DEVICE_ERROR Failed to set the group configuraton
1297 @retval EFI_SUCCESS Successfully updated the group setting.
1298 @retval EFI_NOT_FOUND Try to leave the group which it isn't a member.
1303 IN IP4_PROTOCOL
*IpInstance
,
1304 IN BOOLEAN JoinFlag
,
1305 IN EFI_IPv4_ADDRESS
*GroupAddress OPTIONAL
1313 // Add it to the instance's Groups, and join the group by IGMP.
1314 // IpInstance->Groups is in network byte order. IGMP operates in
1319 // When JoinFlag is TRUE, GroupAddress shouldn't be NULL.
1321 ASSERT (GroupAddress
!= NULL
);
1322 CopyMem (&Group
, GroupAddress
, sizeof (IP4_ADDR
));
1324 for (Index
= 0; Index
< IpInstance
->GroupCount
; Index
++) {
1325 if (IpInstance
->Groups
[Index
] == Group
) {
1326 return EFI_ALREADY_STARTED
;
1330 Members
= Ip4CombineGroups (IpInstance
->Groups
, IpInstance
->GroupCount
, Group
);
1332 if (Members
== NULL
) {
1333 return EFI_OUT_OF_RESOURCES
;
1336 if (EFI_ERROR (Ip4JoinGroup (IpInstance
, NTOHL (Group
)))) {
1338 return EFI_DEVICE_ERROR
;
1341 if (IpInstance
->Groups
!= NULL
) {
1342 FreePool (IpInstance
->Groups
);
1345 IpInstance
->Groups
= Members
;
1346 IpInstance
->GroupCount
++;
1352 // Leave the group. Leave all the groups if GroupAddress is NULL.
1353 // Must iterate from the end to the beginning because the GroupCount
1354 // is decreamented each time an address is removed..
1356 for (Index
= IpInstance
->GroupCount
; Index
> 0 ; Index
--) {
1357 Group
= IpInstance
->Groups
[Index
- 1];
1359 if ((GroupAddress
== NULL
) || EFI_IP4_EQUAL (&Group
, GroupAddress
)) {
1360 if (EFI_ERROR (Ip4LeaveGroup (IpInstance
, NTOHL (Group
)))) {
1361 return EFI_DEVICE_ERROR
;
1364 Ip4RemoveGroupAddr (IpInstance
->Groups
, IpInstance
->GroupCount
, Group
);
1365 IpInstance
->GroupCount
--;
1367 if (IpInstance
->GroupCount
== 0) {
1368 ASSERT (Index
== 1);
1370 FreePool (IpInstance
->Groups
);
1371 IpInstance
->Groups
= NULL
;
1374 if (GroupAddress
!= NULL
) {
1380 return ((GroupAddress
!= NULL
) ? EFI_NOT_FOUND
: EFI_SUCCESS
);
1385 Joins and leaves multicast groups.
1387 The Groups() function is used to join and leave multicast group sessions. Joining
1388 a group will enable reception of matching multicast packets. Leaving a group will
1389 disable the multicast packet reception.
1391 If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left.
1393 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.
1394 @param[in] JoinFlag Set to TRUE to join the multicast group session and FALSE to leave.
1395 @param[in] GroupAddress Pointer to the IPv4 multicast address.
1397 @retval EFI_SUCCESS The operation completed successfully.
1398 @retval EFI_INVALID_PARAMETER One or more of the following is TRUE:
1400 - JoinFlag is TRUE and GroupAddress is NULL.
1401 - GroupAddress is not NULL and *GroupAddress is
1402 not a multicast IPv4 address.
1403 @retval EFI_NOT_STARTED This instance has not been started.
1404 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
1405 RARP, etc.) is not finished yet.
1406 @retval EFI_OUT_OF_RESOURCES System resources could not be allocated.
1407 @retval EFI_UNSUPPORTED This EFI IPv4 Protocol implementation does not support multicast groups.
1408 @retval EFI_ALREADY_STARTED The group address is already in the group table (when
1410 @retval EFI_NOT_FOUND The group address is not in the group table (when JoinFlag is FALSE).
1411 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
1417 IN EFI_IP4_PROTOCOL
*This
,
1418 IN BOOLEAN JoinFlag
,
1419 IN EFI_IPv4_ADDRESS
*GroupAddress OPTIONAL
1422 IP4_PROTOCOL
*IpInstance
;
1427 if ((This
== NULL
) || (JoinFlag
&& (GroupAddress
== NULL
))) {
1428 return EFI_INVALID_PARAMETER
;
1431 if (GroupAddress
!= NULL
) {
1432 CopyMem (&McastIp
, GroupAddress
, sizeof (IP4_ADDR
));
1434 if (!IP4_IS_MULTICAST (NTOHL (McastIp
))) {
1435 return EFI_INVALID_PARAMETER
;
1439 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
1440 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1442 if (IpInstance
->State
!= IP4_STATE_CONFIGED
) {
1443 Status
= EFI_NOT_STARTED
;
1447 if (IpInstance
->ConfigData
.UseDefaultAddress
&& IP4_NO_MAPPING (IpInstance
)) {
1448 Status
= EFI_NO_MAPPING
;
1452 Status
= Ip4Groups (IpInstance
, JoinFlag
, GroupAddress
);
1455 gBS
->RestoreTPL (OldTpl
);
1461 Adds and deletes routing table entries.
1463 The Routes() function adds a route to or deletes a route from the routing table.
1465 Routes are determined by comparing the SubnetAddress with the destination IPv4
1466 address arithmetically AND-ed with the SubnetMask. The gateway address must be
1467 on the same subnet as the configured station address.
1469 The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0.
1470 The default route matches all destination IPv4 addresses that do not match any
1473 A GatewayAddress that is zero is a nonroute. Packets are sent to the destination
1474 IP address if it can be found in the ARP cache or on the local subnet. One automatic
1475 nonroute entry will be inserted into the routing table for outgoing packets that
1476 are addressed to a local subnet (gateway address of 0.0.0.0).
1478 Each EFI IPv4 Protocol instance has its own independent routing table. Those EFI
1479 IPv4 Protocol instances that use the default IPv4 address will also have copies
1480 of the routing table that was provided by the EFI_IP4_CONFIG_PROTOCOL, and these
1481 copies will be updated whenever the EIF IPv4 Protocol driver reconfigures its
1482 instances. As a result, client modification to the routing table will be lost.
1484 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.
1485 @param[in] DeleteRoute Set to TRUE to delete this route from the routing table. Set to
1486 FALSE to add this route to the routing table. SubnetAddress
1487 and SubnetMask are used as the key to each route entry.
1488 @param[in] SubnetAddress The address of the subnet that needs to be routed.
1489 @param[in] SubnetMask The subnet mask of SubnetAddress.
1490 @param[in] GatewayAddress The unicast gateway IPv4 address for this route.
1492 @retval EFI_SUCCESS The operation completed successfully.
1493 @retval EFI_NOT_STARTED The driver instance has not been started.
1494 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
1495 RARP, etc.) is not finished yet.
1496 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
1498 - SubnetAddress is NULL.
1499 - SubnetMask is NULL.
1500 - GatewayAddress is NULL.
1501 - *SubnetAddress is not a valid subnet address.
1502 - *SubnetMask is not a valid subnet mask.
1503 - *GatewayAddress is not a valid unicast IPv4 address.
1504 @retval EFI_OUT_OF_RESOURCES Could not add the entry to the routing table.
1505 @retval EFI_NOT_FOUND This route is not in the routing table (when DeleteRoute is TRUE).
1506 @retval EFI_ACCESS_DENIED The route is already defined in the routing table (when
1507 DeleteRoute is FALSE).
1513 IN EFI_IP4_PROTOCOL
*This
,
1514 IN BOOLEAN DeleteRoute
,
1515 IN EFI_IPv4_ADDRESS
*SubnetAddress
,
1516 IN EFI_IPv4_ADDRESS
*SubnetMask
,
1517 IN EFI_IPv4_ADDRESS
*GatewayAddress
1520 IP4_PROTOCOL
*IpInstance
;
1521 IP4_INTERFACE
*IpIf
;
1529 // First, validate the parameters
1531 if ((This
== NULL
) || (SubnetAddress
== NULL
) ||
1532 (SubnetMask
== NULL
) || (GatewayAddress
== NULL
)) {
1533 return EFI_INVALID_PARAMETER
;
1536 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
1537 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1539 if (IpInstance
->State
!= IP4_STATE_CONFIGED
) {
1540 Status
= EFI_NOT_STARTED
;
1544 if (IpInstance
->ConfigData
.UseDefaultAddress
&& IP4_NO_MAPPING (IpInstance
)) {
1545 Status
= EFI_NO_MAPPING
;
1549 CopyMem (&Dest
, SubnetAddress
, sizeof (IP4_ADDR
));
1550 CopyMem (&Netmask
, SubnetMask
, sizeof (IP4_ADDR
));
1551 CopyMem (&Nexthop
, GatewayAddress
, sizeof (IP4_ADDR
));
1553 Dest
= NTOHL (Dest
);
1554 Netmask
= NTOHL (Netmask
);
1555 Nexthop
= NTOHL (Nexthop
);
1557 IpIf
= IpInstance
->Interface
;
1559 if (!IP4_IS_VALID_NETMASK (Netmask
)) {
1560 Status
= EFI_INVALID_PARAMETER
;
1565 // the gateway address must be a unicast on the connected network if not zero.
1567 if ((Nexthop
!= IP4_ALLZERO_ADDRESS
) &&
1568 (!IP4_NET_EQUAL (Nexthop
, IpIf
->Ip
, IpIf
->SubnetMask
) ||
1569 IP4_IS_BROADCAST (Ip4GetNetCast (Nexthop
, IpIf
)))) {
1571 Status
= EFI_INVALID_PARAMETER
;
1576 Status
= Ip4DelRoute (IpInstance
->RouteTable
, Dest
, Netmask
, Nexthop
);
1578 Status
= Ip4AddRoute (IpInstance
->RouteTable
, Dest
, Netmask
, Nexthop
);
1582 gBS
->RestoreTPL (OldTpl
);
1588 Check whether the user's token or event has already
1589 been enqueued on IP4's list.
1591 @param[in] Map The container of either user's transmit or receive
1593 @param[in] Item Current item to check against
1594 @param[in] Context The Token to check againist.
1596 @retval EFI_ACCESS_DENIED The token or event has already been enqueued in IP
1597 @retval EFI_SUCCESS The current item isn't the same token/event as the
1604 IN NET_MAP_ITEM
*Item
,
1608 EFI_IP4_COMPLETION_TOKEN
*Token
;
1609 EFI_IP4_COMPLETION_TOKEN
*TokenInItem
;
1611 Token
= (EFI_IP4_COMPLETION_TOKEN
*) Context
;
1612 TokenInItem
= (EFI_IP4_COMPLETION_TOKEN
*) Item
->Key
;
1614 if ((Token
== TokenInItem
) || (Token
->Event
== TokenInItem
->Event
)) {
1615 return EFI_ACCESS_DENIED
;
1623 Validate the user's token against current station address.
1625 @param[in] Token User's token to validate
1626 @param[in] IpIf The IP4 child's interface.
1628 @retval EFI_INVALID_PARAMETER Some parameters are invalid
1629 @retval EFI_BAD_BUFFER_SIZE The user's option/data is too long.
1630 @retval EFI_SUCCESS The token is OK
1635 IN EFI_IP4_COMPLETION_TOKEN
*Token
,
1636 IN IP4_INTERFACE
*IpIf
1639 EFI_IP4_TRANSMIT_DATA
*TxData
;
1640 EFI_IP4_OVERRIDE_DATA
*Override
;
1647 if ((Token
== NULL
) || (Token
->Event
== NULL
) || (Token
->Packet
.TxData
== NULL
)) {
1648 return EFI_INVALID_PARAMETER
;
1651 TxData
= Token
->Packet
.TxData
;
1654 // Check the IP options: no more than 40 bytes and format is OK
1656 if (TxData
->OptionsLength
!= 0) {
1657 if ((TxData
->OptionsLength
> 40) || (TxData
->OptionsBuffer
== NULL
)) {
1658 return EFI_INVALID_PARAMETER
;
1661 if (!Ip4OptionIsValid (TxData
->OptionsBuffer
, TxData
->OptionsLength
, FALSE
)) {
1662 return EFI_INVALID_PARAMETER
;
1667 // Check the fragment table: no empty fragment, and length isn't bogus
1669 if ((TxData
->TotalDataLength
== 0) || (TxData
->FragmentCount
== 0)) {
1670 return EFI_INVALID_PARAMETER
;
1673 Offset
= TxData
->TotalDataLength
;
1675 for (Index
= 0; Index
< TxData
->FragmentCount
; Index
++) {
1676 if ((TxData
->FragmentTable
[Index
].FragmentBuffer
== NULL
) ||
1677 (TxData
->FragmentTable
[Index
].FragmentLength
== 0)) {
1679 return EFI_INVALID_PARAMETER
;
1682 Offset
-= TxData
->FragmentTable
[Index
].FragmentLength
;
1686 return EFI_INVALID_PARAMETER
;
1690 // Check the source and gateway: they must be a valid unicast.
1691 // Gateway must also be on the connected network.
1693 if (TxData
->OverrideData
!= NULL
) {
1694 Override
= TxData
->OverrideData
;
1696 CopyMem (&Src
, &Override
->SourceAddress
, sizeof (IP4_ADDR
));
1697 CopyMem (&Gateway
, &Override
->GatewayAddress
, sizeof (IP4_ADDR
));
1700 Gateway
= NTOHL (Gateway
);
1702 if ((NetGetIpClass (Src
) > IP4_ADDR_CLASSC
) ||
1703 (Src
== IP4_ALLONE_ADDRESS
) ||
1704 IP4_IS_BROADCAST (Ip4GetNetCast (Src
, IpIf
))) {
1706 return EFI_INVALID_PARAMETER
;
1710 // If gateway isn't zero, it must be a unicast address, and
1711 // on the connected network.
1713 if ((Gateway
!= IP4_ALLZERO_ADDRESS
) &&
1714 ((NetGetIpClass (Gateway
) > IP4_ADDR_CLASSC
) ||
1715 !IP4_NET_EQUAL (Gateway
, IpIf
->Ip
, IpIf
->SubnetMask
) ||
1716 IP4_IS_BROADCAST (Ip4GetNetCast (Gateway
, IpIf
)))) {
1718 return EFI_INVALID_PARAMETER
;
1723 // Check the packet length: Head length and packet length all has a limit
1725 HeadLen
= sizeof (IP4_HEAD
) + ((TxData
->OptionsLength
+ 3) &~0x03);
1727 if ((HeadLen
> IP4_MAX_HEADLEN
) ||
1728 (TxData
->TotalDataLength
+ HeadLen
> IP4_MAX_PACKET_SIZE
)) {
1730 return EFI_BAD_BUFFER_SIZE
;
1738 The callback function for the net buffer which wraps the user's
1739 transmit token. Although it seems this function is pretty simple,
1740 there are some subtle things.
1741 When user requests the IP to transmit a packet by passing it a
1742 token, the token is wrapped in an IP4_TXTOKEN_WRAP and the data
1743 is wrapped in an net buffer. the net buffer's Free function is
1744 set to Ip4FreeTxToken. The Token and token wrap are added to the
1745 IP child's TxToken map. Then the buffer is passed to Ip4Output for
1746 transmission. If something error happened before that, the buffer
1747 is freed, which in turn will free the token wrap. The wrap may
1748 have been added to the TxToken map or not, and the user's event
1749 shouldn't be fired because we are still in the EfiIp4Transmit. If
1750 the buffer has been sent by Ip4Output, it should be removed from
1751 the TxToken map and user's event signaled. The token wrap and buffer
1752 are bound together. Check the comments in Ip4Output for information
1753 about IP fragmentation.
1755 @param[in] Context The token's wrap
1763 IP4_TXTOKEN_WRAP
*Wrap
;
1766 Wrap
= (IP4_TXTOKEN_WRAP
*) Context
;
1769 // Signal IpSecRecycleEvent to inform IPsec free the memory
1771 if (Wrap
->IpSecRecycleSignal
!= NULL
) {
1772 gBS
->SignalEvent (Wrap
->IpSecRecycleSignal
);
1776 // Find the token in the instance's map. EfiIp4Transmit put the
1777 // token to the map. If that failed, NetMapFindKey will return NULL.
1779 Item
= NetMapFindKey (&Wrap
->IpInstance
->TxTokens
, Wrap
->Token
);
1782 NetMapRemoveItem (&Wrap
->IpInstance
->TxTokens
, Item
, NULL
);
1786 gBS
->SignalEvent (Wrap
->Token
->Event
);
1789 // Dispatch the DPC queued by the NotifyFunction of Token->Event.
1799 The callback function to Ip4Output to update the transmit status.
1801 @param Ip4Instance The Ip4Instance that request the transmit.
1802 @param Packet The user's transmit request
1803 @param IoStatus The result of the transmission
1804 @param Flag Not used during transmission
1805 @param Context The token's wrap.
1810 IP4_PROTOCOL
*Ip4Instance
,
1812 EFI_STATUS IoStatus
,
1817 IP4_TXTOKEN_WRAP
*Wrap
;
1820 // This is the transmission request from upper layer,
1821 // not the IP4 driver itself.
1823 ASSERT (Ip4Instance
!= NULL
);
1826 // The first fragment of the packet has been sent. Update
1827 // the token's status. That is, if fragmented, the transmit's
1828 // status is the first fragment's status. The Wrap will be
1829 // release when all the fragments are release. Check the comments
1830 // in Ip4FreeTxToken and Ip4Output for information.
1832 Wrap
= (IP4_TXTOKEN_WRAP
*) Context
;
1833 Wrap
->Token
->Status
= IoStatus
;
1835 NetbufFree (Wrap
->Packet
);
1840 Places outgoing data packets into the transmit queue.
1842 The Transmit() function places a sending request in the transmit queue of this
1843 EFI IPv4 Protocol instance. Whenever the packet in the token is sent out or some
1844 errors occur, the event in the token will be signaled and the status is updated.
1846 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.
1847 @param[in] Token Pointer to the transmit token.
1849 @retval EFI_SUCCESS The data has been queued for transmission.
1850 @retval EFI_NOT_STARTED This instance has not been started.
1851 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
1852 RARP, etc.) is not finished yet.
1853 @retval EFI_INVALID_PARAMETER One or more pameters are invalid.
1854 @retval EFI_ACCESS_DENIED The transmit completion token with the same Token.Event
1855 was already in the transmit queue.
1856 @retval EFI_NOT_READY The completion token could not be queued because the transmit
1858 @retval EFI_NOT_FOUND Not route is found to destination address.
1859 @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data.
1860 @retval EFI_BUFFER_TOO_SMALL Token.Packet.TxData.TotalDataLength is too
1862 @retval EFI_BAD_BUFFER_SIZE The length of the IPv4 header + option length + total data length is
1863 greater than MTU (or greater than the maximum packet size if
1864 Token.Packet.TxData.OverrideData.
1865 DoNotFragment is TRUE.)
1871 IN EFI_IP4_PROTOCOL
*This
,
1872 IN EFI_IP4_COMPLETION_TOKEN
*Token
1876 IP4_PROTOCOL
*IpInstance
;
1877 IP4_INTERFACE
*IpIf
;
1878 IP4_TXTOKEN_WRAP
*Wrap
;
1879 EFI_IP4_TRANSMIT_DATA
*TxData
;
1880 EFI_IP4_CONFIG_DATA
*Config
;
1881 EFI_IP4_OVERRIDE_DATA
*Override
;
1886 BOOLEAN DontFragment
;
1890 return EFI_INVALID_PARAMETER
;
1893 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
1895 if (IpInstance
->State
!= IP4_STATE_CONFIGED
) {
1896 return EFI_NOT_STARTED
;
1899 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1901 IpSb
= IpInstance
->Service
;
1902 IpIf
= IpInstance
->Interface
;
1903 Config
= &IpInstance
->ConfigData
;
1905 if (Config
->UseDefaultAddress
&& IP4_NO_MAPPING (IpInstance
)) {
1906 Status
= EFI_NO_MAPPING
;
1911 // make sure that token is properly formated
1913 Status
= Ip4TxTokenValid (Token
, IpIf
);
1915 if (EFI_ERROR (Status
)) {
1920 // Check whether the token or signal already existed.
1922 if (EFI_ERROR (NetMapIterate (&IpInstance
->TxTokens
, Ip4TokenExist
, Token
))) {
1923 Status
= EFI_ACCESS_DENIED
;
1928 // Build the IP header, need to fill in the Tos, TotalLen, Id,
1929 // fragment, Ttl, protocol, Src, and Dst.
1931 TxData
= Token
->Packet
.TxData
;
1933 CopyMem (&Head
.Dst
, &TxData
->DestinationAddress
, sizeof (IP4_ADDR
));
1934 Head
.Dst
= NTOHL (Head
.Dst
);
1936 if (TxData
->OverrideData
!= NULL
) {
1937 Override
= TxData
->OverrideData
;
1938 Head
.Protocol
= Override
->Protocol
;
1939 Head
.Tos
= Override
->TypeOfService
;
1940 Head
.Ttl
= Override
->TimeToLive
;
1941 DontFragment
= Override
->DoNotFragment
;
1943 CopyMem (&Head
.Src
, &Override
->SourceAddress
, sizeof (IP4_ADDR
));
1944 CopyMem (&GateWay
, &Override
->GatewayAddress
, sizeof (IP4_ADDR
));
1946 Head
.Src
= NTOHL (Head
.Src
);
1947 GateWay
= NTOHL (GateWay
);
1949 Head
.Src
= IpIf
->Ip
;
1950 GateWay
= IP4_ALLZERO_ADDRESS
;
1951 Head
.Protocol
= Config
->DefaultProtocol
;
1952 Head
.Tos
= Config
->TypeOfService
;
1953 Head
.Ttl
= Config
->TimeToLive
;
1954 DontFragment
= Config
->DoNotFragment
;
1957 Head
.Fragment
= IP4_HEAD_FRAGMENT_FIELD (DontFragment
, FALSE
, 0);
1958 HeadLen
= (TxData
->OptionsLength
+ 3) & (~0x03);
1961 // If don't fragment and fragment needed, return error
1963 if (DontFragment
&& (TxData
->TotalDataLength
+ HeadLen
> IpSb
->MaxPacketSize
)) {
1964 Status
= EFI_BAD_BUFFER_SIZE
;
1969 // OK, it survives all the validation check. Wrap the token in
1970 // a IP4_TXTOKEN_WRAP and the data in a netbuf
1972 Status
= EFI_OUT_OF_RESOURCES
;
1973 Wrap
= AllocateZeroPool (sizeof (IP4_TXTOKEN_WRAP
));
1978 Wrap
->IpInstance
= IpInstance
;
1979 Wrap
->Token
= Token
;
1981 Wrap
->Life
= IP4_US_TO_SEC (Config
->TransmitTimeout
);
1982 Wrap
->Packet
= NetbufFromExt (
1983 (NET_FRAGMENT
*) TxData
->FragmentTable
,
1984 TxData
->FragmentCount
,
1991 if (Wrap
->Packet
== NULL
) {
1996 Token
->Status
= EFI_NOT_READY
;
1998 if (EFI_ERROR (NetMapInsertTail (&IpInstance
->TxTokens
, Token
, Wrap
))) {
2000 // NetbufFree will call Ip4FreeTxToken, which in turn will
2001 // free the IP4_TXTOKEN_WRAP. Now, the token wrap hasn't been
2004 NetbufFree (Wrap
->Packet
);
2009 // Mark the packet sent before output it. Mark it not sent again if the
2010 // returned status is not EFI_SUCCESS;
2014 Status
= Ip4Output (
2019 TxData
->OptionsBuffer
,
2020 TxData
->OptionsLength
,
2026 if (EFI_ERROR (Status
)) {
2028 NetbufFree (Wrap
->Packet
);
2032 gBS
->RestoreTPL (OldTpl
);
2038 Places a receiving request into the receiving queue.
2040 The Receive() function places a completion token into the receive packet queue.
2041 This function is always asynchronous.
2043 The Token.Event field in the completion token must be filled in by the caller
2044 and cannot be NULL. When the receive operation completes, the EFI IPv4 Protocol
2045 driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event
2048 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.
2049 @param[in] Token Pointer to a token that is associated with the receive data descriptor.
2051 @retval EFI_SUCCESS The receive completion token was cached.
2052 @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.
2053 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, RARP, etc.)
2054 is not finished yet.
2055 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
2058 - Token.Event is NULL.
2059 @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system
2060 resources (usually memory).
2061 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
2062 The EFI IPv4 Protocol instance has been reset to startup defaults.
2063 EFI_ACCESS_DENIED The receive completion token with the same Token.Event was already
2064 in the receive queue.
2065 @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full.
2066 @retval EFI_ICMP_ERROR An ICMP error packet was received.
2072 IN EFI_IP4_PROTOCOL
*This
,
2073 IN EFI_IP4_COMPLETION_TOKEN
*Token
2076 IP4_PROTOCOL
*IpInstance
;
2081 // First validate the parameters
2083 if ((This
== NULL
) || (Token
== NULL
) || (Token
->Event
== NULL
)) {
2084 return EFI_INVALID_PARAMETER
;
2087 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
2089 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
2091 if (IpInstance
->State
!= IP4_STATE_CONFIGED
) {
2092 Status
= EFI_NOT_STARTED
;
2097 // Check whether the toke is already on the receive queue.
2099 Status
= NetMapIterate (&IpInstance
->RxTokens
, Ip4TokenExist
, Token
);
2101 if (EFI_ERROR (Status
)) {
2102 Status
= EFI_ACCESS_DENIED
;
2107 // Queue the token then check whether there is pending received packet.
2109 Status
= NetMapInsertTail (&IpInstance
->RxTokens
, Token
, NULL
);
2111 if (EFI_ERROR (Status
)) {
2115 Status
= Ip4InstanceDeliverPacket (IpInstance
);
2118 // Dispatch the DPC queued by the NotifyFunction of this instane's receive
2124 gBS
->RestoreTPL (OldTpl
);
2130 Cancel the transmitted but not recycled packet. If a matching
2131 token is found, it will call Ip4CancelPacket to cancel the
2132 packet. Ip4CancelPacket will cancel all the fragments of the
2133 packet. When all the fragments are freed, the IP4_TXTOKEN_WRAP
2134 will be deleted from the Map, and user's event signalled.
2135 Because Ip4CancelPacket and other functions are all called in
2136 line, so, after Ip4CancelPacket returns, the Item has been freed.
2138 @param[in] Map The IP4 child's transmit queue
2139 @param[in] Item The current transmitted packet to test.
2140 @param[in] Context The user's token to cancel.
2142 @retval EFI_SUCCESS Continue to check the next Item.
2143 @retval EFI_ABORTED The user's Token (Token != NULL) is cancelled.
2149 IN NET_MAP_ITEM
*Item
,
2153 EFI_IP4_COMPLETION_TOKEN
*Token
;
2154 IP4_TXTOKEN_WRAP
*Wrap
;
2156 Token
= (EFI_IP4_COMPLETION_TOKEN
*) Context
;
2159 // Return EFI_SUCCESS to check the next item in the map if
2160 // this one doesn't match.
2162 if ((Token
!= NULL
) && (Token
!= Item
->Key
)) {
2166 Wrap
= (IP4_TXTOKEN_WRAP
*) Item
->Value
;
2167 ASSERT (Wrap
!= NULL
);
2170 // Don't access the Item, Wrap and Token's members after this point.
2171 // Item and wrap has been freed. And we no longer own the Token.
2173 Ip4CancelPacket (Wrap
->IpInstance
->Interface
, Wrap
->Packet
, EFI_ABORTED
);
2176 // If only one item is to be cancel, return EFI_ABORTED to stop
2177 // iterating the map any more.
2179 if (Token
!= NULL
) {
2188 Cancel the receive request. This is quiet simple, because
2189 it is only enqueued in our local receive map.
2191 @param[in] Map The IP4 child's receive queue
2192 @param[in] Item Current receive request to cancel.
2193 @param[in] Context The user's token to cancel
2195 @retval EFI_SUCCESS Continue to check the next receive request on the
2197 @retval EFI_ABORTED The user's token (token != NULL) has been
2204 IN NET_MAP_ITEM
*Item
,
2208 EFI_IP4_COMPLETION_TOKEN
*Token
;
2209 EFI_IP4_COMPLETION_TOKEN
*This
;
2211 Token
= (EFI_IP4_COMPLETION_TOKEN
*) Context
;
2214 if ((Token
!= NULL
) && (Token
!= This
)) {
2218 NetMapRemoveItem (Map
, Item
, NULL
);
2220 This
->Status
= EFI_ABORTED
;
2221 This
->Packet
.RxData
= NULL
;
2222 gBS
->SignalEvent (This
->Event
);
2224 if (Token
!= NULL
) {
2233 Cancel the user's receive/transmit request.
2235 @param[in] IpInstance The IP4 child
2236 @param[in] Token The token to cancel. If NULL, all token will be
2239 @retval EFI_SUCCESS The token is cancelled
2240 @retval EFI_NOT_FOUND The token isn't found on either the
2241 transmit/receive queue
2242 @retval EFI_DEVICE_ERROR Not all token is cancelled when Token is NULL.
2247 IN IP4_PROTOCOL
*IpInstance
,
2248 IN EFI_IP4_COMPLETION_TOKEN
*Token OPTIONAL
2254 // First check the transmitted packet. Ip4CancelTxTokens returns
2255 // EFI_ABORTED to mean that the token has been cancelled when
2256 // token != NULL. So, return EFI_SUCCESS for this condition.
2258 Status
= NetMapIterate (&IpInstance
->TxTokens
, Ip4CancelTxTokens
, Token
);
2260 if (EFI_ERROR (Status
)) {
2261 if ((Token
!= NULL
) && (Status
== EFI_ABORTED
)) {
2269 // Check the receive queue. Ip4CancelRxTokens also returns EFI_ABORT
2270 // for Token!=NULL and it is cancelled.
2272 Status
= NetMapIterate (&IpInstance
->RxTokens
, Ip4CancelRxTokens
, Token
);
2274 // Dispatch the DPCs queued by the NotifyFunction of the canceled rx token's
2278 if (EFI_ERROR (Status
)) {
2279 if ((Token
!= NULL
) && (Status
== EFI_ABORTED
)) {
2287 // OK, if the Token is found when Token != NULL, the NetMapIterate
2288 // will return EFI_ABORTED, which has been interrupted as EFI_SUCCESS.
2290 if (Token
!= NULL
) {
2291 return EFI_NOT_FOUND
;
2295 // If Token == NULL, cancel all the tokens. return error if no
2296 // all of them are cancelled.
2298 if (!NetMapIsEmpty (&IpInstance
->TxTokens
) ||
2299 !NetMapIsEmpty (&IpInstance
->RxTokens
)) {
2301 return EFI_DEVICE_ERROR
;
2309 Abort an asynchronous transmit or receive request.
2311 The Cancel() function is used to abort a pending transmit or receive request.
2312 If the token is in the transmit or receive request queues, after calling this
2313 function, Token->Status will be set to EFI_ABORTED and then Token->Event will
2314 be signaled. If the token is not in one of the queues, which usually means the
2315 asynchronous operation has completed, this function will not signal the token
2316 and EFI_NOT_FOUND is returned.
2318 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.
2319 @param[in] Token Pointer to a token that has been issued by
2320 EFI_IP4_PROTOCOL.Transmit() or
2321 EFI_IP4_PROTOCOL.Receive(). If NULL, all pending
2322 tokens are aborted. Type EFI_IP4_COMPLETION_TOKEN is
2323 defined in EFI_IP4_PROTOCOL.Transmit().
2325 @retval EFI_SUCCESS The asynchronous I/O request was aborted and
2326 Token.->Event was signaled. When Token is NULL, all
2327 pending requests were aborted and their events were signaled.
2328 @retval EFI_INVALID_PARAMETER This is NULL.
2329 @retval EFI_NOT_STARTED This instance has not been started.
2330 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
2331 RARP, etc.) is not finished yet.
2332 @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O request was
2333 not found in the transmit or receive queue. It has either completed
2334 or was not issued by Transmit() and Receive().
2340 IN EFI_IP4_PROTOCOL
*This
,
2341 IN EFI_IP4_COMPLETION_TOKEN
*Token OPTIONAL
2344 IP4_PROTOCOL
*IpInstance
;
2349 return EFI_INVALID_PARAMETER
;
2352 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
2354 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
2356 if (IpInstance
->State
!= IP4_STATE_CONFIGED
) {
2357 Status
= EFI_NOT_STARTED
;
2361 if (IpInstance
->ConfigData
.UseDefaultAddress
&& IP4_NO_MAPPING (IpInstance
)) {
2362 Status
= EFI_NO_MAPPING
;
2366 Status
= Ip4Cancel (IpInstance
, Token
);
2369 gBS
->RestoreTPL (OldTpl
);
2375 Polls for incoming data packets and processes outgoing data packets.
2377 The Poll() function polls for incoming data packets and processes outgoing data
2378 packets. Network drivers and applications can call the EFI_IP4_PROTOCOL.Poll()
2379 function to increase the rate that data packets are moved between the communications
2380 device and the transmit and receive queues.
2382 In some systems the periodic timer event may not poll the underlying communications
2383 device fast enough to transmit and/or receive all data packets without missing
2384 incoming packets or dropping outgoing packets. Drivers and applications that are
2385 experiencing packet loss should try calling the EFI_IP4_PROTOCOL.Poll() function
2388 @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.
2390 @retval EFI_SUCCESS Incoming or outgoing data was processed.
2391 @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.
2392 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
2393 RARP, etc.) is not finished yet.
2394 @retval EFI_INVALID_PARAMETER This is NULL.
2395 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
2396 @retval EFI_NOT_READY No incoming or outgoing data is processed.
2397 @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue.
2398 Consider increasing the polling rate.
2404 IN EFI_IP4_PROTOCOL
*This
2407 IP4_PROTOCOL
*IpInstance
;
2408 EFI_MANAGED_NETWORK_PROTOCOL
*Mnp
;
2411 return EFI_INVALID_PARAMETER
;
2414 IpInstance
= IP4_INSTANCE_FROM_PROTOCOL (This
);
2416 if (IpInstance
->State
== IP4_STATE_UNCONFIGED
) {
2417 return EFI_NOT_STARTED
;
2420 Mnp
= IpInstance
->Service
->Mnp
;
2423 // Don't lock the Poll function to enable the deliver of
2424 // the packet polled up.
2426 return Mnp
->Poll (Mnp
);
2430 Decrease the life of the transmitted packets. If it is
2431 decreased to zero, cancel the packet. This function is
2432 called by Ip4PacketTimerTicking which time out both the
2433 received-but-not-delivered and transmitted-but-not-recycle
2436 @param[in] Map The IP4 child's transmit map.
2437 @param[in] Item Current transmitted packet
2438 @param[in] Context Not used.
2440 @retval EFI_SUCCESS Always returns EFI_SUCCESS
2444 Ip4SentPacketTicking (
2446 IN NET_MAP_ITEM
*Item
,
2450 IP4_TXTOKEN_WRAP
*Wrap
;
2452 Wrap
= (IP4_TXTOKEN_WRAP
*) Item
->Value
;
2453 ASSERT (Wrap
!= NULL
);
2455 if ((Wrap
->Life
> 0) && (--Wrap
->Life
== 0)) {
2456 Ip4CancelPacket (Wrap
->IpInstance
->Interface
, Wrap
->Packet
, EFI_ABORTED
);
2464 The heart beat timer of IP4 service instance. It times out
2465 all of its IP4 children's received-but-not-delivered and
2466 transmitted-but-not-recycle packets, and provides time input
2467 for its IGMP protocol.
2469 @param[in] Event The IP4 service instance's heart beat timer.
2470 @param[in] Context The IP4 service instance.
2482 IpSb
= (IP4_SERVICE
*) Context
;
2483 NET_CHECK_SIGNATURE (IpSb
, IP4_SERVICE_SIGNATURE
);
2485 Ip4PacketTimerTicking (IpSb
);
2486 Ip4IgmpTicking (IpSb
);