+typedef struct {\r
+ LIST_ENTRY Link;\r
+ VOID *Key;\r
+ VOID *Value;\r
+} NET_MAP_ITEM;\r
+\r
+typedef struct {\r
+ LIST_ENTRY Used;\r
+ LIST_ENTRY Recycled;\r
+ UINTN Count;\r
+} NET_MAP;\r
+\r
+#define NET_MAP_INCREAMENT 64\r
+\r
+/**\r
+ Initialize the netmap. Netmap is a reposity to keep the <Key, Value> pairs.\r
+\r
+ Initialize the forward and backward links of two head nodes donated by Map->Used\r
+ and Map->Recycled of two doubly linked lists.\r
+ Initializes the count of the <Key, Value> pairs in the netmap to zero.\r
+\r
+ If Map is NULL, then ASSERT().\r
+ If the address of Map->Used is NULL, then ASSERT().\r
+ If the address of Map->Recycled is NULl, then ASSERT().\r
+\r
+ @param[in, out] Map The netmap to initialize.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+NetMapInit (\r
+ IN OUT NET_MAP *Map\r
+ );\r
+\r
+/**\r
+ To clean up the netmap, that is, release allocated memories.\r
+\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 zero.\r
+\r
+ If Map is NULL, then ASSERT().\r
+\r
+ @param[in, out] Map The netmap to clean up.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+NetMapClean (\r
+ IN OUT NET_MAP *Map\r
+ );\r
+\r
+/**\r
+ Test whether the netmap is empty and return true if it is.\r
+\r
+ If the number of the <Key, Value> pairs in the netmap is zero, return TRUE.\r
+\r
+ If Map is NULL, then ASSERT().\r
+\r
+\r
+ @param[in] Map The net map to test.\r
+\r
+ @return TRUE if the netmap is empty, otherwise FALSE.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+NetMapIsEmpty (\r
+ IN NET_MAP *Map\r
+ );\r
+\r
+/**\r
+ Return the number of the <Key, Value> pairs in the netmap.\r
+\r
+ @param[in] Map The netmap to get the entry number.\r
+\r
+ @return The entry number in the netmap.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+NetMapGetCount (\r
+ IN NET_MAP *Map\r
+ );\r
+\r
+/**\r
+ Allocate an item to save the <Key, Value> pair to the head of the netmap.\r
+\r
+ Allocate an item to save the <Key, Value> pair and add corresponding node entry\r
+ to the beginning of the Used doubly linked list. The number of the <Key, Value>\r
+ pairs in the netmap increase by 1.\r
+\r
+ If Map is NULL, then ASSERT().\r
+\r
+ @param[in, out] Map The netmap to insert into.\r
+ @param[in] Key The user's key.\r
+ @param[in] Value The user's value for the key.\r
+\r
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.\r
+ @retval EFI_SUCCESS The item is inserted to the head.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetMapInsertHead (\r
+ IN OUT NET_MAP *Map,\r
+ IN VOID *Key,\r
+ IN VOID *Value OPTIONAL\r
+ );\r
+\r
+/**\r
+ Allocate an item to save the <Key, Value> pair to the tail of the netmap.\r
+\r
+ Allocate an item to save the <Key, Value> pair and add corresponding node entry\r
+ to the tail of the Used doubly linked list. The number of the <Key, Value>\r
+ pairs in the netmap increase by 1.\r
+\r
+ If Map is NULL, then ASSERT().\r
+\r
+ @param[in, out] Map The netmap to insert into.\r
+ @param[in] Key The user's key.\r
+ @param[in] Value The user's value for the key.\r
+\r
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.\r
+ @retval EFI_SUCCESS The item is inserted to the tail.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetMapInsertTail (\r
+ IN OUT NET_MAP *Map,\r
+ IN VOID *Key,\r
+ IN VOID *Value OPTIONAL\r
+ );\r
+\r
+/**\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
+\r
+ If Map is NULL, then ASSERT().\r
+\r
+ @param[in] Map The netmap to search within.\r
+ @param[in] Key The key to search.\r
+\r
+ @return The point to the item contains the Key, or NULL if Key isn't in the map.\r
+\r
+**/\r
+NET_MAP_ITEM *\r
+EFIAPI\r
+NetMapFindKey (\r
+ IN NET_MAP *Map,\r
+ IN VOID *Key\r
+ );\r
+\r
+/**\r
+ Remove the node entry of the item from the netmap and return the key of the removed item.\r
+\r
+ Remove the node entry of the item from the Used doubly linked list of the netmap.\r
+ The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node\r
+ entry of the item to the Recycled doubly linked list of the netmap. If Value is not NULL,\r
+ Value will point to the value of the item. It returns the key of the removed item.\r
+\r
+ If Map is NULL, then ASSERT().\r
+ If Item is NULL, then ASSERT().\r
+ if item in not in the netmap, then ASSERT().\r
+\r
+ @param[in, out] Map The netmap to remove the item from.\r
+ @param[in, out] Item The item to remove.\r
+ @param[out] Value The variable to receive the value if not NULL.\r
+\r
+ @return The key of the removed item.\r
+\r
+**/\r
+VOID *\r
+EFIAPI\r
+NetMapRemoveItem (\r
+ IN OUT NET_MAP *Map,\r
+ IN OUT NET_MAP_ITEM *Item,\r
+ OUT VOID **Value OPTIONAL\r
+ );\r
+\r
+/**\r
+ Remove the first node entry on the netmap and return the key of the removed item.\r
+\r
+ Remove the first node entry from the Used doubly linked list of the netmap.\r
+ The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node\r
+ entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,\r
+ parameter Value will point to the value of the item. It returns the key of the removed item.\r
+\r
+ If Map is NULL, then ASSERT().\r
+ If the Used doubly linked list is empty, then ASSERT().\r
+\r
+ @param[in, out] Map The netmap to remove the head from.\r
+ @param[out] Value The variable to receive the value if not NULL.\r
+\r
+ @return The key of the item removed.\r
+\r
+**/\r
+VOID *\r
+EFIAPI\r
+NetMapRemoveHead (\r
+ IN OUT NET_MAP *Map,\r
+ OUT VOID **Value OPTIONAL\r
+ );\r
+\r
+/**\r
+ Remove the last node entry on the netmap and return the key of the removed item.\r
+\r
+ Remove the last node entry from the Used doubly linked list of the netmap.\r
+ The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node\r
+ entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,\r
+ parameter Value will point to the value of the item. It returns the key of the removed item.\r
+\r
+ If Map is NULL, then ASSERT().\r
+ If the Used doubly linked list is empty, then ASSERT().\r
+\r
+ @param[in, out] Map The netmap to remove the tail from.\r
+ @param[out] Value The variable to receive the value if not NULL.\r
+\r
+ @return The key of the item removed.\r
+\r
+**/\r
+VOID *\r
+EFIAPI\r
+NetMapRemoveTail (\r
+ IN OUT NET_MAP *Map,\r
+ OUT VOID **Value OPTIONAL\r
+ );\r
+\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *NET_MAP_CALLBACK) (\r
+ IN NET_MAP *Map,\r
+ IN NET_MAP_ITEM *Item,\r
+ IN VOID *Arg\r
+ );\r
+\r
+/**\r
+ Iterate through the netmap and call CallBack for each item.\r
+\r
+ It will contiue the traverse if CallBack returns EFI_SUCCESS, otherwise, break\r
+ from the loop. It returns the CallBack's last return value. This function is\r
+ delete safe for the current item.\r
+\r
+ If Map is NULL, then ASSERT().\r
+ If CallBack is NULL, then ASSERT().\r
+\r
+ @param[in] Map The Map to iterate through.\r
+ @param[in] CallBack The callback function to call for each item.\r
+ @param[in] Arg The opaque parameter to the callback.\r
+\r
+ @retval EFI_SUCCESS There is no item in the netmap, or CallBack for each item\r
+ returns EFI_SUCCESS.\r
+ @retval Others It returns the CallBack's last return value.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetMapIterate (\r
+ IN NET_MAP *Map,\r
+ IN NET_MAP_CALLBACK CallBack,\r
+ IN VOID *Arg OPTIONAL\r
+ );\r
+\r
+\r
+//\r
+// Helper functions to implement driver binding and service binding protocols.\r
+//\r
+/**\r
+ Create a child of the service that is identified by ServiceBindingGuid.\r
+\r
+ Get the ServiceBinding Protocol first, then use it to create a child.\r
+\r
+ If ServiceBindingGuid is NULL, then ASSERT().\r
+ If ChildHandle is NULL, then ASSERT().\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 created child.\r
+\r
+ @retval EFI_SUCCESS The child was successfully created.\r
+ @retval Others Failed to create the child.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibCreateServiceChild (\r
+ IN EFI_HANDLE Controller,\r
+ IN EFI_HANDLE Image,\r
+ IN EFI_GUID *ServiceBindingGuid,\r
+ IN OUT EFI_HANDLE *ChildHandle\r
+ );\r
+\r
+/**\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
+ If ServiceBindingGuid is NULL, then ASSERT().\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 destroy.\r
+\r
+ @retval EFI_SUCCESS The child was destroyed.\r
+ @retval Others Failed to destroy the child.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibDestroyServiceChild (\r
+ IN EFI_HANDLE Controller,\r
+ IN EFI_HANDLE Image,\r
+ IN EFI_GUID *ServiceBindingGuid,\r
+ IN EFI_HANDLE ChildHandle\r
+ );\r
+\r
+/**\r
+ Get handle with Simple Network Protocol installed on it.\r
+\r
+ There should be MNP Service Binding Protocol installed on the input ServiceHandle.\r
+ If Simple Network Protocol is already installed on the ServiceHandle, the\r
+ ServiceHandle will be returned. If SNP is not installed on the ServiceHandle,\r
+ try to find its parent handle with SNP installed.\r
+\r
+ @param[in] ServiceHandle The handle where network service binding protocols are\r
+ installed on.\r
+ @param[out] Snp The pointer to store the address of the SNP instance.\r
+ This is an optional parameter that may be NULL.\r
+\r
+ @return The SNP handle, or NULL if not found.\r
+\r
+**/\r
+EFI_HANDLE\r
+EFIAPI\r
+NetLibGetSnpHandle (\r
+ IN EFI_HANDLE ServiceHandle,\r
+ OUT EFI_SIMPLE_NETWORK_PROTOCOL **Snp OPTIONAL\r
+ );\r
+\r
+/**\r
+ Retrieve VLAN ID of a VLAN device handle.\r
+\r
+ Search VLAN device path node in Device Path of specified ServiceHandle and\r
+ return its VLAN ID. If no VLAN device path node found, then this ServiceHandle\r
+ is not a VLAN device handle, and 0 will be returned.\r
+\r
+ @param[in] ServiceHandle The handle where network service binding protocols are\r
+ installed on.\r
+\r
+ @return VLAN ID of the device handle, or 0 if not a VLAN device.\r
+\r
+**/\r
+UINT16\r
+EFIAPI\r
+NetLibGetVlanId (\r
+ IN EFI_HANDLE ServiceHandle\r
+ );\r
+\r
+/**\r
+ Find VLAN device handle with specified VLAN ID.\r
+\r
+ The VLAN child device handle is created by VLAN Config Protocol on ControllerHandle.\r
+ This function will append VLAN device path node to the parent device path,\r
+ and then use LocateDevicePath() to find the correct VLAN device handle.\r
+\r
+ @param[in] ControllerHandle The handle where network service binding protocols are\r
+ installed on.\r
+ @param[in] VlanId The configured VLAN ID for the VLAN device.\r
+\r
+ @return The VLAN device handle, or NULL if not found.\r
+\r
+**/\r
+EFI_HANDLE\r
+EFIAPI\r
+NetLibGetVlanHandle (\r
+ IN EFI_HANDLE ControllerHandle,\r
+ IN UINT16 VlanId\r
+ );\r
+\r
+/**\r
+ Get MAC address associated with the network service handle.\r
+\r
+ There should be MNP Service Binding Protocol installed on the input ServiceHandle.\r
+ If SNP is installed on the ServiceHandle or its parent handle, MAC address will\r
+ be retrieved from SNP. If no SNP found, try to get SNP mode data use MNP.\r
+\r
+ @param[in] ServiceHandle The handle where network service binding protocols are\r
+ installed on.\r
+ @param[out] MacAddress The pointer to store the returned MAC address.\r
+ @param[out] AddressSize The length of returned MAC address.\r
+\r
+ @retval EFI_SUCCESS MAC address was returned successfully.\r
+ @retval Others Failed to get SNP mode data.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibGetMacAddress (\r
+ IN EFI_HANDLE ServiceHandle,\r
+ OUT EFI_MAC_ADDRESS *MacAddress,\r
+ OUT UINTN *AddressSize\r
+ );\r
+\r
+/**\r
+ Convert MAC address of the NIC associated with specified Service Binding Handle\r
+ to a unicode string. Callers are responsible for freeing the string storage.\r
+\r
+ Locate simple network protocol associated with the Service Binding Handle and\r
+ get the mac address from SNP. Then convert the mac address into a unicode\r
+ string. It takes 2 unicode characters to represent a 1 byte binary buffer.\r
+ Plus one unicode character for the null-terminator.\r
+\r
+ @param[in] ServiceHandle The handle where network service binding protocol is\r
+ installed.\r
+ @param[in] ImageHandle The image handle used to act as the agent handle to\r
+ get the simple network protocol. This parameter is\r
+ optional and may be NULL.\r
+ @param[out] MacString The pointer to store the address of the string\r
+ representation of the mac address.\r
+\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
+EFI_STATUS\r
+EFIAPI\r
+NetLibGetMacString (\r
+ IN EFI_HANDLE ServiceHandle,\r
+ IN EFI_HANDLE ImageHandle, OPTIONAL\r
+ OUT CHAR16 **MacString\r
+ );\r
+\r
+/**\r
+ Detect media status for specified network device.\r
+\r
+ The underlying UNDI driver may or may not support reporting media status from\r
+ GET_STATUS command (PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED). This routine\r
+ will try to invoke Snp->GetStatus() to get the media status. If media is already\r
+ present, it returns directly. If media is not present, it will stop SNP and then\r
+ restart SNP to get the latest media status. This provides an opportunity to get \r
+ the correct media status for old UNDI driver, which doesn't support reporting \r
+ media status from GET_STATUS command.\r
+ Note: there are two limitations for the current algorithm:\r
+ 1) For UNDI with this capability, when the cable is not attached, there will\r
+ be an redundant Stop/Start() process.\r
+ 2) for UNDI without this capability, in case that network cable is attached when\r
+ Snp->Initialize() is invoked while network cable is unattached later,\r
+ NetLibDetectMedia() will report MediaPresent as TRUE, causing upper layer\r
+ apps to wait for timeout time.\r
+\r
+ @param[in] ServiceHandle The handle where network service binding protocols are\r
+ installed.\r
+ @param[out] MediaPresent The pointer to store the media status.\r
+\r
+ @retval EFI_SUCCESS Media detection success.\r
+ @retval EFI_INVALID_PARAMETER ServiceHandle is not a valid network device handle.\r
+ @retval EFI_UNSUPPORTED The network device does not support media detection.\r
+ @retval EFI_DEVICE_ERROR SNP is in an unknown state.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibDetectMedia (\r
+ IN EFI_HANDLE ServiceHandle,\r
+ OUT BOOLEAN *MediaPresent\r
+ );\r
+\r
+/**\r
+ Create an IPv4 device path node.\r
+\r
+ The header type of IPv4 device path node is MESSAGING_DEVICE_PATH.\r
+ The header subtype of IPv4 device path node is MSG_IPv4_DP.\r
+ The length of the IPv4 device path node in bytes is 19.\r
+ Get other information from parameters to make up the whole IPv4 device path node.\r
+\r
+ @param[in, out] Node The pointer to the IPv4 device path node.\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
+ @param[in] RemotePort The remote port.\r
+ @param[in] Protocol The protocol type in the IP header.\r
+ @param[in] UseDefaultAddress Whether this instance is using default address or not.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+NetLibCreateIPv4DPathNode (\r
+ IN OUT IPv4_DEVICE_PATH *Node,\r
+ IN EFI_HANDLE Controller,\r
+ IN IP4_ADDR LocalIp,\r
+ IN UINT16 LocalPort,\r
+ IN IP4_ADDR RemoteIp,\r
+ IN UINT16 RemotePort,\r
+ IN UINT16 Protocol,\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 information from parameters to make up the whole IPv6 device path node.\r
+\r
+ @param[in, out] Node The 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 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 that is related the IP's\r
+ service binding instance that is installed on the UNDI/SNP handle.\r
+ The controller is then either an MNP or an ARP child handle. Note that\r
+ IP opens these handles using BY_DRIVER. Use that infomation to get the\r
+ UNDI/SNP handle.\r
+\r
+ @param[in] Controller The protocol handle to check.\r
+ @param[in] ProtocolGuid The protocol that is related with the handle.\r
+\r
+ @return The UNDI/SNP handle or NULL for errors.\r
+\r
+**/\r
+EFI_HANDLE\r
+EFIAPI\r
+NetLibGetNicHandle (\r
+ IN EFI_HANDLE Controller,\r
+ IN EFI_GUID *ProtocolGuid\r
+ );\r
+\r
+/**\r
+ This is the default unload handle for all the network drivers.\r
+\r
+ Disconnect the driver specified by ImageHandle from all the devices in the handle database.\r
+ Uninstall all the protocols installed in the driver entry point.\r
+\r
+ @param[in] ImageHandle The drivers' driver image.\r
+\r
+ @retval EFI_SUCCESS The image is unloaded.\r
+ @retval Others Failed to unload the image.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibDefaultUnload (\r
+ IN EFI_HANDLE ImageHandle\r
+ );\r
+\r
+/**\r
+ Convert one Null-terminated ASCII string (decimal dotted) to EFI_IPv4_ADDRESS.\r
+\r
+ @param[in] String The pointer to the Ascii string.\r
+ @param[out] Ip4Address The pointer to the converted IPv4 address.\r
+\r
+ @retval EFI_SUCCESS Converted to an IPv4 address successfully.\r
+ @retval EFI_INVALID_PARAMETER The string is malformated, or Ip4Address is NULL.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibAsciiStrToIp4 (\r
+ IN CONST CHAR8 *String,\r
+ OUT EFI_IPv4_ADDRESS *Ip4Address\r
+ );\r
+\r
+/**\r
+ Convert one Null-terminated ASCII string to EFI_IPv6_ADDRESS. The format of the\r
+ string is defined in RFC 4291 - Text Pepresentation of Addresses.\r
+\r
+ @param[in] String The pointer to the Ascii string.\r
+ @param[out] Ip6Address The pointer to the converted IPv6 address.\r
+\r
+ @retval EFI_SUCCESS Converted to an IPv6 address successfully.\r
+ @retval EFI_INVALID_PARAMETER The string is malformated, or Ip6Address is NULL.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibAsciiStrToIp6 (\r
+ IN CONST CHAR8 *String,\r
+ OUT EFI_IPv6_ADDRESS *Ip6Address\r
+ );\r
+\r
+/**\r
+ Convert one Null-terminated Unicode string (decimal dotted) to EFI_IPv4_ADDRESS.\r
+\r
+ @param[in] String The pointer to the Ascii string.\r
+ @param[out] Ip4Address The pointer to the converted IPv4 address.\r
+\r
+ @retval EFI_SUCCESS Converted to an IPv4 address successfully.\r
+ @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip4Address is NULL.\r
+ @retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to lack of resources.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibStrToIp4 (\r
+ IN CONST CHAR16 *String,\r
+ OUT EFI_IPv4_ADDRESS *Ip4Address\r
+ );\r
+\r
+/**\r
+ Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS. The format of\r
+ the string is defined in RFC 4291 - Text Pepresentation of Addresses.\r
+\r
+ @param[in] String The pointer to the Ascii string.\r
+ @param[out] Ip6Address The pointer to the converted IPv6 address.\r
+\r
+ @retval EFI_SUCCESS Converted to an IPv6 address successfully.\r
+ @retval EFI_INVALID_PARAMETER The string is malformated or Ip6Address is NULL.\r
+ @retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to a lack of resources.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibStrToIp6 (\r
+ IN CONST CHAR16 *String,\r
+ OUT EFI_IPv6_ADDRESS *Ip6Address\r
+ );\r
+\r
+/**\r
+ Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS and prefix length.\r
+ The format of the string is defined in RFC 4291 - Text Pepresentation of Addresses\r
+ Prefixes: ipv6-address/prefix-length.\r
+\r
+ @param[in] String The pointer to the Ascii string.\r
+ @param[out] Ip6Address The pointer to the converted IPv6 address.\r
+ @param[out] PrefixLength The pointer to the converted prefix length.\r
+\r
+ @retval EFI_SUCCESS Converted to an IPv6 address successfully.\r
+ @retval EFI_INVALID_PARAMETER The string is malformated, or Ip6Address is NULL.\r
+ @retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to a lack of resources.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibStrToIp6andPrefix (\r
+ IN CONST CHAR16 *String,\r
+ OUT EFI_IPv6_ADDRESS *Ip6Address,\r
+ OUT UINT8 *PrefixLength\r
+ );\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
+#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
+\r
+//\r
+// Single memory block in the vector.\r
+//\r
+typedef struct {\r
+ UINT32 Len; // The block's length\r
+ UINT8 *Bulk; // The block's Data\r
+} NET_BLOCK;\r
+\r
+typedef VOID (EFIAPI *NET_VECTOR_EXT_FREE) (VOID *Arg);\r
+\r
+//\r
+//NET_VECTOR contains several blocks to hold all packet's\r
+//fragments and other house-keeping stuff for sharing. It\r
+//doesn't specify the where actual packet fragment begins.\r
+//\r
+typedef struct {\r
+ UINT32 Signature;\r
+ INTN RefCnt; // Reference count to share NET_VECTOR.\r
+ NET_VECTOR_EXT_FREE Free; // external function to free NET_VECTOR\r
+ VOID *Arg; // opeque argument to Free\r
+ UINT32 Flag; // Flags, NET_VECTOR_OWN_FIRST\r
+ UINT32 Len; // Total length of the assocated BLOCKs\r
+\r
+ UINT32 BlockNum;\r
+ NET_BLOCK Block[1];\r
+} NET_VECTOR;\r
+\r
+//\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
+ UINT8 *BlockTail; // Block's tail. BlockTail-BlockHead=block length\r
+ UINT8 *Head; // 1st byte of the data in the block\r
+ UINT8 *Tail; // Tail of the data in the block, Tail-Head=Size\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. 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 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
+\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
+\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
+//A queue of NET_BUFs. It is a thin extension of\r
+//NET_BUF functions.\r
+//\r
+typedef struct {\r
+ UINT32 Signature;\r
+ INTN RefCnt;\r
+ LIST_ENTRY List; // The List this buffer queue is on\r
+\r
+ LIST_ENTRY BufList; // list of queued buffers\r
+ UINT32 BufSize; // total length of DATA in the buffers\r
+ UINT32 BufNum; // total number of buffers on the chain\r
+} NET_BUF_QUEUE;\r
+\r
+//\r
+// Pseudo header for TCP and UDP checksum\r
+//\r
+#pragma pack(1)\r
+typedef struct {\r
+ IP4_ADDR SrcIp;\r
+ IP4_ADDR DstIp;\r
+ UINT8 Reserved;\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
+// The fragment entry table used in network interfaces. This is\r
+// the same as NET_BLOCK now. Use two different to distinguish\r
+// the two in case that NET_BLOCK be enhanced later.\r
+//\r
+typedef struct {\r
+ UINT32 Len;\r
+ UINT8 *Bulk;\r
+} NET_FRAGMENT;\r
+\r
+#define NET_GET_REF(PData) ((PData)->RefCnt++)\r
+#define NET_PUT_REF(PData) ((PData)->RefCnt--)\r
+#define NETBUF_FROM_PROTODATA(Info) BASE_CR((Info), NET_BUF, ProtoData)\r
+\r
+#define NET_BUF_SHARED(Buf) \\r
+ (((Buf)->RefCnt > 1) || ((Buf)->Vector->RefCnt > 1))\r
+\r
+#define NET_VECTOR_SIZE(BlockNum) \\r
+ (sizeof (NET_VECTOR) + ((BlockNum) - 1) * sizeof (NET_BLOCK))\r
+\r
+#define NET_BUF_SIZE(BlockOpNum) \\r
+ (sizeof (NET_BUF) + ((BlockOpNum) - 1) * sizeof (NET_BLOCK_OP))\r
+\r
+#define NET_HEADSPACE(BlockOp) \\r
+ (UINTN)((BlockOp)->Head - (BlockOp)->BlockHead)\r
+\r
+#define NET_TAILSPACE(BlockOp) \\r
+ (UINTN)((BlockOp)->BlockTail - (BlockOp)->Tail)\r
+\r
+/**\r
+ Allocate a single block NET_BUF. Upon allocation, all the\r
+ free space is in the tail room.\r
+\r
+ @param[in] Len The length of the block.\r
+\r
+ @return The pointer to the allocated NET_BUF, or NULL if the\r
+ allocation failed due to resource limitations.\r
+\r
+**/\r
+NET_BUF *\r
+EFIAPI\r
+NetbufAlloc (\r
+ IN UINT32 Len\r
+ );\r
+\r
+/**\r
+ Free the net buffer and its associated NET_VECTOR.\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 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 The pointer to the NET_BUF to be freed.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+NetbufFree (\r
+ IN NET_BUF *Nbuf\r
+ );\r
+\r
+/**\r
+ Get the index of NET_BLOCK_OP that contains the byte at Offset in the net\r
+ buffer.\r
+\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 The pointer to the net buffer.\r
+ @param[in] Offset The offset of the byte.\r
+ @param[out] Index Index of the NET_BLOCK_OP that contains the byte at\r
+ Offset.\r
+\r
+ @return The pointer to the Offset'th byte of data in the net buffer, or NULL\r
+ if there is no such data in the net buffer.\r
+\r
+**/\r
+UINT8 *\r
+EFIAPI\r
+NetbufGetByte (\r
+ IN NET_BUF *Nbuf,\r
+ IN UINT32 Offset,\r
+ OUT UINT32 *Index OPTIONAL\r
+ );\r
+\r
+/**\r
+ Create a copy of the net buffer that shares the associated net vector.\r
+\r
+ The reference count of the newly created net buffer is set to 1. The reference\r
+ count of the associated net vector is increased by one.\r
+\r
+ @param[in] Nbuf The pointer to the net buffer to be cloned.\r
+\r
+ @return The pointer to the cloned net buffer, or NULL if the\r
+ allocation failed due to resource limitations.\r
+\r
+**/\r
+NET_BUF *\r
+EFIAPI\r
+NetbufClone (\r
+ IN NET_BUF *Nbuf\r
+ );\r
+\r
+/**\r
+ Create a duplicated copy of the net buffer with data copied and HeadSpace\r
+ bytes of head space reserved.\r
+\r
+ The duplicated net buffer will allocate its own memory to hold the data of the\r
+ source net buffer.\r
+\r
+ @param[in] Nbuf The pointer to the net buffer to be duplicated from.\r
+ @param[in, out] Duplicate The pointer to the net buffer to duplicate to. If\r
+ NULL, a new net buffer is allocated.\r
+ @param[in] HeadSpace The length of the head space to reserve.\r
+\r
+ @return The pointer to the duplicated net buffer, or NULL if\r
+ the allocation failed due to resource limitations.\r
+\r
+**/\r
+NET_BUF *\r
+EFIAPI\r
+NetbufDuplicate (\r
+ IN NET_BUF *Nbuf,\r
+ IN OUT NET_BUF *Duplicate OPTIONAL,\r
+ IN UINT32 HeadSpace\r
+ );\r
+\r
+/**\r
+ Create a NET_BUF structure which contains Len byte data of Nbuf starting from\r
+ Offset.\r
+\r
+ A new NET_BUF structure will be created but the associated data in NET_VECTOR\r
+ is shared. This function exists to perform IP packet fragmentation.\r
+\r
+ @param[in] Nbuf The pointer to the net buffer to be extracted.\r
+ @param[in] Offset Starting point of the data to be included in the new\r
+ net buffer.\r
+ @param[in] Len The bytes of data to be included in the new net buffer.\r
+ @param[in] HeadSpace The bytes of the head space to reserve for the protocol header.\r
+\r
+ @return The pointer to the cloned net buffer, or NULL if the\r
+ allocation failed due to resource limitations.\r
+\r
+**/\r
+NET_BUF *\r
+EFIAPI\r
+NetbufGetFragment (\r
+ IN NET_BUF *Nbuf,\r
+ IN UINT32 Offset,\r
+ IN UINT32 Len,\r
+ IN UINT32 HeadSpace\r
+ );\r
+\r
+/**\r
+ Reserve some space in the header room of the net buffer.\r
+\r
+ Upon allocation, all the space is in the tail room of the buffer. Call this\r
+ function to move 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. However, it should be enough for the network stack.\r
+\r
+ @param[in, out] Nbuf The pointer to the net buffer.\r
+ @param[in] Len The length of buffer to be reserved from the header.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+NetbufReserve (\r
+ IN OUT NET_BUF *Nbuf,\r
+ IN UINT32 Len\r
+ );\r
+\r
+/**\r
+ Allocate Len bytes of space from the header or tail of the buffer.\r
+\r
+ @param[in, out] Nbuf The pointer to the net buffer.\r
+ @param[in] Len The length of the buffer to be allocated.\r
+ @param[in] FromHead The flag to indicate whether to reserve the data\r
+ from head (TRUE) or tail (FALSE).\r
+\r
+ @return The pointer to the first byte of the allocated buffer,\r
+ or NULL, if there is no sufficient space.\r
+\r
+**/\r
+UINT8*\r
+EFIAPI\r
+NetbufAllocSpace (\r
+ IN OUT NET_BUF *Nbuf,\r
+ IN UINT32 Len,\r
+ IN BOOLEAN FromHead\r
+ );\r
+\r
+/**\r
+ Trim Len bytes from the header or the tail of the net buffer.\r
+\r
+ @param[in, out] Nbuf The pointer to the net buffer.\r
+ @param[in] Len The length of the data to be trimmed.\r
+ @param[in] FromHead The flag to indicate whether trim data is from the \r
+ head (TRUE) or the tail (FALSE).\r
+\r
+ @return The length of the actual trimmed data, which may be less\r
+ than Len if the TotalSize of Nbuf is less than Len.\r
+\r
+**/\r
+UINT32\r
+EFIAPI\r
+NetbufTrim (\r
+ IN OUT NET_BUF *Nbuf,\r
+ IN UINT32 Len,\r
+ IN BOOLEAN FromHead\r
+ );\r
+\r
+/**\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 several fragments of the net buffer.\r
+\r
+ @param[in] Nbuf The pointer to the net buffer.\r
+ @param[in] Offset The sequence number of the first byte to copy.\r
+ @param[in] Len The length of the data to copy.\r
+ @param[in] Dest The destination of the data to copy to.\r
+\r
+ @return The length of the actual copied data, or 0 if the offset\r
+ specified exceeds the total size of net buffer.\r
+\r
+**/\r
+UINT32\r
+EFIAPI\r
+NetbufCopy (\r
+ IN NET_BUF *Nbuf,\r
+ IN UINT32 Offset,\r
+ IN UINT32 Len,\r
+ IN UINT8 *Dest\r
+ );\r
+\r
+/**\r
+ Build a NET_BUF from external blocks.\r
+\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
+ net buffer to avoid data copying.\r
+\r
+ @param[in] ExtFragment The 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. The function\r
+ pulls this amount of data into a linear block.\r
+ @param[in] ExtFree The pointer to the caller-provided free function.\r
+ @param[in] Arg The argument passed to ExtFree when ExtFree is\r
+ called.\r
+\r
+ @return The pointer to the net buffer built from the data blocks,\r
+ or NULL if the allocation failed due to resource\r
+ limit.\r
+\r
+**/\r
+NET_BUF *\r
+EFIAPI\r
+NetbufFromExt (\r
+ IN NET_FRAGMENT *ExtFragment,\r
+ IN UINT32 ExtNum,\r
+ IN UINT32 HeadSpace,\r
+ IN UINT32 HeadLen,\r
+ IN NET_VECTOR_EXT_FREE ExtFree,\r
+ IN VOID *Arg OPTIONAL\r
+ );\r
+\r
+/**\r
+ Build a fragment table to contain the fragments in the net buffer. This is the\r
+ opposite operation of the NetbufFromExt.\r
+\r
+ @param[in] Nbuf Points to the net buffer.\r
+ @param[in, out] ExtFragment The 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 blocks is bigger than\r
+ ExtNum.\r
+ @retval EFI_SUCCESS The fragment table was built successfully.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetbufBuildExt (\r
+ IN NET_BUF *Nbuf,\r
+ IN OUT NET_FRAGMENT *ExtFragment,\r
+ IN OUT UINT32 *ExtNum\r
+ );\r
+\r
+/**\r
+ Build a net buffer from a list of net buffers.\r
+\r
+ All the fragments will be collected from the list of NEW_BUF, and then a new\r
+ net buffer will be created through NetbufFromExt.\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. The function\r
+ pulls this amount of data into a linear block.\r
+ @param[in] ExtFree The pointer to the caller provided free function.\r
+ @param[in] Arg The argument passed to ExtFree when ExtFree is called.\r
+\r
+ @return The pointer to the net buffer built from the list of net\r
+ buffers.\r
+\r
+**/\r
+NET_BUF *\r
+EFIAPI\r
+NetbufFromBufList (\r
+ IN LIST_ENTRY *BufList,\r
+ IN UINT32 HeadSpace,\r
+ IN UINT32 HeaderLen,\r
+ IN NET_VECTOR_EXT_FREE ExtFree,\r
+ IN VOID *Arg OPTIONAL\r
+ );\r
+\r
+/**\r
+ Free a list of net buffers.\r
+\r
+ @param[in, out] Head The pointer to the head of linked net buffers.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+NetbufFreeList (\r
+ IN OUT LIST_ENTRY *Head\r
+ );\r
+\r
+/**\r
+ Initiate the net buffer queue.\r
+\r
+ @param[in, out] NbufQue The pointer to the net buffer queue to be initialized.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+NetbufQueInit (\r
+ IN OUT NET_BUF_QUEUE *NbufQue\r
+ );\r
+\r
+/**\r
+ Allocate and initialize a net buffer queue.\r
+\r
+ @return The pointer to the allocated net buffer queue, or NULL if the\r
+ allocation failed due to resource limit.\r
+\r
+**/\r
+NET_BUF_QUEUE *\r
+EFIAPI\r
+NetbufQueAlloc (\r
+ VOID\r
+ );\r
+\r
+/**\r
+ Free a net buffer queue.\r
+\r
+ Decrease the reference count of the net buffer queue by one. The real resource\r
+ free operation isn't performed until the reference count of the net buffer\r
+ queue is decreased to 0.\r
+\r
+ @param[in] NbufQue The pointer to the net buffer queue to be freed.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+NetbufQueFree (\r
+ IN NET_BUF_QUEUE *NbufQue\r
+ );\r
+\r
+/**\r
+ Remove a net buffer from the head in the specific queue and return it.\r
+\r
+ @param[in, out] NbufQue The pointer to the net buffer queue.\r
+\r
+ @return The pointer to the net buffer removed from the specific queue,\r
+ or NULL if there is no net buffer in the specific queue.\r
+\r
+**/\r
+NET_BUF *\r
+EFIAPI\r
+NetbufQueRemove (\r
+ IN OUT NET_BUF_QUEUE *NbufQue\r
+ );\r
+\r
+/**\r
+ Append a net buffer to the net buffer queue.\r
+\r
+ @param[in, out] NbufQue The pointer to the net buffer queue.\r
+ @param[in, out] Nbuf The pointer to the net buffer to be appended.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+NetbufQueAppend (\r
+ IN OUT NET_BUF_QUEUE *NbufQue,\r
+ IN OUT NET_BUF *Nbuf\r
+ );\r
+\r
+/**\r
+ Copy Len bytes of data from the net buffer queue at the specific offset to the\r
+ destination memory.\r
+\r
+ The copying operation is the same as NetbufCopy, but applies to the net buffer\r
+ queue instead of the net buffer.\r
+\r
+ @param[in] NbufQue The pointer to the net buffer queue.\r
+ @param[in] Offset The sequence number of the first byte to copy.\r
+ @param[in] Len The length of the data to copy.\r
+ @param[out] Dest The destination of the data to copy to.\r
+\r
+ @return The length of the actual copied data, or 0 if the offset\r
+ specified exceeds the total size of net buffer queue.\r
+\r
+**/\r
+UINT32\r
+EFIAPI\r
+NetbufQueCopy (\r
+ IN NET_BUF_QUEUE *NbufQue,\r
+ IN UINT32 Offset,\r
+ IN UINT32 Len,\r
+ OUT UINT8 *Dest\r
+ );\r
+\r
+/**\r
+ Trim Len bytes of data from the buffer queue and free any net buffer\r
+ that is completely trimmed.\r
+\r
+ The trimming operation is the same as NetbufTrim but applies to the net buffer\r
+ queue instead of the net buffer.\r
+\r
+ @param[in, out] NbufQue The pointer to the net buffer queue.\r
+ @param[in] Len The length of the data to trim.\r
+\r
+ @return The actual length of the data trimmed.\r
+\r
+**/\r
+UINT32\r
+EFIAPI\r
+NetbufQueTrim (\r
+ IN OUT NET_BUF_QUEUE *NbufQue,\r
+ IN UINT32 Len\r
+ );\r
+\r
+\r
+/**\r
+ Flush the net buffer queue.\r
+\r
+ @param[in, out] NbufQue The pointer to the queue to be flushed.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+NetbufQueFlush (\r
+ IN OUT NET_BUF_QUEUE *NbufQue\r
+ );\r
+\r
+/**\r
+ Compute the checksum for a bulk of data.\r
+\r
+ @param[in] Bulk The pointer to the data.\r
+ @param[in] Len The length of the data, in bytes.\r
+\r
+ @return The computed checksum.\r
+\r
+**/\r
+UINT16\r
+EFIAPI\r
+NetblockChecksum (\r
+ IN UINT8 *Bulk,\r
+ IN UINT32 Len\r
+ );\r
+\r
+/**\r
+ Add two checksums.\r
+\r
+ @param[in] Checksum1 The first checksum to be added.\r
+ @param[in] Checksum2 The second checksum to be added.\r
+\r
+ @return The new checksum.\r
+\r
+**/\r
+UINT16\r
+EFIAPI\r
+NetAddChecksum (\r
+ IN UINT16 Checksum1,\r
+ IN UINT16 Checksum2\r
+ );\r
+\r
+/**\r
+ Compute the checksum for a NET_BUF.\r
+\r
+ @param[in] Nbuf The pointer to the net buffer.\r
+\r
+ @return The computed checksum.\r
+\r
+**/\r
+UINT16\r
+EFIAPI\r
+NetbufChecksum (\r
+ IN NET_BUF *Nbuf\r
+ );\r
+\r
+/**\r
+ Compute the checksum for TCP/UDP 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] Proto 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
+EFIAPI\r
+NetPseudoHeadChecksum (\r
+ IN IP4_ADDR Src,\r
+ IN IP4_ADDR Dst,\r
+ IN UINT8 Proto,\r
+ IN UINT16 Len\r
+ );\r
+\r
+/**\r
+ Compute the checksum for the 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
+EFIAPI\r
+NetIp6PseudoHeadChecksum (\r
+ IN EFI_IPv6_ADDRESS *Src,\r
+ IN EFI_IPv6_ADDRESS *Dst,\r
+ IN UINT8 NextHeader,\r
+ IN UINT32 Len\r
+ );\r
+\r
+/**\r
+ The function frees the net buffer which allocated by the IP protocol. It releases \r
+ only the net buffer and doesn't call the external free function. \r
+\r
+ This function should be called after finishing the process of mIpSec->ProcessExt() \r
+ for outbound traffic. The (EFI_IPSEC2_PROTOCOL)->ProcessExt() allocates a new \r
+ buffer for the ESP, so there needs a function to free the old net buffer.\r
+\r
+ @param[in] Nbuf The network buffer to be freed.\r
+\r
+**/\r
+VOID\r
+NetIpSecNetbufFree (\r
+ NET_BUF *Nbuf\r
+ );\r
+\r
+/**\r
+ This function obtains the system guid from the smbios table.\r
+\r
+ @param[out] SystemGuid The pointer of the returned system guid.\r
+\r
+ @retval EFI_SUCCESS Successfully obtained the system guid.\r
+ @retval EFI_NOT_FOUND Did not find the SMBIOS table.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibGetSystemGuid (\r
+ OUT EFI_GUID *SystemGuid\r
+ );\r
+\r
+#endif\r