]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/SimpleTextOut.h
Resolve GCC build error, where #pragma pack(push[, id], <n>) is not supported.
[mirror_edk2.git] / MdePkg / Include / Protocol / SimpleTextOut.h
index b75e52a69605c9c7298c1e593f237e7b6e880973..15ae968e6402586a558a783cc78e1fa77e29e7c7 100644 (file)
@@ -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 - 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
@@ -148,7 +148,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
@@ -165,12 +165,12 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Write a Unicode string to the output device.\r
+  Write a string to the output device.\r
 \r
-  @param  This   Protocol instance pointer.\r
-  @param  String The NULL-terminated Unicode string to be displayed on the output\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 defined in this file.\r
+                 drawing character codes defined in this file.\r
 \r
   @retval EFI_SUCCESS             The string was output to the device.\r
   @retval EFI_DEVICE_ERROR        The device reported an error while attempting to output\r
@@ -178,7 +178,7 @@ EFI_STATUS
   @retval EFI_UNSUPPORTED         The output device's mode is not currently in a\r
                                   defined text mode.\r
   @retval EFI_WARN_UNKNOWN_GLYPH  This warning code indicates that some of the\r
-                                  characters in the Unicode string could not be\r
+                                  characters in the string could not be\r
                                   rendered and were skipped.\r
 \r
 **/\r
@@ -190,15 +190,15 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Verifies that all characters in a Unicode string can be output to the \r
+  Verifies that all characters in a string can be output to the \r
   target device.\r
 \r
-  @param  This   Protocol instance pointer.\r
-  @param  String The NULL-terminated Unicode string to be examined for the output\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
   @retval EFI_SUCCESS      The device(s) are capable of rendering the output string.\r
-  @retval EFI_UNSUPPORTED  Some of the characters in the Unicode string cannot be\r
+  @retval EFI_UNSUPPORTED  Some of the characters in the string cannot be\r
                            rendered by one or more of the output devices mapped\r
                            by the EFI handle.\r
 \r
@@ -214,7 +214,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 +238,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 +257,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 +278,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 +294,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 +319,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 +356,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