#include <Uefi.h>
#include <IndustryStandard/SmBios.h>
#include <Protocol/DriverBinding.h>
#include <Protocol/ServiceBinding.h>
#include <Protocol/SimpleNetwork.h>
#include <Protocol/AdapterInformation.h>
#include <Protocol/ManagedNetwork.h>
#include <Protocol/Ip4Config2.h>
#include <Protocol/ComponentName.h>
#include <Protocol/ComponentName2.h>
#include <Guid/SmBios.h>
#include <Library/NetLib.h>
#include <Library/BaseLib.h>
#include <Library/DebugLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/DevicePathLib.h>
#include <Library/PrintLib.h>
#include <Library/UefiLib.h>
#include <Protocol/Rng.h>

Macros
#define	NIC_ITEM_CONFIG_SIZE (sizeof (NIC_IP4_CONFIG_INFO) + sizeof (EFI_IP4_ROUTE_TABLE) * MAX_IP4_CONFIG_IN_VARIABLE)

#define	DEFAULT_ZERO_START ((UINTN) ~0)

#define	SECURE_HASH_ALGORITHMS_SIZE (sizeof (mSecureHashAlgorithms) / sizeof (EFI_GUID *))

Functions
EFI_SIMPLE_NETWORK_PROTOCOL *	SyslogLocateSnp (VOID)

EFI_STATUS	SyslogSendPacket (IN CHAR8 *Packet, IN UINT32 Length)

UINT32	SyslogBuildPacket (IN UINT32 Level, IN UINT8 Module, IN UINT8 File, IN UINT32 Line, IN UINT8 Message, IN UINT32 BufLen, OUT CHAR8 Buf)

CHAR8 *EFIAPI	NetDebugASPrint (IN CHAR8 *Format,...)

EFI_STATUS EFIAPI	NetDebugOutput (IN UINT32 Level, IN UINT8 Module, IN UINT8 File, IN UINT32 Line, IN UINT8 *Message)

INTN EFIAPI	NetGetMaskLength (IN IP4_ADDR NetMask)

INTN EFIAPI	NetGetIpClass (IN IP4_ADDR Addr)

BOOLEAN EFIAPI	NetIp4IsUnicast (IN IP4_ADDR Ip, IN IP4_ADDR NetMask)

BOOLEAN EFIAPI	NetIp6IsValidUnicast (IN EFI_IPv6_ADDRESS *Ip6)

BOOLEAN EFIAPI	NetIp6IsUnspecifiedAddr (IN EFI_IPv6_ADDRESS *Ip6)

BOOLEAN EFIAPI	NetIp6IsLinkLocalAddr (IN EFI_IPv6_ADDRESS *Ip6)

BOOLEAN EFIAPI	NetIp6IsNetEqual (EFI_IPv6_ADDRESS Ip1, EFI_IPv6_ADDRESS Ip2, UINT8 PrefixLength)

EFI_IPv6_ADDRESS *EFIAPI	Ip6Swap128 (EFI_IPv6_ADDRESS *Ip6)

EFI_STATUS EFIAPI	PseudoRandom (OUT VOID *Output, IN UINTN OutputLength)

EFI_STATUS EFIAPI	PseudoRandomU32 (OUT UINT32 *Output)

UINT32 EFIAPI	NetGetUint32 (IN UINT8 *Buf)

VOID EFIAPI	NetPutUint32 (IN OUT UINT8 *Buf, IN UINT32 Data)

LIST_ENTRY *EFIAPI	NetListRemoveHead (IN OUT LIST_ENTRY *Head)

LIST_ENTRY *EFIAPI	NetListRemoveTail (IN OUT LIST_ENTRY *Head)

VOID EFIAPI	NetListInsertAfter (IN OUT LIST_ENTRY PrevEntry, IN OUT LIST_ENTRY NewEntry)

VOID EFIAPI	NetListInsertBefore (IN OUT LIST_ENTRY PostEntry, IN OUT LIST_ENTRY NewEntry)

EFI_STATUS EFIAPI	NetDestroyLinkList (IN LIST_ENTRY List, IN NET_DESTROY_LINK_LIST_CALLBACK CallBack, IN VOID Context OPTIONAL, OUT UINTN *ListLength OPTIONAL)

BOOLEAN EFIAPI	NetIsInHandleBuffer (IN EFI_HANDLE Handle, IN UINTN NumberOfChildren, IN EFI_HANDLE *ChildHandleBuffer OPTIONAL)

VOID EFIAPI	NetMapInit (IN OUT NET_MAP *Map)

VOID EFIAPI	NetMapClean (IN OUT NET_MAP *Map)

BOOLEAN EFIAPI	NetMapIsEmpty (IN NET_MAP *Map)

UINTN EFIAPI	NetMapGetCount (IN NET_MAP *Map)

NET_MAP_ITEM *	NetMapAllocItem (IN OUT NET_MAP *Map)

EFI_STATUS EFIAPI	NetMapInsertHead (IN OUT NET_MAP Map, IN VOID Key, IN VOID *Value OPTIONAL)

EFI_STATUS EFIAPI	NetMapInsertTail (IN OUT NET_MAP Map, IN VOID Key, IN VOID *Value OPTIONAL)

BOOLEAN	NetItemInMap (IN NET_MAP Map, IN NET_MAP_ITEM Item)

NET_MAP_ITEM *EFIAPI	NetMapFindKey (IN NET_MAP Map, IN VOID Key)

VOID *EFIAPI	NetMapRemoveItem (IN OUT NET_MAP Map, IN OUT NET_MAP_ITEM Item, OUT VOID **Value OPTIONAL)

VOID *EFIAPI	NetMapRemoveHead (IN OUT NET_MAP Map, OUT VOID *Value OPTIONAL)

VOID *EFIAPI	NetMapRemoveTail (IN OUT NET_MAP Map, OUT VOID *Value OPTIONAL)

EFI_STATUS EFIAPI	NetMapIterate (IN NET_MAP Map, IN NET_MAP_CALLBACK CallBack, IN VOID Arg OPTIONAL)

EFI_STATUS EFIAPI	NetLibDefaultUnload (IN EFI_HANDLE ImageHandle)

EFI_STATUS EFIAPI	NetLibCreateServiceChild (IN EFI_HANDLE Controller, IN EFI_HANDLE Image, IN EFI_GUID ServiceBindingGuid, IN OUT EFI_HANDLE ChildHandle)

EFI_STATUS EFIAPI	NetLibDestroyServiceChild (IN EFI_HANDLE Controller, IN EFI_HANDLE Image, IN EFI_GUID *ServiceBindingGuid, IN EFI_HANDLE ChildHandle)

EFI_HANDLE EFIAPI	NetLibGetSnpHandle (IN EFI_HANDLE ServiceHandle, OUT EFI_SIMPLE_NETWORK_PROTOCOL **Snp OPTIONAL)

UINT16 EFIAPI	NetLibGetVlanId (IN EFI_HANDLE ServiceHandle)

EFI_HANDLE EFIAPI	NetLibGetVlanHandle (IN EFI_HANDLE ControllerHandle, IN UINT16 VlanId)

EFI_STATUS EFIAPI	NetLibGetMacAddress (IN EFI_HANDLE ServiceHandle, OUT EFI_MAC_ADDRESS MacAddress, OUT UINTN AddressSize)

EFI_STATUS EFIAPI	NetLibGetMacString (IN EFI_HANDLE ServiceHandle, IN EFI_HANDLE ImageHandle OPTIONAL, OUT CHAR16 **MacString)

EFI_STATUS EFIAPI	NetLibDetectMedia (IN EFI_HANDLE ServiceHandle, OUT BOOLEAN *MediaPresent)

