MdeModulePkg/Include/Library/NetLib.h File Reference


Data Structures

struct  ETHER_HEAD
union  VLAN_TCI
struct  IP4_HEAD
struct  IP4_ICMP_HEAD
struct  IP4_ICMP_ERROR_HEAD
struct  IP4_ICMP_QUERY_HEAD
struct  IP6_ICMP_HEAD
struct  IP6_ICMP_ERROR_HEAD
struct  IP6_ICMP_INFORMATION_HEAD
struct  EFI_UDP_HEADER
struct  TCP_HEAD
struct  NET_MAP_ITEM
struct  NET_MAP
struct  NET_BLOCK
struct  NET_VECTOR
struct  NET_BLOCK_OP
union  NET_IP_HEAD
struct  NET_BUF
struct  NET_BUF_QUEUE
struct  NET_PSEUDO_HDR
struct  NET_IP6_PSEUDO_HDR
struct  NET_FRAGMENT

Defines

#define NET_ETHER_ADDR_LEN   6
#define NET_IFTYPE_ETHERNET   0x01
#define NET_VLAN_TAG_LEN   4
#define ETHER_TYPE_VLAN   0x8100
#define EFI_IP_PROTO_UDP   0x11
#define EFI_IP_PROTO_TCP   0x06
#define EFI_IP_PROTO_ICMP   0x01
#define IP4_PROTO_IGMP   0x02
#define IP6_ICMP   58
#define IP4_ADDR_CLASSA   1
#define IP4_ADDR_CLASSB   2
#define IP4_ADDR_CLASSC   3
#define IP4_ADDR_CLASSD   4
#define IP4_ADDR_CLASSE   5
#define IP4_MASK_NUM   33
#define IP6_PREFIX_NUM   129
#define IP6_HOP_BY_HOP   0
#define IP6_DESTINATION   60
#define IP6_ROUTING   43
#define IP6_FRAGMENT   44
#define IP6_AH   51
#define IP6_ESP   50
#define IP6_NO_NEXT_HEADER   59
#define IP_VERSION_4   4
#define IP_VERSION_6   6
#define IP6_PREFIX_LENGTH   64
#define VLAN_TCI_CFI_CANONICAL_MAC   0
#define VLAN_TCI_CFI_NON_CANONICAL_MAC   1
#define NET_MAC_EQUAL(pMac1, pMac2, Len)   (CompareMem ((pMac1), (pMac2), Len) == 0)
#define NET_MAC_IS_MULTICAST(Mac, BMac, Len)   (((*((UINT8 *) Mac) & 0x01) == 0x01) && (!NET_MAC_EQUAL (Mac, BMac, Len)))
#define NTOHL(x)   SwapBytes32 (x)
#define HTONL(x)   NTOHL(x)
#define NTOHS(x)   SwapBytes16 (x)
#define HTONS(x)   NTOHS(x)
#define NTOHLL(x)   SwapBytes64 (x)
#define HTONLL(x)   NTOHLL(x)
#define NTOHLLL(x)   Ip6Swap128 (x)
#define HTONLLL(x)   NTOHLLL(x)
#define IP4_IS_MULTICAST(Ip)   (((Ip) & 0xF0000000) == 0xE0000000)
#define IP4_IS_LOCAL_BROADCAST(Ip)   ((Ip) == 0xFFFFFFFF)
#define IP4_NET_EQUAL(Ip1, Ip2, NetMask)   (((Ip1) & (NetMask)) == ((Ip2) & (NetMask)))
#define IP4_IS_VALID_NETMASK(Ip)   (NetGetMaskLength (Ip) != IP4_MASK_NUM)
#define IP6_IS_MULTICAST(Ip6)   (((Ip6)->Addr[0]) == 0xFF)
#define EFI_IP4(EfiIpAddr)   (*(IP4_ADDR *) ((EfiIpAddr).Addr))
#define EFI_NTOHL(EfiIp)   (NTOHL (EFI_IP4 ((EfiIp))))
#define EFI_IP4_EQUAL(Ip1, Ip2)   (CompareMem ((Ip1), (Ip2), sizeof (EFI_IPv4_ADDRESS)) == 0)
#define EFI_IP6_EQUAL(Ip1, Ip2)   (CompareMem ((Ip1), (Ip2), sizeof (EFI_IPv6_ADDRESS)) == 0)
#define IP4_COPY_ADDRESS(Dest, Src)   (CopyMem ((Dest), (Src), sizeof (EFI_IPv4_ADDRESS)))
#define IP6_COPY_ADDRESS(Dest, Src)   (CopyMem ((Dest), (Src), sizeof (EFI_IPv6_ADDRESS)))
#define IP6_COPY_LINK_ADDRESS(Mac1, Mac2)   (CopyMem ((Mac1), (Mac2), sizeof (EFI_MAC_ADDRESS)))
#define NETDEBUG_LEVEL_TRACE   5
#define NETDEBUG_LEVEL_WARNING   4
#define NETDEBUG_LEVEL_ERROR   3
#define NET_SYSLOG_FACILITY   16
#define NET_SYSLOG_PACKET_LEN   512
#define NET_SYSLOG_TX_TIMEOUT   (500 * 1000 * 10)
#define NET_DEBUG_MSG_LEN   470
#define NET_DEBUG_TRACE(Module, PrintArg)
#define NET_DEBUG_WARNING(Module, PrintArg)
#define NET_DEBUG_ERROR(Module, PrintArg)
#define NET_IS_DIGIT(Ch)   (('0' <= (Ch)) && ((Ch) <= '9'))
#define NET_ROUNDUP(size, unit)   (((size) + (unit) - 1) & (~((unit) - 1)))
#define NET_IS_LOWER_CASE_CHAR(Ch)   (('a' <= (Ch)) && ((Ch) <= 'z'))
#define NET_IS_UPPER_CASE_CHAR(Ch)   (('A' <= (Ch)) && ((Ch) <= 'Z'))
#define TICKS_PER_MS   10000U
#define TICKS_PER_SECOND   10000000U
#define NET_RANDOM(Seed)   ((UINT32) ((UINT32) (Seed) * 1103515245UL + 12345) % 4294967295UL)
#define NET_LIST_USER_STRUCT(Entry, Type, Field)   BASE_CR(Entry, Type, Field)
#define NET_LIST_USER_STRUCT_S(Entry, Type, Field, Sig)   CR(Entry, Type, Field, Sig)
#define NET_LIST_FOR_EACH(Entry, ListHead)   for(Entry = (ListHead)->ForwardLink; Entry != (ListHead); Entry = Entry->ForwardLink)
#define NET_LIST_FOR_EACH_SAFE(Entry, NextEntry, ListHead)
#define NET_LIST_HEAD(ListHead, Type, Field)   NET_LIST_USER_STRUCT((ListHead)->ForwardLink, Type, Field)
#define NET_LIST_TAIL(ListHead, Type, Field)   NET_LIST_USER_STRUCT((ListHead)->BackLink, Type, Field)
#define NET_MAP_INCREAMENT   64
#define NET_BUF_SIGNATURE   SIGNATURE_32 ('n', 'b', 'u', 'f')
#define NET_VECTOR_SIGNATURE   SIGNATURE_32 ('n', 'v', 'e', 'c')
#define NET_QUE_SIGNATURE   SIGNATURE_32 ('n', 'b', 'q', 'u')
#define NET_PROTO_DATA   64
#define NET_BUF_HEAD   1
#define NET_BUF_TAIL   0
#define NET_VECTOR_OWN_FIRST   0x01
#define NET_CHECK_SIGNATURE(PData, SIGNATURE)   ASSERT (((PData) != NULL) && ((PData)->Signature == (SIGNATURE)))
#define NET_GET_REF(PData)   ((PData)->RefCnt++)
#define NET_PUT_REF(PData)   ((PData)->RefCnt--)
#define NETBUF_FROM_PROTODATA(Info)   BASE_CR((Info), NET_BUF, ProtoData)
#define NET_BUF_SHARED(Buf)   (((Buf)->RefCnt > 1) || ((Buf)->Vector->RefCnt > 1))
#define NET_VECTOR_SIZE(BlockNum)   (sizeof (NET_VECTOR) + ((BlockNum) - 1) * sizeof (NET_BLOCK))
#define NET_BUF_SIZE(BlockOpNum)   (sizeof (NET_BUF) + ((BlockOpNum) - 1) * sizeof (NET_BLOCK_OP))
#define NET_HEADSPACE(BlockOp)   (UINTN)((BlockOp)->Head - (BlockOp)->BlockHead)
#define NET_TAILSPACE(BlockOp)   (UINTN)((BlockOp)->BlockTail - (BlockOp)->Tail)

