-/** @file\r
- Network library.\r
-\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/Ip4Config2.h>\r
-#include <Protocol/ComponentName.h>\r
-#include <Protocol/ComponentName2.h>\r
-\r
-#include <Guid/SmBios.h>\r
-\r
-#include <Library/NetLib.h>\r
-#include <Library/BaseLib.h>\r
-#include <Library/DebugLib.h>\r
-#include <Library/BaseMemoryLib.h>\r
-#include <Library/UefiBootServicesTableLib.h>\r
-#include <Library/UefiRuntimeServicesTableLib.h>\r
-#include <Library/MemoryAllocationLib.h>\r
-#include <Library/DevicePathLib.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 DEFAULT_ZERO_START ((UINTN) ~0)\r
-\r
-//\r
-// All the supported IP4 maskes in host byte order.\r
-//\r
-GLOBAL_REMOVE_IF_UNREFERENCED IP4_ADDR gIp4AllMasks[IP4_MASK_NUM] = {\r
- 0x00000000,\r
- 0x80000000,\r
- 0xC0000000,\r
- 0xE0000000,\r
- 0xF0000000,\r
- 0xF8000000,\r
- 0xFC000000,\r
- 0xFE000000,\r
-\r
- 0xFF000000,\r
- 0xFF800000,\r
- 0xFFC00000,\r
- 0xFFE00000,\r
- 0xFFF00000,\r
- 0xFFF80000,\r
- 0xFFFC0000,\r
- 0xFFFE0000,\r
-\r
- 0xFFFF0000,\r
- 0xFFFF8000,\r
- 0xFFFFC000,\r
- 0xFFFFE000,\r
- 0xFFFFF000,\r
- 0xFFFFF800,\r
- 0xFFFFFC00,\r
- 0xFFFFFE00,\r
-\r
- 0xFFFFFF00,\r
- 0xFFFFFF80,\r
- 0xFFFFFFC0,\r
- 0xFFFFFFE0,\r
- 0xFFFFFFF0,\r
- 0xFFFFFFF8,\r
- 0xFFFFFFFC,\r
- 0xFFFFFFFE,\r
- 0xFFFFFFFF,\r
-};\r
-\r
-GLOBAL_REMOVE_IF_UNREFERENCED EFI_IPv4_ADDRESS mZeroIp4Addr = {{0, 0, 0, 0}};\r
-\r
-//\r
-// Any error level digitally larger than mNetDebugLevelMax\r
-// will be silently discarded.\r
-//\r
-GLOBAL_REMOVE_IF_UNREFERENCED UINTN mNetDebugLevelMax = NETDEBUG_LEVEL_ERROR;\r
-GLOBAL_REMOVE_IF_UNREFERENCED UINT32 mSyslogPacketSeq = 0xDEADBEEF;\r
-\r
-//\r
-// You can change mSyslogDstMac mSyslogDstIp and mSyslogSrcIp\r
-// here to direct the syslog packets to the syslog deamon. The\r
-// default is broadcast to both the ethernet and IP.\r
-//\r
-GLOBAL_REMOVE_IF_UNREFERENCED UINT8 mSyslogDstMac[NET_ETHER_ADDR_LEN] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff};\r
-GLOBAL_REMOVE_IF_UNREFERENCED UINT32 mSyslogDstIp = 0xffffffff;\r
-GLOBAL_REMOVE_IF_UNREFERENCED UINT32 mSyslogSrcIp = 0;\r
-\r
-GLOBAL_REMOVE_IF_UNREFERENCED CHAR8 *mMonthName[] = {\r
- "Jan",\r
- "Feb",\r
- "Mar",\r
- "Apr",\r
- "May",\r
- "Jun",\r
- "Jul",\r
- "Aug",\r
- "Sep",\r
- "Oct",\r
- "Nov",\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
- the SNP after use because the SNP is opened by HandleProtocol.\r
-\r
- @return The point to SNP if one is properly openned. Otherwise NULL\r
-\r
-**/\r
-EFI_SIMPLE_NETWORK_PROTOCOL *\r
-SyslogLocateSnp (\r
- VOID\r
- )\r
-{\r
- EFI_SIMPLE_NETWORK_PROTOCOL *Snp;\r
- EFI_STATUS Status;\r
- EFI_HANDLE *Handles;\r
- UINTN HandleCount;\r
- UINTN Index;\r
-\r
- //\r
- // Locate the handles which has SNP installed.\r
- //\r
- Handles = NULL;\r
- Status = gBS->LocateHandleBuffer (\r
- ByProtocol,\r
- &gEfiSimpleNetworkProtocolGuid,\r
- NULL,\r
- &HandleCount,\r
- &Handles\r
- );\r
-\r
- if (EFI_ERROR (Status) || (HandleCount == 0)) {\r
- return NULL;\r
- }\r
-\r
- //\r
- // Try to open one of the ethernet SNP protocol to send packet\r
- //\r
- Snp = NULL;\r
-\r
- for (Index = 0; Index < HandleCount; Index++) {\r
- Status = gBS->HandleProtocol (\r
- Handles[Index],\r
- &gEfiSimpleNetworkProtocolGuid,\r
- (VOID **) &Snp\r
- );\r
-\r
- if ((Status == EFI_SUCCESS) && (Snp != NULL) &&\r
- (Snp->Mode->IfType == NET_IFTYPE_ETHERNET) &&\r
- (Snp->Mode->MaxPacketSize >= NET_SYSLOG_PACKET_LEN)) {\r
-\r
- break;\r
- }\r
-\r
- Snp = NULL;\r
- }\r
-\r
- FreePool (Handles);\r
- return Snp;\r
-}\r
-\r
-/**\r
- Transmit a syslog packet synchronously through SNP. The Packet\r
- already has the ethernet header prepended. This function should\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
-\r
- @retval EFI_DEVICE_ERROR Failed to locate a usable SNP protocol\r
- @retval EFI_TIMEOUT Timeout happened to send the packet.\r
- @retval EFI_SUCCESS Packet is sent.\r
-\r
-**/\r
-EFI_STATUS\r
-SyslogSendPacket (\r
- IN CHAR8 *Packet,\r
- IN UINT32 Length\r
- )\r
-{\r
- EFI_SIMPLE_NETWORK_PROTOCOL *Snp;\r
- ETHER_HEAD *Ether;\r
- EFI_STATUS Status;\r
- EFI_EVENT TimeoutEvent;\r
- UINT8 *TxBuf;\r
-\r
- ASSERT (Packet != NULL);\r
-\r
- Snp = SyslogLocateSnp ();\r
-\r
- if (Snp == NULL) {\r
- return EFI_DEVICE_ERROR;\r
- }\r
-\r
- Ether = (ETHER_HEAD *) Packet;\r
- CopyMem (Ether->SrcMac, Snp->Mode->CurrentAddress.Addr, NET_ETHER_ADDR_LEN);\r
-\r
- //\r
- // Start the timeout event.\r
- //\r
- Status = gBS->CreateEvent (\r
- EVT_TIMER,\r
- TPL_NOTIFY,\r
- NULL,\r
- NULL,\r
- &TimeoutEvent\r
- );\r
-\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- Status = gBS->SetTimer (TimeoutEvent, TimerRelative, NET_SYSLOG_TX_TIMEOUT);\r
-\r
- if (EFI_ERROR (Status)) {\r
- goto ON_EXIT;\r
- }\r
-\r
- for (;;) {\r
- //\r
- // Transmit the packet through SNP.\r
- //\r
- Status = Snp->Transmit (Snp, 0, Length, Packet, NULL, NULL, NULL);\r
-\r
- if ((Status != EFI_SUCCESS) && (Status != EFI_NOT_READY)) {\r
- Status = EFI_DEVICE_ERROR;\r
- break;\r
- }\r
-\r
- //\r
- // If Status is EFI_SUCCESS, the packet is put in the transmit queue.\r
- // if Status is EFI_NOT_READY, the transmit engine of the network\r
- // interface is busy. Both need to sync SNP.\r
- //\r
- TxBuf = NULL;\r
-\r
- do {\r
- //\r
- // Get the recycled transmit buffer status.\r
- //\r
- Snp->GetStatus (Snp, NULL, (VOID **) &TxBuf);\r
-\r
- if (!EFI_ERROR (gBS->CheckEvent (TimeoutEvent))) {\r
- Status = EFI_TIMEOUT;\r
- break;\r
- }\r
-\r
- } while (TxBuf == NULL);\r
-\r
- if ((Status == EFI_SUCCESS) || (Status == EFI_TIMEOUT)) {\r
- break;\r
- }\r
-\r
- //\r
- // Status is EFI_NOT_READY. Restart the timer event and\r
- // call Snp->Transmit again.\r
- //\r
- gBS->SetTimer (TimeoutEvent, TimerRelative, NET_SYSLOG_TX_TIMEOUT);\r
- }\r
-\r
- gBS->SetTimer (TimeoutEvent, TimerCancel, 0);\r
-\r
-ON_EXIT:\r
- gBS->CloseEvent (TimeoutEvent);\r
- return Status;\r
-}\r
-\r
-/**\r
- Build a syslog packet, including the Ethernet/Ip/Udp headers\r
- and user's message.\r
-\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] Message The log message\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, 0 represents no packet is built.\r
-\r
-**/\r
-UINT32\r
-SyslogBuildPacket (\r
- IN UINT32 Level,\r
- IN UINT8 *Module,\r
- IN UINT8 *File,\r
- IN UINT32 Line,\r
- IN UINT8 *Message,\r
- IN UINT32 BufLen,\r
- OUT CHAR8 *Buf\r
- )\r
-{\r
- EFI_STATUS Status;\r
- ETHER_HEAD *Ether;\r
- IP4_HEAD *Ip4;\r
- EFI_UDP_HEADER *Udp4;\r
- EFI_TIME Time;\r
- UINT32 Pri;\r
- UINT32 Len;\r
-\r
- //\r
- // Fill in the Ethernet header. Leave alone the source MAC.\r
- // SyslogSendPacket will fill in the address for us.\r
- //\r
- Ether = (ETHER_HEAD *) Buf;\r
- CopyMem (Ether->DstMac, mSyslogDstMac, NET_ETHER_ADDR_LEN);\r
- ZeroMem (Ether->SrcMac, NET_ETHER_ADDR_LEN);\r
-\r
- Ether->EtherType = HTONS (0x0800); // IPv4 protocol\r
-\r
- Buf += sizeof (ETHER_HEAD);\r
- BufLen -= sizeof (ETHER_HEAD);\r
-\r
- //\r
- // Fill in the IP header\r
- //\r
- Ip4 = (IP4_HEAD *) Buf;\r
- Ip4->HeadLen = 5;\r
- Ip4->Ver = 4;\r
- Ip4->Tos = 0;\r
- Ip4->TotalLen = 0;\r
- Ip4->Id = (UINT16) mSyslogPacketSeq;\r
- Ip4->Fragment = 0;\r
- Ip4->Ttl = 16;\r
- Ip4->Protocol = 0x11;\r
- Ip4->Checksum = 0;\r
- Ip4->Src = mSyslogSrcIp;\r
- Ip4->Dst = mSyslogDstIp;\r
-\r
- Buf += sizeof (IP4_HEAD);\r
- BufLen -= sizeof (IP4_HEAD);\r
-\r
- //\r
- // Fill in the UDP header, Udp checksum is optional. Leave it zero.\r
- //\r
- Udp4 = (EFI_UDP_HEADER *) Buf;\r
- Udp4->SrcPort = HTONS (514);\r
- Udp4->DstPort = HTONS (514);\r
- Udp4->Length = 0;\r
- Udp4->Checksum = 0;\r
-\r
- Buf += sizeof (EFI_UDP_HEADER);\r
- BufLen -= sizeof (EFI_UDP_HEADER);\r
-\r
- //\r
- // Build the syslog message body with <PRI> Timestamp machine module Message\r
- //\r
- Pri = ((NET_SYSLOG_FACILITY & 31) << 3) | (Level & 7);\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
- //\r
- Len = 0;\r
- Len += (UINT32) AsciiSPrint (\r
- Buf,\r
- BufLen,\r
- "<%d> %a %d %d:%d:%d ",\r
- Pri,\r
- mMonthName [Time.Month-1],\r
- Time.Day,\r
- Time.Hour,\r
- Time.Minute,\r
- Time.Second\r
- );\r
-\r
- Len += (UINT32) AsciiSPrint (\r
- Buf + Len,\r
- BufLen - Len,\r
- "Tiano %a: %a (Line: %d File: %a)",\r
- Module,\r
- Message,\r
- Line,\r
- File\r
- );\r
- Len ++;\r
-\r
- //\r
- // OK, patch the IP length/checksum and UDP length fields.\r
- //\r
- Len += sizeof (EFI_UDP_HEADER);\r
- Udp4->Length = HTONS ((UINT16) Len);\r
-\r
- Len += sizeof (IP4_HEAD);\r
- Ip4->TotalLen = HTONS ((UINT16) Len);\r
- Ip4->Checksum = (UINT16) (~NetblockChecksum ((UINT8 *) Ip4, sizeof (IP4_HEAD)));\r
-\r
- return Len + sizeof (ETHER_HEAD);\r
-}\r
-\r
-/**\r
- Allocate a buffer, then format the message to it. This is a\r
- help function for the NET_DEBUG_XXX macros. The PrintArg of\r
- these macros treats the variable length print parameters as a\r
- single parameter, and pass it to the NetDebugASPrint. For\r
- example, NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name))\r
- if extracted to:\r
-\r
- NetDebugOutput (\r
- NETDEBUG_LEVEL_TRACE,\r
- "Tcp",\r
- __FILE__,\r
- __LINE__,\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
- @return The buffer containing the formatted message,\r
- or NULL if failed to allocate memory.\r
-\r
-**/\r
-CHAR8 *\r
-EFIAPI\r
-NetDebugASPrint (\r
- IN CHAR8 *Format,\r
- ...\r
- )\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
- return NULL;\r
- }\r
-\r
- VA_START (Marker, Format);\r
- AsciiVSPrint (Buf, NET_DEBUG_MSG_LEN, Format, Marker);\r
- VA_END (Marker);\r
-\r
- return Buf;\r
-}\r
-\r
-/**\r
- Builds an UDP4 syslog packet and send it using SNP.\r
-\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 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_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
- IN UINT8 *File,\r
- IN UINT32 Line,\r
- IN UINT8 *Message\r
- )\r
-{\r
- CHAR8 *Packet;\r
- UINT32 Len;\r
- EFI_STATUS Status;\r
-\r
- //\r
- // Check whether the message should be sent out\r
- //\r
- if (Message == NULL || File == NULL || Module == NULL) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- if (Level > mNetDebugLevelMax) {\r
- Status = EFI_SUCCESS;\r
- goto ON_EXIT;\r
- }\r
-\r
- //\r
- // Allocate a maxium of 1024 bytes, the caller should ensure\r
- // that the message plus the ethernet/ip/udp header is shorter\r
- // than this\r
- //\r
- Packet = (CHAR8 *) AllocatePool (NET_SYSLOG_PACKET_LEN);\r
-\r
- if (Packet == NULL) {\r
- Status = EFI_OUT_OF_RESOURCES;\r
- goto ON_EXIT;\r
- }\r
-\r
- //\r
- // Build the message: Ethernet header + IP header + Udp Header + user data\r
- //\r
- Len = SyslogBuildPacket (\r
- Level,\r
- Module,\r
- File,\r
- Line,\r
- Message,\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
- FreePool (Packet);\r
-\r
-ON_EXIT:\r
- FreePool (Message);\r
- return Status;\r
-}\r
-/**\r
- Return the length of the mask.\r
-\r
- Return the length of the mask, the correct value is from 0 to 32.\r
- If the mask is invalid, return the invalid length 33, which is IP4_MASK_NUM.\r
- NetMask is in the host byte order.\r
-\r
- @param[in] NetMask The netmask to get the length from.\r
-\r
- @return The length of the netmask, IP4_MASK_NUM if the mask is invalid.\r
-\r
-**/\r
-INTN\r
-EFIAPI\r
-NetGetMaskLength (\r
- IN IP4_ADDR NetMask\r
- )\r
-{\r
- INTN Index;\r
-\r
- for (Index = 0; Index <= IP4_MASK_MAX; Index++) {\r
- if (NetMask == gIp4AllMasks[Index]) {\r
- break;\r
- }\r
- }\r
-\r
- return Index;\r
-}\r
-\r
-\r
-\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
- If the address belong to class B, return IP4_ADDR_CLASSB.\r
- The address of class C starts with 110.\r
- If the address belong to class C, return IP4_ADDR_CLASSC.\r
- The address of class D starts with 1110.\r
- If the address belong to class D, return IP4_ADDR_CLASSD.\r
- The address of class E starts with 1111.\r
- If the address belong to class E, return IP4_ADDR_CLASSE.\r
-\r
-\r
- @param[in] Addr The address to get the class from.\r
-\r
- @return IP address class, such as IP4_ADDR_CLASSA.\r
-\r
-**/\r
-INTN\r
-EFIAPI\r
-NetGetIpClass (\r
- IN IP4_ADDR Addr\r
- )\r
-{\r
- UINT8 ByteOne;\r
-\r
- ByteOne = (UINT8) (Addr >> 24);\r
-\r
- if ((ByteOne & 0x80) == 0) {\r
- return IP4_ADDR_CLASSA;\r
-\r
- } else if ((ByteOne & 0xC0) == 0x80) {\r
- return IP4_ADDR_CLASSB;\r
-\r
- } else if ((ByteOne & 0xE0) == 0xC0) {\r
- return IP4_ADDR_CLASSC;\r
-\r
- } else if ((ByteOne & 0xF0) == 0xE0) {\r
- return IP4_ADDR_CLASSD;\r
-\r
- } else {\r
- return IP4_ADDR_CLASSE;\r
-\r
- }\r
-}\r
-\r
-\r
-/**\r
- Check whether the IP is a valid unicast address according to\r
- the netmask.\r
-\r
- ASSERT if NetMask is zero.\r
-\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
-\r
- @return TRUE if IP is a valid unicast address on the network, otherwise FALSE.\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-NetIp4IsUnicast (\r
- IN IP4_ADDR Ip,\r
- IN IP4_ADDR NetMask\r
- )\r
-{\r
- INTN MaskLength;\r
-\r
- ASSERT (NetMask != 0);\r
-\r
- if (Ip == 0 || IP4_IS_LOCAL_BROADCAST (Ip)) {\r
- return FALSE;\r
- }\r
-\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
-\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
- ::1, it is also not a valid unicast address to be assigned to any physical\r
- interface.\r
-\r
- @param[in] Ip6 The IPv6 address to check against.\r
-\r
- @return TRUE if Ip6 is a valid unicast address on the network, otherwise FALSE.\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-NetIp6IsValidUnicast (\r
- IN EFI_IPv6_ADDRESS *Ip6\r
- )\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
- for (Index = 0; Index < 15; Index++) {\r
- if (Ip6->Addr[Index] != 0) {\r
- return TRUE;\r
- }\r
- }\r
-\r
- Byte = Ip6->Addr[Index];\r
-\r
- if (Byte == 0x0 || Byte == 0x1) {\r
- return FALSE;\r
- }\r
-\r
- return TRUE;\r
-}\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
- @retval FALSE - No\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
- }\r
-\r
- return TRUE;\r
-}\r
-\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
- @retval FALSE - No\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-NetIp6IsLinkLocalAddr (\r
- IN EFI_IPv6_ADDRESS *Ip6\r
- )\r
-{\r
- UINT8 Index;\r
-\r
- ASSERT (Ip6 != NULL);\r
-\r
- if (Ip6->Addr[0] != 0xFE) {\r
- return FALSE;\r
- }\r
-\r
- if (Ip6->Addr[1] != 0x80) {\r
- return FALSE;\r
- }\r
-\r
- for (Index = 2; Index < 8; Index++) {\r
- if (Ip6->Addr[Index] != 0) {\r
- return FALSE;\r
- }\r
- }\r
-\r
- return TRUE;\r
-}\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
- @retval TRUE - Yes, connected.\r
- @retval FALSE - No.\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-NetIp6IsNetEqual (\r
- EFI_IPv6_ADDRESS *Ip1,\r
- EFI_IPv6_ADDRESS *Ip2,\r
- UINT8 PrefixLength\r
- )\r
-{\r
- UINT8 Byte;\r
- UINT8 Bit;\r
- UINT8 Mask;\r
-\r
- ASSERT ((Ip1 != NULL) && (Ip2 != NULL) && (PrefixLength < IP6_PREFIX_MAX));\r
-\r
- if (PrefixLength == 0) {\r
- return TRUE;\r
- }\r
-\r
- Byte = (UINT8) (PrefixLength / 8);\r
- Bit = (UINT8) (PrefixLength % 8);\r
-\r
- if (CompareMem (Ip1, Ip2, Byte) != 0) {\r
- return FALSE;\r
- }\r
-\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
-\r
- return TRUE;\r
-}\r
-\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
- @param Ip6 Points to an IPv6 address\r
-\r
- @return The byte swapped IPv6 address.\r
-\r
-**/\r
-EFI_IPv6_ADDRESS *\r
-EFIAPI\r
-Ip6Swap128 (\r
- EFI_IPv6_ADDRESS *Ip6\r
- )\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
- High = SwapBytes64 (High);\r
- Low = SwapBytes64 (Low);\r
-\r
- CopyMem (Ip6, &Low, sizeof (UINT64));\r
- CopyMem (&Ip6->Addr[8], &High, sizeof (UINT64));\r
-\r
- return Ip6;\r
-}\r
-\r
-/**\r
- Initialize a random seed using current time and monotonic count.\r
-\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
-UINT32\r
-EFIAPI\r
-NetRandomInitSeed (\r
- VOID\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.Nanosecond;\r
- Seed ^= Time.Year << 7;\r
-\r
- gBS->GetNextMonotonicCount (&MonotonicCount);\r
- Seed += (UINT32) MonotonicCount;\r
-\r
- return Seed;\r
-}\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
- @param[in] Buf The buffer to extract the UINT32.\r
-\r
- @return The UINT32 extracted.\r
-\r
-**/\r
-UINT32\r
-EFIAPI\r
-NetGetUint32 (\r
- IN UINT8 *Buf\r
- )\r
-{\r
- UINT32 Value;\r
-\r
- ASSERT (Buf != NULL);\r
-\r
- CopyMem (&Value, Buf, sizeof (UINT32));\r
- return NTOHL (Value);\r
-}\r
-\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 be converted and put into the byte stream.\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-NetPutUint32 (\r
- IN OUT UINT8 *Buf,\r
- IN UINT32 Data\r
- )\r
-{\r
- ASSERT (Buf != NULL);\r
-\r
- Data = HTONL (Data);\r
- CopyMem (Buf, &Data, sizeof (UINT32));\r
-}\r
-\r
-\r
-/**\r
- Remove the first node entry on the list, and return the removed node entry.\r
-\r
- Removes the first node Entry from a doubly linked list. It is up to the caller of\r
- this function to release the memory used by the first node if that is required. On\r
- exit, the removed node is returned.\r
-\r
- If Head is NULL, then ASSERT().\r
- If Head was not initialized, then ASSERT().\r
- If PcdMaximumLinkedListLength is not zero, and the number of nodes in the\r
- linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,\r
- then ASSERT().\r
-\r
- @param[in, out] Head The list header.\r
-\r
- @return The first node entry that is removed from the list, NULL if the list is empty.\r
-\r
-**/\r
-LIST_ENTRY *\r
-EFIAPI\r
-NetListRemoveHead (\r
- IN OUT LIST_ENTRY *Head\r
- )\r
-{\r
- LIST_ENTRY *First;\r
-\r
- ASSERT (Head != NULL);\r
-\r
- if (IsListEmpty (Head)) {\r
- return NULL;\r
- }\r
-\r
- First = Head->ForwardLink;\r
- Head->ForwardLink = First->ForwardLink;\r
- First->ForwardLink->BackLink = Head;\r
-\r
- DEBUG_CODE (\r
- First->ForwardLink = (LIST_ENTRY *) NULL;\r
- First->BackLink = (LIST_ENTRY *) NULL;\r
- );\r
-\r
- return First;\r
-}\r
-\r
-\r
-/**\r
- Remove the last node entry on the list and and return the removed node entry.\r
-\r
- Removes the last node entry from a doubly linked list. It is up to the caller of\r
- this function to release the memory used by the first node if that is required. On\r
- exit, the removed node is returned.\r
-\r
- If Head is NULL, then ASSERT().\r
- If Head was not initialized, then ASSERT().\r
- If PcdMaximumLinkedListLength is not zero, and the number of nodes in the\r
- linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,\r
- then ASSERT().\r
-\r
- @param[in, out] Head The list head.\r
-\r
- @return The last node entry that is removed from the list, NULL if the list is empty.\r
-\r
-**/\r
-LIST_ENTRY *\r
-EFIAPI\r
-NetListRemoveTail (\r
- IN OUT LIST_ENTRY *Head\r
- )\r
-{\r
- LIST_ENTRY *Last;\r
-\r
- ASSERT (Head != NULL);\r
-\r
- if (IsListEmpty (Head)) {\r
- return NULL;\r
- }\r
-\r
- Last = Head->BackLink;\r
- Head->BackLink = Last->BackLink;\r
- Last->BackLink->ForwardLink = Head;\r
-\r
- DEBUG_CODE (\r
- Last->ForwardLink = (LIST_ENTRY *) NULL;\r
- Last->BackLink = (LIST_ENTRY *) NULL;\r
- );\r
-\r
- return Last;\r
-}\r
-\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
- @param[in, out] PrevEntry The previous entry to insert after.\r
- @param[in, out] NewEntry The new entry to insert.\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-NetListInsertAfter (\r
- IN OUT LIST_ENTRY *PrevEntry,\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
- PrevEntry->ForwardLink = NewEntry;\r
-}\r
-\r
-\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
- @param[in, out] PostEntry The entry to insert before.\r
- @param[in, out] NewEntry The new entry to insert.\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-NetListInsertBefore (\r
- IN OUT LIST_ENTRY *PostEntry,\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
- Initialize the forward and backward links of two head nodes donated by Map->Used\r
- and Map->Recycled of two doubly linked lists.\r
- Initializes the count of the <Key, Value> pairs in the netmap to zero.\r
-\r
- If Map is NULL, then ASSERT().\r
- If the address of Map->Used is NULL, then ASSERT().\r
- If the address of Map->Recycled is NULl, then ASSERT().\r
-\r
- @param[in, out] Map The netmap to initialize.\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-NetMapInit (\r
- IN OUT NET_MAP *Map\r
- )\r
-{\r
- ASSERT (Map != NULL);\r
-\r
- InitializeListHead (&Map->Used);\r
- InitializeListHead (&Map->Recycled);\r
- Map->Count = 0;\r
-}\r
-\r
-\r
-/**\r
- To clean up the netmap, that is, release allocated memories.\r
-\r
- Removes all nodes of the Used doubly linked list and free memory of all related netmap items.\r
- Removes all nodes of the Recycled doubly linked list and free memory of all related netmap items.\r
- The number of the <Key, Value> pairs in the netmap is set to be zero.\r
-\r
- If Map is NULL, then ASSERT().\r
-\r
- @param[in, out] Map The netmap to clean up.\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-NetMapClean (\r
- IN OUT NET_MAP *Map\r
- )\r
-{\r
- NET_MAP_ITEM *Item;\r
- LIST_ENTRY *Entry;\r
- LIST_ENTRY *Next;\r
-\r
- ASSERT (Map != NULL);\r
-\r
- NET_LIST_FOR_EACH_SAFE (Entry, Next, &Map->Used) {\r
- Item = NET_LIST_USER_STRUCT (Entry, NET_MAP_ITEM, Link);\r
-\r
- RemoveEntryList (&Item->Link);\r
- Map->Count--;\r
-\r
- gBS->FreePool (Item);\r
- }\r
-\r
- ASSERT ((Map->Count == 0) && IsListEmpty (&Map->Used));\r
-\r
- NET_LIST_FOR_EACH_SAFE (Entry, Next, &Map->Recycled) {\r
- Item = NET_LIST_USER_STRUCT (Entry, NET_MAP_ITEM, Link);\r
-\r
- RemoveEntryList (&Item->Link);\r
- gBS->FreePool (Item);\r
- }\r
-\r
- ASSERT (IsListEmpty (&Map->Recycled));\r
-}\r
-\r
-\r
-/**\r
- Test whether the netmap is empty and return true if it is.\r
-\r
- If the number of the <Key, Value> pairs in the netmap is zero, return TRUE.\r
-\r
- If Map is NULL, then ASSERT().\r
-\r
- @param[in] Map The net map to test.\r
-\r
- @return TRUE if the netmap is empty, otherwise FALSE.\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-NetMapIsEmpty (\r
- IN NET_MAP *Map\r
- )\r
-{\r
- ASSERT (Map != NULL);\r
- return (BOOLEAN) (Map->Count == 0);\r
-}\r
-\r
-\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
-\r
-**/\r
-UINTN\r
-EFIAPI\r
-NetMapGetCount (\r
- IN NET_MAP *Map\r
- )\r
-{\r
- ASSERT (Map != NULL);\r
- return Map->Count;\r
-}\r
-\r
-\r
-/**\r
- Return one allocated item.\r
-\r
- If the Recycled doubly linked list of the netmap is empty, it will try to allocate\r
- a batch of items if there are enough resources and add corresponding nodes to the begining\r
- of the Recycled doubly linked list of the netmap. Otherwise, it will directly remove\r
- the fist node entry of the Recycled doubly linked list and return the corresponding item.\r
-\r
- If Map is NULL, then ASSERT().\r
-\r
- @param[in, out] Map The netmap to allocate item for.\r
-\r
- @return The allocated item. If NULL, the\r
- allocation failed due to resource limit.\r
-\r
-**/\r
-NET_MAP_ITEM *\r
-NetMapAllocItem (\r
- IN OUT NET_MAP *Map\r
- )\r
-{\r
- NET_MAP_ITEM *Item;\r
- LIST_ENTRY *Head;\r
- UINTN Index;\r
-\r
- ASSERT (Map != NULL);\r
-\r
- Head = &Map->Recycled;\r
-\r
- if (IsListEmpty (Head)) {\r
- for (Index = 0; Index < NET_MAP_INCREAMENT; Index++) {\r
- Item = AllocatePool (sizeof (NET_MAP_ITEM));\r
-\r
- if (Item == NULL) {\r
- if (Index == 0) {\r
- return NULL;\r
- }\r
-\r
- break;\r
- }\r
-\r
- InsertHeadList (Head, &Item->Link);\r
- }\r
- }\r
-\r
- Item = NET_LIST_HEAD (Head, NET_MAP_ITEM, Link);\r
- NetListRemoveHead (Head);\r
-\r
- return Item;\r
-}\r
-\r
-\r
-/**\r
- Allocate an item to save the <Key, Value> pair to the head of the netmap.\r
-\r
- Allocate an item to save the <Key, Value> pair and add corresponding node entry\r
- to the beginning of the Used doubly linked list. The number of the <Key, Value>\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
- @param[in] Value The user's value for the key.\r
-\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.\r
- @retval EFI_SUCCESS The item is inserted to the head.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-NetMapInsertHead (\r
- IN OUT NET_MAP *Map,\r
- IN VOID *Key,\r
- IN VOID *Value OPTIONAL\r
- )\r
-{\r
- NET_MAP_ITEM *Item;\r
-\r
- ASSERT (Map != NULL && Key != NULL);\r
-\r
- Item = NetMapAllocItem (Map);\r
-\r
- if (Item == NULL) {\r
- return EFI_OUT_OF_RESOURCES;\r
- }\r
-\r
- Item->Key = Key;\r
- Item->Value = Value;\r
- InsertHeadList (&Map->Used, &Item->Link);\r
-\r
- Map->Count++;\r
- return EFI_SUCCESS;\r
-}\r
-\r
-\r
-/**\r
- Allocate an item to save the <Key, Value> pair to the tail of the netmap.\r
-\r
- Allocate an item to save the <Key, Value> pair and add corresponding node entry\r
- to the tail of the Used doubly linked list. The number of the <Key, Value>\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
- @param[in] Value The user's value for the key.\r
-\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.\r
- @retval EFI_SUCCESS The item is inserted to the tail.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-NetMapInsertTail (\r
- IN OUT NET_MAP *Map,\r
- IN VOID *Key,\r
- IN VOID *Value OPTIONAL\r
- )\r
-{\r
- NET_MAP_ITEM *Item;\r
-\r
- ASSERT (Map != NULL && Key != NULL);\r
-\r
- Item = NetMapAllocItem (Map);\r
-\r
- if (Item == NULL) {\r
- return EFI_OUT_OF_RESOURCES;\r
- }\r
-\r
- Item->Key = Key;\r
- Item->Value = Value;\r
- InsertTailList (&Map->Used, &Item->Link);\r
-\r
- Map->Count++;\r
-\r
- return EFI_SUCCESS;\r
-}\r
-\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
- @return TRUE if the item is in the netmap, otherwise FALSE.\r
-\r
-**/\r
-BOOLEAN\r
-NetItemInMap (\r
- IN NET_MAP *Map,\r
- IN NET_MAP_ITEM *Item\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
- }\r
- }\r
-\r
- return FALSE;\r
-}\r
-\r
-\r
-/**\r
- Find the key in the netmap and returns the point to the item contains the Key.\r
-\r
- Iterate the Used doubly linked list of the netmap to get every item. Compare the key of every\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
-\r
- @return The point to the item contains the Key, or NULL if Key isn't in the map.\r
-\r
-**/\r
-NET_MAP_ITEM *\r
-EFIAPI\r
-NetMapFindKey (\r
- IN NET_MAP *Map,\r
- IN VOID *Key\r
- )\r
-{\r
- LIST_ENTRY *Entry;\r
- NET_MAP_ITEM *Item;\r
-\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
- if (Item->Key == Key) {\r
- return Item;\r
- }\r
- }\r
-\r
- return NULL;\r
-}\r
-\r
-\r
-/**\r
- Remove the node entry of the item from the netmap and return the key of the removed item.\r
-\r
- Remove the node entry of the item from the Used doubly linked list of the netmap.\r
- The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node\r
- entry of the item to the Recycled doubly linked list of the netmap. If Value is not NULL,\r
- Value will point to the value of the item. It returns the key of the removed item.\r
-\r
- If Map is NULL, then ASSERT().\r
- If Item is NULL, then ASSERT().\r
- if item in not in the netmap, then ASSERT().\r
-\r
- @param[in, out] Map The netmap to remove the item from.\r
- @param[in, out] Item The item to remove.\r
- @param[out] Value The variable to receive the value if not NULL.\r
-\r
- @return The key of the removed item.\r
-\r
-**/\r
-VOID *\r
-EFIAPI\r
-NetMapRemoveItem (\r
- IN OUT NET_MAP *Map,\r
- IN OUT NET_MAP_ITEM *Item,\r
- OUT VOID **Value OPTIONAL\r
- )\r
-{\r
- ASSERT ((Map != NULL) && (Item != NULL));\r
- ASSERT (NetItemInMap (Map, Item));\r
-\r
- RemoveEntryList (&Item->Link);\r
- Map->Count--;\r
- InsertHeadList (&Map->Recycled, &Item->Link);\r
-\r
- if (Value != NULL) {\r
- *Value = Item->Value;\r
- }\r
-\r
- return Item->Key;\r
-}\r
-\r
-\r
-/**\r
- Remove the first node entry on the netmap and return the key of the removed item.\r
-\r
- Remove the first node entry from the Used doubly linked list of the netmap.\r
- The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node\r
- entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,\r
- parameter Value will point to the value of the item. It returns the key of the removed item.\r
-\r
- If Map is NULL, then ASSERT().\r
- If the Used doubly linked list is empty, then ASSERT().\r
-\r
- @param[in, out] Map The netmap to remove the head from.\r
- @param[out] Value The variable to receive the value if not NULL.\r
-\r
- @return The key of the item removed.\r
-\r
-**/\r
-VOID *\r
-EFIAPI\r
-NetMapRemoveHead (\r
- IN OUT NET_MAP *Map,\r
- OUT VOID **Value OPTIONAL\r
- )\r
-{\r
- NET_MAP_ITEM *Item;\r
-\r
- //\r
- // Often, it indicates a programming error to remove\r
- // the first entry in an empty list\r
- //\r
- ASSERT (Map && !IsListEmpty (&Map->Used));\r
-\r
- Item = NET_LIST_HEAD (&Map->Used, NET_MAP_ITEM, Link);\r
- RemoveEntryList (&Item->Link);\r
- Map->Count--;\r
- InsertHeadList (&Map->Recycled, &Item->Link);\r
-\r
- if (Value != NULL) {\r
- *Value = Item->Value;\r
- }\r
-\r
- return Item->Key;\r
-}\r
-\r
-\r
-/**\r
- Remove the last node entry on the netmap and return the key of the removed item.\r
-\r
- Remove the last node entry from the Used doubly linked list of the netmap.\r
- The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node\r
- entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,\r
- parameter Value will point to the value of the item. It returns the key of the removed item.\r
-\r
- If Map is NULL, then ASSERT().\r
- If the Used doubly linked list is empty, then ASSERT().\r
-\r
- @param[in, out] Map The netmap to remove the tail from.\r
- @param[out] Value The variable to receive the value if not NULL.\r
-\r
- @return The key of the item removed.\r
-\r
-**/\r
-VOID *\r
-EFIAPI\r
-NetMapRemoveTail (\r
- IN OUT NET_MAP *Map,\r
- OUT VOID **Value OPTIONAL\r
- )\r
-{\r
- NET_MAP_ITEM *Item;\r
-\r
- //\r
- // Often, it indicates a programming error to remove\r
- // the last entry in an empty list\r
- //\r
- ASSERT (Map && !IsListEmpty (&Map->Used));\r
-\r
- Item = NET_LIST_TAIL (&Map->Used, NET_MAP_ITEM, Link);\r
- RemoveEntryList (&Item->Link);\r
- Map->Count--;\r
- InsertHeadList (&Map->Recycled, &Item->Link);\r
-\r
- if (Value != NULL) {\r
- *Value = Item->Value;\r
- }\r
-\r
- return Item->Key;\r
-}\r
-\r
-\r
-/**\r
- Iterate through the netmap and call CallBack for each item.\r
-\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
- If Map is NULL, then ASSERT().\r
- If CallBack is NULL, then ASSERT().\r
-\r
- @param[in] Map The Map to iterate through.\r
- @param[in] CallBack The callback function to call for each item.\r
- @param[in] Arg The opaque parameter to the callback.\r
-\r
- @retval EFI_SUCCESS There is no item in the netmap or CallBack for each item\r
- return EFI_SUCCESS.\r
- @retval Others It returns the CallBack's last return value.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-NetMapIterate (\r
- IN NET_MAP *Map,\r
- IN NET_MAP_CALLBACK CallBack,\r
- IN VOID *Arg OPTIONAL\r
- )\r
-{\r
-\r
- LIST_ENTRY *Entry;\r
- LIST_ENTRY *Next;\r
- LIST_ENTRY *Head;\r
- NET_MAP_ITEM *Item;\r
- EFI_STATUS Result;\r
-\r
- ASSERT ((Map != NULL) && (CallBack != NULL));\r
-\r
- Head = &Map->Used;\r
-\r
- if (IsListEmpty (Head)) {\r
- return EFI_SUCCESS;\r
- }\r
-\r
- NET_LIST_FOR_EACH_SAFE (Entry, Next, Head) {\r
- Item = NET_LIST_USER_STRUCT (Entry, NET_MAP_ITEM, Link);\r
- Result = CallBack (Map, Item, Arg);\r
-\r
- if (EFI_ERROR (Result)) {\r
- return Result;\r
- }\r
- }\r
-\r
- return EFI_SUCCESS;\r
-}\r
-\r
-\r
-/**\r
- This is the default unload handle for all the network drivers.\r
-\r
- Disconnect the driver specified by ImageHandle from all the devices in the handle database.\r
- Uninstall all the protocols installed in the driver entry point.\r
-\r
- @param[in] ImageHandle The drivers' driver image.\r
-\r
- @retval EFI_SUCCESS The image is unloaded.\r
- @retval Others Failed to unload the image.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-NetLibDefaultUnload (\r
- IN EFI_HANDLE ImageHandle\r
- )\r
-{\r
- EFI_STATUS Status;\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
-\r
- //\r
- // Get the list of all the handles in the handle database.\r
- // If there is an error getting the list, then the unload\r
- // operation fails.\r
- //\r
- Status = gBS->LocateHandleBuffer (\r
- AllHandles,\r
- NULL,\r
- NULL,\r
- &DeviceHandleCount,\r
- &DeviceHandleBuffer\r
- );\r
-\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- for (Index = 0; Index < DeviceHandleCount; Index++) {\r
- Status = gBS->HandleProtocol (\r
- DeviceHandleBuffer[Index],\r
- &gEfiDriverBindingProtocolGuid,\r
- (VOID **) &DriverBinding\r
- );\r
- if (EFI_ERROR (Status)) {\r
- continue;\r
- }\r
-\r
- if (DriverBinding->ImageHandle != ImageHandle) {\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
- DriverBinding->DriverBindingHandle,\r
- &gEfiDriverBindingProtocolGuid,\r
- DriverBinding\r
- );\r
-\r
- Status = gBS->HandleProtocol (\r
- DeviceHandleBuffer[Index],\r
- &gEfiComponentNameProtocolGuid,\r
- (VOID **) &ComponentName\r
- );\r
- if (!EFI_ERROR (Status)) {\r
- gBS->UninstallProtocolInterface (\r
- DriverBinding->DriverBindingHandle,\r
- &gEfiComponentNameProtocolGuid,\r
- ComponentName\r
- );\r
- }\r
-\r
- Status = gBS->HandleProtocol (\r
- DeviceHandleBuffer[Index],\r
- &gEfiComponentName2ProtocolGuid,\r
- (VOID **) &ComponentName2\r
- );\r
- if (!EFI_ERROR (Status)) {\r
- gBS->UninstallProtocolInterface (\r
- DriverBinding->DriverBindingHandle,\r
- &gEfiComponentName2ProtocolGuid,\r
- ComponentName2\r
- );\r
- }\r
- }\r
-\r
- //\r
- // Free the buffer containing the list of handles from the handle database\r
- //\r
- if (DeviceHandleBuffer != NULL) {\r
- gBS->FreePool (DeviceHandleBuffer);\r
- }\r
-\r
- return EFI_SUCCESS;\r
-}\r
-\r
-\r
-\r
-/**\r
- Create a child of the service that is identified by ServiceBindingGuid.\r
-\r
- Get the ServiceBinding Protocol first, then use it to create a child.\r
-\r
- If ServiceBindingGuid is NULL, then ASSERT().\r
- If ChildHandle is NULL, then ASSERT().\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, out] ChildHandle The handle to receive the create child.\r
-\r
- @retval EFI_SUCCESS The child is successfully created.\r
- @retval Others Failed to create the child.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-NetLibCreateServiceChild (\r
- IN EFI_HANDLE Controller,\r
- IN EFI_HANDLE Image,\r
- IN EFI_GUID *ServiceBindingGuid,\r
- IN OUT EFI_HANDLE *ChildHandle\r
- )\r
-{\r
- EFI_STATUS Status;\r
- EFI_SERVICE_BINDING_PROTOCOL *Service;\r
-\r
-\r
- ASSERT ((ServiceBindingGuid != NULL) && (ChildHandle != NULL));\r
-\r
- //\r
- // Get the ServiceBinding Protocol\r
- //\r
- Status = gBS->OpenProtocol (\r
- Controller,\r
- ServiceBindingGuid,\r
- (VOID **) &Service,\r
- Image,\r
- Controller,\r
- EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
- );\r
-\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- //\r
- // Create a child\r
- //\r
- Status = Service->CreateChild (Service, ChildHandle);\r
- return Status;\r
-}\r
-\r
-\r
-/**\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
- If ServiceBindingGuid is NULL, then ASSERT().\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 destroy.\r
-\r
- @retval EFI_SUCCESS The child is successfully destroyed.\r
- @retval Others Failed to destroy the child.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-NetLibDestroyServiceChild (\r
- IN EFI_HANDLE Controller,\r
- IN EFI_HANDLE Image,\r
- IN EFI_GUID *ServiceBindingGuid,\r
- IN EFI_HANDLE ChildHandle\r
- )\r
-{\r
- EFI_STATUS Status;\r
- EFI_SERVICE_BINDING_PROTOCOL *Service;\r
-\r
- ASSERT (ServiceBindingGuid != NULL);\r
-\r
- //\r
- // Get the ServiceBinding Protocol\r
- //\r
- Status = gBS->OpenProtocol (\r
- Controller,\r
- ServiceBindingGuid,\r
- (VOID **) &Service,\r
- Image,\r
- Controller,\r
- EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
- );\r
-\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- //\r
- // destroy the child\r
- //\r
- Status = Service->DestroyChild (Service, ChildHandle);\r
- return Status;\r
-}\r
-\r
-/**\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] 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
- @return The SNP handle, or NULL if not found.\r
-\r
-**/\r
-EFI_HANDLE\r
-EFIAPI\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 *SnpInstance;\r
- EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
- EFI_HANDLE SnpHandle;\r
-\r
- //\r
- // Try to open SNP from ServiceHandle\r
- //\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
- //\r
- // Failed to open SNP, try to get SNP handle by LocateDevicePath()\r
- //\r
- DevicePath = DevicePathFromHandle (ServiceHandle);\r
- if (DevicePath == NULL) {\r
- return NULL;\r
- }\r
-\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
- 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 NULL;\r
-}\r
-\r
-/**\r
- Retrieve VLAN ID of a VLAN device handle.\r
-\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] ServiceHandle The handle where network service binding protocols are\r
- installed on.\r
-\r
- @return VLAN ID of the device handle, or 0 if not a VLAN device.\r
-\r
-**/\r
-UINT16\r
-EFIAPI\r
-NetLibGetVlanId (\r
- IN EFI_HANDLE ServiceHandle\r
- )\r
-{\r
- EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
- EFI_DEVICE_PATH_PROTOCOL *Node;\r
-\r
- DevicePath = DevicePathFromHandle (ServiceHandle);\r
- if (DevicePath == NULL) {\r
- return 0;\r
- }\r
-\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
- return 0;\r
-}\r
-\r
-/**\r
- Find VLAN device handle with specified VLAN ID.\r
-\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
- @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
- @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
-\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
-\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
- FreePool (VlanDevicePath);\r
- return Handle;\r
-}\r
-\r
-/**\r
- Get MAC address associated with the network service handle.\r
-\r
- If MacAddress is NULL, then ASSERT().\r
- If AddressSize is NULL, then ASSERT().\r
-\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
-EFI_STATUS\r
-EFIAPI\r
-NetLibGetMacAddress (\r
- IN EFI_HANDLE ServiceHandle,\r
- OUT EFI_MAC_ADDRESS *MacAddress,\r
- OUT UINTN *AddressSize\r
- )\r
-{\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
- ASSERT (MacAddress != NULL);\r
- ASSERT (AddressSize != NULL);\r
-\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
-\r
- @param[in, out] Node Pointer to the IPv6 device path node.\r
- @param[in] Controller The controller handle.\r
- @param[in] LocalIp The local IPv6 address.\r
- @param[in] LocalPort The local port.\r
- @param[in] RemoteIp The remote IPv6 address.\r
- @param[in] RemotePort The remote port.\r
- @param[in] Protocol The protocol type in the IP header.\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-NetLibCreateIPv6DPathNode (\r
- IN OUT IPv6_DEVICE_PATH *Node,\r
- IN EFI_HANDLE Controller,\r
- IN EFI_IPv6_ADDRESS *LocalIp,\r
- IN UINT16 LocalPort,\r
- IN EFI_IPv6_ADDRESS *RemoteIp,\r
- IN UINT16 RemotePort,\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
-\r
- CopyMem (&Node->LocalIpAddress, LocalIp, sizeof (EFI_IPv6_ADDRESS));\r
- CopyMem (&Node->RemoteIpAddress, RemoteIp, sizeof (EFI_IPv6_ADDRESS));\r
-\r
- Node->LocalPort = LocalPort;\r
- Node->RemotePort = RemotePort;\r
-\r
- Node->Protocol = Protocol;\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
- service binding instance that is install on UNDI/SNP handle.\r
- Now, the controller is either a MNP or ARP child handle. But\r
- IP opens these handle BY_DRIVER, use that info, we can get the\r
- UNDI/SNP handle.\r
-\r
- @param[in] Controller Then protocol handle to check.\r
- @param[in] ProtocolGuid The protocol that is related with the handle.\r
-\r
- @return The UNDI/SNP handle or NULL for errors.\r
-\r
-**/\r
-EFI_HANDLE\r
-EFIAPI\r
-NetLibGetNicHandle (\r
- IN EFI_HANDLE Controller,\r
- IN EFI_GUID *ProtocolGuid\r
- )\r
-{\r
- EFI_OPEN_PROTOCOL_INFORMATION_ENTRY *OpenBuffer;\r
- EFI_HANDLE Handle;\r
- EFI_STATUS Status;\r
- UINTN OpenCount;\r
- UINTN Index;\r
-\r
- ASSERT (ProtocolGuid != NULL);\r
-\r
- Status = gBS->OpenProtocolInformation (\r
- Controller,\r
- ProtocolGuid,\r
- &OpenBuffer,\r
- &OpenCount\r
- );\r
-\r
- if (EFI_ERROR (Status)) {\r
- return NULL;\r
- }\r
-\r
- Handle = NULL;\r
-\r
- for (Index = 0; Index < OpenCount; Index++) {\r
- if ((OpenBuffer[Index].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) {\r
- Handle = OpenBuffer[Index].ControllerHandle;\r
- break;\r
- }\r
- }\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