2 Console Splitter Driver. Any Handle that attatched console I/O protocols
3 (Console In device, Console Out device, Console Error device, Simple Pointer
4 protocol, Absolute Pointer protocol) can be bound by this driver.
6 So far it works like any other driver by opening a SimpleTextIn and/or
7 SimpleTextOut protocol with EFI_OPEN_PROTOCOL_BY_DRIVER attributes. The big
8 difference is this driver does not layer a protocol on the passed in
9 handle, or construct a child handle like a standard device or bus driver.
10 This driver produces three virtual handles as children, one for console input
11 splitter, one for console output splitter and one for error output splitter.
12 These 3 virtual handles would be installed on gST.
14 Each virtual handle, that supports the Console I/O protocol, will be produced
15 in the driver entry point. The virtual handle are added on driver entry and
16 never removed. Such design ensures sytem function well during none console
19 Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>
20 This program and the accompanying materials
21 are licensed and made available under the terms and conditions of the BSD License
22 which accompanies this distribution. The full text of the license may be found at
23 http://opensource.org/licenses/bsd-license.php
25 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
26 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
30 #include "ConSplitter.h"
33 // Identify if ConIn is connected in PcdConInConnectOnDemand enabled mode.
34 // default not connect
36 BOOLEAN mConInIsConnect
= FALSE
;
39 // Text In Splitter Private Data template
41 GLOBAL_REMOVE_IF_UNREFERENCED TEXT_IN_SPLITTER_PRIVATE_DATA mConIn
= {
42 TEXT_IN_SPLITTER_PRIVATE_DATA_SIGNATURE
,
46 ConSplitterTextInReset
,
47 ConSplitterTextInReadKeyStroke
,
51 (EFI_SIMPLE_TEXT_INPUT_PROTOCOL
**) NULL
,
55 ConSplitterTextInResetEx
,
56 ConSplitterTextInReadKeyStrokeEx
,
58 ConSplitterTextInSetState
,
59 ConSplitterTextInRegisterKeyNotify
,
60 ConSplitterTextInUnregisterKeyNotify
63 (EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
**) NULL
,
71 ConSplitterSimplePointerReset
,
72 ConSplitterSimplePointerGetState
,
74 (EFI_SIMPLE_POINTER_MODE
*) NULL
84 (EFI_SIMPLE_POINTER_PROTOCOL
**) NULL
,
88 ConSplitterAbsolutePointerReset
,
89 ConSplitterAbsolutePointerGetState
,
91 (EFI_ABSOLUTE_POINTER_MODE
*) NULL
97 0x10000, // AbsoluteMaxX
98 0x10000, // AbsoluteMaxY
99 0x10000, // AbsoluteMaxZ
103 (EFI_ABSOLUTE_POINTER_PROTOCOL
**) NULL
,
113 // Uga Draw Protocol Private Data template
115 GLOBAL_REMOVE_IF_UNREFERENCED EFI_UGA_DRAW_PROTOCOL mUgaDrawProtocolTemplate
= {
116 ConSplitterUgaDrawGetMode
,
117 ConSplitterUgaDrawSetMode
,
118 ConSplitterUgaDrawBlt
122 // Graphics Output Protocol Private Data template
124 GLOBAL_REMOVE_IF_UNREFERENCED EFI_GRAPHICS_OUTPUT_PROTOCOL mGraphicsOutputProtocolTemplate
= {
125 ConSplitterGraphicsOutputQueryMode
,
126 ConSplitterGraphicsOutputSetMode
,
127 ConSplitterGraphicsOutputBlt
,
133 // Text Out Splitter Private Data template
135 GLOBAL_REMOVE_IF_UNREFERENCED TEXT_OUT_SPLITTER_PRIVATE_DATA mConOut
= {
136 TEXT_OUT_SPLITTER_PRIVATE_DATA_SIGNATURE
,
139 ConSplitterTextOutReset
,
140 ConSplitterTextOutOutputString
,
141 ConSplitterTextOutTestString
,
142 ConSplitterTextOutQueryMode
,
143 ConSplitterTextOutSetMode
,
144 ConSplitterTextOutSetAttribute
,
145 ConSplitterTextOutClearScreen
,
146 ConSplitterTextOutSetCursorPosition
,
147 ConSplitterTextOutEnableCursor
,
148 (EFI_SIMPLE_TEXT_OUTPUT_MODE
*) NULL
175 (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*) NULL
,
180 (TEXT_OUT_AND_GOP_DATA
*) NULL
,
182 (TEXT_OUT_SPLITTER_QUERY_DATA
*) NULL
,
188 // Standard Error Text Out Splitter Data Template
190 GLOBAL_REMOVE_IF_UNREFERENCED TEXT_OUT_SPLITTER_PRIVATE_DATA mStdErr
= {
191 TEXT_OUT_SPLITTER_PRIVATE_DATA_SIGNATURE
,
194 ConSplitterTextOutReset
,
195 ConSplitterTextOutOutputString
,
196 ConSplitterTextOutTestString
,
197 ConSplitterTextOutQueryMode
,
198 ConSplitterTextOutSetMode
,
199 ConSplitterTextOutSetAttribute
,
200 ConSplitterTextOutClearScreen
,
201 ConSplitterTextOutSetCursorPosition
,
202 ConSplitterTextOutEnableCursor
,
203 (EFI_SIMPLE_TEXT_OUTPUT_MODE
*) NULL
230 (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*) NULL
,
235 (TEXT_OUT_AND_GOP_DATA
*) NULL
,
237 (TEXT_OUT_SPLITTER_QUERY_DATA
*) NULL
,
243 // Driver binding instance for Console Input Device
245 EFI_DRIVER_BINDING_PROTOCOL gConSplitterConInDriverBinding
= {
246 ConSplitterConInDriverBindingSupported
,
247 ConSplitterConInDriverBindingStart
,
248 ConSplitterConInDriverBindingStop
,
255 // Driver binding instance for Console Out device
257 EFI_DRIVER_BINDING_PROTOCOL gConSplitterConOutDriverBinding
= {
258 ConSplitterConOutDriverBindingSupported
,
259 ConSplitterConOutDriverBindingStart
,
260 ConSplitterConOutDriverBindingStop
,
267 // Driver binding instance for Standard Error device
269 EFI_DRIVER_BINDING_PROTOCOL gConSplitterStdErrDriverBinding
= {
270 ConSplitterStdErrDriverBindingSupported
,
271 ConSplitterStdErrDriverBindingStart
,
272 ConSplitterStdErrDriverBindingStop
,
279 // Driver binding instance for Simple Pointer protocol
281 EFI_DRIVER_BINDING_PROTOCOL gConSplitterSimplePointerDriverBinding
= {
282 ConSplitterSimplePointerDriverBindingSupported
,
283 ConSplitterSimplePointerDriverBindingStart
,
284 ConSplitterSimplePointerDriverBindingStop
,
291 // Driver binding instance for Absolute Pointer protocol
293 EFI_DRIVER_BINDING_PROTOCOL gConSplitterAbsolutePointerDriverBinding
= {
294 ConSplitterAbsolutePointerDriverBindingSupported
,
295 ConSplitterAbsolutePointerDriverBindingStart
,
296 ConSplitterAbsolutePointerDriverBindingStop
,
303 The Entry Point for module ConSplitter. The user code starts with this function.
305 Installs driver module protocols and. Creates virtual device handles for ConIn,
306 ConOut, and StdErr. Installs Simple Text In protocol, Simple Text In Ex protocol,
307 Simple Pointer protocol, Absolute Pointer protocol on those virtual handlers.
308 Installs Graphics Output protocol and/or UGA Draw protocol if needed.
310 @param[in] ImageHandle The firmware allocated handle for the EFI image.
311 @param[in] SystemTable A pointer to the EFI System Table.
313 @retval EFI_SUCCESS The entry point is executed successfully.
314 @retval other Some error occurs when executing this entry point.
319 ConSplitterDriverEntry(
320 IN EFI_HANDLE ImageHandle
,
321 IN EFI_SYSTEM_TABLE
*SystemTable
327 // Install driver model protocol(s).
329 Status
= EfiLibInstallDriverBindingComponentName2 (
332 &gConSplitterConInDriverBinding
,
334 &gConSplitterConInComponentName
,
335 &gConSplitterConInComponentName2
337 ASSERT_EFI_ERROR (Status
);
339 Status
= EfiLibInstallDriverBindingComponentName2 (
342 &gConSplitterSimplePointerDriverBinding
,
344 &gConSplitterSimplePointerComponentName
,
345 &gConSplitterSimplePointerComponentName2
347 ASSERT_EFI_ERROR (Status
);
349 Status
= EfiLibInstallDriverBindingComponentName2 (
352 &gConSplitterAbsolutePointerDriverBinding
,
354 &gConSplitterAbsolutePointerComponentName
,
355 &gConSplitterAbsolutePointerComponentName2
357 ASSERT_EFI_ERROR (Status
);
359 Status
= EfiLibInstallDriverBindingComponentName2 (
362 &gConSplitterConOutDriverBinding
,
364 &gConSplitterConOutComponentName
,
365 &gConSplitterConOutComponentName2
367 ASSERT_EFI_ERROR (Status
);
369 Status
= EfiLibInstallDriverBindingComponentName2 (
372 &gConSplitterStdErrDriverBinding
,
374 &gConSplitterStdErrComponentName
,
375 &gConSplitterStdErrComponentName2
377 ASSERT_EFI_ERROR (Status
);
380 // Either Graphics Output protocol or UGA Draw protocol must be supported.
382 ASSERT (FeaturePcdGet (PcdConOutGopSupport
) ||
383 FeaturePcdGet (PcdConOutUgaSupport
));
386 // The driver creates virtual handles for ConIn, ConOut, StdErr.
387 // The virtual handles will always exist even if no console exist in the
388 // system. This is need to support hotplug devices like USB.
391 // Create virtual device handle for ConIn Splitter
393 Status
= ConSplitterTextInConstructor (&mConIn
);
394 if (!EFI_ERROR (Status
)) {
395 Status
= gBS
->InstallMultipleProtocolInterfaces (
396 &mConIn
.VirtualHandle
,
397 &gEfiSimpleTextInProtocolGuid
,
399 &gEfiSimpleTextInputExProtocolGuid
,
401 &gEfiSimplePointerProtocolGuid
,
402 &mConIn
.SimplePointer
,
403 &gEfiAbsolutePointerProtocolGuid
,
404 &mConIn
.AbsolutePointer
,
407 if (!EFI_ERROR (Status
)) {
409 // Update the EFI System Table with new virtual console
410 // and update the pointer to Simple Text Input protocol.
412 gST
->ConsoleInHandle
= mConIn
.VirtualHandle
;
413 gST
->ConIn
= &mConIn
.TextIn
;
417 // Create virtual device handle for ConOut Splitter
419 Status
= ConSplitterTextOutConstructor (&mConOut
);
420 if (!EFI_ERROR (Status
)) {
421 Status
= gBS
->InstallMultipleProtocolInterfaces (
422 &mConOut
.VirtualHandle
,
423 &gEfiSimpleTextOutProtocolGuid
,
427 if (!EFI_ERROR (Status
)) {
429 // Update the EFI System Table with new virtual console
430 // and Update the pointer to Text Output protocol.
432 gST
->ConsoleOutHandle
= mConOut
.VirtualHandle
;
433 gST
->ConOut
= &mConOut
.TextOut
;
439 // Create virtual device handle for StdErr Splitter
441 Status
= ConSplitterTextOutConstructor (&mStdErr
);
442 if (!EFI_ERROR (Status
)) {
443 Status
= gBS
->InstallMultipleProtocolInterfaces (
444 &mStdErr
.VirtualHandle
,
445 &gEfiSimpleTextOutProtocolGuid
,
449 if (!EFI_ERROR (Status
)) {
451 // Update the EFI System Table with new virtual console
452 // and update the pointer to Text Output protocol.
454 gST
->StandardErrorHandle
= mStdErr
.VirtualHandle
;
455 gST
->StdErr
= &mStdErr
.TextOut
;
460 // Update the CRC32 in the EFI System Table header
463 gBS
->CalculateCrc32 (
474 Construct console input devices' private data.
476 @param ConInPrivate A pointer to the TEXT_IN_SPLITTER_PRIVATE_DATA
479 @retval EFI_OUT_OF_RESOURCES Out of resources.
480 @retval EFI_SUCCESS Text Input Devcie's private data has been constructed.
481 @retval other Failed to construct private data.
485 ConSplitterTextInConstructor (
486 TEXT_IN_SPLITTER_PRIVATE_DATA
*ConInPrivate
492 // Allocate buffer for Simple Text Input device
494 Status
= ConSplitterGrowBuffer (
495 sizeof (EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*),
496 &ConInPrivate
->TextInListCount
,
497 (VOID
**) &ConInPrivate
->TextInList
499 if (EFI_ERROR (Status
)) {
500 return EFI_OUT_OF_RESOURCES
;
504 // Create Event to wait for a key
506 Status
= gBS
->CreateEvent (
509 ConSplitterTextInWaitForKey
,
511 &ConInPrivate
->TextIn
.WaitForKey
513 ASSERT_EFI_ERROR (Status
);
516 // Allocate buffer for Simple Text Input Ex device
518 Status
= ConSplitterGrowBuffer (
519 sizeof (EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*),
520 &ConInPrivate
->TextInExListCount
,
521 (VOID
**) &ConInPrivate
->TextInExList
523 if (EFI_ERROR (Status
)) {
524 return EFI_OUT_OF_RESOURCES
;
527 // Create Event to wait for a key Ex
529 Status
= gBS
->CreateEvent (
532 ConSplitterTextInWaitForKey
,
534 &ConInPrivate
->TextInEx
.WaitForKeyEx
536 ASSERT_EFI_ERROR (Status
);
538 InitializeListHead (&ConInPrivate
->NotifyList
);
540 ConInPrivate
->AbsolutePointer
.Mode
= &ConInPrivate
->AbsolutePointerMode
;
542 // Allocate buffer for Absolute Pointer device
544 Status
= ConSplitterGrowBuffer (
545 sizeof (EFI_ABSOLUTE_POINTER_PROTOCOL
*),
546 &ConInPrivate
->AbsolutePointerListCount
,
547 (VOID
**) &ConInPrivate
->AbsolutePointerList
549 if (EFI_ERROR (Status
)) {
550 return EFI_OUT_OF_RESOURCES
;
553 // Create Event to wait for device input for Absolute pointer device
555 Status
= gBS
->CreateEvent (
558 ConSplitterAbsolutePointerWaitForInput
,
560 &ConInPrivate
->AbsolutePointer
.WaitForInput
562 ASSERT_EFI_ERROR (Status
);
564 ConInPrivate
->SimplePointer
.Mode
= &ConInPrivate
->SimplePointerMode
;
566 // Allocate buffer for Simple Pointer device
568 Status
= ConSplitterGrowBuffer (
569 sizeof (EFI_SIMPLE_POINTER_PROTOCOL
*),
570 &ConInPrivate
->PointerListCount
,
571 (VOID
**) &ConInPrivate
->PointerList
573 if (EFI_ERROR (Status
)) {
574 return EFI_OUT_OF_RESOURCES
;
577 // Create Event to wait for device input for Simple pointer device
579 Status
= gBS
->CreateEvent (
582 ConSplitterSimplePointerWaitForInput
,
584 &ConInPrivate
->SimplePointer
.WaitForInput
586 ASSERT_EFI_ERROR (Status
);
588 // Create Event to signal ConIn connection request
590 Status
= gBS
->CreateEventEx (
593 ConSplitterEmptyCallbackFunction
,
595 &gConnectConInEventGuid
,
596 &ConInPrivate
->ConnectConInEvent
603 Construct console output devices' private data.
605 @param ConOutPrivate A pointer to the TEXT_OUT_SPLITTER_PRIVATE_DATA
608 @retval EFI_OUT_OF_RESOURCES Out of resources.
609 @retval EFI_SUCCESS Text Input Devcie's private data has been constructed.
613 ConSplitterTextOutConstructor (
614 TEXT_OUT_SPLITTER_PRIVATE_DATA
*ConOutPrivate
618 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*Info
;
621 // Copy protocols template
623 if (FeaturePcdGet (PcdConOutUgaSupport
)) {
624 CopyMem (&ConOutPrivate
->UgaDraw
, &mUgaDrawProtocolTemplate
, sizeof (EFI_UGA_DRAW_PROTOCOL
));
626 if (FeaturePcdGet (PcdConOutGopSupport
)) {
627 CopyMem (&ConOutPrivate
->GraphicsOutput
, &mGraphicsOutputProtocolTemplate
, sizeof (EFI_GRAPHICS_OUTPUT_PROTOCOL
));
631 // Initilize console output splitter's private data.
633 ConOutPrivate
->TextOut
.Mode
= &ConOutPrivate
->TextOutMode
;
636 // When new console device is added, the new mode will be set later,
637 // so put current mode back to init state.
639 ConOutPrivate
->TextOutMode
.Mode
= 0xFF;
641 // Allocate buffer for Console Out device
643 Status
= ConSplitterGrowBuffer (
644 sizeof (TEXT_OUT_AND_GOP_DATA
),
645 &ConOutPrivate
->TextOutListCount
,
646 (VOID
**) &ConOutPrivate
->TextOutList
648 if (EFI_ERROR (Status
)) {
649 return EFI_OUT_OF_RESOURCES
;
652 // Allocate buffer for Text Out query data
654 Status
= ConSplitterGrowBuffer (
655 sizeof (TEXT_OUT_SPLITTER_QUERY_DATA
),
656 &ConOutPrivate
->TextOutQueryDataCount
,
657 (VOID
**) &ConOutPrivate
->TextOutQueryData
659 if (EFI_ERROR (Status
)) {
660 return EFI_OUT_OF_RESOURCES
;
664 // Setup the default console to 80 x 25 and mode to 0
666 ConOutPrivate
->TextOutQueryData
[0].Columns
= 80;
667 ConOutPrivate
->TextOutQueryData
[0].Rows
= 25;
668 TextOutSetMode (ConOutPrivate
, 0);
671 if (FeaturePcdGet (PcdConOutUgaSupport
)) {
673 // Setup the UgaDraw to 800 x 600 x 32 bits per pixel, 60Hz.
675 ConSplitterUgaDrawSetMode (&ConOutPrivate
->UgaDraw
, 800, 600, 32, 60);
677 if (FeaturePcdGet (PcdConOutGopSupport
)) {
679 // Setup resource for mode information in Graphics Output Protocol interface
681 if ((ConOutPrivate
->GraphicsOutput
.Mode
= AllocateZeroPool (sizeof (EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE
))) == NULL
) {
682 return EFI_OUT_OF_RESOURCES
;
684 if ((ConOutPrivate
->GraphicsOutput
.Mode
->Info
= AllocateZeroPool (sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
))) == NULL
) {
685 return EFI_OUT_OF_RESOURCES
;
688 // Setup the DevNullGraphicsOutput to 800 x 600 x 32 bits per pixel
689 // DevNull will be updated to user-defined mode after driver has started.
691 if ((ConOutPrivate
->GraphicsOutputModeBuffer
= AllocateZeroPool (sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
))) == NULL
) {
692 return EFI_OUT_OF_RESOURCES
;
694 Info
= &ConOutPrivate
->GraphicsOutputModeBuffer
[0];
696 Info
->HorizontalResolution
= 800;
697 Info
->VerticalResolution
= 600;
698 Info
->PixelFormat
= PixelBltOnly
;
699 Info
->PixelsPerScanLine
= 800;
700 CopyMem (ConOutPrivate
->GraphicsOutput
.Mode
->Info
, Info
, sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
));
701 ConOutPrivate
->GraphicsOutput
.Mode
->SizeOfInfo
= sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
);
704 // Initialize the following items, theset items remain unchanged in GraphicsOutput->SetMode()
705 // GraphicsOutputMode->FrameBufferBase, GraphicsOutputMode->FrameBufferSize
707 ConOutPrivate
->GraphicsOutput
.Mode
->FrameBufferBase
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) NULL
;
708 ConOutPrivate
->GraphicsOutput
.Mode
->FrameBufferSize
= 0;
710 ConOutPrivate
->GraphicsOutput
.Mode
->MaxMode
= 1;
712 // Initial current mode to unknown state, and then set to mode 0
714 ConOutPrivate
->GraphicsOutput
.Mode
->Mode
= 0xffff;
715 ConOutPrivate
->GraphicsOutput
.SetMode (&ConOutPrivate
->GraphicsOutput
, 0);
723 Test to see if the specified protocol could be supported on the specified device.
725 @param This Driver Binding protocol pointer.
726 @param ControllerHandle Handle of device to test.
727 @param Guid The specified protocol.
729 @retval EFI_SUCCESS The specified protocol is supported on this device.
730 @retval EFI_UNSUPPORTED The specified protocol attempts to be installed on virtul handle.
731 @retval other Failed to open specified protocol on this device.
735 ConSplitterSupported (
736 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
737 IN EFI_HANDLE ControllerHandle
,
745 // Make sure the Console Splitter does not attempt to attach to itself
747 if (ControllerHandle
== mConIn
.VirtualHandle
||
748 ControllerHandle
== mConOut
.VirtualHandle
||
749 ControllerHandle
== mStdErr
.VirtualHandle
751 return EFI_UNSUPPORTED
;
755 // Check to see whether the specific protocol could be opened BY_DRIVER
757 Status
= gBS
->OpenProtocol (
761 This
->DriverBindingHandle
,
763 EFI_OPEN_PROTOCOL_BY_DRIVER
766 if (EFI_ERROR (Status
)) {
773 This
->DriverBindingHandle
,
781 Test to see if Console In Device could be supported on the Controller.
783 @param This Driver Binding protocol instance pointer.
784 @param ControllerHandle Handle of device to test.
785 @param RemainingDevicePath Optional parameter use to pick a specific child
788 @retval EFI_SUCCESS This driver supports this device.
789 @retval other This driver does not support this device.
794 ConSplitterConInDriverBindingSupported (
795 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
796 IN EFI_HANDLE ControllerHandle
,
797 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
800 return ConSplitterSupported (
803 &gEfiConsoleInDeviceGuid
808 Test to see if Simple Pointer protocol could be supported on the Controller.
810 @param This Driver Binding protocol instance pointer.
811 @param ControllerHandle Handle of device to test.
812 @param RemainingDevicePath Optional parameter use to pick a specific child
815 @retval EFI_SUCCESS This driver supports this device.
816 @retval other This driver does not support this device.
821 ConSplitterSimplePointerDriverBindingSupported (
822 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
823 IN EFI_HANDLE ControllerHandle
,
824 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
827 return ConSplitterSupported (
830 &gEfiSimplePointerProtocolGuid
835 Test to see if Absolute Pointer protocol could be supported on the Controller.
837 @param This Driver Binding protocol instance pointer.
838 @param ControllerHandle Handle of device to test.
839 @param RemainingDevicePath Optional parameter use to pick a specific child
842 @retval EFI_SUCCESS This driver supports this device.
843 @retval other This driver does not support this device.
848 ConSplitterAbsolutePointerDriverBindingSupported (
849 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
850 IN EFI_HANDLE ControllerHandle
,
851 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
854 return ConSplitterSupported (
857 &gEfiAbsolutePointerProtocolGuid
863 Test to see if Console Out Device could be supported on the Controller.
865 @param This Driver Binding protocol instance pointer.
866 @param ControllerHandle Handle of device to test.
867 @param RemainingDevicePath Optional parameter use to pick a specific child
870 @retval EFI_SUCCESS This driver supports this device.
871 @retval other This driver does not support this device.
876 ConSplitterConOutDriverBindingSupported (
877 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
878 IN EFI_HANDLE ControllerHandle
,
879 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
882 return ConSplitterSupported (
885 &gEfiConsoleOutDeviceGuid
890 Test to see if Standard Error Device could be supported on the Controller.
892 @param This Driver Binding protocol instance pointer.
893 @param ControllerHandle Handle of device to test.
894 @param RemainingDevicePath Optional parameter use to pick a specific child
897 @retval EFI_SUCCESS This driver supports this device.
898 @retval other This driver does not support this device.
903 ConSplitterStdErrDriverBindingSupported (
904 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
905 IN EFI_HANDLE ControllerHandle
,
906 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
909 return ConSplitterSupported (
912 &gEfiStandardErrorDeviceGuid
918 Start ConSplitter on devcie handle by opening Console Device Guid on device handle
919 and the console virtual handle. And Get the console interface on controller handle.
921 @param This Driver Binding protocol instance pointer.
922 @param ControllerHandle Handle of device.
923 @param ConSplitterVirtualHandle Console virtual Handle.
924 @param DeviceGuid The specified Console Device, such as ConInDev,
926 @param InterfaceGuid The specified protocol to be opened.
927 @param Interface Protocol interface returned.
929 @retval EFI_SUCCESS This driver supports this device.
930 @retval other Failed to open the specified Console Device Guid
931 or specified protocol.
936 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
937 IN EFI_HANDLE ControllerHandle
,
938 IN EFI_HANDLE ConSplitterVirtualHandle
,
939 IN EFI_GUID
*DeviceGuid
,
940 IN EFI_GUID
*InterfaceGuid
,
948 // Check to see whether the ControllerHandle has the DeviceGuid on it.
950 Status
= gBS
->OpenProtocol (
954 This
->DriverBindingHandle
,
956 EFI_OPEN_PROTOCOL_BY_DRIVER
958 if (EFI_ERROR (Status
)) {
963 // Open the Parent Handle for the child.
965 Status
= gBS
->OpenProtocol (
969 This
->DriverBindingHandle
,
970 ConSplitterVirtualHandle
,
971 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
973 if (EFI_ERROR (Status
)) {
978 // Open InterfaceGuid on the virtul handle.
980 Status
= gBS
->OpenProtocol (
984 This
->DriverBindingHandle
,
985 ConSplitterVirtualHandle
,
986 EFI_OPEN_PROTOCOL_GET_PROTOCOL
989 if (!EFI_ERROR (Status
)) {
994 // close the DeviceGuid on ConSplitter VirtualHandle.
999 This
->DriverBindingHandle
,
1000 ConSplitterVirtualHandle
1005 // close the DeviceGuid on ControllerHandle.
1007 gBS
->CloseProtocol (
1010 This
->DriverBindingHandle
,
1019 Start Console In Consplitter on device handle.
1021 @param This Driver Binding protocol instance pointer.
1022 @param ControllerHandle Handle of device to bind driver to.
1023 @param RemainingDevicePath Optional parameter use to pick a specific child
1026 @retval EFI_SUCCESS Console In Consplitter is added to ControllerHandle.
1027 @retval other Console In Consplitter does not support this device.
1032 ConSplitterConInDriverBindingStart (
1033 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1034 IN EFI_HANDLE ControllerHandle
,
1035 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
1039 EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*TextIn
;
1040 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*TextInEx
;
1043 // Start ConSplitter on ControllerHandle, and create the virtual
1044 // agrogated console device on first call Start for a SimpleTextIn handle.
1046 Status
= ConSplitterStart (
1049 mConIn
.VirtualHandle
,
1050 &gEfiConsoleInDeviceGuid
,
1051 &gEfiSimpleTextInProtocolGuid
,
1054 if (EFI_ERROR (Status
)) {
1059 // Add this device into Text In devices list.
1061 Status
= ConSplitterTextInAddDevice (&mConIn
, TextIn
);
1062 if (EFI_ERROR (Status
)) {
1066 Status
= gBS
->OpenProtocol (
1068 &gEfiSimpleTextInputExProtocolGuid
,
1069 (VOID
**) &TextInEx
,
1070 This
->DriverBindingHandle
,
1071 mConIn
.VirtualHandle
,
1072 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1074 if (!EFI_ERROR (Status
)) {
1076 // If Simple Text Input Ex protocol exists,
1077 // add this device into Text In Ex devices list.
1079 Status
= ConSplitterTextInExAddDevice (&mConIn
, TextInEx
);
1087 Start Simple Pointer Consplitter on device handle.
1089 @param This Driver Binding protocol instance pointer.
1090 @param ControllerHandle Handle of device to bind driver to.
1091 @param RemainingDevicePath Optional parameter use to pick a specific child
1094 @retval EFI_SUCCESS Simple Pointer Consplitter is added to ControllerHandle.
1095 @retval other Simple Pointer Consplitter does not support this device.
1100 ConSplitterSimplePointerDriverBindingStart (
1101 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1102 IN EFI_HANDLE ControllerHandle
,
1103 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
1107 EFI_SIMPLE_POINTER_PROTOCOL
*SimplePointer
;
1110 // Start ConSplitter on ControllerHandle, and create the virtual
1111 // agrogated console device on first call Start for a SimplePointer handle.
1113 Status
= ConSplitterStart (
1116 mConIn
.VirtualHandle
,
1117 &gEfiSimplePointerProtocolGuid
,
1118 &gEfiSimplePointerProtocolGuid
,
1119 (VOID
**) &SimplePointer
1121 if (EFI_ERROR (Status
)) {
1126 // Add this devcie into Simple Pointer devices list.
1128 return ConSplitterSimplePointerAddDevice (&mConIn
, SimplePointer
);
1133 Start Absolute Pointer Consplitter on device handle.
1135 @param This Driver Binding protocol instance pointer.
1136 @param ControllerHandle Handle of device to bind driver to.
1137 @param RemainingDevicePath Optional parameter use to pick a specific child
1140 @retval EFI_SUCCESS Absolute Pointer Consplitter is added to ControllerHandle.
1141 @retval other Absolute Pointer Consplitter does not support this device.
1146 ConSplitterAbsolutePointerDriverBindingStart (
1147 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1148 IN EFI_HANDLE ControllerHandle
,
1149 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
1153 EFI_ABSOLUTE_POINTER_PROTOCOL
*AbsolutePointer
;
1156 // Start ConSplitter on ControllerHandle, and create the virtual
1157 // agrogated console device on first call Start for a AbsolutePointer handle.
1159 Status
= ConSplitterStart (
1162 mConIn
.VirtualHandle
,
1163 &gEfiAbsolutePointerProtocolGuid
,
1164 &gEfiAbsolutePointerProtocolGuid
,
1165 (VOID
**) &AbsolutePointer
1168 if (EFI_ERROR (Status
)) {
1173 // Add this devcie into Absolute Pointer devices list.
1175 return ConSplitterAbsolutePointerAddDevice (&mConIn
, AbsolutePointer
);
1180 Start Console Out Consplitter on device handle.
1182 @param This Driver Binding protocol instance pointer.
1183 @param ControllerHandle Handle of device to bind driver to.
1184 @param RemainingDevicePath Optional parameter use to pick a specific child
1187 @retval EFI_SUCCESS Console Out Consplitter is added to ControllerHandle.
1188 @retval other Console Out Consplitter does not support this device.
1193 ConSplitterConOutDriverBindingStart (
1194 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1195 IN EFI_HANDLE ControllerHandle
,
1196 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
1200 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*TextOut
;
1201 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
1202 EFI_UGA_DRAW_PROTOCOL
*UgaDraw
;
1204 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*Info
;
1207 // Start ConSplitter on ControllerHandle, and create the virtual
1208 // agrogated console device on first call Start for a ConsoleOut handle.
1210 Status
= ConSplitterStart (
1213 mConOut
.VirtualHandle
,
1214 &gEfiConsoleOutDeviceGuid
,
1215 &gEfiSimpleTextOutProtocolGuid
,
1218 if (EFI_ERROR (Status
)) {
1222 GraphicsOutput
= NULL
;
1225 // Try to Open Graphics Output protocol
1227 Status
= gBS
->OpenProtocol (
1229 &gEfiGraphicsOutputProtocolGuid
,
1230 (VOID
**) &GraphicsOutput
,
1231 This
->DriverBindingHandle
,
1232 mConOut
.VirtualHandle
,
1233 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1236 if (EFI_ERROR (Status
) && FeaturePcdGet (PcdUgaConsumeSupport
)) {
1238 // Open UGA DRAW protocol
1242 &gEfiUgaDrawProtocolGuid
,
1244 This
->DriverBindingHandle
,
1245 mConOut
.VirtualHandle
,
1246 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1251 // When new console device is added, the new mode will be set later,
1252 // so put current mode back to init state.
1254 mConOut
.TextOutMode
.Mode
= 0xFF;
1257 // If both ConOut and StdErr incorporate the same Text Out device,
1258 // their MaxMode and QueryData should be the intersection of both.
1260 Status
= ConSplitterTextOutAddDevice (&mConOut
, TextOut
, GraphicsOutput
, UgaDraw
);
1261 ConSplitterTextOutSetAttribute (&mConOut
.TextOut
, EFI_TEXT_ATTR (EFI_LIGHTGRAY
, EFI_BLACK
));
1263 if (FeaturePcdGet (PcdConOutUgaSupport
)) {
1265 // Get the UGA mode data of ConOut from the current mode
1267 if (GraphicsOutput
!= NULL
) {
1268 Status
= GraphicsOutput
->QueryMode (GraphicsOutput
, GraphicsOutput
->Mode
->Mode
, &SizeOfInfo
, &Info
);
1269 if (EFI_ERROR (Status
)) {
1272 ASSERT ( SizeOfInfo
<= sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
));
1274 mConOut
.UgaHorizontalResolution
= Info
->HorizontalResolution
;
1275 mConOut
.UgaVerticalResolution
= Info
->VerticalResolution
;
1276 mConOut
.UgaColorDepth
= 32;
1277 mConOut
.UgaRefreshRate
= 60;
1281 } else if (UgaDraw
!= NULL
) {
1282 Status
= UgaDraw
->GetMode (
1284 &mConOut
.UgaHorizontalResolution
,
1285 &mConOut
.UgaVerticalResolution
,
1286 &mConOut
.UgaColorDepth
,
1287 &mConOut
.UgaRefreshRate
1297 Start Standard Error Consplitter on device handle.
1299 @param This Driver Binding protocol instance pointer.
1300 @param ControllerHandle Handle of device to bind driver to.
1301 @param RemainingDevicePath Optional parameter use to pick a specific child
1304 @retval EFI_SUCCESS Standard Error Consplitter is added to ControllerHandle.
1305 @retval other Standard Error Consplitter does not support this device.
1310 ConSplitterStdErrDriverBindingStart (
1311 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1312 IN EFI_HANDLE ControllerHandle
,
1313 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
1317 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*TextOut
;
1320 // Start ConSplitter on ControllerHandle, and create the virtual
1321 // agrogated console device on first call Start for a StandardError handle.
1323 Status
= ConSplitterStart (
1326 mStdErr
.VirtualHandle
,
1327 &gEfiStandardErrorDeviceGuid
,
1328 &gEfiSimpleTextOutProtocolGuid
,
1331 if (EFI_ERROR (Status
)) {
1336 // When new console device is added, the new mode will be set later,
1337 // so put current mode back to init state.
1339 mStdErr
.TextOutMode
.Mode
= 0xFF;
1342 // If both ConOut and StdErr incorporate the same Text Out device,
1343 // their MaxMode and QueryData should be the intersection of both.
1345 Status
= ConSplitterTextOutAddDevice (&mStdErr
, TextOut
, NULL
, NULL
);
1346 ConSplitterTextOutSetAttribute (&mStdErr
.TextOut
, EFI_TEXT_ATTR (EFI_MAGENTA
, EFI_BLACK
));
1347 if (EFI_ERROR (Status
)) {
1356 Stop ConSplitter on device handle by closing Console Device Guid on device handle
1357 and the console virtual handle.
1359 @param This Protocol instance pointer.
1360 @param ControllerHandle Handle of device.
1361 @param ConSplitterVirtualHandle Console virtual Handle.
1362 @param DeviceGuid The specified Console Device, such as ConInDev,
1364 @param InterfaceGuid The specified protocol to be opened.
1365 @param Interface Protocol interface returned.
1367 @retval EFI_SUCCESS Stop ConSplitter on ControllerHandle successfully.
1368 @retval other Failed to Stop ConSplitter on ControllerHandle.
1373 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1374 IN EFI_HANDLE ControllerHandle
,
1375 IN EFI_HANDLE ConSplitterVirtualHandle
,
1376 IN EFI_GUID
*DeviceGuid
,
1377 IN EFI_GUID
*InterfaceGuid
,
1383 Status
= gBS
->OpenProtocol (
1387 This
->DriverBindingHandle
,
1389 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1391 if (EFI_ERROR (Status
)) {
1395 // close the protocol refered.
1397 gBS
->CloseProtocol (
1400 This
->DriverBindingHandle
,
1401 ConSplitterVirtualHandle
1404 gBS
->CloseProtocol (
1407 This
->DriverBindingHandle
,
1416 Stop Console In ConSplitter on ControllerHandle by closing Console In Devcice GUID.
1418 @param This Driver Binding protocol instance pointer.
1419 @param ControllerHandle Handle of device to stop driver on
1420 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
1421 children is zero stop the entire bus driver.
1422 @param ChildHandleBuffer List of Child Handles to Stop.
1424 @retval EFI_SUCCESS This driver is removed ControllerHandle
1425 @retval other This driver was not removed from this device
1430 ConSplitterConInDriverBindingStop (
1431 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1432 IN EFI_HANDLE ControllerHandle
,
1433 IN UINTN NumberOfChildren
,
1434 IN EFI_HANDLE
*ChildHandleBuffer
1438 EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*TextIn
;
1439 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*TextInEx
;
1441 if (NumberOfChildren
== 0) {
1445 Status
= gBS
->OpenProtocol (
1447 &gEfiSimpleTextInputExProtocolGuid
,
1448 (VOID
**) &TextInEx
,
1449 This
->DriverBindingHandle
,
1451 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1453 if (!EFI_ERROR (Status
)) {
1455 // If Simple Text Input Ex protocol exists,
1456 // remove device from Text Input Ex devices list.
1458 Status
= ConSplitterTextInExDeleteDevice (&mConIn
, TextInEx
);
1459 if (EFI_ERROR (Status
)) {
1465 // Close Simple Text In protocol on controller handle and virtual handle.
1467 Status
= ConSplitterStop (
1470 mConIn
.VirtualHandle
,
1471 &gEfiConsoleInDeviceGuid
,
1472 &gEfiSimpleTextInProtocolGuid
,
1475 if (EFI_ERROR (Status
)) {
1480 // Remove device from Text Input devices list.
1482 return ConSplitterTextInDeleteDevice (&mConIn
, TextIn
);
1487 Stop Simple Pointer protocol ConSplitter on ControllerHandle by closing
1488 Simple Pointer protocol.
1490 @param This Driver Binding protocol instance pointer.
1491 @param ControllerHandle Handle of device to stop driver on
1492 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
1493 children is zero stop the entire bus driver.
1494 @param ChildHandleBuffer List of Child Handles to Stop.
1496 @retval EFI_SUCCESS This driver is removed ControllerHandle
1497 @retval other This driver was not removed from this device
1502 ConSplitterSimplePointerDriverBindingStop (
1503 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1504 IN EFI_HANDLE ControllerHandle
,
1505 IN UINTN NumberOfChildren
,
1506 IN EFI_HANDLE
*ChildHandleBuffer
1510 EFI_SIMPLE_POINTER_PROTOCOL
*SimplePointer
;
1512 if (NumberOfChildren
== 0) {
1517 // Close Simple Pointer protocol on controller handle and virtual handle.
1519 Status
= ConSplitterStop (
1522 mConIn
.VirtualHandle
,
1523 &gEfiSimplePointerProtocolGuid
,
1524 &gEfiSimplePointerProtocolGuid
,
1525 (VOID
**) &SimplePointer
1527 if (EFI_ERROR (Status
)) {
1532 // Remove this device from Simple Pointer device list.
1534 return ConSplitterSimplePointerDeleteDevice (&mConIn
, SimplePointer
);
1539 Stop Absolute Pointer protocol ConSplitter on ControllerHandle by closing
1540 Absolute Pointer protocol.
1542 @param This Driver Binding protocol instance pointer.
1543 @param ControllerHandle Handle of device to stop driver on
1544 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
1545 children is zero stop the entire bus driver.
1546 @param ChildHandleBuffer List of Child Handles to Stop.
1548 @retval EFI_SUCCESS This driver is removed ControllerHandle
1549 @retval other This driver was not removed from this device
1554 ConSplitterAbsolutePointerDriverBindingStop (
1555 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1556 IN EFI_HANDLE ControllerHandle
,
1557 IN UINTN NumberOfChildren
,
1558 IN EFI_HANDLE
*ChildHandleBuffer
1562 EFI_ABSOLUTE_POINTER_PROTOCOL
*AbsolutePointer
;
1564 if (NumberOfChildren
== 0) {
1569 // Close Absolute Pointer protocol on controller handle and virtual handle.
1571 Status
= ConSplitterStop (
1574 mConIn
.VirtualHandle
,
1575 &gEfiAbsolutePointerProtocolGuid
,
1576 &gEfiAbsolutePointerProtocolGuid
,
1577 (VOID
**) &AbsolutePointer
1579 if (EFI_ERROR (Status
)) {
1584 // Remove this device from Absolute Pointer device list.
1586 return ConSplitterAbsolutePointerDeleteDevice (&mConIn
, AbsolutePointer
);
1591 Stop Console Out ConSplitter on device handle by closing Console Out Devcice GUID.
1593 @param This Driver Binding protocol instance pointer.
1594 @param ControllerHandle Handle of device to stop driver on
1595 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
1596 children is zero stop the entire bus driver.
1597 @param ChildHandleBuffer List of Child Handles to Stop.
1599 @retval EFI_SUCCESS This driver is removed ControllerHandle
1600 @retval other This driver was not removed from this device
1605 ConSplitterConOutDriverBindingStop (
1606 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1607 IN EFI_HANDLE ControllerHandle
,
1608 IN UINTN NumberOfChildren
,
1609 IN EFI_HANDLE
*ChildHandleBuffer
1613 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*TextOut
;
1615 if (NumberOfChildren
== 0) {
1620 // Close Absolute Pointer protocol on controller handle and virtual handle.
1622 Status
= ConSplitterStop (
1625 mConOut
.VirtualHandle
,
1626 &gEfiConsoleOutDeviceGuid
,
1627 &gEfiSimpleTextOutProtocolGuid
,
1630 if (EFI_ERROR (Status
)) {
1635 // Remove this device from Text Out device list.
1637 return ConSplitterTextOutDeleteDevice (&mConOut
, TextOut
);
1642 Stop Standard Error ConSplitter on ControllerHandle by closing Standard Error GUID.
1644 @param This Driver Binding protocol instance pointer.
1645 @param ControllerHandle Handle of device to stop driver on
1646 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
1647 children is zero stop the entire bus driver.
1648 @param ChildHandleBuffer List of Child Handles to Stop.
1650 @retval EFI_SUCCESS This driver is removed ControllerHandle
1651 @retval other This driver was not removed from this device
1656 ConSplitterStdErrDriverBindingStop (
1657 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1658 IN EFI_HANDLE ControllerHandle
,
1659 IN UINTN NumberOfChildren
,
1660 IN EFI_HANDLE
*ChildHandleBuffer
1664 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*TextOut
;
1666 if (NumberOfChildren
== 0) {
1671 // Close Standard Error Device on controller handle and virtual handle.
1673 Status
= ConSplitterStop (
1676 mStdErr
.VirtualHandle
,
1677 &gEfiStandardErrorDeviceGuid
,
1678 &gEfiSimpleTextOutProtocolGuid
,
1681 if (EFI_ERROR (Status
)) {
1685 // Delete this console error out device's data structures.
1687 return ConSplitterTextOutDeleteDevice (&mStdErr
, TextOut
);
1692 Take the passed in Buffer of size ElementSize and grow the buffer
1693 by CONSOLE_SPLITTER_ALLOC_UNIT * ElementSize bytes.
1694 Copy the current data in Buffer to the new version of Buffer and
1695 free the old version of buffer.
1697 @param ElementSize Size of element in array.
1698 @param Count Current number of elements in array.
1699 @param Buffer Bigger version of passed in Buffer with all the
1702 @retval EFI_SUCCESS Buffer size has grown.
1703 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
1707 ConSplitterGrowBuffer (
1708 IN UINTN ElementSize
,
1709 IN OUT UINTN
*Count
,
1710 IN OUT VOID
**Buffer
1716 // grow the buffer to new buffer size,
1717 // copy the old buffer's content to the new-size buffer,
1718 // then free the old buffer.
1720 Ptr
= ReallocatePool (
1721 ElementSize
* (*Count
),
1722 ElementSize
* ((*Count
) + CONSOLE_SPLITTER_ALLOC_UNIT
),
1726 return EFI_OUT_OF_RESOURCES
;
1728 *Count
+= CONSOLE_SPLITTER_ALLOC_UNIT
;
1735 Add Text Input Device in Consplitter Text Input list.
1737 @param Private Text In Splitter pointer.
1738 @param TextIn Simple Text Input protocol pointer.
1740 @retval EFI_SUCCESS Text Input Device added successfully.
1741 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
1745 ConSplitterTextInAddDevice (
1746 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
1747 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*TextIn
1753 // If the Text In List is full, enlarge it by calling ConSplitterGrowBuffer().
1755 if (Private
->CurrentNumberOfConsoles
>= Private
->TextInListCount
) {
1756 Status
= ConSplitterGrowBuffer (
1757 sizeof (EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*),
1758 &Private
->TextInListCount
,
1759 (VOID
**) &Private
->TextInList
1761 if (EFI_ERROR (Status
)) {
1762 return EFI_OUT_OF_RESOURCES
;
1766 // Add the new text-in device data structure into the Text In List.
1768 Private
->TextInList
[Private
->CurrentNumberOfConsoles
] = TextIn
;
1769 Private
->CurrentNumberOfConsoles
++;
1772 // Extra CheckEvent added to reduce the double CheckEvent().
1774 gBS
->CheckEvent (TextIn
->WaitForKey
);
1781 Remove Text Input Device from Consplitter Text Input list.
1783 @param Private Text In Splitter pointer.
1784 @param TextIn Simple Text protocol pointer.
1786 @retval EFI_SUCCESS Simple Text Device removed successfully.
1787 @retval EFI_NOT_FOUND No Simple Text Device found.
1791 ConSplitterTextInDeleteDevice (
1792 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
1793 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*TextIn
1798 // Remove the specified text-in device data structure from the Text In List,
1799 // and rearrange the remaining data structures in the Text In List.
1801 for (Index
= 0; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
1802 if (Private
->TextInList
[Index
] == TextIn
) {
1803 for (; Index
< Private
->CurrentNumberOfConsoles
- 1; Index
++) {
1804 Private
->TextInList
[Index
] = Private
->TextInList
[Index
+ 1];
1807 Private
->CurrentNumberOfConsoles
--;
1812 return EFI_NOT_FOUND
;
1816 Add Text Input Ex Device in Consplitter Text Input Ex list.
1818 @param Private Text In Splitter pointer.
1819 @param TextInEx Simple Text Input Ex Input protocol pointer.
1821 @retval EFI_SUCCESS Text Input Ex Device added successfully.
1822 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
1826 ConSplitterTextInExAddDevice (
1827 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
1828 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*TextInEx
1833 TEXT_IN_EX_SPLITTER_NOTIFY
*CurrentNotify
;
1834 UINTN TextInExListCount
;
1837 // Enlarge the NotifyHandleList and the TextInExList
1839 if (Private
->CurrentNumberOfExConsoles
>= Private
->TextInExListCount
) {
1840 for (Link
= Private
->NotifyList
.ForwardLink
; Link
!= &Private
->NotifyList
; Link
= Link
->ForwardLink
) {
1841 CurrentNotify
= TEXT_IN_EX_SPLITTER_NOTIFY_FROM_THIS (Link
);
1842 TextInExListCount
= Private
->TextInExListCount
;
1844 Status
= ConSplitterGrowBuffer (
1845 sizeof (EFI_HANDLE
),
1847 (VOID
**) &CurrentNotify
->NotifyHandleList
1849 if (EFI_ERROR (Status
)) {
1850 return EFI_OUT_OF_RESOURCES
;
1853 Status
= ConSplitterGrowBuffer (
1854 sizeof (EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*),
1855 &Private
->TextInExListCount
,
1856 (VOID
**) &Private
->TextInExList
1858 if (EFI_ERROR (Status
)) {
1859 return EFI_OUT_OF_RESOURCES
;
1864 // Register the key notify in the new text-in device
1866 for (Link
= Private
->NotifyList
.ForwardLink
; Link
!= &Private
->NotifyList
; Link
= Link
->ForwardLink
) {
1867 CurrentNotify
= TEXT_IN_EX_SPLITTER_NOTIFY_FROM_THIS (Link
);
1868 Status
= TextInEx
->RegisterKeyNotify (
1870 &CurrentNotify
->KeyData
,
1871 CurrentNotify
->KeyNotificationFn
,
1872 &CurrentNotify
->NotifyHandleList
[Private
->CurrentNumberOfExConsoles
]
1874 if (EFI_ERROR (Status
)) {
1875 for (Link
= Link
->BackLink
; Link
!= &Private
->NotifyList
; Link
= Link
->BackLink
) {
1876 CurrentNotify
= TEXT_IN_EX_SPLITTER_NOTIFY_FROM_THIS (Link
);
1877 TextInEx
->UnregisterKeyNotify (
1879 CurrentNotify
->NotifyHandleList
[Private
->CurrentNumberOfExConsoles
]
1887 // Add the new text-in device data structure into the Text Input Ex List.
1889 Private
->TextInExList
[Private
->CurrentNumberOfExConsoles
] = TextInEx
;
1890 Private
->CurrentNumberOfExConsoles
++;
1893 // Extra CheckEvent added to reduce the double CheckEvent().
1895 gBS
->CheckEvent (TextInEx
->WaitForKeyEx
);
1901 Remove Text Ex Device from Consplitter Text Input Ex list.
1903 @param Private Text In Splitter pointer.
1904 @param TextInEx Simple Text Ex protocol pointer.
1906 @retval EFI_SUCCESS Simple Text Input Ex Device removed successfully.
1907 @retval EFI_NOT_FOUND No Simple Text Input Ex Device found.
1911 ConSplitterTextInExDeleteDevice (
1912 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
1913 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*TextInEx
1918 // Remove the specified text-in device data structure from the Text Input Ex List,
1919 // and rearrange the remaining data structures in the Text In List.
1921 for (Index
= 0; Index
< Private
->CurrentNumberOfExConsoles
; Index
++) {
1922 if (Private
->TextInExList
[Index
] == TextInEx
) {
1923 for (; Index
< Private
->CurrentNumberOfExConsoles
- 1; Index
++) {
1924 Private
->TextInExList
[Index
] = Private
->TextInExList
[Index
+ 1];
1927 Private
->CurrentNumberOfExConsoles
--;
1932 return EFI_NOT_FOUND
;
1937 Add Simple Pointer Device in Consplitter Simple Pointer list.
1939 @param Private Text In Splitter pointer.
1940 @param SimplePointer Simple Pointer protocol pointer.
1942 @retval EFI_SUCCESS Simple Pointer Device added successfully.
1943 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
1947 ConSplitterSimplePointerAddDevice (
1948 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
1949 IN EFI_SIMPLE_POINTER_PROTOCOL
*SimplePointer
1955 // If the Simple Pointer List is full, enlarge it by calling ConSplitterGrowBuffer().
1957 if (Private
->CurrentNumberOfPointers
>= Private
->PointerListCount
) {
1958 Status
= ConSplitterGrowBuffer (
1959 sizeof (EFI_SIMPLE_POINTER_PROTOCOL
*),
1960 &Private
->PointerListCount
,
1961 (VOID
**) &Private
->PointerList
1963 if (EFI_ERROR (Status
)) {
1964 return EFI_OUT_OF_RESOURCES
;
1968 // Add the new text-in device data structure into the Simple Pointer List.
1970 Private
->PointerList
[Private
->CurrentNumberOfPointers
] = SimplePointer
;
1971 Private
->CurrentNumberOfPointers
++;
1978 Remove Simple Pointer Device from Consplitter Simple Pointer list.
1980 @param Private Text In Splitter pointer.
1981 @param SimplePointer Simple Pointer protocol pointer.
1983 @retval EFI_SUCCESS Simple Pointer Device removed successfully.
1984 @retval EFI_NOT_FOUND No Simple Pointer Device found.
1988 ConSplitterSimplePointerDeleteDevice (
1989 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
1990 IN EFI_SIMPLE_POINTER_PROTOCOL
*SimplePointer
1995 // Remove the specified text-in device data structure from the Simple Pointer List,
1996 // and rearrange the remaining data structures in the Text In List.
1998 for (Index
= 0; Index
< Private
->CurrentNumberOfPointers
; Index
++) {
1999 if (Private
->PointerList
[Index
] == SimplePointer
) {
2000 for (; Index
< Private
->CurrentNumberOfPointers
- 1; Index
++) {
2001 Private
->PointerList
[Index
] = Private
->PointerList
[Index
+ 1];
2004 Private
->CurrentNumberOfPointers
--;
2009 return EFI_NOT_FOUND
;
2014 Add Absolute Pointer Device in Consplitter Absolute Pointer list.
2016 @param Private Text In Splitter pointer.
2017 @param AbsolutePointer Absolute Pointer protocol pointer.
2019 @retval EFI_SUCCESS Absolute Pointer Device added successfully.
2020 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
2024 ConSplitterAbsolutePointerAddDevice (
2025 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
2026 IN EFI_ABSOLUTE_POINTER_PROTOCOL
*AbsolutePointer
2032 // If the Absolute Pointer List is full, enlarge it by calling ConSplitterGrowBuffer().
2034 if (Private
->CurrentNumberOfAbsolutePointers
>= Private
->AbsolutePointerListCount
) {
2035 Status
= ConSplitterGrowBuffer (
2036 sizeof (EFI_ABSOLUTE_POINTER_PROTOCOL
*),
2037 &Private
->AbsolutePointerListCount
,
2038 (VOID
**) &Private
->AbsolutePointerList
2040 if (EFI_ERROR (Status
)) {
2041 return EFI_OUT_OF_RESOURCES
;
2045 // Add the new text-in device data structure into the Absolute Pointer List.
2047 Private
->AbsolutePointerList
[Private
->CurrentNumberOfAbsolutePointers
] = AbsolutePointer
;
2048 Private
->CurrentNumberOfAbsolutePointers
++;
2055 Remove Absolute Pointer Device from Consplitter Absolute Pointer list.
2057 @param Private Text In Splitter pointer.
2058 @param AbsolutePointer Absolute Pointer protocol pointer.
2060 @retval EFI_SUCCESS Absolute Pointer Device removed successfully.
2061 @retval EFI_NOT_FOUND No Absolute Pointer Device found.
2065 ConSplitterAbsolutePointerDeleteDevice (
2066 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
2067 IN EFI_ABSOLUTE_POINTER_PROTOCOL
*AbsolutePointer
2072 // Remove the specified text-in device data structure from the Absolute Pointer List,
2073 // and rearrange the remaining data structures from the Absolute Pointer List.
2075 for (Index
= 0; Index
< Private
->CurrentNumberOfAbsolutePointers
; Index
++) {
2076 if (Private
->AbsolutePointerList
[Index
] == AbsolutePointer
) {
2077 for (; Index
< Private
->CurrentNumberOfAbsolutePointers
- 1; Index
++) {
2078 Private
->AbsolutePointerList
[Index
] = Private
->AbsolutePointerList
[Index
+ 1];
2081 Private
->CurrentNumberOfAbsolutePointers
--;
2086 return EFI_NOT_FOUND
;
2090 Reallocate Text Out mode map.
2092 Allocate new buffer and copy original buffer into the new buffer.
2094 @param Private Consplitter Text Out pointer.
2096 @retval EFI_SUCCESS Buffer size has grown
2097 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
2101 ConSplitterGrowMapTable (
2102 IN TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
2108 INT32
*TextOutModeMap
;
2109 INT32
*OldTextOutModeMap
;
2113 NewSize
= Private
->TextOutListCount
* sizeof (INT32
);
2114 OldTextOutModeMap
= Private
->TextOutModeMap
;
2115 TotalSize
= NewSize
* (Private
->TextOutQueryDataCount
);
2118 // Allocate new buffer for Text Out List.
2120 TextOutModeMap
= AllocatePool (TotalSize
);
2121 if (TextOutModeMap
== NULL
) {
2122 return EFI_OUT_OF_RESOURCES
;
2125 SetMem (TextOutModeMap
, TotalSize
, 0xFF);
2126 Private
->TextOutModeMap
= TextOutModeMap
;
2129 // If TextOutList has been enlarged, need to realloc the mode map table
2130 // The mode map table is regarded as a two dimension array.
2133 // 0 ---------> TextOutListCount ----> TextOutListCount
2134 // | -------------------------------------------
2141 // -------------------------------------------
2144 if (OldTextOutModeMap
!= NULL
) {
2146 Size
= Private
->CurrentNumberOfConsoles
* sizeof (INT32
);
2148 SrcAddress
= OldTextOutModeMap
;
2151 // Copy the old data to the new one
2153 while (Index
< Private
->TextOutMode
.MaxMode
) {
2154 CopyMem (TextOutModeMap
, SrcAddress
, Size
);
2155 TextOutModeMap
+= NewSize
;
2160 // Free the old buffer
2162 FreePool (OldTextOutModeMap
);
2170 Add new device's output mode to console splitter's mode list.
2172 @param Private Text Out Splitter pointer
2173 @param TextOut Simple Text Output protocol pointer.
2175 @retval EFI_SUCCESS Device added successfully.
2176 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
2180 ConSplitterAddOutputMode (
2181 IN TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
,
2182 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*TextOut
2190 MaxMode
= TextOut
->Mode
->MaxMode
;
2191 Private
->TextOutMode
.MaxMode
= MaxMode
;
2194 // Grow the buffer if query data buffer is not large enough to
2195 // hold all the mode supported by the first console.
2197 while (MaxMode
> (INT32
) Private
->TextOutQueryDataCount
) {
2198 Status
= ConSplitterGrowBuffer (
2199 sizeof (TEXT_OUT_SPLITTER_QUERY_DATA
),
2200 &Private
->TextOutQueryDataCount
,
2201 (VOID
**) &Private
->TextOutQueryData
2203 if (EFI_ERROR (Status
)) {
2204 return EFI_OUT_OF_RESOURCES
;
2208 // Allocate buffer for the output mode map
2210 Status
= ConSplitterGrowMapTable (Private
);
2211 if (EFI_ERROR (Status
)) {
2212 return EFI_OUT_OF_RESOURCES
;
2215 // As the first textout device, directly add the mode in to QueryData
2216 // and at the same time record the mapping between QueryData and TextOut.
2220 while (Mode
< MaxMode
) {
2221 Status
= TextOut
->QueryMode (
2224 &Private
->TextOutQueryData
[Mode
].Columns
,
2225 &Private
->TextOutQueryData
[Mode
].Rows
2228 // If mode 1 (80x50) is not supported, make sure mode 1 in TextOutQueryData
2231 if ((EFI_ERROR(Status
)) && (Mode
== 1)) {
2232 Private
->TextOutQueryData
[Mode
].Columns
= 0;
2233 Private
->TextOutQueryData
[Mode
].Rows
= 0;
2235 Private
->TextOutModeMap
[Index
] = Mode
;
2237 Index
+= Private
->TextOutListCount
;
2244 Reconstruct TextOutModeMap to get intersection of modes.
2246 This routine reconstruct TextOutModeMap to get the intersection
2247 of modes for all console out devices. Because EFI/UEFI spec require
2248 mode 0 is 80x25, mode 1 is 80x50, this routine will not check the
2249 intersection for mode 0 and mode 1.
2251 @param TextOutModeMap Current text out mode map, begin with the mode 80x25
2252 @param NewlyAddedMap New text out mode map, begin with the mode 80x25
2253 @param MapStepSize Mode step size for one console device
2254 @param NewMapStepSize New Mode step size for one console device
2255 @param MaxMode IN: Current max text mode, OUT: Updated max text mode.
2256 @param CurrentMode IN: Current text mode, OUT: Updated current text mode.
2260 ConSplitterGetIntersection (
2261 IN INT32
*TextOutModeMap
,
2262 IN INT32
*NewlyAddedMap
,
2263 IN UINTN MapStepSize
,
2264 IN UINTN NewMapStepSize
,
2265 IN OUT INT32
*MaxMode
,
2266 IN OUT INT32
*CurrentMode
2270 INT32
*CurrentMapEntry
;
2271 INT32
*NextMapEntry
;
2273 INT32 CurrentMaxMode
;
2277 // According to EFI/UEFI spec, mode 0 and mode 1 have been reserved
2278 // for 80x25 and 80x50 in Simple Text Out protocol, so don't make intersection
2279 // for mode 0 and mode 1, mode number starts from 2.
2282 CurrentMapEntry
= &TextOutModeMap
[MapStepSize
* 2];
2283 NextMapEntry
= CurrentMapEntry
;
2284 NewMapEntry
= &NewlyAddedMap
[NewMapStepSize
* 2];
2286 CurrentMaxMode
= *MaxMode
;
2287 Mode
= *CurrentMode
;
2289 while (Index
< CurrentMaxMode
) {
2290 if (*NewMapEntry
== -1) {
2292 // This mode is not supported any more. Remove it. Special care
2293 // must be taken as this remove will also affect current mode;
2295 if (Index
== *CurrentMode
) {
2297 } else if (Index
< *CurrentMode
) {
2302 if (CurrentMapEntry
!= NextMapEntry
) {
2303 CopyMem (NextMapEntry
, CurrentMapEntry
, MapStepSize
* sizeof (INT32
));
2306 NextMapEntry
+= MapStepSize
;
2309 CurrentMapEntry
+= MapStepSize
;
2310 NewMapEntry
+= NewMapStepSize
;
2314 *CurrentMode
= Mode
;
2320 Sync the device's output mode to console splitter's mode list.
2322 @param Private Text Out Splitter pointer.
2323 @param TextOut Simple Text Output protocol pointer.
2327 ConSplitterSyncOutputMode (
2328 IN TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
,
2329 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*TextOut
2332 INT32 CurrentMaxMode
;
2335 INT32
*TextOutModeMap
;
2338 TEXT_OUT_SPLITTER_QUERY_DATA
*TextOutQueryData
;
2345 // Must make sure that current mode won't change even if mode number changes
2347 CurrentMaxMode
= Private
->TextOutMode
.MaxMode
;
2348 TextOutModeMap
= Private
->TextOutModeMap
;
2349 StepSize
= Private
->TextOutListCount
;
2350 TextOutQueryData
= Private
->TextOutQueryData
;
2353 // Query all the mode that the newly added TextOut supports
2356 MapTable
= TextOutModeMap
+ Private
->CurrentNumberOfConsoles
;
2357 while (Mode
< TextOut
->Mode
->MaxMode
) {
2358 Status
= TextOut
->QueryMode (TextOut
, Mode
, &Columns
, &Rows
);
2360 if (EFI_ERROR(Status
)) {
2363 // If mode 1 (80x50) is not supported, make sure mode 1 in TextOutQueryData
2366 MapTable
[StepSize
] = Mode
;
2367 TextOutQueryData
[Mode
].Columns
= 0;
2368 TextOutQueryData
[Mode
].Rows
= 0;
2374 // Search the intersection map and QueryData database to see if they intersects
2377 while (Index
< CurrentMaxMode
) {
2378 QueryMode
= *(TextOutModeMap
+ Index
* StepSize
);
2379 if ((TextOutQueryData
[QueryMode
].Rows
== Rows
) && (TextOutQueryData
[QueryMode
].Columns
== Columns
)) {
2380 MapTable
[Index
* StepSize
] = Mode
;
2388 // Now search the TextOutModeMap table to find the intersection of supported
2389 // mode between ConSplitter and the newly added device.
2391 ConSplitterGetIntersection (
2396 &Private
->TextOutMode
.MaxMode
,
2397 &Private
->TextOutMode
.Mode
2405 Sync output device between ConOut and StdErr output.
2407 @retval EFI_SUCCESS Sync implemented successfully.
2408 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
2412 ConSplitterGetIntersectionBetweenConOutAndStrErr (
2416 UINTN ConOutNumOfConsoles
;
2417 UINTN StdErrNumOfConsoles
;
2418 TEXT_OUT_AND_GOP_DATA
*ConOutTextOutList
;
2419 TEXT_OUT_AND_GOP_DATA
*StdErrTextOutList
;
2423 UINTN ConOutColumns
;
2425 UINTN StdErrColumns
;
2426 INT32 ConOutMaxMode
;
2427 INT32 StdErrMaxMode
;
2432 INT32
*ConOutModeMap
;
2433 INT32
*StdErrModeMap
;
2434 INT32
*ConOutMapTable
;
2435 INT32
*StdErrMapTable
;
2436 TEXT_OUT_SPLITTER_QUERY_DATA
*ConOutQueryData
;
2437 TEXT_OUT_SPLITTER_QUERY_DATA
*StdErrQueryData
;
2438 UINTN ConOutStepSize
;
2439 UINTN StdErrStepSize
;
2440 BOOLEAN FoundTheSameTextOut
;
2441 UINTN ConOutMapTableSize
;
2442 UINTN StdErrMapTableSize
;
2444 ConOutNumOfConsoles
= mConOut
.CurrentNumberOfConsoles
;
2445 StdErrNumOfConsoles
= mStdErr
.CurrentNumberOfConsoles
;
2446 ConOutTextOutList
= mConOut
.TextOutList
;
2447 StdErrTextOutList
= mStdErr
.TextOutList
;
2450 FoundTheSameTextOut
= FALSE
;
2451 while ((Indexi
< ConOutNumOfConsoles
) && (!FoundTheSameTextOut
)) {
2453 while (Indexj
< StdErrNumOfConsoles
) {
2454 if (ConOutTextOutList
->TextOut
== StdErrTextOutList
->TextOut
) {
2455 FoundTheSameTextOut
= TRUE
;
2460 StdErrTextOutList
++;
2464 ConOutTextOutList
++;
2467 if (!FoundTheSameTextOut
) {
2471 // Must make sure that current mode won't change even if mode number changes
2473 ConOutMaxMode
= mConOut
.TextOutMode
.MaxMode
;
2474 ConOutModeMap
= mConOut
.TextOutModeMap
;
2475 ConOutStepSize
= mConOut
.TextOutListCount
;
2476 ConOutQueryData
= mConOut
.TextOutQueryData
;
2478 StdErrMaxMode
= mStdErr
.TextOutMode
.MaxMode
;
2479 StdErrModeMap
= mStdErr
.TextOutModeMap
;
2480 StdErrStepSize
= mStdErr
.TextOutListCount
;
2481 StdErrQueryData
= mStdErr
.TextOutQueryData
;
2484 // Allocate the map table and set the map table's index to -1.
2486 ConOutMapTableSize
= ConOutMaxMode
* sizeof (INT32
);
2487 ConOutMapTable
= AllocateZeroPool (ConOutMapTableSize
);
2488 if (ConOutMapTable
== NULL
) {
2489 return EFI_OUT_OF_RESOURCES
;
2492 SetMem (ConOutMapTable
, ConOutMapTableSize
, 0xFF);
2494 StdErrMapTableSize
= StdErrMaxMode
* sizeof (INT32
);
2495 StdErrMapTable
= AllocateZeroPool (StdErrMapTableSize
);
2496 if (StdErrMapTable
== NULL
) {
2497 return EFI_OUT_OF_RESOURCES
;
2500 SetMem (StdErrMapTable
, StdErrMapTableSize
, 0xFF);
2503 // Find the intersection of the two set of modes. If they actually intersect, the
2504 // correponding entry in the map table is set to 1.
2507 while (Mode
< ConOutMaxMode
) {
2509 // Search the intersection map and QueryData database to see if they intersect
2512 ConOutMode
= *(ConOutModeMap
+ Mode
* ConOutStepSize
);
2513 ConOutRows
= ConOutQueryData
[ConOutMode
].Rows
;
2514 ConOutColumns
= ConOutQueryData
[ConOutMode
].Columns
;
2515 while (Index
< StdErrMaxMode
) {
2516 StdErrMode
= *(StdErrModeMap
+ Index
* StdErrStepSize
);
2517 StdErrRows
= StdErrQueryData
[StdErrMode
].Rows
;
2518 StdErrColumns
= StdErrQueryData
[StdErrMode
].Columns
;
2519 if ((StdErrRows
== ConOutRows
) && (StdErrColumns
== ConOutColumns
)) {
2520 ConOutMapTable
[Mode
] = 1;
2521 StdErrMapTable
[Index
] = 1;
2531 // Now search the TextOutModeMap table to find the intersection of supported
2532 // mode between ConSplitter and the newly added device.
2534 ConSplitterGetIntersection (
2537 mConOut
.TextOutListCount
,
2539 &(mConOut
.TextOutMode
.MaxMode
),
2540 &(mConOut
.TextOutMode
.Mode
)
2543 if (mConOut
.TextOutMode
.Mode
< 0) {
2544 mConOut
.TextOut
.SetMode (&(mConOut
.TextOut
), 0);
2547 ConSplitterGetIntersection (
2550 mStdErr
.TextOutListCount
,
2552 &(mStdErr
.TextOutMode
.MaxMode
),
2553 &(mStdErr
.TextOutMode
.Mode
)
2556 if (mStdErr
.TextOutMode
.Mode
< 0) {
2557 mStdErr
.TextOut
.SetMode (&(mStdErr
.TextOut
), 0);
2560 FreePool (ConOutMapTable
);
2561 FreePool (StdErrMapTable
);
2568 Add Grahpics Output modes into Consplitter Text Out list.
2570 @param Private Text Out Splitter pointer.
2571 @param GraphicsOutput Graphics Output protocol pointer.
2572 @param UgaDraw UGA Draw protocol pointer.
2574 @retval EFI_SUCCESS Output mode added successfully.
2575 @retval other Failed to add output mode.
2579 ConSplitterAddGraphicsOutputMode (
2580 IN TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
,
2581 IN EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
,
2582 IN EFI_UGA_DRAW_PROTOCOL
*UgaDraw
2588 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*Mode
;
2590 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*Info
;
2591 EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE
*CurrentGraphicsOutputMode
;
2592 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*ModeBuffer
;
2593 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*MatchedMode
;
2596 BOOLEAN AlreadyExist
;
2597 UINT32 UgaHorizontalResolution
;
2598 UINT32 UgaVerticalResolution
;
2599 UINT32 UgaColorDepth
;
2600 UINT32 UgaRefreshRate
;
2602 ASSERT (GraphicsOutput
!= NULL
|| UgaDraw
!= NULL
);
2604 CurrentGraphicsOutputMode
= Private
->GraphicsOutput
.Mode
;
2608 Status
= EFI_SUCCESS
;
2610 if (Private
->CurrentNumberOfUgaDraw
!= 0) {
2612 // If any UGA device has already been added, then there is no need to
2613 // calculate intersection of display mode of different GOP/UGA device,
2614 // since only one display mode will be exported (i.e. user-defined mode)
2619 if (GraphicsOutput
!= NULL
) {
2620 if (Private
->CurrentNumberOfGraphicsOutput
== 0) {
2622 // This is the first Graphics Output device added
2624 CurrentGraphicsOutputMode
->MaxMode
= GraphicsOutput
->Mode
->MaxMode
;
2625 CurrentGraphicsOutputMode
->Mode
= GraphicsOutput
->Mode
->Mode
;
2626 CopyMem (CurrentGraphicsOutputMode
->Info
, GraphicsOutput
->Mode
->Info
, GraphicsOutput
->Mode
->SizeOfInfo
);
2627 CurrentGraphicsOutputMode
->SizeOfInfo
= GraphicsOutput
->Mode
->SizeOfInfo
;
2628 CurrentGraphicsOutputMode
->FrameBufferBase
= GraphicsOutput
->Mode
->FrameBufferBase
;
2629 CurrentGraphicsOutputMode
->FrameBufferSize
= GraphicsOutput
->Mode
->FrameBufferSize
;
2632 // Allocate resource for the private mode buffer
2634 ModeBuffer
= AllocatePool (sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
) * GraphicsOutput
->Mode
->MaxMode
);
2635 if (ModeBuffer
== NULL
) {
2636 return EFI_OUT_OF_RESOURCES
;
2638 FreePool (Private
->GraphicsOutputModeBuffer
);
2639 Private
->GraphicsOutputModeBuffer
= ModeBuffer
;
2642 // Store all supported display modes to the private mode buffer
2645 for (Index
= 0; Index
< GraphicsOutput
->Mode
->MaxMode
; Index
++) {
2647 // The Info buffer would be allocated by callee
2649 Status
= GraphicsOutput
->QueryMode (GraphicsOutput
, (UINT32
) Index
, &SizeOfInfo
, &Info
);
2650 if (EFI_ERROR (Status
)) {
2653 ASSERT ( SizeOfInfo
<= sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
));
2654 CopyMem (Mode
, Info
, SizeOfInfo
);
2660 // Check intersection of display mode
2662 ModeBuffer
= AllocatePool (sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
) * CurrentGraphicsOutputMode
->MaxMode
);
2663 if (ModeBuffer
== NULL
) {
2664 return EFI_OUT_OF_RESOURCES
;
2667 MatchedMode
= ModeBuffer
;
2668 Mode
= &Private
->GraphicsOutputModeBuffer
[0];
2669 for (Index
= 0; Index
< CurrentGraphicsOutputMode
->MaxMode
; Index
++) {
2672 for (NumberIndex
= 0; NumberIndex
< GraphicsOutput
->Mode
->MaxMode
; NumberIndex
++) {
2674 // The Info buffer would be allocated by callee
2676 Status
= GraphicsOutput
->QueryMode (GraphicsOutput
, (UINT32
) NumberIndex
, &SizeOfInfo
, &Info
);
2677 if (EFI_ERROR (Status
)) {
2680 if ((Info
->HorizontalResolution
== Mode
->HorizontalResolution
) &&
2681 (Info
->VerticalResolution
== Mode
->VerticalResolution
)) {
2683 // If GOP device supports one mode in current mode buffer,
2684 // it will be added into matched mode buffer
2694 AlreadyExist
= FALSE
;
2697 // Check if GOP mode has been in the mode buffer, ModeBuffer = MatchedMode at begin.
2699 for (Info
= ModeBuffer
; Info
< MatchedMode
; Info
++) {
2700 if ((Info
->HorizontalResolution
== Mode
->HorizontalResolution
) &&
2701 (Info
->VerticalResolution
== Mode
->VerticalResolution
)) {
2702 AlreadyExist
= TRUE
;
2707 if (!AlreadyExist
) {
2708 CopyMem (MatchedMode
, Mode
, sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
));
2711 // Physical frame buffer is no longer available, change PixelFormat to PixelBltOnly
2713 MatchedMode
->Version
= 0;
2714 MatchedMode
->PixelFormat
= PixelBltOnly
;
2715 ZeroMem (&MatchedMode
->PixelInformation
, sizeof (EFI_PIXEL_BITMASK
));
2725 // Drop the old mode buffer, assign it to a new one
2727 FreePool (Private
->GraphicsOutputModeBuffer
);
2728 Private
->GraphicsOutputModeBuffer
= ModeBuffer
;
2731 // Physical frame buffer is no longer available when there are more than one physical GOP devices
2733 CurrentGraphicsOutputMode
->MaxMode
= (UINT32
) (((UINTN
) MatchedMode
- (UINTN
) ModeBuffer
) / sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
));
2734 CurrentGraphicsOutputMode
->Info
->PixelFormat
= PixelBltOnly
;
2735 ZeroMem (&CurrentGraphicsOutputMode
->Info
->PixelInformation
, sizeof (EFI_PIXEL_BITMASK
));
2736 CurrentGraphicsOutputMode
->SizeOfInfo
= sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
);
2737 CurrentGraphicsOutputMode
->FrameBufferBase
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) NULL
;
2738 CurrentGraphicsOutputMode
->FrameBufferSize
= 0;
2742 // Graphics console driver can ensure the same mode for all GOP devices
2744 for (Index
= 0; Index
< CurrentGraphicsOutputMode
->MaxMode
; Index
++) {
2745 Mode
= &Private
->GraphicsOutputModeBuffer
[Index
];
2746 if ((Mode
->HorizontalResolution
== GraphicsOutput
->Mode
->Info
->HorizontalResolution
) &&
2747 (Mode
->VerticalResolution
== GraphicsOutput
->Mode
->Info
->VerticalResolution
)) {
2748 CurrentIndex
= Index
;
2752 if (Index
>= CurrentGraphicsOutputMode
->MaxMode
) {
2754 // if user defined mode is not found, set to default mode 800x600
2756 for (Index
= 0; Index
< CurrentGraphicsOutputMode
->MaxMode
; Index
++) {
2757 Mode
= &Private
->GraphicsOutputModeBuffer
[Index
];
2758 if ((Mode
->HorizontalResolution
== 800) && (Mode
->VerticalResolution
== 600)) {
2759 CurrentIndex
= Index
;
2764 } else if (UgaDraw
!= NULL
) {
2766 // Graphics console driver can ensure the same mode for all GOP devices
2767 // so we can get the current mode from this video device
2771 &UgaHorizontalResolution
,
2772 &UgaVerticalResolution
,
2777 CurrentGraphicsOutputMode
->MaxMode
= 1;
2778 Info
= CurrentGraphicsOutputMode
->Info
;
2780 Info
->HorizontalResolution
= UgaHorizontalResolution
;
2781 Info
->VerticalResolution
= UgaVerticalResolution
;
2782 Info
->PixelFormat
= PixelBltOnly
;
2783 Info
->PixelsPerScanLine
= UgaHorizontalResolution
;
2784 CurrentGraphicsOutputMode
->SizeOfInfo
= sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
);
2785 CurrentGraphicsOutputMode
->FrameBufferBase
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) NULL
;
2786 CurrentGraphicsOutputMode
->FrameBufferSize
= 0;
2789 // Update the private mode buffer
2791 CopyMem (&Private
->GraphicsOutputModeBuffer
[0], Info
, sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
));
2794 // Only mode 0 is available to be set
2801 if (GraphicsOutput
!= NULL
) {
2802 Private
->CurrentNumberOfGraphicsOutput
++;
2804 if (UgaDraw
!= NULL
) {
2805 Private
->CurrentNumberOfUgaDraw
++;
2809 // Force GraphicsOutput mode to be set,
2812 Mode
= &Private
->GraphicsOutputModeBuffer
[CurrentIndex
];
2813 if ((GraphicsOutput
!= NULL
) &&
2814 (Mode
->HorizontalResolution
== CurrentGraphicsOutputMode
->Info
->HorizontalResolution
) &&
2815 (Mode
->VerticalResolution
== CurrentGraphicsOutputMode
->Info
->VerticalResolution
)) {
2816 CurrentGraphicsOutputMode
->Mode
= (UINT32
) CurrentIndex
;
2817 if ((Mode
->HorizontalResolution
!= GraphicsOutput
->Mode
->Info
->HorizontalResolution
) ||
2818 (Mode
->VerticalResolution
!= GraphicsOutput
->Mode
->Info
->VerticalResolution
)) {
2820 // If all existing video device has been set to common mode, only set new GOP device to
2823 for (NumberIndex
= 0; NumberIndex
< GraphicsOutput
->Mode
->MaxMode
; NumberIndex
++) {
2824 Status
= GraphicsOutput
->QueryMode (GraphicsOutput
, (UINT32
) NumberIndex
, &SizeOfInfo
, &Info
);
2825 if (EFI_ERROR (Status
)) {
2828 if ((Info
->HorizontalResolution
== Mode
->HorizontalResolution
) && (Info
->VerticalResolution
== Mode
->VerticalResolution
)) {
2834 Status
= GraphicsOutput
->SetMode (GraphicsOutput
, (UINT32
) NumberIndex
);
2838 // Current mode number may need update now, so set it to an invalid mode number
2840 CurrentGraphicsOutputMode
->Mode
= 0xffff;
2842 // Graphics console can ensure all GOP devices have the same mode which can be taken as current mode.
2844 Status
= Private
->GraphicsOutput
.SetMode (&Private
->GraphicsOutput
, (UINT32
) CurrentIndex
);
2845 if (EFI_ERROR(Status
)) {
2847 // If user defined mode is not valid for display device, set to the default mode 800x600.
2849 (Private
->GraphicsOutputModeBuffer
[0]).HorizontalResolution
= 800;
2850 (Private
->GraphicsOutputModeBuffer
[0]).VerticalResolution
= 600;
2851 Status
= Private
->GraphicsOutput
.SetMode (&Private
->GraphicsOutput
, 0);
2859 Set the current console out mode.
2861 This routine will get the current console mode information (column, row)
2862 from ConsoleOutMode variable and set it; if the variable does not exist,
2863 set to user defined console mode.
2865 @param Private Consplitter Text Out pointer.
2869 ConsplitterSetConsoleOutMode (
2870 IN TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
2880 CONSOLE_OUT_MODE ModeInfo
;
2881 CONSOLE_OUT_MODE MaxModeInfo
;
2882 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*TextOut
;
2886 TextOut
= &Private
->TextOut
;
2887 MaxMode
= (UINTN
) (TextOut
->Mode
->MaxMode
);
2889 MaxModeInfo
.Column
= 0;
2890 MaxModeInfo
.Row
= 0;
2891 ModeInfo
.Column
= PcdGet32 (PcdConOutColumn
);
2892 ModeInfo
.Row
= PcdGet32 (PcdConOutRow
);
2895 // To find the prefer mode and basic mode from Text Out mode list
2897 for (Mode
= 0; Mode
< MaxMode
; Mode
++) {
2898 Status
= TextOut
->QueryMode (TextOut
, Mode
, &Col
, &Row
);
2899 if (!EFI_ERROR(Status
)) {
2900 if ((ModeInfo
.Column
!= 0) && (ModeInfo
.Row
!= 0)) {
2902 // Use user defined column and row
2904 if (Col
== ModeInfo
.Column
&& Row
== ModeInfo
.Row
) {
2909 // If user sets PcdConOutColumn or PcdConOutRow to 0,
2910 // find and set the highest text mode.
2912 if ((Col
>= MaxModeInfo
.Column
) && (Row
>= MaxModeInfo
.Row
)) {
2913 MaxModeInfo
.Column
= Col
;
2914 MaxModeInfo
.Row
= Row
;
2918 if (Col
== 80 && Row
== 25) {
2925 // Set prefer mode to Text Out devices.
2927 Status
= TextOut
->SetMode (TextOut
, PreferMode
);
2928 if (EFI_ERROR(Status
)) {
2930 // if current mode setting is failed, default 80x25 mode will be set.
2932 Status
= TextOut
->SetMode (TextOut
, BaseMode
);
2933 ASSERT(!EFI_ERROR(Status
));
2935 PcdSet32 (PcdConOutColumn
, 80);
2936 PcdSet32 (PcdConOutRow
, 25);
2944 Add Text Output Device in Consplitter Text Output list.
2946 @param Private Text Out Splitter pointer.
2947 @param TextOut Simple Text Output protocol pointer.
2948 @param GraphicsOutput Graphics Output protocol pointer.
2949 @param UgaDraw UGA Draw protocol pointer.
2951 @retval EFI_SUCCESS Text Output Device added successfully.
2952 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
2956 ConSplitterTextOutAddDevice (
2957 IN TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
,
2958 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*TextOut
,
2959 IN EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
,
2960 IN EFI_UGA_DRAW_PROTOCOL
*UgaDraw
2964 UINTN CurrentNumOfConsoles
;
2966 UINT32 UgaHorizontalResolution
;
2967 UINT32 UgaVerticalResolution
;
2968 UINT32 UgaColorDepth
;
2969 UINT32 UgaRefreshRate
;
2970 TEXT_OUT_AND_GOP_DATA
*TextAndGop
;
2972 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*Info
;
2973 EFI_STATUS DeviceStatus
;
2975 Status
= EFI_SUCCESS
;
2976 CurrentNumOfConsoles
= Private
->CurrentNumberOfConsoles
;
2979 // If the Text Out List is full, enlarge it by calling ConSplitterGrowBuffer().
2981 while (CurrentNumOfConsoles
>= Private
->TextOutListCount
) {
2982 Status
= ConSplitterGrowBuffer (
2983 sizeof (TEXT_OUT_AND_GOP_DATA
),
2984 &Private
->TextOutListCount
,
2985 (VOID
**) &Private
->TextOutList
2987 if (EFI_ERROR (Status
)) {
2988 return EFI_OUT_OF_RESOURCES
;
2991 // Also need to reallocate the TextOutModeMap table
2993 Status
= ConSplitterGrowMapTable (Private
);
2994 if (EFI_ERROR (Status
)) {
2995 return EFI_OUT_OF_RESOURCES
;
2999 TextAndGop
= &Private
->TextOutList
[CurrentNumOfConsoles
];
3001 TextAndGop
->TextOut
= TextOut
;
3002 TextAndGop
->GraphicsOutput
= GraphicsOutput
;
3003 TextAndGop
->UgaDraw
= UgaDraw
;
3005 if (CurrentNumOfConsoles
== 0) {
3007 // Add the first device's output mode to console splitter's mode list
3009 Status
= ConSplitterAddOutputMode (Private
, TextOut
);
3011 ConSplitterSyncOutputMode (Private
, TextOut
);
3014 Private
->CurrentNumberOfConsoles
++;
3017 // Scan both TextOutList, for the intersection TextOut device
3018 // maybe both ConOut and StdErr incorporate the same Text Out
3019 // device in them, thus the output of both should be synced.
3021 ConSplitterGetIntersectionBetweenConOutAndStrErr ();
3023 MaxMode
= Private
->TextOutMode
.MaxMode
;
3024 ASSERT (MaxMode
>= 1);
3026 DeviceStatus
= EFI_DEVICE_ERROR
;
3027 Status
= EFI_DEVICE_ERROR
;
3030 // This device display mode will be added into Graphics Ouput modes.
3032 if ((GraphicsOutput
!= NULL
) || (UgaDraw
!= NULL
)) {
3033 DeviceStatus
= ConSplitterAddGraphicsOutputMode (Private
, GraphicsOutput
, UgaDraw
);
3036 if (FeaturePcdGet (PcdConOutUgaSupport
)) {
3038 // If UGA is produced by Consplitter
3040 if (GraphicsOutput
!= NULL
) {
3041 Status
= GraphicsOutput
->QueryMode (GraphicsOutput
, GraphicsOutput
->Mode
->Mode
, &SizeOfInfo
, &Info
);
3042 if (EFI_ERROR (Status
)) {
3045 ASSERT ( SizeOfInfo
<= sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
));
3047 UgaHorizontalResolution
= Info
->HorizontalResolution
;
3048 UgaVerticalResolution
= Info
->VerticalResolution
;
3052 } else if (UgaDraw
!= NULL
) {
3053 Status
= UgaDraw
->GetMode (
3055 &UgaHorizontalResolution
,
3056 &UgaVerticalResolution
,
3060 if (!EFI_ERROR (Status
) && EFI_ERROR (DeviceStatus
)) {
3062 // if GetMode is successfully and UGA device hasn't been set, set it
3064 Status
= ConSplitterUgaDrawSetMode (
3066 UgaHorizontalResolution
,
3067 UgaVerticalResolution
,
3073 // If GetMode/SetMode is failed, set to 800x600 mode
3075 if(EFI_ERROR (Status
)) {
3076 Status
= ConSplitterUgaDrawSetMode (
3087 if (((!EFI_ERROR (DeviceStatus
)) || (!EFI_ERROR (Status
))) &&
3088 ((Private
->CurrentNumberOfGraphicsOutput
+ Private
->CurrentNumberOfUgaDraw
) == 1)) {
3089 if (!FeaturePcdGet (PcdConOutGopSupport
)) {
3091 // If Graphics Outpurt protocol not supported, UGA Draw protocol is installed
3092 // on the virtual handle.
3094 Status
= gBS
->InstallMultipleProtocolInterfaces (
3095 &mConOut
.VirtualHandle
,
3096 &gEfiUgaDrawProtocolGuid
,
3100 } else if (!FeaturePcdGet (PcdConOutUgaSupport
)) {
3102 // If UGA Draw protocol not supported, Graphics Output Protocol is installed
3103 // on virtual handle.
3105 Status
= gBS
->InstallMultipleProtocolInterfaces (
3106 &mConOut
.VirtualHandle
,
3107 &gEfiGraphicsOutputProtocolGuid
,
3108 &mConOut
.GraphicsOutput
,
3113 // Boot Graphics Output protocol and UGA Draw protocol are supported,
3114 // both they will be installed on virtual handle.
3116 Status
= gBS
->InstallMultipleProtocolInterfaces (
3117 &mConOut
.VirtualHandle
,
3118 &gEfiGraphicsOutputProtocolGuid
,
3119 &mConOut
.GraphicsOutput
,
3120 &gEfiUgaDrawProtocolGuid
,
3128 // After adding new console device, all existing console devices should be
3129 // synced to the current shared mode.
3131 ConsplitterSetConsoleOutMode (Private
);
3138 Remove Text Out Device in Consplitter Text Out list.
3140 @param Private Text Out Splitter pointer.
3141 @param TextOut Simple Text Output Pointer protocol pointer.
3143 @retval EFI_SUCCESS Text Out Device removed successfully.
3144 @retval EFI_NOT_FOUND No Text Out Device found.
3148 ConSplitterTextOutDeleteDevice (
3149 IN TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
,
3150 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*TextOut
3154 UINTN CurrentNumOfConsoles
;
3155 TEXT_OUT_AND_GOP_DATA
*TextOutList
;
3159 // Remove the specified text-out device data structure from the Text out List,
3160 // and rearrange the remaining data structures in the Text out List.
3162 CurrentNumOfConsoles
= Private
->CurrentNumberOfConsoles
;
3163 Index
= (INT32
) CurrentNumOfConsoles
- 1;
3164 TextOutList
= Private
->TextOutList
;
3165 while (Index
>= 0) {
3166 if (TextOutList
->TextOut
== TextOut
) {
3167 if (TextOutList
->UgaDraw
!= NULL
) {
3168 Private
->CurrentNumberOfUgaDraw
--;
3170 if (TextOutList
->GraphicsOutput
!= NULL
) {
3171 Private
->CurrentNumberOfGraphicsOutput
--;
3173 CopyMem (TextOutList
, TextOutList
+ 1, sizeof (TEXT_OUT_AND_GOP_DATA
) * Index
);
3174 CurrentNumOfConsoles
--;
3182 // The specified TextOut is not managed by the ConSplitter driver
3185 return EFI_NOT_FOUND
;
3188 if (CurrentNumOfConsoles
== 0) {
3190 // If the number of consoles is zero, reset all parameters
3192 Private
->CurrentNumberOfConsoles
= 0;
3193 Private
->TextOutMode
.MaxMode
= 1;
3194 Private
->TextOutQueryData
[0].Columns
= 80;
3195 Private
->TextOutQueryData
[0].Rows
= 25;
3196 TextOutSetMode (Private
, 0);
3201 // Max Mode is realy an intersection of the QueryMode command to all
3202 // devices. So we must copy the QueryMode of the first device to
3206 Private
->TextOutQueryData
,
3207 Private
->TextOutQueryDataCount
* sizeof (TEXT_OUT_SPLITTER_QUERY_DATA
)
3210 FreePool (Private
->TextOutModeMap
);
3211 Private
->TextOutModeMap
= NULL
;
3212 TextOutList
= Private
->TextOutList
;
3215 // Add the first TextOut to the QueryData array and ModeMap table
3217 Status
= ConSplitterAddOutputMode (Private
, TextOutList
->TextOut
);
3220 // Now add one by one
3223 Private
->CurrentNumberOfConsoles
= 1;
3225 while ((UINTN
) Index
< CurrentNumOfConsoles
) {
3226 ConSplitterSyncOutputMode (Private
, TextOutList
->TextOut
);
3228 Private
->CurrentNumberOfConsoles
++;
3232 ConSplitterGetIntersectionBetweenConOutAndStrErr ();
3239 Reset the input device and optionaly run diagnostics
3241 @param This Protocol instance pointer.
3242 @param ExtendedVerification Driver may perform diagnostics on reset.
3244 @retval EFI_SUCCESS The device was reset.
3245 @retval EFI_DEVICE_ERROR The device is not functioning properly and could
3251 ConSplitterTextInReset (
3252 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*This
,
3253 IN BOOLEAN ExtendedVerification
3257 EFI_STATUS ReturnStatus
;
3258 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3261 Private
= TEXT_IN_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
3263 Private
->KeyEventSignalState
= FALSE
;
3266 // return the worst status met
3268 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
3269 Status
= Private
->TextInList
[Index
]->Reset (
3270 Private
->TextInList
[Index
],
3271 ExtendedVerification
3273 if (EFI_ERROR (Status
)) {
3274 ReturnStatus
= Status
;
3278 return ReturnStatus
;
3283 Reads the next keystroke from the input device. The WaitForKey Event can
3284 be used to test for existance of a keystroke via WaitForEvent () call.
3286 @param Private Protocol instance pointer.
3287 @param Key Driver may perform diagnostics on reset.
3289 @retval EFI_SUCCESS The keystroke information was returned.
3290 @retval EFI_NOT_READY There was no keystroke data availiable.
3291 @retval EFI_DEVICE_ERROR The keydtroke information was not returned due
3297 ConSplitterTextInPrivateReadKeyStroke (
3298 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
3299 OUT EFI_INPUT_KEY
*Key
3304 EFI_INPUT_KEY CurrentKey
;
3306 Key
->UnicodeChar
= 0;
3307 Key
->ScanCode
= SCAN_NULL
;
3310 // if no physical console input device exists, return EFI_NOT_READY;
3311 // if any physical console input device has key input,
3312 // return the key and EFI_SUCCESS.
3314 for (Index
= 0; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
3315 Status
= Private
->TextInList
[Index
]->ReadKeyStroke (
3316 Private
->TextInList
[Index
],
3319 if (!EFI_ERROR (Status
)) {
3325 return EFI_NOT_READY
;
3331 Reads the next keystroke from the input device. The WaitForKey Event can
3332 be used to test for existance of a keystroke via WaitForEvent () call.
3334 @param This Protocol instance pointer.
3335 @param Key Driver may perform diagnostics on reset.
3337 @retval EFI_SUCCESS The keystroke information was returned.
3338 @retval EFI_NOT_READY There was no keystroke data availiable.
3339 @retval EFI_DEVICE_ERROR The keydtroke information was not returned due
3345 ConSplitterTextInReadKeyStroke (
3346 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*This
,
3347 OUT EFI_INPUT_KEY
*Key
3350 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3352 Private
= TEXT_IN_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
3354 Private
->KeyEventSignalState
= FALSE
;
3357 // Signal ConnectConIn event on first call in Lazy ConIn mode
3359 if (!mConInIsConnect
&& PcdGetBool (PcdConInConnectOnDemand
)) {
3360 DEBUG ((EFI_D_INFO
, "Connect ConIn in first ReadKeyStoke in Lazy ConIn mode.\n"));
3361 gBS
->SignalEvent (Private
->ConnectConInEvent
);
3362 mConInIsConnect
= TRUE
;
3365 return ConSplitterTextInPrivateReadKeyStroke (Private
, Key
);
3370 This event aggregates all the events of the ConIn devices in the spliter.
3372 If any events of physical ConIn devices are signaled, signal the ConIn
3373 spliter event. This will cause the calling code to call
3374 ConSplitterTextInReadKeyStroke ().
3376 @param Event The Event assoicated with callback.
3377 @param Context Context registered when Event was created.
3382 ConSplitterTextInWaitForKey (
3388 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3391 Private
= (TEXT_IN_SPLITTER_PRIVATE_DATA
*) Context
;
3393 if (Private
->KeyEventSignalState
) {
3395 // If KeyEventSignalState is flagged before, and not cleared by Reset() or ReadKeyStroke()
3397 gBS
->SignalEvent (Event
);
3402 // If any physical console input device has key input, signal the event.
3404 for (Index
= 0; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
3405 Status
= gBS
->CheckEvent (Private
->TextInList
[Index
]->WaitForKey
);
3406 if (!EFI_ERROR (Status
)) {
3407 gBS
->SignalEvent (Event
);
3408 Private
->KeyEventSignalState
= TRUE
;
3416 Test if the key has been registered on input device.
3418 @param RegsiteredData A pointer to a buffer that is filled in with the
3419 keystroke state data for the key that was
3421 @param InputData A pointer to a buffer that is filled in with the
3422 keystroke state data for the key that was
3425 @retval TRUE Key be pressed matches a registered key.
3426 @retval FLASE Match failed.
3431 IN EFI_KEY_DATA
*RegsiteredData
,
3432 IN EFI_KEY_DATA
*InputData
3435 ASSERT (RegsiteredData
!= NULL
&& InputData
!= NULL
);
3437 if ((RegsiteredData
->Key
.ScanCode
!= InputData
->Key
.ScanCode
) ||
3438 (RegsiteredData
->Key
.UnicodeChar
!= InputData
->Key
.UnicodeChar
)) {
3443 // Assume KeyShiftState/KeyToggleState = 0 in Registered key data means these state could be ignored.
3445 if (RegsiteredData
->KeyState
.KeyShiftState
!= 0 &&
3446 RegsiteredData
->KeyState
.KeyShiftState
!= InputData
->KeyState
.KeyShiftState
) {
3449 if (RegsiteredData
->KeyState
.KeyToggleState
!= 0 &&
3450 RegsiteredData
->KeyState
.KeyToggleState
!= InputData
->KeyState
.KeyToggleState
) {
3460 Reset the input device and optionaly run diagnostics
3462 @param This Protocol instance pointer.
3463 @param ExtendedVerification Driver may perform diagnostics on reset.
3465 @retval EFI_SUCCESS The device was reset.
3466 @retval EFI_DEVICE_ERROR The device is not functioning properly and could
3472 ConSplitterTextInResetEx (
3473 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*This
,
3474 IN BOOLEAN ExtendedVerification
3478 EFI_STATUS ReturnStatus
;
3479 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3482 Private
= TEXT_IN_EX_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
3484 Private
->KeyEventSignalState
= FALSE
;
3487 // return the worst status met
3489 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfExConsoles
; Index
++) {
3490 Status
= Private
->TextInExList
[Index
]->Reset (
3491 Private
->TextInExList
[Index
],
3492 ExtendedVerification
3494 if (EFI_ERROR (Status
)) {
3495 ReturnStatus
= Status
;
3499 return ReturnStatus
;
3505 Reads the next keystroke from the input device. The WaitForKey Event can
3506 be used to test for existance of a keystroke via WaitForEvent () call.
3508 @param This Protocol instance pointer.
3509 @param KeyData A pointer to a buffer that is filled in with the
3510 keystroke state data for the key that was
3513 @retval EFI_SUCCESS The keystroke information was returned.
3514 @retval EFI_NOT_READY There was no keystroke data availiable.
3515 @retval EFI_DEVICE_ERROR The keystroke information was not returned due
3517 @retval EFI_INVALID_PARAMETER KeyData is NULL.
3522 ConSplitterTextInReadKeyStrokeEx (
3523 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*This
,
3524 OUT EFI_KEY_DATA
*KeyData
3527 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3530 EFI_KEY_DATA CurrentKeyData
;
3533 if (KeyData
== NULL
) {
3534 return EFI_INVALID_PARAMETER
;
3537 Private
= TEXT_IN_EX_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
3539 Private
->KeyEventSignalState
= FALSE
;
3541 KeyData
->Key
.UnicodeChar
= 0;
3542 KeyData
->Key
.ScanCode
= SCAN_NULL
;
3545 // Signal ConnectConIn event on first call in Lazy ConIn mode
3547 if (!mConInIsConnect
&& PcdGetBool (PcdConInConnectOnDemand
)) {
3548 DEBUG ((EFI_D_INFO
, "Connect ConIn in first ReadKeyStoke in Lazy ConIn mode.\n"));
3549 gBS
->SignalEvent (Private
->ConnectConInEvent
);
3550 mConInIsConnect
= TRUE
;
3554 // if no physical console input device exists, return EFI_NOT_READY;
3555 // if any physical console input device has key input,
3556 // return the key and EFI_SUCCESS.
3558 for (Index
= 0; Index
< Private
->CurrentNumberOfExConsoles
; Index
++) {
3559 Status
= Private
->TextInExList
[Index
]->ReadKeyStrokeEx (
3560 Private
->TextInExList
[Index
],
3563 if (!EFI_ERROR (Status
)) {
3564 CopyMem (KeyData
, &CurrentKeyData
, sizeof (CurrentKeyData
));
3569 return EFI_NOT_READY
;
3574 Set certain state for the input device.
3576 @param This Protocol instance pointer.
3577 @param KeyToggleState A pointer to the EFI_KEY_TOGGLE_STATE to set the
3578 state for the input device.
3580 @retval EFI_SUCCESS The device state was set successfully.
3581 @retval EFI_DEVICE_ERROR The device is not functioning correctly and
3582 could not have the setting adjusted.
3583 @retval EFI_UNSUPPORTED The device does not have the ability to set its
3585 @retval EFI_INVALID_PARAMETER KeyToggleState is NULL.
3590 ConSplitterTextInSetState (
3591 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*This
,
3592 IN EFI_KEY_TOGGLE_STATE
*KeyToggleState
3595 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3599 if (KeyToggleState
== NULL
) {
3600 return EFI_INVALID_PARAMETER
;
3603 Private
= TEXT_IN_EX_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
3606 // if no physical console input device exists, return EFI_SUCCESS;
3607 // otherwise return the status of setting state of physical console input device
3609 for (Index
= 0; Index
< Private
->CurrentNumberOfExConsoles
; Index
++) {
3610 Status
= Private
->TextInExList
[Index
]->SetState (
3611 Private
->TextInExList
[Index
],
3614 if (EFI_ERROR (Status
)) {
3625 Register a notification function for a particular keystroke for the input device.
3627 @param This Protocol instance pointer.
3628 @param KeyData A pointer to a buffer that is filled in with the
3629 keystroke information data for the key that was
3631 @param KeyNotificationFunction Points to the function to be called when the key
3632 sequence is typed specified by KeyData.
3633 @param NotifyHandle Points to the unique handle assigned to the
3634 registered notification.
3636 @retval EFI_SUCCESS The notification function was registered
3638 @retval EFI_OUT_OF_RESOURCES Unable to allocate resources for necesssary data
3640 @retval EFI_INVALID_PARAMETER KeyData or KeyNotificationFunction or NotifyHandle is NULL.
3645 ConSplitterTextInRegisterKeyNotify (
3646 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*This
,
3647 IN EFI_KEY_DATA
*KeyData
,
3648 IN EFI_KEY_NOTIFY_FUNCTION KeyNotificationFunction
,
3649 OUT VOID
**NotifyHandle
3652 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3655 TEXT_IN_EX_SPLITTER_NOTIFY
*NewNotify
;
3657 TEXT_IN_EX_SPLITTER_NOTIFY
*CurrentNotify
;
3660 if (KeyData
== NULL
|| NotifyHandle
== NULL
|| KeyNotificationFunction
== NULL
) {
3661 return EFI_INVALID_PARAMETER
;
3664 Private
= TEXT_IN_EX_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
3667 // Return EFI_SUCCESS if the (KeyData, NotificationFunction) is already registered.
3669 for (Link
= Private
->NotifyList
.ForwardLink
; Link
!= &Private
->NotifyList
; Link
= Link
->ForwardLink
) {
3670 CurrentNotify
= TEXT_IN_EX_SPLITTER_NOTIFY_FROM_THIS (Link
);
3671 if (IsKeyRegistered (&CurrentNotify
->KeyData
, KeyData
)) {
3672 if (CurrentNotify
->KeyNotificationFn
== KeyNotificationFunction
) {
3673 *NotifyHandle
= CurrentNotify
;
3680 // Allocate resource to save the notification function
3682 NewNotify
= (TEXT_IN_EX_SPLITTER_NOTIFY
*) AllocateZeroPool (sizeof (TEXT_IN_EX_SPLITTER_NOTIFY
));
3683 if (NewNotify
== NULL
) {
3684 return EFI_OUT_OF_RESOURCES
;
3686 NewNotify
->NotifyHandleList
= (EFI_HANDLE
*) AllocateZeroPool (sizeof (EFI_HANDLE
) * Private
->TextInExListCount
);
3687 if (NewNotify
->NotifyHandleList
== NULL
) {
3688 gBS
->FreePool (NewNotify
);
3689 return EFI_OUT_OF_RESOURCES
;
3691 NewNotify
->Signature
= TEXT_IN_EX_SPLITTER_NOTIFY_SIGNATURE
;
3692 NewNotify
->KeyNotificationFn
= KeyNotificationFunction
;
3693 CopyMem (&NewNotify
->KeyData
, KeyData
, sizeof (EFI_KEY_DATA
));
3696 // Return the wrong status of registering key notify of
3697 // physical console input device if meet problems
3699 for (Index
= 0; Index
< Private
->CurrentNumberOfExConsoles
; Index
++) {
3700 Status
= Private
->TextInExList
[Index
]->RegisterKeyNotify (
3701 Private
->TextInExList
[Index
],
3703 KeyNotificationFunction
,
3704 &NewNotify
->NotifyHandleList
[Index
]
3706 if (EFI_ERROR (Status
)) {
3708 // Un-register the key notify on all physical console input devices
3710 while (Index
-- != 0) {
3711 Private
->TextInExList
[Index
]->UnregisterKeyNotify (
3712 Private
->TextInExList
[Index
],
3713 NewNotify
->NotifyHandleList
[Index
]
3716 gBS
->FreePool (NewNotify
->NotifyHandleList
);
3717 gBS
->FreePool (NewNotify
);
3722 InsertTailList (&mConIn
.NotifyList
, &NewNotify
->NotifyEntry
);
3724 *NotifyHandle
= NewNotify
;
3732 Remove a registered notification function from a particular keystroke.
3734 @param This Protocol instance pointer.
3735 @param NotificationHandle The handle of the notification function being
3738 @retval EFI_SUCCESS The notification function was unregistered
3740 @retval EFI_INVALID_PARAMETER The NotificationHandle is invalid.
3745 ConSplitterTextInUnregisterKeyNotify (
3746 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*This
,
3747 IN VOID
*NotificationHandle
3750 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3752 TEXT_IN_EX_SPLITTER_NOTIFY
*CurrentNotify
;
3755 if (NotificationHandle
== NULL
) {
3756 return EFI_INVALID_PARAMETER
;
3759 Private
= TEXT_IN_EX_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
3761 for (Link
= Private
->NotifyList
.ForwardLink
; Link
!= &Private
->NotifyList
; Link
= Link
->ForwardLink
) {
3762 CurrentNotify
= TEXT_IN_EX_SPLITTER_NOTIFY_FROM_THIS (Link
);
3763 if (CurrentNotify
== NotificationHandle
) {
3764 for (Index
= 0; Index
< Private
->CurrentNumberOfExConsoles
; Index
++) {
3765 Private
->TextInExList
[Index
]->UnregisterKeyNotify (
3766 Private
->TextInExList
[Index
],
3767 CurrentNotify
->NotifyHandleList
[Index
]
3770 RemoveEntryList (&CurrentNotify
->NotifyEntry
);
3772 gBS
->FreePool (CurrentNotify
->NotifyHandleList
);
3773 gBS
->FreePool (CurrentNotify
);
3779 // NotificationHandle is not found in database
3781 return EFI_INVALID_PARAMETER
;
3786 Reset the input device and optionaly run diagnostics
3788 @param This Protocol instance pointer.
3789 @param ExtendedVerification Driver may perform diagnostics on reset.
3791 @retval EFI_SUCCESS The device was reset.
3792 @retval EFI_DEVICE_ERROR The device is not functioning properly and could
3798 ConSplitterSimplePointerReset (
3799 IN EFI_SIMPLE_POINTER_PROTOCOL
*This
,
3800 IN BOOLEAN ExtendedVerification
3804 EFI_STATUS ReturnStatus
;
3805 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3808 Private
= TEXT_IN_SPLITTER_PRIVATE_DATA_FROM_SIMPLE_POINTER_THIS (This
);
3810 Private
->InputEventSignalState
= FALSE
;
3812 if (Private
->CurrentNumberOfPointers
== 0) {
3816 // return the worst status met
3818 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfPointers
; Index
++) {
3819 Status
= Private
->PointerList
[Index
]->Reset (
3820 Private
->PointerList
[Index
],
3821 ExtendedVerification
3823 if (EFI_ERROR (Status
)) {
3824 ReturnStatus
= Status
;
3828 return ReturnStatus
;
3833 Reads the next keystroke from the input device. The WaitForKey Event can
3834 be used to test for existance of a keystroke via WaitForEvent () call.
3836 @param Private Protocol instance pointer.
3837 @param State The state information of simple pointer device.
3839 @retval EFI_SUCCESS The keystroke information was returned.
3840 @retval EFI_NOT_READY There was no keystroke data availiable.
3841 @retval EFI_DEVICE_ERROR The keydtroke information was not returned due
3847 ConSplitterSimplePointerPrivateGetState (
3848 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
3849 IN OUT EFI_SIMPLE_POINTER_STATE
*State
3853 EFI_STATUS ReturnStatus
;
3855 EFI_SIMPLE_POINTER_STATE CurrentState
;
3857 State
->RelativeMovementX
= 0;
3858 State
->RelativeMovementY
= 0;
3859 State
->RelativeMovementZ
= 0;
3860 State
->LeftButton
= FALSE
;
3861 State
->RightButton
= FALSE
;
3864 // if no physical console input device exists, return EFI_NOT_READY;
3865 // if any physical console input device has key input,
3866 // return the key and EFI_SUCCESS.
3868 ReturnStatus
= EFI_NOT_READY
;
3869 for (Index
= 0; Index
< Private
->CurrentNumberOfPointers
; Index
++) {
3871 Status
= Private
->PointerList
[Index
]->GetState (
3872 Private
->PointerList
[Index
],
3875 if (!EFI_ERROR (Status
)) {
3876 if (ReturnStatus
== EFI_NOT_READY
) {
3877 ReturnStatus
= EFI_SUCCESS
;
3880 if (CurrentState
.LeftButton
) {
3881 State
->LeftButton
= TRUE
;
3884 if (CurrentState
.RightButton
) {
3885 State
->RightButton
= TRUE
;
3888 if (CurrentState
.RelativeMovementX
!= 0 && Private
->PointerList
[Index
]->Mode
->ResolutionX
!= 0) {
3889 State
->RelativeMovementX
+= (CurrentState
.RelativeMovementX
* (INT32
) Private
->SimplePointerMode
.ResolutionX
) / (INT32
) Private
->PointerList
[Index
]->Mode
->ResolutionX
;
3892 if (CurrentState
.RelativeMovementY
!= 0 && Private
->PointerList
[Index
]->Mode
->ResolutionY
!= 0) {
3893 State
->RelativeMovementY
+= (CurrentState
.RelativeMovementY
* (INT32
) Private
->SimplePointerMode
.ResolutionY
) / (INT32
) Private
->PointerList
[Index
]->Mode
->ResolutionY
;
3896 if (CurrentState
.RelativeMovementZ
!= 0 && Private
->PointerList
[Index
]->Mode
->ResolutionZ
!= 0) {
3897 State
->RelativeMovementZ
+= (CurrentState
.RelativeMovementZ
* (INT32
) Private
->SimplePointerMode
.ResolutionZ
) / (INT32
) Private
->PointerList
[Index
]->Mode
->ResolutionZ
;
3899 } else if (Status
== EFI_DEVICE_ERROR
) {
3900 ReturnStatus
= EFI_DEVICE_ERROR
;
3904 return ReturnStatus
;
3909 Reads the next keystroke from the input device. The WaitForKey Event can
3910 be used to test for existance of a keystroke via WaitForEvent () call.
3912 @param This A pointer to protocol instance.
3913 @param State A pointer to state information on the pointer device
3915 @retval EFI_SUCCESS The keystroke information was returned in State.
3916 @retval EFI_NOT_READY There was no keystroke data availiable.
3917 @retval EFI_DEVICE_ERROR The keydtroke information was not returned due
3923 ConSplitterSimplePointerGetState (
3924 IN EFI_SIMPLE_POINTER_PROTOCOL
*This
,
3925 IN OUT EFI_SIMPLE_POINTER_STATE
*State
3928 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3930 Private
= TEXT_IN_SPLITTER_PRIVATE_DATA_FROM_SIMPLE_POINTER_THIS (This
);
3932 Private
->InputEventSignalState
= FALSE
;
3934 return ConSplitterSimplePointerPrivateGetState (Private
, State
);
3939 This event agregates all the events of the ConIn devices in the spliter.
3940 If any events of physical ConIn devices are signaled, signal the ConIn
3941 spliter event. This will cause the calling code to call
3942 ConSplitterTextInReadKeyStroke ().
3944 @param Event The Event assoicated with callback.
3945 @param Context Context registered when Event was created.
3950 ConSplitterSimplePointerWaitForInput (
3956 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3959 Private
= (TEXT_IN_SPLITTER_PRIVATE_DATA
*) Context
;
3962 // if InputEventSignalState is flagged before, and not cleared by Reset() or ReadKeyStroke()
3964 if (Private
->InputEventSignalState
) {
3965 gBS
->SignalEvent (Event
);
3969 // if any physical console input device has key input, signal the event.
3971 for (Index
= 0; Index
< Private
->CurrentNumberOfPointers
; Index
++) {
3972 Status
= gBS
->CheckEvent (Private
->PointerList
[Index
]->WaitForInput
);
3973 if (!EFI_ERROR (Status
)) {
3974 gBS
->SignalEvent (Event
);
3975 Private
->InputEventSignalState
= TRUE
;
3981 Resets the pointer device hardware.
3983 @param This Protocol instance pointer.
3984 @param ExtendedVerification Driver may perform diagnostics on reset.
3986 @retval EFI_SUCCESS The device was reset.
3987 @retval EFI_DEVICE_ERROR The device is not functioning correctly and
3993 ConSplitterAbsolutePointerReset (
3994 IN EFI_ABSOLUTE_POINTER_PROTOCOL
*This
,
3995 IN BOOLEAN ExtendedVerification
3999 EFI_STATUS ReturnStatus
;
4000 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
4003 Private
= TEXT_IN_SPLITTER_PRIVATE_DATA_FROM_ABSOLUTE_POINTER_THIS (This
);
4005 Private
->AbsoluteInputEventSignalState
= FALSE
;
4007 if (Private
->CurrentNumberOfAbsolutePointers
== 0) {
4011 // return the worst status met
4013 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfAbsolutePointers
; Index
++) {
4014 Status
= Private
->AbsolutePointerList
[Index
]->Reset (
4015 Private
->AbsolutePointerList
[Index
],
4016 ExtendedVerification
4018 if (EFI_ERROR (Status
)) {
4019 ReturnStatus
= Status
;
4023 return ReturnStatus
;
4028 Retrieves the current state of a pointer device.
4030 @param This Protocol instance pointer.
4031 @param State A pointer to the state information on the
4034 @retval EFI_SUCCESS The state of the pointer device was returned in
4036 @retval EFI_NOT_READY The state of the pointer device has not changed
4037 since the last call to GetState().
4038 @retval EFI_DEVICE_ERROR A device error occurred while attempting to
4039 retrieve the pointer device's current state.
4044 ConSplitterAbsolutePointerGetState (
4045 IN EFI_ABSOLUTE_POINTER_PROTOCOL
*This
,
4046 IN OUT EFI_ABSOLUTE_POINTER_STATE
*State
4049 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
4051 EFI_STATUS ReturnStatus
;
4053 EFI_ABSOLUTE_POINTER_STATE CurrentState
;
4056 Private
= TEXT_IN_SPLITTER_PRIVATE_DATA_FROM_ABSOLUTE_POINTER_THIS (This
);
4058 Private
->AbsoluteInputEventSignalState
= FALSE
;
4060 State
->CurrentX
= 0;
4061 State
->CurrentY
= 0;
4062 State
->CurrentZ
= 0;
4063 State
->ActiveButtons
= 0;
4066 // if no physical pointer device exists, return EFI_NOT_READY;
4067 // if any physical pointer device has changed state,
4068 // return the state and EFI_SUCCESS.
4070 ReturnStatus
= EFI_NOT_READY
;
4071 for (Index
= 0; Index
< Private
->CurrentNumberOfAbsolutePointers
; Index
++) {
4073 Status
= Private
->AbsolutePointerList
[Index
]->GetState (
4074 Private
->AbsolutePointerList
[Index
],
4077 if (!EFI_ERROR (Status
)) {
4078 if (ReturnStatus
== EFI_NOT_READY
) {
4079 ReturnStatus
= EFI_SUCCESS
;
4082 State
->ActiveButtons
= CurrentState
.ActiveButtons
;
4084 if (!(Private
->AbsolutePointerMode
.AbsoluteMinX
== 0 && Private
->AbsolutePointerMode
.AbsoluteMaxX
== 0)) {
4085 State
->CurrentX
= CurrentState
.CurrentX
;
4087 if (!(Private
->AbsolutePointerMode
.AbsoluteMinY
== 0 && Private
->AbsolutePointerMode
.AbsoluteMaxY
== 0)) {
4088 State
->CurrentY
= CurrentState
.CurrentY
;
4090 if (!(Private
->AbsolutePointerMode
.AbsoluteMinZ
== 0 && Private
->AbsolutePointerMode
.AbsoluteMaxZ
== 0)) {
4091 State
->CurrentZ
= CurrentState
.CurrentZ
;
4094 } else if (Status
== EFI_DEVICE_ERROR
) {
4095 ReturnStatus
= EFI_DEVICE_ERROR
;
4099 return ReturnStatus
;
4104 This event agregates all the events of the pointer devices in the splitter.
4105 If any events of physical pointer devices are signaled, signal the pointer
4106 splitter event. This will cause the calling code to call
4107 ConSplitterAbsolutePointerGetState ().
4109 @param Event The Event assoicated with callback.
4110 @param Context Context registered when Event was created.
4115 ConSplitterAbsolutePointerWaitForInput (
4121 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
4124 Private
= (TEXT_IN_SPLITTER_PRIVATE_DATA
*) Context
;
4127 // if AbsoluteInputEventSignalState is flagged before,
4128 // and not cleared by Reset() or GetState(), signal it
4130 if (Private
->AbsoluteInputEventSignalState
) {
4131 gBS
->SignalEvent (Event
);
4135 // if any physical console input device has key input, signal the event.
4137 for (Index
= 0; Index
< Private
->CurrentNumberOfAbsolutePointers
; Index
++) {
4138 Status
= gBS
->CheckEvent (Private
->AbsolutePointerList
[Index
]->WaitForInput
);
4139 if (!EFI_ERROR (Status
)) {
4140 gBS
->SignalEvent (Event
);
4141 Private
->AbsoluteInputEventSignalState
= TRUE
;
4148 Reset the text output device hardware and optionaly run diagnostics
4150 @param This Protocol instance pointer.
4151 @param ExtendedVerification Driver may perform more exhaustive verfication
4152 operation of the device during reset.
4154 @retval EFI_SUCCESS The text output device was reset.
4155 @retval EFI_DEVICE_ERROR The text output device is not functioning
4156 correctly and could not be reset.
4161 ConSplitterTextOutReset (
4162 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
4163 IN BOOLEAN ExtendedVerification
4167 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
4169 EFI_STATUS ReturnStatus
;
4171 Private
= TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
4174 // return the worst status met
4176 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
4177 Status
= Private
->TextOutList
[Index
].TextOut
->Reset (
4178 Private
->TextOutList
[Index
].TextOut
,
4179 ExtendedVerification
4181 if (EFI_ERROR (Status
)) {
4182 ReturnStatus
= Status
;
4186 This
->SetAttribute (This
, EFI_TEXT_ATTR (This
->Mode
->Attribute
& 0x0F, EFI_BLACK
));
4189 // reset all mode parameters
4191 TextOutSetMode (Private
, 0);
4193 return ReturnStatus
;
4198 Write a Unicode string to the output device.
4200 @param This Protocol instance pointer.
4201 @param WString The NULL-terminated Unicode string to be
4202 displayed on the output device(s). All output
4203 devices must also support the Unicode drawing
4204 defined in this file.
4206 @retval EFI_SUCCESS The string was output to the device.
4207 @retval EFI_DEVICE_ERROR The device reported an error while attempting to
4209 @retval EFI_UNSUPPORTED The output device's mode is not currently in a
4211 @retval EFI_WARN_UNKNOWN_GLYPH This warning code indicates that some of the
4212 characters in the Unicode string could not be
4213 rendered and were skipped.
4218 ConSplitterTextOutOutputString (
4219 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
4224 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
4226 EFI_STATUS ReturnStatus
;
4230 This
->SetAttribute (This
, This
->Mode
->Attribute
);
4232 Private
= TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
4235 // return the worst status met
4237 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
4238 Status
= Private
->TextOutList
[Index
].TextOut
->OutputString (
4239 Private
->TextOutList
[Index
].TextOut
,
4242 if (EFI_ERROR (Status
)) {
4243 ReturnStatus
= Status
;
4247 if (Private
->CurrentNumberOfConsoles
> 0) {
4248 Private
->TextOutMode
.CursorColumn
= Private
->TextOutList
[0].TextOut
->Mode
->CursorColumn
;
4249 Private
->TextOutMode
.CursorRow
= Private
->TextOutList
[0].TextOut
->Mode
->CursorRow
;
4252 // When there is no real console devices in system,
4253 // update cursor position for the virtual device in consplitter.
4255 Private
->TextOut
.QueryMode (
4257 Private
->TextOutMode
.Mode
,
4261 for (; *WString
!= CHAR_NULL
; WString
++) {
4263 case CHAR_BACKSPACE
:
4264 if (Private
->TextOutMode
.CursorColumn
== 0 && Private
->TextOutMode
.CursorRow
> 0) {
4265 Private
->TextOutMode
.CursorRow
--;
4266 Private
->TextOutMode
.CursorColumn
= (INT32
) (MaxColumn
- 1);
4267 } else if (Private
->TextOutMode
.CursorColumn
> 0) {
4268 Private
->TextOutMode
.CursorColumn
--;
4273 if (Private
->TextOutMode
.CursorRow
< (INT32
) (MaxRow
- 1)) {
4274 Private
->TextOutMode
.CursorRow
++;
4278 case CHAR_CARRIAGE_RETURN
:
4279 Private
->TextOutMode
.CursorColumn
= 0;
4283 if (Private
->TextOutMode
.CursorColumn
< (INT32
) (MaxColumn
- 1)) {
4284 Private
->TextOutMode
.CursorColumn
++;
4286 Private
->TextOutMode
.CursorColumn
= 0;
4287 if (Private
->TextOutMode
.CursorRow
< (INT32
) (MaxRow
- 1)) {
4288 Private
->TextOutMode
.CursorRow
++;
4296 return ReturnStatus
;
4301 Verifies that all characters in a Unicode string can be output to the
4304 @param This Protocol instance pointer.
4305 @param WString The NULL-terminated Unicode string to be
4306 examined for the output device(s).
4308 @retval EFI_SUCCESS The device(s) are capable of rendering the
4310 @retval EFI_UNSUPPORTED Some of the characters in the Unicode string
4311 cannot be rendered by one or more of the output
4312 devices mapped by the EFI handle.
4317 ConSplitterTextOutTestString (
4318 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
4323 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
4325 EFI_STATUS ReturnStatus
;
4327 Private
= TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
4330 // return the worst status met
4332 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
4333 Status
= Private
->TextOutList
[Index
].TextOut
->TestString (
4334 Private
->TextOutList
[Index
].TextOut
,
4337 if (EFI_ERROR (Status
)) {
4338 ReturnStatus
= Status
;
4342 // There is no DevNullTextOutTestString () since a Unicode buffer would
4343 // always return EFI_SUCCESS.
4344 // ReturnStatus will be EFI_SUCCESS if no consoles are present
4346 return ReturnStatus
;
4351 Returns information for an available text mode that the output device(s)
4354 @param This Protocol instance pointer.
4355 @param ModeNumber The mode number to return information on.
4356 @param Columns Returns the columns of the text output device
4357 for the requested ModeNumber.
4358 @param Rows Returns the rows of the text output device
4359 for the requested ModeNumber.
4361 @retval EFI_SUCCESS The requested mode information was returned.
4362 @retval EFI_DEVICE_ERROR The device had an error and could not complete
4364 @retval EFI_UNSUPPORTED The mode number was not valid.
4369 ConSplitterTextOutQueryMode (
4370 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
4371 IN UINTN ModeNumber
,
4376 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
4378 INT32
*TextOutModeMap
;
4380 Private
= TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
4383 // Check whether param ModeNumber is valid.
4384 // ModeNumber should be within range 0 ~ MaxMode - 1.
4386 if ( (ModeNumber
> (UINTN
)(((UINT32
)-1)>>1)) ) {
4387 return EFI_UNSUPPORTED
;
4390 if ((INT32
) ModeNumber
>= This
->Mode
->MaxMode
) {
4391 return EFI_UNSUPPORTED
;
4395 // We get the available mode from mode intersection map if it's available
4397 if (Private
->TextOutModeMap
!= NULL
) {
4398 TextOutModeMap
= Private
->TextOutModeMap
+ Private
->TextOutListCount
* ModeNumber
;
4399 CurrentMode
= (UINTN
)(*TextOutModeMap
);
4400 *Columns
= Private
->TextOutQueryData
[CurrentMode
].Columns
;
4401 *Rows
= Private
->TextOutQueryData
[CurrentMode
].Rows
;
4403 *Columns
= Private
->TextOutQueryData
[ModeNumber
].Columns
;
4404 *Rows
= Private
->TextOutQueryData
[ModeNumber
].Rows
;
4407 if (*Columns
<= 0 && *Rows
<= 0) {
4408 return EFI_UNSUPPORTED
;
4417 Sets the output device(s) to a specified mode.
4419 @param This Protocol instance pointer.
4420 @param ModeNumber The mode number to set.
4422 @retval EFI_SUCCESS The requested text mode was set.
4423 @retval EFI_DEVICE_ERROR The device had an error and could not complete
4425 @retval EFI_UNSUPPORTED The mode number was not valid.
4430 ConSplitterTextOutSetMode (
4431 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
4436 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
4438 INT32
*TextOutModeMap
;
4439 EFI_STATUS ReturnStatus
;
4441 Private
= TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
4444 // Check whether param ModeNumber is valid.
4445 // ModeNumber should be within range 0 ~ MaxMode - 1.
4447 if ( (ModeNumber
> (UINTN
)(((UINT32
)-1)>>1)) ) {
4448 return EFI_UNSUPPORTED
;
4451 if ((INT32
) ModeNumber
>= This
->Mode
->MaxMode
) {
4452 return EFI_UNSUPPORTED
;
4455 // If the mode is being set to the curent mode, then just clear the screen and return.
4457 if (Private
->TextOutMode
.Mode
== (INT32
) ModeNumber
) {
4458 return ConSplitterTextOutClearScreen (This
);
4461 // return the worst status met
4463 TextOutModeMap
= Private
->TextOutModeMap
+ Private
->TextOutListCount
* ModeNumber
;
4464 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
4465 Status
= Private
->TextOutList
[Index
].TextOut
->SetMode (
4466 Private
->TextOutList
[Index
].TextOut
,
4467 TextOutModeMap
[Index
]
4469 if (EFI_ERROR (Status
)) {
4470 ReturnStatus
= Status
;
4475 // Set mode parameter to specified mode number
4477 TextOutSetMode (Private
, ModeNumber
);
4479 return ReturnStatus
;
4484 Sets the background and foreground colors for the OutputString () and
4485 ClearScreen () functions.
4487 @param This Protocol instance pointer.
4488 @param Attribute The attribute to set. Bits 0..3 are the
4489 foreground color, and bits 4..6 are the
4490 background color. All other bits are undefined
4491 and must be zero. The valid Attributes are
4492 defined in this file.
4494 @retval EFI_SUCCESS The attribute was set.
4495 @retval EFI_DEVICE_ERROR The device had an error and could not complete
4497 @retval EFI_UNSUPPORTED The attribute requested is not defined.
4502 ConSplitterTextOutSetAttribute (
4503 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
4508 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
4510 EFI_STATUS ReturnStatus
;
4512 Private
= TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
4515 // Check whether param Attribute is valid.
4517 if ( (Attribute
> (UINTN
)(((UINT32
)-1)>>1)) ) {
4518 return EFI_UNSUPPORTED
;
4522 // return the worst status met
4524 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
4525 Status
= Private
->TextOutList
[Index
].TextOut
->SetAttribute (
4526 Private
->TextOutList
[Index
].TextOut
,
4529 if (EFI_ERROR (Status
)) {
4530 ReturnStatus
= Status
;
4534 Private
->TextOutMode
.Attribute
= (INT32
) Attribute
;
4536 return ReturnStatus
;
4541 Clears the output device(s) display to the currently selected background
4544 @param This Protocol instance pointer.
4546 @retval EFI_SUCCESS The operation completed successfully.
4547 @retval EFI_DEVICE_ERROR The device had an error and could not complete
4549 @retval EFI_UNSUPPORTED The output device is not in a valid text mode.
4554 ConSplitterTextOutClearScreen (
4555 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
4559 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
4561 EFI_STATUS ReturnStatus
;
4563 Private
= TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
4566 // return the worst status met
4568 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
4569 Status
= Private
->TextOutList
[Index
].TextOut
->ClearScreen (Private
->TextOutList
[Index
].TextOut
);
4570 if (EFI_ERROR (Status
)) {
4571 ReturnStatus
= Status
;
4576 // No need to do extra check here as whether (Column, Row) is valid has
4577 // been checked in ConSplitterTextOutSetCursorPosition. And (0, 0) should
4578 // always be supported.
4580 Private
->TextOutMode
.CursorColumn
= 0;
4581 Private
->TextOutMode
.CursorRow
= 0;
4582 Private
->TextOutMode
.CursorVisible
= TRUE
;
4584 return ReturnStatus
;
4589 Sets the current coordinates of the cursor position
4591 @param This Protocol instance pointer.
4592 @param Column The column position to set the cursor to. Must be
4593 greater than or equal to zero and less than the
4594 number of columns by QueryMode ().
4595 @param Row The row position to set the cursor to. Must be
4596 greater than or equal to zero and less than the
4597 number of rows by QueryMode ().
4599 @retval EFI_SUCCESS The operation completed successfully.
4600 @retval EFI_DEVICE_ERROR The device had an error and could not complete
4602 @retval EFI_UNSUPPORTED The output device is not in a valid text mode,
4603 or the cursor position is invalid for the
4609 ConSplitterTextOutSetCursorPosition (
4610 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
4616 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
4618 EFI_STATUS ReturnStatus
;
4621 INT32
*TextOutModeMap
;
4625 Private
= TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
4626 TextOutModeMap
= NULL
;
4627 ModeNumber
= Private
->TextOutMode
.Mode
;
4630 // Get current MaxColumn and MaxRow from intersection map
4632 if (Private
->TextOutModeMap
!= NULL
) {
4633 TextOutModeMap
= Private
->TextOutModeMap
+ Private
->TextOutListCount
* ModeNumber
;
4634 CurrentMode
= *TextOutModeMap
;
4636 CurrentMode
= ModeNumber
;
4639 MaxColumn
= Private
->TextOutQueryData
[CurrentMode
].Columns
;
4640 MaxRow
= Private
->TextOutQueryData
[CurrentMode
].Rows
;
4642 if (Column
>= MaxColumn
|| Row
>= MaxRow
) {
4643 return EFI_UNSUPPORTED
;
4646 // return the worst status met
4648 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
4649 Status
= Private
->TextOutList
[Index
].TextOut
->SetCursorPosition (
4650 Private
->TextOutList
[Index
].TextOut
,
4654 if (EFI_ERROR (Status
)) {
4655 ReturnStatus
= Status
;
4660 // No need to do extra check here as whether (Column, Row) is valid has
4661 // been checked in ConSplitterTextOutSetCursorPosition. And (0, 0) should
4662 // always be supported.
4664 Private
->TextOutMode
.CursorColumn
= (INT32
) Column
;
4665 Private
->TextOutMode
.CursorRow
= (INT32
) Row
;
4667 return ReturnStatus
;
4672 Makes the cursor visible or invisible
4674 @param This Protocol instance pointer.
4675 @param Visible If TRUE, the cursor is set to be visible. If
4676 FALSE, the cursor is set to be invisible.
4678 @retval EFI_SUCCESS The operation completed successfully.
4679 @retval EFI_DEVICE_ERROR The device had an error and could not complete
4680 the request, or the device does not support
4681 changing the cursor mode.
4682 @retval EFI_UNSUPPORTED The output device is not in a valid text mode.
4687 ConSplitterTextOutEnableCursor (
4688 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
4693 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
4695 EFI_STATUS ReturnStatus
;
4697 Private
= TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
4700 // return the worst status met
4702 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
4703 Status
= Private
->TextOutList
[Index
].TextOut
->EnableCursor (
4704 Private
->TextOutList
[Index
].TextOut
,
4707 if (EFI_ERROR (Status
)) {
4708 ReturnStatus
= Status
;
4712 Private
->TextOutMode
.CursorVisible
= Visible
;
4714 return ReturnStatus
;
4719 An empty function to pass error checking of CreateEventEx ().
4721 @param Event Event whose notification function is being invoked.
4722 @param Context Pointer to the notification function's context,
4723 which is implementation-dependent.
4728 ConSplitterEmptyCallbackFunction (