]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Include/Library/NetLib.h
Clean up DEC files:
[mirror_edk2.git] / MdeModulePkg / Include / Library / NetLib.h
index 039e04f696f4a7f4d860a1702cc5d65e5ebb6a15..102d7f1413844ef52bad68eb35e8d36fb9fa6507 100644 (file)
@@ -2,10 +2,10 @@
   This 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 - 2009, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2005 - 2010, Intel Corporation. All rights reserved.<BR>\r
+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
+which accompanies this distribution.  The full text of the license may be found at<BR>\r
 http://opensource.org/licenses/bsd-license.php\r
 \r
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
@@ -19,6 +19,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Protocol/Ip6.h>\r
 \r
 #include <Library/BaseLib.h>\r
+#include <Library/BaseMemoryLib.h>\r
 \r
 typedef UINT32          IP4_ADDR;\r
 typedef UINT32          TCP_SEQNO;\r
@@ -51,6 +52,7 @@ typedef UINT16          TCP_PORTNO;
 \r
 #define  IP6_HOP_BY_HOP        0\r
 #define  IP6_DESTINATION       60\r
+#define  IP6_ROUTING           43\r
 #define  IP6_FRAGMENT          44\r
 #define  IP6_AH                51\r
 #define  IP6_ESP               50\r
