Code Scrub for Protocol and Ppi Definition

[mirror_edk2.git] / MdePkg / Include / Protocol / Tcp4.h

diff --git a/MdePkg/Include/Protocol/Tcp4.h b/MdePkg/Include/Protocol/Tcp4.h
index 715c581e6d4bc4c269519dd2e5a7452775cf5e22..262c5be75f3b9632e015740a3b03f27ed89ece04 100644 (file)
--- a/MdePkg/Include/Protocol/Tcp4.h
+++ b/MdePkg/Include/Protocol/Tcp4.h
@@ -485,6 +485,48 @@ EFI_STATUS
   )\r
 ;\r
 \r
+/**  \r
+  @par Protocol Description:\r
+  The EFI_TCP4_PROTOCOL defines the EFI TCPv4 Protocol child to be used by \r
+  any network drivers or applications to send or receive data stream. \r
+  It can either listen on a specified port as a service or actively connected \r
+  to remote peer as a client. Each instance has its own independent settings, \r
+  such as the routing table.\r
+\r
+  @param GetModeData\r
+  Get the current operational status. \r
+\r
+  @param Configure\r
+  Initialize, change, or brutally reset operational settings of the EFI TCPv4 Protocol. \r
+\r
+  @param Routes\r
+  Add or delete routing entries for this TCP4 instance. \r
+\r
+  @param Connect\r
+  Initiate the TCP three-way handshake to connect to the remote peer \r
+  configured in this TCP instance. The function is a nonblocking operation. \r
+\r
+  @param Accept\r
+  Listen for incoming TCP connection request. This function is a nonblocking operation. \r
+\r
+  @param Transmit\r
+  Queue outgoing data to the transmit queue. This function is a nonblocking operation. \r
+\r
+  @param Receive\r
+  Queue a receiving request token to the receive queue. This function is \r
+  a nonblocking operation. \r
+\r
+  @param Close\r
+  Gracefully disconnecting a TCP connection follow RFC 793 or reset a TCP \r
+  connection. This function is a nonblocking operation. \r
+\r
+  @param Cancel\r
+  Abort a pending connect, listen, transmit or receive request. \r
+\r
+  @param Poll\r
+  Poll to receive incoming data and transmit outgoing TCP segments. \r
+\r
+**/\r
 struct _EFI_TCP4_PROTOCOL {\r
   EFI_TCP4_GET_MODE_DATA                 GetModeData;\r
   EFI_TCP4_CONFIGURE                     Configure;\r