return EFI_NOT_FOUND;\r
}\r
\r
+/**\r
+ Reallocate Text Out mode map.\r
+\r
+ @param Private Consplitter Text Out pointer.\r
+\r
+ @retval EFI_SUCCESS Buffer size has grown\r
+ @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.\r
+\r
+**/\r
EFI_STATUS\r
ConSplitterGrowMapTable (\r
IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private\r
/**\r
Add the device's output mode to console splitter's mode list.\r
\r
- @param Private Text Out Splitter pointer\r
+ @param Private Text Out Splitter pointer.\r
@param TextOut Simple Text Output protocol pointer.\r
\r
- @reture None\r
+ @return None\r
\r
**/\r
VOID\r
from ConsoleOutMode variable and set it; if the variable does not exist,\r
set to user defined console mode.\r
\r
- None\r
+ @param Private Consplitter Text Out pointer.\r
\r
@return None\r
\r
Reads the next keystroke from the input device. The WaitForKey Event can\r
be used to test for existance of a keystroke via WaitForEvent () call.\r
\r
- @param This Protocol instance pointer.\r
+ @param Private Protocol instance pointer.\r
@param Key Driver may perform diagnostics on reset.\r
\r
@retval EFI_SUCCESS The keystroke information was returned.\r
timer. If the Password is too big return an error. If the Password is valid\r
Copy the Password and enable state variable and then arm the periodic timer\r
\r
+ @param This Console Control protocol 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
Reads the next keystroke from the input device. The WaitForKey Event can\r
be used to test for existance of a keystroke via WaitForEvent () call.\r
\r
- @param This Protocol instance pointer. State -\r
+ @param Private Protocol instance pointer.\r
+ @param State The state information of simple pointer device.\r
\r
@retval EFI_SUCCESS The keystroke information was returned.\r
@retval EFI_NOT_READY There was no keystroke data availiable.\r
Write a Unicode string to the output device.\r
\r
@param This Protocol instance pointer.\r
- @param String The NULL-terminated Unicode string to be\r
+ @param WString The NULL-terminated Unicode string to be\r
displayed on the output device(s). All output\r
devices must also support the Unicode drawing\r
defined in this file.\r
target device.\r
\r
@param This Protocol instance pointer.\r
- @param String The NULL-terminated Unicode string to be\r
+ @param WString The NULL-terminated Unicode string to be\r
examined for the output device(s).\r
\r
@retval EFI_SUCCESS The device(s) are capable of rendering the\r
\r
@param This Protocol instance pointer.\r
@param ModeNumber The mode number to return information on.\r
- @param Rows Returns the geometry of the text output device\r
+ @param Columns Returns the columns of the text output device\r
+ for the requested ModeNumber.\r
+ @param Rows Returns the rows of the text output device\r
for the requested ModeNumber.\r
\r
@retval EFI_SUCCESS The requested mode information was returned.\r
Sets the current coordinates of the cursor position\r
\r
@param This Protocol instance pointer.\r
- @param Row the position to set the cursor to. Must be\r
+ @param Column The column position to set the cursor to. Must be\r
+ greater than or equal to zero and less than the\r
+ number of columns by QueryMode ().\r
+ @param Row The row position to set the cursor to. Must be\r
greater than or equal to zero and less than the\r
- number of columns and rows by QueryMode ().\r
+ number of rows by QueryMode ().\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_DEVICE_ERROR The device had an error and could not complete\r
timer. If the Password is too big return an error. If the Password is valid\r
Copy the Password and enable state variable and then arm the periodic timer\r
\r
+ @param This Console Control protocol 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
Reads the next keystroke from the input device. The WaitForKey Event can\r
be used to test for existance of a keystroke via WaitForEvent () call.\r
\r
- @param This Protocol instance pointer.\r
+ @param Private Protocol instance pointer.\r
@param Key Driver may perform diagnostics on reset.\r
\r
@retval EFI_SUCCESS The keystroke information was returned.\r
Write a Unicode string to the output device.\r
\r
@param This Protocol instance pointer.\r
- @param String The NULL-terminated Unicode string to be\r
+ @param WString The NULL-terminated Unicode string to be\r
displayed on the output device(s). All output\r
devices must also support the Unicode drawing\r
defined in this file.\r
target device.\r
\r
@param This Protocol instance pointer.\r
- @param String The NULL-terminated Unicode string to be\r
+ @param WString The NULL-terminated Unicode string to be\r
examined for the output device(s).\r
\r
@retval EFI_SUCCESS The device(s) are capable of rendering the\r
\r
@param This Protocol instance pointer.\r
@param ModeNumber The mode number to return information on.\r
- @param Rows Returns the geometry of the text output device\r
+ @param Columns Returns the columns of the text output device\r
+ for the requested ModeNumber.\r
+ @param Rows Returns the rows of the text output device\r
for the requested ModeNumber.\r
\r
@retval EFI_SUCCESS The requested mode information was returned.\r
Sets the current coordinates of the cursor position\r
\r
@param This Protocol instance pointer.\r
- @param Row the position to set the cursor to. Must be\r
+ @param Column The column position to set the cursor to. Must be\r
greater than or equal to zero and less than the\r
- number of columns and rows by QueryMode ().\r
+ number of columns by QueryMode ().\r
+ @param Row The row position to set the cursor to. Must be\r
+ greater than or equal to zero and less than the\r
+ number of rows by QueryMode ().\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_DEVICE_ERROR The device had an error and could not complete\r
@param DestinationX X coordinate of destination for the BltBuffer.\r
@param DestinationY Y coordinate of destination for the BltBuffer.\r
@param Width Width of rectangle in BltBuffer in pixels.\r
- @param Height Hight of rectangle in BltBuffer in pixels. Delta\r
- -\r
+ @param Height Hight of rectangle in BltBuffer in pixels. \r
+ @param Delta OPTIONAL.\r
\r
@retval EFI_SUCCESS The Blt operation completed.\r
@retval EFI_INVALID_PARAMETER BltOperation is not valid.\r
)\r
;\r
\r
+/**\r
+ Write data from the buffer to video display based on Graphics Output setting. \r
+\r
+ @param Private Consplitter Text Out pointer.\r
+ @param GraphicsOutput Graphics Output protocol pointer.\r
+ @param UgaDraw UGA Draw protocol pointer.\r
+\r
+ @retval EFI_UNSUPPORTED No graphics devcie available .\r
+ @retval EFI_SUCCESS The Blt operation completed.\r
+ @retval EFI_INVALID_PARAMETER BltOperation is not valid.\r
+ @retval EFI_DEVICE_ERROR A hardware error occured writting to the video buffer.\r
+ \r
+\r
+**/\r
EFI_STATUS\r
DevNullGopSync (\r
IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private,\r
@param DestinationX X coordinate of destination for the BltBuffer.\r
@param DestinationY Y coordinate of destination for the BltBuffer.\r
@param Width Width of rectangle in BltBuffer in pixels.\r
- @param Height Hight of rectangle in BltBuffer in pixels. Delta\r
- -\r
+ @param Height Hight of rectangle in BltBuffer in pixels. \r
+ @param Delta OPTIONAL.\r
\r
@retval EFI_SUCCESS The Blt operation completed.\r
@retval EFI_INVALID_PARAMETER BltOperation is not valid.\r
)\r
;\r
\r
+/**\r
+ Write data from the buffer to video display based on UGA Draw setting. \r
+\r
+ @param Private Consplitter Text Out pointer.\r
+ @param GraphicsOutput Graphics Output protocol pointer.\r
+ @param UgaDraw UGA Draw protocol pointer.\r
+\r
+ @retval EFI_UNSUPPORTED No graphics devcie available .\r
+ @retval EFI_SUCCESS The Blt operation completed.\r
+ @retval EFI_INVALID_PARAMETER BltOperation is not valid.\r
+ @retval EFI_DEVICE_ERROR A hardware error occured writting to the video buffer.\r
+ \r
+**/\r
EFI_STATUS\r
DevNullUgaSync (\r
IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private,\r
return ReturnStatus;\r
}\r
\r
+/**\r
+ The following table defines actions for BltOperations.\r
+\r
+ EfiBltVideoFill - Write data from the BltBuffer pixel (SourceX, SourceY)\r
+ directly to every pixel of the video display rectangle\r
+ (DestinationX, DestinationY)\r
+ (DestinationX + Width, DestinationY + Height).\r
+ Only one pixel will be used from the BltBuffer. Delta is NOT used.\r
+ EfiBltVideoToBltBuffer - Read data from the video display rectangle\r
+ (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in\r
+ the BltBuffer rectangle (DestinationX, DestinationY )\r
+ (DestinationX + Width, DestinationY + Height). If DestinationX or\r
+ DestinationY is not zero then Delta must be set to the length in bytes\r
+ of a row in the BltBuffer.\r
+ EfiBltBufferToVideo - Write data from the BltBuffer rectangle\r
+ (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the\r
+ video display rectangle (DestinationX, DestinationY)\r
+ (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is\r
+ not zero then Delta must be set to the length in bytes of a row in the\r
+ BltBuffer.\r
+ EfiBltVideoToVideo - Copy from the video display rectangle\r
+ (SourceX, SourceY) (SourceX + Width, SourceY + Height) .\r
+ to the video display rectangle (DestinationX, DestinationY)\r
+ (DestinationX + Width, DestinationY + Height).\r
+ The BltBuffer and Delta are not used in this mode.\r
+\r
+ @param Private Protocol instance pointer.\r
+ @param BltBuffer Buffer containing data to blit into video buffer.\r
+ This buffer has a size of\r
+ Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL)\r
+ @param BltOperation Operation to perform on BlitBuffer and video\r
+ memory\r
+ @param SourceX X coordinate of source for the BltBuffer.\r
+ @param SourceY Y coordinate of source for the BltBuffer.\r
+ @param DestinationX X coordinate of destination for the BltBuffer.\r
+ @param DestinationY Y coordinate of destination for the BltBuffer.\r
+ @param Width Width of rectangle in BltBuffer in pixels.\r
+ @param Height Hight of rectangle in BltBuffer in pixels. \r
+ @param Delta OPTIONAL.\r
+\r
+ @retval EFI_SUCCESS The Blt operation completed.\r
+ @retval EFI_INVALID_PARAMETER BltOperation is not valid.\r
+ @retval EFI_DEVICE_ERROR A hardware error occured writting to the video\r
+ buffer.\r
+\r
+**/\r
EFI_STATUS\r
DevNullGraphicsOutputBlt (\r
IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private,\r
@param DestinationY Y coordinate of destination for the BltBuffer.\r
@param Width Width of rectangle in BltBuffer in pixels.\r
@param Height Hight of rectangle in BltBuffer in pixels. \r
- @param Delta (not used here).\r
+ @param Delta OPTIONAL.\r
\r
@retval EFI_SUCCESS The Blt operation completed.\r
@retval EFI_INVALID_PARAMETER BltOperation is not valid.\r
return ReturnStatus;\r
}\r
\r
+/**\r
+ Write data from the buffer to video display based on Graphics Output setting. \r
+\r
+ @param Private Consplitter Text Out pointer.\r
+ @param GraphicsOutput Graphics Output protocol pointer.\r
+ @param UgaDraw UGA Draw protocol pointer.\r
+\r
+ @retval EFI_UNSUPPORTED No graphics devcie available .\r
+ @retval EFI_SUCCESS The Blt operation completed.\r
+ @retval EFI_INVALID_PARAMETER BltOperation is not valid.\r
+ @retval EFI_DEVICE_ERROR A hardware error occured writting to the video buffer.\r
+ \r
+\r
+**/\r
EFI_STATUS\r
DevNullGopSync (\r
IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private,\r
return ReturnStatus;\r
}\r
\r
+/**\r
+ The following table defines actions for BltOperations.\r
+\r
+ EfiBltVideoFill - Write data from the BltBuffer pixel (SourceX, SourceY)\r
+ directly to every pixel of the video display rectangle\r
+ (DestinationX, DestinationY)\r
+ (DestinationX + Width, DestinationY + Height).\r
+ Only one pixel will be used from the BltBuffer. Delta is NOT used.\r
+ EfiBltVideoToBltBuffer - Read data from the video display rectangle\r
+ (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in\r
+ the BltBuffer rectangle (DestinationX, DestinationY )\r
+ (DestinationX + Width, DestinationY + Height). If DestinationX or\r
+ DestinationY is not zero then Delta must be set to the length in bytes\r
+ of a row in the BltBuffer.\r
+ EfiBltBufferToVideo - Write data from the BltBuffer rectangle\r
+ (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the\r
+ video display rectangle (DestinationX, DestinationY)\r
+ (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is\r
+ not zero then Delta must be set to the length in bytes of a row in the\r
+ BltBuffer.\r
+ EfiBltVideoToVideo - Copy from the video display rectangle\r
+ (SourceX, SourceY) (SourceX + Width, SourceY + Height) .\r
+ to the video display rectangle (DestinationX, DestinationY)\r
+ (DestinationX + Width, DestinationY + Height).\r
+ The BltBuffer and Delta are not used in this mode.\r
+\r
+ @param Private Protocol instance pointer.\r
+ @param BltBuffer Buffer containing data to blit into video buffer.\r
+ This buffer has a size of\r
+ Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL)\r
+ @param BltOperation Operation to perform on BlitBuffer and video\r
+ memory\r
+ @param SourceX X coordinate of source for the BltBuffer.\r
+ @param SourceY Y coordinate of source for the BltBuffer.\r
+ @param DestinationX X coordinate of destination for the BltBuffer.\r
+ @param DestinationY Y coordinate of destination for the BltBuffer.\r
+ @param Width Width of rectangle in BltBuffer in pixels.\r
+ @param Height Hight of rectangle in BltBuffer in pixels. \r
+ @param Delta OPTIONAL.\r
+\r
+ @retval EFI_SUCCESS The Blt operation completed.\r
+ @retval EFI_INVALID_PARAMETER BltOperation is not valid.\r
+ @retval EFI_DEVICE_ERROR A hardware error occured writting to the video\r
+ buffer.\r
+\r
+**/\r
EFI_STATUS\r
DevNullUgaBlt (\r
IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private,\r
@param DestinationY Y coordinate of destination for the BltBuffer.\r
@param Width Width of rectangle in BltBuffer in pixels.\r
@param Height Hight of rectangle in BltBuffer in pixels.\r
- @param Delta (not used here)\r
+ @param Delta OPTIONAL.\r
\r
@retval EFI_SUCCESS The Blt operation completed.\r
@retval EFI_INVALID_PARAMETER BltOperation is not valid.\r
return ReturnStatus;\r
}\r
\r
+/**\r
+ Write data from the buffer to video display based on UGA Draw setting. \r
+\r
+ @param Private Consplitter Text Out pointer.\r
+ @param GraphicsOutput Graphics Output protocol pointer.\r
+ @param UgaDraw UGA Draw protocol pointer.\r
+\r
+ @retval EFI_UNSUPPORTED No graphics devcie available .\r
+ @retval EFI_SUCCESS The Blt operation completed.\r
+ @retval EFI_INVALID_PARAMETER BltOperation is not valid.\r
+ @retval EFI_DEVICE_ERROR A hardware error occured writting to the video buffer.\r
+ \r
+**/\r
EFI_STATUS\r
DevNullUgaSync (\r
IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private,\r
projects / mirror_edk2.git / commitdiff