EFI_STATUS EFIAPI	NetLibDetectMediaWaitTimeout (IN EFI_HANDLE ServiceHandle, IN UINT64 Timeout, OUT EFI_STATUS *MediaState)

BOOLEAN	NetLibDefaultAddressIsStatic (IN EFI_HANDLE Controller)

VOID EFIAPI	NetLibCreateIPv4DPathNode (IN OUT IPv4_DEVICE_PATH *Node, IN EFI_HANDLE Controller, IN IP4_ADDR LocalIp, IN UINT16 LocalPort, IN IP4_ADDR RemoteIp, IN UINT16 RemotePort, IN UINT16 Protocol, IN BOOLEAN UseDefaultAddress)

VOID EFIAPI	NetLibCreateIPv6DPathNode (IN OUT IPv6_DEVICE_PATH Node, IN EFI_HANDLE Controller, IN EFI_IPv6_ADDRESS LocalIp, IN UINT16 LocalPort, IN EFI_IPv6_ADDRESS *RemoteIp, IN UINT16 RemotePort, IN UINT16 Protocol)

EFI_HANDLE EFIAPI	NetLibGetNicHandle (IN EFI_HANDLE Controller, IN EFI_GUID *ProtocolGuid)

EFI_STATUS EFIAPI	NetLibAsciiStrToIp4 (IN CONST CHAR8 String, OUT EFI_IPv4_ADDRESS Ip4Address)

EFI_STATUS EFIAPI	NetLibAsciiStrToIp6 (IN CONST CHAR8 String, OUT EFI_IPv6_ADDRESS Ip6Address)

EFI_STATUS EFIAPI	NetLibStrToIp4 (IN CONST CHAR16 String, OUT EFI_IPv4_ADDRESS Ip4Address)

EFI_STATUS EFIAPI	NetLibStrToIp6 (IN CONST CHAR16 String, OUT EFI_IPv6_ADDRESS Ip6Address)

EFI_STATUS EFIAPI	NetLibStrToIp6andPrefix (IN CONST CHAR16 String, OUT EFI_IPv6_ADDRESS Ip6Address, OUT UINT8 *PrefixLength)

EFI_STATUS EFIAPI	NetLibIp6ToStr (IN EFI_IPv6_ADDRESS Ip6Address, OUT CHAR16 String, IN UINTN StringSize)

EFI_STATUS EFIAPI	NetLibGetSystemGuid (OUT EFI_GUID *SystemGuid)

CHAR8 *EFIAPI	NetLibCreateDnsQName (IN CHAR16 *DomainName)

Variables
GLOBAL_REMOVE_IF_UNREFERENCED IP4_ADDR	gIp4AllMasks [IP4_MASK_NUM]

GLOBAL_REMOVE_IF_UNREFERENCED EFI_IPv4_ADDRESS	mZeroIp4Addr

GLOBAL_REMOVE_IF_UNREFERENCED UINTN	mNetDebugLevelMax = NETDEBUG_LEVEL_ERROR

GLOBAL_REMOVE_IF_UNREFERENCED UINT32	mSyslogPacketSeq = 0xDEADBEEF

GLOBAL_REMOVE_IF_UNREFERENCED UINT8	mSyslogDstMac [NET_ETHER_ADDR_LEN] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff }

GLOBAL_REMOVE_IF_UNREFERENCED UINT32	mSyslogDstIp = 0xffffffff

GLOBAL_REMOVE_IF_UNREFERENCED UINT32	mSyslogSrcIp = 0

GLOBAL_REMOVE_IF_UNREFERENCED CHAR8 *	mMonthName []

GLOBAL_REMOVE_IF_UNREFERENCED VLAN_DEVICE_PATH	mNetVlanDevicePathTemplate

Detailed Description

Network library.

Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
(C) Copyright 2015 Hewlett Packard Enterprise Development LP
Copyright (c) Microsoft Corporation SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file DxeNetLib.c.

Macro Definition Documentation

◆ DEFAULT_ZERO_START

#define DEFAULT_ZERO_START ((UINTN) ~0)

Definition at line 38 of file DxeNetLib.c.

◆ NIC_ITEM_CONFIG_SIZE

#define NIC_ITEM_CONFIG_SIZE (sizeof (NIC_IP4_CONFIG_INFO) + sizeof (EFI_IP4_ROUTE_TABLE) * MAX_IP4_CONFIG_IN_VARIABLE)

Definition at line 37 of file DxeNetLib.c.

◆ SECURE_HASH_ALGORITHMS_SIZE

#define SECURE_HASH_ALGORITHMS_SIZE (sizeof (mSecureHashAlgorithms) / sizeof (EFI_GUID *))

Definition at line 155 of file DxeNetLib.c.

Function Documentation

◆ Ip6Swap128()

EFI_IPv6_ADDRESS *EFIAPI Ip6Swap128 ( EFI_IPv6_ADDRESS * Ip6 )

Switches the endianess of an IPv6 address

ASSERT if Ip6 is NULL.

This function swaps the bytes in a 128-bit IPv6 address to switch the value from little endian to big endian or vice versa. The byte swapped value is returned.

Parameters

Ip6	Points to an IPv6 address

Returns: The byte swapped IPv6 address.

Definition at line 892 of file DxeNetLib.c.

◆ NetDebugASPrint()

CHAR8 *EFIAPI NetDebugASPrint	(	IN CHAR8 *	Format,
			...
	)

Allocate a buffer, then format the message to it. This is a help function for the NET_DEBUG_XXX macros. The PrintArg of these macros treats the variable length print parameters as a single parameter, and pass it to the NetDebugASPrint. For example, NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name)) if extracted to:

   NetDebugOutput (
     NETDEBUG_LEVEL_TRACE,
     "Tcp",
     __FILE__,
     DEBUG_LINE_NUMBER,
     NetDebugASPrint ("State transit to %a\n", Name)
   )

If Format is NULL, then ASSERT().

Parameters

Format	The ASCII format string.
...	The variable length parameter whose format is determined by the Format string.

Returns: The buffer containing the formatted message, or NULL if failed to allocate memory.

Definition at line 481 of file DxeNetLib.c.

◆ NetDebugOutput()

EFI_STATUS EFIAPI NetDebugOutput	(	IN UINT32	Level,
		IN UINT8 *	Module,
		IN UINT8 *	File,
		IN UINT32	Line,
		IN UINT8 *	Message
	)

Builds an UDP4 syslog packet and send it using SNP.

This function will locate a instance of SNP then send the message through it. Because it isn't open the SNP BY_DRIVER, apply caution when using it.

Parameters

Level	The severity level of the message.
Module	The Module that generates the log.
File	The file that contains the log.
Line	The exact line that contains the log.
Message	The user message to log.

Return values

EFI_INVALID_PARAMETER	Any input parameter is invalid.
EFI_OUT_OF_RESOURCES	Failed to allocate memory for the packet.
EFI_DEVICE_ERROR	Device error occurs.
EFI_SUCCESS	The log is discard because that it is more verbose than the mNetDebugLevelMax. Or, it has been sent out.

Definition at line 524 of file DxeNetLib.c.

◆ NetDestroyLinkList()

EFI_STATUS EFIAPI NetDestroyLinkList	(	IN LIST_ENTRY *	List,
		IN NET_DESTROY_LINK_LIST_CALLBACK	CallBack,
		IN VOID *Context	OPTIONAL,
		OUT UINTN *ListLength	OPTIONAL
	)

Safe destroy nodes in a linked list, and return the length of the list after all possible operations finished.

Destroy network child instance list by list traversals is not safe due to graph dependencies between nodes. This function performs a safe traversal to destroy these nodes by checking to see if the node being destroyed has been removed from the list or not. If it has been removed, then restart the traversal from the head. If it hasn't been removed, then continue with the next node directly. This function will end the iterate and return the CallBack's last return value if error happens, or return EFI_SUCCESS if 2 complete passes are made with no changes in the number of children in the list.

