code.delx.au - refind/blob - libeg/screen.c

   1 /*
   2  * libeg/screen.c
   3  * Screen handling functions
   4  *
   5  * Copyright (c) 2006 Christoph Pfisterer
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions are
  10  * met:
  11  *
  12  *  * Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  *
  15  *  * Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the
  18  *    distribution.
  19  *
  20  *  * Neither the name of Christoph Pfisterer nor the names of the
  21  *    contributors may be used to endorse or promote products derived
  22  *    from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  27  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  28  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  29  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  30  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  31  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  32  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  33  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  34  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  35  */
  36
  37 #include "libegint.h"
  38 #include "../refind/screen.h"
  39 #include "../refind/lib.h"
  40 #include "../include/refit_call_wrapper.h"
  41
  42 #include <efiUgaDraw.h>
  43 #include <efiConsoleControl.h>
  44
  45 #ifndef __MAKEWITH_GNUEFI
  46 #define LibLocateProtocol EfiLibLocateProtocol
  47 #endif
  48
  49 // Console defines and variables
  50
  51 static EFI_GUID ConsoleControlProtocolGuid = EFI_CONSOLE_CONTROL_PROTOCOL_GUID;
  52 static EFI_CONSOLE_CONTROL_PROTOCOL *ConsoleControl = NULL;
  53
  54 static EFI_GUID UgaDrawProtocolGuid = EFI_UGA_DRAW_PROTOCOL_GUID;
  55 static EFI_UGA_DRAW_PROTOCOL *UgaDraw = NULL;
  56
  57 static EFI_GUID GraphicsOutputProtocolGuid = EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID;
  58 static EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput = NULL;
  59
  60 static BOOLEAN egHasGraphics = FALSE;
  61 static UINTN egScreenWidth  = 800;
  62 static UINTN egScreenHeight = 600;
  63
  64 //
  65 // Screen handling
  66 //
  67
  68 VOID egInitScreen(VOID)
  69 {
  70     EFI_STATUS Status = EFI_SUCCESS;
  71     UINT32 UGAWidth, UGAHeight, UGADepth, UGARefreshRate;
  72
  73     // get protocols
  74     Status = LibLocateProtocol(&ConsoleControlProtocolGuid, (VOID **) &ConsoleControl);
  75     if (EFI_ERROR(Status))
  76         ConsoleControl = NULL;
  77
  78     Status = LibLocateProtocol(&UgaDrawProtocolGuid, (VOID **) &UgaDraw);
  79     if (EFI_ERROR(Status))
  80         UgaDraw = NULL;
  81
  82     Status = LibLocateProtocol(&GraphicsOutputProtocolGuid, (VOID **) &GraphicsOutput);
  83     if (EFI_ERROR(Status))
  84         GraphicsOutput = NULL;
  85
  86     // get screen size
  87     egHasGraphics = FALSE;
  88     if (GraphicsOutput != NULL) {
  89         egScreenWidth = GraphicsOutput->Mode->Info->HorizontalResolution;
  90         egScreenHeight = GraphicsOutput->Mode->Info->VerticalResolution;
  91         egHasGraphics = TRUE;
  92     } else if (UgaDraw != NULL) {
  93         Status = refit_call5_wrapper(UgaDraw->GetMode, UgaDraw, &UGAWidth, &UGAHeight, &UGADepth, &UGARefreshRate);
  94         if (EFI_ERROR(Status)) {
  95             UgaDraw = NULL;   // graphics not available
  96         } else {
  97             egScreenWidth  = UGAWidth;
  98             egScreenHeight = UGAHeight;
  99             egHasGraphics = TRUE;
 100         }
 101     }
 102 }
 103
 104 // Sets the screen resolution to the specified value, if possible.
 105 // If the specified value is not valid, displays a warning with the valid
 106 // modes on UEFI systems, or silently fails on EFI 1.x systems. Note that
 107 // this function attempts to set ANY screen resolution, even 0x0 or
 108 // ridiculously large values.
 109 // Returns TRUE if successful, FALSE if not.
 110 BOOLEAN egSetScreenSize(IN UINTN ScreenWidth, IN UINTN ScreenHeight) {
 111    EFI_STATUS Status = EFI_SUCCESS;
 112    EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *Info;
 113    UINT32 ModeNum = 0;
 114    UINTN Size;
 115    BOOLEAN ModeSet = FALSE;
 116    UINT32 UGAWidth, UGAHeight, UGADepth, UGARefreshRate;
 117
 118    if (GraphicsOutput != NULL) { // GOP mode (UEFI)
 119       // Do a loop through the modes to see if the specified one is available;
 120       // and if so, switch to it....
 121       while ((Status == EFI_SUCCESS) && (!ModeSet)) {
 122          Status = refit_call4_wrapper(GraphicsOutput->QueryMode, GraphicsOutput, ModeNum, &Size, &Info);
 123          if ((Status == EFI_SUCCESS) && (Size >= sizeof(*Info)) &&
 124              (Info->HorizontalResolution == ScreenWidth) && (Info->VerticalResolution == ScreenHeight)) {
 125             Status = refit_call2_wrapper(GraphicsOutput->SetMode, GraphicsOutput, ModeNum);
 126             ModeSet = (Status == EFI_SUCCESS);
 127          } // if
 128          ModeNum++;
 129       } // while()
 130
 131       if (ModeSet) {
 132          egScreenWidth = ScreenWidth;
 133          egScreenHeight = ScreenHeight;
 134       } else {// If unsuccessful, display an error message for the user....
 135          SwitchToText(FALSE);
 136          Print(L"Error setting graphics mode %d x %d; using default mode!\nAvailable modes are:\n", ScreenWidth, ScreenHeight);
 137          ModeNum = 0;
 138          do {
 139             Status = refit_call4_wrapper(GraphicsOutput->QueryMode, GraphicsOutput, ModeNum, &Size, &Info);
 140             if (Status == EFI_SUCCESS) {
 141                Print(L"Mode %d: %d x %d\n", ModeNum, Info->HorizontalResolution, Info->VerticalResolution);
 142             } // else
 143          } while ((ModeNum++ < 10) || (Status == EFI_SUCCESS));
 144 //          Status = EFI_SUCCESS;
 145 //          while (Status == EFI_SUCCESS) {
 146 //             Status = refit_call4_wrapper(GraphicsOutput->QueryMode, GraphicsOutput, ModeNum, &Size, &Info);
 147 //             if ((Status == EFI_SUCCESS) && (Size >= sizeof(*Info))) {
 148 //                Print(L"Mode %d: %d x %d\n", ModeNum, Info->HorizontalResolution, Info->VerticalResolution);
 149 //             } // else
 150 //             ModeNum++;
 151 //          } // while()
 152          PauseForKey();
 153          SwitchToGraphics();
 154       } // if()
 155    } else if (UgaDraw != NULL) { // UGA mode (EFI 1.x)
 156       // Try to use current color depth & refresh rate for new mode. Maybe not the best choice
 157       // in all cases, but I don't know how to probe for alternatives....
 158       Status = refit_call5_wrapper(UgaDraw->GetMode, UgaDraw, &UGAWidth, &UGAHeight, &UGADepth, &UGARefreshRate);
 159       Status = refit_call5_wrapper(UgaDraw->SetMode, UgaDraw, ScreenWidth, ScreenHeight, UGADepth, UGARefreshRate);
 160       if (Status == EFI_SUCCESS) {
 161          egScreenWidth = ScreenWidth;
 162          egScreenHeight = ScreenHeight;
 163          ModeSet = TRUE;
 164       } else {
 165          // TODO: Find a list of supported modes and display it.
 166          // NOTE: Below doesn't actually appear unless we explicitly switch to text mode.
 167          // This is just a placeholder until something better can be done....
 168          Print(L"Error setting graphics mode %d x %d; unsupported mode!\n");
 169       } // if/else
 170    } // if/else if
 171    return (ModeSet);
 172 } // BOOLEAN egSetScreenSize()
 173
 174 VOID egGetScreenSize(OUT UINTN *ScreenWidth, OUT UINTN *ScreenHeight)
 175 {
 176     if (ScreenWidth != NULL)
 177         *ScreenWidth = egScreenWidth;
 178     if (ScreenHeight != NULL)
 179         *ScreenHeight = egScreenHeight;
 180 }
 181
 182 // Set a text mode
 183 // Returns the mode that was actually set.
 184 UINT32 egSetTextMode(UINT32 RequestedMode) {
 185    UINTN         i = 0, Width, Height;
 186    UINT32        UsedMode = ST->ConOut->Mode->Mode;
 187    EFI_STATUS    Status;
 188
 189    if (RequestedMode != ST->ConOut->Mode->Mode) {
 190       Status = refit_call2_wrapper(ST->ConOut->SetMode, ST->ConOut, RequestedMode);
 191       if (Status == EFI_SUCCESS) {
 192          UsedMode = RequestedMode;
 193       } else {
 194          SwitchToText(FALSE);
 195          Print(L"Error setting text mode %d; available modes are:\n", ST->ConOut->Mode->Mode);
 196          do {
 197             Status = refit_call4_wrapper(ST->ConOut->QueryMode, ST->ConOut, i, &Width, &Height);
 198             if (Status == EFI_SUCCESS)
 199                Print(L"Mode: %d: %d x %d\n", i, Width, Height);
 200          } while ((i++ < 2) || (Status == EFI_SUCCESS));
 201
 202          PauseForKey();
 203          SwitchToGraphics();
 204       } // if/else successful change
 205    } // if need to change mode
 206    return UsedMode;
 207 } // UINT32 egSetTextMode()
 208
 209 CHAR16 * egScreenDescription(VOID)
 210 {
 211     CHAR16 *GraphicsInfo, *TextInfo = NULL;
 212
 213     GraphicsInfo = AllocateZeroPool(256 * sizeof(CHAR16));
 214     if (GraphicsInfo == NULL)
 215        return L"memory allocation error";
 216
 217     if (egHasGraphics) {
 218         if (GraphicsOutput != NULL) {
 219             SPrint(GraphicsInfo, 255, L"Graphics Output (UEFI), %dx%d", egScreenWidth, egScreenHeight);
 220         } else if (UgaDraw != NULL) {
 221             GraphicsInfo = AllocateZeroPool(256 * sizeof(CHAR16));
 222             SPrint(GraphicsInfo, 255, L"UGA Draw (EFI 1.10), %dx%d", egScreenWidth, egScreenHeight);
 223         } else {
 224             MyFreePool(GraphicsInfo);
 225             MyFreePool(TextInfo);
 226             return L"Internal Error";
 227         }
 228         if (!AllowGraphicsMode) { // graphics-capable HW, but in text mode
 229            TextInfo = AllocateZeroPool(256 * sizeof(CHAR16));
 230            SPrint(TextInfo, 255, L"(in %dx%d text mode)", ConWidth, ConHeight);
 231            MergeStrings(&GraphicsInfo, TextInfo, L' ');
 232         }
 233     } else {
 234         SPrint(GraphicsInfo, 255, L"Text-foo console, %dx%d", ConWidth, ConHeight);
 235     }
 236     MyFreePool(TextInfo);
 237     return GraphicsInfo;
 238 }
 239
 240 BOOLEAN egHasGraphicsMode(VOID)
 241 {
 242     return egHasGraphics;
 243 }
 244
 245 BOOLEAN egIsGraphicsModeEnabled(VOID)
 246 {
 247     EFI_CONSOLE_CONTROL_SCREEN_MODE CurrentMode;
 248
 249     if (ConsoleControl != NULL) {
 250         refit_call4_wrapper(ConsoleControl->GetMode, ConsoleControl, &CurrentMode, NULL, NULL);
 251         return (CurrentMode == EfiConsoleControlScreenGraphics) ? TRUE : FALSE;
 252     }
 253
 254     return FALSE;
 255 }
 256
 257 VOID egSetGraphicsModeEnabled(IN BOOLEAN Enable)
 258 {
 259     EFI_CONSOLE_CONTROL_SCREEN_MODE CurrentMode;
 260     EFI_CONSOLE_CONTROL_SCREEN_MODE NewMode;
 261
 262     if (ConsoleControl != NULL) {
 263         refit_call4_wrapper(ConsoleControl->GetMode, ConsoleControl, &CurrentMode, NULL, NULL);
 264
 265         NewMode = Enable ? EfiConsoleControlScreenGraphics
 266                          : EfiConsoleControlScreenText;
 267         if (CurrentMode != NewMode)
 268            refit_call2_wrapper(ConsoleControl->SetMode, ConsoleControl, NewMode);
 269     }
 270 }
 271
 272 //
 273 // Drawing to the screen
 274 //
 275
 276 VOID egClearScreen(IN EG_PIXEL *Color)
 277 {
 278     EFI_UGA_PIXEL FillColor;
 279
 280     if (!egHasGraphics)
 281         return;
 282
 283     FillColor.Red   = Color->r;
 284     FillColor.Green = Color->g;
 285     FillColor.Blue  = Color->b;
 286     FillColor.Reserved = 0;
 287
 288     if (GraphicsOutput != NULL) {
 289         // EFI_GRAPHICS_OUTPUT_BLT_PIXEL and EFI_UGA_PIXEL have the same
 290         // layout, and the header from TianoCore actually defines them
 291         // to be the same type.
 292         refit_call10_wrapper(GraphicsOutput->Blt, GraphicsOutput, (EFI_GRAPHICS_OUTPUT_BLT_PIXEL *)&FillColor, EfiBltVideoFill,
 293                             0, 0, 0, 0, egScreenWidth, egScreenHeight, 0);
 294     } else if (UgaDraw != NULL) {
 295         refit_call10_wrapper(UgaDraw->Blt, UgaDraw, &FillColor, EfiUgaVideoFill,
 296                      0, 0, 0, 0, egScreenWidth, egScreenHeight, 0);
 297     }
 298 }
 299
 300 VOID egDrawImage(IN EG_IMAGE *Image, IN UINTN ScreenPosX, IN UINTN ScreenPosY)
 301 {
 302     if (!egHasGraphics)
 303         return;
 304
 305     if (Image->HasAlpha) {
 306         Image->HasAlpha = FALSE;
 307         egSetPlane(PLPTR(Image, a), 0, Image->Width * Image->Height);
 308     }
 309
 310     if (GraphicsOutput != NULL) {
 311         refit_call10_wrapper(GraphicsOutput->Blt, GraphicsOutput, (EFI_GRAPHICS_OUTPUT_BLT_PIXEL *)Image->PixelData, EfiBltBufferToVideo,
 312                             0, 0, ScreenPosX, ScreenPosY, Image->Width, Image->Height, 0);
 313     } else if (UgaDraw != NULL) {
 314         refit_call10_wrapper(UgaDraw->Blt, UgaDraw, (EFI_UGA_PIXEL *)Image->PixelData, EfiUgaBltBufferToVideo,
 315                      0, 0, ScreenPosX, ScreenPosY, Image->Width, Image->Height, 0);
 316     }
 317 }
 318
 319 VOID egDrawImageArea(IN EG_IMAGE *Image,
 320                      IN UINTN AreaPosX, IN UINTN AreaPosY,
 321                      IN UINTN AreaWidth, IN UINTN AreaHeight,
 322                      IN UINTN ScreenPosX, IN UINTN ScreenPosY)
 323 {
 324     if (!egHasGraphics)
 325         return;
 326
 327     egRestrictImageArea(Image, AreaPosX, AreaPosY, &AreaWidth, &AreaHeight);
 328     if (AreaWidth == 0)
 329         return;
 330
 331     if (Image->HasAlpha) {
 332         Image->HasAlpha = FALSE;
 333         egSetPlane(PLPTR(Image, a), 0, Image->Width * Image->Height);
 334     }
 335
 336     if (GraphicsOutput != NULL) {
 337         refit_call10_wrapper(GraphicsOutput->Blt, GraphicsOutput, (EFI_GRAPHICS_OUTPUT_BLT_PIXEL *)Image->PixelData, EfiBltBufferToVideo,
 338                             AreaPosX, AreaPosY, ScreenPosX, ScreenPosY, AreaWidth, AreaHeight, Image->Width * 4);
 339     } else if (UgaDraw != NULL) {
 340         refit_call10_wrapper(UgaDraw->Blt, UgaDraw, (EFI_UGA_PIXEL *)Image->PixelData, EfiUgaBltBufferToVideo,
 341                      AreaPosX, AreaPosY, ScreenPosX, ScreenPosY, AreaWidth, AreaHeight, Image->Width * 4);
 342     }
 343 }
 344
 345 // Display a message in the center of the screen, surrounded by a box of the
 346 // specified color. For the moment, uses graphics calls only. (It still works
 347 // in text mode on GOP/UEFI systems, but not on UGA/EFI 1.x systems.)
 348 VOID egDisplayMessage(IN CHAR16 *Text, EG_PIXEL *BGColor) {
 349    UINTN BoxWidth, BoxHeight;
 350    EG_IMAGE *Box;
 351
 352    if ((Text != NULL) && (BGColor != NULL)) {
 353       BoxWidth = (StrLen(Text) + 2) * FONT_CELL_WIDTH;
 354       if (BoxWidth > egScreenWidth)
 355          BoxWidth = egScreenWidth;
 356       BoxHeight = 2 * FONT_CELL_HEIGHT;
 357       Box = egCreateFilledImage(BoxWidth, BoxHeight, FALSE, BGColor);
 358       egRenderText(Text, Box, FONT_CELL_WIDTH, FONT_CELL_HEIGHT / 2);
 359       egDrawImage(Box, (egScreenWidth - BoxWidth) / 2, (egScreenHeight - BoxHeight) / 2);
 360    } // if non-NULL inputs
 361 } // VOID egDisplayMessage()
 362
 363 //
 364 // Make a screenshot
 365 //
 366
 367 VOID egScreenShot(VOID)
 368 {
 369     EFI_STATUS      Status;
 370     EG_IMAGE        *Image;
 371     UINT8           *FileData;
 372     UINTN           FileDataLength;
 373     UINTN           Index;
 374
 375     if (!egHasGraphics)
 376         return;
 377
 378     // allocate a buffer for the whole screen
 379     Image = egCreateImage(egScreenWidth, egScreenHeight, FALSE);
 380     if (Image == NULL) {
 381         Print(L"Error egCreateImage returned NULL\n");
 382         goto bailout_wait;
 383     }
 384
 385     // get full screen image
 386     if (GraphicsOutput != NULL) {
 387         refit_call10_wrapper(GraphicsOutput->Blt, GraphicsOutput, (EFI_GRAPHICS_OUTPUT_BLT_PIXEL *)Image->PixelData, EfiBltVideoToBltBuffer,
 388                             0, 0, 0, 0, Image->Width, Image->Height, 0);
 389     } else if (UgaDraw != NULL) {
 390         refit_call10_wrapper(UgaDraw->Blt, UgaDraw, (EFI_UGA_PIXEL *)Image->PixelData, EfiUgaVideoToBltBuffer,
 391                      0, 0, 0, 0, Image->Width, Image->Height, 0);
 392     }
 393
 394     // encode as BMP
 395     egEncodeBMP(Image, &FileData, &FileDataLength);
 396     egFreeImage(Image);
 397     if (FileData == NULL) {
 398         Print(L"Error egEncodeBMP returned NULL\n");
 399         goto bailout_wait;
 400     }
 401
 402     // save to file on the ESP
 403     Status = egSaveFile(NULL, L"screenshot.bmp", FileData, FileDataLength);
 404     FreePool(FileData);
 405     if (EFI_ERROR(Status)) {
 406         Print(L"Error egSaveFile: %x\n", Status);
 407         goto bailout_wait;
 408     }
 409
 410     return;
 411
 412     // DEBUG: switch to text mode
 413 bailout_wait:
 414     egSetGraphicsModeEnabled(FALSE);
 415     refit_call3_wrapper(BS->WaitForEvent, 1, &ST->ConIn->WaitForKey, &Index);
 416 }
 417
 418 /* EOF */