#define _CON_SPLITTER_H_\r
\r
#include <Uefi.h>\r
-#include <Guid/PrimaryStandardErrorDevice.h>\r
-#include <Guid/PrimaryConsoleOutDevice.h>\r
-#include <Protocol/GraphicsOutput.h>\r
-#include <Guid/PrimaryConsoleInDevice.h>\r
-#include <Guid/GenericPlatformVariable.h>\r
+\r
+#include <Protocol/DevicePath.h>\r
+#include <Protocol/ComponentName.h>\r
+#include <Protocol/DriverBinding.h>\r
+#include <Protocol/ConsoleControl.h>\r
#include <Protocol/SimplePointer.h>\r
#include <Protocol/AbsolutePointer.h>\r
#include <Protocol/SimpleTextOut.h>\r
-#include <Guid/ConsoleInDevice.h>\r
#include <Protocol/SimpleTextIn.h>\r
#include <Protocol/SimpleTextInEx.h>\r
-#include <Protocol/ConsoleControl.h>\r
+#include <Protocol/GraphicsOutput.h>\r
+#include <Protocol/UgaDraw.h>\r
+\r
+#include <Guid/ConsoleInDevice.h>\r
#include <Guid/StandardErrorDevice.h>\r
#include <Guid/ConsoleOutDevice.h>\r
-#include <Protocol/UgaDraw.h>\r
+\r
#include <Library/PcdLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
extern EFI_COMPONENT_NAME_PROTOCOL gConSplitterStdErrComponentName;\r
extern EFI_COMPONENT_NAME2_PROTOCOL gConSplitterStdErrComponentName2;\r
\r
-extern EFI_GUID gSimpleTextInExNotifyGuid;\r
\r
+//\r
// These definitions were in the old Hii protocol, but are not in the new UEFI\r
// version. So they are defined locally.\r
+//\r
#define UNICODE_NARROW_CHAR 0xFFF0\r
#define UNICODE_WIDE_CHAR 0xFFF1\r
\r
#define CONSOLE_SPLITTER_MODES_ALLOC_UNIT 32\r
#define MAX_STD_IN_PASSWORD 80\r
\r
-#define VARCONOUTMODE L"ConOutMode"\r
\r
typedef struct {\r
UINTN Column;\r
} CONSOLE_OUT_MODE;\r
\r
typedef struct {\r
- UINTN Columns;\r
- UINTN Rows;\r
+ UINTN Columns;\r
+ UINTN Rows;\r
} TEXT_OUT_SPLITTER_QUERY_DATA;\r
\r
-//\r
-// Private data for the EFI_SIMPLE_TEXT_INPUT_PROTOCOL splitter\r
-//\r
-#define TEXT_IN_SPLITTER_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('T', 'i', 'S', 'p')\r
\r
-#define TEXT_IN_EX_SPLITTER_NOTIFY_SIGNATURE SIGNATURE_32 ('T', 'i', 'S', 'n')\r
+#define TEXT_IN_EX_SPLITTER_NOTIFY_SIGNATURE SIGNATURE_32 ('T', 'i', 'S', 'n')\r
\r
+//\r
+// Private data for Text In Ex Splitter Notify\r
+//\r
typedef struct _TEXT_IN_EX_SPLITTER_NOTIFY {\r
UINTN Signature;\r
EFI_HANDLE *NotifyHandleList;\r
LIST_ENTRY NotifyEntry;\r
} TEXT_IN_EX_SPLITTER_NOTIFY;\r
\r
+#define TEXT_IN_EX_SPLITTER_NOTIFY_FROM_THIS(a) \\r
+ CR ((a), \\r
+ TEXT_IN_EX_SPLITTER_NOTIFY, \\r
+ NotifyEntry, \\r
+ TEXT_IN_EX_SPLITTER_NOTIFY_SIGNATURE \\r
+ )\r
+\r
+#define TEXT_IN_SPLITTER_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('T', 'i', 'S', 'p')\r
+\r
+//\r
+// Private data for the Console In splitter\r
+//\r
typedef struct {\r
UINT64 Signature;\r
EFI_HANDLE VirtualHandle;\r
} TEXT_IN_SPLITTER_PRIVATE_DATA;\r
\r
#define TEXT_IN_SPLITTER_PRIVATE_DATA_FROM_THIS(a) \\r
- CR ((a), \\r
+ CR ((a), \\r
TEXT_IN_SPLITTER_PRIVATE_DATA, \\r
TextIn, \\r
TEXT_IN_SPLITTER_PRIVATE_DATA_SIGNATURE \\r
)\r
\r
#define TEXT_IN_SPLITTER_PRIVATE_DATA_FROM_SIMPLE_POINTER_THIS(a) \\r
- CR ((a), \\r
+ CR ((a), \\r
TEXT_IN_SPLITTER_PRIVATE_DATA, \\r
SimplePointer, \\r
TEXT_IN_SPLITTER_PRIVATE_DATA_SIGNATURE \\r
)\r
#define TEXT_IN_EX_SPLITTER_PRIVATE_DATA_FROM_THIS(a) \\r
- CR (a, \\r
- TEXT_IN_SPLITTER_PRIVATE_DATA, \\r
- TextInEx, \\r
- TEXT_IN_SPLITTER_PRIVATE_DATA_SIGNATURE \\r
+ CR (a, \\r
+ TEXT_IN_SPLITTER_PRIVATE_DATA, \\r
+ TextInEx, \\r
+ TEXT_IN_SPLITTER_PRIVATE_DATA_SIGNATURE \\r
)\r
\r
#define TEXT_IN_SPLITTER_PRIVATE_DATA_FROM_ABSOLUTE_POINTER_THIS(a) \\r
- CR (a, \\r
- TEXT_IN_SPLITTER_PRIVATE_DATA, \\r
- AbsolutePointer, \\r
- TEXT_IN_SPLITTER_PRIVATE_DATA_SIGNATURE \\r
+ CR (a, \\r
+ TEXT_IN_SPLITTER_PRIVATE_DATA, \\r
+ AbsolutePointer, \\r
+ TEXT_IN_SPLITTER_PRIVATE_DATA_SIGNATURE \\r
)\r
\r
-//\r
-// Private data for the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL splitter\r
-//\r
+\r
#define TEXT_OUT_SPLITTER_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('T', 'o', 'S', 'p')\r
\r
typedef struct {\r
BOOLEAN TextOutEnabled;\r
} TEXT_OUT_AND_GOP_DATA;\r
\r
+//\r
+// Private data for the Console Out splitter\r
+//\r
typedef struct {\r
UINT64 Signature;\r
EFI_HANDLE VirtualHandle;\r
EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL TextOut;\r
EFI_SIMPLE_TEXT_OUTPUT_MODE TextOutMode;\r
- \r
+\r
EFI_UGA_DRAW_PROTOCOL UgaDraw;\r
UINT32 UgaHorizontalResolution;\r
UINT32 UgaVerticalResolution;\r
UINT32 UgaColorDepth;\r
UINT32 UgaRefreshRate;\r
EFI_UGA_PIXEL *UgaBlt;\r
- \r
+\r
EFI_GRAPHICS_OUTPUT_PROTOCOL GraphicsOutput;\r
EFI_GRAPHICS_OUTPUT_BLT_PIXEL *GraphicsOutputBlt;\r
EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *GraphicsOutputModeBuffer;\r
UINTN CurrentNumberOfGraphicsOutput;\r
UINTN CurrentNumberOfUgaDraw;\r
BOOLEAN HardwareNeedsStarting;\r
- \r
+\r
EFI_CONSOLE_CONTROL_PROTOCOL ConsoleControl;\r
- \r
+\r
UINTN CurrentNumberOfConsoles;\r
TEXT_OUT_AND_GOP_DATA *TextOutList;\r
UINTN TextOutListCount;\r
TEXT_OUT_SPLITTER_QUERY_DATA *TextOutQueryData;\r
UINTN TextOutQueryDataCount;\r
INT32 *TextOutModeMap;\r
- \r
+\r
EFI_CONSOLE_CONTROL_SCREEN_MODE ConsoleOutputMode;\r
- \r
+\r
UINTN DevNullColumns;\r
UINTN DevNullRows;\r
CHAR16 *DevNullScreen;\r
} TEXT_OUT_SPLITTER_PRIVATE_DATA;\r
\r
#define TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS(a) \\r
- CR ((a), \\r
+ CR ((a), \\r
TEXT_OUT_SPLITTER_PRIVATE_DATA, \\r
TextOut, \\r
TEXT_OUT_SPLITTER_PRIVATE_DATA_SIGNATURE \\r
)\r
\r
#define GRAPHICS_OUTPUT_SPLITTER_PRIVATE_DATA_FROM_THIS(a) \\r
- CR ((a), \\r
+ CR ((a), \\r
TEXT_OUT_SPLITTER_PRIVATE_DATA, \\r
GraphicsOutput, \\r
TEXT_OUT_SPLITTER_PRIVATE_DATA_SIGNATURE \\r
)\r
\r
#define UGA_DRAW_SPLITTER_PRIVATE_DATA_FROM_THIS(a) \\r
- CR ((a), \\r
+ CR ((a), \\r
TEXT_OUT_SPLITTER_PRIVATE_DATA, \\r
UgaDraw, \\r
TEXT_OUT_SPLITTER_PRIVATE_DATA_SIGNATURE \\r
)\r
\r
#define CONSOLE_CONTROL_SPLITTER_PRIVATE_DATA_FROM_THIS(a) \\r
- CR ((a), \\r
+ CR ((a), \\r
TEXT_OUT_SPLITTER_PRIVATE_DATA, \\r
ConsoleControl, \\r
TEXT_OUT_SPLITTER_PRIVATE_DATA_SIGNATURE \\r
\r
Installs driver module protocols and. Creates virtual device handles for ConIn,\r
ConOut, and StdErr. Installs Simple Text In protocol, Simple Text In Ex protocol,\r
- Simple Pointer protocol, Absolute Pointer protocol on those virtual handlers. \r
+ Simple Pointer protocol, Absolute Pointer protocol on those virtual handlers.\r
Installs Graphics Output protocol and/or UGA Draw protocol if needed.\r
\r
@param[in] ImageHandle The firmware allocated handle for the EFI image.\r
structure.\r
\r
@retval EFI_OUT_OF_RESOURCES Out of resources.\r
- @retval EFI_SUCCESS Console Input Devcie's private data has been constructed.\r
+ @retval EFI_SUCCESS Text Input Devcie's private data has been constructed.\r
@retval other Failed to construct private data.\r
\r
**/\r
EFI_STATUS\r
ConSplitterTextInConstructor (\r
- TEXT_IN_SPLITTER_PRIVATE_DATA *Private\r
+ TEXT_IN_SPLITTER_PRIVATE_DATA *ConInPrivate\r
);\r
\r
/**\r
Construct console output devices' private data.\r
\r
- @param ConOutPrivate A pointer to the TEXT_IN_SPLITTER_PRIVATE_DATA\r
+ @param ConOutPrivate A pointer to the TEXT_OUT_SPLITTER_PRIVATE_DATA\r
structure.\r
\r
@retval EFI_OUT_OF_RESOURCES Out of resources.\r
**/\r
EFI_STATUS\r
ConSplitterTextOutConstructor (\r
- TEXT_OUT_SPLITTER_PRIVATE_DATA *Private\r
+ TEXT_OUT_SPLITTER_PRIVATE_DATA *ConOutPrivate\r
);\r
\r
-//\r
-// Driver Binding Functions\r
-//\r
\r
/**\r
- Test to see if Console In Device could be supported on the ControllerHandle. \r
+ Test to see if Console In Device could be supported on the Controller.\r
\r
- @param This Protocol instance pointer.\r
+ @param This Driver Binding protocol instance pointer.\r
@param ControllerHandle Handle of device to test.\r
@param RemainingDevicePath Optional parameter use to pick a specific child\r
device to start.\r
);\r
\r
/**\r
- Test to see if Simple Pointer protocol could be supported on the ControllerHandle. \r
+ Test to see if Simple Pointer protocol could be supported on the Controller.\r
\r
- @param This Protocol instance pointer.\r
+ @param This Driver Binding protocol instance pointer.\r
@param ControllerHandle Handle of device to test.\r
@param RemainingDevicePath Optional parameter use to pick a specific child\r
device to start.\r
);\r
\r
/**\r
- Test to see if Console Out Device could be supported on the ControllerHandle. \r
+ Test to see if Console Out Device could be supported on the Controller.\r
\r
- @param This Protocol instance pointer.\r
+ @param This Driver Binding protocol instance pointer.\r
@param ControllerHandle Handle of device to test.\r
@param RemainingDevicePath Optional parameter use to pick a specific child\r
device to start.\r
);\r
\r
/**\r
- Test to see if Standard Error Device could be supported on the ControllerHandle. \r
+ Test to see if Standard Error Device could be supported on the Controller.\r
\r
- @param This Protocol instance pointer.\r
+ @param This Driver Binding protocol instance pointer.\r
@param ControllerHandle Handle of device to test.\r
@param RemainingDevicePath Optional parameter use to pick a specific child\r
device to start.\r
);\r
\r
/**\r
- Start Console In Consplitter on device handle. \r
- \r
- @param This Protocol instance pointer.\r
+ Start Console In Consplitter on device handle.\r
+\r
+ @param This Driver Binding protocol instance pointer.\r
@param ControllerHandle Handle of device to bind driver to.\r
@param RemainingDevicePath Optional parameter use to pick a specific child\r
device to start.\r
);\r
\r
/**\r
- Start Simple Pointer Consplitter on device handle. \r
- \r
- @param This Protocol instance pointer.\r
+ Start Simple Pointer Consplitter on device handle.\r
+\r
+ @param This Driver Binding protocol instance pointer.\r
@param ControllerHandle Handle of device to bind driver to.\r
@param RemainingDevicePath Optional parameter use to pick a specific child\r
device to start.\r
);\r
\r
/**\r
- Start Console Out Consplitter on device handle. \r
- \r
- @param This Protocol instance pointer.\r
+ Start Console Out Consplitter on device handle.\r
+\r
+ @param This Driver Binding protocol instance pointer.\r
@param ControllerHandle Handle of device to bind driver to.\r
@param RemainingDevicePath Optional parameter use to pick a specific child\r
device to start.\r
);\r
\r
/**\r
- Start Standard Error Consplitter on device handle. \r
- \r
- @param This Protocol instance pointer.\r
+ Start Standard Error Consplitter on device handle.\r
+\r
+ @param This Driver Binding protocol instance pointer.\r
@param ControllerHandle Handle of device to bind driver to.\r
@param RemainingDevicePath Optional parameter use to pick a specific child\r
device to start.\r
/**\r
Stop Console In ConSplitter on ControllerHandle by closing Console In Devcice GUID.\r
\r
- @param This Protocol instance pointer.\r
+ @param This Driver Binding protocol instance pointer.\r
@param ControllerHandle Handle of device to stop driver on\r
@param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
children is zero stop the entire bus driver.\r
Stop Simple Pointer protocol ConSplitter on ControllerHandle by closing\r
Simple Pointer protocol.\r
\r
- @param This Protocol instance pointer.\r
+ @param This Driver Binding protocol instance pointer.\r
@param ControllerHandle Handle of device to stop driver on\r
@param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
children is zero stop the entire bus driver.\r
);\r
\r
/**\r
- Stop Console Out ConSplitter on ControllerHandle by closing Console Out Devcice GUID.\r
+ Stop Console Out ConSplitter on device handle by closing Console Out Devcice GUID.\r
\r
- @param This Protocol instance pointer.\r
+ @param This Driver Binding protocol instance pointer.\r
@param ControllerHandle Handle of device to stop driver on\r
@param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
children is zero stop the entire bus driver.\r
/**\r
Stop Standard Error ConSplitter on ControllerHandle by closing Standard Error GUID.\r
\r
- @param This Protocol instance pointer.\r
+ @param This Driver Binding protocol instance pointer.\r
@param ControllerHandle Handle of device to stop driver on\r
@param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
children is zero stop the entire bus driver.\r
\r
\r
/**\r
- Test to see if Absolute Pointer protocol could be supported on the ControllerHandle. \r
+ Test to see if Absolute Pointer protocol could be supported on the Controller.\r
\r
- @param This Protocol instance pointer.\r
+ @param This Driver Binding protocol instance pointer.\r
@param ControllerHandle Handle of device to test.\r
@param RemainingDevicePath Optional parameter use to pick a specific child\r
device to start.\r
);\r
\r
/**\r
- Start Absolute Pointer Consplitter on device handle. \r
- \r
- @param This Protocol instance pointer.\r
+ Start Absolute Pointer Consplitter on device handle.\r
+\r
+ @param This Driver Binding protocol instance pointer.\r
@param ControllerHandle Handle of device to bind driver to.\r
@param RemainingDevicePath Optional parameter use to pick a specific child\r
device to start.\r
Stop Absolute Pointer protocol ConSplitter on ControllerHandle by closing\r
Absolute Pointer protocol.\r
\r
- @param This Protocol instance pointer.\r
+ @param This Driver Binding protocol instance pointer.\r
@param ControllerHandle Handle of device to stop driver on\r
@param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
children is zero stop the entire bus driver.\r
);\r
\r
/**\r
- Remove Absolute Pointer Device in Consplitter Absolute Pointer list.\r
+ Remove Absolute Pointer Device from Consplitter Absolute Pointer list.\r
\r
@param Private Text In Splitter pointer.\r
@param AbsolutePointer Absolute Pointer protocol pointer.\r
@param Event The Event assoicated with callback.\r
@param Context Context registered when Event was created.\r
\r
- @return None\r
-\r
**/\r
VOID\r
EFIAPI\r
**/\r
EFI_STATUS\r
ConSplitterTextInAddDevice (\r
- IN TEXT_IN_SPLITTER_PRIVATE_DATA *Private,\r
- IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *TextIn\r
+ IN TEXT_IN_SPLITTER_PRIVATE_DATA *Private,\r
+ IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *TextIn\r
);\r
\r
/**\r
- Remove Simple Text Device in Consplitter Absolute Pointer list.\r
+ Remove Text Input Device from Consplitter Text Input list.\r
\r
@param Private Text In Splitter pointer.\r
@param TextIn Simple Text protocol pointer.\r
**/\r
EFI_STATUS\r
ConSplitterTextInDeleteDevice (\r
- IN TEXT_IN_SPLITTER_PRIVATE_DATA *Private,\r
- IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *TextIn\r
+ IN TEXT_IN_SPLITTER_PRIVATE_DATA *Private,\r
+ IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *TextIn\r
);\r
\r
//\r
);\r
\r
/**\r
- Remove Simple Pointer Device in Consplitter Absolute Pointer list.\r
+ Remove Simple Pointer Device from Consplitter Simple Pointer list.\r
\r
@param Private Text In Splitter pointer.\r
@param SimplePointer Simple Pointer protocol pointer.\r
EFI_STATUS\r
EFIAPI\r
ConSplitterTextInReset (\r
- IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
- IN BOOLEAN ExtendedVerification\r
+ IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
+ IN BOOLEAN ExtendedVerification\r
);\r
\r
/**\r
EFI_STATUS\r
EFIAPI\r
ConSplitterTextInReadKeyStroke (\r
- IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
- OUT EFI_INPUT_KEY *Key\r
+ IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
+ OUT EFI_INPUT_KEY *Key\r
);\r
\r
/**\r
Add Text Input Ex Device in Consplitter Text Input Ex list.\r
\r
@param Private Text In Splitter pointer.\r
- @param TextInEx Simple Text Ex Input protocol pointer.\r
+ @param TextInEx Simple Text Input Ex Input protocol pointer.\r
\r
@retval EFI_SUCCESS Text Input Ex Device added successfully.\r
@retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.\r
);\r
\r
/**\r
- Remove Simple Text Ex Device in Consplitter Absolute Pointer list.\r
+ Remove Text Ex Device from Consplitter Text Input Ex list.\r
\r
@param Private Text In Splitter pointer.\r
@param TextInEx Simple Text Ex protocol pointer.\r
\r
- @retval EFI_SUCCESS Simple Text Ex Device removed successfully.\r
- @retval EFI_NOT_FOUND No Simple Text Ex Device found.\r
+ @retval EFI_SUCCESS Simple Text Input Ex Device removed successfully.\r
+ @retval EFI_NOT_FOUND No Simple Text Input Ex Device found.\r
\r
**/\r
EFI_STATUS\r
// Simple Text Input Ex protocol function prototypes\r
//\r
\r
-\r
/**\r
Reset the input device and optionaly run diagnostics\r
\r
successfully.\r
@retval EFI_OUT_OF_RESOURCES Unable to allocate resources for necesssary data\r
structures.\r
- @retval EFI_INVALID_PARAMETER KeyData or NotifyHandle is NULL.\r
+ @retval EFI_INVALID_PARAMETER KeyData or KeyNotificationFunction or NotifyHandle is NULL.\r
\r
**/\r
EFI_STATUS\r
);\r
\r
/**\r
- This event agregates all the events of the ConIn devices in the spliter.\r
+ This event aggregates all the events of the ConIn devices in the spliter.\r
+\r
If the ConIn is password locked then return.\r
If any events of physical ConIn devices are signaled, signal the ConIn\r
spliter event. This will cause the calling code to call\r
@param Event The Event assoicated with callback.\r
@param Context Context registered when Event was created.\r
\r
- @return None\r
-\r
**/\r
VOID\r
EFIAPI\r
IN EFI_EVENT Event,\r
IN VOID *Context\r
);\r
+\r
/**\r
Return TRUE if StdIn is locked. The ConIn device on the virtual handle is\r
the only device locked.\r
\r
- NONE\r
-\r
@retval TRUE StdIn locked\r
@retval FALSE StdIn working normally\r
\r
ConSpliterConssoleControlStdInLocked (\r
VOID\r
);\r
+\r
/**\r
- This timer event will fire when StdIn is locked. It will check the key\r
- sequence on StdIn to see if it matches the password. Any error in the\r
- password will cause the check to reset. As long a mConIn.PasswordEnabled is\r
- TRUE the StdIn splitter will not report any input.\r
+ Record and check key sequence on StdIn.\r
+\r
+ This timer event will fire when StdIn is locked. It will record the key sequence\r
+ on StdIn and also check to see if it matches the password. Any error in the\r
+ password will cause the check to reset. As long as a mConIn.PasswordEnabled is\r
+ TRUE, the StdIn splitter will not report any input.\r
\r
@param Event The Event this notify function registered to.\r
@param Context Pointer to the context data registerd to the\r
Event.\r
-\r
- @return None\r
-\r
**/\r
VOID\r
EFIAPI\r
@param Event The Event assoicated with callback.\r
@param Context Context registered when Event was created.\r
\r
- @return None\r
-\r
**/\r
VOID\r
EFIAPI\r
bytes. Copy the current data in Buffer to the new version of Buffer\r
and free the old version of buffer.\r
\r
- @param SizeOfCount Size of element in array\r
- @param Count Current number of elements in array\r
+ @param SizeOfCount Size of element in array.\r
+ @param Count Current number of elements in array.\r
@param Buffer Bigger version of passed in Buffer with all the\r
- data\r
+ data.\r
\r
- @retval EFI_SUCCESS Buffer size has grown\r
+ @retval EFI_SUCCESS Buffer size has grown.\r
@retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.\r
\r
**/\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 GopUgaExists TRUE if Console Spliter has found a GOP or UGA device\r
@param StdInLocked TRUE if StdIn device is keyboard locked\r
\r
@retval EFI_SUCCESS Mode information returned.\r
ConSpliterConsoleControlGetMode (\r
IN EFI_CONSOLE_CONTROL_PROTOCOL *This,\r
OUT EFI_CONSOLE_CONTROL_SCREEN_MODE *Mode,\r
- OUT BOOLEAN *GopExists,\r
+ OUT BOOLEAN *GopUgaExists,\r
OUT BOOLEAN *StdInLocked\r
);\r
\r
Set the current mode to either text or graphics. Graphics is\r
for Quiet Boot.\r
\r
- @param This Protocol instance pointer.\r
- @param Mode Mode to set the\r
+ @param This Console Control Protocol instance pointer.\r
+ @param Mode Mode to set.\r
\r
@retval EFI_SUCCESS Mode information returned.\r
@retval EFI_INVALID_PARAMETER Invalid parameter.\r
);\r
\r
/**\r
- Return the current video mode information.\r
+ Returns information for an available graphics mode that the graphics device\r
+ and the set of active video output devices supports.\r
\r
- @param This Protocol instance pointer.\r
- @param ModeNumber The mode number to return information on.\r
- @param SizeOfInfo A pointer to the size, in bytes, of the Info\r
- buffer.\r
- @param Info Caller allocated buffer that returns information\r
- about ModeNumber.\r
+ @param This The EFI_GRAPHICS_OUTPUT_PROTOCOL instance.\r
+ @param ModeNumber The mode number to return information on.\r
+ @param SizeOfInfo A pointer to the size, in bytes, of the Info buffer.\r
+ @param Info A pointer to callee allocated buffer that returns information about ModeNumber.\r
\r
- @retval EFI_SUCCESS Mode information returned.\r
- @retval EFI_BUFFER_TOO_SMALL The Info buffer was too small.\r
- @retval EFI_DEVICE_ERROR A hardware error occurred trying to retrieve the\r
- video mode.\r
- @retval EFI_NOT_STARTED Video display is not initialized. Call SetMode ()\r
- @retval EFI_INVALID_PARAMETER One of the input args was NULL.\r
+ @retval EFI_SUCCESS Mode information returned.\r
+ @retval EFI_BUFFER_TOO_SMALL The Info buffer was too small.\r
+ @retval EFI_DEVICE_ERROR A hardware error occurred trying to retrieve the video mode.\r
+ @retval EFI_NOT_STARTED Video display is not initialized. Call SetMode ()\r
+ @retval EFI_INVALID_PARAMETER One of the input args was NULL.\r
+ @retval EFI_OUT_OF_RESOURCES No resource available.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
ConSpliterGraphicsOutputQueryMode (\r
- IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,\r
- IN UINT32 ModeNumber,\r
- OUT UINTN *SizeOfInfo,\r
+ IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,\r
+ IN UINT32 ModeNumber,\r
+ OUT UINTN *SizeOfInfo,\r
OUT EFI_GRAPHICS_OUTPUT_MODE_INFORMATION **Info\r
);\r
\r
/**\r
- Graphics output protocol interface to set video mode.\r
+ Set the video device into the specified mode and clears the visible portions of\r
+ the output display to black.\r
\r
- @param This Protocol instance pointer.\r
- @param ModeNumber The mode number to be set.\r
+ @param This The EFI_GRAPHICS_OUTPUT_PROTOCOL instance.\r
+ @param ModeNumber Abstraction that defines the current video mode.\r
\r
- @retval EFI_SUCCESS Graphics mode was changed.\r
- @retval EFI_DEVICE_ERROR The device had an error and could not complete\r
- the request.\r
- @retval EFI_UNSUPPORTED ModeNumber is not supported by this device.\r
+ @retval EFI_SUCCESS The graphics mode specified by ModeNumber was selected.\r
+ @retval EFI_DEVICE_ERROR The device had an error and could not complete the request.\r
+ @retval EFI_UNSUPPORTED ModeNumber is not supported by this device.\r
+ @retval EFI_OUT_OF_RESOURCES No resource available.\r
\r
**/\r
EFI_STATUS\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 Height Hight of rectangle in BltBuffer in pixels.\r
@param Delta OPTIONAL.\r
\r
@retval EFI_SUCCESS The Blt operation completed.\r
);\r
\r
/**\r
- Write data from the buffer to video display based on Graphics Output setting. \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
@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
**/\r
EFI_STATUS\r
/**\r
Return the current video mode information.\r
\r
- @param This Protocol instance pointer.\r
- @param HorizontalResolution Current video horizontal resolution in pixels\r
- @param VerticalResolution Current video vertical resolution in pixels\r
- @param ColorDepth Current video color depth in bits per pixel\r
- @param RefreshRate Current video refresh rate in Hz.\r
+ @param This The EFI_UGA_DRAW_PROTOCOL instance.\r
+ @param HorizontalResolution The size of video screen in pixels in the X dimension.\r
+ @param VerticalResolution The size of video screen in pixels in the Y dimension.\r
+ @param ColorDepth Number of bits per pixel, currently defined to be 32.\r
+ @param RefreshRate The refresh rate of the monitor in Hertz.\r
\r
- @retval EFI_SUCCESS Mode information returned.\r
- @retval EFI_NOT_STARTED Video display is not initialized. Call SetMode ()\r
- @retval EFI_INVALID_PARAMETER One of the input args was NULL.\r
+ @retval EFI_SUCCESS Mode information returned.\r
+ @retval EFI_NOT_STARTED Video display is not initialized. Call SetMode ()\r
+ @retval EFI_INVALID_PARAMETER One of the input args was NULL.\r
\r
**/\r
EFI_STATUS\r
);\r
\r
/**\r
- Return the current video mode information.\r
+ Set the current video mode information.\r
\r
- @param This Protocol instance pointer.\r
- @param HorizontalResolution Current video horizontal resolution in pixels\r
- @param VerticalResolution Current video vertical resolution in pixels\r
- @param ColorDepth Current video color depth in bits per pixel\r
- @param RefreshRate Current video refresh rate in Hz.\r
+ @param This The EFI_UGA_DRAW_PROTOCOL instance.\r
+ @param HorizontalResolution The size of video screen in pixels in the X dimension.\r
+ @param VerticalResolution The size of video screen in pixels in the Y dimension.\r
+ @param ColorDepth Number of bits per pixel, currently defined to be 32.\r
+ @param RefreshRate The refresh rate of the monitor in Hertz.\r
\r
- @retval EFI_SUCCESS Mode information returned.\r
- @retval EFI_NOT_STARTED Video display is not initialized. Call SetMode ()\r
- @retval EFI_OUT_OF_RESOURCES Out of resources.\r
+ @retval EFI_SUCCESS Mode information returned.\r
+ @retval EFI_NOT_STARTED Video display is not initialized. Call SetMode ()\r
+ @retval EFI_OUT_OF_RESOURCES Out of resources.\r
\r
**/\r
EFI_STATUS\r
);\r
\r
/**\r
- The following table defines actions for BltOperations.\r
+ Blt a rectangle of pixels on the graphics screen.\r
\r
- EfiUgaVideoFill - 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
- EfiUgaVideoToBltBuffer - 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
- EfiUgaBltBufferToVideo - 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
- EfiUgaVideoToVideo - 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 This 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_UGA_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
+ The following table defines actions for BltOperations.\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
+ EfiUgaVideoFill:\r
+ 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
+ EfiUgaVideoToBltBuffer:\r
+ 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
+ EfiUgaBltBufferToVideo:\r
+ 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
+ EfiUgaVideoToVideo:\r
+ 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 This Protocol instance pointer.\r
+ @param BltBuffer Buffer containing data to blit into video buffer. This\r
+ buffer has a size of Width*Height*sizeof(EFI_UGA_PIXEL)\r
+ @param BltOperation Operation to perform on BlitBuffer and video 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 buffer.\r
\r
**/\r
EFI_STATUS\r
);\r
\r
/**\r
- Write data from the buffer to video display based on UGA Draw setting. \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
@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
DevNullUgaSync (\r
/**\r
Sets the output device(s) to a specified mode.\r
\r
- @param Private Private data structure pointer.\r
+ @param Private Text Out Splitter pointer.\r
@param ModeNumber The mode number to set.\r
\r
@retval EFI_SUCCESS The requested text mode was set.\r
Clears the output device(s) display to the currently selected background\r
color.\r
\r
- @param Private Protocol instance pointer.\r
+ @param Private Text Out Splitter pointer.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_DEVICE_ERROR The device had an error and could not complete\r
);\r
\r
/**\r
- Sets the current coordinates of the cursor position.\r
+ Sets the current coordinates of the cursor position on NULL device.\r
\r
- @param Private Protocol instance pointer.\r
- @param Column \r
- @param Row the 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
+ @param Private Text Out Splitter pointer.\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 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
- the request.\r
- @retval EFI_UNSUPPORTED The output device is not in a valid text mode, or\r
- the cursor position is invalid for the current\r
- mode.\r
+ @retval EFI_SUCCESS Always returned.\r
\r
**/\r
EFI_STATUS\r
);\r
\r
/**\r
- Implements SIMPLE_TEXT_OUTPUT.EnableCursor().\r
- In this driver, the cursor cannot be hidden.\r
+ Set cursor visibility property on NULL device.\r
\r
- @param Private Indicates the calling context.\r
+ @param Private Text Out Splitter pointer.\r
@param Visible If TRUE, the cursor is set to be visible, If\r
FALSE, the cursor is set to be invisible.\r
\r
- @retval EFI_SUCCESS The request is valid.\r
+ @retval EFI_SUCCESS Always returned.\r
\r
**/\r
EFI_STATUS\r
Take the DevNull TextOut device and update the Simple Text Out on every\r
UGA device.\r
\r
- @param Private Indicates the calling context.\r
+ @param Private Text Out Splitter pointer.\r
\r
@retval EFI_SUCCESS The request is valid.\r
@retval other Return status of TextOut->OutputString ()\r
projects / mirror_edk2.git / blobdiff