]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c
projects / mirror_edk2.git / blob
? search:


bcb9fd6f7315b87a2bd06a99c144956d69cb12ff
[mirror_edk2.git] / MdeModulePkg / Universal / Console / ConSplitterDxe / ConSplitter.c
1 /** @file
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.
5
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.
13
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
17 device situation.
18
19 Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>
20 This program and the accompanying materials
21 are licensed and made available under the terms and conditions of the BSD License
22 which accompanies this distribution. The full text of the license may be found at
23 http://opensource.org/licenses/bsd-license.php
24
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.
27
28 **/
29
30 #include "ConSplitter.h"
31
32 //
33 // Identify if ConIn is connected in PcdConInConnectOnDemand enabled mode.
34 // default not connect
35 //
36 BOOLEAN mConInIsConnect = FALSE;
37
38 //
39 // Text In Splitter Private Data template
40 //
41 GLOBAL_REMOVE_IF_UNREFERENCED TEXT_IN_SPLITTER_PRIVATE_DATA mConIn = {
42 TEXT_IN_SPLITTER_PRIVATE_DATA_SIGNATURE,
43 (EFI_HANDLE) NULL,
44
45 {
46 ConSplitterTextInReset,
47 ConSplitterTextInReadKeyStroke,
48 (EFI_EVENT) NULL
49 },
50 0,
51 (EFI_SIMPLE_TEXT_INPUT_PROTOCOL **) NULL,
52 0,
53
54 {
55 ConSplitterTextInResetEx,
56 ConSplitterTextInReadKeyStrokeEx,
57 (EFI_EVENT) NULL,
58 ConSplitterTextInSetState,
59 ConSplitterTextInRegisterKeyNotify,
60 ConSplitterTextInUnregisterKeyNotify
61 },
62 0,
63 (EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL **) NULL,
64 0,
65 {
66 (LIST_ENTRY *) NULL,
67 (LIST_ENTRY *) NULL
68 },
69
70 {
71 ConSplitterSimplePointerReset,
72 ConSplitterSimplePointerGetState,
73 (EFI_EVENT) NULL,
74 (EFI_SIMPLE_POINTER_MODE *) NULL
75 },
76 {
77 0x10000,
78 0x10000,
79 0x10000,
80 TRUE,
81 TRUE
82 },
83 0,
84 (EFI_SIMPLE_POINTER_PROTOCOL **) NULL,
85 0,
86
87 {
88 ConSplitterAbsolutePointerReset,
89 ConSplitterAbsolutePointerGetState,
90 (EFI_EVENT) NULL,
91 (EFI_ABSOLUTE_POINTER_MODE *) NULL
92 },
93 {
94 0, // AbsoluteMinX
95 0, // AbsoluteMinY
96 0, // AbsoluteMinZ
97 0x10000, // AbsoluteMaxX
98 0x10000, // AbsoluteMaxY
99 0x10000, // AbsoluteMaxZ
100 0 // Attributes
101 },
102 0,
103 (EFI_ABSOLUTE_POINTER_PROTOCOL **) NULL,
104 0,
105 FALSE,
106
107 FALSE,
108 FALSE
109 };
110
111
112 //
113 // Uga Draw Protocol Private Data template
114 //
115 GLOBAL_REMOVE_IF_UNREFERENCED EFI_UGA_DRAW_PROTOCOL mUgaDrawProtocolTemplate = {
116 ConSplitterUgaDrawGetMode,
117 ConSplitterUgaDrawSetMode,
118 ConSplitterUgaDrawBlt
119 };
120
121 //
122 // Graphics Output Protocol Private Data template
123 //
124 GLOBAL_REMOVE_IF_UNREFERENCED EFI_GRAPHICS_OUTPUT_PROTOCOL mGraphicsOutputProtocolTemplate = {
125 ConSplitterGraphicsOutputQueryMode,
126 ConSplitterGraphicsOutputSetMode,
127 ConSplitterGraphicsOutputBlt,
128 NULL
129 };
130
131
132 //
133 // Text Out Splitter Private Data template
134 //
135 GLOBAL_REMOVE_IF_UNREFERENCED TEXT_OUT_SPLITTER_PRIVATE_DATA mConOut = {
136 TEXT_OUT_SPLITTER_PRIVATE_DATA_SIGNATURE,
137 (EFI_HANDLE) NULL,
138 {
139 ConSplitterTextOutReset,
140 ConSplitterTextOutOutputString,
141 ConSplitterTextOutTestString,
142 ConSplitterTextOutQueryMode,
143 ConSplitterTextOutSetMode,
144 ConSplitterTextOutSetAttribute,
145 ConSplitterTextOutClearScreen,
146 ConSplitterTextOutSetCursorPosition,
147 ConSplitterTextOutEnableCursor,
148 (EFI_SIMPLE_TEXT_OUTPUT_MODE *) NULL
149 },
150 {
151 1,
152 0,
153 0,
154 0,
155 0,
156 FALSE,
157 },
158
159 {
160 NULL,
161 NULL,
162 NULL
163 },
164 0,
165 0,
166 0,
167 0,
168
169 {
170 NULL,
171 NULL,
172 NULL,
173 NULL
174 },
175 (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *) NULL,
176 0,
177 0,
178
179 0,
180 (TEXT_OUT_AND_GOP_DATA *) NULL,
181 0,
182 (TEXT_OUT_SPLITTER_QUERY_DATA *) NULL,
183 0,
184 (INT32 *) NULL
185 };
186
187 //
188 // Standard Error Text Out Splitter Data Template
189 //
190 GLOBAL_REMOVE_IF_UNREFERENCED TEXT_OUT_SPLITTER_PRIVATE_DATA mStdErr = {
191 TEXT_OUT_SPLITTER_PRIVATE_DATA_SIGNATURE,
192 (EFI_HANDLE) NULL,
193 {
194 ConSplitterTextOutReset,
195 ConSplitterTextOutOutputString,
196 ConSplitterTextOutTestString,
197 ConSplitterTextOutQueryMode,
198 ConSplitterTextOutSetMode,
199 ConSplitterTextOutSetAttribute,
200 ConSplitterTextOutClearScreen,
201 ConSplitterTextOutSetCursorPosition,
202 ConSplitterTextOutEnableCursor,
203 (EFI_SIMPLE_TEXT_OUTPUT_MODE *) NULL
204 },
205 {
206 1,
207 0,
208 0,
209 0,
210 0,
211 FALSE,
212 },
213
214 {
215 NULL,
216 NULL,
217 NULL
218 },
219 0,
220 0,
221 0,
222 0,
223
224 {
225 NULL,
226 NULL,
227 NULL,
228 NULL
229 },
230 (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *) NULL,
231 0,
232 0,
233
234 0,
235 (TEXT_OUT_AND_GOP_DATA *) NULL,
236 0,
237 (TEXT_OUT_SPLITTER_QUERY_DATA *) NULL,
238 0,
239 (INT32 *) NULL
240 };
241
242 //
243 // Driver binding instance for Console Input Device
244 //
245 EFI_DRIVER_BINDING_PROTOCOL gConSplitterConInDriverBinding = {
246 ConSplitterConInDriverBindingSupported,
247 ConSplitterConInDriverBindingStart,
248 ConSplitterConInDriverBindingStop,
249 0xa,
250 NULL,
251 NULL
252 };
253
254 //
255 // Driver binding instance for Console Out device
256 //
257 EFI_DRIVER_BINDING_PROTOCOL gConSplitterConOutDriverBinding = {
258 ConSplitterConOutDriverBindingSupported,
259 ConSplitterConOutDriverBindingStart,
260 ConSplitterConOutDriverBindingStop,
261 0xa,
262 NULL,
263 NULL
264 };
265
266 //
267 // Driver binding instance for Standard Error device
268 //
269 EFI_DRIVER_BINDING_PROTOCOL gConSplitterStdErrDriverBinding = {
270 ConSplitterStdErrDriverBindingSupported,
271 ConSplitterStdErrDriverBindingStart,
272 ConSplitterStdErrDriverBindingStop,
273 0xa,
274 NULL,
275 NULL
276 };
277
278 //
279 // Driver binding instance for Simple Pointer protocol
280 //
281 EFI_DRIVER_BINDING_PROTOCOL gConSplitterSimplePointerDriverBinding = {
282 ConSplitterSimplePointerDriverBindingSupported,
283 ConSplitterSimplePointerDriverBindingStart,
284 ConSplitterSimplePointerDriverBindingStop,
285 0xa,
286 NULL,
287 NULL
288 };
289
290 //
291 // Driver binding instance for Absolute Pointer protocol
292 //
293 EFI_DRIVER_BINDING_PROTOCOL gConSplitterAbsolutePointerDriverBinding = {
294 ConSplitterAbsolutePointerDriverBindingSupported,
295 ConSplitterAbsolutePointerDriverBindingStart,
296 ConSplitterAbsolutePointerDriverBindingStop,
297 0xa,
298 NULL,
299 NULL
300 };
301
302 /**
303 The Entry Point for module ConSplitter. The user code starts with this function.
304
305 Installs driver module protocols and. Creates virtual device handles for ConIn,
306 ConOut, and StdErr. Installs Simple Text In protocol, Simple Text In Ex protocol,
307 Simple Pointer protocol, Absolute Pointer protocol on those virtual handlers.
308 Installs Graphics Output protocol and/or UGA Draw protocol if needed.
309
310 @param[in] ImageHandle The firmware allocated handle for the EFI image.
311 @param[in] SystemTable A pointer to the EFI System Table.
312
313 @retval EFI_SUCCESS The entry point is executed successfully.
314 @retval other Some error occurs when executing this entry point.
315
316 **/
317 EFI_STATUS
318 EFIAPI
319 ConSplitterDriverEntry(
320 IN EFI_HANDLE ImageHandle,
321 IN EFI_SYSTEM_TABLE *SystemTable
322 )
323 {
324 EFI_STATUS Status;
325
326 //
327 // Install driver model protocol(s).
328 //
329 Status = EfiLibInstallDriverBindingComponentName2 (
330 ImageHandle,
331 SystemTable,
332 &gConSplitterConInDriverBinding,
333 ImageHandle,
334 &gConSplitterConInComponentName,
335 &gConSplitterConInComponentName2
336 );
337 ASSERT_EFI_ERROR (Status);
338
339 Status = EfiLibInstallDriverBindingComponentName2 (
340 ImageHandle,
341 SystemTable,
342 &gConSplitterSimplePointerDriverBinding,
343 NULL,
344 &gConSplitterSimplePointerComponentName,
345 &gConSplitterSimplePointerComponentName2
346 );
347 ASSERT_EFI_ERROR (Status);
348
349 Status = EfiLibInstallDriverBindingComponentName2 (
350 ImageHandle,
351 SystemTable,
352 &gConSplitterAbsolutePointerDriverBinding,
353 NULL,
354 &gConSplitterAbsolutePointerComponentName,
355 &gConSplitterAbsolutePointerComponentName2
356 );
357 ASSERT_EFI_ERROR (Status);
358
359 Status = EfiLibInstallDriverBindingComponentName2 (
360 ImageHandle,
361 SystemTable,
362 &gConSplitterConOutDriverBinding,
363 NULL,
364 &gConSplitterConOutComponentName,
365 &gConSplitterConOutComponentName2
366 );
367 ASSERT_EFI_ERROR (Status);
368
369 Status = EfiLibInstallDriverBindingComponentName2 (
370 ImageHandle,
371 SystemTable,
372 &gConSplitterStdErrDriverBinding,
373 NULL,
374 &gConSplitterStdErrComponentName,
375 &gConSplitterStdErrComponentName2
376 );
377 ASSERT_EFI_ERROR (Status);
378
379 //
380 // Either Graphics Output protocol or UGA Draw protocol must be supported.
381 //
382 ASSERT (FeaturePcdGet (PcdConOutGopSupport) ||
383 FeaturePcdGet (PcdConOutUgaSupport));
384
385 //
386 // The driver creates virtual handles for ConIn, ConOut, StdErr.
387 // The virtual handles will always exist even if no console exist in the
388 // system. This is need to support hotplug devices like USB.
389 //
390 //
391 // Create virtual device handle for ConIn Splitter
392 //
393 Status = ConSplitterTextInConstructor (&mConIn);
394 if (!EFI_ERROR (Status)) {
395 Status = gBS->InstallMultipleProtocolInterfaces (
396 &mConIn.VirtualHandle,
397 &gEfiSimpleTextInProtocolGuid,
398 &mConIn.TextIn,
399 &gEfiSimpleTextInputExProtocolGuid,
400 &mConIn.TextInEx,
401 &gEfiSimplePointerProtocolGuid,
402 &mConIn.SimplePointer,
403 &gEfiAbsolutePointerProtocolGuid,
404 &mConIn.AbsolutePointer,
405 NULL
406 );
407 if (!EFI_ERROR (Status)) {
408 //
409 // Update the EFI System Table with new virtual console
410 // and update the pointer to Simple Text Input protocol.
411 //
412 gST->ConsoleInHandle = mConIn.VirtualHandle;
413 gST->ConIn = &mConIn.TextIn;
414 }
415 }
416 //
417 // Create virtual device handle for ConOut Splitter
418 //
419 Status = ConSplitterTextOutConstructor (&mConOut);
420 if (!EFI_ERROR (Status)) {
421 Status = gBS->InstallMultipleProtocolInterfaces (
422 &mConOut.VirtualHandle,
423 &gEfiSimpleTextOutProtocolGuid,
424 &mConOut.TextOut,
425 NULL
426 );
427 if (!EFI_ERROR (Status)) {
428 //
429 // Update the EFI System Table with new virtual console
430 // and Update the pointer to Text Output protocol.
431 //
432 gST->ConsoleOutHandle = mConOut.VirtualHandle;
433 gST->ConOut = &mConOut.TextOut;
434 }
435
436 }
437
438 //
439 // Create virtual device handle for StdErr Splitter
440 //
441 Status = ConSplitterTextOutConstructor (&mStdErr);
442 if (!EFI_ERROR (Status)) {
443 Status = gBS->InstallMultipleProtocolInterfaces (
444 &mStdErr.VirtualHandle,
445 &gEfiSimpleTextOutProtocolGuid,
446 &mStdErr.TextOut,
447 NULL
448 );
449 if (!EFI_ERROR (Status)) {
450 //
451 // Update the EFI System Table with new virtual console
452 // and update the pointer to Text Output protocol.
453 //
454 gST->StandardErrorHandle = mStdErr.VirtualHandle;
455 gST->StdErr = &mStdErr.TextOut;
456 }
457 }
458
459 //
460 // Update the CRC32 in the EFI System Table header
461 //
462 gST->Hdr.CRC32 = 0;
463 gBS->CalculateCrc32 (
464 (UINT8 *) &gST->Hdr,
465 gST->Hdr.HeaderSize,
466 &gST->Hdr.CRC32
467 );
468
469 return EFI_SUCCESS;
470
471 }
472
473 /**
474 Construct console input devices' private data.
475
476 @param ConInPrivate A pointer to the TEXT_IN_SPLITTER_PRIVATE_DATA
477 structure.
478
479 @retval EFI_OUT_OF_RESOURCES Out of resources.
480 @retval EFI_SUCCESS Text Input Devcie's private data has been constructed.
481 @retval other Failed to construct private data.
482
483 **/
484 EFI_STATUS
485 ConSplitterTextInConstructor (
486 TEXT_IN_SPLITTER_PRIVATE_DATA *ConInPrivate
487 )
488 {
489 EFI_STATUS Status;
490
491 //
492 // Allocate buffer for Simple Text Input device
493 //
494 Status = ConSplitterGrowBuffer (
495 sizeof (EFI_SIMPLE_TEXT_INPUT_PROTOCOL *),
496 &ConInPrivate->TextInListCount,
497 (VOID **) &ConInPrivate->TextInList
498 );
499 if (EFI_ERROR (Status)) {
500 return EFI_OUT_OF_RESOURCES;
501 }
502
503 //
504 // Create Event to wait for a key
505 //
506 Status = gBS->CreateEvent (
507 EVT_NOTIFY_WAIT,
508 TPL_NOTIFY,
509 ConSplitterTextInWaitForKey,
510 ConInPrivate,
511 &ConInPrivate->TextIn.WaitForKey
512 );
513 ASSERT_EFI_ERROR (Status);
514
515 //
516 // Allocate buffer for Simple Text Input Ex device
517 //
518 Status = ConSplitterGrowBuffer (
519 sizeof (EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *),
520 &ConInPrivate->TextInExListCount,
521 (VOID **) &ConInPrivate->TextInExList
522 );
523 if (EFI_ERROR (Status)) {
524 return EFI_OUT_OF_RESOURCES;
525 }
526 //
527 // Create Event to wait for a key Ex
528 //
529 Status = gBS->CreateEvent (
530 EVT_NOTIFY_WAIT,
531 TPL_NOTIFY,
532 ConSplitterTextInWaitForKey,
533 ConInPrivate,
534 &ConInPrivate->TextInEx.WaitForKeyEx
535 );
536 ASSERT_EFI_ERROR (Status);
537
538 InitializeListHead (&ConInPrivate->NotifyList);
539
540 ConInPrivate->AbsolutePointer.Mode = &ConInPrivate->AbsolutePointerMode;
541 //
542 // Allocate buffer for Absolute Pointer device
543 //
544 Status = ConSplitterGrowBuffer (
545 sizeof (EFI_ABSOLUTE_POINTER_PROTOCOL *),
546 &ConInPrivate->AbsolutePointerListCount,
547 (VOID **) &ConInPrivate->AbsolutePointerList
548 );
549 if (EFI_ERROR (Status)) {
550 return EFI_OUT_OF_RESOURCES;
551 }
552 //
553 // Create Event to wait for device input for Absolute pointer device
554 //
555 Status = gBS->CreateEvent (
556 EVT_NOTIFY_WAIT,
557 TPL_NOTIFY,
558 ConSplitterAbsolutePointerWaitForInput,
559 ConInPrivate,
560 &ConInPrivate->AbsolutePointer.WaitForInput
561 );
562 ASSERT_EFI_ERROR (Status);
563
564 ConInPrivate->SimplePointer.Mode = &ConInPrivate->SimplePointerMode;
565 //
566 // Allocate buffer for Simple Pointer device
567 //
568 Status = ConSplitterGrowBuffer (
569 sizeof (EFI_SIMPLE_POINTER_PROTOCOL *),
570 &ConInPrivate->PointerListCount,
571 (VOID **) &ConInPrivate->PointerList
572 );
573 if (EFI_ERROR (Status)) {
574 return EFI_OUT_OF_RESOURCES;
575 }
576 //
577 // Create Event to wait for device input for Simple pointer device
578 //
579 Status = gBS->CreateEvent (
580 EVT_NOTIFY_WAIT,
581 TPL_NOTIFY,
582 ConSplitterSimplePointerWaitForInput,
583 ConInPrivate,
584 &ConInPrivate->SimplePointer.WaitForInput
585 );
586 ASSERT_EFI_ERROR (Status);
587 //
588 // Create Event to signal ConIn connection request
589 //
590 Status = gBS->CreateEventEx (
591 EVT_NOTIFY_SIGNAL,
592 TPL_CALLBACK,
593 ConSplitterEmptyCallbackFunction,
594 NULL,
595 &gConnectConInEventGuid,
596 &ConInPrivate->ConnectConInEvent
597 );
598
599 return Status;
600 }
601
602 /**
603 Construct console output devices' private data.
604
605 @param ConOutPrivate A pointer to the TEXT_OUT_SPLITTER_PRIVATE_DATA
606 structure.
607
608 @retval EFI_OUT_OF_RESOURCES Out of resources.
609 @retval EFI_SUCCESS Text Input Devcie's private data has been constructed.
610
611 **/
612 EFI_STATUS
613 ConSplitterTextOutConstructor (
614 TEXT_OUT_SPLITTER_PRIVATE_DATA *ConOutPrivate
615 )
616 {
617 EFI_STATUS Status;
618 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *Info;
619
620 //
621 // Copy protocols template
622 //
623 if (FeaturePcdGet (PcdConOutUgaSupport)) {
624 CopyMem (&ConOutPrivate->UgaDraw, &mUgaDrawProtocolTemplate, sizeof (EFI_UGA_DRAW_PROTOCOL));
625 }
626 if (FeaturePcdGet (PcdConOutGopSupport)) {
627 CopyMem (&ConOutPrivate->GraphicsOutput, &mGraphicsOutputProtocolTemplate, sizeof (EFI_GRAPHICS_OUTPUT_PROTOCOL));
628 }
629
630 //
631 // Initilize console output splitter's private data.
632 //
633 ConOutPrivate->TextOut.Mode = &ConOutPrivate->TextOutMode;
634
635 //
636 // When new console device is added, the new mode will be set later,
637 // so put current mode back to init state.
638 //
639 ConOutPrivate->TextOutMode.Mode = 0xFF;
640 //
641 // Allocate buffer for Console Out device
642 //
643 Status = ConSplitterGrowBuffer (
644 sizeof (TEXT_OUT_AND_GOP_DATA),
645 &ConOutPrivate->TextOutListCount,
646 (VOID **) &ConOutPrivate->TextOutList
647 );
648 if (EFI_ERROR (Status)) {
649 return EFI_OUT_OF_RESOURCES;
650 }
651 //
652 // Allocate buffer for Text Out query data
653 //
654 Status = ConSplitterGrowBuffer (
655 sizeof (TEXT_OUT_SPLITTER_QUERY_DATA),
656 &ConOutPrivate->TextOutQueryDataCount,
657 (VOID **) &ConOutPrivate->TextOutQueryData
658 );
659 if (EFI_ERROR (Status)) {
660 return EFI_OUT_OF_RESOURCES;
661 }
662
663 //
664 // Setup the default console to 80 x 25 and mode to 0
665 //
666 ConOutPrivate->TextOutQueryData[0].Columns = 80;
667 ConOutPrivate->TextOutQueryData[0].Rows = 25;
668 TextOutSetMode (ConOutPrivate, 0);
669
670
671 if (FeaturePcdGet (PcdConOutUgaSupport)) {
672 //
673 // Setup the UgaDraw to 800 x 600 x 32 bits per pixel, 60Hz.
674 //
675 ConSplitterUgaDrawSetMode (&ConOutPrivate->UgaDraw, 800, 600, 32, 60);
676 }
677 if (FeaturePcdGet (PcdConOutGopSupport)) {
678 //
679 // Setup resource for mode information in Graphics Output Protocol interface
680 //
681 if ((ConOutPrivate->GraphicsOutput.Mode = AllocateZeroPool (sizeof (EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE))) == NULL) {
682 return EFI_OUT_OF_RESOURCES;
683 }
684 if ((ConOutPrivate->GraphicsOutput.Mode->Info = AllocateZeroPool (sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION))) == NULL) {
685 return EFI_OUT_OF_RESOURCES;
686 }
687 //
688 // Setup the DevNullGraphicsOutput to 800 x 600 x 32 bits per pixel
689 // DevNull will be updated to user-defined mode after driver has started.
690 //
691 if ((ConOutPrivate->GraphicsOutputModeBuffer = AllocateZeroPool (sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION))) == NULL) {
692 return EFI_OUT_OF_RESOURCES;
693 }
694 Info = &ConOutPrivate->GraphicsOutputModeBuffer[0];
695 Info->Version = 0;
696 Info->HorizontalResolution = 800;
697 Info->VerticalResolution = 600;
698 Info->PixelFormat = PixelBltOnly;
699 Info->PixelsPerScanLine = 800;
700 CopyMem (ConOutPrivate->GraphicsOutput.Mode->Info, Info, sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION));
701 ConOutPrivate->GraphicsOutput.Mode->SizeOfInfo = sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION);
702
703 //
704 // Initialize the following items, theset items remain unchanged in GraphicsOutput->SetMode()
705 // GraphicsOutputMode->FrameBufferBase, GraphicsOutputMode->FrameBufferSize
706 //
707 ConOutPrivate->GraphicsOutput.Mode->FrameBufferBase = (EFI_PHYSICAL_ADDRESS) (UINTN) NULL;
708 ConOutPrivate->GraphicsOutput.Mode->FrameBufferSize = 0;
709
710 ConOutPrivate->GraphicsOutput.Mode->MaxMode = 1;
711 //
712 // Initial current mode to unknown state, and then set to mode 0
713 //
714 ConOutPrivate->GraphicsOutput.Mode->Mode = 0xffff;
715 ConOutPrivate->GraphicsOutput.SetMode (&ConOutPrivate->GraphicsOutput, 0);
716 }
717
718 return EFI_SUCCESS;
719 }
720
721
722 /**
723 Test to see if the specified protocol could be supported on the specified device.
724
725 @param This Driver Binding protocol pointer.
726 @param ControllerHandle Handle of device to test.
727 @param Guid The specified protocol.
728
729 @retval EFI_SUCCESS The specified protocol is supported on this device.
730 @retval EFI_UNSUPPORTED The specified protocol attempts to be installed on virtul handle.
731 @retval other Failed to open specified protocol on this device.
732
733 **/
734 EFI_STATUS
735 ConSplitterSupported (
736 IN EFI_DRIVER_BINDING_PROTOCOL *This,
737 IN EFI_HANDLE ControllerHandle,
738 IN EFI_GUID *Guid
739 )
740 {
741 EFI_STATUS Status;
742 VOID *Instance;
743
744 //
745 // Make sure the Console Splitter does not attempt to attach to itself
746 //
747 if (ControllerHandle == mConIn.VirtualHandle ||
748 ControllerHandle == mConOut.VirtualHandle ||
749 ControllerHandle == mStdErr.VirtualHandle
750 ) {
751 return EFI_UNSUPPORTED;
752 }
753
754 //
755 // Check to see whether the specific protocol could be opened BY_DRIVER
756 //
757 Status = gBS->OpenProtocol (
758 ControllerHandle,
759 Guid,
760 &Instance,
761 This->DriverBindingHandle,
762 ControllerHandle,
763 EFI_OPEN_PROTOCOL_BY_DRIVER
764 );
765
766 if (EFI_ERROR (Status)) {
767 return Status;
768 }
769
770 gBS->CloseProtocol (
771 ControllerHandle,
772 Guid,
773 This->DriverBindingHandle,
774 ControllerHandle
775 );
776
777 return EFI_SUCCESS;
778 }
779
780 /**
781 Test to see if Console In Device could be supported on the Controller.
782
783 @param This Driver Binding protocol instance pointer.
784 @param ControllerHandle Handle of device to test.
785 @param RemainingDevicePath Optional parameter use to pick a specific child
786 device to start.
787
788 @retval EFI_SUCCESS This driver supports this device.
789 @retval other This driver does not support this device.
790
791 **/
792 EFI_STATUS
793 EFIAPI
794 ConSplitterConInDriverBindingSupported (
795 IN EFI_DRIVER_BINDING_PROTOCOL *This,
796 IN EFI_HANDLE ControllerHandle,
797 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
798 )
799 {
800 return ConSplitterSupported (
801 This,
802 ControllerHandle,
803 &gEfiConsoleInDeviceGuid
804 );
805 }
806
807 /**
808 Test to see if Simple Pointer protocol could be supported on the Controller.
809
810 @param This Driver Binding protocol instance pointer.
811 @param ControllerHandle Handle of device to test.
812 @param RemainingDevicePath Optional parameter use to pick a specific child
813 device to start.
814
815 @retval EFI_SUCCESS This driver supports this device.
816 @retval other This driver does not support this device.
817
818 **/
819 EFI_STATUS
820 EFIAPI
821 ConSplitterSimplePointerDriverBindingSupported (
822 IN EFI_DRIVER_BINDING_PROTOCOL *This,
823 IN EFI_HANDLE ControllerHandle,
824 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
825 )
826 {
827 return ConSplitterSupported (
828 This,
829 ControllerHandle,
830 &gEfiSimplePointerProtocolGuid
831 );
832 }
833
834 /**
835 Test to see if Absolute Pointer protocol could be supported on the Controller.
836
837 @param This Driver Binding protocol instance pointer.
838 @param ControllerHandle Handle of device to test.
839 @param RemainingDevicePath Optional parameter use to pick a specific child
840 device to start.
841
842 @retval EFI_SUCCESS This driver supports this device.
843 @retval other This driver does not support this device.
844
845 **/
846 EFI_STATUS
847 EFIAPI
848 ConSplitterAbsolutePointerDriverBindingSupported (
849 IN EFI_DRIVER_BINDING_PROTOCOL *This,
850 IN EFI_HANDLE ControllerHandle,
851 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
852 )
853 {
854 return ConSplitterSupported (
855 This,
856 ControllerHandle,
857 &gEfiAbsolutePointerProtocolGuid
858 );
859 }
860
861
862 /**
863 Test to see if Console Out Device could be supported on the Controller.
864
865 @param This Driver Binding protocol instance pointer.
866 @param ControllerHandle Handle of device to test.
867 @param RemainingDevicePath Optional parameter use to pick a specific child
868 device to start.
869
870 @retval EFI_SUCCESS This driver supports this device.
871 @retval other This driver does not support this device.
872
873 **/
874 EFI_STATUS
875 EFIAPI
876 ConSplitterConOutDriverBindingSupported (
877 IN EFI_DRIVER_BINDING_PROTOCOL *This,
878 IN EFI_HANDLE ControllerHandle,
879 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
880 )
881 {
882 return ConSplitterSupported (
883 This,
884 ControllerHandle,
885 &gEfiConsoleOutDeviceGuid
886 );
887 }
888
889 /**
890 Test to see if Standard Error Device could be supported on the Controller.
891
892 @param This Driver Binding protocol instance pointer.
893 @param ControllerHandle Handle of device to test.
894 @param RemainingDevicePath Optional parameter use to pick a specific child
895 device to start.
896
897 @retval EFI_SUCCESS This driver supports this device.
898 @retval other This driver does not support this device.
899
900 **/
901 EFI_STATUS
902 EFIAPI
903 ConSplitterStdErrDriverBindingSupported (
904 IN EFI_DRIVER_BINDING_PROTOCOL *This,
905 IN EFI_HANDLE ControllerHandle,
906 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
907 )
908 {
909 return ConSplitterSupported (
910 This,
911 ControllerHandle,
912 &gEfiStandardErrorDeviceGuid
913 );
914 }
915
916
917 /**
918 Start ConSplitter on devcie handle by opening Console Device Guid on device handle
919 and the console virtual handle. And Get the console interface on controller handle.
920
921 @param This Driver Binding protocol instance pointer.
922 @param ControllerHandle Handle of device.
923 @param ConSplitterVirtualHandle Console virtual Handle.
924 @param DeviceGuid The specified Console Device, such as ConInDev,
925 ConOutDev.
926 @param InterfaceGuid The specified protocol to be opened.
927 @param Interface Protocol interface returned.
928
929 @retval EFI_SUCCESS This driver supports this device.
930 @retval other Failed to open the specified Console Device Guid
931 or specified protocol.
932
933 **/
934 EFI_STATUS
935 ConSplitterStart (
936 IN EFI_DRIVER_BINDING_PROTOCOL *This,
937 IN EFI_HANDLE ControllerHandle,
938 IN EFI_HANDLE ConSplitterVirtualHandle,
939 IN EFI_GUID *DeviceGuid,
940 IN EFI_GUID *InterfaceGuid,
941 OUT VOID **Interface
942 )
943 {
944 EFI_STATUS Status;
945 VOID *Instance;
946
947 //
948 // Check to see whether the ControllerHandle has the DeviceGuid on it.
949 //
950 Status = gBS->OpenProtocol (
951 ControllerHandle,
952 DeviceGuid,
953 &Instance,
954 This->DriverBindingHandle,
955 ControllerHandle,
956 EFI_OPEN_PROTOCOL_BY_DRIVER
957 );
958 if (EFI_ERROR (Status)) {
959 return Status;
960 }
961
962 //
963 // Open the Parent Handle for the child.
964 //
965 Status = gBS->OpenProtocol (
966 ControllerHandle,
967 DeviceGuid,
968 &Instance,
969 This->DriverBindingHandle,
970 ConSplitterVirtualHandle,
971 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
972 );
973 if (EFI_ERROR (Status)) {
974 goto Err;
975 }
976
977 //
978 // Open InterfaceGuid on the virtul handle.
979 //
980 Status = gBS->OpenProtocol (
981 ControllerHandle,
982 InterfaceGuid,
983 Interface,
984 This->DriverBindingHandle,
985 ConSplitterVirtualHandle,
986 EFI_OPEN_PROTOCOL_GET_PROTOCOL
987 );
988
989 if (!EFI_ERROR (Status)) {
990 return EFI_SUCCESS;
991 }
992
993 //
994 // close the DeviceGuid on ConSplitter VirtualHandle.
995 //
996 gBS->CloseProtocol (
997 ControllerHandle,
998 DeviceGuid,
999 This->DriverBindingHandle,
1000 ConSplitterVirtualHandle
1001 );
1002
1003 Err:
1004 //
1005 // close the DeviceGuid on ControllerHandle.
1006 //
1007 gBS->CloseProtocol (
1008 ControllerHandle,
1009 DeviceGuid,
1010 This->DriverBindingHandle,
1011 ControllerHandle
1012 );
1013
1014 return Status;
1015 }
1016
1017
1018 /**
1019 Start Console In Consplitter on device handle.
1020
1021 @param This Driver Binding protocol instance pointer.
1022 @param ControllerHandle Handle of device to bind driver to.
1023 @param RemainingDevicePath Optional parameter use to pick a specific child
1024 device to start.
1025
1026 @retval EFI_SUCCESS Console In Consplitter is added to ControllerHandle.
1027 @retval other Console In Consplitter does not support this device.
1028
1029 **/
1030 EFI_STATUS
1031 EFIAPI
1032 ConSplitterConInDriverBindingStart (
1033 IN EFI_DRIVER_BINDING_PROTOCOL *This,
1034 IN EFI_HANDLE ControllerHandle,
1035 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
1036 )
1037 {
1038 EFI_STATUS Status;
1039 EFI_SIMPLE_TEXT_INPUT_PROTOCOL *TextIn;
1040 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *TextInEx;
1041
1042 //
1043 // Start ConSplitter on ControllerHandle, and create the virtual
1044 // agrogated console device on first call Start for a SimpleTextIn handle.
1045 //
1046 Status = ConSplitterStart (
1047 This,
1048 ControllerHandle,
1049 mConIn.VirtualHandle,
1050 &gEfiConsoleInDeviceGuid,
1051 &gEfiSimpleTextInProtocolGuid,
1052 (VOID **) &TextIn
1053 );
1054 if (EFI_ERROR (Status)) {
1055 return Status;
1056 }
1057
1058 //
1059 // Add this device into Text In devices list.
1060 //
1061 Status = ConSplitterTextInAddDevice (&mConIn, TextIn);
1062 if (EFI_ERROR (Status)) {
1063 return Status;
1064 }
1065
1066 Status = gBS->OpenProtocol (
1067 ControllerHandle,
1068 &gEfiSimpleTextInputExProtocolGuid,
1069 (VOID **) &TextInEx,
1070 This->DriverBindingHandle,
1071 mConIn.VirtualHandle,
1072 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1073 );
1074 if (!EFI_ERROR (Status)) {
1075 //
1076 // If Simple Text Input Ex protocol exists,
1077 // add this device into Text In Ex devices list.
1078 //
1079 Status = ConSplitterTextInExAddDevice (&mConIn, TextInEx);
1080 }
1081
1082 return Status;
1083 }
1084
1085
1086 /**
1087 Start Simple Pointer Consplitter on device handle.
1088
1089 @param This Driver Binding protocol instance pointer.
1090 @param ControllerHandle Handle of device to bind driver to.
1091 @param RemainingDevicePath Optional parameter use to pick a specific child
1092 device to start.
1093
1094 @retval EFI_SUCCESS Simple Pointer Consplitter is added to ControllerHandle.
1095 @retval other Simple Pointer Consplitter does not support this device.
1096
1097 **/
1098 EFI_STATUS
1099 EFIAPI
1100 ConSplitterSimplePointerDriverBindingStart (
1101 IN EFI_DRIVER_BINDING_PROTOCOL *This,
1102 IN EFI_HANDLE ControllerHandle,
1103 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
1104 )
1105 {
1106 EFI_STATUS Status;
1107 EFI_SIMPLE_POINTER_PROTOCOL *SimplePointer;
1108
1109 //
1110 // Start ConSplitter on ControllerHandle, and create the virtual
1111 // agrogated console device on first call Start for a SimplePointer handle.
1112 //
1113 Status = ConSplitterStart (
1114 This,
1115 ControllerHandle,
1116 mConIn.VirtualHandle,
1117 &gEfiSimplePointerProtocolGuid,
1118 &gEfiSimplePointerProtocolGuid,
1119 (VOID **) &SimplePointer
1120 );
1121 if (EFI_ERROR (Status)) {
1122 return Status;
1123 }
1124
1125 //
1126 // Add this devcie into Simple Pointer devices list.
1127 //
1128 return ConSplitterSimplePointerAddDevice (&mConIn, SimplePointer);
1129 }
1130
1131
1132 /**
1133 Start Absolute Pointer Consplitter on device handle.
1134
1135 @param This Driver Binding protocol instance pointer.
1136 @param ControllerHandle Handle of device to bind driver to.
1137 @param RemainingDevicePath Optional parameter use to pick a specific child
1138 device to start.
1139
1140 @retval EFI_SUCCESS Absolute Pointer Consplitter is added to ControllerHandle.
1141 @retval other Absolute Pointer Consplitter does not support this device.
1142
1143 **/
1144 EFI_STATUS
1145 EFIAPI
1146 ConSplitterAbsolutePointerDriverBindingStart (
1147 IN EFI_DRIVER_BINDING_PROTOCOL *This,
1148 IN EFI_HANDLE ControllerHandle,
1149 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
1150 )
1151 {
1152 EFI_STATUS Status;
1153 EFI_ABSOLUTE_POINTER_PROTOCOL *AbsolutePointer;
1154
1155 //
1156 // Start ConSplitter on ControllerHandle, and create the virtual
1157 // agrogated console device on first call Start for a AbsolutePointer handle.
1158 //
1159 Status = ConSplitterStart (
1160 This,
1161 ControllerHandle,
1162 mConIn.VirtualHandle,
1163 &gEfiAbsolutePointerProtocolGuid,
1164 &gEfiAbsolutePointerProtocolGuid,
1165 (VOID **) &AbsolutePointer
1166 );
1167
1168 if (EFI_ERROR (Status)) {
1169 return Status;
1170 }
1171
1172 //
1173 // Add this devcie into Absolute Pointer devices list.
1174 //
1175 return ConSplitterAbsolutePointerAddDevice (&mConIn, AbsolutePointer);
1176 }
1177
1178
1179 /**
1180 Start Console Out Consplitter on device handle.
1181
1182 @param This Driver Binding protocol instance pointer.
1183 @param ControllerHandle Handle of device to bind driver to.
1184 @param RemainingDevicePath Optional parameter use to pick a specific child
1185 device to start.
1186
1187 @retval EFI_SUCCESS Console Out Consplitter is added to ControllerHandle.
1188 @retval other Console Out Consplitter does not support this device.
1189
1190 **/
1191 EFI_STATUS
1192 EFIAPI
1193 ConSplitterConOutDriverBindingStart (
1194 IN EFI_DRIVER_BINDING_PROTOCOL *This,
1195 IN EFI_HANDLE ControllerHandle,
1196 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
1197 )
1198 {
1199 EFI_STATUS Status;
1200 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *TextOut;
1201 EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput;
1202 EFI_UGA_DRAW_PROTOCOL *UgaDraw;
1203 UINTN SizeOfInfo;
1204 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *Info;
1205
1206 //
1207 // Start ConSplitter on ControllerHandle, and create the virtual
1208 // agrogated console device on first call Start for a ConsoleOut handle.
1209 //
1210 Status = ConSplitterStart (
1211 This,
1212 ControllerHandle,
1213 mConOut.VirtualHandle,
1214 &gEfiConsoleOutDeviceGuid,
1215 &gEfiSimpleTextOutProtocolGuid,
1216 (VOID **) &TextOut
1217 );
1218 if (EFI_ERROR (Status)) {
1219 return Status;
1220 }
1221
1222 GraphicsOutput = NULL;
1223 UgaDraw = NULL;
1224 //
1225 // Try to Open Graphics Output protocol
1226 //
1227 Status = gBS->OpenProtocol (
1228 ControllerHandle,
1229 &gEfiGraphicsOutputProtocolGuid,
1230 (VOID **) &GraphicsOutput,
1231 This->DriverBindingHandle,
1232 mConOut.VirtualHandle,
1233 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1234 );
1235
1236 if (EFI_ERROR (Status) && FeaturePcdGet (PcdUgaConsumeSupport)) {
1237 //
1238 // Open UGA DRAW protocol
1239 //
1240 gBS->OpenProtocol (
1241 ControllerHandle,
1242 &gEfiUgaDrawProtocolGuid,
1243 (VOID **) &UgaDraw,
1244 This->DriverBindingHandle,
1245 mConOut.VirtualHandle,
1246 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1247 );
1248 }
1249
1250 //
1251 // When new console device is added, the new mode will be set later,
1252 // so put current mode back to init state.
1253 //
1254 mConOut.TextOutMode.Mode = 0xFF;
1255
1256 //
1257 // If both ConOut and StdErr incorporate the same Text Out device,
1258 // their MaxMode and QueryData should be the intersection of both.
1259 //
1260 Status = ConSplitterTextOutAddDevice (&mConOut, TextOut, GraphicsOutput, UgaDraw);
1261 ConSplitterTextOutSetAttribute (&mConOut.TextOut, EFI_TEXT_ATTR (EFI_LIGHTGRAY, EFI_BLACK));
1262
1263 if (FeaturePcdGet (PcdConOutUgaSupport)) {
1264 //
1265 // Get the UGA mode data of ConOut from the current mode
1266 //
1267 if (GraphicsOutput != NULL) {
1268 Status = GraphicsOutput->QueryMode (GraphicsOutput, GraphicsOutput->Mode->Mode, &SizeOfInfo, &Info);
1269 if (EFI_ERROR (Status)) {
1270 return Status;
1271 }
1272 ASSERT ( SizeOfInfo <= sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION));
1273
1274 mConOut.UgaHorizontalResolution = Info->HorizontalResolution;
1275 mConOut.UgaVerticalResolution = Info->VerticalResolution;
1276 mConOut.UgaColorDepth = 32;
1277 mConOut.UgaRefreshRate = 60;
1278
1279 FreePool (Info);
1280
1281 } else if (UgaDraw != NULL) {
1282 Status = UgaDraw->GetMode (
1283 UgaDraw,
1284 &mConOut.UgaHorizontalResolution,
1285 &mConOut.UgaVerticalResolution,
1286 &mConOut.UgaColorDepth,
1287 &mConOut.UgaRefreshRate
1288 );
1289 }
1290 }
1291
1292 return Status;
1293 }
1294
1295
1296 /**
1297 Start Standard Error Consplitter on device handle.
1298
1299 @param This Driver Binding protocol instance pointer.
1300 @param ControllerHandle Handle of device to bind driver to.
1301 @param RemainingDevicePath Optional parameter use to pick a specific child
1302 device to start.
1303
1304 @retval EFI_SUCCESS Standard Error Consplitter is added to ControllerHandle.
1305 @retval other Standard Error Consplitter does not support this device.
1306
1307 **/
1308 EFI_STATUS
1309 EFIAPI
1310 ConSplitterStdErrDriverBindingStart (
1311 IN EFI_DRIVER_BINDING_PROTOCOL *This,
1312 IN EFI_HANDLE ControllerHandle,
1313 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
1314 )
1315 {
1316 EFI_STATUS Status;
1317 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *TextOut;
1318
1319 //
1320 // Start ConSplitter on ControllerHandle, and create the virtual
1321 // agrogated console device on first call Start for a StandardError handle.
1322 //
1323 Status = ConSplitterStart (
1324 This,
1325 ControllerHandle,
1326 mStdErr.VirtualHandle,
1327 &gEfiStandardErrorDeviceGuid,
1328 &gEfiSimpleTextOutProtocolGuid,
1329 (VOID **) &TextOut
1330 );
1331 if (EFI_ERROR (Status)) {
1332 return Status;
1333 }
1334
1335 //
1336 // When new console device is added, the new mode will be set later,
1337 // so put current mode back to init state.
1338 //
1339 mStdErr.TextOutMode.Mode = 0xFF;
1340
1341 //
1342 // If both ConOut and StdErr incorporate the same Text Out device,
1343 // their MaxMode and QueryData should be the intersection of both.
1344 //
1345 Status = ConSplitterTextOutAddDevice (&mStdErr, TextOut, NULL, NULL);
1346 ConSplitterTextOutSetAttribute (&mStdErr.TextOut, EFI_TEXT_ATTR (EFI_MAGENTA, EFI_BLACK));
1347 if (EFI_ERROR (Status)) {
1348 return Status;
1349 }
1350
1351 return Status;
1352 }
1353
1354
1355 /**
1356 Stop ConSplitter on device handle by closing Console Device Guid on device handle
1357 and the console virtual handle.
1358
1359 @param This Protocol instance pointer.
1360 @param ControllerHandle Handle of device.
1361 @param ConSplitterVirtualHandle Console virtual Handle.
1362 @param DeviceGuid The specified Console Device, such as ConInDev,
1363 ConOutDev.
1364 @param InterfaceGuid The specified protocol to be opened.
1365 @param Interface Protocol interface returned.
1366
1367 @retval EFI_SUCCESS Stop ConSplitter on ControllerHandle successfully.
1368 @retval other Failed to Stop ConSplitter on ControllerHandle.
1369
1370 **/
1371 EFI_STATUS
1372 ConSplitterStop (
1373 IN EFI_DRIVER_BINDING_PROTOCOL *This,
1374 IN EFI_HANDLE ControllerHandle,
1375 IN EFI_HANDLE ConSplitterVirtualHandle,
1376 IN EFI_GUID *DeviceGuid,
1377 IN EFI_GUID *InterfaceGuid,
1378 IN VOID **Interface
1379 )
1380 {
1381 EFI_STATUS Status;
1382
1383 Status = gBS->OpenProtocol (
1384 ControllerHandle,
1385 InterfaceGuid,
1386 Interface,
1387 This->DriverBindingHandle,
1388 ControllerHandle,
1389 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1390 );
1391 if (EFI_ERROR (Status)) {
1392 return Status;
1393 }
1394 //
1395 // close the protocol refered.
1396 //
1397 gBS->CloseProtocol (
1398 ControllerHandle,
1399 DeviceGuid,
1400 This->DriverBindingHandle,
1401 ConSplitterVirtualHandle
1402 );
1403
1404 gBS->CloseProtocol (
1405 ControllerHandle,
1406 DeviceGuid,
1407 This->DriverBindingHandle,
1408 ControllerHandle
1409 );
1410
1411 return EFI_SUCCESS;
1412 }
1413
1414
1415 /**
1416 Stop Console In ConSplitter on ControllerHandle by closing Console In Devcice GUID.
1417
1418 @param This Driver Binding protocol instance pointer.
1419 @param ControllerHandle Handle of device to stop driver on
1420 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
1421 children is zero stop the entire bus driver.
1422 @param ChildHandleBuffer List of Child Handles to Stop.
1423
1424 @retval EFI_SUCCESS This driver is removed ControllerHandle
1425 @retval other This driver was not removed from this device
1426
1427 **/
1428 EFI_STATUS
1429 EFIAPI
1430 ConSplitterConInDriverBindingStop (
1431 IN EFI_DRIVER_BINDING_PROTOCOL *This,
1432 IN EFI_HANDLE ControllerHandle,
1433 IN UINTN NumberOfChildren,
1434 IN EFI_HANDLE *ChildHandleBuffer
1435 )
1436 {
1437 EFI_STATUS Status;
1438 EFI_SIMPLE_TEXT_INPUT_PROTOCOL *TextIn;
1439 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *TextInEx;
1440
1441 if (NumberOfChildren == 0) {
1442 return EFI_SUCCESS;
1443 }
1444
1445 Status = gBS->OpenProtocol (
1446 ControllerHandle,
1447 &gEfiSimpleTextInputExProtocolGuid,
1448 (VOID **) &TextInEx,
1449 This->DriverBindingHandle,
1450 ControllerHandle,
1451 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1452 );
1453 if (!EFI_ERROR (Status)) {
1454 //
1455 // If Simple Text Input Ex protocol exists,
1456 // remove device from Text Input Ex devices list.
1457 //
1458 Status = ConSplitterTextInExDeleteDevice (&mConIn, TextInEx);
1459 if (EFI_ERROR (Status)) {
1460 return Status;
1461 }
1462 }
1463
1464 //
1465 // Close Simple Text In protocol on controller handle and virtual handle.
1466 //
1467 Status = ConSplitterStop (
1468 This,
1469 ControllerHandle,
1470 mConIn.VirtualHandle,
1471 &gEfiConsoleInDeviceGuid,
1472 &gEfiSimpleTextInProtocolGuid,
1473 (VOID **) &TextIn
1474 );
1475 if (EFI_ERROR (Status)) {
1476 return Status;
1477 }
1478
1479 //
1480 // Remove device from Text Input devices list.
1481 //
1482 return ConSplitterTextInDeleteDevice (&mConIn, TextIn);
1483 }
1484
1485
1486 /**
1487 Stop Simple Pointer protocol ConSplitter on ControllerHandle by closing
1488 Simple Pointer protocol.
1489
1490 @param This Driver Binding protocol instance pointer.
1491 @param ControllerHandle Handle of device to stop driver on
1492 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
1493 children is zero stop the entire bus driver.
1494 @param ChildHandleBuffer List of Child Handles to Stop.
1495
1496 @retval EFI_SUCCESS This driver is removed ControllerHandle
1497 @retval other This driver was not removed from this device
1498
1499 **/
1500 EFI_STATUS
1501 EFIAPI
1502 ConSplitterSimplePointerDriverBindingStop (
1503 IN EFI_DRIVER_BINDING_PROTOCOL *This,
1504 IN EFI_HANDLE ControllerHandle,
1505 IN UINTN NumberOfChildren,
1506 IN EFI_HANDLE *ChildHandleBuffer
1507 )
1508 {
1509 EFI_STATUS Status;
1510 EFI_SIMPLE_POINTER_PROTOCOL *SimplePointer;
1511
1512 if (NumberOfChildren == 0) {
1513 return EFI_SUCCESS;
1514 }
1515
1516 //
1517 // Close Simple Pointer protocol on controller handle and virtual handle.
1518 //
1519 Status = ConSplitterStop (
1520 This,
1521 ControllerHandle,
1522 mConIn.VirtualHandle,
1523 &gEfiSimplePointerProtocolGuid,
1524 &gEfiSimplePointerProtocolGuid,
1525 (VOID **) &SimplePointer
1526 );
1527 if (EFI_ERROR (Status)) {
1528 return Status;
1529 }
1530
1531 //
1532 // Remove this device from Simple Pointer device list.
1533 //
1534 return ConSplitterSimplePointerDeleteDevice (&mConIn, SimplePointer);
1535 }
1536
1537
1538 /**
1539 Stop Absolute Pointer protocol ConSplitter on ControllerHandle by closing
1540 Absolute Pointer protocol.
1541
1542 @param This Driver Binding protocol instance pointer.
1543 @param ControllerHandle Handle of device to stop driver on
1544 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
1545 children is zero stop the entire bus driver.
1546 @param ChildHandleBuffer List of Child Handles to Stop.
1547
1548 @retval EFI_SUCCESS This driver is removed ControllerHandle
1549 @retval other This driver was not removed from this device
1550
1551 **/
1552 EFI_STATUS
1553 EFIAPI
1554 ConSplitterAbsolutePointerDriverBindingStop (
1555 IN EFI_DRIVER_BINDING_PROTOCOL *This,
1556 IN EFI_HANDLE ControllerHandle,
1557 IN UINTN NumberOfChildren,
1558 IN EFI_HANDLE *ChildHandleBuffer
1559 )
1560 {
1561 EFI_STATUS Status;
1562 EFI_ABSOLUTE_POINTER_PROTOCOL *AbsolutePointer;
1563
1564 if (NumberOfChildren == 0) {
1565 return EFI_SUCCESS;
1566 }
1567
1568 //
1569 // Close Absolute Pointer protocol on controller handle and virtual handle.
1570 //
1571 Status = ConSplitterStop (
1572 This,
1573 ControllerHandle,
1574 mConIn.VirtualHandle,
1575 &gEfiAbsolutePointerProtocolGuid,
1576 &gEfiAbsolutePointerProtocolGuid,
1577 (VOID **) &AbsolutePointer
1578 );
1579 if (EFI_ERROR (Status)) {
1580 return Status;
1581 }
1582
1583 //
1584 // Remove this device from Absolute Pointer device list.
1585 //
1586 return ConSplitterAbsolutePointerDeleteDevice (&mConIn, AbsolutePointer);
1587 }
1588
1589
1590 /**
1591 Stop Console Out ConSplitter on device handle by closing Console Out Devcice GUID.
1592
1593 @param This Driver Binding protocol instance pointer.
1594 @param ControllerHandle Handle of device to stop driver on
1595 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
1596 children is zero stop the entire bus driver.
1597 @param ChildHandleBuffer List of Child Handles to Stop.
1598
1599 @retval EFI_SUCCESS This driver is removed ControllerHandle
1600 @retval other This driver was not removed from this device
1601
1602 **/
1603 EFI_STATUS
1604 EFIAPI
1605 ConSplitterConOutDriverBindingStop (
1606 IN EFI_DRIVER_BINDING_PROTOCOL *This,
1607 IN EFI_HANDLE ControllerHandle,
1608 IN UINTN NumberOfChildren,
1609 IN EFI_HANDLE *ChildHandleBuffer
1610 )
1611 {
1612 EFI_STATUS Status;
1613 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *TextOut;
1614
1615 if (NumberOfChildren == 0) {
1616 return EFI_SUCCESS;
1617 }
1618
1619 //
1620 // Close Absolute Pointer protocol on controller handle and virtual handle.
1621 //
1622 Status = ConSplitterStop (
1623 This,
1624 ControllerHandle,
1625 mConOut.VirtualHandle,
1626 &gEfiConsoleOutDeviceGuid,
1627 &gEfiSimpleTextOutProtocolGuid,
1628 (VOID **) &TextOut
1629 );
1630 if (EFI_ERROR (Status)) {
1631 return Status;
1632 }
1633
1634 //
1635 // Remove this device from Text Out device list.
1636 //
1637 return ConSplitterTextOutDeleteDevice (&mConOut, TextOut);
1638 }
1639
1640
1641 /**
1642 Stop Standard Error ConSplitter on ControllerHandle by closing Standard Error GUID.
1643
1644 @param This Driver Binding protocol instance pointer.
1645 @param ControllerHandle Handle of device to stop driver on
1646 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
1647 children is zero stop the entire bus driver.
1648 @param ChildHandleBuffer List of Child Handles to Stop.
1649
1650 @retval EFI_SUCCESS This driver is removed ControllerHandle
1651 @retval other This driver was not removed from this device
1652
1653 **/
1654 EFI_STATUS
1655 EFIAPI
1656 ConSplitterStdErrDriverBindingStop (
1657 IN EFI_DRIVER_BINDING_PROTOCOL *This,
1658 IN EFI_HANDLE ControllerHandle,
1659 IN UINTN NumberOfChildren,
1660 IN EFI_HANDLE *ChildHandleBuffer
1661 )
1662 {
1663 EFI_STATUS Status;
1664 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *TextOut;
1665
1666 if (NumberOfChildren == 0) {
1667 return EFI_SUCCESS;
1668 }
1669
1670 //
1671 // Close Standard Error Device on controller handle and virtual handle.
1672 //
1673 Status = ConSplitterStop (
1674 This,
1675 ControllerHandle,
1676 mStdErr.VirtualHandle,
1677 &gEfiStandardErrorDeviceGuid,
1678 &gEfiSimpleTextOutProtocolGuid,
1679 (VOID **) &TextOut
1680 );
1681 if (EFI_ERROR (Status)) {
1682 return Status;
1683 }
1684 //
1685 // Delete this console error out device's data structures.
1686 //
1687 return ConSplitterTextOutDeleteDevice (&mStdErr, TextOut);
1688 }
1689
1690
1691 /**
1692 Take the passed in Buffer of size ElementSize and grow the buffer
1693 by CONSOLE_SPLITTER_ALLOC_UNIT * ElementSize bytes.
1694 Copy the current data in Buffer to the new version of Buffer and
1695 free the old version of buffer.
1696
1697 @param ElementSize Size of element in array.
1698 @param Count Current number of elements in array.
1699 @param Buffer Bigger version of passed in Buffer with all the
1700 data.
1701
1702 @retval EFI_SUCCESS Buffer size has grown.
1703 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
1704
1705 **/
1706 EFI_STATUS
1707 ConSplitterGrowBuffer (
1708 IN UINTN ElementSize,
1709 IN OUT UINTN *Count,
1710 IN OUT VOID **Buffer
1711 )
1712 {
1713 VOID *Ptr;
1714
1715 //
1716 // grow the buffer to new buffer size,
1717 // copy the old buffer's content to the new-size buffer,
1718 // then free the old buffer.
1719 //
1720 Ptr = ReallocatePool (
1721 ElementSize * (*Count),
1722 ElementSize * ((*Count) + CONSOLE_SPLITTER_ALLOC_UNIT),
1723 *Buffer
1724 );
1725 if (Ptr == NULL) {
1726 return EFI_OUT_OF_RESOURCES;
1727 }
1728 *Count += CONSOLE_SPLITTER_ALLOC_UNIT;
1729 *Buffer = Ptr;
1730 return EFI_SUCCESS;
1731 }
1732
1733
1734 /**
1735 Add Text Input Device in Consplitter Text Input list.
1736
1737 @param Private Text In Splitter pointer.
1738 @param TextIn Simple Text Input protocol pointer.
1739
1740 @retval EFI_SUCCESS Text Input Device added successfully.
1741 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
1742
1743 **/
1744 EFI_STATUS
1745 ConSplitterTextInAddDevice (
1746 IN TEXT_IN_SPLITTER_PRIVATE_DATA *Private,
1747 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *TextIn
1748 )
1749 {
1750 EFI_STATUS Status;
1751
1752 //
1753 // If the Text In List is full, enlarge it by calling ConSplitterGrowBuffer().
1754 //
1755 if (Private->CurrentNumberOfConsoles >= Private->TextInListCount) {
1756 Status = ConSplitterGrowBuffer (
1757 sizeof (EFI_SIMPLE_TEXT_INPUT_PROTOCOL *),
1758 &Private->TextInListCount,
1759 (VOID **) &Private->TextInList
1760 );
1761 if (EFI_ERROR (Status)) {
1762 return EFI_OUT_OF_RESOURCES;
1763 }
1764 }
1765 //
1766 // Add the new text-in device data structure into the Text In List.
1767 //
1768 Private->TextInList[Private->CurrentNumberOfConsoles] = TextIn;
1769 Private->CurrentNumberOfConsoles++;
1770
1771 //
1772 // Extra CheckEvent added to reduce the double CheckEvent().
1773 //
1774 gBS->CheckEvent (TextIn->WaitForKey);
1775
1776 return EFI_SUCCESS;
1777 }
1778
1779
1780 /**
1781 Remove Text Input Device from Consplitter Text Input list.
1782
1783 @param Private Text In Splitter pointer.
1784 @param TextIn Simple Text protocol pointer.
1785
1786 @retval EFI_SUCCESS Simple Text Device removed successfully.
1787 @retval EFI_NOT_FOUND No Simple Text Device found.
1788
1789 **/
1790 EFI_STATUS
1791 ConSplitterTextInDeleteDevice (
1792 IN TEXT_IN_SPLITTER_PRIVATE_DATA *Private,
1793 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *TextIn
1794 )
1795 {
1796 UINTN Index;
1797 //
1798 // Remove the specified text-in device data structure from the Text In List,
1799 // and rearrange the remaining data structures in the Text In List.
1800 //
1801 for (Index = 0; Index < Private->CurrentNumberOfConsoles; Index++) {
1802 if (Private->TextInList[Index] == TextIn) {
1803 for (; Index < Private->CurrentNumberOfConsoles - 1; Index++) {
1804 Private->TextInList[Index] = Private->TextInList[Index + 1];
1805 }
1806
1807 Private->CurrentNumberOfConsoles--;
1808 return EFI_SUCCESS;
1809 }
1810 }
1811
1812 return EFI_NOT_FOUND;
1813 }
1814
1815 /**
1816 Add Text Input Ex Device in Consplitter Text Input Ex list.
1817
1818 @param Private Text In Splitter pointer.
1819 @param TextInEx Simple Text Input Ex Input protocol pointer.
1820
1821 @retval EFI_SUCCESS Text Input Ex Device added successfully.
1822 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
1823
1824 **/
1825 EFI_STATUS
1826 ConSplitterTextInExAddDevice (
1827 IN TEXT_IN_SPLITTER_PRIVATE_DATA *Private,
1828 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *TextInEx
1829 )
1830 {
1831 EFI_STATUS Status;
1832 LIST_ENTRY *Link;
1833 TEXT_IN_EX_SPLITTER_NOTIFY *CurrentNotify;
1834 UINTN TextInExListCount;
1835
1836 //
1837 // Enlarge the NotifyHandleList and the TextInExList
1838 //
1839 if (Private->CurrentNumberOfExConsoles >= Private->TextInExListCount) {
1840 for (Link = Private->NotifyList.ForwardLink; Link != &Private->NotifyList; Link = Link->ForwardLink) {
1841 CurrentNotify = TEXT_IN_EX_SPLITTER_NOTIFY_FROM_THIS (Link);
1842 TextInExListCount = Private->TextInExListCount;
1843
1844 Status = ConSplitterGrowBuffer (
1845 sizeof (EFI_HANDLE),
1846 &TextInExListCount,
1847 (VOID **) &CurrentNotify->NotifyHandleList
1848 );
1849 if (EFI_ERROR (Status)) {
1850 return EFI_OUT_OF_RESOURCES;
1851 }
1852 }
1853 Status = ConSplitterGrowBuffer (
1854 sizeof (EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *),
1855 &Private->TextInExListCount,
1856 (VOID **) &Private->TextInExList
1857 );
1858 if (EFI_ERROR (Status)) {
1859 return EFI_OUT_OF_RESOURCES;
1860 }
1861 }
1862
1863 //
1864 // Register the key notify in the new text-in device
1865 //
1866 for (Link = Private->NotifyList.ForwardLink; Link != &Private->NotifyList; Link = Link->ForwardLink) {
1867 CurrentNotify = TEXT_IN_EX_SPLITTER_NOTIFY_FROM_THIS (Link);
1868 Status = TextInEx->RegisterKeyNotify (
1869 TextInEx,
1870 &CurrentNotify->KeyData,
1871 CurrentNotify->KeyNotificationFn,
1872 &CurrentNotify->NotifyHandleList[Private->CurrentNumberOfExConsoles]
1873 );
1874 if (EFI_ERROR (Status)) {
1875 for (Link = Link->BackLink; Link != &Private->NotifyList; Link = Link->BackLink) {
1876 CurrentNotify = TEXT_IN_EX_SPLITTER_NOTIFY_FROM_THIS (Link);
1877 TextInEx->UnregisterKeyNotify (
1878 TextInEx,
1879 CurrentNotify->NotifyHandleList[Private->CurrentNumberOfExConsoles]
1880 );
1881 }
1882 return Status;
1883 }
1884 }
1885
1886 //
1887 // Add the new text-in device data structure into the Text Input Ex List.
1888 //
1889 Private->TextInExList[Private->CurrentNumberOfExConsoles] = TextInEx;
1890 Private->CurrentNumberOfExConsoles++;
1891
1892 //
1893 // Extra CheckEvent added to reduce the double CheckEvent().
1894 //
1895 gBS->CheckEvent (TextInEx->WaitForKeyEx);
1896
1897 return EFI_SUCCESS;
1898 }
1899
1900 /**
1901 Remove Text Ex Device from Consplitter Text Input Ex list.
1902
1903 @param Private Text In Splitter pointer.
1904 @param TextInEx Simple Text Ex protocol pointer.
1905
1906 @retval EFI_SUCCESS Simple Text Input Ex Device removed successfully.
1907 @retval EFI_NOT_FOUND No Simple Text Input Ex Device found.
1908
1909 **/
1910 EFI_STATUS
1911 ConSplitterTextInExDeleteDevice (
1912 IN TEXT_IN_SPLITTER_PRIVATE_DATA *Private,
1913 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *TextInEx
1914 )
1915 {
1916 UINTN Index;
1917 //
1918 // Remove the specified text-in device data structure from the Text Input Ex List,
1919 // and rearrange the remaining data structures in the Text In List.
1920 //
1921 for (Index = 0; Index < Private->CurrentNumberOfExConsoles; Index++) {
1922 if (Private->TextInExList[Index] == TextInEx) {
1923 for (; Index < Private->CurrentNumberOfExConsoles - 1; Index++) {
1924 Private->TextInExList[Index] = Private->TextInExList[Index + 1];
1925 }
1926
1927 Private->CurrentNumberOfExConsoles--;
1928 return EFI_SUCCESS;
1929 }
1930 }
1931
1932 return EFI_NOT_FOUND;
1933 }
1934
1935
1936 /**
1937 Add Simple Pointer Device in Consplitter Simple Pointer list.
1938
1939 @param Private Text In Splitter pointer.
1940 @param SimplePointer Simple Pointer protocol pointer.
1941
1942 @retval EFI_SUCCESS Simple Pointer Device added successfully.
1943 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
1944
1945 **/
1946 EFI_STATUS
1947 ConSplitterSimplePointerAddDevice (
1948 IN TEXT_IN_SPLITTER_PRIVATE_DATA *Private,
1949 IN EFI_SIMPLE_POINTER_PROTOCOL *SimplePointer
1950 )
1951 {
1952 EFI_STATUS Status;
1953
1954 //
1955 // If the Simple Pointer List is full, enlarge it by calling ConSplitterGrowBuffer().
1956 //
1957 if (Private->CurrentNumberOfPointers >= Private->PointerListCount) {
1958 Status = ConSplitterGrowBuffer (
1959 sizeof (EFI_SIMPLE_POINTER_PROTOCOL *),
1960 &Private->PointerListCount,
1961 (VOID **) &Private->PointerList
1962 );
1963 if (EFI_ERROR (Status)) {
1964 return EFI_OUT_OF_RESOURCES;
1965 }
1966 }
1967 //
1968 // Add the new text-in device data structure into the Simple Pointer List.
1969 //
1970 Private->PointerList[Private->CurrentNumberOfPointers] = SimplePointer;
1971 Private->CurrentNumberOfPointers++;
1972
1973 return EFI_SUCCESS;
1974 }
1975
1976
1977 /**
1978 Remove Simple Pointer Device from Consplitter Simple Pointer list.
1979
1980 @param Private Text In Splitter pointer.
1981 @param SimplePointer Simple Pointer protocol pointer.
1982
1983 @retval EFI_SUCCESS Simple Pointer Device removed successfully.
1984 @retval EFI_NOT_FOUND No Simple Pointer Device found.
1985
1986 **/
1987 EFI_STATUS
1988 ConSplitterSimplePointerDeleteDevice (
1989 IN TEXT_IN_SPLITTER_PRIVATE_DATA *Private,
1990 IN EFI_SIMPLE_POINTER_PROTOCOL *SimplePointer
1991 )
1992 {
1993 UINTN Index;
1994 //
1995 // Remove the specified text-in device data structure from the Simple Pointer List,
1996 // and rearrange the remaining data structures in the Text In List.
1997 //
1998 for (Index = 0; Index < Private->CurrentNumberOfPointers; Index++) {
1999 if (Private->PointerList[Index] == SimplePointer) {
2000 for (; Index < Private->CurrentNumberOfPointers - 1; Index++) {
2001 Private->PointerList[Index] = Private->PointerList[Index + 1];
2002 }
2003
2004 Private->CurrentNumberOfPointers--;
2005 return EFI_SUCCESS;
2006 }
2007 }
2008
2009 return EFI_NOT_FOUND;
2010 }
2011
2012
2013 /**
2014 Add Absolute Pointer Device in Consplitter Absolute Pointer list.
2015
2016 @param Private Text In Splitter pointer.
2017 @param AbsolutePointer Absolute Pointer protocol pointer.
2018
2019 @retval EFI_SUCCESS Absolute Pointer Device added successfully.
2020 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
2021
2022 **/
2023 EFI_STATUS
2024 ConSplitterAbsolutePointerAddDevice (
2025 IN TEXT_IN_SPLITTER_PRIVATE_DATA *Private,
2026 IN EFI_ABSOLUTE_POINTER_PROTOCOL *AbsolutePointer
2027 )
2028 {
2029 EFI_STATUS Status;
2030
2031 //
2032 // If the Absolute Pointer List is full, enlarge it by calling ConSplitterGrowBuffer().
2033 //
2034 if (Private->CurrentNumberOfAbsolutePointers >= Private->AbsolutePointerListCount) {
2035 Status = ConSplitterGrowBuffer (
2036 sizeof (EFI_ABSOLUTE_POINTER_PROTOCOL *),
2037 &Private->AbsolutePointerListCount,
2038 (VOID **) &Private->AbsolutePointerList
2039 );
2040 if (EFI_ERROR (Status)) {
2041 return EFI_OUT_OF_RESOURCES;
2042 }
2043 }
2044 //
2045 // Add the new text-in device data structure into the Absolute Pointer List.
2046 //
2047 Private->AbsolutePointerList[Private->CurrentNumberOfAbsolutePointers] = AbsolutePointer;
2048 Private->CurrentNumberOfAbsolutePointers++;
2049
2050 return EFI_SUCCESS;
2051 }
2052
2053
2054 /**
2055 Remove Absolute Pointer Device from Consplitter Absolute Pointer list.
2056
2057 @param Private Text In Splitter pointer.
2058 @param AbsolutePointer Absolute Pointer protocol pointer.
2059
2060 @retval EFI_SUCCESS Absolute Pointer Device removed successfully.
2061 @retval EFI_NOT_FOUND No Absolute Pointer Device found.
2062
2063 **/
2064 EFI_STATUS
2065 ConSplitterAbsolutePointerDeleteDevice (
2066 IN TEXT_IN_SPLITTER_PRIVATE_DATA *Private,
2067 IN EFI_ABSOLUTE_POINTER_PROTOCOL *AbsolutePointer
2068 )
2069 {
2070 UINTN Index;
2071 //
2072 // Remove the specified text-in device data structure from the Absolute Pointer List,
2073 // and rearrange the remaining data structures from the Absolute Pointer List.
2074 //
2075 for (Index = 0; Index < Private->CurrentNumberOfAbsolutePointers; Index++) {
2076 if (Private->AbsolutePointerList[Index] == AbsolutePointer) {
2077 for (; Index < Private->CurrentNumberOfAbsolutePointers - 1; Index++) {
2078 Private->AbsolutePointerList[Index] = Private->AbsolutePointerList[Index + 1];
2079 }
2080
2081 Private->CurrentNumberOfAbsolutePointers--;
2082 return EFI_SUCCESS;
2083 }
2084 }
2085
2086 return EFI_NOT_FOUND;
2087 }
2088
2089 /**
2090 Reallocate Text Out mode map.
2091
2092 Allocate new buffer and copy original buffer into the new buffer.
2093
2094 @param Private Consplitter Text Out pointer.
2095
2096 @retval EFI_SUCCESS Buffer size has grown
2097 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
2098
2099 **/
2100 EFI_STATUS
2101 ConSplitterGrowMapTable (
2102 IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private
2103 )
2104 {
2105 UINTN Size;
2106 UINTN NewSize;
2107 UINTN TotalSize;
2108 INT32 *TextOutModeMap;
2109 INT32 *OldTextOutModeMap;
2110 INT32 *SrcAddress;
2111 INT32 Index;
2112 UINTN OldStepSize;
2113 UINTN NewStepSize;
2114
2115 NewSize = Private->TextOutListCount * sizeof (INT32);
2116 OldTextOutModeMap = Private->TextOutModeMap;
2117 TotalSize = NewSize * (Private->TextOutQueryDataCount);
2118
2119 //
2120 // Allocate new buffer for Text Out List.
2121 //
2122 TextOutModeMap = AllocatePool (TotalSize);
2123 if (TextOutModeMap == NULL) {
2124 return EFI_OUT_OF_RESOURCES;
2125 }
2126
2127 SetMem (TextOutModeMap, TotalSize, 0xFF);
2128 Private->TextOutModeMap = TextOutModeMap;
2129
2130 //
2131 // If TextOutList has been enlarged, need to realloc the mode map table
2132 // The mode map table is regarded as a two dimension array.
2133 //
2134 // Old New
2135 // 0 ---------> TextOutListCount ----> TextOutListCount
2136 // | -------------------------------------------
2137 // | | | |
2138 // | | | |
2139 // | | | |
2140 // | | | |
2141 // | | | |
2142 // \/ | | |
2143 // -------------------------------------------
2144 // QueryDataCount
2145 //
2146 if (OldTextOutModeMap != NULL) {
2147
2148 Size = Private->CurrentNumberOfConsoles * sizeof (INT32);
2149 Index = 0;
2150 SrcAddress = OldTextOutModeMap;
2151 NewStepSize = NewSize / sizeof(INT32);
2152 // If Private->CurrentNumberOfConsoles is not zero and OldTextOutModeMap
2153 // is not NULL, it indicates that the original TextOutModeMap is not enough
2154 // for the new console devices and has been enlarged by CONSOLE_SPLITTER_ALLOC_UNIT columns.
2155 //
2156 OldStepSize = NewStepSize - CONSOLE_SPLITTER_ALLOC_UNIT;
2157
2158 //
2159 // Copy the old data to the new one
2160 //
2161 while (Index < Private->TextOutMode.MaxMode) {
2162 CopyMem (TextOutModeMap, SrcAddress, Size);
2163 //
2164 // Go to next row of new TextOutModeMap.
2165 //
2166 TextOutModeMap += NewStepSize;
2167 //
2168 // Go to next row of old TextOutModeMap.
2169 //
2170 SrcAddress += OldStepSize;
2171 Index++;
2172 }
2173 //
2174 // Free the old buffer
2175 //
2176 FreePool (OldTextOutModeMap);
2177 }
2178
2179 return EFI_SUCCESS;
2180 }
2181
2182
2183 /**
2184 Add new device's output mode to console splitter's mode list.
2185
2186 @param Private Text Out Splitter pointer
2187 @param TextOut Simple Text Output protocol pointer.
2188
2189 @retval EFI_SUCCESS Device added successfully.
2190 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
2191
2192 **/
2193 EFI_STATUS
2194 ConSplitterAddOutputMode (
2195 IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private,
2196 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *TextOut
2197 )
2198 {
2199 EFI_STATUS Status;
2200 INT32 MaxMode;
2201 INT32 Mode;
2202 UINTN Index;
2203
2204 MaxMode = TextOut->Mode->MaxMode;
2205 Private->TextOutMode.MaxMode = MaxMode;
2206
2207 //
2208 // Grow the buffer if query data buffer is not large enough to
2209 // hold all the mode supported by the first console.
2210 //
2211 while (MaxMode > (INT32) Private->TextOutQueryDataCount) {
2212 Status = ConSplitterGrowBuffer (
2213 sizeof (TEXT_OUT_SPLITTER_QUERY_DATA),
2214 &Private->TextOutQueryDataCount,
2215 (VOID **) &Private->TextOutQueryData
2216 );
2217 if (EFI_ERROR (Status)) {
2218 return EFI_OUT_OF_RESOURCES;
2219 }
2220 }
2221 //
2222 // Allocate buffer for the output mode map
2223 //
2224 Status = ConSplitterGrowMapTable (Private);
2225 if (EFI_ERROR (Status)) {
2226 return EFI_OUT_OF_RESOURCES;
2227 }
2228 //
2229 // As the first textout device, directly add the mode in to QueryData
2230 // and at the same time record the mapping between QueryData and TextOut.
2231 //
2232 Mode = 0;
2233 Index = 0;
2234 while (Mode < MaxMode) {
2235 Status = TextOut->QueryMode (
2236 TextOut,
2237 Mode,
2238 &Private->TextOutQueryData[Mode].Columns,
2239 &Private->TextOutQueryData[Mode].Rows
2240 );
2241 //
2242 // If mode 1 (80x50) is not supported, make sure mode 1 in TextOutQueryData
2243 // is clear to 0x0.
2244 //
2245 if ((EFI_ERROR(Status)) && (Mode == 1)) {
2246 Private->TextOutQueryData[Mode].Columns = 0;
2247 Private->TextOutQueryData[Mode].Rows = 0;
2248 }
2249 Private->TextOutModeMap[Index] = Mode;
2250 Mode++;
2251 Index += Private->TextOutListCount;
2252 }
2253
2254 return EFI_SUCCESS;
2255 }
2256
2257 /**
2258 Reconstruct TextOutModeMap to get intersection of modes.
2259
2260 This routine reconstruct TextOutModeMap to get the intersection
2261 of modes for all console out devices. Because EFI/UEFI spec require
2262 mode 0 is 80x25, mode 1 is 80x50, this routine will not check the
2263 intersection for mode 0 and mode 1.
2264
2265 @param TextOutModeMap Current text out mode map, begin with the mode 80x25
2266 @param NewlyAddedMap New text out mode map, begin with the mode 80x25
2267 @param MapStepSize Mode step size for one console device
2268 @param NewMapStepSize New Mode step size for one console device
2269 @param MaxMode IN: Current max text mode, OUT: Updated max text mode.
2270 @param CurrentMode IN: Current text mode, OUT: Updated current text mode.
2271
2272 **/
2273 VOID
2274 ConSplitterGetIntersection (
2275 IN INT32 *TextOutModeMap,
2276 IN INT32 *NewlyAddedMap,
2277 IN UINTN MapStepSize,
2278 IN UINTN NewMapStepSize,
2279 IN OUT INT32 *MaxMode,
2280 IN OUT INT32 *CurrentMode
2281 )
2282 {
2283 INT32 Index;
2284 INT32 *CurrentMapEntry;
2285 INT32 *NextMapEntry;
2286 INT32 *NewMapEntry;
2287 INT32 CurrentMaxMode;
2288 INT32 Mode;
2289
2290 //
2291 // According to EFI/UEFI spec, mode 0 and mode 1 have been reserved
2292 // for 80x25 and 80x50 in Simple Text Out protocol, so don't make intersection
2293 // for mode 0 and mode 1, mode number starts from 2.
2294 //
2295 Index = 2;
2296 CurrentMapEntry = &TextOutModeMap[MapStepSize * 2];
2297 NextMapEntry = CurrentMapEntry;
2298 NewMapEntry = &NewlyAddedMap[NewMapStepSize * 2];
2299
2300 CurrentMaxMode = *MaxMode;
2301 Mode = *CurrentMode;
2302
2303 while (Index < CurrentMaxMode) {
2304 if (*NewMapEntry == -1) {
2305 //
2306 // This mode is not supported any more. Remove it. Special care
2307 // must be taken as this remove will also affect current mode;
2308 //
2309 if (Index == *CurrentMode) {
2310 Mode = -1;
2311 } else if (Index < *CurrentMode) {
2312 Mode--;
2313 }
2314 (*MaxMode)--;
2315 } else {
2316 if (CurrentMapEntry != NextMapEntry) {
2317 CopyMem (NextMapEntry, CurrentMapEntry, MapStepSize * sizeof (INT32));
2318 }
2319
2320 NextMapEntry += MapStepSize;
2321 }
2322
2323 CurrentMapEntry += MapStepSize;
2324 NewMapEntry += NewMapStepSize;
2325 Index++;
2326 }
2327
2328 *CurrentMode = Mode;
2329
2330 return ;
2331 }
2332
2333 /**
2334 Sync the device's output mode to console splitter's mode list.
2335
2336 @param Private Text Out Splitter pointer.
2337 @param TextOut Simple Text Output protocol pointer.
2338
2339 **/
2340 VOID
2341 ConSplitterSyncOutputMode (
2342 IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private,
2343 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *TextOut
2344 )
2345 {
2346 INT32 CurrentMaxMode;
2347 INT32 Mode;
2348 INT32 Index;
2349 INT32 *TextOutModeMap;
2350 INT32 *MapTable;
2351 INT32 QueryMode;
2352 TEXT_OUT_SPLITTER_QUERY_DATA *TextOutQueryData;
2353 UINTN Rows;
2354 UINTN Columns;
2355 UINTN StepSize;
2356 EFI_STATUS Status;
2357
2358 //
2359 // Must make sure that current mode won't change even if mode number changes
2360 //
2361 CurrentMaxMode = Private->TextOutMode.MaxMode;
2362 TextOutModeMap = Private->TextOutModeMap;
2363 StepSize = Private->TextOutListCount;
2364 TextOutQueryData = Private->TextOutQueryData;
2365
2366 //
2367 // Query all the mode that the newly added TextOut supports
2368 //
2369 Mode = 0;
2370 MapTable = TextOutModeMap + Private->CurrentNumberOfConsoles;
2371 while (Mode < TextOut->Mode->MaxMode) {
2372 Status = TextOut->QueryMode (TextOut, Mode, &Columns, &Rows);
2373
2374 if (EFI_ERROR(Status)) {
2375 if (Mode == 1) {
2376 //
2377 // If mode 1 (80x50) is not supported, make sure mode 1 in TextOutQueryData
2378 // is clear to 0x0.
2379 //
2380 MapTable[StepSize] = Mode;
2381 TextOutQueryData[Mode].Columns = 0;
2382 TextOutQueryData[Mode].Rows = 0;
2383 }
2384 Mode++;
2385 continue;
2386 }
2387 //
2388 // Search the intersection map and QueryData database to see if they intersects
2389 //
2390 Index = 0;
2391 while (Index < CurrentMaxMode) {
2392 QueryMode = *(TextOutModeMap + Index * StepSize);
2393 if ((TextOutQueryData[QueryMode].Rows == Rows) && (TextOutQueryData[QueryMode].Columns == Columns)) {
2394 MapTable[Index * StepSize] = Mode;
2395 break;
2396 }
2397 Index++;
2398 }
2399 Mode++;
2400 }
2401 //
2402 // Now search the TextOutModeMap table to find the intersection of supported
2403 // mode between ConSplitter and the newly added device.
2404 //
2405 ConSplitterGetIntersection (
2406 TextOutModeMap,
2407 MapTable,
2408 StepSize,
2409 StepSize,
2410 &Private->TextOutMode.MaxMode,
2411 &Private->TextOutMode.Mode
2412 );
2413
2414 return ;
2415 }
2416
2417
2418 /**
2419 Sync output device between ConOut and StdErr output.
2420
2421 @retval EFI_SUCCESS Sync implemented successfully.
2422 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
2423
2424 **/
2425 EFI_STATUS
2426 ConSplitterGetIntersectionBetweenConOutAndStrErr (
2427 VOID
2428 )
2429 {
2430 UINTN ConOutNumOfConsoles;
2431 UINTN StdErrNumOfConsoles;
2432 TEXT_OUT_AND_GOP_DATA *ConOutTextOutList;
2433 TEXT_OUT_AND_GOP_DATA *StdErrTextOutList;
2434 UINTN Indexi;
2435 UINTN Indexj;
2436 UINTN ConOutRows;
2437 UINTN ConOutColumns;
2438 UINTN StdErrRows;
2439 UINTN StdErrColumns;
2440 INT32 ConOutMaxMode;
2441 INT32 StdErrMaxMode;
2442 INT32 ConOutMode;
2443 INT32 StdErrMode;
2444 INT32 Mode;
2445 INT32 Index;
2446 INT32 *ConOutModeMap;
2447 INT32 *StdErrModeMap;
2448 INT32 *ConOutMapTable;
2449 INT32 *StdErrMapTable;
2450 TEXT_OUT_SPLITTER_QUERY_DATA *ConOutQueryData;
2451 TEXT_OUT_SPLITTER_QUERY_DATA *StdErrQueryData;
2452 UINTN ConOutStepSize;
2453 UINTN StdErrStepSize;
2454 BOOLEAN FoundTheSameTextOut;
2455 UINTN ConOutMapTableSize;
2456 UINTN StdErrMapTableSize;
2457
2458 ConOutNumOfConsoles = mConOut.CurrentNumberOfConsoles;
2459 StdErrNumOfConsoles = mStdErr.CurrentNumberOfConsoles;
2460 ConOutTextOutList = mConOut.TextOutList;
2461 StdErrTextOutList = mStdErr.TextOutList;
2462
2463 Indexi = 0;
2464 FoundTheSameTextOut = FALSE;
2465 while ((Indexi < ConOutNumOfConsoles) && (!FoundTheSameTextOut)) {
2466 Indexj = 0;
2467 while (Indexj < StdErrNumOfConsoles) {
2468 if (ConOutTextOutList->TextOut == StdErrTextOutList->TextOut) {
2469 FoundTheSameTextOut = TRUE;
2470 break;
2471 }
2472
2473 Indexj++;
2474 StdErrTextOutList++;
2475 }
2476
2477 Indexi++;
2478 ConOutTextOutList++;
2479 }
2480
2481 if (!FoundTheSameTextOut) {
2482 return EFI_SUCCESS;
2483 }
2484 //
2485 // Must make sure that current mode won't change even if mode number changes
2486 //
2487 ConOutMaxMode = mConOut.TextOutMode.MaxMode;
2488 ConOutModeMap = mConOut.TextOutModeMap;
2489 ConOutStepSize = mConOut.TextOutListCount;
2490 ConOutQueryData = mConOut.TextOutQueryData;
2491
2492 StdErrMaxMode = mStdErr.TextOutMode.MaxMode;
2493 StdErrModeMap = mStdErr.TextOutModeMap;
2494 StdErrStepSize = mStdErr.TextOutListCount;
2495 StdErrQueryData = mStdErr.TextOutQueryData;
2496
2497 //
2498 // Allocate the map table and set the map table's index to -1.
2499 //
2500 ConOutMapTableSize = ConOutMaxMode * sizeof (INT32);
2501 ConOutMapTable = AllocateZeroPool (ConOutMapTableSize);
2502 if (ConOutMapTable == NULL) {
2503 return EFI_OUT_OF_RESOURCES;
2504 }
2505
2506 SetMem (ConOutMapTable, ConOutMapTableSize, 0xFF);
2507
2508 StdErrMapTableSize = StdErrMaxMode * sizeof (INT32);
2509 StdErrMapTable = AllocateZeroPool (StdErrMapTableSize);
2510 if (StdErrMapTable == NULL) {
2511 return EFI_OUT_OF_RESOURCES;
2512 }
2513
2514 SetMem (StdErrMapTable, StdErrMapTableSize, 0xFF);
2515
2516 //
2517 // Find the intersection of the two set of modes. If they actually intersect, the
2518 // correponding entry in the map table is set to 1.
2519 //
2520 Mode = 0;
2521 while (Mode < ConOutMaxMode) {
2522 //
2523 // Search the intersection map and QueryData database to see if they intersect
2524 //
2525 Index = 0;
2526 ConOutMode = *(ConOutModeMap + Mode * ConOutStepSize);
2527 ConOutRows = ConOutQueryData[ConOutMode].Rows;
2528 ConOutColumns = ConOutQueryData[ConOutMode].Columns;
2529 while (Index < StdErrMaxMode) {
2530 StdErrMode = *(StdErrModeMap + Index * StdErrStepSize);
2531 StdErrRows = StdErrQueryData[StdErrMode].Rows;
2532 StdErrColumns = StdErrQueryData[StdErrMode].Columns;
2533 if ((StdErrRows == ConOutRows) && (StdErrColumns == ConOutColumns)) {
2534 ConOutMapTable[Mode] = 1;
2535 StdErrMapTable[Index] = 1;
2536 break;
2537 }
2538
2539 Index++;
2540 }
2541
2542 Mode++;
2543 }
2544 //
2545 // Now search the TextOutModeMap table to find the intersection of supported
2546 // mode between ConSplitter and the newly added device.
2547 //
2548 ConSplitterGetIntersection (
2549 ConOutModeMap,
2550 ConOutMapTable,
2551 mConOut.TextOutListCount,
2552 1,
2553 &(mConOut.TextOutMode.MaxMode),
2554 &(mConOut.TextOutMode.Mode)
2555 );
2556
2557 if (mConOut.TextOutMode.Mode < 0) {
2558 mConOut.TextOut.SetMode (&(mConOut.TextOut), 0);
2559 }
2560
2561 ConSplitterGetIntersection (
2562 StdErrModeMap,
2563 StdErrMapTable,
2564 mStdErr.TextOutListCount,
2565 1,
2566 &(mStdErr.TextOutMode.MaxMode),
2567 &(mStdErr.TextOutMode.Mode)
2568 );
2569
2570 if (mStdErr.TextOutMode.Mode < 0) {
2571 mStdErr.TextOut.SetMode (&(mStdErr.TextOut), 0);
2572 }
2573
2574 FreePool (ConOutMapTable);
2575 FreePool (StdErrMapTable);
2576
2577 return EFI_SUCCESS;
2578 }
2579
2580
2581 /**
2582 Add Grahpics Output modes into Consplitter Text Out list.
2583
2584 @param Private Text Out Splitter pointer.
2585 @param GraphicsOutput Graphics Output protocol pointer.
2586 @param UgaDraw UGA Draw protocol pointer.
2587
2588 @retval EFI_SUCCESS Output mode added successfully.
2589 @retval other Failed to add output mode.
2590
2591 **/
2592 EFI_STATUS
2593 ConSplitterAddGraphicsOutputMode (
2594 IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private,
2595 IN EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput,
2596 IN EFI_UGA_DRAW_PROTOCOL *UgaDraw
2597 )
2598 {
2599 EFI_STATUS Status;
2600 UINTN Index;
2601 UINTN CurrentIndex;
2602 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *Mode;
2603 UINTN SizeOfInfo;
2604 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *Info;
2605 EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE *CurrentGraphicsOutputMode;
2606 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *ModeBuffer;
2607 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *MatchedMode;
2608 UINTN NumberIndex;
2609 BOOLEAN Match;
2610 BOOLEAN AlreadyExist;
2611 UINT32 UgaHorizontalResolution;
2612 UINT32 UgaVerticalResolution;
2613 UINT32 UgaColorDepth;
2614 UINT32 UgaRefreshRate;
2615
2616 ASSERT (GraphicsOutput != NULL || UgaDraw != NULL);
2617
2618 CurrentGraphicsOutputMode = Private->GraphicsOutput.Mode;
2619
2620 Index = 0;
2621 CurrentIndex = 0;
2622 Status = EFI_SUCCESS;
2623
2624 if (Private->CurrentNumberOfUgaDraw != 0) {
2625 //
2626 // If any UGA device has already been added, then there is no need to
2627 // calculate intersection of display mode of different GOP/UGA device,
2628 // since only one display mode will be exported (i.e. user-defined mode)
2629 //
2630 goto Done;
2631 }
2632
2633 if (GraphicsOutput != NULL) {
2634 if (Private->CurrentNumberOfGraphicsOutput == 0) {
2635 //
2636 // This is the first Graphics Output device added
2637 //
2638 CurrentGraphicsOutputMode->MaxMode = GraphicsOutput->Mode->MaxMode;
2639 CurrentGraphicsOutputMode->Mode = GraphicsOutput->Mode->Mode;
2640 CopyMem (CurrentGraphicsOutputMode->Info, GraphicsOutput->Mode->Info, GraphicsOutput->Mode->SizeOfInfo);
2641 CurrentGraphicsOutputMode->SizeOfInfo = GraphicsOutput->Mode->SizeOfInfo;
2642 CurrentGraphicsOutputMode->FrameBufferBase = GraphicsOutput->Mode->FrameBufferBase;
2643 CurrentGraphicsOutputMode->FrameBufferSize = GraphicsOutput->Mode->FrameBufferSize;
2644
2645 //
2646 // Allocate resource for the private mode buffer
2647 //
2648 ModeBuffer = AllocatePool (sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION) * GraphicsOutput->Mode->MaxMode);
2649 if (ModeBuffer == NULL) {
2650 return EFI_OUT_OF_RESOURCES;
2651 }
2652 FreePool (Private->GraphicsOutputModeBuffer);
2653 Private->GraphicsOutputModeBuffer = ModeBuffer;
2654
2655 //
2656 // Store all supported display modes to the private mode buffer
2657 //
2658 Mode = ModeBuffer;
2659 for (Index = 0; Index < GraphicsOutput->Mode->MaxMode; Index++) {
2660 //
2661 // The Info buffer would be allocated by callee
2662 //
2663 Status = GraphicsOutput->QueryMode (GraphicsOutput, (UINT32) Index, &SizeOfInfo, &Info);
2664 if (EFI_ERROR (Status)) {
2665 return Status;
2666 }
2667 ASSERT ( SizeOfInfo <= sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION));
2668 CopyMem (Mode, Info, SizeOfInfo);
2669 Mode++;
2670 FreePool (Info);
2671 }
2672 } else {
2673 //
2674 // Check intersection of display mode
2675 //
2676 ModeBuffer = AllocatePool (sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION) * CurrentGraphicsOutputMode->MaxMode);
2677 if (ModeBuffer == NULL) {
2678 return EFI_OUT_OF_RESOURCES;
2679 }
2680
2681 MatchedMode = ModeBuffer;
2682 Mode = &Private->GraphicsOutputModeBuffer[0];
2683 for (Index = 0; Index < CurrentGraphicsOutputMode->MaxMode; Index++) {
2684 Match = FALSE;
2685
2686 for (NumberIndex = 0; NumberIndex < GraphicsOutput->Mode->MaxMode; NumberIndex++) {
2687 //
2688 // The Info buffer would be allocated by callee
2689 //
2690 Status = GraphicsOutput->QueryMode (GraphicsOutput, (UINT32) NumberIndex, &SizeOfInfo, &Info);
2691 if (EFI_ERROR (Status)) {
2692 return Status;
2693 }
2694 if ((Info->HorizontalResolution == Mode->HorizontalResolution) &&
2695 (Info->VerticalResolution == Mode->VerticalResolution)) {
2696 //
2697 // If GOP device supports one mode in current mode buffer,
2698 // it will be added into matched mode buffer
2699 //
2700 Match = TRUE;
2701 FreePool (Info);
2702 break;
2703 }
2704 FreePool (Info);
2705 }
2706
2707 if (Match) {
2708 AlreadyExist = FALSE;
2709
2710 //
2711 // Check if GOP mode has been in the mode buffer, ModeBuffer = MatchedMode at begin.
2712 //
2713 for (Info = ModeBuffer; Info < MatchedMode; Info++) {
2714 if ((Info->HorizontalResolution == Mode->HorizontalResolution) &&
2715 (Info->VerticalResolution == Mode->VerticalResolution)) {
2716 AlreadyExist = TRUE;
2717 break;
2718 }
2719 }
2720
2721 if (!AlreadyExist) {
2722 CopyMem (MatchedMode, Mode, sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION));
2723
2724 //
2725 // Physical frame buffer is no longer available, change PixelFormat to PixelBltOnly
2726 //
2727 MatchedMode->Version = 0;
2728 MatchedMode->PixelFormat = PixelBltOnly;
2729 ZeroMem (&MatchedMode->PixelInformation, sizeof (EFI_PIXEL_BITMASK));
2730
2731 MatchedMode++;
2732 }
2733 }
2734
2735 Mode++;
2736 }
2737
2738 //
2739 // Drop the old mode buffer, assign it to a new one
2740 //
2741 FreePool (Private->GraphicsOutputModeBuffer);
2742 Private->GraphicsOutputModeBuffer = ModeBuffer;
2743
2744 //
2745 // Physical frame buffer is no longer available when there are more than one physical GOP devices
2746 //
2747 CurrentGraphicsOutputMode->MaxMode = (UINT32) (((UINTN) MatchedMode - (UINTN) ModeBuffer) / sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION));
2748 CurrentGraphicsOutputMode->Info->PixelFormat = PixelBltOnly;
2749 ZeroMem (&CurrentGraphicsOutputMode->Info->PixelInformation, sizeof (EFI_PIXEL_BITMASK));
2750 CurrentGraphicsOutputMode->SizeOfInfo = sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION);
2751 CurrentGraphicsOutputMode->FrameBufferBase = (EFI_PHYSICAL_ADDRESS) (UINTN) NULL;
2752 CurrentGraphicsOutputMode->FrameBufferSize = 0;
2753 }
2754
2755 //
2756 // Graphics console driver can ensure the same mode for all GOP devices
2757 //
2758 for (Index = 0; Index < CurrentGraphicsOutputMode->MaxMode; Index++) {
2759 Mode = &Private->GraphicsOutputModeBuffer[Index];
2760 if ((Mode->HorizontalResolution == GraphicsOutput->Mode->Info->HorizontalResolution) &&
2761 (Mode->VerticalResolution == GraphicsOutput->Mode->Info->VerticalResolution)) {
2762 CurrentIndex = Index;
2763 break;
2764 }
2765 }
2766 if (Index >= CurrentGraphicsOutputMode->MaxMode) {
2767 //
2768 // if user defined mode is not found, set to default mode 800x600
2769 //
2770 for (Index = 0; Index < CurrentGraphicsOutputMode->MaxMode; Index++) {
2771 Mode = &Private->GraphicsOutputModeBuffer[Index];
2772 if ((Mode->HorizontalResolution == 800) && (Mode->VerticalResolution == 600)) {
2773 CurrentIndex = Index;
2774 break;
2775 }
2776 }
2777 }
2778 } else if (UgaDraw != NULL) {
2779 //
2780 // Graphics console driver can ensure the same mode for all GOP devices
2781 // so we can get the current mode from this video device
2782 //
2783 UgaDraw->GetMode (
2784 UgaDraw,
2785 &UgaHorizontalResolution,
2786 &UgaVerticalResolution,
2787 &UgaColorDepth,
2788 &UgaRefreshRate
2789 );
2790
2791 CurrentGraphicsOutputMode->MaxMode = 1;
2792 Info = CurrentGraphicsOutputMode->Info;
2793 Info->Version = 0;
2794 Info->HorizontalResolution = UgaHorizontalResolution;
2795 Info->VerticalResolution = UgaVerticalResolution;
2796 Info->PixelFormat = PixelBltOnly;
2797 Info->PixelsPerScanLine = UgaHorizontalResolution;
2798 CurrentGraphicsOutputMode->SizeOfInfo = sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION);
2799 CurrentGraphicsOutputMode->FrameBufferBase = (EFI_PHYSICAL_ADDRESS) (UINTN) NULL;
2800 CurrentGraphicsOutputMode->FrameBufferSize = 0;
2801
2802 //
2803 // Update the private mode buffer
2804 //
2805 CopyMem (&Private->GraphicsOutputModeBuffer[0], Info, sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION));
2806
2807 //
2808 // Only mode 0 is available to be set
2809 //
2810 CurrentIndex = 0;
2811 }
2812
2813 Done:
2814
2815 if (GraphicsOutput != NULL) {
2816 Private->CurrentNumberOfGraphicsOutput++;
2817 }
2818 if (UgaDraw != NULL) {
2819 Private->CurrentNumberOfUgaDraw++;
2820 }
2821
2822 //
2823 // Force GraphicsOutput mode to be set,
2824 //
2825
2826 Mode = &Private->GraphicsOutputModeBuffer[CurrentIndex];
2827 if ((GraphicsOutput != NULL) &&
2828 (Mode->HorizontalResolution == CurrentGraphicsOutputMode->Info->HorizontalResolution) &&
2829 (Mode->VerticalResolution == CurrentGraphicsOutputMode->Info->VerticalResolution)) {
2830 CurrentGraphicsOutputMode->Mode = (UINT32) CurrentIndex;
2831 if ((Mode->HorizontalResolution != GraphicsOutput->Mode->Info->HorizontalResolution) ||
2832 (Mode->VerticalResolution != GraphicsOutput->Mode->Info->VerticalResolution)) {
2833 //
2834 // If all existing video device has been set to common mode, only set new GOP device to
2835 // the common mode
2836 //
2837 for (NumberIndex = 0; NumberIndex < GraphicsOutput->Mode->MaxMode; NumberIndex ++) {
2838 Status = GraphicsOutput->QueryMode (GraphicsOutput, (UINT32) NumberIndex, &SizeOfInfo, &Info);
2839 if (EFI_ERROR (Status)) {
2840 return Status;
2841 }
2842 if ((Info->HorizontalResolution == Mode->HorizontalResolution) && (Info->VerticalResolution == Mode->VerticalResolution)) {
2843 FreePool (Info);
2844 break;
2845 }
2846 FreePool (Info);
2847 }
2848 Status = GraphicsOutput->SetMode (GraphicsOutput, (UINT32) NumberIndex);
2849 }
2850 } else {
2851 //
2852 // Current mode number may need update now, so set it to an invalid mode number
2853 //
2854 CurrentGraphicsOutputMode->Mode = 0xffff;
2855 //
2856 // Graphics console can ensure all GOP devices have the same mode which can be taken as current mode.
2857 //
2858 Status = Private->GraphicsOutput.SetMode (&Private->GraphicsOutput, (UINT32) CurrentIndex);
2859 if (EFI_ERROR(Status)) {
2860 //
2861 // If user defined mode is not valid for display device, set to the default mode 800x600.
2862 //
2863 (Private->GraphicsOutputModeBuffer[0]).HorizontalResolution = 800;
2864 (Private->GraphicsOutputModeBuffer[0]).VerticalResolution = 600;
2865 Status = Private->GraphicsOutput.SetMode (&Private->GraphicsOutput, 0);
2866 }
2867 }
2868
2869 return Status;
2870 }
2871
2872 /**
2873 Set the current console out mode.
2874
2875 This routine will get the current console mode information (column, row)
2876 from ConsoleOutMode variable and set it; if the variable does not exist,
2877 set to user defined console mode.
2878
2879 @param Private Consplitter Text Out pointer.
2880
2881 **/
2882 VOID
2883 ConsplitterSetConsoleOutMode (
2884 IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private
2885 )
2886 {
2887 UINTN Col;
2888 UINTN Row;
2889 UINTN Mode;
2890 UINTN PreferMode;
2891 UINTN BaseMode;
2892 UINTN MaxMode;
2893 EFI_STATUS Status;
2894 CONSOLE_OUT_MODE ModeInfo;
2895 CONSOLE_OUT_MODE MaxModeInfo;
2896 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *TextOut;
2897
2898 PreferMode = 0xFF;
2899 BaseMode = 0xFF;
2900 TextOut = &Private->TextOut;
2901 MaxMode = (UINTN) (TextOut->Mode->MaxMode);
2902
2903 MaxModeInfo.Column = 0;
2904 MaxModeInfo.Row = 0;
2905 ModeInfo.Column = PcdGet32 (PcdConOutColumn);
2906 ModeInfo.Row = PcdGet32 (PcdConOutRow);
2907
2908 //
2909 // To find the prefer mode and basic mode from Text Out mode list
2910 //
2911 for (Mode = 0; Mode < MaxMode; Mode++) {
2912 Status = TextOut->QueryMode (TextOut, Mode, &Col, &Row);
2913 if (!EFI_ERROR(Status)) {
2914 if ((ModeInfo.Column != 0) && (ModeInfo.Row != 0)) {
2915 //
2916 // Use user defined column and row
2917 //
2918 if (Col == ModeInfo.Column && Row == ModeInfo.Row) {
2919 PreferMode = Mode;
2920 }
2921 } else {
2922 //
2923 // If user sets PcdConOutColumn or PcdConOutRow to 0,
2924 // find and set the highest text mode.
2925 //
2926 if ((Col >= MaxModeInfo.Column) && (Row >= MaxModeInfo.Row)) {
2927 MaxModeInfo.Column = Col;
2928 MaxModeInfo.Row = Row;
2929 PreferMode = Mode;
2930 }
2931 }
2932 if (Col == 80 && Row == 25) {
2933 BaseMode = Mode;
2934 }
2935 }
2936 }
2937
2938 //
2939 // Set prefer mode to Text Out devices.
2940 //
2941 Status = TextOut->SetMode (TextOut, PreferMode);
2942 if (EFI_ERROR(Status)) {
2943 //
2944 // if current mode setting is failed, default 80x25 mode will be set.
2945 //
2946 Status = TextOut->SetMode (TextOut, BaseMode);
2947 ASSERT(!EFI_ERROR(Status));
2948
2949 PcdSet32 (PcdConOutColumn, 80);
2950 PcdSet32 (PcdConOutRow, 25);
2951 }
2952
2953 return ;
2954 }
2955
2956
2957 /**
2958 Add Text Output Device in Consplitter Text Output list.
2959
2960 @param Private Text Out Splitter pointer.
2961 @param TextOut Simple Text Output protocol pointer.
2962 @param GraphicsOutput Graphics Output protocol pointer.
2963 @param UgaDraw UGA Draw protocol pointer.
2964
2965 @retval EFI_SUCCESS Text Output Device added successfully.
2966 @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size.
2967
2968 **/
2969 EFI_STATUS
2970 ConSplitterTextOutAddDevice (
2971 IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private,
2972 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *TextOut,
2973 IN EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput,
2974 IN EFI_UGA_DRAW_PROTOCOL *UgaDraw
2975 )
2976 {
2977 EFI_STATUS Status;
2978 UINTN CurrentNumOfConsoles;
2979 INT32 MaxMode;
2980 UINT32 UgaHorizontalResolution;
2981 UINT32 UgaVerticalResolution;
2982 UINT32 UgaColorDepth;
2983 UINT32 UgaRefreshRate;
2984 TEXT_OUT_AND_GOP_DATA *TextAndGop;
2985 UINTN SizeOfInfo;
2986 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *Info;
2987 EFI_STATUS DeviceStatus;
2988
2989 Status = EFI_SUCCESS;
2990 CurrentNumOfConsoles = Private->CurrentNumberOfConsoles;
2991
2992 //
2993 // If the Text Out List is full, enlarge it by calling ConSplitterGrowBuffer().
2994 //
2995 while (CurrentNumOfConsoles >= Private->TextOutListCount) {
2996 Status = ConSplitterGrowBuffer (
2997 sizeof (TEXT_OUT_AND_GOP_DATA),
2998 &Private->TextOutListCount,
2999 (VOID **) &Private->TextOutList
3000 );
3001 if (EFI_ERROR (Status)) {
3002 return EFI_OUT_OF_RESOURCES;
3003 }
3004 //
3005 // Also need to reallocate the TextOutModeMap table
3006 //
3007 Status = ConSplitterGrowMapTable (Private);
3008 if (EFI_ERROR (Status)) {
3009 return EFI_OUT_OF_RESOURCES;
3010 }
3011 }
3012
3013 TextAndGop = &Private->TextOutList[CurrentNumOfConsoles];
3014
3015 TextAndGop->TextOut = TextOut;
3016 TextAndGop->GraphicsOutput = GraphicsOutput;
3017 TextAndGop->UgaDraw = UgaDraw;
3018
3019 if (CurrentNumOfConsoles == 0) {
3020 //
3021 // Add the first device's output mode to console splitter's mode list
3022 //
3023 Status = ConSplitterAddOutputMode (Private, TextOut);
3024 } else {
3025 ConSplitterSyncOutputMode (Private, TextOut);
3026 }
3027
3028 Private->CurrentNumberOfConsoles++;
3029
3030 //
3031 // Scan both TextOutList, for the intersection TextOut device
3032 // maybe both ConOut and StdErr incorporate the same Text Out
3033 // device in them, thus the output of both should be synced.
3034 //
3035 ConSplitterGetIntersectionBetweenConOutAndStrErr ();
3036
3037 MaxMode = Private->TextOutMode.MaxMode;
3038 ASSERT (MaxMode >= 1);
3039
3040 DeviceStatus = EFI_DEVICE_ERROR;
3041 Status = EFI_DEVICE_ERROR;
3042
3043 //
3044 // This device display mode will be added into Graphics Ouput modes.
3045 //
3046 if ((GraphicsOutput != NULL) || (UgaDraw != NULL)) {
3047 DeviceStatus = ConSplitterAddGraphicsOutputMode (Private, GraphicsOutput, UgaDraw);
3048 }
3049
3050 if (FeaturePcdGet (PcdConOutUgaSupport)) {
3051 //
3052 // If UGA is produced by Consplitter
3053 //
3054 if (GraphicsOutput != NULL) {
3055 Status = GraphicsOutput->QueryMode (GraphicsOutput, GraphicsOutput->Mode->Mode, &SizeOfInfo, &Info);
3056 if (EFI_ERROR (Status)) {
3057 return Status;
3058 }
3059 ASSERT ( SizeOfInfo <= sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION));
3060
3061 UgaHorizontalResolution = Info->HorizontalResolution;
3062 UgaVerticalResolution = Info->VerticalResolution;
3063
3064 FreePool (Info);
3065
3066 } else if (UgaDraw != NULL) {
3067 Status = UgaDraw->GetMode (
3068 UgaDraw,
3069 &UgaHorizontalResolution,
3070 &UgaVerticalResolution,
3071 &UgaColorDepth,
3072 &UgaRefreshRate
3073 );
3074 if (!EFI_ERROR (Status) && EFI_ERROR (DeviceStatus)) {
3075 //
3076 // if GetMode is successfully and UGA device hasn't been set, set it
3077 //
3078 Status = ConSplitterUgaDrawSetMode (
3079 &Private->UgaDraw,
3080 UgaHorizontalResolution,
3081 UgaVerticalResolution,
3082 UgaColorDepth,
3083 UgaRefreshRate
3084 );
3085 }
3086 //
3087 // If GetMode/SetMode is failed, set to 800x600 mode
3088 //
3089 if(EFI_ERROR (Status)) {
3090 Status = ConSplitterUgaDrawSetMode (
3091 &Private->UgaDraw,
3092 800,
3093 600,
3094 32,
3095 60
3096 );
3097 }
3098 }
3099 }
3100
3101 if (((!EFI_ERROR (DeviceStatus)) || (!EFI_ERROR (Status))) &&
3102 ((Private->CurrentNumberOfGraphicsOutput + Private->CurrentNumberOfUgaDraw) == 1)) {
3103 if (!FeaturePcdGet (PcdConOutGopSupport)) {
3104 //
3105 // If Graphics Outpurt protocol not supported, UGA Draw protocol is installed
3106 // on the virtual handle.
3107 //
3108 Status = gBS->InstallMultipleProtocolInterfaces (
3109 &mConOut.VirtualHandle,
3110 &gEfiUgaDrawProtocolGuid,
3111 &mConOut.UgaDraw,
3112 NULL
3113 );
3114 } else if (!FeaturePcdGet (PcdConOutUgaSupport)) {
3115 //
3116 // If UGA Draw protocol not supported, Graphics Output Protocol is installed
3117 // on virtual handle.
3118 //
3119 Status = gBS->InstallMultipleProtocolInterfaces (
3120 &mConOut.VirtualHandle,
3121 &gEfiGraphicsOutputProtocolGuid,
3122 &mConOut.GraphicsOutput,
3123 NULL
3124 );
3125 } else {
3126 //
3127 // Boot Graphics Output protocol and UGA Draw protocol are supported,
3128 // both they will be installed on virtual handle.
3129 //
3130 Status = gBS->InstallMultipleProtocolInterfaces (
3131 &mConOut.VirtualHandle,
3132 &gEfiGraphicsOutputProtocolGuid,
3133 &mConOut.GraphicsOutput,
3134 &gEfiUgaDrawProtocolGuid,
3135 &mConOut.UgaDraw,
3136 NULL
3137 );
3138 }
3139 }
3140
3141 //
3142 // After adding new console device, all existing console devices should be
3143 // synced to the current shared mode.
3144 //
3145 ConsplitterSetConsoleOutMode (Private);
3146
3147 return Status;
3148 }
3149
3150
3151 /**
3152 Remove Text Out Device in Consplitter Text Out list.
3153
3154 @param Private Text Out Splitter pointer.
3155 @param TextOut Simple Text Output Pointer protocol pointer.
3156
3157 @retval EFI_SUCCESS Text Out Device removed successfully.
3158 @retval EFI_NOT_FOUND No Text Out Device found.
3159
3160 **/
3161 EFI_STATUS
3162 ConSplitterTextOutDeleteDevice (
3163 IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private,
3164 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *TextOut
3165 )
3166 {
3167 INT32 Index;
3168 UINTN CurrentNumOfConsoles;
3169 TEXT_OUT_AND_GOP_DATA *TextOutList;
3170 EFI_STATUS Status;
3171
3172 //
3173 // Remove the specified text-out device data structure from the Text out List,
3174 // and rearrange the remaining data structures in the Text out List.
3175 //
3176 CurrentNumOfConsoles = Private->CurrentNumberOfConsoles;
3177 Index = (INT32) CurrentNumOfConsoles - 1;
3178 TextOutList = Private->TextOutList;
3179 while (Index >= 0) {
3180 if (TextOutList->TextOut == TextOut) {
3181 if (TextOutList->UgaDraw != NULL) {
3182 Private->CurrentNumberOfUgaDraw--;
3183 }
3184 if (TextOutList->GraphicsOutput != NULL) {
3185 Private->CurrentNumberOfGraphicsOutput--;
3186 }
3187 CopyMem (TextOutList, TextOutList + 1, sizeof (TEXT_OUT_AND_GOP_DATA) * Index);
3188 CurrentNumOfConsoles--;
3189 break;
3190 }
3191
3192 Index--;
3193 TextOutList++;
3194 }
3195 //
3196 // The specified TextOut is not managed by the ConSplitter driver
3197 //
3198 if (Index < 0) {
3199 return EFI_NOT_FOUND;
3200 }
3201
3202 if (CurrentNumOfConsoles == 0) {
3203 //
3204 // If the number of consoles is zero, reset all parameters
3205 //
3206 Private->CurrentNumberOfConsoles = 0;
3207 Private->TextOutMode.MaxMode = 1;
3208 Private->TextOutQueryData[0].Columns = 80;
3209 Private->TextOutQueryData[0].Rows = 25;
3210 TextOutSetMode (Private, 0);
3211
3212 return EFI_SUCCESS;
3213 }
3214 //
3215 // Max Mode is realy an intersection of the QueryMode command to all
3216 // devices. So we must copy the QueryMode of the first device to
3217 // QueryData.
3218 //
3219 ZeroMem (
3220 Private->TextOutQueryData,
3221 Private->TextOutQueryDataCount * sizeof (TEXT_OUT_SPLITTER_QUERY_DATA)
3222 );
3223
3224 FreePool (Private->TextOutModeMap);
3225 Private->TextOutModeMap = NULL;
3226 TextOutList = Private->TextOutList;
3227
3228 //
3229 // Add the first TextOut to the QueryData array and ModeMap table
3230 //
3231 Status = ConSplitterAddOutputMode (Private, TextOutList->TextOut);
3232
3233 //
3234 // Now add one by one
3235 //
3236 Index = 1;
3237 Private->CurrentNumberOfConsoles = 1;
3238 TextOutList++;
3239 while ((UINTN) Index < CurrentNumOfConsoles) {
3240 ConSplitterSyncOutputMode (Private, TextOutList->TextOut);
3241 Index++;
3242 Private->CurrentNumberOfConsoles++;
3243 TextOutList++;
3244 }
3245
3246 ConSplitterGetIntersectionBetweenConOutAndStrErr ();
3247
3248 return Status;
3249 }
3250
3251
3252 /**
3253 Reset the input device and optionaly run diagnostics
3254
3255 @param This Protocol instance pointer.
3256 @param ExtendedVerification Driver may perform diagnostics on reset.
3257
3258 @retval EFI_SUCCESS The device was reset.
3259 @retval EFI_DEVICE_ERROR The device is not functioning properly and could
3260 not be reset.
3261
3262 **/
3263 EFI_STATUS
3264 EFIAPI
3265 ConSplitterTextInReset (
3266 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,
3267 IN BOOLEAN ExtendedVerification
3268 )
3269 {
3270 EFI_STATUS Status;
3271 EFI_STATUS ReturnStatus;
3272 TEXT_IN_SPLITTER_PRIVATE_DATA *Private;
3273 UINTN Index;
3274
3275 Private = TEXT_IN_SPLITTER_PRIVATE_DATA_FROM_THIS (This);
3276
3277 Private->KeyEventSignalState = FALSE;
3278
3279 //
3280 // return the worst status met
3281 //
3282 for (Index = 0, ReturnStatus = EFI_SUCCESS; Index < Private->CurrentNumberOfConsoles; Index++) {
3283 Status = Private->TextInList[Index]->Reset (
3284 Private->TextInList[Index],
3285 ExtendedVerification
3286 );
3287 if (EFI_ERROR (Status)) {
3288 ReturnStatus = Status;
3289 }
3290 }
3291
3292 return ReturnStatus;
3293 }
3294
3295
3296 /**
3297 Reads the next keystroke from the input device. The WaitForKey Event can
3298 be used to test for existance of a keystroke via WaitForEvent () call.
3299
3300 @param Private Protocol instance pointer.
3301 @param Key Driver may perform diagnostics on reset.
3302
3303 @retval EFI_SUCCESS The keystroke information was returned.
3304 @retval EFI_NOT_READY There was no keystroke data availiable.
3305 @retval EFI_DEVICE_ERROR The keydtroke information was not returned due
3306 to hardware errors.
3307
3308 **/
3309 EFI_STATUS
3310 EFIAPI
3311 ConSplitterTextInPrivateReadKeyStroke (
3312 IN TEXT_IN_SPLITTER_PRIVATE_DATA *Private,
3313 OUT EFI_INPUT_KEY *Key
3314 )
3315 {
3316 EFI_STATUS Status;
3317 UINTN Index;
3318 EFI_INPUT_KEY CurrentKey;
3319
3320 Key->UnicodeChar = 0;
3321 Key->ScanCode = SCAN_NULL;
3322
3323 //
3324 // if no physical console input device exists, return EFI_NOT_READY;
3325 // if any physical console input device has key input,
3326 // return the key and EFI_SUCCESS.
3327 //
3328 for (Index = 0; Index < Private->CurrentNumberOfConsoles; Index++) {
3329 Status = Private->TextInList[Index]->ReadKeyStroke (
3330 Private->TextInList[Index],
3331 &CurrentKey
3332 );
3333 if (!EFI_ERROR (Status)) {
3334 *Key = CurrentKey;
3335 return Status;
3336 }
3337 }
3338
3339 return EFI_NOT_READY;
3340 }
3341
3342
3343
3344 /**
3345 Reads the next keystroke from the input device. The WaitForKey Event can
3346 be used to test for existance of a keystroke via WaitForEvent () call.
3347
3348 @param This Protocol instance pointer.
3349 @param Key Driver may perform diagnostics on reset.
3350
3351 @retval EFI_SUCCESS The keystroke information was returned.
3352 @retval EFI_NOT_READY There was no keystroke data availiable.
3353 @retval EFI_DEVICE_ERROR The keydtroke information was not returned due
3354 to hardware errors.
3355
3356 **/
3357 EFI_STATUS
3358 EFIAPI
3359 ConSplitterTextInReadKeyStroke (
3360 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,
3361 OUT EFI_INPUT_KEY *Key
3362 )
3363 {
3364 TEXT_IN_SPLITTER_PRIVATE_DATA *Private;
3365
3366 Private = TEXT_IN_SPLITTER_PRIVATE_DATA_FROM_THIS (This);
3367
3368 Private->KeyEventSignalState = FALSE;
3369
3370 //
3371 // Signal ConnectConIn event on first call in Lazy ConIn mode
3372 //
3373 if (!mConInIsConnect && PcdGetBool (PcdConInConnectOnDemand)) {
3374 DEBUG ((EFI_D_INFO, "Connect ConIn in first ReadKeyStoke in Lazy ConIn mode.\n"));
3375 gBS->SignalEvent (Private->ConnectConInEvent);
3376 mConInIsConnect = TRUE;
3377 }
3378
3379 return ConSplitterTextInPrivateReadKeyStroke (Private, Key);
3380 }
3381
3382
3383 /**
3384 This event aggregates all the events of the ConIn devices in the spliter.
3385
3386 If any events of physical ConIn devices are signaled, signal the ConIn
3387 spliter event. This will cause the calling code to call
3388 ConSplitterTextInReadKeyStroke ().
3389
3390 @param Event The Event assoicated with callback.
3391 @param Context Context registered when Event was created.
3392
3393 **/
3394 VOID
3395 EFIAPI
3396 ConSplitterTextInWaitForKey (
3397 IN EFI_EVENT Event,
3398 IN VOID *Context
3399 )
3400 {
3401 EFI_STATUS Status;
3402 TEXT_IN_SPLITTER_PRIVATE_DATA *Private;
3403 UINTN Index;
3404
3405 Private = (TEXT_IN_SPLITTER_PRIVATE_DATA *) Context;
3406
3407 if (Private->KeyEventSignalState) {
3408 //
3409 // If KeyEventSignalState is flagged before, and not cleared by Reset() or ReadKeyStroke()
3410 //
3411 gBS->SignalEvent (Event);
3412 return ;
3413 }
3414
3415 //
3416 // If any physical console input device has key input, signal the event.
3417 //
3418 for (Index = 0; Index < Private->CurrentNumberOfConsoles; Index++) {
3419 Status = gBS->CheckEvent (Private->TextInList[Index]->WaitForKey);
3420 if (!EFI_ERROR (Status)) {
3421 gBS->SignalEvent (Event);
3422 Private->KeyEventSignalState = TRUE;
3423 }
3424 }
3425 }
3426
3427
3428
3429 /**
3430 Test if the key has been registered on input device.
3431
3432 @param RegsiteredData A pointer to a buffer that is filled in with the
3433 keystroke state data for the key that was
3434 registered.
3435 @param InputData A pointer to a buffer that is filled in with the
3436 keystroke state data for the key that was
3437 pressed.
3438
3439 @retval TRUE Key be pressed matches a registered key.
3440 @retval FLASE Match failed.
3441
3442 **/
3443 BOOLEAN
3444 IsKeyRegistered (
3445 IN EFI_KEY_DATA *RegsiteredData,
3446 IN EFI_KEY_DATA *InputData
3447 )
3448 {
3449 ASSERT (RegsiteredData != NULL && InputData != NULL);
3450
3451 if ((RegsiteredData->Key.ScanCode != InputData->Key.ScanCode) ||
3452 (RegsiteredData->Key.UnicodeChar != InputData->Key.UnicodeChar)) {
3453 return FALSE;
3454 }
3455
3456 //
3457 // Assume KeyShiftState/KeyToggleState = 0 in Registered key data means these state could be ignored.
3458 //
3459 if (RegsiteredData->KeyState.KeyShiftState != 0 &&
3460 RegsiteredData->KeyState.KeyShiftState != InputData->KeyState.KeyShiftState) {
3461 return FALSE;
3462 }
3463 if (RegsiteredData->KeyState.KeyToggleState != 0 &&
3464 RegsiteredData->KeyState.KeyToggleState != InputData->KeyState.KeyToggleState) {
3465 return FALSE;
3466 }
3467
3468 return TRUE;
3469
3470 }
3471
3472
3473 /**
3474 Reset the input device and optionaly run diagnostics
3475
3476 @param This Protocol instance pointer.
3477 @param ExtendedVerification Driver may perform diagnostics on reset.
3478
3479 @retval EFI_SUCCESS The device was reset.
3480 @retval EFI_DEVICE_ERROR The device is not functioning properly and could
3481 not be reset.
3482
3483 **/
3484 EFI_STATUS
3485 EFIAPI
3486 ConSplitterTextInResetEx (
3487 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,
3488 IN BOOLEAN ExtendedVerification
3489 )
3490 {
3491 EFI_STATUS Status;
3492 EFI_STATUS ReturnStatus;
3493 TEXT_IN_SPLITTER_PRIVATE_DATA *Private;
3494 UINTN Index;
3495
3496 Private = TEXT_IN_EX_SPLITTER_PRIVATE_DATA_FROM_THIS (This);
3497
3498 Private->KeyEventSignalState = FALSE;
3499
3500 //
3501 // return the worst status met
3502 //
3503 for (Index = 0, ReturnStatus = EFI_SUCCESS; Index < Private->CurrentNumberOfExConsoles; Index++) {
3504 Status = Private->TextInExList[Index]->Reset (
3505 Private->TextInExList[Index],
3506 ExtendedVerification
3507 );
3508 if (EFI_ERROR (Status)) {
3509 ReturnStatus = Status;
3510 }
3511 }
3512
3513 return ReturnStatus;
3514
3515 }
3516
3517
3518 /**
3519 Reads the next keystroke from the input device. The WaitForKey Event can
3520 be used to test for existance of a keystroke via WaitForEvent () call.
3521
3522 @param This Protocol instance pointer.
3523 @param KeyData A pointer to a buffer that is filled in with the
3524 keystroke state data for the key that was
3525 pressed.
3526
3527 @retval EFI_SUCCESS The keystroke information was returned.
3528 @retval EFI_NOT_READY There was no keystroke data availiable.
3529 @retval EFI_DEVICE_ERROR The keystroke information was not returned due
3530 to hardware errors.
3531 @retval EFI_INVALID_PARAMETER KeyData is NULL.
3532
3533 **/
3534 EFI_STATUS
3535 EFIAPI
3536 ConSplitterTextInReadKeyStrokeEx (
3537 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,
3538 OUT EFI_KEY_DATA *KeyData
3539 )
3540 {
3541 TEXT_IN_SPLITTER_PRIVATE_DATA *Private;
3542 EFI_STATUS Status;
3543 UINTN Index;
3544 EFI_KEY_DATA CurrentKeyData;
3545
3546
3547 if (KeyData == NULL) {
3548 return EFI_INVALID_PARAMETER;
3549 }
3550
3551 Private = TEXT_IN_EX_SPLITTER_PRIVATE_DATA_FROM_THIS (This);
3552
3553 Private->KeyEventSignalState = FALSE;
3554
3555 KeyData->Key.UnicodeChar = 0;
3556 KeyData->Key.ScanCode = SCAN_NULL;
3557
3558 //
3559 // Signal ConnectConIn event on first call in Lazy ConIn mode
3560 //
3561 if (!mConInIsConnect && PcdGetBool (PcdConInConnectOnDemand)) {
3562 DEBUG ((EFI_D_INFO, "Connect ConIn in first ReadKeyStoke in Lazy ConIn mode.\n"));
3563 gBS->SignalEvent (Private->ConnectConInEvent);
3564 mConInIsConnect = TRUE;
3565 }
3566
3567 //
3568 // if no physical console input device exists, return EFI_NOT_READY;
3569 // if any physical console input device has key input,
3570 // return the key and EFI_SUCCESS.
3571 //
3572 for (Index = 0; Index < Private->CurrentNumberOfExConsoles; Index++) {
3573 Status = Private->TextInExList[Index]->ReadKeyStrokeEx (
3574 Private->TextInExList[Index],
3575 &CurrentKeyData
3576 );
3577 if (!EFI_ERROR (Status)) {
3578 CopyMem (KeyData, &CurrentKeyData, sizeof (CurrentKeyData));
3579 return Status;
3580 }
3581 }
3582
3583 return EFI_NOT_READY;
3584 }
3585
3586
3587 /**
3588 Set certain state for the input device.
3589
3590 @param This Protocol instance pointer.
3591 @param KeyToggleState A pointer to the EFI_KEY_TOGGLE_STATE to set the
3592 state for the input device.
3593
3594 @retval EFI_SUCCESS The device state was set successfully.
3595 @retval EFI_DEVICE_ERROR The device is not functioning correctly and
3596 could not have the setting adjusted.
3597 @retval EFI_UNSUPPORTED The device does not have the ability to set its
3598 state.
3599 @retval EFI_INVALID_PARAMETER KeyToggleState is NULL.
3600
3601 **/
3602 EFI_STATUS
3603 EFIAPI
3604 ConSplitterTextInSetState (
3605 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,
3606 IN EFI_KEY_TOGGLE_STATE *KeyToggleState
3607 )
3608 {
3609 TEXT_IN_SPLITTER_PRIVATE_DATA *Private;
3610 EFI_STATUS Status;
3611 UINTN Index;
3612
3613 if (KeyToggleState == NULL) {
3614 return EFI_INVALID_PARAMETER;
3615 }
3616
3617 Private = TEXT_IN_EX_SPLITTER_PRIVATE_DATA_FROM_THIS (This);
3618
3619 //
3620 // if no physical console input device exists, return EFI_SUCCESS;
3621 // otherwise return the status of setting state of physical console input device
3622 //
3623 for (Index = 0; Index < Private->CurrentNumberOfExConsoles; Index++) {
3624 Status = Private->TextInExList[Index]->SetState (
3625 Private->TextInExList[Index],
3626 KeyToggleState
3627 );
3628 if (EFI_ERROR (Status)) {
3629 return Status;
3630 }
3631 }
3632
3633 return EFI_SUCCESS;
3634
3635 }
3636
3637
3638 /**
3639 Register a notification function for a particular keystroke for the input device.
3640
3641 @param This Protocol instance pointer.
3642 @param KeyData A pointer to a buffer that is filled in with the
3643 keystroke information data for the key that was
3644 pressed.
3645 @param KeyNotificationFunction Points to the function to be called when the key
3646 sequence is typed specified by KeyData.
3647 @param NotifyHandle Points to the unique handle assigned to the
3648 registered notification.
3649
3650 @retval EFI_SUCCESS The notification function was registered
3651 successfully.
3652 @retval EFI_OUT_OF_RESOURCES Unable to allocate resources for necesssary data
3653 structures.
3654 @retval EFI_INVALID_PARAMETER KeyData or KeyNotificationFunction or NotifyHandle is NULL.
3655
3656 **/
3657 EFI_STATUS
3658 EFIAPI
3659 ConSplitterTextInRegisterKeyNotify (
3660 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,
3661 IN EFI_KEY_DATA *KeyData,
3662 IN EFI_KEY_NOTIFY_FUNCTION KeyNotificationFunction,
3663 OUT VOID **NotifyHandle
3664 )
3665 {
3666 TEXT_IN_SPLITTER_PRIVATE_DATA *Private;
3667 EFI_STATUS Status;
3668 UINTN Index;
3669 TEXT_IN_EX_SPLITTER_NOTIFY *NewNotify;
3670 LIST_ENTRY *Link;
3671 TEXT_IN_EX_SPLITTER_NOTIFY *CurrentNotify;
3672
3673
3674 if (KeyData == NULL || NotifyHandle == NULL || KeyNotificationFunction == NULL) {
3675 return EFI_INVALID_PARAMETER;
3676 }
3677
3678 Private = TEXT_IN_EX_SPLITTER_PRIVATE_DATA_FROM_THIS (This);
3679
3680 //
3681 // Return EFI_SUCCESS if the (KeyData, NotificationFunction) is already registered.
3682 //
3683 for (Link = Private->NotifyList.ForwardLink; Link != &Private->NotifyList; Link = Link->ForwardLink) {
3684 CurrentNotify = TEXT_IN_EX_SPLITTER_NOTIFY_FROM_THIS (Link);
3685 if (IsKeyRegistered (&CurrentNotify->KeyData, KeyData)) {
3686 if (CurrentNotify->KeyNotificationFn == KeyNotificationFunction) {
3687 *NotifyHandle = CurrentNotify;
3688 return EFI_SUCCESS;
3689 }
3690 }
3691 }
3692
3693 //
3694 // Allocate resource to save the notification function
3695 //
3696 NewNotify = (TEXT_IN_EX_SPLITTER_NOTIFY *) AllocateZeroPool (sizeof (TEXT_IN_EX_SPLITTER_NOTIFY));
3697 if (NewNotify == NULL) {
3698 return EFI_OUT_OF_RESOURCES;
3699 }
3700 NewNotify->NotifyHandleList = (EFI_HANDLE *) AllocateZeroPool (sizeof (EFI_HANDLE) * Private->TextInExListCount);
3701 if (NewNotify->NotifyHandleList == NULL) {
3702 gBS->FreePool (NewNotify);
3703 return EFI_OUT_OF_RESOURCES;
3704 }
3705 NewNotify->Signature = TEXT_IN_EX_SPLITTER_NOTIFY_SIGNATURE;
3706 NewNotify->KeyNotificationFn = KeyNotificationFunction;
3707 CopyMem (&NewNotify->KeyData, KeyData, sizeof (EFI_KEY_DATA));
3708
3709 //
3710 // Return the wrong status of registering key notify of
3711 // physical console input device if meet problems
3712 //
3713 for (Index = 0; Index < Private->CurrentNumberOfExConsoles; Index++) {
3714 Status = Private->TextInExList[Index]->RegisterKeyNotify (
3715 Private->TextInExList[Index],
3716 KeyData,
3717 KeyNotificationFunction,
3718 &NewNotify->NotifyHandleList[Index]
3719 );
3720 if (EFI_ERROR (Status)) {
3721 //
3722 // Un-register the key notify on all physical console input devices
3723 //
3724 while (Index-- != 0) {
3725 Private->TextInExList[Index]->UnregisterKeyNotify (
3726 Private->TextInExList[Index],
3727 NewNotify->NotifyHandleList[Index]
3728 );
3729 }
3730 gBS->FreePool (NewNotify->NotifyHandleList);
3731 gBS->FreePool (NewNotify);
3732 return Status;
3733 }
3734 }
3735
3736 InsertTailList (&mConIn.NotifyList, &NewNotify->NotifyEntry);
3737
3738 *NotifyHandle = NewNotify;
3739
3740 return EFI_SUCCESS;
3741
3742 }
3743
3744
3745 /**
3746 Remove a registered notification function from a particular keystroke.
3747
3748 @param This Protocol instance pointer.
3749 @param NotificationHandle The handle of the notification function being
3750 unregistered.
3751
3752 @retval EFI_SUCCESS The notification function was unregistered
3753 successfully.
3754 @retval EFI_INVALID_PARAMETER The NotificationHandle is invalid.
3755
3756 **/
3757 EFI_STATUS
3758 EFIAPI
3759 ConSplitterTextInUnregisterKeyNotify (
3760 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,
3761 IN VOID *NotificationHandle
3762 )
3763 {
3764 TEXT_IN_SPLITTER_PRIVATE_DATA *Private;
3765 UINTN Index;
3766 TEXT_IN_EX_SPLITTER_NOTIFY *CurrentNotify;
3767 LIST_ENTRY *Link;
3768
3769 if (NotificationHandle == NULL) {
3770 return EFI_INVALID_PARAMETER;
3771 }
3772
3773 Private = TEXT_IN_EX_SPLITTER_PRIVATE_DATA_FROM_THIS (This);
3774
3775 for (Link = Private->NotifyList.ForwardLink; Link != &Private->NotifyList; Link = Link->ForwardLink) {
3776 CurrentNotify = TEXT_IN_EX_SPLITTER_NOTIFY_FROM_THIS (Link);
3777 if (CurrentNotify == NotificationHandle) {
3778 for (Index = 0; Index < Private->CurrentNumberOfExConsoles; Index++) {
3779 Private->TextInExList[Index]->UnregisterKeyNotify (
3780 Private->TextInExList[Index],
3781 CurrentNotify->NotifyHandleList[Index]
3782 );
3783 }
3784 RemoveEntryList (&CurrentNotify->NotifyEntry);
3785
3786 gBS->FreePool (CurrentNotify->NotifyHandleList);
3787 gBS->FreePool (CurrentNotify);
3788 return EFI_SUCCESS;
3789 }
3790 }
3791
3792 //
3793 // NotificationHandle is not found in database
3794 //
3795 return EFI_INVALID_PARAMETER;
3796 }
3797
3798
3799 /**
3800 Reset the input device and optionaly run diagnostics
3801
3802 @param This Protocol instance pointer.
3803 @param ExtendedVerification Driver may perform diagnostics on reset.
3804
3805 @retval EFI_SUCCESS The device was reset.
3806 @retval EFI_DEVICE_ERROR The device is not functioning properly and could
3807 not be reset.
3808
3809 **/
3810 EFI_STATUS
3811 EFIAPI
3812 ConSplitterSimplePointerReset (
3813 IN EFI_SIMPLE_POINTER_PROTOCOL *This,
3814 IN BOOLEAN ExtendedVerification
3815 )
3816 {
3817 EFI_STATUS Status;
3818 EFI_STATUS ReturnStatus;
3819 TEXT_IN_SPLITTER_PRIVATE_DATA *Private;
3820 UINTN Index;
3821
3822 Private = TEXT_IN_SPLITTER_PRIVATE_DATA_FROM_SIMPLE_POINTER_THIS (This);
3823
3824 Private->InputEventSignalState = FALSE;
3825
3826 if (Private->CurrentNumberOfPointers == 0) {
3827 return EFI_SUCCESS;
3828 }
3829 //
3830 // return the worst status met
3831 //
3832 for (Index = 0, ReturnStatus = EFI_SUCCESS; Index < Private->CurrentNumberOfPointers; Index++) {
3833 Status = Private->PointerList[Index]->Reset (
3834 Private->PointerList[Index],
3835 ExtendedVerification
3836 );
3837 if (EFI_ERROR (Status)) {
3838 ReturnStatus = Status;
3839 }
3840 }
3841
3842 return ReturnStatus;
3843 }
3844
3845
3846 /**
3847 Reads the next keystroke from the input device. The WaitForKey Event can
3848 be used to test for existance of a keystroke via WaitForEvent () call.
3849
3850 @param Private Protocol instance pointer.
3851 @param State The state information of simple pointer device.
3852
3853 @retval EFI_SUCCESS The keystroke information was returned.
3854 @retval EFI_NOT_READY There was no keystroke data availiable.
3855 @retval EFI_DEVICE_ERROR The keydtroke information was not returned due
3856 to hardware errors.
3857
3858 **/
3859 EFI_STATUS
3860 EFIAPI
3861 ConSplitterSimplePointerPrivateGetState (
3862 IN TEXT_IN_SPLITTER_PRIVATE_DATA *Private,
3863 IN OUT EFI_SIMPLE_POINTER_STATE *State
3864 )
3865 {
3866 EFI_STATUS Status;
3867 EFI_STATUS ReturnStatus;
3868 UINTN Index;
3869 EFI_SIMPLE_POINTER_STATE CurrentState;
3870
3871 State->RelativeMovementX = 0;
3872 State->RelativeMovementY = 0;
3873 State->RelativeMovementZ = 0;
3874 State->LeftButton = FALSE;
3875 State->RightButton = FALSE;
3876
3877 //
3878 // if no physical console input device exists, return EFI_NOT_READY;
3879 // if any physical console input device has key input,
3880 // return the key and EFI_SUCCESS.
3881 //
3882 ReturnStatus = EFI_NOT_READY;
3883 for (Index = 0; Index < Private->CurrentNumberOfPointers; Index++) {
3884
3885 Status = Private->PointerList[Index]->GetState (
3886 Private->PointerList[Index],
3887 &CurrentState
3888 );
3889 if (!EFI_ERROR (Status)) {
3890 if (ReturnStatus == EFI_NOT_READY) {
3891 ReturnStatus = EFI_SUCCESS;
3892 }
3893
3894 if (CurrentState.LeftButton) {
3895 State->LeftButton = TRUE;
3896 }
3897
3898 if (CurrentState.RightButton) {
3899 State->RightButton = TRUE;
3900 }
3901
3902 if (CurrentState.RelativeMovementX != 0 && Private->PointerList[Index]->Mode->ResolutionX != 0) {
3903 State->RelativeMovementX += (CurrentState.RelativeMovementX * (INT32) Private->SimplePointerMode.ResolutionX) / (INT32) Private->PointerList[Index]->Mode->ResolutionX;
3904 }
3905
3906 if (CurrentState.RelativeMovementY != 0 && Private->PointerList[Index]->Mode->ResolutionY != 0) {
3907 State->RelativeMovementY += (CurrentState.RelativeMovementY * (INT32) Private->SimplePointerMode.ResolutionY) / (INT32) Private->PointerList[Index]->Mode->ResolutionY;
3908 }
3909
3910 if (CurrentState.RelativeMovementZ != 0 && Private->PointerList[Index]->Mode->ResolutionZ != 0) {
3911 State->RelativeMovementZ += (CurrentState.RelativeMovementZ * (INT32) Private->SimplePointerMode.ResolutionZ) / (INT32) Private->PointerList[Index]->Mode->ResolutionZ;
3912 }
3913 } else if (Status == EFI_DEVICE_ERROR) {
3914 ReturnStatus = EFI_DEVICE_ERROR;
3915 }
3916 }
3917
3918 return ReturnStatus;
3919 }
3920
3921
3922 /**
3923 Reads the next keystroke from the input device. The WaitForKey Event can
3924 be used to test for existance of a keystroke via WaitForEvent () call.
3925
3926 @param This A pointer to protocol instance.
3927 @param State A pointer to state information on the pointer device
3928
3929 @retval EFI_SUCCESS The keystroke information was returned in State.
3930 @retval EFI_NOT_READY There was no keystroke data availiable.
3931 @retval EFI_DEVICE_ERROR The keydtroke information was not returned due
3932 to hardware errors.
3933
3934 **/
3935 EFI_STATUS
3936 EFIAPI
3937 ConSplitterSimplePointerGetState (
3938 IN EFI_SIMPLE_POINTER_PROTOCOL *This,
3939 IN OUT EFI_SIMPLE_POINTER_STATE *State
3940 )
3941 {
3942 TEXT_IN_SPLITTER_PRIVATE_DATA *Private;
3943
3944 Private = TEXT_IN_SPLITTER_PRIVATE_DATA_FROM_SIMPLE_POINTER_THIS (This);
3945
3946 Private->InputEventSignalState = FALSE;
3947
3948 return ConSplitterSimplePointerPrivateGetState (Private, State);
3949 }
3950
3951
3952 /**
3953 This event agregates all the events of the ConIn devices in the spliter.
3954 If any events of physical ConIn devices are signaled, signal the ConIn
3955 spliter event. This will cause the calling code to call
3956 ConSplitterTextInReadKeyStroke ().
3957
3958 @param Event The Event assoicated with callback.
3959 @param Context Context registered when Event was created.
3960
3961 **/
3962 VOID
3963 EFIAPI
3964 ConSplitterSimplePointerWaitForInput (
3965 IN EFI_EVENT Event,
3966 IN VOID *Context
3967 )
3968 {
3969 EFI_STATUS Status;
3970 TEXT_IN_SPLITTER_PRIVATE_DATA *Private;
3971 UINTN Index;
3972
3973 Private = (TEXT_IN_SPLITTER_PRIVATE_DATA *) Context;
3974
3975 //
3976 // if InputEventSignalState is flagged before, and not cleared by Reset() or ReadKeyStroke()
3977 //
3978 if (Private->InputEventSignalState) {
3979 gBS->SignalEvent (Event);
3980 return ;
3981 }
3982 //
3983 // if any physical console input device has key input, signal the event.
3984 //
3985 for (Index = 0; Index < Private->CurrentNumberOfPointers; Index++) {
3986 Status = gBS->CheckEvent (Private->PointerList[Index]->WaitForInput);
3987 if (!EFI_ERROR (Status)) {
3988 gBS->SignalEvent (Event);
3989 Private->InputEventSignalState = TRUE;
3990 }
3991 }
3992 }
3993
3994 /**
3995 Resets the pointer device hardware.
3996
3997 @param This Protocol instance pointer.
3998 @param ExtendedVerification Driver may perform diagnostics on reset.
3999
4000 @retval EFI_SUCCESS The device was reset.
4001 @retval EFI_DEVICE_ERROR The device is not functioning correctly and
4002 could not be reset.
4003
4004 **/
4005 EFI_STATUS
4006 EFIAPI
4007 ConSplitterAbsolutePointerReset (
4008 IN EFI_ABSOLUTE_POINTER_PROTOCOL *This,
4009 IN BOOLEAN ExtendedVerification
4010 )
4011 {
4012 EFI_STATUS Status;
4013 EFI_STATUS ReturnStatus;
4014 TEXT_IN_SPLITTER_PRIVATE_DATA *Private;
4015 UINTN Index;
4016
4017 Private = TEXT_IN_SPLITTER_PRIVATE_DATA_FROM_ABSOLUTE_POINTER_THIS (This);
4018
4019 Private->AbsoluteInputEventSignalState = FALSE;
4020
4021 if (Private->CurrentNumberOfAbsolutePointers == 0) {
4022 return EFI_SUCCESS;
4023 }
4024 //
4025 // return the worst status met
4026 //
4027 for (Index = 0, ReturnStatus = EFI_SUCCESS; Index < Private->CurrentNumberOfAbsolutePointers; Index++) {
4028 Status = Private->AbsolutePointerList[Index]->Reset (
4029 Private->AbsolutePointerList[Index],
4030 ExtendedVerification
4031 );
4032 if (EFI_ERROR (Status)) {
4033 ReturnStatus = Status;
4034 }
4035 }
4036
4037 return ReturnStatus;
4038 }
4039
4040
4041 /**
4042 Retrieves the current state of a pointer device.
4043
4044 @param This Protocol instance pointer.
4045 @param State A pointer to the state information on the
4046 pointer device.
4047
4048 @retval EFI_SUCCESS The state of the pointer device was returned in
4049 State..
4050 @retval EFI_NOT_READY The state of the pointer device has not changed
4051 since the last call to GetState().
4052 @retval EFI_DEVICE_ERROR A device error occurred while attempting to
4053 retrieve the pointer device's current state.
4054
4055 **/
4056 EFI_STATUS
4057 EFIAPI
4058 ConSplitterAbsolutePointerGetState (
4059 IN EFI_ABSOLUTE_POINTER_PROTOCOL *This,
4060 IN OUT EFI_ABSOLUTE_POINTER_STATE *State
4061 )
4062 {
4063 TEXT_IN_SPLITTER_PRIVATE_DATA *Private;
4064 EFI_STATUS Status;
4065 EFI_STATUS ReturnStatus;
4066 UINTN Index;
4067 EFI_ABSOLUTE_POINTER_STATE CurrentState;
4068
4069
4070 Private = TEXT_IN_SPLITTER_PRIVATE_DATA_FROM_ABSOLUTE_POINTER_THIS (This);
4071
4072 Private->AbsoluteInputEventSignalState = FALSE;
4073
4074 State->CurrentX = 0;
4075 State->CurrentY = 0;
4076 State->CurrentZ = 0;
4077 State->ActiveButtons = 0;
4078
4079 //
4080 // if no physical pointer device exists, return EFI_NOT_READY;
4081 // if any physical pointer device has changed state,
4082 // return the state and EFI_SUCCESS.
4083 //
4084 ReturnStatus = EFI_NOT_READY;
4085 for (Index = 0; Index < Private->CurrentNumberOfAbsolutePointers; Index++) {
4086
4087 Status = Private->AbsolutePointerList[Index]->GetState (
4088 Private->AbsolutePointerList[Index],
4089 &CurrentState
4090 );
4091 if (!EFI_ERROR (Status)) {
4092 if (ReturnStatus == EFI_NOT_READY) {
4093 ReturnStatus = EFI_SUCCESS;
4094 }
4095
4096 State->ActiveButtons = CurrentState.ActiveButtons;
4097
4098 if (!(Private->AbsolutePointerMode.AbsoluteMinX == 0 && Private->AbsolutePointerMode.AbsoluteMaxX == 0)) {
4099 State->CurrentX = CurrentState.CurrentX;
4100 }
4101 if (!(Private->AbsolutePointerMode.AbsoluteMinY == 0 && Private->AbsolutePointerMode.AbsoluteMaxY == 0)) {
4102 State->CurrentY = CurrentState.CurrentY;
4103 }
4104 if (!(Private->AbsolutePointerMode.AbsoluteMinZ == 0 && Private->AbsolutePointerMode.AbsoluteMaxZ == 0)) {
4105 State->CurrentZ = CurrentState.CurrentZ;
4106 }
4107
4108 } else if (Status == EFI_DEVICE_ERROR) {
4109 ReturnStatus = EFI_DEVICE_ERROR;
4110 }
4111 }
4112
4113 return ReturnStatus;
4114 }
4115
4116
4117 /**
4118 This event agregates all the events of the pointer devices in the splitter.
4119 If any events of physical pointer devices are signaled, signal the pointer
4120 splitter event. This will cause the calling code to call
4121 ConSplitterAbsolutePointerGetState ().
4122
4123 @param Event The Event assoicated with callback.
4124 @param Context Context registered when Event was created.
4125
4126 **/
4127 VOID
4128 EFIAPI
4129 ConSplitterAbsolutePointerWaitForInput (
4130 IN EFI_EVENT Event,
4131 IN VOID *Context
4132 )
4133 {
4134 EFI_STATUS Status;
4135 TEXT_IN_SPLITTER_PRIVATE_DATA *Private;
4136 UINTN Index;
4137
4138 Private = (TEXT_IN_SPLITTER_PRIVATE_DATA *) Context;
4139
4140 //
4141 // if AbsoluteInputEventSignalState is flagged before,
4142 // and not cleared by Reset() or GetState(), signal it
4143 //
4144 if (Private->AbsoluteInputEventSignalState) {
4145 gBS->SignalEvent (Event);
4146 return ;
4147 }
4148 //
4149 // if any physical console input device has key input, signal the event.
4150 //
4151 for (Index = 0; Index < Private->CurrentNumberOfAbsolutePointers; Index++) {
4152 Status = gBS->CheckEvent (Private->AbsolutePointerList[Index]->WaitForInput);
4153 if (!EFI_ERROR (Status)) {
4154 gBS->SignalEvent (Event);
4155 Private->AbsoluteInputEventSignalState = TRUE;
4156 }
4157 }
4158 }
4159
4160
4161 /**
4162 Reset the text output device hardware and optionaly run diagnostics
4163
4164 @param This Protocol instance pointer.
4165 @param ExtendedVerification Driver may perform more exhaustive verfication
4166 operation of the device during reset.
4167
4168 @retval EFI_SUCCESS The text output device was reset.
4169 @retval EFI_DEVICE_ERROR The text output device is not functioning
4170 correctly and could not be reset.
4171
4172 **/
4173 EFI_STATUS
4174 EFIAPI
4175 ConSplitterTextOutReset (
4176 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
4177 IN BOOLEAN ExtendedVerification
4178 )
4179 {
4180 EFI_STATUS Status;
4181 TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;
4182 UINTN Index;
4183 EFI_STATUS ReturnStatus;
4184
4185 Private = TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This);
4186
4187 //
4188 // return the worst status met
4189 //
4190 for (Index = 0, ReturnStatus = EFI_SUCCESS; Index < Private->CurrentNumberOfConsoles; Index++) {
4191 Status = Private->TextOutList[Index].TextOut->Reset (
4192 Private->TextOutList[Index].TextOut,
4193 ExtendedVerification
4194 );
4195 if (EFI_ERROR (Status)) {
4196 ReturnStatus = Status;
4197 }
4198 }
4199
4200 This->SetAttribute (This, EFI_TEXT_ATTR (This->Mode->Attribute & 0x0F, EFI_BLACK));
4201
4202 //
4203 // reset all mode parameters
4204 //
4205 TextOutSetMode (Private, 0);
4206
4207 return ReturnStatus;
4208 }
4209
4210
4211 /**
4212 Write a Unicode string to the output device.
4213
4214 @param This Protocol instance pointer.
4215 @param WString The NULL-terminated Unicode string to be
4216 displayed on the output device(s). All output
4217 devices must also support the Unicode drawing
4218 defined in this file.
4219
4220 @retval EFI_SUCCESS The string was output to the device.
4221 @retval EFI_DEVICE_ERROR The device reported an error while attempting to
4222 output the text.
4223 @retval EFI_UNSUPPORTED The output device's mode is not currently in a
4224 defined text mode.
4225 @retval EFI_WARN_UNKNOWN_GLYPH This warning code indicates that some of the
4226 characters in the Unicode string could not be
4227 rendered and were skipped.
4228
4229 **/
4230 EFI_STATUS
4231 EFIAPI
4232 ConSplitterTextOutOutputString (
4233 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
4234 IN CHAR16 *WString
4235 )
4236 {
4237 EFI_STATUS Status;
4238 TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;
4239 UINTN Index;
4240 EFI_STATUS ReturnStatus;
4241 UINTN MaxColumn;
4242 UINTN MaxRow;
4243
4244 This->SetAttribute (This, This->Mode->Attribute);
4245
4246 Private = TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This);
4247
4248 //
4249 // return the worst status met
4250 //
4251 for (Index = 0, ReturnStatus = EFI_SUCCESS; Index < Private->CurrentNumberOfConsoles; Index++) {
4252 Status = Private->TextOutList[Index].TextOut->OutputString (
4253 Private->TextOutList[Index].TextOut,
4254 WString
4255 );
4256 if (EFI_ERROR (Status)) {
4257 ReturnStatus = Status;
4258 }
4259 }
4260
4261 if (Private->CurrentNumberOfConsoles > 0) {
4262 Private->TextOutMode.CursorColumn = Private->TextOutList[0].TextOut->Mode->CursorColumn;
4263 Private->TextOutMode.CursorRow = Private->TextOutList[0].TextOut->Mode->CursorRow;
4264 } else {
4265 //
4266 // When there is no real console devices in system,
4267 // update cursor position for the virtual device in consplitter.
4268 //
4269 Private->TextOut.QueryMode (
4270 &Private->TextOut,
4271 Private->TextOutMode.Mode,
4272 &MaxColumn,
4273 &MaxRow
4274 );
4275 for (; *WString != CHAR_NULL; WString++) {
4276 switch (*WString) {
4277 case CHAR_BACKSPACE:
4278 if (Private->TextOutMode.CursorColumn == 0 && Private->TextOutMode.CursorRow > 0) {
4279 Private->TextOutMode.CursorRow--;
4280 Private->TextOutMode.CursorColumn = (INT32) (MaxColumn - 1);
4281 } else if (Private->TextOutMode.CursorColumn > 0) {
4282 Private->TextOutMode.CursorColumn--;
4283 }
4284 break;
4285
4286 case CHAR_LINEFEED:
4287 if (Private->TextOutMode.CursorRow < (INT32) (MaxRow - 1)) {
4288 Private->TextOutMode.CursorRow++;
4289 }
4290 break;
4291
4292 case CHAR_CARRIAGE_RETURN:
4293 Private->TextOutMode.CursorColumn = 0;
4294 break;
4295
4296 default:
4297 if (Private->TextOutMode.CursorColumn < (INT32) (MaxColumn - 1)) {
4298 Private->TextOutMode.CursorColumn++;
4299 } else {
4300 Private->TextOutMode.CursorColumn = 0;
4301 if (Private->TextOutMode.CursorRow < (INT32) (MaxRow - 1)) {
4302 Private->TextOutMode.CursorRow++;
4303 }
4304 }
4305 break;
4306 }
4307 }
4308 }
4309
4310 return ReturnStatus;
4311 }
4312
4313
4314 /**
4315 Verifies that all characters in a Unicode string can be output to the
4316 target device.
4317
4318 @param This Protocol instance pointer.
4319 @param WString The NULL-terminated Unicode string to be
4320 examined for the output device(s).
4321
4322 @retval EFI_SUCCESS The device(s) are capable of rendering the
4323 output string.
4324 @retval EFI_UNSUPPORTED Some of the characters in the Unicode string
4325 cannot be rendered by one or more of the output
4326 devices mapped by the EFI handle.
4327
4328 **/
4329 EFI_STATUS
4330 EFIAPI
4331 ConSplitterTextOutTestString (
4332 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
4333 IN CHAR16 *WString
4334 )
4335 {
4336 EFI_STATUS Status;
4337 TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;
4338 UINTN Index;
4339 EFI_STATUS ReturnStatus;
4340
4341 Private = TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This);
4342
4343 //
4344 // return the worst status met
4345 //
4346 for (Index = 0, ReturnStatus = EFI_SUCCESS; Index < Private->CurrentNumberOfConsoles; Index++) {
4347 Status = Private->TextOutList[Index].TextOut->TestString (
4348 Private->TextOutList[Index].TextOut,
4349 WString
4350 );
4351 if (EFI_ERROR (Status)) {
4352 ReturnStatus = Status;
4353 }
4354 }
4355 //
4356 // There is no DevNullTextOutTestString () since a Unicode buffer would
4357 // always return EFI_SUCCESS.
4358 // ReturnStatus will be EFI_SUCCESS if no consoles are present
4359 //
4360 return ReturnStatus;
4361 }
4362
4363
4364 /**
4365 Returns information for an available text mode that the output device(s)
4366 supports.
4367
4368 @param This Protocol instance pointer.
4369 @param ModeNumber The mode number to return information on.
4370 @param Columns Returns the columns of the text output device
4371 for the requested ModeNumber.
4372 @param Rows Returns the rows of the text output device
4373 for the requested ModeNumber.
4374
4375 @retval EFI_SUCCESS The requested mode information was returned.
4376 @retval EFI_DEVICE_ERROR The device had an error and could not complete
4377 the request.
4378 @retval EFI_UNSUPPORTED The mode number was not valid.
4379
4380 **/
4381 EFI_STATUS
4382 EFIAPI
4383 ConSplitterTextOutQueryMode (
4384 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
4385 IN UINTN ModeNumber,
4386 OUT UINTN *Columns,
4387 OUT UINTN *Rows
4388 )
4389 {
4390 TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;
4391 UINTN CurrentMode;
4392 INT32 *TextOutModeMap;
4393
4394 Private = TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This);
4395
4396 //
4397 // Check whether param ModeNumber is valid.
4398 // ModeNumber should be within range 0 ~ MaxMode - 1.
4399 //
4400 if ( (ModeNumber > (UINTN)(((UINT32)-1)>>1)) ) {
4401 return EFI_UNSUPPORTED;
4402 }
4403
4404 if ((INT32) ModeNumber >= This->Mode->MaxMode) {
4405 return EFI_UNSUPPORTED;
4406 }
4407
4408 //
4409 // We get the available mode from mode intersection map if it's available
4410 //
4411 if (Private->TextOutModeMap != NULL) {
4412 TextOutModeMap = Private->TextOutModeMap + Private->TextOutListCount * ModeNumber;
4413 CurrentMode = (UINTN)(*TextOutModeMap);
4414 *Columns = Private->TextOutQueryData[CurrentMode].Columns;
4415 *Rows = Private->TextOutQueryData[CurrentMode].Rows;
4416 } else {
4417 *Columns = Private->TextOutQueryData[ModeNumber].Columns;
4418 *Rows = Private->TextOutQueryData[ModeNumber].Rows;
4419 }
4420
4421 if (*Columns <= 0 && *Rows <= 0) {
4422 return EFI_UNSUPPORTED;
4423
4424 }
4425
4426 return EFI_SUCCESS;
4427 }
4428
4429
4430 /**
4431 Sets the output device(s) to a specified mode.
4432
4433 @param This Protocol instance pointer.
4434 @param ModeNumber The mode number to set.
4435
4436 @retval EFI_SUCCESS The requested text mode was set.
4437 @retval EFI_DEVICE_ERROR The device had an error and could not complete
4438 the request.
4439 @retval EFI_UNSUPPORTED The mode number was not valid.
4440
4441 **/
4442 EFI_STATUS
4443 EFIAPI
4444 ConSplitterTextOutSetMode (
4445 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
4446 IN UINTN ModeNumber
4447 )
4448 {
4449 EFI_STATUS Status;
4450 TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;
4451 UINTN Index;
4452 INT32 *TextOutModeMap;
4453 EFI_STATUS ReturnStatus;
4454
4455 Private = TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This);
4456
4457 //
4458 // Check whether param ModeNumber is valid.
4459 // ModeNumber should be within range 0 ~ MaxMode - 1.
4460 //
4461 if ( (ModeNumber > (UINTN)(((UINT32)-1)>>1)) ) {
4462 return EFI_UNSUPPORTED;
4463 }
4464
4465 if ((INT32) ModeNumber >= This->Mode->MaxMode) {
4466 return EFI_UNSUPPORTED;
4467 }
4468 //
4469 // If the mode is being set to the curent mode, then just clear the screen and return.
4470 //
4471 if (Private->TextOutMode.Mode == (INT32) ModeNumber) {
4472 return ConSplitterTextOutClearScreen (This);
4473 }
4474 //
4475 // return the worst status met
4476 //
4477 TextOutModeMap = Private->TextOutModeMap + Private->TextOutListCount * ModeNumber;
4478 for (Index = 0, ReturnStatus = EFI_SUCCESS; Index < Private->CurrentNumberOfConsoles; Index++) {
4479 Status = Private->TextOutList[Index].TextOut->SetMode (
4480 Private->TextOutList[Index].TextOut,
4481 TextOutModeMap[Index]
4482 );
4483 if (EFI_ERROR (Status)) {
4484 ReturnStatus = Status;
4485 }
4486 }
4487
4488 //
4489 // Set mode parameter to specified mode number
4490 //
4491 TextOutSetMode (Private, ModeNumber);
4492
4493 return ReturnStatus;
4494 }
4495
4496
4497 /**
4498 Sets the background and foreground colors for the OutputString () and
4499 ClearScreen () functions.
4500
4501 @param This Protocol instance pointer.
4502 @param Attribute The attribute to set. Bits 0..3 are the
4503 foreground color, and bits 4..6 are the
4504 background color. All other bits are undefined
4505 and must be zero. The valid Attributes are
4506 defined in this file.
4507
4508 @retval EFI_SUCCESS The attribute was set.
4509 @retval EFI_DEVICE_ERROR The device had an error and could not complete
4510 the request.
4511 @retval EFI_UNSUPPORTED The attribute requested is not defined.
4512
4513 **/
4514 EFI_STATUS
4515 EFIAPI
4516 ConSplitterTextOutSetAttribute (
4517 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
4518 IN UINTN Attribute
4519 )
4520 {
4521 EFI_STATUS Status;
4522 TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;
4523 UINTN Index;
4524 EFI_STATUS ReturnStatus;
4525
4526 Private = TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This);
4527
4528 //
4529 // Check whether param Attribute is valid.
4530 //
4531 if ( (Attribute > (UINTN)(((UINT32)-1)>>1)) ) {
4532 return EFI_UNSUPPORTED;
4533 }
4534
4535 //
4536 // return the worst status met
4537 //
4538 for (Index = 0, ReturnStatus = EFI_SUCCESS; Index < Private->CurrentNumberOfConsoles; Index++) {
4539 Status = Private->TextOutList[Index].TextOut->SetAttribute (
4540 Private->TextOutList[Index].TextOut,
4541 Attribute
4542 );
4543 if (EFI_ERROR (Status)) {
4544 ReturnStatus = Status;
4545 }
4546 }
4547
4548 Private->TextOutMode.Attribute = (INT32) Attribute;
4549
4550 return ReturnStatus;
4551 }
4552
4553
4554 /**
4555 Clears the output device(s) display to the currently selected background
4556 color.
4557
4558 @param This Protocol instance pointer.
4559
4560 @retval EFI_SUCCESS The operation completed successfully.
4561 @retval EFI_DEVICE_ERROR The device had an error and could not complete
4562 the request.
4563 @retval EFI_UNSUPPORTED The output device is not in a valid text mode.
4564
4565 **/
4566 EFI_STATUS
4567 EFIAPI
4568 ConSplitterTextOutClearScreen (
4569 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This
4570 )
4571 {
4572 EFI_STATUS Status;
4573 TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;
4574 UINTN Index;
4575 EFI_STATUS ReturnStatus;
4576
4577 Private = TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This);
4578
4579 //
4580 // return the worst status met
4581 //
4582 for (Index = 0, ReturnStatus = EFI_SUCCESS; Index < Private->CurrentNumberOfConsoles; Index++) {
4583 Status = Private->TextOutList[Index].TextOut->ClearScreen (Private->TextOutList[Index].TextOut);
4584 if (EFI_ERROR (Status)) {
4585 ReturnStatus = Status;
4586 }
4587 }
4588
4589 //
4590 // No need to do extra check here as whether (Column, Row) is valid has
4591 // been checked in ConSplitterTextOutSetCursorPosition. And (0, 0) should
4592 // always be supported.
4593 //
4594 Private->TextOutMode.CursorColumn = 0;
4595 Private->TextOutMode.CursorRow = 0;
4596 Private->TextOutMode.CursorVisible = TRUE;
4597
4598 return ReturnStatus;
4599 }
4600
4601
4602 /**
4603 Sets the current coordinates of the cursor position
4604
4605 @param This Protocol instance pointer.
4606 @param Column The column position to set the cursor to. Must be
4607 greater than or equal to zero and less than the
4608 number of columns by QueryMode ().
4609 @param Row The row position to set the cursor to. Must be
4610 greater than or equal to zero and less than the
4611 number of rows by QueryMode ().
4612
4613 @retval EFI_SUCCESS The operation completed successfully.
4614 @retval EFI_DEVICE_ERROR The device had an error and could not complete
4615 the request.
4616 @retval EFI_UNSUPPORTED The output device is not in a valid text mode,
4617 or the cursor position is invalid for the
4618 current mode.
4619
4620 **/
4621 EFI_STATUS
4622 EFIAPI
4623 ConSplitterTextOutSetCursorPosition (
4624 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
4625 IN UINTN Column,
4626 IN UINTN Row
4627 )
4628 {
4629 EFI_STATUS Status;
4630 TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;
4631 UINTN Index;
4632 EFI_STATUS ReturnStatus;
4633 UINTN MaxColumn;
4634 UINTN MaxRow;
4635 INT32 *TextOutModeMap;
4636 INT32 ModeNumber;
4637 INT32 CurrentMode;
4638
4639 Private = TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This);
4640 TextOutModeMap = NULL;
4641 ModeNumber = Private->TextOutMode.Mode;
4642
4643 //
4644 // Get current MaxColumn and MaxRow from intersection map
4645 //
4646 if (Private->TextOutModeMap != NULL) {
4647 TextOutModeMap = Private->TextOutModeMap + Private->TextOutListCount * ModeNumber;
4648 CurrentMode = *TextOutModeMap;
4649 } else {
4650 CurrentMode = ModeNumber;
4651 }
4652
4653 MaxColumn = Private->TextOutQueryData[CurrentMode].Columns;
4654 MaxRow = Private->TextOutQueryData[CurrentMode].Rows;
4655
4656 if (Column >= MaxColumn || Row >= MaxRow) {
4657 return EFI_UNSUPPORTED;
4658 }
4659 //
4660 // return the worst status met
4661 //
4662 for (Index = 0, ReturnStatus = EFI_SUCCESS; Index < Private->CurrentNumberOfConsoles; Index++) {
4663 Status = Private->TextOutList[Index].TextOut->SetCursorPosition (
4664 Private->TextOutList[Index].TextOut,
4665 Column,
4666 Row
4667 );
4668 if (EFI_ERROR (Status)) {
4669 ReturnStatus = Status;
4670 }
4671 }
4672
4673 //
4674 // No need to do extra check here as whether (Column, Row) is valid has
4675 // been checked in ConSplitterTextOutSetCursorPosition. And (0, 0) should
4676 // always be supported.
4677 //
4678 Private->TextOutMode.CursorColumn = (INT32) Column;
4679 Private->TextOutMode.CursorRow = (INT32) Row;
4680
4681 return ReturnStatus;
4682 }
4683
4684
4685 /**
4686 Makes the cursor visible or invisible
4687
4688 @param This Protocol instance pointer.
4689 @param Visible If TRUE, the cursor is set to be visible. If
4690 FALSE, the cursor is set to be invisible.
4691
4692 @retval EFI_SUCCESS The operation completed successfully.
4693 @retval EFI_DEVICE_ERROR The device had an error and could not complete
4694 the request, or the device does not support
4695 changing the cursor mode.
4696 @retval EFI_UNSUPPORTED The output device is not in a valid text mode.
4697
4698 **/
4699 EFI_STATUS
4700 EFIAPI
4701 ConSplitterTextOutEnableCursor (
4702 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,
4703 IN BOOLEAN Visible
4704 )
4705 {
4706 EFI_STATUS Status;
4707 TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;
4708 UINTN Index;
4709 EFI_STATUS ReturnStatus;
4710
4711 Private = TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This);
4712
4713 //
4714 // return the worst status met
4715 //
4716 for (Index = 0, ReturnStatus = EFI_SUCCESS; Index < Private->CurrentNumberOfConsoles; Index++) {
4717 Status = Private->TextOutList[Index].TextOut->EnableCursor (
4718 Private->TextOutList[Index].TextOut,
4719 Visible
4720 );
4721 if (EFI_ERROR (Status)) {
4722 ReturnStatus = Status;
4723 }
4724 }
4725
4726 Private->TextOutMode.CursorVisible = Visible;
4727
4728 return ReturnStatus;
4729 }
4730
4731
4732 /**
4733 An empty function to pass error checking of CreateEventEx ().
4734
4735 @param Event Event whose notification function is being invoked.
4736 @param Context Pointer to the notification function's context,
4737 which is implementation-dependent.
4738
4739 **/
4740 VOID
4741 EFIAPI
4742 ConSplitterEmptyCallbackFunction (
4743 IN EFI_EVENT Event,
4744 IN VOID *Context
4745 )
4746 {
4747 }
EFI Development Kit II mirror for PVE