2 Support for Graphics output spliter.
4 Copyright (c) 2006 - 2009, Intel Corporation. <BR>
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #include "ConSplitter.h"
19 CHAR16 mCrLfString
[3] = { CHAR_CARRIAGE_RETURN
, CHAR_LINEFEED
, CHAR_NULL
};
22 Returns information for an available graphics mode that the graphics device
23 and the set of active video output devices supports.
25 @param This The EFI_GRAPHICS_OUTPUT_PROTOCOL instance.
26 @param ModeNumber The mode number to return information on.
27 @param SizeOfInfo A pointer to the size, in bytes, of the Info buffer.
28 @param Info A pointer to callee allocated buffer that returns information about ModeNumber.
30 @retval EFI_SUCCESS Mode information returned.
31 @retval EFI_BUFFER_TOO_SMALL The Info buffer was too small.
32 @retval EFI_DEVICE_ERROR A hardware error occurred trying to retrieve the video mode.
33 @retval EFI_NOT_STARTED Video display is not initialized. Call SetMode ()
34 @retval EFI_INVALID_PARAMETER One of the input args was NULL.
35 @retval EFI_OUT_OF_RESOURCES No resource available.
40 ConSpliterGraphicsOutputQueryMode (
41 IN EFI_GRAPHICS_OUTPUT_PROTOCOL
*This
,
43 OUT UINTN
*SizeOfInfo
,
44 OUT EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
**Info
47 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
49 if (This
== NULL
|| Info
== NULL
|| SizeOfInfo
== NULL
|| ModeNumber
>= This
->Mode
->MaxMode
) {
50 return EFI_INVALID_PARAMETER
;
54 // retrieve private data
56 Private
= GRAPHICS_OUTPUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
58 if (Private
->HardwareNeedsStarting
) {
59 return EFI_NOT_STARTED
;
62 *Info
= AllocatePool (sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
));
64 return EFI_OUT_OF_RESOURCES
;
67 *SizeOfInfo
= sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
);
69 CopyMem (*Info
, &Private
->GraphicsOutputModeBuffer
[ModeNumber
], *SizeOfInfo
);
76 Set the video device into the specified mode and clears the visible portions of
77 the output display to black.
79 @param This The EFI_GRAPHICS_OUTPUT_PROTOCOL instance.
80 @param ModeNumber Abstraction that defines the current video mode.
82 @retval EFI_SUCCESS The graphics mode specified by ModeNumber was selected.
83 @retval EFI_DEVICE_ERROR The device had an error and could not complete the request.
84 @retval EFI_UNSUPPORTED ModeNumber is not supported by this device.
85 @retval EFI_OUT_OF_RESOURCES No resource available.
90 ConSpliterGraphicsOutputSetMode (
91 IN EFI_GRAPHICS_OUTPUT_PROTOCOL
* This
,
96 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
98 EFI_STATUS ReturnStatus
;
99 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*Mode
;
100 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
103 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*Info
;
104 EFI_UGA_DRAW_PROTOCOL
*UgaDraw
;
106 if (ModeNumber
>= This
->Mode
->MaxMode
) {
107 return EFI_UNSUPPORTED
;
110 if (ModeNumber
== This
->Mode
->Mode
) {
114 Private
= GRAPHICS_OUTPUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
115 Mode
= &Private
->GraphicsOutputModeBuffer
[ModeNumber
];
117 ReturnStatus
= EFI_SUCCESS
;
119 // return the worst status met
121 for (Index
= 0; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
122 GraphicsOutput
= Private
->TextOutList
[Index
].GraphicsOutput
;
123 if (GraphicsOutput
!= NULL
) {
125 // Find corresponding ModeNumber of this GraphicsOutput instance
127 for (NumberIndex
= 0; NumberIndex
< GraphicsOutput
->Mode
->MaxMode
; NumberIndex
++) {
128 Status
= GraphicsOutput
->QueryMode (GraphicsOutput
, (UINT32
) NumberIndex
, &SizeOfInfo
, &Info
);
129 if (EFI_ERROR (Status
)) {
132 if ((Info
->HorizontalResolution
== Mode
->HorizontalResolution
) && (Info
->VerticalResolution
== Mode
->VerticalResolution
)) {
139 Status
= GraphicsOutput
->SetMode (GraphicsOutput
, (UINT32
) NumberIndex
);
140 if (EFI_ERROR (Status
)) {
141 ReturnStatus
= Status
;
143 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
144 UgaDraw
= Private
->TextOutList
[Index
].UgaDraw
;
145 if (UgaDraw
!= NULL
) {
146 Status
= UgaDraw
->SetMode (
148 Mode
->HorizontalResolution
,
149 Mode
->VerticalResolution
,
153 if (EFI_ERROR (Status
)) {
154 ReturnStatus
= Status
;
160 This
->Mode
->Mode
= ModeNumber
;
162 CopyMem (This
->Mode
->Info
, &Private
->GraphicsOutputModeBuffer
[ModeNumber
], This
->Mode
->SizeOfInfo
);
165 // Information is not enough here, so the following items remain unchanged:
166 // GraphicsOutputMode->Info->Version, GraphicsOutputMode->Info->PixelFormat
167 // GraphicsOutputMode->SizeOfInfo, GraphicsOutputMode->FrameBufferBase, GraphicsOutputMode->FrameBufferSize
168 // These items will be initialized/updated when a new GOP device is added into ConsoleSplitter.
171 Private
->HardwareNeedsStarting
= FALSE
;
179 The following table defines actions for BltOperations.
181 EfiBltVideoFill - Write data from the BltBuffer pixel (SourceX, SourceY)
182 directly to every pixel of the video display rectangle
183 (DestinationX, DestinationY)
184 (DestinationX + Width, DestinationY + Height).
185 Only one pixel will be used from the BltBuffer. Delta is NOT used.
186 EfiBltVideoToBltBuffer - Read data from the video display rectangle
187 (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in
188 the BltBuffer rectangle (DestinationX, DestinationY )
189 (DestinationX + Width, DestinationY + Height). If DestinationX or
190 DestinationY is not zero then Delta must be set to the length in bytes
191 of a row in the BltBuffer.
192 EfiBltBufferToVideo - Write data from the BltBuffer rectangle
193 (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the
194 video display rectangle (DestinationX, DestinationY)
195 (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is
196 not zero then Delta must be set to the length in bytes of a row in the
198 EfiBltVideoToVideo - Copy from the video display rectangle
199 (SourceX, SourceY) (SourceX + Width, SourceY + Height) .
200 to the video display rectangle (DestinationX, DestinationY)
201 (DestinationX + Width, DestinationY + Height).
202 The BltBuffer and Delta are not used in this mode.
204 @param This Protocol instance pointer.
205 @param BltBuffer Buffer containing data to blit into video buffer.
206 This buffer has a size of
207 Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL)
208 @param BltOperation Operation to perform on BlitBuffer and video
210 @param SourceX X coordinate of source for the BltBuffer.
211 @param SourceY Y coordinate of source for the BltBuffer.
212 @param DestinationX X coordinate of destination for the BltBuffer.
213 @param DestinationY Y coordinate of destination for the BltBuffer.
214 @param Width Width of rectangle in BltBuffer in pixels.
215 @param Height Hight of rectangle in BltBuffer in pixels.
216 @param Delta OPTIONAL.
218 @retval EFI_SUCCESS The Blt operation completed.
219 @retval EFI_INVALID_PARAMETER BltOperation is not valid.
220 @retval EFI_DEVICE_ERROR A hardware error occured writting to the video
226 ConSpliterGraphicsOutputBlt (
227 IN EFI_GRAPHICS_OUTPUT_PROTOCOL
*This
,
228 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*BltBuffer
, OPTIONAL
229 IN EFI_GRAPHICS_OUTPUT_BLT_OPERATION BltOperation
,
232 IN UINTN DestinationX
,
233 IN UINTN DestinationY
,
236 IN UINTN Delta OPTIONAL
240 EFI_STATUS ReturnStatus
= EFI_DEVICE_ERROR
;
241 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
243 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
244 EFI_UGA_DRAW_PROTOCOL
*UgaDraw
;
246 Private
= GRAPHICS_OUTPUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
249 // return the worst status met
251 for (Index
= 0; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
252 GraphicsOutput
= Private
->TextOutList
[Index
].GraphicsOutput
;
253 if (GraphicsOutput
!= NULL
) {
254 Status
= GraphicsOutput
->Blt (
266 if (EFI_ERROR (Status
)) {
267 ReturnStatus
= Status
;
268 } else if (BltOperation
== EfiBltVideoToBltBuffer
) {
270 // Only need to read the data into buffer one time
276 UgaDraw
= Private
->TextOutList
[Index
].UgaDraw
;
277 if (UgaDraw
!= NULL
&& FeaturePcdGet (PcdUgaConsumeSupport
)) {
278 Status
= UgaDraw
->Blt (
280 (EFI_UGA_PIXEL
*) BltBuffer
,
281 (EFI_UGA_BLT_OPERATION
) BltOperation
,
290 if (EFI_ERROR (Status
)) {
291 ReturnStatus
= Status
;
292 } else if (BltOperation
== EfiBltVideoToBltBuffer
) {
294 // Only need to read the data into buffer one time
305 Return the current video mode information.
307 @param This The EFI_UGA_DRAW_PROTOCOL instance.
308 @param HorizontalResolution The size of video screen in pixels in the X dimension.
309 @param VerticalResolution The size of video screen in pixels in the Y dimension.
310 @param ColorDepth Number of bits per pixel, currently defined to be 32.
311 @param RefreshRate The refresh rate of the monitor in Hertz.
313 @retval EFI_SUCCESS Mode information returned.
314 @retval EFI_NOT_STARTED Video display is not initialized. Call SetMode ()
315 @retval EFI_INVALID_PARAMETER One of the input args was NULL.
320 ConSpliterUgaDrawGetMode (
321 IN EFI_UGA_DRAW_PROTOCOL
*This
,
322 OUT UINT32
*HorizontalResolution
,
323 OUT UINT32
*VerticalResolution
,
324 OUT UINT32
*ColorDepth
,
325 OUT UINT32
*RefreshRate
328 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
330 if ((HorizontalResolution
== NULL
) ||
331 (VerticalResolution
== NULL
) ||
332 (RefreshRate
== NULL
) ||
333 (ColorDepth
== NULL
)) {
334 return EFI_INVALID_PARAMETER
;
337 // retrieve private data
339 Private
= UGA_DRAW_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
341 *HorizontalResolution
= Private
->UgaHorizontalResolution
;
342 *VerticalResolution
= Private
->UgaVerticalResolution
;
343 *ColorDepth
= Private
->UgaColorDepth
;
344 *RefreshRate
= Private
->UgaRefreshRate
;
351 Set the current video mode information.
353 @param This The EFI_UGA_DRAW_PROTOCOL instance.
354 @param HorizontalResolution The size of video screen in pixels in the X dimension.
355 @param VerticalResolution The size of video screen in pixels in the Y dimension.
356 @param ColorDepth Number of bits per pixel, currently defined to be 32.
357 @param RefreshRate The refresh rate of the monitor in Hertz.
359 @retval EFI_SUCCESS Mode information returned.
360 @retval EFI_NOT_STARTED Video display is not initialized. Call SetMode ()
361 @retval EFI_OUT_OF_RESOURCES Out of resources.
366 ConSpliterUgaDrawSetMode (
367 IN EFI_UGA_DRAW_PROTOCOL
*This
,
368 IN UINT32 HorizontalResolution
,
369 IN UINT32 VerticalResolution
,
370 IN UINT32 ColorDepth
,
371 IN UINT32 RefreshRate
375 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
377 EFI_STATUS ReturnStatus
;
378 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
381 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*Info
;
382 EFI_UGA_DRAW_PROTOCOL
*UgaDraw
;
384 Private
= UGA_DRAW_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
386 ReturnStatus
= EFI_SUCCESS
;
389 // Update the Mode data
391 Private
->UgaHorizontalResolution
= HorizontalResolution
;
392 Private
->UgaVerticalResolution
= VerticalResolution
;
393 Private
->UgaColorDepth
= ColorDepth
;
394 Private
->UgaRefreshRate
= RefreshRate
;
397 // return the worst status met
399 for (Index
= 0; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
401 GraphicsOutput
= Private
->TextOutList
[Index
].GraphicsOutput
;
402 if (GraphicsOutput
!= NULL
) {
404 // Find corresponding ModeNumber of this GraphicsOutput instance
406 for (NumberIndex
= 0; NumberIndex
< GraphicsOutput
->Mode
->MaxMode
; NumberIndex
++) {
407 Status
= GraphicsOutput
->QueryMode (GraphicsOutput
, (UINT32
) NumberIndex
, &SizeOfInfo
, &Info
);
408 if (EFI_ERROR (Status
)) {
411 if ((Info
->HorizontalResolution
== HorizontalResolution
) && (Info
->VerticalResolution
== VerticalResolution
)) {
418 Status
= GraphicsOutput
->SetMode (GraphicsOutput
, (UINT32
) NumberIndex
);
419 if (EFI_ERROR (Status
)) {
420 ReturnStatus
= Status
;
422 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)){
423 UgaDraw
= Private
->TextOutList
[Index
].UgaDraw
;
424 if (UgaDraw
!= NULL
) {
425 Status
= UgaDraw
->SetMode (
427 HorizontalResolution
,
432 if (EFI_ERROR (Status
)) {
433 ReturnStatus
= Status
;
444 Blt a rectangle of pixels on the graphics screen.
446 The following table defines actions for BltOperations.
449 Write data from the BltBuffer pixel (SourceX, SourceY)
450 directly to every pixel of the video display rectangle
451 (DestinationX, DestinationY)
452 (DestinationX + Width, DestinationY + Height).
453 Only one pixel will be used from the BltBuffer. Delta is NOT used.
454 EfiUgaVideoToBltBuffer:
455 Read data from the video display rectangle
456 (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in
457 the BltBuffer rectangle (DestinationX, DestinationY )
458 (DestinationX + Width, DestinationY + Height). If DestinationX or
459 DestinationY is not zero then Delta must be set to the length in bytes
460 of a row in the BltBuffer.
461 EfiUgaBltBufferToVideo:
462 Write data from the BltBuffer rectangle
463 (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the
464 video display rectangle (DestinationX, DestinationY)
465 (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is
466 not zero then Delta must be set to the length in bytes of a row in the
469 Copy from the video display rectangle
470 (SourceX, SourceY) (SourceX + Width, SourceY + Height) .
471 to the video display rectangle (DestinationX, DestinationY)
472 (DestinationX + Width, DestinationY + Height).
473 The BltBuffer and Delta are not used in this mode.
475 @param This Protocol instance pointer.
476 @param BltBuffer Buffer containing data to blit into video buffer. This
477 buffer has a size of Width*Height*sizeof(EFI_UGA_PIXEL)
478 @param BltOperation Operation to perform on BlitBuffer and video memory
479 @param SourceX X coordinate of source for the BltBuffer.
480 @param SourceY Y coordinate of source for the BltBuffer.
481 @param DestinationX X coordinate of destination for the BltBuffer.
482 @param DestinationY Y coordinate of destination for the BltBuffer.
483 @param Width Width of rectangle in BltBuffer in pixels.
484 @param Height Hight of rectangle in BltBuffer in pixels.
485 @param Delta OPTIONAL
487 @retval EFI_SUCCESS The Blt operation completed.
488 @retval EFI_INVALID_PARAMETER BltOperation is not valid.
489 @retval EFI_DEVICE_ERROR A hardware error occured writting to the video buffer.
494 ConSpliterUgaDrawBlt (
495 IN EFI_UGA_DRAW_PROTOCOL
*This
,
496 IN EFI_UGA_PIXEL
*BltBuffer
, OPTIONAL
497 IN EFI_UGA_BLT_OPERATION BltOperation
,
500 IN UINTN DestinationX
,
501 IN UINTN DestinationY
,
504 IN UINTN Delta OPTIONAL
508 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
510 EFI_STATUS ReturnStatus
;
511 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
513 Private
= UGA_DRAW_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
515 ReturnStatus
= EFI_SUCCESS
;
517 // return the worst status met
519 for (Index
= 0; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
520 GraphicsOutput
= Private
->TextOutList
[Index
].GraphicsOutput
;
521 if (GraphicsOutput
!= NULL
) {
522 Status
= GraphicsOutput
->Blt (
524 (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*) BltBuffer
,
525 (EFI_GRAPHICS_OUTPUT_BLT_OPERATION
) BltOperation
,
534 if (EFI_ERROR (Status
)) {
535 ReturnStatus
= Status
;
536 } else if (BltOperation
== EfiBltVideoToBltBuffer
) {
538 // Only need to read the data into buffer one time
544 if (Private
->TextOutList
[Index
].UgaDraw
!= NULL
&& FeaturePcdGet (PcdUgaConsumeSupport
)) {
545 Status
= Private
->TextOutList
[Index
].UgaDraw
->Blt (
546 Private
->TextOutList
[Index
].UgaDraw
,
557 if (EFI_ERROR (Status
)) {
558 ReturnStatus
= Status
;
559 } else if (BltOperation
== EfiUgaVideoToBltBuffer
) {
561 // Only need to read the data into buffer one time
572 Sets the output device(s) to a specified mode.
574 @param Private Text Out Splitter pointer.
575 @param ModeNumber The mode number to set.
580 IN TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
,
585 // No need to do extra check here as whether (Column, Row) is valid has
586 // been checked in ConSplitterTextOutSetCursorPosition. And (0, 0) should
587 // always be supported.
589 Private
->TextOutMode
.Mode
= (INT32
) ModeNumber
;
590 Private
->TextOutMode
.CursorColumn
= 0;
591 Private
->TextOutMode
.CursorRow
= 0;
592 Private
->TextOutMode
.CursorVisible
= TRUE
;