Typedefs

typedef UINT32 IP4_ADDR
typedef UINT32 TCP_SEQNO
typedef UINT16 TCP_PORTNO
typedef IN VOID * Context
typedef IN NET_MAP_ITEMItem
typedef IN NET_MAP_ITEM IN VOID * Arg

Functions

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)
UINT32 EFIAPI NetGetUint32 (IN UINT8 *Buf)
VOID EFIAPI NetPutUint32 (IN OUT UINT8 *Buf, IN UINT32 Data)
UINT32 EFIAPI NetRandomInitSeed (VOID)
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)
typedef EFI_STATUS (EFIAPI *NET_DESTROY_LINK_LIST_CALLBACK)(IN LIST_ENTRY *Entry
EFI_STATUS EFIAPI NetDestroyLinkList (IN LIST_ENTRY *List, IN NET_DESTROY_LINK_LIST_CALLBACK CallBack, IN VOID *Context, OUT UINTN *ListLength)
BOOLEAN EFIAPI NetIsInHandleBuffer (IN EFI_HANDLE Handle, IN UINTN NumberOfChildren, IN EFI_HANDLE *ChildHandleBuffer)
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)
EFI_STATUS EFIAPI NetMapInsertHead (IN OUT NET_MAP *Map, IN VOID *Key, IN VOID *Value)
EFI_STATUS EFIAPI NetMapInsertTail (IN OUT NET_MAP *Map, IN VOID *Key, IN VOID *Value)
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)
VOID *EFIAPI NetMapRemoveHead (IN OUT NET_MAP *Map, OUT VOID **Value)
VOID *EFIAPI NetMapRemoveTail (IN OUT NET_MAP *Map, OUT VOID **Value)
EFI_STATUS EFIAPI NetMapIterate (IN NET_MAP *Map, IN NET_MAP_CALLBACK CallBack, IN VOID *Arg)
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)
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, OUT CHAR16 **MacString)
EFI_STATUS EFIAPI NetLibDetectMedia (IN EFI_HANDLE ServiceHandle, OUT BOOLEAN *MediaPresent)
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 NetLibDefaultUnload (IN EFI_HANDLE ImageHandle)
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)
typedef VOID (EFIAPI *NET_VECTOR_EXT_FREE)(VOID *Arg)
NET_BUF *EFIAPI NetbufAlloc (IN UINT32 Len)
VOID EFIAPI NetbufFree (IN NET_BUF *Nbuf)
UINT8 *EFIAPI NetbufGetByte (IN NET_BUF *Nbuf, IN UINT32 Offset, OUT UINT32 *Index)
NET_BUF *EFIAPI NetbufClone (IN NET_BUF *Nbuf)
NET_BUF *EFIAPI NetbufDuplicate (IN NET_BUF *Nbuf, IN OUT NET_BUF *Duplicate, IN UINT32 HeadSpace)
NET_BUF *EFIAPI NetbufGetFragment (IN NET_BUF *Nbuf, IN UINT32 Offset, IN UINT32 Len, IN UINT32 HeadSpace)
VOID EFIAPI NetbufReserve (IN OUT NET_BUF *Nbuf, IN UINT32 Len)
UINT8 *EFIAPI NetbufAllocSpace (IN OUT NET_BUF *Nbuf, IN UINT32 Len, IN BOOLEAN FromHead)
UINT32 EFIAPI NetbufTrim (IN OUT NET_BUF *Nbuf, IN UINT32 Len, IN BOOLEAN FromHead)
UINT32 EFIAPI NetbufCopy (IN NET_BUF *Nbuf, IN UINT32 Offset, IN UINT32 Len, IN UINT8 *Dest)
NET_BUF *EFIAPI NetbufFromExt (IN NET_FRAGMENT *ExtFragment, IN UINT32 ExtNum, IN UINT32 HeadSpace, IN UINT32 HeadLen, IN NET_VECTOR_EXT_FREE ExtFree, IN VOID *Arg)
EFI_STATUS EFIAPI NetbufBuildExt (IN NET_BUF *Nbuf, IN OUT NET_FRAGMENT *ExtFragment, IN OUT UINT32 *ExtNum)
NET_BUF *EFIAPI NetbufFromBufList (IN LIST_ENTRY *BufList, IN UINT32 HeadSpace, IN UINT32 HeaderLen, IN NET_VECTOR_EXT_FREE ExtFree, IN VOID *Arg)
VOID EFIAPI NetbufFreeList (IN OUT LIST_ENTRY *Head)
VOID EFIAPI NetbufQueInit (IN OUT NET_BUF_QUEUE *NbufQue)
NET_BUF_QUEUE *EFIAPI NetbufQueAlloc (VOID)
VOID EFIAPI NetbufQueFree (IN NET_BUF_QUEUE *NbufQue)
NET_BUF *EFIAPI NetbufQueRemove (IN OUT NET_BUF_QUEUE *NbufQue)
VOID EFIAPI NetbufQueAppend (IN OUT NET_BUF_QUEUE *NbufQue, IN OUT NET_BUF *Nbuf)
UINT32 EFIAPI NetbufQueCopy (IN NET_BUF_QUEUE *NbufQue, IN UINT32 Offset, IN UINT32 Len, OUT UINT8 *Dest)
UINT32 EFIAPI NetbufQueTrim (IN OUT NET_BUF_QUEUE *NbufQue, IN UINT32 Len)
VOID EFIAPI NetbufQueFlush (IN OUT NET_BUF_QUEUE *NbufQue)
UINT16 EFIAPI NetblockChecksum (IN UINT8 *Bulk, IN UINT32 Len)
UINT16 EFIAPI NetAddChecksum (IN UINT16 Checksum1, IN UINT16 Checksum2)
UINT16 EFIAPI NetbufChecksum (IN NET_BUF *Nbuf)
UINT16 EFIAPI NetPseudoHeadChecksum (IN IP4_ADDR Src, IN IP4_ADDR Dst, IN UINT8 Proto, IN UINT16 Len)
UINT16 EFIAPI NetIp6PseudoHeadChecksum (IN EFI_IPv6_ADDRESS *Src, IN EFI_IPv6_ADDRESS *Dst, IN UINT8 NextHeader, IN UINT32 Len)
VOID NetIpSecNetbufFree (NET_BUF *Nbuf)
EFI_STATUS EFIAPI NetLibGetSystemGuid (OUT EFI_GUID *SystemGuid)