Parameters

[in]	List	The head of the list.
[in]	CallBack	Pointer to the callback function to destroy one node in the list.
[in]	Context	Pointer to the callback function's context: corresponds to the parameter Context in NET_DESTROY_LINK_LIST_CALLBACK.
[out]	ListLength	The length of the link list if the function returns successfully.

Return values

EFI_SUCCESS	Two complete passes are made with no changes in the number of children.
EFI_INVALID_PARAMETER	The input parameter is invalid.
Others	Return the CallBack's last return value.

Definition at line 1236 of file DxeNetLib.c.

◆ NetGetIpClass()

INTN EFIAPI NetGetIpClass ( IN IP4_ADDR Addr )

Return the class of the IP address, such as class A, B, C. Addr is in host byte order.

[ATTENTION] Classful addressing (IP class A/B/C) has been deprecated according to RFC4632. Caller of this function could only check the returned value against IP4_ADDR_CLASSD (multicast) or IP4_ADDR_CLASSE (reserved) now.

The address of class A starts with 0. If the address belong to class A, return IP4_ADDR_CLASSA. The address of class B starts with 10. If the address belong to class B, return IP4_ADDR_CLASSB. The address of class C starts with 110. If the address belong to class C, return IP4_ADDR_CLASSC. The address of class D starts with 1110. If the address belong to class D, return IP4_ADDR_CLASSD. The address of class E starts with 1111. If the address belong to class E, return IP4_ADDR_CLASSE.

Parameters

[in] Addr The address to get the class from.

Returns: IP address class, such as IP4_ADDR_CLASSA.

Definition at line 643 of file DxeNetLib.c.

◆ NetGetMaskLength()

INTN EFIAPI NetGetMaskLength ( IN IP4_ADDR NetMask )

Return the length of the mask.

Return the length of the mask, the correct value is from 0 to 32. If the mask is invalid, return the invalid length 33, which is IP4_MASK_NUM. NetMask is in the host byte order.

Parameters

[in] NetMask The netmask to get the length from.

Returns: The length of the netmask, IP4_MASK_NUM if the mask is invalid.

Definition at line 600 of file DxeNetLib.c.

◆ NetGetUint32()

UINT32 EFIAPI NetGetUint32 ( IN UINT8 * Buf )

Extract a UINT32 from a byte stream.

ASSERT if Buf is NULL.

Copy a UINT32 from a byte stream, then converts it from Network byte order to host byte order. Use this function to avoid alignment error.

Parameters

[in] Buf The buffer to extract the UINT32.

Returns: The UINT32 extracted.

Definition at line 1033 of file DxeNetLib.c.

◆ NetIp4IsUnicast()

BOOLEAN EFIAPI NetIp4IsUnicast	(	IN IP4_ADDR	Ip,
		IN IP4_ADDR	NetMask
	)

Check whether the IP is a valid unicast address according to the netmask.

ASSERT if NetMask is zero.

If all bits of the host address of IP are 0 or 1, IP is also not a valid unicast address, except when the originator is one of the endpoints of a point-to-point link with a 31-bit mask (RFC3021), or a 32bit NetMask (all 0xFF) is used for special network environment (e.g. PPP link).

Parameters

[in]	Ip	The IP to check against.
[in]	NetMask	The mask of the IP.

Returns: TRUE if IP is a valid unicast address on the network, otherwise FALSE.

Definition at line 683 of file DxeNetLib.c.

◆ NetIp6IsLinkLocalAddr()

BOOLEAN EFIAPI NetIp6IsLinkLocalAddr ( IN EFI_IPv6_ADDRESS * Ip6 )

Check whether the incoming Ipv6 address is a link-local address.

ASSERT if Ip6 is NULL.

Parameters

[in] Ip6 - Ip6 address, in network order.

Return values

TRUE	- Yes, link-local address
FALSE	- No

Definition at line 796 of file DxeNetLib.c.

◆ NetIp6IsNetEqual()

BOOLEAN EFIAPI NetIp6IsNetEqual	(	EFI_IPv6_ADDRESS *	Ip1,
		EFI_IPv6_ADDRESS *	Ip2,
		UINT8	PrefixLength
	)

Check whether the Ipv6 address1 and address2 are on the connected network.

ASSERT if Ip1 or Ip2 is NULL. ASSERT if PrefixLength exceeds or equals to IP6_PREFIX_MAX.

Parameters

[in]	Ip1	- Ip6 address1, in network order.
[in]	Ip2	- Ip6 address2, in network order.
[in]	PrefixLength	- The prefix length of the checking net.

Return values

TRUE	- Yes, connected.
FALSE	- No.

Definition at line 837 of file DxeNetLib.c.

◆ NetIp6IsUnspecifiedAddr()

BOOLEAN EFIAPI NetIp6IsUnspecifiedAddr ( IN EFI_IPv6_ADDRESS * Ip6 )

Check whether the incoming Ipv6 address is the unspecified address or not.

ASSERT if Ip6 is NULL.

Parameters

[in] Ip6 - Ip6 address, in network order.

Return values

TRUE	- Yes, unspecified
FALSE	- No

Definition at line 766 of file DxeNetLib.c.

◆ NetIp6IsValidUnicast()

BOOLEAN EFIAPI NetIp6IsValidUnicast ( IN EFI_IPv6_ADDRESS * Ip6 )

Check whether the incoming IPv6 address is a valid unicast address.

ASSERT if Ip6 is NULL.

If the address is a multicast address has binary 0xFF at the start, it is not a valid unicast address. If the address is unspecified ::, it is not a valid unicast address to be assigned to any node. If the address is loopback address ::1, it is also not a valid unicast address to be assigned to any physical interface.

Parameters

[in] Ip6 The IPv6 address to check against.

Returns: TRUE if Ip6 is a valid unicast address on the network, otherwise FALSE.

Definition at line 725 of file DxeNetLib.c.

◆ NetIsInHandleBuffer()

BOOLEAN EFIAPI NetIsInHandleBuffer	(	IN EFI_HANDLE	Handle,
		IN UINTN	NumberOfChildren,
		IN EFI_HANDLE *ChildHandleBuffer	OPTIONAL
	)

This function checks the input Handle to see if it's one of these handles in ChildHandleBuffer.

Parameters

[in]	Handle	Handle to be checked.
[in]	NumberOfChildren	Number of Handles in ChildHandleBuffer.
[in]	ChildHandleBuffer	An array of child handles to be freed. May be NULL if NumberOfChildren is 0.

Return values

TRUE	Found the input Handle in ChildHandleBuffer.
FALSE	Can't find the input Handle in ChildHandleBuffer.

Definition at line 1306 of file DxeNetLib.c.

◆ NetItemInMap()

BOOLEAN NetItemInMap	(	IN NET_MAP *	Map,
		IN NET_MAP_ITEM *	Item
	)

Check whether the item is in the Map and return TRUE if it is.

If Map is NULL, then ASSERT(). If Item is NULL, then ASSERT().

Parameters

[in]	Map	The netmap to search within.
[in]	Item	The item to search.

Returns: TRUE if the item is in the netmap, otherwise FALSE.

Definition at line 1594 of file DxeNetLib.c.

◆ NetLibAsciiStrToIp4()

EFI_STATUS EFIAPI NetLibAsciiStrToIp4	(	IN CONST CHAR8 *	String,
		OUT EFI_IPv4_ADDRESS *	Ip4Address
	)

Convert one Null-terminated ASCII string (decimal dotted) to EFI_IPv4_ADDRESS.

Parameters

[in]	String	The pointer to the Ascii string.
[out]	Ip4Address	The pointer to the converted IPv4 address.

