Update the Doxygen comments for the common transmit completion processing.

Signed-off by: Lee Leahy

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/branches/EADK@12320 6f19259b-4bc3-4df7-8a09-765794883524

5 files changed, 47 insertions, 45 deletions

diff --git a/StdLib/EfiSocketLib/Ip4.c b/StdLib/EfiSocketLib/Ip4.c
index a72905a..23248fe 100644
--- a/StdLib/EfiSocketLib/Ip4.c
+++ b/StdLib/EfiSocketLib/Ip4.c
@@ -2654,10 +2654,8 @@ EslIp4TxBuffer (
 /**

   Process the transmit completion

 

-  This routine handles the completion of data transmissions.  It

-  frees the \ref TransmitEngine resources by calling ::EslSocketTxComplete

-  and frees packet resources by calling ::EslSocketPacketFree.  Transmit

-  errors are logged in ESL_SOCKET::TxError.

+  This routine use ::EslSocketTxComplete to perform the transmit

+  completion processing for data packets.

 

   This routine is called by the IPv4 network layer when a data

   transmit request completes.

diff --git a/StdLib/EfiSocketLib/Socket.c b/StdLib/EfiSocketLib/Socket.c
index b7d731b..1029251 100644
--- a/StdLib/EfiSocketLib/Socket.c
+++ b/StdLib/EfiSocketLib/Socket.c
@@ -36,10 +36,12 @@
 

   Upon completion, the network specific TxComplete routine calls

   ::EslSocketTxComplete to disconnect the transmit packet from the

-  ESL_IO_MGMT structure.  The routine also releases the structure

-  to to the appropriate free queue: ESL_PORT::pTxFree or

-  ESL_PORT::pTxOobFree.  The network specific PortClose routine

-  calls ::EslSocketIoFree to deallocate the ESL_IO_MGMT structures.

+  ESL_IO_MGMT structure and freeing the ::ESL_PACKET structure by calling

+  ::EslSocketPacketFree.  The routine places the ::ESL_IO_MGMT structure

+  into either the ESL_PORT::pTxFree or ESL_PORT::pTxOobFree list.

+  EslSocketTxComplete then starts the next transmit operation while

+  the socket is active or calls the network specific PortCloseTxDone

+  routine via ESL_PROTOCOL_API::pfnPortCloseTxDone when the socket is shutting down.

 

 **/

 

@@ -2940,11 +2942,19 @@ EslSocketTransmit (
 /**

   Complete the transmit operation

 

-  This support routine removes the ESL_IO_MGMT structure from

-  the active queue and returns it to the free queue.

+  This support routine handles the transmit completion processing for

+  the various network layers.  It frees the ::ESL_IO_MGMT structure

+  and and frees packet resources by calling ::EslSocketPacketFree.

+  Transmit errors are logged in ESL_SOCKET::TxError.

+  See the \ref TransmitEngine section.

 

-  The network specific code calls this routine during its transmit

-  complete processing.  See the \ref TransmitEngine section.

+  This routine is called by:

+  <ul>

+    <li>::EslIp4TxComplete</li>

+    <li>::EslTcp4TxComplete</li>

+    <li>::EslTcp4TxOobComplete</li>

+    <li>::EslUdp4TxComplete</li>

+  </ul>

 

   @param [in] pIo             Address of an ::ESL_IO_MGMT structure

   @param [in] LengthInBytes   Length of the data in bytes

diff --git a/StdLib/EfiSocketLib/Socket.h b/StdLib/EfiSocketLib/Socket.h
index 90e602a..3eaca21 100644
--- a/StdLib/EfiSocketLib/Socket.h
+++ b/StdLib/EfiSocketLib/Socket.h
@@ -590,7 +590,7 @@ EFI_STATUS
   continues the close operation after the transmission is complete.

   The next step is to stop the receive engine.

 

-  This routine is called by ::EslSocketTxCompleteto determine if

+  This routine is called by ::EslSocketTxComplete to determine if

   the transmission is complete.

 

   @param [in] pPort           Address of an ::ESL_PORT structure.

@@ -1007,11 +1007,19 @@ EslSocketPacketFree (
 /**

   Complete the transmit operation

 

-  This support routine removes the ESL_IO_MGMT structure from

-  the active queue and returns it to the free queue.

+  This support routine handles the transmit completion processing for

+  the various network layers.  It frees the ::ESL_IO_MGMT structure

+  and and frees packet resources by calling ::EslSocketPacketFree.

+  Transmit errors are logged in ESL_SOCKET::TxError.

+  See the \ref TransmitEngine section.

 

-  The network specific code calls this routine during its transmit

-  complete processing.  See the \ref TransmitEngine section.

+  This routine is called by:

+  <ul>

+    <li>::EslIp4TxComplete</li>

+    <li>::EslTcp4TxComplete</li>

+    <li>::EslTcp4TxOobComplete</li>

+    <li>::EslUdp4TxComplete</li>

+  </ul>

 

   @param [in] pIo             Address of an ::ESL_IO_MGMT structure

   @param [in] LengthInBytes   Length of the data in bytes

@@ -1554,10 +1562,8 @@ EslIp4TxBuffer (
 /**

   Process the transmit completion

 

-  This routine handles the completion of data transmissions.  It

-  frees the \ref TransmitEngine resources by calling ::EslSocketTxComplete

-  and frees packet resources by calling ::EslSocketPacketFree.  Transmit

-  errors are logged in ESL_SOCKET::TxError.

+  This routine use ::EslSocketTxComplete to perform the transmit

+  completion processing for data packets.

 

   This routine is called by the IPv4 network layer when a data

   transmit request completes.

@@ -2151,10 +2157,8 @@ EslTcp4TxBuffer (
 /**

   Process the normal data transmit completion

 

-  This routine handles the completion of normal data transmissions.

-  It frees the transmit engine resources by calling ::EslSocketTxComplete

-  and frees packet resources by calling ::EslSocketPacketFree.  Transmit

-  errors are logged in ESL_SOCKET::TxError.

+  This routine use ::EslSocketTxComplete to perform the transmit

+  completion processing for normal data.

 

   This routine is called by the TCPv4 network layer when a

   normal data transmit request completes.

@@ -2173,10 +2177,8 @@ EslTcp4TxComplete (
 /**

   Process the urgent data transmit completion

 

-  This routine handles the completion of urgent data transmissions.

-  It frees the transmit engine resources by calling ::EslSocketTxComplete

-  and frees packet resources by calling ::EslSocketPacketFree.  Transmit

-  errors are logged in ESL_SOCKET::TxError.

+  This routine use ::EslSocketTxComplete to perform the transmit

+  completion processing for urgent data.

 

   This routine is called by the TCPv4 network layer when a

   urgent data transmit request completes.

@@ -2636,10 +2638,8 @@ EslUdp4TxBuffer (
 /**

   Process the transmit completion

 

-  This routine handles the completion of data transmissions.  It

-  frees the \ref TransmitEngine resources by calling ::EslSocketTxComplete

-  and frees packet resources by calling ::EslSocketPacketFree.  Transmit

-  errors are logged in ESL_SOCKET::TxError.

+  This routine use ::EslSocketTxComplete to perform the transmit

+  completion processing for data packets.

 

   This routine is called by the UDPv4 network layer when a data

   transmit request completes.

diff --git a/StdLib/EfiSocketLib/Tcp4.c b/StdLib/EfiSocketLib/Tcp4.c
index bc3f3a0..2437dce 100644
--- a/StdLib/EfiSocketLib/Tcp4.c
+++ b/StdLib/EfiSocketLib/Tcp4.c
@@ -3359,10 +3359,8 @@ EslTcp4TxBuffer (
 /**

   Process the normal data transmit completion

 

-  This routine handles the completion of normal data transmissions.

-  It frees the \ref TransmitEngine resources by calling ::EslSocketTxComplete

-  and frees packet resources by calling ::EslSocketPacketFree.  Transmit

-  errors are logged in ESL_SOCKET::TxError.

+  This routine use ::EslSocketTxComplete to perform the transmit

+  completion processing for normal data.

 

   This routine is called by the TCPv4 network layer when a

   normal data transmit request completes.

@@ -3418,10 +3416,8 @@ EslTcp4TxComplete (
 /**

   Process the urgent data transmit completion

 

-  This routine handles the completion of urgent data transmissions.

-  It frees the \ref TransmitEngine resources by calling ::EslSocketTxComplete

-  and frees packet resources by calling ::EslSocketPacketFree.  Transmit

-  errors are logged in ESL_SOCKET::TxError.

+  This routine use ::EslSocketTxComplete to perform the transmit

+  completion processing for urgent data.

 

   This routine is called by the TCPv4 network layer when a

   urgent data transmit request completes.

diff --git a/StdLib/EfiSocketLib/Udp4.c b/StdLib/EfiSocketLib/Udp4.c
index 7127781..d1e2524 100644
--- a/StdLib/EfiSocketLib/Udp4.c
+++ b/StdLib/EfiSocketLib/Udp4.c
@@ -2428,10 +2428,8 @@ EslUdp4TxBuffer (
 /**

   Process the transmit completion

 

-  This routine handles the completion of data transmissions.  It

-  frees the \ref TransmitEngine resources by calling ::EslSocketTxComplete

-  and frees packet resources by calling ::EslSocketPacketFree.  Transmit

-  errors are logged in ESL_SOCKET::TxError.

+  This routine use ::EslSocketTxComplete to perform the transmit

+  completion processing for data packets.

 

   This routine is called by the UDPv4 network layer when a data

   transmit request completes.