4 Copyright (c) 2005 - 2012, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #include <IndustryStandard/SmBios.h>
18 #include <Protocol/DriverBinding.h>
19 #include <Protocol/ServiceBinding.h>
20 #include <Protocol/SimpleNetwork.h>
21 #include <Protocol/ManagedNetwork.h>
22 #include <Protocol/HiiConfigRouting.h>
23 #include <Protocol/ComponentName.h>
24 #include <Protocol/ComponentName2.h>
25 #include <Protocol/HiiConfigAccess.h>
27 #include <Guid/NicIp4ConfigNvData.h>
28 #include <Guid/SmBios.h>
30 #include <Library/NetLib.h>
31 #include <Library/BaseLib.h>
32 #include <Library/DebugLib.h>
33 #include <Library/BaseMemoryLib.h>
34 #include <Library/UefiBootServicesTableLib.h>
35 #include <Library/UefiRuntimeServicesTableLib.h>
36 #include <Library/MemoryAllocationLib.h>
37 #include <Library/DevicePathLib.h>
38 #include <Library/HiiLib.h>
39 #include <Library/PrintLib.h>
40 #include <Library/UefiLib.h>
42 #define NIC_ITEM_CONFIG_SIZE sizeof (NIC_IP4_CONFIG_INFO) + sizeof (EFI_IP4_ROUTE_TABLE) * MAX_IP4_CONFIG_IN_VARIABLE
43 #define DEFAULT_ZERO_START ((UINTN) ~0)
46 // All the supported IP4 maskes in host byte order.
48 GLOBAL_REMOVE_IF_UNREFERENCED IP4_ADDR gIp4AllMasks
[IP4_MASK_NUM
] = {
87 GLOBAL_REMOVE_IF_UNREFERENCED EFI_IPv4_ADDRESS mZeroIp4Addr
= {{0, 0, 0, 0}};
90 // Any error level digitally larger than mNetDebugLevelMax
91 // will be silently discarded.
93 GLOBAL_REMOVE_IF_UNREFERENCED UINTN mNetDebugLevelMax
= NETDEBUG_LEVEL_ERROR
;
94 GLOBAL_REMOVE_IF_UNREFERENCED UINT32 mSyslogPacketSeq
= 0xDEADBEEF;
97 // You can change mSyslogDstMac mSyslogDstIp and mSyslogSrcIp
98 // here to direct the syslog packets to the syslog deamon. The
99 // default is broadcast to both the ethernet and IP.
101 GLOBAL_REMOVE_IF_UNREFERENCED UINT8 mSyslogDstMac
[NET_ETHER_ADDR_LEN
] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
102 GLOBAL_REMOVE_IF_UNREFERENCED UINT32 mSyslogDstIp
= 0xffffffff;
103 GLOBAL_REMOVE_IF_UNREFERENCED UINT32 mSyslogSrcIp
= 0;
105 GLOBAL_REMOVE_IF_UNREFERENCED CHAR8
*mMonthName
[] = {
121 // VLAN device path node template
123 GLOBAL_REMOVE_IF_UNREFERENCED VLAN_DEVICE_PATH mNetVlanDevicePathTemplate
= {
125 MESSAGING_DEVICE_PATH
,
128 (UINT8
) (sizeof (VLAN_DEVICE_PATH
)),
129 (UINT8
) ((sizeof (VLAN_DEVICE_PATH
)) >> 8)
136 Locate the handles that support SNP, then open one of them
137 to send the syslog packets. The caller isn't required to close
138 the SNP after use because the SNP is opened by HandleProtocol.
140 @return The point to SNP if one is properly openned. Otherwise NULL
143 EFI_SIMPLE_NETWORK_PROTOCOL
*
148 EFI_SIMPLE_NETWORK_PROTOCOL
*Snp
;
155 // Locate the handles which has SNP installed.
158 Status
= gBS
->LocateHandleBuffer (
160 &gEfiSimpleNetworkProtocolGuid
,
166 if (EFI_ERROR (Status
) || (HandleCount
== 0)) {
171 // Try to open one of the ethernet SNP protocol to send packet
175 for (Index
= 0; Index
< HandleCount
; Index
++) {
176 Status
= gBS
->HandleProtocol (
178 &gEfiSimpleNetworkProtocolGuid
,
182 if ((Status
== EFI_SUCCESS
) && (Snp
!= NULL
) &&
183 (Snp
->Mode
->IfType
== NET_IFTYPE_ETHERNET
) &&
184 (Snp
->Mode
->MaxPacketSize
>= NET_SYSLOG_PACKET_LEN
)) {
197 Transmit a syslog packet synchronously through SNP. The Packet
198 already has the ethernet header prepended. This function should
199 fill in the source MAC because it will try to locate a SNP each
200 time it is called to avoid the problem if SNP is unloaded.
201 This code snip is copied from MNP.
203 @param[in] Packet The Syslog packet
204 @param[in] Length The length of the packet
206 @retval EFI_DEVICE_ERROR Failed to locate a usable SNP protocol
207 @retval EFI_TIMEOUT Timeout happened to send the packet.
208 @retval EFI_SUCCESS Packet is sent.
217 EFI_SIMPLE_NETWORK_PROTOCOL
*Snp
;
220 EFI_EVENT TimeoutEvent
;
223 Snp
= SyslogLocateSnp ();
226 return EFI_DEVICE_ERROR
;
229 Ether
= (ETHER_HEAD
*) Packet
;
230 CopyMem (Ether
->SrcMac
, Snp
->Mode
->CurrentAddress
.Addr
, NET_ETHER_ADDR_LEN
);
233 // Start the timeout event.
235 Status
= gBS
->CreateEvent (
243 if (EFI_ERROR (Status
)) {
247 Status
= gBS
->SetTimer (TimeoutEvent
, TimerRelative
, NET_SYSLOG_TX_TIMEOUT
);
249 if (EFI_ERROR (Status
)) {
255 // Transmit the packet through SNP.
257 Status
= Snp
->Transmit (Snp
, 0, Length
, Packet
, NULL
, NULL
, NULL
);
259 if ((Status
!= EFI_SUCCESS
) && (Status
!= EFI_NOT_READY
)) {
260 Status
= EFI_DEVICE_ERROR
;
265 // If Status is EFI_SUCCESS, the packet is put in the transmit queue.
266 // if Status is EFI_NOT_READY, the transmit engine of the network
267 // interface is busy. Both need to sync SNP.
273 // Get the recycled transmit buffer status.
275 Snp
->GetStatus (Snp
, NULL
, (VOID
**) &TxBuf
);
277 if (!EFI_ERROR (gBS
->CheckEvent (TimeoutEvent
))) {
278 Status
= EFI_TIMEOUT
;
282 } while (TxBuf
== NULL
);
284 if ((Status
== EFI_SUCCESS
) || (Status
== EFI_TIMEOUT
)) {
289 // Status is EFI_NOT_READY. Restart the timer event and
290 // call Snp->Transmit again.
292 gBS
->SetTimer (TimeoutEvent
, TimerRelative
, NET_SYSLOG_TX_TIMEOUT
);
295 gBS
->SetTimer (TimeoutEvent
, TimerCancel
, 0);
298 gBS
->CloseEvent (TimeoutEvent
);
303 Build a syslog packet, including the Ethernet/Ip/Udp headers
306 @param[in] Level Syslog servity level
307 @param[in] Module The module that generates the log
308 @param[in] File The file that contains the current log
309 @param[in] Line The line of code in the File that contains the current log
310 @param[in] Message The log message
311 @param[in] BufLen The lenght of the Buf
312 @param[out] Buf The buffer to put the packet data
314 @return The length of the syslog packet built.
330 EFI_UDP_HEADER
*Udp4
;
336 // Fill in the Ethernet header. Leave alone the source MAC.
337 // SyslogSendPacket will fill in the address for us.
339 Ether
= (ETHER_HEAD
*) Buf
;
340 CopyMem (Ether
->DstMac
, mSyslogDstMac
, NET_ETHER_ADDR_LEN
);
341 ZeroMem (Ether
->SrcMac
, NET_ETHER_ADDR_LEN
);
343 Ether
->EtherType
= HTONS (0x0800); // IPv4 protocol
345 Buf
+= sizeof (ETHER_HEAD
);
346 BufLen
-= sizeof (ETHER_HEAD
);
349 // Fill in the IP header
351 Ip4
= (IP4_HEAD
*) Buf
;
356 Ip4
->Id
= (UINT16
) mSyslogPacketSeq
;
359 Ip4
->Protocol
= 0x11;
361 Ip4
->Src
= mSyslogSrcIp
;
362 Ip4
->Dst
= mSyslogDstIp
;
364 Buf
+= sizeof (IP4_HEAD
);
365 BufLen
-= sizeof (IP4_HEAD
);
368 // Fill in the UDP header, Udp checksum is optional. Leave it zero.
370 Udp4
= (EFI_UDP_HEADER
*) Buf
;
371 Udp4
->SrcPort
= HTONS (514);
372 Udp4
->DstPort
= HTONS (514);
376 Buf
+= sizeof (EFI_UDP_HEADER
);
377 BufLen
-= sizeof (EFI_UDP_HEADER
);
380 // Build the syslog message body with <PRI> Timestamp machine module Message
382 Pri
= ((NET_SYSLOG_FACILITY
& 31) << 3) | (Level
& 7);
383 gRT
->GetTime (&Time
, NULL
);
384 ASSERT ((Time
.Month
<= 12) && (Time
.Month
>= 1));
387 // Use %a to format the ASCII strings, %s to format UNICODE strings
390 Len
+= (UINT32
) AsciiSPrint (
393 "<%d> %a %d %d:%d:%d ",
395 mMonthName
[Time
.Month
-1],
403 Len
+= (UINT32
) AsciiSPrint (
406 "Tiano %a: %a (Line: %d File: %a)",
415 // OK, patch the IP length/checksum and UDP length fields.
417 Len
+= sizeof (EFI_UDP_HEADER
);
418 Udp4
->Length
= HTONS ((UINT16
) Len
);
420 Len
+= sizeof (IP4_HEAD
);
421 Ip4
->TotalLen
= HTONS ((UINT16
) Len
);
422 Ip4
->Checksum
= (UINT16
) (~NetblockChecksum ((UINT8
*) Ip4
, sizeof (IP4_HEAD
)));
424 return Len
+ sizeof (ETHER_HEAD
);
428 Allocate a buffer, then format the message to it. This is a
429 help function for the NET_DEBUG_XXX macros. The PrintArg of
430 these macros treats the variable length print parameters as a
431 single parameter, and pass it to the NetDebugASPrint. For
432 example, NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name))
436 NETDEBUG_LEVEL_TRACE,
440 NetDebugASPrint ("State transit to %a\n", Name)
443 @param Format The ASCII format string.
444 @param ... The variable length parameter whose format is determined
445 by the Format string.
447 @return The buffer containing the formatted message,
448 or NULL if failed to allocate memory.
461 Buf
= (CHAR8
*) AllocatePool (NET_DEBUG_MSG_LEN
);
467 VA_START (Marker
, Format
);
468 AsciiVSPrint (Buf
, NET_DEBUG_MSG_LEN
, Format
, Marker
);
475 Builds an UDP4 syslog packet and send it using SNP.
477 This function will locate a instance of SNP then send the message through it.
478 Because it isn't open the SNP BY_DRIVER, apply caution when using it.
480 @param Level The servity level of the message.
481 @param Module The Moudle that generates the log.
482 @param File The file that contains the log.
483 @param Line The exact line that contains the log.
484 @param Message The user message to log.
486 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
487 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the packet
488 @retval EFI_SUCCESS The log is discard because that it is more verbose
489 than the mNetDebugLevelMax. Or, it has been sent out.
506 // Check whether the message should be sent out
508 if (Message
== NULL
) {
509 return EFI_INVALID_PARAMETER
;
512 if (Level
> mNetDebugLevelMax
) {
513 Status
= EFI_SUCCESS
;
518 // Allocate a maxium of 1024 bytes, the caller should ensure
519 // that the message plus the ethernet/ip/udp header is shorter
522 Packet
= (CHAR8
*) AllocatePool (NET_SYSLOG_PACKET_LEN
);
524 if (Packet
== NULL
) {
525 Status
= EFI_OUT_OF_RESOURCES
;
530 // Build the message: Ethernet header + IP header + Udp Header + user data
532 Len
= SyslogBuildPacket (
538 NET_SYSLOG_PACKET_LEN
,
543 Status
= SyslogSendPacket (Packet
, Len
);
551 Return the length of the mask.
553 Return the length of the mask, the correct value is from 0 to 32.
554 If the mask is invalid, return the invalid length 33, which is IP4_MASK_NUM.
555 NetMask is in the host byte order.
557 @param[in] NetMask The netmask to get the length from.
559 @return The length of the netmask, IP4_MASK_NUM if the mask is invalid.
570 for (Index
= 0; Index
< IP4_MASK_NUM
; Index
++) {
571 if (NetMask
== gIp4AllMasks
[Index
]) {
582 Return the class of the IP address, such as class A, B, C.
583 Addr is in host byte order.
585 The address of class A starts with 0.
586 If the address belong to class A, return IP4_ADDR_CLASSA.
587 The address of class B starts with 10.
588 If the address belong to class B, return IP4_ADDR_CLASSB.
589 The address of class C starts with 110.
590 If the address belong to class C, return IP4_ADDR_CLASSC.
591 The address of class D starts with 1110.
592 If the address belong to class D, return IP4_ADDR_CLASSD.
593 The address of class E starts with 1111.
594 If the address belong to class E, return IP4_ADDR_CLASSE.
597 @param[in] Addr The address to get the class from.
599 @return IP address class, such as IP4_ADDR_CLASSA.
610 ByteOne
= (UINT8
) (Addr
>> 24);
612 if ((ByteOne
& 0x80) == 0) {
613 return IP4_ADDR_CLASSA
;
615 } else if ((ByteOne
& 0xC0) == 0x80) {
616 return IP4_ADDR_CLASSB
;
618 } else if ((ByteOne
& 0xE0) == 0xC0) {
619 return IP4_ADDR_CLASSC
;
621 } else if ((ByteOne
& 0xF0) == 0xE0) {
622 return IP4_ADDR_CLASSD
;
625 return IP4_ADDR_CLASSE
;
632 Check whether the IP is a valid unicast address according to
633 the netmask. If NetMask is zero, use the IP address's class to get the default mask.
635 If Ip is 0, IP is not a valid unicast address.
636 Class D address is used for multicasting and class E address is reserved for future. If Ip
637 belongs to class D or class E, IP is not a valid unicast address.
638 If all bits of the host address of IP are 0 or 1, IP is also not a valid unicast address.
640 @param[in] Ip The IP to check against.
641 @param[in] NetMask The mask of the IP.
643 @return TRUE if IP is a valid unicast address on the network, otherwise FALSE.
655 Class
= NetGetIpClass (Ip
);
657 if ((Ip
== 0) || (Class
>= IP4_ADDR_CLASSD
)) {
662 NetMask
= gIp4AllMasks
[Class
<< 3];
665 if (((Ip
&~NetMask
) == ~NetMask
) || ((Ip
&~NetMask
) == 0)) {
673 Check whether the incoming IPv6 address is a valid unicast address.
675 If the address is a multicast address has binary 0xFF at the start, it is not
676 a valid unicast address. If the address is unspecified ::, it is not a valid
677 unicast address to be assigned to any node. If the address is loopback address
678 ::1, it is also not a valid unicast address to be assigned to any physical
681 @param[in] Ip6 The IPv6 address to check against.
683 @return TRUE if Ip6 is a valid unicast address on the network, otherwise FALSE.
688 NetIp6IsValidUnicast (
689 IN EFI_IPv6_ADDRESS
*Ip6
695 if (Ip6
->Addr
[0] == 0xFF) {
699 for (Index
= 0; Index
< 15; Index
++) {
700 if (Ip6
->Addr
[Index
] != 0) {
705 Byte
= Ip6
->Addr
[Index
];
707 if (Byte
== 0x0 || Byte
== 0x1) {
715 Check whether the incoming Ipv6 address is the unspecified address or not.
717 @param[in] Ip6 - Ip6 address, in network order.
719 @retval TRUE - Yes, unspecified
725 NetIp6IsUnspecifiedAddr (
726 IN EFI_IPv6_ADDRESS
*Ip6
731 for (Index
= 0; Index
< 16; Index
++) {
732 if (Ip6
->Addr
[Index
] != 0) {
741 Check whether the incoming Ipv6 address is a link-local address.
743 @param[in] Ip6 - Ip6 address, in network order.
745 @retval TRUE - Yes, link-local address
751 NetIp6IsLinkLocalAddr (
752 IN EFI_IPv6_ADDRESS
*Ip6
757 ASSERT (Ip6
!= NULL
);
759 if (Ip6
->Addr
[0] != 0xFE) {
763 if (Ip6
->Addr
[1] != 0x80) {
767 for (Index
= 2; Index
< 8; Index
++) {
768 if (Ip6
->Addr
[Index
] != 0) {
777 Check whether the Ipv6 address1 and address2 are on the connected network.
779 @param[in] Ip1 - Ip6 address1, in network order.
780 @param[in] Ip2 - Ip6 address2, in network order.
781 @param[in] PrefixLength - The prefix length of the checking net.
783 @retval TRUE - Yes, connected.
790 EFI_IPv6_ADDRESS
*Ip1
,
791 EFI_IPv6_ADDRESS
*Ip2
,
799 ASSERT ((Ip1
!= NULL
) && (Ip2
!= NULL
) && (PrefixLength
< IP6_PREFIX_NUM
));
801 if (PrefixLength
== 0) {
805 Byte
= (UINT8
) (PrefixLength
/ 8);
806 Bit
= (UINT8
) (PrefixLength
% 8);
808 if (CompareMem (Ip1
, Ip2
, Byte
) != 0) {
813 Mask
= (UINT8
) (0xFF << (8 - Bit
));
816 if ((Ip1
->Addr
[Byte
] & Mask
) != (Ip2
->Addr
[Byte
] & Mask
)) {
826 Switches the endianess of an IPv6 address
828 This function swaps the bytes in a 128-bit IPv6 address to switch the value
829 from little endian to big endian or vice versa. The byte swapped value is
832 @param Ip6 Points to an IPv6 address
834 @return The byte swapped IPv6 address.
840 EFI_IPv6_ADDRESS
*Ip6
846 CopyMem (&High
, Ip6
, sizeof (UINT64
));
847 CopyMem (&Low
, &Ip6
->Addr
[8], sizeof (UINT64
));
849 High
= SwapBytes64 (High
);
850 Low
= SwapBytes64 (Low
);
852 CopyMem (Ip6
, &Low
, sizeof (UINT64
));
853 CopyMem (&Ip6
->Addr
[8], &High
, sizeof (UINT64
));
859 Initialize a random seed using current time.
861 Get current time first. Then initialize a random seed based on some basic
862 mathematics operation on the hour, day, minute, second, nanosecond and year
865 @return The random seed initialized with current time.
877 gRT
->GetTime (&Time
, NULL
);
878 Seed
= (~Time
.Hour
<< 24 | Time
.Day
<< 16 | Time
.Minute
<< 8 | Time
.Second
);
879 Seed
^= Time
.Nanosecond
;
880 Seed
^= Time
.Year
<< 7;
887 Extract a UINT32 from a byte stream.
889 Copy a UINT32 from a byte stream, then converts it from Network
890 byte order to host byte order. Use this function to avoid alignment error.
892 @param[in] Buf The buffer to extract the UINT32.
894 @return The UINT32 extracted.
905 CopyMem (&Value
, Buf
, sizeof (UINT32
));
906 return NTOHL (Value
);
911 Put a UINT32 to the byte stream in network byte order.
913 Converts a UINT32 from host byte order to network byte order. Then copy it to the
916 @param[in, out] Buf The buffer to put the UINT32.
917 @param[in] Data The data to be converted and put into the byte stream.
928 CopyMem (Buf
, &Data
, sizeof (UINT32
));
933 Remove the first node entry on the list, and return the removed node entry.
935 Removes the first node Entry from a doubly linked list. It is up to the caller of
936 this function to release the memory used by the first node if that is required. On
937 exit, the removed node is returned.
939 If Head is NULL, then ASSERT().
940 If Head was not initialized, then ASSERT().
941 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
942 linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,
945 @param[in, out] Head The list header.
947 @return The first node entry that is removed from the list, NULL if the list is empty.
953 IN OUT LIST_ENTRY
*Head
958 ASSERT (Head
!= NULL
);
960 if (IsListEmpty (Head
)) {
964 First
= Head
->ForwardLink
;
965 Head
->ForwardLink
= First
->ForwardLink
;
966 First
->ForwardLink
->BackLink
= Head
;
969 First
->ForwardLink
= (LIST_ENTRY
*) NULL
;
970 First
->BackLink
= (LIST_ENTRY
*) NULL
;
978 Remove the last node entry on the list and and return the removed node entry.
980 Removes the last node entry from a doubly linked list. It is up to the caller of
981 this function to release the memory used by the first node if that is required. On
982 exit, the removed node is returned.
984 If Head is NULL, then ASSERT().
985 If Head was not initialized, then ASSERT().
986 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
987 linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,
990 @param[in, out] Head The list head.
992 @return The last node entry that is removed from the list, NULL if the list is empty.
998 IN OUT LIST_ENTRY
*Head
1003 ASSERT (Head
!= NULL
);
1005 if (IsListEmpty (Head
)) {
1009 Last
= Head
->BackLink
;
1010 Head
->BackLink
= Last
->BackLink
;
1011 Last
->BackLink
->ForwardLink
= Head
;
1014 Last
->ForwardLink
= (LIST_ENTRY
*) NULL
;
1015 Last
->BackLink
= (LIST_ENTRY
*) NULL
;
1023 Insert a new node entry after a designated node entry of a doubly linked list.
1025 Inserts a new node entry donated by NewEntry after the node entry donated by PrevEntry
1026 of the doubly linked list.
1028 @param[in, out] PrevEntry The previous entry to insert after.
1029 @param[in, out] NewEntry The new entry to insert.
1034 NetListInsertAfter (
1035 IN OUT LIST_ENTRY
*PrevEntry
,
1036 IN OUT LIST_ENTRY
*NewEntry
1039 NewEntry
->BackLink
= PrevEntry
;
1040 NewEntry
->ForwardLink
= PrevEntry
->ForwardLink
;
1041 PrevEntry
->ForwardLink
->BackLink
= NewEntry
;
1042 PrevEntry
->ForwardLink
= NewEntry
;
1047 Insert a new node entry before a designated node entry of a doubly linked list.
1049 Inserts a new node entry donated by NewEntry after the node entry donated by PostEntry
1050 of the doubly linked list.
1052 @param[in, out] PostEntry The entry to insert before.
1053 @param[in, out] NewEntry The new entry to insert.
1058 NetListInsertBefore (
1059 IN OUT LIST_ENTRY
*PostEntry
,
1060 IN OUT LIST_ENTRY
*NewEntry
1063 NewEntry
->ForwardLink
= PostEntry
;
1064 NewEntry
->BackLink
= PostEntry
->BackLink
;
1065 PostEntry
->BackLink
->ForwardLink
= NewEntry
;
1066 PostEntry
->BackLink
= NewEntry
;
1070 Safe destroy nodes in a linked list, and return the length of the list after all possible operations finished.
1072 Destroy network child instance list by list traversals is not safe due to graph dependencies between nodes.
1073 This function performs a safe traversal to destroy these nodes by checking to see if the node being destroyed
1074 has been removed from the list or not.
1075 If it has been removed, then restart the traversal from the head.
1076 If it hasn't been removed, then continue with the next node directly.
1077 This function will end the iterate and return the CallBack's last return value if error happens,
1078 or retrun EFI_SUCCESS if 2 complete passes are made with no changes in the number of children in the list.
1080 @param[in] List The head of the list.
1081 @param[in] CallBack Pointer to the callback function to destroy one node in the list.
1082 @param[in] Context Pointer to the callback function's context: corresponds to the
1083 parameter Context in NET_DESTROY_LINK_LIST_CALLBACK.
1084 @param[out] ListLength The length of the link list if the function returns successfully.
1086 @retval EFI_SUCCESS Two complete passes are made with no changes in the number of children.
1087 @retval EFI_INVALID_PARAMETER The input parameter is invalid.
1088 @retval Others Return the CallBack's last return value.
1093 NetDestroyLinkList (
1094 IN LIST_ENTRY
*List
,
1095 IN NET_DESTROY_LINK_LIST_CALLBACK CallBack
,
1096 IN VOID
*Context
, OPTIONAL
1097 OUT UINTN
*ListLength OPTIONAL
1100 UINTN PreviousLength
;
1106 if (List
== NULL
|| CallBack
== NULL
) {
1107 return EFI_INVALID_PARAMETER
;
1112 PreviousLength
= Length
;
1113 Entry
= GetFirstNode (List
);
1114 while (!IsNull (List
, Entry
)) {
1115 Status
= CallBack (Entry
, Context
);
1116 if (EFI_ERROR (Status
)) {
1120 // Walk through the list to see whether the Entry has been removed or not.
1121 // If the Entry still exists, just try to destroy the next one.
1122 // If not, go back to the start point to iterate the list again.
1124 for (Ptr
= List
->ForwardLink
; Ptr
!= List
; Ptr
= Ptr
->ForwardLink
) {
1130 Entry
= GetNextNode (List
, Entry
);
1132 Entry
= GetFirstNode (List
);
1135 for (Length
= 0, Ptr
= List
->ForwardLink
; Ptr
!= List
; Length
++, Ptr
= Ptr
->ForwardLink
);
1136 } while (Length
!= PreviousLength
);
1138 if (ListLength
!= NULL
) {
1139 *ListLength
= Length
;
1145 This function checks the input Handle to see if it's one of these handles in ChildHandleBuffer.
1147 @param[in] Handle Handle to be checked.
1148 @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer.
1149 @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL
1150 if NumberOfChildren is 0.
1152 @retval TURE Found the input Handle in ChildHandleBuffer.
1153 @retval FALSE Can't find the input Handle in ChildHandleBuffer.
1158 NetIsInHandleBuffer (
1159 IN EFI_HANDLE Handle
,
1160 IN UINTN NumberOfChildren
,
1161 IN EFI_HANDLE
*ChildHandleBuffer OPTIONAL
1166 if (NumberOfChildren
== 0 || ChildHandleBuffer
== NULL
) {
1170 for (Index
= 0; Index
< NumberOfChildren
; Index
++) {
1171 if (Handle
== ChildHandleBuffer
[Index
]) {
1181 Initialize the netmap. Netmap is a reposity to keep the <Key, Value> pairs.
1183 Initialize the forward and backward links of two head nodes donated by Map->Used
1184 and Map->Recycled of two doubly linked lists.
1185 Initializes the count of the <Key, Value> pairs in the netmap to zero.
1187 If Map is NULL, then ASSERT().
1188 If the address of Map->Used is NULL, then ASSERT().
1189 If the address of Map->Recycled is NULl, then ASSERT().
1191 @param[in, out] Map The netmap to initialize.
1200 ASSERT (Map
!= NULL
);
1202 InitializeListHead (&Map
->Used
);
1203 InitializeListHead (&Map
->Recycled
);
1209 To clean up the netmap, that is, release allocated memories.
1211 Removes all nodes of the Used doubly linked list and free memory of all related netmap items.
1212 Removes all nodes of the Recycled doubly linked list and free memory of all related netmap items.
1213 The number of the <Key, Value> pairs in the netmap is set to be zero.
1215 If Map is NULL, then ASSERT().
1217 @param[in, out] Map The netmap to clean up.
1230 ASSERT (Map
!= NULL
);
1232 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, &Map
->Used
) {
1233 Item
= NET_LIST_USER_STRUCT (Entry
, NET_MAP_ITEM
, Link
);
1235 RemoveEntryList (&Item
->Link
);
1238 gBS
->FreePool (Item
);
1241 ASSERT ((Map
->Count
== 0) && IsListEmpty (&Map
->Used
));
1243 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, &Map
->Recycled
) {
1244 Item
= NET_LIST_USER_STRUCT (Entry
, NET_MAP_ITEM
, Link
);
1246 RemoveEntryList (&Item
->Link
);
1247 gBS
->FreePool (Item
);
1250 ASSERT (IsListEmpty (&Map
->Recycled
));
1255 Test whether the netmap is empty and return true if it is.
1257 If the number of the <Key, Value> pairs in the netmap is zero, return TRUE.
1259 If Map is NULL, then ASSERT().
1262 @param[in] Map The net map to test.
1264 @return TRUE if the netmap is empty, otherwise FALSE.
1273 ASSERT (Map
!= NULL
);
1274 return (BOOLEAN
) (Map
->Count
== 0);
1279 Return the number of the <Key, Value> pairs in the netmap.
1281 @param[in] Map The netmap to get the entry number.
1283 @return The entry number in the netmap.
1297 Return one allocated item.
1299 If the Recycled doubly linked list of the netmap is empty, it will try to allocate
1300 a batch of items if there are enough resources and add corresponding nodes to the begining
1301 of the Recycled doubly linked list of the netmap. Otherwise, it will directly remove
1302 the fist node entry of the Recycled doubly linked list and return the corresponding item.
1304 If Map is NULL, then ASSERT().
1306 @param[in, out] Map The netmap to allocate item for.
1308 @return The allocated item. If NULL, the
1309 allocation failed due to resource limit.
1321 ASSERT (Map
!= NULL
);
1323 Head
= &Map
->Recycled
;
1325 if (IsListEmpty (Head
)) {
1326 for (Index
= 0; Index
< NET_MAP_INCREAMENT
; Index
++) {
1327 Item
= AllocatePool (sizeof (NET_MAP_ITEM
));
1337 InsertHeadList (Head
, &Item
->Link
);
1341 Item
= NET_LIST_HEAD (Head
, NET_MAP_ITEM
, Link
);
1342 NetListRemoveHead (Head
);
1349 Allocate an item to save the <Key, Value> pair to the head of the netmap.
1351 Allocate an item to save the <Key, Value> pair and add corresponding node entry
1352 to the beginning of the Used doubly linked list. The number of the <Key, Value>
1353 pairs in the netmap increase by 1.
1355 If Map is NULL, then ASSERT().
1357 @param[in, out] Map The netmap to insert into.
1358 @param[in] Key The user's key.
1359 @param[in] Value The user's value for the key.
1361 @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.
1362 @retval EFI_SUCCESS The item is inserted to the head.
1368 IN OUT NET_MAP
*Map
,
1370 IN VOID
*Value OPTIONAL
1375 ASSERT (Map
!= NULL
);
1377 Item
= NetMapAllocItem (Map
);
1380 return EFI_OUT_OF_RESOURCES
;
1384 Item
->Value
= Value
;
1385 InsertHeadList (&Map
->Used
, &Item
->Link
);
1393 Allocate an item to save the <Key, Value> pair to the tail of the netmap.
1395 Allocate an item to save the <Key, Value> pair and add corresponding node entry
1396 to the tail of the Used doubly linked list. The number of the <Key, Value>
1397 pairs in the netmap increase by 1.
1399 If Map is NULL, then ASSERT().
1401 @param[in, out] Map The netmap to insert into.
1402 @param[in] Key The user's key.
1403 @param[in] Value The user's value for the key.
1405 @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.
1406 @retval EFI_SUCCESS The item is inserted to the tail.
1412 IN OUT NET_MAP
*Map
,
1414 IN VOID
*Value OPTIONAL
1419 ASSERT (Map
!= NULL
);
1421 Item
= NetMapAllocItem (Map
);
1424 return EFI_OUT_OF_RESOURCES
;
1428 Item
->Value
= Value
;
1429 InsertTailList (&Map
->Used
, &Item
->Link
);
1438 Check whether the item is in the Map and return TRUE if it is.
1440 @param[in] Map The netmap to search within.
1441 @param[in] Item The item to search.
1443 @return TRUE if the item is in the netmap, otherwise FALSE.
1449 IN NET_MAP_ITEM
*Item
1452 LIST_ENTRY
*ListEntry
;
1454 NET_LIST_FOR_EACH (ListEntry
, &Map
->Used
) {
1455 if (ListEntry
== &Item
->Link
) {
1465 Find the key in the netmap and returns the point to the item contains the Key.
1467 Iterate the Used doubly linked list of the netmap to get every item. Compare the key of every
1468 item with the key to search. It returns the point to the item contains the Key if found.
1470 If Map is NULL, then ASSERT().
1472 @param[in] Map The netmap to search within.
1473 @param[in] Key The key to search.
1475 @return The point to the item contains the Key, or NULL if Key isn't in the map.
1488 ASSERT (Map
!= NULL
);
1490 NET_LIST_FOR_EACH (Entry
, &Map
->Used
) {
1491 Item
= NET_LIST_USER_STRUCT (Entry
, NET_MAP_ITEM
, Link
);
1493 if (Item
->Key
== Key
) {
1503 Remove the node entry of the item from the netmap and return the key of the removed item.
1505 Remove the node entry of the item from the Used doubly linked list of the netmap.
1506 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
1507 entry of the item to the Recycled doubly linked list of the netmap. If Value is not NULL,
1508 Value will point to the value of the item. It returns the key of the removed item.
1510 If Map is NULL, then ASSERT().
1511 If Item is NULL, then ASSERT().
1512 if item in not in the netmap, then ASSERT().
1514 @param[in, out] Map The netmap to remove the item from.
1515 @param[in, out] Item The item to remove.
1516 @param[out] Value The variable to receive the value if not NULL.
1518 @return The key of the removed item.
1524 IN OUT NET_MAP
*Map
,
1525 IN OUT NET_MAP_ITEM
*Item
,
1526 OUT VOID
**Value OPTIONAL
1529 ASSERT ((Map
!= NULL
) && (Item
!= NULL
));
1530 ASSERT (NetItemInMap (Map
, Item
));
1532 RemoveEntryList (&Item
->Link
);
1534 InsertHeadList (&Map
->Recycled
, &Item
->Link
);
1536 if (Value
!= NULL
) {
1537 *Value
= Item
->Value
;
1545 Remove the first node entry on the netmap and return the key of the removed item.
1547 Remove the first node entry from the Used doubly linked list of the netmap.
1548 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
1549 entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,
1550 parameter Value will point to the value of the item. It returns the key of the removed item.
1552 If Map is NULL, then ASSERT().
1553 If the Used doubly linked list is empty, then ASSERT().
1555 @param[in, out] Map The netmap to remove the head from.
1556 @param[out] Value The variable to receive the value if not NULL.
1558 @return The key of the item removed.
1564 IN OUT NET_MAP
*Map
,
1565 OUT VOID
**Value OPTIONAL
1571 // Often, it indicates a programming error to remove
1572 // the first entry in an empty list
1574 ASSERT (Map
&& !IsListEmpty (&Map
->Used
));
1576 Item
= NET_LIST_HEAD (&Map
->Used
, NET_MAP_ITEM
, Link
);
1577 RemoveEntryList (&Item
->Link
);
1579 InsertHeadList (&Map
->Recycled
, &Item
->Link
);
1581 if (Value
!= NULL
) {
1582 *Value
= Item
->Value
;
1590 Remove the last node entry on the netmap and return the key of the removed item.
1592 Remove the last node entry from the Used doubly linked list of the netmap.
1593 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
1594 entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,
1595 parameter Value will point to the value of the item. It returns the key of the removed item.
1597 If Map is NULL, then ASSERT().
1598 If the Used doubly linked list is empty, then ASSERT().
1600 @param[in, out] Map The netmap to remove the tail from.
1601 @param[out] Value The variable to receive the value if not NULL.
1603 @return The key of the item removed.
1609 IN OUT NET_MAP
*Map
,
1610 OUT VOID
**Value OPTIONAL
1616 // Often, it indicates a programming error to remove
1617 // the last entry in an empty list
1619 ASSERT (Map
&& !IsListEmpty (&Map
->Used
));
1621 Item
= NET_LIST_TAIL (&Map
->Used
, NET_MAP_ITEM
, Link
);
1622 RemoveEntryList (&Item
->Link
);
1624 InsertHeadList (&Map
->Recycled
, &Item
->Link
);
1626 if (Value
!= NULL
) {
1627 *Value
= Item
->Value
;
1635 Iterate through the netmap and call CallBack for each item.
1637 It will contiue the traverse if CallBack returns EFI_SUCCESS, otherwise, break
1638 from the loop. It returns the CallBack's last return value. This function is
1639 delete safe for the current item.
1641 If Map is NULL, then ASSERT().
1642 If CallBack is NULL, then ASSERT().
1644 @param[in] Map The Map to iterate through.
1645 @param[in] CallBack The callback function to call for each item.
1646 @param[in] Arg The opaque parameter to the callback.
1648 @retval EFI_SUCCESS There is no item in the netmap or CallBack for each item
1650 @retval Others It returns the CallBack's last return value.
1657 IN NET_MAP_CALLBACK CallBack
,
1658 IN VOID
*Arg OPTIONAL
1668 ASSERT ((Map
!= NULL
) && (CallBack
!= NULL
));
1672 if (IsListEmpty (Head
)) {
1676 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, Head
) {
1677 Item
= NET_LIST_USER_STRUCT (Entry
, NET_MAP_ITEM
, Link
);
1678 Result
= CallBack (Map
, Item
, Arg
);
1680 if (EFI_ERROR (Result
)) {
1690 Internal function to get the child handle of the NIC handle.
1692 @param[in] Controller NIC controller handle.
1693 @param[out] ChildHandle Returned child handle.
1695 @retval EFI_SUCCESS Successfully to get child handle.
1696 @retval Others Failed to get child handle.
1701 IN EFI_HANDLE Controller
,
1702 OUT EFI_HANDLE
*ChildHandle
1706 EFI_HANDLE
*Handles
;
1709 EFI_DEVICE_PATH_PROTOCOL
*ChildDeviceDevicePath
;
1710 VENDOR_DEVICE_PATH
*VendorDeviceNode
;
1713 // Locate all EFI Hii Config Access protocols
1715 Status
= gBS
->LocateHandleBuffer (
1717 &gEfiHiiConfigAccessProtocolGuid
,
1722 if (EFI_ERROR (Status
) || (HandleCount
== 0)) {
1726 Status
= EFI_NOT_FOUND
;
1728 for (Index
= 0; Index
< HandleCount
; Index
++) {
1730 Status
= EfiTestChildHandle (Controller
, Handles
[Index
], &gEfiManagedNetworkServiceBindingProtocolGuid
);
1731 if (!EFI_ERROR (Status
)) {
1733 // Get device path on the child handle
1735 Status
= gBS
->HandleProtocol (
1737 &gEfiDevicePathProtocolGuid
,
1738 (VOID
**) &ChildDeviceDevicePath
1741 if (!EFI_ERROR (Status
)) {
1742 while (!IsDevicePathEnd (ChildDeviceDevicePath
)) {
1743 ChildDeviceDevicePath
= NextDevicePathNode (ChildDeviceDevicePath
);
1745 // Parse one instance
1747 if (ChildDeviceDevicePath
->Type
== HARDWARE_DEVICE_PATH
&&
1748 ChildDeviceDevicePath
->SubType
== HW_VENDOR_DP
) {
1749 VendorDeviceNode
= (VENDOR_DEVICE_PATH
*) ChildDeviceDevicePath
;
1750 if (CompareMem (&VendorDeviceNode
->Guid
, &gEfiNicIp4ConfigVariableGuid
, sizeof (EFI_GUID
)) == 0) {
1752 // Found item matched gEfiNicIp4ConfigVariableGuid
1754 *ChildHandle
= Handles
[Index
];
1770 This is the default unload handle for all the network drivers.
1772 Disconnect the driver specified by ImageHandle from all the devices in the handle database.
1773 Uninstall all the protocols installed in the driver entry point.
1775 @param[in] ImageHandle The drivers' driver image.
1777 @retval EFI_SUCCESS The image is unloaded.
1778 @retval Others Failed to unload the image.
1783 NetLibDefaultUnload (
1784 IN EFI_HANDLE ImageHandle
1788 EFI_HANDLE
*DeviceHandleBuffer
;
1789 UINTN DeviceHandleCount
;
1791 EFI_DRIVER_BINDING_PROTOCOL
*DriverBinding
;
1792 EFI_COMPONENT_NAME_PROTOCOL
*ComponentName
;
1793 EFI_COMPONENT_NAME2_PROTOCOL
*ComponentName2
;
1796 // Get the list of all the handles in the handle database.
1797 // If there is an error getting the list, then the unload
1800 Status
= gBS
->LocateHandleBuffer (
1808 if (EFI_ERROR (Status
)) {
1813 // Disconnect the driver specified by ImageHandle from all
1814 // the devices in the handle database.
1816 for (Index
= 0; Index
< DeviceHandleCount
; Index
++) {
1817 Status
= gBS
->DisconnectController (
1818 DeviceHandleBuffer
[Index
],
1825 // Uninstall all the protocols installed in the driver entry point
1827 for (Index
= 0; Index
< DeviceHandleCount
; Index
++) {
1828 Status
= gBS
->HandleProtocol (
1829 DeviceHandleBuffer
[Index
],
1830 &gEfiDriverBindingProtocolGuid
,
1831 (VOID
**) &DriverBinding
1834 if (EFI_ERROR (Status
)) {
1838 if (DriverBinding
->ImageHandle
!= ImageHandle
) {
1842 gBS
->UninstallProtocolInterface (
1844 &gEfiDriverBindingProtocolGuid
,
1847 Status
= gBS
->HandleProtocol (
1848 DeviceHandleBuffer
[Index
],
1849 &gEfiComponentNameProtocolGuid
,
1850 (VOID
**) &ComponentName
1852 if (!EFI_ERROR (Status
)) {
1853 gBS
->UninstallProtocolInterface (
1855 &gEfiComponentNameProtocolGuid
,
1860 Status
= gBS
->HandleProtocol (
1861 DeviceHandleBuffer
[Index
],
1862 &gEfiComponentName2ProtocolGuid
,
1863 (VOID
**) &ComponentName2
1865 if (!EFI_ERROR (Status
)) {
1866 gBS
->UninstallProtocolInterface (
1868 &gEfiComponentName2ProtocolGuid
,
1875 // Free the buffer containing the list of handles from the handle database
1877 if (DeviceHandleBuffer
!= NULL
) {
1878 gBS
->FreePool (DeviceHandleBuffer
);
1887 Create a child of the service that is identified by ServiceBindingGuid.
1889 Get the ServiceBinding Protocol first, then use it to create a child.
1891 If ServiceBindingGuid is NULL, then ASSERT().
1892 If ChildHandle is NULL, then ASSERT().
1894 @param[in] Controller The controller which has the service installed.
1895 @param[in] Image The image handle used to open service.
1896 @param[in] ServiceBindingGuid The service's Guid.
1897 @param[in, out] ChildHandle The handle to receive the create child.
1899 @retval EFI_SUCCESS The child is successfully created.
1900 @retval Others Failed to create the child.
1905 NetLibCreateServiceChild (
1906 IN EFI_HANDLE Controller
,
1907 IN EFI_HANDLE Image
,
1908 IN EFI_GUID
*ServiceBindingGuid
,
1909 IN OUT EFI_HANDLE
*ChildHandle
1913 EFI_SERVICE_BINDING_PROTOCOL
*Service
;
1916 ASSERT ((ServiceBindingGuid
!= NULL
) && (ChildHandle
!= NULL
));
1919 // Get the ServiceBinding Protocol
1921 Status
= gBS
->OpenProtocol (
1927 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1930 if (EFI_ERROR (Status
)) {
1937 Status
= Service
->CreateChild (Service
, ChildHandle
);
1943 Destroy a child of the service that is identified by ServiceBindingGuid.
1945 Get the ServiceBinding Protocol first, then use it to destroy a child.
1947 If ServiceBindingGuid is NULL, then ASSERT().
1949 @param[in] Controller The controller which has the service installed.
1950 @param[in] Image The image handle used to open service.
1951 @param[in] ServiceBindingGuid The service's Guid.
1952 @param[in] ChildHandle The child to destroy.
1954 @retval EFI_SUCCESS The child is successfully destroyed.
1955 @retval Others Failed to destroy the child.
1960 NetLibDestroyServiceChild (
1961 IN EFI_HANDLE Controller
,
1962 IN EFI_HANDLE Image
,
1963 IN EFI_GUID
*ServiceBindingGuid
,
1964 IN EFI_HANDLE ChildHandle
1968 EFI_SERVICE_BINDING_PROTOCOL
*Service
;
1970 ASSERT (ServiceBindingGuid
!= NULL
);
1973 // Get the ServiceBinding Protocol
1975 Status
= gBS
->OpenProtocol (
1981 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1984 if (EFI_ERROR (Status
)) {
1989 // destroy the child
1991 Status
= Service
->DestroyChild (Service
, ChildHandle
);
1996 Get handle with Simple Network Protocol installed on it.
1998 There should be MNP Service Binding Protocol installed on the input ServiceHandle.
1999 If Simple Network Protocol is already installed on the ServiceHandle, the
2000 ServiceHandle will be returned. If SNP is not installed on the ServiceHandle,
2001 try to find its parent handle with SNP installed.
2003 @param[in] ServiceHandle The handle where network service binding protocols are
2005 @param[out] Snp The pointer to store the address of the SNP instance.
2006 This is an optional parameter that may be NULL.
2008 @return The SNP handle, or NULL if not found.
2013 NetLibGetSnpHandle (
2014 IN EFI_HANDLE ServiceHandle
,
2015 OUT EFI_SIMPLE_NETWORK_PROTOCOL
**Snp OPTIONAL
2019 EFI_SIMPLE_NETWORK_PROTOCOL
*SnpInstance
;
2020 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2021 EFI_HANDLE SnpHandle
;
2024 // Try to open SNP from ServiceHandle
2027 Status
= gBS
->HandleProtocol (ServiceHandle
, &gEfiSimpleNetworkProtocolGuid
, (VOID
**) &SnpInstance
);
2028 if (!EFI_ERROR (Status
)) {
2032 return ServiceHandle
;
2036 // Failed to open SNP, try to get SNP handle by LocateDevicePath()
2038 DevicePath
= DevicePathFromHandle (ServiceHandle
);
2039 if (DevicePath
== NULL
) {
2044 Status
= gBS
->LocateDevicePath (&gEfiSimpleNetworkProtocolGuid
, &DevicePath
, &SnpHandle
);
2045 if (EFI_ERROR (Status
)) {
2047 // Failed to find SNP handle
2052 Status
= gBS
->HandleProtocol (SnpHandle
, &gEfiSimpleNetworkProtocolGuid
, (VOID
**) &SnpInstance
);
2053 if (!EFI_ERROR (Status
)) {
2064 Retrieve VLAN ID of a VLAN device handle.
2066 Search VLAN device path node in Device Path of specified ServiceHandle and
2067 return its VLAN ID. If no VLAN device path node found, then this ServiceHandle
2068 is not a VLAN device handle, and 0 will be returned.
2070 @param[in] ServiceHandle The handle where network service binding protocols are
2073 @return VLAN ID of the device handle, or 0 if not a VLAN device.
2079 IN EFI_HANDLE ServiceHandle
2082 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2083 EFI_DEVICE_PATH_PROTOCOL
*Node
;
2085 DevicePath
= DevicePathFromHandle (ServiceHandle
);
2086 if (DevicePath
== NULL
) {
2091 while (!IsDevicePathEnd (Node
)) {
2092 if (Node
->Type
== MESSAGING_DEVICE_PATH
&& Node
->SubType
== MSG_VLAN_DP
) {
2093 return ((VLAN_DEVICE_PATH
*) Node
)->VlanId
;
2095 Node
= NextDevicePathNode (Node
);
2102 Find VLAN device handle with specified VLAN ID.
2104 The VLAN child device handle is created by VLAN Config Protocol on ControllerHandle.
2105 This function will append VLAN device path node to the parent device path,
2106 and then use LocateDevicePath() to find the correct VLAN device handle.
2108 @param[in] ControllerHandle The handle where network service binding protocols are
2110 @param[in] VlanId The configured VLAN ID for the VLAN device.
2112 @return The VLAN device handle, or NULL if not found.
2117 NetLibGetVlanHandle (
2118 IN EFI_HANDLE ControllerHandle
,
2122 EFI_DEVICE_PATH_PROTOCOL
*ParentDevicePath
;
2123 EFI_DEVICE_PATH_PROTOCOL
*VlanDevicePath
;
2124 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2125 VLAN_DEVICE_PATH VlanNode
;
2128 ParentDevicePath
= DevicePathFromHandle (ControllerHandle
);
2129 if (ParentDevicePath
== NULL
) {
2134 // Construct VLAN device path
2136 CopyMem (&VlanNode
, &mNetVlanDevicePathTemplate
, sizeof (VLAN_DEVICE_PATH
));
2137 VlanNode
.VlanId
= VlanId
;
2138 VlanDevicePath
= AppendDevicePathNode (
2140 (EFI_DEVICE_PATH_PROTOCOL
*) &VlanNode
2142 if (VlanDevicePath
== NULL
) {
2147 // Find VLAN device handle
2150 DevicePath
= VlanDevicePath
;
2151 gBS
->LocateDevicePath (
2152 &gEfiDevicePathProtocolGuid
,
2156 if (!IsDevicePathEnd (DevicePath
)) {
2158 // Device path is not exactly match
2163 FreePool (VlanDevicePath
);
2168 Get MAC address associated with the network service handle.
2170 There should be MNP Service Binding Protocol installed on the input ServiceHandle.
2171 If SNP is installed on the ServiceHandle or its parent handle, MAC address will
2172 be retrieved from SNP. If no SNP found, try to get SNP mode data use MNP.
2174 @param[in] ServiceHandle The handle where network service binding protocols are
2176 @param[out] MacAddress The pointer to store the returned MAC address.
2177 @param[out] AddressSize The length of returned MAC address.
2179 @retval EFI_SUCCESS MAC address is returned successfully.
2180 @retval Others Failed to get SNP mode data.
2185 NetLibGetMacAddress (
2186 IN EFI_HANDLE ServiceHandle
,
2187 OUT EFI_MAC_ADDRESS
*MacAddress
,
2188 OUT UINTN
*AddressSize
2192 EFI_SIMPLE_NETWORK_PROTOCOL
*Snp
;
2193 EFI_SIMPLE_NETWORK_MODE
*SnpMode
;
2194 EFI_SIMPLE_NETWORK_MODE SnpModeData
;
2195 EFI_MANAGED_NETWORK_PROTOCOL
*Mnp
;
2196 EFI_SERVICE_BINDING_PROTOCOL
*MnpSb
;
2197 EFI_HANDLE
*SnpHandle
;
2198 EFI_HANDLE MnpChildHandle
;
2200 ASSERT (MacAddress
!= NULL
);
2201 ASSERT (AddressSize
!= NULL
);
2204 // Try to get SNP handle
2207 SnpHandle
= NetLibGetSnpHandle (ServiceHandle
, &Snp
);
2208 if (SnpHandle
!= NULL
) {
2210 // SNP found, use it directly
2212 SnpMode
= Snp
->Mode
;
2215 // Failed to get SNP handle, try to get MAC address from MNP
2217 MnpChildHandle
= NULL
;
2218 Status
= gBS
->HandleProtocol (
2220 &gEfiManagedNetworkServiceBindingProtocolGuid
,
2223 if (EFI_ERROR (Status
)) {
2228 // Create a MNP child
2230 Status
= MnpSb
->CreateChild (MnpSb
, &MnpChildHandle
);
2231 if (EFI_ERROR (Status
)) {
2236 // Open MNP protocol
2238 Status
= gBS
->HandleProtocol (
2240 &gEfiManagedNetworkProtocolGuid
,
2243 if (EFI_ERROR (Status
)) {
2244 MnpSb
->DestroyChild (MnpSb
, MnpChildHandle
);
2249 // Try to get SNP mode from MNP
2251 Status
= Mnp
->GetModeData (Mnp
, NULL
, &SnpModeData
);
2252 if (EFI_ERROR (Status
)) {
2253 MnpSb
->DestroyChild (MnpSb
, MnpChildHandle
);
2256 SnpMode
= &SnpModeData
;
2259 // Destroy the MNP child
2261 MnpSb
->DestroyChild (MnpSb
, MnpChildHandle
);
2264 *AddressSize
= SnpMode
->HwAddressSize
;
2265 CopyMem (MacAddress
->Addr
, SnpMode
->CurrentAddress
.Addr
, SnpMode
->HwAddressSize
);
2271 Convert MAC address of the NIC associated with specified Service Binding Handle
2272 to a unicode string. Callers are responsible for freeing the string storage.
2274 Locate simple network protocol associated with the Service Binding Handle and
2275 get the mac address from SNP. Then convert the mac address into a unicode
2276 string. It takes 2 unicode characters to represent a 1 byte binary buffer.
2277 Plus one unicode character for the null-terminator.
2279 @param[in] ServiceHandle The handle where network service binding protocol is
2281 @param[in] ImageHandle The image handle used to act as the agent handle to
2282 get the simple network protocol. This parameter is
2283 optional and may be NULL.
2284 @param[out] MacString The pointer to store the address of the string
2285 representation of the mac address.
2287 @retval EFI_SUCCESS Convert the mac address a unicode string successfully.
2288 @retval EFI_OUT_OF_RESOURCES There are not enough memory resource.
2289 @retval Others Failed to open the simple network protocol.
2294 NetLibGetMacString (
2295 IN EFI_HANDLE ServiceHandle
,
2296 IN EFI_HANDLE ImageHandle
, OPTIONAL
2297 OUT CHAR16
**MacString
2301 EFI_MAC_ADDRESS MacAddress
;
2303 UINTN HwAddressSize
;
2308 ASSERT (MacString
!= NULL
);
2311 // Get MAC address of the network device
2313 Status
= NetLibGetMacAddress (ServiceHandle
, &MacAddress
, &HwAddressSize
);
2314 if (EFI_ERROR (Status
)) {
2319 // It takes 2 unicode characters to represent a 1 byte binary buffer.
2320 // If VLAN is configured, it will need extra 5 characters like "\0005".
2321 // Plus one unicode character for the null-terminator.
2323 String
= AllocateZeroPool ((2 * HwAddressSize
+ 5 + 1) * sizeof (CHAR16
));
2324 if (String
== NULL
) {
2325 return EFI_OUT_OF_RESOURCES
;
2327 *MacString
= String
;
2330 // Convert the MAC address into a unicode string.
2332 HwAddress
= &MacAddress
.Addr
[0];
2333 for (Index
= 0; Index
< HwAddressSize
; Index
++) {
2334 String
+= UnicodeValueToString (String
, PREFIX_ZERO
| RADIX_HEX
, *(HwAddress
++), 2);
2338 // Append VLAN ID if any
2340 VlanId
= NetLibGetVlanId (ServiceHandle
);
2343 String
+= UnicodeValueToString (String
, PREFIX_ZERO
| RADIX_HEX
, VlanId
, 4);
2347 // Null terminate the Unicode string
2355 Detect media status for specified network device.
2357 The underlying UNDI driver may or may not support reporting media status from
2358 GET_STATUS command (PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED). This routine
2359 will try to invoke Snp->GetStatus() to get the media status: if media already
2360 present, it return directly; if media not present, it will stop SNP and then
2361 restart SNP to get the latest media status, this give chance to get the correct
2362 media status for old UNDI driver which doesn't support reporting media status
2363 from GET_STATUS command.
2364 Note: there will be two limitations for current algorithm:
2365 1) for UNDI with this capability, in case of cable is not attached, there will
2366 be an redundant Stop/Start() process;
2367 2) for UNDI without this capability, in case that network cable is attached when
2368 Snp->Initialize() is invoked while network cable is unattached later,
2369 NetLibDetectMedia() will report MediaPresent as TRUE, causing upper layer
2370 apps to wait for timeout time.
2372 @param[in] ServiceHandle The handle where network service binding protocols are
2374 @param[out] MediaPresent The pointer to store the media status.
2376 @retval EFI_SUCCESS Media detection success.
2377 @retval EFI_INVALID_PARAMETER ServiceHandle is not valid network device handle.
2378 @retval EFI_UNSUPPORTED Network device does not support media detection.
2379 @retval EFI_DEVICE_ERROR SNP is in unknown state.
2385 IN EFI_HANDLE ServiceHandle
,
2386 OUT BOOLEAN
*MediaPresent
2390 EFI_HANDLE SnpHandle
;
2391 EFI_SIMPLE_NETWORK_PROTOCOL
*Snp
;
2392 UINT32 InterruptStatus
;
2394 EFI_MAC_ADDRESS
*MCastFilter
;
2395 UINT32 MCastFilterCount
;
2396 UINT32 EnableFilterBits
;
2397 UINT32 DisableFilterBits
;
2398 BOOLEAN ResetMCastFilters
;
2400 ASSERT (MediaPresent
!= NULL
);
2406 SnpHandle
= NetLibGetSnpHandle (ServiceHandle
, &Snp
);
2407 if (SnpHandle
== NULL
) {
2408 return EFI_INVALID_PARAMETER
;
2412 // Check whether SNP support media detection
2414 if (!Snp
->Mode
->MediaPresentSupported
) {
2415 return EFI_UNSUPPORTED
;
2419 // Invoke Snp->GetStatus() to refresh MediaPresent field in SNP mode data
2421 Status
= Snp
->GetStatus (Snp
, &InterruptStatus
, NULL
);
2422 if (EFI_ERROR (Status
)) {
2426 if (Snp
->Mode
->MediaPresent
) {
2428 // Media is present, return directly
2430 *MediaPresent
= TRUE
;
2435 // Till now, GetStatus() report no media; while, in case UNDI not support
2436 // reporting media status from GetStatus(), this media status may be incorrect.
2437 // So, we will stop SNP and then restart it to get the correct media status.
2439 OldState
= Snp
->Mode
->State
;
2440 if (OldState
>= EfiSimpleNetworkMaxState
) {
2441 return EFI_DEVICE_ERROR
;
2446 if (OldState
== EfiSimpleNetworkInitialized
) {
2448 // SNP is already in use, need Shutdown/Stop and then Start/Initialize
2452 // Backup current SNP receive filter settings
2454 EnableFilterBits
= Snp
->Mode
->ReceiveFilterSetting
;
2455 DisableFilterBits
= Snp
->Mode
->ReceiveFilterMask
^ EnableFilterBits
;
2457 ResetMCastFilters
= TRUE
;
2458 MCastFilterCount
= Snp
->Mode
->MCastFilterCount
;
2459 if (MCastFilterCount
!= 0) {
2460 MCastFilter
= AllocateCopyPool (
2461 MCastFilterCount
* sizeof (EFI_MAC_ADDRESS
),
2462 Snp
->Mode
->MCastFilter
2464 ASSERT (MCastFilter
!= NULL
);
2466 ResetMCastFilters
= FALSE
;
2470 // Shutdown/Stop the simple network
2472 Status
= Snp
->Shutdown (Snp
);
2473 if (!EFI_ERROR (Status
)) {
2474 Status
= Snp
->Stop (Snp
);
2476 if (EFI_ERROR (Status
)) {
2481 // Start/Initialize the simple network
2483 Status
= Snp
->Start (Snp
);
2484 if (!EFI_ERROR (Status
)) {
2485 Status
= Snp
->Initialize (Snp
, 0, 0);
2487 if (EFI_ERROR (Status
)) {
2492 // Here we get the correct media status
2494 *MediaPresent
= Snp
->Mode
->MediaPresent
;
2497 // Restore SNP receive filter settings
2499 Status
= Snp
->ReceiveFilters (
2508 if (MCastFilter
!= NULL
) {
2509 FreePool (MCastFilter
);
2516 // SNP is not in use, it's in state of EfiSimpleNetworkStopped or EfiSimpleNetworkStarted
2518 if (OldState
== EfiSimpleNetworkStopped
) {
2520 // SNP not start yet, start it
2522 Status
= Snp
->Start (Snp
);
2523 if (EFI_ERROR (Status
)) {
2529 // Initialize the simple network
2531 Status
= Snp
->Initialize (Snp
, 0, 0);
2532 if (EFI_ERROR (Status
)) {
2533 Status
= EFI_DEVICE_ERROR
;
2538 // Here we get the correct media status
2540 *MediaPresent
= Snp
->Mode
->MediaPresent
;
2543 // Shut down the simple network
2545 Snp
->Shutdown (Snp
);
2548 if (OldState
== EfiSimpleNetworkStopped
) {
2550 // Original SNP sate is Stopped, restore to original state
2555 if (MCastFilter
!= NULL
) {
2556 FreePool (MCastFilter
);
2563 Check the default address used by the IPv4 driver is static or dynamic (acquired
2566 If the controller handle does not have the NIC Ip4 Config Protocol installed, the
2567 default address is static. If the EFI variable to save the configuration is not found,
2568 the default address is static. Otherwise, get the result from the EFI variable which
2569 saving the configuration.
2571 @param[in] Controller The controller handle which has the NIC Ip4 Config Protocol
2572 relative with the default address to judge.
2574 @retval TRUE If the default address is static.
2575 @retval FALSE If the default address is acquired from DHCP.
2579 NetLibDefaultAddressIsStatic (
2580 IN EFI_HANDLE Controller
2584 EFI_HII_CONFIG_ROUTING_PROTOCOL
*HiiConfigRouting
;
2586 NIC_IP4_CONFIG_INFO
*ConfigInfo
;
2588 EFI_STRING ConfigHdr
;
2589 EFI_STRING ConfigResp
;
2590 EFI_STRING AccessProgress
;
2591 EFI_STRING AccessResults
;
2593 EFI_HANDLE ChildHandle
;
2598 AccessProgress
= NULL
;
2599 AccessResults
= NULL
;
2602 Status
= gBS
->LocateProtocol (
2603 &gEfiHiiConfigRoutingProtocolGuid
,
2605 (VOID
**) &HiiConfigRouting
2607 if (EFI_ERROR (Status
)) {
2611 Status
= NetGetChildHandle (Controller
, &ChildHandle
);
2612 if (EFI_ERROR (Status
)) {
2617 // Construct config request string header
2619 ConfigHdr
= HiiConstructConfigHdr (&gEfiNicIp4ConfigVariableGuid
, EFI_NIC_IP4_CONFIG_VARIABLE
, ChildHandle
);
2620 if (ConfigHdr
== NULL
) {
2624 Len
= StrLen (ConfigHdr
);
2625 ConfigResp
= AllocateZeroPool ((Len
+ NIC_ITEM_CONFIG_SIZE
* 2 + 100) * sizeof (CHAR16
));
2626 if (ConfigResp
== NULL
) {
2629 StrCpy (ConfigResp
, ConfigHdr
);
2631 String
= ConfigResp
+ Len
;
2634 (8 + 4 + 7 + 4 + 1) * sizeof (CHAR16
),
2635 L
"&OFFSET=%04X&WIDTH=%04X",
2636 OFFSET_OF (NIC_IP4_CONFIG_INFO
, Source
),
2640 Status
= HiiConfigRouting
->ExtractConfig (
2646 if (EFI_ERROR (Status
)) {
2650 ConfigInfo
= AllocateZeroPool (NIC_ITEM_CONFIG_SIZE
);
2651 if (ConfigInfo
== NULL
) {
2655 ConfigInfo
->Source
= IP4_CONFIG_SOURCE_STATIC
;
2656 Len
= NIC_ITEM_CONFIG_SIZE
;
2657 Status
= HiiConfigRouting
->ConfigToBlock (
2660 (UINT8
*) ConfigInfo
,
2664 if (EFI_ERROR (Status
)) {
2668 IsStatic
= (BOOLEAN
) (ConfigInfo
->Source
== IP4_CONFIG_SOURCE_STATIC
);
2672 if (AccessResults
!= NULL
) {
2673 FreePool (AccessResults
);
2675 if (ConfigInfo
!= NULL
) {
2676 FreePool (ConfigInfo
);
2678 if (ConfigResp
!= NULL
) {
2679 FreePool (ConfigResp
);
2681 if (ConfigHdr
!= NULL
) {
2682 FreePool (ConfigHdr
);
2689 Create an IPv4 device path node.
2691 The header type of IPv4 device path node is MESSAGING_DEVICE_PATH.
2692 The header subtype of IPv4 device path node is MSG_IPv4_DP.
2693 Get other info from parameters to make up the whole IPv4 device path node.
2695 @param[in, out] Node Pointer to the IPv4 device path node.
2696 @param[in] Controller The controller handle.
2697 @param[in] LocalIp The local IPv4 address.
2698 @param[in] LocalPort The local port.
2699 @param[in] RemoteIp The remote IPv4 address.
2700 @param[in] RemotePort The remote port.
2701 @param[in] Protocol The protocol type in the IP header.
2702 @param[in] UseDefaultAddress Whether this instance is using default address or not.
2707 NetLibCreateIPv4DPathNode (
2708 IN OUT IPv4_DEVICE_PATH
*Node
,
2709 IN EFI_HANDLE Controller
,
2710 IN IP4_ADDR LocalIp
,
2711 IN UINT16 LocalPort
,
2712 IN IP4_ADDR RemoteIp
,
2713 IN UINT16 RemotePort
,
2715 IN BOOLEAN UseDefaultAddress
2718 Node
->Header
.Type
= MESSAGING_DEVICE_PATH
;
2719 Node
->Header
.SubType
= MSG_IPv4_DP
;
2720 SetDevicePathNodeLength (&Node
->Header
, sizeof (IPv4_DEVICE_PATH
));
2722 CopyMem (&Node
->LocalIpAddress
, &LocalIp
, sizeof (EFI_IPv4_ADDRESS
));
2723 CopyMem (&Node
->RemoteIpAddress
, &RemoteIp
, sizeof (EFI_IPv4_ADDRESS
));
2725 Node
->LocalPort
= LocalPort
;
2726 Node
->RemotePort
= RemotePort
;
2728 Node
->Protocol
= Protocol
;
2730 if (!UseDefaultAddress
) {
2731 Node
->StaticIpAddress
= TRUE
;
2733 Node
->StaticIpAddress
= NetLibDefaultAddressIsStatic (Controller
);
2737 // Set the Gateway IP address to default value 0:0:0:0.
2738 // Set the Subnet mask to default value 255:255:255:0.
2740 ZeroMem (&Node
->GatewayIpAddress
, sizeof (EFI_IPv4_ADDRESS
));
2741 SetMem (&Node
->SubnetMask
, sizeof (EFI_IPv4_ADDRESS
), 0xff);
2742 Node
->SubnetMask
.Addr
[3] = 0;
2746 Create an IPv6 device path node.
2748 The header type of IPv6 device path node is MESSAGING_DEVICE_PATH.
2749 The header subtype of IPv6 device path node is MSG_IPv6_DP.
2750 Get other info from parameters to make up the whole IPv6 device path node.
2752 @param[in, out] Node Pointer to the IPv6 device path node.
2753 @param[in] Controller The controller handle.
2754 @param[in] LocalIp The local IPv6 address.
2755 @param[in] LocalPort The local port.
2756 @param[in] RemoteIp The remote IPv6 address.
2757 @param[in] RemotePort The remote port.
2758 @param[in] Protocol The protocol type in the IP header.
2763 NetLibCreateIPv6DPathNode (
2764 IN OUT IPv6_DEVICE_PATH
*Node
,
2765 IN EFI_HANDLE Controller
,
2766 IN EFI_IPv6_ADDRESS
*LocalIp
,
2767 IN UINT16 LocalPort
,
2768 IN EFI_IPv6_ADDRESS
*RemoteIp
,
2769 IN UINT16 RemotePort
,
2773 Node
->Header
.Type
= MESSAGING_DEVICE_PATH
;
2774 Node
->Header
.SubType
= MSG_IPv6_DP
;
2775 SetDevicePathNodeLength (&Node
->Header
, sizeof (IPv6_DEVICE_PATH
));
2777 CopyMem (&Node
->LocalIpAddress
, LocalIp
, sizeof (EFI_IPv6_ADDRESS
));
2778 CopyMem (&Node
->RemoteIpAddress
, RemoteIp
, sizeof (EFI_IPv6_ADDRESS
));
2780 Node
->LocalPort
= LocalPort
;
2781 Node
->RemotePort
= RemotePort
;
2783 Node
->Protocol
= Protocol
;
2786 // Set default value to IPAddressOrigin, PrefixLength.
2787 // Set the Gateway IP address to unspecified address.
2789 Node
->IpAddressOrigin
= 0;
2790 Node
->PrefixLength
= IP6_PREFIX_LENGTH
;
2791 ZeroMem (&Node
->GatewayIpAddress
, sizeof (EFI_IPv6_ADDRESS
));
2795 Find the UNDI/SNP handle from controller and protocol GUID.
2797 For example, IP will open a MNP child to transmit/receive
2798 packets, when MNP is stopped, IP should also be stopped. IP
2799 needs to find its own private data which is related the IP's
2800 service binding instance that is install on UNDI/SNP handle.
2801 Now, the controller is either a MNP or ARP child handle. But
2802 IP opens these handle BY_DRIVER, use that info, we can get the
2805 @param[in] Controller Then protocol handle to check.
2806 @param[in] ProtocolGuid The protocol that is related with the handle.
2808 @return The UNDI/SNP handle or NULL for errors.
2813 NetLibGetNicHandle (
2814 IN EFI_HANDLE Controller
,
2815 IN EFI_GUID
*ProtocolGuid
2818 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
*OpenBuffer
;
2824 Status
= gBS
->OpenProtocolInformation (
2831 if (EFI_ERROR (Status
)) {
2837 for (Index
= 0; Index
< OpenCount
; Index
++) {
2838 if ((OpenBuffer
[Index
].Attributes
& EFI_OPEN_PROTOCOL_BY_DRIVER
) != 0) {
2839 Handle
= OpenBuffer
[Index
].ControllerHandle
;
2844 gBS
->FreePool (OpenBuffer
);
2849 Convert one Null-terminated ASCII string (decimal dotted) to EFI_IPv4_ADDRESS.
2851 @param[in] String The pointer to the Ascii string.
2852 @param[out] Ip4Address The pointer to the converted IPv4 address.
2854 @retval EFI_SUCCESS Convert to IPv4 address successfully.
2855 @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip4Address is NULL.
2860 NetLibAsciiStrToIp4 (
2861 IN CONST CHAR8
*String
,
2862 OUT EFI_IPv4_ADDRESS
*Ip4Address
2870 if ((String
== NULL
) || (Ip4Address
== NULL
)) {
2871 return EFI_INVALID_PARAMETER
;
2874 Ip4Str
= (CHAR8
*) String
;
2876 for (Index
= 0; Index
< 4; Index
++) {
2879 while ((*Ip4Str
!= '\0') && (*Ip4Str
!= '.')) {
2884 // The IPv4 address is X.X.X.X
2886 if (*Ip4Str
== '.') {
2888 return EFI_INVALID_PARAMETER
;
2892 return EFI_INVALID_PARAMETER
;
2897 // Convert the string to IPv4 address. AsciiStrDecimalToUintn stops at the
2898 // first character that is not a valid decimal character, '.' or '\0' here.
2900 NodeVal
= AsciiStrDecimalToUintn (TempStr
);
2901 if (NodeVal
> 0xFF) {
2902 return EFI_INVALID_PARAMETER
;
2905 Ip4Address
->Addr
[Index
] = (UINT8
) NodeVal
;
2915 Convert one Null-terminated ASCII string to EFI_IPv6_ADDRESS. The format of the
2916 string is defined in RFC 4291 - Text Pepresentation of Addresses.
2918 @param[in] String The pointer to the Ascii string.
2919 @param[out] Ip6Address The pointer to the converted IPv6 address.
2921 @retval EFI_SUCCESS Convert to IPv6 address successfully.
2922 @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip6Address is NULL.
2927 NetLibAsciiStrToIp6 (
2928 IN CONST CHAR8
*String
,
2929 OUT EFI_IPv6_ADDRESS
*Ip6Address
2946 if ((String
== NULL
) || (Ip6Address
== NULL
)) {
2947 return EFI_INVALID_PARAMETER
;
2950 Ip6Str
= (CHAR8
*) String
;
2955 // An IPv6 address leading with : looks strange.
2957 if (*Ip6Str
== ':') {
2958 if (*(Ip6Str
+ 1) != ':') {
2959 return EFI_INVALID_PARAMETER
;
2965 ZeroMem (Ip6Address
, sizeof (EFI_IPv6_ADDRESS
));
2973 for (Index
= 0; Index
< 15; Index
= (UINT8
) (Index
+ 2)) {
2976 while ((*Ip6Str
!= '\0') && (*Ip6Str
!= ':')) {
2980 if ((*Ip6Str
== '\0') && (Index
!= 14)) {
2981 return EFI_INVALID_PARAMETER
;
2984 if (*Ip6Str
== ':') {
2985 if (*(Ip6Str
+ 1) == ':') {
2986 if ((NodeCnt
> 6) ||
2987 ((*(Ip6Str
+ 2) != '\0') && (AsciiStrHexToUintn (Ip6Str
+ 2) == 0))) {
2989 // ::0 looks strange. report error to user.
2991 return EFI_INVALID_PARAMETER
;
2993 if ((NodeCnt
== 6) && (*(Ip6Str
+ 2) != '\0') &&
2994 (AsciiStrHexToUintn (Ip6Str
+ 2) != 0)) {
2995 return EFI_INVALID_PARAMETER
;
2999 // Skip the abbreviation part of IPv6 address.
3001 TempStr2
= Ip6Str
+ 2;
3002 while ((*TempStr2
!= '\0')) {
3003 if (*TempStr2
== ':') {
3004 if (*(TempStr2
+ 1) == ':') {
3006 // :: can only appear once in IPv6 address.
3008 return EFI_INVALID_PARAMETER
;
3012 if (TailNodeCnt
>= (AllowedCnt
- NodeCnt
)) {
3014 // :: indicates one or more groups of 16 bits of zeros.
3016 return EFI_INVALID_PARAMETER
;
3026 Ip6Str
= Ip6Str
+ 2;
3028 if (*(Ip6Str
+ 1) == '\0') {
3029 return EFI_INVALID_PARAMETER
;
3033 if ((Short
&& (NodeCnt
> 6)) || (!Short
&& (NodeCnt
> 7))) {
3035 // There are more than 8 groups of 16 bits of zeros.
3037 return EFI_INVALID_PARAMETER
;
3043 // Convert the string to IPv6 address. AsciiStrHexToUintn stops at the first
3044 // character that is not a valid hexadecimal character, ':' or '\0' here.
3046 NodeVal
= AsciiStrHexToUintn (TempStr
);
3047 if ((NodeVal
> 0xFFFF) || (Index
> 14)) {
3048 return EFI_INVALID_PARAMETER
;
3051 if ((*TempStr
== '0') &&
3052 ((*(TempStr
+ 2) == ':') || (*(TempStr
+ 3) == ':') ||
3053 (*(TempStr
+ 2) == '\0') || (*(TempStr
+ 3) == '\0'))) {
3054 return EFI_INVALID_PARAMETER
;
3056 if ((*TempStr
== '0') && (*(TempStr
+ 4) != '\0') &&
3057 (*(TempStr
+ 4) != ':')) {
3058 return EFI_INVALID_PARAMETER
;
3061 if (((*TempStr
== '0') && (*(TempStr
+ 1) == '0') &&
3062 ((*(TempStr
+ 2) == ':') || (*(TempStr
+ 2) == '\0'))) ||
3063 ((*TempStr
== '0') && (*(TempStr
+ 1) == '0') && (*(TempStr
+ 2) == '0') &&
3064 ((*(TempStr
+ 3) == ':') || (*(TempStr
+ 3) == '\0')))) {
3065 return EFI_INVALID_PARAMETER
;
3070 while ((TempStr
[Cnt
] != ':') && (TempStr
[Cnt
] != '\0')) {
3073 if (LeadZeroCnt
== 0) {
3074 if ((Cnt
== 4) && (*TempStr
== '0')) {
3078 if ((Cnt
!= 0) && (Cnt
< 4)) {
3083 if ((Cnt
== 4) && (*TempStr
== '0') && !LeadZero
) {
3084 return EFI_INVALID_PARAMETER
;
3086 if ((Cnt
!= 0) && (Cnt
< 4) && LeadZero
) {
3087 return EFI_INVALID_PARAMETER
;
3091 Ip6Address
->Addr
[Index
] = (UINT8
) (NodeVal
>> 8);
3092 Ip6Address
->Addr
[Index
+ 1] = (UINT8
) (NodeVal
& 0xFF);
3095 // Skip the groups of zeros by ::
3097 if (Short
&& Update
) {
3098 Index
= (UINT8
) (16 - (TailNodeCnt
+ 2) * 2);
3103 if ((!Short
&& Index
!= 16) || (*Ip6Str
!= '\0')) {
3104 return EFI_INVALID_PARAMETER
;
3112 Convert one Null-terminated Unicode string (decimal dotted) to EFI_IPv4_ADDRESS.
3114 @param[in] String The pointer to the Ascii string.
3115 @param[out] Ip4Address The pointer to the converted IPv4 address.
3117 @retval EFI_SUCCESS Convert to IPv4 address successfully.
3118 @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip4Address is NULL.
3119 @retval EFI_OUT_OF_RESOURCES Fail to perform the operation due to lack of resource.
3125 IN CONST CHAR16
*String
,
3126 OUT EFI_IPv4_ADDRESS
*Ip4Address
3132 if ((String
== NULL
) || (Ip4Address
== NULL
)) {
3133 return EFI_INVALID_PARAMETER
;
3136 Ip4Str
= (CHAR8
*) AllocatePool ((StrLen (String
) + 1) * sizeof (CHAR8
));
3137 if (Ip4Str
== NULL
) {
3138 return EFI_OUT_OF_RESOURCES
;
3141 UnicodeStrToAsciiStr (String
, Ip4Str
);
3143 Status
= NetLibAsciiStrToIp4 (Ip4Str
, Ip4Address
);
3152 Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS. The format of
3153 the string is defined in RFC 4291 - Text Pepresentation of Addresses.
3155 @param[in] String The pointer to the Ascii string.
3156 @param[out] Ip6Address The pointer to the converted IPv6 address.
3158 @retval EFI_SUCCESS Convert to IPv6 address successfully.
3159 @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip6Address is NULL.
3160 @retval EFI_OUT_OF_RESOURCES Fail to perform the operation due to lack of resource.
3166 IN CONST CHAR16
*String
,
3167 OUT EFI_IPv6_ADDRESS
*Ip6Address
3173 if ((String
== NULL
) || (Ip6Address
== NULL
)) {
3174 return EFI_INVALID_PARAMETER
;
3177 Ip6Str
= (CHAR8
*) AllocatePool ((StrLen (String
) + 1) * sizeof (CHAR8
));
3178 if (Ip6Str
== NULL
) {
3179 return EFI_OUT_OF_RESOURCES
;
3182 UnicodeStrToAsciiStr (String
, Ip6Str
);
3184 Status
= NetLibAsciiStrToIp6 (Ip6Str
, Ip6Address
);
3192 Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS and prefix length.
3193 The format of the string is defined in RFC 4291 - Text Pepresentation of Addresses
3194 Prefixes: ipv6-address/prefix-length.
3196 @param[in] String The pointer to the Ascii string.
3197 @param[out] Ip6Address The pointer to the converted IPv6 address.
3198 @param[out] PrefixLength The pointer to the converted prefix length.
3200 @retval EFI_SUCCESS Convert to IPv6 address successfully.
3201 @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip6Address is NULL.
3202 @retval EFI_OUT_OF_RESOURCES Fail to perform the operation due to lack of resource.
3207 NetLibStrToIp6andPrefix (
3208 IN CONST CHAR16
*String
,
3209 OUT EFI_IPv6_ADDRESS
*Ip6Address
,
3210 OUT UINT8
*PrefixLength
3219 if ((String
== NULL
) || (Ip6Address
== NULL
) || (PrefixLength
== NULL
)) {
3220 return EFI_INVALID_PARAMETER
;
3223 Ip6Str
= (CHAR8
*) AllocatePool ((StrLen (String
) + 1) * sizeof (CHAR8
));
3224 if (Ip6Str
== NULL
) {
3225 return EFI_OUT_OF_RESOURCES
;
3228 UnicodeStrToAsciiStr (String
, Ip6Str
);
3231 // Get the sub string describing prefix length.
3234 while (*TempStr
!= '\0' && (*TempStr
!= '/')) {
3238 if (*TempStr
== '/') {
3239 PrefixStr
= TempStr
+ 1;
3245 // Get the sub string describing IPv6 address and convert it.
3249 Status
= NetLibAsciiStrToIp6 (Ip6Str
, Ip6Address
);
3250 if (EFI_ERROR (Status
)) {
3255 // If input string doesn't indicate the prefix length, return 0xff.
3260 // Convert the string to prefix length
3262 if (PrefixStr
!= NULL
) {
3264 Status
= EFI_INVALID_PARAMETER
;
3266 while (*PrefixStr
!= '\0') {
3267 if (NET_IS_DIGIT (*PrefixStr
)) {
3268 Length
= (UINT8
) (Length
* 10 + (*PrefixStr
- '0'));
3269 if (Length
>= IP6_PREFIX_NUM
) {
3280 *PrefixLength
= Length
;
3281 Status
= EFI_SUCCESS
;
3291 Convert one EFI_IPv6_ADDRESS to Null-terminated Unicode string.
3292 The text representation of address is defined in RFC 4291.
3294 @param[in] Ip6Address The pointer to the IPv6 address.
3295 @param[out] String The buffer to return the converted string.
3296 @param[in] StringSize The length in bytes of the input String.
3298 @retval EFI_SUCCESS Convert to string successfully.
3299 @retval EFI_INVALID_PARAMETER The input parameter is invalid.
3300 @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result. BufferSize has been
3301 updated with the size needed to complete the request.
3306 IN EFI_IPv6_ADDRESS
*Ip6Address
,
3313 UINTN LongestZerosStart
;
3314 UINTN LongestZerosLength
;
3315 UINTN CurrentZerosStart
;
3316 UINTN CurrentZerosLength
;
3317 CHAR16 Buffer
[sizeof"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff"];
3320 if (Ip6Address
== NULL
|| String
== NULL
|| StringSize
== 0) {
3321 return EFI_INVALID_PARAMETER
;
3325 // Convert the UINT8 array to an UINT16 array for easy handling.
3327 ZeroMem (Ip6Addr
, sizeof (Ip6Addr
));
3328 for (Index
= 0; Index
< 16; Index
++) {
3329 Ip6Addr
[Index
/ 2] |= (Ip6Address
->Addr
[Index
] << ((1 - (Index
% 2)) << 3));
3333 // Find the longest zeros and mark it.
3335 CurrentZerosStart
= DEFAULT_ZERO_START
;
3336 CurrentZerosLength
= 0;
3337 LongestZerosStart
= DEFAULT_ZERO_START
;
3338 LongestZerosLength
= 0;
3339 for (Index
= 0; Index
< 8; Index
++) {
3340 if (Ip6Addr
[Index
] == 0) {
3341 if (CurrentZerosStart
== DEFAULT_ZERO_START
) {
3342 CurrentZerosStart
= Index
;
3343 CurrentZerosLength
= 1;
3345 CurrentZerosLength
++;
3348 if (CurrentZerosStart
!= DEFAULT_ZERO_START
) {
3349 if (CurrentZerosLength
> 2 && (LongestZerosStart
== (DEFAULT_ZERO_START
) || CurrentZerosLength
> LongestZerosLength
)) {
3350 LongestZerosStart
= CurrentZerosStart
;
3351 LongestZerosLength
= CurrentZerosLength
;
3353 CurrentZerosStart
= DEFAULT_ZERO_START
;
3354 CurrentZerosLength
= 0;
3359 if (CurrentZerosStart
!= DEFAULT_ZERO_START
&& CurrentZerosLength
> 2) {
3360 if (LongestZerosStart
== DEFAULT_ZERO_START
|| LongestZerosLength
< CurrentZerosLength
) {
3361 LongestZerosStart
= CurrentZerosStart
;
3362 LongestZerosLength
= CurrentZerosLength
;
3367 for (Index
= 0; Index
< 8; Index
++) {
3368 if (LongestZerosStart
!= DEFAULT_ZERO_START
&& Index
>= LongestZerosStart
&& Index
< LongestZerosStart
+ LongestZerosLength
) {
3369 if (Index
== LongestZerosStart
) {
3377 Ptr
+= UnicodeSPrint(Ptr
, 10, L
"%x", Ip6Addr
[Index
]);
3380 if (LongestZerosStart
!= DEFAULT_ZERO_START
&& LongestZerosStart
+ LongestZerosLength
== 8) {
3385 if ((UINTN
)Ptr
- (UINTN
)Buffer
> StringSize
) {
3386 return EFI_BUFFER_TOO_SMALL
;
3389 StrCpy (String
, Buffer
);
3395 This function obtains the system guid from the smbios table.
3397 @param[out] SystemGuid The pointer of the returned system guid.
3399 @retval EFI_SUCCESS Successfully obtained the system guid.
3400 @retval EFI_NOT_FOUND Did not find the SMBIOS table.
3405 NetLibGetSystemGuid (
3406 OUT EFI_GUID
*SystemGuid
3410 SMBIOS_TABLE_ENTRY_POINT
*SmbiosTable
;
3411 SMBIOS_STRUCTURE_POINTER Smbios
;
3412 SMBIOS_STRUCTURE_POINTER SmbiosEnd
;
3416 Status
= EfiGetSystemConfigurationTable (&gEfiSmbiosTableGuid
, (VOID
**) &SmbiosTable
);
3418 if (EFI_ERROR (Status
) || SmbiosTable
== NULL
) {
3419 return EFI_NOT_FOUND
;
3422 Smbios
.Hdr
= (SMBIOS_STRUCTURE
*) (UINTN
) SmbiosTable
->TableAddress
;
3423 SmbiosEnd
.Raw
= (UINT8
*) (UINTN
) (SmbiosTable
->TableAddress
+ SmbiosTable
->TableLength
);
3426 if (Smbios
.Hdr
->Type
== 1) {
3427 if (Smbios
.Hdr
->Length
< 0x19) {
3429 // Older version did not support UUID.
3431 return EFI_NOT_FOUND
;
3435 // SMBIOS tables are byte packed so we need to do a byte copy to
3436 // prevend alignment faults on Itanium-based platform.
3438 CopyMem (SystemGuid
, &Smbios
.Type1
->Uuid
, sizeof (EFI_GUID
));
3443 // Go to the next SMBIOS structure. Each SMBIOS structure may include 2 parts:
3444 // 1. Formatted section; 2. Unformatted string section. So, 2 steps are needed
3445 // to skip one SMBIOS structure.
3449 // Step 1: Skip over formatted section.
3451 String
= (CHAR8
*) (Smbios
.Raw
+ Smbios
.Hdr
->Length
);
3454 // Step 2: Skip over unformated string section.
3458 // Each string is terminated with a NULL(00h) BYTE and the sets of strings
3459 // is terminated with an additional NULL(00h) BYTE.
3461 for ( ; *String
!= 0; String
++) {
3464 if (*(UINT8
*)++String
== 0) {
3466 // Pointer to the next SMBIOS structure.
3468 Smbios
.Raw
= (UINT8
*)++String
;
3472 } while (Smbios
.Raw
< SmbiosEnd
.Raw
);
3473 return EFI_NOT_FOUND
;