Return values

EFI_SUCCESS	Convert to IPv4 address successfully.
EFI_INVALID_PARAMETER	The string is malformatted or Ip4Address is NULL.

Definition at line 3068 of file DxeNetLib.c.

◆ NetLibAsciiStrToIp6()

EFI_STATUS EFIAPI NetLibAsciiStrToIp6	(	IN CONST CHAR8 *	String,
		OUT EFI_IPv6_ADDRESS *	Ip6Address
	)

Convert one Null-terminated ASCII string to EFI_IPv6_ADDRESS. The format of the string is defined in RFC 4291 - Text Representation of Addresses.

Parameters

[in]	String	The pointer to the Ascii string.
[out]	Ip6Address	The pointer to the converted IPv6 address.

Return values

EFI_SUCCESS	Convert to IPv6 address successfully.
EFI_INVALID_PARAMETER	The string is malformatted or Ip6Address is NULL.

Definition at line 3097 of file DxeNetLib.c.

◆ NetLibCreateDnsQName()

CHAR8 *EFIAPI NetLibCreateDnsQName ( IN CHAR16 * DomainName )

Create Dns QName according the queried domain name.

If DomainName is NULL, then ASSERT().

QName is a domain name represented as a sequence of labels, where each label consists of a length octet followed by that number of octets. The QName terminates with the zero length octet for the null label of the root. Caller should take responsibility to free the buffer in returned pointer.

Parameters

DomainName The pointer to the queried domain name string.

Return values

NULL	Failed to fill QName.

Returns: QName filled successfully.

Definition at line 3424 of file DxeNetLib.c.

◆ NetLibCreateIPv4DPathNode()

VOID EFIAPI NetLibCreateIPv4DPathNode	(	IN OUT IPv4_DEVICE_PATH *	Node,
		IN EFI_HANDLE	Controller,
		IN IP4_ADDR	LocalIp,
		IN UINT16	LocalPort,
		IN IP4_ADDR	RemoteIp,
		IN UINT16	RemotePort,
		IN UINT16	Protocol,
		IN BOOLEAN	UseDefaultAddress
	)

Create an IPv4 device path node.

If Node is NULL, then ASSERT().

The header type of IPv4 device path node is MESSAGING_DEVICE_PATH. The header subtype of IPv4 device path node is MSG_IPv4_DP. Get other info from parameters to make up the whole IPv4 device path node.

Parameters

[in,out]	Node	Pointer to the IPv4 device path node.
[in]	Controller	The controller handle.
[in]	LocalIp	The local IPv4 address.
[in]	LocalPort	The local port.
[in]	RemoteIp	The remote IPv4 address.
[in]	RemotePort	The remote port.
[in]	Protocol	The protocol type in the IP header.
[in]	UseDefaultAddress	Whether this instance is using default address or not.

Definition at line 2903 of file DxeNetLib.c.

◆ NetLibCreateIPv6DPathNode()

VOID EFIAPI NetLibCreateIPv6DPathNode	(	IN OUT IPv6_DEVICE_PATH *	Node,
		IN EFI_HANDLE	Controller,
		IN EFI_IPv6_ADDRESS *	LocalIp,
		IN UINT16	LocalPort,
		IN EFI_IPv6_ADDRESS *	RemoteIp,
		IN UINT16	RemotePort,
		IN UINT16	Protocol
	)

Create an IPv6 device path node.

If Node is NULL, then ASSERT(). If LocalIp is NULL, then ASSERT(). If RemoteIp is NULL, then ASSERT().

The header type of IPv6 device path node is MESSAGING_DEVICE_PATH. The header subtype of IPv6 device path node is MSG_IPv6_DP. Get other info from parameters to make up the whole IPv6 device path node.

Parameters

[in,out]	Node	Pointer to the IPv6 device path node.
[in]	Controller	The controller handle.
[in]	LocalIp	The local IPv6 address.
[in]	LocalPort	The local port.
[in]	RemoteIp	The remote IPv6 address.
[in]	RemotePort	The remote port.
[in]	Protocol	The protocol type in the IP header.

Definition at line 2965 of file DxeNetLib.c.

◆ NetLibCreateServiceChild()

EFI_STATUS EFIAPI NetLibCreateServiceChild	(	IN EFI_HANDLE	Controller,
		IN EFI_HANDLE	Image,
		IN EFI_GUID *	ServiceBindingGuid,
		IN OUT EFI_HANDLE *	ChildHandle
	)

Create a child of the service that is identified by ServiceBindingGuid.

Get the ServiceBinding Protocol first, then use it to create a child.

If ServiceBindingGuid is NULL, then ASSERT(). If ChildHandle is NULL, then ASSERT().

Parameters

[in]	Controller	The controller which has the service installed.
[in]	Image	The image handle used to open service.
[in]	ServiceBindingGuid	The service's Guid.
[in,out]	ChildHandle	The handle to receive the create child.

Return values

EFI_SUCCESS	The child is successfully created.
Others	Failed to create the child.

Definition at line 1967 of file DxeNetLib.c.

◆ NetLibDefaultAddressIsStatic()

BOOLEAN NetLibDefaultAddressIsStatic ( IN EFI_HANDLE Controller )

Check the default address used by the IPv4 driver is static or dynamic (acquired from DHCP).

If the controller handle does not have the EFI_IP4_CONFIG2_PROTOCOL installed, the default address is static. If failed to get the policy from Ip4 Config2 Protocol, the default address is static. Otherwise, get the result from Ip4 Config2 Protocol.

Parameters

[in] Controller The controller handle which has the EFI_IP4_CONFIG2_PROTOCOL relative with the default address to judge.

Return values

TRUE	If the default address is static.
FALSE	If the default address is acquired from DHCP.

Definition at line 2846 of file DxeNetLib.c.

◆ NetLibDefaultUnload()

EFI_STATUS EFIAPI NetLibDefaultUnload ( IN EFI_HANDLE ImageHandle )

This is the default unload handle for all the network drivers.

Disconnect the driver specified by ImageHandle from all the devices in the handle database. Uninstall all the protocols installed in the driver entry point.

Parameters

[in] ImageHandle The drivers' driver image.

Return values

EFI_SUCCESS	The image is unloaded.
Others	Failed to unload the image.

Definition at line 1846 of file DxeNetLib.c.

◆ NetLibDestroyServiceChild()

EFI_STATUS EFIAPI NetLibDestroyServiceChild	(	IN EFI_HANDLE	Controller,
		IN EFI_HANDLE	Image,
		IN EFI_GUID *	ServiceBindingGuid,
		IN EFI_HANDLE	ChildHandle
	)

Destroy a child of the service that is identified by ServiceBindingGuid.

Get the ServiceBinding Protocol first, then use it to destroy a child.

If ServiceBindingGuid is NULL, then ASSERT().

Parameters

[in]	Controller	The controller which has the service installed.
[in]	Image	The image handle used to open service.
[in]	ServiceBindingGuid	The service's Guid.
[in]	ChildHandle	The child to destroy.

Return values

EFI_SUCCESS	The child is successfully destroyed.
Others	Failed to destroy the child.

Definition at line 2020 of file DxeNetLib.c.

◆ NetLibDetectMedia()

EFI_STATUS EFIAPI NetLibDetectMedia	(	IN EFI_HANDLE	ServiceHandle,
		OUT BOOLEAN *	MediaPresent
	)

Detect media status for specified network device.

If MediaPresent is NULL, then ASSERT().