Variables

IP4_ADDR gIp4AllMasks [IP4_MASK_NUM]
EFI_IPv4_ADDRESS mZeroIp4Addr

Detailed Description

This library is only intended to be used by UEFI network stack modules. It provides basic functions for the UEFI network stack.

Copyright (c) 2005 - 2012, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


Define Documentation

#define EFI_IP4 ( EfiIpAddr   )     (*(IP4_ADDR *) ((EfiIpAddr).Addr))

#define EFI_IP4_EQUAL ( Ip1,
Ip2   )     (CompareMem ((Ip1), (Ip2), sizeof (EFI_IPv4_ADDRESS)) == 0)

#define EFI_IP6_EQUAL ( Ip1,
Ip2   )     (CompareMem ((Ip1), (Ip2), sizeof (EFI_IPv6_ADDRESS)) == 0)

#define EFI_IP_PROTO_ICMP   0x01

#define EFI_IP_PROTO_TCP   0x06

#define EFI_IP_PROTO_UDP   0x11

#define EFI_NTOHL ( EfiIp   )     (NTOHL (EFI_IP4 ((EfiIp))))

#define ETHER_TYPE_VLAN   0x8100

#define HTONL (  )     NTOHL(x)

#define HTONLL (  )     NTOHLL(x)

#define HTONLLL (  )     NTOHLLL(x)

#define HTONS (  )     NTOHS(x)

#define IP4_ADDR_CLASSA   1

#define IP4_ADDR_CLASSB   2

#define IP4_ADDR_CLASSC   3

#define IP4_ADDR_CLASSD   4

#define IP4_ADDR_CLASSE   5

#define IP4_COPY_ADDRESS ( Dest,
Src   )     (CopyMem ((Dest), (Src), sizeof (EFI_IPv4_ADDRESS)))

#define IP4_IS_LOCAL_BROADCAST ( Ip   )     ((Ip) == 0xFFFFFFFF)

#define IP4_IS_MULTICAST ( Ip   )     (((Ip) & 0xF0000000) == 0xE0000000)

#define IP4_IS_VALID_NETMASK ( Ip   )     (NetGetMaskLength (Ip) != IP4_MASK_NUM)

#define IP4_MASK_NUM   33

#define IP4_NET_EQUAL ( Ip1,
Ip2,
NetMask   )     (((Ip1) & (NetMask)) == ((Ip2) & (NetMask)))

#define IP4_PROTO_IGMP   0x02

#define IP6_AH   51

#define IP6_COPY_ADDRESS ( Dest,
Src   )     (CopyMem ((Dest), (Src), sizeof (EFI_IPv6_ADDRESS)))

#define IP6_COPY_LINK_ADDRESS ( Mac1,
Mac2   )     (CopyMem ((Mac1), (Mac2), sizeof (EFI_MAC_ADDRESS)))

#define IP6_DESTINATION   60

#define IP6_ESP   50

#define IP6_FRAGMENT   44

#define IP6_HOP_BY_HOP   0

#define IP6_ICMP   58

#define IP6_IS_MULTICAST ( Ip6   )     (((Ip6)->Addr[0]) == 0xFF)

