Use RLE (Run Length Encoding) to improve debugging performance.

[mirror_edk2.git] / SourceLevelDebugPkg / Include / TransferProtocol.h

diff --git a/SourceLevelDebugPkg/Include/TransferProtocol.h b/SourceLevelDebugPkg/Include/TransferProtocol.h
index 42add9164a831e2447c73e3c9e82e9c921c6ea56..45d82c2995991e7fab61c57691bbc436abb38950 100644 (file)
--- a/SourceLevelDebugPkg/Include/TransferProtocol.h
+++ b/SourceLevelDebugPkg/Include/TransferProtocol.h
@@ -2,7 +2,7 @@
   Transfer protocol defintions used by debug agent and host. It is only\r
   intended to be used by Debug related module implementation.\r
 \r
-  Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2010 - 2015, 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
@@ -20,12 +20,15 @@
 \r
 //\r
 // Current revision of transfer protocol\r
+// 0.4: Packet compression and decompression.\r
 //\r
-#define DEBUG_AGENT_REVISION            ((0 << 16) | 03)\r
+#define DEBUG_AGENT_REVISION_03         ((0 << 16) | 03)\r
+#define DEBUG_AGENT_REVISION_04         ((0 << 16) | 04)\r
+#define DEBUG_AGENT_REVISION            DEBUG_AGENT_REVISION_03\r
 #define DEBUG_AGENT_CAPABILITIES        0\r
 \r
 //\r
-// Definitions for attach command\r
+// Definitions for the (A)ttach command\r
 //\r
 #define DEBUG_STARTING_SYMBOL_ATTACH    (0xFA)\r
 \r
@@ -34,10 +37,15 @@
 //\r
 #define DEBUG_STARTING_SYMBOL_NORMAL    (0xFE)\r
 \r
+//\r
+// Definition for starting symbol of a (C)ompressed debug packet. Choose a non-ASCII to avoid conflict with other serial output.\r
+//\r
+#define DEBUG_STARTING_SYMBOL_COMPRESS  (0xFC)\r
+\r
 #pragma pack(1)\r
 \r
 //\r
-// Definition for debug packet header for normal debug packets (not including break/attach command)\r
+// Definition for debug packet header for debug packets (not including attach command)\r
 //\r
 typedef struct {\r
   UINT8                      StartSymbol;\r