The underlying UNDI driver may or may not support reporting media status from GET_STATUS command (PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED). This routine will try to invoke Snp->GetStatus() to get the media status: if media already present, it return directly; if media not present, it will stop SNP and then restart SNP to get the latest media status, this give chance to get the correct media status for old UNDI driver which doesn't support reporting media status from GET_STATUS command. Note: there will be two limitations for current algorithm: 1) for UNDI with this capability, in case of cable is not attached, there will be an redundant Stop/Start() process; 2) for UNDI without this capability, in case that network cable is attached when Snp->Initialize() is invoked while network cable is unattached later, NetLibDetectMedia() will report MediaPresent as TRUE, causing upper layer apps to wait for timeout time.

Parameters

[in]	ServiceHandle	The handle where network service binding protocols are installed on.
[out]	MediaPresent	The pointer to store the media status.

Return values

EFI_SUCCESS	Media detection success.
EFI_INVALID_PARAMETER	ServiceHandle is not valid network device handle.
EFI_UNSUPPORTED	Network device does not support media detection.
EFI_DEVICE_ERROR	SNP is in unknown state.

Definition at line 2472 of file DxeNetLib.c.

◆ NetLibDetectMediaWaitTimeout()

EFI_STATUS EFIAPI NetLibDetectMediaWaitTimeout	(	IN EFI_HANDLE	ServiceHandle,
		IN UINT64	Timeout,
		OUT EFI_STATUS *	MediaState
	)

Detect media state for a network device. This routine will wait for a period of time at a specified checking interval when a certain network is under connecting until connection process finishs or timeout. If Aip protocol is supported by low layer drivers, three kinds of media states can be detected: EFI_SUCCESS, EFI_NOT_READY and EFI_NO_MEDIA, represents connected state, connecting state and no media state respectively. When function detects the current state is EFI_NOT_READY, it will loop to wait for next time's check until state turns to be EFI_SUCCESS or EFI_NO_MEDIA. If Aip protocol is not supported, function will call NetLibDetectMedia() and return state directly.

Parameters

[in]	ServiceHandle	The handle where network service binding protocols are installed on.
[in]	Timeout	The maximum number of 100ns units to wait when network is connecting. Zero value means detect once and return immediately.
[out]	MediaState	The pointer to the detected media state.

Return values

EFI_SUCCESS	Media detection success.
EFI_INVALID_PARAMETER	ServiceHandle is not a valid network device handle or MediaState pointer is NULL.
EFI_DEVICE_ERROR	A device error occurred.
EFI_TIMEOUT	Network is connecting but timeout.

Definition at line 2683 of file DxeNetLib.c.

◆ NetLibGetMacAddress()

EFI_STATUS EFIAPI NetLibGetMacAddress	(	IN EFI_HANDLE	ServiceHandle,
		OUT EFI_MAC_ADDRESS *	MacAddress,
		OUT UINTN *	AddressSize
	)

Get MAC address associated with the network service handle.

If MacAddress is NULL, then ASSERT(). If AddressSize is NULL, then ASSERT().

There should be MNP Service Binding Protocol installed on the input ServiceHandle. If SNP is installed on the ServiceHandle or its parent handle, MAC address will be retrieved from SNP. If no SNP found, try to get SNP mode data use MNP.

Parameters

[in]	ServiceHandle	The handle where network service binding protocols are installed on.
[out]	MacAddress	The pointer to store the returned MAC address.
[out]	AddressSize	The length of returned MAC address.

Return values

EFI_SUCCESS	MAC address is returned successfully.
Others	Failed to get SNP mode data.

Definition at line 2251 of file DxeNetLib.c.

◆ NetLibGetMacString()

EFI_STATUS EFIAPI NetLibGetMacString	(	IN EFI_HANDLE	ServiceHandle,
		IN EFI_HANDLE ImageHandle	OPTIONAL,
		OUT CHAR16 **	MacString
	)

Convert MAC address of the NIC associated with specified Service Binding Handle to a unicode string. Callers are responsible for freeing the string storage.

If MacString is NULL, then ASSERT().

Locate simple network protocol associated with the Service Binding Handle and get the mac address from SNP. Then convert the mac address into a unicode string. It takes 2 unicode characters to represent a 1 byte binary buffer. Plus one unicode character for the null-terminator.

Parameters

[in]	ServiceHandle	The handle where network service binding protocol is installed on.
[in]	ImageHandle	The image handle used to act as the agent handle to get the simple network protocol. This parameter is optional and may be NULL.
[out]	MacString	The pointer to store the address of the string representation of the mac address.

Return values

EFI_SUCCESS	Convert the mac address a unicode string successfully.
EFI_OUT_OF_RESOURCES	There are not enough memory resource.
Others	Failed to open the simple network protocol.

Definition at line 2363 of file DxeNetLib.c.

◆ NetLibGetNicHandle()

EFI_HANDLE EFIAPI NetLibGetNicHandle	(	IN EFI_HANDLE	Controller,
		IN EFI_GUID *	ProtocolGuid
	)

Find the UNDI/SNP handle from controller and protocol GUID.

If ProtocolGuid is NULL, then ASSERT().

For example, IP will open a MNP child to transmit/receive packets, when MNP is stopped, IP should also be stopped. IP needs to find its own private data which is related the IP's service binding instance that is install on UNDI/SNP handle. Now, the controller is either a MNP or ARP child handle. But IP opens these handle BY_DRIVER, use that info, we can get the UNDI/SNP handle.

Parameters

[in]	Controller	Then protocol handle to check.
[in]	ProtocolGuid	The protocol that is related with the handle.

Returns: The UNDI/SNP handle or NULL for errors.

Definition at line 3019 of file DxeNetLib.c.

◆ NetLibGetSnpHandle()

EFI_HANDLE EFIAPI NetLibGetSnpHandle	(	IN EFI_HANDLE	ServiceHandle,
		OUT EFI_SIMPLE_NETWORK_PROTOCOL **Snp	OPTIONAL
	)

Get handle with Simple Network Protocol installed on it.

There should be MNP Service Binding Protocol installed on the input ServiceHandle. If Simple Network Protocol is already installed on the ServiceHandle, the ServiceHandle will be returned. If SNP is not installed on the ServiceHandle, try to find its parent handle with SNP installed.

Parameters

[in]	ServiceHandle	The handle where network service binding protocols are installed on.
[out]	Snp	The pointer to store the address of the SNP instance. This is an optional parameter that may be NULL.

Returns: The SNP handle, or NULL if not found.

Definition at line 2073 of file DxeNetLib.c.

◆ NetLibGetSystemGuid()

EFI_STATUS EFIAPI NetLibGetSystemGuid ( OUT EFI_GUID * SystemGuid )

This function obtains the system guid from the smbios table.

If SystemGuid is NULL, then ASSERT().

Parameters

[out] SystemGuid The pointer of the returned system guid.

Return values

EFI_SUCCESS	Successfully obtained the system guid.
EFI_NOT_FOUND	Did not find the SMBIOS table.

Definition at line 3325 of file DxeNetLib.c.

◆ NetLibGetVlanHandle()

EFI_HANDLE EFIAPI NetLibGetVlanHandle	(	IN EFI_HANDLE	ControllerHandle,
		IN UINT16	VlanId
	)

Find VLAN device handle with specified VLAN ID.

The VLAN child device handle is created by VLAN Config Protocol on ControllerHandle. This function will append VLAN device path node to the parent device path, and then use LocateDevicePath() to find the correct VLAN device handle.

Parameters

[in]	ControllerHandle	The handle where network service binding protocols are installed on.
[in]	VlanId	The configured VLAN ID for the VLAN device.

Returns: The VLAN device handle, or NULL if not found.

Definition at line 2180 of file DxeNetLib.c.

◆ NetLibGetVlanId()

UINT16 EFIAPI NetLibGetVlanId ( IN EFI_HANDLE ServiceHandle )

Retrieve VLAN ID of a VLAN device handle.

