* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
+/*
+ * Modifications copyright (c) 2012 Roderick W. Smith
+ *
+ * Modifications distributed under the terms of the GNU General Public
+ * License (GPL) version 3 (GPLv3), a copy of which must be distributed
+ * with this source code or binaries made from it.
+ *
+ */
#include "libegint.h"
-#include "refit_call_wrapper.h"
+#include "../refind/screen.h"
+#include "../refind/lib.h"
+#include "../include/refit_call_wrapper.h"
#include <efiUgaDraw.h>
-/* #include <efiGraphicsOutput.h> */
#include <efiConsoleControl.h>
+#ifndef __MAKEWITH_GNUEFI
+#define LibLocateProtocol EfiLibLocateProtocol
+#endif
+
// Console defines and variables
static EFI_GUID ConsoleControlProtocolGuid = EFI_CONSOLE_CONTROL_PROTOCOL_GUID;
// Screen handling
//
-VOID egInitScreen(VOID)
-{
- EFI_STATUS Status;
+// Make the necessary system calls to identify the current graphics mode.
+// Stores the results in the file-global variables egScreenWidth,
+// egScreenHeight, and egHasGraphics. The first two of these will be
+// unchanged if neither GraphicsOutput nor UgaDraw is a valid pointer.
+static VOID egDetermineScreenSize(VOID) {
+ EFI_STATUS Status = EFI_SUCCESS;
UINT32 UGAWidth, UGAHeight, UGADepth, UGARefreshRate;
- // get protocols
- Status = LibLocateProtocol(&ConsoleControlProtocolGuid, (VOID **) &ConsoleControl);
- if (EFI_ERROR(Status))
- ConsoleControl = NULL;
-
- Status = LibLocateProtocol(&UgaDrawProtocolGuid, (VOID **) &UgaDraw);
- if (EFI_ERROR(Status))
- UgaDraw = NULL;
-
- Status = LibLocateProtocol(&GraphicsOutputProtocolGuid, (VOID **) &GraphicsOutput);
- if (EFI_ERROR(Status))
- GraphicsOutput = NULL;
-
// get screen size
egHasGraphics = FALSE;
if (GraphicsOutput != NULL) {
egHasGraphics = TRUE;
}
}
-}
+} // static VOID egDetermineScreenSize()
VOID egGetScreenSize(OUT UINTN *ScreenWidth, OUT UINTN *ScreenHeight)
{
+ egDetermineScreenSize();
+
if (ScreenWidth != NULL)
*ScreenWidth = egScreenWidth;
if (ScreenHeight != NULL)
*ScreenHeight = egScreenHeight;
}
+VOID egInitScreen(VOID)
+{
+ EFI_STATUS Status = EFI_SUCCESS;
+
+ // get protocols
+ Status = LibLocateProtocol(&ConsoleControlProtocolGuid, (VOID **) &ConsoleControl);
+ if (EFI_ERROR(Status))
+ ConsoleControl = NULL;
+
+ Status = LibLocateProtocol(&UgaDrawProtocolGuid, (VOID **) &UgaDraw);
+ if (EFI_ERROR(Status))
+ UgaDraw = NULL;
+
+ Status = LibLocateProtocol(&GraphicsOutputProtocolGuid, (VOID **) &GraphicsOutput);
+ if (EFI_ERROR(Status))
+ GraphicsOutput = NULL;
+
+ egDetermineScreenSize();
+}
+
+// Convert a graphics mode (in *ModeWidth) to a width and height (returned in
+// *ModeWidth and *Height, respectively).
+// Returns TRUE if successful, FALSE if not (invalid mode, typically)
+BOOLEAN egGetResFromMode(UINTN *ModeWidth, UINTN *Height) {
+ UINTN Size;
+ EFI_STATUS Status;
+ EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *Info = NULL;
+
+ if ((ModeWidth != NULL) && (Height != NULL)) {
+ Status = refit_call4_wrapper(GraphicsOutput->QueryMode, GraphicsOutput, *ModeWidth, &Size, &Info);
+ if ((Status == EFI_SUCCESS) && (Info != NULL)) {
+ *ModeWidth = Info->HorizontalResolution;
+ *Height = Info->VerticalResolution;
+ return TRUE;
+ }
+ }
+ return FALSE;
+} // BOOLEAN egGetResFromMode()
+
+// Sets the screen resolution to the specified value, if possible. If *ScreenHeight
+// is 0 and GOP mode is detected, assume that *ScreenWidth contains a GOP mode
+// number rather than a horizontal resolution. If the specified resolution is not
+// valid, displays a warning with the valid modes on GOP (UEFI) systems, or silently
+// fails on UGA (EFI 1.x) systems. Note that this function attempts to set ANY screen
+// resolution, even 0x0 or ridiculously large values.
+// Upon success, returns actual screen resolution in *ScreenWidth and *ScreenHeight.
+// These values are unchanged upon failure.
+// Returns TRUE if successful, FALSE if not.
+BOOLEAN egSetScreenSize(IN OUT UINTN *ScreenWidth, IN OUT UINTN *ScreenHeight) {
+ EFI_STATUS Status = EFI_SUCCESS;
+ EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *Info;
+ UINTN Size;
+ UINT32 ModeNum = 0;
+ UINT32 UGAWidth, UGAHeight, UGADepth, UGARefreshRate;
+ BOOLEAN ModeSet = FALSE;
+
+ if ((ScreenWidth == NULL) || (ScreenHeight == NULL))
+ return FALSE;
+
+ if (GraphicsOutput != NULL) { // GOP mode (UEFI)
+ if (*ScreenHeight == 0) { // User specified a mode number (stored in *ScreenWidth); use it directly
+ ModeNum = (UINT32) *ScreenWidth;
+ if (egGetResFromMode(ScreenWidth, ScreenHeight) &&
+ (refit_call2_wrapper(GraphicsOutput->SetMode, GraphicsOutput, ModeNum) == EFI_SUCCESS)) {
+ ModeSet = TRUE;
+ }
+
+ // User specified width & height; must find mode...
+ } else {
+ // Do a loop through the modes to see if the specified one is available;
+ // and if so, switch to it....
+ do {
+ Status = refit_call4_wrapper(GraphicsOutput->QueryMode, GraphicsOutput, ModeNum, &Size, &Info);
+ if ((Status == EFI_SUCCESS) && (Size >= sizeof(*Info) && (Info != NULL)) &&
+ (Info->HorizontalResolution == *ScreenWidth) && (Info->VerticalResolution == *ScreenHeight)) {
+ Status = refit_call2_wrapper(GraphicsOutput->SetMode, GraphicsOutput, ModeNum);
+ ModeSet = (Status == EFI_SUCCESS);
+ } // if
+ } while ((++ModeNum < GraphicsOutput->Mode->MaxMode) && !ModeSet);
+ } // if/else
+
+ if (ModeSet) {
+ egScreenWidth = *ScreenWidth;
+ egScreenHeight = *ScreenHeight;
+ } else {// If unsuccessful, display an error message for the user....
+ SwitchToText(FALSE);
+ Print(L"Error setting graphics mode %d x %d; using default mode!\nAvailable modes are:\n", *ScreenWidth, *ScreenHeight);
+ ModeNum = 0;
+ do {
+ Status = refit_call4_wrapper(GraphicsOutput->QueryMode, GraphicsOutput, ModeNum, &Size, &Info);
+ if ((Status == EFI_SUCCESS) && (Info != NULL)) {
+ Print(L"Mode %d: %d x %d\n", ModeNum, Info->HorizontalResolution, Info->VerticalResolution);
+ } // else
+ } while (++ModeNum < GraphicsOutput->Mode->MaxMode);
+ PauseForKey();
+ SwitchToGraphics();
+ } // if GOP mode (UEFI)
+
+ } else if (UgaDraw != NULL) { // UGA mode (EFI 1.x)
+ // Try to use current color depth & refresh rate for new mode. Maybe not the best choice
+ // in all cases, but I don't know how to probe for alternatives....
+ Status = refit_call5_wrapper(UgaDraw->GetMode, UgaDraw, &UGAWidth, &UGAHeight, &UGADepth, &UGARefreshRate);
+ Status = refit_call5_wrapper(UgaDraw->SetMode, UgaDraw, *ScreenWidth, *ScreenHeight, UGADepth, UGARefreshRate);
+ if (Status == EFI_SUCCESS) {
+ egScreenWidth = *ScreenWidth;
+ egScreenHeight = *ScreenHeight;
+ ModeSet = TRUE;
+ } else {
+ // TODO: Find a list of supported modes and display it.
+ // NOTE: Below doesn't actually appear unless we explicitly switch to text mode.
+ // This is just a placeholder until something better can be done....
+ Print(L"Error setting graphics mode %d x %d; unsupported mode!\n");
+ } // if/else
+ } // if/else if UGA mode (EFI 1.x)
+ return (ModeSet);
+} // BOOLEAN egSetScreenSize()
+
+// Set a text mode.
+// Returns TRUE if the mode actually changed, FALSE otherwise.
+// Note that a FALSE return value can mean either an error or no change
+// necessary.
+BOOLEAN egSetTextMode(UINT32 RequestedMode) {
+ UINTN i = 0, Width, Height;
+ EFI_STATUS Status;
+ BOOLEAN ChangedIt = FALSE;
+
+ if ((RequestedMode != DONT_CHANGE_TEXT_MODE) && (RequestedMode != ST->ConOut->Mode->Mode)) {
+// SwitchToGraphics();
+ Status = refit_call2_wrapper(ST->ConOut->SetMode, ST->ConOut, RequestedMode);
+ if (Status == EFI_SUCCESS) {
+ ChangedIt = TRUE;
+ } else {
+ SwitchToText(FALSE);
+ Print(L"\nError setting text mode %d; available modes are:\n", RequestedMode);
+ do {
+ Status = refit_call4_wrapper(ST->ConOut->QueryMode, ST->ConOut, i, &Width, &Height);
+ if (Status == EFI_SUCCESS)
+ Print(L"Mode %d: %d x %d\n", i, Width, Height);
+ } while (++i < ST->ConOut->Mode->MaxMode);
+ Print(L"Mode %d: Use default mode\n", DONT_CHANGE_TEXT_MODE);
+
+ PauseForKey();
+ SwitchToGraphics();
+ } // if/else successful change
+ } // if need to change mode
+ return ChangedIt;
+} // BOOLEAN egSetTextMode()
+
CHAR16 * egScreenDescription(VOID)
{
+ CHAR16 *GraphicsInfo, *TextInfo = NULL;
+
+ GraphicsInfo = AllocateZeroPool(256 * sizeof(CHAR16));
+ if (GraphicsInfo == NULL)
+ return L"memory allocation error";
+
if (egHasGraphics) {
if (GraphicsOutput != NULL) {
- return PoolPrint(L"Graphics Output (UEFI), %dx%d",
- egScreenWidth, egScreenHeight);
+ SPrint(GraphicsInfo, 255, L"Graphics Output (UEFI), %dx%d", egScreenWidth, egScreenHeight);
} else if (UgaDraw != NULL) {
- return PoolPrint(L"UGA Draw (EFI 1.10), %dx%d",
- egScreenWidth, egScreenHeight);
+ GraphicsInfo = AllocateZeroPool(256 * sizeof(CHAR16));
+ SPrint(GraphicsInfo, 255, L"UGA Draw (EFI 1.10), %dx%d", egScreenWidth, egScreenHeight);
} else {
+ MyFreePool(GraphicsInfo);
+ MyFreePool(TextInfo);
return L"Internal Error";
}
+ if (!AllowGraphicsMode) { // graphics-capable HW, but in text mode
+ TextInfo = AllocateZeroPool(256 * sizeof(CHAR16));
+ SPrint(TextInfo, 255, L"(in %dx%d text mode)", ConWidth, ConHeight);
+ MergeStrings(&GraphicsInfo, TextInfo, L' ');
+ }
} else {
- return L"Text Console";
+ SPrint(GraphicsInfo, 255, L"Text-foo console, %dx%d", ConWidth, ConHeight);
}
+ MyFreePool(TextInfo);
+ return GraphicsInfo;
}
BOOLEAN egHasGraphicsMode(VOID)
BOOLEAN egIsGraphicsModeEnabled(VOID)
{
EFI_CONSOLE_CONTROL_SCREEN_MODE CurrentMode;
-
+
if (ConsoleControl != NULL) {
refit_call4_wrapper(ConsoleControl->GetMode, ConsoleControl, &CurrentMode, NULL, NULL);
return (CurrentMode == EfiConsoleControlScreenGraphics) ? TRUE : FALSE;
}
-
+
return FALSE;
}
VOID egClearScreen(IN EG_PIXEL *Color)
{
EFI_UGA_PIXEL FillColor;
-
+
if (!egHasGraphics)
return;
-
- FillColor.Red = Color->r;
- FillColor.Green = Color->g;
- FillColor.Blue = Color->b;
+
+ if (Color != NULL) {
+ FillColor.Red = Color->r;
+ FillColor.Green = Color->g;
+ FillColor.Blue = Color->b;
+ } else {
+ FillColor.Red = 0x0;
+ FillColor.Green = 0x0;
+ FillColor.Blue = 0x0;
+ }
FillColor.Reserved = 0;
-
+
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.
refit_call10_wrapper(GraphicsOutput->Blt, GraphicsOutput, (EFI_GRAPHICS_OUTPUT_BLT_PIXEL *)&FillColor, EfiBltVideoFill,
- 0, 0, 0, 0, egScreenWidth, egScreenHeight, 0);
+ 0, 0, 0, 0, egScreenWidth, egScreenHeight, 0);
} else if (UgaDraw != NULL) {
- refit_call10_wrapper(UgaDraw->Blt, UgaDraw, &FillColor, EfiUgaVideoFill,
- 0, 0, 0, 0, egScreenWidth, egScreenHeight, 0);
+ refit_call10_wrapper(UgaDraw->Blt, UgaDraw, &FillColor, EfiUgaVideoFill, 0, 0, 0, 0, egScreenWidth, egScreenHeight, 0);
}
}
VOID egDrawImage(IN EG_IMAGE *Image, IN UINTN ScreenPosX, IN UINTN ScreenPosY)
{
- if (!egHasGraphics)
+ EG_IMAGE *CompImage = NULL;
+
+ // NOTE: Weird seemingly redundant tests because some placement code can "wrap around" and
+ // send "negative" values, which of course become very large unsigned ints that can then
+ // wrap around AGAIN if values are added to them.....
+ if (!egHasGraphics || ((ScreenPosX + Image->Width) > egScreenWidth) || ((ScreenPosY + Image->Height) > egScreenHeight) ||
+ (ScreenPosX > egScreenWidth) || (ScreenPosY > egScreenHeight))
return;
-
- if (Image->HasAlpha) {
- Image->HasAlpha = FALSE;
- egSetPlane(PLPTR(Image, a), 0, Image->Width * Image->Height);
+
+ if ((GlobalConfig.ScreenBackground == NULL) || ((Image->Width == egScreenWidth) && (Image->Height == egScreenHeight))) {
+ CompImage = Image;
+ } else if (GlobalConfig.ScreenBackground == Image) {
+ CompImage = GlobalConfig.ScreenBackground;
+ } else {
+ CompImage = egCropImage(GlobalConfig.ScreenBackground, ScreenPosX, ScreenPosY, Image->Width, Image->Height);
+ if (CompImage == NULL) {
+ Print(L"Error! Can't crop image in egDrawImage()!\n");
+ return;
+ }
+ egComposeImage(CompImage, Image, 0, 0);
}
-
+
if (GraphicsOutput != NULL) {
- refit_call10_wrapper(GraphicsOutput->Blt, GraphicsOutput, (EFI_GRAPHICS_OUTPUT_BLT_PIXEL *)Image->PixelData, EfiBltBufferToVideo,
- 0, 0, ScreenPosX, ScreenPosY, Image->Width, Image->Height, 0);
+ refit_call10_wrapper(GraphicsOutput->Blt, GraphicsOutput, (EFI_GRAPHICS_OUTPUT_BLT_PIXEL *)CompImage->PixelData,
+ EfiBltBufferToVideo, 0, 0, ScreenPosX, ScreenPosY, CompImage->Width, CompImage->Height, 0);
} else if (UgaDraw != NULL) {
- refit_call10_wrapper(UgaDraw->Blt, UgaDraw, (EFI_UGA_PIXEL *)Image->PixelData, EfiUgaBltBufferToVideo,
- 0, 0, ScreenPosX, ScreenPosY, Image->Width, Image->Height, 0);
+ refit_call10_wrapper(UgaDraw->Blt, UgaDraw, (EFI_UGA_PIXEL *)CompImage->PixelData, EfiUgaBltBufferToVideo,
+ 0, 0, ScreenPosX, ScreenPosY, CompImage->Width, CompImage->Height, 0);
}
-}
+ if ((CompImage != GlobalConfig.ScreenBackground) && (CompImage != Image))
+ egFreeImage(CompImage);
+} /* VOID egDrawImage() */
+
+// Display an unselected icon on the screen, so that the background image shows
+// through the transparency areas. The BadgeImage may be NULL, in which case
+// it's not composited in.
+VOID egDrawImageWithTransparency(EG_IMAGE *Image, EG_IMAGE *BadgeImage, UINTN XPos, UINTN YPos, UINTN Width, UINTN Height) {
+ EG_IMAGE *Background;
+
+ Background = egCropImage(GlobalConfig.ScreenBackground, XPos, YPos, Width, Height);
+ if (Background != NULL) {
+ BltImageCompositeBadge(Background, Image, BadgeImage, XPos, YPos);
+ egFreeImage(Background);
+ }
+} // VOID DrawImageWithTransparency()
VOID egDrawImageArea(IN EG_IMAGE *Image,
IN UINTN AreaPosX, IN UINTN AreaPosY,
{
if (!egHasGraphics)
return;
-
+
egRestrictImageArea(Image, AreaPosX, AreaPosY, &AreaWidth, &AreaHeight);
if (AreaWidth == 0)
return;
-
- if (Image->HasAlpha) {
- Image->HasAlpha = FALSE;
- egSetPlane(PLPTR(Image, a), 0, Image->Width * Image->Height);
- }
-
+
if (GraphicsOutput != NULL) {
- refit_call10_wrapper(GraphicsOutput->Blt, GraphicsOutput, (EFI_GRAPHICS_OUTPUT_BLT_PIXEL *)Image->PixelData, EfiBltBufferToVideo,
- AreaPosX, AreaPosY, ScreenPosX, ScreenPosY, AreaWidth, AreaHeight, Image->Width * 4);
+ refit_call10_wrapper(GraphicsOutput->Blt, GraphicsOutput, (EFI_GRAPHICS_OUTPUT_BLT_PIXEL *)Image->PixelData,
+ EfiBltBufferToVideo, AreaPosX, AreaPosY, ScreenPosX, ScreenPosY, AreaWidth, AreaHeight,
+ Image->Width * 4);
} else if (UgaDraw != NULL) {
refit_call10_wrapper(UgaDraw->Blt, UgaDraw, (EFI_UGA_PIXEL *)Image->PixelData, EfiUgaBltBufferToVideo,
- AreaPosX, AreaPosY, ScreenPosX, ScreenPosY, AreaWidth, AreaHeight, Image->Width * 4);
+ AreaPosX, AreaPosY, ScreenPosX, ScreenPosY, AreaWidth, AreaHeight, Image->Width * 4);
}
}
+// Display a message in the center of the screen, surrounded by a box of the
+// specified color. For the moment, uses graphics calls only. (It still works
+// in text mode on GOP/UEFI systems, but not on UGA/EFI 1.x systems.)
+VOID egDisplayMessage(IN CHAR16 *Text, EG_PIXEL *BGColor) {
+ UINTN BoxWidth, BoxHeight;
+ EG_IMAGE *Box;
+
+ if ((Text != NULL) && (BGColor != NULL)) {
+ BoxWidth = (StrLen(Text) + 2) * FONT_CELL_WIDTH;
+ if (BoxWidth > egScreenWidth)
+ BoxWidth = egScreenWidth;
+ BoxHeight = 2 * FONT_CELL_HEIGHT;
+ Box = egCreateFilledImage(BoxWidth, BoxHeight, FALSE, BGColor);
+ egRenderText(Text, Box, FONT_CELL_WIDTH, FONT_CELL_HEIGHT / 2, (BGColor->r + BGColor->g + BGColor->b) / 3);
+ egDrawImage(Box, (egScreenWidth - BoxWidth) / 2, (egScreenHeight - BoxHeight) / 2);
+ } // if non-NULL inputs
+} // VOID egDisplayMessage()
+
+// Copy the current contents of the display into an EG_IMAGE....
+// Returns pointer if successful, NULL if not.
+EG_IMAGE * egCopyScreen(VOID) {
+ EG_IMAGE *Image = NULL;
+
+ if (!egHasGraphics)
+ return NULL;
+
+ // allocate a buffer for the whole screen
+ Image = egCreateImage(egScreenWidth, egScreenHeight, FALSE);
+ if (Image == NULL) {
+ return NULL;
+ }
+
+ // get full screen image
+ if (GraphicsOutput != NULL) {
+ refit_call10_wrapper(GraphicsOutput->Blt, GraphicsOutput, (EFI_GRAPHICS_OUTPUT_BLT_PIXEL *)Image->PixelData,
+ EfiBltVideoToBltBuffer, 0, 0, 0, 0, Image->Width, Image->Height, 0);
+ } else if (UgaDraw != NULL) {
+ refit_call10_wrapper(UgaDraw->Blt, UgaDraw, (EFI_UGA_PIXEL *)Image->PixelData, EfiUgaVideoToBltBuffer,
+ 0, 0, 0, 0, Image->Width, Image->Height, 0);
+ }
+ return Image;
+} // EG_IMAGE * egCopyScreen()
+
//
// Make a screenshot
//
UINT8 *FileData;
UINTN FileDataLength;
UINTN Index;
-
- if (!egHasGraphics)
- return;
-
- // allocate a buffer for the whole screen
- Image = egCreateImage(egScreenWidth, egScreenHeight, FALSE);
+
+ Image = egCopyScreen();
if (Image == NULL) {
- Print(L"Error egCreateImage returned NULL\n");
- goto bailout_wait;
+ Print(L"Error: Unable to take screen shot\n");
+ goto bailout_wait;
}
-
- // get full screen image
- if (GraphicsOutput != NULL) {
- refit_call10_wrapper(GraphicsOutput->Blt, GraphicsOutput, (EFI_GRAPHICS_OUTPUT_BLT_PIXEL *)Image->PixelData, EfiBltVideoToBltBuffer,
- 0, 0, 0, 0, Image->Width, Image->Height, 0);
- } else if (UgaDraw != NULL) {
- refit_call10_wrapper(UgaDraw->Blt, UgaDraw, (EFI_UGA_PIXEL *)Image->PixelData, EfiUgaVideoToBltBuffer,
- 0, 0, 0, 0, Image->Width, Image->Height, 0);
- }
-
+
// encode as BMP
egEncodeBMP(Image, &FileData, &FileDataLength);
egFreeImage(Image);
Print(L"Error egEncodeBMP returned NULL\n");
goto bailout_wait;
}
-
+
// save to file on the ESP
Status = egSaveFile(NULL, L"screenshot.bmp", FileData, FileDataLength);
FreePool(FileData);
Print(L"Error egSaveFile: %x\n", Status);
goto bailout_wait;
}
-
+
return;
-
+
// DEBUG: switch to text mode
bailout_wait:
egSetGraphicsModeEnabled(FALSE);