[mirror_edk2.git] / MdePkg / Include / Library / GraphicsLib.h

/** @file\r
  Library supports displaying graphical splash screen,\r
  locking of keyboard input and printing character on\r
  screen.\r
\r
  Copyright (c) 2006 - 2008, Intel Corporation.<BR>\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
#ifndef __EFI_GRAPHICS_LIB_H__\r
#define __EFI_GRAPHICS_LIB_H__\r
\r
#include <Protocol/GraphicsOutput.h>\r
\r
\r
/**\r
  Return the graphics image file named FileNameGuid into Image and return it's\r
  size in ImageSize. All Firmware Volumes (FV) in the system are searched for the\r
  file name.\r
\r
  @param[in]  FileNameGuid  File Name of graphics file in the FV(s).\r
  @param[out] Image         Pointer to pointer to return graphics image.  If NULL, a \r
                            buffer will be allocated.\r
  @param[out] ImageSize     Size of the graphics Image in bytes. Zero if no image found.\r
\r
  @retval  EFI_SUCCESS          The image is found and data and size is returned.\r
  @retval  EFI_UNSUPPORTED      FvHandle does not support EFI_FIRMWARE_VOLUME2_PROTOCOL.\r
  @retval  EFI_NOT_FOUND        The image specified by NameGuid and SectionType can't be found.\r
  @retval  EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.\r
  @retval  EFI_DEVICE_ERROR	    A hardware error occurs during reading from the Firmware Volume.\r
  @retval  EFI_ACCESS_DENIED    The firmware volume containing the searched Firmware File is configured to disallow reads.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
GetGraphicsBitMapFromFV (\r
  IN  EFI_GUID      *FileNameGuid,\r
  OUT VOID          **Image,\r
  OUT UINTN         *ImageSize\r
  );\r
\r
/**\r
  Return the graphics image file named FileNameGuid into Image and return it's\r
  size in ImageSize. All Firmware Volumes (FV) in the system are searched for the\r
  file name.\r
\r
  @param[in]  ImageHandle   The driver image handle of the caller. The parameter is used to\r
                            optimize the loading of the image file so that the FV from which\r
                            the driver image is loaded will be tried first. \r
  @param[in]  FileNameGuid  File Name of graphics file in the FV(s).\r
  @param[out] Image         Pointer to pointer to return graphics image.  If NULL, a \r
                            buffer will be allocated.\r
  @param[out] ImageSize     Size of the graphics Image in bytes. Zero if no image found.\r
\r
  @retval  EFI_SUCCESS          The image is found and data and size is returned.\r
  @retval  EFI_UNSUPPORTED      FvHandle does not support EFI_FIRMWARE_VOLUME2_PROTOCOL.\r
  @retval  EFI_NOT_FOUND        The image specified by NameGuid and SectionType can't be found.\r
  @retval  EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.\r
  @retval  EFI_DEVICE_ERROR	    A hardware error occurs during reading from the Firmware Volume.\r
  @retval  EFI_ACCESS_DENIED    The firmware volume containing the searched Firmware File is configured to disallow reads.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
GetGraphicsBitMapFromFVEx (\r
  IN  EFI_HANDLE    ImageHandle,\r
  IN  EFI_GUID      *FileNameGuid,\r
  OUT VOID          **Image,\r
  OUT UINTN         *ImageSize\r
  );\r
\r
\r
/**\r
  Use Console Control to turn off UGA based Simple Text Out consoles from going\r
  to the UGA device. Put up LogoFile on every UGA device that is a console\r
\r
  @param[in]  LogoFile   File name of logo to display on the center of the screen.\r
\r
  @retval EFI_SUCCESS     ConsoleControl has been flipped to graphics and logo displayed.\r
  @retval EFI_UNSUPPORTED Logo not found\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EnableQuietBoot (\r
  IN  EFI_GUID  *LogoFile\r
  );\r
\r
/**\r
  Use Console Control to turn off GOP/UGA based Simple Text Out consoles from going\r
  to the UGA device. Put up LogoFile on every UGA device that is a console\r
\r
  @param  LogoFile    File name of logo to display on the center of the screen.\r
  @param  ImageHandle The driver image handle of the caller. The parameter is used to\r
                      optimize the loading of the logo file so that the FV from which\r
                      the driver image is loaded will be tried first.\r
\r
  @retval EFI_SUCCESS     ConsoleControl has been flipped to graphics and logo displayed.\r
  @retval EFI_UNSUPPORTED Logo not found\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EnableQuietBootEx (\r
  IN  EFI_GUID    *LogoFile,\r
  IN  EFI_HANDLE  ImageHandle\r
  );\r
\r
\r
/**\r
  Use Console Control to turn on UGA based Simple Text Out consoles. The UGA \r
  Simple Text Out screens will now be synced up with all non UGA output devices\r
\r
  @retval EFI_SUCCESS     UGA devices are back in text mode and synced up.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
DisableQuietBoot (\r
  VOID\r
  );\r
\r
\r
/**\r
  Use Console Control Protocol to lock the Console In Spliter virtual handle. \r
  This is the ConInHandle and ConIn handle in the EFI system table. All key\r
  presses will be ignored until the Password is typed in. The only way to\r
  disable the password is to type it in to a ConIn device.\r
\r
  @param[in]  Password   Password used to lock ConIn device.\r
\r
  @retval EFI_SUCCESS     lock the Console In Spliter virtual handle successfully.\r
  @retval EFI_UNSUPPORTED Password not found\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
LockKeyboards (\r
  IN  CHAR16    *Password\r
  );\r
\r
\r
/**\r
  Print Unicode string to graphics screen at the given X,Y coordinates of the graphics screen.\r
  see definition of Print to find rules for constructing Fmt.\r
\r
  @param[in]  X            Row to start printing at\r
  @param[in]  Y            Column to start printing at\r
  @param[in]  ForeGround   Foreground color\r
  @param[in]  BackGround   background color\r
  @param[in]  Fmt          Print format sting. See definition of Print\r
  @param ...               Variable argument list whose contents are accessed based on \r
                           the format string specified by Format.\r
\r
  @return  Number of Characters printed.\r
\r
**/\r
UINTN\r
EFIAPI\r
PrintXY (\r
  IN UINTN                            X,\r
  IN UINTN                            Y,\r
  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL    *ForeGround, OPTIONAL\r
  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL    *BackGround, OPTIONAL\r
  IN CHAR16                           *Fmt,\r
  ...\r
  );\r
