X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdeModulePkg%2FUniversal%2FConsole%2FGraphicsConsoleDxe%2FGraphicsConsole.c;h=2fe6dc02dae7578fd8aebe115c5ad272bd27025d;hp=37e816af019f1f721f9244743ba726c248fdf8c9;hb=7601dbe7c5ed94c859600649fc316918bb3572b3;hpb=7347d5d6e62ddd214f6bee9dbf8074a11015ece5 diff --git a/MdeModulePkg/Universal/Console/GraphicsConsoleDxe/GraphicsConsole.c b/MdeModulePkg/Universal/Console/GraphicsConsoleDxe/GraphicsConsole.c index 37e816af01..2fe6dc02da 100644 --- a/MdeModulePkg/Universal/Console/GraphicsConsoleDxe/GraphicsConsole.c +++ b/MdeModulePkg/Universal/Console/GraphicsConsoleDxe/GraphicsConsole.c @@ -1,58 +1,23 @@ -/**@file +/** @file This is the main routine for initializing the Graphics Console support routines. -Remaining Tasks - Add all standard Glyphs from UEFI 2.0 Specification - Implement optimal automatic Mode creation algorithm - Solve palette issues for mixed graphics and text - When does this protocol reset the palette? - -Copyright (c) 2006 - 2007 Intel Corporation.
-All rights reserved. This program and the accompanying materials -are licensed and made available under the terms and conditions of the BSD License -which accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - -**/ -#include "GraphicsConsole.h" +Copyright (c) 2006 - 2008 Intel Corporation.
+All rights reserved. This program and the accompanying materials +are licensed and made available under the terms and conditions of the BSD License +which accompanies this distribution. The full text of the license may be found at +http://opensource.org/licenses/bsd-license.php -STATIC -EFI_STATUS -GetTextColors ( - IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, - OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL *Foreground, - OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL *Background - ); +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. -STATIC -EFI_STATUS -DrawUnicodeWeightAtCursorN ( - IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, - IN CHAR16 *UnicodeWeight, - IN UINTN Count - ); - -STATIC -EFI_STATUS -EraseCursor ( - IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This - ); +**/ -EFI_STATUS -CheckModeSupported ( - EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput, - IN UINT32 HorizontalResolution, - IN UINT32 VerticalResolution, - OUT UINT32 *CurrentModeNumber - ); +#include "GraphicsConsole.h" // -// Globals +// Graphics Console Device Private Data template // -GRAPHICS_CONSOLE_DEV mGraphicsConsoleDevTemplate = { +GRAPHICS_CONSOLE_DEV mGraphicsConsoleDevTemplate = { GRAPHICS_CONSOLE_DEV_SIGNATURE, (EFI_GRAPHICS_OUTPUT_PROTOCOL *) NULL, (EFI_UGA_DRAW_PROTOCOL *) NULL, @@ -83,41 +48,47 @@ GRAPHICS_CONSOLE_DEV mGraphicsConsoleDevTemplate = { { 0, 0, 0, 0, 0, 0 } // Mode 3 }, (EFI_GRAPHICS_OUTPUT_BLT_PIXEL *) NULL, - (EFI_HII_HANDLE) 0 + (EFI_HII_HANDLE ) 0 }; -EFI_HII_PROTOCOL *mHii; +EFI_HII_DATABASE_PROTOCOL *mHiiDatabase; +EFI_HII_FONT_PROTOCOL *mHiiFont; +BOOLEAN mFirstAccessFlag = TRUE; + +EFI_GUID mFontPackageListGuid = {0xf5f219d3, 0x7006, 0x4648, {0xac, 0x8d, 0xd6, 0x1d, 0xfb, 0x7b, 0xc6, 0xad}}; -static CHAR16 mCrLfString[3] = { CHAR_CARRIAGE_RETURN, CHAR_LINEFEED, CHAR_NULL }; +CHAR16 mCrLfString[3] = { CHAR_CARRIAGE_RETURN, CHAR_LINEFEED, CHAR_NULL }; -static EFI_GRAPHICS_OUTPUT_BLT_PIXEL mEfiColors[16] = { +EFI_GRAPHICS_OUTPUT_BLT_PIXEL mEfiColors[16] = { // - // B G R + // B G R reserved // {0x00, 0x00, 0x00, 0x00}, // BLACK - {0x98, 0x00, 0x00, 0x00}, // BLUE - {0x00, 0x98, 0x00, 0x00}, // GREEN - {0x98, 0x98, 0x00, 0x00}, // CYAN - {0x00, 0x00, 0x98, 0x00}, // RED + {0x98, 0x00, 0x00, 0x00}, // LIGHTBLUE + {0x00, 0x98, 0x00, 0x00}, // LIGHGREEN + {0x98, 0x98, 0x00, 0x00}, // LIGHCYAN + {0x00, 0x00, 0x98, 0x00}, // LIGHRED {0x98, 0x00, 0x98, 0x00}, // MAGENTA {0x00, 0x98, 0x98, 0x00}, // BROWN {0x98, 0x98, 0x98, 0x00}, // LIGHTGRAY {0x30, 0x30, 0x30, 0x00}, // DARKGRAY - BRIGHT BLACK - {0xff, 0x00, 0x00, 0x00}, // LIGHTBLUE - ? - {0x00, 0xff, 0x00, 0x00}, // LIGHTGREEN - ? - {0xff, 0xff, 0x00, 0x00}, // LIGHTCYAN - {0x00, 0x00, 0xff, 0x00}, // LIGHTRED - {0xff, 0x00, 0xff, 0x00}, // LIGHTMAGENTA - {0x00, 0xff, 0xff, 0x00}, // LIGHTBROWN - {0xff, 0xff, 0xff, 0x00} // WHITE + {0xff, 0x00, 0x00, 0x00}, // BLUE + {0x00, 0xff, 0x00, 0x00}, // LIME + {0xff, 0xff, 0x00, 0x00}, // CYAN + {0x00, 0x00, 0xff, 0x00}, // RED + {0xff, 0x00, 0xff, 0x00}, // FUCHSIA + {0x00, 0xff, 0xff, 0x00}, // YELLOW + {0xff, 0xff, 0xff, 0x00} // WHITE }; -static EFI_NARROW_GLYPH mCursorGlyph = { +EFI_NARROW_GLYPH mCursorGlyph = { 0x0000, 0x00, { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF, 0xFF, 0xFF } }; +CHAR16 SpaceStr[] = { NARROW_CHAR, ' ', 0 }; + EFI_DRIVER_BINDING_PROTOCOL gGraphicsConsoleDriverBinding = { GraphicsConsoleControllerDriverSupported, GraphicsConsoleControllerDriverStart, @@ -127,6 +98,100 @@ EFI_DRIVER_BINDING_PROTOCOL gGraphicsConsoleDriverBinding = { NULL }; +/** + Gets Graphics Console devcie's foreground color and background color. + + @param This Protocol instance pointer. + @param Foreground Returned text foreground color. + @param Background Returned text background color. + + @retval EFI_SUCCESS It returned always. + +**/ +EFI_STATUS +GetTextColors ( + IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, + OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL *Foreground, + OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL *Background + ); + +/** + Draw Unicode string on the Graphics Console device's screen. + + @param This Protocol instance pointer. + @param UnicodeWeight One Unicode string to be displayed. + @param Count The count of Unicode string. + + @retval EFI_OUT_OF_RESOURCES If no memory resource to use. + @retval EFI_UNSUPPORTED If no Graphics Output protocol and UGA Draw + protocol exist. + @retval EFI_SUCCESS Drawing Unicode string implemented successfully. + +**/ +EFI_STATUS +DrawUnicodeWeightAtCursorN ( + IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, + IN CHAR16 *UnicodeWeight, + IN UINTN Count + ); + +/** + Erase the cursor on the screen. + + @param This Protocol instance pointer. + + @retval EFI_SUCCESS The cursor is erased successfully. + +**/ +EFI_STATUS +EraseCursor ( + IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This + ); + +/** + Check if the current specific mode supported the user defined resolution + for the Graphics Console device based on Graphics Output Protocol. + + If yes, set the graphic device's current mode to this specific mode. + + @param GraphicsOutput Graphics Output Protocol instance pointer. + @param HorizontalResolution User defined horizontal resolution + @param VerticalResolution User defined vertical resolution. + @param CurrentModeNumber Current specific mode to be check. + + @retval EFI_SUCCESS The mode is supported. + @retval EFI_UNSUPPORTED The specific mode is out of range of graphics + device supported. + @retval other The specific mode does not support user defined + resolution or failed to set the current mode to the + specific mode on graphics device. + +**/ +EFI_STATUS +CheckModeSupported ( + EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput, + IN UINT32 HorizontalResolution, + IN UINT32 VerticalResolution, + OUT UINT32 *CurrentModeNumber + ); + + +/** + Test to see if Graphics Console could be supported on the Controller. + + Graphics Console could be supported if Graphics Output Protocol or UGA Draw + Protocol exists on the Controller. (UGA Draw Protocol could be skipped + if PcdUgaConsumeSupport is set to FALSE.) + + @param This Protocol instance pointer. + @param Controller Handle of device to test. + @param RemainingDevicePath Optional parameter use to pick a specific child + device to start. + + @retval EFI_SUCCESS This driver supports this device. + @retval other This driver does not support this device. + +**/ EFI_STATUS EFIAPI GraphicsConsoleControllerDriverSupported ( @@ -135,12 +200,13 @@ GraphicsConsoleControllerDriverSupported ( IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath ) { - EFI_STATUS Status; + EFI_STATUS Status; EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput; - EFI_UGA_DRAW_PROTOCOL *UgaDraw; - EFI_DEVICE_PATH_PROTOCOL *DevicePath; + EFI_UGA_DRAW_PROTOCOL *UgaDraw; + EFI_DEVICE_PATH_PROTOCOL *DevicePath; - UgaDraw = NULL; + GraphicsOutput = NULL; + UgaDraw = NULL; // // Open the IO Abstraction(s) needed to perform the supported test // @@ -152,9 +218,8 @@ GraphicsConsoleControllerDriverSupported ( Controller, EFI_OPEN_PROTOCOL_BY_DRIVER ); - - if (EFI_ERROR (Status)) { - GraphicsOutput = NULL; + + if (EFI_ERROR (Status) && FeaturePcdGet (PcdUgaConsumeSupport)) { // // Open Graphics Output Protocol failed, try to open UGA Draw Protocol // @@ -166,9 +231,9 @@ GraphicsConsoleControllerDriverSupported ( Controller, EFI_OPEN_PROTOCOL_BY_DRIVER ); - if (EFI_ERROR (Status)) { - return Status; - } + } + if (EFI_ERROR (Status)) { + return Status; } // @@ -194,6 +259,7 @@ GraphicsConsoleControllerDriverSupported ( } else { goto Error; } + // // Does Hii Exist? If not, we aren't ready to run // @@ -210,7 +276,7 @@ Error: This->DriverBindingHandle, Controller ); - } else { + } else if (FeaturePcdGet (PcdUgaConsumeSupport)) { gBS->CloseProtocol ( Controller, &gEfiUgaDrawProtocolGuid, @@ -221,6 +287,21 @@ Error: return Status; } + +/** + Start this driver on Controller by opening Graphics Output protocol or + UGA Draw protocol, and installing Simple Text Out protocol on Controller. + (UGA Draw protocol could be skipped if PcdUgaConsumeSupport is set to FALSE.) + + @param This Protocol instance pointer. + @param Controller Handle of device to bind driver to + @param RemainingDevicePath Optional parameter use to pick a specific child + device to start. + + @retval EFI_SUCCESS This driver is added to Controller. + @retval other This driver does not support this device. + +**/ EFI_STATUS EFIAPI GraphicsConsoleControllerDriverStart ( @@ -228,30 +309,10 @@ GraphicsConsoleControllerDriverStart ( IN EFI_HANDLE Controller, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath ) -/*++ - - Routine Description: - - Start the controller. - - Arguments: - - This - A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. - Controller - The handle of the controller to start. - RemainingDevicePath - A pointer to the remaining portion of a devcie path. - - Returns: - - EFI_SUCCESS - Return successfully. - EFI_OUT_OF_RESOURCES - Out of resources. - ---*/ { EFI_STATUS Status; GRAPHICS_CONSOLE_DEV *Private; - EFI_HII_PACKAGES *Package; - EFI_HII_FONT_PACK *FontPack; - UINTN NarrowFontSize; + UINT32 NarrowFontSize; UINT32 HorizontalResolution; UINT32 VerticalResolution; UINT32 ColorDepth; @@ -259,9 +320,13 @@ GraphicsConsoleControllerDriverStart ( UINTN MaxMode; UINTN Columns; UINTN Rows; - UINT8 *Location; UINT32 ModeNumber; - + EFI_HII_SIMPLE_FONT_PACKAGE_HDR *SimplifiedFont; + UINT32 PackageLength; + EFI_HII_PACKAGE_LIST_HEADER *PackageList; + UINT8 *Package; + UINT8 *Location; + EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE *Mode; ModeNumber = 0; // @@ -285,9 +350,8 @@ GraphicsConsoleControllerDriverStart ( Controller, EFI_OPEN_PROTOCOL_BY_DRIVER ); - if (EFI_ERROR(Status)) { - Private->GraphicsOutput = NULL; + if (EFI_ERROR(Status) && FeaturePcdGet (PcdUgaConsumeSupport)) { Status = gBS->OpenProtocol ( Controller, &gEfiUgaDrawProtocolGuid, @@ -296,60 +360,74 @@ GraphicsConsoleControllerDriverStart ( Controller, EFI_OPEN_PROTOCOL_BY_DRIVER ); - if (EFI_ERROR (Status)) { - goto Error; - } } - // - // Get the HII protocol. If Supported() succeeds, do we really - // need to get HII protocol again? - // - Status = EfiLocateHiiProtocol (); if (EFI_ERROR (Status)) { goto Error; } NarrowFontSize = ReturnNarrowFontSize (); - FontPack = AllocateZeroPool (sizeof (EFI_HII_FONT_PACK) + NarrowFontSize); - ASSERT (FontPack); - - FontPack->Header.Length = (UINT32) (sizeof (EFI_HII_FONT_PACK) + NarrowFontSize); - FontPack->Header.Type = EFI_HII_FONT; - FontPack->NumberOfNarrowGlyphs = (UINT16) (NarrowFontSize / sizeof (EFI_NARROW_GLYPH)); + if (mFirstAccessFlag) { + // + // Add 4 bytes to the header for entire length for HiiLibPreparePackageList use only. + // Looks ugly. Might be updated when font tool is ready. + // + // +--------------------------------+ <-- Package + // | | + // | PackageLength(4 bytes) | + // | | + // |--------------------------------| <-- SimplifiedFont + // | | + // |EFI_HII_SIMPLE_FONT_PACKAGE_HDR | + // | | + // |--------------------------------| <-- Location + // | | + // | gUsStdNarrowGlyphData | + // | | + // +--------------------------------+ + + PackageLength = sizeof (EFI_HII_SIMPLE_FONT_PACKAGE_HDR) + NarrowFontSize + 4; + Package = AllocateZeroPool (PackageLength); + if (Package == NULL) { + return EFI_OUT_OF_RESOURCES; + } + WriteUnaligned32((UINT32 *) Package,PackageLength); + SimplifiedFont = (EFI_HII_SIMPLE_FONT_PACKAGE_HDR *) (Package + 4); + SimplifiedFont->Header.Length = (UINT32) (PackageLength - 4); + SimplifiedFont->Header.Type = EFI_HII_PACKAGE_SIMPLE_FONTS; + SimplifiedFont->NumberOfNarrowGlyphs = (UINT16) (NarrowFontSize / sizeof (EFI_NARROW_GLYPH)); - Location = (UINT8 *) (&FontPack->NumberOfWideGlyphs + sizeof (UINT8)); - CopyMem (Location, UsStdNarrowGlyphData, NarrowFontSize); + Location = (UINT8 *) (&SimplifiedFont->NumberOfWideGlyphs + 1); + CopyMem (Location, gUsStdNarrowGlyphData, NarrowFontSize); - // - // Register our Fonts into the global database - // - Package = PreparePackages (1, NULL, FontPack); - mHii->NewPack (mHii, Package, &(Private->HiiHandle)); - FreePool (Package); - - // - // Free the font database - // - FreePool (FontPack); + // + // Add this simplified font package to a package list then install it. + // + PackageList = HiiLibPreparePackageList (1, &mFontPackageListGuid, Package); + Status = mHiiDatabase->NewPackageList (mHiiDatabase, PackageList, NULL, &(Private->HiiHandle)); + ASSERT_EFI_ERROR (Status); + FreePool (PackageList); + FreePool (Package); + mFirstAccessFlag = FALSE; + } // - // If the current mode information can not be retrieved, then attemp to set the default mode - // of 800x600, 32 bit colot, 60 Hz refresh. + // If the current mode information can not be retrieved, then attempt to set the default mode + // of 800x600, 32 bit color, 60 Hz refresh. // HorizontalResolution = 800; VerticalResolution = 600; if (Private->GraphicsOutput != NULL) { // - // The console is build on top of Graphics Output Protocol, find the mode number + // The console is build on top of Graphics Output Protocol, find the mode number // for the user-defined mode; if there are multiple video devices, // graphic console driver will set all the video devices to the same mode. // Status = CheckModeSupported ( - Private->GraphicsOutput, - CURRENT_HORIZONTAL_RESOLUTION, + Private->GraphicsOutput, + CURRENT_HORIZONTAL_RESOLUTION, CURRENT_VERTICAL_RESOLUTION, &ModeNumber ); @@ -364,22 +442,24 @@ GraphicsConsoleControllerDriverStart ( // if not supporting current mode, try 800x600 which is required by UEFI/EFI spec // Status = CheckModeSupported ( - Private->GraphicsOutput, - 800, - 600, + Private->GraphicsOutput, + 800, + 600, &ModeNumber ); } - - if (EFI_ERROR (Status) || (ModeNumber == Private->GraphicsOutput->Mode->MaxMode)) { + + Mode = Private->GraphicsOutput->Mode; + + if (EFI_ERROR (Status) || (Mode->MaxMode)) { // // Set default mode failed or device don't support default mode, then get the current mode information // - HorizontalResolution = Private->GraphicsOutput->Mode->Info->HorizontalResolution; - VerticalResolution = Private->GraphicsOutput->Mode->Info->VerticalResolution; - ModeNumber = Private->GraphicsOutput->Mode->Mode; + HorizontalResolution = Mode->Info->HorizontalResolution; + VerticalResolution = Mode->Info->VerticalResolution; + ModeNumber = Mode->Mode; } - } else { + } else if (FeaturePcdGet (PcdUgaConsumeSupport)) { // // At first try to set user-defined resolution // @@ -395,7 +475,7 @@ GraphicsConsoleControllerDriverStart ( if (!EFI_ERROR (Status)) { HorizontalResolution = CURRENT_HORIZONTAL_RESOLUTION; VerticalResolution = CURRENT_VERTICAL_RESOLUTION; - } else { + } else if (FeaturePcdGet (PcdUgaConsumeSupport)) { // // Try to set 800*600 which is required by UEFI/EFI spec // @@ -418,14 +498,17 @@ GraphicsConsoleControllerDriverStart ( goto Error; } } + } else { + Status = EFI_UNSUPPORTED; + goto Error; } } // // Compute the maximum number of text Rows and Columns that this current graphics mode can support // - Columns = HorizontalResolution / GLYPH_WIDTH; - Rows = VerticalResolution / GLYPH_HEIGHT; + Columns = HorizontalResolution / EFI_GLYPH_WIDTH; + Rows = VerticalResolution / EFI_GLYPH_HEIGHT; // // See if the mode is too small to support the required 80x25 text mode @@ -437,22 +520,22 @@ GraphicsConsoleControllerDriverStart ( // Add Mode #0 that must be 80x25 // MaxMode = 0; - Private->ModeData[MaxMode].GopWidth = HorizontalResolution; - Private->ModeData[MaxMode].GopHeight = VerticalResolution; + Private->ModeData[MaxMode].GopWidth = HorizontalResolution; + Private->ModeData[MaxMode].GopHeight = VerticalResolution; Private->ModeData[MaxMode].GopModeNumber = ModeNumber; - Private->ModeData[MaxMode].DeltaX = (HorizontalResolution - (80 * GLYPH_WIDTH)) >> 1; - Private->ModeData[MaxMode].DeltaY = (VerticalResolution - (25 * GLYPH_HEIGHT)) >> 1; + Private->ModeData[MaxMode].DeltaX = (HorizontalResolution - (80 * EFI_GLYPH_WIDTH)) >> 1; + Private->ModeData[MaxMode].DeltaY = (VerticalResolution - (25 * EFI_GLYPH_HEIGHT)) >> 1; MaxMode++; // // If it is possible to support Mode #1 - 80x50, than add it as an active mode // if (Rows >= 50) { - Private->ModeData[MaxMode].GopWidth = HorizontalResolution; - Private->ModeData[MaxMode].GopHeight = VerticalResolution; + Private->ModeData[MaxMode].GopWidth = HorizontalResolution; + Private->ModeData[MaxMode].GopHeight = VerticalResolution; Private->ModeData[MaxMode].GopModeNumber = ModeNumber; - Private->ModeData[MaxMode].DeltaX = (HorizontalResolution - (80 * GLYPH_WIDTH)) >> 1; - Private->ModeData[MaxMode].DeltaY = (VerticalResolution - (50 * GLYPH_HEIGHT)) >> 1; + Private->ModeData[MaxMode].DeltaX = (HorizontalResolution - (80 * EFI_GLYPH_WIDTH)) >> 1; + Private->ModeData[MaxMode].DeltaY = (VerticalResolution - (50 * EFI_GLYPH_HEIGHT)) >> 1; MaxMode++; } @@ -460,25 +543,25 @@ GraphicsConsoleControllerDriverStart ( // If it is not to support Mode #1 - 80x50, then skip it // if (MaxMode < 2) { - Private->ModeData[MaxMode].Columns = 0; - Private->ModeData[MaxMode].Rows = 0; - Private->ModeData[MaxMode].GopWidth = HorizontalResolution; - Private->ModeData[MaxMode].GopHeight = VerticalResolution; + Private->ModeData[MaxMode].Columns = 0; + Private->ModeData[MaxMode].Rows = 0; + Private->ModeData[MaxMode].GopWidth = HorizontalResolution; + Private->ModeData[MaxMode].GopHeight = VerticalResolution; Private->ModeData[MaxMode].GopModeNumber = ModeNumber; - Private->ModeData[MaxMode].DeltaX = 0; - Private->ModeData[MaxMode].DeltaY = 0; + Private->ModeData[MaxMode].DeltaX = 0; + Private->ModeData[MaxMode].DeltaY = 0; MaxMode++; } - + // // Add Mode #2 that must be 100x31 (graphic mode >= 800x600) // - if (Columns >= 100 && Rows >= 31) { - Private->ModeData[MaxMode].GopWidth = HorizontalResolution; - Private->ModeData[MaxMode].GopHeight = VerticalResolution; + if (Columns >= 100 && Rows >= 31) { + Private->ModeData[MaxMode].GopWidth = HorizontalResolution; + Private->ModeData[MaxMode].GopHeight = VerticalResolution; Private->ModeData[MaxMode].GopModeNumber = ModeNumber; - Private->ModeData[MaxMode].DeltaX = (HorizontalResolution - (100 * GLYPH_WIDTH)) >> 1; - Private->ModeData[MaxMode].DeltaY = (VerticalResolution - (31 * GLYPH_HEIGHT)) >> 1; + Private->ModeData[MaxMode].DeltaX = (HorizontalResolution - (100 * EFI_GLYPH_WIDTH)) >> 1; + Private->ModeData[MaxMode].DeltaY = (VerticalResolution - (31 * EFI_GLYPH_HEIGHT)) >> 1; MaxMode++; } @@ -486,16 +569,16 @@ GraphicsConsoleControllerDriverStart ( // Add Mode #3 that uses the entire display for user-defined mode // if (HorizontalResolution > 800 && VerticalResolution > 600) { - Private->ModeData[MaxMode].Columns = HorizontalResolution/GLYPH_WIDTH; - Private->ModeData[MaxMode].Rows = VerticalResolution/GLYPH_HEIGHT; - Private->ModeData[MaxMode].GopWidth = HorizontalResolution; - Private->ModeData[MaxMode].GopHeight = VerticalResolution; + Private->ModeData[MaxMode].Columns = HorizontalResolution/EFI_GLYPH_WIDTH; + Private->ModeData[MaxMode].Rows = VerticalResolution/EFI_GLYPH_HEIGHT; + Private->ModeData[MaxMode].GopWidth = HorizontalResolution; + Private->ModeData[MaxMode].GopHeight = VerticalResolution; Private->ModeData[MaxMode].GopModeNumber = ModeNumber; - Private->ModeData[MaxMode].DeltaX = (HorizontalResolution % GLYPH_WIDTH) >> 1; - Private->ModeData[MaxMode].DeltaY = (VerticalResolution % GLYPH_HEIGHT) >> 1; + Private->ModeData[MaxMode].DeltaX = (HorizontalResolution % EFI_GLYPH_WIDTH) >> 1; + Private->ModeData[MaxMode].DeltaY = (VerticalResolution % EFI_GLYPH_HEIGHT) >> 1; MaxMode++; } - + // // Update the maximum number of modes // @@ -526,7 +609,7 @@ GraphicsConsoleControllerDriverStart ( Error: if (EFI_ERROR (Status)) { // - // Close the GOP or UGA IO Protocol + // Close the GOP and UGA Draw Protocol // if (Private->GraphicsOutput != NULL) { gBS->CloseProtocol ( @@ -535,7 +618,7 @@ Error: This->DriverBindingHandle, Controller ); - } else { + } else if (FeaturePcdGet (PcdUgaConsumeSupport)) { gBS->CloseProtocol ( Controller, &gEfiUgaDrawProtocolGuid, @@ -558,6 +641,24 @@ Error: return Status; } +/** + Stop this driver on Controller by removing Simple Text Out protocol + and closing the Graphics Output Protocol or UGA Draw protocol on Controller. + (UGA Draw protocol could be skipped if PcdUgaConsumeSupport is set to FALSE.) + + + @param This Protocol instance pointer. + @param Controller Handle of device to stop driver on + @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of + children is zero stop the entire bus driver. + @param ChildHandleBuffer List of Child Handles to Stop. + + @retval EFI_SUCCESS This driver is removed Controller. + @retval EFI_NOT_STARTED Simple Text Out protocol could not be found the + Controller. + @retval other This driver was not removed from this device. + +**/ EFI_STATUS EFIAPI GraphicsConsoleControllerDriverStop ( @@ -602,7 +703,7 @@ GraphicsConsoleControllerDriverStop ( This->DriverBindingHandle, Controller ); - } else { + } else if (FeaturePcdGet (PcdUgaConsumeSupport)) { gBS->CloseProtocol ( Controller, &gEfiUgaDrawProtocolGuid, @@ -614,7 +715,10 @@ GraphicsConsoleControllerDriverStop ( // // Remove the font pack // - mHii->RemovePack (mHii, Private->HiiHandle); + if (Private->HiiHandle != NULL) { + HiiLibRemovePackages (Private->HiiHandle); + mFirstAccessFlag = TRUE; + } // // Free our instance data @@ -628,22 +732,43 @@ GraphicsConsoleControllerDriverStop ( return Status; } +/** + Check if the current specific mode supported the user defined resolution + for the Graphics Console device based on Graphics Output Protocol. + + If yes, set the graphic devcice's current mode to this specific mode. + + @param GraphicsOutput Graphics Output Protocol instance pointer. + @param HorizontalResolution User defined horizontal resolution + @param VerticalResolution User defined vertical resolution. + @param CurrentModeNumber Current specific mode to be check. + + @retval EFI_SUCCESS The mode is supported. + @retval EFI_UNSUPPORTED The specific mode is out of range of graphics + device supported. + @retval other The specific mode does not support user defined + resolution or failed to set the current mode to the + specific mode on graphics device. + +**/ EFI_STATUS CheckModeSupported ( EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput, - IN UINT32 HorizontalResolution, - IN UINT32 VerticalResolution, - OUT UINT32 *CurrentModeNumber + IN UINT32 HorizontalResolution, + IN UINT32 VerticalResolution, + OUT UINT32 *CurrentModeNumber ) { UINT32 ModeNumber; EFI_STATUS Status; - UINTN SizeOfInfo; + UINTN SizeOfInfo; EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *Info; - - Status = EFI_SUCCESS; + UINT32 MaxMode; + + Status = EFI_SUCCESS; + MaxMode = GraphicsOutput->Mode->MaxMode; - for (ModeNumber = 0; ModeNumber < GraphicsOutput->Mode->MaxMode; ModeNumber++) { + for (ModeNumber = 0; ModeNumber < MaxMode; ModeNumber++) { Status = GraphicsOutput->QueryMode ( GraphicsOutput, ModeNumber, @@ -655,36 +780,36 @@ CheckModeSupported ( (Info->VerticalResolution == VerticalResolution)) { Status = GraphicsOutput->SetMode (GraphicsOutput, ModeNumber); if (!EFI_ERROR (Status)) { - gBS->FreePool (Info); + FreePool (Info); break; } } - gBS->FreePool (Info); + FreePool (Info); } } - + if (ModeNumber == GraphicsOutput->Mode->MaxMode) { Status = EFI_UNSUPPORTED; } - + *CurrentModeNumber = ModeNumber; - return Status; + return Status; } + +/** + Locate HII Database protocol and HII Font protocol. + + @retval EFI_SUCCESS HII Database protocol and HII Font protocol + are located successfully. + @return other Failed to locate HII Database protocol or + HII Font protocol. + +**/ EFI_STATUS EfiLocateHiiProtocol ( VOID ) -/*++ - - Routine Description: - Find if the HII protocol is available. If yes, locate the HII protocol - - Arguments: - - Returns: - ---*/ { EFI_HANDLE Handle; UINTN Size; @@ -697,10 +822,10 @@ EfiLocateHiiProtocol ( Status = gBS->LocateHandle ( ByProtocol, - &gEfiHiiProtocolGuid, + &gEfiHiiDatabaseProtocolGuid, NULL, &Size, - &Handle + (VOID **) &Handle ); if (EFI_ERROR (Status)) { @@ -709,84 +834,84 @@ EfiLocateHiiProtocol ( Status = gBS->HandleProtocol ( Handle, - &gEfiHiiProtocolGuid, - (VOID **)&mHii + &gEfiHiiDatabaseProtocolGuid, + (VOID **) &mHiiDatabase ); + if (EFI_ERROR (Status)) { + return Status; + } + + Status = gBS->HandleProtocol ( + Handle, + &gEfiHiiFontProtocolGuid, + (VOID **) &mHiiFont + ); return Status; } + // // Body of the STO functions // + +/** + Reset the text output device hardware and optionally run diagnostics. + + Implements SIMPLE_TEXT_OUTPUT.Reset(). + If ExtendeVerification is TRUE, then perform dependent Graphics Console + device reset, and set display mode to mode 0. + If ExtendedVerification is FALSE, only set display mode to mode 0. + + @param This Protocol instance pointer. + @param ExtendedVerification Indicates that the driver may perform a more + exhaustive verification operation of the device + during reset. + + @retval EFI_SUCCESS The text output device was reset. + @retval EFI_DEVICE_ERROR The text output device is not functioning correctly and + could not be reset. + +**/ EFI_STATUS EFIAPI GraphicsConsoleConOutReset ( IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN BOOLEAN ExtendedVerification ) -/*++ - Routine Description: - - Implements SIMPLE_TEXT_OUTPUT.Reset(). - If ExtendeVerification is TRUE, then perform dependent Graphics Console - device reset, and set display mode to mode 0. - If ExtendedVerification is FALSE, only set display mode to mode 0. - - Arguments: - - This - Indicates the calling context. - - ExtendedVerification - Indicates that the driver may perform a more exhaustive - verification operation of the device during reset. - - Returns: - - EFI_SUCCESS - The reset operation succeeds. - - EFI_DEVICE_ERROR - The Graphics Console is not functioning correctly - ---*/ { This->SetAttribute (This, EFI_TEXT_ATTR (This->Mode->Attribute & 0x0F, EFI_BACKGROUND_BLACK)); return This->SetMode (This, 0); } + +/** + Write a Unicode string to the output device. + + Implements SIMPLE_TEXT_OUTPUT.OutputString(). + The Unicode string will be converted to Glyphs and will be + sent to the Graphics Console. + + @param This Protocol instance pointer. + @param WString The NULL-terminated Unicode string to be displayed + on the output device(s). All output devices must + also support the Unicode drawing defined in this file. + + @retval EFI_SUCCESS The string was output to the device. + @retval EFI_DEVICE_ERROR The device reported an error while attempting to output + the text. + @retval EFI_UNSUPPORTED The output device's mode is not currently in a + defined text mode. + @retval EFI_WARN_UNKNOWN_GLYPH This warning code indicates that some of the + characters in the Unicode string could not be + rendered and were skipped. + +**/ EFI_STATUS EFIAPI GraphicsConsoleConOutOutputString ( IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN CHAR16 *WString ) -/*++ - Routine Description: - - Implements SIMPLE_TEXT_OUTPUT.OutputString(). - The Unicode string will be converted to Glyphs and will be - sent to the Graphics Console. - - - Arguments: - - This - Indicates the calling context. - - WString - The Null-terminated Unicode string to be displayed on - the Graphics Console. - - Returns: - - EFI_SUCCESS - The string is output successfully. - - EFI_DEVICE_ERROR - The Graphics Console failed to send the string out. - - EFI_WARN_UNKNOWN_GLYPH - Indicates that some of the characters in the Unicode string could not - be rendered and are skipped. - ---*/ { GRAPHICS_CONSOLE_DEV *Private; EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput; @@ -807,7 +932,6 @@ GraphicsConsoleConOutOutputString ( UINTN Index; INT32 OriginAttribute; EFI_TPL OldTpl; - CHAR16 SpaceStr[] = { NARROW_CHAR, ' ', 0 }; Status = EFI_SUCCESS; @@ -824,8 +948,8 @@ GraphicsConsoleConOutOutputString ( MaxRow = Private->ModeData[Mode].Rows; DeltaX = Private->ModeData[Mode].DeltaX; DeltaY = Private->ModeData[Mode].DeltaY; - Width = MaxColumn * GLYPH_WIDTH; - Height = (MaxRow - 1) * GLYPH_HEIGHT; + Width = MaxColumn * EFI_GLYPH_WIDTH; + Height = (MaxRow - 1) * EFI_GLYPH_HEIGHT; Delta = Width * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL); // @@ -842,7 +966,7 @@ GraphicsConsoleConOutOutputString ( // OriginAttribute = This->Mode->Attribute; - while (*WString) { + while (*WString != L'\0') { if (*WString == CHAR_BACKSPACE) { // @@ -885,7 +1009,7 @@ GraphicsConsoleConOutOutputString ( NULL, EfiBltVideoToVideo, DeltaX, - DeltaY + GLYPH_HEIGHT, + DeltaY + EFI_GLYPH_HEIGHT, DeltaX, DeltaY, Width, @@ -905,10 +1029,10 @@ GraphicsConsoleConOutOutputString ( DeltaX, DeltaY + Height, Width, - GLYPH_HEIGHT, + EFI_GLYPH_HEIGHT, Delta ); - } else { + } else if (FeaturePcdGet (PcdUgaConsumeSupport)) { // // Scroll Screen Up One Row // @@ -917,7 +1041,7 @@ GraphicsConsoleConOutOutputString ( NULL, EfiUgaVideoToVideo, DeltaX, - DeltaY + GLYPH_HEIGHT, + DeltaY + EFI_GLYPH_HEIGHT, DeltaX, DeltaY, Width, @@ -937,7 +1061,7 @@ GraphicsConsoleConOutOutputString ( DeltaX, DeltaY + Height, Width, - GLYPH_HEIGHT, + EFI_GLYPH_HEIGHT, Delta ); } @@ -979,27 +1103,12 @@ GraphicsConsoleConOutOutputString ( // Count is used to determine how many characters are used regardless of their attributes // for (Count = 0, Index = 0; (This->Mode->CursorColumn + Index) < MaxColumn; Count++, Index++) { - if (WString[Count] == CHAR_NULL) { - break; - } - - if (WString[Count] == CHAR_BACKSPACE) { - break; - } - - if (WString[Count] == CHAR_LINEFEED) { - break; - } - - if (WString[Count] == CHAR_CARRIAGE_RETURN) { - break; - } - - if (WString[Count] == WIDE_CHAR) { - break; - } - - if (WString[Count] == NARROW_CHAR) { + if (WString[Count] == CHAR_NULL || + WString[Count] == CHAR_BACKSPACE || + WString[Count] == CHAR_LINEFEED || + WString[Count] == CHAR_CARRIAGE_RETURN || + WString[Count] == WIDE_CHAR || + WString[Count] == NARROW_CHAR) { break; } // @@ -1057,56 +1166,53 @@ GraphicsConsoleConOutOutputString ( } +/** + Verifies that all characters in a Unicode string can be output to the + target device. + + Implements SIMPLE_TEXT_OUTPUT.QueryMode(). + If one of the characters in the *Wstring is neither valid valid Unicode + drawing characters, not ASCII code, then this function will return + EFI_UNSUPPORTED + + @param This Protocol instance pointer. + @param WString The NULL-terminated Unicode string to be examined for the output + device(s). + + @retval EFI_SUCCESS The device(s) are capable of rendering the output string. + @retval EFI_UNSUPPORTED Some of the characters in the Unicode string cannot be + rendered by one or more of the output devices mapped + by the EFI handle. + +**/ EFI_STATUS EFIAPI GraphicsConsoleConOutTestString ( IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN CHAR16 *WString ) -/*++ - Routine Description: - - Implements SIMPLE_TEXT_OUTPUT.TestString(). - If one of the characters in the *Wstring is - neither valid valid Unicode drawing characters, - not ASCII code, then this function will return - EFI_UNSUPPORTED. - - - Arguments: - - This - Indicates the calling context. - - WString - The Null-terminated Unicode string to be tested. - - Returns: - - EFI_SUCCESS - The Graphics Console is capable of rendering the output string. - - EFI_UNSUPPORTED - Some of the characters in the Unicode string cannot be rendered. - ---*/ { EFI_STATUS Status; - UINT16 GlyphWidth; - UINT32 GlyphStatus; UINT16 Count; - GLYPH_UNION *Glyph; - - GlyphStatus = 0; - Count = 0; - - while (WString[Count]) { - Status = mHii->GetGlyph ( - mHii, - WString, - &Count, - (UINT8 **) &Glyph, - &GlyphWidth, - &GlyphStatus - ); + + EFI_IMAGE_OUTPUT *Blt; + + Blt = NULL; + Count = 0; + + while (WString[Count] != 0) { + Status = mHiiFont->GetGlyph ( + mHiiFont, + WString[Count], + NULL, + &Blt, + NULL + ); + if (Blt != NULL) { + FreePool (Blt); + Blt = NULL; + } + Count++; if (EFI_ERROR (Status)) { return EFI_UNSUPPORTED; @@ -1116,6 +1222,24 @@ GraphicsConsoleConOutTestString ( return EFI_SUCCESS; } + +/** + Returns information for an available text mode that the output device(s) + supports + + Implements SIMPLE_TEXT_OUTPUT.QueryMode(). + It returnes information for an available text mode that the Graphics Console supports. + In this driver,we only support text mode 80x25, which is defined as mode 0. + + @param This Protocol instance pointer. + @param ModeNumber The mode number to return information on. + @param Columns The returned columns of the requested mode. + @param Rows The returned rows of the requested mode. + + @retval EFI_SUCCESS The requested mode information is returned. + @retval EFI_UNSUPPORTED The mode number is not valid. + +**/ EFI_STATUS EFIAPI GraphicsConsoleConOutQueryMode ( @@ -1124,47 +1248,18 @@ GraphicsConsoleConOutQueryMode ( OUT UINTN *Columns, OUT UINTN *Rows ) -/*++ - Routine Description: - - Implements SIMPLE_TEXT_OUTPUT.QueryMode(). - It returnes information for an available text mode - that the Graphics Console supports. - In this driver,we only support text mode 80x25, which is - defined as mode 0. - - - Arguments: - - This - Indicates the calling context. - - ModeNumber - The mode number to return information on. - - Columns - The returned columns of the requested mode. - - Rows - The returned rows of the requested mode. - - Returns: - - EFI_SUCCESS - The requested mode information is returned. - - EFI_UNSUPPORTED - The mode number is not valid. - ---*/ { GRAPHICS_CONSOLE_DEV *Private; EFI_STATUS Status; EFI_TPL OldTpl; - + if (ModeNumber >= (UINTN) This->Mode->MaxMode) { return EFI_UNSUPPORTED; } OldTpl = gBS->RaiseTPL (TPL_NOTIFY); Status = EFI_SUCCESS; - + Private = GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS (This); *Columns = Private->ModeData[ModeNumber].Columns; @@ -1181,37 +1276,28 @@ Done: return Status; } + +/** + Sets the output device(s) to a specified mode. + + Implements SIMPLE_TEXT_OUTPUT.SetMode(). + Set the Graphics Console to a specified mode. In this driver, we only support mode 0. + + @param This Protocol instance pointer. + @param ModeNumber The text mode to set. + + @retval EFI_SUCCESS The requested text mode is set. + @retval EFI_DEVICE_ERROR The requested text mode cannot be set because of + Graphics Console device error. + @retval EFI_UNSUPPORTED The text mode number is not valid. + +**/ EFI_STATUS EFIAPI GraphicsConsoleConOutSetMode ( IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN UINTN ModeNumber ) -/*++ - Routine Description: - - Implements SIMPLE_TEXT_OUTPUT.SetMode(). - Set the Graphics Console to a specified mode. - In this driver, we only support mode 0. - - Arguments: - - This - Indicates the calling context. - - ModeNumber - The text mode to set. - - Returns: - - EFI_SUCCESS - The requested text mode is set. - - EFI_DEVICE_ERROR - The requested text mode cannot be set because of Graphics Console device error. - - EFI_UNSUPPORTED - The text mode number is not valid. - ---*/ { EFI_STATUS Status; GRAPHICS_CONSOLE_DEV *Private; @@ -1252,7 +1338,7 @@ GraphicsConsoleConOutSetMode ( // // Attempt to allocate a line buffer for the requested mode number // - NewLineBuffer = AllocatePool (sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL) * ModeData->Columns * GLYPH_WIDTH * GLYPH_HEIGHT); + NewLineBuffer = AllocatePool (sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL) * ModeData->Columns * EFI_GLYPH_WIDTH * EFI_GLYPH_HEIGHT); if (NewLineBuffer == NULL) { // @@ -1295,7 +1381,7 @@ GraphicsConsoleConOutSetMode ( if (GraphicsOutput != NULL) { if (ModeData->GopModeNumber != GraphicsOutput->Mode->Mode) { // - // Either no graphics mode is currently set, or it is set to the wrong resolution, so set the new grapghics mode + // Either no graphics mode is currently set, or it is set to the wrong resolution, so set the new graphics mode // Status = GraphicsOutput->SetMode (GraphicsOutput, ModeData->GopModeNumber); if (EFI_ERROR (Status)) { @@ -1321,7 +1407,7 @@ GraphicsConsoleConOutSetMode ( 0 ); } - } else { + } else if (FeaturePcdGet (PcdUgaConsumeSupport)) { // // Get the current UGA Draw mode information // @@ -1334,7 +1420,7 @@ GraphicsConsoleConOutSetMode ( ); if (EFI_ERROR (Status) || HorizontalResolution != ModeData->GopWidth || VerticalResolution != ModeData->GopHeight) { // - // Either no graphics mode is currently set, or it is set to the wrong resolution, so set the new grapghics mode + // Either no graphics mode is currently set, or it is set to the wrong resolution, so set the new graphics mode // Status = UgaDraw->SetMode ( UgaDraw, @@ -1374,7 +1460,7 @@ GraphicsConsoleConOutSetMode ( This->Mode->Mode = (INT32) ModeNumber; // - // Move the text cursor to the upper left hand corner of the displat and enable it + // Move the text cursor to the upper left hand corner of the display and enable it // This->SetCursorPosition (This, 0, 0); @@ -1385,39 +1471,32 @@ Done: return Status; } + +/** + Sets the background and foreground colors for the OutputString () and + ClearScreen () functions. + + Implements SIMPLE_TEXT_OUTPUT.SetAttribute(). + + @param This Protocol instance pointer. + @param Attribute The attribute to set. Bits 0..3 are the foreground + color, and bits 4..6 are the background color. + All other bits are undefined and must be zero. + + @retval EFI_SUCCESS The requested attribute is set. + @retval EFI_DEVICE_ERROR The requested attribute cannot be set due to Graphics Console port error. + @retval EFI_UNSUPPORTED The attribute requested is not defined. + +**/ EFI_STATUS EFIAPI GraphicsConsoleConOutSetAttribute ( IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN UINTN Attribute ) -/*++ - Routine Description: - - Implements SIMPLE_TEXT_OUTPUT.SetAttribute(). - - Arguments: - - This - Indicates the calling context. - - Attrubute - The attribute to set. Only bit0..6 are valid, all other bits - are undefined and must be zero. - - Returns: - - EFI_SUCCESS - The requested attribute is set. - - EFI_DEVICE_ERROR - The requested attribute cannot be set due to Graphics Console port error. - - EFI_UNSUPPORTED - The attribute requested is not defined by EFI spec. - ---*/ { EFI_TPL OldTpl; - + if ((Attribute | 0xFF) != 0xFF) { return EFI_UNSUPPORTED; } @@ -1439,35 +1518,25 @@ GraphicsConsoleConOutSetAttribute ( return EFI_SUCCESS; } + +/** + Clears the output device(s) display to the currently selected background + color. + + Implements SIMPLE_TEXT_OUTPUT.ClearScreen(). + + @param This Protocol instance pointer. + + @retval EFI_SUCCESS The operation completed successfully. + @retval EFI_DEVICE_ERROR The device had an error and could not complete the request. + @retval EFI_UNSUPPORTED The output device is not in a valid text mode. + +**/ EFI_STATUS EFIAPI GraphicsConsoleConOutClearScreen ( IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This ) -/*++ - Routine Description: - - Implements SIMPLE_TEXT_OUTPUT.ClearScreen(). - It clears the Graphics Console's display to the - currently selected background color. - - - Arguments: - - This - Indicates the calling context. - - Returns: - - EFI_SUCCESS - The operation completed successfully. - - EFI_DEVICE_ERROR - The Graphics Console cannot be cleared due to Graphics Console device error. - - EFI_UNSUPPORTED - The Graphics Console is not in a valid text mode. - ---*/ { EFI_STATUS Status; GRAPHICS_CONSOLE_DEV *Private; @@ -1499,7 +1568,7 @@ GraphicsConsoleConOutClearScreen ( ModeData->GopHeight, 0 ); - } else { + } else if (FeaturePcdGet (PcdUgaConsumeSupport)) { Status = UgaDraw->Blt ( UgaDraw, (EFI_UGA_PIXEL *) (UINTN) &Background, @@ -1512,6 +1581,8 @@ GraphicsConsoleConOutClearScreen ( ModeData->GopHeight, 0 ); + } else { + Status = EFI_UNSUPPORTED; } This->Mode->CursorColumn = 0; @@ -1524,6 +1595,26 @@ GraphicsConsoleConOutClearScreen ( return Status; } + +/** + Sets the current coordinates of the cursor position. + + Implements SIMPLE_TEXT_OUTPUT.SetCursorPosition(). + + @param This Protocol instance pointer. + @param Column The position to set the cursor to. Must be greater than or + equal to zero and less than the number of columns and rows + by QueryMode (). + @param Row The position to set the cursor to. Must be greater than or + equal to zero and less than the number of columns and rows + by QueryMode (). + + @retval EFI_SUCCESS The operation completed successfully. + @retval EFI_DEVICE_ERROR The device had an error and could not complete the request. + @retval EFI_UNSUPPORTED The output device is not in a valid text mode, or the + cursor position is invalid for the current mode. + +**/ EFI_STATUS EFIAPI GraphicsConsoleConOutSetCursorPosition ( @@ -1531,32 +1622,6 @@ GraphicsConsoleConOutSetCursorPosition ( IN UINTN Column, IN UINTN Row ) -/*++ - Routine Description: - - Implements SIMPLE_TEXT_OUTPUT.SetCursorPosition(). - - Arguments: - - This - Indicates the calling context. - - Column - The row to set cursor to. - - Row - The column to set cursor to. - - Returns: - - EFI_SUCCESS - The operation completed successfully. - - EFI_DEVICE_ERROR - The request fails due to Graphics Console device error. - - EFI_UNSUPPORTED - The Graphics Console is not in a valid text mode, or the cursor position - is invalid for current mode. - ---*/ { GRAPHICS_CONSOLE_DEV *Private; GRAPHICS_CONSOLE_MODE_DATA *ModeData; @@ -1575,7 +1640,7 @@ GraphicsConsoleConOutSetCursorPosition ( goto Done; } - if (((INT32) Column == This->Mode->CursorColumn) && ((INT32) Row == This->Mode->CursorRow)) { + if ((This->Mode->CursorColumn == (INT32) Column) && (This->Mode->CursorRow == (INT32) Row)) { Status = EFI_SUCCESS; goto Done; } @@ -1593,39 +1658,30 @@ Done: return Status; } + +/** + Makes the cursor visible or invisible. + + Implements SIMPLE_TEXT_OUTPUT.EnableCursor(). + + @param This Protocol instance pointer. + @param Visible If TRUE, the cursor is set to be visible, If FALSE, + the cursor is set to be invisible. + + @retval EFI_SUCCESS The operation completed successfully. + +**/ EFI_STATUS EFIAPI GraphicsConsoleConOutEnableCursor ( IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, IN BOOLEAN Visible ) -/*++ - Routine Description: - - Implements SIMPLE_TEXT_OUTPUT.EnableCursor(). - In this driver, the cursor cannot be hidden. - - Arguments: - - This - Indicates the calling context. - - Visible - If TRUE, the cursor is set to be visible, - If FALSE, the cursor is set to be invisible. - - Returns: - - EFI_SUCCESS - The request is valid. - - EFI_UNSUPPORTED - The Graphics Console does not support a hidden cursor. - ---*/ { EFI_TPL OldTpl; - + OldTpl = gBS->RaiseTPL (TPL_NOTIFY); - + EraseCursor (This); This->Mode->CursorVisible = Visible; @@ -1636,7 +1692,16 @@ GraphicsConsoleConOutEnableCursor ( return EFI_SUCCESS; } -STATIC +/** + Gets Graphics Console devcie's foreground color and background color. + + @param This Protocol instance pointer. + @param Foreground Returned text foreground color. + @param Background Returned text background color. + + @retval EFI_SUCCESS It returned always. + +**/ EFI_STATUS GetTextColors ( IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, @@ -1654,7 +1719,19 @@ GetTextColors ( return EFI_SUCCESS; } -STATIC +/** + Draw Unicode string on the Graphics Console device's screen. + + @param This Protocol instance pointer. + @param UnicodeWeight One Unicode string to be displayed. + @param Count The count of Unicode string. + + @retval EFI_OUT_OF_RESOURCES If no memory resource to use. + @retval EFI_UNSUPPORTED If no Graphics Output protocol and UGA Draw + protocol exist. + @retval EFI_SUCCESS Drawing Unicode string implemented successfully. + +**/ EFI_STATUS DrawUnicodeWeightAtCursorN ( IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, @@ -1662,156 +1739,161 @@ DrawUnicodeWeightAtCursorN ( IN UINTN Count ) { - GRAPHICS_CONSOLE_DEV *Private; - EFI_STATUS Status; - EFI_STATUS ReturnStatus; - GLYPH_UNION *Glyph; - GLYPH_UNION GlyphData; - INTN GlyphX; - INTN GlyphY; - EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput; - EFI_UGA_DRAW_PROTOCOL *UgaDraw; - EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground; - EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background; - UINTN Index; - UINTN ArrayIndex; - UINTN Counts; - UINT16 GlyphWidth; - UINT32 GlyphStatus; + EFI_STATUS Status; + GRAPHICS_CONSOLE_DEV *Private; + EFI_IMAGE_OUTPUT *Blt; + EFI_STRING String; + EFI_FONT_DISPLAY_INFO *FontInfo; + EFI_UGA_DRAW_PROTOCOL *UgaDraw; + EFI_HII_ROW_INFO *RowInfoArray; + UINTN RowInfoArraySize; - Private = GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS (This); + Private = GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS (This); + Blt = (EFI_IMAGE_OUTPUT *) AllocateZeroPool (sizeof (EFI_IMAGE_OUTPUT)); + if (Blt == NULL) { + return EFI_OUT_OF_RESOURCES; + } - ReturnStatus = EFI_SUCCESS; - GlyphStatus = 0; - GlyphWidth = 0x08; + Blt->Width = (UINT16) (Private->ModeData[This->Mode->Mode].GopWidth); + Blt->Height = (UINT16) (Private->ModeData[This->Mode->Mode].GopHeight); - GetTextColors (This, &Foreground, &Background); + String = AllocateCopyPool ((Count + 1) * sizeof (CHAR16), UnicodeWeight); + if (String == NULL) { + FreePool (Blt); + return EFI_OUT_OF_RESOURCES; + } + // + // Set the end character + // + *(String + Count) = L'\0'; - Index = 0; - ArrayIndex = 0; - while (Index < Count) { - if (This->Mode->Attribute & EFI_WIDE_ATTRIBUTE) { - GlyphStatus = WIDE_CHAR; - } else { - GlyphStatus = NARROW_CHAR; - } + FontInfo = (EFI_FONT_DISPLAY_INFO *) AllocateZeroPool (sizeof (EFI_FONT_DISPLAY_INFO)); + if (FontInfo == NULL) { + FreePool (Blt); + FreePool (String); + return EFI_OUT_OF_RESOURCES; + } + // + // Get current foreground and background colors. + // + GetTextColors (This, &FontInfo->ForegroundColor, &FontInfo->BackgroundColor); - Status = mHii->GetGlyph ( - mHii, - UnicodeWeight, - (UINT16 *) &Index, - (UINT8 **) &Glyph, - &GlyphWidth, - &GlyphStatus - ); - if (EFI_ERROR (Status)) { - ReturnStatus = Status; - } + if (Private->GraphicsOutput != NULL) { + // + // If Graphics Output protocol exists, using HII Font protocol to draw. + // + Blt->Image.Screen = Private->GraphicsOutput; + + Status = mHiiFont->StringToImage ( + mHiiFont, + EFI_HII_IGNORE_IF_NO_GLYPH | EFI_HII_DIRECT_TO_SCREEN, + String, + FontInfo, + &Blt, + This->Mode->CursorColumn * EFI_GLYPH_WIDTH + Private->ModeData[This->Mode->Mode].DeltaX, + This->Mode->CursorRow * EFI_GLYPH_HEIGHT + Private->ModeData[This->Mode->Mode].DeltaY, + NULL, + NULL, + NULL + ); + + } else if (FeaturePcdGet (PcdUgaConsumeSupport)) { + // + // If Graphics Output protocol cannot be found and PcdUgaConsumeSupport enabled, + // using UGA Draw protocol to draw. + // + ASSERT (Private->UgaDraw!= NULL); - Counts = 0; + UgaDraw = Private->UgaDraw; - CopyMem (&GlyphData, Glyph, sizeof (GLYPH_UNION)); + Blt->Image.Bitmap = AllocateZeroPool (Blt->Width * Blt->Height * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL)); + if (Blt->Image.Bitmap == NULL) { + FreePool (Blt); + FreePool (String); + return EFI_OUT_OF_RESOURCES; + } - do { + RowInfoArray = NULL; + // + // StringToImage only support blt'ing image to device using GOP protocol. If GOP is not supported in this platform, + // we ask StringToImage to print the string to blt buffer, then blt to device using UgaDraw. + // + Status = mHiiFont->StringToImage ( + mHiiFont, + EFI_HII_IGNORE_IF_NO_GLYPH, + String, + FontInfo, + &Blt, + This->Mode->CursorColumn * EFI_GLYPH_WIDTH + Private->ModeData[This->Mode->Mode].DeltaX, + This->Mode->CursorRow * EFI_GLYPH_HEIGHT + Private->ModeData[This->Mode->Mode].DeltaY, + &RowInfoArray, + &RowInfoArraySize, + NULL + ); + + if (!EFI_ERROR (Status)) { // - // We are creating the second half of the wide character's BLT buffer + // Line breaks are handled by caller of DrawUnicodeWeightAtCursorN, so the updated parameter RowInfoArraySize by StringToImage will + // always be 1 or 0 (if there is no valid Unicode Char can be printed). ASSERT here to make sure. // - if (GlyphWidth == 0x10 && Counts == 1) { - CopyMem (&GlyphData.NarrowGlyph.GlyphCol1, &Glyph->WideGlyph.GlyphCol2, sizeof (Glyph->WideGlyph.GlyphCol2)); - } + ASSERT (RowInfoArraySize <= 1); - Counts++; - - if (GlyphWidth == 0x10) { - mHii->GlyphToBlt ( - mHii, - (UINT8 *) &GlyphData, - Foreground, - Background, - Count * 2, - GLYPH_WIDTH, - GLYPH_HEIGHT, - &Private->LineBuffer[ArrayIndex * GLYPH_WIDTH] - ); - } else { - mHii->GlyphToBlt ( - mHii, - (UINT8 *) &GlyphData, - Foreground, - Background, - Count, - GLYPH_WIDTH, - GLYPH_HEIGHT, - &Private->LineBuffer[ArrayIndex * GLYPH_WIDTH] - ); - } - - ArrayIndex++; + Status = UgaDraw->Blt ( + UgaDraw, + (EFI_UGA_PIXEL *) Blt->Image.Bitmap, + EfiUgaBltBufferToVideo, + This->Mode->CursorColumn * EFI_GLYPH_WIDTH + Private->ModeData[This->Mode->Mode].DeltaX, + (This->Mode->CursorRow) * EFI_GLYPH_HEIGHT + Private->ModeData[This->Mode->Mode].DeltaY, + This->Mode->CursorColumn * EFI_GLYPH_WIDTH + Private->ModeData[This->Mode->Mode].DeltaX, + (This->Mode->CursorRow) * EFI_GLYPH_HEIGHT + Private->ModeData[This->Mode->Mode].DeltaY, + RowInfoArray[0].LineWidth, + RowInfoArray[0].LineHeight, + Blt->Width * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL) + ); + } - } while (Counts < 2 && GlyphWidth == 0x10); + FreePool (RowInfoArray); + FreePool (Blt->Image.Bitmap); + } else { + Status = EFI_UNSUPPORTED; + } + if (Blt != NULL) { + FreePool (Blt); } - // - // If we are printing Wide characters, treat the BLT as if it is twice as many characters - // - if (GlyphWidth == 0x10) { - Count = Count * 2; + if (String != NULL) { + FreePool (String); } - // - // Blt a character to the screen - // - GlyphX = This->Mode->CursorColumn * GLYPH_WIDTH; - GlyphY = This->Mode->CursorRow * GLYPH_HEIGHT; - GraphicsOutput = Private->GraphicsOutput; - UgaDraw = Private->UgaDraw; - if (GraphicsOutput != NULL) { - GraphicsOutput->Blt ( - GraphicsOutput, - Private->LineBuffer, - EfiBltBufferToVideo, - 0, - 0, - GlyphX + Private->ModeData[This->Mode->Mode].DeltaX, - GlyphY + Private->ModeData[This->Mode->Mode].DeltaY, - GLYPH_WIDTH * Count, - GLYPH_HEIGHT, - GLYPH_WIDTH * Count * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL) - ); - } else { - UgaDraw->Blt ( - UgaDraw, - (EFI_UGA_PIXEL *) (UINTN) Private->LineBuffer, - EfiUgaBltBufferToVideo, - 0, - 0, - GlyphX + Private->ModeData[This->Mode->Mode].DeltaX, - GlyphY + Private->ModeData[This->Mode->Mode].DeltaY, - GLYPH_WIDTH * Count, - GLYPH_HEIGHT, - GLYPH_WIDTH * Count * sizeof (EFI_UGA_PIXEL) - ); + if (FontInfo != NULL) { + FreePool (FontInfo); } - - return ReturnStatus; + return Status; } -STATIC +/** + Erase the cursor on the screen. + + @param This Protocol instance pointer. + + @retval EFI_SUCCESS The cursor is erased successfully. + +**/ EFI_STATUS EraseCursor ( IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This ) { - GRAPHICS_CONSOLE_DEV *Private; - EFI_SIMPLE_TEXT_OUTPUT_MODE *CurrentMode; - INTN GlyphX; - INTN GlyphY; + GRAPHICS_CONSOLE_DEV *Private; + EFI_SIMPLE_TEXT_OUTPUT_MODE *CurrentMode; + INTN GlyphX; + INTN GlyphY; EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput; - EFI_UGA_DRAW_PROTOCOL *UgaDraw; + EFI_UGA_DRAW_PROTOCOL *UgaDraw; EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION Foreground; EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION Background; - EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION BltChar[GLYPH_HEIGHT][GLYPH_WIDTH]; - UINTN X; - UINTN Y; + EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION BltChar[EFI_GLYPH_HEIGHT][EFI_GLYPH_WIDTH]; + UINTN PosX; + UINTN PosY; CurrentMode = This->Mode; @@ -1824,13 +1906,13 @@ EraseCursor ( UgaDraw = Private->UgaDraw; // - // BUGBUG - we need to think about what to do with wide and narrow character deletions. + // In this driver, only narrow character was supported. // // // Blt a character to the screen // - GlyphX = (CurrentMode->CursorColumn * GLYPH_WIDTH) + Private->ModeData[CurrentMode->Mode].DeltaX; - GlyphY = (CurrentMode->CursorRow * GLYPH_HEIGHT) + Private->ModeData[CurrentMode->Mode].DeltaY; + GlyphX = (CurrentMode->CursorColumn * EFI_GLYPH_WIDTH) + Private->ModeData[CurrentMode->Mode].DeltaX; + GlyphY = (CurrentMode->CursorRow * EFI_GLYPH_HEIGHT) + Private->ModeData[CurrentMode->Mode].DeltaY; if (GraphicsOutput != NULL) { GraphicsOutput->Blt ( GraphicsOutput, @@ -1840,11 +1922,11 @@ EraseCursor ( GlyphY, 0, 0, - GLYPH_WIDTH, - GLYPH_HEIGHT, - GLYPH_WIDTH * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL) + EFI_GLYPH_WIDTH, + EFI_GLYPH_HEIGHT, + EFI_GLYPH_WIDTH * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL) ); - } else { + } else if (FeaturePcdGet (PcdUgaConsumeSupport)) { UgaDraw->Blt ( UgaDraw, (EFI_UGA_PIXEL *) (UINTN) BltChar, @@ -1853,9 +1935,9 @@ EraseCursor ( GlyphY, 0, 0, - GLYPH_WIDTH, - GLYPH_HEIGHT, - GLYPH_WIDTH * sizeof (EFI_UGA_PIXEL) + EFI_GLYPH_WIDTH, + EFI_GLYPH_HEIGHT, + EFI_GLYPH_WIDTH * sizeof (EFI_UGA_PIXEL) ); } @@ -1864,10 +1946,10 @@ EraseCursor ( // // Convert Monochrome bitmap of the Glyph to BltBuffer structure // - for (Y = 0; Y < GLYPH_HEIGHT; Y++) { - for (X = 0; X < GLYPH_WIDTH; X++) { - if ((mCursorGlyph.GlyphCol1[Y] & (1 << X)) != 0) { - BltChar[Y][GLYPH_WIDTH - X - 1].Raw ^= Foreground.Raw; + for (PosY = 0; PosY < EFI_GLYPH_HEIGHT; PosY++) { + for (PosX = 0; PosX < EFI_GLYPH_WIDTH; PosX++) { + if ((mCursorGlyph.GlyphCol1[PosY] & (BIT0 << PosX)) != 0) { + BltChar[PosY][EFI_GLYPH_WIDTH - PosX - 1].Raw ^= Foreground.Raw; } } } @@ -1881,11 +1963,11 @@ EraseCursor ( 0, GlyphX, GlyphY, - GLYPH_WIDTH, - GLYPH_HEIGHT, - GLYPH_WIDTH * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL) + EFI_GLYPH_WIDTH, + EFI_GLYPH_HEIGHT, + EFI_GLYPH_WIDTH * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL) ); - } else { + } else if (FeaturePcdGet (PcdUgaConsumeSupport)) { UgaDraw->Blt ( UgaDraw, (EFI_UGA_PIXEL *) (UINTN) BltChar, @@ -1894,9 +1976,9 @@ EraseCursor ( 0, GlyphX, GlyphY, - GLYPH_WIDTH, - GLYPH_HEIGHT, - GLYPH_WIDTH * sizeof (EFI_UGA_PIXEL) + EFI_GLYPH_WIDTH, + EFI_GLYPH_HEIGHT, + EFI_GLYPH_WIDTH * sizeof (EFI_UGA_PIXEL) ); } @@ -1906,11 +1988,11 @@ EraseCursor ( /** The user Entry Point for module GraphicsConsole. The user code starts with this function. - @param[in] ImageHandle The firmware allocated handle for the EFI image. + @param[in] ImageHandle The firmware allocated handle for the EFI image. @param[in] SystemTable A pointer to the EFI System Table. - - @retval EFI_SUCCESS The entry point is executed successfully. - @retval other Some error occurs when executing this entry point. + + @retval EFI_SUCCESS The entry point is executed successfully. + @return other Some error occurs when executing this entry point. **/ EFI_STATUS @@ -1935,7 +2017,7 @@ InitializeGraphicsConsole ( ); ASSERT_EFI_ERROR (Status); - return Status; } +