?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
1. updated return value to EFI_SUCCESS by default.
[edk2.git] / MdeModulePkg / Universal / Console / ConSplitterDxe / ConSplitterGraphics.c
blob452f7a9c5982d3590331c6ff08c45876eff8e2ad
1 /** @file
2 Support for Graphics output spliter.
3
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
9
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.
12
13
14 **/
15
16 #include "ConSplitter.h"
17
18
19 CHAR16 mCrLfString[3] = { CHAR_CARRIAGE_RETURN, CHAR_LINEFEED, CHAR_NULL };
20
21 /**
22 Returns information for an available graphics mode that the graphics device
23 and the set of active video output devices supports.
24
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.
29
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.
36
37 **/
38 EFI_STATUS
39 EFIAPI
40 ConSpliterGraphicsOutputQueryMode (
41 IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,
42 IN UINT32 ModeNumber,
43 OUT UINTN *SizeOfInfo,
44 OUT EFI_GRAPHICS_OUTPUT_MODE_INFORMATION **Info
45 )
46 {
47 TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;
48
49 if (This == NULL || Info == NULL || SizeOfInfo == NULL || ModeNumber >= This->Mode->MaxMode) {
50 return EFI_INVALID_PARAMETER;
51 }
52
53 //
54 // retrieve private data
55 //
56 Private = GRAPHICS_OUTPUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This);
57
58 if (Private->HardwareNeedsStarting) {
59 return EFI_NOT_STARTED;
60 }
61
62 *Info = AllocatePool (sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION));
63 if (*Info == NULL) {
64 return EFI_OUT_OF_RESOURCES;
65 }
66
67 *SizeOfInfo = sizeof (EFI_GRAPHICS_OUTPUT_MODE_INFORMATION);
68
69 CopyMem (*Info, &Private->GraphicsOutputModeBuffer[ModeNumber], *SizeOfInfo);
70
71 return EFI_SUCCESS;
72 }
73
74
75 /**
76 Set the video device into the specified mode and clears the visible portions of
77 the output display to black.
78
79 @param This The EFI_GRAPHICS_OUTPUT_PROTOCOL instance.
80 @param ModeNumber Abstraction that defines the current video mode.
81
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.
86
87 **/
88 EFI_STATUS
89 EFIAPI
90 ConSpliterGraphicsOutputSetMode (
91 IN EFI_GRAPHICS_OUTPUT_PROTOCOL * This,
92 IN UINT32 ModeNumber
93 )
94 {
95 EFI_STATUS Status;
96 TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;
97 UINTN Index;
98 EFI_STATUS ReturnStatus;
99 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *Mode;
100 EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput;
101 UINTN NumberIndex;
102 UINTN SizeOfInfo;
103 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *Info;
104 EFI_UGA_DRAW_PROTOCOL *UgaDraw;
105
106 if (ModeNumber >= This->Mode->MaxMode) {
107 return EFI_UNSUPPORTED;
108 }
109
110 if (ModeNumber == This->Mode->Mode) {
111 return EFI_SUCCESS;
112 }
113
114 Private = GRAPHICS_OUTPUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This);
115 Mode = &Private->GraphicsOutputModeBuffer[ModeNumber];
116
117 ReturnStatus = EFI_SUCCESS;
118 //
119 // return the worst status met
120 //
121 for (Index = 0; Index < Private->CurrentNumberOfConsoles; Index++) {
122 GraphicsOutput = Private->TextOutList[Index].GraphicsOutput;
123 if (GraphicsOutput != NULL) {
124 //
125 // Find corresponding ModeNumber of this GraphicsOutput instance
126 //
127 for (NumberIndex = 0; NumberIndex < GraphicsOutput->Mode->MaxMode; NumberIndex ++) {
128 Status = GraphicsOutput->QueryMode (GraphicsOutput, (UINT32) NumberIndex, &SizeOfInfo, &Info);
129 if (EFI_ERROR (Status)) {
130 return Status;
131 }
132 if ((Info->HorizontalResolution == Mode->HorizontalResolution) && (Info->VerticalResolution == Mode->VerticalResolution)) {
133 FreePool (Info);
134 break;
135 }
136 FreePool (Info);
137 }
138
139 Status = GraphicsOutput->SetMode (GraphicsOutput, (UINT32) NumberIndex);
140 if (EFI_ERROR (Status)) {
141 ReturnStatus = Status;
142 }
143 } else if (FeaturePcdGet (PcdUgaConsumeSupport)) {
144 UgaDraw = Private->TextOutList[Index].UgaDraw;
145 if (UgaDraw != NULL) {
146 Status = UgaDraw->SetMode (
147 UgaDraw,
148 Mode->HorizontalResolution,
149 Mode->VerticalResolution,
150 32,
151 60
152 );
153 if (EFI_ERROR (Status)) {
154 ReturnStatus = Status;
155 }
156 }
157 }
158 }
159
160 This->Mode->Mode = ModeNumber;
161
162 CopyMem (This->Mode->Info, &Private->GraphicsOutputModeBuffer[ModeNumber], This->Mode->SizeOfInfo);
163
164 //
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.
169 //
170
171 Private->HardwareNeedsStarting = FALSE;
172
173 return ReturnStatus;
174 }
175
176
177
178 /**
179 The following table defines actions for BltOperations.
180
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
197 BltBuffer.
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.
203
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
209 memory
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.
217
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
221 buffer.
222
223 **/
224 EFI_STATUS
225 EFIAPI
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,
230 IN UINTN SourceX,
231 IN UINTN SourceY,
232 IN UINTN DestinationX,
233 IN UINTN DestinationY,
234 IN UINTN Width,
235 IN UINTN Height,
236 IN UINTN Delta OPTIONAL
237 )
238 {
239 EFI_STATUS Status;
240 EFI_STATUS ReturnStatus;
241 TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;
242 UINTN Index;
243 EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput;
244 EFI_UGA_DRAW_PROTOCOL *UgaDraw;
245
246 Private = GRAPHICS_OUTPUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This);
247
248 ReturnStatus = EFI_SUCCESS;
249
250 //
251 // return the worst status met
252 //
253 for (Index = 0; Index < Private->CurrentNumberOfConsoles; Index++) {
254 GraphicsOutput = Private->TextOutList[Index].GraphicsOutput;
255 if (GraphicsOutput != NULL) {
256 Status = GraphicsOutput->Blt (
257 GraphicsOutput,
258 BltBuffer,
259 BltOperation,
260 SourceX,
261 SourceY,
262 DestinationX,
263 DestinationY,
264 Width,
265 Height,
266 Delta
267 );
268 if (EFI_ERROR (Status)) {
269 ReturnStatus = Status;
270 } else if (BltOperation == EfiBltVideoToBltBuffer) {
271 //
272 // Only need to read the data into buffer one time
273 //
274 return EFI_SUCCESS;
275 }
276 }
277
278 UgaDraw = Private->TextOutList[Index].UgaDraw;
279 if (UgaDraw != NULL && FeaturePcdGet (PcdUgaConsumeSupport)) {
280 Status = UgaDraw->Blt (
281 UgaDraw,
282 (EFI_UGA_PIXEL *) BltBuffer,
283 (EFI_UGA_BLT_OPERATION) BltOperation,
284 SourceX,
285 SourceY,
286 DestinationX,
287 DestinationY,
288 Width,
289 Height,
290 Delta
291 );
292 if (EFI_ERROR (Status)) {
293 ReturnStatus = Status;
294 } else if (BltOperation == EfiBltVideoToBltBuffer) {
295 //
296 // Only need to read the data into buffer one time
297 //
298 return EFI_SUCCESS;
299 }
300 }
301 }
302
303 return ReturnStatus;
304 }
305
306 /**
307 Return the current video mode information.
308
309 @param This The EFI_UGA_DRAW_PROTOCOL instance.
310 @param HorizontalResolution The size of video screen in pixels in the X dimension.
311 @param VerticalResolution The size of video screen in pixels in the Y dimension.
312 @param ColorDepth Number of bits per pixel, currently defined to be 32.
313 @param RefreshRate The refresh rate of the monitor in Hertz.
314
315 @retval EFI_SUCCESS Mode information returned.
316 @retval EFI_NOT_STARTED Video display is not initialized. Call SetMode ()
317 @retval EFI_INVALID_PARAMETER One of the input args was NULL.
318
319 **/
320 EFI_STATUS
321 EFIAPI
322 ConSpliterUgaDrawGetMode (
323 IN EFI_UGA_DRAW_PROTOCOL *This,
324 OUT UINT32 *HorizontalResolution,
325 OUT UINT32 *VerticalResolution,
326 OUT UINT32 *ColorDepth,
327 OUT UINT32 *RefreshRate
328 )
329 {
330 TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;
331
332 if ((HorizontalResolution == NULL) ||
333 (VerticalResolution == NULL) ||
334 (RefreshRate == NULL) ||
335 (ColorDepth == NULL)) {
336 return EFI_INVALID_PARAMETER;
337 }
338 //
339 // retrieve private data
340 //
341 Private = UGA_DRAW_SPLITTER_PRIVATE_DATA_FROM_THIS (This);
342
343 *HorizontalResolution = Private->UgaHorizontalResolution;
344 *VerticalResolution = Private->UgaVerticalResolution;
345 *ColorDepth = Private->UgaColorDepth;
346 *RefreshRate = Private->UgaRefreshRate;
347
348 return EFI_SUCCESS;
349 }
350
351
352 /**
353 Set the current video mode information.
354
355 @param This The EFI_UGA_DRAW_PROTOCOL instance.
356 @param HorizontalResolution The size of video screen in pixels in the X dimension.
357 @param VerticalResolution The size of video screen in pixels in the Y dimension.
358 @param ColorDepth Number of bits per pixel, currently defined to be 32.
359 @param RefreshRate The refresh rate of the monitor in Hertz.
360
361 @retval EFI_SUCCESS Mode information returned.
362 @retval EFI_NOT_STARTED Video display is not initialized. Call SetMode ()
363 @retval EFI_OUT_OF_RESOURCES Out of resources.
364
365 **/
366 EFI_STATUS
367 EFIAPI
368 ConSpliterUgaDrawSetMode (
369 IN EFI_UGA_DRAW_PROTOCOL *This,
370 IN UINT32 HorizontalResolution,
371 IN UINT32 VerticalResolution,
372 IN UINT32 ColorDepth,
373 IN UINT32 RefreshRate
374 )
375 {
376 EFI_STATUS Status;
377 TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;
378 UINTN Index;
379 EFI_STATUS ReturnStatus;
380 EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput;
381 UINTN NumberIndex;
382 UINTN SizeOfInfo;
383 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *Info;
384 EFI_UGA_DRAW_PROTOCOL *UgaDraw;
385
386 Private = UGA_DRAW_SPLITTER_PRIVATE_DATA_FROM_THIS (This);
387
388 ReturnStatus = EFI_SUCCESS;
389
390 //
391 // Update the Mode data
392 //
393 Private->UgaHorizontalResolution = HorizontalResolution;
394 Private->UgaVerticalResolution = VerticalResolution;
395 Private->UgaColorDepth = ColorDepth;
396 Private->UgaRefreshRate = RefreshRate;
397
398 //
399 // return the worst status met
400 //
401 for (Index = 0; Index < Private->CurrentNumberOfConsoles; Index++) {
402
403 GraphicsOutput = Private->TextOutList[Index].GraphicsOutput;
404 if (GraphicsOutput != NULL) {
405 //
406 // Find corresponding ModeNumber of this GraphicsOutput instance
407 //
408 for (NumberIndex = 0; NumberIndex < GraphicsOutput->Mode->MaxMode; NumberIndex ++) {
409 Status = GraphicsOutput->QueryMode (GraphicsOutput, (UINT32) NumberIndex, &SizeOfInfo, &Info);
410 if (EFI_ERROR (Status)) {
411 return Status;
412 }
413 if ((Info->HorizontalResolution == HorizontalResolution) && (Info->VerticalResolution == VerticalResolution)) {
414 FreePool (Info);
415 break;
416 }
417 FreePool (Info);
418 }
419
420 Status = GraphicsOutput->SetMode (GraphicsOutput, (UINT32) NumberIndex);
421 if (EFI_ERROR (Status)) {
422 ReturnStatus = Status;
423 }
424 } else if (FeaturePcdGet (PcdUgaConsumeSupport)){
425 UgaDraw = Private->TextOutList[Index].UgaDraw;
426 if (UgaDraw != NULL) {
427 Status = UgaDraw->SetMode (
428 UgaDraw,
429 HorizontalResolution,
430 VerticalResolution,
431 ColorDepth,
432 RefreshRate
433 );
434 if (EFI_ERROR (Status)) {
435 ReturnStatus = Status;
436 }
437 }
438 }
439 }
440
441 return ReturnStatus;
442 }
443
444
445 /**
446 Blt a rectangle of pixels on the graphics screen.
447
448 The following table defines actions for BltOperations.
449
450 EfiUgaVideoFill:
451 Write data from the BltBuffer pixel (SourceX, SourceY)
452 directly to every pixel of the video display rectangle
453 (DestinationX, DestinationY)
454 (DestinationX + Width, DestinationY + Height).
455 Only one pixel will be used from the BltBuffer. Delta is NOT used.
456 EfiUgaVideoToBltBuffer:
457 Read data from the video display rectangle
458 (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in
459 the BltBuffer rectangle (DestinationX, DestinationY )
460 (DestinationX + Width, DestinationY + Height). If DestinationX or
461 DestinationY is not zero then Delta must be set to the length in bytes
462 of a row in the BltBuffer.
463 EfiUgaBltBufferToVideo:
464 Write data from the BltBuffer rectangle
465 (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the
466 video display rectangle (DestinationX, DestinationY)
467 (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is
468 not zero then Delta must be set to the length in bytes of a row in the
469 BltBuffer.
470 EfiUgaVideoToVideo:
471 Copy from the video display rectangle
472 (SourceX, SourceY) (SourceX + Width, SourceY + Height) .
473 to the video display rectangle (DestinationX, DestinationY)
474 (DestinationX + Width, DestinationY + Height).
475 The BltBuffer and Delta are not used in this mode.
476
477 @param This Protocol instance pointer.
478 @param BltBuffer Buffer containing data to blit into video buffer. This
479 buffer has a size of Width*Height*sizeof(EFI_UGA_PIXEL)
480 @param BltOperation Operation to perform on BlitBuffer and video memory
481 @param SourceX X coordinate of source for the BltBuffer.
482 @param SourceY Y coordinate of source for the BltBuffer.
483 @param DestinationX X coordinate of destination for the BltBuffer.
484 @param DestinationY Y coordinate of destination for the BltBuffer.
485 @param Width Width of rectangle in BltBuffer in pixels.
486 @param Height Hight of rectangle in BltBuffer in pixels.
487 @param Delta OPTIONAL
488
489 @retval EFI_SUCCESS The Blt operation completed.
490 @retval EFI_INVALID_PARAMETER BltOperation is not valid.
491 @retval EFI_DEVICE_ERROR A hardware error occured writting to the video buffer.
492
493 **/
494 EFI_STATUS
495 EFIAPI
496 ConSpliterUgaDrawBlt (
497 IN EFI_UGA_DRAW_PROTOCOL *This,
498 IN EFI_UGA_PIXEL *BltBuffer, OPTIONAL
499 IN EFI_UGA_BLT_OPERATION BltOperation,
500 IN UINTN SourceX,
501 IN UINTN SourceY,
502 IN UINTN DestinationX,
503 IN UINTN DestinationY,
504 IN UINTN Width,
505 IN UINTN Height,
506 IN UINTN Delta OPTIONAL
507 )
508 {
509 EFI_STATUS Status;
510 TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;
511 UINTN Index;
512 EFI_STATUS ReturnStatus;
513 EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput;
514
515 Private = UGA_DRAW_SPLITTER_PRIVATE_DATA_FROM_THIS (This);
516
517 ReturnStatus = EFI_SUCCESS;
518 //
519 // return the worst status met
520 //
521 for (Index = 0; Index < Private->CurrentNumberOfConsoles; Index++) {
522 GraphicsOutput = Private->TextOutList[Index].GraphicsOutput;
523 if (GraphicsOutput != NULL) {
524 Status = GraphicsOutput->Blt (
525 GraphicsOutput,
526 (EFI_GRAPHICS_OUTPUT_BLT_PIXEL *) BltBuffer,
527 (EFI_GRAPHICS_OUTPUT_BLT_OPERATION) BltOperation,
528 SourceX,
529 SourceY,
530 DestinationX,
531 DestinationY,
532 Width,
533 Height,
534 Delta
535 );
536 if (EFI_ERROR (Status)) {
537 ReturnStatus = Status;
538 } else if (BltOperation == EfiBltVideoToBltBuffer) {
539 //
540 // Only need to read the data into buffer one time
541 //
542 return EFI_SUCCESS;
543 }
544 }
545
546 if (Private->TextOutList[Index].UgaDraw != NULL && FeaturePcdGet (PcdUgaConsumeSupport)) {
547 Status = Private->TextOutList[Index].UgaDraw->Blt (
548 Private->TextOutList[Index].UgaDraw,
549 BltBuffer,
550 BltOperation,
551 SourceX,
552 SourceY,
553 DestinationX,
554 DestinationY,
555 Width,
556 Height,
557 Delta
558 );
559 if (EFI_ERROR (Status)) {
560 ReturnStatus = Status;
561 } else if (BltOperation == EfiUgaVideoToBltBuffer) {
562 //
563 // Only need to read the data into buffer one time
564 //
565 return EFI_SUCCESS;
566 }
567 }
568 }
569
570 return ReturnStatus;
571 }
572
573 /**
574 Sets the output device(s) to a specified mode.
575
576 @param Private Text Out Splitter pointer.
577 @param ModeNumber The mode number to set.
578
579 **/
580 VOID
581 TextOutSetMode (
582 IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private,
583 IN UINTN ModeNumber
584 )
585 {
586 //
587 // No need to do extra check here as whether (Column, Row) is valid has
588 // been checked in ConSplitterTextOutSetCursorPosition. And (0, 0) should
589 // always be supported.
590 //
591 Private->TextOutMode.Mode = (INT32) ModeNumber;
592 Private->TextOutMode.CursorColumn = 0;
593 Private->TextOutMode.CursorRow = 0;
594 Private->TextOutMode.CursorVisible = TRUE;
595
596 return;
597 }
EDK2 Git Mirror