Clarify the UEFI/EFI specification version in file header comments.

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

diff --git a/MdePkg/Include/Protocol/Tcp4.h b/MdePkg/Include/Protocol/Tcp4.h
index 04b8c92696d321f8a1353a101c5248f8d01ae688..b233fd9b7127b73ae72eba2bd7f9105cb28c4e03 100644 (file)
--- a/MdePkg/Include/Protocol/Tcp4.h
+++ b/MdePkg/Include/Protocol/Tcp4.h
@@ -1,10 +1,10 @@
 /** @file\r
-  EFI TCPv4 Protocol Definition\r
+  EFI TCPv4(Transmission Control Protocol version 4) Protocol Definition\r
   The EFI TCPv4 Service Binding Protocol is used to locate EFI TCPv4 Protocol drivers to create\r
   and destroy child of the driver to communicate with other host using TCP protocol.\r
   The EFI TCPv4 Protocol provides services to send and receive data stream.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation\r
+  Copyright (c) 2006 - 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
@@ -13,6 +13,9 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
+  @par Revision Reference:          \r
+  This Protocol is introduced in UEFI Specification 2.0\r
+\r
 **/\r
 \r
 #ifndef __EFI_TCP4_PROTOCOL_H__\r
@@ -92,6 +95,9 @@ typedef struct {
   EFI_TCP4_OPTION         *ControlOption;\r
 } EFI_TCP4_CONFIG_DATA;\r
 \r
+///\r
+/// TCP4 connnection state\r
+///\r
 typedef enum {\r
   Tcp4StateClosed         = 0,\r
   Tcp4StateListen         = 1,\r
@@ -266,8 +272,7 @@ EFI_STATUS
                                 way handshake finishes.\r
 \r
   @retval EFI_SUCCESS           The connection request is successfully initiated and the state\r
-                                - of this TCPv4 instance has been changed to\r
-                                - Tcp4StateSynSent.\r
+                                of this TCPv4 instance has been changed to Tcp4StateSynSent.\r
   @retval EFI_NOT_STARTED       This EFI TCPv4 Protocol instance has not been configured.\r
   @retval EFI_ACCESS_DENIED     One or more of the following conditions are TRUE:\r
                                 - This instance is not configured as an active one.\r
@@ -276,7 +281,7 @@ EFI_STATUS
                                 - This is NULL.\r
                                 - ConnectionToken is NULL.\r
                                 - ConnectionToken->CompletionToken.Event is NULL.\r
-  @retval EFI_OUT_OF_RESOURCES  The driver can't allocate enough resource to initiate the activeopen.\r
+  @retval EFI_OUT_OF_RESOURCES  The driver can't allocate enough resource to initiate the activ eopen.\r
   @retval EFI_DEVICE_ERROR      An unexpected system or network error occurred.\r
 \r
 **/\r
@@ -440,12 +445,15 @@ EFI_STATUS
                 EFI_TCP4_COMPLETION_TOKEN is defined in\r
                 EFI_TCP4_PROTOCOL.Connect().\r
 \r
-  @retval  EFI_SUCCESS           Incoming or outgoing data was processed.\r
-  @retval  EFI_INVALID_PARAMETER This is NULL.\r
-  @retval  EFI_DEVICE_ERROR      An unexpected system or network error occurred.\r
-  @retval  EFI_NOT_READY         No incoming or outgoing data is processed.\r
-  @retval  EFI_TIMEOUT           Data was dropped out of the transmission or receive queue.\r
-                                 Consider increasing the polling rate.\r
+  @retval  EFI_SUCCESS             The asynchronous I/O request is aborted and Token->Event\r
+                                   is signaled.\r
+  @retval  EFI_INVALID_PARAMETER   This is NULL.\r
+  @retval  EFI_NOT_STARTED         This instance hasn't been configured.\r
+  @retval  EFI_NO_MAPPING          When using the default address, configuration\r
+                                   (DHCP, BOOTP,RARP, etc.) hasn't finished yet.\r
+  @retval  EFI_NOT_FOUND           The asynchronous I/O request isn't found in the \r
+                                   transmission or receive queue. It has either \r
+                                   completed or wasn't issued by Transmit() and Receive().\r
 \r
 **/\r
 typedef\r
@@ -475,14 +483,13 @@ EFI_STATUS
   IN EFI_TCP4_PROTOCOL                   *This\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
+///\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
 struct _EFI_TCP4_PROTOCOL {\r
   EFI_TCP4_GET_MODE_DATA                 GetModeData;\r
   EFI_TCP4_CONFIGURE                     Configure;\r
@@ -496,10 +503,6 @@ struct _EFI_TCP4_PROTOCOL {
   EFI_TCP4_POLL                          Poll;\r
 };\r
 \r
-#define EFI_CONNECTION_FIN               EFIERR (104)\r
-#define EFI_CONNECTION_RESET             EFIERR (105)\r
-#define EFI_CONNECTION_REFUSED           EFIERR (106)\r
-\r
 extern EFI_GUID gEfiTcp4ServiceBindingProtocolGuid;\r
 extern EFI_GUID gEfiTcp4ProtocolGuid;\r
 \r