Search VLAN device path node in Device Path of specified ServiceHandle and return its VLAN ID. If no VLAN device path node found, then this ServiceHandle is not a VLAN device handle, and 0 will be returned.

Parameters

[in] ServiceHandle The handle where network service binding protocols are installed on.

Returns: VLAN ID of the device handle, or 0 if not a VLAN device.

Definition at line 2140 of file DxeNetLib.c.

◆ NetLibIp6ToStr()

EFI_STATUS EFIAPI NetLibIp6ToStr	(	IN EFI_IPv6_ADDRESS *	Ip6Address,
		OUT CHAR16 *	String,
		IN UINTN	StringSize
	)

Convert one EFI_IPv6_ADDRESS to Null-terminated Unicode string. The text representation of address is defined in RFC 4291.

Parameters

[in]	Ip6Address	The pointer to the IPv6 address.
[out]	String	The buffer to return the converted string.
[in]	StringSize	The length in bytes of the input String.

Return values

EFI_SUCCESS	Convert to string successfully.
EFI_INVALID_PARAMETER	The input parameter is invalid.
EFI_BUFFER_TOO_SMALL	The BufferSize is too small for the result. BufferSize has been updated with the size needed to complete the request.

Definition at line 3218 of file DxeNetLib.c.

◆ NetLibStrToIp4()

EFI_STATUS EFIAPI NetLibStrToIp4	(	IN CONST CHAR16 *	String,
		OUT EFI_IPv4_ADDRESS *	Ip4Address
	)

Convert one Null-terminated Unicode string (decimal dotted) to EFI_IPv4_ADDRESS.

Parameters

[in]	String	The pointer to the Ascii string.
[out]	Ip4Address	The pointer to the converted IPv4 address.

Return values

EFI_SUCCESS	Convert to IPv4 address successfully.
EFI_INVALID_PARAMETER	The string is malformatted or Ip4Address is NULL.

Definition at line 3125 of file DxeNetLib.c.

◆ NetLibStrToIp6()

EFI_STATUS EFIAPI NetLibStrToIp6	(	IN CONST CHAR16 *	String,
		OUT EFI_IPv6_ADDRESS *	Ip6Address
	)

Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS. The format of the string is defined in RFC 4291 - Text Representation of Addresses.

Parameters

[in]	String	The pointer to the Ascii string.
[out]	Ip6Address	The pointer to the converted IPv6 address.

Return values

EFI_SUCCESS	Convert to IPv6 address successfully.
EFI_INVALID_PARAMETER	The string is malformatted or Ip6Address is NULL.

Definition at line 3154 of file DxeNetLib.c.

◆ NetLibStrToIp6andPrefix()

EFI_STATUS EFIAPI NetLibStrToIp6andPrefix	(	IN CONST CHAR16 *	String,
		OUT EFI_IPv6_ADDRESS *	Ip6Address,
		OUT UINT8 *	PrefixLength
	)

Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS and prefix length. The format of the string is defined in RFC 4291 - Text Representation of Addresses Prefixes: ipv6-address/prefix-length.

Parameters

[in]	String	The pointer to the Ascii string.
[out]	Ip6Address	The pointer to the converted IPv6 address.
[out]	PrefixLength	The pointer to the converted prefix length.

Return values

EFI_SUCCESS	Convert to IPv6 address successfully.
EFI_INVALID_PARAMETER	The string is malformatted or Ip6Address is NULL.

Definition at line 3185 of file DxeNetLib.c.

◆ NetListInsertAfter()

VOID EFIAPI NetListInsertAfter	(	IN OUT LIST_ENTRY *	PrevEntry,
		IN OUT LIST_ENTRY *	NewEntry
	)

Insert a new node entry after a designated node entry of a doubly linked list.

ASSERT if PrevEntry or NewEntry is NULL.

Inserts a new node entry donated by NewEntry after the node entry donated by PrevEntry of the doubly linked list.

Parameters

[in,out]	PrevEntry	The previous entry to insert after.
[in,out]	NewEntry	The new entry to insert.

Definition at line 1172 of file DxeNetLib.c.

◆ NetListInsertBefore()

VOID EFIAPI NetListInsertBefore	(	IN OUT LIST_ENTRY *	PostEntry,
		IN OUT LIST_ENTRY *	NewEntry
	)

Insert a new node entry before a designated node entry of a doubly linked list.

ASSERT if PostEntry or NewEntry is NULL.

Inserts a new node entry donated by NewEntry after the node entry donated by PostEntry of the doubly linked list.

Parameters

[in,out]	PostEntry	The entry to insert before.
[in,out]	NewEntry	The new entry to insert.

Definition at line 1199 of file DxeNetLib.c.

◆ NetListRemoveHead()

LIST_ENTRY *EFIAPI NetListRemoveHead ( IN OUT LIST_ENTRY * Head )

Remove the first node entry on the list, and return the removed node entry.

Removes the first node Entry from a doubly linked list. It is up to the caller of this function to release the memory used by the first node if that is required. On exit, the removed node is returned.

If Head is NULL, then ASSERT(). If Head was not initialized, then ASSERT(). If PcdMaximumLinkedListLength is not zero, and the number of nodes in the linked list including the head node is greater than or equal to PcdMaximumLinkedListLength, then ASSERT().

Parameters

[in,out] Head The list header.

Returns: The first node entry that is removed from the list, NULL if the list is empty.

Definition at line 1090 of file DxeNetLib.c.

◆ NetListRemoveTail()

LIST_ENTRY *EFIAPI NetListRemoveTail ( IN OUT LIST_ENTRY * Head )

Remove the last node entry on the list and and return the removed node entry.

Removes the last node entry from a doubly linked list. It is up to the caller of this function to release the memory used by the first node if that is required. On exit, the removed node is returned.

If Head is NULL, then ASSERT(). If Head was not initialized, then ASSERT(). If PcdMaximumLinkedListLength is not zero, and the number of nodes in the linked list including the head node is greater than or equal to PcdMaximumLinkedListLength, then ASSERT().

Parameters

[in,out] Head The list head.

Returns: The last node entry that is removed from the list, NULL if the list is empty.

Definition at line 1134 of file DxeNetLib.c.

◆ NetMapAllocItem()

NET_MAP_ITEM * NetMapAllocItem ( IN OUT NET_MAP * Map )

Return one allocated item.

If the Recycled doubly linked list of the netmap is empty, it will try to allocate a batch of items if there are enough resources and add corresponding nodes to the beginning of the Recycled doubly linked list of the netmap. Otherwise, it will directly remove the fist node entry of the Recycled doubly linked list and return the corresponding item.

If Map is NULL, then ASSERT().

Parameters

[in,out] Map The netmap to allocate item for.

Returns: The allocated item. If NULL, the allocation failed due to resource limit.

Definition at line 1458 of file DxeNetLib.c.

◆ NetMapClean()

VOID EFIAPI NetMapClean ( IN OUT NET_MAP * Map )

To clean up the netmap, that is, release allocated memories.

Removes all nodes of the Used doubly linked list and free memory of all related netmap items. Removes all nodes of the Recycled doubly linked list and free memory of all related netmap items. The number of the <Key, Value> pairs in the netmap is set to be zero.

If Map is NULL, then ASSERT().

Parameters

[in,out] Map The netmap to clean up.

Definition at line 1368 of file DxeNetLib.c.

◆ NetMapFindKey()

NET_MAP_ITEM *EFIAPI NetMapFindKey	(	IN NET_MAP *	Map,
		IN VOID *	Key
	)

Find the key in the netmap and returns the point to the item contains the Key.

Iterate the Used doubly linked list of the netmap to get every item. Compare the key of every item with the key to search. It returns the point to the item contains the Key if found.

If Map is NULL, then ASSERT(). If Key is NULL, then ASSERT().

