Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=1205

This patch is to add the driver usage/difference clarification
compared to TcpDxe in NetworkPkg.

Cc: Ye Ting <[email protected]>
Cc: Fu Siyuan <[email protected]>
Cc: Laszlo Ersek <[email protected]>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Wu Jiaxin <[email protected]>
---
 MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Dxe.inf | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Dxe.inf 
b/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Dxe.inf
index b54321caaa..0561eb7421 100644
--- a/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Dxe.inf
+++ b/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Dxe.inf
@@ -1,10 +1,20 @@
 ## @file
 #  This module produces EFI TCPv4 Protocol and EFI TCPv4 Service Binding 
Protocol.
 #
 #  This module produces EFI TCPv4(Transmission Control Protocol version 4) 
Protocol
-#  upon EFI IPv4 Protocol, to provide basic TCPv4 I/O services.
+#  upon EFI IPv4 Protocol, to provide basic TCPv4 I/O services. This driver 
only 
+#  supports IPv4 network stack.
+#
+#  Notes: 
+#  1) This driver can't co-work with the TcpDxe driver in NetworkPkg. 
+#  2) This driver might have some issues that have been fixed in the TcpDxe 
driver 
+#     in NetworkPkg. 
+#  3) This driver supports less feature than the TcpDxe driver in NetworkPkg 
(e.g. IPv6, 
+#     TCP Cancel function). 
+#  4) TcpDxe driver in NetworkPkg is recommanded to use instead of this one 
even both 
+#     of them can be used.
 #
 #  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
 #  This program and the accompanying materials
 #  are licensed and made available under the terms and conditions of the BSD 
License
 #  which accompanies this distribution. The full text of the license may be 
found at
-- 
2.17.1.windows.2

_______________________________________________
edk2-devel mailing list
[email protected]
https://lists.01.org/mailman/listinfo/edk2-devel

Reply via email to