#define IP6_NO_NEXT_HEADER   59

#define IP6_PREFIX_LENGTH   64

#define IP6_PREFIX_NUM   129

#define IP6_ROUTING   43

#define IP_VERSION_4   4

#define IP_VERSION_6   6

#define NET_BUF_HEAD   1

#define NET_BUF_SHARED ( Buf   )     (((Buf)->RefCnt > 1) || ((Buf)->Vector->RefCnt > 1))

#define NET_BUF_SIGNATURE   SIGNATURE_32 ('n', 'b', 'u', 'f')

#define NET_BUF_SIZE ( BlockOpNum   )     (sizeof (NET_BUF) + ((BlockOpNum) - 1) * sizeof (NET_BLOCK_OP))

#define NET_BUF_TAIL   0

#define NET_CHECK_SIGNATURE ( PData,
SIGNATURE   )     ASSERT (((PData) != NULL) && ((PData)->Signature == (SIGNATURE)))

#define NET_DEBUG_ERROR ( Module,
PrintArg   ) 

Value:

NetDebugOutput ( \
    NETDEBUG_LEVEL_ERROR, \
    Module, \
    __FILE__, \
    __LINE__, \
    NetDebugASPrint PrintArg \
    )

#define NET_DEBUG_MSG_LEN   470

#define NET_DEBUG_TRACE ( Module,
PrintArg   ) 

Value:

NetDebugOutput ( \
    NETDEBUG_LEVEL_TRACE, \
    Module, \
    __FILE__, \
    __LINE__, \
    NetDebugASPrint PrintArg \
    )

#define NET_DEBUG_WARNING ( Module,
PrintArg   ) 

Value:

NetDebugOutput ( \
    NETDEBUG_LEVEL_WARNING, \
    Module, \
    __FILE__, \
    __LINE__, \
    NetDebugASPrint PrintArg \
    )

#define NET_ETHER_ADDR_LEN   6

#define NET_GET_REF ( PData   )     ((PData)->RefCnt++)

#define NET_HEADSPACE ( BlockOp   )     (UINTN)((BlockOp)->Head - (BlockOp)->BlockHead)

#define NET_IFTYPE_ETHERNET   0x01

#define NET_IS_DIGIT ( Ch   )     (('0' <= (Ch)) && ((Ch) <= '9'))

#define NET_IS_LOWER_CASE_CHAR ( Ch   )     (('a' <= (Ch)) && ((Ch) <= 'z'))

#define NET_IS_UPPER_CASE_CHAR ( Ch   )     (('A' <= (Ch)) && ((Ch) <= 'Z'))

#define NET_LIST_FOR_EACH ( Entry,
ListHead   )     for(Entry = (ListHead)->ForwardLink; Entry != (ListHead); Entry = Entry->ForwardLink)

#define NET_LIST_FOR_EACH_SAFE ( Entry,
NextEntry,
ListHead   ) 

Value:

for(Entry = (ListHead)->ForwardLink, NextEntry = Entry->ForwardLink; \
      Entry != (ListHead); \
      Entry = NextEntry, NextEntry = Entry->ForwardLink \
     )

#define NET_LIST_HEAD ( ListHead,
Type,
Field   )     NET_LIST_USER_STRUCT((ListHead)->ForwardLink, Type, Field)

#define NET_LIST_TAIL ( ListHead,
Type,
Field   )     NET_LIST_USER_STRUCT((ListHead)->BackLink, Type, Field)

#define NET_LIST_USER_STRUCT ( Entry,
Type,
Field   )     BASE_CR(Entry, Type, Field)

#define NET_LIST_USER_STRUCT_S ( Entry,
Type,
Field,
Sig   )     CR(Entry, Type, Field, Sig)

#define NET_MAC_EQUAL ( pMac1,
pMac2,
Len   )     (CompareMem ((pMac1), (pMac2), Len) == 0)

#define NET_MAC_IS_MULTICAST ( Mac,
BMac,
Len   )     (((*((UINT8 *) Mac) & 0x01) == 0x01) && (!NET_MAC_EQUAL (Mac, BMac, Len)))

#define NET_MAP_INCREAMENT   64

#define NET_PROTO_DATA   64

#define NET_PUT_REF ( PData   )     ((PData)->RefCnt--)

#define NET_QUE_SIGNATURE   SIGNATURE_32 ('n', 'b', 'q', 'u')

#define NET_RANDOM ( Seed   )     ((UINT32) ((UINT32) (Seed) * 1103515245UL + 12345) % 4294967295UL)

#define NET_ROUNDUP ( size,
unit   )     (((size) + (unit) - 1) & (~((unit) - 1)))

#define NET_SYSLOG_FACILITY   16

#define NET_SYSLOG_PACKET_LEN   512

#define NET_SYSLOG_TX_TIMEOUT   (500 * 1000 * 10)

#define NET_TAILSPACE ( BlockOp   )     (UINTN)((BlockOp)->BlockTail - (BlockOp)->Tail)

#define NET_VECTOR_OWN_FIRST   0x01

#define NET_VECTOR_SIGNATURE   SIGNATURE_32 ('n', 'v', 'e', 'c')

#define NET_VECTOR_SIZE ( BlockNum   )     (sizeof (NET_VECTOR) + ((BlockNum) - 1) * sizeof (NET_BLOCK))

#define NET_VLAN_TAG_LEN   4

#define NETBUF_FROM_PROTODATA ( Info   )     BASE_CR((Info), NET_BUF, ProtoData)

#define NETDEBUG_LEVEL_ERROR   3

#define NETDEBUG_LEVEL_TRACE   5

#define NETDEBUG_LEVEL_WARNING   4

#define NTOHL (  )     SwapBytes32 (x)

#define NTOHLL (  )     SwapBytes64 (x)

#define NTOHLLL (  )     Ip6Swap128 (x)

#define NTOHS (  )     SwapBytes16 (x)

#define TICKS_PER_MS   10000U

#define TICKS_PER_SECOND   10000000U

#define VLAN_TCI_CFI_CANONICAL_MAC   0

