/* * libeg/screen.c * Screen handling functions * * Copyright (c) 2006 Christoph Pfisterer * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are * met: * * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the * distribution. * * * Neither the name of Christoph Pfisterer nor the names of the * contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #include // Only use angled for Platform, else, xcode project won't compile #include "libegint.h" #include "lodepng.h" #include "../Platform/Settings.h" #include "../Settings/Self.h" // Console defines and variables static constexpr const EFI_GUID ConsoleControlProtocolGuid = EFI_CONSOLE_CONTROL_PROTOCOL_GUID; static EFI_CONSOLE_CONTROL_PROTOCOL *ConsoleControl = NULL; static constexpr const EFI_GUID UgaDrawProtocolGuid = EFI_UGA_DRAW_PROTOCOL_GUID; static EFI_UGA_DRAW_PROTOCOL *UgaDraw = NULL; static constexpr const EFI_GUID GraphicsOutputProtocolGuid = EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID; static EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput = NULL; static XBool egHasGraphics = false; static UINTN egScreenWidth = 0; //1024; static UINTN egScreenHeight = 0; //768; static XBool IgnoreConsoleSetMode = false; static EFI_CONSOLE_CONTROL_SCREEN_MODE CurrentForcedConsoleMode = EfiConsoleControlScreenText; static EFI_CONSOLE_CONTROL_PROTOCOL_GET_MODE ConsoleControlGetMode = NULL; static EFI_CONSOLE_CONTROL_PROTOCOL_SET_MODE ConsoleControlSetMode = NULL; static EFI_STATUS GopSetModeAndReconnectTextOut(IN UINT32 ModeNumber); // // Wrapped ConsoleControl GetMode() implementation - for blocking resolution switch when changing modes // EFI_STATUS EFIAPI egConsoleControlGetMode(IN EFI_CONSOLE_CONTROL_PROTOCOL *This, OUT EFI_CONSOLE_CONTROL_SCREEN_MODE *Mode, OUT BOOLEAN *GopUgaExists, OPTIONAL OUT BOOLEAN *StdInLocked OPTIONAL) { if (IgnoreConsoleSetMode) { *Mode = CurrentForcedConsoleMode; if (GopUgaExists) *GopUgaExists = true; if (StdInLocked) *StdInLocked = false; return EFI_SUCCESS; } return ConsoleControlGetMode(This, Mode, GopUgaExists, StdInLocked); } EFI_STATUS EFIAPI egConsoleControlSetMode(IN EFI_CONSOLE_CONTROL_PROTOCOL *This, IN EFI_CONSOLE_CONTROL_SCREEN_MODE Mode) { // Pretend that we updated our console mode but do not call SetMode itself to avoid breaking the resolution. // Please note, that it is also relevant for proper boot.efi progress bar rendering with FileVault 2. // See more details in refit/main.c if (IgnoreConsoleSetMode) { CurrentForcedConsoleMode = Mode; return EFI_SUCCESS; } return ConsoleControlSetMode(This, Mode); } // // Screen handling // /* void egDumpGOPVideoModes(void) { EFI_STATUS Status; UINT32 MaxMode; UINT32 Mode; UINTN SizeOfInfo; EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *Info; CHAR16 *PixelFormatDesc; if (GraphicsOutput == NULL) { return; } // get dump MaxMode = GraphicsOutput->Mode->MaxMode; Mode = GraphicsOutput->Mode->Mode; // MsgLog("Available graphics modes for refit.conf screen_resolution:\n"); // MsgLog("Curr. Mode = %d, Modes = %d, FB = %lx, FB size=0x%X\n", // Mode, MaxMode, GraphicsOutput->Mode->FrameBufferBase, GraphicsOutput->Mode->FrameBufferSize); for (Mode = 0; Mode < MaxMode; Mode++) { Status = GraphicsOutput->QueryMode(GraphicsOutput, Mode, &SizeOfInfo, &Info); if (Status == EFI_SUCCESS) { switch (Info->PixelFormat) { case PixelRedGreenBlueReserved8BitPerColor: PixelFormatDesc = L"8bit RGB"; break; case PixelBlueGreenRedReserved8BitPerColor: PixelFormatDesc = L"8bit BGR"; break; case PixelBitMask: PixelFormatDesc = L"BITMASK"; break; case PixelBltOnly: PixelFormatDesc = L"NO FB"; break; default: PixelFormatDesc = L"invalid"; break; } MsgLog("- Mode %d: %dx%d PixFmt = %ls, PixPerScanLine = %d\n", Mode, Info->HorizontalResolution, Info->VerticalResolution, PixelFormatDesc, Info->PixelsPerScanLine); } else { MsgLog("- Mode %d: %s\n", Mode, efiStrError(Status)); } } } */ void egDumpSetConsoleVideoModes(void) { UINTN i; UINTN Width, Height; UINTN BestMode = 0, BestWidth = 0, BestHeight = 0; EFI_STATUS Status; STATIC int Once=0; if (gST->ConOut != NULL && gST->ConOut->Mode != NULL) { if (!Once) { MsgLog("Console modes reported: %d, available modes:\n",gST->ConOut->Mode->MaxMode); } for (i=1; i <= (UINTN)gST->ConOut->Mode->MaxMode; i++) { Status = gST->ConOut->QueryMode(gST->ConOut, i-1, &Width, &Height); if (Status == EFI_SUCCESS) { //MsgLog(" Mode %d: %dx%d%ls\n", i, Width, Height, (i-1==(UINTN)gST->ConOut->Mode->Mode)?L" (current mode)":L""); if (!Once) { MsgLog(" - [%02llu]: %llux%llu%ls\n", i, Width, Height, (i-1==(UINTN)gST->ConOut->Mode->Mode)?L" (current mode)":L""); } // Select highest mode (-1) or lowest mode (-2) as/if requested if ((gSettings.GUI.ConsoleMode == -1 && (BestMode == 0 || Height > BestHeight || (Height == BestHeight && Width > BestWidth))) || (gSettings.GUI.ConsoleMode == -2 && (BestMode == 0 || Height < BestHeight || (Height == BestHeight && Width < BestWidth)))) { BestMode = i; BestWidth = Width; BestHeight = Height; } } } Once++; } else { MsgLog("Console modes are not available.\n"); return; } if (gSettings.GUI.ConsoleMode > 0) { // Specific mode chosen, try to set it BestMode = gSettings.GUI.ConsoleMode; } if (BestMode >= 1 && BestMode <= (UINTN)gST->ConOut->Mode->MaxMode) { // Mode is valid if (BestMode-1 != (UINTN)gST->ConOut->Mode->Mode) { Status = gST->ConOut->SetMode(gST->ConOut, BestMode-1); MsgLog(" Setting mode (%llu): %s\n", BestMode, efiStrError(Status)); } else { MsgLog(" Selected mode (%llu) is already set\n", BestMode); } } else if (BestMode != 0) { MsgLog(" Selected mode (%llu) is not valid\n", BestMode); } } EFI_STATUS egSetMaxResolution() { EFI_STATUS Status = EFI_UNSUPPORTED; UINT32 Width = 0; UINT32 Height = 0; UINT32 BestMode = 0; UINT32 MaxMode; UINT32 Mode; UINTN SizeOfInfo = 0; EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *Info = NULL; if (GraphicsOutput == NULL) { return EFI_UNSUPPORTED; } MsgLog("SetMaxResolution: "); MaxMode = GraphicsOutput->Mode->MaxMode; for (Mode = 0; Mode < MaxMode; Mode++) { Status = GraphicsOutput->QueryMode(GraphicsOutput, Mode, &SizeOfInfo, &Info); if (Status == EFI_SUCCESS) { if (Width > Info->HorizontalResolution) { continue; } if (Height > Info->VerticalResolution) { continue; } Width = Info->HorizontalResolution; Height = Info->VerticalResolution; BestMode = Mode; } } MsgLog("found best mode %d: %dx%d\n", BestMode, Width, Height); // check if requested mode is equal to current mode if (BestMode == GraphicsOutput->Mode->Mode) { MsgLog(" - already set\n"); egScreenWidth = GraphicsOutput->Mode->Info->HorizontalResolution; egScreenHeight = GraphicsOutput->Mode->Info->VerticalResolution; Status = EFI_SUCCESS; } else { //Status = GraphicsOutput->SetMode(GraphicsOutput, BestMode); Status = GopSetModeAndReconnectTextOut(BestMode); if (Status == EFI_SUCCESS) { egScreenWidth = Width; egScreenHeight = Height; MsgLog(" - set\n"); } else { // we can not set BestMode - search for first one that we can MsgLog(" - %s\n", efiStrError(Status)); Status = egSetMode(1); } } return Status; } EFI_STATUS egSetMode(INT32 Next) { EFI_STATUS Status = EFI_UNSUPPORTED; UINT32 MaxMode; UINTN SizeOfInfo = 0; EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *Info = NULL; INT32 Mode; UINT32 Index = 0; if (GraphicsOutput == NULL) { return EFI_UNSUPPORTED; } MaxMode = GraphicsOutput->Mode->MaxMode; Mode = GraphicsOutput->Mode->Mode; while (EFI_ERROR(Status) && Index <= MaxMode) { Mode = Mode + Next; Mode = (Mode >= (INT32)MaxMode)?0:Mode; Mode = (Mode < 0)?((INT32)MaxMode - 1):Mode; Status = GraphicsOutput->QueryMode(GraphicsOutput, (UINT32)Mode, &SizeOfInfo, &Info); MsgLog("QueryMode %d Status=%s\n", Mode, efiStrError(Status)); if (Status == EFI_SUCCESS) { //Status = GraphicsOutput->SetMode(GraphicsOutput, (UINT32)Mode); Status = GopSetModeAndReconnectTextOut((UINT32)Mode); //MsgLog("SetMode %d Status=%s\n", Mode, efiStrError(Status)); egScreenWidth = GraphicsOutput->Mode->Info->HorizontalResolution; egScreenHeight = GraphicsOutput->Mode->Info->VerticalResolution; } Index++; } return Status; } EFI_STATUS egSetScreenResolution(IN const CHAR16 *WidthHeight) { EFI_STATUS Status = EFI_UNSUPPORTED; UINT32 Width; UINT32 Height; const CHAR16 *HeightP; UINT32 MaxMode; UINT32 Mode; UINTN SizeOfInfo; EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *Info; if (GraphicsOutput == NULL) { return EFI_UNSUPPORTED; } if (WidthHeight == NULL) { return EFI_INVALID_PARAMETER; } MsgLog("SetScreenResolution: %ls", WidthHeight); // we are expecting WidthHeight=L"1024x768" // parse Width and Height HeightP = WidthHeight; while (*HeightP != L'\0' && *HeightP != L'x' && *HeightP != L'X') { HeightP++; } if (*HeightP == L'\0') { return EFI_INVALID_PARAMETER; } HeightP++; Width = (UINT32)StrDecimalToUintn(WidthHeight); Height = (UINT32)StrDecimalToUintn(HeightP); // check if requested mode is equal to current mode if ((GraphicsOutput->Mode->Info->HorizontalResolution == Width) && (GraphicsOutput->Mode->Info->VerticalResolution == Height)) { MsgLog(" - already set\n"); egScreenWidth = GraphicsOutput->Mode->Info->HorizontalResolution; egScreenHeight = GraphicsOutput->Mode->Info->VerticalResolution; return EFI_SUCCESS; } // iterate through modes and set it if found MaxMode = GraphicsOutput->Mode->MaxMode; for (Mode = 0; Mode < MaxMode; Mode++) { Status = GraphicsOutput->QueryMode(GraphicsOutput, Mode, &SizeOfInfo, &Info); if (Status == EFI_SUCCESS) { if (Width == Info->HorizontalResolution && Height == Info->VerticalResolution) { MsgLog(" - setting Mode %d\n", Mode); //Status = GraphicsOutput->SetMode(GraphicsOutput, Mode); Status = GopSetModeAndReconnectTextOut(Mode); if (Status == EFI_SUCCESS) { egScreenWidth = Width; egScreenHeight = Height; return EFI_SUCCESS; } } } } MsgLog(" - not found!\n"); return EFI_UNSUPPORTED; } void egInitScreen(IN XBool SetMaxResolution) { EFI_STATUS Status; UINT32 Width, Height, Depth, RefreshRate; // CHAR16 *Resolution; // get protocols Status = EfiLibLocateProtocol(ConsoleControlProtocolGuid, (void **) &ConsoleControl); if (EFI_ERROR(Status)) ConsoleControl = NULL; Status = EfiLibLocateProtocol(UgaDrawProtocolGuid, (void **) &UgaDraw); if (EFI_ERROR(Status)) UgaDraw = NULL; Status = EfiLibLocateProtocol(GraphicsOutputProtocolGuid, (void **) &GraphicsOutput); if (EFI_ERROR(Status)) GraphicsOutput = NULL; // Wrap GetMode and SetMode if (ConsoleControl != NULL && (ConsoleControlGetMode == NULL || ConsoleControlSetMode == NULL)) { ConsoleControlGetMode = ConsoleControl->GetMode; ConsoleControlSetMode = ConsoleControl->SetMode; ConsoleControl->GetMode = egConsoleControlGetMode; ConsoleControl->SetMode = egConsoleControlSetMode; } // if it not the first run, just restore resolution if (egScreenWidth != 0 && egScreenHeight != 0) { XStringW Resolution = SWPrintf("%llux%llu", egScreenWidth, egScreenHeight); Status = egSetScreenResolution(Resolution.wc_str()); if (!EFI_ERROR(Status)) { return; } } egDumpSetConsoleVideoModes(); // get screen size egHasGraphics = false; if (GraphicsOutput != NULL) { // egDumpGOPVideoModes(); if (gSettings.GUI.ScreenResolution.notEmpty()) { if (EFI_ERROR(egSetScreenResolution(gSettings.GUI.ScreenResolution.wc_str()))) { if (SetMaxResolution) { egSetMaxResolution(); } } } else { if (SetMaxResolution) { egSetMaxResolution(); } } egScreenWidth = GraphicsOutput->Mode->Info->HorizontalResolution; egScreenHeight = GraphicsOutput->Mode->Info->VerticalResolution; egHasGraphics = true; } //is there anybody ever see UGA protocol??? else if (UgaDraw != NULL) { //MsgLog("you are lucky guy having UGA, inform please projectosx!\n"); Status = UgaDraw->GetMode(UgaDraw, &Width, &Height, &Depth, &RefreshRate); if (EFI_ERROR(Status)) { UgaDraw = NULL; // graphics not available } else { egScreenWidth = Width; egScreenHeight = Height; egHasGraphics = true; } } } void egGetScreenSize(OUT INTN *ScreenWidth, OUT INTN *ScreenHeight) { if (ScreenWidth != NULL) *ScreenWidth = egScreenWidth; if (ScreenHeight != NULL) *ScreenHeight = egScreenHeight; } XString8 egScreenDescription(void) { if (egHasGraphics) { if (GraphicsOutput != NULL) { return S8Printf("Graphics Output (UEFI), %lldx%lld", egScreenWidth, egScreenHeight); } else if (UgaDraw != NULL) { return S8Printf("UGA Draw (EFI 1.10), %lldx%lld", egScreenWidth, egScreenHeight); } else { return "Internal Error"_XS8; } } else { return "Text Console"_XS8; } } XBool egHasGraphicsMode(void) { return egHasGraphics; } XBool egIsGraphicsModeEnabled(void) { EFI_CONSOLE_CONTROL_SCREEN_MODE CurrentMode; if (ConsoleControl != NULL) { ConsoleControl->GetMode(ConsoleControl, &CurrentMode, NULL, NULL); return (CurrentMode == EfiConsoleControlScreenGraphics) ? true : false; } return false; } void egSetGraphicsModeEnabled(IN XBool Enable) { EFI_CONSOLE_CONTROL_SCREEN_MODE CurrentMode; EFI_CONSOLE_CONTROL_SCREEN_MODE NewMode; if (ConsoleControl != NULL) { // Some UEFI bioses may cause resolution switch when switching to Text Mode via the ConsoleControl->SetMode command // EFI applications wishing to use text, call the ConsoleControl->GetMode() command, and depending on its result may call ConsoleControl->SetMode(). // To avoid the resolution switch, when we set text mode, we can make ConsoleControl->GetMode report that text mode is enabled. // ConsoleControl->SetMode should not be needed on UEFI 2.x to switch to text, but some firmwares seem to block text out if it is not given. // We know it blocks text out on HPQ UEFI (HP ProBook for example - reported by dmazar), Apple firmwares with UGA, and some VMs. // So, it may be better considering to do this only with firmware vendors where the bug was observed (currently it is known to exist on some AMI firmwares). //if (GraphicsOutput != NULL && StrCmp(gST->FirmwareVendor, L"American Megatrends") == 0) { if (GraphicsOutput != NULL && StrCmp(gST->FirmwareVendor, L"HPQ") != 0 && StrCmp(gST->FirmwareVendor, L"VMware, Inc.") != 0 && StrCmp(gST->FirmwareVendor, L"INSYDE Corp.") != 0) { if (!Enable) { // Don't allow switching to text mode, but report that we are in text mode when queried CurrentForcedConsoleMode = EfiConsoleControlScreenText; IgnoreConsoleSetMode = true; return; } // Allow mode switching to work normally again IgnoreConsoleSetMode = false; } ConsoleControl->GetMode(ConsoleControl, &CurrentMode, NULL, NULL); NewMode = Enable ? EfiConsoleControlScreenGraphics : EfiConsoleControlScreenText; if (CurrentMode != NewMode) { ConsoleControl->SetMode(ConsoleControl, NewMode); } } } // // Drawing to the screen // void egClearScreen(IN const void *Color) { EFI_GRAPHICS_OUTPUT_BLT_PIXEL FillColor = *(EFI_GRAPHICS_OUTPUT_BLT_PIXEL *)Color; if (!egHasGraphics) return; if (GraphicsOutput != NULL) { // EFI_GRAPHICS_OUTPUT_BLT_PIXEL and EFI_UGA_PIXEL have the same // layout, and the header from TianoCore actually defines them // to be the same type. GraphicsOutput->Blt(GraphicsOutput, &FillColor, EfiBltVideoFill, 0, 0, 0, 0, egScreenWidth, egScreenHeight, 0); } else if (UgaDraw != NULL) { UgaDraw->Blt(UgaDraw, (EFI_UGA_PIXEL*)&FillColor, EfiUgaVideoFill, 0, 0, 0, 0, egScreenWidth, egScreenHeight, 0); } } // // Make a screenshot // EFI_STATUS egScreenShot(void) { EFI_STATUS Status = EFI_NOT_READY; //take screen XImage Screen(egScreenWidth, egScreenHeight); MsgLog("Make screenshot W=%llu H=%llu\n", egScreenWidth, egScreenHeight); Screen.GetArea(0, 0, egScreenWidth, egScreenHeight); //convert to PNG UINT8 *FileData = NULL; UINTN FileDataLength = 0U; Status = Screen.ToPNG(&FileData, FileDataLength); if (EFI_ERROR(Status)) { if (FileData != NULL) { FreePool(FileData); } return Status; } if (!FileData) { return EFI_NOT_READY; } //save file with a first unoccupied name for (UINTN Index = 0; Index < 60; Index++) { XStringW Name = SWPrintf("misc\\screenshot%lld.png", Index); if (!FileExists(&self.getCloverDir(), Name.wc_str())) { Status = egSaveFile(&self.getCloverDir(), Name.wc_str(), FileData, FileDataLength); // Jief : don't write outside SelfDir // if (EFI_ERROR(Status)) // Status = egSaveFile(NULL, Name.wc_str(), FileData, FileDataLength); if (!EFI_ERROR(Status)) { break; } } } FreePool(FileData); return Status; } // // Sets mode via GOP protocol, and reconnects simple text out drivers // static EFI_STATUS GopSetModeAndReconnectTextOut(IN UINT32 ModeNumber) { UINTN HandleCount = 0; // UINTN Index; EFI_HANDLE *HandleBuffer = NULL; EFI_STATUS Status; if (GraphicsOutput == NULL) { return EFI_UNSUPPORTED; } Status = GraphicsOutput->SetMode(GraphicsOutput, ModeNumber); MsgLog("Video mode change to mode #%d: %s\n", ModeNumber, efiStrError(Status)); if (gFirmwareClover && !EFI_ERROR(Status)) { // When we change mode on GOP, we need to reconnect the drivers which produce simple text out // Otherwise, they won't produce text based on the new resolution Status = gBS->LocateHandleBuffer ( ByProtocol, &gEfiSimpleTextOutProtocolGuid, NULL, &HandleCount, &HandleBuffer ); if (!EFI_ERROR(Status)) { for (UINTN Index = 0; Index < HandleCount; Index++) { gBS->DisconnectController (HandleBuffer[Index], NULL, NULL); } for (UINTN Index = 0; Index < HandleCount; Index++) { gBS->ConnectController (HandleBuffer[Index], NULL, NULL, true); } if (HandleBuffer != NULL) { FreePool(HandleBuffer); } egDumpSetConsoleVideoModes(); } // return value is according to whether SetMode succeeded Status = EFI_SUCCESS; } return Status; } /* EOF */