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 ConSplitterGraphicsOutputQueryMode (
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 ConSplitterGraphicsOutputSetMode (
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 Private
= GRAPHICS_OUTPUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
111 Mode
= &Private
->GraphicsOutputModeBuffer
[ModeNumber
];
113 ReturnStatus
= EFI_SUCCESS
;
115 // return the worst status met
117 for (Index
= 0; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
118 GraphicsOutput
= Private
->TextOutList
[Index
].GraphicsOutput
;
119 if (GraphicsOutput
!= NULL
) {
121 // Find corresponding ModeNumber of this GraphicsOutput instance
123 for (NumberIndex
= 0; NumberIndex
< GraphicsOutput
->Mode
->MaxMode
; NumberIndex
++) {
124 Status
= GraphicsOutput
->QueryMode (GraphicsOutput
, (UINT32
) NumberIndex
, &SizeOfInfo
, &Info
);
125 if (EFI_ERROR (Status
)) {
128 if ((Info
->HorizontalResolution
== Mode
->HorizontalResolution
) && (Info
->VerticalResolution
== Mode
->VerticalResolution
)) {
135 Status
= GraphicsOutput
->SetMode (GraphicsOutput
, (UINT32
) NumberIndex
);
136 if (EFI_ERROR (Status
)) {
137 ReturnStatus
= Status
;
139 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
140 UgaDraw
= Private
->TextOutList
[Index
].UgaDraw
;
141 if (UgaDraw
!= NULL
) {
142 Status
= UgaDraw
->SetMode (
144 Mode
->HorizontalResolution
,
145 Mode
->VerticalResolution
,
149 if (EFI_ERROR (Status
)) {
150 ReturnStatus
= Status
;
156 This
->Mode
->Mode
= ModeNumber
;
158 CopyMem (This
->Mode
->Info
, &Private
->GraphicsOutputModeBuffer
[ModeNumber
], This
->Mode
->SizeOfInfo
);
161 // Information is not enough here, so the following items remain unchanged:
162 // GraphicsOutputMode->Info->Version, GraphicsOutputMode->Info->PixelFormat
163 // GraphicsOutputMode->SizeOfInfo, GraphicsOutputMode->FrameBufferBase, GraphicsOutputMode->FrameBufferSize
164 // These items will be initialized/updated when a new GOP device is added into ConsoleSplitter.
167 Private
->HardwareNeedsStarting
= FALSE
;
175 The following table defines actions for BltOperations.
177 EfiBltVideoFill - Write data from the BltBuffer pixel (SourceX, SourceY)
178 directly to every pixel of the video display rectangle
179 (DestinationX, DestinationY)
180 (DestinationX + Width, DestinationY + Height).
181 Only one pixel will be used from the BltBuffer. Delta is NOT used.
182 EfiBltVideoToBltBuffer - Read data from the video display rectangle
183 (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in
184 the BltBuffer rectangle (DestinationX, DestinationY )
185 (DestinationX + Width, DestinationY + Height). If DestinationX or
186 DestinationY is not zero then Delta must be set to the length in bytes
187 of a row in the BltBuffer.
188 EfiBltBufferToVideo - Write data from the BltBuffer rectangle
189 (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the
190 video display rectangle (DestinationX, DestinationY)
191 (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is
192 not zero then Delta must be set to the length in bytes of a row in the
194 EfiBltVideoToVideo - Copy from the video display rectangle
195 (SourceX, SourceY) (SourceX + Width, SourceY + Height) .
196 to the video display rectangle (DestinationX, DestinationY)
197 (DestinationX + Width, DestinationY + Height).
198 The BltBuffer and Delta are not used in this mode.
200 @param This Protocol instance pointer.
201 @param BltBuffer Buffer containing data to blit into video buffer.
202 This buffer has a size of
203 Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL)
204 @param BltOperation Operation to perform on BlitBuffer and video
206 @param SourceX X coordinate of source for the BltBuffer.
207 @param SourceY Y coordinate of source for the BltBuffer.
208 @param DestinationX X coordinate of destination for the BltBuffer.
209 @param DestinationY Y coordinate of destination for the BltBuffer.
210 @param Width Width of rectangle in BltBuffer in pixels.
211 @param Height Hight of rectangle in BltBuffer in pixels.
212 @param Delta OPTIONAL.
214 @retval EFI_SUCCESS The Blt operation completed.
215 @retval EFI_INVALID_PARAMETER BltOperation is not valid.
216 @retval EFI_DEVICE_ERROR A hardware error occured writting to the video
222 ConSplitterGraphicsOutputBlt (
223 IN EFI_GRAPHICS_OUTPUT_PROTOCOL
*This
,
224 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*BltBuffer
, OPTIONAL
225 IN EFI_GRAPHICS_OUTPUT_BLT_OPERATION BltOperation
,
228 IN UINTN DestinationX
,
229 IN UINTN DestinationY
,
232 IN UINTN Delta OPTIONAL
236 EFI_STATUS ReturnStatus
;
237 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
239 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
240 EFI_UGA_DRAW_PROTOCOL
*UgaDraw
;
242 Private
= GRAPHICS_OUTPUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
244 ReturnStatus
= EFI_SUCCESS
;
247 // return the worst status met
249 for (Index
= 0; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
250 GraphicsOutput
= Private
->TextOutList
[Index
].GraphicsOutput
;
251 if (GraphicsOutput
!= NULL
) {
252 Status
= GraphicsOutput
->Blt (
264 if (EFI_ERROR (Status
)) {
265 ReturnStatus
= Status
;
266 } else if (BltOperation
== EfiBltVideoToBltBuffer
) {
268 // Only need to read the data into buffer one time
274 UgaDraw
= Private
->TextOutList
[Index
].UgaDraw
;
275 if (UgaDraw
!= NULL
&& FeaturePcdGet (PcdUgaConsumeSupport
)) {
276 Status
= UgaDraw
->Blt (
278 (EFI_UGA_PIXEL
*) BltBuffer
,
279 (EFI_UGA_BLT_OPERATION
) BltOperation
,
288 if (EFI_ERROR (Status
)) {
289 ReturnStatus
= Status
;
290 } else if (BltOperation
== EfiBltVideoToBltBuffer
) {
292 // Only need to read the data into buffer one time
303 Return the current video mode information.
305 @param This The EFI_UGA_DRAW_PROTOCOL instance.
306 @param HorizontalResolution The size of video screen in pixels in the X dimension.
307 @param VerticalResolution The size of video screen in pixels in the Y dimension.
308 @param ColorDepth Number of bits per pixel, currently defined to be 32.
309 @param RefreshRate The refresh rate of the monitor in Hertz.
311 @retval EFI_SUCCESS Mode information returned.
312 @retval EFI_NOT_STARTED Video display is not initialized. Call SetMode ()
313 @retval EFI_INVALID_PARAMETER One of the input args was NULL.
318 ConSplitterUgaDrawGetMode (
319 IN EFI_UGA_DRAW_PROTOCOL
*This
,
320 OUT UINT32
*HorizontalResolution
,
321 OUT UINT32
*VerticalResolution
,
322 OUT UINT32
*ColorDepth
,
323 OUT UINT32
*RefreshRate
326 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
328 if ((HorizontalResolution
== NULL
) ||
329 (VerticalResolution
== NULL
) ||
330 (RefreshRate
== NULL
) ||
331 (ColorDepth
== NULL
)) {
332 return EFI_INVALID_PARAMETER
;
335 // retrieve private data
337 Private
= UGA_DRAW_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
339 *HorizontalResolution
= Private
->UgaHorizontalResolution
;
340 *VerticalResolution
= Private
->UgaVerticalResolution
;
341 *ColorDepth
= Private
->UgaColorDepth
;
342 *RefreshRate
= Private
->UgaRefreshRate
;
349 Set the current video mode information.
351 @param This The EFI_UGA_DRAW_PROTOCOL instance.
352 @param HorizontalResolution The size of video screen in pixels in the X dimension.
353 @param VerticalResolution The size of video screen in pixels in the Y dimension.
354 @param ColorDepth Number of bits per pixel, currently defined to be 32.
355 @param RefreshRate The refresh rate of the monitor in Hertz.
357 @retval EFI_SUCCESS Mode information returned.
358 @retval EFI_NOT_STARTED Video display is not initialized. Call SetMode ()
359 @retval EFI_OUT_OF_RESOURCES Out of resources.
364 ConSplitterUgaDrawSetMode (
365 IN EFI_UGA_DRAW_PROTOCOL
*This
,
366 IN UINT32 HorizontalResolution
,
367 IN UINT32 VerticalResolution
,
368 IN UINT32 ColorDepth
,
369 IN UINT32 RefreshRate
373 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
375 EFI_STATUS ReturnStatus
;
376 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
379 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*Info
;
380 EFI_UGA_DRAW_PROTOCOL
*UgaDraw
;
382 Private
= UGA_DRAW_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
384 ReturnStatus
= EFI_SUCCESS
;
387 // Update the Mode data
389 Private
->UgaHorizontalResolution
= HorizontalResolution
;
390 Private
->UgaVerticalResolution
= VerticalResolution
;
391 Private
->UgaColorDepth
= ColorDepth
;
392 Private
->UgaRefreshRate
= RefreshRate
;
395 // return the worst status met
397 for (Index
= 0; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
399 GraphicsOutput
= Private
->TextOutList
[Index
].GraphicsOutput
;
400 if (GraphicsOutput
!= NULL
) {
402 // Find corresponding ModeNumber of this GraphicsOutput instance
404 for (NumberIndex
= 0; NumberIndex
< GraphicsOutput
->Mode
->MaxMode
; NumberIndex
++) {
405 Status
= GraphicsOutput
->QueryMode (GraphicsOutput
, (UINT32
) NumberIndex
, &SizeOfInfo
, &Info
);
406 if (EFI_ERROR (Status
)) {
409 if ((Info
->HorizontalResolution
== HorizontalResolution
) && (Info
->VerticalResolution
== VerticalResolution
)) {
416 Status
= GraphicsOutput
->SetMode (GraphicsOutput
, (UINT32
) NumberIndex
);
417 if (EFI_ERROR (Status
)) {
418 ReturnStatus
= Status
;
420 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)){
421 UgaDraw
= Private
->TextOutList
[Index
].UgaDraw
;
422 if (UgaDraw
!= NULL
) {
423 Status
= UgaDraw
->SetMode (
425 HorizontalResolution
,
430 if (EFI_ERROR (Status
)) {
431 ReturnStatus
= Status
;
442 Blt a rectangle of pixels on the graphics screen.
444 The following table defines actions for BltOperations.
447 Write data from the BltBuffer pixel (SourceX, SourceY)
448 directly to every pixel of the video display rectangle
449 (DestinationX, DestinationY)
450 (DestinationX + Width, DestinationY + Height).
451 Only one pixel will be used from the BltBuffer. Delta is NOT used.
452 EfiUgaVideoToBltBuffer:
453 Read data from the video display rectangle
454 (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in
455 the BltBuffer rectangle (DestinationX, DestinationY )
456 (DestinationX + Width, DestinationY + Height). If DestinationX or
457 DestinationY is not zero then Delta must be set to the length in bytes
458 of a row in the BltBuffer.
459 EfiUgaBltBufferToVideo:
460 Write data from the BltBuffer rectangle
461 (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the
462 video display rectangle (DestinationX, DestinationY)
463 (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is
464 not zero then Delta must be set to the length in bytes of a row in the
467 Copy from the video display rectangle
468 (SourceX, SourceY) (SourceX + Width, SourceY + Height) .
469 to the video display rectangle (DestinationX, DestinationY)
470 (DestinationX + Width, DestinationY + Height).
471 The BltBuffer and Delta are not used in this mode.
473 @param This Protocol instance pointer.
474 @param BltBuffer Buffer containing data to blit into video buffer. This
475 buffer has a size of Width*Height*sizeof(EFI_UGA_PIXEL)
476 @param BltOperation Operation to perform on BlitBuffer and video memory
477 @param SourceX X coordinate of source for the BltBuffer.
478 @param SourceY Y coordinate of source for the BltBuffer.
479 @param DestinationX X coordinate of destination for the BltBuffer.
480 @param DestinationY Y coordinate of destination for the BltBuffer.
481 @param Width Width of rectangle in BltBuffer in pixels.
482 @param Height Hight of rectangle in BltBuffer in pixels.
483 @param Delta OPTIONAL
485 @retval EFI_SUCCESS The Blt operation completed.
486 @retval EFI_INVALID_PARAMETER BltOperation is not valid.
487 @retval EFI_DEVICE_ERROR A hardware error occured writting to the video buffer.
492 ConSplitterUgaDrawBlt (
493 IN EFI_UGA_DRAW_PROTOCOL
*This
,
494 IN EFI_UGA_PIXEL
*BltBuffer
, OPTIONAL
495 IN EFI_UGA_BLT_OPERATION BltOperation
,
498 IN UINTN DestinationX
,
499 IN UINTN DestinationY
,
502 IN UINTN Delta OPTIONAL
506 TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
;
508 EFI_STATUS ReturnStatus
;
509 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
511 Private
= UGA_DRAW_SPLITTER_PRIVATE_DATA_FROM_THIS (This
);
513 ReturnStatus
= EFI_SUCCESS
;
515 // return the worst status met
517 for (Index
= 0; Index
< Private
->CurrentNumberOfConsoles
; Index
++) {
518 GraphicsOutput
= Private
->TextOutList
[Index
].GraphicsOutput
;
519 if (GraphicsOutput
!= NULL
) {
520 Status
= GraphicsOutput
->Blt (
522 (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*) BltBuffer
,
523 (EFI_GRAPHICS_OUTPUT_BLT_OPERATION
) BltOperation
,
532 if (EFI_ERROR (Status
)) {
533 ReturnStatus
= Status
;
534 } else if (BltOperation
== EfiBltVideoToBltBuffer
) {
536 // Only need to read the data into buffer one time
542 if (Private
->TextOutList
[Index
].UgaDraw
!= NULL
&& FeaturePcdGet (PcdUgaConsumeSupport
)) {
543 Status
= Private
->TextOutList
[Index
].UgaDraw
->Blt (
544 Private
->TextOutList
[Index
].UgaDraw
,
555 if (EFI_ERROR (Status
)) {
556 ReturnStatus
= Status
;
557 } else if (BltOperation
== EfiUgaVideoToBltBuffer
) {
559 // Only need to read the data into buffer one time
570 Sets the output device(s) to a specified mode.
572 @param Private Text Out Splitter pointer.
573 @param ModeNumber The mode number to set.
578 IN TEXT_OUT_SPLITTER_PRIVATE_DATA
*Private
,
583 // No need to do extra check here as whether (Column, Row) is valid has
584 // been checked in ConSplitterTextOutSetCursorPosition. And (0, 0) should
585 // always be supported.
587 Private
->TextOutMode
.Mode
= (INT32
) ModeNumber
;
588 Private
->TextOutMode
.CursorColumn
= 0;
589 Private
->TextOutMode
.CursorRow
= 0;
590 Private
->TextOutMode
.CursorVisible
= TRUE
;