#define VLAN_TCI_CFI_NON_CANONICAL_MAC   1


Typedef Documentation

typedef IN NET_MAP_ITEM IN VOID* Arg

typedef IN VOID* Context

typedef UINT32 IP4_ADDR

typedef IN NET_MAP_ITEM* Item

typedef UINT16 TCP_PORTNO

typedef UINT32 TCP_SEQNO


Function Documentation

typedef EFI_STATUS ( EFIAPI *  NET_DESTROY_LINK_LIST_CALLBACK  ) 

Callback function which provided by user to remove one node in NetDestroyLinkList process.

Parameters:
[in] Entry The entry to be removed.
[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList.
Return values:
EFI_SUCCESS The entry has been removed successfully.
Others Fail to remove the entry.

EFI_IPv6_ADDRESS* EFIAPI Ip6Swap128 ( EFI_IPv6_ADDRESS *  Ip6  ) 

Switches the endianess of an IPv6 address.

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.

UINT16 EFIAPI NetAddChecksum ( IN UINT16  Checksum1,
IN UINT16  Checksum2 
)

Add two checksums.

Parameters:
[in] Checksum1 The first checksum to be added.
[in] Checksum2 The second checksum to be added.
Returns:
The new checksum.

UINT16 EFIAPI NetblockChecksum ( IN UINT8 *  Bulk,
IN UINT32  Len 
)

Compute the checksum for a bulk of data.

Parameters:
[in] Bulk The pointer to the data.
[in] Len The length of the data, in bytes.
Returns:
The computed checksum.

NET_BUF* EFIAPI NetbufAlloc ( IN UINT32  Len  ) 

Allocate a single block NET_BUF. Upon allocation, all the free space is in the tail room.

Parameters:
[in] Len The length of the block.
Returns:
The pointer to the allocated NET_BUF, or NULL if the allocation failed due to resource limitations.

UINT8* EFIAPI NetbufAllocSpace ( IN OUT NET_BUF Nbuf,
IN UINT32  Len,
IN BOOLEAN  FromHead 
)

Allocate Len bytes of space from the header or tail of the buffer.

Parameters:
[in,out] Nbuf The pointer to the net buffer.
[in] Len The length of the buffer to be allocated.
[in] FromHead The flag to indicate whether to reserve the data from head (TRUE) or tail (FALSE).
Returns:
The pointer to the first byte of the allocated buffer, or NULL, if there is no sufficient space.

EFI_STATUS EFIAPI NetbufBuildExt ( IN NET_BUF Nbuf,
IN OUT NET_FRAGMENT ExtFragment,
IN OUT UINT32 *  ExtNum 
)

Build a fragment table to contain the fragments in the net buffer. This is the opposite operation of the NetbufFromExt.

Parameters:
[in] Nbuf Points to the net buffer.
[in,out] ExtFragment The pointer to the data block.
[in,out] ExtNum The number of the data blocks.
Return values:
EFI_BUFFER_TOO_SMALL The number of non-empty blocks is bigger than ExtNum.
EFI_SUCCESS The fragment table was built successfully.

UINT16 EFIAPI NetbufChecksum ( IN NET_BUF Nbuf  ) 

Compute the checksum for a NET_BUF.

Parameters:
[in] Nbuf The pointer to the net buffer.
Returns:
The computed checksum.

NET_BUF* EFIAPI NetbufClone ( IN NET_BUF Nbuf  ) 

Create a copy of the net buffer that shares the associated net vector.

The reference count of the newly created net buffer is set to 1. The reference count of the associated net vector is increased by one.

Parameters:
[in] Nbuf The pointer to the net buffer to be cloned.
Returns:
The pointer to the cloned net buffer, or NULL if the allocation failed due to resource limitations.

UINT32 EFIAPI NetbufCopy ( IN NET_BUF Nbuf,
IN UINT32  Offset,
IN UINT32  Len,
IN UINT8 *  Dest 
)

Copy Len bytes of data from the specific offset of the net buffer to the destination memory.

The Len bytes of data may cross several fragments of the net buffer.

Parameters:
[in] Nbuf The pointer to the net buffer.
[in] Offset The sequence number of the first byte to copy.
[in] Len The length of the data to copy.
[in] Dest The destination of the data to copy to.
Returns:
The length of the actual copied data, or 0 if the offset specified exceeds the total size of net buffer.

NET_BUF* EFIAPI NetbufDuplicate ( IN NET_BUF Nbuf,
IN OUT NET_BUF Duplicate,
IN UINT32  HeadSpace 
)

Create a duplicated copy of the net buffer with data copied and HeadSpace bytes of head space reserved.

The duplicated net buffer will allocate its own memory to hold the data of the source net buffer.

Parameters:
[in] Nbuf The pointer to the net buffer to be duplicated from.
[in,out] Duplicate The pointer to the net buffer to duplicate to. If NULL, a new net buffer is allocated.
[in] HeadSpace The length of the head space to reserve.
Returns:
The pointer to the duplicated net buffer, or NULL if the allocation failed due to resource limitations.

VOID EFIAPI NetbufFree ( IN NET_BUF Nbuf  ) 

Free the net buffer and its associated NET_VECTOR.

Decrease the reference count of the net buffer by one. Free the associated net vector and itself if the reference count of the net buffer is decreased to 0. The net vector free operation decreases the reference count of the net vector by one, and performs the resource free operation when the reference count of the net vector is 0.

Parameters:
[in] Nbuf The pointer to the NET_BUF to be freed.

VOID EFIAPI NetbufFreeList ( IN OUT LIST_ENTRY *  Head  ) 

Free a list of net buffers.

Parameters:
[in,out] Head The pointer to the head of linked net buffers.

NET_BUF* EFIAPI NetbufFromBufList ( IN LIST_ENTRY *  BufList,
IN UINT32  HeadSpace,
IN UINT32  HeaderLen,
IN NET_VECTOR_EXT_FREE  ExtFree,
IN VOID *  Arg 
)

Build a net buffer from a list of net buffers.

All the fragments will be collected from the list of NEW_BUF, and then a new net buffer will be created through NetbufFromExt.

Parameters:
[in] BufList A List of the net buffer.
[in] HeadSpace The head space to be reserved.
[in] HeaderLen The length of the protocol header. The function pulls this amount of data into a linear block.
[in] ExtFree The pointer to the caller provided free function.
[in] Arg The argument passed to ExtFree when ExtFree is called.
Returns:
The pointer to the net buffer built from the list of net buffers.

NET_BUF* EFIAPI NetbufFromExt ( IN NET_FRAGMENT ExtFragment,
IN UINT32  ExtNum,
IN UINT32  HeadSpace,
IN UINT32  HeadLen,
IN NET_VECTOR_EXT_FREE  ExtFree,
IN VOID *  Arg 
)

Build a NET_BUF from external blocks.

A new NET_BUF structure will be created from external blocks. An additional block of memory will be allocated to hold reserved HeadSpace bytes of header room and existing HeadLen bytes of header, but the external blocks are shared by the net buffer to avoid data copying.

Parameters:
[in] ExtFragment The pointer to the data block.
[in] ExtNum The number of the data blocks.
[in] HeadSpace The head space to be reserved.
[in] HeadLen The length of the protocol header. The function pulls this amount of data into a linear block.
[in] ExtFree The pointer to the caller-provided free function.
[in] Arg The argument passed to ExtFree when ExtFree is called.
Returns:
The pointer to the net buffer built from the data blocks, or NULL if the allocation failed due to resource limit.

UINT8* EFIAPI NetbufGetByte ( IN NET_BUF Nbuf,
IN UINT32  Offset,
OUT UINT32 *  Index 
)

Get the index of NET_BLOCK_OP that contains the byte at Offset in the net buffer.

For example, this function can be used to retrieve the IP header in the packet. It also can be used to get the fragment that contains the byte used mainly by the library implementation itself.

Parameters:
[in] Nbuf The pointer to the net buffer.
[in] Offset The offset of the byte.
[out] Index Index of the NET_BLOCK_OP that contains the byte at Offset.
Returns:
The pointer to the Offset'th byte of data in the net buffer, or NULL if there is no such data in the net buffer.

NET_BUF* EFIAPI NetbufGetFragment ( IN NET_BUF Nbuf,
IN UINT32  Offset,
IN UINT32  Len,
IN UINT32  HeadSpace 
)

Create a NET_BUF structure which contains Len byte data of Nbuf starting from Offset.

A new NET_BUF structure will be created but the associated data in NET_VECTOR is shared. This function exists to perform IP packet fragmentation.

Parameters:
[in] Nbuf The pointer to the net buffer to be extracted.
[in] Offset Starting point of the data to be included in the new net buffer.
[in] Len The bytes of data to be included in the new net buffer.
[in] HeadSpace The bytes of the head space to reserve for the protocol header.
Returns:
The pointer to the cloned net buffer, or NULL if the allocation failed due to resource limitations.

NET_BUF_QUEUE* EFIAPI NetbufQueAlloc ( VOID   ) 

Allocate and initialize a net buffer queue.

Returns:
The pointer to the allocated net buffer queue, or NULL if the allocation failed due to resource limit.

VOID EFIAPI NetbufQueAppend ( IN OUT NET_BUF_QUEUE NbufQue,
IN OUT NET_BUF Nbuf 
)

Append a net buffer to the net buffer queue.

Parameters:
[in,out] NbufQue The pointer to the net buffer queue.
[in,out] Nbuf The pointer to the net buffer to be appended.

UINT32 EFIAPI NetbufQueCopy ( IN NET_BUF_QUEUE NbufQue,
IN UINT32  Offset,
IN UINT32  Len,
OUT UINT8 *  Dest 
)

Copy Len bytes of data from the net buffer queue at the specific offset to the destination memory.

The copying operation is the same as NetbufCopy, but applies to the net buffer queue instead of the net buffer.

Parameters:
[in] NbufQue The pointer to the net buffer queue.
[in] Offset The sequence number of the first byte to copy.
[in] Len The length of the data to copy.
[out] Dest The destination of the data to copy to.
Returns:
The length of the actual copied data, or 0 if the offset specified exceeds the total size of net buffer queue.

VOID EFIAPI NetbufQueFlush ( IN OUT NET_BUF_QUEUE NbufQue  ) 

Flush the net buffer queue.

Parameters:
[in,out] NbufQue The pointer to the queue to be flushed.

VOID EFIAPI NetbufQueFree ( IN NET_BUF_QUEUE NbufQue  ) 

Free a net buffer queue.

Decrease the reference count of the net buffer queue by one. The real resource free operation isn't performed until the reference count of the net buffer queue is decreased to 0.

Parameters:
[in] NbufQue The pointer to the net buffer queue to be freed.

VOID EFIAPI NetbufQueInit ( IN OUT NET_BUF_QUEUE NbufQue  ) 

Initiate the net buffer queue.

Parameters:
[in,out] NbufQue The pointer to the net buffer queue to be initialized.

NET_BUF* EFIAPI NetbufQueRemove ( IN OUT NET_BUF_QUEUE NbufQue  ) 

Remove a net buffer from the head in the specific queue and return it.

Parameters:
[in,out] NbufQue The pointer to the net buffer queue.
Returns:
The pointer to the net buffer removed from the specific queue, or NULL if there is no net buffer in the specific queue.

UINT32 EFIAPI NetbufQueTrim ( IN OUT NET_BUF_QUEUE NbufQue,
IN UINT32  Len 
)

Trim Len bytes of data from the buffer queue and free any net buffer that is completely trimmed.

The trimming operation is the same as NetbufTrim but applies to the net buffer queue instead of the net buffer.

Parameters:
[in,out] NbufQue The pointer to the net buffer queue.
[in] Len The length of the data to trim.
Returns:
The actual length of the data trimmed.

VOID EFIAPI NetbufReserve ( IN OUT NET_BUF Nbuf,
IN UINT32  Len 
)

Reserve some space in the header room of the net buffer.

Upon allocation, all the space is in the tail room of the buffer. Call this function to move space to the header room. This function is quite limited in that it can only reserve space from the first block of an empty NET_BUF not built from the external. However, it should be enough for the network stack.

Parameters:
[in,out] Nbuf The pointer to the net buffer.
[in] Len The length of buffer to be reserved from the header.

UINT32 EFIAPI NetbufTrim ( IN OUT NET_BUF Nbuf,
IN UINT32  Len,
IN BOOLEAN  FromHead 
)

Trim Len bytes from the header or the tail of the net buffer.

Parameters:
[in,out] Nbuf The pointer to the net buffer.
[in] Len The length of the data to be trimmed.
[in] FromHead The flag to indicate whether trim data is from the head (TRUE) or the tail (FALSE).
Returns:
The length of the actual trimmed data, which may be less than Len if the TotalSize of Nbuf is less than Len.

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__, __LINE__, NetDebugASPrint ("State transit to %a\n", Name) )

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 memory allocation failed.

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 servity level of the message.
Module The Moudle 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_SUCCESS The log is discard because that it is more verbose than the mNetDebugLevelMax. Or, it has been sent out.

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

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