@@ -282,10 +284,11 @@ typedef struct {
                  by the Format string.\r
 \r
   @return        The buffer containing the formatted message,\r
-                 or NULL if failed to allocate memory.\r
+                 or NULL if memory allocation failed.\r
 \r
 **/\r
 CHAR8 *\r
+EFIAPI\r
 NetDebugASPrint (\r
   IN CHAR8                  *Format,\r
   ...\r
@@ -309,6 +312,7 @@ NetDebugASPrint (
                                 than the mNetDebugLevelMax. Or, it has been sent out.\r
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 NetDebugOutput (\r
   IN UINT32                    Level,\r
   IN UINT8                     *Module,\r
@@ -400,6 +404,7 @@ NetIp4IsUnicast (
 \r
 **/\r
 BOOLEAN\r
+EFIAPI\r
 NetIp6IsValidUnicast (\r
   IN EFI_IPv6_ADDRESS       *Ip6\r
   );\r
@@ -410,11 +415,12 @@ NetIp6IsValidUnicast (
 \r
   @param[in] Ip6   - Ip6 address, in network order.\r
 \r
-  @retval TRUE     - Yes, unspecified\r
-  @retval FALSE    - No\r
+  @retval TRUE     - Yes, incoming Ipv6 address is the unspecified address.\r
+  @retval FALSE    - The incoming Ipv6 address is not the unspecified address\r
 \r
 **/\r
 BOOLEAN\r
+EFIAPI\r
 NetIp6IsUnspecifiedAddr (\r
   IN EFI_IPv6_ADDRESS       *Ip6\r
   );\r
@@ -424,11 +430,12 @@ NetIp6IsUnspecifiedAddr (
 \r
   @param[in] Ip6   - Ip6 address, in network order.\r
 \r
-  @retval TRUE  - Yes, link-local address\r
-  @retval FALSE - No\r
+  @retval TRUE  - The incoming Ipv6 address is a link-local address.\r
+  @retval FALSE - The incoming Ipv6 address is not a link-local address.\r
 \r
 **/\r
 BOOLEAN\r
+EFIAPI\r
 NetIp6IsLinkLocalAddr (\r
   IN EFI_IPv6_ADDRESS *Ip6\r
   );\r
@@ -440,11 +447,12 @@ NetIp6IsLinkLocalAddr (
   @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
+  @retval TRUE            - Yes, the Ipv6 address1 and address2 are connected.\r
+  @retval FALSE           - No the Ipv6 address1 and address2 are not connected.\r
 \r
 **/\r
 BOOLEAN\r
+EFIAPI\r
 NetIp6IsNetEqual (\r
   EFI_IPv6_ADDRESS *Ip1,\r
   EFI_IPv6_ADDRESS *Ip2,\r
@@ -452,18 +460,19 @@ NetIp6IsNetEqual (
   );\r
 \r
 /**\r
-  Switches the endianess of an IPv6 address\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
+  @param  Ip6 Points to an IPv6 address.\r
 \r
   @return The byte swapped IPv6 address.\r
 \r
 **/\r
 EFI_IPv6_ADDRESS *\r
+EFIAPI\r
 Ip6Swap128 (\r
   EFI_IPv6_ADDRESS *Ip6\r
   );\r
@@ -503,11 +512,11 @@ NetGetUint32 (
 /**\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, and then copies it to the\r
+  Converts a UINT32 from host byte order to network byte order, then copies it to the\r
   byte stream.\r
 \r
-  @param[in, out]  Buf          The buffer to put the UINT32.\r
-  @param[in]      Data          The data to put.\r
+  @param[in, out]  Buf          The buffer in which to put the UINT32.\r
+  @param[in]       Data         The data to be converted and put into the byte stream.\r
 \r
 **/\r
 VOID\r
@@ -888,7 +897,7 @@ NetMapRemoveTail (
 \r
 typedef\r
 EFI_STATUS\r
-(*NET_MAP_CALLBACK) (\r
+(EFIAPI *NET_MAP_CALLBACK) (\r
   IN NET_MAP                *Map,\r
   IN NET_MAP_ITEM           *Item,\r
   IN VOID                   *Arg\r
@@ -908,8 +917,8 @@ EFI_STATUS
   @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
-                                 return EFI_SUCCESS.\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
@@ -963,7 +972,7 @@ NetLibCreateServiceChild (
   @param[in]   ServiceBindingGuid    The service's Guid.\r
   @param[in]   ChildHandle           The child to destroy.\r
 \r
-  @retval EFI_SUCCESS           The child is successfully destroyed.\r
+  @retval EFI_SUCCESS           The child was destroyed.\r
   @retval Others                Failed to destroy the child.\r
 \r
 **/\r
@@ -1025,9 +1034,9 @@ NetLibGetVlanId (
   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]   ServiceHandle    The handle where network service binding protocols are\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
+  @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
@@ -1051,7 +1060,7 @@ NetLibGetVlanHandle (
   @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 is returned successfully.\r
+  @retval EFI_SUCCESS           MAC address was returned successfully.\r
   @retval Others                Failed to get SNP mode data.\r
 \r
 **/\r
@@ -1073,14 +1082,14 @@ NetLibGetMacAddress (
   Plus one unicode character for the null-terminator.\r
 \r
   @param[in]   ServiceHandle         The handle where network service binding protocol is\r
-                                     installed on.\r
+                                     installed.\r
   @param[in]   ImageHandle           The image handle used 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
@@ -1092,15 +1101,50 @@ NetLibGetMacString (
   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 info from parameters to make up the whole IPv4 device path node.\r
+  Get other information 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, 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
@@ -1129,9 +1173,9 @@ NetLibCreateIPv4DPathNode (
   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
+  Get other information 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, 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
@@ -1158,13 +1202,13 @@ NetLibCreateIPv6DPathNode (
 \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
-  IP opens these handle BY_DRIVER, use that info, we can get the\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            Then protocol handle to check.\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
@@ -1195,9 +1239,102 @@ NetLibDefaultUnload (
   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
+// 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
@@ -1220,7 +1357,7 @@ typedef struct {
   UINT8               *Bulk;      // The block's Data\r
 } NET_BLOCK;\r
 \r
-typedef VOID (*NET_VECTOR_EXT_FREE) (VOID *Arg);\r
+typedef VOID (EFIAPI *NET_VECTOR_EXT_FREE) (VOID *Arg);\r
 \r
 //\r
 //NET_VECTOR contains several blocks to hold all packet's\r
@@ -1353,8 +1490,8 @@ typedef struct {
 \r
   @param[in]  Len              The length of the block.\r
 \r
-  @return                      Pointer to the allocated NET_BUF, or NULL if the\r
-                               allocation failed due to resource limit.\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
@@ -1372,7 +1509,7 @@ NetbufAlloc (
   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
+  @param[in]  Nbuf                  The pointer to the NET_BUF to be freed.\r
 \r
 **/\r
 VOID\r
@@ -1389,12 +1526,12 @@ NetbufFree (
   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
+  @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       Pointer to the Offset'th byte of data in the net buffer, or NULL\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
@@ -1412,10 +1549,10 @@ NetbufGetByte (
   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              Pointer to the net buffer to be cloned.\r
+  @param[in]  Nbuf              The pointer to the net buffer to be cloned.\r
 \r
-  @return                       Pointer to the cloned net buffer, or NULL if the\r
-                                allocation failed due to resource limit.\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
@@ -1431,13 +1568,13 @@ NetbufClone (
   The duplicated net buffer will allocate its own memory to hold the data of the\r
   source net buffer.\r
 \r
-  @param[in]       Nbuf         Pointer to the net buffer to be duplicated from.\r
-  @param[in, out]  Duplicate    Pointer to the net buffer to duplicate to, if\r
-                                NULL a new net buffer is allocated.\r
-  @param[in]      HeadSpace     Length of the head space to reserve.\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                       Pointer to the duplicated net buffer, or NULL if\r
-                                the allocation failed due to resource limit.\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
@@ -1453,16 +1590,16 @@ NetbufDuplicate (
   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 do IP packet fragmentation.\r
+  is shared. This function exists to perform IP packet fragmentation.\r
 \r
-  @param[in]  Nbuf         Pointer to the net buffer to be extracted.\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          Bytes of data to be included in the new net buffer.\r
-  @param[in]  HeadSpace    Bytes of head space to reserve for protocol header.\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                  Pointer to the cloned net buffer, or NULL if the\r
-                           allocation failed due to resource limit.\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
@@ -1478,11 +1615,11 @@ NetbufGetFragment (
   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 some space to the header room. This function is quite limited\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. But it should be enough for the network stack.\r
+  built from the external. However, it should be enough for the network stack.\r
 \r
-  @param[in, out]  Nbuf     Pointer to the net buffer.\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
@@ -1496,13 +1633,13 @@ NetbufReserve (
 /**\r
   Allocate Len bytes of space from the header or tail of the buffer.\r
 \r
-  @param[in, out]  Nbuf       Pointer to the net buffer.\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 reserve the data\r
+  @param[in]       FromHead   The flag to indicate whether to reserve the data\r
                               from head (TRUE) or tail (FALSE).\r
 \r
-  @return                     Pointer to the first byte of the allocated buffer,\r
-                              or NULL if there is no sufficient space.\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
@@ -1514,14 +1651,14 @@ NetbufAllocSpace (
   );\r
 \r
 /**\r
-  Trim Len bytes from the header or tail of the net buffer.\r
+  Trim Len bytes from the header or the tail of the net buffer.\r
 \r
-  @param[in, out]  Nbuf         Pointer to the net buffer.\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 from head\r
-                                (TRUE) or tail (FALSE).\r
+  @param[in]      FromHead      The flag to indicate whether trim data is from the \r
+                                head (TRUE) or the tail (FALSE).\r
 \r
-  @return    Length of the actually trimmed data, which may be less\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
@@ -1539,9 +1676,9 @@ NetbufTrim (
 \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]   Nbuf         The pointer to the net buffer.\r
   @param[in]   Offset       The sequence number of the first byte to copy.\r
-  @param[in]   Len          Length of the data 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
@@ -1565,16 +1702,16 @@ NetbufCopy (
   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]  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               Pointer to the caller-provided free function.\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                  Pointer to the net buffer built from the data blocks,\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
@@ -1594,13 +1731,13 @@ NetbufFromExt (
   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                  Point to the net buffer.\r
-  @param[in, out]  ExtFragment           Pointer to the data block.\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           Fragment table is built successfully.\r
+  @retval EFI_SUCCESS           The fragment table was built successfully.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1614,17 +1751,17 @@ NetbufBuildExt (
 /**\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
+  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    Pointer to the caller provided free function.\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                 Pointer to the net buffer built from the list of net\r
+  @return                 The pointer to the net buffer built from the list of net\r
                           buffers.\r
 \r
 **/\r
@@ -1641,7 +1778,7 @@ NetbufFromBufList (
 /**\r
   Free a list of net buffers.\r
 \r
-  @param[in, out]  Head              Pointer to the head of linked net buffers.\r
+  @param[in, out]  Head              The pointer to the head of linked net buffers.\r
 \r
 **/\r
 VOID\r
@@ -1653,7 +1790,7 @@ NetbufFreeList (
 /**\r
   Initiate the net buffer queue.\r
 \r
-  @param[in, out]  NbufQue   Pointer to the net buffer queue to be initialized.\r
+  @param[in, out]  NbufQue   The pointer to the net buffer queue to be initialized.\r
 \r
 **/\r
 VOID\r
@@ -1665,7 +1802,7 @@ NetbufQueInit (
 /**\r
   Allocate and initialize a net buffer queue.\r
 \r
-  @return         Pointer to the allocated net buffer queue, or NULL if the\r
+  @return         The pointer to the allocated net buffer queue, or NULL if the\r
                   allocation failed due to resource limit.\r
 \r
 **/\r
@@ -1682,7 +1819,7 @@ NetbufQueAlloc (
   free operation isn't performed until the reference count of the net buffer\r
   queue is decreased to 0.\r
 \r
-  @param[in]  NbufQue               Pointer to the net buffer queue to be freed.\r
+  @param[in]  NbufQue               The pointer to the net buffer queue to be freed.\r
 \r
 **/\r
 VOID\r
@@ -1694,9 +1831,9 @@ NetbufQueFree (
 /**\r
   Remove a net buffer from the head in the specific queue and return it.\r
 \r
-  @param[in, out]  NbufQue               Pointer to the net buffer queue.\r
+  @param[in, out]  NbufQue               The pointer to the net buffer queue.\r
 \r
-  @return           Pointer to the net buffer removed from the specific queue,\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
@@ -1709,8 +1846,8 @@ NetbufQueRemove (
 /**\r
   Append a net buffer to the net buffer queue.\r
 \r
-  @param[in, out]  NbufQue            Pointer to the net buffer queue.\r
-  @param[in, out]  Nbuf               Pointer to the net buffer to be appended.\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
@@ -1724,12 +1861,12 @@ NetbufQueAppend (
   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
+  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         Pointer to the net buffer queue.\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             Length of the data 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
@@ -1746,14 +1883,14 @@ NetbufQueCopy (
   );\r
 \r
 /**\r
-  Trim Len bytes of data from the queue header and release any net buffer\r
-  that is trimmed wholely.\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               Pointer to the net buffer queue.\r
-  @param[in]       Len                   Length of the data to trim.\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
@@ -1769,7 +1906,7 @@ NetbufQueTrim (
 /**\r
   Flush the net buffer queue.\r
 \r
-  @param[in, out]  NbufQue               Pointer to the queue to be flushed.\r
+  @param[in, out]  NbufQue               The pointer to the queue to be flushed.\r
 \r
 **/\r
 VOID\r
@@ -1781,8 +1918,8 @@ NetbufQueFlush (
 /**\r
   Compute the checksum for a bulk of data.\r
 \r
-  @param[in]   Bulk                  Pointer to the data.\r
-  @param[in]   Len                   Length of the data, in bytes.\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
@@ -1813,7 +1950,7 @@ NetAddChecksum (
 /**\r
   Compute the checksum for a NET_BUF.\r
 \r
-  @param[in]   Nbuf                  Pointer to the net buffer.\r
+  @param[in]   Nbuf                  The pointer to the net buffer.\r
 \r
   @return    The computed checksum.\r
 \r
@@ -1847,7 +1984,7 @@ NetPseudoHeadChecksum (
   );\r
 \r
 /**\r
-  Compute the checksum for TCP6/UDP6 pseudo header.\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
@@ -1860,10 +1997,27 @@ NetPseudoHeadChecksum (
 \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
 #endif\r