\r
\r
#endif\r
Commit	Line	Data
	1	/** @file\r
	2	Library supports displaying graphical splash screen,\r
	3	locking of keyboard input and printing character on\r
	4	screen.\r
	5	\r
	6	Copyright (c) 2006 - 2008, Intel Corporation.<BR>\r
	7	All rights reserved. This program and the accompanying materials \r
	8	are licensed and made available under the terms and conditions of the BSD License \r
	9	which accompanies this distribution. The full text of the license may be found at \r
	10	http://opensource.org/licenses/bsd-license.php \r
	11	\r
	12	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	13	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	14	\r
	15	**/\r
	16	\r
	17	#ifndef __EFI_GRAPHICS_LIB_H__\r
	18	#define __EFI_GRAPHICS_LIB_H__\r
	19	\r
	20	#include <Protocol/GraphicsOutput.h>\r
	21	\r
	22	\r
	23	/**\r
	24	Return the graphics image file named FileNameGuid into Image and return it's\r
	25	size in ImageSize. All Firmware Volumes (FV) in the system are searched for the\r
	26	file name.\r
	27	\r
	28	@param[in] FileNameGuid File Name of graphics file in the FV(s).\r
	29	@param[out] Image Pointer to pointer to return graphics image. If NULL, a \r
	30	buffer will be allocated.\r
	31	@param[out] ImageSize Size of the graphics Image in bytes. Zero if no image found.\r
	32	\r
	33	@retval EFI_SUCCESS The image is found and data and size is returned.\r
	34	@retval EFI_UNSUPPORTED FvHandle does not support EFI_FIRMWARE_VOLUME2_PROTOCOL.\r
	35	@retval EFI_NOT_FOUND The image specified by NameGuid and SectionType can't be found.\r
	36	@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.\r
	37	@retval EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume.\r
	38	@retval EFI_ACCESS_DENIED The firmware volume containing the searched Firmware File is configured to disallow reads.\r
	39	\r
	40	**/\r
	41	EFI_STATUS\r
	42	EFIAPI\r
	43	GetGraphicsBitMapFromFV (\r
	44	IN EFI_GUID *FileNameGuid,\r
	45	OUT VOID **Image,\r
	46	OUT UINTN *ImageSize\r
	47	);\r
	48	\r
	49	/**\r
	50	Return the graphics image file named FileNameGuid into Image and return it's\r
	51	size in ImageSize. All Firmware Volumes (FV) in the system are searched for the\r
	52	file name.\r
	53	\r
	54	@param[in] ImageHandle The driver image handle of the caller. The parameter is used to\r
	55	optimize the loading of the image file so that the FV from which\r
	56	the driver image is loaded will be tried first. \r
	57	@param[in] FileNameGuid File Name of graphics file in the FV(s).\r
	58	@param[out] Image Pointer to pointer to return graphics image. If NULL, a \r
	59	buffer will be allocated.\r
	60	@param[out] ImageSize Size of the graphics Image in bytes. Zero if no image found.\r
	61	\r
	62	@retval EFI_SUCCESS The image is found and data and size is returned.\r
	63	@retval EFI_UNSUPPORTED FvHandle does not support EFI_FIRMWARE_VOLUME2_PROTOCOL.\r
	64	@retval EFI_NOT_FOUND The image specified by NameGuid and SectionType can't be found.\r
	65	@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.\r
	66	@retval EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume.\r
	67	@retval EFI_ACCESS_DENIED The firmware volume containing the searched Firmware File is configured to disallow reads.\r
	68	\r
	69	**/\r
	70	EFI_STATUS\r
	71	EFIAPI\r
	72	GetGraphicsBitMapFromFVEx (\r
	73	IN EFI_HANDLE ImageHandle,\r
	74	IN EFI_GUID *FileNameGuid,\r
	75	OUT VOID **Image,\r
	76	OUT UINTN *ImageSize\r
	77	);\r
	78	\r
	79	\r
	80	/**\r
	81	Use Console Control to turn off UGA based Simple Text Out consoles from going\r
	82	to the UGA device. Put up LogoFile on every UGA device that is a console\r
	83	\r
	84	@param[in] LogoFile File name of logo to display on the center of the screen.\r
	85	\r
	86	@retval EFI_SUCCESS ConsoleControl has been flipped to graphics and logo displayed.\r
	87	@retval EFI_UNSUPPORTED Logo not found\r
	88	\r
	89	**/\r
	90	EFI_STATUS\r
	91	EFIAPI\r
	92	EnableQuietBoot (\r
	93	IN EFI_GUID *LogoFile\r
	94	);\r
	95	\r
	96	/**\r
	97	Use Console Control to turn off GOP/UGA based Simple Text Out consoles from going\r
	98	to the UGA device. Put up LogoFile on every UGA device that is a console\r
	99	\r
	100	@param LogoFile File name of logo to display on the center of the screen.\r
	101	@param ImageHandle The driver image handle of the caller. The parameter is used to\r
	102	optimize the loading of the logo file so that the FV from which\r
	103	the driver image is loaded will be tried first.\r
	104	\r
	105	@retval EFI_SUCCESS ConsoleControl has been flipped to graphics and logo displayed.\r
	106	@retval EFI_UNSUPPORTED Logo not found\r
	107	\r
	108	**/\r
	109	EFI_STATUS\r
	110	EFIAPI\r
	111	EnableQuietBootEx (\r
	112	IN EFI_GUID *LogoFile,\r
	113	IN EFI_HANDLE ImageHandle\r
	114	);\r
	115	\r
	116	\r
	117	/**\r
	118	Use Console Control to turn on UGA based Simple Text Out consoles. The UGA \r
	119	Simple Text Out screens will now be synced up with all non UGA output devices\r
	120	\r
	121	@retval EFI_SUCCESS UGA devices are back in text mode and synced up.\r
	122	\r
	123	**/\r
	124	EFI_STATUS\r
	125	EFIAPI\r
	126	DisableQuietBoot (\r
	127	VOID\r
	128	);\r
	129	\r
	130	\r
	131	/**\r
	132	Use Console Control Protocol to lock the Console In Spliter virtual handle. \r
	133	This is the ConInHandle and ConIn handle in the EFI system table. All key\r
	134	presses will be ignored until the Password is typed in. The only way to\r
	135	disable the password is to type it in to a ConIn device.\r
	136	\r
	137	@param[in] Password Password used to lock ConIn device.\r
	138	\r
	139	@retval EFI_SUCCESS lock the Console In Spliter virtual handle successfully.\r
	140	@retval EFI_UNSUPPORTED Password not found\r
	141	\r
	142	**/\r
	143	EFI_STATUS\r
	144	EFIAPI\r
	145	LockKeyboards (\r
	146	IN CHAR16 *Password\r
	147	);\r
	148	\r
	149	\r
	150	/**\r
	151	Print Unicode string to graphics screen at the given X,Y coordinates of the graphics screen.\r
	152	see definition of Print to find rules for constructing Fmt.\r
	153	\r
	154	@param[in] X Row to start printing at\r
	155	@param[in] Y Column to start printing at\r
	156	@param[in] ForeGround Foreground color\r
	157	@param[in] BackGround background color\r
	158	@param[in] Fmt Print format sting. See definition of Print\r
	159	@param ... Variable argument list whose contents are accessed based on \r
	160	the format string specified by Format.\r
	161	\r
	162	@return Number of Characters printed.\r
	163	\r
	164	**/\r
	165	UINTN\r
	166	EFIAPI\r
	167	PrintXY (\r
	168	IN UINTN X,\r
	169	IN UINTN Y,\r
	170	IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *ForeGround, OPTIONAL\r
	171	IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BackGround, OPTIONAL\r
	172	IN CHAR16 *Fmt,\r
	173	...\r
	174	);\r
	175	\r
	176	\r
	177	#endif\r