Parameters

[in]	Map	The netmap to search within.
[in]	Key	The key to search.

Returns: The point to the item contains the Key, or NULL if Key isn't in the map.

Definition at line 1629 of file DxeNetLib.c.

◆ NetMapGetCount()

UINTN EFIAPI NetMapGetCount ( IN NET_MAP * Map )

Return the number of the <Key, Value> pairs in the netmap.

If Map is NULL, then ASSERT().

Parameters

[in] Map The netmap to get the entry number.

Returns: The entry number in the netmap.

Definition at line 1433 of file DxeNetLib.c.

◆ NetMapInit()

VOID EFIAPI NetMapInit ( IN OUT NET_MAP * Map )

Initialize the netmap. Netmap is a reposity to keep the <Key, Value> pairs.

Initialize the forward and backward links of two head nodes donated by Map->Used and Map->Recycled of two doubly linked lists. Initializes the count of the <Key, Value> pairs in the netmap to zero.

If Map is NULL, then ASSERT(). If the address of Map->Used is NULL, then ASSERT(). If the address of Map->Recycled is NULl, then ASSERT().

Parameters

[in,out] Map The netmap to initialize.

Definition at line 1343 of file DxeNetLib.c.

◆ NetMapInsertHead()

EFI_STATUS EFIAPI NetMapInsertHead	(	IN OUT NET_MAP *	Map,
		IN VOID *	Key,
		IN VOID *Value	OPTIONAL
	)

Allocate an item to save the <Key, Value> pair to the head of the netmap.

Allocate an item to save the <Key, Value> pair and add corresponding node entry to the beginning of the Used doubly linked list. The number of the <Key, Value> pairs in the netmap increase by 1.

If Map is NULL, then ASSERT(). If Key is NULL, then ASSERT().

Parameters

[in,out]	Map	The netmap to insert into.
[in]	Key	The user's key.
[in]	Value	The user's value for the key.

Return values

EFI_OUT_OF_RESOURCES	Failed to allocate the memory for the item.
EFI_SUCCESS	The item is inserted to the head.

Definition at line 1512 of file DxeNetLib.c.

◆ NetMapInsertTail()

EFI_STATUS EFIAPI NetMapInsertTail	(	IN OUT NET_MAP *	Map,
		IN VOID *	Key,
		IN VOID *Value	OPTIONAL
	)

Allocate an item to save the <Key, Value> pair to the tail of the netmap.

Allocate an item to save the <Key, Value> pair and add corresponding node entry to the tail of the Used doubly linked list. The number of the <Key, Value> pairs in the netmap increase by 1.

If Map is NULL, then ASSERT(). If Key is NULL, then ASSERT().

Parameters

[in,out]	Map	The netmap to insert into.
[in]	Key	The user's key.
[in]	Value	The user's value for the key.

Return values

EFI_OUT_OF_RESOURCES	Failed to allocate the memory for the item.
EFI_SUCCESS	The item is inserted to the tail.

Definition at line 1556 of file DxeNetLib.c.

◆ NetMapIsEmpty()

BOOLEAN EFIAPI NetMapIsEmpty ( IN NET_MAP * Map )

Test whether the netmap is empty and return true if it is.

If the number of the <Key, Value> pairs in the netmap is zero, return TRUE.

If Map is NULL, then ASSERT().

Parameters

[in] Map The net map to test.

Returns: TRUE if the netmap is empty, otherwise FALSE.

Definition at line 1413 of file DxeNetLib.c.

◆ NetMapIterate()

EFI_STATUS EFIAPI NetMapIterate	(	IN NET_MAP *	Map,
		IN NET_MAP_CALLBACK	CallBack,
		IN VOID *Arg	OPTIONAL
	)

Iterate through the netmap and call CallBack for each item.

It will continue the traverse if CallBack returns EFI_SUCCESS, otherwise, break from the loop. It returns the CallBack's last return value. This function is delete safe for the current item.

If Map is NULL, then ASSERT(). If CallBack is NULL, then ASSERT().

Parameters

[in]	Map	The Map to iterate through.
[in]	CallBack	The callback function to call for each item.
[in]	Arg	The opaque parameter to the callback.

Return values

EFI_SUCCESS	There is no item in the netmap or CallBack for each item return EFI_SUCCESS.
Others	It returns the CallBack's last return value.

Definition at line 1800 of file DxeNetLib.c.

◆ NetMapRemoveHead()

VOID *EFIAPI NetMapRemoveHead	(	IN OUT NET_MAP *	Map,
		OUT VOID **Value	OPTIONAL
	)

Remove the first node entry on the netmap and return the key of the removed item.

Remove the first node entry from the Used doubly linked list of the netmap. The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL, parameter Value will point to the value of the item. It returns the key of the removed item.

If Map is NULL, then ASSERT(). If the Used doubly linked list is empty, then ASSERT().

Parameters

[in,out]	Map	The netmap to remove the head from.
[out]	Value	The variable to receive the value if not NULL.

Returns: The key of the item removed.

Definition at line 1710 of file DxeNetLib.c.

◆ NetMapRemoveItem()

VOID *EFIAPI NetMapRemoveItem	(	IN OUT NET_MAP *	Map,
		IN OUT NET_MAP_ITEM *	Item,
		OUT VOID **Value	OPTIONAL
	)

Remove the node entry of the item from the netmap and return the key of the removed item.

Remove the node entry of the item from the Used doubly linked list of the netmap. The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node entry of the item to the Recycled doubly linked list of the netmap. If Value is not NULL, Value will point to the value of the item. It returns the key of the removed item.

If Map is NULL, then ASSERT(). If Item is NULL, then ASSERT(). if item in not in the netmap, then ASSERT().

Parameters

[in,out]	Map	The netmap to remove the item from.
[in,out]	Item	The item to remove.
[out]	Value	The variable to receive the value if not NULL.

Returns: The key of the removed item.

Definition at line 1671 of file DxeNetLib.c.

◆ NetMapRemoveTail()

VOID *EFIAPI NetMapRemoveTail	(	IN OUT NET_MAP *	Map,
		OUT VOID **Value	OPTIONAL
	)

Remove the last node entry on the netmap and return the key of the removed item.

Remove the last node entry from the Used doubly linked list of the netmap. The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL, parameter Value will point to the value of the item. It returns the key of the removed item.

If Map is NULL, then ASSERT(). If the Used doubly linked list is empty, then ASSERT().

Parameters

[in,out]	Map	The netmap to remove the tail from.
[out]	Value	The variable to receive the value if not NULL.

Returns: The key of the item removed.

Definition at line 1754 of file DxeNetLib.c.

◆ NetPutUint32()

VOID EFIAPI NetPutUint32	(	IN OUT UINT8 *	Buf,
		IN UINT32	Data
	)

Put a UINT32 to the byte stream in network byte order.

ASSERT if Buf is NULL.

Converts a UINT32 from host byte order to network byte order. Then copy it to the byte stream.

Parameters

[in,out]	Buf	The buffer to put the UINT32.
[in]	Data	The data to be converted and put into the byte stream.

Definition at line 1059 of file DxeNetLib.c.

◆ PseudoRandom()

EFI_STATUS EFIAPI PseudoRandom	(	OUT VOID *	Output,
		IN UINTN	OutputLength
	)

Generate a Random output data given a length.

Parameters

[out]	Output	- The buffer to store the generated random data.
[in]	OutputLength	- The length of the output buffer.

Return values

EFI_SUCCESS	On Success
EFI_INVALID_PARAMETER	Pointer is null or size is zero
EFI_NOT_FOUND	RNG protocol not found
Others	Error from RngProtocol->GetRNG()

Returns: Status code

Definition at line 928 of file DxeNetLib.c.

