/** @file\r
Network library.\r
\r
-Copyright (c) 2005 - 2009, Intel Corporation.<BR>\r
-All rights reserved. This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.<BR>\r
+(C) Copyright 2015 Hewlett Packard Enterprise Development LP<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
**/\r
\r
#include <Uefi.h>\r
\r
+#include <IndustryStandard/SmBios.h>\r
+\r
#include <Protocol/DriverBinding.h>\r
#include <Protocol/ServiceBinding.h>\r
#include <Protocol/SimpleNetwork.h>\r
+#include <Protocol/AdapterInformation.h>\r
#include <Protocol/ManagedNetwork.h>\r
-#include <Protocol/HiiConfigRouting.h>\r
+#include <Protocol/Ip4Config2.h>\r
#include <Protocol/ComponentName.h>\r
#include <Protocol/ComponentName2.h>\r
\r
-#include <Guid/NicIp4ConfigNvData.h>\r
+#include <Guid/SmBios.h>\r
\r
#include <Library/NetLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/DevicePathLib.h>\r
-#include <Library/HiiLib.h>\r
#include <Library/PrintLib.h>\r
+#include <Library/UefiLib.h>\r
\r
-#define NIC_ITEM_CONFIG_SIZE sizeof (NIC_IP4_CONFIG_INFO) + sizeof (EFI_IP4_ROUTE_TABLE) * MAX_IP4_CONFIG_IN_VARIABLE\r
+#define NIC_ITEM_CONFIG_SIZE (sizeof (NIC_IP4_CONFIG_INFO) + sizeof (EFI_IP4_ROUTE_TABLE) * MAX_IP4_CONFIG_IN_VARIABLE)\r
+#define DEFAULT_ZERO_START ((UINTN) ~0)\r
\r
//\r
// All the supported IP4 maskes in host byte order.\r
"Dec"\r
};\r
\r
+//\r
+// VLAN device path node template\r
+//\r
+GLOBAL_REMOVE_IF_UNREFERENCED VLAN_DEVICE_PATH mNetVlanDevicePathTemplate = {\r
+ {\r
+ MESSAGING_DEVICE_PATH,\r
+ MSG_VLAN_DP,\r
+ {\r
+ (UINT8) (sizeof (VLAN_DEVICE_PATH)),\r
+ (UINT8) ((sizeof (VLAN_DEVICE_PATH)) >> 8)\r
+ }\r
+ },\r
+ 0\r
+};\r
+\r
/**\r
Locate the handles that support SNP, then open one of them\r
to send the syslog packets. The caller isn't required to close\r
fill in the source MAC because it will try to locate a SNP each\r
time it is called to avoid the problem if SNP is unloaded.\r
This code snip is copied from MNP.\r
+ If Packet is NULL, then ASSERT().\r
\r
@param[in] Packet The Syslog packet\r
@param[in] Length The length of the packet\r
EFI_EVENT TimeoutEvent;\r
UINT8 *TxBuf;\r
\r
+ ASSERT (Packet != NULL);\r
+\r
Snp = SyslogLocateSnp ();\r
\r
if (Snp == NULL) {\r
Build a syslog packet, including the Ethernet/Ip/Udp headers\r
and user's message.\r
\r
- @param[in] Level Syslog servity level\r
+ @param[in] Level Syslog severity level\r
@param[in] Module The module that generates the log\r
@param[in] File The file that contains the current log\r
@param[in] Line The line of code in the File that contains the current log\r
@param[in] BufLen The lenght of the Buf\r
@param[out] Buf The buffer to put the packet data\r
\r
- @return The length of the syslog packet built.\r
+ @return The length of the syslog packet built, 0 represents no packet is built.\r
\r
**/\r
UINT32\r
OUT CHAR8 *Buf\r
)\r
{\r
+ EFI_STATUS Status;\r
ETHER_HEAD *Ether;\r
IP4_HEAD *Ip4;\r
EFI_UDP_HEADER *Udp4;\r
// Build the syslog message body with <PRI> Timestamp machine module Message\r
//\r
Pri = ((NET_SYSLOG_FACILITY & 31) << 3) | (Level & 7);\r
- gRT->GetTime (&Time, NULL);\r
+ Status = gRT->GetTime (&Time, NULL);\r
+ if (EFI_ERROR (Status)) {\r
+ return 0;\r
+ }\r
\r
//\r
// Use %a to format the ASCII strings, %s to format UNICODE strings\r
Time.Minute,\r
Time.Second\r
);\r
- Len--;\r
\r
Len += (UINT32) AsciiSPrint (\r
Buf + Len,\r
Line,\r
File\r
);\r
- Len--;\r
+ Len ++;\r
\r
//\r
// OK, patch the IP length/checksum and UDP length fields.\r
NetDebugASPrint ("State transit to %a\n", Name)\r
)\r
\r
+ If Format is NULL, then ASSERT().\r
+\r
@param Format The ASCII format string.\r
@param ... The variable length parameter whose format is determined\r
by the Format string.\r
\r
**/\r
CHAR8 *\r
+EFIAPI\r
NetDebugASPrint (\r
IN CHAR8 *Format,\r
...\r
VA_LIST Marker;\r
CHAR8 *Buf;\r
\r
+ ASSERT (Format != NULL);\r
+\r
Buf = (CHAR8 *) AllocatePool (NET_DEBUG_MSG_LEN);\r
\r
if (Buf == NULL) {\r
This function will locate a instance of SNP then send the message through it.\r
Because it isn't open the SNP BY_DRIVER, apply caution when using it.\r
\r
- @param Level The servity level of the message.\r
+ @param Level The severity level of the message.\r
@param Module The Moudle that generates the log.\r
@param File The file that contains the log.\r
@param Line The exact line that contains the log.\r
@param Message The user message to log.\r
\r
@retval EFI_INVALID_PARAMETER Any input parameter is invalid.\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the packet\r
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the packet.\r
+ @retval EFI_DEVICE_ERROR Device error occurs.\r
@retval EFI_SUCCESS The log is discard because that it is more verbose\r
than the mNetDebugLevelMax. Or, it has been sent out.\r
**/\r
EFI_STATUS\r
+EFIAPI\r
NetDebugOutput (\r
IN UINT32 Level,\r
IN UINT8 *Module,\r
//\r
// Check whether the message should be sent out\r
//\r
- if (Message == NULL) {\r
+ if (Message == NULL || File == NULL || Module == NULL) {\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
NET_SYSLOG_PACKET_LEN,\r
Packet\r
);\r
+ if (Len == 0) {\r
+ Status = EFI_DEVICE_ERROR;\r
+ } else {\r
+ mSyslogPacketSeq++;\r
+ Status = SyslogSendPacket (Packet, Len);\r
+ }\r
\r
- mSyslogPacketSeq++;\r
- Status = SyslogSendPacket (Packet, Len);\r
FreePool (Packet);\r
\r
ON_EXIT:\r
{\r
INTN Index;\r
\r
- for (Index = 0; Index < IP4_MASK_NUM; Index++) {\r
+ for (Index = 0; Index <= IP4_MASK_MAX; Index++) {\r
if (NetMask == gIp4AllMasks[Index]) {\r
break;\r
}\r
Return the class of the IP address, such as class A, B, C.\r
Addr is in host byte order.\r
\r
+ [ATTENTION]\r
+ Classful addressing (IP class A/B/C) has been deprecated according to RFC4632.\r
+ Caller of this function could only check the returned value against\r
+ IP4_ADDR_CLASSD (multicast) or IP4_ADDR_CLASSE (reserved) now.\r
+\r
The address of class A starts with 0.\r
If the address belong to class A, return IP4_ADDR_CLASSA.\r
The address of class B starts with 10.\r
\r
/**\r
Check whether the IP is a valid unicast address according to\r
- the netmask. If NetMask is zero, use the IP address's class to get the default mask.\r
+ the netmask.\r
+\r
+ ASSERT if NetMask is zero.\r
\r
- If Ip is 0, IP is not a valid unicast address.\r
- Class D address is used for multicasting and class E address is reserved for future. If Ip\r
- belongs to class D or class E, IP is not a valid unicast address.\r
- If all bits of the host address of IP are 0 or 1, IP is also not a valid unicast address.\r
+ If all bits of the host address of IP are 0 or 1, IP is also not a valid unicast address,\r
+ except when the originator is one of the endpoints of a point-to-point link with a 31-bit\r
+ mask (RFC3021), or a 32bit NetMask (all 0xFF) is used for special network environment (e.g.\r
+ PPP link).\r
\r
@param[in] Ip The IP to check against.\r
@param[in] NetMask The mask of the IP.\r
IN IP4_ADDR NetMask\r
)\r
{\r
- INTN Class;\r
+ INTN MaskLength;\r
\r
- Class = NetGetIpClass (Ip);\r
+ ASSERT (NetMask != 0);\r
\r
- if ((Ip == 0) || (Class >= IP4_ADDR_CLASSD)) {\r
+ if (Ip == 0 || IP4_IS_LOCAL_BROADCAST (Ip)) {\r
return FALSE;\r
}\r
\r
- if (NetMask == 0) {\r
- NetMask = gIp4AllMasks[Class << 3];\r
- }\r
-\r
- if (((Ip &~NetMask) == ~NetMask) || ((Ip &~NetMask) == 0)) {\r
- return FALSE;\r
+ MaskLength = NetGetMaskLength (NetMask);\r
+ ASSERT ((MaskLength >= 0) && (MaskLength <= IP4_MASK_NUM));\r
+ if (MaskLength < 31) {\r
+ if (((Ip &~NetMask) == ~NetMask) || ((Ip &~NetMask) == 0)) {\r
+ return FALSE;\r
+ }\r
}\r
\r
return TRUE;\r
/**\r
Check whether the incoming IPv6 address is a valid unicast address.\r
\r
+ ASSERT if Ip6 is NULL.\r
+\r
If the address is a multicast address has binary 0xFF at the start, it is not\r
a valid unicast address. If the address is unspecified ::, it is not a valid\r
unicast address to be assigned to any node. If the address is loopback address\r
\r
**/\r
BOOLEAN\r
+EFIAPI\r
NetIp6IsValidUnicast (\r
IN EFI_IPv6_ADDRESS *Ip6\r
)\r
UINT8 Byte;\r
UINT8 Index;\r
\r
+ ASSERT (Ip6 != NULL);\r
+\r
if (Ip6->Addr[0] == 0xFF) {\r
return FALSE;\r
}\r
/**\r
Check whether the incoming Ipv6 address is the unspecified address or not.\r
\r
+ ASSERT if Ip6 is NULL.\r
+\r
@param[in] Ip6 - Ip6 address, in network order.\r
\r
@retval TRUE - Yes, unspecified\r
\r
**/\r
BOOLEAN\r
+EFIAPI\r
NetIp6IsUnspecifiedAddr (\r
IN EFI_IPv6_ADDRESS *Ip6\r
)\r
{\r
UINT8 Index;\r
\r
+ ASSERT (Ip6 != NULL);\r
+\r
for (Index = 0; Index < 16; Index++) {\r
if (Ip6->Addr[Index] != 0) {\r
return FALSE;\r
/**\r
Check whether the incoming Ipv6 address is a link-local address.\r
\r
+ ASSERT if Ip6 is NULL.\r
+\r
@param[in] Ip6 - Ip6 address, in network order.\r
\r
@retval TRUE - Yes, link-local address\r
\r
**/\r
BOOLEAN\r
+EFIAPI\r
NetIp6IsLinkLocalAddr (\r
IN EFI_IPv6_ADDRESS *Ip6\r
)\r
/**\r
Check whether the Ipv6 address1 and address2 are on the connected network.\r
\r
+ ASSERT if Ip1 or Ip2 is NULL.\r
+ ASSERT if PrefixLength exceeds or equals to IP6_PREFIX_MAX.\r
+\r
@param[in] Ip1 - Ip6 address1, in network order.\r
@param[in] Ip2 - Ip6 address2, in network order.\r
@param[in] PrefixLength - The prefix length of the checking net.\r
\r
**/\r
BOOLEAN\r
+EFIAPI\r
NetIp6IsNetEqual (\r
EFI_IPv6_ADDRESS *Ip1,\r
EFI_IPv6_ADDRESS *Ip2,\r
UINT8 Bit;\r
UINT8 Mask;\r
\r
- ASSERT (Ip1 != NULL && Ip2 != NULL);\r
+ ASSERT ((Ip1 != NULL) && (Ip2 != NULL) && (PrefixLength < IP6_PREFIX_MAX));\r
\r
if (PrefixLength == 0) {\r
return TRUE;\r
if (Bit > 0) {\r
Mask = (UINT8) (0xFF << (8 - Bit));\r
\r
+ ASSERT (Byte < 16);\r
+ if (Byte >= 16) {\r
+ return FALSE;\r
+ }\r
if ((Ip1->Addr[Byte] & Mask) != (Ip2->Addr[Byte] & Mask)) {\r
return FALSE;\r
}\r
/**\r
Switches the endianess of an IPv6 address\r
\r
+ ASSERT if Ip6 is NULL.\r
+\r
This function swaps the bytes in a 128-bit IPv6 address to switch the value\r
from little endian to big endian or vice versa. The byte swapped value is\r
returned.\r
\r
**/\r
EFI_IPv6_ADDRESS *\r
+EFIAPI\r
Ip6Swap128 (\r
EFI_IPv6_ADDRESS *Ip6\r
)\r
UINT64 High;\r
UINT64 Low;\r
\r
+ ASSERT (Ip6 != NULL);\r
+\r
CopyMem (&High, Ip6, sizeof (UINT64));\r
CopyMem (&Low, &Ip6->Addr[8], sizeof (UINT64));\r
\r
}\r
\r
/**\r
- Initialize a random seed using current time.\r
+ Initialize a random seed using current time and monotonic count.\r
\r
- Get current time first. Then initialize a random seed based on some basic\r
- mathematics operation on the hour, day, minute, second, nanosecond and year\r
- of the current time.\r
+ Get current time and monotonic count first. Then initialize a random seed\r
+ based on some basic mathematics operation on the hour, day, minute, second,\r
+ nanosecond and year of the current time and the monotonic count value.\r
\r
@return The random seed initialized with current time.\r
\r
{\r
EFI_TIME Time;\r
UINT32 Seed;\r
+ UINT64 MonotonicCount;\r
\r
gRT->GetTime (&Time, NULL);\r
- Seed = (~Time.Hour << 24 | Time.Day << 16 | Time.Minute << 8 | Time.Second);\r
+ Seed = (Time.Hour << 24 | Time.Day << 16 | Time.Minute << 8 | Time.Second);\r
Seed ^= Time.Nanosecond;\r
Seed ^= Time.Year << 7;\r
\r
+ gBS->GetNextMonotonicCount (&MonotonicCount);\r
+ Seed += (UINT32) MonotonicCount;\r
+\r
return Seed;\r
}\r
\r
/**\r
Extract a UINT32 from a byte stream.\r
\r
+ ASSERT if Buf is NULL.\r
+\r
Copy a UINT32 from a byte stream, then converts it from Network\r
byte order to host byte order. Use this function to avoid alignment error.\r
\r
{\r
UINT32 Value;\r
\r
+ ASSERT (Buf != NULL);\r
+\r
CopyMem (&Value, Buf, sizeof (UINT32));\r
return NTOHL (Value);\r
}\r
/**\r
Put a UINT32 to the byte stream in network byte order.\r
\r
+ ASSERT if Buf is NULL.\r
+\r
Converts a UINT32 from host byte order to network byte order. Then copy it to the\r
byte stream.\r
\r
@param[in, out] Buf The buffer to put the UINT32.\r
- @param[in] Data The data to put.\r
+ @param[in] Data The data to be converted and put into the byte stream.\r
\r
**/\r
VOID\r
IN UINT32 Data\r
)\r
{\r
+ ASSERT (Buf != NULL);\r
+\r
Data = HTONL (Data);\r
CopyMem (Buf, &Data, sizeof (UINT32));\r
}\r
/**\r
Insert a new node entry after a designated node entry of a doubly linked list.\r
\r
+ ASSERT if PrevEntry or NewEntry is NULL.\r
+\r
Inserts a new node entry donated by NewEntry after the node entry donated by PrevEntry\r
of the doubly linked list.\r
\r
IN OUT LIST_ENTRY *NewEntry\r
)\r
{\r
+ ASSERT (PrevEntry != NULL && NewEntry != NULL);\r
+\r
NewEntry->BackLink = PrevEntry;\r
NewEntry->ForwardLink = PrevEntry->ForwardLink;\r
PrevEntry->ForwardLink->BackLink = NewEntry;\r
/**\r
Insert a new node entry before a designated node entry of a doubly linked list.\r
\r
+ ASSERT if PostEntry or NewEntry is NULL.\r
+\r
Inserts a new node entry donated by NewEntry after the node entry donated by PostEntry\r
of the doubly linked list.\r
\r
IN OUT LIST_ENTRY *NewEntry\r
)\r
{\r
+ ASSERT (PostEntry != NULL && NewEntry != NULL);\r
+\r
NewEntry->ForwardLink = PostEntry;\r
NewEntry->BackLink = PostEntry->BackLink;\r
PostEntry->BackLink->ForwardLink = NewEntry;\r
PostEntry->BackLink = NewEntry;\r
}\r
\r
+/**\r
+ Safe destroy nodes in a linked list, and return the length of the list after all possible operations finished.\r
+\r
+ Destroy network child instance list by list traversals is not safe due to graph dependencies between nodes.\r
+ This function performs a safe traversal to destroy these nodes by checking to see if the node being destroyed\r
+ has been removed from the list or not.\r
+ If it has been removed, then restart the traversal from the head.\r
+ If it hasn't been removed, then continue with the next node directly.\r
+ This function will end the iterate and return the CallBack's last return value if error happens,\r
+ or retrun EFI_SUCCESS if 2 complete passes are made with no changes in the number of children in the list.\r
+\r
+ @param[in] List The head of the list.\r
+ @param[in] CallBack Pointer to the callback function to destroy one node in the list.\r
+ @param[in] Context Pointer to the callback function's context: corresponds to the\r
+ parameter Context in NET_DESTROY_LINK_LIST_CALLBACK.\r
+ @param[out] ListLength The length of the link list if the function returns successfully.\r
+\r
+ @retval EFI_SUCCESS Two complete passes are made with no changes in the number of children.\r
+ @retval EFI_INVALID_PARAMETER The input parameter is invalid.\r
+ @retval Others Return the CallBack's last return value.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetDestroyLinkList (\r
+ IN LIST_ENTRY *List,\r
+ IN NET_DESTROY_LINK_LIST_CALLBACK CallBack,\r
+ IN VOID *Context, OPTIONAL\r
+ OUT UINTN *ListLength OPTIONAL\r
+ )\r
+{\r
+ UINTN PreviousLength;\r
+ LIST_ENTRY *Entry;\r
+ LIST_ENTRY *Ptr;\r
+ UINTN Length;\r
+ EFI_STATUS Status;\r
+\r
+ if (List == NULL || CallBack == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ Length = 0;\r
+ do {\r
+ PreviousLength = Length;\r
+ Entry = GetFirstNode (List);\r
+ while (!IsNull (List, Entry)) {\r
+ Status = CallBack (Entry, Context);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+ //\r
+ // Walk through the list to see whether the Entry has been removed or not.\r
+ // If the Entry still exists, just try to destroy the next one.\r
+ // If not, go back to the start point to iterate the list again.\r
+ //\r
+ for (Ptr = List->ForwardLink; Ptr != List; Ptr = Ptr->ForwardLink) {\r
+ if (Ptr == Entry) {\r
+ break;\r
+ }\r
+ }\r
+ if (Ptr == Entry) {\r
+ Entry = GetNextNode (List, Entry);\r
+ } else {\r
+ Entry = GetFirstNode (List);\r
+ }\r
+ }\r
+ for (Length = 0, Ptr = List->ForwardLink; Ptr != List; Length++, Ptr = Ptr->ForwardLink);\r
+ } while (Length != PreviousLength);\r
+\r
+ if (ListLength != NULL) {\r
+ *ListLength = Length;\r
+ }\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ This function checks the input Handle to see if it's one of these handles in ChildHandleBuffer.\r
+\r
+ @param[in] Handle Handle to be checked.\r
+ @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer.\r
+ @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL\r
+ if NumberOfChildren is 0.\r
+\r
+ @retval TRUE Found the input Handle in ChildHandleBuffer.\r
+ @retval FALSE Can't find the input Handle in ChildHandleBuffer.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+NetIsInHandleBuffer (\r
+ IN EFI_HANDLE Handle,\r
+ IN UINTN NumberOfChildren,\r
+ IN EFI_HANDLE *ChildHandleBuffer OPTIONAL\r
+ )\r
+{\r
+ UINTN Index;\r
+\r
+ if (NumberOfChildren == 0 || ChildHandleBuffer == NULL) {\r
+ return FALSE;\r
+ }\r
+\r
+ for (Index = 0; Index < NumberOfChildren; Index++) {\r
+ if (Handle == ChildHandleBuffer[Index]) {\r
+ return TRUE;\r
+ }\r
+ }\r
+\r
+ return FALSE;\r
+}\r
+\r
\r
/**\r
Initialize the netmap. Netmap is a reposity to keep the <Key, Value> pairs.\r
\r
If Map is NULL, then ASSERT().\r
\r
-\r
@param[in] Map The net map to test.\r
\r
@return TRUE if the netmap is empty, otherwise FALSE.\r
/**\r
Return the number of the <Key, Value> pairs in the netmap.\r
\r
+ If Map is NULL, then ASSERT().\r
+\r
@param[in] Map The netmap to get the entry number.\r
\r
@return The entry number in the netmap.\r
IN NET_MAP *Map\r
)\r
{\r
+ ASSERT (Map != NULL);\r
return Map->Count;\r
}\r
\r
pairs in the netmap increase by 1.\r
\r
If Map is NULL, then ASSERT().\r
+ If Key is NULL, then ASSERT().\r
\r
@param[in, out] Map The netmap to insert into.\r
@param[in] Key The user's key.\r
{\r
NET_MAP_ITEM *Item;\r
\r
- ASSERT (Map != NULL);\r
+ ASSERT (Map != NULL && Key != NULL);\r
\r
Item = NetMapAllocItem (Map);\r
\r
pairs in the netmap increase by 1.\r
\r
If Map is NULL, then ASSERT().\r
+ If Key is NULL, then ASSERT().\r
\r
@param[in, out] Map The netmap to insert into.\r
@param[in] Key The user's key.\r
{\r
NET_MAP_ITEM *Item;\r
\r
- ASSERT (Map != NULL);\r
+ ASSERT (Map != NULL && Key != NULL);\r
\r
Item = NetMapAllocItem (Map);\r
\r
/**\r
Check whether the item is in the Map and return TRUE if it is.\r
\r
+ If Map is NULL, then ASSERT().\r
+ If Item is NULL, then ASSERT().\r
+\r
@param[in] Map The netmap to search within.\r
@param[in] Item The item to search.\r
\r
{\r
LIST_ENTRY *ListEntry;\r
\r
+ ASSERT (Map != NULL && Item != NULL);\r
+\r
NET_LIST_FOR_EACH (ListEntry, &Map->Used) {\r
if (ListEntry == &Item->Link) {\r
return TRUE;\r
item with the key to search. It returns the point to the item contains the Key if found.\r
\r
If Map is NULL, then ASSERT().\r
+ If Key is NULL, then ASSERT().\r
\r
@param[in] Map The netmap to search within.\r
@param[in] Key The key to search.\r
LIST_ENTRY *Entry;\r
NET_MAP_ITEM *Item;\r
\r
- ASSERT (Map != NULL);\r
+ ASSERT (Map != NULL && Key != NULL);\r
\r
NET_LIST_FOR_EACH (Entry, &Map->Used) {\r
Item = NET_LIST_USER_STRUCT (Entry, NET_MAP_ITEM, Link);\r
/**\r
Iterate through the netmap and call CallBack for each item.\r
\r
- It will contiue the traverse if CallBack returns EFI_SUCCESS, otherwise, break\r
+ It will continue the traverse if CallBack returns EFI_SUCCESS, otherwise, break\r
from the loop. It returns the CallBack's last return value. This function is\r
delete safe for the current item.\r
\r
NetMapIterate (\r
IN NET_MAP *Map,\r
IN NET_MAP_CALLBACK CallBack,\r
- IN VOID *Arg\r
+ IN VOID *Arg OPTIONAL\r
)\r
{\r
\r
EFI_HANDLE *DeviceHandleBuffer;\r
UINTN DeviceHandleCount;\r
UINTN Index;\r
+ UINTN Index2;\r
EFI_DRIVER_BINDING_PROTOCOL *DriverBinding;\r
EFI_COMPONENT_NAME_PROTOCOL *ComponentName;\r
EFI_COMPONENT_NAME2_PROTOCOL *ComponentName2;\r
return Status;\r
}\r
\r
- //\r
- // Disconnect the driver specified by ImageHandle from all\r
- // the devices in the handle database.\r
- //\r
- for (Index = 0; Index < DeviceHandleCount; Index++) {\r
- Status = gBS->DisconnectController (\r
- DeviceHandleBuffer[Index],\r
- ImageHandle,\r
- NULL\r
- );\r
- }\r
-\r
- //\r
- // Uninstall all the protocols installed in the driver entry point\r
- //\r
for (Index = 0; Index < DeviceHandleCount; Index++) {\r
Status = gBS->HandleProtocol (\r
DeviceHandleBuffer[Index],\r
&gEfiDriverBindingProtocolGuid,\r
(VOID **) &DriverBinding\r
);\r
-\r
if (EFI_ERROR (Status)) {\r
continue;\r
}\r
continue;\r
}\r
\r
+ //\r
+ // Disconnect the driver specified by ImageHandle from all\r
+ // the devices in the handle database.\r
+ //\r
+ for (Index2 = 0; Index2 < DeviceHandleCount; Index2++) {\r
+ Status = gBS->DisconnectController (\r
+ DeviceHandleBuffer[Index2],\r
+ DriverBinding->DriverBindingHandle,\r
+ NULL\r
+ );\r
+ }\r
+\r
+ //\r
+ // Uninstall all the protocols installed in the driver entry point\r
+ //\r
gBS->UninstallProtocolInterface (\r
- ImageHandle,\r
+ DriverBinding->DriverBindingHandle,\r
&gEfiDriverBindingProtocolGuid,\r
DriverBinding\r
);\r
+\r
Status = gBS->HandleProtocol (\r
DeviceHandleBuffer[Index],\r
&gEfiComponentNameProtocolGuid,\r
);\r
if (!EFI_ERROR (Status)) {\r
gBS->UninstallProtocolInterface (\r
- ImageHandle,\r
+ DriverBinding->DriverBindingHandle,\r
&gEfiComponentNameProtocolGuid,\r
ComponentName\r
);\r
);\r
if (!EFI_ERROR (Status)) {\r
gBS->UninstallProtocolInterface (\r
- ImageHandle,\r
+ DriverBinding->DriverBindingHandle,\r
&gEfiComponentName2ProtocolGuid,\r
ComponentName2\r
);\r
\r
\r
/**\r
- Destory a child of the service that is identified by ServiceBindingGuid.\r
+ Destroy a child of the service that is identified by ServiceBindingGuid.\r
\r
Get the ServiceBinding Protocol first, then use it to destroy a child.\r
\r
@param[in] Controller The controller which has the service installed.\r
@param[in] Image The image handle used to open service.\r
@param[in] ServiceBindingGuid The service's Guid.\r
- @param[in] ChildHandle The child to destory.\r
+ @param[in] ChildHandle The child to destroy.\r
\r
- @retval EFI_SUCCESS The child is successfully destoried.\r
- @retval Others Failed to destory the child.\r
+ @retval EFI_SUCCESS The child is successfully destroyed.\r
+ @retval Others Failed to destroy the child.\r
\r
**/\r
EFI_STATUS\r
}\r
\r
//\r
- // destory the child\r
+ // destroy the child\r
//\r
Status = Service->DestroyChild (Service, ChildHandle);\r
return Status;\r
}\r
\r
-\r
/**\r
- Convert the mac address of the simple network protocol installed on\r
- SnpHandle to a unicode string. Callers are responsible for freeing the\r
- string storage.\r
-\r
- Get the mac address of the Simple Network protocol from the SnpHandle. Then convert\r
- the mac address into a unicode string. It takes 2 unicode characters to represent \r
- a 1 byte binary buffer. Plus one unicode character for the null-terminator.\r
+ Get handle with Simple Network Protocol installed on it.\r
\r
+ There should be MNP Service Binding Protocol installed on the input ServiceHandle.\r
+ If Simple Network Protocol is already installed on the ServiceHandle, the\r
+ ServiceHandle will be returned. If SNP is not installed on the ServiceHandle,\r
+ try to find its parent handle with SNP installed.\r
\r
- @param[in] SnpHandle The handle where the simple network protocol is\r
- installed on.\r
- @param[in] ImageHandle The image handle used to act as the agent handle to\r
- get the simple network protocol.\r
- @param[out] MacString The pointer to store the address of the string\r
- representation of the mac address.\r
+ @param[in] ServiceHandle The handle where network service binding protocols are\r
+ installed on.\r
+ @param[out] Snp The pointer to store the address of the SNP instance.\r
+ This is an optional parameter that may be NULL.\r
\r
- @retval EFI_SUCCESS Convert the mac address a unicode string successfully.\r
- @retval EFI_OUT_OF_RESOURCES There are not enough memory resource.\r
- @retval Others Failed to open the simple network protocol.\r
+ @return The SNP handle, or NULL if not found.\r
\r
**/\r
-EFI_STATUS\r
+EFI_HANDLE\r
EFIAPI\r
-NetLibGetMacString (\r
- IN EFI_HANDLE SnpHandle,\r
- IN EFI_HANDLE ImageHandle,\r
- OUT CHAR16 **MacString\r
+NetLibGetSnpHandle (\r
+ IN EFI_HANDLE ServiceHandle,\r
+ OUT EFI_SIMPLE_NETWORK_PROTOCOL **Snp OPTIONAL\r
)\r
{\r
EFI_STATUS Status;\r
- EFI_SIMPLE_NETWORK_PROTOCOL *Snp;\r
- EFI_SIMPLE_NETWORK_MODE *Mode;\r
- CHAR16 *MacAddress;\r
- UINT8 *HwAddress;\r
- UINTN Index;\r
-\r
- *MacString = NULL;\r
+ EFI_SIMPLE_NETWORK_PROTOCOL *SnpInstance;\r
+ EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
+ EFI_HANDLE SnpHandle;\r
\r
//\r
- // Get the Simple Network protocol from the SnpHandle.\r
+ // Try to open SNP from ServiceHandle\r
//\r
- Status = gBS->OpenProtocol (\r
- SnpHandle,\r
- &gEfiSimpleNetworkProtocolGuid,\r
- (VOID **) &Snp,\r
- ImageHandle,\r
- SnpHandle,\r
- EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
- );\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
+ SnpInstance = NULL;\r
+ Status = gBS->HandleProtocol (ServiceHandle, &gEfiSimpleNetworkProtocolGuid, (VOID **) &SnpInstance);\r
+ if (!EFI_ERROR (Status)) {\r
+ if (Snp != NULL) {\r
+ *Snp = SnpInstance;\r
+ }\r
+ return ServiceHandle;\r
}\r
\r
- Mode = Snp->Mode;\r
-\r
//\r
- // It takes 2 unicode characters to represent a 1 byte binary buffer.\r
- // Plus one unicode character for the null-terminator.\r
+ // Failed to open SNP, try to get SNP handle by LocateDevicePath()\r
//\r
- MacAddress = AllocatePool ((2 * Mode->HwAddressSize + 1) * sizeof (CHAR16));\r
- if (MacAddress == NULL) {\r
- return EFI_OUT_OF_RESOURCES;\r
+ DevicePath = DevicePathFromHandle (ServiceHandle);\r
+ if (DevicePath == NULL) {\r
+ return NULL;\r
}\r
- *MacString = MacAddress;\r
\r
- //\r
- // Convert the mac address into a unicode string.\r
- //\r
- HwAddress = Mode->CurrentAddress.Addr;\r
- for (Index = 0; Index < Mode->HwAddressSize; Index++) {\r
- MacAddress += UnicodeValueToString (MacAddress, PREFIX_ZERO | RADIX_HEX, *(HwAddress++), 2);\r
+ SnpHandle = NULL;\r
+ Status = gBS->LocateDevicePath (&gEfiSimpleNetworkProtocolGuid, &DevicePath, &SnpHandle);\r
+ if (EFI_ERROR (Status)) {\r
+ //\r
+ // Failed to find SNP handle\r
+ //\r
+ return NULL;\r
}\r
\r
- MacAddress[Mode->HwAddressSize * 2] = L'\0';\r
-\r
+ Status = gBS->HandleProtocol (SnpHandle, &gEfiSimpleNetworkProtocolGuid, (VOID **) &SnpInstance);\r
+ if (!EFI_ERROR (Status)) {\r
+ if (Snp != NULL) {\r
+ *Snp = SnpInstance;\r
+ }\r
+ return SnpHandle;\r
+ }\r
\r
- return EFI_SUCCESS;\r
+ return NULL;\r
}\r
\r
/**\r
- Check the default address used by the IPv4 driver is static or dynamic (acquired\r
- from DHCP).\r
+ Retrieve VLAN ID of a VLAN device handle.\r
\r
- If the controller handle does not have the NIC Ip4 Config Protocol installed, the\r
- default address is static. If the EFI variable to save the configuration is not found,\r
- the default address is static. Otherwise, get the result from the EFI variable which\r
- saving the configuration.\r
+ Search VLAN device path node in Device Path of specified ServiceHandle and\r
+ return its VLAN ID. If no VLAN device path node found, then this ServiceHandle\r
+ is not a VLAN device handle, and 0 will be returned.\r
\r
- @param[in] Controller The controller handle which has the NIC Ip4 Config Protocol\r
- relative with the default address to judge.\r
+ @param[in] ServiceHandle The handle where network service binding protocols are\r
+ installed on.\r
\r
- @retval TRUE If the default address is static.\r
- @retval FALSE If the default address is acquired from DHCP.\r
+ @return VLAN ID of the device handle, or 0 if not a VLAN device.\r
\r
**/\r
-BOOLEAN\r
-NetLibDefaultAddressIsStatic (\r
- IN EFI_HANDLE Controller\r
+UINT16\r
+EFIAPI\r
+NetLibGetVlanId (\r
+ IN EFI_HANDLE ServiceHandle\r
)\r
{\r
- EFI_STATUS Status;\r
- EFI_HII_CONFIG_ROUTING_PROTOCOL *HiiConfigRouting;\r
- UINTN Len;\r
- NIC_IP4_CONFIG_INFO *ConfigInfo;\r
- BOOLEAN IsStatic;\r
- EFI_STRING ConfigHdr;\r
- EFI_STRING ConfigResp;\r
- EFI_STRING AccessProgress;\r
- EFI_STRING AccessResults;\r
- EFI_STRING String;\r
-\r
- ConfigInfo = NULL;\r
- ConfigHdr = NULL;\r
- ConfigResp = NULL;\r
- AccessProgress = NULL;\r
- AccessResults = NULL;\r
- IsStatic = TRUE;\r
-\r
- Status = gBS->LocateProtocol (\r
- &gEfiHiiConfigRoutingProtocolGuid,\r
- NULL,\r
- (VOID **) &HiiConfigRouting\r
- );\r
- if (EFI_ERROR (Status)) {\r
- return TRUE;\r
- }\r
+ EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
+ EFI_DEVICE_PATH_PROTOCOL *Node;\r
\r
- //\r
- // Construct config request string header\r
- //\r
- ConfigHdr = HiiConstructConfigHdr (&gEfiNicIp4ConfigVariableGuid, EFI_NIC_IP4_CONFIG_VARIABLE, Controller);\r
- if (ConfigHdr == NULL) {\r
- return TRUE;\r
+ DevicePath = DevicePathFromHandle (ServiceHandle);\r
+ if (DevicePath == NULL) {\r
+ return 0;\r
}\r
\r
- Len = StrLen (ConfigHdr);\r
- ConfigResp = AllocateZeroPool ((Len + NIC_ITEM_CONFIG_SIZE * 2 + 100) * sizeof (CHAR16));\r
- if (ConfigResp == NULL) {\r
- goto ON_EXIT;\r
- }\r
- StrCpy (ConfigResp, ConfigHdr);\r
-\r
- String = ConfigResp + Len;\r
- UnicodeSPrint (\r
- String,\r
- (8 + 4 + 7 + 4 + 1) * sizeof (CHAR16),\r
- L"&OFFSET=%04X&WIDTH=%04X",\r
- OFFSET_OF (NIC_IP4_CONFIG_INFO, Source),\r
- sizeof (UINT32)\r
- );\r
-\r
- Status = HiiConfigRouting->ExtractConfig (\r
- HiiConfigRouting,\r
- ConfigResp,\r
- &AccessProgress,\r
- &AccessResults\r
- );\r
- if (EFI_ERROR (Status)) {\r
- goto ON_EXIT;\r
+ Node = DevicePath;\r
+ while (!IsDevicePathEnd (Node)) {\r
+ if (Node->Type == MESSAGING_DEVICE_PATH && Node->SubType == MSG_VLAN_DP) {\r
+ return ((VLAN_DEVICE_PATH *) Node)->VlanId;\r
+ }\r
+ Node = NextDevicePathNode (Node);\r
}\r
\r
- ConfigInfo = AllocateZeroPool (sizeof (NIC_ITEM_CONFIG_SIZE));\r
- if (ConfigInfo == NULL) {\r
- goto ON_EXIT;\r
- }\r
+ return 0;\r
+}\r
\r
- ConfigInfo->Source = IP4_CONFIG_SOURCE_STATIC;\r
- Len = NIC_ITEM_CONFIG_SIZE;\r
- Status = HiiConfigRouting->ConfigToBlock (\r
- HiiConfigRouting,\r
- AccessResults,\r
- (UINT8 *) ConfigInfo,\r
- &Len,\r
- &AccessProgress\r
- );\r
- if (EFI_ERROR (Status)) {\r
- goto ON_EXIT;\r
- }\r
+/**\r
+ Find VLAN device handle with specified VLAN ID.\r
\r
- IsStatic = (BOOLEAN) (ConfigInfo->Source == IP4_CONFIG_SOURCE_STATIC);\r
+ The VLAN child device handle is created by VLAN Config Protocol on ControllerHandle.\r
+ This function will append VLAN device path node to the parent device path,\r
+ and then use LocateDevicePath() to find the correct VLAN device handle.\r
\r
-ON_EXIT:\r
+ @param[in] ControllerHandle The handle where network service binding protocols are\r
+ installed on.\r
+ @param[in] VlanId The configured VLAN ID for the VLAN device.\r
\r
- if (AccessResults != NULL) {\r
- FreePool (AccessResults);\r
- }\r
- if (ConfigInfo != NULL) {\r
- FreePool (ConfigInfo);\r
+ @return The VLAN device handle, or NULL if not found.\r
+\r
+**/\r
+EFI_HANDLE\r
+EFIAPI\r
+NetLibGetVlanHandle (\r
+ IN EFI_HANDLE ControllerHandle,\r
+ IN UINT16 VlanId\r
+ )\r
+{\r
+ EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath;\r
+ EFI_DEVICE_PATH_PROTOCOL *VlanDevicePath;\r
+ EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
+ VLAN_DEVICE_PATH VlanNode;\r
+ EFI_HANDLE Handle;\r
+\r
+ ParentDevicePath = DevicePathFromHandle (ControllerHandle);\r
+ if (ParentDevicePath == NULL) {\r
+ return NULL;\r
}\r
- if (ConfigResp != NULL) {\r
- FreePool (ConfigResp);\r
+\r
+ //\r
+ // Construct VLAN device path\r
+ //\r
+ CopyMem (&VlanNode, &mNetVlanDevicePathTemplate, sizeof (VLAN_DEVICE_PATH));\r
+ VlanNode.VlanId = VlanId;\r
+ VlanDevicePath = AppendDevicePathNode (\r
+ ParentDevicePath,\r
+ (EFI_DEVICE_PATH_PROTOCOL *) &VlanNode\r
+ );\r
+ if (VlanDevicePath == NULL) {\r
+ return NULL;\r
}\r
- if (ConfigHdr != NULL) {\r
- FreePool (ConfigHdr);\r
+\r
+ //\r
+ // Find VLAN device handle\r
+ //\r
+ Handle = NULL;\r
+ DevicePath = VlanDevicePath;\r
+ gBS->LocateDevicePath (\r
+ &gEfiDevicePathProtocolGuid,\r
+ &DevicePath,\r
+ &Handle\r
+ );\r
+ if (!IsDevicePathEnd (DevicePath)) {\r
+ //\r
+ // Device path is not exactly match\r
+ //\r
+ Handle = NULL;\r
}\r
\r
- return IsStatic;\r
+ FreePool (VlanDevicePath);\r
+ return Handle;\r
}\r
\r
/**\r
- Create an IPv4 device path node.\r
+ Get MAC address associated with the network service handle.\r
\r
- The header type of IPv4 device path node is MESSAGING_DEVICE_PATH.\r
- The header subtype of IPv4 device path node is MSG_IPv4_DP.\r
- The length of the IPv4 device path node in bytes is 19.\r
- Get other info from parameters to make up the whole IPv4 device path node.\r
+ If MacAddress is NULL, then ASSERT().\r
+ If AddressSize is NULL, then ASSERT().\r
\r
- @param[in, out] Node Pointer to the IPv4 device path node.\r
- @param[in] Controller The controller handle.\r
- @param[in] LocalIp The local IPv4 address.\r
- @param[in] LocalPort The local port.\r
- @param[in] RemoteIp The remote IPv4 address.\r
- @param[in] RemotePort The remote port.\r
- @param[in] Protocol The protocol type in the IP header.\r
- @param[in] UseDefaultAddress Whether this instance is using default address or not.\r
+ There should be MNP Service Binding Protocol installed on the input ServiceHandle.\r
+ If SNP is installed on the ServiceHandle or its parent handle, MAC address will\r
+ be retrieved from SNP. If no SNP found, try to get SNP mode data use MNP.\r
+\r
+ @param[in] ServiceHandle The handle where network service binding protocols are\r
+ installed on.\r
+ @param[out] MacAddress The pointer to store the returned MAC address.\r
+ @param[out] AddressSize The length of returned MAC address.\r
+\r
+ @retval EFI_SUCCESS MAC address is returned successfully.\r
+ @retval Others Failed to get SNP mode data.\r
\r
**/\r
-VOID\r
+EFI_STATUS\r
EFIAPI\r
-NetLibCreateIPv4DPathNode (\r
- IN OUT IPv4_DEVICE_PATH *Node,\r
- IN EFI_HANDLE Controller,\r
- IN IP4_ADDR LocalIp,\r
- IN UINT16 LocalPort,\r
- IN IP4_ADDR RemoteIp,\r
- IN UINT16 RemotePort,\r
- IN UINT16 Protocol,\r
- IN BOOLEAN UseDefaultAddress\r
+NetLibGetMacAddress (\r
+ IN EFI_HANDLE ServiceHandle,\r
+ OUT EFI_MAC_ADDRESS *MacAddress,\r
+ OUT UINTN *AddressSize\r
)\r
{\r
- Node->Header.Type = MESSAGING_DEVICE_PATH;\r
- Node->Header.SubType = MSG_IPv4_DP;\r
- SetDevicePathNodeLength (&Node->Header, 19);\r
-\r
- CopyMem (&Node->LocalIpAddress, &LocalIp, sizeof (EFI_IPv4_ADDRESS));\r
- CopyMem (&Node->RemoteIpAddress, &RemoteIp, sizeof (EFI_IPv4_ADDRESS));\r
-\r
- Node->LocalPort = LocalPort;\r
- Node->RemotePort = RemotePort;\r
+ EFI_STATUS Status;\r
+ EFI_SIMPLE_NETWORK_PROTOCOL *Snp;\r
+ EFI_SIMPLE_NETWORK_MODE *SnpMode;\r
+ EFI_SIMPLE_NETWORK_MODE SnpModeData;\r
+ EFI_MANAGED_NETWORK_PROTOCOL *Mnp;\r
+ EFI_SERVICE_BINDING_PROTOCOL *MnpSb;\r
+ EFI_HANDLE *SnpHandle;\r
+ EFI_HANDLE MnpChildHandle;\r
\r
- Node->Protocol = Protocol;\r
+ ASSERT (MacAddress != NULL);\r
+ ASSERT (AddressSize != NULL);\r
\r
- if (!UseDefaultAddress) {\r
- Node->StaticIpAddress = TRUE;\r
+ //\r
+ // Try to get SNP handle\r
+ //\r
+ Snp = NULL;\r
+ SnpHandle = NetLibGetSnpHandle (ServiceHandle, &Snp);\r
+ if (SnpHandle != NULL) {\r
+ //\r
+ // SNP found, use it directly\r
+ //\r
+ SnpMode = Snp->Mode;\r
+ } else {\r
+ //\r
+ // Failed to get SNP handle, try to get MAC address from MNP\r
+ //\r
+ MnpChildHandle = NULL;\r
+ Status = gBS->HandleProtocol (\r
+ ServiceHandle,\r
+ &gEfiManagedNetworkServiceBindingProtocolGuid,\r
+ (VOID **) &MnpSb\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ //\r
+ // Create a MNP child\r
+ //\r
+ Status = MnpSb->CreateChild (MnpSb, &MnpChildHandle);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ //\r
+ // Open MNP protocol\r
+ //\r
+ Status = gBS->HandleProtocol (\r
+ MnpChildHandle,\r
+ &gEfiManagedNetworkProtocolGuid,\r
+ (VOID **) &Mnp\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ MnpSb->DestroyChild (MnpSb, MnpChildHandle);\r
+ return Status;\r
+ }\r
+\r
+ //\r
+ // Try to get SNP mode from MNP\r
+ //\r
+ Status = Mnp->GetModeData (Mnp, NULL, &SnpModeData);\r
+ if (EFI_ERROR (Status) && (Status != EFI_NOT_STARTED)) {\r
+ MnpSb->DestroyChild (MnpSb, MnpChildHandle);\r
+ return Status;\r
+ }\r
+ SnpMode = &SnpModeData;\r
+\r
+ //\r
+ // Destroy the MNP child\r
+ //\r
+ MnpSb->DestroyChild (MnpSb, MnpChildHandle);\r
+ }\r
+\r
+ *AddressSize = SnpMode->HwAddressSize;\r
+ CopyMem (MacAddress->Addr, SnpMode->CurrentAddress.Addr, SnpMode->HwAddressSize);\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ Convert MAC address of the NIC associated with specified Service Binding Handle\r
+ to a unicode string. Callers are responsible for freeing the string storage.\r
+\r
+ If MacString is NULL, then ASSERT().\r
+\r
+ Locate simple network protocol associated with the Service Binding Handle and\r
+ get the mac address from SNP. Then convert the mac address into a unicode\r
+ string. It takes 2 unicode characters to represent a 1 byte binary buffer.\r
+ Plus one unicode character for the null-terminator.\r
+\r
+ @param[in] ServiceHandle The handle where network service binding protocol is\r
+ installed on.\r
+ @param[in] ImageHandle The image handle used to act as the agent handle to\r
+ get the simple network protocol. This parameter is\r
+ optional and may be NULL.\r
+ @param[out] MacString The pointer to store the address of the string\r
+ representation of the mac address.\r
+\r
+ @retval EFI_SUCCESS Convert the mac address a unicode string successfully.\r
+ @retval EFI_OUT_OF_RESOURCES There are not enough memory resource.\r
+ @retval Others Failed to open the simple network protocol.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibGetMacString (\r
+ IN EFI_HANDLE ServiceHandle,\r
+ IN EFI_HANDLE ImageHandle, OPTIONAL\r
+ OUT CHAR16 **MacString\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ EFI_MAC_ADDRESS MacAddress;\r
+ UINT8 *HwAddress;\r
+ UINTN HwAddressSize;\r
+ UINT16 VlanId;\r
+ CHAR16 *String;\r
+ UINTN Index;\r
+ UINTN BufferSize;\r
+\r
+ ASSERT (MacString != NULL);\r
+\r
+ //\r
+ // Get MAC address of the network device\r
+ //\r
+ Status = NetLibGetMacAddress (ServiceHandle, &MacAddress, &HwAddressSize);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ //\r
+ // It takes 2 unicode characters to represent a 1 byte binary buffer.\r
+ // If VLAN is configured, it will need extra 5 characters like "\0005".\r
+ // Plus one unicode character for the null-terminator.\r
+ //\r
+ BufferSize = (2 * HwAddressSize + 5 + 1) * sizeof (CHAR16);\r
+ String = AllocateZeroPool (BufferSize);\r
+ if (String == NULL) {\r
+ return EFI_OUT_OF_RESOURCES;\r
+ }\r
+ *MacString = String;\r
+\r
+ //\r
+ // Convert the MAC address into a unicode string.\r
+ //\r
+ HwAddress = &MacAddress.Addr[0];\r
+ for (Index = 0; Index < HwAddressSize; Index++) {\r
+ UnicodeValueToStringS (\r
+ String,\r
+ BufferSize - ((UINTN)String - (UINTN)*MacString),\r
+ PREFIX_ZERO | RADIX_HEX,\r
+ *(HwAddress++),\r
+ 2\r
+ );\r
+ String += StrnLenS (String, (BufferSize - ((UINTN)String - (UINTN)*MacString)) / sizeof (CHAR16));\r
+ }\r
+\r
+ //\r
+ // Append VLAN ID if any\r
+ //\r
+ VlanId = NetLibGetVlanId (ServiceHandle);\r
+ if (VlanId != 0) {\r
+ *String++ = L'\\';\r
+ UnicodeValueToStringS (\r
+ String,\r
+ BufferSize - ((UINTN)String - (UINTN)*MacString),\r
+ PREFIX_ZERO | RADIX_HEX,\r
+ VlanId,\r
+ 4\r
+ );\r
+ String += StrnLenS (String, (BufferSize - ((UINTN)String - (UINTN)*MacString)) / sizeof (CHAR16));\r
+ }\r
+\r
+ //\r
+ // Null terminate the Unicode string\r
+ //\r
+ *String = L'\0';\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ Detect media status for specified network device.\r
+\r
+ If MediaPresent is NULL, then ASSERT().\r
+\r
+ The underlying UNDI driver may or may not support reporting media status from\r
+ GET_STATUS command (PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED). This routine\r
+ will try to invoke Snp->GetStatus() to get the media status: if media already\r
+ present, it return directly; if media not present, it will stop SNP and then\r
+ restart SNP to get the latest media status, this give chance to get the correct\r
+ media status for old UNDI driver which doesn't support reporting media status\r
+ from GET_STATUS command.\r
+ Note: there will be two limitations for current algorithm:\r
+ 1) for UNDI with this capability, in case of cable is not attached, there will\r
+ be an redundant Stop/Start() process;\r
+ 2) for UNDI without this capability, in case that network cable is attached when\r
+ Snp->Initialize() is invoked while network cable is unattached later,\r
+ NetLibDetectMedia() will report MediaPresent as TRUE, causing upper layer\r
+ apps to wait for timeout time.\r
+\r
+ @param[in] ServiceHandle The handle where network service binding protocols are\r
+ installed on.\r
+ @param[out] MediaPresent The pointer to store the media status.\r
+\r
+ @retval EFI_SUCCESS Media detection success.\r
+ @retval EFI_INVALID_PARAMETER ServiceHandle is not valid network device handle.\r
+ @retval EFI_UNSUPPORTED Network device does not support media detection.\r
+ @retval EFI_DEVICE_ERROR SNP is in unknown state.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibDetectMedia (\r
+ IN EFI_HANDLE ServiceHandle,\r
+ OUT BOOLEAN *MediaPresent\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ EFI_HANDLE SnpHandle;\r
+ EFI_SIMPLE_NETWORK_PROTOCOL *Snp;\r
+ UINT32 InterruptStatus;\r
+ UINT32 OldState;\r
+ EFI_MAC_ADDRESS *MCastFilter;\r
+ UINT32 MCastFilterCount;\r
+ UINT32 EnableFilterBits;\r
+ UINT32 DisableFilterBits;\r
+ BOOLEAN ResetMCastFilters;\r
+\r
+ ASSERT (MediaPresent != NULL);\r
+\r
+ //\r
+ // Get SNP handle\r
+ //\r
+ Snp = NULL;\r
+ SnpHandle = NetLibGetSnpHandle (ServiceHandle, &Snp);\r
+ if (SnpHandle == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ //\r
+ // Check whether SNP support media detection\r
+ //\r
+ if (!Snp->Mode->MediaPresentSupported) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+\r
+ //\r
+ // Invoke Snp->GetStatus() to refresh MediaPresent field in SNP mode data\r
+ //\r
+ Status = Snp->GetStatus (Snp, &InterruptStatus, NULL);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ if (Snp->Mode->MediaPresent) {\r
+ //\r
+ // Media is present, return directly\r
+ //\r
+ *MediaPresent = TRUE;\r
+ return EFI_SUCCESS;\r
+ }\r
+\r
+ //\r
+ // Till now, GetStatus() report no media; while, in case UNDI not support\r
+ // reporting media status from GetStatus(), this media status may be incorrect.\r
+ // So, we will stop SNP and then restart it to get the correct media status.\r
+ //\r
+ OldState = Snp->Mode->State;\r
+ if (OldState >= EfiSimpleNetworkMaxState) {\r
+ return EFI_DEVICE_ERROR;\r
+ }\r
+\r
+ MCastFilter = NULL;\r
+\r
+ if (OldState == EfiSimpleNetworkInitialized) {\r
+ //\r
+ // SNP is already in use, need Shutdown/Stop and then Start/Initialize\r
+ //\r
+\r
+ //\r
+ // Backup current SNP receive filter settings\r
+ //\r
+ EnableFilterBits = Snp->Mode->ReceiveFilterSetting;\r
+ DisableFilterBits = Snp->Mode->ReceiveFilterMask ^ EnableFilterBits;\r
+\r
+ ResetMCastFilters = TRUE;\r
+ MCastFilterCount = Snp->Mode->MCastFilterCount;\r
+ if (MCastFilterCount != 0) {\r
+ MCastFilter = AllocateCopyPool (\r
+ MCastFilterCount * sizeof (EFI_MAC_ADDRESS),\r
+ Snp->Mode->MCastFilter\r
+ );\r
+ ASSERT (MCastFilter != NULL);\r
+ if (MCastFilter == NULL) {\r
+ Status = EFI_OUT_OF_RESOURCES;\r
+ goto Exit;\r
+ }\r
+\r
+ ResetMCastFilters = FALSE;\r
+ }\r
+\r
+ //\r
+ // Shutdown/Stop the simple network\r
+ //\r
+ Status = Snp->Shutdown (Snp);\r
+ if (!EFI_ERROR (Status)) {\r
+ Status = Snp->Stop (Snp);\r
+ }\r
+ if (EFI_ERROR (Status)) {\r
+ goto Exit;\r
+ }\r
+\r
+ //\r
+ // Start/Initialize the simple network\r
+ //\r
+ Status = Snp->Start (Snp);\r
+ if (!EFI_ERROR (Status)) {\r
+ Status = Snp->Initialize (Snp, 0, 0);\r
+ }\r
+ if (EFI_ERROR (Status)) {\r
+ goto Exit;\r
+ }\r
+\r
+ //\r
+ // Here we get the correct media status\r
+ //\r
+ *MediaPresent = Snp->Mode->MediaPresent;\r
+\r
+ //\r
+ // Restore SNP receive filter settings\r
+ //\r
+ Status = Snp->ReceiveFilters (\r
+ Snp,\r
+ EnableFilterBits,\r
+ DisableFilterBits,\r
+ ResetMCastFilters,\r
+ MCastFilterCount,\r
+ MCastFilter\r
+ );\r
+\r
+ if (MCastFilter != NULL) {\r
+ FreePool (MCastFilter);\r
+ }\r
+\r
+ return Status;\r
+ }\r
+\r
+ //\r
+ // SNP is not in use, it's in state of EfiSimpleNetworkStopped or EfiSimpleNetworkStarted\r
+ //\r
+ if (OldState == EfiSimpleNetworkStopped) {\r
+ //\r
+ // SNP not start yet, start it\r
+ //\r
+ Status = Snp->Start (Snp);\r
+ if (EFI_ERROR (Status)) {\r
+ goto Exit;\r
+ }\r
+ }\r
+\r
+ //\r
+ // Initialize the simple network\r
+ //\r
+ Status = Snp->Initialize (Snp, 0, 0);\r
+ if (EFI_ERROR (Status)) {\r
+ Status = EFI_DEVICE_ERROR;\r
+ goto Exit;\r
+ }\r
+\r
+ //\r
+ // Here we get the correct media status\r
+ //\r
+ *MediaPresent = Snp->Mode->MediaPresent;\r
+\r
+ //\r
+ // Shut down the simple network\r
+ //\r
+ Snp->Shutdown (Snp);\r
+\r
+Exit:\r
+ if (OldState == EfiSimpleNetworkStopped) {\r
+ //\r
+ // Original SNP sate is Stopped, restore to original state\r
+ //\r
+ Snp->Stop (Snp);\r
+ }\r
+\r
+ if (MCastFilter != NULL) {\r
+ FreePool (MCastFilter);\r
+ }\r
+\r
+ return Status;\r
+}\r
+\r
+/**\r
+\r
+ Detect media state for a network device. This routine will wait for a period of time at\r
+ a specified checking interval when a certain network is under connecting until connection\r
+ process finishs or timeout. If Aip protocol is supported by low layer drivers, three kinds\r
+ of media states can be detected: EFI_SUCCESS, EFI_NOT_READY and EFI_NO_MEDIA, represents\r
+ connected state, connecting state and no media state respectively. When function detects\r
+ the current state is EFI_NOT_READY, it will loop to wait for next time's check until state\r
+ turns to be EFI_SUCCESS or EFI_NO_MEDIA. If Aip protocol is not supported, function will\r
+ call NetLibDetectMedia() and return state directly.\r
+\r
+ @param[in] ServiceHandle The handle where network service binding protocols are\r
+ installed on.\r
+ @param[in] Timeout The maximum number of 100ns units to wait when network\r
+ is connecting. Zero value means detect once and return\r
+ immediately.\r
+ @param[out] MediaState The pointer to the detected media state.\r
+\r
+ @retval EFI_SUCCESS Media detection success.\r
+ @retval EFI_INVALID_PARAMETER ServiceHandle is not a valid network device handle or\r
+ MediaState pointer is NULL.\r
+ @retval EFI_DEVICE_ERROR A device error occurred.\r
+ @retval EFI_TIMEOUT Network is connecting but timeout.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibDetectMediaWaitTimeout (\r
+ IN EFI_HANDLE ServiceHandle,\r
+ IN UINT64 Timeout,\r
+ OUT EFI_STATUS *MediaState\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ EFI_HANDLE SnpHandle;\r
+ EFI_SIMPLE_NETWORK_PROTOCOL *Snp;\r
+ EFI_ADAPTER_INFORMATION_PROTOCOL *Aip;\r
+ EFI_ADAPTER_INFO_MEDIA_STATE *MediaInfo;\r
+ BOOLEAN MediaPresent;\r
+ UINTN DataSize;\r
+ EFI_STATUS TimerStatus;\r
+ EFI_EVENT Timer;\r
+ UINT64 TimeRemained;\r
+\r
+ if (MediaState == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ *MediaState = EFI_SUCCESS;\r
+ MediaInfo = NULL;\r
+\r
+ //\r
+ // Get SNP handle\r
+ //\r
+ Snp = NULL;\r
+ SnpHandle = NetLibGetSnpHandle (ServiceHandle, &Snp);\r
+ if (SnpHandle == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ Status = gBS->HandleProtocol (\r
+ SnpHandle,\r
+ &gEfiAdapterInformationProtocolGuid,\r
+ (VOID *) &Aip\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+\r
+ MediaPresent = TRUE;\r
+ Status = NetLibDetectMedia (ServiceHandle, &MediaPresent);\r
+ if (!EFI_ERROR (Status)) {\r
+ if (MediaPresent) {\r
+ *MediaState = EFI_SUCCESS;\r
+ } else {\r
+ *MediaState = EFI_NO_MEDIA;\r
+ }\r
+ }\r
+\r
+ //\r
+ // NetLibDetectMedia doesn't support EFI_NOT_READY status, return now!\r
+ //\r
+ return Status;\r
+ }\r
+\r
+ Status = Aip->GetInformation (\r
+ Aip,\r
+ &gEfiAdapterInfoMediaStateGuid,\r
+ (VOID **) &MediaInfo,\r
+ &DataSize\r
+ );\r
+ if (!EFI_ERROR (Status)) {\r
+\r
+ *MediaState = MediaInfo->MediaState;\r
+ FreePool (MediaInfo);\r
+ if (*MediaState != EFI_NOT_READY || Timeout < MEDIA_STATE_DETECT_TIME_INTERVAL) {\r
+\r
+ return EFI_SUCCESS;\r
+ }\r
+ } else {\r
+\r
+ if (MediaInfo != NULL) {\r
+ FreePool (MediaInfo);\r
+ }\r
+\r
+ if (Status == EFI_UNSUPPORTED) {\r
+\r
+ //\r
+ // If gEfiAdapterInfoMediaStateGuid is not supported, call NetLibDetectMedia to get media state!\r
+ //\r
+ MediaPresent = TRUE;\r
+ Status = NetLibDetectMedia (ServiceHandle, &MediaPresent);\r
+ if (!EFI_ERROR (Status)) {\r
+ if (MediaPresent) {\r
+ *MediaState = EFI_SUCCESS;\r
+ } else {\r
+ *MediaState = EFI_NO_MEDIA;\r
+ }\r
+ }\r
+ return Status;\r
+ }\r
+\r
+ return Status;\r
+ }\r
+\r
+ //\r
+ // Loop to check media state\r
+ //\r
+\r
+ Timer = NULL;\r
+ TimeRemained = Timeout;\r
+ Status = gBS->CreateEvent (EVT_TIMER, TPL_CALLBACK, NULL, NULL, &Timer);\r
+ if (EFI_ERROR (Status)) {\r
+ return EFI_DEVICE_ERROR;\r
+ }\r
+\r
+ do {\r
+ Status = gBS->SetTimer (\r
+ Timer,\r
+ TimerRelative,\r
+ MEDIA_STATE_DETECT_TIME_INTERVAL\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ gBS->CloseEvent(Timer);\r
+ return EFI_DEVICE_ERROR;\r
+ }\r
+\r
+ do {\r
+ TimerStatus = gBS->CheckEvent (Timer);\r
+ if (!EFI_ERROR (TimerStatus)) {\r
+\r
+ TimeRemained -= MEDIA_STATE_DETECT_TIME_INTERVAL;\r
+ Status = Aip->GetInformation (\r
+ Aip,\r
+ &gEfiAdapterInfoMediaStateGuid,\r
+ (VOID **) &MediaInfo,\r
+ &DataSize\r
+ );\r
+ if (!EFI_ERROR (Status)) {\r
+\r
+ *MediaState = MediaInfo->MediaState;\r
+ FreePool (MediaInfo);\r
+ } else {\r
+\r
+ if (MediaInfo != NULL) {\r
+ FreePool (MediaInfo);\r
+ }\r
+ gBS->CloseEvent(Timer);\r
+ return Status;\r
+ }\r
+ }\r
+ } while (TimerStatus == EFI_NOT_READY);\r
+ } while (*MediaState == EFI_NOT_READY && TimeRemained >= MEDIA_STATE_DETECT_TIME_INTERVAL);\r
+\r
+ gBS->CloseEvent(Timer);\r
+ if (*MediaState == EFI_NOT_READY && TimeRemained < MEDIA_STATE_DETECT_TIME_INTERVAL) {\r
+ return EFI_TIMEOUT;\r
+ } else {\r
+ return EFI_SUCCESS;\r
+ }\r
+}\r
+\r
+/**\r
+ Check the default address used by the IPv4 driver is static or dynamic (acquired\r
+ from DHCP).\r
+\r
+ If the controller handle does not have the EFI_IP4_CONFIG2_PROTOCOL installed, the\r
+ default address is static. If failed to get the policy from Ip4 Config2 Protocol,\r
+ the default address is static. Otherwise, get the result from Ip4 Config2 Protocol.\r
+\r
+ @param[in] Controller The controller handle which has the EFI_IP4_CONFIG2_PROTOCOL\r
+ relative with the default address to judge.\r
+\r
+ @retval TRUE If the default address is static.\r
+ @retval FALSE If the default address is acquired from DHCP.\r
+\r
+**/\r
+BOOLEAN\r
+NetLibDefaultAddressIsStatic (\r
+ IN EFI_HANDLE Controller\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ EFI_IP4_CONFIG2_PROTOCOL *Ip4Config2;\r
+ UINTN DataSize;\r
+ EFI_IP4_CONFIG2_POLICY Policy;\r
+ BOOLEAN IsStatic;\r
+\r
+ Ip4Config2 = NULL;\r
+\r
+ DataSize = sizeof (EFI_IP4_CONFIG2_POLICY);\r
+\r
+ IsStatic = TRUE;\r
+\r
+ //\r
+ // Get Ip4Config2 policy.\r
+ //\r
+ Status = gBS->HandleProtocol (Controller, &gEfiIp4Config2ProtocolGuid, (VOID **) &Ip4Config2);\r
+ if (EFI_ERROR (Status)) {\r
+ goto ON_EXIT;\r
+ }\r
+\r
+ Status = Ip4Config2->GetData (Ip4Config2, Ip4Config2DataTypePolicy, &DataSize, &Policy);\r
+ if (EFI_ERROR (Status)) {\r
+ goto ON_EXIT;\r
+ }\r
+\r
+ IsStatic = (BOOLEAN) (Policy == Ip4Config2PolicyStatic);\r
+\r
+ON_EXIT:\r
+\r
+ return IsStatic;\r
+}\r
+\r
+/**\r
+ Create an IPv4 device path node.\r
+\r
+ If Node is NULL, then ASSERT().\r
+\r
+ The header type of IPv4 device path node is MESSAGING_DEVICE_PATH.\r
+ The header subtype of IPv4 device path node is MSG_IPv4_DP.\r
+ Get other info from parameters to make up the whole IPv4 device path node.\r
+\r
+ @param[in, out] Node Pointer to the IPv4 device path node.\r
+ @param[in] Controller The controller handle.\r
+ @param[in] LocalIp The local IPv4 address.\r
+ @param[in] LocalPort The local port.\r
+ @param[in] RemoteIp The remote IPv4 address.\r
+ @param[in] RemotePort The remote port.\r
+ @param[in] Protocol The protocol type in the IP header.\r
+ @param[in] UseDefaultAddress Whether this instance is using default address or not.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+NetLibCreateIPv4DPathNode (\r
+ IN OUT IPv4_DEVICE_PATH *Node,\r
+ IN EFI_HANDLE Controller,\r
+ IN IP4_ADDR LocalIp,\r
+ IN UINT16 LocalPort,\r
+ IN IP4_ADDR RemoteIp,\r
+ IN UINT16 RemotePort,\r
+ IN UINT16 Protocol,\r
+ IN BOOLEAN UseDefaultAddress\r
+ )\r
+{\r
+ ASSERT (Node != NULL);\r
+\r
+ Node->Header.Type = MESSAGING_DEVICE_PATH;\r
+ Node->Header.SubType = MSG_IPv4_DP;\r
+ SetDevicePathNodeLength (&Node->Header, sizeof (IPv4_DEVICE_PATH));\r
+\r
+ CopyMem (&Node->LocalIpAddress, &LocalIp, sizeof (EFI_IPv4_ADDRESS));\r
+ CopyMem (&Node->RemoteIpAddress, &RemoteIp, sizeof (EFI_IPv4_ADDRESS));\r
+\r
+ Node->LocalPort = LocalPort;\r
+ Node->RemotePort = RemotePort;\r
+\r
+ Node->Protocol = Protocol;\r
+\r
+ if (!UseDefaultAddress) {\r
+ Node->StaticIpAddress = TRUE;\r
} else {\r
Node->StaticIpAddress = NetLibDefaultAddressIsStatic (Controller);\r
}\r
+\r
+ //\r
+ // Set the Gateway IP address to default value 0:0:0:0.\r
+ // Set the Subnet mask to default value 255:255:255:0.\r
+ //\r
+ ZeroMem (&Node->GatewayIpAddress, sizeof (EFI_IPv4_ADDRESS));\r
+ SetMem (&Node->SubnetMask, sizeof (EFI_IPv4_ADDRESS), 0xff);\r
+ Node->SubnetMask.Addr[3] = 0;\r
}\r
\r
/**\r
Create an IPv6 device path node.\r
\r
+ If Node is NULL, then ASSERT().\r
+ If LocalIp is NULL, then ASSERT().\r
+ If RemoteIp is NULL, then ASSERT().\r
+\r
The header type of IPv6 device path node is MESSAGING_DEVICE_PATH.\r
The header subtype of IPv6 device path node is MSG_IPv6_DP.\r
Get other info from parameters to make up the whole IPv6 device path node.\r
IN UINT16 Protocol\r
)\r
{\r
+ ASSERT (Node != NULL && LocalIp != NULL && RemoteIp != NULL);\r
+\r
Node->Header.Type = MESSAGING_DEVICE_PATH;\r
Node->Header.SubType = MSG_IPv6_DP;\r
SetDevicePathNodeLength (&Node->Header, sizeof (IPv6_DEVICE_PATH));\r
Node->RemotePort = RemotePort;\r
\r
Node->Protocol = Protocol;\r
- Node->StaticIpAddress = FALSE;\r
+\r
+ //\r
+ // Set default value to IPAddressOrigin, PrefixLength.\r
+ // Set the Gateway IP address to unspecified address.\r
+ //\r
+ Node->IpAddressOrigin = 0;\r
+ Node->PrefixLength = IP6_PREFIX_LENGTH;\r
+ ZeroMem (&Node->GatewayIpAddress, sizeof (EFI_IPv6_ADDRESS));\r
}\r
\r
/**\r
Find the UNDI/SNP handle from controller and protocol GUID.\r
\r
+ If ProtocolGuid is NULL, then ASSERT().\r
+\r
For example, IP will open a MNP child to transmit/receive\r
packets, when MNP is stopped, IP should also be stopped. IP\r
needs to find its own private data which is related the IP's\r
UINTN OpenCount;\r
UINTN Index;\r
\r
+ ASSERT (ProtocolGuid != NULL);\r
+\r
Status = gBS->OpenProtocolInformation (\r
Controller,\r
ProtocolGuid,\r
Handle = NULL;\r
\r
for (Index = 0; Index < OpenCount; Index++) {\r
- if (OpenBuffer[Index].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) {\r
+ if ((OpenBuffer[Index].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) {\r
Handle = OpenBuffer[Index].ControllerHandle;\r
break;\r
}\r
gBS->FreePool (OpenBuffer);\r
return Handle;\r
}\r
+\r
+/**\r
+ Convert one Null-terminated ASCII string (decimal dotted) to EFI_IPv4_ADDRESS.\r
+\r
+ @param[in] String The pointer to the Ascii string.\r
+ @param[out] Ip4Address The pointer to the converted IPv4 address.\r
+\r
+ @retval EFI_SUCCESS Convert to IPv4 address successfully.\r
+ @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip4Address is NULL.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibAsciiStrToIp4 (\r
+ IN CONST CHAR8 *String,\r
+ OUT EFI_IPv4_ADDRESS *Ip4Address\r
+ )\r
+{\r
+ RETURN_STATUS Status;\r
+ CHAR8 *EndPointer;\r
+\r
+ Status = AsciiStrToIpv4Address (String, &EndPointer, Ip4Address, NULL);\r
+ if (RETURN_ERROR (Status) || (*EndPointer != '\0')) {\r
+ return EFI_INVALID_PARAMETER;\r
+ } else {\r
+ return EFI_SUCCESS;\r
+ }\r
+}\r
+\r
+\r
+/**\r
+ Convert one Null-terminated ASCII string to EFI_IPv6_ADDRESS. The format of the\r
+ string is defined in RFC 4291 - Text Representation of Addresses.\r
+\r
+ @param[in] String The pointer to the Ascii string.\r
+ @param[out] Ip6Address The pointer to the converted IPv6 address.\r
+\r
+ @retval EFI_SUCCESS Convert to IPv6 address successfully.\r
+ @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip6Address is NULL.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibAsciiStrToIp6 (\r
+ IN CONST CHAR8 *String,\r
+ OUT EFI_IPv6_ADDRESS *Ip6Address\r
+ )\r
+{\r
+ RETURN_STATUS Status;\r
+ CHAR8 *EndPointer;\r
+\r
+ Status = AsciiStrToIpv6Address (String, &EndPointer, Ip6Address, NULL);\r
+ if (RETURN_ERROR (Status) || (*EndPointer != '\0')) {\r
+ return EFI_INVALID_PARAMETER;\r
+ } else {\r
+ return EFI_SUCCESS;\r
+ }\r
+}\r
+\r
+\r
+/**\r
+ Convert one Null-terminated Unicode string (decimal dotted) to EFI_IPv4_ADDRESS.\r
+\r
+ @param[in] String The pointer to the Ascii string.\r
+ @param[out] Ip4Address The pointer to the converted IPv4 address.\r
+\r
+ @retval EFI_SUCCESS Convert to IPv4 address successfully.\r
+ @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip4Address is NULL.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibStrToIp4 (\r
+ IN CONST CHAR16 *String,\r
+ OUT EFI_IPv4_ADDRESS *Ip4Address\r
+ )\r
+{\r
+ RETURN_STATUS Status;\r
+ CHAR16 *EndPointer;\r
+\r
+ Status = StrToIpv4Address (String, &EndPointer, Ip4Address, NULL);\r
+ if (RETURN_ERROR (Status) || (*EndPointer != L'\0')) {\r
+ return EFI_INVALID_PARAMETER;\r
+ } else {\r
+ return EFI_SUCCESS;\r
+ }\r
+}\r
+\r
+\r
+/**\r
+ Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS. The format of\r
+ the string is defined in RFC 4291 - Text Representation of Addresses.\r
+\r
+ @param[in] String The pointer to the Ascii string.\r
+ @param[out] Ip6Address The pointer to the converted IPv6 address.\r
+\r
+ @retval EFI_SUCCESS Convert to IPv6 address successfully.\r
+ @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip6Address is NULL.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibStrToIp6 (\r
+ IN CONST CHAR16 *String,\r
+ OUT EFI_IPv6_ADDRESS *Ip6Address\r
+ )\r
+{\r
+ RETURN_STATUS Status;\r
+ CHAR16 *EndPointer;\r
+\r
+ Status = StrToIpv6Address (String, &EndPointer, Ip6Address, NULL);\r
+ if (RETURN_ERROR (Status) || (*EndPointer != L'\0')) {\r
+ return EFI_INVALID_PARAMETER;\r
+ } else {\r
+ return EFI_SUCCESS;\r
+ }\r
+}\r
+\r
+/**\r
+ Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS and prefix length.\r
+ The format of the string is defined in RFC 4291 - Text Representation of Addresses\r
+ Prefixes: ipv6-address/prefix-length.\r
+\r
+ @param[in] String The pointer to the Ascii string.\r
+ @param[out] Ip6Address The pointer to the converted IPv6 address.\r
+ @param[out] PrefixLength The pointer to the converted prefix length.\r
+\r
+ @retval EFI_SUCCESS Convert to IPv6 address successfully.\r
+ @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip6Address is NULL.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibStrToIp6andPrefix (\r
+ IN CONST CHAR16 *String,\r
+ OUT EFI_IPv6_ADDRESS *Ip6Address,\r
+ OUT UINT8 *PrefixLength\r
+ )\r
+{\r
+ RETURN_STATUS Status;\r
+ CHAR16 *EndPointer;\r
+\r
+ Status = StrToIpv6Address (String, &EndPointer, Ip6Address, PrefixLength);\r
+ if (RETURN_ERROR (Status) || (*EndPointer != L'\0')) {\r
+ return EFI_INVALID_PARAMETER;\r
+ } else {\r
+ return EFI_SUCCESS;\r
+ }\r
+}\r
+\r
+/**\r
+\r
+ Convert one EFI_IPv6_ADDRESS to Null-terminated Unicode string.\r
+ The text representation of address is defined in RFC 4291.\r
+\r
+ @param[in] Ip6Address The pointer to the IPv6 address.\r
+ @param[out] String The buffer to return the converted string.\r
+ @param[in] StringSize The length in bytes of the input String.\r
+\r
+ @retval EFI_SUCCESS Convert to string successfully.\r
+ @retval EFI_INVALID_PARAMETER The input parameter is invalid.\r
+ @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result. BufferSize has been\r
+ updated with the size needed to complete the request.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibIp6ToStr (\r
+ IN EFI_IPv6_ADDRESS *Ip6Address,\r
+ OUT CHAR16 *String,\r
+ IN UINTN StringSize\r
+ )\r
+{\r
+ UINT16 Ip6Addr[8];\r
+ UINTN Index;\r
+ UINTN LongestZerosStart;\r
+ UINTN LongestZerosLength;\r
+ UINTN CurrentZerosStart;\r
+ UINTN CurrentZerosLength;\r
+ CHAR16 Buffer[sizeof"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff"];\r
+ CHAR16 *Ptr;\r
+\r
+ if (Ip6Address == NULL || String == NULL || StringSize == 0) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ //\r
+ // Convert the UINT8 array to an UINT16 array for easy handling.\r
+ //\r
+ ZeroMem (Ip6Addr, sizeof (Ip6Addr));\r
+ for (Index = 0; Index < 16; Index++) {\r
+ Ip6Addr[Index / 2] |= (Ip6Address->Addr[Index] << ((1 - (Index % 2)) << 3));\r
+ }\r
+\r
+ //\r
+ // Find the longest zeros and mark it.\r
+ //\r
+ CurrentZerosStart = DEFAULT_ZERO_START;\r
+ CurrentZerosLength = 0;\r
+ LongestZerosStart = DEFAULT_ZERO_START;\r
+ LongestZerosLength = 0;\r
+ for (Index = 0; Index < 8; Index++) {\r
+ if (Ip6Addr[Index] == 0) {\r
+ if (CurrentZerosStart == DEFAULT_ZERO_START) {\r
+ CurrentZerosStart = Index;\r
+ CurrentZerosLength = 1;\r
+ } else {\r
+ CurrentZerosLength++;\r
+ }\r
+ } else {\r
+ if (CurrentZerosStart != DEFAULT_ZERO_START) {\r
+ if (CurrentZerosLength > 2 && (LongestZerosStart == (DEFAULT_ZERO_START) || CurrentZerosLength > LongestZerosLength)) {\r
+ LongestZerosStart = CurrentZerosStart;\r
+ LongestZerosLength = CurrentZerosLength;\r
+ }\r
+ CurrentZerosStart = DEFAULT_ZERO_START;\r
+ CurrentZerosLength = 0;\r
+ }\r
+ }\r
+ }\r
+\r
+ if (CurrentZerosStart != DEFAULT_ZERO_START && CurrentZerosLength > 2) {\r
+ if (LongestZerosStart == DEFAULT_ZERO_START || LongestZerosLength < CurrentZerosLength) {\r
+ LongestZerosStart = CurrentZerosStart;\r
+ LongestZerosLength = CurrentZerosLength;\r
+ }\r
+ }\r
+\r
+ Ptr = Buffer;\r
+ for (Index = 0; Index < 8; Index++) {\r
+ if (LongestZerosStart != DEFAULT_ZERO_START && Index >= LongestZerosStart && Index < LongestZerosStart + LongestZerosLength) {\r
+ if (Index == LongestZerosStart) {\r
+ *Ptr++ = L':';\r
+ }\r
+ continue;\r
+ }\r
+ if (Index != 0) {\r
+ *Ptr++ = L':';\r
+ }\r
+ Ptr += UnicodeSPrint(Ptr, 10, L"%x", Ip6Addr[Index]);\r
+ }\r
+\r
+ if (LongestZerosStart != DEFAULT_ZERO_START && LongestZerosStart + LongestZerosLength == 8) {\r
+ *Ptr++ = L':';\r
+ }\r
+ *Ptr = L'\0';\r
+\r
+ if ((UINTN)Ptr - (UINTN)Buffer > StringSize) {\r
+ return EFI_BUFFER_TOO_SMALL;\r
+ }\r
+\r
+ StrCpyS (String, StringSize / sizeof (CHAR16), Buffer);\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ This function obtains the system guid from the smbios table.\r
+\r
+ If SystemGuid is NULL, then ASSERT().\r
+\r
+ @param[out] SystemGuid The pointer of the returned system guid.\r
+\r
+ @retval EFI_SUCCESS Successfully obtained the system guid.\r
+ @retval EFI_NOT_FOUND Did not find the SMBIOS table.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibGetSystemGuid (\r
+ OUT EFI_GUID *SystemGuid\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ SMBIOS_TABLE_ENTRY_POINT *SmbiosTable;\r
+ SMBIOS_TABLE_3_0_ENTRY_POINT *Smbios30Table;\r
+ SMBIOS_STRUCTURE_POINTER Smbios;\r
+ SMBIOS_STRUCTURE_POINTER SmbiosEnd;\r
+ CHAR8 *String;\r
+\r
+ ASSERT (SystemGuid != NULL);\r
+\r
+ SmbiosTable = NULL;\r
+ Status = EfiGetSystemConfigurationTable (&gEfiSmbios3TableGuid, (VOID **) &Smbios30Table);\r
+ if (!(EFI_ERROR (Status) || Smbios30Table == NULL)) {\r
+ Smbios.Hdr = (SMBIOS_STRUCTURE *) (UINTN) Smbios30Table->TableAddress;\r
+ SmbiosEnd.Raw = (UINT8 *) (UINTN) (Smbios30Table->TableAddress + Smbios30Table->TableMaximumSize);\r
+ } else {\r
+ Status = EfiGetSystemConfigurationTable (&gEfiSmbiosTableGuid, (VOID **) &SmbiosTable);\r
+ if (EFI_ERROR (Status) || SmbiosTable == NULL) {\r
+ return EFI_NOT_FOUND;\r
+ }\r
+ Smbios.Hdr = (SMBIOS_STRUCTURE *) (UINTN) SmbiosTable->TableAddress;\r
+ SmbiosEnd.Raw = (UINT8 *) ((UINTN) SmbiosTable->TableAddress + SmbiosTable->TableLength);\r
+ }\r
+\r
+ do {\r
+ if (Smbios.Hdr->Type == 1) {\r
+ if (Smbios.Hdr->Length < 0x19) {\r
+ //\r
+ // Older version did not support UUID.\r
+ //\r
+ return EFI_NOT_FOUND;\r
+ }\r
+\r
+ //\r
+ // SMBIOS tables are byte packed so we need to do a byte copy to\r
+ // prevend alignment faults on Itanium-based platform.\r
+ //\r
+ CopyMem (SystemGuid, &Smbios.Type1->Uuid, sizeof (EFI_GUID));\r
+ return EFI_SUCCESS;\r
+ }\r
+\r
+ //\r
+ // Go to the next SMBIOS structure. Each SMBIOS structure may include 2 parts:\r
+ // 1. Formatted section; 2. Unformatted string section. So, 2 steps are needed\r
+ // to skip one SMBIOS structure.\r
+ //\r
+\r
+ //\r
+ // Step 1: Skip over formatted section.\r
+ //\r
+ String = (CHAR8 *) (Smbios.Raw + Smbios.Hdr->Length);\r
+\r
+ //\r
+ // Step 2: Skip over unformated string section.\r
+ //\r
+ do {\r
+ //\r
+ // Each string is terminated with a NULL(00h) BYTE and the sets of strings\r
+ // is terminated with an additional NULL(00h) BYTE.\r
+ //\r
+ for ( ; *String != 0; String++) {\r
+ }\r
+\r
+ if (*(UINT8*)++String == 0) {\r
+ //\r
+ // Pointer to the next SMBIOS structure.\r
+ //\r
+ Smbios.Raw = (UINT8 *)++String;\r
+ break;\r
+ }\r
+ } while (TRUE);\r
+ } while (Smbios.Raw < SmbiosEnd.Raw);\r
+ return EFI_NOT_FOUND;\r
+}\r
+\r
+/**\r
+ Create Dns QName according the queried domain name.\r
+\r
+ If DomainName is NULL, then ASSERT().\r
+\r
+ QName is a domain name represented as a sequence of labels,\r
+ where each label consists of a length octet followed by that\r
+ number of octets. The QName terminates with the zero\r
+ length octet for the null label of the root. Caller should\r
+ take responsibility to free the buffer in returned pointer.\r
+\r
+ @param DomainName The pointer to the queried domain name string.\r
+\r
+ @retval NULL Failed to fill QName.\r
+ @return QName filled successfully.\r
+\r
+**/\r
+CHAR8 *\r
+EFIAPI\r
+NetLibCreateDnsQName (\r
+ IN CHAR16 *DomainName\r
+ )\r
+{\r
+ CHAR8 *QueryName;\r
+ UINTN QueryNameSize;\r
+ CHAR8 *Header;\r
+ CHAR8 *Tail;\r
+ UINTN Len;\r
+ UINTN Index;\r
+\r
+ ASSERT (DomainName != NULL);\r
+\r
+ QueryName = NULL;\r
+ QueryNameSize = 0;\r
+ Header = NULL;\r
+ Tail = NULL;\r
+\r
+ //\r
+ // One byte for first label length, one byte for terminated length zero.\r
+ //\r
+ QueryNameSize = StrLen (DomainName) + 2;\r
+\r
+ if (QueryNameSize > DNS_MAX_NAME_SIZE) {\r
+ return NULL;\r
+ }\r
+\r
+ QueryName = AllocateZeroPool (QueryNameSize);\r
+ if (QueryName == NULL) {\r
+ return NULL;\r
+ }\r
+\r
+ Header = QueryName;\r
+ Tail = Header + 1;\r
+ Len = 0;\r
+ for (Index = 0; DomainName[Index] != 0; Index++) {\r
+ *Tail = (CHAR8) DomainName[Index];\r
+ if (*Tail == '.') {\r
+ *Header = (CHAR8) Len;\r
+ Header = Tail;\r
+ Tail ++;\r
+ Len = 0;\r
+ } else {\r
+ Tail++;\r
+ Len++;\r
+ }\r
+ }\r
+ *Header = (CHAR8) Len;\r
+ *Tail = 0;\r
+\r
+ return QueryName;\r
+}\r
projects / mirror_edk2.git / blobdiff