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 - 2009, Intel Corporation. <BR>
20 All rights reserved. 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 // Text In Splitter Private Data template
35 GLOBAL_REMOVE_IF_UNREFERENCED TEXT_IN_SPLITTER_PRIVATE_DATA mConIn
= {
36 TEXT_IN_SPLITTER_PRIVATE_DATA_SIGNATURE
,
40 ConSplitterTextInReset
,
41 ConSplitterTextInReadKeyStroke
,
45 (EFI_SIMPLE_TEXT_INPUT_PROTOCOL
**) NULL
,
49 ConSplitterTextInResetEx
,
50 ConSplitterTextInReadKeyStrokeEx
,
52 ConSplitterTextInSetState
,
53 ConSplitterTextInRegisterKeyNotify
,
54 ConSplitterTextInUnregisterKeyNotify
57 (EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
**) NULL
,
65 ConSplitterSimplePointerReset
,
66 ConSplitterSimplePointerGetState
,
68 (EFI_SIMPLE_POINTER_MODE
*) NULL
78 (EFI_SIMPLE_POINTER_PROTOCOL
**) NULL
,
82 ConSplitterAbsolutePointerReset
,
83 ConSplitterAbsolutePointerGetState
,
85 (EFI_ABSOLUTE_POINTER_MODE
*) NULL
91 0x10000, // AbsoluteMaxX
92 0x10000, // AbsoluteMaxY
93 0x10000, // AbsoluteMaxZ
97 (EFI_ABSOLUTE_POINTER_PROTOCOL
**) NULL
,
107 // Uga Draw Protocol Private Data template
109 GLOBAL_REMOVE_IF_UNREFERENCED EFI_UGA_DRAW_PROTOCOL mUgaDrawProtocolTemplate
= {
110 ConSpliterUgaDrawGetMode
,
111 ConSpliterUgaDrawSetMode
,
116 // Graphics Output Protocol Private Data template
118 GLOBAL_REMOVE_IF_UNREFERENCED EFI_GRAPHICS_OUTPUT_PROTOCOL mGraphicsOutputProtocolTemplate
= {
119 ConSpliterGraphicsOutputQueryMode
,
120 ConSpliterGraphicsOutputSetMode
,
121 ConSpliterGraphicsOutputBlt
,
127 // Text Out Splitter Private Data template
129 GLOBAL_REMOVE_IF_UNREFERENCED TEXT_OUT_SPLITTER_PRIVATE_DATA mConOut
= {
130 TEXT_OUT_SPLITTER_PRIVATE_DATA_SIGNATURE
,
133 ConSplitterTextOutReset
,
134 ConSplitterTextOutOutputString
,
135 ConSplitterTextOutTestString
,
136 ConSplitterTextOutQueryMode
,
137 ConSplitterTextOutSetMode
,
138 ConSplitterTextOutSetAttribute
,
139 ConSplitterTextOutClearScreen
,
140 ConSplitterTextOutSetCursorPosition
,
141 ConSplitterTextOutEnableCursor
,
142 (EFI_SIMPLE_TEXT_OUTPUT_MODE
*) NULL
169 (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*) NULL
,
175 (TEXT_OUT_AND_GOP_DATA
*) NULL
,
177 (TEXT_OUT_SPLITTER_QUERY_DATA
*) NULL
,
183 // Standard Error Text Out Splitter Data Template
185 GLOBAL_REMOVE_IF_UNREFERENCED TEXT_OUT_SPLITTER_PRIVATE_DATA mStdErr
= {
186 TEXT_OUT_SPLITTER_PRIVATE_DATA_SIGNATURE
,
189 ConSplitterTextOutReset
,
190 ConSplitterTextOutOutputString
,
191 ConSplitterTextOutTestString
,
192 ConSplitterTextOutQueryMode
,
193 ConSplitterTextOutSetMode
,
194 ConSplitterTextOutSetAttribute
,
195 ConSplitterTextOutClearScreen
,
196 ConSplitterTextOutSetCursorPosition
,
197 ConSplitterTextOutEnableCursor
,
198 (EFI_SIMPLE_TEXT_OUTPUT_MODE
*) NULL
225 (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*) NULL
,
231 (TEXT_OUT_AND_GOP_DATA
*) NULL
,
233 (TEXT_OUT_SPLITTER_QUERY_DATA
*) NULL
,
239 // Driver binding instance for Console Input Device
241 EFI_DRIVER_BINDING_PROTOCOL gConSplitterConInDriverBinding
= {
242 ConSplitterConInDriverBindingSupported
,
243 ConSplitterConInDriverBindingStart
,
244 ConSplitterConInDriverBindingStop
,
251 // Driver binding instance for Console Out device
253 EFI_DRIVER_BINDING_PROTOCOL gConSplitterConOutDriverBinding
= {
254 ConSplitterConOutDriverBindingSupported
,
255 ConSplitterConOutDriverBindingStart
,
256 ConSplitterConOutDriverBindingStop
,
263 // Driver binding instance for Standard Error device
265 EFI_DRIVER_BINDING_PROTOCOL gConSplitterStdErrDriverBinding
= {
266 ConSplitterStdErrDriverBindingSupported
,
267 ConSplitterStdErrDriverBindingStart
,
268 ConSplitterStdErrDriverBindingStop
,
275 // Driver binding instance for Simple Pointer protocol
277 EFI_DRIVER_BINDING_PROTOCOL gConSplitterSimplePointerDriverBinding
= {
278 ConSplitterSimplePointerDriverBindingSupported
,
279 ConSplitterSimplePointerDriverBindingStart
,
280 ConSplitterSimplePointerDriverBindingStop
,
287 // Driver binding instance for Absolute Pointer protocol
289 EFI_DRIVER_BINDING_PROTOCOL gConSplitterAbsolutePointerDriverBinding
= {
290 ConSplitterAbsolutePointerDriverBindingSupported
,
291 ConSplitterAbsolutePointerDriverBindingStart
,
292 ConSplitterAbsolutePointerDriverBindingStop
,
299 The Entry Point for module ConSplitter. The user code starts with this function.
301 Installs driver module protocols and. Creates virtual device handles for ConIn,
302 ConOut, and StdErr. Installs Simple Text In protocol, Simple Text In Ex protocol,
303 Simple Pointer protocol, Absolute Pointer protocol on those virtual handlers.
304 Installs Graphics Output protocol and/or UGA Draw protocol if needed.
306 @param[in] ImageHandle The firmware allocated handle for the EFI image.
307 @param[in] SystemTable A pointer to the EFI System Table.
309 @retval EFI_SUCCESS The entry point is executed successfully.
310 @retval other Some error occurs when executing this entry point.
315 ConSplitterDriverEntry(
316 IN EFI_HANDLE ImageHandle
,
317 IN EFI_SYSTEM_TABLE
*SystemTable
323 // Install driver model protocol(s).
325 Status
= EfiLibInstallDriverBindingComponentName2 (
328 &gConSplitterConInDriverBinding
,
330 &gConSplitterConInComponentName
,
331 &gConSplitterConInComponentName2
333 ASSERT_EFI_ERROR (Status
);
335 Status
= EfiLibInstallDriverBindingComponentName2 (
338 &gConSplitterSimplePointerDriverBinding
,
340 &gConSplitterSimplePointerComponentName
,
341 &gConSplitterSimplePointerComponentName2
343 ASSERT_EFI_ERROR (Status
);
345 Status
= EfiLibInstallDriverBindingComponentName2 (
348 &gConSplitterAbsolutePointerDriverBinding
,
350 &gConSplitterAbsolutePointerComponentName
,
351 &gConSplitterAbsolutePointerComponentName2
353 ASSERT_EFI_ERROR (Status
);
355 Status
= EfiLibInstallDriverBindingComponentName2 (
358 &gConSplitterConOutDriverBinding
,
360 &gConSplitterConOutComponentName
,
361 &gConSplitterConOutComponentName2
363 ASSERT_EFI_ERROR (Status
);
365 Status
= EfiLibInstallDriverBindingComponentName2 (
368 &gConSplitterStdErrDriverBinding
,
370 &gConSplitterStdErrComponentName
,
371 &gConSplitterStdErrComponentName2
373 ASSERT_EFI_ERROR (Status
);
376 // Either Graphics Output protocol or UGA Draw protocol must be supported.
378 ASSERT (FeaturePcdGet (PcdConOutGopSupport
) ||
379 FeaturePcdGet (PcdConOutUgaSupport
));
382 // The driver creates virtual handles for ConIn, ConOut.
383 // The virtual handles will always exist even if no console exist in the
384 // system. This is need to support hotplug devices like USB.
387 // Create virtual device handle for ConIn Splitter
389 Status
= ConSplitterTextInConstructor (&mConIn
);
390 if (!EFI_ERROR (Status
)) {
391 Status
= gBS
->InstallMultipleProtocolInterfaces (
392 &mConIn
.VirtualHandle
,
393 &gEfiSimpleTextInProtocolGuid
,
395 &gEfiSimpleTextInputExProtocolGuid
,
397 &gEfiSimplePointerProtocolGuid
,
398 &mConIn
.SimplePointer
,
399 &gEfiAbsolutePointerProtocolGuid
,
400 &mConIn
.AbsolutePointer
,
403 if (!EFI_ERROR (Status
)) {
405 // Update the EFI System Table with new virtual console
406 // and update the pointer to Simple Text Input protocol.
408 gST
->ConsoleInHandle
= mConIn
.VirtualHandle
;
409 gST
->ConIn
= &mConIn
.TextIn
;
413 // Create virtual device handle for ConOut Splitter
415 Status
= ConSplitterTextOutConstructor (&mConOut
);
416 if (!EFI_ERROR (Status
)) {
417 if (!FeaturePcdGet (PcdConOutGopSupport
)) {
419 // If Graphics Outpurt protocol not supported, UGA Draw protocol is installed
420 // on the virtual handle.
422 Status
= gBS
->InstallMultipleProtocolInterfaces (
423 &mConOut
.VirtualHandle
,
424 &gEfiSimpleTextOutProtocolGuid
,
426 &gEfiUgaDrawProtocolGuid
,
430 } else if (!FeaturePcdGet (PcdConOutUgaSupport
)) {
432 // If UGA Draw protocol not supported, Graphics Output Protocol is installed
433 // on virtual handle.
435 Status
= gBS
->InstallMultipleProtocolInterfaces (
436 &mConOut
.VirtualHandle
,
437 &gEfiSimpleTextOutProtocolGuid
,
439 &gEfiGraphicsOutputProtocolGuid
,
440 &mConOut
.GraphicsOutput
,
445 // Boot Graphics Output protocol and UGA Draw protocol are supported,
446 // both they will be installed on virtual handle.
448 Status
= gBS
->InstallMultipleProtocolInterfaces (
449 &mConOut
.VirtualHandle
,
450 &gEfiSimpleTextOutProtocolGuid
,
452 &gEfiGraphicsOutputProtocolGuid
,
453 &mConOut
.GraphicsOutput
,
454 &gEfiUgaDrawProtocolGuid
,
460 if (!EFI_ERROR (Status
)) {
462 // Update the EFI System Table with new virtual console
463 // and Update the pointer to Text Output protocol.
465 gST
->ConsoleOutHandle
= mConOut
.VirtualHandle
;
466 gST
->ConOut
= &mConOut
.TextOut
;
471 // Update the CRC32 in the EFI System Table header
474 gBS
->CalculateCrc32 (
485 Construct console input devices' private data.
487 @param ConInPrivate A pointer to the TEXT_IN_SPLITTER_PRIVATE_DATA
490 @retval EFI_OUT_OF_RESOURCES Out of resources.
491 @retval EFI_SUCCESS Text Input Devcie's private data has been constructed.
492 @retval other Failed to construct private data.
496 ConSplitterTextInConstructor (
497 TEXT_IN_SPLITTER_PRIVATE_DATA
*ConInPrivate
503 // Allocate buffer for Simple Text Input device
505 Status
= ConSplitterGrowBuffer (
506 sizeof (EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*),
507 &ConInPrivate
->TextInListCount
,
508 (VOID
**) &ConInPrivate
->TextInList
510 if (EFI_ERROR (Status
)) {
511 return EFI_OUT_OF_RESOURCES
;
515 // Create Event to wait for a key
517 Status
= gBS
->CreateEvent (
520 ConSplitterTextInWaitForKey
,
522 &ConInPrivate
->TextIn
.WaitForKey
524 ASSERT_EFI_ERROR (Status
);
527 // Allocate buffer for Simple Text Input Ex device
529 Status
= ConSplitterGrowBuffer (
530 sizeof (EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*),
531 &ConInPrivate
->TextInExListCount
,
532 (VOID
**) &ConInPrivate
->TextInExList
534 if (EFI_ERROR (Status
)) {
535 return EFI_OUT_OF_RESOURCES
;
538 // Create Event to wait for a key Ex
540 Status
= gBS
->CreateEvent (
543 ConSplitterTextInWaitForKey
,
545 &ConInPrivate
->TextInEx
.WaitForKeyEx
547 ASSERT_EFI_ERROR (Status
);
549 InitializeListHead (&ConInPrivate
->NotifyList
);
551 ConInPrivate
->AbsolutePointer
.Mode
= &ConInPrivate
->AbsolutePointerMode
;
553 // Allocate buffer for Absolute Pointer device
555 Status
= ConSplitterGrowBuffer (
556 sizeof (EFI_ABSOLUTE_POINTER_PROTOCOL
*),
557 &ConInPrivate
->AbsolutePointerListCount
,
558 (VOID
**) &ConInPrivate
->AbsolutePointerList
560 if (EFI_ERROR (Status
)) {
561 return EFI_OUT_OF_RESOURCES
;
564 // Create Event to wait for device input for Absolute pointer device
566 Status
= gBS
->CreateEvent (
569 ConSplitterAbsolutePointerWaitForInput
,
571 &ConInPrivate
->AbsolutePointer
.WaitForInput
573 ASSERT_EFI_ERROR (Status
);
575 ConInPrivate
->SimplePointer
.Mode
= &ConInPrivate
->SimplePointerMode
;
577 // Allocate buffer for Simple Pointer device
579 Status
= ConSplitterGrowBuffer (
580 sizeof (EFI_SIMPLE_POINTER_PROTOCOL
*),
581 &ConInPrivate
->PointerListCount
,
582 (VOID
**) &ConInPrivate
->PointerList
584 if (EFI_ERROR (Status
)) {
585 return EFI_OUT_OF_RESOURCES
;
588 // Create Event to wait for device input for Simple pointer device
590 Status
= gBS
->CreateEvent (
593 ConSplitterSimplePointerWaitForInput
,
595 &ConInPrivate
->SimplePointer
.WaitForInput
602 Construct console output devices' private data.
604 @param ConOutPrivate A pointer to the TEXT_OUT_SPLITTER_PRIVATE_DATA
607 @retval EFI_OUT_OF_RESOURCES Out of resources.
608 @retval EFI_SUCCESS Text Input Devcie's private data has been constructed.
612 ConSplitterTextOutConstructor (
613 TEXT_OUT_SPLITTER_PRIVATE_DATA
*ConOutPrivate
617 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*Info
;
620 // Copy protocols template
622 if (FeaturePcdGet (PcdConOutUgaSupport
)) {
623 CopyMem (&ConOutPrivate
->UgaDraw
, &mUgaDrawProtocolTemplate
, sizeof (EFI_UGA_DRAW_PROTOCOL
));
625 if (FeaturePcdGet (PcdConOutGopSupport
)) {
626 CopyMem (&ConOutPrivate
->GraphicsOutput
, &mGraphicsOutputProtocolTemplate
, sizeof (EFI_GRAPHICS_OUTPUT_PROTOCOL
));
630 // Initilize console output splitter's private data.
632 ConOutPrivate
->TextOut
.Mode
= &ConOutPrivate
->TextOutMode
;
635 // When new console device is added, the new mode will be set later,
636 // so put current mode back to init state.
638 ConOutPrivate
->TextOutMode
.Mode
= 0xFF;
640 // Allocate buffer for Console Out device
642 Status
= ConSplitterGrowBuffer (
643 sizeof (TEXT_OUT_AND_GOP_DATA
),
644 &ConOutPrivate
->TextOutListCount
,
645 (VOID
**) &ConOutPrivate
->TextOutList
647 if (EFI_ERROR (Status
)) {
648 return EFI_OUT_OF_RESOURCES
;
651 // Allocate buffer for Text Out query data
653 Status
= ConSplitterGrowBuffer (
654 sizeof (TEXT_OUT_SPLITTER_QUERY_DATA
),
655 &ConOutPrivate
->TextOutQueryDataCount
,
656 (VOID
**) &ConOutPrivate
->TextOutQueryData
658 if (EFI_ERROR (Status
)) {
659 return EFI_OUT_OF_RESOURCES
;
663 // Setup the default console to 80 x 25 and mode to 0
665 ConOutPrivate
->TextOutQueryData
[0].Columns
= 80;
666 ConOutPrivate
->TextOutQueryData
[0].Rows
= 25;
667 TextOutSetMode (ConOutPrivate
, 0);
670 if (FeaturePcdGet (PcdConOutUgaSupport
)) {
672 // Setup the UgaDraw to 800 x 600 x 32 bits per pixel, 60Hz.
674 ConSpliterUgaDrawSetMode (&ConOutPrivate
->UgaDraw
, 800, 600, 32, 60);
676 if (FeaturePcdGet (PcdConOutGopSupport
)) {
678 // Setup resource for mode information in Graphics Output Protocol interface
680 if ((ConOutPrivate
->GraphicsOutput
.Mode
= AllocateZeroPool (sizeof (EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE
))) == NULL
) {
681 return EFI_OUT_OF_RESOURCES
;
683 if ((ConOutPrivate
->GraphicsOutput
.Mode
->Info
= AllocateZeroPool (sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
))) == NULL
) {
684 return EFI_OUT_OF_RESOURCES
;
687 // Setup the DevNullGraphicsOutput to 800 x 600 x 32 bits per pixel
688 // DevNull will be updated to user-defined mode after driver has started.
690 if ((ConOutPrivate
->GraphicsOutputModeBuffer
= AllocateZeroPool (sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
))) == NULL
) {
691 return EFI_OUT_OF_RESOURCES
;
693 Info
= &ConOutPrivate
->GraphicsOutputModeBuffer
[0];
695 Info
->HorizontalResolution
= 800;
696 Info
->VerticalResolution
= 600;
697 Info
->PixelFormat
= PixelBltOnly
;
698 Info
->PixelsPerScanLine
= 800;
699 CopyMem (ConOutPrivate
->GraphicsOutput
.Mode
->Info
, Info
, sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
));
700 ConOutPrivate
->GraphicsOutput
.Mode
->SizeOfInfo
= sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
);
703 // Initialize the following items, theset items remain unchanged in GraphicsOutput->SetMode()
704 // GraphicsOutputMode->FrameBufferBase, GraphicsOutputMode->FrameBufferSize
706 ConOutPrivate
->GraphicsOutput
.Mode
->FrameBufferBase
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) NULL
;
707 ConOutPrivate
->GraphicsOutput
.Mode
->FrameBufferSize
= 0;
709 ConOutPrivate
->GraphicsOutput
.Mode
->MaxMode
= 1;
711 // Initial current mode to unknown state, and then set to mode 0
713 ConOutPrivate
->GraphicsOutput
.Mode
->Mode
= 0xffff;
714 ConOutPrivate
->GraphicsOutput
.SetMode (&ConOutPrivate
->GraphicsOutput
, 0);
722 Test to see if the specified protocol could be supported on the specified device.
724 @param This Driver Binding protocol pointer.
725 @param ControllerHandle Handle of device to test.
726 @param Guid The specified protocol.
728 @retval EFI_SUCCESS The specified protocol is supported on this device.
729 @retval EFI_UNSUPPORTED The specified protocol attempts to be installed on virtul handle.
730 @retval other Failed to open specified protocol on this device.
734 ConSplitterSupported (
735 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
736 IN EFI_HANDLE ControllerHandle
,
744 // Make sure the Console Splitter does not attempt to attach to itself
746 if (ControllerHandle
== mConIn
.VirtualHandle
||
747 ControllerHandle
== mConOut
.VirtualHandle
||
748 ControllerHandle
== mStdErr
.VirtualHandle
750 return EFI_UNSUPPORTED
;
754 // Check to see whether the specific protocol could be opened BY_DRIVER
756 Status
= gBS
->OpenProtocol (
760 This
->DriverBindingHandle
,
762 EFI_OPEN_PROTOCOL_BY_DRIVER
765 if (EFI_ERROR (Status
)) {
772 This
->DriverBindingHandle
,
780 Test to see if Console In Device could be supported on the Controller.
782 @param This Driver Binding protocol instance pointer.
783 @param ControllerHandle Handle of device to test.
784 @param RemainingDevicePath Optional parameter use to pick a specific child
787 @retval EFI_SUCCESS This driver supports this device.
788 @retval other This driver does not support this device.
793 ConSplitterConInDriverBindingSupported (
794 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
795 IN EFI_HANDLE ControllerHandle
,
796 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
799 return ConSplitterSupported (
802 &gEfiConsoleInDeviceGuid
807 Test to see if Simple Pointer protocol could be supported on the Controller.
809 @param This Driver Binding protocol instance pointer.
810 @param ControllerHandle Handle of device to test.
811 @param RemainingDevicePath Optional parameter use to pick a specific child
814 @retval EFI_SUCCESS This driver supports this device.
815 @retval other This driver does not support this device.
820 ConSplitterSimplePointerDriverBindingSupported (
821 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
822 IN EFI_HANDLE ControllerHandle
,
823 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
826 return ConSplitterSupported (
829 &gEfiSimplePointerProtocolGuid
834 Test to see if Absolute Pointer protocol could be supported on the Controller.
836 @param This Driver Binding protocol instance pointer.
837 @param ControllerHandle Handle of device to test.
838 @param RemainingDevicePath Optional parameter use to pick a specific child
841 @retval EFI_SUCCESS This driver supports this device.
842 @retval other This driver does not support this device.
847 ConSplitterAbsolutePointerDriverBindingSupported (
848 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
849 IN EFI_HANDLE ControllerHandle
,
850 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
853 return ConSplitterSupported (
856 &gEfiAbsolutePointerProtocolGuid
862 Test to see if Console Out Device could be supported on the Controller.
864 @param This Driver Binding protocol instance pointer.
865 @param ControllerHandle Handle of device to test.
866 @param RemainingDevicePath Optional parameter use to pick a specific child
869 @retval EFI_SUCCESS This driver supports this device.
870 @retval other This driver does not support this device.
875 ConSplitterConOutDriverBindingSupported (
876 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
877 IN EFI_HANDLE ControllerHandle
,
878 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
881 return ConSplitterSupported (
884 &gEfiConsoleOutDeviceGuid
889 Test to see if Standard Error Device could be supported on the Controller.
891 @param This Driver Binding protocol instance pointer.
892 @param ControllerHandle Handle of device to test.
893 @param RemainingDevicePath Optional parameter use to pick a specific child
896 @retval EFI_SUCCESS This driver supports this device.
897 @retval other This driver does not support this device.
902 ConSplitterStdErrDriverBindingSupported (
903 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
904 IN EFI_HANDLE ControllerHandle
,
905 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
908 return ConSplitterSupported (
911 &gEfiStandardErrorDeviceGuid
917 Start ConSplitter on devcie handle by opening Console Device Guid on device handle
918 and the console virtual handle. And Get the console interface on controller handle.
920 @param This Driver Binding protocol instance pointer.
921 @param ControllerHandle Handle of device.
922 @param ConSplitterVirtualHandle Console virtual Handle.
923 @param DeviceGuid The specified Console Device, such as ConInDev,
925 @param InterfaceGuid The specified protocol to be opened.
926 @param Interface Protocol interface returned.
928 @retval EFI_SUCCESS This driver supports this device.
929 @retval other Failed to open the specified Console Device Guid
930 or specified protocol.
935 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
936 IN EFI_HANDLE ControllerHandle
,
937 IN EFI_HANDLE ConSplitterVirtualHandle
,
938 IN EFI_GUID
*DeviceGuid
,
939 IN EFI_GUID
*InterfaceGuid
,
947 // Check to see whether the ControllerHandle has the DeviceGuid on it.
949 Status
= gBS
->OpenProtocol (
953 This
->DriverBindingHandle
,
955 EFI_OPEN_PROTOCOL_BY_DRIVER
957 if (EFI_ERROR (Status
)) {
962 // Create virtual handle and open DeviceGuid on the virtul handle.
964 Status
= gBS
->OpenProtocol (
968 This
->DriverBindingHandle
,
969 ConSplitterVirtualHandle
,
970 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
972 if (EFI_ERROR (Status
)) {
977 // Open InterfaceGuid on the virtul handle.
979 Status
= gBS
->OpenProtocol (
983 This
->DriverBindingHandle
,
984 ConSplitterVirtualHandle
,
985 EFI_OPEN_PROTOCOL_GET_PROTOCOL
988 if (!EFI_ERROR (Status
)) {
993 // close the DeviceGuid on ConSplitter VirtualHandle.
998 This
->DriverBindingHandle
,
999 ConSplitterVirtualHandle
1004 // close the DeviceGuid on ControllerHandle.
1006 gBS
->CloseProtocol (
1009 This
->DriverBindingHandle
,
1018 Start Console In Consplitter on device handle.
1020 @param This Driver Binding protocol instance pointer.
1021 @param ControllerHandle Handle of device to bind driver to.
1022 @param RemainingDevicePath Optional parameter use to pick a specific child
1025 @retval EFI_SUCCESS Console In Consplitter is added to ControllerHandle.
1026 @retval other Console In Consplitter does not support this device.
1031 ConSplitterConInDriverBindingStart (
1032 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1033 IN EFI_HANDLE ControllerHandle
,
1034 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
1038 EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*TextIn
;
1039 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*TextInEx
;
1042 // Start ConSplitter on ControllerHandle, and create the virtual
1043 // agrogated console device on first call Start for a SimpleTextIn handle.
1045 Status
= ConSplitterStart (
1048 mConIn
.VirtualHandle
,
1049 &gEfiConsoleInDeviceGuid
,
1050 &gEfiSimpleTextInProtocolGuid
,
1053 if (EFI_ERROR (Status
)) {
1058 // Add this device into Text In devices list.
1060 Status
= ConSplitterTextInAddDevice (&mConIn
, TextIn
);
1061 if (EFI_ERROR (Status
)) {
1065 Status
= gBS
->OpenProtocol (
1067 &gEfiSimpleTextInputExProtocolGuid
,
1068 (VOID
**) &TextInEx
,
1069 This
->DriverBindingHandle
,
1070 mConIn
.VirtualHandle
,
1071 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1073 if (!EFI_ERROR (Status
)) {
1075 // If Simple Text Input Ex protocol exists,
1076 // add this device into Text In Ex devices list.
1078 Status
= ConSplitterTextInExAddDevice (&mConIn
, TextInEx
);
1086 Start Simple Pointer Consplitter on device handle.
1088 @param This Driver Binding protocol instance pointer.
1089 @param ControllerHandle Handle of device to bind driver to.
1090 @param RemainingDevicePath Optional parameter use to pick a specific child
1093 @retval EFI_SUCCESS Simple Pointer Consplitter is added to ControllerHandle.
1094 @retval other Simple Pointer Consplitter does not support this device.
1099 ConSplitterSimplePointerDriverBindingStart (
1100 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1101 IN EFI_HANDLE ControllerHandle
,
1102 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
1106 EFI_SIMPLE_POINTER_PROTOCOL
*SimplePointer
;
1109 // Start ConSplitter on ControllerHandle, and create the virtual
1110 // agrogated console device on first call Start for a SimplePointer handle.
1112 Status
= ConSplitterStart (
1115 mConIn
.VirtualHandle
,
1116 &gEfiSimplePointerProtocolGuid
,
1117 &gEfiSimplePointerProtocolGuid
,
1118 (VOID
**) &SimplePointer
1120 if (EFI_ERROR (Status
)) {
1125 // Add this devcie into Simple Pointer devices list.
1127 return ConSplitterSimplePointerAddDevice (&mConIn
, SimplePointer
);
1132 Start Absolute Pointer Consplitter on device handle.
1134 @param This Driver Binding protocol instance pointer.
1135 @param ControllerHandle Handle of device to bind driver to.
1136 @param RemainingDevicePath Optional parameter use to pick a specific child
1139 @retval EFI_SUCCESS Absolute Pointer Consplitter is added to ControllerHandle.
1140 @retval other Absolute Pointer Consplitter does not support this device.
1145 ConSplitterAbsolutePointerDriverBindingStart (
1146 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1147 IN EFI_HANDLE ControllerHandle
,
1148 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
1152 EFI_ABSOLUTE_POINTER_PROTOCOL
*AbsolutePointer
;
1155 // Start ConSplitter on ControllerHandle, and create the virtual
1156 // agrogated console device on first call Start for a AbsolutePointer handle.
1158 Status
= ConSplitterStart (
1161 mConIn
.VirtualHandle
,
1162 &gEfiAbsolutePointerProtocolGuid
,
1163 &gEfiAbsolutePointerProtocolGuid
,
1164 (VOID
**) &AbsolutePointer
1167 if (EFI_ERROR (Status
)) {
1172 // Add this devcie into Absolute Pointer devices list.
1174 return ConSplitterAbsolutePointerAddDevice (&mConIn
, AbsolutePointer
);
1179 Start Console Out Consplitter on device handle.
1181 @param This Driver Binding protocol instance pointer.
1182 @param ControllerHandle Handle of device to bind driver to.
1183 @param RemainingDevicePath Optional parameter use to pick a specific child
1186 @retval EFI_SUCCESS Console Out Consplitter is added to ControllerHandle.
1187 @retval other Console Out Consplitter does not support this device.
1192 ConSplitterConOutDriverBindingStart (
1193 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1194 IN EFI_HANDLE ControllerHandle
,
1195 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
1199 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*TextOut
;
1200 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
1201 EFI_UGA_DRAW_PROTOCOL
*UgaDraw
;
1203 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*Info
;
1206 // Start ConSplitter on ControllerHandle, and create the virtual
1207 // agrogated console device on first call Start for a ConsoleOut handle.
1209 Status
= ConSplitterStart (
1212 mConOut
.VirtualHandle
,
1213 &gEfiConsoleOutDeviceGuid
,
1214 &gEfiSimpleTextOutProtocolGuid
,
1217 if (EFI_ERROR (Status
)) {
1221 GraphicsOutput
= NULL
;
1224 // Try to Open Graphics Output protocol
1226 Status
= gBS
->OpenProtocol (
1228 &gEfiGraphicsOutputProtocolGuid
,
1229 (VOID
**) &GraphicsOutput
,
1230 This
->DriverBindingHandle
,
1231 mConOut
.VirtualHandle
,
1232 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1235 if (EFI_ERROR (Status
) && FeaturePcdGet (PcdUgaConsumeSupport
)) {
1237 // Open UGA DRAW protocol
1241 &gEfiUgaDrawProtocolGuid
,
1243 This
->DriverBindingHandle
,
1244 mConOut
.VirtualHandle
,
1245 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1250 // When new console device is added, the new mode will be set later,
1251 // so put current mode back to init state.
1253 mConOut
.TextOutMode
.Mode
= 0xFF;
1256 // If both ConOut and StdErr incorporate the same Text Out device,
1257 // their MaxMode and QueryData should be the intersection of both.
1259 Status
= ConSplitterTextOutAddDevice (&mConOut
, TextOut
, GraphicsOutput
, UgaDraw
);
1260 ConSplitterTextOutSetAttribute (&mConOut
.TextOut
, EFI_TEXT_ATTR (EFI_LIGHTGRAY
, EFI_BLACK
));
1262 if (FeaturePcdGet (PcdConOutUgaSupport
)) {
1264 // Get the UGA mode data of ConOut from the current mode
1266 if (GraphicsOutput
!= NULL
) {
1267 Status
= GraphicsOutput
->QueryMode (GraphicsOutput
, GraphicsOutput
->Mode
->Mode
, &SizeOfInfo
, &Info
);
1268 if (EFI_ERROR (Status
)) {
1271 ASSERT ( SizeOfInfo
<= sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
));
1273 mConOut
.UgaHorizontalResolution
= Info
->HorizontalResolution
;
1274 mConOut
.UgaVerticalResolution
= Info
->VerticalResolution
;
1275 mConOut
.UgaColorDepth
= 32;
1276 mConOut
.UgaRefreshRate
= 60;
1280 } else if (UgaDraw
!= NULL
&& FeaturePcdGet (PcdUgaConsumeSupport
)) {
1281 Status
= UgaDraw
->GetMode (
1283 &mConOut
.UgaHorizontalResolution
,
1284 &mConOut
.UgaVerticalResolution
,
1285 &mConOut
.UgaColorDepth
,
1286 &mConOut
.UgaRefreshRate
1296 Start Standard Error Consplitter on device handle.
1298 @param This Driver Binding protocol instance pointer.
1299 @param ControllerHandle Handle of device to bind driver to.
1300 @param RemainingDevicePath Optional parameter use to pick a specific child
1303 @retval EFI_SUCCESS Standard Error Consplitter is added to ControllerHandle.
1304 @retval other Standard Error Consplitter does not support this device.
1309 ConSplitterStdErrDriverBindingStart (
1310 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1311 IN EFI_HANDLE ControllerHandle
,
1312 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
1316 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*TextOut
;
1318 if (mStdErr
.CurrentNumberOfConsoles
== 0) {
1320 // Create virtual device handle for StdErr Splitter
1322 Status
= ConSplitterTextOutConstructor (&mStdErr
);
1323 if (!EFI_ERROR (Status
)) {
1324 Status
= gBS
->InstallMultipleProtocolInterfaces (
1325 &mStdErr
.VirtualHandle
,
1326 &gEfiSimpleTextOutProtocolGuid
,
1332 if (EFI_ERROR (Status
)) {
1338 // Start ConSplitter on ControllerHandle, and create the virtual
1339 // agrogated console device on first call Start for a StandardError handle.
1341 Status
= ConSplitterStart (
1344 mStdErr
.VirtualHandle
,
1345 &gEfiStandardErrorDeviceGuid
,
1346 &gEfiSimpleTextOutProtocolGuid
,
1349 if (EFI_ERROR (Status
)) {
1354 // When new console device is added, the new mode will be set later,
1355 // so put current mode back to init state.
1357 mStdErr
.TextOutMode
.Mode
= 0xFF;
1360 // If both ConOut and StdErr incorporate the same Text Out device,
1361 // their MaxMode and QueryData should be the intersection of both.
1363 Status
= ConSplitterTextOutAddDevice (&mStdErr
, TextOut
, NULL
, NULL
);
1364 ConSplitterTextOutSetAttribute (&mStdErr
.TextOut
, EFI_TEXT_ATTR (EFI_MAGENTA
, EFI_BLACK
));
1365 if (EFI_ERROR (Status
)) {
1369 if (mStdErr
.CurrentNumberOfConsoles
== 1) {
1371 // Create virtual device handle for StdErr Splitter
1373 Status
= ConSplitterTextOutConstructor (&mStdErr
);
1374 if (!EFI_ERROR (Status
)) {
1375 Status
= gBS
->InstallMultipleProtocolInterfaces (
1376 &mStdErr
.VirtualHandle
,
1377 &gEfiSimpleTextOutProtocolGuid
,
1383 gST
->StandardErrorHandle
= mStdErr
.VirtualHandle
;
1384 gST
->StdErr
= &mStdErr
.TextOut
;
1386 // Update the CRC32 in the EFI System Table header
1389 gBS
->CalculateCrc32 (
1390 (UINT8
*) &gST
->Hdr
,
1391 gST
->Hdr
.HeaderSize
,
1401 Stop ConSplitter on device handle by closing Console Device Guid on device handle
1402 and the console virtual handle.
1404 @param This Protocol instance pointer.
1405 @param ControllerHandle Handle of device.
1406 @param ConSplitterVirtualHandle Console virtual Handle.
1407 @param DeviceGuid The specified Console Device, such as ConInDev,
1409 @param InterfaceGuid The specified protocol to be opened.
1410 @param Interface Protocol interface returned.
1412 @retval EFI_SUCCESS Stop ConSplitter on ControllerHandle successfully.
1413 @retval other Failed to Stop ConSplitter on ControllerHandle.
1418 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1419 IN EFI_HANDLE ControllerHandle
,
1420 IN EFI_HANDLE ConSplitterVirtualHandle
,
1421 IN EFI_GUID
*DeviceGuid
,
1422 IN EFI_GUID
*InterfaceGuid
,
1428 Status
= gBS
->OpenProtocol (
1432 This
->DriverBindingHandle
,
1434 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1436 if (EFI_ERROR (Status
)) {
1440 // close the protocol refered.
1442 gBS
->CloseProtocol (
1445 This
->DriverBindingHandle
,
1446 ConSplitterVirtualHandle
1449 gBS
->CloseProtocol (
1452 This
->DriverBindingHandle
,
1461 Stop Console In ConSplitter on ControllerHandle by closing Console In Devcice GUID.
1463 @param This Driver Binding protocol instance pointer.
1464 @param ControllerHandle Handle of device to stop driver on
1465 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
1466 children is zero stop the entire bus driver.
1467 @param ChildHandleBuffer List of Child Handles to Stop.
1469 @retval EFI_SUCCESS This driver is removed ControllerHandle
1470 @retval other This driver was not removed from this device
1475 ConSplitterConInDriverBindingStop (
1476 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1477 IN EFI_HANDLE ControllerHandle
,
1478 IN UINTN NumberOfChildren
,
1479 IN EFI_HANDLE
*ChildHandleBuffer
1483 EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*TextIn
;
1484 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*TextInEx
;
1486 if (NumberOfChildren
== 0) {
1490 Status
= gBS
->OpenProtocol (
1492 &gEfiSimpleTextInputExProtocolGuid
,
1493 (VOID
**) &TextInEx
,
1494 This
->DriverBindingHandle
,
1496 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1498 if (!EFI_ERROR (Status
)) {
1500 // If Simple Text Input Ex protocol exists,
1501 // remove device from Text Input Ex devices list.
1503 Status
= ConSplitterTextInExDeleteDevice (&mConIn
, TextInEx
);
1504 if (EFI_ERROR (Status
)) {
1510 // Close Simple Text In protocol on controller handle and virtual handle.
1512 Status
= ConSplitterStop (
1515 mConIn
.VirtualHandle
,
1516 &gEfiConsoleInDeviceGuid
,
1517 &gEfiSimpleTextInProtocolGuid
,
1520 if (EFI_ERROR (Status
)) {
1525 // Remove device from Text Input devices list.
1527 return ConSplitterTextInDeleteDevice (&mConIn
, TextIn
);
1532 Stop Simple Pointer protocol ConSplitter on ControllerHandle by closing
1533 Simple Pointer protocol.
1535 @param This Driver Binding protocol instance pointer.
1536 @param ControllerHandle Handle of device to stop driver on
1537 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
1538 children is zero stop the entire bus driver.
1539 @param ChildHandleBuffer List of Child Handles to Stop.
1541 @retval EFI_SUCCESS This driver is removed ControllerHandle
1542 @retval other This driver was not removed from this device
1547 ConSplitterSimplePointerDriverBindingStop (
1548 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1549 IN EFI_HANDLE ControllerHandle
,
1550 IN UINTN NumberOfChildren
,
1551 IN EFI_HANDLE
*ChildHandleBuffer
1555 EFI_SIMPLE_POINTER_PROTOCOL
*SimplePointer
;
1557 if (NumberOfChildren
== 0) {
1562 // Close Simple Pointer protocol on controller handle and virtual handle.
1564 Status
= ConSplitterStop (
1567 mConIn
.VirtualHandle
,
1568 &gEfiSimplePointerProtocolGuid
,
1569 &gEfiSimplePointerProtocolGuid
,
1570 (VOID
**) &SimplePointer
1572 if (EFI_ERROR (Status
)) {
1577 // Remove this device from Simple Pointer device list.
1579 return ConSplitterSimplePointerDeleteDevice (&mConIn
, SimplePointer
);
1584 Stop Absolute Pointer protocol ConSplitter on ControllerHandle by closing
1585 Absolute Pointer protocol.
1587 @param This Driver Binding protocol instance pointer.
1588 @param ControllerHandle Handle of device to stop driver on
1589 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
1590 children is zero stop the entire bus driver.
1591 @param ChildHandleBuffer List of Child Handles to Stop.
1593 @retval EFI_SUCCESS This driver is removed ControllerHandle
1594 @retval other This driver was not removed from this device
1599 ConSplitterAbsolutePointerDriverBindingStop (
1600 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1601 IN EFI_HANDLE ControllerHandle
,
1602 IN UINTN NumberOfChildren
,
1603 IN EFI_HANDLE
*ChildHandleBuffer
1607 EFI_ABSOLUTE_POINTER_PROTOCOL
*AbsolutePointer
;
1609 if (NumberOfChildren
== 0) {
1614 // Close Absolute Pointer protocol on controller handle and virtual handle.
1616 Status
= ConSplitterStop (
1619 mConIn
.VirtualHandle
,
1620 &gEfiAbsolutePointerProtocolGuid
,
1621 &gEfiAbsolutePointerProtocolGuid
,
1622 (VOID
**) &AbsolutePointer
1624 if (EFI_ERROR (Status
)) {
1629 // Remove this device from Absolute Pointer device list.
1631 return ConSplitterAbsolutePointerDeleteDevice (&mConIn
, AbsolutePointer
);
1636 Stop Console Out ConSplitter on device handle by closing Console Out Devcice GUID.
1638 @param This Driver Binding protocol instance pointer.
1639 @param ControllerHandle Handle of device to stop driver on
1640 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
1641 children is zero stop the entire bus driver.
1642 @param ChildHandleBuffer List of Child Handles to Stop.
1644 @retval EFI_SUCCESS This driver is removed ControllerHandle
1645 @retval other This driver was not removed from this device
1650 ConSplitterConOutDriverBindingStop (
1651 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1652 IN EFI_HANDLE ControllerHandle
,
1653 IN UINTN NumberOfChildren
,
1654 IN EFI_HANDLE
*ChildHandleBuffer
1658 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*TextOut
;
1660 if (NumberOfChildren
== 0) {
1665 // Close Absolute Pointer protocol on controller handle and virtual handle.
1667 Status
= ConSplitterStop (
1670 mConOut
.VirtualHandle
,
1671 &gEfiConsoleOutDeviceGuid
,
1672 &gEfiSimpleTextOutProtocolGuid
,
1675 if (EFI_ERROR (Status
)) {
1680 // Remove this device from Text Out device list.
1682 return ConSplitterTextOutDeleteDevice (&mConOut
, TextOut
);
1687 Stop Standard Error ConSplitter on ControllerHandle by closing Standard Error GUID.
1689 @param This Driver Binding protocol instance pointer.
1690 @param ControllerHandle Handle of device to stop driver on
1691 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
1692 children is zero stop the entire bus driver.
1693 @param ChildHandleBuffer List of Child Handles to Stop.
1695 @retval EFI_SUCCESS This driver is removed ControllerHandle
1696 @retval other This driver was not removed from this device
1701 ConSplitterStdErrDriverBindingStop (
1702 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1703 IN EFI_HANDLE ControllerHandle
,
1704 IN UINTN NumberOfChildren
,
1705 IN EFI_HANDLE
*ChildHandleBuffer
1709 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*TextOut
;
1711 if (NumberOfChildren
== 0) {
1716 // Close Standard Error Device on controller handle and virtual handle.
1718 Status
= ConSplitterStop (
1721 mStdErr
.VirtualHandle
,
1722 &gEfiStandardErrorDeviceGuid
,
1723 &gEfiSimpleTextOutProtocolGuid
,
1726 if (EFI_ERROR (Status
)) {
1730 // Delete this console error out device's data structures.
1732 Status
= ConSplitterTextOutDeleteDevice (&mStdErr
, TextOut
);
1733 if (EFI_ERROR (Status
)) {
1737 if (mStdErr
.CurrentNumberOfConsoles
== 0) {
1738 gST
->StandardErrorHandle
= NULL
;
1741 // Update the CRC32 in the EFI System Table header
1744 gBS
->CalculateCrc32 (
1745 (UINT8
*) &gST
->Hdr
,
1746 gST
->Hdr
.HeaderSize
,
1751 // Uninstall Simple Text Output protocol from StdErr Handle.
1753 gBS
->UninstallMultipleProtocolInterfaces (
1754 mStdErr
.VirtualHandle
,
1755 &gEfiSimpleTextOutProtocolGuid
,
1766 Take the passed in Buffer of size SizeOfCount and grow the buffer
1767 by MAX (CONSOLE_SPLITTER_CONSOLES_ALLOC_UNIT, MaxGrow) * SizeOfCount
1768 bytes. Copy the current data in Buffer to the new version of Buffer
1769 and free the old version of buffer.
1771 @param SizeOfCount Size of element in array.
1772 @param Count Current number of elements in array.
1773 @param Buffer Bigger version of passed in Buffer with all the
1776 @retval EFI_SUCCESS Buffer size has grown.
1777 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
1781 ConSplitterGrowBuffer (
1782 IN UINTN SizeOfCount
,
1784 IN OUT VOID
**Buffer
1790 // grow the buffer to new buffer size,
1791 // copy the old buffer's content to the new-size buffer,
1792 // then free the old buffer.
1794 *Count
+= CONSOLE_SPLITTER_CONSOLES_ALLOC_UNIT
;
1795 Ptr
= ReallocatePool (
1796 SizeOfCount
* ((*Count
) - CONSOLE_SPLITTER_CONSOLES_ALLOC_UNIT
),
1797 SizeOfCount
* (*Count
),
1801 return EFI_OUT_OF_RESOURCES
;
1809 Add Text Input Device in Consplitter Text Input list.
1811 @param Private Text In Splitter pointer.
1812 @param TextIn Simple Text Input protocol pointer.
1814 @retval EFI_SUCCESS Text Input Device added successfully.
1815 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
1819 ConSplitterTextInAddDevice (
1820 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
1821 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*TextIn
1827 // If the Text In List is full, enlarge it by calling ConSplitterGrowBuffer().
1829 if (Private
->CurrentNumberOfConsoles
>= Private
->TextInListCount
) {
1830 Status
= ConSplitterGrowBuffer (
1831 sizeof (EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*),
1832 &Private
->TextInListCount
,
1833 (VOID
**) &Private
->TextInList
1835 if (EFI_ERROR (Status
)) {
1836 return EFI_OUT_OF_RESOURCES
;
1840 // Add the new text-in device data structure into the Text In List.
1842 Private
->TextInList
[Private
->CurrentNumberOfConsoles
] = TextIn
;
1843 Private
->CurrentNumberOfConsoles
++;
1846 // Extra CheckEvent added to reduce the double CheckEvent().
1848 gBS
->CheckEvent (TextIn
->WaitForKey
);
1855 Remove Text Input Device from Consplitter Text Input list.
1857 @param Private Text In Splitter pointer.
1858 @param TextIn Simple Text protocol pointer.
1860 @retval EFI_SUCCESS Simple Text Device removed successfully.
1861 @retval EFI_NOT_FOUND No Simple Text Device found.
1865 ConSplitterTextInDeleteDevice (
1866 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
1867 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*TextIn
1872 // Remove the specified text-in device data structure from the Text In List,
1873 // and rearrange the remaining data structures in the Text In List.
1875 for (Index
= 0; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
1876 if (Private
->TextInList
[Index
] == TextIn
) {
1877 for (Index
= Index
; Index
< Private
->CurrentNumberOfConsoles
- 1; Index
++) {
1878 Private
->TextInList
[Index
] = Private
->TextInList
[Index
+ 1];
1881 Private
->CurrentNumberOfConsoles
--;
1886 return EFI_NOT_FOUND
;
1890 Add Text Input Ex Device in Consplitter Text Input Ex list.
1892 @param Private Text In Splitter pointer.
1893 @param TextInEx Simple Text Input Ex Input protocol pointer.
1895 @retval EFI_SUCCESS Text Input Ex Device added successfully.
1896 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
1900 ConSplitterTextInExAddDevice (
1901 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
1902 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*TextInEx
1908 // If the Text Input Ex List is full, enlarge it by calling ConSplitterGrowBuffer().
1910 if (Private
->CurrentNumberOfExConsoles
>= Private
->TextInExListCount
) {
1911 Status
= ConSplitterGrowBuffer (
1912 sizeof (EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*),
1913 &Private
->TextInExListCount
,
1914 (VOID
**) &Private
->TextInExList
1916 if (EFI_ERROR (Status
)) {
1917 return EFI_OUT_OF_RESOURCES
;
1921 // Add the new text-in device data structure into the Text Input Ex List.
1923 Private
->TextInExList
[Private
->CurrentNumberOfExConsoles
] = TextInEx
;
1924 Private
->CurrentNumberOfExConsoles
++;
1927 // Extra CheckEvent added to reduce the double CheckEvent().
1929 gBS
->CheckEvent (TextInEx
->WaitForKeyEx
);
1935 Remove Text Ex Device from Consplitter Text Input Ex list.
1937 @param Private Text In Splitter pointer.
1938 @param TextInEx Simple Text Ex protocol pointer.
1940 @retval EFI_SUCCESS Simple Text Input Ex Device removed successfully.
1941 @retval EFI_NOT_FOUND No Simple Text Input Ex Device found.
1945 ConSplitterTextInExDeleteDevice (
1946 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
1947 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*TextInEx
1952 // Remove the specified text-in device data structure from the Text Input Ex List,
1953 // and rearrange the remaining data structures in the Text In List.
1955 for (Index
= 0; Index
< Private
->CurrentNumberOfExConsoles
; Index
++) {
1956 if (Private
->TextInExList
[Index
] == TextInEx
) {
1957 for (Index
= Index
; Index
< Private
->CurrentNumberOfExConsoles
- 1; Index
++) {
1958 Private
->TextInExList
[Index
] = Private
->TextInExList
[Index
+ 1];
1961 Private
->CurrentNumberOfExConsoles
--;
1966 return EFI_NOT_FOUND
;
1971 Add Simple Pointer Device in Consplitter Simple Pointer list.
1973 @param Private Text In Splitter pointer.
1974 @param SimplePointer Simple Pointer protocol pointer.
1976 @retval EFI_SUCCESS Simple Pointer Device added successfully.
1977 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
1981 ConSplitterSimplePointerAddDevice (
1982 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
1983 IN EFI_SIMPLE_POINTER_PROTOCOL
*SimplePointer
1989 // If the Simple Pointer List is full, enlarge it by calling ConSplitterGrowBuffer().
1991 if (Private
->CurrentNumberOfPointers
>= Private
->PointerListCount
) {
1992 Status
= ConSplitterGrowBuffer (
1993 sizeof (EFI_SIMPLE_POINTER_PROTOCOL
*),
1994 &Private
->PointerListCount
,
1995 (VOID
**) &Private
->PointerList
1997 if (EFI_ERROR (Status
)) {
1998 return EFI_OUT_OF_RESOURCES
;
2002 // Add the new text-in device data structure into the Simple Pointer List.
2004 Private
->PointerList
[Private
->CurrentNumberOfPointers
] = SimplePointer
;
2005 Private
->CurrentNumberOfPointers
++;
2012 Remove Simple Pointer Device from Consplitter Simple Pointer list.
2014 @param Private Text In Splitter pointer.
2015 @param SimplePointer Simple Pointer protocol pointer.
2017 @retval EFI_SUCCESS Simple Pointer Device removed successfully.
2018 @retval EFI_NOT_FOUND No Simple Pointer Device found.
2022 ConSplitterSimplePointerDeleteDevice (
2023 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
2024 IN EFI_SIMPLE_POINTER_PROTOCOL
*SimplePointer
2029 // Remove the specified text-in device data structure from the Simple Pointer List,
2030 // and rearrange the remaining data structures in the Text In List.
2032 for (Index
= 0; Index
< Private
->CurrentNumberOfPointers
; Index
++) {
2033 if (Private
->PointerList
[Index
] == SimplePointer
) {
2034 for (Index
= Index
; Index
< Private
->CurrentNumberOfPointers
- 1; Index
++) {
2035 Private
->PointerList
[Index
] = Private
->PointerList
[Index
+ 1];
2038 Private
->CurrentNumberOfPointers
--;
2043 return EFI_NOT_FOUND
;
2048 Add Absolute Pointer Device in Consplitter Absolute Pointer list.
2050 @param Private Text In Splitter pointer.
2051 @param AbsolutePointer Absolute Pointer protocol pointer.
2053 @retval EFI_SUCCESS Absolute Pointer Device added successfully.
2054 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
2058 ConSplitterAbsolutePointerAddDevice (
2059 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
2060 IN EFI_ABSOLUTE_POINTER_PROTOCOL
*AbsolutePointer
2066 // If the Absolute Pointer List is full, enlarge it by calling ConSplitterGrowBuffer().
2068 if (Private
->CurrentNumberOfAbsolutePointers
>= Private
->AbsolutePointerListCount
) {
2069 Status
= ConSplitterGrowBuffer (
2070 sizeof (EFI_ABSOLUTE_POINTER_PROTOCOL
*),
2071 &Private
->AbsolutePointerListCount
,
2072 (VOID
**) &Private
->AbsolutePointerList
2074 if (EFI_ERROR (Status
)) {
2075 return EFI_OUT_OF_RESOURCES
;
2079 // Add the new text-in device data structure into the Absolute Pointer List.
2081 Private
->AbsolutePointerList
[Private
->CurrentNumberOfAbsolutePointers
] = AbsolutePointer
;
2082 Private
->CurrentNumberOfAbsolutePointers
++;
2089 Remove Absolute Pointer Device from Consplitter Absolute Pointer list.
2091 @param Private Text In Splitter pointer.
2092 @param AbsolutePointer Absolute Pointer protocol pointer.
2094 @retval EFI_SUCCESS Absolute Pointer Device removed successfully.
2095 @retval EFI_NOT_FOUND No Absolute Pointer Device found.
2099 ConSplitterAbsolutePointerDeleteDevice (
2100 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
2101 IN EFI_ABSOLUTE_POINTER_PROTOCOL
*AbsolutePointer
2106 // Remove the specified text-in device data structure from the Absolute Pointer List,
2107 // and rearrange the remaining data structures from the Absolute Pointer List.
2109 for (Index
= 0; Index
< Private
->CurrentNumberOfAbsolutePointers
; Index
++) {
2110 if (Private
->AbsolutePointerList
[Index
] == AbsolutePointer
) {
2111 for (Index
= Index
; Index
< Private
->CurrentNumberOfAbsolutePointers
- 1; Index
++) {
2112 Private
->AbsolutePointerList
[Index
] = Private
->AbsolutePointerList
[Index
+ 1];
2115 Private
->CurrentNumberOfAbsolutePointers
--;
2120 return EFI_NOT_FOUND
;
2124 Reallocate Text Out mode map.
2126 Allocate new buffer and copy original buffer into the new buffer.
2128 @param Private Consplitter Text Out pointer.
2130 @retval EFI_SUCCESS Buffer size has grown
2131 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
2135 ConSplitterGrowMapTable (
2136 IN TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
2142 INT32
*TextOutModeMap
;
2143 INT32
*OldTextOutModeMap
;
2147 NewSize
= Private
->TextOutListCount
* sizeof (INT32
);
2148 OldTextOutModeMap
= Private
->TextOutModeMap
;
2149 TotalSize
= NewSize
* (Private
->TextOutQueryDataCount
);
2152 // Allocate new buffer for Text Out List.
2154 TextOutModeMap
= AllocatePool (TotalSize
);
2155 if (TextOutModeMap
== NULL
) {
2156 return EFI_OUT_OF_RESOURCES
;
2159 SetMem (TextOutModeMap
, TotalSize
, 0xFF);
2160 Private
->TextOutModeMap
= TextOutModeMap
;
2163 // If TextOutList has been enlarged, need to realloc the mode map table
2164 // The mode map table is regarded as a two dimension array.
2167 // 0 ---------> TextOutListCount ----> TextOutListCount
2168 // | -------------------------------------------
2175 // -------------------------------------------
2178 if (OldTextOutModeMap
!= NULL
) {
2180 Size
= Private
->CurrentNumberOfConsoles
* sizeof (INT32
);
2182 SrcAddress
= OldTextOutModeMap
;
2185 // Copy the old data to the new one
2187 while (Index
< Private
->TextOutMode
.MaxMode
) {
2188 CopyMem (TextOutModeMap
, SrcAddress
, Size
);
2189 TextOutModeMap
+= NewSize
;
2194 // Free the old buffer
2196 FreePool (OldTextOutModeMap
);
2204 Add new device's output mode to console splitter's mode list.
2206 @param Private Text Out Splitter pointer
2207 @param TextOut Simple Text Output protocol pointer.
2209 @retval EFI_SUCCESS Device added successfully.
2210 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
2214 ConSplitterAddOutputMode (
2215 IN TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
,
2216 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*TextOut
2224 MaxMode
= TextOut
->Mode
->MaxMode
;
2225 Private
->TextOutMode
.MaxMode
= MaxMode
;
2228 // Grow the buffer if query data buffer is not large enough to
2229 // hold all the mode supported by the first console.
2231 while (MaxMode
> (INT32
) Private
->TextOutQueryDataCount
) {
2232 Status
= ConSplitterGrowBuffer (
2233 sizeof (TEXT_OUT_SPLITTER_QUERY_DATA
),
2234 &Private
->TextOutQueryDataCount
,
2235 (VOID
**) &Private
->TextOutQueryData
2237 if (EFI_ERROR (Status
)) {
2238 return EFI_OUT_OF_RESOURCES
;
2242 // Allocate buffer for the output mode map
2244 Status
= ConSplitterGrowMapTable (Private
);
2245 if (EFI_ERROR (Status
)) {
2246 return EFI_OUT_OF_RESOURCES
;
2249 // As the first textout device, directly add the mode in to QueryData
2250 // and at the same time record the mapping between QueryData and TextOut.
2254 while (Mode
< MaxMode
) {
2255 Status
= TextOut
->QueryMode (
2258 &Private
->TextOutQueryData
[Mode
].Columns
,
2259 &Private
->TextOutQueryData
[Mode
].Rows
2262 // If mode 1 (80x50) is not supported, make sure mode 1 in TextOutQueryData
2265 if ((EFI_ERROR(Status
)) && (Mode
== 1)) {
2266 Private
->TextOutQueryData
[Mode
].Columns
= 0;
2267 Private
->TextOutQueryData
[Mode
].Rows
= 0;
2269 Private
->TextOutModeMap
[Index
] = Mode
;
2271 Index
+= Private
->TextOutListCount
;
2278 Reconstruct TextOutModeMap to get intersection of modes.
2280 This routine reconstruct TextOutModeMap to get the intersection
2281 of modes for all console out devices. Because EFI/UEFI spec require
2282 mode 0 is 80x25, mode 1 is 80x50, this routine will not check the
2283 intersection for mode 0 and mode 1.
2285 @param TextOutModeMap Current text out mode map, begin with the mode 80x25
2286 @param NewlyAddedMap New text out mode map, begin with the mode 80x25
2287 @param MapStepSize Mode step size for one console device
2288 @param NewMapStepSize New Mode step size for one console device
2289 @param MaxMode IN: Current max text mode, OUT: Updated max text mode.
2290 @param CurrentMode IN: Current text mode, OUT: Updated current text mode.
2294 ConSplitterGetIntersection (
2295 IN INT32
*TextOutModeMap
,
2296 IN INT32
*NewlyAddedMap
,
2297 IN UINTN MapStepSize
,
2298 IN UINTN NewMapStepSize
,
2299 IN OUT INT32
*MaxMode
,
2300 IN OUT INT32
*CurrentMode
2304 INT32
*CurrentMapEntry
;
2305 INT32
*NextMapEntry
;
2307 INT32 CurrentMaxMode
;
2311 // According to EFI/UEFI spec, mode 0 and mode 1 have been reserved
2312 // for 80x25 and 80x50 in Simple Text Out protocol, so don't make intersection
2313 // for mode 0 and mode 1, mode number starts from 2.
2316 CurrentMapEntry
= &TextOutModeMap
[MapStepSize
* 2];
2317 NextMapEntry
= CurrentMapEntry
;
2318 NewMapEntry
= &NewlyAddedMap
[NewMapStepSize
* 2];
2320 CurrentMaxMode
= *MaxMode
;
2321 Mode
= *CurrentMode
;
2323 while (Index
< CurrentMaxMode
) {
2324 if (*NewMapEntry
== -1) {
2326 // This mode is not supported any more. Remove it. Special care
2327 // must be taken as this remove will also affect current mode;
2329 if (Index
== *CurrentMode
) {
2331 } else if (Index
< *CurrentMode
) {
2336 if (CurrentMapEntry
!= NextMapEntry
) {
2337 CopyMem (NextMapEntry
, CurrentMapEntry
, MapStepSize
* sizeof (INT32
));
2340 NextMapEntry
+= MapStepSize
;
2343 CurrentMapEntry
+= MapStepSize
;
2344 NewMapEntry
+= NewMapStepSize
;
2348 *CurrentMode
= Mode
;
2354 Sync the device's output mode to console splitter's mode list.
2356 @param Private Text Out Splitter pointer.
2357 @param TextOut Simple Text Output protocol pointer.
2361 ConSplitterSyncOutputMode (
2362 IN TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
,
2363 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*TextOut
2366 INT32 CurrentMaxMode
;
2369 INT32
*TextOutModeMap
;
2372 TEXT_OUT_SPLITTER_QUERY_DATA
*TextOutQueryData
;
2379 // Must make sure that current mode won't change even if mode number changes
2381 CurrentMaxMode
= Private
->TextOutMode
.MaxMode
;
2382 TextOutModeMap
= Private
->TextOutModeMap
;
2383 StepSize
= Private
->TextOutListCount
;
2384 TextOutQueryData
= Private
->TextOutQueryData
;
2387 // Query all the mode that the newly added TextOut supports
2390 MapTable
= TextOutModeMap
+ Private
->CurrentNumberOfConsoles
;
2391 while (Mode
< TextOut
->Mode
->MaxMode
) {
2392 Status
= TextOut
->QueryMode (TextOut
, Mode
, &Columns
, &Rows
);
2394 if (EFI_ERROR(Status
)) {
2397 // If mode 1 (80x50) is not supported, make sure mode 1 in TextOutQueryData
2400 MapTable
[StepSize
] = Mode
;
2401 TextOutQueryData
[Mode
].Columns
= 0;
2402 TextOutQueryData
[Mode
].Rows
= 0;
2408 // Search the intersection map and QueryData database to see if they intersects
2411 while (Index
< CurrentMaxMode
) {
2412 QueryMode
= *(TextOutModeMap
+ Index
* StepSize
);
2413 if ((TextOutQueryData
[QueryMode
].Rows
== Rows
) && (TextOutQueryData
[QueryMode
].Columns
== Columns
)) {
2414 MapTable
[Index
* StepSize
] = Mode
;
2422 // Now search the TextOutModeMap table to find the intersection of supported
2423 // mode between ConSplitter and the newly added device.
2425 ConSplitterGetIntersection (
2430 &Private
->TextOutMode
.MaxMode
,
2431 &Private
->TextOutMode
.Mode
2439 Sync output device between ConOut and StdErr output.
2441 @retval EFI_SUCCESS Sync implemented successfully.
2442 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
2446 ConSplitterGetIntersectionBetweenConOutAndStrErr (
2450 UINTN ConOutNumOfConsoles
;
2451 UINTN StdErrNumOfConsoles
;
2452 TEXT_OUT_AND_GOP_DATA
*ConOutTextOutList
;
2453 TEXT_OUT_AND_GOP_DATA
*StdErrTextOutList
;
2457 UINTN ConOutColumns
;
2459 UINTN StdErrColumns
;
2460 INT32 ConOutMaxMode
;
2461 INT32 StdErrMaxMode
;
2466 INT32
*ConOutModeMap
;
2467 INT32
*StdErrModeMap
;
2468 INT32
*ConOutMapTable
;
2469 INT32
*StdErrMapTable
;
2470 TEXT_OUT_SPLITTER_QUERY_DATA
*ConOutQueryData
;
2471 TEXT_OUT_SPLITTER_QUERY_DATA
*StdErrQueryData
;
2472 UINTN ConOutStepSize
;
2473 UINTN StdErrStepSize
;
2474 BOOLEAN FoundTheSameTextOut
;
2475 UINTN ConOutMapTableSize
;
2476 UINTN StdErrMapTableSize
;
2478 ConOutNumOfConsoles
= mConOut
.CurrentNumberOfConsoles
;
2479 StdErrNumOfConsoles
= mStdErr
.CurrentNumberOfConsoles
;
2480 ConOutTextOutList
= mConOut
.TextOutList
;
2481 StdErrTextOutList
= mStdErr
.TextOutList
;
2484 FoundTheSameTextOut
= FALSE
;
2485 while ((Indexi
< ConOutNumOfConsoles
) && (!FoundTheSameTextOut
)) {
2487 while (Indexj
< StdErrNumOfConsoles
) {
2488 if (ConOutTextOutList
->TextOut
== StdErrTextOutList
->TextOut
) {
2489 FoundTheSameTextOut
= TRUE
;
2494 StdErrTextOutList
++;
2498 ConOutTextOutList
++;
2501 if (!FoundTheSameTextOut
) {
2505 // Must make sure that current mode won't change even if mode number changes
2507 ConOutMaxMode
= mConOut
.TextOutMode
.MaxMode
;
2508 ConOutModeMap
= mConOut
.TextOutModeMap
;
2509 ConOutStepSize
= mConOut
.TextOutListCount
;
2510 ConOutQueryData
= mConOut
.TextOutQueryData
;
2512 StdErrMaxMode
= mStdErr
.TextOutMode
.MaxMode
;
2513 StdErrModeMap
= mStdErr
.TextOutModeMap
;
2514 StdErrStepSize
= mStdErr
.TextOutListCount
;
2515 StdErrQueryData
= mStdErr
.TextOutQueryData
;
2518 // Allocate the map table and set the map table's index to -1.
2520 ConOutMapTableSize
= ConOutMaxMode
* sizeof (INT32
);
2521 ConOutMapTable
= AllocateZeroPool (ConOutMapTableSize
);
2522 if (ConOutMapTable
== NULL
) {
2523 return EFI_OUT_OF_RESOURCES
;
2526 SetMem (ConOutMapTable
, ConOutMapTableSize
, 0xFF);
2528 StdErrMapTableSize
= StdErrMaxMode
* sizeof (INT32
);
2529 StdErrMapTable
= AllocateZeroPool (StdErrMapTableSize
);
2530 if (StdErrMapTable
== NULL
) {
2531 return EFI_OUT_OF_RESOURCES
;
2534 SetMem (StdErrMapTable
, StdErrMapTableSize
, 0xFF);
2537 // Find the intersection of the two set of modes. If they actually intersect, the
2538 // correponding entry in the map table is set to 1.
2541 while (Mode
< ConOutMaxMode
) {
2543 // Search the intersection map and QueryData database to see if they intersect
2546 ConOutMode
= *(ConOutModeMap
+ Mode
* ConOutStepSize
);
2547 ConOutRows
= ConOutQueryData
[ConOutMode
].Rows
;
2548 ConOutColumns
= ConOutQueryData
[ConOutMode
].Columns
;
2549 while (Index
< StdErrMaxMode
) {
2550 StdErrMode
= *(StdErrModeMap
+ Index
* StdErrStepSize
);
2551 StdErrRows
= StdErrQueryData
[StdErrMode
].Rows
;
2552 StdErrColumns
= StdErrQueryData
[StdErrMode
].Columns
;
2553 if ((StdErrRows
== ConOutRows
) && (StdErrColumns
== ConOutColumns
)) {
2554 ConOutMapTable
[Mode
] = 1;
2555 StdErrMapTable
[Index
] = 1;
2565 // Now search the TextOutModeMap table to find the intersection of supported
2566 // mode between ConSplitter and the newly added device.
2568 ConSplitterGetIntersection (
2571 mConOut
.TextOutListCount
,
2573 &(mConOut
.TextOutMode
.MaxMode
),
2574 &(mConOut
.TextOutMode
.Mode
)
2577 if (mConOut
.TextOutMode
.Mode
< 0) {
2578 mConOut
.TextOut
.SetMode (&(mConOut
.TextOut
), 0);
2581 ConSplitterGetIntersection (
2584 mStdErr
.TextOutListCount
,
2586 &(mStdErr
.TextOutMode
.MaxMode
),
2587 &(mStdErr
.TextOutMode
.Mode
)
2590 if (mStdErr
.TextOutMode
.Mode
< 0) {
2591 mStdErr
.TextOut
.SetMode (&(mStdErr
.TextOut
), 0);
2594 FreePool (ConOutMapTable
);
2595 FreePool (StdErrMapTable
);
2602 Add Grahpics Output modes into Consplitter Text Out list.
2604 @param Private Text Out Splitter pointer.
2605 @param GraphicsOutput Graphics Output protocol pointer.
2606 @param UgaDraw UGA Draw protocol pointer.
2608 @retval EFI_SUCCESS Output mode added successfully.
2609 @retval other Failed to add output mode.
2613 ConSplitterAddGraphicsOutputMode (
2614 IN TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
,
2615 IN EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
,
2616 IN EFI_UGA_DRAW_PROTOCOL
*UgaDraw
2622 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*Mode
;
2624 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*Info
;
2625 EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE
*CurrentGraphicsOutputMode
;
2626 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*ModeBuffer
;
2627 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*MatchedMode
;
2630 BOOLEAN AlreadyExist
;
2631 UINT32 UgaHorizontalResolution
;
2632 UINT32 UgaVerticalResolution
;
2633 UINT32 UgaColorDepth
;
2634 UINT32 UgaRefreshRate
;
2636 ASSERT (GraphicsOutput
!= NULL
|| UgaDraw
!= NULL
);
2638 CurrentGraphicsOutputMode
= Private
->GraphicsOutput
.Mode
;
2643 if (Private
->CurrentNumberOfUgaDraw
!= 0) {
2645 // If any UGA device has already been added, then there is no need to
2646 // calculate intersection of display mode of different GOP/UGA device,
2647 // since only one display mode will be exported (i.e. user-defined mode)
2652 if (GraphicsOutput
!= NULL
) {
2653 if (Private
->CurrentNumberOfGraphicsOutput
== 0) {
2655 // This is the first Graphics Output device added
2657 CurrentGraphicsOutputMode
->MaxMode
= GraphicsOutput
->Mode
->MaxMode
;
2658 CurrentGraphicsOutputMode
->Mode
= GraphicsOutput
->Mode
->Mode
;
2659 CopyMem (CurrentGraphicsOutputMode
->Info
, GraphicsOutput
->Mode
->Info
, GraphicsOutput
->Mode
->SizeOfInfo
);
2660 CurrentGraphicsOutputMode
->SizeOfInfo
= GraphicsOutput
->Mode
->SizeOfInfo
;
2661 CurrentGraphicsOutputMode
->FrameBufferBase
= GraphicsOutput
->Mode
->FrameBufferBase
;
2662 CurrentGraphicsOutputMode
->FrameBufferSize
= GraphicsOutput
->Mode
->FrameBufferSize
;
2665 // Allocate resource for the private mode buffer
2667 ModeBuffer
= AllocatePool (sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
) * GraphicsOutput
->Mode
->MaxMode
);
2668 if (ModeBuffer
== NULL
) {
2669 return EFI_OUT_OF_RESOURCES
;
2671 FreePool (Private
->GraphicsOutputModeBuffer
);
2672 Private
->GraphicsOutputModeBuffer
= ModeBuffer
;
2675 // Store all supported display modes to the private mode buffer
2678 for (Index
= 0; Index
< GraphicsOutput
->Mode
->MaxMode
; Index
++) {
2680 // The Info buffer would be allocated by callee
2682 Status
= GraphicsOutput
->QueryMode (GraphicsOutput
, (UINT32
) Index
, &SizeOfInfo
, &Info
);
2683 if (EFI_ERROR (Status
)) {
2686 ASSERT ( SizeOfInfo
<= sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
));
2687 CopyMem (Mode
, Info
, SizeOfInfo
);
2693 // Check intersection of display mode
2695 ModeBuffer
= AllocatePool (sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
) * CurrentGraphicsOutputMode
->MaxMode
);
2696 if (ModeBuffer
== NULL
) {
2697 return EFI_OUT_OF_RESOURCES
;
2700 MatchedMode
= ModeBuffer
;
2701 Mode
= &Private
->GraphicsOutputModeBuffer
[0];
2702 for (Index
= 0; Index
< CurrentGraphicsOutputMode
->MaxMode
; Index
++) {
2705 for (NumberIndex
= 0; NumberIndex
< GraphicsOutput
->Mode
->MaxMode
; NumberIndex
++) {
2707 // The Info buffer would be allocated by callee
2709 Status
= GraphicsOutput
->QueryMode (GraphicsOutput
, (UINT32
) NumberIndex
, &SizeOfInfo
, &Info
);
2710 if (EFI_ERROR (Status
)) {
2713 if ((Info
->HorizontalResolution
== Mode
->HorizontalResolution
) &&
2714 (Info
->VerticalResolution
== Mode
->VerticalResolution
)) {
2716 // If GOP device supports one mode in current mode buffer,
2717 // it will be added into matched mode buffer
2727 AlreadyExist
= FALSE
;
2730 // Check if GOP mode has been in the mode buffer, ModeBuffer = MatchedMode at begin.
2732 for (Info
= ModeBuffer
; Info
< MatchedMode
; Info
++) {
2733 if ((Info
->HorizontalResolution
== Mode
->HorizontalResolution
) &&
2734 (Info
->VerticalResolution
== Mode
->VerticalResolution
)) {
2735 AlreadyExist
= TRUE
;
2740 if (!AlreadyExist
) {
2741 CopyMem (MatchedMode
, Mode
, sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
));
2744 // Physical frame buffer is no longer available, change PixelFormat to PixelBltOnly
2746 MatchedMode
->Version
= 0;
2747 MatchedMode
->PixelFormat
= PixelBltOnly
;
2748 ZeroMem (&MatchedMode
->PixelInformation
, sizeof (EFI_PIXEL_BITMASK
));
2758 // Drop the old mode buffer, assign it to a new one
2760 FreePool (Private
->GraphicsOutputModeBuffer
);
2761 Private
->GraphicsOutputModeBuffer
= ModeBuffer
;
2764 // Physical frame buffer is no longer available when there are more than one physical GOP devices
2766 CurrentGraphicsOutputMode
->MaxMode
= (UINT32
) (((UINTN
) MatchedMode
- (UINTN
) ModeBuffer
) / sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
));
2767 CurrentGraphicsOutputMode
->Info
->PixelFormat
= PixelBltOnly
;
2768 ZeroMem (&CurrentGraphicsOutputMode
->Info
->PixelInformation
, sizeof (EFI_PIXEL_BITMASK
));
2769 CurrentGraphicsOutputMode
->SizeOfInfo
= sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
);
2770 CurrentGraphicsOutputMode
->FrameBufferBase
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) NULL
;
2771 CurrentGraphicsOutputMode
->FrameBufferSize
= 0;
2775 // Graphics console driver can ensure the same mode for all GOP devices
2777 for (Index
= 0; Index
< CurrentGraphicsOutputMode
->MaxMode
; Index
++) {
2778 Mode
= &Private
->GraphicsOutputModeBuffer
[Index
];
2779 if ((Mode
->HorizontalResolution
== GraphicsOutput
->Mode
->Info
->HorizontalResolution
) &&
2780 (Mode
->VerticalResolution
== GraphicsOutput
->Mode
->Info
->VerticalResolution
)) {
2781 CurrentIndex
= Index
;
2785 if (Index
>= CurrentGraphicsOutputMode
->MaxMode
) {
2787 // if user defined mode is not found, set to default mode 800x600
2789 for (Index
= 0; Index
< CurrentGraphicsOutputMode
->MaxMode
; Index
++) {
2790 Mode
= &Private
->GraphicsOutputModeBuffer
[Index
];
2791 if ((Mode
->HorizontalResolution
== 800) && (Mode
->VerticalResolution
== 600)) {
2792 CurrentIndex
= Index
;
2797 } else if (UgaDraw
!= NULL
&& FeaturePcdGet (PcdUgaConsumeSupport
)) {
2799 // Graphics console driver can ensure the same mode for all GOP devices
2800 // so we can get the current mode from this video device
2804 &UgaHorizontalResolution
,
2805 &UgaVerticalResolution
,
2810 CurrentGraphicsOutputMode
->MaxMode
= 1;
2811 Info
= CurrentGraphicsOutputMode
->Info
;
2813 Info
->HorizontalResolution
= UgaHorizontalResolution
;
2814 Info
->VerticalResolution
= UgaVerticalResolution
;
2815 Info
->PixelFormat
= PixelBltOnly
;
2816 Info
->PixelsPerScanLine
= UgaHorizontalResolution
;
2817 CurrentGraphicsOutputMode
->SizeOfInfo
= sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
);
2818 CurrentGraphicsOutputMode
->FrameBufferBase
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) NULL
;
2819 CurrentGraphicsOutputMode
->FrameBufferSize
= 0;
2822 // Update the private mode buffer
2824 CopyMem (&Private
->GraphicsOutputModeBuffer
[0], Info
, sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
));
2827 // Only mode 0 is available to be set
2834 if (GraphicsOutput
!= NULL
) {
2835 Private
->CurrentNumberOfGraphicsOutput
++;
2837 if (UgaDraw
!= NULL
&& FeaturePcdGet (PcdUgaConsumeSupport
)) {
2838 Private
->CurrentNumberOfUgaDraw
++;
2842 // Force GraphicsOutput mode to be set,
2843 // regardless whether the console is in EfiConsoleControlScreenGraphics or EfiConsoleControlScreenText mode
2845 Private
->HardwareNeedsStarting
= TRUE
;
2847 // Current mode number may need update now, so set it to an invalid mode number
2849 CurrentGraphicsOutputMode
->Mode
= 0xffff;
2851 // Graphics console can ensure all GOP devices have the same mode which can be taken as current mode.
2853 Status
= Private
->GraphicsOutput
.SetMode (&Private
->GraphicsOutput
, (UINT32
) CurrentIndex
);
2854 if (EFI_ERROR(Status
)) {
2856 // If user defined mode is not valid for display device, set to the default mode 800x600.
2858 (Private
->GraphicsOutputModeBuffer
[0]).HorizontalResolution
= 800;
2859 (Private
->GraphicsOutputModeBuffer
[0]).VerticalResolution
= 600;
2860 Status
= Private
->GraphicsOutput
.SetMode (&Private
->GraphicsOutput
, 0);
2867 Set the current console out mode.
2869 This routine will get the current console mode information (column, row)
2870 from ConsoleOutMode variable and set it; if the variable does not exist,
2871 set to user defined console mode.
2873 @param Private Consplitter Text Out pointer.
2877 ConsplitterSetConsoleOutMode (
2878 IN TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
2888 CONSOLE_OUT_MODE ModeInfo
;
2889 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*TextOut
;
2893 TextOut
= &Private
->TextOut
;
2894 MaxMode
= (UINTN
) (TextOut
->Mode
->MaxMode
);
2896 ModeInfo
.Column
= PcdGet32 (PcdConOutColumn
);
2897 ModeInfo
.Row
= PcdGet32 (PcdConOutRow
);
2900 // To find the prefer mode and basic mode from Text Out mode list
2902 for (Mode
= 0; Mode
< MaxMode
; Mode
++) {
2903 Status
= TextOut
->QueryMode (TextOut
, Mode
, &Col
, &Row
);
2904 if (!EFI_ERROR(Status
)) {
2905 if (Col
== ModeInfo
.Column
&& Row
== ModeInfo
.Row
) {
2908 if (Col
== 80 && Row
== 25) {
2915 // Set prefer mode to Text Out devices.
2917 Status
= TextOut
->SetMode (TextOut
, PreferMode
);
2918 if (EFI_ERROR(Status
)) {
2920 // if current mode setting is failed, default 80x25 mode will be set.
2922 Status
= TextOut
->SetMode (TextOut
, BaseMode
);
2923 ASSERT(!EFI_ERROR(Status
));
2925 PcdSet32 (PcdConOutColumn
, 80);
2926 PcdSet32 (PcdConOutRow
, 25);
2934 Add Text Output Device in Consplitter Text Output list.
2936 @param Private Text Out Splitter pointer.
2937 @param TextOut Simple Text Output protocol pointer.
2938 @param GraphicsOutput Graphics Output protocol pointer.
2939 @param UgaDraw UGA Draw protocol pointer.
2941 @retval EFI_SUCCESS Text Output Device added successfully.
2942 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
2946 ConSplitterTextOutAddDevice (
2947 IN TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
,
2948 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*TextOut
,
2949 IN EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
,
2950 IN EFI_UGA_DRAW_PROTOCOL
*UgaDraw
2954 UINTN CurrentNumOfConsoles
;
2956 UINT32 UgaHorizontalResolution
;
2957 UINT32 UgaVerticalResolution
;
2958 UINT32 UgaColorDepth
;
2959 UINT32 UgaRefreshRate
;
2960 TEXT_OUT_AND_GOP_DATA
*TextAndGop
;
2962 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*Info
;
2964 Status
= EFI_SUCCESS
;
2965 CurrentNumOfConsoles
= Private
->CurrentNumberOfConsoles
;
2968 // If the Text Out List is full, enlarge it by calling ConSplitterGrowBuffer().
2970 while (CurrentNumOfConsoles
>= Private
->TextOutListCount
) {
2971 Status
= ConSplitterGrowBuffer (
2972 sizeof (TEXT_OUT_AND_GOP_DATA
),
2973 &Private
->TextOutListCount
,
2974 (VOID
**) &Private
->TextOutList
2976 if (EFI_ERROR (Status
)) {
2977 return EFI_OUT_OF_RESOURCES
;
2980 // Also need to reallocate the TextOutModeMap table
2982 Status
= ConSplitterGrowMapTable (Private
);
2983 if (EFI_ERROR (Status
)) {
2984 return EFI_OUT_OF_RESOURCES
;
2988 TextAndGop
= &Private
->TextOutList
[CurrentNumOfConsoles
];
2990 TextAndGop
->TextOut
= TextOut
;
2991 TextAndGop
->GraphicsOutput
= GraphicsOutput
;
2992 TextAndGop
->UgaDraw
= UgaDraw
;
2994 if (CurrentNumOfConsoles
== 0) {
2996 // Add the first device's output mode to console splitter's mode list
2998 Status
= ConSplitterAddOutputMode (Private
, TextOut
);
3000 ConSplitterSyncOutputMode (Private
, TextOut
);
3003 Private
->CurrentNumberOfConsoles
++;
3006 // Scan both TextOutList, for the intersection TextOut device
3007 // maybe both ConOut and StdErr incorporate the same Text Out
3008 // device in them, thus the output of both should be synced.
3010 ConSplitterGetIntersectionBetweenConOutAndStrErr ();
3012 MaxMode
= Private
->TextOutMode
.MaxMode
;
3013 ASSERT (MaxMode
>= 1);
3015 if (FeaturePcdGet (PcdConOutGopSupport
)) {
3017 // If GOP is produced by Consplitter, this device display mode will be added into Graphics Ouput modes.
3019 if ((GraphicsOutput
!= NULL
) || (UgaDraw
!= NULL
&& FeaturePcdGet (PcdUgaConsumeSupport
))) {
3020 ConSplitterAddGraphicsOutputMode (Private
, GraphicsOutput
, UgaDraw
);
3024 if (FeaturePcdGet (PcdConOutUgaSupport
)) {
3025 UgaHorizontalResolution
= 800;
3026 UgaVerticalResolution
= 600;
3028 UgaRefreshRate
= 60;
3030 Status
= EFI_DEVICE_ERROR
;
3032 // If UGA is produced by Consplitter
3034 if (GraphicsOutput
!= NULL
) {
3035 Status
= GraphicsOutput
->QueryMode (GraphicsOutput
, GraphicsOutput
->Mode
->Mode
, &SizeOfInfo
, &Info
);
3036 if (EFI_ERROR (Status
)) {
3039 ASSERT ( SizeOfInfo
<= sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
));
3041 UgaHorizontalResolution
= Info
->HorizontalResolution
;
3042 UgaVerticalResolution
= Info
->VerticalResolution
;
3046 } else if (UgaDraw
!= NULL
&& FeaturePcdGet (PcdUgaConsumeSupport
)) {
3047 Status
= UgaDraw
->GetMode (
3049 &UgaHorizontalResolution
,
3050 &UgaVerticalResolution
,
3057 // Set UGA Draw mode,
3058 // if GetMode is failed, set to 800x600 mode
3060 Status
= ConSpliterUgaDrawSetMode (
3062 UgaHorizontalResolution
,
3063 UgaVerticalResolution
,
3070 // If ConOut, then set the mode to Mode #0 which us 80 x 25
3072 Private
->TextOut
.SetMode (&Private
->TextOut
, 0);
3075 // After adding new console device, all existing console devices should be
3076 // synced to the current shared mode.
3078 ConsplitterSetConsoleOutMode (Private
);
3085 Remove Text Out Device in Consplitter Text Out list.
3087 @param Private Text Out Splitter pointer.
3088 @param TextOut Simple Text Output Pointer protocol pointer.
3090 @retval EFI_SUCCESS Text Out Device removed successfully.
3091 @retval EFI_NOT_FOUND No Text Out Device found.
3095 ConSplitterTextOutDeleteDevice (
3096 IN TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
,
3097 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*TextOut
3101 UINTN CurrentNumOfConsoles
;
3102 TEXT_OUT_AND_GOP_DATA
*TextOutList
;
3106 // Remove the specified text-out device data structure from the Text out List,
3107 // and rearrange the remaining data structures in the Text out List.
3109 CurrentNumOfConsoles
= Private
->CurrentNumberOfConsoles
;
3110 Index
= (INT32
) CurrentNumOfConsoles
- 1;
3111 TextOutList
= Private
->TextOutList
;
3112 while (Index
>= 0) {
3113 if (TextOutList
->TextOut
== TextOut
) {
3114 CopyMem (TextOutList
, TextOutList
+ 1, sizeof (TEXT_OUT_AND_GOP_DATA
) * Index
);
3115 CurrentNumOfConsoles
--;
3116 if (TextOutList
->UgaDraw
!= NULL
&& FeaturePcdGet (PcdUgaConsumeSupport
)) {
3117 Private
->CurrentNumberOfUgaDraw
--;
3119 if (TextOutList
->GraphicsOutput
!= NULL
) {
3120 Private
->CurrentNumberOfGraphicsOutput
--;
3129 // The specified TextOut is not managed by the ConSplitter driver
3132 return EFI_NOT_FOUND
;
3135 if (CurrentNumOfConsoles
== 0) {
3137 // If the number of consoles is zero, reset all parameters
3139 Private
->CurrentNumberOfConsoles
= 0;
3140 Private
->TextOutMode
.MaxMode
= 1;
3141 Private
->TextOutQueryData
[0].Columns
= 80;
3142 Private
->TextOutQueryData
[0].Rows
= 25;
3143 TextOutSetMode (Private
, 0);
3148 // Max Mode is realy an intersection of the QueryMode command to all
3149 // devices. So we must copy the QueryMode of the first device to
3153 Private
->TextOutQueryData
,
3154 Private
->TextOutQueryDataCount
* sizeof (TEXT_OUT_SPLITTER_QUERY_DATA
)
3157 FreePool (Private
->TextOutModeMap
);
3158 Private
->TextOutModeMap
= NULL
;
3159 TextOutList
= Private
->TextOutList
;
3162 // Add the first TextOut to the QueryData array and ModeMap table
3164 Status
= ConSplitterAddOutputMode (Private
, TextOutList
->TextOut
);
3167 // Now add one by one
3170 Private
->CurrentNumberOfConsoles
= 1;
3172 while ((UINTN
) Index
< CurrentNumOfConsoles
) {
3173 ConSplitterSyncOutputMode (Private
, TextOutList
->TextOut
);
3175 Private
->CurrentNumberOfConsoles
++;
3179 ConSplitterGetIntersectionBetweenConOutAndStrErr ();
3186 Reset the input device and optionaly run diagnostics
3188 @param This Protocol instance pointer.
3189 @param ExtendedVerification Driver may perform diagnostics on reset.
3191 @retval EFI_SUCCESS The device was reset.
3192 @retval EFI_DEVICE_ERROR The device is not functioning properly and could
3198 ConSplitterTextInReset (
3199 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*This
,
3200 IN BOOLEAN ExtendedVerification
3204 EFI_STATUS ReturnStatus
;
3205 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3208 Private
= TEXT_IN_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
3210 Private
->KeyEventSignalState
= FALSE
;
3213 // return the worst status met
3215 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
3216 Status
= Private
->TextInList
[Index
]->Reset (
3217 Private
->TextInList
[Index
],
3218 ExtendedVerification
3220 if (EFI_ERROR (Status
)) {
3221 ReturnStatus
= Status
;
3225 return ReturnStatus
;
3230 Reads the next keystroke from the input device. The WaitForKey Event can
3231 be used to test for existance of a keystroke via WaitForEvent () call.
3233 @param Private Protocol instance pointer.
3234 @param Key Driver may perform diagnostics on reset.
3236 @retval EFI_SUCCESS The keystroke information was returned.
3237 @retval EFI_NOT_READY There was no keystroke data availiable.
3238 @retval EFI_DEVICE_ERROR The keydtroke information was not returned due
3244 ConSplitterTextInPrivateReadKeyStroke (
3245 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
3246 OUT EFI_INPUT_KEY
*Key
3251 EFI_INPUT_KEY CurrentKey
;
3253 Key
->UnicodeChar
= 0;
3254 Key
->ScanCode
= SCAN_NULL
;
3257 // if no physical console input device exists, return EFI_NOT_READY;
3258 // if any physical console input device has key input,
3259 // return the key and EFI_SUCCESS.
3261 for (Index
= 0; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
3262 Status
= Private
->TextInList
[Index
]->ReadKeyStroke (
3263 Private
->TextInList
[Index
],
3266 if (!EFI_ERROR (Status
)) {
3272 return EFI_NOT_READY
;
3277 Reads the next keystroke from the input device. The WaitForKey Event can
3278 be used to test for existance of a keystroke via WaitForEvent () call.
3280 @param This Protocol instance pointer.
3281 @param Key Driver may perform diagnostics on reset.
3283 @retval EFI_SUCCESS The keystroke information was returned.
3284 @retval EFI_NOT_READY There was no keystroke data availiable.
3285 @retval EFI_DEVICE_ERROR The keydtroke information was not returned due
3291 ConSplitterTextInReadKeyStroke (
3292 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*This
,
3293 OUT EFI_INPUT_KEY
*Key
3296 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3298 Private
= TEXT_IN_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
3300 Private
->KeyEventSignalState
= FALSE
;
3302 return ConSplitterTextInPrivateReadKeyStroke (Private
, Key
);
3307 This event aggregates all the events of the ConIn devices in the spliter.
3309 If any events of physical ConIn devices are signaled, signal the ConIn
3310 spliter event. This will cause the calling code to call
3311 ConSplitterTextInReadKeyStroke ().
3313 @param Event The Event assoicated with callback.
3314 @param Context Context registered when Event was created.
3319 ConSplitterTextInWaitForKey (
3325 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3328 Private
= (TEXT_IN_SPLITTER_PRIVATE_DATA
*) Context
;
3330 if (Private
->KeyEventSignalState
) {
3332 // If KeyEventSignalState is flagged before, and not cleared by Reset() or ReadKeyStroke()
3334 gBS
->SignalEvent (Event
);
3339 // If any physical console input device has key input, signal the event.
3341 for (Index
= 0; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
3342 Status
= gBS
->CheckEvent (Private
->TextInList
[Index
]->WaitForKey
);
3343 if (!EFI_ERROR (Status
)) {
3344 gBS
->SignalEvent (Event
);
3345 Private
->KeyEventSignalState
= TRUE
;
3353 Test if the key has been registered on input device.
3355 @param RegsiteredData A pointer to a buffer that is filled in with the
3356 keystroke state data for the key that was
3358 @param InputData A pointer to a buffer that is filled in with the
3359 keystroke state data for the key that was
3362 @retval TRUE Key be pressed matches a registered key.
3363 @retval FLASE Match failed.
3368 IN EFI_KEY_DATA
*RegsiteredData
,
3369 IN EFI_KEY_DATA
*InputData
3372 ASSERT (RegsiteredData
!= NULL
&& InputData
!= NULL
);
3374 if ((RegsiteredData
->Key
.ScanCode
!= InputData
->Key
.ScanCode
) ||
3375 (RegsiteredData
->Key
.UnicodeChar
!= InputData
->Key
.UnicodeChar
)) {
3380 // Assume KeyShiftState/KeyToggleState = 0 in Registered key data means these state could be ignored.
3382 if (RegsiteredData
->KeyState
.KeyShiftState
!= 0 &&
3383 RegsiteredData
->KeyState
.KeyShiftState
!= InputData
->KeyState
.KeyShiftState
) {
3386 if (RegsiteredData
->KeyState
.KeyToggleState
!= 0 &&
3387 RegsiteredData
->KeyState
.KeyToggleState
!= InputData
->KeyState
.KeyToggleState
) {
3397 Reset the input device and optionaly run diagnostics
3399 @param This Protocol instance pointer.
3400 @param ExtendedVerification Driver may perform diagnostics on reset.
3402 @retval EFI_SUCCESS The device was reset.
3403 @retval EFI_DEVICE_ERROR The device is not functioning properly and could
3409 ConSplitterTextInResetEx (
3410 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*This
,
3411 IN BOOLEAN ExtendedVerification
3415 EFI_STATUS ReturnStatus
;
3416 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3419 Private
= TEXT_IN_EX_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
3421 Private
->KeyEventSignalState
= FALSE
;
3424 // return the worst status met
3426 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfExConsoles
; Index
++) {
3427 Status
= Private
->TextInExList
[Index
]->Reset (
3428 Private
->TextInExList
[Index
],
3429 ExtendedVerification
3431 if (EFI_ERROR (Status
)) {
3432 ReturnStatus
= Status
;
3436 return ReturnStatus
;
3442 Reads the next keystroke from the input device. The WaitForKey Event can
3443 be used to test for existance of a keystroke via WaitForEvent () call.
3445 @param This Protocol instance pointer.
3446 @param KeyData A pointer to a buffer that is filled in with the
3447 keystroke state data for the key that was
3450 @retval EFI_SUCCESS The keystroke information was returned.
3451 @retval EFI_NOT_READY There was no keystroke data availiable.
3452 @retval EFI_DEVICE_ERROR The keystroke information was not returned due
3454 @retval EFI_INVALID_PARAMETER KeyData is NULL.
3459 ConSplitterTextInReadKeyStrokeEx (
3460 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*This
,
3461 OUT EFI_KEY_DATA
*KeyData
3464 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3467 EFI_KEY_DATA CurrentKeyData
;
3470 if (KeyData
== NULL
) {
3471 return EFI_INVALID_PARAMETER
;
3474 Private
= TEXT_IN_EX_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
3476 Private
->KeyEventSignalState
= FALSE
;
3478 KeyData
->Key
.UnicodeChar
= 0;
3479 KeyData
->Key
.ScanCode
= SCAN_NULL
;
3482 // if no physical console input device exists, return EFI_NOT_READY;
3483 // if any physical console input device has key input,
3484 // return the key and EFI_SUCCESS.
3486 for (Index
= 0; Index
< Private
->CurrentNumberOfExConsoles
; Index
++) {
3487 Status
= Private
->TextInExList
[Index
]->ReadKeyStrokeEx (
3488 Private
->TextInExList
[Index
],
3491 if (!EFI_ERROR (Status
)) {
3492 CopyMem (KeyData
, &CurrentKeyData
, sizeof (CurrentKeyData
));
3497 return EFI_NOT_READY
;
3502 Set certain state for the input device.
3504 @param This Protocol instance pointer.
3505 @param KeyToggleState A pointer to the EFI_KEY_TOGGLE_STATE to set the
3506 state for the input device.
3508 @retval EFI_SUCCESS The device state was set successfully.
3509 @retval EFI_DEVICE_ERROR The device is not functioning correctly and
3510 could not have the setting adjusted.
3511 @retval EFI_UNSUPPORTED The device does not have the ability to set its
3513 @retval EFI_INVALID_PARAMETER KeyToggleState is NULL.
3518 ConSplitterTextInSetState (
3519 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*This
,
3520 IN EFI_KEY_TOGGLE_STATE
*KeyToggleState
3523 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3527 if (KeyToggleState
== NULL
) {
3528 return EFI_INVALID_PARAMETER
;
3531 Private
= TEXT_IN_EX_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
3534 // if no physical console input device exists, return EFI_SUCCESS;
3535 // otherwise return the status of setting state of physical console input device
3537 for (Index
= 0; Index
< Private
->CurrentNumberOfExConsoles
; Index
++) {
3538 Status
= Private
->TextInExList
[Index
]->SetState (
3539 Private
->TextInExList
[Index
],
3542 if (EFI_ERROR (Status
)) {
3553 Register a notification function for a particular keystroke for the input device.
3555 @param This Protocol instance pointer.
3556 @param KeyData A pointer to a buffer that is filled in with the
3557 keystroke information data for the key that was
3559 @param KeyNotificationFunction Points to the function to be called when the key
3560 sequence is typed specified by KeyData.
3561 @param NotifyHandle Points to the unique handle assigned to the
3562 registered notification.
3564 @retval EFI_SUCCESS The notification function was registered
3566 @retval EFI_OUT_OF_RESOURCES Unable to allocate resources for necesssary data
3568 @retval EFI_INVALID_PARAMETER KeyData or KeyNotificationFunction or NotifyHandle is NULL.
3573 ConSplitterTextInRegisterKeyNotify (
3574 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*This
,
3575 IN EFI_KEY_DATA
*KeyData
,
3576 IN EFI_KEY_NOTIFY_FUNCTION KeyNotificationFunction
,
3577 OUT EFI_HANDLE
*NotifyHandle
3580 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3583 TEXT_IN_EX_SPLITTER_NOTIFY
*NewNotify
;
3585 TEXT_IN_EX_SPLITTER_NOTIFY
*CurrentNotify
;
3588 if (KeyData
== NULL
|| NotifyHandle
== NULL
|| KeyNotificationFunction
== NULL
) {
3589 return EFI_INVALID_PARAMETER
;
3592 Private
= TEXT_IN_EX_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
3595 // If no physical console input device exists,
3596 // return EFI_SUCCESS directly.
3598 if (Private
->CurrentNumberOfExConsoles
<= 0) {
3603 // Return EFI_SUCCESS if the (KeyData, NotificationFunction) is already registered.
3605 for (Link
= Private
->NotifyList
.ForwardLink
; Link
!= &Private
->NotifyList
; Link
= Link
->ForwardLink
) {
3606 CurrentNotify
= TEXT_IN_EX_SPLITTER_NOTIFY_FROM_THIS (Link
);
3607 if (IsKeyRegistered (&CurrentNotify
->KeyData
, KeyData
)) {
3608 if (CurrentNotify
->KeyNotificationFn
== KeyNotificationFunction
) {
3609 *NotifyHandle
= CurrentNotify
->NotifyHandle
;
3616 // Allocate resource to save the notification function
3618 NewNotify
= (TEXT_IN_EX_SPLITTER_NOTIFY
*) AllocateZeroPool (sizeof (TEXT_IN_EX_SPLITTER_NOTIFY
));
3619 if (NewNotify
== NULL
) {
3620 return EFI_OUT_OF_RESOURCES
;
3622 NewNotify
->NotifyHandleList
= (EFI_HANDLE
*) AllocateZeroPool (sizeof (EFI_HANDLE
) * Private
->CurrentNumberOfExConsoles
);
3623 if (NewNotify
->NotifyHandleList
== NULL
) {
3624 gBS
->FreePool (NewNotify
);
3625 return EFI_OUT_OF_RESOURCES
;
3627 NewNotify
->Signature
= TEXT_IN_EX_SPLITTER_NOTIFY_SIGNATURE
;
3628 NewNotify
->KeyNotificationFn
= KeyNotificationFunction
;
3629 NewNotify
->NotifyHandle
= (EFI_HANDLE
) NewNotify
;
3630 CopyMem (&NewNotify
->KeyData
, KeyData
, sizeof (KeyData
));
3633 // Return the wrong status of registering key notify of
3634 // physical console input device if meet problems
3636 for (Index
= 0; Index
< Private
->CurrentNumberOfExConsoles
; Index
++) {
3637 Status
= Private
->TextInExList
[Index
]->RegisterKeyNotify (
3638 Private
->TextInExList
[Index
],
3640 KeyNotificationFunction
,
3641 &NewNotify
->NotifyHandleList
[Index
]
3643 if (EFI_ERROR (Status
)) {
3644 gBS
->FreePool (NewNotify
->NotifyHandleList
);
3645 gBS
->FreePool (NewNotify
);
3650 InsertTailList (&mConIn
.NotifyList
, &NewNotify
->NotifyEntry
);
3652 *NotifyHandle
= NewNotify
->NotifyHandle
;
3660 Remove a registered notification function from a particular keystroke.
3662 @param This Protocol instance pointer.
3663 @param NotificationHandle The handle of the notification function being
3666 @retval EFI_SUCCESS The notification function was unregistered
3668 @retval EFI_INVALID_PARAMETER The NotificationHandle is invalid.
3669 @retval EFI_NOT_FOUND Can not find the matching entry in database.
3674 ConSplitterTextInUnregisterKeyNotify (
3675 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*This
,
3676 IN EFI_HANDLE NotificationHandle
3679 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3682 TEXT_IN_EX_SPLITTER_NOTIFY
*CurrentNotify
;
3685 if (NotificationHandle
== NULL
) {
3686 return EFI_INVALID_PARAMETER
;
3689 if (((TEXT_IN_EX_SPLITTER_NOTIFY
*) NotificationHandle
)->Signature
!= TEXT_IN_EX_SPLITTER_NOTIFY_SIGNATURE
) {
3690 return EFI_INVALID_PARAMETER
;
3693 Private
= TEXT_IN_EX_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
3696 // if no physical console input device exists,
3697 // return EFI_SUCCESS directly.
3699 if (Private
->CurrentNumberOfExConsoles
<= 0) {
3703 for (Link
= Private
->NotifyList
.ForwardLink
; Link
!= &Private
->NotifyList
; Link
= Link
->ForwardLink
) {
3704 CurrentNotify
= TEXT_IN_EX_SPLITTER_NOTIFY_FROM_THIS (Link
);
3705 if (CurrentNotify
->NotifyHandle
== NotificationHandle
) {
3706 for (Index
= 0; Index
< Private
->CurrentNumberOfExConsoles
; Index
++) {
3707 Status
= Private
->TextInExList
[Index
]->UnregisterKeyNotify (
3708 Private
->TextInExList
[Index
],
3709 CurrentNotify
->NotifyHandleList
[Index
]
3711 if (EFI_ERROR (Status
)) {
3715 RemoveEntryList (&CurrentNotify
->NotifyEntry
);
3717 gBS
->FreePool (CurrentNotify
->NotifyHandleList
);
3718 gBS
->FreePool (CurrentNotify
);
3723 return EFI_NOT_FOUND
;
3729 Reset the input device and optionaly run diagnostics
3731 @param This Protocol instance pointer.
3732 @param ExtendedVerification Driver may perform diagnostics on reset.
3734 @retval EFI_SUCCESS The device was reset.
3735 @retval EFI_DEVICE_ERROR The device is not functioning properly and could
3741 ConSplitterSimplePointerReset (
3742 IN EFI_SIMPLE_POINTER_PROTOCOL
*This
,
3743 IN BOOLEAN ExtendedVerification
3747 EFI_STATUS ReturnStatus
;
3748 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3751 Private
= TEXT_IN_SPLITTER_PRIVATE_DATA_FROM_SIMPLE_POINTER_THIS (This
);
3753 Private
->InputEventSignalState
= FALSE
;
3755 if (Private
->CurrentNumberOfPointers
== 0) {
3759 // return the worst status met
3761 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfPointers
; Index
++) {
3762 Status
= Private
->PointerList
[Index
]->Reset (
3763 Private
->PointerList
[Index
],
3764 ExtendedVerification
3766 if (EFI_ERROR (Status
)) {
3767 ReturnStatus
= Status
;
3771 return ReturnStatus
;
3776 Reads the next keystroke from the input device. The WaitForKey Event can
3777 be used to test for existance of a keystroke via WaitForEvent () call.
3779 @param Private Protocol instance pointer.
3780 @param State The state information of simple pointer device.
3782 @retval EFI_SUCCESS The keystroke information was returned.
3783 @retval EFI_NOT_READY There was no keystroke data availiable.
3784 @retval EFI_DEVICE_ERROR The keydtroke information was not returned due
3790 ConSplitterSimplePointerPrivateGetState (
3791 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
3792 IN OUT EFI_SIMPLE_POINTER_STATE
*State
3796 EFI_STATUS ReturnStatus
;
3798 EFI_SIMPLE_POINTER_STATE CurrentState
;
3800 State
->RelativeMovementX
= 0;
3801 State
->RelativeMovementY
= 0;
3802 State
->RelativeMovementZ
= 0;
3803 State
->LeftButton
= FALSE
;
3804 State
->RightButton
= FALSE
;
3807 // if no physical console input device exists, return EFI_NOT_READY;
3808 // if any physical console input device has key input,
3809 // return the key and EFI_SUCCESS.
3811 ReturnStatus
= EFI_NOT_READY
;
3812 for (Index
= 0; Index
< Private
->CurrentNumberOfPointers
; Index
++) {
3814 Status
= Private
->PointerList
[Index
]->GetState (
3815 Private
->PointerList
[Index
],
3818 if (!EFI_ERROR (Status
)) {
3819 if (ReturnStatus
== EFI_NOT_READY
) {
3820 ReturnStatus
= EFI_SUCCESS
;
3823 if (CurrentState
.LeftButton
) {
3824 State
->LeftButton
= TRUE
;
3827 if (CurrentState
.RightButton
) {
3828 State
->RightButton
= TRUE
;
3831 if (CurrentState
.RelativeMovementX
!= 0 && Private
->PointerList
[Index
]->Mode
->ResolutionX
!= 0) {
3832 State
->RelativeMovementX
+= (CurrentState
.RelativeMovementX
* (INT32
) Private
->SimplePointerMode
.ResolutionX
) / (INT32
) Private
->PointerList
[Index
]->Mode
->ResolutionX
;
3835 if (CurrentState
.RelativeMovementY
!= 0 && Private
->PointerList
[Index
]->Mode
->ResolutionY
!= 0) {
3836 State
->RelativeMovementY
+= (CurrentState
.RelativeMovementY
* (INT32
) Private
->SimplePointerMode
.ResolutionY
) / (INT32
) Private
->PointerList
[Index
]->Mode
->ResolutionY
;
3839 if (CurrentState
.RelativeMovementZ
!= 0 && Private
->PointerList
[Index
]->Mode
->ResolutionZ
!= 0) {
3840 State
->RelativeMovementZ
+= (CurrentState
.RelativeMovementZ
* (INT32
) Private
->SimplePointerMode
.ResolutionZ
) / (INT32
) Private
->PointerList
[Index
]->Mode
->ResolutionZ
;
3842 } else if (Status
== EFI_DEVICE_ERROR
) {
3843 ReturnStatus
= EFI_DEVICE_ERROR
;
3847 return ReturnStatus
;
3852 Reads the next keystroke from the input device. The WaitForKey Event can
3853 be used to test for existance of a keystroke via WaitForEvent () call.
3855 @param This A pointer to protocol instance.
3856 @param State A pointer to state information on the pointer device
3858 @retval EFI_SUCCESS The keystroke information was returned in State.
3859 @retval EFI_NOT_READY There was no keystroke data availiable.
3860 @retval EFI_DEVICE_ERROR The keydtroke information was not returned due
3866 ConSplitterSimplePointerGetState (
3867 IN EFI_SIMPLE_POINTER_PROTOCOL
*This
,
3868 IN OUT EFI_SIMPLE_POINTER_STATE
*State
3871 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3873 Private
= TEXT_IN_SPLITTER_PRIVATE_DATA_FROM_SIMPLE_POINTER_THIS (This
);
3875 Private
->InputEventSignalState
= FALSE
;
3877 return ConSplitterSimplePointerPrivateGetState (Private
, State
);
3882 This event agregates all the events of the ConIn devices in the spliter.
3883 If any events of physical ConIn devices are signaled, signal the ConIn
3884 spliter event. This will cause the calling code to call
3885 ConSplitterTextInReadKeyStroke ().
3887 @param Event The Event assoicated with callback.
3888 @param Context Context registered when Event was created.
3893 ConSplitterSimplePointerWaitForInput (
3899 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3902 Private
= (TEXT_IN_SPLITTER_PRIVATE_DATA
*) Context
;
3905 // if InputEventSignalState is flagged before, and not cleared by Reset() or ReadKeyStroke()
3907 if (Private
->InputEventSignalState
) {
3908 gBS
->SignalEvent (Event
);
3912 // if any physical console input device has key input, signal the event.
3914 for (Index
= 0; Index
< Private
->CurrentNumberOfPointers
; Index
++) {
3915 Status
= gBS
->CheckEvent (Private
->PointerList
[Index
]->WaitForInput
);
3916 if (!EFI_ERROR (Status
)) {
3917 gBS
->SignalEvent (Event
);
3918 Private
->InputEventSignalState
= TRUE
;
3924 Resets the pointer device hardware.
3926 @param This Protocol instance pointer.
3927 @param ExtendedVerification Driver may perform diagnostics on reset.
3929 @retval EFI_SUCCESS The device was reset.
3930 @retval EFI_DEVICE_ERROR The device is not functioning correctly and
3936 ConSplitterAbsolutePointerReset (
3937 IN EFI_ABSOLUTE_POINTER_PROTOCOL
*This
,
3938 IN BOOLEAN ExtendedVerification
3942 EFI_STATUS ReturnStatus
;
3943 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3946 Private
= TEXT_IN_SPLITTER_PRIVATE_DATA_FROM_ABSOLUTE_POINTER_THIS (This
);
3948 Private
->AbsoluteInputEventSignalState
= FALSE
;
3950 if (Private
->CurrentNumberOfAbsolutePointers
== 0) {
3954 // return the worst status met
3956 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfAbsolutePointers
; Index
++) {
3957 Status
= Private
->AbsolutePointerList
[Index
]->Reset (
3958 Private
->AbsolutePointerList
[Index
],
3959 ExtendedVerification
3961 if (EFI_ERROR (Status
)) {
3962 ReturnStatus
= Status
;
3966 return ReturnStatus
;
3971 Retrieves the current state of a pointer device.
3973 @param This Protocol instance pointer.
3974 @param State A pointer to the state information on the
3977 @retval EFI_SUCCESS The state of the pointer device was returned in
3979 @retval EFI_NOT_READY The state of the pointer device has not changed
3980 since the last call to GetState().
3981 @retval EFI_DEVICE_ERROR A device error occurred while attempting to
3982 retrieve the pointer device's current state.
3987 ConSplitterAbsolutePointerGetState (
3988 IN EFI_ABSOLUTE_POINTER_PROTOCOL
*This
,
3989 IN OUT EFI_ABSOLUTE_POINTER_STATE
*State
3992 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3994 EFI_STATUS ReturnStatus
;
3996 EFI_ABSOLUTE_POINTER_STATE CurrentState
;
3999 Private
= TEXT_IN_SPLITTER_PRIVATE_DATA_FROM_ABSOLUTE_POINTER_THIS (This
);
4001 Private
->AbsoluteInputEventSignalState
= FALSE
;
4003 State
->CurrentX
= 0;
4004 State
->CurrentY
= 0;
4005 State
->CurrentZ
= 0;
4006 State
->ActiveButtons
= 0;
4009 // if no physical pointer device exists, return EFI_NOT_READY;
4010 // if any physical pointer device has changed state,
4011 // return the state and EFI_SUCCESS.
4013 ReturnStatus
= EFI_NOT_READY
;
4014 for (Index
= 0; Index
< Private
->CurrentNumberOfAbsolutePointers
; Index
++) {
4016 Status
= Private
->AbsolutePointerList
[Index
]->GetState (
4017 Private
->AbsolutePointerList
[Index
],
4020 if (!EFI_ERROR (Status
)) {
4021 if (ReturnStatus
== EFI_NOT_READY
) {
4022 ReturnStatus
= EFI_SUCCESS
;
4025 State
->ActiveButtons
= CurrentState
.ActiveButtons
;
4027 if (!(Private
->AbsolutePointerMode
.AbsoluteMinX
== 0 && Private
->AbsolutePointerMode
.AbsoluteMaxX
== 0)) {
4028 State
->CurrentX
= CurrentState
.CurrentX
;
4030 if (!(Private
->AbsolutePointerMode
.AbsoluteMinY
== 0 && Private
->AbsolutePointerMode
.AbsoluteMaxY
== 0)) {
4031 State
->CurrentY
= CurrentState
.CurrentY
;
4033 if (!(Private
->AbsolutePointerMode
.AbsoluteMinZ
== 0 && Private
->AbsolutePointerMode
.AbsoluteMaxZ
== 0)) {
4034 State
->CurrentZ
= CurrentState
.CurrentZ
;
4037 } else if (Status
== EFI_DEVICE_ERROR
) {
4038 ReturnStatus
= EFI_DEVICE_ERROR
;
4042 return ReturnStatus
;
4047 This event agregates all the events of the pointer devices in the splitter.
4048 If any events of physical pointer devices are signaled, signal the pointer
4049 splitter event. This will cause the calling code to call
4050 ConSplitterAbsolutePointerGetState ().
4052 @param Event The Event assoicated with callback.
4053 @param Context Context registered when Event was created.
4058 ConSplitterAbsolutePointerWaitForInput (
4064 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
4067 Private
= (TEXT_IN_SPLITTER_PRIVATE_DATA
*) Context
;
4070 // if AbsoluteInputEventSignalState is flagged before,
4071 // and not cleared by Reset() or GetState(), signal it
4073 if (Private
->AbsoluteInputEventSignalState
) {
4074 gBS
->SignalEvent (Event
);
4078 // if any physical console input device has key input, signal the event.
4080 for (Index
= 0; Index
< Private
->CurrentNumberOfAbsolutePointers
; Index
++) {
4081 Status
= gBS
->CheckEvent (Private
->AbsolutePointerList
[Index
]->WaitForInput
);
4082 if (!EFI_ERROR (Status
)) {
4083 gBS
->SignalEvent (Event
);
4084 Private
->AbsoluteInputEventSignalState
= TRUE
;
4091 Reset the text output device hardware and optionaly run diagnostics
4093 @param This Protocol instance pointer.
4094 @param ExtendedVerification Driver may perform more exhaustive verfication
4095 operation of the device during reset.
4097 @retval EFI_SUCCESS The text output device was reset.
4098 @retval EFI_DEVICE_ERROR The text output device is not functioning
4099 correctly and could not be reset.
4104 ConSplitterTextOutReset (
4105 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
4106 IN BOOLEAN ExtendedVerification
4110 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
4112 EFI_STATUS ReturnStatus
;
4114 Private
= TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
4117 // return the worst status met
4119 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
4120 Status
= Private
->TextOutList
[Index
].TextOut
->Reset (
4121 Private
->TextOutList
[Index
].TextOut
,
4122 ExtendedVerification
4124 if (EFI_ERROR (Status
)) {
4125 ReturnStatus
= Status
;
4129 This
->SetAttribute (This
, EFI_TEXT_ATTR (This
->Mode
->Attribute
& 0x0F, EFI_BLACK
));
4132 // reset all mode parameters
4134 TextOutSetMode (Private
, 0);
4136 return ReturnStatus
;
4141 Write a Unicode string to the output device.
4143 @param This Protocol instance pointer.
4144 @param WString The NULL-terminated Unicode string to be
4145 displayed on the output device(s). All output
4146 devices must also support the Unicode drawing
4147 defined in this file.
4149 @retval EFI_SUCCESS The string was output to the device.
4150 @retval EFI_DEVICE_ERROR The device reported an error while attempting to
4152 @retval EFI_UNSUPPORTED The output device's mode is not currently in a
4154 @retval EFI_WARN_UNKNOWN_GLYPH This warning code indicates that some of the
4155 characters in the Unicode string could not be
4156 rendered and were skipped.
4161 ConSplitterTextOutOutputString (
4162 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
4167 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
4169 UINTN BackSpaceCount
;
4170 EFI_STATUS ReturnStatus
;
4171 CHAR16
*TargetString
;
4173 This
->SetAttribute (This
, This
->Mode
->Attribute
);
4175 Private
= TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
4179 for (TargetString
= WString
; *TargetString
!= L
'\0'; TargetString
++) {
4180 if (*TargetString
== CHAR_BACKSPACE
) {
4185 if (BackSpaceCount
== 0) {
4186 TargetString
= WString
;
4188 TargetString
= AllocatePool (sizeof (CHAR16
) * (StrLen (WString
) + BackSpaceCount
+ 1));
4189 ASSERT (TargetString
!= NULL
);
4191 StrCpy (TargetString
, WString
);
4194 // return the worst status met
4196 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
4197 Status
= Private
->TextOutList
[Index
].TextOut
->OutputString (
4198 Private
->TextOutList
[Index
].TextOut
,
4201 if (EFI_ERROR (Status
)) {
4202 ReturnStatus
= Status
;
4206 if (Private
->CurrentNumberOfConsoles
> 0) {
4207 Private
->TextOutMode
.CursorColumn
= Private
->TextOutList
[0].TextOut
->Mode
->CursorColumn
;
4208 Private
->TextOutMode
.CursorRow
= Private
->TextOutList
[0].TextOut
->Mode
->CursorRow
;
4211 if (BackSpaceCount
> 0) {
4212 FreePool (TargetString
);
4215 return ReturnStatus
;
4220 Verifies that all characters in a Unicode string can be output to the
4223 @param This Protocol instance pointer.
4224 @param WString The NULL-terminated Unicode string to be
4225 examined for the output device(s).
4227 @retval EFI_SUCCESS The device(s) are capable of rendering the
4229 @retval EFI_UNSUPPORTED Some of the characters in the Unicode string
4230 cannot be rendered by one or more of the output
4231 devices mapped by the EFI handle.
4236 ConSplitterTextOutTestString (
4237 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
4242 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
4244 EFI_STATUS ReturnStatus
;
4246 Private
= TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
4249 // return the worst status met
4251 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
4252 Status
= Private
->TextOutList
[Index
].TextOut
->TestString (
4253 Private
->TextOutList
[Index
].TextOut
,
4256 if (EFI_ERROR (Status
)) {
4257 ReturnStatus
= Status
;
4261 // There is no DevNullTextOutTestString () since a Unicode buffer would
4262 // always return EFI_SUCCESS.
4263 // ReturnStatus will be EFI_SUCCESS if no consoles are present
4265 return ReturnStatus
;
4270 Returns information for an available text mode that the output device(s)
4273 @param This Protocol instance pointer.
4274 @param ModeNumber The mode number to return information on.
4275 @param Columns Returns the columns of the text output device
4276 for the requested ModeNumber.
4277 @param Rows Returns the rows of the text output device
4278 for the requested ModeNumber.
4280 @retval EFI_SUCCESS The requested mode information was returned.
4281 @retval EFI_DEVICE_ERROR The device had an error and could not complete
4283 @retval EFI_UNSUPPORTED The mode number was not valid.
4288 ConSplitterTextOutQueryMode (
4289 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
4290 IN UINTN ModeNumber
,
4295 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
4297 INT32
*TextOutModeMap
;
4299 Private
= TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
4302 // Check whether param ModeNumber is valid.
4303 // ModeNumber should be within range 0 ~ MaxMode - 1.
4305 if ( (ModeNumber
> (UINTN
)(((UINT32
)-1)>>1)) ) {
4306 return EFI_UNSUPPORTED
;
4309 if ((INT32
) ModeNumber
>= This
->Mode
->MaxMode
) {
4310 return EFI_UNSUPPORTED
;
4314 // We get the available mode from mode intersection map if it's available
4316 if (Private
->TextOutModeMap
!= NULL
) {
4317 TextOutModeMap
= Private
->TextOutModeMap
+ Private
->TextOutListCount
* ModeNumber
;
4318 CurrentMode
= (UINTN
)(*TextOutModeMap
);
4319 *Columns
= Private
->TextOutQueryData
[CurrentMode
].Columns
;
4320 *Rows
= Private
->TextOutQueryData
[CurrentMode
].Rows
;
4322 *Columns
= Private
->TextOutQueryData
[ModeNumber
].Columns
;
4323 *Rows
= Private
->TextOutQueryData
[ModeNumber
].Rows
;
4326 if (*Columns
<= 0 && *Rows
<= 0) {
4327 return EFI_UNSUPPORTED
;
4336 Sets the output device(s) to a specified mode.
4338 @param This Protocol instance pointer.
4339 @param ModeNumber The mode number to set.
4341 @retval EFI_SUCCESS The requested text mode was set.
4342 @retval EFI_DEVICE_ERROR The device had an error and could not complete
4344 @retval EFI_UNSUPPORTED The mode number was not valid.
4349 ConSplitterTextOutSetMode (
4350 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
4355 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
4357 INT32
*TextOutModeMap
;
4358 EFI_STATUS ReturnStatus
;
4360 Private
= TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
4363 // Check whether param ModeNumber is valid.
4364 // ModeNumber should be within range 0 ~ MaxMode - 1.
4366 if ( (ModeNumber
> (UINTN
)(((UINT32
)-1)>>1)) ) {
4367 return EFI_UNSUPPORTED
;
4370 if ((INT32
) ModeNumber
>= This
->Mode
->MaxMode
) {
4371 return EFI_UNSUPPORTED
;
4374 // If the mode is being set to the curent mode, then just clear the screen and return.
4376 if (Private
->TextOutMode
.Mode
== (INT32
) ModeNumber
) {
4377 return ConSplitterTextOutClearScreen (This
);
4380 // return the worst status met
4382 TextOutModeMap
= Private
->TextOutModeMap
+ Private
->TextOutListCount
* ModeNumber
;
4383 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
4384 Status
= Private
->TextOutList
[Index
].TextOut
->SetMode (
4385 Private
->TextOutList
[Index
].TextOut
,
4386 TextOutModeMap
[Index
]
4389 // If this console device is based on a GOP or UGA device, then sync up the bitmap from
4390 // the GOP/UGA splitter and reclear the text portion of the display in the new mode.
4392 if ((Private
->TextOutList
[Index
].GraphicsOutput
!= NULL
) || (Private
->TextOutList
[Index
].UgaDraw
!= NULL
)) {
4393 Private
->TextOutList
[Index
].TextOut
->ClearScreen (Private
->TextOutList
[Index
].TextOut
);
4396 if (EFI_ERROR (Status
)) {
4397 ReturnStatus
= Status
;
4402 // Set mode parameter to specified mode number
4404 TextOutSetMode (Private
, ModeNumber
);
4406 return ReturnStatus
;
4411 Sets the background and foreground colors for the OutputString () and
4412 ClearScreen () functions.
4414 @param This Protocol instance pointer.
4415 @param Attribute The attribute to set. Bits 0..3 are the
4416 foreground color, and bits 4..6 are the
4417 background color. All other bits are undefined
4418 and must be zero. The valid Attributes are
4419 defined in this file.
4421 @retval EFI_SUCCESS The attribute was set.
4422 @retval EFI_DEVICE_ERROR The device had an error and could not complete
4424 @retval EFI_UNSUPPORTED The attribute requested is not defined.
4429 ConSplitterTextOutSetAttribute (
4430 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
4435 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
4437 EFI_STATUS ReturnStatus
;
4439 Private
= TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
4442 // Check whether param Attribute is valid.
4444 if ( (Attribute
> (UINTN
)(((UINT32
)-1)>>1)) ) {
4445 return EFI_UNSUPPORTED
;
4449 // return the worst status met
4451 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
4452 Status
= Private
->TextOutList
[Index
].TextOut
->SetAttribute (
4453 Private
->TextOutList
[Index
].TextOut
,
4456 if (EFI_ERROR (Status
)) {
4457 ReturnStatus
= Status
;
4461 Private
->TextOutMode
.Attribute
= (INT32
) Attribute
;
4463 return ReturnStatus
;
4468 Clears the output device(s) display to the currently selected background
4471 @param This Protocol instance pointer.
4473 @retval EFI_SUCCESS The operation completed successfully.
4474 @retval EFI_DEVICE_ERROR The device had an error and could not complete
4476 @retval EFI_UNSUPPORTED The output device is not in a valid text mode.
4481 ConSplitterTextOutClearScreen (
4482 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
4486 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
4488 EFI_STATUS ReturnStatus
;
4490 Private
= TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
4493 // return the worst status met
4495 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
4496 Status
= Private
->TextOutList
[Index
].TextOut
->ClearScreen (Private
->TextOutList
[Index
].TextOut
);
4497 if (EFI_ERROR (Status
)) {
4498 ReturnStatus
= Status
;
4503 // No need to do extra check here as whether (Column, Row) is valid has
4504 // been checked in ConSplitterTextOutSetCursorPosition. And (0, 0) should
4505 // always be supported.
4507 Private
->TextOutMode
.CursorColumn
= 0;
4508 Private
->TextOutMode
.CursorRow
= 0;
4509 Private
->TextOutMode
.CursorVisible
= TRUE
;
4511 return ReturnStatus
;
4516 Sets the current coordinates of the cursor position
4518 @param This Protocol instance pointer.
4519 @param Column The column position to set the cursor to. Must be
4520 greater than or equal to zero and less than the
4521 number of columns by QueryMode ().
4522 @param Row The row position to set the cursor to. Must be
4523 greater than or equal to zero and less than the
4524 number of rows by QueryMode ().
4526 @retval EFI_SUCCESS The operation completed successfully.
4527 @retval EFI_DEVICE_ERROR The device had an error and could not complete
4529 @retval EFI_UNSUPPORTED The output device is not in a valid text mode,
4530 or the cursor position is invalid for the
4536 ConSplitterTextOutSetCursorPosition (
4537 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
4543 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
4545 EFI_STATUS ReturnStatus
;
4548 INT32
*TextOutModeMap
;
4552 Private
= TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
4553 TextOutModeMap
= NULL
;
4554 ModeNumber
= Private
->TextOutMode
.Mode
;
4557 // Get current MaxColumn and MaxRow from intersection map
4559 if (Private
->TextOutModeMap
!= NULL
) {
4560 TextOutModeMap
= Private
->TextOutModeMap
+ Private
->TextOutListCount
* ModeNumber
;
4561 CurrentMode
= *TextOutModeMap
;
4563 CurrentMode
= ModeNumber
;
4566 MaxColumn
= Private
->TextOutQueryData
[CurrentMode
].Columns
;
4567 MaxRow
= Private
->TextOutQueryData
[CurrentMode
].Rows
;
4569 if (Column
>= MaxColumn
|| Row
>= MaxRow
) {
4570 return EFI_UNSUPPORTED
;
4573 // return the worst status met
4575 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
4576 Status
= Private
->TextOutList
[Index
].TextOut
->SetCursorPosition (
4577 Private
->TextOutList
[Index
].TextOut
,
4581 if (EFI_ERROR (Status
)) {
4582 ReturnStatus
= Status
;
4587 // No need to do extra check here as whether (Column, Row) is valid has
4588 // been checked in ConSplitterTextOutSetCursorPosition. And (0, 0) should
4589 // always be supported.
4591 Private
->TextOutMode
.CursorColumn
= (INT32
) Column
;
4592 Private
->TextOutMode
.CursorRow
= (INT32
) Row
;
4594 return ReturnStatus
;
4599 Makes the cursor visible or invisible
4601 @param This Protocol instance pointer.
4602 @param Visible If TRUE, the cursor is set to be visible. If
4603 FALSE, the cursor is set to be invisible.
4605 @retval EFI_SUCCESS The operation completed successfully.
4606 @retval EFI_DEVICE_ERROR The device had an error and could not complete
4607 the request, or the device does not support
4608 changing the cursor mode.
4609 @retval EFI_UNSUPPORTED The output device is not in a valid text mode.
4614 ConSplitterTextOutEnableCursor (
4615 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
4620 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
4622 EFI_STATUS ReturnStatus
;
4624 Private
= TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
4627 // return the worst status met
4629 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
4630 Status
= Private
->TextOutList
[Index
].TextOut
->EnableCursor (
4631 Private
->TextOutList
[Index
].TextOut
,
4634 if (EFI_ERROR (Status
)) {
4635 ReturnStatus
= Status
;
4639 Private
->TextOutMode
.CursorVisible
= Visible
;
4641 return ReturnStatus
;