◆ PseudoRandomU32()

EFI_STATUS EFIAPI PseudoRandomU32 ( OUT UINT32 * Output )

Generate a 32-bit pseudo-random number.

Parameters

[out] Output - The buffer to store the generated random number.

Return values

EFI_SUCCESS	On Success
EFI_NOT_FOUND	RNG protocol not found
Others	Error from RngProtocol->GetRNG()

Returns: Status code

Definition at line 1011 of file DxeNetLib.c.

◆ SyslogBuildPacket()

UINT32 SyslogBuildPacket	(	IN UINT32	Level,
		IN UINT8 *	Module,
		IN UINT8 *	File,
		IN UINT32	Line,
		IN UINT8 *	Message,
		IN UINT32	BufLen,
		OUT CHAR8 *	Buf
	)

Build a syslog packet, including the Ethernet/Ip/Udp headers and user's message.

Parameters

[in]	Level	Syslog severity level
[in]	Module	The module that generates the log
[in]	File	The file that contains the current log
[in]	Line	The line of code in the File that contains the current log
[in]	Message	The log message
[in]	BufLen	The length of the Buf
[out]	Buf	The buffer to put the packet data

Returns: The length of the syslog packet built, 0 represents no packet is built.

Definition at line 342 of file DxeNetLib.c.

◆ SyslogLocateSnp()

EFI_SIMPLE_NETWORK_PROTOCOL * SyslogLocateSnp ( VOID )

Locate the handles that support SNP, then open one of them to send the syslog packets. The caller isn't required to close the SNP after use because the SNP is opened by HandleProtocol.

Returns: The point to SNP if one is properly opened. Otherwise NULL

Definition at line 166 of file DxeNetLib.c.

◆ SyslogSendPacket()

EFI_STATUS SyslogSendPacket	(	IN CHAR8 *	Packet,
		IN UINT32	Length
	)

Transmit a syslog packet synchronously through SNP. The Packet already has the ethernet header prepended. This function should fill in the source MAC because it will try to locate a SNP each time it is called to avoid the problem if SNP is unloaded. This code snip is copied from MNP. If Packet is NULL, then ASSERT().

Parameters

[in]	Packet	The Syslog packet
[in]	Length	The length of the packet

Return values

EFI_DEVICE_ERROR	Failed to locate a usable SNP protocol
EFI_TIMEOUT	Timeout happened to send the packet.
EFI_SUCCESS	Packet is sent.

Definition at line 235 of file DxeNetLib.c.

Variable Documentation

◆ gIp4AllMasks

GLOBAL_REMOVE_IF_UNREFERENCED IP4_ADDR gIp4AllMasks[IP4_MASK_NUM]

Definition at line 43 of file DxeNetLib.c.

◆ mMonthName

GLOBAL_REMOVE_IF_UNREFERENCED CHAR8* mMonthName[]

Initial value:

= {
  "Jan",
  "Feb",
  "Mar",
  "Apr",
  "May",
  "Jun",
  "Jul",
  "Aug",
  "Sep",
  "Oct",
  "Nov",
  "Dec"
}

Definition at line 102 of file DxeNetLib.c.

◆ mNetDebugLevelMax

GLOBAL_REMOVE_IF_UNREFERENCED UINTN mNetDebugLevelMax = NETDEBUG_LEVEL_ERROR

Definition at line 90 of file DxeNetLib.c.

◆ mNetVlanDevicePathTemplate

GLOBAL_REMOVE_IF_UNREFERENCED VLAN_DEVICE_PATH mNetVlanDevicePathTemplate

Initial value:

= {
  {
    MESSAGING_DEVICE_PATH,
    MSG_VLAN_DP,
    {
      (UINT8)(sizeof (VLAN_DEVICE_PATH)),
      (UINT8)((sizeof (VLAN_DEVICE_PATH)) >> 8)
    }
  },
  0
}

Definition at line 120 of file DxeNetLib.c.

◆ mSyslogDstIp

GLOBAL_REMOVE_IF_UNREFERENCED UINT32 mSyslogDstIp = 0xffffffff

Definition at line 99 of file DxeNetLib.c.

◆ mSyslogDstMac

GLOBAL_REMOVE_IF_UNREFERENCED UINT8 mSyslogDstMac[NET_ETHER_ADDR_LEN] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff }

Definition at line 98 of file DxeNetLib.c.

◆ mSyslogPacketSeq

GLOBAL_REMOVE_IF_UNREFERENCED UINT32 mSyslogPacketSeq = 0xDEADBEEF

Definition at line 91 of file DxeNetLib.c.

◆ mSyslogSrcIp

GLOBAL_REMOVE_IF_UNREFERENCED UINT32 mSyslogSrcIp = 0

Definition at line 100 of file DxeNetLib.c.

◆ mZeroIp4Addr

GLOBAL_REMOVE_IF_UNREFERENCED EFI_IPv4_ADDRESS mZeroIp4Addr

Initial value:

= {
  { 0, 0, 0, 0 }
}

Definition at line 82 of file DxeNetLib.c.

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ DEFAULT_ZERO_START

◆ NIC_ITEM_CONFIG_SIZE

◆ SECURE_HASH_ALGORITHMS_SIZE

Function Documentation

◆ Ip6Swap128()

◆ NetDebugASPrint()

◆ NetDebugOutput()

◆ NetDestroyLinkList()

◆ NetGetIpClass()

◆ NetGetMaskLength()

◆ NetGetUint32()

◆ NetIp4IsUnicast()

◆ NetIp6IsLinkLocalAddr()

◆ NetIp6IsNetEqual()

◆ NetIp6IsUnspecifiedAddr()

◆ NetIp6IsValidUnicast()

◆ NetIsInHandleBuffer()

◆ NetItemInMap()

◆ NetLibAsciiStrToIp4()

◆ NetLibAsciiStrToIp6()

◆ NetLibCreateDnsQName()

◆ NetLibCreateIPv4DPathNode()

◆ NetLibCreateIPv6DPathNode()

◆ NetLibCreateServiceChild()

◆ NetLibDefaultAddressIsStatic()

◆ NetLibDefaultUnload()

◆ NetLibDestroyServiceChild()

◆ NetLibDetectMedia()

◆ NetLibDetectMediaWaitTimeout()

◆ NetLibGetMacAddress()

◆ NetLibGetMacString()

◆ NetLibGetNicHandle()

◆ NetLibGetSnpHandle()

◆ NetLibGetSystemGuid()

◆ NetLibGetVlanHandle()

◆ NetLibGetVlanId()

◆ NetLibIp6ToStr()

◆ NetLibStrToIp4()

◆ NetLibStrToIp6()

◆ NetLibStrToIp6andPrefix()

◆ NetListInsertAfter()

◆ NetListInsertBefore()

◆ NetListRemoveHead()

◆ NetListRemoveTail()

◆ NetMapAllocItem()

◆ NetMapClean()

◆ NetMapFindKey()

◆ NetMapGetCount()

◆ NetMapInit()

◆ NetMapInsertHead()

◆ NetMapInsertTail()

◆ NetMapIsEmpty()

◆ NetMapIterate()

◆ NetMapRemoveHead()

◆ NetMapRemoveItem()

◆ NetMapRemoveTail()

◆ NetPutUint32()

◆ PseudoRandom()

◆ PseudoRandomU32()

◆ SyslogBuildPacket()

◆ SyslogLocateSnp()

◆ SyslogSendPacket()

Variable Documentation

◆ gIp4AllMasks

◆ mMonthName

◆ mNetDebugLevelMax

◆ mNetVlanDevicePathTemplate

◆ mSyslogDstIp

◆ mSyslogDstMac

◆ mSyslogPacketSeq

◆ mSyslogSrcIp

◆ mZeroIp4Addr