summaryrefslogtreecommitdiff
path: root/MdePkg
diff options
context:
space:
mode:
authoreric_tian <eric_tian@6f19259b-4bc3-4df7-8a09-765794883524>2008-09-28 01:49:41 +0000
committereric_tian <eric_tian@6f19259b-4bc3-4df7-8a09-765794883524>2008-09-28 01:49:41 +0000
commit8517ee5107e6f39bcffb45465fd839b7a57009f6 (patch)
tree1a552fa12f7f810ab5f554e13f37c21fb0ac99b2 /MdePkg
parent77927226262ba71631c4a1a13dc02078249daa6c (diff)
downloadedk2-platforms-8517ee5107e6f39bcffb45465fd839b7a57009f6.tar.xz
sync GraphicsLib.h with Mde Library Spec.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6054 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg')
-rw-r--r--MdePkg/Include/Library/GraphicsLib.h29
1 files changed, 15 insertions, 14 deletions
diff --git a/MdePkg/Include/Library/GraphicsLib.h b/MdePkg/Include/Library/GraphicsLib.h
index 915c306ee1..50cb421370 100644
--- a/MdePkg/Include/Library/GraphicsLib.h
+++ b/MdePkg/Include/Library/GraphicsLib.h
@@ -1,5 +1,5 @@
/** @file
- Library supports diplaying graphical splash screen,
+ Library supports displaying graphical splash screen,
locking of keyboard input and printing character on
screen.
@@ -30,11 +30,12 @@
buffer will be allocated.
@param[out] ImageSize Size of the graphics Image in bytes. Zero if no image found.
- @retval EFI_INVALID_PARAMETER invalid parameter
- @retval EFI_UNSUPPORTED Range can not be erased
- @retval EFI_SUCCESS Image and ImageSize are valid.
- @retval EFI_BUFFER_TOO_SMALL Image not big enough. ImageSize has required size
- @retval EFI_NOT_FOUND FileNameGuid not found
+ @retval EFI_SUCCESS The image is found and data and size is returned.
+ @retval EFI_UNSUPPORTED FvHandle does not support EFI_FIRMWARE_VOLUME2_PROTOCOL.
+ @retval EFI_NOT_FOUND The image specified by NameGuid and SectionType can't be found.
+ @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.
+ @retval EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume.
+ @retval EFI_ACCESS_DENIED The firmware volume containing the searched Firmware File is configured to disallow reads.
**/
EFI_STATUS
@@ -58,11 +59,12 @@ GetGraphicsBitMapFromFV (
buffer will be allocated.
@param[out] ImageSize Size of the graphics Image in bytes. Zero if no image found.
- @retval EFI_INVALID_PARAMETER invalid parameter
- @retval EFI_UNSUPPORTED Range can not be erased
- @retval EFI_SUCCESS Image and ImageSize are valid.
- @retval EFI_BUFFER_TOO_SMALL Image not big enough. ImageSize has required size
- @retval EFI_NOT_FOUND FileNameGuid not found
+ @retval EFI_SUCCESS The image is found and data and size is returned.
+ @retval EFI_UNSUPPORTED FvHandle does not support EFI_FIRMWARE_VOLUME2_PROTOCOL.
+ @retval EFI_NOT_FOUND The image specified by NameGuid and SectionType can't be found.
+ @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.
+ @retval EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume.
+ @retval EFI_ACCESS_DENIED The firmware volume containing the searched Firmware File is configured to disallow reads.
**/
EFI_STATUS
@@ -134,8 +136,7 @@ DisableQuietBoot (
@param[in] Password Password used to lock ConIn device.
- @retval EFI_SUCCESS ConsoleControl has been flipped to graphics and logo
- displayed.
+ @retval EFI_SUCCESS lock the Console In Spliter virtual handle successfully.
@retval EFI_UNSUPPORTED Password not found
**/
@@ -147,7 +148,7 @@ LockKeyboards (
/**
- Print to graphics screen at the given X,Y coordinates of the graphics screen.
+ Print Unicode string to graphics screen at the given X,Y coordinates of the graphics screen.
see definition of Print to find rules for constructing Fmt.
@param[in] X Row to start printing at