Destroy network children 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 retrun 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.

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.

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.

INTN EFIAPI NetGetMaskLength ( IN IP4_ADDR  NetMask  ) 

Return the length of the mask.

Return the length of the mask. Valid values are 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, or IP4_MASK_NUM (33) if the mask is invalid.

UINT32 EFIAPI NetGetUint32 ( IN UINT8 *  Buf  ) 

Extract a UINT32 from a byte stream.

This function copies a UINT32 from a byte stream, and 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.

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

Check whether the IP is a valid unicast address according to the netmask. If NetMask is zero, use the IP address's class to get the default mask.

If Ip is 0, IP is not a valid unicast address. Class D address is used for multicasting and class E address is reserved for future. If Ip belongs to class D or class E, Ip is not a valid unicast address. If all bits of the host address of Ip are 0 or 1, Ip is not a valid unicast address.

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.

BOOLEAN EFIAPI NetIp6IsLinkLocalAddr ( IN EFI_IPv6_ADDRESS *  Ip6  ) 

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

Parameters:
[in] Ip6 - Ip6 address, in network order.
Return values:
TRUE - The incoming Ipv6 address is a link-local address.
FALSE - The incoming Ipv6 address is not a link-local address.

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.

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, the Ipv6 address1 and address2 are connected.
FALSE - No the Ipv6 address1 and address2 are not connected.

