MdePkg: Refine EFI_DARKGRAY definition and comments for EFI_TEXT_ATTR

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

diff --git a/MdePkg/Include/Protocol/SimpleTextOut.h b/MdePkg/Include/Protocol/SimpleTextOut.h
index f3e88ee6853acadc4fd639d61a8302474c57b21d..5f64b64c2f7d55866a4c920d7fd468df29a86864 100644 (file)
--- a/MdePkg/Include/Protocol/SimpleTextOut.h
+++ b/MdePkg/Include/Protocol/SimpleTextOut.h
@@ -6,14 +6,14 @@
   a single hardware device or a virtual device that is an aggregation\r
   of multiple physical devices.\r
 \r
-  Copyright (c) 2006 - 2008, 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
-  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 - 2015, 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
@@ -115,7 +115,7 @@ typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL   SIMPLE_TEXT_OUTPUT_INTERFACE;
 #define EFI_BROWN                 (EFI_GREEN | EFI_RED)\r
 #define EFI_LIGHTGRAY             (EFI_BLUE | EFI_GREEN | EFI_RED)\r
 #define EFI_BRIGHT                0x08\r
-#define EFI_DARKGRAY              (EFI_BRIGHT)\r
+#define EFI_DARKGRAY              (EFI_BLACK | EFI_BRIGHT)\r
 #define EFI_LIGHTBLUE             (EFI_BLUE | EFI_BRIGHT)\r
 #define EFI_LIGHTGREEN            (EFI_GREEN | EFI_BRIGHT)\r
 #define EFI_LIGHTCYAN             (EFI_CYAN | EFI_BRIGHT)\r
@@ -124,7 +124,18 @@ typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL   SIMPLE_TEXT_OUTPUT_INTERFACE;
 #define EFI_YELLOW                (EFI_BROWN | EFI_BRIGHT)\r
 #define EFI_WHITE                 (EFI_BLUE | EFI_GREEN | EFI_RED | EFI_BRIGHT)\r
 \r
-#define EFI_TEXT_ATTR(f, b)       ((f) | ((b) << 4))\r
+//\r
+// Macro to accept color values in their raw form to create \r
+// a value that represents both a foreground and background \r
+// color in a single byte.\r
+// For Foreground, and EFI_* value is valid from EFI_BLACK(0x00) to\r
+// EFI_WHITE (0x0F).\r
+// For Background, only EFI_BLACK, EFI_BLUE, EFI_GREEN, EFI_CYAN,\r
+// EFI_RED, EFI_MAGENTA, EFI_BROWN, and EFI_LIGHTGRAY are acceptable\r
+//\r
+// Do not use EFI_BACKGROUND_xxx values with this macro.\r
+//\r
+#define EFI_TEXT_ATTR(Foreground,Background) ((Foreground) | ((Background) << 4))\r
 \r
 #define EFI_BACKGROUND_BLACK      0x00\r
 #define EFI_BACKGROUND_BLUE       0x10\r
@@ -148,7 +159,7 @@ typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL   SIMPLE_TEXT_OUTPUT_INTERFACE;
 /**\r
   Reset the text output device hardware and optionaly run diagnostics\r
 \r
-  @param  This                 Protocol instance pointer.\r
+  @param  This                 The protocol instance pointer.\r
   @param  ExtendedVerification Driver may perform more exhaustive verfication\r
                                operation of the device during reset.\r
 \r
@@ -167,7 +178,7 @@ EFI_STATUS
 /**\r
   Write a string to the output device.\r
 \r
-  @param  This   Protocol instance pointer.\r
+  @param  This   The protocol instance pointer.\r
   @param  String The NULL-terminated string to be displayed on the output\r
                  device(s). All output devices must also support the Unicode\r
                  drawing character codes defined in this file.\r
@@ -193,7 +204,7 @@ EFI_STATUS
   Verifies that all characters in a string can be output to the \r
   target device.\r
 \r
-  @param  This   Protocol instance pointer.\r
+  @param  This   The protocol instance pointer.\r
   @param  String The NULL-terminated string to be examined for the output\r
                  device(s).\r
 \r
@@ -214,7 +225,7 @@ EFI_STATUS
   Returns information for an available text mode that the output device(s)\r
   supports.\r
 \r
-  @param  This       Protocol instance pointer.\r
+  @param  This       The protocol instance pointer.\r
   @param  ModeNumber The mode number to return information on.\r
   @param  Columns    Returns the geometry of the text output device for the\r
                      requested ModeNumber.\r
@@ -238,7 +249,7 @@ EFI_STATUS
 /**\r
   Sets the output device(s) to a specified mode.\r
 \r
-  @param  This       Protocol instance pointer.\r
+  @param  This       The protocol instance pointer.\r
   @param  ModeNumber The mode number to set.\r
 \r
   @retval EFI_SUCCESS      The requested text mode was set.\r
@@ -257,7 +268,7 @@ EFI_STATUS
   Sets the background and foreground colors for the OutputString () and\r
   ClearScreen () functions.\r
 \r
-  @param  This      Protocol instance pointer.\r
+  @param  This      The protocol instance pointer.\r
   @param  Attribute The attribute to set. Bits 0..3 are the foreground color, and\r
                     bits 4..6 are the background color. All other bits are undefined\r
                     and must be zero. The valid Attributes are defined in this file.\r
@@ -278,7 +289,7 @@ EFI_STATUS
   Clears the output device(s) display to the currently selected background \r
   color.\r
 \r
-  @param  This              Protocol instance pointer.\r
+  @param  This              The protocol instance pointer.\r
                            \r
   @retval  EFI_SUCCESS      The operation completed successfully.\r
   @retval  EFI_DEVICE_ERROR The device had an error and could not complete the request.\r
@@ -294,7 +305,7 @@ EFI_STATUS
 /**\r
   Sets the current coordinates of the cursor position\r
 \r
-  @param  This        Protocol instance pointer.\r
+  @param  This        The protocol instance pointer.\r
   @param  Column      The position to set the cursor to. Must be greater than or\r
                       equal to zero and less than the number of columns and rows\r
                       by QueryMode ().\r
@@ -319,7 +330,7 @@ EFI_STATUS
 /**\r
   Makes the cursor visible or invisible\r
 \r
-  @param  This    Protocol instance pointer.\r
+  @param  This    The protocol instance pointer.\r
   @param  Visible If TRUE, the cursor is set to be visible. If FALSE, the cursor is\r
                   set to be invisible.\r
 \r
@@ -356,7 +367,7 @@ typedef struct {
   ///\r
   INT32   Mode;\r
   ///\r
-  /// The current character output attribute\r
+  /// The current character output attribute.\r
   ///\r
   INT32   Attribute;\r
   ///\r