Grammatical and disclaimer changes (does not follow internal C coding stds.)

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

diff --git a/MdePkg/Include/Protocol/DebugSupport.h b/MdePkg/Include/Protocol/DebugSupport.h
index e3b0d02e31602f72e953169aed1f88b24133615e..16ce98738f205d4b73a3a3e4c656a3323e4334dd 100644 (file)
--- a/MdePkg/Include/Protocol/DebugSupport.h
+++ b/MdePkg/Include/Protocol/DebugSupport.h
@@ -5,15 +5,14 @@
   The DebugSupport protocol is used by source level debuggers to abstract the\r
   processor and handle context save and restore operations.\r
 \r
-  Copyright (c) 2006 - 2009, Intel Corporation<BR>       \r
-  Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<BR>\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
-  http://opensource.org/licenses/bsd-license.php                                            \r
-\r
-  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
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php.                                          \r
+    \r
+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
 **/\r
 \r
@@ -25,7 +24,7 @@
 typedef struct _EFI_DEBUG_SUPPORT_PROTOCOL EFI_DEBUG_SUPPORT_PROTOCOL;\r
 \r
 ///\r
-/// Debug Support protocol {2755590C-6F3C-42FA-9EA4-A3BA543CDA25}\r
+/// Debug Support protocol {2755590C-6F3C-42FA-9EA4-A3BA543CDA25}.\r
 ///\r
 #define EFI_DEBUG_SUPPORT_PROTOCOL_GUID \\r
   { \\r
@@ -39,7 +38,7 @@ typedef struct _EFI_DEBUG_SUPPORT_PROTOCOL EFI_DEBUG_SUPPORT_PROTOCOL;
 typedef INTN  EFI_EXCEPTION_TYPE;\r
 \r
 ///\r
-///  IA-32 processor exception types\r
+///  IA-32 processor exception types.\r
 ///\r
 #define EXCEPT_IA32_DIVIDE_ERROR    0\r
 #define EXCEPT_IA32_DEBUG           1\r
@@ -60,8 +59,8 @@ typedef INTN  EFI_EXCEPTION_TYPE;
 #define EXCEPT_IA32_SIMD            19\r
 \r
 ///\r
-/// FXSAVE_STATE\r
-/// FP / MMX / XMM registers (see fxrstor instruction definition)\r
+/// FXSAVE_STATE.\r
+/// FP / MMX / XMM registers (see fxrstor instruction definition).\r
 ///\r
 typedef struct {\r
   UINT16  Fcw;\r
@@ -94,7 +93,7 @@ typedef struct {
 } EFI_FX_SAVE_STATE_IA32;\r
 \r
 ///\r
-///  IA-32 processor context definition\r
+///  IA-32 processor context definition.\r
 ///\r
 typedef struct {\r
   UINT32                 ExceptionData;\r
@@ -133,7 +132,7 @@ typedef struct {
 } EFI_SYSTEM_CONTEXT_IA32;\r
 \r
 ///\r
-///  x64 processor exception types\r
+///  x64 processor exception types.\r
 ///\r
 #define EXCEPT_X64_DIVIDE_ERROR    0\r
 #define EXCEPT_X64_DEBUG           1\r
@@ -154,8 +153,8 @@ typedef struct {
 #define EXCEPT_X64_SIMD            19\r
 \r
 ///\r
-/// FXSAVE_STATE\r
-/// FP / MMX / XMM registers (see fxrstor instruction definition)\r
+/// FXSAVE_STATE.\r
+/// FP / MMX / XMM registers (see fxrstor instruction definition).\r
 ///\r
 typedef struct {\r
   UINT16  Fcw;\r
@@ -188,7 +187,7 @@ typedef struct {
 } EFI_FX_SAVE_STATE_X64;\r
 \r
 ///\r
-///  x64 processor context definition\r
+///  x64 processor context definition.\r
 ///\r
 typedef struct {\r
   UINT64                ExceptionData;\r
@@ -236,7 +235,7 @@ typedef struct {
 } EFI_SYSTEM_CONTEXT_X64;\r
 \r
 ///\r
-///  Itanium Processor Family Exception types\r
+///  Itanium Processor Family Exception types.\r
 ///\r
 #define EXCEPT_IPF_VHTP_TRANSLATION       0\r
 #define EXCEPT_IPF_INSTRUCTION_TLB        1\r
@@ -281,7 +280,7 @@ typedef struct {
 #define EXCEPT_IPF_IA32_INTERRUPT 47\r
 \r
 ///\r
-///  IPF processor context definition\r
+///  IPF processor context definition.\r
 ///\r
 typedef struct {\r
   //\r
@@ -437,26 +436,26 @@ typedef struct {
 } EFI_SYSTEM_CONTEXT_IPF;\r
 \r
 ///\r
-///  EBC processor exception types\r
+///  EBC processor exception types.\r
 ///\r
 #define EXCEPT_EBC_UNDEFINED            0\r
 #define EXCEPT_EBC_DIVIDE_ERROR         1\r
 #define EXCEPT_EBC_DEBUG                2\r
 #define EXCEPT_EBC_BREAKPOINT           3\r
 #define EXCEPT_EBC_OVERFLOW             4\r
-#define EXCEPT_EBC_INVALID_OPCODE       5   ///< opcode out of range\r
+#define EXCEPT_EBC_INVALID_OPCODE       5   ///< Opcode out of range.\r
 #define EXCEPT_EBC_STACK_FAULT          6\r
 #define EXCEPT_EBC_ALIGNMENT_CHECK      7\r
-#define EXCEPT_EBC_INSTRUCTION_ENCODING 8   ///< malformed instruction\r
-#define EXCEPT_EBC_BAD_BREAK            9   ///< BREAK 0 or undefined BREAK\r
-#define EXCEPT_EBC_STEP                 10  ///< to support debug stepping\r
+#define EXCEPT_EBC_INSTRUCTION_ENCODING 8   ///< Malformed instruction.\r
+#define EXCEPT_EBC_BAD_BREAK            9   ///< BREAK 0 or undefined BREAK.\r
+#define EXCEPT_EBC_STEP                 10  ///< To support debug stepping.\r
 ///\r
 /// For coding convenience, define the maximum valid EBC exception.\r
 ///\r
 #define MAX_EBC_EXCEPTION EXCEPT_EBC_STEP\r
 \r
 ///\r
-///  EBC processor context definition\r
+///  EBC processor context definition.\r
 ///\r
 typedef struct {\r
   UINT64  R0;\r
@@ -475,7 +474,7 @@ typedef struct {
 \r
 \r
 ///\r
-///  ARM processor exception types\r
+///  ARM processor exception types.\r
 ///\r
 #define EXCEPT_ARM_RESET                    0\r
 #define EXCEPT_ARM_UNDEFINED_INSTRUCTION    1\r
@@ -492,7 +491,7 @@ typedef struct {
 #define MAX_ARM_EXCEPTION EXCEPT_ARM_FIQ\r
 \r
 ///\r
-///  ARM processor context definition\r
+///  ARM processor context definition.\r
 ///\r
 typedef struct {\r
   UINT32  R0;\r
@@ -519,7 +518,7 @@ typedef struct {
 } EFI_SYSTEM_CONTEXT_ARM;\r
 \r
 ///\r
-/// Universal EFI_SYSTEM_CONTEXT definition\r
+/// Universal EFI_SYSTEM_CONTEXT definition.\r
 ///\r
 typedef union {\r
   EFI_SYSTEM_CONTEXT_EBC  *SystemContextEbc;\r
@@ -536,7 +535,7 @@ typedef union {
 /**                                                                 \r
   Registers and enables an exception callback function for the specified exception.\r
     \r
-  @param  ExceptionType         Exception types in EBC, IA-32, x64, or IPF\r
+  @param  ExceptionType         Exception types in EBC, IA-32, x64, or IPF.\r
   @param  SystemContext         Exception content.\r
                                    \r
 **/\r