BOOLEAN EFIAPI NetIp6IsUnspecifiedAddr ( IN EFI_IPv6_ADDRESS *  Ip6  ) 

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

Parameters:
[in] Ip6 - Ip6 address, in network order.
Return values:
TRUE - Yes, incoming Ipv6 address is the unspecified address.
FALSE - The incoming Ipv6 address is not the unspecified address

BOOLEAN EFIAPI NetIp6IsValidUnicast ( IN EFI_IPv6_ADDRESS *  Ip6  ) 

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

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.

UINT16 EFIAPI NetIp6PseudoHeadChecksum ( IN EFI_IPv6_ADDRESS *  Src,
IN EFI_IPv6_ADDRESS *  Dst,
IN UINT8  NextHeader,
IN UINT32  Len 
)

Compute the checksum for the TCP6/UDP6 pseudo header.

Src and Dst are in network byte order, and Len is in host byte order.

Parameters:
[in] Src The source address of the packet.
[in] Dst The destination address of the packet.
[in] NextHeader The protocol type of the packet.
[in] Len The length of the packet.
Returns:
The computed checksum.

VOID NetIpSecNetbufFree ( NET_BUF Nbuf  ) 

The function frees the net buffer which allocated by the IP protocol. It releases only the net buffer and doesn't call the external free function.

This function should be called after finishing the process of mIpSec->ProcessExt() for outbound traffic. The (EFI_IPSEC2_PROTOCOL)->ProcessExt() allocates a new buffer for the ESP, so there needs a function to free the old net buffer.

Parameters:
[in] Nbuf The network buffer to be freed.

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

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:
TURE Found the input Handle in ChildHandleBuffer.
FALSE Can't find the input Handle in ChildHandleBuffer.

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 Converted to an IPv4 address successfully.
EFI_INVALID_PARAMETER The string is malformated, or Ip4Address is NULL.

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 Pepresentation of Addresses.

Parameters:
[in] String The pointer to the Ascii string.
[out] Ip6Address The pointer to the converted IPv6 address.
Return values:
EFI_SUCCESS Converted to an IPv6 address successfully.
EFI_INVALID_PARAMETER The string is malformated, or Ip6Address is NULL.

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.

The header type of IPv4 device path node is MESSAGING_DEVICE_PATH. The header subtype of IPv4 device path node is MSG_IPv4_DP. The length of the IPv4 device path node in bytes is 19. Get other information from parameters to make up the whole IPv4 device path node.

Parameters:
[in,out] Node The 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.

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.

The header type of IPv6 device path node is MESSAGING_DEVICE_PATH. The header subtype of IPv6 device path node is MSG_IPv6_DP. The length of the IPv6 device path node in bytes is 43. Get other information from parameters to make up the whole IPv6 device path node.

Parameters:
[in,out] Node The 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.

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 created child.
Return values:
EFI_SUCCESS The child was successfully created.
Others Failed to create the child.

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.

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 was destroyed.
Others Failed to destroy the child.

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

Detect media status for specified network device.

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 is already present, it returns directly. If media is not present, it will stop SNP and then restart SNP to get the latest media status. This provides an opportunity to get the correct media status for old UNDI driver, which doesn't support reporting media status from GET_STATUS command. Note: there are two limitations for the current algorithm: 1) For UNDI with this capability, when the 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.
[out] MediaPresent The pointer to store the media status.
Return values:
EFI_SUCCESS Media detection success.
EFI_INVALID_PARAMETER ServiceHandle is not a valid network device handle.
EFI_UNSUPPORTED The network device does not support media detection.
EFI_DEVICE_ERROR SNP is in an unknown state.

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.

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 was returned successfully.
Others Failed to get SNP mode data.

