3 Copyright (c) 2006 - 2007, Intel Corporation
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.
18 The implementation of the Udp4 protocol.
26 UINT16 mUdp4RandomPort
;
38 Udp4FindInstanceByPort (
39 IN NET_LIST_ENTRY
*InstanceList
,
40 IN EFI_IPv4_ADDRESS
*Address
,
57 IN ICMP_ERROR IcmpError
,
58 IN EFI_NET_SESSION_DATA
*NetSession
,
67 IN NET_MAP_ITEM
*Item
,
74 IN UDP4_INSTANCE_DATA
*Instance
,
75 IN EFI_UDP4_SESSION_DATA
*Udp4Session
81 Udp4RecycleRxDataWrap (
89 IN UDP4_INSTANCE_DATA
*Instance
,
91 IN EFI_UDP4_RECEIVE_DATA
*RxData
97 IN UDP4_SERVICE_DATA
*Udp4Service
,
99 IN EFI_UDP4_RECEIVE_DATA
*RxData
105 IN UDP4_SERVICE_DATA
*Udp4Service
111 IN UDP4_SERVICE_DATA
*Udp4Service
,
112 IN EFI_NET_SESSION_DATA
*NetSession
,
119 IN UDP4_SERVICE_DATA
*Udp4Service
,
120 IN ICMP_ERROR IcmpError
,
121 IN EFI_NET_SESSION_DATA
*NetSession
,
127 Udp4SendPortUnreach (
129 IN EFI_NET_SESSION_DATA
*NetSession
,
135 Create the Udp service context data.
137 @param Udp4Service Pointer to the UDP4_SERVICE_DATA.
138 @param ImageHandle The image handle of this udp4 driver.
139 @param ControllerHandle The controller handle this udp4 driver binds on.
141 @retval EFI_SUCCESS The udp4 service context data is created and
143 @retval EFI_OUT_OF_RESOURCES Cannot allocate memory.
148 IN UDP4_SERVICE_DATA
*Udp4Service
,
149 IN EFI_HANDLE ImageHandle
,
150 IN EFI_HANDLE ControllerHandle
154 IP_IO_OPEN_DATA OpenData
;
156 Udp4Service
->Signature
= UDP4_SERVICE_DATA_SIGNATURE
;
157 Udp4Service
->ServiceBinding
= mUdp4ServiceBinding
;
158 Udp4Service
->ImageHandle
= ImageHandle
;
159 Udp4Service
->ControllerHandle
= ControllerHandle
;
160 Udp4Service
->ChildrenNumber
= 0;
162 NetListInit (&Udp4Service
->ChildrenList
);
165 // Create the IpIo for this service context.
167 Udp4Service
->IpIo
= IpIoCreate (ImageHandle
, ControllerHandle
);
168 if (Udp4Service
->IpIo
== NULL
) {
169 return EFI_OUT_OF_RESOURCES
;
173 // Set the OpenData used to open the IpIo.
175 CopyMem (&OpenData
.IpConfigData
, &mIpIoDefaultIpConfigData
, sizeof (EFI_IP4_CONFIG_DATA
));
176 OpenData
.IpConfigData
.AcceptBroadcast
= TRUE
;
177 OpenData
.RcvdContext
= (VOID
*) Udp4Service
;
178 OpenData
.SndContext
= NULL
;
179 OpenData
.PktRcvdNotify
= Udp4DgramRcvd
;
180 OpenData
.PktSentNotify
= Udp4DgramSent
;
183 // Configure and start the IpIo.
185 Status
= IpIoOpen (Udp4Service
->IpIo
, &OpenData
);
186 if (EFI_ERROR (Status
)) {
191 // Create the event for Udp timeout checking.
193 Status
= gBS
->CreateEvent (
194 EVT_TIMER
| EVT_NOTIFY_SIGNAL
,
198 &Udp4Service
->TimeoutEvent
200 if (EFI_ERROR (Status
)) {
205 // Start the timeout timer event.
207 Status
= gBS
->SetTimer (
208 Udp4Service
->TimeoutEvent
,
210 UDP4_TIMEOUT_INTERVAL
212 if (EFI_ERROR (Status
)) {
216 Udp4Service
->MacString
= NULL
;
222 gBS
->CloseEvent (Udp4Service
->TimeoutEvent
);
226 IpIoDestroy (Udp4Service
->IpIo
);
233 Clean the Udp service context data.
235 @param Udp4Service Pointer to the UDP4_SERVICE_DATA.
242 IN UDP4_SERVICE_DATA
*Udp4Service
246 // Cancel the TimeoutEvent timer.
248 gBS
->SetTimer (Udp4Service
->TimeoutEvent
, TimerCancel
, 0);
251 // Close the TimeoutEvent timer.
253 gBS
->CloseEvent (Udp4Service
->TimeoutEvent
);
258 IpIoDestroy (Udp4Service
->IpIo
);
263 This function checks and timeouts the I/O datagrams holding by the corresponding
266 @param Event The event this function registered to.
267 @param Conext The context data registered during the creation of
281 UDP4_SERVICE_DATA
*Udp4Service
;
282 NET_LIST_ENTRY
*Entry
;
283 UDP4_INSTANCE_DATA
*Instance
;
284 NET_LIST_ENTRY
*WrapEntry
;
285 NET_LIST_ENTRY
*NextEntry
;
286 UDP4_RXDATA_WRAP
*Wrap
;
288 Udp4Service
= (UDP4_SERVICE_DATA
*) Context
;
289 NET_CHECK_SIGNATURE (Udp4Service
, UDP4_SERVICE_DATA_SIGNATURE
);
291 NET_LIST_FOR_EACH (Entry
, &Udp4Service
->ChildrenList
) {
293 // Iterate all the instances belonging to this service context.
295 Instance
= NET_LIST_USER_STRUCT (Entry
, UDP4_INSTANCE_DATA
, Link
);
296 NET_CHECK_SIGNATURE (Instance
, UDP4_INSTANCE_DATA_SIGNATURE
);
298 if (!Instance
->Configured
|| (Instance
->ConfigData
.ReceiveTimeout
== 0)) {
300 // Skip this instance if it's not configured or no receive timeout.
305 NET_LIST_FOR_EACH_SAFE (WrapEntry
, NextEntry
, &Instance
->RcvdDgramQue
) {
307 // Iterate all the rxdatas belonging to this udp instance.
309 Wrap
= NET_LIST_USER_STRUCT (Entry
, UDP4_RXDATA_WRAP
, Link
);
311 if (Wrap
->TimeoutTick
<= UDP4_TIMEOUT_INTERVAL
/ 1000) {
313 // Remove this RxData if it timeouts.
315 Udp4RecycleRxDataWrap (NULL
, (VOID
*) Wrap
);
317 Wrap
->TimeoutTick
-= UDP4_TIMEOUT_INTERVAL
/ 1000;
325 This function intializes the new created udp instance.
327 @param Udp4Service Pointer to the UDP4_SERVICE_DATA.
328 @param Instance Pointer to the un-initialized UDP4_INSTANCE_DATA.
335 IN UDP4_SERVICE_DATA
*Udp4Service
,
336 IN UDP4_INSTANCE_DATA
*Instance
340 // Set the signature.
342 Instance
->Signature
= UDP4_INSTANCE_DATA_SIGNATURE
;
347 NetListInit (&Instance
->Link
);
348 NetListInit (&Instance
->RcvdDgramQue
);
349 NetListInit (&Instance
->DeliveredDgramQue
);
352 // Init the NET_MAPs.
354 NetMapInit (&Instance
->TxTokens
);
355 NetMapInit (&Instance
->RxTokens
);
356 NetMapInit (&Instance
->McastIps
);
359 // Save the pointer to the UDP4_SERVICE_DATA, and initialize other members.
361 Instance
->Udp4Service
= Udp4Service
;
362 CopyMem (&Instance
->Udp4Proto
, &mUdp4Protocol
, sizeof (EFI_UDP4_PROTOCOL
));
363 Instance
->IcmpError
= EFI_SUCCESS
;
364 Instance
->Configured
= FALSE
;
365 Instance
->IsNoMapping
= FALSE
;
366 Instance
->Destroyed
= FALSE
;
371 This function cleans the udp instance.
373 @param Instance Pointer to the UDP4_INSTANCE_DATA to clean.
380 IN UDP4_INSTANCE_DATA
*Instance
383 NetMapClean (&Instance
->McastIps
);
384 NetMapClean (&Instance
->RxTokens
);
385 NetMapClean (&Instance
->TxTokens
);
390 This function finds the udp instance by the specified <Address, Port> pair.
392 @param InstanceList Pointer to the head of the list linking the udp
394 @param Address Pointer to the specified IPv4 address.
395 @param Port The udp port number.
397 @return Is the specified <Address, Port> pair found or not.
402 Udp4FindInstanceByPort (
403 IN NET_LIST_ENTRY
*InstanceList
,
404 IN EFI_IPv4_ADDRESS
*Address
,
408 NET_LIST_ENTRY
*Entry
;
409 UDP4_INSTANCE_DATA
*Instance
;
410 EFI_UDP4_CONFIG_DATA
*ConfigData
;
412 NET_LIST_FOR_EACH (Entry
, InstanceList
) {
414 // Iterate all the udp instances.
416 Instance
= NET_LIST_USER_STRUCT (Entry
, UDP4_INSTANCE_DATA
, Link
);
417 ConfigData
= &Instance
->ConfigData
;
419 if (!Instance
->Configured
|| ConfigData
->AcceptAnyPort
) {
421 // If the instance is not configured or the configdata of the instance indicates
422 // this instance accepts any port, skip it.
427 if (EFI_IP_EQUAL (ConfigData
->StationAddress
, *Address
) &&
428 (ConfigData
->StationPort
== Port
)) {
430 // if both the address and the port are the same, return TRUE.
437 // return FALSE when matching fails.
444 This function tries to bind the udp instance according to the configured port
447 @param InstanceList Pointer to the head of the list linking the udp
449 @param ConfigData Pointer to the ConfigData of the instance to be
452 @retval EFI_SUCCESS The bound operation is completed successfully.
453 @retval EFI_ACCESS_DENIED The <Address, Port> specified by the ConfigData is
454 already used by other instance.
455 @retval EFI_OUT_OF_RESOURCES No available port resources.
460 IN NET_LIST_ENTRY
*InstanceList
,
461 IN EFI_UDP4_CONFIG_DATA
*ConfigData
464 EFI_IPv4_ADDRESS
*StationAddress
;
467 if (ConfigData
->AcceptAnyPort
) {
471 StationAddress
= &ConfigData
->StationAddress
;
473 if (ConfigData
->StationPort
!= 0) {
475 if (!ConfigData
->AllowDuplicatePort
&&
476 Udp4FindInstanceByPort (InstanceList
, StationAddress
, ConfigData
->StationPort
)) {
478 // Do not allow duplicate port and the port is already used by other instance.
480 return EFI_ACCESS_DENIED
;
484 // select a random port for this instance;
487 if (ConfigData
->AllowDuplicatePort
) {
489 // Just pick up the random port if the instance allows duplicate port.
491 ConfigData
->StationPort
= mUdp4RandomPort
;
494 StartPort
= mUdp4RandomPort
;
496 while (Udp4FindInstanceByPort(InstanceList
, StationAddress
, mUdp4RandomPort
)) {
499 if (mUdp4RandomPort
== 0) {
500 mUdp4RandomPort
= UDP4_PORT_KNOWN
;
503 if (mUdp4RandomPort
== StartPort
) {
505 // No available port.
507 return EFI_OUT_OF_RESOURCES
;
511 ConfigData
->StationPort
= mUdp4RandomPort
;
515 if (mUdp4RandomPort
== 0) {
516 mUdp4RandomPort
= UDP4_PORT_KNOWN
;
525 This function is used to check whether the NewConfigData has any un-reconfigurable
526 parameters changed compared to the OldConfigData.
528 @param OldConfigData Pointer to the current ConfigData the udp instance
530 @param NewConfigData Pointer to the new ConfigData.
532 @return The instance is reconfigurable or not according to the NewConfigData.
536 Udp4IsReconfigurable (
537 IN EFI_UDP4_CONFIG_DATA
*OldConfigData
,
538 IN EFI_UDP4_CONFIG_DATA
*NewConfigData
541 if ((NewConfigData
->AcceptAnyPort
!= OldConfigData
->AcceptAnyPort
) ||
542 (NewConfigData
->AcceptBroadcast
!= OldConfigData
->AcceptBroadcast
) ||
543 (NewConfigData
->AcceptPromiscuous
!= OldConfigData
->AcceptPromiscuous
) ||
544 (NewConfigData
->AllowDuplicatePort
!= OldConfigData
->AllowDuplicatePort
)) {
546 // The receiving filter parameters cannot be changed.
551 if ((!NewConfigData
->AcceptAnyPort
) &&
552 (NewConfigData
->StationPort
!= OldConfigData
->StationPort
)) {
554 // The port is not changeable.
559 if (!NewConfigData
->AcceptPromiscuous
) {
561 if (NewConfigData
->UseDefaultAddress
!= OldConfigData
->UseDefaultAddress
) {
563 // The NewConfigData differs to the old one on the UseDefaultAddress.
568 if (!NewConfigData
->UseDefaultAddress
&&
569 (!EFI_IP_EQUAL (NewConfigData
->StationAddress
, OldConfigData
->StationAddress
) ||
570 !EFI_IP_EQUAL (NewConfigData
->SubnetMask
, OldConfigData
->SubnetMask
))) {
572 // If the instance doesn't use the default address, and the new address or
573 // new subnet mask is different from the old values.
579 if (!EFI_IP_EQUAL (NewConfigData
->RemoteAddress
, OldConfigData
->RemoteAddress
)) {
581 // The remoteaddress is not the same.
586 if ((EFI_IP4 (NewConfigData
->RemoteAddress
) != 0) &&
587 (NewConfigData
->RemotePort
!= OldConfigData
->RemotePort
)) {
589 // The RemotePort differs if it's designated in the configdata.
595 // All checks pass, return TRUE.
602 This function builds the Ip4 configdata from the Udp4ConfigData.
604 @param Udp4ConfigData Pointer to the EFI_UDP4_CONFIG_DATA.
605 @param Ip4ConfigData Pointer to the EFI_IP4_CONFIG_DATA.
611 Udp4BuildIp4ConfigData (
612 IN EFI_UDP4_CONFIG_DATA
*Udp4ConfigData
,
613 IN EFI_IP4_CONFIG_DATA
*Ip4ConfigData
616 CopyMem (Ip4ConfigData
, &mIpIoDefaultIpConfigData
, sizeof (EFI_IP4_CONFIG_DATA
));
618 Ip4ConfigData
->DefaultProtocol
= EFI_IP_PROTO_UDP
;
619 Ip4ConfigData
->AcceptBroadcast
= Udp4ConfigData
->AcceptBroadcast
;
620 Ip4ConfigData
->AcceptPromiscuous
= Udp4ConfigData
->AcceptPromiscuous
;
621 Ip4ConfigData
->UseDefaultAddress
= Udp4ConfigData
->UseDefaultAddress
;
622 Ip4ConfigData
->StationAddress
= Udp4ConfigData
->StationAddress
;
623 Ip4ConfigData
->SubnetMask
= Udp4ConfigData
->SubnetMask
;
626 // use the -1 magic number to disable the receiving process of the ip instance.
628 Ip4ConfigData
->ReceiveTimeout
= (UINT32
) (-1);
633 This function validates the TxToken, it returns the error code according to the spec.
635 @param Instance Pointer to the udp instance context data.
636 @param TxToken Pointer to the token to be checked.
638 @retval EFI_SUCCESS The TxToken is valid.
639 @retval EFI_INVALID_PARAMETER One or more of the following are TRUE: This is
640 NULL. Token is NULL. Token.Event is NULL.
641 Token.Packet.TxData is NULL.
642 Token.Packet.TxData.FragmentCount is zero.
643 Token.Packet.TxData.DataLength is not equal to the
644 sum of fragment lengths. One or more of the
645 Token.Packet.TxData.FragmentTable[].
646 FragmentLength fields is zero. One or more of the
647 Token.Packet.TxData.FragmentTable[].
648 FragmentBuffer fields is NULL.
649 Token.Packet.TxData. GatewayAddress is not a
650 unicast IPv4 address if it is not NULL. One or
651 more IPv4 addresses in Token.Packet.TxData.
652 UdpSessionData are not valid unicast IPv4
653 addresses if the UdpSessionData is not NULL.
654 @retval EFI_BAD_BUFFER_SIZE The data length is greater than the maximum UDP
659 Udp4ValidateTxToken (
660 IN UDP4_INSTANCE_DATA
*Instance
,
661 IN EFI_UDP4_COMPLETION_TOKEN
*TxToken
664 EFI_UDP4_TRANSMIT_DATA
*TxData
;
667 EFI_UDP4_CONFIG_DATA
*ConfigData
;
668 EFI_UDP4_SESSION_DATA
*UdpSessionData
;
669 IP4_ADDR SourceAddress
;
671 if (TxToken
->Event
== NULL
) {
672 return EFI_INVALID_PARAMETER
;
675 TxData
= TxToken
->Packet
.TxData
;
677 if ((TxData
== NULL
) || (TxData
->FragmentCount
== 0)) {
678 return EFI_INVALID_PARAMETER
;
682 for (Index
= 0; Index
< TxData
->FragmentCount
; Index
++) {
684 if ((TxData
->FragmentTable
[Index
].FragmentBuffer
== NULL
) ||
685 (TxData
->FragmentTable
[Index
].FragmentLength
== 0)) {
687 // if the FragmentBuffer is NULL or the FragmentLeng is zero.
689 return EFI_INVALID_PARAMETER
;
692 TotalLen
+= TxData
->FragmentTable
[Index
].FragmentLength
;
695 if (TotalLen
!= TxData
->DataLength
) {
697 // The TotalLen calculated by adding all the FragmentLeng doesn't equal to the
700 return EFI_INVALID_PARAMETER
;
703 if ((TxData
->GatewayAddress
!= NULL
) &&
704 !Ip4IsUnicast(EFI_NTOHL (*(TxData
->GatewayAddress
)), 0)) {
706 // The specified GatewayAddress is not a unicast IPv4 address while it's not 0.
708 return EFI_INVALID_PARAMETER
;
711 ConfigData
= &Instance
->ConfigData
;
712 UdpSessionData
= TxData
->UdpSessionData
;
714 if (UdpSessionData
!= NULL
) {
716 SourceAddress
= EFI_NTOHL (UdpSessionData
->SourceAddress
);
718 if ((SourceAddress
!= 0) && !Ip4IsUnicast (SourceAddress
, 0)) {
720 // Check whether SourceAddress is a valid IPv4 address in case it's not zero.
721 // The configured station address is used if SourceAddress is zero.
723 return EFI_INVALID_PARAMETER
;
726 if ((UdpSessionData
->DestinationPort
== 0) && (ConfigData
->RemotePort
== 0)) {
728 // Ambiguous, no avalaible DestinationPort for this token.
730 return EFI_INVALID_PARAMETER
;
733 if (EFI_IP4 (UdpSessionData
->DestinationAddress
) == 0) {
735 // The DestinationAddress specified in the UdpSessionData is 0.
737 return EFI_INVALID_PARAMETER
;
739 } else if (EFI_IP4 (ConfigData
->RemoteAddress
) == 0) {
741 // the configured RemoteAddress is all zero, and the user doens't override the
742 // destination address.
744 return EFI_INVALID_PARAMETER
;
747 if (TxData
->DataLength
> UDP4_MAX_DATA_SIZE
) {
748 return EFI_BAD_BUFFER_SIZE
;
756 This function checks whether the specified Token duplicates with the one in the Map.
758 @param Map Pointer to the NET_MAP.
759 @param Item Pointer to the NET_MAP_ITEM contain the pointer to
761 @param Context Pointer to the Token to be checked.
763 @retval EFI_SUCCESS The Token specified by Context differs from the
765 @retval EFI_ACCESS_DENIED The Token duplicates with the one in the Item.
771 IN NET_MAP_ITEM
*Item
,
775 EFI_UDP4_COMPLETION_TOKEN
*Token
;
776 EFI_UDP4_COMPLETION_TOKEN
*TokenInItem
;
778 Token
= (EFI_UDP4_COMPLETION_TOKEN
*) Context
;
779 TokenInItem
= (EFI_UDP4_COMPLETION_TOKEN
*) Item
->Key
;
781 if ((Token
== TokenInItem
) || (Token
->Event
== TokenInItem
->Event
)) {
783 // The Token duplicates with the TokenInItem in case either the two pointers are the
784 // same or the Events of these two tokens are the same.
786 return EFI_ACCESS_DENIED
;
794 This function calculates the checksum for the Packet, utilizing the pre-calculated
795 pseudo HeadSum to reduce some overhead.
797 @param Packet Pointer to the NET_BUF contains the udp datagram.
798 @param HeadSum Checksum of the pseudo header execpt the length
801 @return The 16-bit checksum of this udp datagram.
812 Checksum
= NetbufChecksum (Packet
);
813 Checksum
= NetAddChecksum (Checksum
, HeadSum
);
815 Checksum
= NetAddChecksum (Checksum
, HTONS ((UINT16
) Packet
->TotalSize
));
822 This function removes the specified Token from the TokenMap.
824 @param TokenMap Pointer to the NET_MAP containing the tokens.
825 @param Token Pointer to the Token to be removed.
827 @retval EFI_SUCCESS The specified Token is removed from the TokenMap.
828 @retval EFI_NOT_FOUND The specified Token is not found in the TokenMap.
833 IN NET_MAP
*TokenMap
,
834 IN EFI_UDP4_COMPLETION_TOKEN
*Token
840 // Find the Token first.
842 Item
= NetMapFindKey (TokenMap
, (VOID
*) Token
);
846 // Remove the token if it's found in the map.
848 NetMapRemoveItem (TokenMap
, Item
, NULL
);
853 return EFI_NOT_FOUND
;
858 This function is the packet transmitting notify function registered to the IpIo
859 interface. It's called to signal the udp TxToken when IpIo layer completes the
860 transmitting of the udp datagram.
862 @param Status The completion status of the output udp datagram.
863 @param Context Pointer to the context data.
864 @param Sender Pointer to the Ip sender of the udp datagram.
865 @param NotifyData Pointer to the notify data.
873 IN EFI_STATUS Status
,
879 UDP4_INSTANCE_DATA
*Instance
;
880 EFI_UDP4_COMPLETION_TOKEN
*Token
;
882 Instance
= (UDP4_INSTANCE_DATA
*) Context
;
883 Token
= (EFI_UDP4_COMPLETION_TOKEN
*) NotifyData
;
885 if (Udp4RemoveToken (&Instance
->TxTokens
, Token
) == EFI_SUCCESS
) {
887 // The token may be cancelled. Only signal it if the remove operation succeeds.
889 Token
->Status
= Status
;
890 gBS
->SignalEvent (Token
->Event
);
896 This function processes the received datagram passed up by the IpIo layer.
898 @param Status The status of this udp datagram.
899 @param IcmpError The IcmpError code, only available when Status is
901 @param NetSession Pointer to the EFI_NET_SESSION_DATA.
902 @param Packet Pointer to the NET_BUF containing the received udp
904 @param Context Pointer to the context data.
912 IN EFI_STATUS Status
,
913 IN ICMP_ERROR IcmpError
,
914 IN EFI_NET_SESSION_DATA
*NetSession
,
919 NET_CHECK_SIGNATURE (Packet
, NET_BUF_SIGNATURE
);
922 // IpIo only passes received packets with Status EFI_SUCCESS or EFI_ICMP_ERROR.
924 if (Status
== EFI_SUCCESS
) {
926 // Demultiplex the received datagram.
928 Udp4Demultiplex ((UDP4_SERVICE_DATA
*) Context
, NetSession
, Packet
);
931 // Handle the ICMP_ERROR packet.
933 Udp4IcmpHandler ((UDP4_SERVICE_DATA
*) Context
, IcmpError
, NetSession
, Packet
);
939 This function removes the multicast group specified by Arg from the Map.
941 @param Map Pointer to the NET_MAP.
942 @param Item Pointer to the NET_MAP_ITEM.
943 @param Arg Pointer to the Arg, it's the pointer to a
944 multicast IPv4 Address.
946 @retval EFI_SUCCESS The multicast address is removed.
947 @retval EFI_ABORTED The specified multicast address is removed and the
954 IN NET_MAP_ITEM
*Item
,
955 IN VOID
*Arg OPTIONAL
958 EFI_IPv4_ADDRESS
*McastIp
;
962 if ((McastIp
!= NULL
) && ((UINTN
) EFI_IP4 (*McastIp
) != (UINTN
) (Item
->Key
))) {
964 // McastIp is not NULL and the multicast address contained in the Item
965 // is not the same as McastIp.
973 NetMapRemoveItem (Map
, Item
, NULL
);
975 if (McastIp
!= NULL
) {
977 // Return EFI_ABORTED in case McastIp is not NULL to terminate the iteration.
987 This function cancle the token specified by Arg in the Map.
989 @param Map Pointer to the NET_MAP.
990 @param Item Pointer to the NET_MAP_ITEM.
991 @param Arg Pointer to the token to be cancelled, if NULL, all
992 the tokens in this Map will be cancelled.
994 @retval EFI_SUCCESS The token is cancelled if Arg is NULL or the token
995 is not the same as that in the Item if Arg is not
997 @retval EFI_ABORTED Arg is not NULL, and the token specified by Arg is
1005 IN NET_MAP_ITEM
*Item
,
1006 IN VOID
*Arg OPTIONAL
1009 EFI_UDP4_COMPLETION_TOKEN
*TokenToCancel
;
1013 if ((Arg
!= NULL
) && (Item
->Key
!= Arg
)) {
1017 if (Item
->Value
!= NULL
) {
1019 // If the token is a transmit token, the corresponding Packet is recorded in
1020 // Item->Value, invoke IpIo to cancel this packet first. The IpIoCancelTxToken
1021 // will invoke Udp4DgramSent, the token will be signaled and this Item will
1022 // be removed from the Map there.
1024 Packet
= (NET_BUF
*) (Item
->Value
);
1025 IpIo
= (IP_IO
*) (*((UINTN
*) &Packet
->ProtoData
[0]));
1027 IpIoCancelTxToken (IpIo
, Packet
);
1030 // The token is a receive token. Abort it and remove it from the Map.
1032 TokenToCancel
= (EFI_UDP4_COMPLETION_TOKEN
*) Item
->Key
;
1034 TokenToCancel
->Status
= EFI_ABORTED
;
1035 gBS
->SignalEvent (TokenToCancel
->Event
);
1037 NetMapRemoveItem (Map
, Item
, NULL
);
1049 This function removes all the Wrap datas in the RcvdDgramQue.
1051 @param RcvdDgramQue Pointer to the list containing all the Wrap datas.
1058 IN NET_LIST_ENTRY
*RcvdDgramQue
1061 UDP4_RXDATA_WRAP
*Wrap
;
1064 OldTpl
= NET_RAISE_TPL (NET_TPL_RECYCLE
);
1066 while (!NetListIsEmpty (RcvdDgramQue
)) {
1068 // Iterate all the Wraps in the RcvdDgramQue.
1070 Wrap
= NET_LIST_HEAD (RcvdDgramQue
, UDP4_RXDATA_WRAP
, Link
);
1073 // The Wrap will be removed from the RcvdDgramQue by this function call.
1075 Udp4RecycleRxDataWrap (NULL
, (VOID
*) Wrap
);
1078 NET_RESTORE_TPL (OldTpl
);
1085 @param Instance Pointer to the udp instance context data.
1086 @param Token Pointer to the token to be canceled, if NULL, all
1087 tokens in this instance will be cancelled.
1089 @retval EFI_SUCCESS The Token is cancelled.
1090 @retval EFI_NOT_FOUND The Token is not found.
1094 Udp4InstanceCancelToken (
1095 IN UDP4_INSTANCE_DATA
*Instance
,
1096 IN EFI_UDP4_COMPLETION_TOKEN
*Token OPTIONAL
1102 // Cancle this token from the TxTokens map.
1104 Status
= NetMapIterate (&Instance
->TxTokens
, Udp4CancelTokens
, Token
);
1106 if ((Token
!= NULL
) && (Status
== EFI_ABORTED
)) {
1108 // If Token isn't NULL and Status is EFI_ABORTED, the token is cancelled from
1109 // the TxTokens, just return success.
1115 // Try to cancel this token from the RxTokens map in condition either the Token
1116 // is NULL or the specified Token is not in TxTokens.
1118 Status
= NetMapIterate (&Instance
->RxTokens
, Udp4CancelTokens
, Token
);
1120 if ((Token
!= NULL
) && (Status
== EFI_SUCCESS
)) {
1122 // If Token isn't NULL and Status is EFI_SUCCESS, the token is neither in the
1123 // TxTokens nor the RxTokens, or say, it's not found.
1125 return EFI_NOT_FOUND
;
1128 ASSERT ((Token
!= NULL
) || ((0 == NetMapGetCount (&Instance
->TxTokens
))
1129 && (0 == NetMapGetCount (&Instance
->RxTokens
))));
1136 This function matches the received udp datagram with the Instance.
1138 @param Instance Pointer to the udp instance context data.
1139 @param Udp4Session Pointer to the EFI_UDP4_SESSION_DATA abstracted
1140 from the received udp datagram.
1142 @return The udp datagram matches the receiving requirments of the Instance or not.
1148 IN UDP4_INSTANCE_DATA
*Instance
,
1149 IN EFI_UDP4_SESSION_DATA
*Udp4Session
1152 EFI_UDP4_CONFIG_DATA
*ConfigData
;
1153 IP4_ADDR Destination
;
1155 ConfigData
= &Instance
->ConfigData
;
1157 if (ConfigData
->AcceptPromiscuous
) {
1159 // Always matches if this instance is in the promiscuous state.
1164 if ((!ConfigData
->AcceptAnyPort
&& (Udp4Session
->DestinationPort
!= ConfigData
->StationPort
)) ||
1165 ((ConfigData
->RemotePort
!= 0) && (Udp4Session
->SourcePort
!= ConfigData
->RemotePort
))) {
1167 // The local port or the remote port doesn't match.
1172 if ((EFI_IP4 (ConfigData
->RemoteAddress
) != 0) &&
1173 !EFI_IP_EQUAL (ConfigData
->RemoteAddress
, Udp4Session
->SourceAddress
)) {
1175 // This datagram doesn't come from the instance's specified sender.
1180 if ((EFI_IP4 (ConfigData
->StationAddress
) == 0) ||
1181 EFI_IP_EQUAL (Udp4Session
->DestinationAddress
, ConfigData
->StationAddress
)) {
1183 // The instance is configured to receive datagrams destinated to any station IP or
1184 // the destination address of this datagram matches the configured station IP.
1189 Destination
= EFI_IP4 (Udp4Session
->DestinationAddress
);
1191 if (IP4_IS_LOCAL_BROADCAST (Destination
) && ConfigData
->AcceptBroadcast
) {
1193 // The instance is configured to receive broadcast and this is a broadcast packet.
1198 if (IP4_IS_MULTICAST (NTOHL (Destination
)) &&
1199 (NULL
!= NetMapFindKey (&Instance
->McastIps
, (VOID
*) (UINTN
) Destination
))) {
1201 // It's a multicast packet and the multicast address is accepted by this instance.
1211 This function removes the Wrap specified by Context and release relevant resources.
1213 @param Event The Event this notify function registered to.
1214 @param Context Pointer to the context data.
1222 Udp4RecycleRxDataWrap (
1227 UDP4_RXDATA_WRAP
*Wrap
;
1229 Wrap
= (UDP4_RXDATA_WRAP
*) Context
;
1232 // Remove the Wrap from the list it belongs to.
1234 NetListRemoveEntry (&Wrap
->Link
);
1237 // Free the Packet associated with this Wrap.
1239 NetbufFree (Wrap
->Packet
);
1244 gBS
->CloseEvent (Wrap
->RxData
.RecycleSignal
);
1251 This function wraps the Packet and the RxData.
1253 @param Instance Pointer to the instance context data.
1254 @param Packet Pointer to the buffer containing the received
1256 @param RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this
1259 @return Pointer to the structure wrapping the RxData and the Packet.
1265 IN UDP4_INSTANCE_DATA
*Instance
,
1267 IN EFI_UDP4_RECEIVE_DATA
*RxData
1271 UDP4_RXDATA_WRAP
*Wrap
;
1274 // Allocate buffer for the Wrap.
1276 Wrap
= NetAllocatePool (sizeof (UDP4_RXDATA_WRAP
) +
1277 (Packet
->BlockOpNum
- 1) * sizeof (EFI_UDP4_FRAGMENT_DATA
));
1282 NetListInit (&Wrap
->Link
);
1284 CopyMem (&Wrap
->RxData
, RxData
, sizeof (EFI_UDP4_RECEIVE_DATA
));
1287 // Create the Recycle event.
1289 Status
= gBS
->CreateEvent (
1292 Udp4RecycleRxDataWrap
,
1294 &Wrap
->RxData
.RecycleSignal
1296 if (EFI_ERROR (Status
)) {
1301 Wrap
->Packet
= Packet
;
1302 Wrap
->TimeoutTick
= Instance
->ConfigData
.ReceiveTimeout
;
1309 This function enqueues the received datagram into the instances' receiving queues.
1311 @param Udp4Service Pointer to the udp service context data.
1312 @param Packet Pointer to the buffer containing the received
1314 @param RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this
1317 @return The times this datagram is enqueued.
1323 IN UDP4_SERVICE_DATA
*Udp4Service
,
1325 IN EFI_UDP4_RECEIVE_DATA
*RxData
1328 NET_LIST_ENTRY
*Entry
;
1329 UDP4_INSTANCE_DATA
*Instance
;
1330 UDP4_RXDATA_WRAP
*Wrap
;
1335 NET_LIST_FOR_EACH (Entry
, &Udp4Service
->ChildrenList
) {
1337 // Iterate the instances.
1339 Instance
= NET_LIST_USER_STRUCT (Entry
, UDP4_INSTANCE_DATA
, Link
);
1341 if (!Instance
->Configured
) {
1345 if (Udp4MatchDgram (Instance
, &RxData
->UdpSession
)) {
1347 // Wrap the RxData and put this Wrap into the instances RcvdDgramQue.
1349 CopyMem (&Wrap
, Udp4WrapRxData (Instance
, Packet
, RxData
), sizeof (UDP4_RXDATA_WRAP
));
1354 NET_GET_REF (Packet
);
1356 NetListInsertTail (&Instance
->RcvdDgramQue
, &Wrap
->Link
);
1367 This function delivers the received datagrams for the specified instance.
1369 @param Instance Pointer to the instance context data.
1375 Udp4InstanceDeliverDgram (
1376 IN UDP4_INSTANCE_DATA
*Instance
1379 UDP4_RXDATA_WRAP
*Wrap
;
1380 EFI_UDP4_COMPLETION_TOKEN
*Token
;
1382 EFI_UDP4_RECEIVE_DATA
*RxData
;
1384 if (!NetListIsEmpty (&Instance
->RcvdDgramQue
) &&
1385 !NetMapIsEmpty (&Instance
->RxTokens
)) {
1387 Wrap
= NET_LIST_HEAD (&Instance
->RcvdDgramQue
, UDP4_RXDATA_WRAP
, Link
);
1389 if (NET_BUF_SHARED (Wrap
->Packet
)) {
1391 // Duplicate the Packet if it is shared between instances.
1393 Dup
= NetbufDuplicate (Wrap
->Packet
, NULL
, 0);
1398 NetbufFree (Wrap
->Packet
);
1403 NetListRemoveHead (&Instance
->RcvdDgramQue
);
1405 Token
= (EFI_UDP4_COMPLETION_TOKEN
*) NetMapRemoveHead (&Instance
->RxTokens
, NULL
);
1408 // Build the FragmentTable and set the FragmentCount in RxData.
1410 RxData
= &Wrap
->RxData
;
1411 RxData
->FragmentCount
= Wrap
->Packet
->BlockOpNum
;
1415 (NET_FRAGMENT
*) RxData
->FragmentTable
,
1416 &RxData
->FragmentCount
1419 Token
->Status
= EFI_SUCCESS
;
1420 Token
->Packet
.RxData
= &Wrap
->RxData
;
1422 gBS
->SignalEvent (Token
->Event
);
1424 NetListInsertTail (&Instance
->DeliveredDgramQue
, &Wrap
->Link
);
1430 This function delivers the datagrams enqueued in the instances.
1432 @param Udp4Service Pointer to the udp service context data.
1440 IN UDP4_SERVICE_DATA
*Udp4Service
1443 NET_LIST_ENTRY
*Entry
;
1444 UDP4_INSTANCE_DATA
*Instance
;
1446 NET_LIST_FOR_EACH (Entry
, &Udp4Service
->ChildrenList
) {
1448 // Iterate the instances.
1450 Instance
= NET_LIST_USER_STRUCT (Entry
, UDP4_INSTANCE_DATA
, Link
);
1452 if (!Instance
->Configured
) {
1457 // Deliver the datagrams of this instance.
1459 Udp4InstanceDeliverDgram (Instance
);
1465 This function demultiplexes the received udp datagram to the apropriate instances.
1467 @param Udp4Service Pointer to the udp service context data.
1468 @param NetSession Pointer to the EFI_NET_SESSION_DATA abstrated from
1469 the received datagram.
1470 @param Packet Pointer to the buffer containing the received udp
1479 IN UDP4_SERVICE_DATA
*Udp4Service
,
1480 IN EFI_NET_SESSION_DATA
*NetSession
,
1484 EFI_UDP4_HEADER
*Udp4Header
;
1486 EFI_UDP4_RECEIVE_DATA RxData
;
1487 EFI_UDP4_SESSION_DATA
*Udp4Session
;
1491 // Get the datagram header from the packet buffer.
1493 Udp4Header
= (EFI_UDP4_HEADER
*) NetbufGetByte (Packet
, 0, NULL
);
1495 if (Udp4Header
->Checksum
!= 0) {
1497 // check the checksum.
1499 HeadSum
= NetPseudoHeadChecksum (
1506 if (Udp4Checksum (Packet
, HeadSum
) != 0) {
1514 gRT
->GetTime (&RxData
.TimeStamp
, NULL
);
1516 Udp4Session
= &RxData
.UdpSession
;
1517 EFI_IP4 (Udp4Session
->SourceAddress
) = NetSession
->Source
;
1518 EFI_IP4 (Udp4Session
->DestinationAddress
) = NetSession
->Dest
;
1519 Udp4Session
->SourcePort
= NTOHS (Udp4Header
->SrcPort
);
1520 Udp4Session
->DestinationPort
= NTOHS (Udp4Header
->DstPort
);
1523 // Trim the UDP header.
1525 NetbufTrim (Packet
, UDP4_HEADER_SIZE
, TRUE
);
1527 RxData
.DataLength
= (UINT32
) Packet
->TotalSize
;
1530 // Try to enqueue this datagram into the instances.
1532 Enqueued
= Udp4EnqueueDgram (Udp4Service
, Packet
, &RxData
);
1534 if (Enqueued
== 0) {
1536 // Send the port unreachable ICMP packet before we free this NET_BUF
1538 Udp4SendPortUnreach (Udp4Service
->IpIo
, NetSession
, Udp4Header
);
1542 // Try to free the packet before deliver it.
1544 NetbufFree (Packet
);
1548 // Deliver the datagram.
1550 Udp4DeliverDgram (Udp4Service
);
1556 This function builds and sends out a icmp port unreachable message.
1558 @param IpIo Pointer to the IP_IO instance.
1559 @param NetSession Pointer to the EFI_NET_SESSION_DATA of the packet
1560 causes this icmp error message.
1561 @param Udp4Header Pointer to the udp header of the datagram causes
1562 this icmp error message.
1569 Udp4SendPortUnreach (
1571 IN EFI_NET_SESSION_DATA
*NetSession
,
1577 IP4_ICMP_ERROR_HEAD
*IcmpErrHdr
;
1578 EFI_IP4_HEADER
*IpHdr
;
1580 IP_IO_OVERRIDE Override
;
1581 IP_IO_IP_INFO
*IpSender
;
1583 IpSender
= IpIoFindSender (&IpIo
, NetSession
->Dest
);
1584 if (IpSender
== NULL
) {
1586 // No apropriate sender, since we cannot send out the ICMP message through
1587 // the default zero station address IP instance, abort.
1592 IpHdr
= NetSession
->IpHdr
;
1595 // Calculate the requried length of the icmp error message.
1597 Len
= sizeof (IP4_ICMP_ERROR_HEAD
) + (EFI_IP4_HEADER_LEN (IpHdr
) -
1598 sizeof (IP4_HEAD
)) + ICMP_ERROR_PACKET_LENGTH
;
1601 // Allocate buffer for the icmp error message.
1603 Packet
= NetbufAlloc (Len
);
1604 if (Packet
== NULL
) {
1609 // Allocate space for the IP4_ICMP_ERROR_HEAD.
1611 IcmpErrHdr
= (IP4_ICMP_ERROR_HEAD
*) NetbufAllocSpace (Packet
, Len
, FALSE
);
1614 // Set the required fields for the icmp port unreachable message.
1616 IcmpErrHdr
->Head
.Type
= ICMP_TYPE_UNREACH
;
1617 IcmpErrHdr
->Head
.Code
= ICMP_CODE_UNREACH_PORT
;
1618 IcmpErrHdr
->Head
.Checksum
= 0;
1619 IcmpErrHdr
->Fourth
= 0;
1622 // Copy the IP header of the datagram tragged the error.
1624 NetCopyMem (&IcmpErrHdr
->IpHead
, IpHdr
, EFI_IP4_HEADER_LEN (IpHdr
));
1627 // Copy the UDP header.
1629 Ptr
= (UINT8
*) &IcmpErrHdr
->IpHead
+ EFI_IP4_HEADER_LEN (IpHdr
);
1630 NetCopyMem (Ptr
, Udp4Header
, ICMP_ERROR_PACKET_LENGTH
);
1633 // Calculate the checksum.
1635 IcmpErrHdr
->Head
.Checksum
= ~(NetbufChecksum (Packet
));
1638 // Fill the override data.
1640 Override
.DoNotFragment
= FALSE
;
1641 Override
.TypeOfService
= 0;
1642 Override
.TimeToLive
= 255;
1643 Override
.Protocol
= EFI_IP_PROTO_ICMP
;
1644 EFI_IP4 (Override
.SourceAddress
) = NetSession
->Dest
;
1645 EFI_IP4 (Override
.GatewayAddress
) = 0;
1648 // Send out this icmp packet.
1650 IpIoSend (IpIo
, Packet
, IpSender
, NULL
, NULL
, NetSession
->Source
, &Override
);
1652 NetbufFree (Packet
);
1657 This function handles the received Icmp Error message and demultiplexes it to the
1660 @param Udp4Service Pointer to the udp service context data.
1661 @param IcmpError The icmp error code.
1662 @param NetSession Pointer to the EFI_NET_SESSION_DATA abstracted
1663 from the received Icmp Error packet.
1664 @param Packet Pointer to the Icmp Error packet.
1672 IN UDP4_SERVICE_DATA
*Udp4Service
,
1673 IN ICMP_ERROR IcmpError
,
1674 IN EFI_NET_SESSION_DATA
*NetSession
,
1678 EFI_UDP4_HEADER
*Udp4Header
;
1679 EFI_UDP4_SESSION_DATA Udp4Session
;
1680 NET_LIST_ENTRY
*Entry
;
1681 UDP4_INSTANCE_DATA
*Instance
;
1683 Udp4Header
= (EFI_UDP4_HEADER
*) NetbufGetByte (Packet
, 0, NULL
);
1685 EFI_IP4 (Udp4Session
.SourceAddress
) = NetSession
->Source
;
1686 EFI_IP4 (Udp4Session
.DestinationAddress
) = NetSession
->Dest
;
1687 Udp4Session
.SourcePort
= NTOHS (Udp4Header
->DstPort
);
1688 Udp4Session
.DestinationPort
= NTOHS (Udp4Header
->SrcPort
);
1690 NET_LIST_FOR_EACH (Entry
, &Udp4Service
->ChildrenList
) {
1692 // Iterate all the instances.
1694 Instance
= NET_LIST_USER_STRUCT (Entry
, UDP4_INSTANCE_DATA
, Link
);
1696 if (!Instance
->Configured
||
1697 Instance
->ConfigData
.AcceptPromiscuous
||
1698 Instance
->ConfigData
.AcceptAnyPort
||
1699 (EFI_IP4 (Instance
->ConfigData
.StationAddress
) == 0)) {
1701 // Don't try to deliver the ICMP error to this instance if it is not configured,
1702 // or it's configured to be promiscuous or accept any port or accept all the
1708 if (Udp4MatchDgram (Instance
, &Udp4Session
)) {
1710 // Translate the Icmp Error code according to the udp spec.
1712 Instance
->IcmpError
= IpIoGetIcmpErrStatus (IcmpError
, NULL
, NULL
);
1714 if (IcmpError
> ICMP_ERR_UNREACH_PORT
) {
1715 Instance
->IcmpError
= EFI_ICMP_ERROR
;
1719 // Notify the instance with the received Icmp Error.
1721 Udp4ReportIcmpError (Instance
);
1727 NetbufFree (Packet
);
1732 This function reports the received ICMP error.
1734 @param Instance Pointer to the udp instance context data.
1740 Udp4ReportIcmpError (
1741 IN UDP4_INSTANCE_DATA
*Instance
1744 EFI_UDP4_COMPLETION_TOKEN
*Token
;
1746 if (NetMapIsEmpty (&Instance
->RxTokens
)) {
1748 // There are no receive tokens to deliver the ICMP error.
1753 if (EFI_ERROR (Instance
->IcmpError
)) {
1755 // Try to get a RxToken from the RxTokens map.
1757 Token
= (EFI_UDP4_COMPLETION_TOKEN
*) NetMapRemoveHead (&Instance
->RxTokens
, NULL
);
1759 if (Token
!= NULL
) {
1761 // Report the error through the Token.
1763 Token
->Status
= Instance
->IcmpError
;
1764 gBS
->SignalEvent (Token
->Event
);
1767 // Clear the IcmpError.
1769 Instance
->IcmpError
= EFI_SUCCESS
;
1776 This function is a dummy ext-free function for the NET_BUF created for the output
1779 @param Context Pointer to the context data.
1785 Udp4NetVectorExtFree (
1793 Set the Udp4 variable data.
1795 @param Udp4Service Udp4 service data.
1797 @retval EFI_OUT_OF_RESOURCES There are not enough resources to set the
1799 @retval other Set variable failed.
1803 Udp4SetVariableData (
1804 IN UDP4_SERVICE_DATA
*Udp4Service
1807 UINT32 NumConfiguredInstance
;
1808 NET_LIST_ENTRY
*Entry
;
1809 UINTN VariableDataSize
;
1810 EFI_UDP4_VARIABLE_DATA
*Udp4VariableData
;
1811 EFI_UDP4_SERVICE_POINT
*Udp4ServicePoint
;
1812 UDP4_INSTANCE_DATA
*Udp4Instance
;
1813 CHAR16
*NewMacString
;
1816 NumConfiguredInstance
= 0;
1819 // Go through the children list to count the configured children.
1821 NET_LIST_FOR_EACH (Entry
, &Udp4Service
->ChildrenList
) {
1822 Udp4Instance
= NET_LIST_USER_STRUCT_S (
1826 UDP4_INSTANCE_DATA_SIGNATURE
1829 if (Udp4Instance
->Configured
) {
1830 NumConfiguredInstance
++;
1835 // Calculate the size of the Udp4VariableData. As there may be no Udp4 child,
1836 // we should add extra buffer for the service points only if the number of configured
1837 // children is more than 1.
1839 VariableDataSize
= sizeof (EFI_UDP4_VARIABLE_DATA
);
1841 if (NumConfiguredInstance
> 1) {
1842 VariableDataSize
+= sizeof (EFI_UDP4_SERVICE_POINT
) * (NumConfiguredInstance
- 1);
1845 Udp4VariableData
= NetAllocatePool (VariableDataSize
);
1846 if (Udp4VariableData
== NULL
) {
1847 return EFI_OUT_OF_RESOURCES
;
1850 Udp4VariableData
->DriverHandle
= Udp4Service
->ImageHandle
;
1851 Udp4VariableData
->ServiceCount
= NumConfiguredInstance
;
1853 Udp4ServicePoint
= &Udp4VariableData
->Services
[0];
1856 // Go through the children list to fill the configured children's address pairs.
1858 NET_LIST_FOR_EACH (Entry
, &Udp4Service
->ChildrenList
) {
1859 Udp4Instance
= NET_LIST_USER_STRUCT_S (
1863 UDP4_INSTANCE_DATA_SIGNATURE
1866 if (Udp4Instance
->Configured
) {
1867 Udp4ServicePoint
->InstanceHandle
= Udp4Instance
->ChildHandle
;
1868 Udp4ServicePoint
->LocalAddress
= Udp4Instance
->ConfigData
.StationAddress
;
1869 Udp4ServicePoint
->LocalPort
= Udp4Instance
->ConfigData
.StationPort
;
1870 Udp4ServicePoint
->RemoteAddress
= Udp4Instance
->ConfigData
.RemoteAddress
;
1871 Udp4ServicePoint
->RemotePort
= Udp4Instance
->ConfigData
.RemotePort
;
1878 // Get the mac string.
1880 Status
= NetLibGetMacString (
1881 Udp4Service
->ControllerHandle
,
1882 Udp4Service
->ImageHandle
,
1885 if (EFI_ERROR (Status
)) {
1889 if (Udp4Service
->MacString
!= NULL
) {
1891 // The variable is set already, we're going to update it.
1893 if (StrCmp (Udp4Service
->MacString
, NewMacString
) != 0) {
1895 // The mac address is changed, delete the previous variable first.
1898 Udp4Service
->MacString
,
1899 &gEfiUdp4ServiceBindingProtocolGuid
,
1900 EFI_VARIABLE_BOOTSERVICE_ACCESS
,
1906 NetFreePool (Udp4Service
->MacString
);
1909 Udp4Service
->MacString
= NewMacString
;
1911 Status
= gRT
->SetVariable (
1912 Udp4Service
->MacString
,
1913 &gEfiUdp4ServiceBindingProtocolGuid
,
1914 EFI_VARIABLE_BOOTSERVICE_ACCESS
,
1916 (VOID
*) Udp4VariableData
1921 NetFreePool (Udp4VariableData
);
1928 Clear the variable and free the resource.
1930 @param Udp4Service Udp4 service data.
1936 Udp4ClearVariableData (
1937 IN UDP4_SERVICE_DATA
*Udp4Service
1940 ASSERT (Udp4Service
->MacString
!= NULL
);
1943 Udp4Service
->MacString
,
1944 &gEfiUdp4ServiceBindingProtocolGuid
,
1945 EFI_VARIABLE_BOOTSERVICE_ACCESS
,
1950 NetFreePool (Udp4Service
->MacString
);
1951 Udp4Service
->MacString
= NULL
;