tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

refine comments for EFI_CONSOLE_CONTROL_PROTOCOL 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7091 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
eric_tian 2008-12-23 02:56:44 +00:00
parent aae4ad0583
commit d2bc9f321f
3 changed files with 17 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
MdeModulePkg/Include/Protocol/ConsoleControl.h
View File

@ -30,8 +30,8 @@ typedef enum {
/**
Return the current video mode information. Also returns info about existence
of Graphics Output devices or UGA Draw devices in system, and whether the Std In device is locked.
GopUgaExists and StdInLocked parameters are optional.
of Graphics Output devices or UGA Draw devices in system, and whether the Std
In device is locked. GopUgaExists and StdInLocked parameters are optional.
@param This Protocol instance pointer.
@param Mode Current video mode.
@ -52,7 +52,8 @@ EFI_STATUS
);
/**
Set the current video mode to either text or graphics.
Set the current video mode to either text or graphics. Graphics is
for Quiet Boot.
@param This Protocol instance pointer.
@param Mode Video mode is to be set.
@ -70,17 +71,15 @@ EFI_STATUS
);
/**
Store the password, enable state variable and arm the periodic timer.
If Password is NULL unlock the password state variable and set the event
timer. If the Password is too big return an error. If the Password is valid
Copy the Password and enable state variable and then arm the periodic timer
If Password is NULL or the Password is too big, then return an error. If the
Password is valid, then store the password, lock StdIn and arm the periodic timer.
@param This Console Control protocol pointer.
@param Password The password input.
@retval EFI_SUCCESS Lock the StdIn device successfully.
@retval EFI_SUCCESS Lock the StdIn device
@retval EFI_INVALID_PARAMETER Password is NULL
@retval EFI_OUT_OF_RESOURCES Buffer allocation to store the big password fails
@retval EFI_OUT_OF_RESOURCES Buffer allocation to store the password fails
**/
typedef

5
MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c
View File

@ -3434,9 +3434,8 @@ ConSpliterConsoleControlLockStdInEvent (
/**
If Password is NULL unlock the password state variable and set the event
timer. If the Password is too big return an error. If the Password is valid
Copy the Password and enable state variable and then arm the periodic timer
If Password is NULL or the Password is too big, then return an error. If the
Password is valid, then store the password, lock StdIn and arm the periodic timer.
@param This Console Control protocol pointer.
@param Password The password input.

13
MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitterGraphics.c
View File

@ -25,16 +25,17 @@ CHAR16 mCrLfString[3] = { CHAR_CARRIAGE_RETURN, CHAR_LINEFEED, CHAR_NULL };
/**
Return the current video mode information. Also returns info about existence
of Graphics Output devices or UGA Draw devices in system, and if the Std In device is locked. All the
arguments are optional and only returned if a non NULL pointer is passed in.
of Graphics Output devices or UGA Draw devices in system, and whether the Std
In device is locked. GopUgaExists and StdInLocked parameters are optional, and
only returned if a non NULL pointer is passed in.
@param This Protocol instance pointer.
@param Mode Are we in text of grahics mode.
@param GopUgaExists TRUE if Console Spliter has found a GOP or UGA device
@param Mode Current video mode.
@param GopExists TRUE if GOP Spliter has found a GOP/UGA device
@param StdInLocked TRUE if StdIn device is keyboard locked
@retval EFI_SUCCESS Mode information returned.
@retval EFI_INVALID_PARAMETER Invalid parameters.
@retval EFI_SUCCESS Video mode information is returned.
@retval EFI_INVALID_PARAMETER Invalid parameters if Mode == NULL.
**/
EFI_STATUS