- Generated on Fri Nov 15 2024 18:01:38 for TianoCore EDK2 by
1.9.6
|
TianoCore EDK2 master
|
Go to the source code of this file.
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 |
Macros | |
| #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 | DNS_MAX_NAME_SIZE 255 |
| #define | DNS_MAX_MESSAGE_SIZE 512 |
| #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 | IP4_MASK_MAX 32 |
| #define | IP6_PREFIX_MAX 128 |
| #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 | DNS_TYPE_A 1 |
| #define | DNS_TYPE_NS 2 |
| #define | DNS_TYPE_CNAME 5 |
| #define | DNS_TYPE_SOA 6 |
| #define | DNS_TYPE_WKS 11 |
| #define | DNS_TYPE_PTR 12 |
| #define | DNS_TYPE_HINFO 13 |
| #define | DNS_TYPE_MINFO 14 |
| #define | DNS_TYPE_MX 15 |
| #define | DNS_TYPE_TXT 16 |
| #define | DNS_TYPE_AAAA 28 |
| #define | DNS_TYPE_SRV_RR 33 |
| #define | DNS_TYPE_AXFR 252 |
| #define | DNS_TYPE_MAILB 253 |
| #define | DNS_TYPE_ANY 255 |
| #define | DNS_CLASS_INET 1 |
| #define | DNS_CLASS_CH 3 |
| #define | DNS_CLASS_HS 4 |
| #define | DNS_CLASS_ANY 255 |
| #define | MEDIA_STATE_DETECT_TIME_INTERVAL 1000000U |
| #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_UNSPECIFIED(Ip) ((Ip) == 0) |
| #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_MAX + 1)) |
| #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_IS_HEX(Ch) ((('0' <= (Ch)) && ((Ch) <= '9')) || (('A' <= (Ch)) && ((Ch) <= 'F')) || (('a' <= (Ch)) && ((Ch) <= 'f'))) |
| #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_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) - (UINTN)((BlockOp)->BlockHead)) |
| #define | NET_TAILSPACE(BlockOp) ((UINTN)((BlockOp)->BlockTail) - (UINTN)((BlockOp)->Tail)) |
Typedefs | |
| typedef UINT32 | IP4_ADDR |
| typedef UINT32 | TCP_SEQNO |
| typedef UINT16 | TCP_PORTNO |
| typedef EFI_STATUS(EFIAPI * | NET_DESTROY_LINK_LIST_CALLBACK) (IN LIST_ENTRY *Entry, IN VOID *Context OPTIONAL) |
| typedef EFI_STATUS(EFIAPI * | NET_MAP_CALLBACK) (IN NET_MAP *Map, IN NET_MAP_ITEM *Item, IN VOID *Arg) |
| typedef VOID(EFIAPI * | NET_VECTOR_EXT_FREE) (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) |
| EFI_STATUS EFIAPI | PseudoRandom (OUT VOID *Output, IN UINTN OutputLength) |
| EFI_STATUS EFIAPI | PseudoRandomU32 (OUT UINT32 *Output) |
| LIST_ENTRY *EFIAPI | NetListRemoveHead (IN OUT LIST_ENTRY *Head) |
| LIST_ENTRY *EFIAPI | NetListRemoveTail (IN OUT LIST_ENTRY *Head) |
| VOID EFIAPI | NetListInsertAfter (IN OUT LIST_ENTRY *PrevEntry, IN OUT LIST_ENTRY *NewEntry) |
| VOID EFIAPI | NetListInsertBefore (IN OUT LIST_ENTRY *PostEntry, IN OUT LIST_ENTRY *NewEntry) |
| EFI_STATUS EFIAPI | NetDestroyLinkList (IN LIST_ENTRY *List, IN NET_DESTROY_LINK_LIST_CALLBACK CallBack, IN VOID *Context OPTIONAL, OUT UINTN *ListLength OPTIONAL) |
| BOOLEAN EFIAPI | NetIsInHandleBuffer (IN EFI_HANDLE Handle, IN UINTN NumberOfChildren, IN EFI_HANDLE *ChildHandleBuffer OPTIONAL) |
| VOID EFIAPI | NetMapInit (IN OUT NET_MAP *Map) |
| VOID EFIAPI | NetMapClean (IN OUT NET_MAP *Map) |
| BOOLEAN EFIAPI | NetMapIsEmpty (IN NET_MAP *Map) |
| UINTN EFIAPI | NetMapGetCount (IN NET_MAP *Map) |
| EFI_STATUS EFIAPI | NetMapInsertHead (IN OUT NET_MAP *Map, IN VOID *Key, IN VOID *Value OPTIONAL) |
| EFI_STATUS EFIAPI | NetMapInsertTail (IN OUT NET_MAP *Map, IN VOID *Key, IN VOID *Value OPTIONAL) |
| NET_MAP_ITEM *EFIAPI | NetMapFindKey (IN NET_MAP *Map, IN VOID *Key) |
| VOID *EFIAPI | NetMapRemoveItem (IN OUT NET_MAP *Map, IN OUT NET_MAP_ITEM *Item, OUT VOID **Value OPTIONAL) |
| VOID *EFIAPI | NetMapRemoveHead (IN OUT NET_MAP *Map, OUT VOID **Value OPTIONAL) |
| VOID *EFIAPI | NetMapRemoveTail (IN OUT NET_MAP *Map, OUT VOID **Value OPTIONAL) |
| EFI_STATUS EFIAPI | NetMapIterate (IN NET_MAP *Map, IN NET_MAP_CALLBACK CallBack, IN VOID *Arg OPTIONAL) |
| EFI_STATUS EFIAPI | NetLibCreateServiceChild (IN EFI_HANDLE Controller, IN EFI_HANDLE Image, IN EFI_GUID *ServiceBindingGuid, IN OUT EFI_HANDLE *ChildHandle) |
| EFI_STATUS EFIAPI | NetLibDestroyServiceChild (IN EFI_HANDLE Controller, IN EFI_HANDLE Image, IN EFI_GUID *ServiceBindingGuid, IN EFI_HANDLE ChildHandle) |
| EFI_HANDLE EFIAPI | NetLibGetSnpHandle (IN EFI_HANDLE ServiceHandle, OUT EFI_SIMPLE_NETWORK_PROTOCOL **Snp OPTIONAL) |
| UINT16 EFIAPI | NetLibGetVlanId (IN EFI_HANDLE ServiceHandle) |
| EFI_HANDLE EFIAPI | NetLibGetVlanHandle (IN EFI_HANDLE ControllerHandle, IN UINT16 VlanId) |
| EFI_STATUS EFIAPI | NetLibGetMacAddress (IN EFI_HANDLE ServiceHandle, OUT EFI_MAC_ADDRESS *MacAddress, OUT UINTN *AddressSize) |
| EFI_STATUS EFIAPI | NetLibGetMacString (IN EFI_HANDLE ServiceHandle, IN EFI_HANDLE ImageHandle OPTIONAL, OUT CHAR16 **MacString) |
| EFI_STATUS EFIAPI | NetLibDetectMedia (IN EFI_HANDLE ServiceHandle, OUT BOOLEAN *MediaPresent) |
| EFI_STATUS EFIAPI | NetLibDetectMediaWaitTimeout (IN EFI_HANDLE ServiceHandle, IN UINT64 Timeout, OUT EFI_STATUS *MediaState) |
| 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) |
| 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 OPTIONAL) |
| NET_BUF *EFIAPI | NetbufClone (IN NET_BUF *Nbuf) |
| NET_BUF *EFIAPI | NetbufDuplicate (IN NET_BUF *Nbuf, IN OUT NET_BUF *Duplicate OPTIONAL, 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 OPTIONAL) |
| 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 OPTIONAL) |
| 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) |
| CHAR8 *EFIAPI | NetLibCreateDnsQName (IN CHAR16 *DomainName) |
Variables | |
| IP4_ADDR | gIp4AllMasks [IP4_MASK_NUM] |
| EFI_IPv4_ADDRESS | mZeroIp4Addr |
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 - 2018, Intel Corporation. All rights reserved.
Copyright (c) Microsoft Corporation SPDX-License-Identifier: BSD-2-Clause-Patent
Definition in file NetLib.h.
| #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 IP4_COPY_ADDRESS | ( | Dest, | |
| Src | |||
| ) | (CopyMem ((Dest), (Src), sizeof (EFI_IPv4_ADDRESS))) |
| #define IP4_IS_MULTICAST | ( | Ip | ) | (((Ip) & 0xF0000000) == 0xE0000000) |
| #define IP4_IS_VALID_NETMASK | ( | Ip | ) | (NetGetMaskLength (Ip) != (IP4_MASK_MAX + 1)) |
| #define IP4_NET_EQUAL | ( | Ip1, | |
| Ip2, | |||
| NetMask | |||
| ) | (((Ip1) & (NetMask)) == ((Ip2) & (NetMask))) |
| #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 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_CHECK_SIGNATURE | ( | PData, | |
| SIGNATURE | |||
| ) | ASSERT (((PData) != NULL) && ((PData)->Signature == (SIGNATURE))) |
| #define NET_DEBUG_ERROR | ( | Module, | |
| PrintArg | |||
| ) |
| #define NET_DEBUG_TRACE | ( | Module, | |
| PrintArg | |||
| ) |
| #define NET_DEBUG_WARNING | ( | Module, | |
| PrintArg | |||
| ) |
| #define NET_IS_DIGIT | ( | Ch | ) | (('0' <= (Ch)) && ((Ch) <= '9')) |
| #define NET_IS_HEX | ( | Ch | ) | ((('0' <= (Ch)) && ((Ch) <= '9')) || (('A' <= (Ch)) && ((Ch) <= 'F')) || (('a' <= (Ch)) && ((Ch) <= 'f'))) |
| #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 | |||
| ) |
| #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_QUE_SIGNATURE SIGNATURE_32 ('n', 'b', 'q', 'u') |
| #define NET_ROUNDUP | ( | size, | |
| unit | |||
| ) | (((size) + (unit) - 1) & (~((unit) - 1))) |
| #define NET_VECTOR_SIGNATURE SIGNATURE_32 ('n', 'v', 'e', 'c') |
| #define NET_VECTOR_SIZE | ( | BlockNum | ) | (sizeof (NET_VECTOR) + ((BlockNum) - 1) * sizeof (NET_BLOCK)) |
| #define NTOHL | ( | x | ) | SwapBytes32 (x) |
| #define NTOHLL | ( | x | ) | SwapBytes64 (x) |
| #define NTOHLLL | ( | x | ) | Ip6Swap128 (x) |
| #define NTOHS | ( | x | ) | SwapBytes16 (x) |
| typedef EFI_STATUS(EFIAPI * NET_DESTROY_LINK_LIST_CALLBACK) (IN LIST_ENTRY *Entry, IN VOID *Context OPTIONAL) |
Callback function which provided by user to remove one node in NetDestroyLinkList process.
| [in] | Entry | The entry to be removed. |
| [in] | Context | Pointer to the callback context corresponds to the Context in NetDestroyLinkList. |
| EFI_SUCCESS | The entry has been removed successfully. |
| Others | Fail to remove the entry. |
| typedef EFI_STATUS(EFIAPI * NET_MAP_CALLBACK) (IN NET_MAP *Map, IN NET_MAP_ITEM *Item, IN VOID *Arg) |
| EFI_IPv6_ADDRESS *EFIAPI Ip6Swap128 | ( | EFI_IPv6_ADDRESS * | Ip6 | ) |
Switches the endianess of an IPv6 address.
ASSERT if Ip6 is NULL.
This function swaps the bytes in a 128-bit IPv6 address to switch the value from little endian to big endian or vice versa. The byte swapped value is returned.
| Ip6 | Points to an IPv6 address. |
Switches the endianess of an IPv6 address
ASSERT if Ip6 is NULL.
This function swaps the bytes in a 128-bit IPv6 address to switch the value from little endian to big endian or vice versa. The byte swapped value is returned.
| Ip6 | Points to an IPv6 address |
Definition at line 892 of file DxeNetLib.c.
Add two checksums.
| [in] | Checksum1 | The first checksum to be added. |
| [in] | Checksum2 | The second checksum to be added. |
Definition at line 1658 of file NetBuffer.c.
Compute the checksum for a bulk of data.
| [in] | Bulk | The pointer to the data. |
| [in] | Len | The length of the data, in bytes. |
Compute the checksum for a bulk of data.
| [in] | Bulk | Pointer to the data. |
| [in] | Len | Length of the data, in bytes. |
Definition at line 1615 of file NetBuffer.c.
Allocate a single block NET_BUF. Upon allocation, all the free space is in the tail room.
| [in] | Len | The length of the block. |
Allocate a single block NET_BUF. Upon allocation, all the free space is in the tail room.
| [in] | Len | The length of the block. |
Definition at line 89 of file NetBuffer.c.
Allocate Len bytes of space from the header or tail of the buffer.
| [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). |
Allocate Len bytes of space from the header or tail of the buffer.
| [in,out] | Nbuf | Pointer to the net buffer. |
| [in] | Len | The length of the buffer to be allocated. |
| [in] | FromHead | The flag to indicate whether reserve the data from head (TRUE) or tail (FALSE). |
Definition at line 1015 of file NetBuffer.c.
| 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.
| [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. |
| EFI_BUFFER_TOO_SMALL | The number of non-empty blocks is bigger than ExtNum. |
| EFI_SUCCESS | The fragment table was built successfully. |
Build a fragment table to contain the fragments in the net buffer. This is the opposite operation of the NetbufFromExt.
| [in] | Nbuf | Point to the net buffer. |
| [in,out] | ExtFragment | Pointer to the data block. |
| [in,out] | ExtNum | The number of the data blocks. |
| EFI_BUFFER_TOO_SMALL | The number of non-empty block is bigger than ExtNum. |
| EFI_SUCCESS | Fragment table is built successfully. |
Definition at line 866 of file NetBuffer.c.
Compute the checksum for a NET_BUF.
| [in] | Nbuf | The pointer to the net buffer. |
Compute the checksum for a NET_BUF.
| [in] | Nbuf | Pointer to the net buffer. |
Definition at line 1687 of file NetBuffer.c.
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.
| [in] | Nbuf | The pointer to the net buffer to be cloned. |
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.
| [in] | Nbuf | Pointer to the net buffer to be cloned. |
Definition at line 229 of file NetBuffer.c.
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.
| [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. |
Copy Len bytes of data from the specific offset of the net buffer to the destination memory.
The Len bytes of data may cross the several fragments of the net buffer.
| [in] | Nbuf | Pointer to the net buffer. |
| [in] | Offset | The sequence number of the first byte to copy. |
| [in] | Len | Length of the data to copy. |
| [in] | Dest | The destination of the data to copy to. |
Definition at line 1206 of file NetBuffer.c.
| NET_BUF *EFIAPI NetbufDuplicate | ( | IN NET_BUF * | Nbuf, |
| IN OUT NET_BUF *Duplicate | OPTIONAL, | ||
| 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.
| [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. |
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.
| [in] | Nbuf | Pointer to the net buffer to be duplicated from. |
| [in,out] | Duplicate | Pointer to the net buffer to duplicate to, if NULL a new net buffer is allocated. |
| [in] | HeadSpace | Length of the head space to reserve. |
Definition at line 280 of file NetBuffer.c.
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.
| [in] | Nbuf | The pointer to the NET_BUF to be freed. |
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 just decrease the reference count of the net vector by one and do the real resource free operation when the reference count of the net vector is 0.
| [in] | Nbuf | Pointer to the NET_BUF to be freed. |
Definition at line 195 of file NetBuffer.c.
| VOID EFIAPI NetbufFreeList | ( | IN OUT LIST_ENTRY * | Head | ) |
Free a list of net buffers.
| [in,out] | Head | The pointer to the head of linked net buffers. |
Free a list of net buffers.
| [in,out] | Head | Pointer to the head of linked net buffers. |
Definition at line 319 of file NetBuffer.c.
| NET_BUF *EFIAPI NetbufFromBufList | ( | IN LIST_ENTRY * | BufList, |
| IN UINT32 | HeadSpace, | ||
| IN UINT32 | HeaderLen, | ||
| IN NET_VECTOR_EXT_FREE | ExtFree, | ||
| IN VOID *Arg | OPTIONAL | ||
| ) |
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.
| [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. |
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.
| [in] | BufList | A List of the net buffer. |
| [in] | HeadSpace | The head space to be reserved. |
| [in] | HeaderLen | The length of the protocol header, This function will pull that number of data into a linear block. |
| [in] | ExtFree | Pointer to the caller provided free function. |
| [in] | Arg | The argument passed to ExtFree when ExtFree is called. |
Definition at line 914 of file NetBuffer.c.
| 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 | OPTIONAL | ||
| ) |
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.
| [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. |
Build a NET_BUF from external blocks.
A new NET_BUF structure will be created from external blocks. 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.
| [in] | ExtFragment | 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, This function will pull that number of data into a linear block. |
| [in] | ExtFree | Pointer to the caller provided free function. |
| [in] | Arg | The argument passed to ExtFree when ExtFree is called. |
Definition at line 693 of file NetBuffer.c.
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.
| [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. |
Get the index of NET_BLOCK_OP that contains the byte at Offset in the net buffer.
This can be used to, for example, retrieve the IP header in the packet. It also can be used to get the fragment that contains the byte which is used mainly by the library implementation itself.
| [in] | Nbuf | 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. |
Definition at line 359 of file NetBuffer.c.
| 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.
| [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. |
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 do IP packet fragmentation.
| [in] | Nbuf | 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 | Bytes of data to be included in the new net buffer. |
| [in] | HeadSpace | Bytes of head space to reserve for protocol header. |
Definition at line 510 of file NetBuffer.c.
| NET_BUF_QUEUE *EFIAPI NetbufQueAlloc | ( | VOID | ) |
Allocate and initialize a net buffer queue.
Allocate and initialize a net buffer queue.
Definition at line 1322 of file NetBuffer.c.
Append a net buffer to the net buffer queue.
| [in,out] | NbufQue | The pointer to the net buffer queue. |
| [in,out] | Nbuf | The pointer to the net buffer to be appended. |
Append a net buffer to the net buffer queue.
| [in,out] | NbufQue | Pointer to the net buffer queue. |
| [in,out] | Nbuf | Pointer to the net buffer to be appended. |
Definition at line 1374 of file NetBuffer.c.
| 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.
| [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. |
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.
| [in] | NbufQue | Pointer to the net buffer queue. |
| [in] | Offset | The sequence number of the first byte to copy. |
| [in] | Len | Length of the data to copy. |
| [out] | Dest | The destination of the data to copy to. |
Definition at line 1438 of file NetBuffer.c.
| VOID EFIAPI NetbufQueFlush | ( | IN OUT NET_BUF_QUEUE * | NbufQue | ) |
Flush the net buffer queue.
| [in,out] | NbufQue | The pointer to the queue to be flushed. |
Flush the net buffer queue.
| [in,out] | NbufQue | Pointer to the queue to be flushed. |
Definition at line 1592 of file NetBuffer.c.
| 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.
| [in] | NbufQue | The pointer to the net buffer queue to be freed. |
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.
| [in] | NbufQue | Pointer to the net buffer queue to be freed. |
Definition at line 1350 of file NetBuffer.c.
| VOID EFIAPI NetbufQueInit | ( | IN OUT NET_BUF_QUEUE * | NbufQue | ) |
Initiate the net buffer queue.
| [in,out] | NbufQue | The pointer to the net buffer queue to be initialized. |
Initiate the net buffer queue.
| [in,out] | NbufQue | Pointer to the net buffer queue to be initialized. |
Definition at line 1300 of file NetBuffer.c.
| NET_BUF *EFIAPI NetbufQueRemove | ( | IN OUT NET_BUF_QUEUE * | NbufQue | ) |
Remove a net buffer from the head in the specific queue and return it.
| [in,out] | NbufQue | The pointer to the net buffer queue. |
Remove a net buffer from the head in the specific queue and return it.
| [in,out] | NbufQue | Pointer to the net buffer queue. |
Definition at line 1399 of file NetBuffer.c.
| 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.
| [in,out] | NbufQue | The pointer to the net buffer queue. |
| [in] | Len | The length of the data to trim. |
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.
| [in,out] | NbufQue | Pointer to the net buffer queue. |
| [in] | Len | Length of the data to trim. |
Definition at line 1537 of file NetBuffer.c.
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.
| [in,out] | Nbuf | The pointer to the net buffer. |
| [in] | Len | The length of buffer to be reserved from the header. |
Reserve some space in the header room of the net buffer.
Upon allocation, all the space are in the tail room of the buffer. Call this function to move some 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. But it should be enough for the network stack.
| [in,out] | Nbuf | Pointer to the net buffer. |
| [in] | Len | The length of buffer to be reserved from the header. |
Definition at line 984 of file NetBuffer.c.
Trim Len bytes from the header or the tail of the net buffer.
| [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). |
Trim Len bytes from the header or tail of the net buffer.
| [in,out] | Nbuf | Pointer to the net buffer. |
| [in] | Len | The length of the data to be trimmed. |
| [in] | FromHead | The flag to indicate whether trim data from head (TRUE) or tail (FALSE). |
Definition at line 1134 of file NetBuffer.c.
| CHAR8 *EFIAPI NetDebugASPrint | ( | IN CHAR8 * | Format, |
| ... | |||
| ) |
Allocate a buffer, then format the message to it. This is a help function for the NET_DEBUG_XXX macros. The PrintArg of these macros treats the variable length print parameters as a single parameter, and pass it to the NetDebugASPrint. For example, NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name)) if extracted to:
NetDebugOutput (
NETDEBUG_LEVEL_TRACE,
"Tcp",
__FILE__,
DEBUG_LINE_NUMBER,
NetDebugASPrint ("State transit to %a\n", Name)
)
| Format | The ASCII format string. |
| ... | The variable length parameter whose format is determined by the Format string. |
Allocate a buffer, then format the message to it. This is a help function for the NET_DEBUG_XXX macros. The PrintArg of these macros treats the variable length print parameters as a single parameter, and pass it to the NetDebugASPrint. For example, NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name)) if extracted to:
NetDebugOutput (
NETDEBUG_LEVEL_TRACE,
"Tcp",
__FILE__,
DEBUG_LINE_NUMBER,
NetDebugASPrint ("State transit to %a\n", Name)
)
If Format is NULL, then ASSERT().
| Format | The ASCII format string. |
| ... | The variable length parameter whose format is determined by the Format string. |
Definition at line 481 of file DxeNetLib.c.
| 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.
| Level | The severity level of the message. |
| Module | The Module that generates the log. |
| File | The file that contains the log. |
| Line | The exact line that contains the log. |
| Message | The user message to log. |
| 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. |
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.
| Level | The severity level of the message. |
| Module | The Module that generates the log. |
| File | The file that contains the log. |
| Line | The exact line that contains the log. |
| Message | The user message to log. |
| EFI_INVALID_PARAMETER | Any input parameter is invalid. |
| EFI_OUT_OF_RESOURCES | Failed to allocate memory for the packet. |
| EFI_DEVICE_ERROR | Device error occurs. |
| EFI_SUCCESS | The log is discard because that it is more verbose than the mNetDebugLevelMax. Or, it has been sent out. |
Definition at line 524 of file DxeNetLib.c.
| EFI_STATUS EFIAPI NetDestroyLinkList | ( | IN LIST_ENTRY * | List, |
| IN NET_DESTROY_LINK_LIST_CALLBACK | CallBack, | ||
| IN VOID *Context | OPTIONAL, | ||
| OUT UINTN *ListLength | OPTIONAL | ||
| ) |
Safe destroy nodes in a linked list, and return the length of the list after all possible operations finished.
Destroy network 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 return EFI_SUCCESS if 2 complete passes are made with no changes in the number of children in the list.
| [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. |
| 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. |
Safe destroy nodes in a linked list, and return the length of the list after all possible operations finished.
Destroy network child instance list by list traversals is not safe due to graph dependencies between nodes. This function performs a safe traversal to destroy these nodes by checking to see if the node being destroyed has been removed from the list or not. If it has been removed, then restart the traversal from the head. If it hasn't been removed, then continue with the next node directly. This function will end the iterate and return the CallBack's last return value if error happens, or return EFI_SUCCESS if 2 complete passes are made with no changes in the number of children in the list.
| [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. |
| EFI_SUCCESS | Two complete passes are made with no changes in the number of children. |
| EFI_INVALID_PARAMETER | The input parameter is invalid. |
| Others | Return the CallBack's last return value. |
Definition at line 1236 of file DxeNetLib.c.
Return the class of the IP address, such as class A, B, C. Addr is in host byte order.
[ATTENTION] Classful addressing (IP class A/B/C) has been deprecated according to RFC4632. Caller of this function could only check the returned value against IP4_ADDR_CLASSD (multicast) or IP4_ADDR_CLASSE (reserved) now.
The address of class A starts with 0. If the address belong to class A, return IP4_ADDR_CLASSA. The address of class B starts with 10. If the address belong to class B, return IP4_ADDR_CLASSB. The address of class C starts with 110. If the address belong to class C, return IP4_ADDR_CLASSC. The address of class D starts with 1110. If the address belong to class D, return IP4_ADDR_CLASSD. The address of class E starts with 1111. If the address belong to class E, return IP4_ADDR_CLASSE.
| [in] | Addr | The address to get the class from. |
Definition at line 643 of file DxeNetLib.c.
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.
| [in] | NetMask | The netmask to get the length from. |
Return the length of the mask.
Return the length of the mask, the correct value is from 0 to 32. If the mask is invalid, return the invalid length 33, which is IP4_MASK_NUM. NetMask is in the host byte order.
| [in] | NetMask | The netmask to get the length from. |
Definition at line 600 of file DxeNetLib.c.
| UINT32 EFIAPI NetGetUint32 | ( | IN UINT8 * | Buf | ) |
Extract a UINT32 from a byte stream.
ASSERT if Buf is NULL.
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.
| [in] | Buf | The buffer to extract the UINT32. |
Extract a UINT32 from a byte stream.
ASSERT if Buf is NULL.
Copy a UINT32 from a byte stream, then converts it from Network byte order to host byte order. Use this function to avoid alignment error.
| [in] | Buf | The buffer to extract the UINT32. |
Definition at line 1033 of file DxeNetLib.c.
Check whether the IP is a valid unicast address according to the netmask.
ASSERT if NetMask is zero.
If all bits of the host address of IP are 0 or 1, IP is also not a valid unicast address, except when the originator is one of the endpoints of a point-to-point link with a 31-bit mask (RFC3021), or a 32bit NetMask (all 0xFF) is used for special network environment (e.g. PPP link).
| [in] | Ip | The IP to check against. |
| [in] | NetMask | The mask of the IP. |
Definition at line 683 of file DxeNetLib.c.
| BOOLEAN EFIAPI NetIp6IsLinkLocalAddr | ( | IN EFI_IPv6_ADDRESS * | Ip6 | ) |
Check whether the incoming Ipv6 address is a link-local address.
ASSERT if Ip6 is NULL.
| [in] | Ip6 | - Ip6 address, in network order. |
| TRUE | - The incoming Ipv6 address is a link-local address. |
| FALSE | - The incoming Ipv6 address is not a link-local address. |
Check whether the incoming Ipv6 address is a link-local address.
ASSERT if Ip6 is NULL.
| [in] | Ip6 | - Ip6 address, in network order. |
| TRUE | - Yes, link-local address |
| FALSE | - No |
Definition at line 796 of file DxeNetLib.c.
| BOOLEAN EFIAPI NetIp6IsNetEqual | ( | EFI_IPv6_ADDRESS * | Ip1, |
| EFI_IPv6_ADDRESS * | Ip2, | ||
| UINT8 | PrefixLength | ||
| ) |
Check whether the Ipv6 address1 and address2 are on the connected network.
ASSERT if Ip1 or Ip2 is NULL. ASSERT if PrefixLength exceeds or equals to IP6_PREFIX_MAX.
| [in] | Ip1 | - Ip6 address1, in network order. |
| [in] | Ip2 | - Ip6 address2, in network order. |
| [in] | PrefixLength | - The prefix length of the checking net. |
| TRUE | - Yes, the Ipv6 address1 and address2 are connected. |
| FALSE | - No the Ipv6 address1 and address2 are not connected. |
Check whether the Ipv6 address1 and address2 are on the connected network.
ASSERT if Ip1 or Ip2 is NULL. ASSERT if PrefixLength exceeds or equals to IP6_PREFIX_MAX.
| [in] | Ip1 | - Ip6 address1, in network order. |
| [in] | Ip2 | - Ip6 address2, in network order. |
| [in] | PrefixLength | - The prefix length of the checking net. |
| TRUE | - Yes, connected. |
| FALSE | - No. |
Definition at line 837 of file DxeNetLib.c.
| BOOLEAN EFIAPI NetIp6IsUnspecifiedAddr | ( | IN EFI_IPv6_ADDRESS * | Ip6 | ) |
Check whether the incoming Ipv6 address is the unspecified address or not.
ASSERT if Ip6 is NULL.
| [in] | Ip6 | - Ip6 address, in network order. |
| TRUE | - Yes, incoming Ipv6 address is the unspecified address. |
| FALSE | - The incoming Ipv6 address is not the unspecified address |
Check whether the incoming Ipv6 address is the unspecified address or not.
ASSERT if Ip6 is NULL.
| [in] | Ip6 | - Ip6 address, in network order. |
| TRUE | - Yes, unspecified |
| FALSE | - No |
Definition at line 766 of file DxeNetLib.c.
| BOOLEAN EFIAPI NetIp6IsValidUnicast | ( | IN EFI_IPv6_ADDRESS * | Ip6 | ) |
Check whether the incoming IPv6 address is a valid unicast address.
ASSERT if Ip6 is NULL.
If the address is a multicast address has binary 0xFF at the start, it is not a valid unicast address. If the address is unspecified ::, it is not a valid unicast address to be assigned to any node. If the address is loopback address ::1, it is also not a valid unicast address to be assigned to any physical interface.
| [in] | Ip6 | The IPv6 address to check against. |
Definition at line 725 of file DxeNetLib.c.
| 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.
| [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. |
Compute the checksum for TCP6/UDP6 pseudo header.
Src and Dst are in network byte order, and Len is in host byte order.
| [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. |
Definition at line 1777 of file NetBuffer.c.
| 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.
| [in] | Nbuf | The network buffer to be freed. |
Definition at line 1812 of file NetBuffer.c.
| BOOLEAN EFIAPI NetIsInHandleBuffer | ( | IN EFI_HANDLE | Handle, |
| IN UINTN | NumberOfChildren, | ||
| IN EFI_HANDLE *ChildHandleBuffer | OPTIONAL | ||
| ) |
This function checks the input Handle to see if it's one of these handles in ChildHandleBuffer.
| [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. |
| TRUE | Found the input Handle in ChildHandleBuffer. |
| FALSE | Can't find the input Handle in ChildHandleBuffer. |
Definition at line 1306 of file DxeNetLib.c.
| 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.
| [in] | String | The pointer to the Ascii string. |
| [out] | Ip4Address | The pointer to the converted IPv4 address. |
| EFI_SUCCESS | Converted to an IPv4 address successfully. |
| EFI_INVALID_PARAMETER | The string is malformatted, or Ip4Address is NULL. |
Convert one Null-terminated ASCII string (decimal dotted) to EFI_IPv4_ADDRESS.
| [in] | String | The pointer to the Ascii string. |
| [out] | Ip4Address | The pointer to the converted IPv4 address. |
| EFI_SUCCESS | Convert to IPv4 address successfully. |
| EFI_INVALID_PARAMETER | The string is malformatted or Ip4Address is NULL. |
Definition at line 3068 of file DxeNetLib.c.
| EFI_STATUS EFIAPI NetLibAsciiStrToIp6 | ( | IN CONST CHAR8 * | String, |
| OUT EFI_IPv6_ADDRESS * | Ip6Address | ||
| ) |
Convert one Null-terminated ASCII string to EFI_IPv6_ADDRESS. The format of the string is defined in RFC 4291 - Text Representation of Addresses.
| [in] | String | The pointer to the Ascii string. |
| [out] | Ip6Address | The pointer to the converted IPv6 address. |
| EFI_SUCCESS | Converted to an IPv6 address successfully. |
| EFI_INVALID_PARAMETER | The string is malformatted, or Ip6Address is NULL. |
Convert one Null-terminated ASCII string to EFI_IPv6_ADDRESS. The format of the string is defined in RFC 4291 - Text Representation of Addresses.
| [in] | String | The pointer to the Ascii string. |
| [out] | Ip6Address | The pointer to the converted IPv6 address. |
| EFI_SUCCESS | Convert to IPv6 address successfully. |
| EFI_INVALID_PARAMETER | The string is malformatted or Ip6Address is NULL. |
Definition at line 3097 of file DxeNetLib.c.
| CHAR8 *EFIAPI NetLibCreateDnsQName | ( | IN CHAR16 * | DomainName | ) |
Create Dns QName according the queried domain name.
If DomainName is NULL, then ASSERT().
QName is a domain name represented as a sequence of labels, where each label consists of a length octet followed by that number of octets. The QName terminates with the zero length octet for the null label of the root. Caller should take responsibility to free the buffer in returned pointer.
| DomainName | The pointer to the queried domain name string. |
| NULL | Failed to fill QName. |
Definition at line 3424 of file DxeNetLib.c.
| VOID EFIAPI NetLibCreateIPv4DPathNode | ( | IN OUT IPv4_DEVICE_PATH * | Node, |
| IN EFI_HANDLE | Controller, | ||
| IN IP4_ADDR | LocalIp, | ||
| IN UINT16 | LocalPort, | ||
| IN IP4_ADDR | RemoteIp, | ||
| IN UINT16 | RemotePort, | ||
| IN UINT16 | Protocol, | ||
| IN BOOLEAN | UseDefaultAddress | ||
| ) |
Create an IPv4 device path node.
If Node is NULL, then ASSERT().
The header type of IPv4 device path node is MESSAGING_DEVICE_PATH. The header subtype of IPv4 device path node is MSG_IPv4_DP. 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.
| [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. |
Create an IPv4 device path node.
If Node is NULL, then ASSERT().
The header type of IPv4 device path node is MESSAGING_DEVICE_PATH. The header subtype of IPv4 device path node is MSG_IPv4_DP. Get other info from parameters to make up the whole IPv4 device path node.
| [in,out] | Node | Pointer to the IPv4 device path node. |
| [in] | Controller | The controller handle. |
| [in] | LocalIp | The local IPv4 address. |
| [in] | LocalPort | The local port. |
| [in] | RemoteIp | The remote IPv4 address. |
| [in] | RemotePort | The remote port. |
| [in] | Protocol | The protocol type in the IP header. |
| [in] | UseDefaultAddress | Whether this instance is using default address or not. |
Definition at line 2903 of file DxeNetLib.c.
| VOID EFIAPI NetLibCreateIPv6DPathNode | ( | IN OUT IPv6_DEVICE_PATH * | Node, |
| IN EFI_HANDLE | Controller, | ||
| IN EFI_IPv6_ADDRESS * | LocalIp, | ||
| IN UINT16 | LocalPort, | ||
| IN EFI_IPv6_ADDRESS * | RemoteIp, | ||
| IN UINT16 | RemotePort, | ||
| IN UINT16 | Protocol | ||
| ) |
Create an IPv6 device path node.
If Node is NULL, then ASSERT(). If LocalIp is NULL, then ASSERT(). If RemoteIp is NULL, then ASSERT().
The header type of IPv6 device path node is MESSAGING_DEVICE_PATH. The header subtype of IPv6 device path node is MSG_IPv6_DP. 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.
| [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. |
Create an IPv6 device path node.
If Node is NULL, then ASSERT(). If LocalIp is NULL, then ASSERT(). If RemoteIp is NULL, then ASSERT().
The header type of IPv6 device path node is MESSAGING_DEVICE_PATH. The header subtype of IPv6 device path node is MSG_IPv6_DP. Get other info from parameters to make up the whole IPv6 device path node.
| [in,out] | Node | Pointer to the IPv6 device path node. |
| [in] | Controller | The controller handle. |
| [in] | LocalIp | The local IPv6 address. |
| [in] | LocalPort | The local port. |
| [in] | RemoteIp | The remote IPv6 address. |
| [in] | RemotePort | The remote port. |
| [in] | Protocol | The protocol type in the IP header. |
Definition at line 2965 of file DxeNetLib.c.
| 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().
| [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. |
| EFI_SUCCESS | The child was successfully created. |
| Others | Failed to create the child. |
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().
| [in] | Controller | The controller which has the service installed. |
| [in] | Image | The image handle used to open service. |
| [in] | ServiceBindingGuid | The service's Guid. |
| [in,out] | ChildHandle | The handle to receive the create child. |
| EFI_SUCCESS | The child is successfully created. |
| Others | Failed to create the child. |
Definition at line 1967 of file DxeNetLib.c.
| 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.
| [in] | ImageHandle | The drivers' driver image. |
| EFI_SUCCESS | The image is unloaded. |
| Others | Failed to unload the image. |
Definition at line 1846 of file DxeNetLib.c.
| 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().
| [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. |
| EFI_SUCCESS | The child was destroyed. |
| Others | Failed to destroy the child. |
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().
| [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. |
| EFI_SUCCESS | The child is successfully destroyed. |
| Others | Failed to destroy the child. |
Definition at line 2020 of file DxeNetLib.c.
| EFI_STATUS EFIAPI NetLibDetectMedia | ( | IN EFI_HANDLE | ServiceHandle, |
| OUT BOOLEAN * | MediaPresent | ||
| ) |
Detect media status for specified network device.
If MediaPresent is NULL, then ASSERT().
The underlying UNDI driver may or may not support reporting media status from GET_STATUS command (PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED). This routine will try to invoke Snp->GetStatus() to get the media status. If media 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.
| [in] | ServiceHandle | The handle where network service binding protocols are installed. |
| [out] | MediaPresent | The pointer to store the media status. |
| 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. |
Detect media status for specified network device.
If MediaPresent is NULL, then ASSERT().
The underlying UNDI driver may or may not support reporting media status from GET_STATUS command (PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED). This routine will try to invoke Snp->GetStatus() to get the media status: if media already present, it return directly; if media not present, it will stop SNP and then restart SNP to get the latest media status, this give chance to get the correct media status for old UNDI driver which doesn't support reporting media status from GET_STATUS command. Note: there will be two limitations for current algorithm: 1) for UNDI with this capability, in case of cable is not attached, there will be an redundant Stop/Start() process; 2) for UNDI without this capability, in case that network cable is attached when Snp->Initialize() is invoked while network cable is unattached later, NetLibDetectMedia() will report MediaPresent as TRUE, causing upper layer apps to wait for timeout time.
| [in] | ServiceHandle | The handle where network service binding protocols are installed on. |
| [out] | MediaPresent | The pointer to store the media status. |
| EFI_SUCCESS | Media detection success. |
| EFI_INVALID_PARAMETER | ServiceHandle is not valid network device handle. |
| EFI_UNSUPPORTED | Network device does not support media detection. |
| EFI_DEVICE_ERROR | SNP is in unknown state. |
Definition at line 2472 of file DxeNetLib.c.
| EFI_STATUS EFIAPI NetLibDetectMediaWaitTimeout | ( | IN EFI_HANDLE | ServiceHandle, |
| IN UINT64 | Timeout, | ||
| OUT EFI_STATUS * | MediaState | ||
| ) |
Detect media state for a network device. This routine will wait for a period of time at a specified checking interval when a certain network is under connecting until connection process finishes or timeout. If Aip protocol is supported by low layer drivers, three kinds of media states can be detected: EFI_SUCCESS, EFI_NOT_READY and EFI_NO_MEDIA, represents connected state, connecting state and no media state respectively. When function detects the current state is EFI_NOT_READY, it will loop to wait for next time's check until state turns to be EFI_SUCCESS or EFI_NO_MEDIA. If Aip protocol is not supported, function will call NetLibDetectMedia() and return state directly.
| [in] | ServiceHandle | The handle where network service binding protocols are installed on. |
| [in] | Timeout | The maximum number of 100ns units to wait when network is connecting. Zero value means detect once and return immediately. |
| [out] | MediaState | The pointer to the detected media state. |
| EFI_SUCCESS | Media detection success. |
| EFI_INVALID_PARAMETER | ServiceHandle is not a valid network device handle or MediaState pointer is NULL. |
| EFI_DEVICE_ERROR | A device error occurred. |
| EFI_TIMEOUT | Network is connecting but timeout. |
Detect media state for a network device. This routine will wait for a period of time at a specified checking interval when a certain network is under connecting until connection process finishs or timeout. If Aip protocol is supported by low layer drivers, three kinds of media states can be detected: EFI_SUCCESS, EFI_NOT_READY and EFI_NO_MEDIA, represents connected state, connecting state and no media state respectively. When function detects the current state is EFI_NOT_READY, it will loop to wait for next time's check until state turns to be EFI_SUCCESS or EFI_NO_MEDIA. If Aip protocol is not supported, function will call NetLibDetectMedia() and return state directly.
| [in] | ServiceHandle | The handle where network service binding protocols are installed on. |
| [in] | Timeout | The maximum number of 100ns units to wait when network is connecting. Zero value means detect once and return immediately. |
| [out] | MediaState | The pointer to the detected media state. |
| EFI_SUCCESS | Media detection success. |
| EFI_INVALID_PARAMETER | ServiceHandle is not a valid network device handle or MediaState pointer is NULL. |
| EFI_DEVICE_ERROR | A device error occurred. |
| EFI_TIMEOUT | Network is connecting but timeout. |
Definition at line 2683 of file DxeNetLib.c.
| EFI_STATUS EFIAPI NetLibGetMacAddress | ( | IN EFI_HANDLE | ServiceHandle, |
| OUT EFI_MAC_ADDRESS * | MacAddress, | ||
| OUT UINTN * | AddressSize | ||
| ) |
Get MAC address associated with the network service handle.
If MacAddress is NULL, then ASSERT(). If AddressSize is NULL, then ASSERT().
There should be MNP Service Binding Protocol installed on the input ServiceHandle. If SNP is installed on the ServiceHandle or its parent handle, MAC address will be retrieved from SNP. If no SNP found, try to get SNP mode data use MNP.
| [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. |
| EFI_SUCCESS | MAC address was returned successfully. |
| Others | Failed to get SNP mode data. |
Get MAC address associated with the network service handle.
If MacAddress is NULL, then ASSERT(). If AddressSize is NULL, then ASSERT().
There should be MNP Service Binding Protocol installed on the input ServiceHandle. If SNP is installed on the ServiceHandle or its parent handle, MAC address will be retrieved from SNP. If no SNP found, try to get SNP mode data use MNP.
| [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. |
| EFI_SUCCESS | MAC address is returned successfully. |
| Others | Failed to get SNP mode data. |
Definition at line 2251 of file DxeNetLib.c.
| EFI_STATUS EFIAPI NetLibGetMacString | ( | IN EFI_HANDLE | ServiceHandle, |
| IN EFI_HANDLE ImageHandle | OPTIONAL, | ||
| OUT CHAR16 ** | MacString | ||
| ) |
Convert MAC address of the NIC associated with specified Service Binding Handle to a unicode string. Callers are responsible for freeing the string storage.
If MacString is NULL, then ASSERT().
Locate simple network protocol associated with the Service Binding Handle and get the mac address from SNP. Then convert the mac address into a unicode string. It takes 2 unicode characters to represent a 1 byte binary buffer. Plus one unicode character for the null-terminator.
| [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. |
| 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. |
Convert MAC address of the NIC associated with specified Service Binding Handle to a unicode string. Callers are responsible for freeing the string storage.
If MacString is NULL, then ASSERT().
Locate simple network protocol associated with the Service Binding Handle and get the mac address from SNP. Then convert the mac address into a unicode string. It takes 2 unicode characters to represent a 1 byte binary buffer. Plus one unicode character for the null-terminator.
| [in] | ServiceHandle | The handle where network service binding protocol is installed on. |
| [in] | ImageHandle | The image handle used to act as the agent handle to get the simple network protocol. This parameter is optional and may be NULL. |
| [out] | MacString | The pointer to store the address of the string representation of the mac address. |
| EFI_SUCCESS | Convert the mac address a unicode string successfully. |
| EFI_OUT_OF_RESOURCES | There are not enough memory resource. |
| Others | Failed to open the simple network protocol. |
Definition at line 2363 of file DxeNetLib.c.
| EFI_HANDLE EFIAPI NetLibGetNicHandle | ( | IN EFI_HANDLE | Controller, |
| IN EFI_GUID * | ProtocolGuid | ||
| ) |
Find the UNDI/SNP handle from controller and protocol GUID.
If ProtocolGuid is NULL, then ASSERT().
For example, IP will open 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 information to get the UNDI/SNP handle.
| [in] | Controller | The protocol handle to check. |
| [in] | ProtocolGuid | The protocol that is related with the handle. |
Find the UNDI/SNP handle from controller and protocol GUID.
If ProtocolGuid is NULL, then ASSERT().
For example, IP will open a MNP child to transmit/receive packets, when MNP is stopped, IP should also be stopped. IP needs to find its own private data which is related the IP's service binding instance that is install on UNDI/SNP handle. Now, the controller is either a MNP or ARP child handle. But IP opens these handle BY_DRIVER, use that info, we can get the UNDI/SNP handle.
| [in] | Controller | Then protocol handle to check. |
| [in] | ProtocolGuid | The protocol that is related with the handle. |
Definition at line 3019 of file DxeNetLib.c.
| EFI_HANDLE EFIAPI NetLibGetSnpHandle | ( | IN EFI_HANDLE | ServiceHandle, |
| OUT EFI_SIMPLE_NETWORK_PROTOCOL **Snp | OPTIONAL | ||
| ) |
Get handle with Simple Network Protocol installed on it.
There should be MNP Service Binding Protocol installed on the input ServiceHandle. If Simple Network Protocol is already installed on the ServiceHandle, the ServiceHandle will be returned. If SNP is not installed on the ServiceHandle, try to find its parent handle with SNP installed.
| [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. |
Definition at line 2073 of file DxeNetLib.c.
| EFI_STATUS EFIAPI NetLibGetSystemGuid | ( | OUT EFI_GUID * | SystemGuid | ) |
This function obtains the system guid from the smbios table.
If SystemGuid is NULL, then ASSERT().
| [out] | SystemGuid | The pointer of the returned system guid. |
| EFI_SUCCESS | Successfully obtained the system guid. |
| EFI_NOT_FOUND | Did not find the SMBIOS table. |
Definition at line 3325 of file DxeNetLib.c.
| 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.
| [in] | ControllerHandle | The handle where network service binding protocols are installed on. |
| [in] | VlanId | The configured VLAN ID for the VLAN device. |
Definition at line 2180 of file DxeNetLib.c.
| 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.
| [in] | ServiceHandle | The handle where network service binding protocols are installed on. |
Definition at line 2140 of file DxeNetLib.c.
| 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.
| [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. |
| EFI_SUCCESS | Convert to string successfully. |
| EFI_INVALID_PARAMETER | The input parameter is invalid. |
| EFI_BUFFER_TOO_SMALL | The BufferSize is too small for the result. BufferSize has been updated with the size needed to complete the request. |
Definition at line 3218 of file DxeNetLib.c.
| 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.
| [in] | String | The pointer to the Ascii string. |
| [out] | Ip4Address | The pointer to the converted IPv4 address. |
| EFI_SUCCESS | Converted to an IPv4 address successfully. |
| EFI_INVALID_PARAMETER | The string is mal-formatted or Ip4Address is NULL. |
Convert one Null-terminated Unicode string (decimal dotted) to EFI_IPv4_ADDRESS.
| [in] | String | The pointer to the Ascii string. |
| [out] | Ip4Address | The pointer to the converted IPv4 address. |
| EFI_SUCCESS | Convert to IPv4 address successfully. |
| EFI_INVALID_PARAMETER | The string is malformatted or Ip4Address is NULL. |
Definition at line 3125 of file DxeNetLib.c.
| EFI_STATUS EFIAPI NetLibStrToIp6 | ( | IN CONST CHAR16 * | String, |
| OUT EFI_IPv6_ADDRESS * | Ip6Address | ||
| ) |
Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS. The format of the string is defined in RFC 4291 - Text Representation of Addresses.
| [in] | String | The pointer to the Ascii string. |
| [out] | Ip6Address | The pointer to the converted IPv6 address. |
| EFI_SUCCESS | Converted to an IPv6 address successfully. |
| EFI_INVALID_PARAMETER | The string is malformatted or Ip6Address is NULL. |
Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS. The format of the string is defined in RFC 4291 - Text Representation of Addresses.
| [in] | String | The pointer to the Ascii string. |
| [out] | Ip6Address | The pointer to the converted IPv6 address. |
| EFI_SUCCESS | Convert to IPv6 address successfully. |
| EFI_INVALID_PARAMETER | The string is malformatted or Ip6Address is NULL. |
Definition at line 3154 of file DxeNetLib.c.
| EFI_STATUS EFIAPI NetLibStrToIp6andPrefix | ( | IN CONST CHAR16 * | String, |
| OUT EFI_IPv6_ADDRESS * | Ip6Address, | ||
| OUT UINT8 * | PrefixLength | ||
| ) |
Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS and prefix length. The format of the string is defined in RFC 4291 - Text Representation of Addresses Prefixes: ipv6-address/prefix-length.
| [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. |
| EFI_SUCCESS | Converted to an IPv6 address successfully. |
| EFI_INVALID_PARAMETER | The string is malformatted, or Ip6Address is NULL. |
Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS and prefix length. The format of the string is defined in RFC 4291 - Text Representation of Addresses Prefixes: ipv6-address/prefix-length.
| [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. |
| EFI_SUCCESS | Convert to IPv6 address successfully. |
| EFI_INVALID_PARAMETER | The string is malformatted or Ip6Address is NULL. |
Definition at line 3185 of file DxeNetLib.c.
| VOID EFIAPI NetListInsertAfter | ( | IN OUT LIST_ENTRY * | PrevEntry, |
| IN OUT LIST_ENTRY * | NewEntry | ||
| ) |
Insert a new node entry after a designated node entry of a doubly linked list.
ASSERT if PrevEntry or NewEntry is NULL.
Inserts a new node entry designated by NewEntry after the node entry designated by PrevEntry of the doubly linked list.
| [in,out] | PrevEntry | The entry after which to insert. |
| [in,out] | NewEntry | The new entry to insert. |
Insert a new node entry after a designated node entry of a doubly linked list.
ASSERT if PrevEntry or NewEntry is NULL.
Inserts a new node entry donated by NewEntry after the node entry donated by PrevEntry of the doubly linked list.
| [in,out] | PrevEntry | The previous entry to insert after. |
| [in,out] | NewEntry | The new entry to insert. |
Definition at line 1172 of file DxeNetLib.c.
| VOID EFIAPI NetListInsertBefore | ( | IN OUT LIST_ENTRY * | PostEntry, |
| IN OUT LIST_ENTRY * | NewEntry | ||
| ) |
Insert a new node entry before a designated node entry of a doubly linked list.
ASSERT if PostEntry or NewEntry is NULL.
Inserts a new node entry designated by NewEntry before the node entry designated by PostEntry of the doubly linked list.
| [in,out] | PostEntry | The entry to insert before. |
| [in,out] | NewEntry | The new entry to insert. |
Insert a new node entry before a designated node entry of a doubly linked list.
ASSERT if PostEntry or NewEntry is NULL.
Inserts a new node entry donated by NewEntry after the node entry donated by PostEntry of the doubly linked list.
| [in,out] | PostEntry | The entry to insert before. |
| [in,out] | NewEntry | The new entry to insert. |
Definition at line 1199 of file DxeNetLib.c.
| 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().
| [in,out] | Head | The list header. |
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().
| [in,out] | Head | The list header. |
Definition at line 1090 of file DxeNetLib.c.
| 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().
| [in,out] | Head | The list head. |
Remove the last node entry on the list and and return the removed node entry.
Removes the last node entry from a doubly linked list. It is up to the caller of this function to release the memory used by the first node if that is required. On exit, the removed node is returned.
If Head is NULL, then ASSERT(). If Head was not initialized, then ASSERT(). If PcdMaximumLinkedListLength is not zero, and the number of nodes in the linked list including the head node is greater than or equal to PcdMaximumLinkedListLength, then ASSERT().
| [in,out] | Head | The list head. |
Definition at line 1134 of file DxeNetLib.c.
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().
| [in,out] | Map | The netmap to clean up. |
To clean up the netmap, that is, release allocated memories.
Removes all nodes of the Used doubly linked list and free memory of all related netmap items. Removes all nodes of the Recycled doubly linked list and free memory of all related netmap items. The number of the <Key, Value> pairs in the netmap is set to be zero.
If Map is NULL, then ASSERT().
| [in,out] | Map | The netmap to clean up. |
Definition at line 1368 of file DxeNetLib.c.
| 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(). If Key is NULL, then ASSERT().
| [in] | Map | The netmap to search within. |
| [in] | Key | The key to search. |
Find the key in the netmap and returns the point to the item contains the Key.
Iterate the Used doubly linked list of the netmap to get every item. Compare the key of every item with the key to search. It returns the point to the item contains the Key if found.
If Map is NULL, then ASSERT(). If Key is NULL, then ASSERT().
| [in] | Map | The netmap to search within. |
| [in] | Key | The key to search. |
Definition at line 1629 of file DxeNetLib.c.
Return the number of the <Key, Value> pairs in the netmap.
If Map is NULL, then ASSERT().
| [in] | Map | The netmap to get the entry number. |
Definition at line 1433 of file DxeNetLib.c.
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().
| [in,out] | Map | The netmap to initialize. |
Definition at line 1343 of file DxeNetLib.c.
Allocate an item to save the <Key, Value> pair to the head of the netmap.
Allocate an item to save the <Key, Value> pair and add corresponding node entry to the beginning of the Used doubly linked list. The number of the <Key, Value> pairs in the netmap increase by 1.
If Map is NULL, then ASSERT(). If Key is NULL, then ASSERT().
| [in,out] | Map | The netmap to insert into. |
| [in] | Key | The user's key. |
| [in] | Value | The user's value for the key. |
| EFI_OUT_OF_RESOURCES | Failed to allocate the memory for the item. |
| EFI_SUCCESS | The item is inserted to the head. |
Definition at line 1512 of file DxeNetLib.c.
Allocate an item to save the <Key, Value> pair to the tail of the netmap.
Allocate an item to save the <Key, Value> pair and add corresponding node entry to the tail of the Used doubly linked list. The number of the <Key, Value> pairs in the netmap increase by 1.
If Map is NULL, then ASSERT(). If Key is NULL, then ASSERT().
| [in,out] | Map | The netmap to insert into. |
| [in] | Key | The user's key. |
| [in] | Value | The user's value for the key. |
| EFI_OUT_OF_RESOURCES | Failed to allocate the memory for the item. |
| EFI_SUCCESS | The item is inserted to the tail. |
Definition at line 1556 of file DxeNetLib.c.
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().
| [in] | Map | The net map to test. |
Definition at line 1413 of file DxeNetLib.c.
| EFI_STATUS EFIAPI NetMapIterate | ( | IN NET_MAP * | Map, |
| IN NET_MAP_CALLBACK | CallBack, | ||
| IN VOID *Arg | OPTIONAL | ||
| ) |
Iterate through the netmap and call CallBack for each item.
It will continue the traverse if CallBack returns EFI_SUCCESS, otherwise, break from the loop. It returns the CallBack's last return value. This function is delete safe for the current item.
If Map is NULL, then ASSERT(). If CallBack is NULL, then ASSERT().
| [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. |
| 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. |
Iterate through the netmap and call CallBack for each item.
It will continue the traverse if CallBack returns EFI_SUCCESS, otherwise, break from the loop. It returns the CallBack's last return value. This function is delete safe for the current item.
If Map is NULL, then ASSERT(). If CallBack is NULL, then ASSERT().
| [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. |
| EFI_SUCCESS | There is no item in the netmap or CallBack for each item return EFI_SUCCESS. |
| Others | It returns the CallBack's last return value. |
Definition at line 1800 of file DxeNetLib.c.
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().
| [in,out] | Map | The netmap to remove the head from. |
| [out] | Value | The variable to receive the value if not NULL. |
Definition at line 1710 of file DxeNetLib.c.
| VOID *EFIAPI NetMapRemoveItem | ( | IN OUT NET_MAP * | Map, |
| IN OUT NET_MAP_ITEM * | Item, | ||
| OUT VOID **Value | OPTIONAL | ||
| ) |
Remove the node entry of the item from the netmap and return the key of the removed item.
Remove the node entry of the item from the Used doubly linked list of the netmap. The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node entry of the item to the Recycled doubly linked list of the netmap. If Value is not NULL, Value will point to the value of the item. It returns the key of the removed item.
If Map is NULL, then ASSERT(). If Item is NULL, then ASSERT(). if item in not in the netmap, then ASSERT().
| [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. |
Definition at line 1671 of file DxeNetLib.c.
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().
| [in,out] | Map | The netmap to remove the tail from. |
| [out] | Value | The variable to receive the value if not NULL. |
Definition at line 1754 of file DxeNetLib.c.
| 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.
| [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. |
Definition at line 1740 of file NetBuffer.c.
Puts a UINT32 into the byte stream in network byte order.
ASSERT if Buf is NULL.
Converts a UINT32 from host byte order to network byte order, then copies it to the byte stream.
| [in,out] | Buf | The buffer in which to put the UINT32. |
| [in] | Data | The data to be converted and put into the byte stream. |
Put a UINT32 to the byte stream in network byte order.
ASSERT if Buf is NULL.
Converts a UINT32 from host byte order to network byte order. Then copy it to the byte stream.
| [in,out] | Buf | The buffer to put the UINT32. |
| [in] | Data | The data to be converted and put into the byte stream. |
Definition at line 1059 of file DxeNetLib.c.
| EFI_STATUS EFIAPI PseudoRandom | ( | OUT VOID * | Output, |
| IN UINTN | OutputLength | ||
| ) |
Generate a Random output data given a length.
| [out] | Output | - The buffer to store the generated random data. |
| [in] | OutputLength | - The length of the output buffer. |
| EFI_SUCCESS | On Success |
| EFI_INVALID_PARAMETER | Pointer is null or size is zero |
| EFI_NOT_FOUND | RNG protocol not found |
| Others | Error from RngProtocol->GetRNG() |
Definition at line 928 of file DxeNetLib.c.
| EFI_STATUS EFIAPI PseudoRandomU32 | ( | OUT UINT32 * | Output | ) |
Generate a 32-bit pseudo-random number.
| [out] | Output | - The buffer to store the generated random number. |
| EFI_SUCCESS | On Success |
| EFI_NOT_FOUND | RNG protocol not found |
| Others | Error from RngProtocol->GetRNG() |
Definition at line 1011 of file DxeNetLib.c.
|
extern |
Definition at line 43 of file DxeNetLib.c.
|
extern |
Definition at line 82 of file DxeNetLib.c.
1.9.6