EFI_STATUS EFIAPI NetLibGetMacString ( IN EFI_HANDLE  ServiceHandle,
IN EFI_HANDLE  ImageHandle,
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.

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.
[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 Converted the mac address a unicode string successfully.
EFI_OUT_OF_RESOURCES There are not enough memory resources.
Others Failed to open the simple network protocol.

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

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

For example, IP will open an MNP child to transmit/receive packets. When MNP is stopped, IP should also be stopped. IP needs to find its own private data that is related the IP's service binding instance that is installed on the UNDI/SNP handle. The controller is then either an MNP or an ARP child handle. Note that IP opens these handles using BY_DRIVER. Use that infomation to get the UNDI/SNP handle.

Parameters:
[in] Controller The protocol handle to check.
[in] ProtocolGuid The protocol that is related with the handle.
Returns:
The UNDI/SNP handle or NULL for errors.

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

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.

EFI_STATUS EFIAPI NetLibGetSystemGuid ( OUT EFI_GUID *  SystemGuid  ) 

This function obtains the system guid from the smbios table.

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.

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.

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.

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.

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 Converted to an IPv4 address successfully.
EFI_INVALID_PARAMETER The string is mal-formated or Ip4Address is NULL.
EFI_OUT_OF_RESOURCES Failed to perform the operation due to lack of resources.

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 Pepresentation of Addresses.

Parameters:
[in] String The pointer to the Ascii string.
[out] Ip6Address The pointer to the converted IPv6 address.
Return values:
EFI_SUCCESS Converted to an IPv6 address successfully.
EFI_INVALID_PARAMETER The string is malformated or Ip6Address is NULL.
EFI_OUT_OF_RESOURCES Failed to perform the operation due to a lack of resources.

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 Pepresentation 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 Converted to an IPv6 address successfully.
EFI_INVALID_PARAMETER The string is malformated, or Ip6Address is NULL.
EFI_OUT_OF_RESOURCES Failed to perform the operation due to a lack of resources.

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.

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

Parameters:
[in,out] PrevEntry The entry after which to insert.
[in,out] NewEntry The new entry to insert.

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.

Inserts a new node entry designated by NewEntry before the node entry designated by PostEntry of the doubly linked list.

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

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.

LIST_ENTRY* EFIAPI NetListRemoveTail ( IN OUT LIST_ENTRY *  Head  ) 

Remove the last node entry on the list 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.

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 frees 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 zero.

If Map is NULL, then ASSERT().

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

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

Finds the key in the netmap and returns the point to the item containing 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().

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.

UINTN EFIAPI NetMapGetCount ( IN NET_MAP Map  ) 

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

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

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.

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

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().

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.

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

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().

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.

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.

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

Iterate through the netmap and call CallBack for each item.

It will contiue 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 returns EFI_SUCCESS.
Others It returns the CallBack's last return value.

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

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.

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

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.

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

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.

UINT16 EFIAPI NetPseudoHeadChecksum ( IN IP4_ADDR  Src,
IN IP4_ADDR  Dst,
IN UINT8  Proto,
IN UINT16  Len 
)

Compute the checksum for TCP/UDP pseudo header.

Src and Dst are in network byte order, and Len is in host byte order.

Parameters:
[in] Src The source address of the packet.
[in] Dst The destination address of the packet.
[in] Proto The protocol type of the packet.
[in] Len The length of the packet.
Returns:
The computed checksum.

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

Puts a UINT32 into the byte stream in network byte order.

Converts a UINT32 from host byte order to network byte order, then copies it to the byte stream.

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

UINT32 EFIAPI NetRandomInitSeed ( VOID   ) 

Initialize a random seed using current time and monotonic count.

Get current time and monotonic count first. Then initialize a random seed based on some basic mathematics operation on the hour, day, minute, second, nanosecond and year of the current time and the monotonic count value.

Returns:
The random seed initialized with current time.

typedef VOID ( EFIAPI *  EBC_DEBUGGER_DEBUG  ) 

The prototype is called back when an IP packet is received.

Parameters:
[in] Status The result of the receive request.
[in] IcmpErr Valid when Status is EFI_ICMP_ERROR.
[in] NetSession The IP session for the received packet.
[in] Pkt The packet received.
[in] Context The data provided by the user for the received packet when the callback is registered in IP_IO_OPEN_DATA::RcvdContext.
The prototype is called back when an IP packet is sent.

Parameters:
[in] Status Result of the IP packet being sent.
[in] Context The data provided by user for the received packet when the callback is registered in IP_IO_OPEN_DATA::SndContext.
[in] Sender A Union type to specify a pointer of EFI_IP4_PROTOCOL or EFI_IP6_PROTOCOL.
[in] NotifyData The Context data specified when calling IpIoSend()
The function boots a legacy boot option.

Register Exit handler function. When more than one handler function is registered, the latter one will override the previous one. When NULL handler is specified, the previous Exit handler will be unregistered.

Parameters:
[in] Handler Pointer to handler function.
Prototype called when receiving or sending packets to or from a UDP point.

This prototype is used by both receive and sending when calling UdpIoRecvDatagram() or UdpIoSendDatagram(). When receiving, Netbuf is allocated by the UDP access point and released by the user. When sending, the user allocates the the NetBuf, which is then provided to the callback as a reference.

Parameters:
[in] Packet The packet received or sent.
[in] EndPoint The UDP address pair corresponds to the UDP IO.
[in] IoStatus The packet receiving or sending status.
[in] Context The user-defined data when calling UdpIoRecvDatagram() or UdpIoSendDatagram().
Given a pointer to a new VM context, debug one or more instructions.

Parameters:
[in] This A pointer to the EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL structure.
[in] VmPtr A pointer to a VM context.
Return values:
EFI_UNSUPPORTED No support for it.
EFI_SUCCESS Debug one or more instructions.


Variable Documentation

IP4_ADDR gIp4AllMasks[IP4_MASK_NUM]

EFI_IPv4_ADDRESS mZeroIp4Addr


Generated on Thu Sep 24 23:30:14 2015 for MdeModulePkg[ALL] by  doxygen 1.5.7.1