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 ConSplitterUgaDrawGetMode
,
111 ConSplitterUgaDrawSetMode
,
112 ConSplitterUgaDrawBlt
116 // Graphics Output Protocol Private Data template
118 GLOBAL_REMOVE_IF_UNREFERENCED EFI_GRAPHICS_OUTPUT_PROTOCOL mGraphicsOutputProtocolTemplate
= {
119 ConSplitterGraphicsOutputQueryMode
,
120 ConSplitterGraphicsOutputSetMode
,
121 ConSplitterGraphicsOutputBlt
,
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 ConSplitterUgaDrawSetMode (&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 // Construct console output devices' private data
1322 Status
= ConSplitterTextOutConstructor (&mStdErr
);
1323 if (EFI_ERROR (Status
)) {
1329 // Start ConSplitter on ControllerHandle, and create the virtual
1330 // agrogated console device on first call Start for a StandardError handle.
1332 Status
= ConSplitterStart (
1335 mStdErr
.VirtualHandle
,
1336 &gEfiStandardErrorDeviceGuid
,
1337 &gEfiSimpleTextOutProtocolGuid
,
1340 if (EFI_ERROR (Status
)) {
1345 // When new console device is added, the new mode will be set later,
1346 // so put current mode back to init state.
1348 mStdErr
.TextOutMode
.Mode
= 0xFF;
1351 // If both ConOut and StdErr incorporate the same Text Out device,
1352 // their MaxMode and QueryData should be the intersection of both.
1354 Status
= ConSplitterTextOutAddDevice (&mStdErr
, TextOut
, NULL
, NULL
);
1355 ConSplitterTextOutSetAttribute (&mStdErr
.TextOut
, EFI_TEXT_ATTR (EFI_MAGENTA
, EFI_BLACK
));
1356 if (EFI_ERROR (Status
)) {
1360 if (mStdErr
.CurrentNumberOfConsoles
== 1) {
1362 // Create virtual device handle for StdErr Splitter
1364 Status
= gBS
->InstallMultipleProtocolInterfaces (
1365 &mStdErr
.VirtualHandle
,
1366 &gEfiSimpleTextOutProtocolGuid
,
1370 if (EFI_ERROR (Status
)) {
1374 gST
->StandardErrorHandle
= mStdErr
.VirtualHandle
;
1375 gST
->StdErr
= &mStdErr
.TextOut
;
1377 // Update the CRC32 in the EFI System Table header
1380 gBS
->CalculateCrc32 (
1381 (UINT8
*) &gST
->Hdr
,
1382 gST
->Hdr
.HeaderSize
,
1392 Stop ConSplitter on device handle by closing Console Device Guid on device handle
1393 and the console virtual handle.
1395 @param This Protocol instance pointer.
1396 @param ControllerHandle Handle of device.
1397 @param ConSplitterVirtualHandle Console virtual Handle.
1398 @param DeviceGuid The specified Console Device, such as ConInDev,
1400 @param InterfaceGuid The specified protocol to be opened.
1401 @param Interface Protocol interface returned.
1403 @retval EFI_SUCCESS Stop ConSplitter on ControllerHandle successfully.
1404 @retval other Failed to Stop ConSplitter on ControllerHandle.
1409 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1410 IN EFI_HANDLE ControllerHandle
,
1411 IN EFI_HANDLE ConSplitterVirtualHandle
,
1412 IN EFI_GUID
*DeviceGuid
,
1413 IN EFI_GUID
*InterfaceGuid
,
1419 Status
= gBS
->OpenProtocol (
1423 This
->DriverBindingHandle
,
1425 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1427 if (EFI_ERROR (Status
)) {
1431 // close the protocol refered.
1433 gBS
->CloseProtocol (
1436 This
->DriverBindingHandle
,
1437 ConSplitterVirtualHandle
1440 gBS
->CloseProtocol (
1443 This
->DriverBindingHandle
,
1452 Stop Console In ConSplitter on ControllerHandle by closing Console In Devcice GUID.
1454 @param This Driver Binding protocol instance pointer.
1455 @param ControllerHandle Handle of device to stop driver on
1456 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
1457 children is zero stop the entire bus driver.
1458 @param ChildHandleBuffer List of Child Handles to Stop.
1460 @retval EFI_SUCCESS This driver is removed ControllerHandle
1461 @retval other This driver was not removed from this device
1466 ConSplitterConInDriverBindingStop (
1467 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1468 IN EFI_HANDLE ControllerHandle
,
1469 IN UINTN NumberOfChildren
,
1470 IN EFI_HANDLE
*ChildHandleBuffer
1474 EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*TextIn
;
1475 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*TextInEx
;
1477 if (NumberOfChildren
== 0) {
1481 Status
= gBS
->OpenProtocol (
1483 &gEfiSimpleTextInputExProtocolGuid
,
1484 (VOID
**) &TextInEx
,
1485 This
->DriverBindingHandle
,
1487 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1489 if (!EFI_ERROR (Status
)) {
1491 // If Simple Text Input Ex protocol exists,
1492 // remove device from Text Input Ex devices list.
1494 Status
= ConSplitterTextInExDeleteDevice (&mConIn
, TextInEx
);
1495 if (EFI_ERROR (Status
)) {
1501 // Close Simple Text In protocol on controller handle and virtual handle.
1503 Status
= ConSplitterStop (
1506 mConIn
.VirtualHandle
,
1507 &gEfiConsoleInDeviceGuid
,
1508 &gEfiSimpleTextInProtocolGuid
,
1511 if (EFI_ERROR (Status
)) {
1516 // Remove device from Text Input devices list.
1518 return ConSplitterTextInDeleteDevice (&mConIn
, TextIn
);
1523 Stop Simple Pointer protocol ConSplitter on ControllerHandle by closing
1524 Simple Pointer protocol.
1526 @param This Driver Binding protocol instance pointer.
1527 @param ControllerHandle Handle of device to stop driver on
1528 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
1529 children is zero stop the entire bus driver.
1530 @param ChildHandleBuffer List of Child Handles to Stop.
1532 @retval EFI_SUCCESS This driver is removed ControllerHandle
1533 @retval other This driver was not removed from this device
1538 ConSplitterSimplePointerDriverBindingStop (
1539 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1540 IN EFI_HANDLE ControllerHandle
,
1541 IN UINTN NumberOfChildren
,
1542 IN EFI_HANDLE
*ChildHandleBuffer
1546 EFI_SIMPLE_POINTER_PROTOCOL
*SimplePointer
;
1548 if (NumberOfChildren
== 0) {
1553 // Close Simple Pointer protocol on controller handle and virtual handle.
1555 Status
= ConSplitterStop (
1558 mConIn
.VirtualHandle
,
1559 &gEfiSimplePointerProtocolGuid
,
1560 &gEfiSimplePointerProtocolGuid
,
1561 (VOID
**) &SimplePointer
1563 if (EFI_ERROR (Status
)) {
1568 // Remove this device from Simple Pointer device list.
1570 return ConSplitterSimplePointerDeleteDevice (&mConIn
, SimplePointer
);
1575 Stop Absolute Pointer protocol ConSplitter on ControllerHandle by closing
1576 Absolute Pointer protocol.
1578 @param This Driver Binding protocol instance pointer.
1579 @param ControllerHandle Handle of device to stop driver on
1580 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
1581 children is zero stop the entire bus driver.
1582 @param ChildHandleBuffer List of Child Handles to Stop.
1584 @retval EFI_SUCCESS This driver is removed ControllerHandle
1585 @retval other This driver was not removed from this device
1590 ConSplitterAbsolutePointerDriverBindingStop (
1591 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1592 IN EFI_HANDLE ControllerHandle
,
1593 IN UINTN NumberOfChildren
,
1594 IN EFI_HANDLE
*ChildHandleBuffer
1598 EFI_ABSOLUTE_POINTER_PROTOCOL
*AbsolutePointer
;
1600 if (NumberOfChildren
== 0) {
1605 // Close Absolute Pointer protocol on controller handle and virtual handle.
1607 Status
= ConSplitterStop (
1610 mConIn
.VirtualHandle
,
1611 &gEfiAbsolutePointerProtocolGuid
,
1612 &gEfiAbsolutePointerProtocolGuid
,
1613 (VOID
**) &AbsolutePointer
1615 if (EFI_ERROR (Status
)) {
1620 // Remove this device from Absolute Pointer device list.
1622 return ConSplitterAbsolutePointerDeleteDevice (&mConIn
, AbsolutePointer
);
1627 Stop Console Out ConSplitter on device handle by closing Console Out Devcice GUID.
1629 @param This Driver Binding protocol instance pointer.
1630 @param ControllerHandle Handle of device to stop driver on
1631 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
1632 children is zero stop the entire bus driver.
1633 @param ChildHandleBuffer List of Child Handles to Stop.
1635 @retval EFI_SUCCESS This driver is removed ControllerHandle
1636 @retval other This driver was not removed from this device
1641 ConSplitterConOutDriverBindingStop (
1642 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1643 IN EFI_HANDLE ControllerHandle
,
1644 IN UINTN NumberOfChildren
,
1645 IN EFI_HANDLE
*ChildHandleBuffer
1649 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*TextOut
;
1651 if (NumberOfChildren
== 0) {
1656 // Close Absolute Pointer protocol on controller handle and virtual handle.
1658 Status
= ConSplitterStop (
1661 mConOut
.VirtualHandle
,
1662 &gEfiConsoleOutDeviceGuid
,
1663 &gEfiSimpleTextOutProtocolGuid
,
1666 if (EFI_ERROR (Status
)) {
1671 // Remove this device from Text Out device list.
1673 return ConSplitterTextOutDeleteDevice (&mConOut
, TextOut
);
1678 Stop Standard Error ConSplitter on ControllerHandle by closing Standard Error GUID.
1680 @param This Driver Binding protocol instance pointer.
1681 @param ControllerHandle Handle of device to stop driver on
1682 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
1683 children is zero stop the entire bus driver.
1684 @param ChildHandleBuffer List of Child Handles to Stop.
1686 @retval EFI_SUCCESS This driver is removed ControllerHandle
1687 @retval other This driver was not removed from this device
1692 ConSplitterStdErrDriverBindingStop (
1693 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
1694 IN EFI_HANDLE ControllerHandle
,
1695 IN UINTN NumberOfChildren
,
1696 IN EFI_HANDLE
*ChildHandleBuffer
1700 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*TextOut
;
1702 if (NumberOfChildren
== 0) {
1707 // Close Standard Error Device on controller handle and virtual handle.
1709 Status
= ConSplitterStop (
1712 mStdErr
.VirtualHandle
,
1713 &gEfiStandardErrorDeviceGuid
,
1714 &gEfiSimpleTextOutProtocolGuid
,
1717 if (EFI_ERROR (Status
)) {
1721 // Delete this console error out device's data structures.
1723 Status
= ConSplitterTextOutDeleteDevice (&mStdErr
, TextOut
);
1724 if (EFI_ERROR (Status
)) {
1728 if (mStdErr
.CurrentNumberOfConsoles
== 0) {
1729 gST
->StandardErrorHandle
= NULL
;
1732 // Update the CRC32 in the EFI System Table header
1735 gBS
->CalculateCrc32 (
1736 (UINT8
*) &gST
->Hdr
,
1737 gST
->Hdr
.HeaderSize
,
1742 // Uninstall Simple Text Output protocol from StdErr Handle.
1744 gBS
->UninstallMultipleProtocolInterfaces (
1745 mStdErr
.VirtualHandle
,
1746 &gEfiSimpleTextOutProtocolGuid
,
1757 Take the passed in Buffer of size SizeOfCount and grow the buffer
1758 by MAX (CONSOLE_SPLITTER_CONSOLES_ALLOC_UNIT, MaxGrow) * SizeOfCount
1759 bytes. Copy the current data in Buffer to the new version of Buffer
1760 and free the old version of buffer.
1762 @param SizeOfCount Size of element in array.
1763 @param Count Current number of elements in array.
1764 @param Buffer Bigger version of passed in Buffer with all the
1767 @retval EFI_SUCCESS Buffer size has grown.
1768 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
1772 ConSplitterGrowBuffer (
1773 IN UINTN SizeOfCount
,
1774 IN OUT UINTN
*Count
,
1775 IN OUT VOID
**Buffer
1781 // grow the buffer to new buffer size,
1782 // copy the old buffer's content to the new-size buffer,
1783 // then free the old buffer.
1785 *Count
+= CONSOLE_SPLITTER_CONSOLES_ALLOC_UNIT
;
1786 Ptr
= ReallocatePool (
1787 SizeOfCount
* ((*Count
) - CONSOLE_SPLITTER_CONSOLES_ALLOC_UNIT
),
1788 SizeOfCount
* (*Count
),
1792 return EFI_OUT_OF_RESOURCES
;
1800 Add Text Input Device in Consplitter Text Input list.
1802 @param Private Text In Splitter pointer.
1803 @param TextIn Simple Text Input protocol pointer.
1805 @retval EFI_SUCCESS Text Input Device added successfully.
1806 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
1810 ConSplitterTextInAddDevice (
1811 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
1812 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*TextIn
1818 // If the Text In List is full, enlarge it by calling ConSplitterGrowBuffer().
1820 if (Private
->CurrentNumberOfConsoles
>= Private
->TextInListCount
) {
1821 Status
= ConSplitterGrowBuffer (
1822 sizeof (EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*),
1823 &Private
->TextInListCount
,
1824 (VOID
**) &Private
->TextInList
1826 if (EFI_ERROR (Status
)) {
1827 return EFI_OUT_OF_RESOURCES
;
1831 // Add the new text-in device data structure into the Text In List.
1833 Private
->TextInList
[Private
->CurrentNumberOfConsoles
] = TextIn
;
1834 Private
->CurrentNumberOfConsoles
++;
1837 // Extra CheckEvent added to reduce the double CheckEvent().
1839 gBS
->CheckEvent (TextIn
->WaitForKey
);
1846 Remove Text Input Device from Consplitter Text Input list.
1848 @param Private Text In Splitter pointer.
1849 @param TextIn Simple Text protocol pointer.
1851 @retval EFI_SUCCESS Simple Text Device removed successfully.
1852 @retval EFI_NOT_FOUND No Simple Text Device found.
1856 ConSplitterTextInDeleteDevice (
1857 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
1858 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*TextIn
1863 // Remove the specified text-in device data structure from the Text In List,
1864 // and rearrange the remaining data structures in the Text In List.
1866 for (Index
= 0; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
1867 if (Private
->TextInList
[Index
] == TextIn
) {
1868 for (Index
= Index
; Index
< Private
->CurrentNumberOfConsoles
- 1; Index
++) {
1869 Private
->TextInList
[Index
] = Private
->TextInList
[Index
+ 1];
1872 Private
->CurrentNumberOfConsoles
--;
1877 return EFI_NOT_FOUND
;
1881 Add Text Input Ex Device in Consplitter Text Input Ex list.
1883 @param Private Text In Splitter pointer.
1884 @param TextInEx Simple Text Input Ex Input protocol pointer.
1886 @retval EFI_SUCCESS Text Input Ex Device added successfully.
1887 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
1891 ConSplitterTextInExAddDevice (
1892 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
1893 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*TextInEx
1899 // If the Text Input Ex List is full, enlarge it by calling ConSplitterGrowBuffer().
1901 if (Private
->CurrentNumberOfExConsoles
>= Private
->TextInExListCount
) {
1902 Status
= ConSplitterGrowBuffer (
1903 sizeof (EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*),
1904 &Private
->TextInExListCount
,
1905 (VOID
**) &Private
->TextInExList
1907 if (EFI_ERROR (Status
)) {
1908 return EFI_OUT_OF_RESOURCES
;
1912 // Add the new text-in device data structure into the Text Input Ex List.
1914 Private
->TextInExList
[Private
->CurrentNumberOfExConsoles
] = TextInEx
;
1915 Private
->CurrentNumberOfExConsoles
++;
1918 // Extra CheckEvent added to reduce the double CheckEvent().
1920 gBS
->CheckEvent (TextInEx
->WaitForKeyEx
);
1926 Remove Text Ex Device from Consplitter Text Input Ex list.
1928 @param Private Text In Splitter pointer.
1929 @param TextInEx Simple Text Ex protocol pointer.
1931 @retval EFI_SUCCESS Simple Text Input Ex Device removed successfully.
1932 @retval EFI_NOT_FOUND No Simple Text Input Ex Device found.
1936 ConSplitterTextInExDeleteDevice (
1937 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
1938 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*TextInEx
1943 // Remove the specified text-in device data structure from the Text Input Ex List,
1944 // and rearrange the remaining data structures in the Text In List.
1946 for (Index
= 0; Index
< Private
->CurrentNumberOfExConsoles
; Index
++) {
1947 if (Private
->TextInExList
[Index
] == TextInEx
) {
1948 for (Index
= Index
; Index
< Private
->CurrentNumberOfExConsoles
- 1; Index
++) {
1949 Private
->TextInExList
[Index
] = Private
->TextInExList
[Index
+ 1];
1952 Private
->CurrentNumberOfExConsoles
--;
1957 return EFI_NOT_FOUND
;
1962 Add Simple Pointer Device in Consplitter Simple Pointer list.
1964 @param Private Text In Splitter pointer.
1965 @param SimplePointer Simple Pointer protocol pointer.
1967 @retval EFI_SUCCESS Simple Pointer Device added successfully.
1968 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
1972 ConSplitterSimplePointerAddDevice (
1973 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
1974 IN EFI_SIMPLE_POINTER_PROTOCOL
*SimplePointer
1980 // If the Simple Pointer List is full, enlarge it by calling ConSplitterGrowBuffer().
1982 if (Private
->CurrentNumberOfPointers
>= Private
->PointerListCount
) {
1983 Status
= ConSplitterGrowBuffer (
1984 sizeof (EFI_SIMPLE_POINTER_PROTOCOL
*),
1985 &Private
->PointerListCount
,
1986 (VOID
**) &Private
->PointerList
1988 if (EFI_ERROR (Status
)) {
1989 return EFI_OUT_OF_RESOURCES
;
1993 // Add the new text-in device data structure into the Simple Pointer List.
1995 Private
->PointerList
[Private
->CurrentNumberOfPointers
] = SimplePointer
;
1996 Private
->CurrentNumberOfPointers
++;
2003 Remove Simple Pointer Device from Consplitter Simple Pointer list.
2005 @param Private Text In Splitter pointer.
2006 @param SimplePointer Simple Pointer protocol pointer.
2008 @retval EFI_SUCCESS Simple Pointer Device removed successfully.
2009 @retval EFI_NOT_FOUND No Simple Pointer Device found.
2013 ConSplitterSimplePointerDeleteDevice (
2014 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
2015 IN EFI_SIMPLE_POINTER_PROTOCOL
*SimplePointer
2020 // Remove the specified text-in device data structure from the Simple Pointer List,
2021 // and rearrange the remaining data structures in the Text In List.
2023 for (Index
= 0; Index
< Private
->CurrentNumberOfPointers
; Index
++) {
2024 if (Private
->PointerList
[Index
] == SimplePointer
) {
2025 for (Index
= Index
; Index
< Private
->CurrentNumberOfPointers
- 1; Index
++) {
2026 Private
->PointerList
[Index
] = Private
->PointerList
[Index
+ 1];
2029 Private
->CurrentNumberOfPointers
--;
2034 return EFI_NOT_FOUND
;
2039 Add Absolute Pointer Device in Consplitter Absolute Pointer list.
2041 @param Private Text In Splitter pointer.
2042 @param AbsolutePointer Absolute Pointer protocol pointer.
2044 @retval EFI_SUCCESS Absolute Pointer Device added successfully.
2045 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
2049 ConSplitterAbsolutePointerAddDevice (
2050 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
2051 IN EFI_ABSOLUTE_POINTER_PROTOCOL
*AbsolutePointer
2057 // If the Absolute Pointer List is full, enlarge it by calling ConSplitterGrowBuffer().
2059 if (Private
->CurrentNumberOfAbsolutePointers
>= Private
->AbsolutePointerListCount
) {
2060 Status
= ConSplitterGrowBuffer (
2061 sizeof (EFI_ABSOLUTE_POINTER_PROTOCOL
*),
2062 &Private
->AbsolutePointerListCount
,
2063 (VOID
**) &Private
->AbsolutePointerList
2065 if (EFI_ERROR (Status
)) {
2066 return EFI_OUT_OF_RESOURCES
;
2070 // Add the new text-in device data structure into the Absolute Pointer List.
2072 Private
->AbsolutePointerList
[Private
->CurrentNumberOfAbsolutePointers
] = AbsolutePointer
;
2073 Private
->CurrentNumberOfAbsolutePointers
++;
2080 Remove Absolute Pointer Device from Consplitter Absolute Pointer list.
2082 @param Private Text In Splitter pointer.
2083 @param AbsolutePointer Absolute Pointer protocol pointer.
2085 @retval EFI_SUCCESS Absolute Pointer Device removed successfully.
2086 @retval EFI_NOT_FOUND No Absolute Pointer Device found.
2090 ConSplitterAbsolutePointerDeleteDevice (
2091 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
2092 IN EFI_ABSOLUTE_POINTER_PROTOCOL
*AbsolutePointer
2097 // Remove the specified text-in device data structure from the Absolute Pointer List,
2098 // and rearrange the remaining data structures from the Absolute Pointer List.
2100 for (Index
= 0; Index
< Private
->CurrentNumberOfAbsolutePointers
; Index
++) {
2101 if (Private
->AbsolutePointerList
[Index
] == AbsolutePointer
) {
2102 for (Index
= Index
; Index
< Private
->CurrentNumberOfAbsolutePointers
- 1; Index
++) {
2103 Private
->AbsolutePointerList
[Index
] = Private
->AbsolutePointerList
[Index
+ 1];
2106 Private
->CurrentNumberOfAbsolutePointers
--;
2111 return EFI_NOT_FOUND
;
2115 Reallocate Text Out mode map.
2117 Allocate new buffer and copy original buffer into the new buffer.
2119 @param Private Consplitter Text Out pointer.
2121 @retval EFI_SUCCESS Buffer size has grown
2122 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
2126 ConSplitterGrowMapTable (
2127 IN TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
2133 INT32
*TextOutModeMap
;
2134 INT32
*OldTextOutModeMap
;
2138 NewSize
= Private
->TextOutListCount
* sizeof (INT32
);
2139 OldTextOutModeMap
= Private
->TextOutModeMap
;
2140 TotalSize
= NewSize
* (Private
->TextOutQueryDataCount
);
2143 // Allocate new buffer for Text Out List.
2145 TextOutModeMap
= AllocatePool (TotalSize
);
2146 if (TextOutModeMap
== NULL
) {
2147 return EFI_OUT_OF_RESOURCES
;
2150 SetMem (TextOutModeMap
, TotalSize
, 0xFF);
2151 Private
->TextOutModeMap
= TextOutModeMap
;
2154 // If TextOutList has been enlarged, need to realloc the mode map table
2155 // The mode map table is regarded as a two dimension array.
2158 // 0 ---------> TextOutListCount ----> TextOutListCount
2159 // | -------------------------------------------
2166 // -------------------------------------------
2169 if (OldTextOutModeMap
!= NULL
) {
2171 Size
= Private
->CurrentNumberOfConsoles
* sizeof (INT32
);
2173 SrcAddress
= OldTextOutModeMap
;
2176 // Copy the old data to the new one
2178 while (Index
< Private
->TextOutMode
.MaxMode
) {
2179 CopyMem (TextOutModeMap
, SrcAddress
, Size
);
2180 TextOutModeMap
+= NewSize
;
2185 // Free the old buffer
2187 FreePool (OldTextOutModeMap
);
2195 Add new device's output mode to console splitter's mode list.
2197 @param Private Text Out Splitter pointer
2198 @param TextOut Simple Text Output protocol pointer.
2200 @retval EFI_SUCCESS Device added successfully.
2201 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
2205 ConSplitterAddOutputMode (
2206 IN TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
,
2207 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*TextOut
2215 MaxMode
= TextOut
->Mode
->MaxMode
;
2216 Private
->TextOutMode
.MaxMode
= MaxMode
;
2219 // Grow the buffer if query data buffer is not large enough to
2220 // hold all the mode supported by the first console.
2222 while (MaxMode
> (INT32
) Private
->TextOutQueryDataCount
) {
2223 Status
= ConSplitterGrowBuffer (
2224 sizeof (TEXT_OUT_SPLITTER_QUERY_DATA
),
2225 &Private
->TextOutQueryDataCount
,
2226 (VOID
**) &Private
->TextOutQueryData
2228 if (EFI_ERROR (Status
)) {
2229 return EFI_OUT_OF_RESOURCES
;
2233 // Allocate buffer for the output mode map
2235 Status
= ConSplitterGrowMapTable (Private
);
2236 if (EFI_ERROR (Status
)) {
2237 return EFI_OUT_OF_RESOURCES
;
2240 // As the first textout device, directly add the mode in to QueryData
2241 // and at the same time record the mapping between QueryData and TextOut.
2245 while (Mode
< MaxMode
) {
2246 Status
= TextOut
->QueryMode (
2249 &Private
->TextOutQueryData
[Mode
].Columns
,
2250 &Private
->TextOutQueryData
[Mode
].Rows
2253 // If mode 1 (80x50) is not supported, make sure mode 1 in TextOutQueryData
2256 if ((EFI_ERROR(Status
)) && (Mode
== 1)) {
2257 Private
->TextOutQueryData
[Mode
].Columns
= 0;
2258 Private
->TextOutQueryData
[Mode
].Rows
= 0;
2260 Private
->TextOutModeMap
[Index
] = Mode
;
2262 Index
+= Private
->TextOutListCount
;
2269 Reconstruct TextOutModeMap to get intersection of modes.
2271 This routine reconstruct TextOutModeMap to get the intersection
2272 of modes for all console out devices. Because EFI/UEFI spec require
2273 mode 0 is 80x25, mode 1 is 80x50, this routine will not check the
2274 intersection for mode 0 and mode 1.
2276 @param TextOutModeMap Current text out mode map, begin with the mode 80x25
2277 @param NewlyAddedMap New text out mode map, begin with the mode 80x25
2278 @param MapStepSize Mode step size for one console device
2279 @param NewMapStepSize New Mode step size for one console device
2280 @param MaxMode IN: Current max text mode, OUT: Updated max text mode.
2281 @param CurrentMode IN: Current text mode, OUT: Updated current text mode.
2285 ConSplitterGetIntersection (
2286 IN INT32
*TextOutModeMap
,
2287 IN INT32
*NewlyAddedMap
,
2288 IN UINTN MapStepSize
,
2289 IN UINTN NewMapStepSize
,
2290 IN OUT INT32
*MaxMode
,
2291 IN OUT INT32
*CurrentMode
2295 INT32
*CurrentMapEntry
;
2296 INT32
*NextMapEntry
;
2298 INT32 CurrentMaxMode
;
2302 // According to EFI/UEFI spec, mode 0 and mode 1 have been reserved
2303 // for 80x25 and 80x50 in Simple Text Out protocol, so don't make intersection
2304 // for mode 0 and mode 1, mode number starts from 2.
2307 CurrentMapEntry
= &TextOutModeMap
[MapStepSize
* 2];
2308 NextMapEntry
= CurrentMapEntry
;
2309 NewMapEntry
= &NewlyAddedMap
[NewMapStepSize
* 2];
2311 CurrentMaxMode
= *MaxMode
;
2312 Mode
= *CurrentMode
;
2314 while (Index
< CurrentMaxMode
) {
2315 if (*NewMapEntry
== -1) {
2317 // This mode is not supported any more. Remove it. Special care
2318 // must be taken as this remove will also affect current mode;
2320 if (Index
== *CurrentMode
) {
2322 } else if (Index
< *CurrentMode
) {
2327 if (CurrentMapEntry
!= NextMapEntry
) {
2328 CopyMem (NextMapEntry
, CurrentMapEntry
, MapStepSize
* sizeof (INT32
));
2331 NextMapEntry
+= MapStepSize
;
2334 CurrentMapEntry
+= MapStepSize
;
2335 NewMapEntry
+= NewMapStepSize
;
2339 *CurrentMode
= Mode
;
2345 Sync the device's output mode to console splitter's mode list.
2347 @param Private Text Out Splitter pointer.
2348 @param TextOut Simple Text Output protocol pointer.
2352 ConSplitterSyncOutputMode (
2353 IN TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
,
2354 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*TextOut
2357 INT32 CurrentMaxMode
;
2360 INT32
*TextOutModeMap
;
2363 TEXT_OUT_SPLITTER_QUERY_DATA
*TextOutQueryData
;
2370 // Must make sure that current mode won't change even if mode number changes
2372 CurrentMaxMode
= Private
->TextOutMode
.MaxMode
;
2373 TextOutModeMap
= Private
->TextOutModeMap
;
2374 StepSize
= Private
->TextOutListCount
;
2375 TextOutQueryData
= Private
->TextOutQueryData
;
2378 // Query all the mode that the newly added TextOut supports
2381 MapTable
= TextOutModeMap
+ Private
->CurrentNumberOfConsoles
;
2382 while (Mode
< TextOut
->Mode
->MaxMode
) {
2383 Status
= TextOut
->QueryMode (TextOut
, Mode
, &Columns
, &Rows
);
2385 if (EFI_ERROR(Status
)) {
2388 // If mode 1 (80x50) is not supported, make sure mode 1 in TextOutQueryData
2391 MapTable
[StepSize
] = Mode
;
2392 TextOutQueryData
[Mode
].Columns
= 0;
2393 TextOutQueryData
[Mode
].Rows
= 0;
2399 // Search the intersection map and QueryData database to see if they intersects
2402 while (Index
< CurrentMaxMode
) {
2403 QueryMode
= *(TextOutModeMap
+ Index
* StepSize
);
2404 if ((TextOutQueryData
[QueryMode
].Rows
== Rows
) && (TextOutQueryData
[QueryMode
].Columns
== Columns
)) {
2405 MapTable
[Index
* StepSize
] = Mode
;
2413 // Now search the TextOutModeMap table to find the intersection of supported
2414 // mode between ConSplitter and the newly added device.
2416 ConSplitterGetIntersection (
2421 &Private
->TextOutMode
.MaxMode
,
2422 &Private
->TextOutMode
.Mode
2430 Sync output device between ConOut and StdErr output.
2432 @retval EFI_SUCCESS Sync implemented successfully.
2433 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
2437 ConSplitterGetIntersectionBetweenConOutAndStrErr (
2441 UINTN ConOutNumOfConsoles
;
2442 UINTN StdErrNumOfConsoles
;
2443 TEXT_OUT_AND_GOP_DATA
*ConOutTextOutList
;
2444 TEXT_OUT_AND_GOP_DATA
*StdErrTextOutList
;
2448 UINTN ConOutColumns
;
2450 UINTN StdErrColumns
;
2451 INT32 ConOutMaxMode
;
2452 INT32 StdErrMaxMode
;
2457 INT32
*ConOutModeMap
;
2458 INT32
*StdErrModeMap
;
2459 INT32
*ConOutMapTable
;
2460 INT32
*StdErrMapTable
;
2461 TEXT_OUT_SPLITTER_QUERY_DATA
*ConOutQueryData
;
2462 TEXT_OUT_SPLITTER_QUERY_DATA
*StdErrQueryData
;
2463 UINTN ConOutStepSize
;
2464 UINTN StdErrStepSize
;
2465 BOOLEAN FoundTheSameTextOut
;
2466 UINTN ConOutMapTableSize
;
2467 UINTN StdErrMapTableSize
;
2469 ConOutNumOfConsoles
= mConOut
.CurrentNumberOfConsoles
;
2470 StdErrNumOfConsoles
= mStdErr
.CurrentNumberOfConsoles
;
2471 ConOutTextOutList
= mConOut
.TextOutList
;
2472 StdErrTextOutList
= mStdErr
.TextOutList
;
2475 FoundTheSameTextOut
= FALSE
;
2476 while ((Indexi
< ConOutNumOfConsoles
) && (!FoundTheSameTextOut
)) {
2478 while (Indexj
< StdErrNumOfConsoles
) {
2479 if (ConOutTextOutList
->TextOut
== StdErrTextOutList
->TextOut
) {
2480 FoundTheSameTextOut
= TRUE
;
2485 StdErrTextOutList
++;
2489 ConOutTextOutList
++;
2492 if (!FoundTheSameTextOut
) {
2496 // Must make sure that current mode won't change even if mode number changes
2498 ConOutMaxMode
= mConOut
.TextOutMode
.MaxMode
;
2499 ConOutModeMap
= mConOut
.TextOutModeMap
;
2500 ConOutStepSize
= mConOut
.TextOutListCount
;
2501 ConOutQueryData
= mConOut
.TextOutQueryData
;
2503 StdErrMaxMode
= mStdErr
.TextOutMode
.MaxMode
;
2504 StdErrModeMap
= mStdErr
.TextOutModeMap
;
2505 StdErrStepSize
= mStdErr
.TextOutListCount
;
2506 StdErrQueryData
= mStdErr
.TextOutQueryData
;
2509 // Allocate the map table and set the map table's index to -1.
2511 ConOutMapTableSize
= ConOutMaxMode
* sizeof (INT32
);
2512 ConOutMapTable
= AllocateZeroPool (ConOutMapTableSize
);
2513 if (ConOutMapTable
== NULL
) {
2514 return EFI_OUT_OF_RESOURCES
;
2517 SetMem (ConOutMapTable
, ConOutMapTableSize
, 0xFF);
2519 StdErrMapTableSize
= StdErrMaxMode
* sizeof (INT32
);
2520 StdErrMapTable
= AllocateZeroPool (StdErrMapTableSize
);
2521 if (StdErrMapTable
== NULL
) {
2522 return EFI_OUT_OF_RESOURCES
;
2525 SetMem (StdErrMapTable
, StdErrMapTableSize
, 0xFF);
2528 // Find the intersection of the two set of modes. If they actually intersect, the
2529 // correponding entry in the map table is set to 1.
2532 while (Mode
< ConOutMaxMode
) {
2534 // Search the intersection map and QueryData database to see if they intersect
2537 ConOutMode
= *(ConOutModeMap
+ Mode
* ConOutStepSize
);
2538 ConOutRows
= ConOutQueryData
[ConOutMode
].Rows
;
2539 ConOutColumns
= ConOutQueryData
[ConOutMode
].Columns
;
2540 while (Index
< StdErrMaxMode
) {
2541 StdErrMode
= *(StdErrModeMap
+ Index
* StdErrStepSize
);
2542 StdErrRows
= StdErrQueryData
[StdErrMode
].Rows
;
2543 StdErrColumns
= StdErrQueryData
[StdErrMode
].Columns
;
2544 if ((StdErrRows
== ConOutRows
) && (StdErrColumns
== ConOutColumns
)) {
2545 ConOutMapTable
[Mode
] = 1;
2546 StdErrMapTable
[Index
] = 1;
2556 // Now search the TextOutModeMap table to find the intersection of supported
2557 // mode between ConSplitter and the newly added device.
2559 ConSplitterGetIntersection (
2562 mConOut
.TextOutListCount
,
2564 &(mConOut
.TextOutMode
.MaxMode
),
2565 &(mConOut
.TextOutMode
.Mode
)
2568 if (mConOut
.TextOutMode
.Mode
< 0) {
2569 mConOut
.TextOut
.SetMode (&(mConOut
.TextOut
), 0);
2572 ConSplitterGetIntersection (
2575 mStdErr
.TextOutListCount
,
2577 &(mStdErr
.TextOutMode
.MaxMode
),
2578 &(mStdErr
.TextOutMode
.Mode
)
2581 if (mStdErr
.TextOutMode
.Mode
< 0) {
2582 mStdErr
.TextOut
.SetMode (&(mStdErr
.TextOut
), 0);
2585 FreePool (ConOutMapTable
);
2586 FreePool (StdErrMapTable
);
2593 Add Grahpics Output modes into Consplitter Text Out list.
2595 @param Private Text Out Splitter pointer.
2596 @param GraphicsOutput Graphics Output protocol pointer.
2597 @param UgaDraw UGA Draw protocol pointer.
2599 @retval EFI_SUCCESS Output mode added successfully.
2600 @retval other Failed to add output mode.
2604 ConSplitterAddGraphicsOutputMode (
2605 IN TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
,
2606 IN EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
,
2607 IN EFI_UGA_DRAW_PROTOCOL
*UgaDraw
2613 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*Mode
;
2615 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*Info
;
2616 EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE
*CurrentGraphicsOutputMode
;
2617 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*ModeBuffer
;
2618 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*MatchedMode
;
2621 BOOLEAN AlreadyExist
;
2622 UINT32 UgaHorizontalResolution
;
2623 UINT32 UgaVerticalResolution
;
2624 UINT32 UgaColorDepth
;
2625 UINT32 UgaRefreshRate
;
2627 ASSERT (GraphicsOutput
!= NULL
|| UgaDraw
!= NULL
);
2629 CurrentGraphicsOutputMode
= Private
->GraphicsOutput
.Mode
;
2634 if (Private
->CurrentNumberOfUgaDraw
!= 0) {
2636 // If any UGA device has already been added, then there is no need to
2637 // calculate intersection of display mode of different GOP/UGA device,
2638 // since only one display mode will be exported (i.e. user-defined mode)
2643 if (GraphicsOutput
!= NULL
) {
2644 if (Private
->CurrentNumberOfGraphicsOutput
== 0) {
2646 // This is the first Graphics Output device added
2648 CurrentGraphicsOutputMode
->MaxMode
= GraphicsOutput
->Mode
->MaxMode
;
2649 CurrentGraphicsOutputMode
->Mode
= GraphicsOutput
->Mode
->Mode
;
2650 CopyMem (CurrentGraphicsOutputMode
->Info
, GraphicsOutput
->Mode
->Info
, GraphicsOutput
->Mode
->SizeOfInfo
);
2651 CurrentGraphicsOutputMode
->SizeOfInfo
= GraphicsOutput
->Mode
->SizeOfInfo
;
2652 CurrentGraphicsOutputMode
->FrameBufferBase
= GraphicsOutput
->Mode
->FrameBufferBase
;
2653 CurrentGraphicsOutputMode
->FrameBufferSize
= GraphicsOutput
->Mode
->FrameBufferSize
;
2656 // Allocate resource for the private mode buffer
2658 ModeBuffer
= AllocatePool (sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
) * GraphicsOutput
->Mode
->MaxMode
);
2659 if (ModeBuffer
== NULL
) {
2660 return EFI_OUT_OF_RESOURCES
;
2662 FreePool (Private
->GraphicsOutputModeBuffer
);
2663 Private
->GraphicsOutputModeBuffer
= ModeBuffer
;
2666 // Store all supported display modes to the private mode buffer
2669 for (Index
= 0; Index
< GraphicsOutput
->Mode
->MaxMode
; Index
++) {
2671 // The Info buffer would be allocated by callee
2673 Status
= GraphicsOutput
->QueryMode (GraphicsOutput
, (UINT32
) Index
, &SizeOfInfo
, &Info
);
2674 if (EFI_ERROR (Status
)) {
2677 ASSERT ( SizeOfInfo
<= sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
));
2678 CopyMem (Mode
, Info
, SizeOfInfo
);
2684 // Check intersection of display mode
2686 ModeBuffer
= AllocatePool (sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
) * CurrentGraphicsOutputMode
->MaxMode
);
2687 if (ModeBuffer
== NULL
) {
2688 return EFI_OUT_OF_RESOURCES
;
2691 MatchedMode
= ModeBuffer
;
2692 Mode
= &Private
->GraphicsOutputModeBuffer
[0];
2693 for (Index
= 0; Index
< CurrentGraphicsOutputMode
->MaxMode
; Index
++) {
2696 for (NumberIndex
= 0; NumberIndex
< GraphicsOutput
->Mode
->MaxMode
; NumberIndex
++) {
2698 // The Info buffer would be allocated by callee
2700 Status
= GraphicsOutput
->QueryMode (GraphicsOutput
, (UINT32
) NumberIndex
, &SizeOfInfo
, &Info
);
2701 if (EFI_ERROR (Status
)) {
2704 if ((Info
->HorizontalResolution
== Mode
->HorizontalResolution
) &&
2705 (Info
->VerticalResolution
== Mode
->VerticalResolution
)) {
2707 // If GOP device supports one mode in current mode buffer,
2708 // it will be added into matched mode buffer
2718 AlreadyExist
= FALSE
;
2721 // Check if GOP mode has been in the mode buffer, ModeBuffer = MatchedMode at begin.
2723 for (Info
= ModeBuffer
; Info
< MatchedMode
; Info
++) {
2724 if ((Info
->HorizontalResolution
== Mode
->HorizontalResolution
) &&
2725 (Info
->VerticalResolution
== Mode
->VerticalResolution
)) {
2726 AlreadyExist
= TRUE
;
2731 if (!AlreadyExist
) {
2732 CopyMem (MatchedMode
, Mode
, sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
));
2735 // Physical frame buffer is no longer available, change PixelFormat to PixelBltOnly
2737 MatchedMode
->Version
= 0;
2738 MatchedMode
->PixelFormat
= PixelBltOnly
;
2739 ZeroMem (&MatchedMode
->PixelInformation
, sizeof (EFI_PIXEL_BITMASK
));
2749 // Drop the old mode buffer, assign it to a new one
2751 FreePool (Private
->GraphicsOutputModeBuffer
);
2752 Private
->GraphicsOutputModeBuffer
= ModeBuffer
;
2755 // Physical frame buffer is no longer available when there are more than one physical GOP devices
2757 CurrentGraphicsOutputMode
->MaxMode
= (UINT32
) (((UINTN
) MatchedMode
- (UINTN
) ModeBuffer
) / sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
));
2758 CurrentGraphicsOutputMode
->Info
->PixelFormat
= PixelBltOnly
;
2759 ZeroMem (&CurrentGraphicsOutputMode
->Info
->PixelInformation
, sizeof (EFI_PIXEL_BITMASK
));
2760 CurrentGraphicsOutputMode
->SizeOfInfo
= sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
);
2761 CurrentGraphicsOutputMode
->FrameBufferBase
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) NULL
;
2762 CurrentGraphicsOutputMode
->FrameBufferSize
= 0;
2766 // Graphics console driver can ensure the same mode for all GOP devices
2768 for (Index
= 0; Index
< CurrentGraphicsOutputMode
->MaxMode
; Index
++) {
2769 Mode
= &Private
->GraphicsOutputModeBuffer
[Index
];
2770 if ((Mode
->HorizontalResolution
== GraphicsOutput
->Mode
->Info
->HorizontalResolution
) &&
2771 (Mode
->VerticalResolution
== GraphicsOutput
->Mode
->Info
->VerticalResolution
)) {
2772 CurrentIndex
= Index
;
2776 if (Index
>= CurrentGraphicsOutputMode
->MaxMode
) {
2778 // if user defined mode is not found, set to default mode 800x600
2780 for (Index
= 0; Index
< CurrentGraphicsOutputMode
->MaxMode
; Index
++) {
2781 Mode
= &Private
->GraphicsOutputModeBuffer
[Index
];
2782 if ((Mode
->HorizontalResolution
== 800) && (Mode
->VerticalResolution
== 600)) {
2783 CurrentIndex
= Index
;
2788 } else if (UgaDraw
!= NULL
&& FeaturePcdGet (PcdUgaConsumeSupport
)) {
2790 // Graphics console driver can ensure the same mode for all GOP devices
2791 // so we can get the current mode from this video device
2795 &UgaHorizontalResolution
,
2796 &UgaVerticalResolution
,
2801 CurrentGraphicsOutputMode
->MaxMode
= 1;
2802 Info
= CurrentGraphicsOutputMode
->Info
;
2804 Info
->HorizontalResolution
= UgaHorizontalResolution
;
2805 Info
->VerticalResolution
= UgaVerticalResolution
;
2806 Info
->PixelFormat
= PixelBltOnly
;
2807 Info
->PixelsPerScanLine
= UgaHorizontalResolution
;
2808 CurrentGraphicsOutputMode
->SizeOfInfo
= sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
);
2809 CurrentGraphicsOutputMode
->FrameBufferBase
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) NULL
;
2810 CurrentGraphicsOutputMode
->FrameBufferSize
= 0;
2813 // Update the private mode buffer
2815 CopyMem (&Private
->GraphicsOutputModeBuffer
[0], Info
, sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
));
2818 // Only mode 0 is available to be set
2825 if (GraphicsOutput
!= NULL
) {
2826 Private
->CurrentNumberOfGraphicsOutput
++;
2828 if (UgaDraw
!= NULL
&& FeaturePcdGet (PcdUgaConsumeSupport
)) {
2829 Private
->CurrentNumberOfUgaDraw
++;
2833 // Force GraphicsOutput mode to be set,
2834 // regardless whether the console is in EfiConsoleControlScreenGraphics or EfiConsoleControlScreenText mode
2836 Private
->HardwareNeedsStarting
= TRUE
;
2838 // Current mode number may need update now, so set it to an invalid mode number
2840 CurrentGraphicsOutputMode
->Mode
= 0xffff;
2842 // Graphics console can ensure all GOP devices have the same mode which can be taken as current mode.
2844 Status
= Private
->GraphicsOutput
.SetMode (&Private
->GraphicsOutput
, (UINT32
) CurrentIndex
);
2845 if (EFI_ERROR(Status
)) {
2847 // If user defined mode is not valid for display device, set to the default mode 800x600.
2849 (Private
->GraphicsOutputModeBuffer
[0]).HorizontalResolution
= 800;
2850 (Private
->GraphicsOutputModeBuffer
[0]).VerticalResolution
= 600;
2851 Status
= Private
->GraphicsOutput
.SetMode (&Private
->GraphicsOutput
, 0);
2858 Set the current console out mode.
2860 This routine will get the current console mode information (column, row)
2861 from ConsoleOutMode variable and set it; if the variable does not exist,
2862 set to user defined console mode.
2864 @param Private Consplitter Text Out pointer.
2868 ConsplitterSetConsoleOutMode (
2869 IN TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
2879 CONSOLE_OUT_MODE ModeInfo
;
2880 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*TextOut
;
2884 TextOut
= &Private
->TextOut
;
2885 MaxMode
= (UINTN
) (TextOut
->Mode
->MaxMode
);
2887 ModeInfo
.Column
= PcdGet32 (PcdConOutColumn
);
2888 ModeInfo
.Row
= PcdGet32 (PcdConOutRow
);
2891 // To find the prefer mode and basic mode from Text Out mode list
2893 for (Mode
= 0; Mode
< MaxMode
; Mode
++) {
2894 Status
= TextOut
->QueryMode (TextOut
, Mode
, &Col
, &Row
);
2895 if (!EFI_ERROR(Status
)) {
2896 if (Col
== ModeInfo
.Column
&& Row
== ModeInfo
.Row
) {
2899 if (Col
== 80 && Row
== 25) {
2906 // Set prefer mode to Text Out devices.
2908 Status
= TextOut
->SetMode (TextOut
, PreferMode
);
2909 if (EFI_ERROR(Status
)) {
2911 // if current mode setting is failed, default 80x25 mode will be set.
2913 Status
= TextOut
->SetMode (TextOut
, BaseMode
);
2914 ASSERT(!EFI_ERROR(Status
));
2916 PcdSet32 (PcdConOutColumn
, 80);
2917 PcdSet32 (PcdConOutRow
, 25);
2925 Add Text Output Device in Consplitter Text Output list.
2927 @param Private Text Out Splitter pointer.
2928 @param TextOut Simple Text Output protocol pointer.
2929 @param GraphicsOutput Graphics Output protocol pointer.
2930 @param UgaDraw UGA Draw protocol pointer.
2932 @retval EFI_SUCCESS Text Output Device added successfully.
2933 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
2937 ConSplitterTextOutAddDevice (
2938 IN TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
,
2939 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*TextOut
,
2940 IN EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
,
2941 IN EFI_UGA_DRAW_PROTOCOL
*UgaDraw
2945 UINTN CurrentNumOfConsoles
;
2947 UINT32 UgaHorizontalResolution
;
2948 UINT32 UgaVerticalResolution
;
2949 UINT32 UgaColorDepth
;
2950 UINT32 UgaRefreshRate
;
2951 TEXT_OUT_AND_GOP_DATA
*TextAndGop
;
2953 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*Info
;
2954 EFI_STATUS DeviceStatus
;
2956 Status
= EFI_SUCCESS
;
2957 CurrentNumOfConsoles
= Private
->CurrentNumberOfConsoles
;
2960 // If the Text Out List is full, enlarge it by calling ConSplitterGrowBuffer().
2962 while (CurrentNumOfConsoles
>= Private
->TextOutListCount
) {
2963 Status
= ConSplitterGrowBuffer (
2964 sizeof (TEXT_OUT_AND_GOP_DATA
),
2965 &Private
->TextOutListCount
,
2966 (VOID
**) &Private
->TextOutList
2968 if (EFI_ERROR (Status
)) {
2969 return EFI_OUT_OF_RESOURCES
;
2972 // Also need to reallocate the TextOutModeMap table
2974 Status
= ConSplitterGrowMapTable (Private
);
2975 if (EFI_ERROR (Status
)) {
2976 return EFI_OUT_OF_RESOURCES
;
2980 TextAndGop
= &Private
->TextOutList
[CurrentNumOfConsoles
];
2982 TextAndGop
->TextOut
= TextOut
;
2983 TextAndGop
->GraphicsOutput
= GraphicsOutput
;
2984 TextAndGop
->UgaDraw
= UgaDraw
;
2986 if (CurrentNumOfConsoles
== 0) {
2988 // Add the first device's output mode to console splitter's mode list
2990 Status
= ConSplitterAddOutputMode (Private
, TextOut
);
2992 ConSplitterSyncOutputMode (Private
, TextOut
);
2995 Private
->CurrentNumberOfConsoles
++;
2998 // Scan both TextOutList, for the intersection TextOut device
2999 // maybe both ConOut and StdErr incorporate the same Text Out
3000 // device in them, thus the output of both should be synced.
3002 ConSplitterGetIntersectionBetweenConOutAndStrErr ();
3004 MaxMode
= Private
->TextOutMode
.MaxMode
;
3005 ASSERT (MaxMode
>= 1);
3007 DeviceStatus
= EFI_DEVICE_ERROR
;
3008 if (FeaturePcdGet (PcdConOutGopSupport
)) {
3010 // If GOP is produced by Consplitter, this device display mode will be added into Graphics Ouput modes.
3012 if ((GraphicsOutput
!= NULL
) || (UgaDraw
!= NULL
&& FeaturePcdGet (PcdUgaConsumeSupport
))) {
3013 DeviceStatus
= ConSplitterAddGraphicsOutputMode (Private
, GraphicsOutput
, UgaDraw
);
3017 if (FeaturePcdGet (PcdConOutUgaSupport
)) {
3019 Status
= EFI_DEVICE_ERROR
;
3021 // If UGA is produced by Consplitter
3023 if (GraphicsOutput
!= NULL
) {
3024 Status
= GraphicsOutput
->QueryMode (GraphicsOutput
, GraphicsOutput
->Mode
->Mode
, &SizeOfInfo
, &Info
);
3025 if (EFI_ERROR (Status
)) {
3028 ASSERT ( SizeOfInfo
<= sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
));
3030 UgaHorizontalResolution
= Info
->HorizontalResolution
;
3031 UgaVerticalResolution
= Info
->VerticalResolution
;
3035 } else if (UgaDraw
!= NULL
&& FeaturePcdGet (PcdUgaConsumeSupport
)) {
3036 Status
= UgaDraw
->GetMode (
3038 &UgaHorizontalResolution
,
3039 &UgaVerticalResolution
,
3043 if (!EFI_ERROR (Status
) && EFI_ERROR (DeviceStatus
)) {
3045 // if GetMode is successfully and UGA device hasn't been set, set it
3047 Status
= ConSplitterUgaDrawSetMode (
3049 UgaHorizontalResolution
,
3050 UgaVerticalResolution
,
3056 // If GetMode/SetMode is failed, set to 800x600 mode
3058 if(EFI_ERROR (Status
)) {
3059 Status
= ConSplitterUgaDrawSetMode (
3071 // If ConOut, then set the mode to Mode #0 which us 80 x 25
3073 Private
->TextOut
.SetMode (&Private
->TextOut
, 0);
3076 // After adding new console device, all existing console devices should be
3077 // synced to the current shared mode.
3079 ConsplitterSetConsoleOutMode (Private
);
3086 Remove Text Out Device in Consplitter Text Out list.
3088 @param Private Text Out Splitter pointer.
3089 @param TextOut Simple Text Output Pointer protocol pointer.
3091 @retval EFI_SUCCESS Text Out Device removed successfully.
3092 @retval EFI_NOT_FOUND No Text Out Device found.
3096 ConSplitterTextOutDeleteDevice (
3097 IN TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
,
3098 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*TextOut
3102 UINTN CurrentNumOfConsoles
;
3103 TEXT_OUT_AND_GOP_DATA
*TextOutList
;
3107 // Remove the specified text-out device data structure from the Text out List,
3108 // and rearrange the remaining data structures in the Text out List.
3110 CurrentNumOfConsoles
= Private
->CurrentNumberOfConsoles
;
3111 Index
= (INT32
) CurrentNumOfConsoles
- 1;
3112 TextOutList
= Private
->TextOutList
;
3113 while (Index
>= 0) {
3114 if (TextOutList
->TextOut
== TextOut
) {
3115 CopyMem (TextOutList
, TextOutList
+ 1, sizeof (TEXT_OUT_AND_GOP_DATA
) * Index
);
3116 CurrentNumOfConsoles
--;
3117 if (TextOutList
->UgaDraw
!= NULL
&& FeaturePcdGet (PcdUgaConsumeSupport
)) {
3118 Private
->CurrentNumberOfUgaDraw
--;
3120 if (TextOutList
->GraphicsOutput
!= NULL
) {
3121 Private
->CurrentNumberOfGraphicsOutput
--;
3130 // The specified TextOut is not managed by the ConSplitter driver
3133 return EFI_NOT_FOUND
;
3136 if (CurrentNumOfConsoles
== 0) {
3138 // If the number of consoles is zero, reset all parameters
3140 Private
->CurrentNumberOfConsoles
= 0;
3141 Private
->TextOutMode
.MaxMode
= 1;
3142 Private
->TextOutQueryData
[0].Columns
= 80;
3143 Private
->TextOutQueryData
[0].Rows
= 25;
3144 TextOutSetMode (Private
, 0);
3149 // Max Mode is realy an intersection of the QueryMode command to all
3150 // devices. So we must copy the QueryMode of the first device to
3154 Private
->TextOutQueryData
,
3155 Private
->TextOutQueryDataCount
* sizeof (TEXT_OUT_SPLITTER_QUERY_DATA
)
3158 FreePool (Private
->TextOutModeMap
);
3159 Private
->TextOutModeMap
= NULL
;
3160 TextOutList
= Private
->TextOutList
;
3163 // Add the first TextOut to the QueryData array and ModeMap table
3165 Status
= ConSplitterAddOutputMode (Private
, TextOutList
->TextOut
);
3168 // Now add one by one
3171 Private
->CurrentNumberOfConsoles
= 1;
3173 while ((UINTN
) Index
< CurrentNumOfConsoles
) {
3174 ConSplitterSyncOutputMode (Private
, TextOutList
->TextOut
);
3176 Private
->CurrentNumberOfConsoles
++;
3180 ConSplitterGetIntersectionBetweenConOutAndStrErr ();
3187 Reset the input device and optionaly run diagnostics
3189 @param This Protocol instance pointer.
3190 @param ExtendedVerification Driver may perform diagnostics on reset.
3192 @retval EFI_SUCCESS The device was reset.
3193 @retval EFI_DEVICE_ERROR The device is not functioning properly and could
3199 ConSplitterTextInReset (
3200 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*This
,
3201 IN BOOLEAN ExtendedVerification
3205 EFI_STATUS ReturnStatus
;
3206 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3209 Private
= TEXT_IN_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
3211 Private
->KeyEventSignalState
= FALSE
;
3214 // return the worst status met
3216 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
3217 Status
= Private
->TextInList
[Index
]->Reset (
3218 Private
->TextInList
[Index
],
3219 ExtendedVerification
3221 if (EFI_ERROR (Status
)) {
3222 ReturnStatus
= Status
;
3226 return ReturnStatus
;
3231 Reads the next keystroke from the input device. The WaitForKey Event can
3232 be used to test for existance of a keystroke via WaitForEvent () call.
3234 @param Private Protocol instance pointer.
3235 @param Key Driver may perform diagnostics on reset.
3237 @retval EFI_SUCCESS The keystroke information was returned.
3238 @retval EFI_NOT_READY There was no keystroke data availiable.
3239 @retval EFI_DEVICE_ERROR The keydtroke information was not returned due
3245 ConSplitterTextInPrivateReadKeyStroke (
3246 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
3247 OUT EFI_INPUT_KEY
*Key
3252 EFI_INPUT_KEY CurrentKey
;
3254 Key
->UnicodeChar
= 0;
3255 Key
->ScanCode
= SCAN_NULL
;
3258 // if no physical console input device exists, return EFI_NOT_READY;
3259 // if any physical console input device has key input,
3260 // return the key and EFI_SUCCESS.
3262 for (Index
= 0; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
3263 Status
= Private
->TextInList
[Index
]->ReadKeyStroke (
3264 Private
->TextInList
[Index
],
3267 if (!EFI_ERROR (Status
)) {
3273 return EFI_NOT_READY
;
3278 Reads the next keystroke from the input device. The WaitForKey Event can
3279 be used to test for existance of a keystroke via WaitForEvent () call.
3281 @param This Protocol instance pointer.
3282 @param Key Driver may perform diagnostics on reset.
3284 @retval EFI_SUCCESS The keystroke information was returned.
3285 @retval EFI_NOT_READY There was no keystroke data availiable.
3286 @retval EFI_DEVICE_ERROR The keydtroke information was not returned due
3292 ConSplitterTextInReadKeyStroke (
3293 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*This
,
3294 OUT EFI_INPUT_KEY
*Key
3297 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3299 Private
= TEXT_IN_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
3301 Private
->KeyEventSignalState
= FALSE
;
3303 return ConSplitterTextInPrivateReadKeyStroke (Private
, Key
);
3308 This event aggregates all the events of the ConIn devices in the spliter.
3310 If any events of physical ConIn devices are signaled, signal the ConIn
3311 spliter event. This will cause the calling code to call
3312 ConSplitterTextInReadKeyStroke ().
3314 @param Event The Event assoicated with callback.
3315 @param Context Context registered when Event was created.
3320 ConSplitterTextInWaitForKey (
3326 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3329 Private
= (TEXT_IN_SPLITTER_PRIVATE_DATA
*) Context
;
3331 if (Private
->KeyEventSignalState
) {
3333 // If KeyEventSignalState is flagged before, and not cleared by Reset() or ReadKeyStroke()
3335 gBS
->SignalEvent (Event
);
3340 // If any physical console input device has key input, signal the event.
3342 for (Index
= 0; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
3343 Status
= gBS
->CheckEvent (Private
->TextInList
[Index
]->WaitForKey
);
3344 if (!EFI_ERROR (Status
)) {
3345 gBS
->SignalEvent (Event
);
3346 Private
->KeyEventSignalState
= TRUE
;
3354 Test if the key has been registered on input device.
3356 @param RegsiteredData A pointer to a buffer that is filled in with the
3357 keystroke state data for the key that was
3359 @param InputData A pointer to a buffer that is filled in with the
3360 keystroke state data for the key that was
3363 @retval TRUE Key be pressed matches a registered key.
3364 @retval FLASE Match failed.
3369 IN EFI_KEY_DATA
*RegsiteredData
,
3370 IN EFI_KEY_DATA
*InputData
3373 ASSERT (RegsiteredData
!= NULL
&& InputData
!= NULL
);
3375 if ((RegsiteredData
->Key
.ScanCode
!= InputData
->Key
.ScanCode
) ||
3376 (RegsiteredData
->Key
.UnicodeChar
!= InputData
->Key
.UnicodeChar
)) {
3381 // Assume KeyShiftState/KeyToggleState = 0 in Registered key data means these state could be ignored.
3383 if (RegsiteredData
->KeyState
.KeyShiftState
!= 0 &&
3384 RegsiteredData
->KeyState
.KeyShiftState
!= InputData
->KeyState
.KeyShiftState
) {
3387 if (RegsiteredData
->KeyState
.KeyToggleState
!= 0 &&
3388 RegsiteredData
->KeyState
.KeyToggleState
!= InputData
->KeyState
.KeyToggleState
) {
3398 Reset the input device and optionaly run diagnostics
3400 @param This Protocol instance pointer.
3401 @param ExtendedVerification Driver may perform diagnostics on reset.
3403 @retval EFI_SUCCESS The device was reset.
3404 @retval EFI_DEVICE_ERROR The device is not functioning properly and could
3410 ConSplitterTextInResetEx (
3411 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*This
,
3412 IN BOOLEAN ExtendedVerification
3416 EFI_STATUS ReturnStatus
;
3417 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3420 Private
= TEXT_IN_EX_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
3422 Private
->KeyEventSignalState
= FALSE
;
3425 // return the worst status met
3427 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfExConsoles
; Index
++) {
3428 Status
= Private
->TextInExList
[Index
]->Reset (
3429 Private
->TextInExList
[Index
],
3430 ExtendedVerification
3432 if (EFI_ERROR (Status
)) {
3433 ReturnStatus
= Status
;
3437 return ReturnStatus
;
3443 Reads the next keystroke from the input device. The WaitForKey Event can
3444 be used to test for existance of a keystroke via WaitForEvent () call.
3446 @param This Protocol instance pointer.
3447 @param KeyData A pointer to a buffer that is filled in with the
3448 keystroke state data for the key that was
3451 @retval EFI_SUCCESS The keystroke information was returned.
3452 @retval EFI_NOT_READY There was no keystroke data availiable.
3453 @retval EFI_DEVICE_ERROR The keystroke information was not returned due
3455 @retval EFI_INVALID_PARAMETER KeyData is NULL.
3460 ConSplitterTextInReadKeyStrokeEx (
3461 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*This
,
3462 OUT EFI_KEY_DATA
*KeyData
3465 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3468 EFI_KEY_DATA CurrentKeyData
;
3471 if (KeyData
== NULL
) {
3472 return EFI_INVALID_PARAMETER
;
3475 Private
= TEXT_IN_EX_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
3477 Private
->KeyEventSignalState
= FALSE
;
3479 KeyData
->Key
.UnicodeChar
= 0;
3480 KeyData
->Key
.ScanCode
= SCAN_NULL
;
3483 // if no physical console input device exists, return EFI_NOT_READY;
3484 // if any physical console input device has key input,
3485 // return the key and EFI_SUCCESS.
3487 for (Index
= 0; Index
< Private
->CurrentNumberOfExConsoles
; Index
++) {
3488 Status
= Private
->TextInExList
[Index
]->ReadKeyStrokeEx (
3489 Private
->TextInExList
[Index
],
3492 if (!EFI_ERROR (Status
)) {
3493 CopyMem (KeyData
, &CurrentKeyData
, sizeof (CurrentKeyData
));
3498 return EFI_NOT_READY
;
3503 Set certain state for the input device.
3505 @param This Protocol instance pointer.
3506 @param KeyToggleState A pointer to the EFI_KEY_TOGGLE_STATE to set the
3507 state for the input device.
3509 @retval EFI_SUCCESS The device state was set successfully.
3510 @retval EFI_DEVICE_ERROR The device is not functioning correctly and
3511 could not have the setting adjusted.
3512 @retval EFI_UNSUPPORTED The device does not have the ability to set its
3514 @retval EFI_INVALID_PARAMETER KeyToggleState is NULL.
3519 ConSplitterTextInSetState (
3520 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*This
,
3521 IN EFI_KEY_TOGGLE_STATE
*KeyToggleState
3524 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3528 if (KeyToggleState
== NULL
) {
3529 return EFI_INVALID_PARAMETER
;
3532 Private
= TEXT_IN_EX_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
3535 // if no physical console input device exists, return EFI_SUCCESS;
3536 // otherwise return the status of setting state of physical console input device
3538 for (Index
= 0; Index
< Private
->CurrentNumberOfExConsoles
; Index
++) {
3539 Status
= Private
->TextInExList
[Index
]->SetState (
3540 Private
->TextInExList
[Index
],
3543 if (EFI_ERROR (Status
)) {
3554 Register a notification function for a particular keystroke for the input device.
3556 @param This Protocol instance pointer.
3557 @param KeyData A pointer to a buffer that is filled in with the
3558 keystroke information data for the key that was
3560 @param KeyNotificationFunction Points to the function to be called when the key
3561 sequence is typed specified by KeyData.
3562 @param NotifyHandle Points to the unique handle assigned to the
3563 registered notification.
3565 @retval EFI_SUCCESS The notification function was registered
3567 @retval EFI_OUT_OF_RESOURCES Unable to allocate resources for necesssary data
3569 @retval EFI_INVALID_PARAMETER KeyData or KeyNotificationFunction or NotifyHandle is NULL.
3574 ConSplitterTextInRegisterKeyNotify (
3575 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*This
,
3576 IN EFI_KEY_DATA
*KeyData
,
3577 IN EFI_KEY_NOTIFY_FUNCTION KeyNotificationFunction
,
3578 OUT EFI_HANDLE
*NotifyHandle
3581 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3584 TEXT_IN_EX_SPLITTER_NOTIFY
*NewNotify
;
3586 TEXT_IN_EX_SPLITTER_NOTIFY
*CurrentNotify
;
3589 if (KeyData
== NULL
|| NotifyHandle
== NULL
|| KeyNotificationFunction
== NULL
) {
3590 return EFI_INVALID_PARAMETER
;
3593 Private
= TEXT_IN_EX_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
3596 // If no physical console input device exists,
3597 // return EFI_SUCCESS directly.
3599 if (Private
->CurrentNumberOfExConsoles
<= 0) {
3604 // Return EFI_SUCCESS if the (KeyData, NotificationFunction) is already registered.
3606 for (Link
= Private
->NotifyList
.ForwardLink
; Link
!= &Private
->NotifyList
; Link
= Link
->ForwardLink
) {
3607 CurrentNotify
= TEXT_IN_EX_SPLITTER_NOTIFY_FROM_THIS (Link
);
3608 if (IsKeyRegistered (&CurrentNotify
->KeyData
, KeyData
)) {
3609 if (CurrentNotify
->KeyNotificationFn
== KeyNotificationFunction
) {
3610 *NotifyHandle
= CurrentNotify
->NotifyHandle
;
3617 // Allocate resource to save the notification function
3619 NewNotify
= (TEXT_IN_EX_SPLITTER_NOTIFY
*) AllocateZeroPool (sizeof (TEXT_IN_EX_SPLITTER_NOTIFY
));
3620 if (NewNotify
== NULL
) {
3621 return EFI_OUT_OF_RESOURCES
;
3623 NewNotify
->NotifyHandleList
= (EFI_HANDLE
*) AllocateZeroPool (sizeof (EFI_HANDLE
) * Private
->CurrentNumberOfExConsoles
);
3624 if (NewNotify
->NotifyHandleList
== NULL
) {
3625 gBS
->FreePool (NewNotify
);
3626 return EFI_OUT_OF_RESOURCES
;
3628 NewNotify
->Signature
= TEXT_IN_EX_SPLITTER_NOTIFY_SIGNATURE
;
3629 NewNotify
->KeyNotificationFn
= KeyNotificationFunction
;
3630 NewNotify
->NotifyHandle
= (EFI_HANDLE
) NewNotify
;
3631 CopyMem (&NewNotify
->KeyData
, KeyData
, sizeof (KeyData
));
3634 // Return the wrong status of registering key notify of
3635 // physical console input device if meet problems
3637 for (Index
= 0; Index
< Private
->CurrentNumberOfExConsoles
; Index
++) {
3638 Status
= Private
->TextInExList
[Index
]->RegisterKeyNotify (
3639 Private
->TextInExList
[Index
],
3641 KeyNotificationFunction
,
3642 &NewNotify
->NotifyHandleList
[Index
]
3644 if (EFI_ERROR (Status
)) {
3645 gBS
->FreePool (NewNotify
->NotifyHandleList
);
3646 gBS
->FreePool (NewNotify
);
3651 InsertTailList (&mConIn
.NotifyList
, &NewNotify
->NotifyEntry
);
3653 *NotifyHandle
= NewNotify
->NotifyHandle
;
3661 Remove a registered notification function from a particular keystroke.
3663 @param This Protocol instance pointer.
3664 @param NotificationHandle The handle of the notification function being
3667 @retval EFI_SUCCESS The notification function was unregistered
3669 @retval EFI_INVALID_PARAMETER The NotificationHandle is invalid.
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
);
3724 // NotificationHandle is not found in database
3726 return EFI_INVALID_PARAMETER
;
3731 Reset the input device and optionaly run diagnostics
3733 @param This Protocol instance pointer.
3734 @param ExtendedVerification Driver may perform diagnostics on reset.
3736 @retval EFI_SUCCESS The device was reset.
3737 @retval EFI_DEVICE_ERROR The device is not functioning properly and could
3743 ConSplitterSimplePointerReset (
3744 IN EFI_SIMPLE_POINTER_PROTOCOL
*This
,
3745 IN BOOLEAN ExtendedVerification
3749 EFI_STATUS ReturnStatus
;
3750 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3753 Private
= TEXT_IN_SPLITTER_PRIVATE_DATA_FROM_SIMPLE_POINTER_THIS (This
);
3755 Private
->InputEventSignalState
= FALSE
;
3757 if (Private
->CurrentNumberOfPointers
== 0) {
3761 // return the worst status met
3763 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfPointers
; Index
++) {
3764 Status
= Private
->PointerList
[Index
]->Reset (
3765 Private
->PointerList
[Index
],
3766 ExtendedVerification
3768 if (EFI_ERROR (Status
)) {
3769 ReturnStatus
= Status
;
3773 return ReturnStatus
;
3778 Reads the next keystroke from the input device. The WaitForKey Event can
3779 be used to test for existance of a keystroke via WaitForEvent () call.
3781 @param Private Protocol instance pointer.
3782 @param State The state information of simple pointer device.
3784 @retval EFI_SUCCESS The keystroke information was returned.
3785 @retval EFI_NOT_READY There was no keystroke data availiable.
3786 @retval EFI_DEVICE_ERROR The keydtroke information was not returned due
3792 ConSplitterSimplePointerPrivateGetState (
3793 IN TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
,
3794 IN OUT EFI_SIMPLE_POINTER_STATE
*State
3798 EFI_STATUS ReturnStatus
;
3800 EFI_SIMPLE_POINTER_STATE CurrentState
;
3802 State
->RelativeMovementX
= 0;
3803 State
->RelativeMovementY
= 0;
3804 State
->RelativeMovementZ
= 0;
3805 State
->LeftButton
= FALSE
;
3806 State
->RightButton
= FALSE
;
3809 // if no physical console input device exists, return EFI_NOT_READY;
3810 // if any physical console input device has key input,
3811 // return the key and EFI_SUCCESS.
3813 ReturnStatus
= EFI_NOT_READY
;
3814 for (Index
= 0; Index
< Private
->CurrentNumberOfPointers
; Index
++) {
3816 Status
= Private
->PointerList
[Index
]->GetState (
3817 Private
->PointerList
[Index
],
3820 if (!EFI_ERROR (Status
)) {
3821 if (ReturnStatus
== EFI_NOT_READY
) {
3822 ReturnStatus
= EFI_SUCCESS
;
3825 if (CurrentState
.LeftButton
) {
3826 State
->LeftButton
= TRUE
;
3829 if (CurrentState
.RightButton
) {
3830 State
->RightButton
= TRUE
;
3833 if (CurrentState
.RelativeMovementX
!= 0 && Private
->PointerList
[Index
]->Mode
->ResolutionX
!= 0) {
3834 State
->RelativeMovementX
+= (CurrentState
.RelativeMovementX
* (INT32
) Private
->SimplePointerMode
.ResolutionX
) / (INT32
) Private
->PointerList
[Index
]->Mode
->ResolutionX
;
3837 if (CurrentState
.RelativeMovementY
!= 0 && Private
->PointerList
[Index
]->Mode
->ResolutionY
!= 0) {
3838 State
->RelativeMovementY
+= (CurrentState
.RelativeMovementY
* (INT32
) Private
->SimplePointerMode
.ResolutionY
) / (INT32
) Private
->PointerList
[Index
]->Mode
->ResolutionY
;
3841 if (CurrentState
.RelativeMovementZ
!= 0 && Private
->PointerList
[Index
]->Mode
->ResolutionZ
!= 0) {
3842 State
->RelativeMovementZ
+= (CurrentState
.RelativeMovementZ
* (INT32
) Private
->SimplePointerMode
.ResolutionZ
) / (INT32
) Private
->PointerList
[Index
]->Mode
->ResolutionZ
;
3844 } else if (Status
== EFI_DEVICE_ERROR
) {
3845 ReturnStatus
= EFI_DEVICE_ERROR
;
3849 return ReturnStatus
;
3854 Reads the next keystroke from the input device. The WaitForKey Event can
3855 be used to test for existance of a keystroke via WaitForEvent () call.
3857 @param This A pointer to protocol instance.
3858 @param State A pointer to state information on the pointer device
3860 @retval EFI_SUCCESS The keystroke information was returned in State.
3861 @retval EFI_NOT_READY There was no keystroke data availiable.
3862 @retval EFI_DEVICE_ERROR The keydtroke information was not returned due
3868 ConSplitterSimplePointerGetState (
3869 IN EFI_SIMPLE_POINTER_PROTOCOL
*This
,
3870 IN OUT EFI_SIMPLE_POINTER_STATE
*State
3873 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3875 Private
= TEXT_IN_SPLITTER_PRIVATE_DATA_FROM_SIMPLE_POINTER_THIS (This
);
3877 Private
->InputEventSignalState
= FALSE
;
3879 return ConSplitterSimplePointerPrivateGetState (Private
, State
);
3884 This event agregates all the events of the ConIn devices in the spliter.
3885 If any events of physical ConIn devices are signaled, signal the ConIn
3886 spliter event. This will cause the calling code to call
3887 ConSplitterTextInReadKeyStroke ().
3889 @param Event The Event assoicated with callback.
3890 @param Context Context registered when Event was created.
3895 ConSplitterSimplePointerWaitForInput (
3901 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3904 Private
= (TEXT_IN_SPLITTER_PRIVATE_DATA
*) Context
;
3907 // if InputEventSignalState is flagged before, and not cleared by Reset() or ReadKeyStroke()
3909 if (Private
->InputEventSignalState
) {
3910 gBS
->SignalEvent (Event
);
3914 // if any physical console input device has key input, signal the event.
3916 for (Index
= 0; Index
< Private
->CurrentNumberOfPointers
; Index
++) {
3917 Status
= gBS
->CheckEvent (Private
->PointerList
[Index
]->WaitForInput
);
3918 if (!EFI_ERROR (Status
)) {
3919 gBS
->SignalEvent (Event
);
3920 Private
->InputEventSignalState
= TRUE
;
3926 Resets the pointer device hardware.
3928 @param This Protocol instance pointer.
3929 @param ExtendedVerification Driver may perform diagnostics on reset.
3931 @retval EFI_SUCCESS The device was reset.
3932 @retval EFI_DEVICE_ERROR The device is not functioning correctly and
3938 ConSplitterAbsolutePointerReset (
3939 IN EFI_ABSOLUTE_POINTER_PROTOCOL
*This
,
3940 IN BOOLEAN ExtendedVerification
3944 EFI_STATUS ReturnStatus
;
3945 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3948 Private
= TEXT_IN_SPLITTER_PRIVATE_DATA_FROM_ABSOLUTE_POINTER_THIS (This
);
3950 Private
->AbsoluteInputEventSignalState
= FALSE
;
3952 if (Private
->CurrentNumberOfAbsolutePointers
== 0) {
3956 // return the worst status met
3958 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfAbsolutePointers
; Index
++) {
3959 Status
= Private
->AbsolutePointerList
[Index
]->Reset (
3960 Private
->AbsolutePointerList
[Index
],
3961 ExtendedVerification
3963 if (EFI_ERROR (Status
)) {
3964 ReturnStatus
= Status
;
3968 return ReturnStatus
;
3973 Retrieves the current state of a pointer device.
3975 @param This Protocol instance pointer.
3976 @param State A pointer to the state information on the
3979 @retval EFI_SUCCESS The state of the pointer device was returned in
3981 @retval EFI_NOT_READY The state of the pointer device has not changed
3982 since the last call to GetState().
3983 @retval EFI_DEVICE_ERROR A device error occurred while attempting to
3984 retrieve the pointer device's current state.
3989 ConSplitterAbsolutePointerGetState (
3990 IN EFI_ABSOLUTE_POINTER_PROTOCOL
*This
,
3991 IN OUT EFI_ABSOLUTE_POINTER_STATE
*State
3994 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
3996 EFI_STATUS ReturnStatus
;
3998 EFI_ABSOLUTE_POINTER_STATE CurrentState
;
4001 Private
= TEXT_IN_SPLITTER_PRIVATE_DATA_FROM_ABSOLUTE_POINTER_THIS (This
);
4003 Private
->AbsoluteInputEventSignalState
= FALSE
;
4005 State
->CurrentX
= 0;
4006 State
->CurrentY
= 0;
4007 State
->CurrentZ
= 0;
4008 State
->ActiveButtons
= 0;
4011 // if no physical pointer device exists, return EFI_NOT_READY;
4012 // if any physical pointer device has changed state,
4013 // return the state and EFI_SUCCESS.
4015 ReturnStatus
= EFI_NOT_READY
;
4016 for (Index
= 0; Index
< Private
->CurrentNumberOfAbsolutePointers
; Index
++) {
4018 Status
= Private
->AbsolutePointerList
[Index
]->GetState (
4019 Private
->AbsolutePointerList
[Index
],
4022 if (!EFI_ERROR (Status
)) {
4023 if (ReturnStatus
== EFI_NOT_READY
) {
4024 ReturnStatus
= EFI_SUCCESS
;
4027 State
->ActiveButtons
= CurrentState
.ActiveButtons
;
4029 if (!(Private
->AbsolutePointerMode
.AbsoluteMinX
== 0 && Private
->AbsolutePointerMode
.AbsoluteMaxX
== 0)) {
4030 State
->CurrentX
= CurrentState
.CurrentX
;
4032 if (!(Private
->AbsolutePointerMode
.AbsoluteMinY
== 0 && Private
->AbsolutePointerMode
.AbsoluteMaxY
== 0)) {
4033 State
->CurrentY
= CurrentState
.CurrentY
;
4035 if (!(Private
->AbsolutePointerMode
.AbsoluteMinZ
== 0 && Private
->AbsolutePointerMode
.AbsoluteMaxZ
== 0)) {
4036 State
->CurrentZ
= CurrentState
.CurrentZ
;
4039 } else if (Status
== EFI_DEVICE_ERROR
) {
4040 ReturnStatus
= EFI_DEVICE_ERROR
;
4044 return ReturnStatus
;
4049 This event agregates all the events of the pointer devices in the splitter.
4050 If any events of physical pointer devices are signaled, signal the pointer
4051 splitter event. This will cause the calling code to call
4052 ConSplitterAbsolutePointerGetState ().
4054 @param Event The Event assoicated with callback.
4055 @param Context Context registered when Event was created.
4060 ConSplitterAbsolutePointerWaitForInput (
4066 TEXT_IN_SPLITTER_PRIVATE_DATA
*Private
;
4069 Private
= (TEXT_IN_SPLITTER_PRIVATE_DATA
*) Context
;
4072 // if AbsoluteInputEventSignalState is flagged before,
4073 // and not cleared by Reset() or GetState(), signal it
4075 if (Private
->AbsoluteInputEventSignalState
) {
4076 gBS
->SignalEvent (Event
);
4080 // if any physical console input device has key input, signal the event.
4082 for (Index
= 0; Index
< Private
->CurrentNumberOfAbsolutePointers
; Index
++) {
4083 Status
= gBS
->CheckEvent (Private
->AbsolutePointerList
[Index
]->WaitForInput
);
4084 if (!EFI_ERROR (Status
)) {
4085 gBS
->SignalEvent (Event
);
4086 Private
->AbsoluteInputEventSignalState
= TRUE
;
4093 Reset the text output device hardware and optionaly run diagnostics
4095 @param This Protocol instance pointer.
4096 @param ExtendedVerification Driver may perform more exhaustive verfication
4097 operation of the device during reset.
4099 @retval EFI_SUCCESS The text output device was reset.
4100 @retval EFI_DEVICE_ERROR The text output device is not functioning
4101 correctly and could not be reset.
4106 ConSplitterTextOutReset (
4107 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
4108 IN BOOLEAN ExtendedVerification
4112 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
4114 EFI_STATUS ReturnStatus
;
4116 Private
= TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
4119 // return the worst status met
4121 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
4122 Status
= Private
->TextOutList
[Index
].TextOut
->Reset (
4123 Private
->TextOutList
[Index
].TextOut
,
4124 ExtendedVerification
4126 if (EFI_ERROR (Status
)) {
4127 ReturnStatus
= Status
;
4131 This
->SetAttribute (This
, EFI_TEXT_ATTR (This
->Mode
->Attribute
& 0x0F, EFI_BLACK
));
4134 // reset all mode parameters
4136 TextOutSetMode (Private
, 0);
4138 return ReturnStatus
;
4143 Write a Unicode string to the output device.
4145 @param This Protocol instance pointer.
4146 @param WString The NULL-terminated Unicode string to be
4147 displayed on the output device(s). All output
4148 devices must also support the Unicode drawing
4149 defined in this file.
4151 @retval EFI_SUCCESS The string was output to the device.
4152 @retval EFI_DEVICE_ERROR The device reported an error while attempting to
4154 @retval EFI_UNSUPPORTED The output device's mode is not currently in a
4156 @retval EFI_WARN_UNKNOWN_GLYPH This warning code indicates that some of the
4157 characters in the Unicode string could not be
4158 rendered and were skipped.
4163 ConSplitterTextOutOutputString (
4164 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
4169 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
4171 UINTN BackSpaceCount
;
4172 EFI_STATUS ReturnStatus
;
4173 CHAR16
*TargetString
;
4175 This
->SetAttribute (This
, This
->Mode
->Attribute
);
4177 Private
= TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
4181 for (TargetString
= WString
; *TargetString
!= L
'\0'; TargetString
++) {
4182 if (*TargetString
== CHAR_BACKSPACE
) {
4187 if (BackSpaceCount
== 0) {
4188 TargetString
= WString
;
4190 TargetString
= AllocatePool (sizeof (CHAR16
) * (StrLen (WString
) + BackSpaceCount
+ 1));
4191 ASSERT (TargetString
!= NULL
);
4193 StrCpy (TargetString
, WString
);
4196 // return the worst status met
4198 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
4199 Status
= Private
->TextOutList
[Index
].TextOut
->OutputString (
4200 Private
->TextOutList
[Index
].TextOut
,
4203 if (EFI_ERROR (Status
)) {
4204 ReturnStatus
= Status
;
4208 if (Private
->CurrentNumberOfConsoles
> 0) {
4209 Private
->TextOutMode
.CursorColumn
= Private
->TextOutList
[0].TextOut
->Mode
->CursorColumn
;
4210 Private
->TextOutMode
.CursorRow
= Private
->TextOutList
[0].TextOut
->Mode
->CursorRow
;
4213 if (BackSpaceCount
> 0) {
4214 FreePool (TargetString
);
4217 return ReturnStatus
;
4222 Verifies that all characters in a Unicode string can be output to the
4225 @param This Protocol instance pointer.
4226 @param WString The NULL-terminated Unicode string to be
4227 examined for the output device(s).
4229 @retval EFI_SUCCESS The device(s) are capable of rendering the
4231 @retval EFI_UNSUPPORTED Some of the characters in the Unicode string
4232 cannot be rendered by one or more of the output
4233 devices mapped by the EFI handle.
4238 ConSplitterTextOutTestString (
4239 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
4244 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
4246 EFI_STATUS ReturnStatus
;
4248 Private
= TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
4251 // return the worst status met
4253 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
4254 Status
= Private
->TextOutList
[Index
].TextOut
->TestString (
4255 Private
->TextOutList
[Index
].TextOut
,
4258 if (EFI_ERROR (Status
)) {
4259 ReturnStatus
= Status
;
4263 // There is no DevNullTextOutTestString () since a Unicode buffer would
4264 // always return EFI_SUCCESS.
4265 // ReturnStatus will be EFI_SUCCESS if no consoles are present
4267 return ReturnStatus
;
4272 Returns information for an available text mode that the output device(s)
4275 @param This Protocol instance pointer.
4276 @param ModeNumber The mode number to return information on.
4277 @param Columns Returns the columns of the text output device
4278 for the requested ModeNumber.
4279 @param Rows Returns the rows of the text output device
4280 for the requested ModeNumber.
4282 @retval EFI_SUCCESS The requested mode information was returned.
4283 @retval EFI_DEVICE_ERROR The device had an error and could not complete
4285 @retval EFI_UNSUPPORTED The mode number was not valid.
4290 ConSplitterTextOutQueryMode (
4291 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
4292 IN UINTN ModeNumber
,
4297 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
4299 INT32
*TextOutModeMap
;
4301 Private
= TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
4304 // Check whether param ModeNumber is valid.
4305 // ModeNumber should be within range 0 ~ MaxMode - 1.
4307 if ( (ModeNumber
> (UINTN
)(((UINT32
)-1)>>1)) ) {
4308 return EFI_UNSUPPORTED
;
4311 if ((INT32
) ModeNumber
>= This
->Mode
->MaxMode
) {
4312 return EFI_UNSUPPORTED
;
4316 // We get the available mode from mode intersection map if it's available
4318 if (Private
->TextOutModeMap
!= NULL
) {
4319 TextOutModeMap
= Private
->TextOutModeMap
+ Private
->TextOutListCount
* ModeNumber
;
4320 CurrentMode
= (UINTN
)(*TextOutModeMap
);
4321 *Columns
= Private
->TextOutQueryData
[CurrentMode
].Columns
;
4322 *Rows
= Private
->TextOutQueryData
[CurrentMode
].Rows
;
4324 *Columns
= Private
->TextOutQueryData
[ModeNumber
].Columns
;
4325 *Rows
= Private
->TextOutQueryData
[ModeNumber
].Rows
;
4328 if (*Columns
<= 0 && *Rows
<= 0) {
4329 return EFI_UNSUPPORTED
;
4338 Sets the output device(s) to a specified mode.
4340 @param This Protocol instance pointer.
4341 @param ModeNumber The mode number to set.
4343 @retval EFI_SUCCESS The requested text mode was set.
4344 @retval EFI_DEVICE_ERROR The device had an error and could not complete
4346 @retval EFI_UNSUPPORTED The mode number was not valid.
4351 ConSplitterTextOutSetMode (
4352 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
4357 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
4359 INT32
*TextOutModeMap
;
4360 EFI_STATUS ReturnStatus
;
4362 Private
= TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
4365 // Check whether param ModeNumber is valid.
4366 // ModeNumber should be within range 0 ~ MaxMode - 1.
4368 if ( (ModeNumber
> (UINTN
)(((UINT32
)-1)>>1)) ) {
4369 return EFI_UNSUPPORTED
;
4372 if ((INT32
) ModeNumber
>= This
->Mode
->MaxMode
) {
4373 return EFI_UNSUPPORTED
;
4376 // If the mode is being set to the curent mode, then just clear the screen and return.
4378 if (Private
->TextOutMode
.Mode
== (INT32
) ModeNumber
) {
4379 return ConSplitterTextOutClearScreen (This
);
4382 // return the worst status met
4384 TextOutModeMap
= Private
->TextOutModeMap
+ Private
->TextOutListCount
* ModeNumber
;
4385 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
4386 Status
= Private
->TextOutList
[Index
].TextOut
->SetMode (
4387 Private
->TextOutList
[Index
].TextOut
,
4388 TextOutModeMap
[Index
]
4391 // If this console device is based on a GOP or UGA device, then sync up the bitmap from
4392 // the GOP/UGA splitter and reclear the text portion of the display in the new mode.
4394 if ((Private
->TextOutList
[Index
].GraphicsOutput
!= NULL
) || (Private
->TextOutList
[Index
].UgaDraw
!= NULL
)) {
4395 Private
->TextOutList
[Index
].TextOut
->ClearScreen (Private
->TextOutList
[Index
].TextOut
);
4398 if (EFI_ERROR (Status
)) {
4399 ReturnStatus
= Status
;
4404 // Set mode parameter to specified mode number
4406 TextOutSetMode (Private
, ModeNumber
);
4408 return ReturnStatus
;
4413 Sets the background and foreground colors for the OutputString () and
4414 ClearScreen () functions.
4416 @param This Protocol instance pointer.
4417 @param Attribute The attribute to set. Bits 0..3 are the
4418 foreground color, and bits 4..6 are the
4419 background color. All other bits are undefined
4420 and must be zero. The valid Attributes are
4421 defined in this file.
4423 @retval EFI_SUCCESS The attribute was set.
4424 @retval EFI_DEVICE_ERROR The device had an error and could not complete
4426 @retval EFI_UNSUPPORTED The attribute requested is not defined.
4431 ConSplitterTextOutSetAttribute (
4432 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
4437 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
4439 EFI_STATUS ReturnStatus
;
4441 Private
= TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
4444 // Check whether param Attribute is valid.
4446 if ( (Attribute
> (UINTN
)(((UINT32
)-1)>>1)) ) {
4447 return EFI_UNSUPPORTED
;
4451 // return the worst status met
4453 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
4454 Status
= Private
->TextOutList
[Index
].TextOut
->SetAttribute (
4455 Private
->TextOutList
[Index
].TextOut
,
4458 if (EFI_ERROR (Status
)) {
4459 ReturnStatus
= Status
;
4463 Private
->TextOutMode
.Attribute
= (INT32
) Attribute
;
4465 return ReturnStatus
;
4470 Clears the output device(s) display to the currently selected background
4473 @param This Protocol instance pointer.
4475 @retval EFI_SUCCESS The operation completed successfully.
4476 @retval EFI_DEVICE_ERROR The device had an error and could not complete
4478 @retval EFI_UNSUPPORTED The output device is not in a valid text mode.
4483 ConSplitterTextOutClearScreen (
4484 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
4488 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
4490 EFI_STATUS ReturnStatus
;
4492 Private
= TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
4495 // return the worst status met
4497 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
4498 Status
= Private
->TextOutList
[Index
].TextOut
->ClearScreen (Private
->TextOutList
[Index
].TextOut
);
4499 if (EFI_ERROR (Status
)) {
4500 ReturnStatus
= Status
;
4505 // No need to do extra check here as whether (Column, Row) is valid has
4506 // been checked in ConSplitterTextOutSetCursorPosition. And (0, 0) should
4507 // always be supported.
4509 Private
->TextOutMode
.CursorColumn
= 0;
4510 Private
->TextOutMode
.CursorRow
= 0;
4511 Private
->TextOutMode
.CursorVisible
= TRUE
;
4513 return ReturnStatus
;
4518 Sets the current coordinates of the cursor position
4520 @param This Protocol instance pointer.
4521 @param Column The column position to set the cursor to. Must be
4522 greater than or equal to zero and less than the
4523 number of columns by QueryMode ().
4524 @param Row The row position to set the cursor to. Must be
4525 greater than or equal to zero and less than the
4526 number of rows by QueryMode ().
4528 @retval EFI_SUCCESS The operation completed successfully.
4529 @retval EFI_DEVICE_ERROR The device had an error and could not complete
4531 @retval EFI_UNSUPPORTED The output device is not in a valid text mode,
4532 or the cursor position is invalid for the
4538 ConSplitterTextOutSetCursorPosition (
4539 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
4545 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
4547 EFI_STATUS ReturnStatus
;
4550 INT32
*TextOutModeMap
;
4554 Private
= TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
4555 TextOutModeMap
= NULL
;
4556 ModeNumber
= Private
->TextOutMode
.Mode
;
4559 // Get current MaxColumn and MaxRow from intersection map
4561 if (Private
->TextOutModeMap
!= NULL
) {
4562 TextOutModeMap
= Private
->TextOutModeMap
+ Private
->TextOutListCount
* ModeNumber
;
4563 CurrentMode
= *TextOutModeMap
;
4565 CurrentMode
= ModeNumber
;
4568 MaxColumn
= Private
->TextOutQueryData
[CurrentMode
].Columns
;
4569 MaxRow
= Private
->TextOutQueryData
[CurrentMode
].Rows
;
4571 if (Column
>= MaxColumn
|| Row
>= MaxRow
) {
4572 return EFI_UNSUPPORTED
;
4575 // return the worst status met
4577 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
4578 Status
= Private
->TextOutList
[Index
].TextOut
->SetCursorPosition (
4579 Private
->TextOutList
[Index
].TextOut
,
4583 if (EFI_ERROR (Status
)) {
4584 ReturnStatus
= Status
;
4589 // No need to do extra check here as whether (Column, Row) is valid has
4590 // been checked in ConSplitterTextOutSetCursorPosition. And (0, 0) should
4591 // always be supported.
4593 Private
->TextOutMode
.CursorColumn
= (INT32
) Column
;
4594 Private
->TextOutMode
.CursorRow
= (INT32
) Row
;
4596 return ReturnStatus
;
4601 Makes the cursor visible or invisible
4603 @param This Protocol instance pointer.
4604 @param Visible If TRUE, the cursor is set to be visible. If
4605 FALSE, the cursor is set to be invisible.
4607 @retval EFI_SUCCESS The operation completed successfully.
4608 @retval EFI_DEVICE_ERROR The device had an error and could not complete
4609 the request, or the device does not support
4610 changing the cursor mode.
4611 @retval EFI_UNSUPPORTED The output device is not in a valid text mode.
4616 ConSplitterTextOutEnableCursor (
4617 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
4622 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
4624 EFI_STATUS ReturnStatus
;
4626 Private
= TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
4629 // return the worst status met
4631 for (Index
= 0, ReturnStatus
= EFI_SUCCESS
; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
4632 Status
= Private
->TextOutList
[Index
].TextOut
->EnableCursor (
4633 Private
->TextOutList
[Index
].TextOut
,
4636 if (EFI_ERROR (Status
)) {
4637 ReturnStatus
= Status
;
4641 Private
->TextOutMode
.CursorVisible
= Visible
;
4643 return ReturnStatus
;