Add comments for these header files

[mirror_edk2.git] / MdeModulePkg / Include / Protocol / ConsoleControl.h

diff --git a/MdeModulePkg/Include/Protocol/ConsoleControl.h b/MdeModulePkg/Include/Protocol/ConsoleControl.h
index 5b3eb0d8d2af858d0f9d1727382243894adc0395..bf662f2b799a34244205aa80c252ea0025680256 100644 (file)
--- a/MdeModulePkg/Include/Protocol/ConsoleControl.h
+++ b/MdeModulePkg/Include/Protocol/ConsoleControl.h
@@ -2,14 +2,14 @@
 \r
   This protocol provides the interfaces to Get/Set the current video mode for GOP/UGA screen\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 - 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
 \r
 **/\r
 \r
@@ -23,19 +23,20 @@ typedef struct _EFI_CONSOLE_CONTROL_PROTOCOL   EFI_CONSOLE_CONTROL_PROTOCOL;
 \r
 \r
 typedef enum {\r
-  EfiConsoleControlScreenText,\r
-  EfiConsoleControlScreenGraphics,\r
+  EfiConsoleControlScreenText,     /// Text Mode\r
+  EfiConsoleControlScreenGraphics, /// Graphics Mode\r
   EfiConsoleControlScreenMaxValue\r
 } EFI_CONSOLE_CONTROL_SCREEN_MODE;\r
 \r
 /**\r
   Return the current video mode information. Also returns info about existence\r
-  of Graphics Output devices or UGA Draw devices in system, and if the Std In device is locked. All the\r
-  arguments are optional and only returned if a non NULL pointer is passed in.\r
+  of Graphics Output devices or UGA Draw devices in system, and whether the Std\r
+  In device is locked. GopUgaExists and StdInLocked parameters are optional, and\r
+  only returned if a non NULL pointer is passed in.\r
 \r
   @param  This                    Protocol instance pointer.\r
-  @param  Mode                    Are we in text of grahics mode.\r
-  @param  GopExists               TRUE if GOP Spliter has found a GOP/UGA device\r
+  @param  Mode                    Current video mode.\r
+  @param  GopUgaExists            TRUE if GOP Spliter has found a GOP/UGA device\r
   @param  StdInLocked             TRUE if StdIn device is keyboard locked\r
 \r
   @retval EFI_SUCCESS             Video mode information is returned.\r
@@ -44,48 +45,50 @@ typedef enum {
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_CONSOLE_CONTROL_PROTOCOL_GET_MODE) (\r
+(EFIAPI *EFI_CONSOLE_CONTROL_PROTOCOL_GET_MODE)(\r
   IN  EFI_CONSOLE_CONTROL_PROTOCOL      *This,\r
   OUT EFI_CONSOLE_CONTROL_SCREEN_MODE   *Mode,\r
-  OUT BOOLEAN                           *GopUgaExists,  OPTIONAL  \r
+  OUT BOOLEAN                           *GopUgaExists,  OPTIONAL\r
   OUT BOOLEAN                           *StdInLocked    OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
-  Set the current video mode to either text or graphics. \r
+  Set the current video mode to either text or graphics. Graphics is\r
+  for Quiet Boot.\r
 \r
   @param  This                    Protocol instance pointer.\r
-  @param  Mode                    Mode is to be set.\r
+  @param  Mode                    Video mode is to be set.\r
 \r
-  @retval EFI_SUCCESS             Mode is set.\r
+  @retval EFI_SUCCESS             Mode is set successfully.\r
   @retval EFI_INVALID_PARAMETER   Mode is not the valid mode value.\r
   @retval EFI_UNSUPPORTED         Mode is unsupported by console device.\r
 \r
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_CONSOLE_CONTROL_PROTOCOL_SET_MODE) (\r
+(EFIAPI *EFI_CONSOLE_CONTROL_PROTOCOL_SET_MODE)(\r
   IN  EFI_CONSOLE_CONTROL_PROTOCOL      *This,\r
   OUT EFI_CONSOLE_CONTROL_SCREEN_MODE   Mode\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
-  Copy the Password and enable state variable and then arm the periodic timer\r
+  If Password is NULL or the Password is too big, then return an error. If the\r
+  Password is valid, then store the password, lock StdIn and arm the periodic timer.\r
+\r
+  @param  This                     Protocol instance pointer.\r
+  @param  Password                 The password input.\r
 \r
-  @retval EFI_SUCCESS              Lock the StdIn device\r
-  @retval EFI_INVALID_PARAMETER    Password is NULL\r
-  @retval EFI_OUT_OF_RESOURCES     Buffer allocation to store the big password fails\r
+  @retval EFI_SUCCESS              Lock the StdIn device.\r
+  @retval EFI_INVALID_PARAMETER    Password is NULL.\r
+  @retval EFI_OUT_OF_RESOURCES     Buffer allocation to store the password fails.\r
 \r
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_CONSOLE_CONTROL_PROTOCOL_LOCK_STD_IN) (\r
+(EFIAPI *EFI_CONSOLE_CONTROL_PROTOCOL_LOCK_STD_IN)(\r
   IN  EFI_CONSOLE_CONTROL_PROTOCOL      *This,\r
-  IN CHAR16                             *Password\r
-  )\r
-;\r
+  IN  CHAR16                            *Password\r
+  );\r
 \r
 struct _EFI_CONSOLE_CONTROL_PROTOCOL {\r
   EFI_CONSOLE_CONTROL_PROTOCOL_GET_MODE           GetMode;\r