/** @file\r
- This library provides basic function for UEFI network stack.\r
+ Ihis library is only intended to be used by UEFI network stack modules.\r
+ It provides basic functions for the UEFI network stack.\r
\r
-Copyright (c) 2005 - 2008, Intel Corporation\r
+Copyright (c) 2005 - 2009, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
#ifndef _NET_LIB_H_\r
#define _NET_LIB_H_\r
\r
-#include <Library/BaseMemoryLib.h>\r
-#include <Library/MemoryAllocationLib.h>\r
-#include <Protocol/DriverBinding.h>\r
-#include <Protocol/ComponentName.h>\r
-#include <Protocol/DriverConfiguration.h>\r
-#include <Protocol/DriverDiagnostics.h>\r
-#include <Protocol/Dpc.h>\r
+#include <Protocol/Ip6.h>\r
\r
typedef UINT32 IP4_ADDR;\r
typedef UINT32 TCP_SEQNO;\r
typedef UINT16 TCP_PORTNO;\r
\r
-typedef enum {\r
- NET_ETHER_ADDR_LEN = 6,\r
- NET_IFTYPE_ETHERNET = 0x01,\r
\r
- EFI_IP_PROTO_UDP = 0x11,\r
- EFI_IP_PROTO_TCP = 0x06,\r
- EFI_IP_PROTO_ICMP = 0x01,\r
+#define NET_ETHER_ADDR_LEN 6\r
+#define NET_IFTYPE_ETHERNET 0x01\r
\r
- //\r
- // The address classification\r
- //\r
- IP4_ADDR_CLASSA = 1,\r
- IP4_ADDR_CLASSB,\r
- IP4_ADDR_CLASSC,\r
- IP4_ADDR_CLASSD,\r
- IP4_ADDR_CLASSE,\r
+#define EFI_IP_PROTO_UDP 0x11\r
+#define EFI_IP_PROTO_TCP 0x06\r
+#define EFI_IP_PROTO_ICMP 0x01\r
+#define IP4_PROTO_IGMP 0x02\r
+#define IP6_ICMP 58\r
\r
- IP4_MASK_NUM = 33\r
-} IP4_CLASS_TYPE;\r
+//\r
+// The address classification\r
+//\r
+#define IP4_ADDR_CLASSA 1\r
+#define IP4_ADDR_CLASSB 2\r
+#define IP4_ADDR_CLASSC 3\r
+#define IP4_ADDR_CLASSD 4\r
+#define IP4_ADDR_CLASSE 5\r
+\r
+#define IP4_MASK_NUM 33\r
+#define IP6_PREFIX_NUM 129\r
+\r
+#define IP6_HOP_BY_HOP 0\r
+#define IP6_DESTINATION 60\r
+#define IP6_FRAGMENT 44\r
+#define IP6_AH 51\r
+#define IP6_ESP 50\r
+#define IP6_NO_NEXT_HEADER 59\r
+\r
+#define IP_VERSION_4 4\r
+#define IP_VERSION_6 6\r
\r
#pragma pack(1)\r
\r
\r
\r
//\r
-// ICMP head definition. ICMP message is categoried as either an error\r
+// ICMP head definition. Each ICMP message is categorized as either an error\r
// message or query message. Two message types have their own head format.\r
//\r
typedef struct {\r
UINT16 Seq;\r
} IP4_ICMP_QUERY_HEAD;\r
\r
+typedef struct {\r
+ UINT8 Type;\r
+ UINT8 Code;\r
+ UINT16 Checksum;\r
+} IP6_ICMP_HEAD;\r
+\r
+typedef struct {\r
+ IP6_ICMP_HEAD Head;\r
+ UINT32 Fourth;\r
+ EFI_IP6_HEADER IpHead;\r
+} IP6_ICMP_ERROR_HEAD;\r
+\r
+typedef struct {\r
+ IP6_ICMP_HEAD Head;\r
+ UINT32 Fourth;\r
+} IP6_ICMP_INFORMATION_HEAD;\r
\r
//\r
// UDP header definition\r
UINT16 DstPort;\r
UINT16 Length;\r
UINT16 Checksum;\r
-} EFI_UDP4_HEADER;\r
-\r
+} EFI_UDP_HEADER;\r
\r
//\r
// TCP header definition\r
#define NTOHS(x) (UINT16)((((UINT16) (x) & 0xff) << 8) | \\r
(((UINT16) (x) & 0xff00) >> 8))\r
\r
-#define HTONS(x) NTOHS(x)\r
+#define HTONS(x) NTOHS(x)\r
+#define NTOHLL(x) SwapBytes64 (x)\r
+#define HTONLL(x) NTOHLL(x)\r
+#define NTOHLLL(x) Ip6Swap128 (x)\r
+#define HTONLLL(x) NTOHLLL(x)\r
\r
//\r
// Test the IP's attribute, All the IPs are in host byte order.\r
#define IP4_NET_EQUAL(Ip1, Ip2, NetMask) (((Ip1) & (NetMask)) == ((Ip2) & (NetMask)))\r
#define IP4_IS_VALID_NETMASK(Ip) (NetGetMaskLength (Ip) != IP4_MASK_NUM)\r
\r
+#define IP6_IS_MULTICAST(Ip6) (((Ip6)->Addr[0]) == 0xFF)\r
+\r
//\r
// Convert the EFI_IP4_ADDRESS to plain UINT32 IP4 address.\r
//\r
#define EFI_NTOHL(EfiIp) (NTOHL (EFI_IP4 ((EfiIp))))\r
#define EFI_IP4_EQUAL(Ip1, Ip2) (CompareMem ((Ip1), (Ip2), sizeof (EFI_IPv4_ADDRESS)) == 0)\r
\r
+#define EFI_IP6_EQUAL(Ip1, Ip2) (CompareMem ((Ip1), (Ip2), sizeof (EFI_IPv6_ADDRESS)) == 0)\r
+\r
+#define IP6_COPY_ADDRESS(Dest, Src) (CopyMem ((Dest), (Src), sizeof (EFI_IPv6_ADDRESS)))\r
+#define IP6_COPY_LINK_ADDRESS(Mac1, Mac2) (CopyMem ((Mac1), (Mac2), sizeof (EFI_MAC_ADDRESS)))\r
+\r
+//\r
+// The debug level definition. This value is also used as the \r
+// syslog's servity level. Don't change it. \r
+//\r
+#define NETDEBUG_LEVEL_TRACE 5\r
+#define NETDEBUG_LEVEL_WARNING 4\r
+#define NETDEBUG_LEVEL_ERROR 3\r
+\r
+//\r
+// Network debug message is sent out as syslog packet. \r
+//\r
+#define NET_SYSLOG_FACILITY 16 // Syslog local facility local use\r
+#define NET_SYSLOG_PACKET_LEN 512 \r
+#define NET_SYSLOG_TX_TIMEOUT 500 *1000 *10 // 500ms\r
+#define NET_DEBUG_MSG_LEN 470 // 512 - (ether+ip4+udp4 head length)\r
+\r
+//\r
+// The debug output expects the ASCII format string, Use %a to print ASCII \r
+// string, and %s to print UNICODE string. PrintArg must be enclosed in (). \r
+// For example: NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name));\r
+//\r
+#define NET_DEBUG_TRACE(Module, PrintArg) \\r
+ NetDebugOutput ( \\r
+ NETDEBUG_LEVEL_TRACE, \\r
+ Module, \\r
+ __FILE__, \\r
+ __LINE__, \\r
+ NetDebugASPrint PrintArg \\r
+ )\r
+\r
+#define NET_DEBUG_WARNING(Module, PrintArg) \\r
+ NetDebugOutput ( \\r
+ NETDEBUG_LEVEL_WARNING, \\r
+ Module, \\r
+ __FILE__, \\r
+ __LINE__, \\r
+ NetDebugASPrint PrintArg \\r
+ )\r
+\r
+#define NET_DEBUG_ERROR(Module, PrintArg) \\r
+ NetDebugOutput ( \\r
+ NETDEBUG_LEVEL_ERROR, \\r
+ Module, \\r
+ __FILE__, \\r
+ __LINE__, \\r
+ NetDebugASPrint PrintArg \\r
+ )\r
+\r
+/**\r
+ Allocate a buffer, then format the message to it. This is a \r
+ help function for the NET_DEBUG_XXX macros. The PrintArg of \r
+ these macros treats the variable length print parameters as a \r
+ single parameter, and pass it to the NetDebugASPrint. For\r
+ example, NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name))\r
+ if extracted to: \r
+ \r
+ NetDebugOutput (\r
+ NETDEBUG_LEVEL_TRACE, \r
+ "Tcp", \r
+ __FILE__,\r
+ __LINE__,\r
+ NetDebugASPrint ("State transit to %a\n", Name) \r
+ ) \r
+ \r
+ @param Format The ASCII format string.\r
+ @param ... The variable length parameter whose format is determined \r
+ by the Format string.\r
+\r
+ @return The buffer containing the formatted message,\r
+ or NULL if failed to allocate memory.\r
+\r
+**/\r
+CHAR8 *\r
+NetDebugASPrint (\r
+ IN CHAR8 *Format,\r
+ ...\r
+ );\r
+\r
+/**\r
+ Builds an UDP4 syslog packet and send it using SNP.\r
+\r
+ This function will locate a instance of SNP then send the message through it.\r
+ Because it isn't open the SNP BY_DRIVER, apply caution when using it.\r
+\r
+ @param Level The servity level of the message.\r
+ @param Module The Moudle that generates the log.\r
+ @param File The file that contains the log.\r
+ @param Line The exact line that contains the log.\r
+ @param Message The user message to log.\r
+\r
+ @retval EFI_INVALID_PARAMETER Any input parameter is invalid.\r
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the packet\r
+ @retval EFI_SUCCESS The log is discard because that it is more verbose \r
+ than the mNetDebugLevelMax. Or, it has been sent out.\r
+**/ \r
+EFI_STATUS\r
+NetDebugOutput (\r
+ IN UINT32 Level, \r
+ IN UINT8 *Module,\r
+ IN UINT8 *File,\r
+ IN UINT32 Line,\r
+ IN UINT8 *Message\r
+ );\r
+\r
+\r
/**\r
Return the length of the mask. \r
\r
- Return the length of the mask, the correct value is from 0 to 32.\r
+ Return the length of the mask. Valid values are 0 to 32.\r
If the mask is invalid, return the invalid length 33, which is IP4_MASK_NUM.\r
NetMask is in the host byte order.\r
\r
@param[in] NetMask The netmask to get the length from.\r
\r
- @return The length of the netmask, IP4_MASK_NUM if the mask is invalid.\r
+ @return The length of the netmask, or IP4_MASK_NUM (33) if the mask is invalid.\r
\r
**/\r
INTN\r
\r
If Ip is 0, IP is not a valid unicast address.\r
Class D address is used for multicasting and class E address is reserved for future. If Ip\r
- belongs to class D or class E, IP is not a valid unicast address. \r
- If all bits of the host address of IP are 0 or 1, IP is also not a valid unicast address.\r
+ belongs to class D or class E, Ip is not a valid unicast address. \r
+ If all bits of the host address of Ip are 0 or 1, Ip is not a valid unicast address.\r
\r
@param[in] Ip The IP to check against.\r
@param[in] NetMask The mask of the IP.\r
\r
- @return TRUE if IP is a valid unicast address on the network, otherwise FALSE.\r
+ @return TRUE if Ip is a valid unicast address on the network, otherwise FALSE.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-Ip4IsUnicast (\r
+NetIp4IsUnicast (\r
IN IP4_ADDR Ip,\r
IN IP4_ADDR NetMask\r
);\r
\r
-extern IP4_ADDR gIp4AllMasks [IP4_MASK_NUM];\r
+/**\r
+ Check whether the incoming IPv6 address is a valid unicast address.\r
+\r
+ If the address is a multicast address has binary 0xFF at the start, it is not\r
+ a valid unicast address. If the address is unspecified ::, it is not a valid\r
+ unicast address to be assigned to any node. If the address is loopback address\r
+ ::1, it is also not a valid unicast address to be assigned to any physical\r
+ interface. \r
+\r
+ @param[in] Ip6 The IPv6 address to check against.\r
+\r
+ @return TRUE if Ip6 is a valid unicast address on the network, otherwise FALSE.\r
+\r
+**/ \r
+BOOLEAN\r
+NetIp6IsValidUnicast (\r
+ IN EFI_IPv6_ADDRESS *Ip6\r
+ );\r
+\r
+\r
+/**\r
+ Check whether the incoming Ipv6 address is the unspecified address or not.\r
+\r
+ @param[in] Ip6 - Ip6 address, in network order.\r
+\r
+ @retval TRUE - Yes, unspecified\r
+ @retval FALSE - No\r
+ \r
+**/\r
+BOOLEAN\r
+NetIp6IsUnspecifiedAddr (\r
+ IN EFI_IPv6_ADDRESS *Ip6\r
+ );\r
+\r
+/**\r
+ Check whether the incoming Ipv6 address is a link-local address.\r
+\r
+ @param[in] Ip6 - Ip6 address, in network order.\r
+\r
+ @retval TRUE - Yes, link-local address\r
+ @retval FALSE - No\r
+ \r
+**/\r
+BOOLEAN\r
+NetIp6IsLinkLocalAddr (\r
+ IN EFI_IPv6_ADDRESS *Ip6\r
+ );\r
+\r
+/**\r
+ Check whether the Ipv6 address1 and address2 are on the connected network.\r
+\r
+ @param[in] Ip1 - Ip6 address1, in network order.\r
+ @param[in] Ip2 - Ip6 address2, in network order.\r
+ @param[in] PrefixLength - The prefix length of the checking net.\r
+\r
+ @retval TRUE - Yes, connected.\r
+ @retval FALSE - No.\r
+ \r
+**/\r
+BOOLEAN\r
+NetIp6IsNetEqual (\r
+ EFI_IPv6_ADDRESS *Ip1,\r
+ EFI_IPv6_ADDRESS *Ip2,\r
+ UINT8 PrefixLength\r
+ );\r
+\r
+/**\r
+ Switches the endianess of an IPv6 address\r
+\r
+ This function swaps the bytes in a 128-bit IPv6 address to switch the value\r
+ from little endian to big endian or vice versa. The byte swapped value is\r
+ returned.\r
+\r
+ @param Ip6 Points to an IPv6 address\r
+\r
+ @return The byte swapped IPv6 address.\r
+\r
+**/\r
+EFI_IPv6_ADDRESS *\r
+Ip6Swap128 (\r
+ EFI_IPv6_ADDRESS *Ip6\r
+ );\r
+\r
+extern IP4_ADDR gIp4AllMasks[IP4_MASK_NUM];\r
\r
\r
extern EFI_IPv4_ADDRESS mZeroIp4Addr;\r
/**\r
Extract a UINT32 from a byte stream.\r
\r
- Copy a UINT32 from a byte stream, then converts it from Network \r
+ This function copies a UINT32 from a byte stream, and then converts it from Network \r
byte order to host byte order. Use this function to avoid alignment error.\r
\r
@param[in] Buf The buffer to extract the UINT32.\r
);\r
\r
/**\r
- Put a UINT32 to the byte stream in network byte order. \r
+ Puts a UINT32 into the byte stream in network byte order. \r
\r
- Converts a UINT32 from host byte order to network byte order. Then copy it to the \r
+ Converts a UINT32 from host byte order to network byte order, and then copies it to the \r
byte stream.\r
\r
@param[in, out] Buf The buffer to put the UINT32.\r
Initialize a random seed using current time.\r
\r
Get current time first. Then initialize a random seed based on some basic \r
- mathematics operation on the hour, day, minute, second, nanosecond and year \r
+ mathematical operations on the hour, day, minute, second, nanosecond and year \r
of the current time.\r
\r
- @return The random seed initialized with current time.\r
+ @return The random seed, initialized with current time.\r
\r
**/\r
UINT32\r
CR(Entry, Type, Field, Sig)\r
\r
//\r
-// Iterate through the doule linked list. It is NOT delete safe\r
+// Iterate through the double linked list. It is NOT delete safe\r
//\r
#define NET_LIST_FOR_EACH(Entry, ListHead) \\r
for(Entry = (ListHead)->ForwardLink; Entry != (ListHead); Entry = Entry->ForwardLink)\r
\r
//\r
-// Iterate through the doule linked list. This is delete-safe.\r
+// Iterate through the double linked list. This is delete-safe.\r
// Don't touch NextEntry. Also, don't use this macro if list\r
// entries other than the Entry may be deleted when processing\r
// the current Entry.\r
)\r
\r
//\r
-// Make sure the list isn't empty before get the frist/last record.\r
+// Make sure the list isn't empty before getting the first/last record.\r
//\r
#define NET_LIST_HEAD(ListHead, Type, Field) \\r
NET_LIST_USER_STRUCT((ListHead)->ForwardLink, Type, Field)\r
/**\r
Remove the first node entry on the list, and return the removed node entry.\r
\r
- Removes the first node Entry from a doubly linked list. It is up to the caller of\r
- this function to release the memory used by the first node if that is required. On\r
+ Removes the first node entry from a doubly linked list. It is up to the caller of\r
+ this function to release the memory used by the first node, if that is required. On\r
exit, the removed node is returned. \r
\r
If Head is NULL, then ASSERT().\r
);\r
\r
/**\r
- Remove the last node entry on the list and and return the removed node entry.\r
+ Remove the last node entry on the list and return the removed node entry.\r
\r
Removes the last node entry from a doubly linked list. It is up to the caller of\r
- this function to release the memory used by the first node if that is required. On\r
+ this function to release the memory used by the first node, if that is required. On\r
exit, the removed node is returned. \r
\r
If Head is NULL, then ASSERT().\r
/**\r
Insert a new node entry after a designated node entry of a doubly linked list.\r
\r
- Inserts a new node entry donated by NewEntry after the node entry donated by PrevEntry\r
+ Inserts a new node entry designated by NewEntry after the node entry designated by PrevEntry\r
of the doubly linked list.\r
\r
- @param[in, out] PrevEntry The previous entry to insert after.\r
+ @param[in, out] PrevEntry The entry after which to insert. \r
@param[in, out] NewEntry The new entry to insert.\r
\r
**/\r
/**\r
Insert a new node entry before a designated node entry of a doubly linked list.\r
\r
- Inserts a new node entry donated by NewEntry after the node entry donated by PostEntry\r
+ Inserts a new node entry designated by NewEntry before the node entry designated by PostEntry\r
of the doubly linked list.\r
\r
@param[in, out] PostEntry The entry to insert before.\r
/**\r
To clean up the netmap, that is, release allocated memories.\r
\r
- Removes all nodes of the Used doubly linked list and free memory of all related netmap items.\r
+ Removes all nodes of the Used doubly linked list and frees memory of all related netmap items.\r
Removes all nodes of the Recycled doubly linked list and free memory of all related netmap items.\r
- The number of the <Key, Value> pairs in the netmap is set to be zero.\r
+ The number of the <Key, Value> pairs in the netmap is set to zero.\r
\r
If Map is NULL, then ASSERT().\r
\r
);\r
\r
/**\r
- Find the key in the netmap and returns the point to the item contains the Key.\r
+ Finds the key in the netmap and returns the point to the item containing the Key.\r
\r
Iterate the Used doubly linked list of the netmap to get every item. Compare the key of every \r
item with the key to search. It returns the point to the item contains the Key if found.\r
NetMapIterate (\r
IN NET_MAP *Map,\r
IN NET_MAP_CALLBACK CallBack,\r
- IN VOID *Arg\r
+ IN VOID *Arg OPTIONAL\r
);\r
\r
\r
@param[in] Controller The controller which has the service installed.\r
@param[in] Image The image handle used to open service.\r
@param[in] ServiceBindingGuid The service's Guid.\r
- @param[in, out] ChildHandle The handle to receive the create child.\r
+ @param[in, out] ChildHandle The handle to receive the created child.\r
\r
- @retval EFI_SUCCESS The child is successfully created.\r
+ @retval EFI_SUCCESS The child was successfully created.\r
@retval Others Failed to create the child.\r
\r
**/\r
);\r
\r
/**\r
- Destory a child of the service that is identified by ServiceBindingGuid.\r
+ Destroy a child of the service that is identified by ServiceBindingGuid.\r
\r
Get the ServiceBinding Protocol first, then use it to destroy a child.\r
\r
@param[in] Controller The controller which has the service installed.\r
@param[in] Image The image handle used to open service.\r
@param[in] ServiceBindingGuid The service's Guid.\r
- @param[in] ChildHandle The child to destory.\r
+ @param[in] ChildHandle The child to destroy.\r
\r
- @retval EFI_SUCCESS The child is successfully destoried.\r
- @retval Others Failed to destory the child.\r
+ @retval EFI_SUCCESS The child is successfully destroyed.\r
+ @retval Others Failed to destroy the child.\r
\r
**/\r
EFI_STATUS\r
\r
Get the mac address of the Simple Network protocol from the SnpHandle. Then convert\r
the mac address into a unicode string. It takes 2 unicode characters to represent \r
- a 1 byte binary buffer. Plus one unicode character for the null-terminator.\r
+ a 1 byte binary buffer, plus one unicode character for the null terminator.\r
\r
\r
- @param[in] SnpHandle The handle where the simple network protocol is\r
- installed on.\r
- @param[in] ImageHandle The image handle used to act as the agent handle to\r
+ @param[in] SnpHandle The handle on which the simple network protocol is\r
+ installed.\r
+ @param[in] ImageHandle The image handle to act as the agent handle to\r
get the simple network protocol.\r
@param[out] MacString The pointer to store the address of the string\r
representation of the mac address.\r
\r
- @retval EFI_SUCCESS Convert the mac address a unicode string successfully.\r
- @retval EFI_OUT_OF_RESOURCES There are not enough memory resource.\r
+ @retval EFI_SUCCESS Converted the mac address a unicode string successfully.\r
+ @retval EFI_OUT_OF_RESOURCES There are not enough memory resources.\r
@retval Others Failed to open the simple network protocol.\r
\r
**/\r
Get other info from parameters to make up the whole IPv4 device path node.\r
\r
@param[in, out] Node Pointer to the IPv4 device path node.\r
- @param[in] Controller The handle where the NIC IP4 config protocol resides.\r
+ @param[in] Controller The controller handle.\r
@param[in] LocalIp The local IPv4 address.\r
@param[in] LocalPort The local port.\r
@param[in] RemoteIp The remote IPv4 address.\r
IN BOOLEAN UseDefaultAddress\r
);\r
\r
+/**\r
+ Create an IPv6 device path node.\r
+ \r
+ The header type of IPv6 device path node is MESSAGING_DEVICE_PATH.\r
+ The header subtype of IPv6 device path node is MSG_IPv6_DP.\r
+ The length of the IPv6 device path node in bytes is 43.\r
+ Get other info from parameters to make up the whole IPv6 device path node.\r
+\r
+ @param[in, out] Node Pointer to the IPv6 device path node.\r
+ @param[in] Controller The controller handle.\r
+ @param[in] LocalIp The local IPv6 address.\r
+ @param[in] LocalPort The local port.\r
+ @param[in] RemoteIp The remote IPv6 address.\r
+ @param[in] RemotePort The remote port.\r
+ @param[in] Protocol The protocol type in the IP header.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+NetLibCreateIPv6DPathNode (\r
+ IN OUT IPv6_DEVICE_PATH *Node,\r
+ IN EFI_HANDLE Controller,\r
+ IN EFI_IPv6_ADDRESS *LocalIp,\r
+ IN UINT16 LocalPort,\r
+ IN EFI_IPv6_ADDRESS *RemoteIp,\r
+ IN UINT16 RemotePort,\r
+ IN UINT16 Protocol\r
+ );\r
+\r
+\r
/**\r
Find the UNDI/SNP handle from controller and protocol GUID.\r
\r
- For example, IP will open a MNP child to transmit/receive\r
- packets, when MNP is stopped, IP should also be stopped. IP\r
+ For example, IP will open an MNP child to transmit/receive\r
+ packets. When MNP is stopped, IP should also be stopped. IP\r
needs to find its own private data which is related the IP's\r
service binding instance that is install on UNDI/SNP handle.\r
Now, the controller is either a MNP or ARP child handle. But\r
IN EFI_GUID *ProtocolGuid\r
);\r
\r
-/**\r
- Add a Deferred Procedure Call to the end of the DPC queue.\r
-\r
- @param[in] DpcTpl The EFI_TPL that the DPC should be invoked.\r
- @param[in] DpcProcedure Pointer to the DPC's function.\r
- @param[in] DpcContext Pointer to the DPC's context. Passed to DpcProcedure\r
- when DpcProcedure is invoked.\r
-\r
- @retval EFI_SUCCESS The DPC was queued.\r
- @retval EFI_INVALID_PARAMETER DpcTpl is not a valid EFI_TPL, or DpcProcedure\r
- is NULL.\r
- @retval EFI_OUT_OF_RESOURCES There are not enough resources available to\r
- add the DPC to the queue.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-NetLibQueueDpc (\r
- IN EFI_TPL DpcTpl,\r
- IN EFI_DPC_PROCEDURE DpcProcedure,\r
- IN VOID *DpcContext OPTIONAL\r
- );\r
-\r
-/**\r
- Dispatch the queue of DPCs. ALL DPCs that have been queued with a DpcTpl\r
- value greater than or equal to the current TPL are invoked in the order that\r
- they were queued. DPCs with higher DpcTpl values are invoked before DPCs with\r
- lower DpcTpl values.\r
-\r
- @retval EFI_SUCCESS One or more DPCs were invoked.\r
- @retval EFI_NOT_FOUND No DPCs were invoked.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-NetLibDispatchDpc (\r
- VOID\r
- );\r
-\r
/**\r
This is the default unload handle for all the network drivers.\r
\r
IN EFI_HANDLE ImageHandle\r
);\r
\r
-typedef enum {\r
- //\r
- //Various signatures\r
- //\r
- NET_BUF_SIGNATURE = SIGNATURE_32 ('n', 'b', 'u', 'f'),\r
- NET_VECTOR_SIGNATURE = SIGNATURE_32 ('n', 'v', 'e', 'c'),\r
- NET_QUE_SIGNATURE = SIGNATURE_32 ('n', 'b', 'q', 'u'),\r
+\r
+//\r
+//Various signatures\r
+//\r
+#define NET_BUF_SIGNATURE SIGNATURE_32 ('n', 'b', 'u', 'f')\r
+#define NET_VECTOR_SIGNATURE SIGNATURE_32 ('n', 'v', 'e', 'c')\r
+#define NET_QUE_SIGNATURE SIGNATURE_32 ('n', 'b', 'q', 'u')\r
\r
\r
- NET_PROTO_DATA = 64, // Opaque buffer for protocols\r
- NET_BUF_HEAD = 1, // Trim or allocate space from head\r
- NET_BUF_TAIL = 0, // Trim or allocate space from tail\r
- NET_VECTOR_OWN_FIRST = 0x01 // We allocated the 1st block in the vector\r
-} NET_SIGNATURE_TYPE;\r
+#define NET_PROTO_DATA 64 // Opaque buffer for protocols\r
+#define NET_BUF_HEAD 1 // Trim or allocate space from head\r
+#define NET_BUF_TAIL 0 // Trim or allocate space from tail\r
+#define NET_VECTOR_OWN_FIRST 0x01 // We allocated the 1st block in the vector\r
\r
#define NET_CHECK_SIGNATURE(PData, SIGNATURE) \\r
ASSERT (((PData) != NULL) && ((PData)->Signature == (SIGNATURE)))\r
} NET_VECTOR;\r
\r
//\r
-//NET_BLOCK_OP operate on the NET_BLOCK, It specifies\r
-//where the actual fragment begins and where it ends\r
+//NET_BLOCK_OP operates on the NET_BLOCK. It specifies\r
+//where the actual fragment begins and ends\r
//\r
typedef struct {\r
UINT8 *BlockHead; // Block's head, or the smallest valid Head\r
UINT32 Size; // The size of the data\r
} NET_BLOCK_OP;\r
\r
+typedef union {\r
+ IP4_HEAD *Ip4;\r
+ EFI_IP6_HEADER *Ip6;\r
+} NET_IP_HEAD;\r
\r
//\r
//NET_BUF is the buffer manage structure used by the\r
-//network stack. Every network packet may be fragmented,\r
-//and contains multiple fragments. The Vector points to\r
-//memory blocks used by the each fragment, and BlockOp\r
+//network stack. Every network packet may be fragmented. The Vector points to\r
+//memory blocks used by each fragment, and BlockOp\r
//specifies where each fragment begins and ends.\r
//\r
-//It also contains a opaque area for protocol to store\r
-//per-packet informations. Protocol must be caution not\r
+//It also contains an opaque area for the protocol to store\r
+//per-packet information. Protocol must be careful not\r
//to overwrite the members after that.\r
//\r
typedef struct {\r
- UINT32 Signature;\r
- INTN RefCnt;\r
- LIST_ENTRY List; // The List this NET_BUF is on\r
+ UINT32 Signature;\r
+ INTN RefCnt;\r
+ LIST_ENTRY List; // The List this NET_BUF is on\r
\r
- IP4_HEAD *Ip; // Network layer header, for fast access\r
- TCP_HEAD *Tcp; // Transport layer header, for fast access\r
- UINT8 ProtoData [NET_PROTO_DATA]; //Protocol specific data\r
+ NET_IP_HEAD Ip; // Network layer header, for fast access\r
+ TCP_HEAD *Tcp; // Transport layer header, for fast access\r
+ EFI_UDP_HEADER *Udp; // User Datagram Protocol header\r
+ UINT8 ProtoData [NET_PROTO_DATA]; //Protocol specific data\r
\r
- NET_VECTOR *Vector; // The vector containing the packet\r
+ NET_VECTOR *Vector; // The vector containing the packet\r
\r
- UINT32 BlockOpNum; // Total number of BlockOp in the buffer\r
- UINT32 TotalSize; // Total size of the actual packet\r
- NET_BLOCK_OP BlockOp[1]; // Specify the position of actual packet\r
+ UINT32 BlockOpNum; // Total number of BlockOp in the buffer\r
+ UINT32 TotalSize; // Total size of the actual packet\r
+ NET_BLOCK_OP BlockOp[1]; // Specify the position of actual packet\r
} NET_BUF;\r
\r
-\r
//\r
-//A queue of NET_BUFs, It is just a thin extension of\r
+//A queue of NET_BUFs. It is a thin extension of\r
//NET_BUF functions.\r
//\r
typedef struct {\r
UINT8 Protocol;\r
UINT16 Len;\r
} NET_PSEUDO_HDR;\r
+\r
+typedef struct {\r
+ EFI_IPv6_ADDRESS SrcIp;\r
+ EFI_IPv6_ADDRESS DstIp;\r
+ UINT32 Len;\r
+ UINT32 Reserved:24;\r
+ UINT32 NextHeader:8;\r
+} NET_IP6_PSEUDO_HDR;\r
#pragma pack()\r
\r
//\r
\r
Decrease the reference count of the net buffer by one. Free the associated net\r
vector and itself if the reference count of the net buffer is decreased to 0. \r
- The net vector free operation just decrease the reference count of the net \r
- vector by one and do the real resource free operation when the reference count\r
+ The net vector free operation decreases the reference count of the net \r
+ vector by one, and performs the resource free operation when the reference count\r
of the net vector is 0. \r
\r
@param[in] Nbuf Pointer to the NET_BUF to be freed.\r
Get the index of NET_BLOCK_OP that contains the byte at Offset in the net \r
buffer. \r
\r
- This can be used to, for example, retrieve the IP header in the packet. It \r
- also can be used to get the fragment that contains the byte which is used \r
+ For example, this function can be used to retrieve the IP header in the packet. It \r
+ also can be used to get the fragment that contains the byte used \r
mainly by the library implementation itself. \r
\r
@param[in] Nbuf Pointer to the net buffer.\r
/**\r
Reserve some space in the header room of the net buffer.\r
\r
- Upon allocation, all the space are in the tail room of the buffer. Call this \r
+ Upon allocation, all the space is in the tail room of the buffer. Call this \r
function to move some space to the header room. This function is quite limited\r
in that it can only reserve space from the first block of an empty NET_BUF not \r
built from the external. But it should be enough for the network stack. \r
@param[in] FromHead The flag to indicate whether trim data from head \r
(TRUE) or tail (FALSE).\r
\r
- @return Length of the actually trimmed data, which is possible to be less \r
- than Len because the TotalSize of Nbuf is less than Len.\r
+ @return Length of the actually trimmed data, which may be less \r
+ than Len if the TotalSize of Nbuf is less than Len.\r
\r
**/\r
UINT32\r
Copy Len bytes of data from the specific offset of the net buffer to the \r
destination memory.\r
\r
- The Len bytes of data may cross the several fragments of the net buffer.\r
+ The Len bytes of data may cross several fragments of the net buffer.\r
\r
@param[in] Nbuf Pointer to the net buffer.\r
@param[in] Offset The sequence number of the first byte to copy.\r
/**\r
Build a NET_BUF from external blocks. \r
\r
- A new NET_BUF structure will be created from external blocks. Additional block\r
+ A new NET_BUF structure will be created from external blocks. An additional block\r
of memory will be allocated to hold reserved HeadSpace bytes of header room\r
- and existing HeadLen bytes of header but the external blocks are shared by the\r
+ and existing HeadLen bytes of header, but the external blocks are shared by the\r
net buffer to avoid data copying.\r
\r
@param[in] ExtFragment Pointer to the data block.\r
@param[in] ExtNum The number of the data blocks.\r
@param[in] HeadSpace The head space to be reserved.\r
- @param[in] HeadLen The length of the protocol header, This function\r
- will pull that number of data into a linear block.\r
- @param[in] ExtFree Pointer to the caller provided free function.\r
+ @param[in] HeadLen The length of the protocol header. The function\r
+ pulls this amount of data into a linear block.\r
+ @param[in] ExtFree Pointer to the caller-provided free function.\r
@param[in] Arg The argument passed to ExtFree when ExtFree is\r
called.\r
\r
@param[in, out] ExtFragment Pointer to the data block.\r
@param[in, out] ExtNum The number of the data blocks.\r
\r
- @retval EFI_BUFFER_TOO_SMALL The number of non-empty block is bigger than \r
+ @retval EFI_BUFFER_TOO_SMALL The number of non-empty blocks is bigger than \r
ExtNum.\r
@retval EFI_SUCCESS Fragment table is built successfully.\r
\r
\r
@param[in] BufList A List of the net buffer.\r
@param[in] HeadSpace The head space to be reserved.\r
- @param[in] HeaderLen The length of the protocol header, This function\r
- will pull that number of data into a linear block.\r
+ @param[in] HeaderLen The length of the protocol header. The function\r
+ pulls this amount of data into a linear block.\r
@param[in] ExtFree Pointer to the caller provided free function.\r
@param[in] Arg The argument passed to ExtFree when ExtFree is called.\r
\r
);\r
\r
/**\r
- Trim Len bytes of data from the queue header, release any of the net buffer \r
- whom is trimmed wholely.\r
+ Trim Len bytes of data from the queue header and release any net buffer \r
+ that is trimmed wholely.\r
\r
The trimming operation is the same as NetbufTrim but applies to the net buffer\r
queue instead of the net buffer.\r
IN UINT16 Len\r
);\r
\r
+/**\r
+ Compute the checksum for TCP6/UDP6 pseudo header. \r
+ \r
+ Src and Dst are in network byte order, and Len is in host byte order.\r
+\r
+ @param[in] Src The source address of the packet.\r
+ @param[in] Dst The destination address of the packet.\r
+ @param[in] NextHeader The protocol type of the packet.\r
+ @param[in] Len The length of the packet.\r
+\r
+ @return The computed checksum.\r
+\r
+**/\r
+UINT16\r
+NetIp6PseudoHeadChecksum (\r
+ IN EFI_IPv6_ADDRESS *Src,\r
+ IN EFI_IPv6_ADDRESS *Dst,\r
+ IN UINT8 NextHeader,\r
+ IN UINT32 Len\r
+ );\r
#endif\r
projects / mirror_edk2.git / blobdiff