4 Copyright (c) 2005 - 2010, Intel Corporation.<BR>
5 All rights reserved. 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 <Protocol/DriverBinding.h>
17 #include <Protocol/ServiceBinding.h>
18 #include <Protocol/SimpleNetwork.h>
19 #include <Protocol/ManagedNetwork.h>
20 #include <Protocol/HiiConfigRouting.h>
21 #include <Protocol/ComponentName.h>
22 #include <Protocol/ComponentName2.h>
24 #include <Guid/NicIp4ConfigNvData.h>
26 #include <Library/NetLib.h>
27 #include <Library/BaseLib.h>
28 #include <Library/DebugLib.h>
29 #include <Library/BaseMemoryLib.h>
30 #include <Library/UefiBootServicesTableLib.h>
31 #include <Library/UefiRuntimeServicesTableLib.h>
32 #include <Library/MemoryAllocationLib.h>
33 #include <Library/DevicePathLib.h>
34 #include <Library/HiiLib.h>
35 #include <Library/PrintLib.h>
37 #define NIC_ITEM_CONFIG_SIZE sizeof (NIC_IP4_CONFIG_INFO) + sizeof (EFI_IP4_ROUTE_TABLE) * MAX_IP4_CONFIG_IN_VARIABLE
40 // All the supported IP4 maskes in host byte order.
42 GLOBAL_REMOVE_IF_UNREFERENCED IP4_ADDR gIp4AllMasks
[IP4_MASK_NUM
] = {
81 GLOBAL_REMOVE_IF_UNREFERENCED EFI_IPv4_ADDRESS mZeroIp4Addr
= {{0, 0, 0, 0}};
84 // Any error level digitally larger than mNetDebugLevelMax
85 // will be silently discarded.
87 GLOBAL_REMOVE_IF_UNREFERENCED UINTN mNetDebugLevelMax
= NETDEBUG_LEVEL_ERROR
;
88 GLOBAL_REMOVE_IF_UNREFERENCED UINT32 mSyslogPacketSeq
= 0xDEADBEEF;
91 // You can change mSyslogDstMac mSyslogDstIp and mSyslogSrcIp
92 // here to direct the syslog packets to the syslog deamon. The
93 // default is broadcast to both the ethernet and IP.
95 GLOBAL_REMOVE_IF_UNREFERENCED UINT8 mSyslogDstMac
[NET_ETHER_ADDR_LEN
] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
96 GLOBAL_REMOVE_IF_UNREFERENCED UINT32 mSyslogDstIp
= 0xffffffff;
97 GLOBAL_REMOVE_IF_UNREFERENCED UINT32 mSyslogSrcIp
= 0;
99 GLOBAL_REMOVE_IF_UNREFERENCED CHAR8
*mMonthName
[] = {
115 // VLAN device path node template
117 GLOBAL_REMOVE_IF_UNREFERENCED VLAN_DEVICE_PATH mNetVlanDevicePathTemplate
= {
119 MESSAGING_DEVICE_PATH
,
122 (UINT8
) (sizeof (VLAN_DEVICE_PATH
)),
123 (UINT8
) ((sizeof (VLAN_DEVICE_PATH
)) >> 8)
130 Locate the handles that support SNP, then open one of them
131 to send the syslog packets. The caller isn't required to close
132 the SNP after use because the SNP is opened by HandleProtocol.
134 @return The point to SNP if one is properly openned. Otherwise NULL
137 EFI_SIMPLE_NETWORK_PROTOCOL
*
142 EFI_SIMPLE_NETWORK_PROTOCOL
*Snp
;
149 // Locate the handles which has SNP installed.
152 Status
= gBS
->LocateHandleBuffer (
154 &gEfiSimpleNetworkProtocolGuid
,
160 if (EFI_ERROR (Status
) || (HandleCount
== 0)) {
165 // Try to open one of the ethernet SNP protocol to send packet
169 for (Index
= 0; Index
< HandleCount
; Index
++) {
170 Status
= gBS
->HandleProtocol (
172 &gEfiSimpleNetworkProtocolGuid
,
176 if ((Status
== EFI_SUCCESS
) && (Snp
!= NULL
) &&
177 (Snp
->Mode
->IfType
== NET_IFTYPE_ETHERNET
) &&
178 (Snp
->Mode
->MaxPacketSize
>= NET_SYSLOG_PACKET_LEN
)) {
191 Transmit a syslog packet synchronously through SNP. The Packet
192 already has the ethernet header prepended. This function should
193 fill in the source MAC because it will try to locate a SNP each
194 time it is called to avoid the problem if SNP is unloaded.
195 This code snip is copied from MNP.
197 @param[in] Packet The Syslog packet
198 @param[in] Length The length of the packet
200 @retval EFI_DEVICE_ERROR Failed to locate a usable SNP protocol
201 @retval EFI_TIMEOUT Timeout happened to send the packet.
202 @retval EFI_SUCCESS Packet is sent.
211 EFI_SIMPLE_NETWORK_PROTOCOL
*Snp
;
214 EFI_EVENT TimeoutEvent
;
217 Snp
= SyslogLocateSnp ();
220 return EFI_DEVICE_ERROR
;
223 Ether
= (ETHER_HEAD
*) Packet
;
224 CopyMem (Ether
->SrcMac
, Snp
->Mode
->CurrentAddress
.Addr
, NET_ETHER_ADDR_LEN
);
227 // Start the timeout event.
229 Status
= gBS
->CreateEvent (
237 if (EFI_ERROR (Status
)) {
241 Status
= gBS
->SetTimer (TimeoutEvent
, TimerRelative
, NET_SYSLOG_TX_TIMEOUT
);
243 if (EFI_ERROR (Status
)) {
249 // Transmit the packet through SNP.
251 Status
= Snp
->Transmit (Snp
, 0, Length
, Packet
, NULL
, NULL
, NULL
);
253 if ((Status
!= EFI_SUCCESS
) && (Status
!= EFI_NOT_READY
)) {
254 Status
= EFI_DEVICE_ERROR
;
259 // If Status is EFI_SUCCESS, the packet is put in the transmit queue.
260 // if Status is EFI_NOT_READY, the transmit engine of the network
261 // interface is busy. Both need to sync SNP.
267 // Get the recycled transmit buffer status.
269 Snp
->GetStatus (Snp
, NULL
, (VOID
**) &TxBuf
);
271 if (!EFI_ERROR (gBS
->CheckEvent (TimeoutEvent
))) {
272 Status
= EFI_TIMEOUT
;
276 } while (TxBuf
== NULL
);
278 if ((Status
== EFI_SUCCESS
) || (Status
== EFI_TIMEOUT
)) {
283 // Status is EFI_NOT_READY. Restart the timer event and
284 // call Snp->Transmit again.
286 gBS
->SetTimer (TimeoutEvent
, TimerRelative
, NET_SYSLOG_TX_TIMEOUT
);
289 gBS
->SetTimer (TimeoutEvent
, TimerCancel
, 0);
292 gBS
->CloseEvent (TimeoutEvent
);
297 Build a syslog packet, including the Ethernet/Ip/Udp headers
300 @param[in] Level Syslog servity level
301 @param[in] Module The module that generates the log
302 @param[in] File The file that contains the current log
303 @param[in] Line The line of code in the File that contains the current log
304 @param[in] Message The log message
305 @param[in] BufLen The lenght of the Buf
306 @param[out] Buf The buffer to put the packet data
308 @return The length of the syslog packet built.
324 EFI_UDP_HEADER
*Udp4
;
330 // Fill in the Ethernet header. Leave alone the source MAC.
331 // SyslogSendPacket will fill in the address for us.
333 Ether
= (ETHER_HEAD
*) Buf
;
334 CopyMem (Ether
->DstMac
, mSyslogDstMac
, NET_ETHER_ADDR_LEN
);
335 ZeroMem (Ether
->SrcMac
, NET_ETHER_ADDR_LEN
);
337 Ether
->EtherType
= HTONS (0x0800); // IPv4 protocol
339 Buf
+= sizeof (ETHER_HEAD
);
340 BufLen
-= sizeof (ETHER_HEAD
);
343 // Fill in the IP header
345 Ip4
= (IP4_HEAD
*) Buf
;
350 Ip4
->Id
= (UINT16
) mSyslogPacketSeq
;
353 Ip4
->Protocol
= 0x11;
355 Ip4
->Src
= mSyslogSrcIp
;
356 Ip4
->Dst
= mSyslogDstIp
;
358 Buf
+= sizeof (IP4_HEAD
);
359 BufLen
-= sizeof (IP4_HEAD
);
362 // Fill in the UDP header, Udp checksum is optional. Leave it zero.
364 Udp4
= (EFI_UDP_HEADER
*) Buf
;
365 Udp4
->SrcPort
= HTONS (514);
366 Udp4
->DstPort
= HTONS (514);
370 Buf
+= sizeof (EFI_UDP_HEADER
);
371 BufLen
-= sizeof (EFI_UDP_HEADER
);
374 // Build the syslog message body with <PRI> Timestamp machine module Message
376 Pri
= ((NET_SYSLOG_FACILITY
& 31) << 3) | (Level
& 7);
377 gRT
->GetTime (&Time
, NULL
);
378 ASSERT ((Time
.Month
<= 12) && (Time
.Month
>= 1));
381 // Use %a to format the ASCII strings, %s to format UNICODE strings
384 Len
+= (UINT32
) AsciiSPrint (
387 "<%d> %a %d %d:%d:%d ",
389 mMonthName
[Time
.Month
-1],
397 Len
+= (UINT32
) AsciiSPrint (
400 "Tiano %a: %a (Line: %d File: %a)",
409 // OK, patch the IP length/checksum and UDP length fields.
411 Len
+= sizeof (EFI_UDP_HEADER
);
412 Udp4
->Length
= HTONS ((UINT16
) Len
);
414 Len
+= sizeof (IP4_HEAD
);
415 Ip4
->TotalLen
= HTONS ((UINT16
) Len
);
416 Ip4
->Checksum
= (UINT16
) (~NetblockChecksum ((UINT8
*) Ip4
, sizeof (IP4_HEAD
)));
418 return Len
+ sizeof (ETHER_HEAD
);
422 Allocate a buffer, then format the message to it. This is a
423 help function for the NET_DEBUG_XXX macros. The PrintArg of
424 these macros treats the variable length print parameters as a
425 single parameter, and pass it to the NetDebugASPrint. For
426 example, NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name))
430 NETDEBUG_LEVEL_TRACE,
434 NetDebugASPrint ("State transit to %a\n", Name)
437 @param Format The ASCII format string.
438 @param ... The variable length parameter whose format is determined
439 by the Format string.
441 @return The buffer containing the formatted message,
442 or NULL if failed to allocate memory.
454 Buf
= (CHAR8
*) AllocatePool (NET_DEBUG_MSG_LEN
);
460 VA_START (Marker
, Format
);
461 AsciiVSPrint (Buf
, NET_DEBUG_MSG_LEN
, Format
, Marker
);
468 Builds an UDP4 syslog packet and send it using SNP.
470 This function will locate a instance of SNP then send the message through it.
471 Because it isn't open the SNP BY_DRIVER, apply caution when using it.
473 @param Level The servity level of the message.
474 @param Module The Moudle that generates the log.
475 @param File The file that contains the log.
476 @param Line The exact line that contains the log.
477 @param Message The user message to log.
479 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
480 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the packet
481 @retval EFI_SUCCESS The log is discard because that it is more verbose
482 than the mNetDebugLevelMax. Or, it has been sent out.
498 // Check whether the message should be sent out
500 if (Message
== NULL
) {
501 return EFI_INVALID_PARAMETER
;
504 if (Level
> mNetDebugLevelMax
) {
505 Status
= EFI_SUCCESS
;
510 // Allocate a maxium of 1024 bytes, the caller should ensure
511 // that the message plus the ethernet/ip/udp header is shorter
514 Packet
= (CHAR8
*) AllocatePool (NET_SYSLOG_PACKET_LEN
);
516 if (Packet
== NULL
) {
517 Status
= EFI_OUT_OF_RESOURCES
;
522 // Build the message: Ethernet header + IP header + Udp Header + user data
524 Len
= SyslogBuildPacket (
530 NET_SYSLOG_PACKET_LEN
,
535 Status
= SyslogSendPacket (Packet
, Len
);
543 Return the length of the mask.
545 Return the length of the mask, the correct value is from 0 to 32.
546 If the mask is invalid, return the invalid length 33, which is IP4_MASK_NUM.
547 NetMask is in the host byte order.
549 @param[in] NetMask The netmask to get the length from.
551 @return The length of the netmask, IP4_MASK_NUM if the mask is invalid.
562 for (Index
= 0; Index
< IP4_MASK_NUM
; Index
++) {
563 if (NetMask
== gIp4AllMasks
[Index
]) {
574 Return the class of the IP address, such as class A, B, C.
575 Addr is in host byte order.
577 The address of class A starts with 0.
578 If the address belong to class A, return IP4_ADDR_CLASSA.
579 The address of class B starts with 10.
580 If the address belong to class B, return IP4_ADDR_CLASSB.
581 The address of class C starts with 110.
582 If the address belong to class C, return IP4_ADDR_CLASSC.
583 The address of class D starts with 1110.
584 If the address belong to class D, return IP4_ADDR_CLASSD.
585 The address of class E starts with 1111.
586 If the address belong to class E, return IP4_ADDR_CLASSE.
589 @param[in] Addr The address to get the class from.
591 @return IP address class, such as IP4_ADDR_CLASSA.
602 ByteOne
= (UINT8
) (Addr
>> 24);
604 if ((ByteOne
& 0x80) == 0) {
605 return IP4_ADDR_CLASSA
;
607 } else if ((ByteOne
& 0xC0) == 0x80) {
608 return IP4_ADDR_CLASSB
;
610 } else if ((ByteOne
& 0xE0) == 0xC0) {
611 return IP4_ADDR_CLASSC
;
613 } else if ((ByteOne
& 0xF0) == 0xE0) {
614 return IP4_ADDR_CLASSD
;
617 return IP4_ADDR_CLASSE
;
624 Check whether the IP is a valid unicast address according to
625 the netmask. If NetMask is zero, use the IP address's class to get the default mask.
627 If Ip is 0, IP is not a valid unicast address.
628 Class D address is used for multicasting and class E address is reserved for future. If Ip
629 belongs to class D or class E, IP is not a valid unicast address.
630 If all bits of the host address of IP are 0 or 1, IP is also not a valid unicast address.
632 @param[in] Ip The IP to check against.
633 @param[in] NetMask The mask of the IP.
635 @return TRUE if IP is a valid unicast address on the network, otherwise FALSE.
647 Class
= NetGetIpClass (Ip
);
649 if ((Ip
== 0) || (Class
>= IP4_ADDR_CLASSD
)) {
654 NetMask
= gIp4AllMasks
[Class
<< 3];
657 if (((Ip
&~NetMask
) == ~NetMask
) || ((Ip
&~NetMask
) == 0)) {
665 Check whether the incoming IPv6 address is a valid unicast address.
667 If the address is a multicast address has binary 0xFF at the start, it is not
668 a valid unicast address. If the address is unspecified ::, it is not a valid
669 unicast address to be assigned to any node. If the address is loopback address
670 ::1, it is also not a valid unicast address to be assigned to any physical
673 @param[in] Ip6 The IPv6 address to check against.
675 @return TRUE if Ip6 is a valid unicast address on the network, otherwise FALSE.
679 NetIp6IsValidUnicast (
680 IN EFI_IPv6_ADDRESS
*Ip6
686 if (Ip6
->Addr
[0] == 0xFF) {
690 for (Index
= 0; Index
< 15; Index
++) {
691 if (Ip6
->Addr
[Index
] != 0) {
696 Byte
= Ip6
->Addr
[Index
];
698 if (Byte
== 0x0 || Byte
== 0x1) {
706 Check whether the incoming Ipv6 address is the unspecified address or not.
708 @param[in] Ip6 - Ip6 address, in network order.
710 @retval TRUE - Yes, unspecified
715 NetIp6IsUnspecifiedAddr (
716 IN EFI_IPv6_ADDRESS
*Ip6
721 for (Index
= 0; Index
< 16; Index
++) {
722 if (Ip6
->Addr
[Index
] != 0) {
731 Check whether the incoming Ipv6 address is a link-local address.
733 @param[in] Ip6 - Ip6 address, in network order.
735 @retval TRUE - Yes, link-local address
740 NetIp6IsLinkLocalAddr (
741 IN EFI_IPv6_ADDRESS
*Ip6
746 ASSERT (Ip6
!= NULL
);
748 if (Ip6
->Addr
[0] != 0xFE) {
752 if (Ip6
->Addr
[1] != 0x80) {
756 for (Index
= 2; Index
< 8; Index
++) {
757 if (Ip6
->Addr
[Index
] != 0) {
766 Check whether the Ipv6 address1 and address2 are on the connected network.
768 @param[in] Ip1 - Ip6 address1, in network order.
769 @param[in] Ip2 - Ip6 address2, in network order.
770 @param[in] PrefixLength - The prefix length of the checking net.
772 @retval TRUE - Yes, connected.
778 EFI_IPv6_ADDRESS
*Ip1
,
779 EFI_IPv6_ADDRESS
*Ip2
,
787 ASSERT ((Ip1
!= NULL
) && (Ip2
!= NULL
) && (PrefixLength
< IP6_PREFIX_NUM
));
789 if (PrefixLength
== 0) {
793 Byte
= (UINT8
) (PrefixLength
/ 8);
794 Bit
= (UINT8
) (PrefixLength
% 8);
796 if (CompareMem (Ip1
, Ip2
, Byte
) != 0) {
801 Mask
= (UINT8
) (0xFF << (8 - Bit
));
804 if ((Ip1
->Addr
[Byte
] & Mask
) != (Ip2
->Addr
[Byte
] & Mask
)) {
814 Switches the endianess of an IPv6 address
816 This function swaps the bytes in a 128-bit IPv6 address to switch the value
817 from little endian to big endian or vice versa. The byte swapped value is
820 @param Ip6 Points to an IPv6 address
822 @return The byte swapped IPv6 address.
827 EFI_IPv6_ADDRESS
*Ip6
833 CopyMem (&High
, Ip6
, sizeof (UINT64
));
834 CopyMem (&Low
, &Ip6
->Addr
[8], sizeof (UINT64
));
836 High
= SwapBytes64 (High
);
837 Low
= SwapBytes64 (Low
);
839 CopyMem (Ip6
, &Low
, sizeof (UINT64
));
840 CopyMem (&Ip6
->Addr
[8], &High
, sizeof (UINT64
));
846 Initialize a random seed using current time.
848 Get current time first. Then initialize a random seed based on some basic
849 mathematics operation on the hour, day, minute, second, nanosecond and year
852 @return The random seed initialized with current time.
864 gRT
->GetTime (&Time
, NULL
);
865 Seed
= (~Time
.Hour
<< 24 | Time
.Day
<< 16 | Time
.Minute
<< 8 | Time
.Second
);
866 Seed
^= Time
.Nanosecond
;
867 Seed
^= Time
.Year
<< 7;
874 Extract a UINT32 from a byte stream.
876 Copy a UINT32 from a byte stream, then converts it from Network
877 byte order to host byte order. Use this function to avoid alignment error.
879 @param[in] Buf The buffer to extract the UINT32.
881 @return The UINT32 extracted.
892 CopyMem (&Value
, Buf
, sizeof (UINT32
));
893 return NTOHL (Value
);
898 Put a UINT32 to the byte stream in network byte order.
900 Converts a UINT32 from host byte order to network byte order. Then copy it to the
903 @param[in, out] Buf The buffer to put the UINT32.
904 @param[in] Data The data to put.
915 CopyMem (Buf
, &Data
, sizeof (UINT32
));
920 Remove the first node entry on the list, and return the removed node entry.
922 Removes the first node Entry from a doubly linked list. It is up to the caller of
923 this function to release the memory used by the first node if that is required. On
924 exit, the removed node is returned.
926 If Head is NULL, then ASSERT().
927 If Head was not initialized, then ASSERT().
928 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
929 linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,
932 @param[in, out] Head The list header.
934 @return The first node entry that is removed from the list, NULL if the list is empty.
940 IN OUT LIST_ENTRY
*Head
945 ASSERT (Head
!= NULL
);
947 if (IsListEmpty (Head
)) {
951 First
= Head
->ForwardLink
;
952 Head
->ForwardLink
= First
->ForwardLink
;
953 First
->ForwardLink
->BackLink
= Head
;
956 First
->ForwardLink
= (LIST_ENTRY
*) NULL
;
957 First
->BackLink
= (LIST_ENTRY
*) NULL
;
965 Remove the last node entry on the list and and return the removed node entry.
967 Removes the last node entry from a doubly linked list. It is up to the caller of
968 this function to release the memory used by the first node if that is required. On
969 exit, the removed node is returned.
971 If Head is NULL, then ASSERT().
972 If Head was not initialized, then ASSERT().
973 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
974 linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,
977 @param[in, out] Head The list head.
979 @return The last node entry that is removed from the list, NULL if the list is empty.
985 IN OUT LIST_ENTRY
*Head
990 ASSERT (Head
!= NULL
);
992 if (IsListEmpty (Head
)) {
996 Last
= Head
->BackLink
;
997 Head
->BackLink
= Last
->BackLink
;
998 Last
->BackLink
->ForwardLink
= Head
;
1001 Last
->ForwardLink
= (LIST_ENTRY
*) NULL
;
1002 Last
->BackLink
= (LIST_ENTRY
*) NULL
;
1010 Insert a new node entry after a designated node entry of a doubly linked list.
1012 Inserts a new node entry donated by NewEntry after the node entry donated by PrevEntry
1013 of the doubly linked list.
1015 @param[in, out] PrevEntry The previous entry to insert after.
1016 @param[in, out] NewEntry The new entry to insert.
1021 NetListInsertAfter (
1022 IN OUT LIST_ENTRY
*PrevEntry
,
1023 IN OUT LIST_ENTRY
*NewEntry
1026 NewEntry
->BackLink
= PrevEntry
;
1027 NewEntry
->ForwardLink
= PrevEntry
->ForwardLink
;
1028 PrevEntry
->ForwardLink
->BackLink
= NewEntry
;
1029 PrevEntry
->ForwardLink
= NewEntry
;
1034 Insert a new node entry before a designated node entry of a doubly linked list.
1036 Inserts a new node entry donated by NewEntry after the node entry donated by PostEntry
1037 of the doubly linked list.
1039 @param[in, out] PostEntry The entry to insert before.
1040 @param[in, out] NewEntry The new entry to insert.
1045 NetListInsertBefore (
1046 IN OUT LIST_ENTRY
*PostEntry
,
1047 IN OUT LIST_ENTRY
*NewEntry
1050 NewEntry
->ForwardLink
= PostEntry
;
1051 NewEntry
->BackLink
= PostEntry
->BackLink
;
1052 PostEntry
->BackLink
->ForwardLink
= NewEntry
;
1053 PostEntry
->BackLink
= NewEntry
;
1058 Initialize the netmap. Netmap is a reposity to keep the <Key, Value> pairs.
1060 Initialize the forward and backward links of two head nodes donated by Map->Used
1061 and Map->Recycled of two doubly linked lists.
1062 Initializes the count of the <Key, Value> pairs in the netmap to zero.
1064 If Map is NULL, then ASSERT().
1065 If the address of Map->Used is NULL, then ASSERT().
1066 If the address of Map->Recycled is NULl, then ASSERT().
1068 @param[in, out] Map The netmap to initialize.
1077 ASSERT (Map
!= NULL
);
1079 InitializeListHead (&Map
->Used
);
1080 InitializeListHead (&Map
->Recycled
);
1086 To clean up the netmap, that is, release allocated memories.
1088 Removes all nodes of the Used doubly linked list and free memory of all related netmap items.
1089 Removes all nodes of the Recycled doubly linked list and free memory of all related netmap items.
1090 The number of the <Key, Value> pairs in the netmap is set to be zero.
1092 If Map is NULL, then ASSERT().
1094 @param[in, out] Map The netmap to clean up.
1107 ASSERT (Map
!= NULL
);
1109 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, &Map
->Used
) {
1110 Item
= NET_LIST_USER_STRUCT (Entry
, NET_MAP_ITEM
, Link
);
1112 RemoveEntryList (&Item
->Link
);
1115 gBS
->FreePool (Item
);
1118 ASSERT ((Map
->Count
== 0) && IsListEmpty (&Map
->Used
));
1120 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, &Map
->Recycled
) {
1121 Item
= NET_LIST_USER_STRUCT (Entry
, NET_MAP_ITEM
, Link
);
1123 RemoveEntryList (&Item
->Link
);
1124 gBS
->FreePool (Item
);
1127 ASSERT (IsListEmpty (&Map
->Recycled
));
1132 Test whether the netmap is empty and return true if it is.
1134 If the number of the <Key, Value> pairs in the netmap is zero, return TRUE.
1136 If Map is NULL, then ASSERT().
1139 @param[in] Map The net map to test.
1141 @return TRUE if the netmap is empty, otherwise FALSE.
1150 ASSERT (Map
!= NULL
);
1151 return (BOOLEAN
) (Map
->Count
== 0);
1156 Return the number of the <Key, Value> pairs in the netmap.
1158 @param[in] Map The netmap to get the entry number.
1160 @return The entry number in the netmap.
1174 Return one allocated item.
1176 If the Recycled doubly linked list of the netmap is empty, it will try to allocate
1177 a batch of items if there are enough resources and add corresponding nodes to the begining
1178 of the Recycled doubly linked list of the netmap. Otherwise, it will directly remove
1179 the fist node entry of the Recycled doubly linked list and return the corresponding item.
1181 If Map is NULL, then ASSERT().
1183 @param[in, out] Map The netmap to allocate item for.
1185 @return The allocated item. If NULL, the
1186 allocation failed due to resource limit.
1198 ASSERT (Map
!= NULL
);
1200 Head
= &Map
->Recycled
;
1202 if (IsListEmpty (Head
)) {
1203 for (Index
= 0; Index
< NET_MAP_INCREAMENT
; Index
++) {
1204 Item
= AllocatePool (sizeof (NET_MAP_ITEM
));
1214 InsertHeadList (Head
, &Item
->Link
);
1218 Item
= NET_LIST_HEAD (Head
, NET_MAP_ITEM
, Link
);
1219 NetListRemoveHead (Head
);
1226 Allocate an item to save the <Key, Value> pair to the head of the netmap.
1228 Allocate an item to save the <Key, Value> pair and add corresponding node entry
1229 to the beginning of the Used doubly linked list. The number of the <Key, Value>
1230 pairs in the netmap increase by 1.
1232 If Map is NULL, then ASSERT().
1234 @param[in, out] Map The netmap to insert into.
1235 @param[in] Key The user's key.
1236 @param[in] Value The user's value for the key.
1238 @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.
1239 @retval EFI_SUCCESS The item is inserted to the head.
1245 IN OUT NET_MAP
*Map
,
1247 IN VOID
*Value OPTIONAL
1252 ASSERT (Map
!= NULL
);
1254 Item
= NetMapAllocItem (Map
);
1257 return EFI_OUT_OF_RESOURCES
;
1261 Item
->Value
= Value
;
1262 InsertHeadList (&Map
->Used
, &Item
->Link
);
1270 Allocate an item to save the <Key, Value> pair to the tail of the netmap.
1272 Allocate an item to save the <Key, Value> pair and add corresponding node entry
1273 to the tail of the Used doubly linked list. The number of the <Key, Value>
1274 pairs in the netmap increase by 1.
1276 If Map is NULL, then ASSERT().
1278 @param[in, out] Map The netmap to insert into.
1279 @param[in] Key The user's key.
1280 @param[in] Value The user's value for the key.
1282 @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.
1283 @retval EFI_SUCCESS The item is inserted to the tail.
1289 IN OUT NET_MAP
*Map
,
1291 IN VOID
*Value OPTIONAL
1296 ASSERT (Map
!= NULL
);
1298 Item
= NetMapAllocItem (Map
);
1301 return EFI_OUT_OF_RESOURCES
;
1305 Item
->Value
= Value
;
1306 InsertTailList (&Map
->Used
, &Item
->Link
);
1315 Check whether the item is in the Map and return TRUE if it is.
1317 @param[in] Map The netmap to search within.
1318 @param[in] Item The item to search.
1320 @return TRUE if the item is in the netmap, otherwise FALSE.
1326 IN NET_MAP_ITEM
*Item
1329 LIST_ENTRY
*ListEntry
;
1331 NET_LIST_FOR_EACH (ListEntry
, &Map
->Used
) {
1332 if (ListEntry
== &Item
->Link
) {
1342 Find the key in the netmap and returns the point to the item contains the Key.
1344 Iterate the Used doubly linked list of the netmap to get every item. Compare the key of every
1345 item with the key to search. It returns the point to the item contains the Key if found.
1347 If Map is NULL, then ASSERT().
1349 @param[in] Map The netmap to search within.
1350 @param[in] Key The key to search.
1352 @return The point to the item contains the Key, or NULL if Key isn't in the map.
1365 ASSERT (Map
!= NULL
);
1367 NET_LIST_FOR_EACH (Entry
, &Map
->Used
) {
1368 Item
= NET_LIST_USER_STRUCT (Entry
, NET_MAP_ITEM
, Link
);
1370 if (Item
->Key
== Key
) {
1380 Remove the node entry of the item from the netmap and return the key of the removed item.
1382 Remove the node entry of the item from the Used doubly linked list of the netmap.
1383 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
1384 entry of the item to the Recycled doubly linked list of the netmap. If Value is not NULL,
1385 Value will point to the value of the item. It returns the key of the removed item.
1387 If Map is NULL, then ASSERT().
1388 If Item is NULL, then ASSERT().
1389 if item in not in the netmap, then ASSERT().
1391 @param[in, out] Map The netmap to remove the item from.
1392 @param[in, out] Item The item to remove.
1393 @param[out] Value The variable to receive the value if not NULL.
1395 @return The key of the removed item.
1401 IN OUT NET_MAP
*Map
,
1402 IN OUT NET_MAP_ITEM
*Item
,
1403 OUT VOID
**Value OPTIONAL
1406 ASSERT ((Map
!= NULL
) && (Item
!= NULL
));
1407 ASSERT (NetItemInMap (Map
, Item
));
1409 RemoveEntryList (&Item
->Link
);
1411 InsertHeadList (&Map
->Recycled
, &Item
->Link
);
1413 if (Value
!= NULL
) {
1414 *Value
= Item
->Value
;
1422 Remove the first node entry on the netmap and return the key of the removed item.
1424 Remove the first node entry from the Used doubly linked list of the netmap.
1425 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
1426 entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,
1427 parameter Value will point to the value of the item. It returns the key of the removed item.
1429 If Map is NULL, then ASSERT().
1430 If the Used doubly linked list is empty, then ASSERT().
1432 @param[in, out] Map The netmap to remove the head from.
1433 @param[out] Value The variable to receive the value if not NULL.
1435 @return The key of the item removed.
1441 IN OUT NET_MAP
*Map
,
1442 OUT VOID
**Value OPTIONAL
1448 // Often, it indicates a programming error to remove
1449 // the first entry in an empty list
1451 ASSERT (Map
&& !IsListEmpty (&Map
->Used
));
1453 Item
= NET_LIST_HEAD (&Map
->Used
, NET_MAP_ITEM
, Link
);
1454 RemoveEntryList (&Item
->Link
);
1456 InsertHeadList (&Map
->Recycled
, &Item
->Link
);
1458 if (Value
!= NULL
) {
1459 *Value
= Item
->Value
;
1467 Remove the last node entry on the netmap and return the key of the removed item.
1469 Remove the last node entry from the Used doubly linked list of the netmap.
1470 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
1471 entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,
1472 parameter Value will point to the value of the item. It returns the key of the removed item.
1474 If Map is NULL, then ASSERT().
1475 If the Used doubly linked list is empty, then ASSERT().
1477 @param[in, out] Map The netmap to remove the tail from.
1478 @param[out] Value The variable to receive the value if not NULL.
1480 @return The key of the item removed.
1486 IN OUT NET_MAP
*Map
,
1487 OUT VOID
**Value OPTIONAL
1493 // Often, it indicates a programming error to remove
1494 // the last entry in an empty list
1496 ASSERT (Map
&& !IsListEmpty (&Map
->Used
));
1498 Item
= NET_LIST_TAIL (&Map
->Used
, NET_MAP_ITEM
, Link
);
1499 RemoveEntryList (&Item
->Link
);
1501 InsertHeadList (&Map
->Recycled
, &Item
->Link
);
1503 if (Value
!= NULL
) {
1504 *Value
= Item
->Value
;
1512 Iterate through the netmap and call CallBack for each item.
1514 It will contiue the traverse if CallBack returns EFI_SUCCESS, otherwise, break
1515 from the loop. It returns the CallBack's last return value. This function is
1516 delete safe for the current item.
1518 If Map is NULL, then ASSERT().
1519 If CallBack is NULL, then ASSERT().
1521 @param[in] Map The Map to iterate through.
1522 @param[in] CallBack The callback function to call for each item.
1523 @param[in] Arg The opaque parameter to the callback.
1525 @retval EFI_SUCCESS There is no item in the netmap or CallBack for each item
1527 @retval Others It returns the CallBack's last return value.
1534 IN NET_MAP_CALLBACK CallBack
,
1535 IN VOID
*Arg OPTIONAL
1545 ASSERT ((Map
!= NULL
) && (CallBack
!= NULL
));
1549 if (IsListEmpty (Head
)) {
1553 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, Head
) {
1554 Item
= NET_LIST_USER_STRUCT (Entry
, NET_MAP_ITEM
, Link
);
1555 Result
= CallBack (Map
, Item
, Arg
);
1557 if (EFI_ERROR (Result
)) {
1567 This is the default unload handle for all the network drivers.
1569 Disconnect the driver specified by ImageHandle from all the devices in the handle database.
1570 Uninstall all the protocols installed in the driver entry point.
1572 @param[in] ImageHandle The drivers' driver image.
1574 @retval EFI_SUCCESS The image is unloaded.
1575 @retval Others Failed to unload the image.
1580 NetLibDefaultUnload (
1581 IN EFI_HANDLE ImageHandle
1585 EFI_HANDLE
*DeviceHandleBuffer
;
1586 UINTN DeviceHandleCount
;
1588 EFI_DRIVER_BINDING_PROTOCOL
*DriverBinding
;
1589 EFI_COMPONENT_NAME_PROTOCOL
*ComponentName
;
1590 EFI_COMPONENT_NAME2_PROTOCOL
*ComponentName2
;
1593 // Get the list of all the handles in the handle database.
1594 // If there is an error getting the list, then the unload
1597 Status
= gBS
->LocateHandleBuffer (
1605 if (EFI_ERROR (Status
)) {
1610 // Disconnect the driver specified by ImageHandle from all
1611 // the devices in the handle database.
1613 for (Index
= 0; Index
< DeviceHandleCount
; Index
++) {
1614 Status
= gBS
->DisconnectController (
1615 DeviceHandleBuffer
[Index
],
1622 // Uninstall all the protocols installed in the driver entry point
1624 for (Index
= 0; Index
< DeviceHandleCount
; Index
++) {
1625 Status
= gBS
->HandleProtocol (
1626 DeviceHandleBuffer
[Index
],
1627 &gEfiDriverBindingProtocolGuid
,
1628 (VOID
**) &DriverBinding
1631 if (EFI_ERROR (Status
)) {
1635 if (DriverBinding
->ImageHandle
!= ImageHandle
) {
1639 gBS
->UninstallProtocolInterface (
1641 &gEfiDriverBindingProtocolGuid
,
1644 Status
= gBS
->HandleProtocol (
1645 DeviceHandleBuffer
[Index
],
1646 &gEfiComponentNameProtocolGuid
,
1647 (VOID
**) &ComponentName
1649 if (!EFI_ERROR (Status
)) {
1650 gBS
->UninstallProtocolInterface (
1652 &gEfiComponentNameProtocolGuid
,
1657 Status
= gBS
->HandleProtocol (
1658 DeviceHandleBuffer
[Index
],
1659 &gEfiComponentName2ProtocolGuid
,
1660 (VOID
**) &ComponentName2
1662 if (!EFI_ERROR (Status
)) {
1663 gBS
->UninstallProtocolInterface (
1665 &gEfiComponentName2ProtocolGuid
,
1672 // Free the buffer containing the list of handles from the handle database
1674 if (DeviceHandleBuffer
!= NULL
) {
1675 gBS
->FreePool (DeviceHandleBuffer
);
1684 Create a child of the service that is identified by ServiceBindingGuid.
1686 Get the ServiceBinding Protocol first, then use it to create a child.
1688 If ServiceBindingGuid is NULL, then ASSERT().
1689 If ChildHandle is NULL, then ASSERT().
1691 @param[in] Controller The controller which has the service installed.
1692 @param[in] Image The image handle used to open service.
1693 @param[in] ServiceBindingGuid The service's Guid.
1694 @param[in, out] ChildHandle The handle to receive the create child.
1696 @retval EFI_SUCCESS The child is successfully created.
1697 @retval Others Failed to create the child.
1702 NetLibCreateServiceChild (
1703 IN EFI_HANDLE Controller
,
1704 IN EFI_HANDLE Image
,
1705 IN EFI_GUID
*ServiceBindingGuid
,
1706 IN OUT EFI_HANDLE
*ChildHandle
1710 EFI_SERVICE_BINDING_PROTOCOL
*Service
;
1713 ASSERT ((ServiceBindingGuid
!= NULL
) && (ChildHandle
!= NULL
));
1716 // Get the ServiceBinding Protocol
1718 Status
= gBS
->OpenProtocol (
1724 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1727 if (EFI_ERROR (Status
)) {
1734 Status
= Service
->CreateChild (Service
, ChildHandle
);
1740 Destory a child of the service that is identified by ServiceBindingGuid.
1742 Get the ServiceBinding Protocol first, then use it to destroy a child.
1744 If ServiceBindingGuid is NULL, then ASSERT().
1746 @param[in] Controller The controller which has the service installed.
1747 @param[in] Image The image handle used to open service.
1748 @param[in] ServiceBindingGuid The service's Guid.
1749 @param[in] ChildHandle The child to destory.
1751 @retval EFI_SUCCESS The child is successfully destoried.
1752 @retval Others Failed to destory the child.
1757 NetLibDestroyServiceChild (
1758 IN EFI_HANDLE Controller
,
1759 IN EFI_HANDLE Image
,
1760 IN EFI_GUID
*ServiceBindingGuid
,
1761 IN EFI_HANDLE ChildHandle
1765 EFI_SERVICE_BINDING_PROTOCOL
*Service
;
1767 ASSERT (ServiceBindingGuid
!= NULL
);
1770 // Get the ServiceBinding Protocol
1772 Status
= gBS
->OpenProtocol (
1778 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1781 if (EFI_ERROR (Status
)) {
1786 // destory the child
1788 Status
= Service
->DestroyChild (Service
, ChildHandle
);
1793 Get handle with Simple Network Protocol installed on it.
1795 There should be MNP Service Binding Protocol installed on the input ServiceHandle.
1796 If Simple Network Protocol is already installed on the ServiceHandle, the
1797 ServiceHandle will be returned. If SNP is not installed on the ServiceHandle,
1798 try to find its parent handle with SNP installed.
1800 @param[in] ServiceHandle The handle where network service binding protocols are
1802 @param[out] Snp The pointer to store the address of the SNP instance.
1803 This is an optional parameter that may be NULL.
1805 @return The SNP handle, or NULL if not found.
1810 NetLibGetSnpHandle (
1811 IN EFI_HANDLE ServiceHandle
,
1812 OUT EFI_SIMPLE_NETWORK_PROTOCOL
**Snp OPTIONAL
1816 EFI_SIMPLE_NETWORK_PROTOCOL
*SnpInstance
;
1817 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1818 EFI_HANDLE SnpHandle
;
1821 // Try to open SNP from ServiceHandle
1824 Status
= gBS
->HandleProtocol (ServiceHandle
, &gEfiSimpleNetworkProtocolGuid
, (VOID
**) &SnpInstance
);
1825 if (!EFI_ERROR (Status
)) {
1829 return ServiceHandle
;
1833 // Failed to open SNP, try to get SNP handle by LocateDevicePath()
1835 DevicePath
= DevicePathFromHandle (ServiceHandle
);
1836 if (DevicePath
== NULL
) {
1841 Status
= gBS
->LocateDevicePath (&gEfiSimpleNetworkProtocolGuid
, &DevicePath
, &SnpHandle
);
1842 if (EFI_ERROR (Status
)) {
1844 // Failed to find SNP handle
1849 Status
= gBS
->HandleProtocol (SnpHandle
, &gEfiSimpleNetworkProtocolGuid
, (VOID
**) &SnpInstance
);
1850 if (!EFI_ERROR (Status
)) {
1861 Retrieve VLAN ID of a VLAN device handle.
1863 Search VLAN device path node in Device Path of specified ServiceHandle and
1864 return its VLAN ID. If no VLAN device path node found, then this ServiceHandle
1865 is not a VLAN device handle, and 0 will be returned.
1867 @param[in] ServiceHandle The handle where network service binding protocols are
1870 @return VLAN ID of the device handle, or 0 if not a VLAN device.
1876 IN EFI_HANDLE ServiceHandle
1879 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1880 EFI_DEVICE_PATH_PROTOCOL
*Node
;
1882 DevicePath
= DevicePathFromHandle (ServiceHandle
);
1883 if (DevicePath
== NULL
) {
1888 while (!IsDevicePathEnd (Node
)) {
1889 if (Node
->Type
== MESSAGING_DEVICE_PATH
&& Node
->SubType
== MSG_VLAN_DP
) {
1890 return ((VLAN_DEVICE_PATH
*) Node
)->VlanId
;
1892 Node
= NextDevicePathNode (Node
);
1899 Find VLAN device handle with specified VLAN ID.
1901 The VLAN child device handle is created by VLAN Config Protocol on ControllerHandle.
1902 This function will append VLAN device path node to the parent device path,
1903 and then use LocateDevicePath() to find the correct VLAN device handle.
1905 @param[in] ControllerHandle The handle where network service binding protocols are
1907 @param[in] VlanId The configured VLAN ID for the VLAN device.
1909 @return The VLAN device handle, or NULL if not found.
1914 NetLibGetVlanHandle (
1915 IN EFI_HANDLE ControllerHandle
,
1919 EFI_DEVICE_PATH_PROTOCOL
*ParentDevicePath
;
1920 EFI_DEVICE_PATH_PROTOCOL
*VlanDevicePath
;
1921 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1922 VLAN_DEVICE_PATH VlanNode
;
1925 ParentDevicePath
= DevicePathFromHandle (ControllerHandle
);
1926 if (ParentDevicePath
== NULL
) {
1931 // Construct VLAN device path
1933 CopyMem (&VlanNode
, &mNetVlanDevicePathTemplate
, sizeof (VLAN_DEVICE_PATH
));
1934 VlanNode
.VlanId
= VlanId
;
1935 VlanDevicePath
= AppendDevicePathNode (
1937 (EFI_DEVICE_PATH_PROTOCOL
*) &VlanNode
1939 if (VlanDevicePath
== NULL
) {
1944 // Find VLAN device handle
1947 DevicePath
= VlanDevicePath
;
1948 gBS
->LocateDevicePath (
1949 &gEfiDevicePathProtocolGuid
,
1953 if (!IsDevicePathEnd (DevicePath
)) {
1955 // Device path is not exactly match
1960 FreePool (VlanDevicePath
);
1965 Get MAC address associated with the network service handle.
1967 There should be MNP Service Binding Protocol installed on the input ServiceHandle.
1968 If SNP is installed on the ServiceHandle or its parent handle, MAC address will
1969 be retrieved from SNP. If no SNP found, try to get SNP mode data use MNP.
1971 @param[in] ServiceHandle The handle where network service binding protocols are
1973 @param[out] MacAddress The pointer to store the returned MAC address.
1974 @param[out] AddressSize The length of returned MAC address.
1976 @retval EFI_SUCCESS MAC address is returned successfully.
1977 @retval Others Failed to get SNP mode data.
1982 NetLibGetMacAddress (
1983 IN EFI_HANDLE ServiceHandle
,
1984 OUT EFI_MAC_ADDRESS
*MacAddress
,
1985 OUT UINTN
*AddressSize
1989 EFI_SIMPLE_NETWORK_PROTOCOL
*Snp
;
1990 EFI_SIMPLE_NETWORK_MODE
*SnpMode
;
1991 EFI_SIMPLE_NETWORK_MODE SnpModeData
;
1992 EFI_MANAGED_NETWORK_PROTOCOL
*Mnp
;
1993 EFI_SERVICE_BINDING_PROTOCOL
*MnpSb
;
1994 EFI_HANDLE
*SnpHandle
;
1995 EFI_HANDLE MnpChildHandle
;
1997 ASSERT (MacAddress
!= NULL
);
1998 ASSERT (AddressSize
!= NULL
);
2001 // Try to get SNP handle
2004 SnpHandle
= NetLibGetSnpHandle (ServiceHandle
, &Snp
);
2005 if (SnpHandle
!= NULL
) {
2007 // SNP found, use it directly
2009 SnpMode
= Snp
->Mode
;
2012 // Failed to get SNP handle, try to get MAC address from MNP
2014 MnpChildHandle
= NULL
;
2015 Status
= gBS
->HandleProtocol (
2017 &gEfiManagedNetworkServiceBindingProtocolGuid
,
2020 if (EFI_ERROR (Status
)) {
2025 // Create a MNP child
2027 Status
= MnpSb
->CreateChild (MnpSb
, &MnpChildHandle
);
2028 if (EFI_ERROR (Status
)) {
2033 // Open MNP protocol
2035 Status
= gBS
->HandleProtocol (
2037 &gEfiManagedNetworkProtocolGuid
,
2040 if (EFI_ERROR (Status
)) {
2045 // Try to get SNP mode from MNP
2047 Status
= Mnp
->GetModeData (Mnp
, NULL
, &SnpModeData
);
2048 if (EFI_ERROR (Status
)) {
2051 SnpMode
= &SnpModeData
;
2054 // Destroy the MNP child
2056 MnpSb
->DestroyChild (MnpSb
, MnpChildHandle
);
2059 *AddressSize
= SnpMode
->HwAddressSize
;
2060 CopyMem (MacAddress
->Addr
, SnpMode
->CurrentAddress
.Addr
, SnpMode
->HwAddressSize
);
2066 Convert MAC address of the NIC associated with specified Service Binding Handle
2067 to a unicode string. Callers are responsible for freeing the string storage.
2069 Locate simple network protocol associated with the Service Binding Handle and
2070 get the mac address from SNP. Then convert the mac address into a unicode
2071 string. It takes 2 unicode characters to represent a 1 byte binary buffer.
2072 Plus one unicode character for the null-terminator.
2074 @param[in] ServiceHandle The handle where network service binding protocol is
2076 @param[in] ImageHandle The image handle used to act as the agent handle to
2077 get the simple network protocol.
2078 @param[out] MacString The pointer to store the address of the string
2079 representation of the mac address.
2081 @retval EFI_SUCCESS Convert the mac address a unicode string successfully.
2082 @retval EFI_OUT_OF_RESOURCES There are not enough memory resource.
2083 @retval Others Failed to open the simple network protocol.
2088 NetLibGetMacString (
2089 IN EFI_HANDLE ServiceHandle
,
2090 IN EFI_HANDLE ImageHandle
,
2091 OUT CHAR16
**MacString
2095 EFI_MAC_ADDRESS MacAddress
;
2097 UINTN HwAddressSize
;
2102 ASSERT (MacString
!= NULL
);
2105 // Get MAC address of the network device
2107 Status
= NetLibGetMacAddress (ServiceHandle
, &MacAddress
, &HwAddressSize
);
2108 if (EFI_ERROR (Status
)) {
2113 // It takes 2 unicode characters to represent a 1 byte binary buffer.
2114 // If VLAN is configured, it will need extra 5 characters like "\0005".
2115 // Plus one unicode character for the null-terminator.
2117 String
= AllocateZeroPool ((2 * HwAddressSize
+ 5 + 1) * sizeof (CHAR16
));
2118 if (String
== NULL
) {
2119 return EFI_OUT_OF_RESOURCES
;
2121 *MacString
= String
;
2124 // Convert the MAC address into a unicode string.
2126 HwAddress
= &MacAddress
.Addr
[0];
2127 for (Index
= 0; Index
< HwAddressSize
; Index
++) {
2128 String
+= UnicodeValueToString (String
, PREFIX_ZERO
| RADIX_HEX
, *(HwAddress
++), 2);
2132 // Append VLAN ID if any
2134 VlanId
= NetLibGetVlanId (ServiceHandle
);
2137 String
+= UnicodeValueToString (String
, PREFIX_ZERO
| RADIX_HEX
, VlanId
, 4);
2141 // Null terminate the Unicode string
2149 Check the default address used by the IPv4 driver is static or dynamic (acquired
2152 If the controller handle does not have the NIC Ip4 Config Protocol installed, the
2153 default address is static. If the EFI variable to save the configuration is not found,
2154 the default address is static. Otherwise, get the result from the EFI variable which
2155 saving the configuration.
2157 @param[in] Controller The controller handle which has the NIC Ip4 Config Protocol
2158 relative with the default address to judge.
2160 @retval TRUE If the default address is static.
2161 @retval FALSE If the default address is acquired from DHCP.
2165 NetLibDefaultAddressIsStatic (
2166 IN EFI_HANDLE Controller
2170 EFI_HII_CONFIG_ROUTING_PROTOCOL
*HiiConfigRouting
;
2172 NIC_IP4_CONFIG_INFO
*ConfigInfo
;
2174 EFI_STRING ConfigHdr
;
2175 EFI_STRING ConfigResp
;
2176 EFI_STRING AccessProgress
;
2177 EFI_STRING AccessResults
;
2183 AccessProgress
= NULL
;
2184 AccessResults
= NULL
;
2187 Status
= gBS
->LocateProtocol (
2188 &gEfiHiiConfigRoutingProtocolGuid
,
2190 (VOID
**) &HiiConfigRouting
2192 if (EFI_ERROR (Status
)) {
2197 // Construct config request string header
2199 ConfigHdr
= HiiConstructConfigHdr (&gEfiNicIp4ConfigVariableGuid
, EFI_NIC_IP4_CONFIG_VARIABLE
, Controller
);
2200 if (ConfigHdr
== NULL
) {
2204 Len
= StrLen (ConfigHdr
);
2205 ConfigResp
= AllocateZeroPool ((Len
+ NIC_ITEM_CONFIG_SIZE
* 2 + 100) * sizeof (CHAR16
));
2206 if (ConfigResp
== NULL
) {
2209 StrCpy (ConfigResp
, ConfigHdr
);
2211 String
= ConfigResp
+ Len
;
2214 (8 + 4 + 7 + 4 + 1) * sizeof (CHAR16
),
2215 L
"&OFFSET=%04X&WIDTH=%04X",
2216 OFFSET_OF (NIC_IP4_CONFIG_INFO
, Source
),
2220 Status
= HiiConfigRouting
->ExtractConfig (
2226 if (EFI_ERROR (Status
)) {
2230 ConfigInfo
= AllocateZeroPool (sizeof (NIC_ITEM_CONFIG_SIZE
));
2231 if (ConfigInfo
== NULL
) {
2235 ConfigInfo
->Source
= IP4_CONFIG_SOURCE_STATIC
;
2236 Len
= NIC_ITEM_CONFIG_SIZE
;
2237 Status
= HiiConfigRouting
->ConfigToBlock (
2240 (UINT8
*) ConfigInfo
,
2244 if (EFI_ERROR (Status
)) {
2248 IsStatic
= (BOOLEAN
) (ConfigInfo
->Source
== IP4_CONFIG_SOURCE_STATIC
);
2252 if (AccessResults
!= NULL
) {
2253 FreePool (AccessResults
);
2255 if (ConfigInfo
!= NULL
) {
2256 FreePool (ConfigInfo
);
2258 if (ConfigResp
!= NULL
) {
2259 FreePool (ConfigResp
);
2261 if (ConfigHdr
!= NULL
) {
2262 FreePool (ConfigHdr
);
2269 Create an IPv4 device path node.
2271 The header type of IPv4 device path node is MESSAGING_DEVICE_PATH.
2272 The header subtype of IPv4 device path node is MSG_IPv4_DP.
2273 The length of the IPv4 device path node in bytes is 19.
2274 Get other info from parameters to make up the whole IPv4 device path node.
2276 @param[in, out] Node Pointer to the IPv4 device path node.
2277 @param[in] Controller The controller handle.
2278 @param[in] LocalIp The local IPv4 address.
2279 @param[in] LocalPort The local port.
2280 @param[in] RemoteIp The remote IPv4 address.
2281 @param[in] RemotePort The remote port.
2282 @param[in] Protocol The protocol type in the IP header.
2283 @param[in] UseDefaultAddress Whether this instance is using default address or not.
2288 NetLibCreateIPv4DPathNode (
2289 IN OUT IPv4_DEVICE_PATH
*Node
,
2290 IN EFI_HANDLE Controller
,
2291 IN IP4_ADDR LocalIp
,
2292 IN UINT16 LocalPort
,
2293 IN IP4_ADDR RemoteIp
,
2294 IN UINT16 RemotePort
,
2296 IN BOOLEAN UseDefaultAddress
2299 Node
->Header
.Type
= MESSAGING_DEVICE_PATH
;
2300 Node
->Header
.SubType
= MSG_IPv4_DP
;
2301 SetDevicePathNodeLength (&Node
->Header
, 19);
2303 CopyMem (&Node
->LocalIpAddress
, &LocalIp
, sizeof (EFI_IPv4_ADDRESS
));
2304 CopyMem (&Node
->RemoteIpAddress
, &RemoteIp
, sizeof (EFI_IPv4_ADDRESS
));
2306 Node
->LocalPort
= LocalPort
;
2307 Node
->RemotePort
= RemotePort
;
2309 Node
->Protocol
= Protocol
;
2311 if (!UseDefaultAddress
) {
2312 Node
->StaticIpAddress
= TRUE
;
2314 Node
->StaticIpAddress
= NetLibDefaultAddressIsStatic (Controller
);
2319 Create an IPv6 device path node.
2321 The header type of IPv6 device path node is MESSAGING_DEVICE_PATH.
2322 The header subtype of IPv6 device path node is MSG_IPv6_DP.
2323 Get other info from parameters to make up the whole IPv6 device path node.
2325 @param[in, out] Node Pointer to the IPv6 device path node.
2326 @param[in] Controller The controller handle.
2327 @param[in] LocalIp The local IPv6 address.
2328 @param[in] LocalPort The local port.
2329 @param[in] RemoteIp The remote IPv6 address.
2330 @param[in] RemotePort The remote port.
2331 @param[in] Protocol The protocol type in the IP header.
2336 NetLibCreateIPv6DPathNode (
2337 IN OUT IPv6_DEVICE_PATH
*Node
,
2338 IN EFI_HANDLE Controller
,
2339 IN EFI_IPv6_ADDRESS
*LocalIp
,
2340 IN UINT16 LocalPort
,
2341 IN EFI_IPv6_ADDRESS
*RemoteIp
,
2342 IN UINT16 RemotePort
,
2346 Node
->Header
.Type
= MESSAGING_DEVICE_PATH
;
2347 Node
->Header
.SubType
= MSG_IPv6_DP
;
2348 SetDevicePathNodeLength (&Node
->Header
, sizeof (IPv6_DEVICE_PATH
));
2350 CopyMem (&Node
->LocalIpAddress
, LocalIp
, sizeof (EFI_IPv6_ADDRESS
));
2351 CopyMem (&Node
->RemoteIpAddress
, RemoteIp
, sizeof (EFI_IPv6_ADDRESS
));
2353 Node
->LocalPort
= LocalPort
;
2354 Node
->RemotePort
= RemotePort
;
2356 Node
->Protocol
= Protocol
;
2357 Node
->StaticIpAddress
= FALSE
;
2361 Find the UNDI/SNP handle from controller and protocol GUID.
2363 For example, IP will open a MNP child to transmit/receive
2364 packets, when MNP is stopped, IP should also be stopped. IP
2365 needs to find its own private data which is related the IP's
2366 service binding instance that is install on UNDI/SNP handle.
2367 Now, the controller is either a MNP or ARP child handle. But
2368 IP opens these handle BY_DRIVER, use that info, we can get the
2371 @param[in] Controller Then protocol handle to check.
2372 @param[in] ProtocolGuid The protocol that is related with the handle.
2374 @return The UNDI/SNP handle or NULL for errors.
2379 NetLibGetNicHandle (
2380 IN EFI_HANDLE Controller
,
2381 IN EFI_GUID
*ProtocolGuid
2384 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
*OpenBuffer
;
2390 Status
= gBS
->OpenProtocolInformation (
2397 if (EFI_ERROR (Status
)) {
2403 for (Index
= 0; Index
< OpenCount
; Index
++) {
2404 if ((OpenBuffer
[Index
].Attributes
& EFI_OPEN_PROTOCOL_BY_DRIVER
) != 0) {
2405 Handle
= OpenBuffer
[Index
].ControllerHandle
;
2410 gBS
->FreePool (OpenBuffer
);
2415 Convert one Null-terminated ASCII string (decimal dotted) to EFI_IPv4_ADDRESS.
2417 @param[in] String The pointer to the Ascii string.
2418 @param[out] Ip4Address The pointer to the converted IPv4 address.
2420 @retval EFI_SUCCESS Convert to IPv4 address successfully.
2421 @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip4Address is NULL.
2425 NetLibAsciiStrToIp4 (
2426 IN CONST CHAR8
*String
,
2427 OUT EFI_IPv4_ADDRESS
*Ip4Address
2435 if ((String
== NULL
) || (Ip4Address
== NULL
)) {
2436 return EFI_INVALID_PARAMETER
;
2439 Ip4Str
= (CHAR8
*) String
;
2441 for (Index
= 0; Index
< 4; Index
++) {
2444 while ((*Ip4Str
!= '\0') && (*Ip4Str
!= '.')) {
2449 // The IPv4 address is X.X.X.X
2451 if (*Ip4Str
== '.') {
2453 return EFI_INVALID_PARAMETER
;
2457 return EFI_INVALID_PARAMETER
;
2462 // Convert the string to IPv4 address. AsciiStrDecimalToUintn stops at the
2463 // first character that is not a valid decimal character, '.' or '\0' here.
2465 NodeVal
= AsciiStrDecimalToUintn (TempStr
);
2466 if (NodeVal
> 0xFF) {
2467 return EFI_INVALID_PARAMETER
;
2470 Ip4Address
->Addr
[Index
] = (UINT8
) NodeVal
;
2480 Convert one Null-terminated ASCII string to EFI_IPv6_ADDRESS. The format of the
2481 string is defined in RFC 4291 - Text Pepresentation of Addresses.
2483 @param[in] String The pointer to the Ascii string.
2484 @param[out] Ip6Address The pointer to the converted IPv6 address.
2486 @retval EFI_SUCCESS Convert to IPv6 address successfully.
2487 @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip6Address is NULL.
2491 NetLibAsciiStrToIp6 (
2492 IN CONST CHAR8
*String
,
2493 OUT EFI_IPv6_ADDRESS
*Ip6Address
2507 if ((String
== NULL
) || (Ip6Address
== NULL
)) {
2508 return EFI_INVALID_PARAMETER
;
2511 Ip6Str
= (CHAR8
*) String
;
2515 // An IPv6 address leading with : looks strange.
2517 if (*Ip6Str
== ':') {
2518 if (*(Ip6Str
+ 1) != ':') {
2519 return EFI_INVALID_PARAMETER
;
2525 ZeroMem (Ip6Address
, sizeof (EFI_IPv6_ADDRESS
));
2532 for (Index
= 0; Index
< 15; Index
= (UINT8
) (Index
+ 2)) {
2535 while ((*Ip6Str
!= '\0') && (*Ip6Str
!= ':')) {
2539 if ((*Ip6Str
== '\0') && (Index
!= 14)) {
2540 return EFI_INVALID_PARAMETER
;
2543 if (*Ip6Str
== ':') {
2544 if (*(Ip6Str
+ 1) == ':') {
2545 if ((*(Ip6Str
+ 2) == '0') || (NodeCnt
> 6)) {
2547 // ::0 looks strange. report error to user.
2549 return EFI_INVALID_PARAMETER
;
2553 // Skip the abbreviation part of IPv6 address.
2555 TempStr2
= Ip6Str
+ 2;
2556 while ((*TempStr2
!= '\0')) {
2557 if (*TempStr2
== ':') {
2558 if (*(TempStr2
+ 1) == ':') {
2560 // :: can only appear once in IPv6 address.
2562 return EFI_INVALID_PARAMETER
;
2566 if (TailNodeCnt
>= (AllowedCnt
- NodeCnt
)) {
2568 // :: indicates one or more groups of 16 bits of zeros.
2570 return EFI_INVALID_PARAMETER
;
2580 Ip6Str
= Ip6Str
+ 2;
2584 if ((Short
&& (NodeCnt
> 6)) || (!Short
&& (NodeCnt
> 7))) {
2586 // There are more than 8 groups of 16 bits of zeros.
2588 return EFI_INVALID_PARAMETER
;
2594 // Convert the string to IPv6 address. AsciiStrHexToUintn stops at the first
2595 // character that is not a valid hexadecimal character, ':' or '\0' here.
2597 NodeVal
= AsciiStrHexToUintn (TempStr
);
2598 if ((NodeVal
> 0xFFFF) || (Index
> 14)) {
2599 return EFI_INVALID_PARAMETER
;
2602 Ip6Address
->Addr
[Index
] = (UINT8
) (NodeVal
>> 8);
2603 Ip6Address
->Addr
[Index
+ 1] = (UINT8
) (NodeVal
& 0xFF);
2606 // Skip the groups of zeros by ::
2608 if (Short
&& Update
) {
2609 Index
= (UINT8
) (16 - (TailNodeCnt
+ 2) * 2);
2614 if ((!Short
&& Index
!= 16) || (*Ip6Str
!= '\0')) {
2615 return EFI_INVALID_PARAMETER
;
2623 Convert one Null-terminated Unicode string (decimal dotted) to EFI_IPv4_ADDRESS.
2625 @param[in] String The pointer to the Ascii string.
2626 @param[out] Ip4Address The pointer to the converted IPv4 address.
2628 @retval EFI_SUCCESS Convert to IPv4 address successfully.
2629 @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip4Address is NULL.
2630 @retval EFI_OUT_OF_RESOURCES Fail to perform the operation due to lack of resource.
2635 IN CONST CHAR16
*String
,
2636 OUT EFI_IPv4_ADDRESS
*Ip4Address
2642 if ((String
== NULL
) || (Ip4Address
== NULL
)) {
2643 return EFI_INVALID_PARAMETER
;
2646 Ip4Str
= (CHAR8
*) AllocatePool ((StrLen (String
) + 1) * sizeof (CHAR8
));
2647 if (Ip4Str
== NULL
) {
2648 return EFI_OUT_OF_RESOURCES
;
2651 UnicodeStrToAsciiStr (String
, Ip4Str
);
2653 Status
= NetLibAsciiStrToIp4 (Ip4Str
, Ip4Address
);
2662 Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS. The format of
2663 the string is defined in RFC 4291 - Text Pepresentation of Addresses.
2665 @param[in] String The pointer to the Ascii string.
2666 @param[out] Ip6Address The pointer to the converted IPv6 address.
2668 @retval EFI_SUCCESS Convert to IPv6 address successfully.
2669 @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip6Address is NULL.
2670 @retval EFI_OUT_OF_RESOURCES Fail to perform the operation due to lack of resource.
2675 IN CONST CHAR16
*String
,
2676 OUT EFI_IPv6_ADDRESS
*Ip6Address
2682 if ((String
== NULL
) || (Ip6Address
== NULL
)) {
2683 return EFI_INVALID_PARAMETER
;
2686 Ip6Str
= (CHAR8
*) AllocatePool ((StrLen (String
) + 1) * sizeof (CHAR8
));
2687 if (Ip6Str
== NULL
) {
2688 return EFI_OUT_OF_RESOURCES
;
2691 UnicodeStrToAsciiStr (String
, Ip6Str
);
2693 Status
= NetLibAsciiStrToIp6 (Ip6Str
, Ip6Address
);
2701 Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS and prefix length.
2702 The format of the string is defined in RFC 4291 - Text Pepresentation of Addresses
2703 Prefixes: ipv6-address/prefix-length.
2705 @param[in] String The pointer to the Ascii string.
2706 @param[out] Ip6Address The pointer to the converted IPv6 address.
2707 @param[out] PrefixLength The pointer to the converted prefix length.
2709 @retval EFI_SUCCESS Convert to IPv6 address successfully.
2710 @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip6Address is NULL.
2711 @retval EFI_OUT_OF_RESOURCES Fail to perform the operation due to lack of resource.
2715 NetLibStrToIp6andPrefix (
2716 IN CONST CHAR16
*String
,
2717 OUT EFI_IPv6_ADDRESS
*Ip6Address
,
2718 OUT UINT8
*PrefixLength
2727 if ((String
== NULL
) || (Ip6Address
== NULL
) || (PrefixLength
== NULL
)) {
2728 return EFI_INVALID_PARAMETER
;
2731 Ip6Str
= (CHAR8
*) AllocatePool ((StrLen (String
) + 1) * sizeof (CHAR8
));
2732 if (Ip6Str
== NULL
) {
2733 return EFI_OUT_OF_RESOURCES
;
2736 UnicodeStrToAsciiStr (String
, Ip6Str
);
2739 // Get the sub string describing prefix length.
2742 while (*TempStr
!= '\0' && (*TempStr
!= '/')) {
2746 if (*TempStr
== '/') {
2747 PrefixStr
= TempStr
+ 1;
2753 // Get the sub string describing IPv6 address and convert it.
2757 Status
= NetLibAsciiStrToIp6 (Ip6Str
, Ip6Address
);
2758 if (EFI_ERROR (Status
)) {
2763 // Convert the string to prefix length
2766 if (PrefixStr
!= NULL
) {
2768 Status
= EFI_INVALID_PARAMETER
;
2770 while (*PrefixStr
!= '\0') {
2771 if (NET_IS_DIGIT (*PrefixStr
)) {
2772 Length
= (UINT8
) (Length
* 10 + (*PrefixStr
- '0'));
2773 if (Length
>= IP6_PREFIX_NUM
) {
2784 *PrefixLength
= Length
;
2785 Status
= EFI_SUCCESS
;