4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This library is only intended to be used by UEFI network stack modules.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync It provides basic functions for the UEFI network stack.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2005 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncare licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncwhich accompanies this distribution. The full text of the license may be found at<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// The address classification
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Ethernet head definition
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// 802.1Q VLAN Tag Control Information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef union {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT16 Vid : 12; // Unique VLAN identifier (0 to 4094)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT16 Priority : 3; // 802.1Q priority level (0 to 7)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// The EFI_IP4_HEADER is hard to use because the source and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// destination address are defined as EFI_IPv4_ADDRESS, which
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// is a structure. Two structures can't be compared or masked
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// directly. This is why there is an internal representation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// ICMP head definition. Each ICMP message is categorized as either an error
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// message or query message. Two message types have their own head format.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 Fourth; // 4th filed of the head, it depends on Type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// UDP header definition
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// TCP header definition
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (((*((UINT8 *) Mac) & 0x01) == 0x01) && (!NET_MAC_EQUAL (Mac, BMac, Len)))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Test the IP's attribute, All the IPs are in host byte order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define IP4_IS_MULTICAST(Ip) (((Ip) & 0xF0000000) == 0xE0000000)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define IP4_IS_LOCAL_BROADCAST(Ip) ((Ip) == 0xFFFFFFFF)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define IP4_NET_EQUAL(Ip1, Ip2, NetMask) (((Ip1) & (NetMask)) == ((Ip2) & (NetMask)))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define IP4_IS_VALID_NETMASK(Ip) (NetGetMaskLength (Ip) != IP4_MASK_NUM)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define IP6_IS_MULTICAST(Ip6) (((Ip6)->Addr[0]) == 0xFF)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Convert the EFI_IP4_ADDRESS to plain UINT32 IP4 address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_IP4(EfiIpAddr) (*(IP4_ADDR *) ((EfiIpAddr).Addr))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_NTOHL(EfiIp) (NTOHL (EFI_IP4 ((EfiIp))))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_IP4_EQUAL(Ip1, Ip2) (CompareMem ((Ip1), (Ip2), sizeof (EFI_IPv4_ADDRESS)) == 0)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_IP6_EQUAL(Ip1, Ip2) (CompareMem ((Ip1), (Ip2), sizeof (EFI_IPv6_ADDRESS)) == 0)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define IP4_COPY_ADDRESS(Dest, Src) (CopyMem ((Dest), (Src), sizeof (EFI_IPv4_ADDRESS)))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define IP6_COPY_ADDRESS(Dest, Src) (CopyMem ((Dest), (Src), sizeof (EFI_IPv6_ADDRESS)))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define IP6_COPY_LINK_ADDRESS(Mac1, Mac2) (CopyMem ((Mac1), (Mac2), sizeof (EFI_MAC_ADDRESS)))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// The debug level definition. This value is also used as the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// syslog's servity level. Don't change it.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Network debug message is sent out as syslog packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define NET_SYSLOG_FACILITY 16 // Syslog local facility local use
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define NET_SYSLOG_TX_TIMEOUT (500 * 1000 * 10) // 500ms
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define NET_DEBUG_MSG_LEN 470 // 512 - (ether+ip4+udp4 head length)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// The debug output expects the ASCII format string, Use %a to print ASCII
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// string, and %s to print UNICODE string. PrintArg must be enclosed in ().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// For example: NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Allocate a buffer, then format the message to it. This is a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync help function for the NET_DEBUG_XXX macros. The PrintArg of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync these macros treats the variable length print parameters as a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync single parameter, and pass it to the NetDebugASPrint. For
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync example, NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if extracted to:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NetDebugOutput (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NETDEBUG_LEVEL_TRACE,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NetDebugASPrint ("State transit to %a\n", Name)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Format The ASCII format string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ... The variable length parameter whose format is determined
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by the Format string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The buffer containing the formatted message,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or NULL if memory allocation failed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Builds an UDP4 syslog packet and send it using SNP.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function will locate a instance of SNP then send the message through it.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Because it isn't open the SNP BY_DRIVER, apply caution when using it.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Level The servity level of the message.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Module The Moudle that generates the log.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param File The file that contains the log.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Line The exact line that contains the log.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Message The user message to log.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the packet
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The log is discard because that it is more verbose
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync than the mNetDebugLevelMax. Or, it has been sent out.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Return the length of the mask.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Return the length of the mask. Valid values are 0 to 32.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the mask is invalid, return the invalid length 33, which is IP4_MASK_NUM.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NetMask is in the host byte order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] NetMask The netmask to get the length from.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The length of the netmask, or IP4_MASK_NUM (33) if the mask is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Return the class of the IP address, such as class A, B, C.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Addr is in host byte order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The address of class A starts with 0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the address belong to class A, return IP4_ADDR_CLASSA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The address of class B starts with 10.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the address belong to class B, return IP4_ADDR_CLASSB.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The address of class C starts with 110.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the address belong to class C, return IP4_ADDR_CLASSC.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The address of class D starts with 1110.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the address belong to class D, return IP4_ADDR_CLASSD.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The address of class E starts with 1111.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the address belong to class E, return IP4_ADDR_CLASSE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Addr The address to get the class from.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return IP address class, such as IP4_ADDR_CLASSA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Check whether the IP is a valid unicast address according to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the netmask. If NetMask is zero, use the IP address's class to get the default mask.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Ip is 0, IP is not a valid unicast address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Class D address is used for multicasting and class E address is reserved for future. If Ip
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync belongs to class D or class E, Ip is not a valid unicast address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If all bits of the host address of Ip are 0 or 1, Ip is not a valid unicast address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Ip The IP to check against.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] NetMask The mask of the IP.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return TRUE if Ip is a valid unicast address on the network, otherwise FALSE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Check whether the incoming IPv6 address is a valid unicast address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the address is a multicast address has binary 0xFF at the start, it is not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a valid unicast address. If the address is unspecified ::, it is not a valid
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync unicast address to be assigned to any node. If the address is loopback address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ::1, it is also not a valid unicast address to be assigned to any physical
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Ip6 The IPv6 address to check against.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return TRUE if Ip6 is a valid unicast address on the network, otherwise FALSE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Check whether the incoming Ipv6 address is the unspecified address or not.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Ip6 - Ip6 address, in network order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE - Yes, incoming Ipv6 address is the unspecified address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE - The incoming Ipv6 address is not the unspecified address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Check whether the incoming Ipv6 address is a link-local address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Ip6 - Ip6 address, in network order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE - The incoming Ipv6 address is a link-local address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE - The incoming Ipv6 address is not a link-local address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Check whether the Ipv6 address1 and address2 are on the connected network.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Ip1 - Ip6 address1, in network order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Ip2 - Ip6 address2, in network order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] PrefixLength - The prefix length of the checking net.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE - Yes, the Ipv6 address1 and address2 are connected.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE - No the Ipv6 address1 and address2 are not connected.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Switches the endianess of an IPv6 address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function swaps the bytes in a 128-bit IPv6 address to switch the value
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync from little endian to big endian or vice versa. The byte swapped value is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Ip6 Points to an IPv6 address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The byte swapped IPv6 address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define NET_IS_DIGIT(Ch) (('0' <= (Ch)) && ((Ch) <= '9'))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define NET_ROUNDUP(size, unit) (((size) + (unit) - 1) & (~((unit) - 1)))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define NET_IS_LOWER_CASE_CHAR(Ch) (('a' <= (Ch)) && ((Ch) <= 'z'))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define NET_IS_UPPER_CASE_CHAR(Ch) (('A' <= (Ch)) && ((Ch) <= 'Z'))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define NET_RANDOM(Seed) ((UINT32) ((UINT32) (Seed) * 1103515245UL + 12345) % 4294967295UL)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Extract a UINT32 from a byte stream.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function copies a UINT32 from a byte stream, and then converts it from Network
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync byte order to host byte order. Use this function to avoid alignment error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Buf The buffer to extract the UINT32.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The UINT32 extracted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Puts a UINT32 into the byte stream in network byte order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Converts a UINT32 from host byte order to network byte order, then copies it to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync byte stream.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Buf The buffer in which to put the UINT32.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Data The data to be converted and put into the byte stream.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Initialize a random seed using current time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Get current time first. Then initialize a random seed based on some basic
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mathematical operations on the hour, day, minute, second, nanosecond and year
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the current time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The random seed, initialized with current time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define NET_LIST_USER_STRUCT_S(Entry, Type, Field, Sig) \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Iterate through the double linked list. It is NOT delete safe
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for(Entry = (ListHead)->ForwardLink; Entry != (ListHead); Entry = Entry->ForwardLink)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Iterate through the double linked list. This is delete-safe.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Don't touch NextEntry. Also, don't use this macro if list
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// entries other than the Entry may be deleted when processing
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// the current Entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define NET_LIST_FOR_EACH_SAFE(Entry, NextEntry, ListHead) \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for(Entry = (ListHead)->ForwardLink, NextEntry = Entry->ForwardLink; \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Entry = NextEntry, NextEntry = Entry->ForwardLink \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Make sure the list isn't empty before getting the first/last record.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NET_LIST_USER_STRUCT((ListHead)->ForwardLink, Type, Field)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NET_LIST_USER_STRUCT((ListHead)->BackLink, Type, Field)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Remove the first node entry on the list, and return the removed node entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Removes the first node entry from a doubly linked list. It is up to the caller of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this function to release the memory used by the first node, if that is required. On
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync exit, the removed node is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Head is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Head was not initialized, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Head The list header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The first node entry that is removed from the list, NULL if the list is empty.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Remove the last node entry on the list and return the removed node entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Removes the last node entry from a doubly linked list. It is up to the caller of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this function to release the memory used by the first node, if that is required. On
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync exit, the removed node is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Head is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Head was not initialized, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Head The list head.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The last node entry that is removed from the list, NULL if the list is empty.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Insert a new node entry after a designated node entry of a doubly linked list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Inserts a new node entry designated by NewEntry after the node entry designated by PrevEntry
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the doubly linked list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] PrevEntry The entry after which to insert.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] NewEntry The new entry to insert.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Insert a new node entry before a designated node entry of a doubly linked list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Inserts a new node entry designated by NewEntry before the node entry designated by PostEntry
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the doubly linked list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] PostEntry The entry to insert before.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] NewEntry The new entry to insert.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Object container: EFI network stack spec defines various kinds of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// tokens. The drivers can share code to manage those objects.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Initialize the netmap. Netmap is a reposity to keep the <Key, Value> pairs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Initialize the forward and backward links of two head nodes donated by Map->Used
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and Map->Recycled of two doubly linked lists.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Initializes the count of the <Key, Value> pairs in the netmap to zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Map is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the address of Map->Used is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the address of Map->Recycled is NULl, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Map The netmap to initialize.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync To clean up the netmap, that is, release allocated memories.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Removes all nodes of the Used doubly linked list and frees memory of all related netmap items.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Removes all nodes of the Recycled doubly linked list and free memory of all related netmap items.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The number of the <Key, Value> pairs in the netmap is set to zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Map is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Map The netmap to clean up.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Test whether the netmap is empty and return true if it is.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the number of the <Key, Value> pairs in the netmap is zero, return TRUE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Map is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Map The net map to test.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return TRUE if the netmap is empty, otherwise FALSE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Return the number of the <Key, Value> pairs in the netmap.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Map The netmap to get the entry number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The entry number in the netmap.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Allocate an item to save the <Key, Value> pair to the head of the netmap.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Allocate an item to save the <Key, Value> pair and add corresponding node entry
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to the beginning of the Used doubly linked list. The number of the <Key, Value>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync pairs in the netmap increase by 1.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Map is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Map The netmap to insert into.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Key The user's key.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Value The user's value for the key.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The item is inserted to the head.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Allocate an item to save the <Key, Value> pair to the tail of the netmap.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Allocate an item to save the <Key, Value> pair and add corresponding node entry
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to the tail of the Used doubly linked list. The number of the <Key, Value>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync pairs in the netmap increase by 1.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Map is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Map The netmap to insert into.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Key The user's key.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Value The user's value for the key.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The item is inserted to the tail.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Finds the key in the netmap and returns the point to the item containing the Key.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Iterate the Used doubly linked list of the netmap to get every item. Compare the key of every
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync item with the key to search. It returns the point to the item contains the Key if found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Map is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Map The netmap to search within.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Key The key to search.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The point to the item contains the Key, or NULL if Key isn't in the map.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Remove the node entry of the item from the netmap and return the key of the removed item.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Remove the node entry of the item from the Used doubly linked list of the netmap.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync entry of the item to the Recycled doubly linked list of the netmap. If Value is not NULL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Value will point to the value of the item. It returns the key of the removed item.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Map is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Item is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if item in not in the netmap, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Map The netmap to remove the item from.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Item The item to remove.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Value The variable to receive the value if not NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The key of the removed item.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Remove the first node entry on the netmap and return the key of the removed item.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Remove the first node entry from the Used doubly linked list of the netmap.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync parameter Value will point to the value of the item. It returns the key of the removed item.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Map is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the Used doubly linked list is empty, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Map The netmap to remove the head from.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Value The variable to receive the value if not NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The key of the item removed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Remove the last node entry on the netmap and return the key of the removed item.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Remove the last node entry from the Used doubly linked list of the netmap.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync parameter Value will point to the value of the item. It returns the key of the removed item.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Map is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the Used doubly linked list is empty, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Map The netmap to remove the tail from.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Value The variable to receive the value if not NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The key of the item removed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Iterate through the netmap and call CallBack for each item.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync It will contiue the traverse if CallBack returns EFI_SUCCESS, otherwise, break
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync from the loop. It returns the CallBack's last return value. This function is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync delete safe for the current item.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Map is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If CallBack is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Map The Map to iterate through.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] CallBack The callback function to call for each item.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Arg The opaque parameter to the callback.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS There is no item in the netmap, or CallBack for each item
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returns EFI_SUCCESS.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval Others It returns the CallBack's last return value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Helper functions to implement driver binding and service binding protocols.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Create a child of the service that is identified by ServiceBindingGuid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Get the ServiceBinding Protocol first, then use it to create a child.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If ServiceBindingGuid is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If ChildHandle is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Controller The controller which has the service installed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Image The image handle used to open service.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ServiceBindingGuid The service's Guid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] ChildHandle The handle to receive the created child.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The child was successfully created.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval Others Failed to create the child.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Destroy a child of the service that is identified by ServiceBindingGuid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Get the ServiceBinding Protocol first, then use it to destroy a child.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If ServiceBindingGuid is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Controller The controller which has the service installed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Image The image handle used to open service.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ServiceBindingGuid The service's Guid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ChildHandle The child to destroy.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The child was destroyed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval Others Failed to destroy the child.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Get handle with Simple Network Protocol installed on it.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync There should be MNP Service Binding Protocol installed on the input ServiceHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Simple Network Protocol is already installed on the ServiceHandle, the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ServiceHandle will be returned. If SNP is not installed on the ServiceHandle,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync try to find its parent handle with SNP installed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ServiceHandle The handle where network service binding protocols are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync installed on.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Snp The pointer to store the address of the SNP instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is an optional parameter that may be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The SNP handle, or NULL if not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieve VLAN ID of a VLAN device handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Search VLAN device path node in Device Path of specified ServiceHandle and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return its VLAN ID. If no VLAN device path node found, then this ServiceHandle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is not a VLAN device handle, and 0 will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ServiceHandle The handle where network service binding protocols are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync installed on.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return VLAN ID of the device handle, or 0 if not a VLAN device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Find VLAN device handle with specified VLAN ID.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The VLAN child device handle is created by VLAN Config Protocol on ControllerHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function will append VLAN device path node to the parent device path,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and then use LocateDevicePath() to find the correct VLAN device handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ControllerHandle The handle where network service binding protocols are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync installed on.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] VlanId The configured VLAN ID for the VLAN device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The VLAN device handle, or NULL if not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Get MAC address associated with the network service handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync There should be MNP Service Binding Protocol installed on the input ServiceHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If SNP is installed on the ServiceHandle or its parent handle, MAC address will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be retrieved from SNP. If no SNP found, try to get SNP mode data use MNP.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ServiceHandle The handle where network service binding protocols are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync installed on.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] MacAddress The pointer to store the returned MAC address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] AddressSize The length of returned MAC address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS MAC address was returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval Others Failed to get SNP mode data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Convert MAC address of the NIC associated with specified Service Binding Handle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to a unicode string. Callers are responsible for freeing the string storage.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Locate simple network protocol associated with the Service Binding Handle and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync get the mac address from SNP. Then convert the mac address into a unicode
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync string. It takes 2 unicode characters to represent a 1 byte binary buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Plus one unicode character for the null-terminator.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ServiceHandle The handle where network service binding protocol is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ImageHandle The image handle used to act as the agent handle to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync get the simple network protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] MacString The pointer to store the address of the string
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync representation of the mac address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Converted the mac address a unicode string successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There are not enough memory resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval Others Failed to open the simple network protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Detect media status for specified network device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The underlying UNDI driver may or may not support reporting media status from
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync GET_STATUS command (PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED). This routine
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will try to invoke Snp->GetStatus() to get the media status. If media is already
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync present, it returns directly. If media is not present, it will stop SNP and then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync restart SNP to get the latest media status. This provides an opportunity to get
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the correct media status for old UNDI driver, which doesn't support reporting
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync media status from GET_STATUS command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Note: there are two limitations for the current algorithm:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 1) For UNDI with this capability, when the cable is not attached, there will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be an redundant Stop/Start() process.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 2) for UNDI without this capability, in case that network cable is attached when
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Snp->Initialize() is invoked while network cable is unattached later,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NetLibDetectMedia() will report MediaPresent as TRUE, causing upper layer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync apps to wait for timeout time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ServiceHandle The handle where network service binding protocols are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] MediaPresent The pointer to store the media status.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Media detection success.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER ServiceHandle is not a valid network device handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The network device does not support media detection.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR SNP is in an unknown state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Create an IPv4 device path node.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The header type of IPv4 device path node is MESSAGING_DEVICE_PATH.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The header subtype of IPv4 device path node is MSG_IPv4_DP.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The length of the IPv4 device path node in bytes is 19.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Get other information from parameters to make up the whole IPv4 device path node.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Node The pointer to the IPv4 device path node.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Controller The controller handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] LocalIp The local IPv4 address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] LocalPort The local port.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] RemoteIp The remote IPv4 address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] RemotePort The remote port.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Protocol The protocol type in the IP header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] UseDefaultAddress Whether this instance is using default address or not.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Create an IPv6 device path node.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The header type of IPv6 device path node is MESSAGING_DEVICE_PATH.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The header subtype of IPv6 device path node is MSG_IPv6_DP.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The length of the IPv6 device path node in bytes is 43.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Get other information from parameters to make up the whole IPv6 device path node.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Node The pointer to the IPv6 device path node.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Controller The controller handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] LocalIp The local IPv6 address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] LocalPort The local port.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] RemoteIp The remote IPv6 address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] RemotePort The remote port.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Protocol The protocol type in the IP header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Find the UNDI/SNP handle from controller and protocol GUID.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync For example, IP will open an MNP child to transmit/receive
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync packets. When MNP is stopped, IP should also be stopped. IP
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync needs to find its own private data that is related the IP's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync service binding instance that is installed on the UNDI/SNP handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The controller is then either an MNP or an ARP child handle. Note that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IP opens these handles using BY_DRIVER. Use that infomation to get the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Controller The protocol handle to check.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ProtocolGuid The protocol that is related with the handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The UNDI/SNP handle or NULL for errors.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is the default unload handle for all the network drivers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Disconnect the driver specified by ImageHandle from all the devices in the handle database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Uninstall all the protocols installed in the driver entry point.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ImageHandle The drivers' driver image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The image is unloaded.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval Others Failed to unload the image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Convert one Null-terminated ASCII string (decimal dotted) to EFI_IPv4_ADDRESS.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] String The pointer to the Ascii string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Ip4Address The pointer to the converted IPv4 address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Converted to an IPv4 address successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The string is malformated, or Ip4Address is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Convert one Null-terminated ASCII string to EFI_IPv6_ADDRESS. The format of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync string is defined in RFC 4291 - Text Pepresentation of Addresses.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] String The pointer to the Ascii string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Ip6Address The pointer to the converted IPv6 address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Converted to an IPv6 address successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The string is malformated, or Ip6Address is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Convert one Null-terminated Unicode string (decimal dotted) to EFI_IPv4_ADDRESS.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] String The pointer to the Ascii string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Ip4Address The pointer to the converted IPv4 address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Converted to an IPv4 address successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip4Address is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to lack of resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS. The format of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the string is defined in RFC 4291 - Text Pepresentation of Addresses.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] String The pointer to the Ascii string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Ip6Address The pointer to the converted IPv6 address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Converted to an IPv6 address successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The string is malformated or Ip6Address is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to a lack of resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS and prefix length.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The format of the string is defined in RFC 4291 - Text Pepresentation of Addresses
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] String The pointer to the Ascii string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Ip6Address The pointer to the converted IPv6 address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] PrefixLength The pointer to the converted prefix length.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Converted to an IPv6 address successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The string is malformated, or Ip6Address is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to a lack of resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Various signatures
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define NET_BUF_SIGNATURE SIGNATURE_32 ('n', 'b', 'u', 'f')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define NET_VECTOR_SIGNATURE SIGNATURE_32 ('n', 'v', 'e', 'c')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define NET_QUE_SIGNATURE SIGNATURE_32 ('n', 'b', 'q', 'u')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define NET_PROTO_DATA 64 // Opaque buffer for protocols
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define NET_BUF_HEAD 1 // Trim or allocate space from head
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define NET_BUF_TAIL 0 // Trim or allocate space from tail
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define NET_VECTOR_OWN_FIRST 0x01 // We allocated the 1st block in the vector
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT (((PData) != NULL) && ((PData)->Signature == (SIGNATURE)))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Single memory block in the vector.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef VOID (EFIAPI *NET_VECTOR_EXT_FREE) (VOID *Arg);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//NET_VECTOR contains several blocks to hold all packet's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//fragments and other house-keeping stuff for sharing. It
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//doesn't specify the where actual packet fragment begins.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync INTN RefCnt; // Reference count to share NET_VECTOR.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NET_VECTOR_EXT_FREE Free; // external function to free NET_VECTOR
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 Len; // Total length of the assocated BLOCKs
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//NET_BLOCK_OP operates on the NET_BLOCK. It specifies
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//where the actual fragment begins and ends
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 *BlockHead; // Block's head, or the smallest valid Head
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 *BlockTail; // Block's tail. BlockTail-BlockHead=block length
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 *Tail; // Tail of the data in the block, Tail-Head=Size
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef union {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//NET_BUF is the buffer manage structure used by the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//network stack. Every network packet may be fragmented. The Vector points to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//memory blocks used by each fragment, and BlockOp
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//specifies where each fragment begins and ends.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//It also contains an opaque area for the protocol to store
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//per-packet information. Protocol must be careful not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//to overwrite the members after that.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NET_IP_HEAD Ip; // Network layer header, for fast access
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TCP_HEAD *Tcp; // Transport layer header, for fast access
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_UDP_HEADER *Udp; // User Datagram Protocol header
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 ProtoData [NET_PROTO_DATA]; //Protocol specific data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NET_VECTOR *Vector; // The vector containing the packet
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 BlockOpNum; // Total number of BlockOp in the buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 TotalSize; // Total size of the actual packet
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NET_BLOCK_OP BlockOp[1]; // Specify the position of actual packet
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//A queue of NET_BUFs. It is a thin extension of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//NET_BUF functions.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync LIST_ENTRY List; // The List this buffer queue is on
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 BufSize; // total length of DATA in the buffers
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 BufNum; // total number of buffers on the chain
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Pseudo header for TCP and UDP checksum
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// The fragment entry table used in network interfaces. This is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// the same as NET_BLOCK now. Use two different to distinguish
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// the two in case that NET_BLOCK be enhanced later.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define NETBUF_FROM_PROTODATA(Info) BASE_CR((Info), NET_BUF, ProtoData)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (((Buf)->RefCnt > 1) || ((Buf)->Vector->RefCnt > 1))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (sizeof (NET_VECTOR) + ((BlockNum) - 1) * sizeof (NET_BLOCK))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (sizeof (NET_BUF) + ((BlockOpNum) - 1) * sizeof (NET_BLOCK_OP))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Allocate a single block NET_BUF. Upon allocation, all the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync free space is in the tail room.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Len The length of the block.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The pointer to the allocated NET_BUF, or NULL if the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync allocation failed due to resource limitations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Free the net buffer and its associated NET_VECTOR.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Decrease the reference count of the net buffer by one. Free the associated net
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync vector and itself if the reference count of the net buffer is decreased to 0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The net vector free operation decreases the reference count of the net
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync vector by one, and performs the resource free operation when the reference count
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the net vector is 0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Nbuf The pointer to the NET_BUF to be freed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Get the index of NET_BLOCK_OP that contains the byte at Offset in the net
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync For example, this function can be used to retrieve the IP header in the packet. It
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync also can be used to get the fragment that contains the byte used
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mainly by the library implementation itself.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Nbuf The pointer to the net buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Offset The offset of the byte.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Index Index of the NET_BLOCK_OP that contains the byte at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The pointer to the Offset'th byte of data in the net buffer, or NULL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if there is no such data in the net buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Create a copy of the net buffer that shares the associated net vector.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The reference count of the newly created net buffer is set to 1. The reference
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync count of the associated net vector is increased by one.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Nbuf The pointer to the net buffer to be cloned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The pointer to the cloned net buffer, or NULL if the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync allocation failed due to resource limitations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Create a duplicated copy of the net buffer with data copied and HeadSpace
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync bytes of head space reserved.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The duplicated net buffer will allocate its own memory to hold the data of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync source net buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Nbuf The pointer to the net buffer to be duplicated from.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Duplicate The pointer to the net buffer to duplicate to. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NULL, a new net buffer is allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] HeadSpace The length of the head space to reserve.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The pointer to the duplicated net buffer, or NULL if
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the allocation failed due to resource limitations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Create a NET_BUF structure which contains Len byte data of Nbuf starting from
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync A new NET_BUF structure will be created but the associated data in NET_VECTOR
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is shared. This function exists to perform IP packet fragmentation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Nbuf The pointer to the net buffer to be extracted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Offset Starting point of the data to be included in the new
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync net buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Len The bytes of data to be included in the new net buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] HeadSpace The bytes of the head space to reserve for the protocol header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The pointer to the cloned net buffer, or NULL if the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync allocation failed due to resource limitations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Reserve some space in the header room of the net buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Upon allocation, all the space is in the tail room of the buffer. Call this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync function to move space to the header room. This function is quite limited
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in that it can only reserve space from the first block of an empty NET_BUF not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync built from the external. However, it should be enough for the network stack.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Nbuf The pointer to the net buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Len The length of buffer to be reserved from the header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Allocate Len bytes of space from the header or tail of the buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Nbuf The pointer to the net buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Len The length of the buffer to be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FromHead The flag to indicate whether to reserve the data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync from head (TRUE) or tail (FALSE).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The pointer to the first byte of the allocated buffer,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or NULL, if there is no sufficient space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Trim Len bytes from the header or the tail of the net buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Nbuf The pointer to the net buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Len The length of the data to be trimmed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FromHead The flag to indicate whether trim data is from the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync head (TRUE) or the tail (FALSE).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The length of the actual trimmed data, which may be less
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync than Len if the TotalSize of Nbuf is less than Len.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copy Len bytes of data from the specific offset of the net buffer to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync destination memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Len bytes of data may cross several fragments of the net buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Nbuf The pointer to the net buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Offset The sequence number of the first byte to copy.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Len The length of the data to copy.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Dest The destination of the data to copy to.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The length of the actual copied data, or 0 if the offset
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified exceeds the total size of net buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Build a NET_BUF from external blocks.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync A new NET_BUF structure will be created from external blocks. An additional block
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of memory will be allocated to hold reserved HeadSpace bytes of header room
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and existing HeadLen bytes of header, but the external blocks are shared by the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync net buffer to avoid data copying.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ExtFragment The pointer to the data block.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ExtNum The number of the data blocks.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] HeadSpace The head space to be reserved.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] HeadLen The length of the protocol header. The function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync pulls this amount of data into a linear block.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ExtFree The pointer to the caller-provided free function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Arg The argument passed to ExtFree when ExtFree is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The pointer to the net buffer built from the data blocks,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or NULL if the allocation failed due to resource
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Build a fragment table to contain the fragments in the net buffer. This is the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync opposite operation of the NetbufFromExt.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Nbuf Points to the net buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] ExtFragment The pointer to the data block.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] ExtNum The number of the data blocks.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL The number of non-empty blocks is bigger than
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The fragment table was built successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Build a net buffer from a list of net buffers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync All the fragments will be collected from the list of NEW_BUF, and then a new
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync net buffer will be created through NetbufFromExt.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] BufList A List of the net buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] HeadSpace The head space to be reserved.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] HeaderLen The length of the protocol header. The function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync pulls this amount of data into a linear block.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ExtFree The pointer to the caller provided free function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Arg The argument passed to ExtFree when ExtFree is called.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The pointer to the net buffer built from the list of net
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Free a list of net buffers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Head The pointer to the head of linked net buffers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Initiate the net buffer queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] NbufQue The pointer to the net buffer queue to be initialized.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Allocate and initialize a net buffer queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The pointer to the allocated net buffer queue, or NULL if the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync allocation failed due to resource limit.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Free a net buffer queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Decrease the reference count of the net buffer queue by one. The real resource
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync free operation isn't performed until the reference count of the net buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync queue is decreased to 0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] NbufQue The pointer to the net buffer queue to be freed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Remove a net buffer from the head in the specific queue and return it.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] NbufQue The pointer to the net buffer queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The pointer to the net buffer removed from the specific queue,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or NULL if there is no net buffer in the specific queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Append a net buffer to the net buffer queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] NbufQue The pointer to the net buffer queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Nbuf The pointer to the net buffer to be appended.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copy Len bytes of data from the net buffer queue at the specific offset to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync destination memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The copying operation is the same as NetbufCopy, but applies to the net buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync queue instead of the net buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] NbufQue The pointer to the net buffer queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Offset The sequence number of the first byte to copy.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Len The length of the data to copy.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Dest The destination of the data to copy to.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The length of the actual copied data, or 0 if the offset
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified exceeds the total size of net buffer queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Trim Len bytes of data from the buffer queue and free any net buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync that is completely trimmed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The trimming operation is the same as NetbufTrim but applies to the net buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync queue instead of the net buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] NbufQue The pointer to the net buffer queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Len The length of the data to trim.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The actual length of the data trimmed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Flush the net buffer queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] NbufQue The pointer to the queue to be flushed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Compute the checksum for a bulk of data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Bulk The pointer to the data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Len The length of the data, in bytes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The computed checksum.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Add two checksums.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Checksum1 The first checksum to be added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Checksum2 The second checksum to be added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The new checksum.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Compute the checksum for a NET_BUF.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Nbuf The pointer to the net buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The computed checksum.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Compute the checksum for TCP/UDP pseudo header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Src and Dst are in network byte order, and Len is in host byte order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Src The source address of the packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Dst The destination address of the packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Proto The protocol type of the packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Len The length of the packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The computed checksum.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Compute the checksum for the TCP6/UDP6 pseudo header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Src and Dst are in network byte order, and Len is in host byte order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Src The source address of the packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Dst The destination address of the packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] NextHeader The protocol type of the packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Len The length of the packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The computed checksum.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The function frees the net buffer which allocated by the IP protocol. It releases
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync only the net buffer and doesn't call the external free function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function should be called after finishing the process of mIpSec->ProcessExt()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for outbound traffic. The (EFI_IPSEC2_PROTOCOL)->ProcessExt() allocates a new
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync buffer for the ESP, so there needs a function to free the old net buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Nbuf The network buffer to be freed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function obtains the system guid from the smbios table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] SystemGuid The pointer of the returned system guid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Successfully obtained the system guid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND Did not find the SMBIOS table.