/** @file BDS Lib functions which contain all the code to connect console device Copyright (c) 2004 - 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 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 "InternalBdsLib.h" /** Check if we need to save the EFI variable with "ConVarName" as name as NV type @param ConVarName The name of the EFI variable. @retval TRUE Set the EFI variabel as NV type. @retval FALSE EFI variabel as NV type can be set NonNV. **/ BOOLEAN IsNvNeed ( IN CHAR16 *ConVarName ) { CHAR16 *Ptr; Ptr = ConVarName; // // If the variable includes "Dev" at last, we consider // it does not support NV attribute. // while (*Ptr != L'\0') { Ptr++; } if ((*(Ptr - 3) == 'D') && (*(Ptr - 2) == 'e') && (*(Ptr - 1) == 'v')) { return FALSE; } else { return TRUE; } } /** This function update console variable based on ConVarName, it can add or remove one specific console device path from the variable @param ConVarName Console related variable name, ConIn, ConOut, ErrOut. @param CustomizedConDevicePath The console device path which will be added to the console variable ConVarName, this parameter can not be multi-instance. @param ExclusiveDevicePath The console device path which will be removed from the console variable ConVarName, this parameter can not be multi-instance. @retval EFI_UNSUPPORTED The added device path is same to the removed one. @retval EFI_SUCCESS Success add or remove the device path from the console variable. **/ EFI_STATUS EFIAPI BdsLibUpdateConsoleVariable ( IN CHAR16 *ConVarName, IN EFI_DEVICE_PATH_PROTOCOL *CustomizedConDevicePath, IN EFI_DEVICE_PATH_PROTOCOL *ExclusiveDevicePath ) { EFI_DEVICE_PATH_PROTOCOL *VarConsole; UINTN DevicePathSize; EFI_DEVICE_PATH_PROTOCOL *NewDevicePath; EFI_DEVICE_PATH_PROTOCOL *TempNewDevicePath; UINT32 Attributes; VarConsole = NULL; DevicePathSize = 0; // // Notes: check the device path point, here should check // with compare memory // if (CustomizedConDevicePath == ExclusiveDevicePath) { return EFI_UNSUPPORTED; } // // Delete the ExclusiveDevicePath from current default console // VarConsole = BdsLibGetVariableAndSize ( ConVarName, &gEfiGlobalVariableGuid, &DevicePathSize ); // // Initialize NewDevicePath // NewDevicePath = VarConsole; // // If ExclusiveDevicePath is even the part of the instance in VarConsole, delete it. // In the end, NewDevicePath is the final device path. // if (ExclusiveDevicePath != NULL && VarConsole != NULL) { NewDevicePath = BdsLibDelPartMatchInstance (VarConsole, ExclusiveDevicePath); } // // Try to append customized device path to NewDevicePath. // if (CustomizedConDevicePath != NULL) { if (!BdsLibMatchDevicePaths (NewDevicePath, CustomizedConDevicePath)) { // // Check if there is part of CustomizedConDevicePath in NewDevicePath, delete it. // NewDevicePath = BdsLibDelPartMatchInstance (NewDevicePath, CustomizedConDevicePath); // // In the first check, the default console variable will be _ModuleEntryPoint, // just append current customized device path // TempNewDevicePath = NewDevicePath; NewDevicePath = AppendDevicePathInstance (NewDevicePath, CustomizedConDevicePath); if (TempNewDevicePath != NULL) { FreePool(TempNewDevicePath); } } } // // The attribute for ConInDev, ConOutDev and ErrOutDev does not include NV. // if (IsNvNeed(ConVarName)) { // // ConVarName has NV attribute. // Attributes = EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE; } else { // // ConVarName does not have NV attribute. // Attributes = EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS; } // // Finally, Update the variable of the default console by NewDevicePath // gRT->SetVariable ( ConVarName, &gEfiGlobalVariableGuid, Attributes, GetDevicePathSize (NewDevicePath), NewDevicePath ); if (VarConsole == NewDevicePath) { if (VarConsole != NULL) { FreePool(VarConsole); } } else { if (VarConsole != NULL) { FreePool(VarConsole); } if (NewDevicePath != NULL) { FreePool(NewDevicePath); } } return EFI_SUCCESS; } /** Connect the console device base on the variable ConVarName, if device path of the ConVarName is multi-instance device path, if anyone of the instances is connected success, then this function will return success. @param ConVarName Console related variable name, ConIn, ConOut, ErrOut. @retval EFI_NOT_FOUND There is not any console devices connected success @retval EFI_SUCCESS Success connect any one instance of the console device path base on the variable ConVarName. **/ EFI_STATUS EFIAPI BdsLibConnectConsoleVariable ( IN CHAR16 *ConVarName ) { EFI_STATUS Status; EFI_DEVICE_PATH_PROTOCOL *StartDevicePath; UINTN VariableSize; EFI_DEVICE_PATH_PROTOCOL *Instance; EFI_DEVICE_PATH_PROTOCOL *Next; EFI_DEVICE_PATH_PROTOCOL *CopyOfDevicePath; UINTN Size; BOOLEAN DeviceExist; Status = EFI_SUCCESS; DeviceExist = FALSE; // // Check if the console variable exist // StartDevicePath = BdsLibGetVariableAndSize ( ConVarName, &gEfiGlobalVariableGuid, &VariableSize ); if (StartDevicePath == NULL) { return EFI_UNSUPPORTED; } CopyOfDevicePath = StartDevicePath; do { // // Check every instance of the console variable // Instance = GetNextDevicePathInstance (&CopyOfDevicePath, &Size); Next = Instance; while (!IsDevicePathEndType (Next)) { Next = NextDevicePathNode (Next); } SetDevicePathEndNode (Next); // // Check USB1.1 console // if ((DevicePathType (Instance) == MESSAGING_DEVICE_PATH) && ((DevicePathSubType (Instance) == MSG_USB_CLASS_DP) || (DevicePathSubType (Instance) == MSG_USB_WWID_DP) )) { // // Check the Usb console in Usb2.0 bus firstly, then Usb1.1 bus // Status = BdsLibConnectUsbDevByShortFormDP (PCI_CLASSC_PI_EHCI, Instance); if (!EFI_ERROR (Status)) { DeviceExist = TRUE; } Status = BdsLibConnectUsbDevByShortFormDP (PCI_CLASSC_PI_UHCI, Instance); if (!EFI_ERROR (Status)) { DeviceExist = TRUE; } } else { // // Connect the instance device path // Status = BdsLibConnectDevicePath (Instance); if (EFI_ERROR (Status)) { // // Delete the instance from the console varialbe // BdsLibUpdateConsoleVariable (ConVarName, NULL, Instance); } else { DeviceExist = TRUE; } } FreePool(Instance); } while (CopyOfDevicePath != NULL); FreePool (StartDevicePath); if (!DeviceExist) { return EFI_NOT_FOUND; } return EFI_SUCCESS; } /** This function will search every simpletxt devive in current system, and make every simpletxt device as pertantial console device. **/ VOID EFIAPI BdsLibConnectAllConsoles ( VOID ) { UINTN Index; EFI_DEVICE_PATH_PROTOCOL *ConDevicePath; UINTN HandleCount; EFI_HANDLE *HandleBuffer; Index = 0; HandleCount = 0; HandleBuffer = NULL; ConDevicePath = NULL; // // Update all the console varables // gBS->LocateHandleBuffer ( ByProtocol, &gEfiSimpleTextInProtocolGuid, NULL, &HandleCount, &HandleBuffer ); for (Index = 0; Index < HandleCount; Index++) { gBS->HandleProtocol ( HandleBuffer[Index], &gEfiDevicePathProtocolGuid, (VOID **) &ConDevicePath ); BdsLibUpdateConsoleVariable (L"ConIn", ConDevicePath, NULL); } if (HandleBuffer != NULL) { FreePool(HandleBuffer); HandleBuffer = NULL; } gBS->LocateHandleBuffer ( ByProtocol, &gEfiSimpleTextOutProtocolGuid, NULL, &HandleCount, &HandleBuffer ); for (Index = 0; Index < HandleCount; Index++) { gBS->HandleProtocol ( HandleBuffer[Index], &gEfiDevicePathProtocolGuid, (VOID **) &ConDevicePath ); BdsLibUpdateConsoleVariable (L"ConOut", ConDevicePath, NULL); BdsLibUpdateConsoleVariable (L"ErrOut", ConDevicePath, NULL); } if (HandleBuffer != NULL) { FreePool(HandleBuffer); } // // Connect all console variables // BdsLibConnectAllDefaultConsoles (); } /** This function will connect console device base on the console device variable ConIn, ConOut and ErrOut. @retval EFI_SUCCESS At least one of the ConIn and ConOut device have been connected success. @retval EFI_STATUS Return the status of BdsLibConnectConsoleVariable (). **/ EFI_STATUS EFIAPI BdsLibConnectAllDefaultConsoles ( VOID ) { EFI_STATUS Status; // // Connect all default console variables // // // It seems impossible not to have any ConOut device on platform, // so we check the status here. // Status = BdsLibConnectConsoleVariable (L"ConOut"); if (EFI_ERROR (Status)) { return Status; } // // Insert the performance probe for Console Out // PERF_START (NULL, "ConOut", "BDS", 1); PERF_END (NULL, "ConOut", "BDS", 0); // // Because possibly the platform is legacy free, in such case, // ConIn devices (Serial Port and PS2 Keyboard ) does not exist, // so we need not check the status. // BdsLibConnectConsoleVariable (L"ConIn"); // // The _ModuleEntryPoint err out var is legal. // BdsLibConnectConsoleVariable (L"ErrOut"); return EFI_SUCCESS; } /** Convert a *.BMP graphics image to a GOP blt buffer. If a NULL Blt buffer is passed in a GopBlt buffer will be allocated by this routine. If a GopBlt buffer is passed in it will be used if it is big enough. @param BmpImage Pointer to BMP file @param BmpImageSize Number of bytes in BmpImage @param GopBlt Buffer containing GOP version of BmpImage. @param GopBltSize Size of GopBlt in bytes. @param PixelHeight Height of GopBlt/BmpImage in pixels @param PixelWidth Width of GopBlt/BmpImage in pixels @retval EFI_SUCCESS GopBlt and GopBltSize are returned. @retval EFI_UNSUPPORTED BmpImage is not a valid *.BMP image @retval EFI_BUFFER_TOO_SMALL The passed in GopBlt buffer is not big enough. GopBltSize will contain the required size. @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate. **/ EFI_STATUS ConvertBmpToGopBlt ( IN VOID *BmpImage, IN UINTN BmpImageSize, IN OUT VOID **GopBlt, IN OUT UINTN *GopBltSize, OUT UINTN *PixelHeight, OUT UINTN *PixelWidth ) { UINT8 *Image; UINT8 *ImageHeader; BMP_IMAGE_HEADER *BmpHeader; BMP_COLOR_MAP *BmpColorMap; EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer; EFI_GRAPHICS_OUTPUT_BLT_PIXEL *Blt; UINTN BltBufferSize; UINTN Index; UINTN Height; UINTN Width; UINTN ImageIndex; BOOLEAN IsAllocated; BmpHeader = (BMP_IMAGE_HEADER *) BmpImage; if (BmpHeader->CharB != 'B' || BmpHeader->CharM != 'M') { return EFI_UNSUPPORTED; } // // Doesn't support compress. // if (BmpHeader->CompressionType != 0) { return EFI_UNSUPPORTED; } // // Calculate Color Map offset in the image. // Image = BmpImage; BmpColorMap = (BMP_COLOR_MAP *) (Image + sizeof (BMP_IMAGE_HEADER)); // // Calculate graphics image data address in the image // Image = ((UINT8 *) BmpImage) + BmpHeader->ImageOffset; ImageHeader = Image; // // Calculate the BltBuffer needed size. // BltBufferSize = BmpHeader->PixelWidth * BmpHeader->PixelHeight * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL); IsAllocated = FALSE; if (*GopBlt == NULL) { // // GopBlt is not allocated by caller. // *GopBltSize = BltBufferSize; *GopBlt = AllocatePool (*GopBltSize); IsAllocated = TRUE; if (*GopBlt == NULL) { return EFI_OUT_OF_RESOURCES; } } else { // // GopBlt has been allocated by caller. // if (*GopBltSize < BltBufferSize) { *GopBltSize = BltBufferSize; return EFI_BUFFER_TOO_SMALL; } } *PixelWidth = BmpHeader->PixelWidth; *PixelHeight = BmpHeader->PixelHeight; // // Convert image from BMP to Blt buffer format // BltBuffer = *GopBlt; for (Height = 0; Height < BmpHeader->PixelHeight; Height++) { Blt = &BltBuffer[(BmpHeader->PixelHeight - Height - 1) * BmpHeader->PixelWidth]; for (Width = 0; Width < BmpHeader->PixelWidth; Width++, Image++, Blt++) { switch (BmpHeader->BitPerPixel) { case 1: // // Convert 1-bit (2 colors) BMP to 24-bit color // for (Index = 0; Index < 8 && Width < BmpHeader->PixelWidth; Index++) { Blt->Red = BmpColorMap[((*Image) >> (7 - Index)) & 0x1].Red; Blt->Green = BmpColorMap[((*Image) >> (7 - Index)) & 0x1].Green; Blt->Blue = BmpColorMap[((*Image) >> (7 - Index)) & 0x1].Blue; Blt++; Width++; } Blt --; Width --; break; case 4: // // Convert 4-bit (16 colors) BMP Palette to 24-bit color // Index = (*Image) >> 4; Blt->Red = BmpColorMap[Index].Red; Blt->Green = BmpColorMap[Index].Green; Blt->Blue = BmpColorMap[Index].Blue; if (Width < (BmpHeader->PixelWidth - 1)) { Blt++; Width++; Index = (*Image) & 0x0f; Blt->Red = BmpColorMap[Index].Red; Blt->Green = BmpColorMap[Index].Green; Blt->Blue = BmpColorMap[Index].Blue; } break; case 8: // // Convert 8-bit (256 colors) BMP Palette to 24-bit color // Blt->Red = BmpColorMap[*Image].Red; Blt->Green = BmpColorMap[*Image].Green; Blt->Blue = BmpColorMap[*Image].Blue; break; case 24: // // It is 24-bit BMP. // Blt->Blue = *Image++; Blt->Green = *Image++; Blt->Red = *Image; break; default: // // Other bit format BMP is not supported. // if (IsAllocated) { FreePool (*GopBlt); *GopBlt = NULL; } return EFI_UNSUPPORTED; break; }; } ImageIndex = (UINTN) (Image - ImageHeader); if ((ImageIndex % 4) != 0) { // // Bmp Image starts each row on a 32-bit boundary! // Image = Image + (4 - (ImageIndex % 4)); } } return EFI_SUCCESS; } /** Use Console Control Protocol to lock the Console In Spliter virtual handle. This is the ConInHandle and ConIn handle in the EFI system table. All key presses will be ignored until the Password is typed in. The only way to disable the password is to type it in to a ConIn device. @param Password Password used to lock ConIn device. @retval EFI_SUCCESS lock the Console In Spliter virtual handle successfully. @retval EFI_UNSUPPORTED Password not found **/ EFI_STATUS EFIAPI LockKeyboards ( IN CHAR16 *Password ) { EFI_STATUS Status; EFI_CONSOLE_CONTROL_PROTOCOL *ConsoleControl; Status = gBS->LocateProtocol (&gEfiConsoleControlProtocolGuid, NULL, (VOID **) &ConsoleControl); if (EFI_ERROR (Status)) { return EFI_UNSUPPORTED; } Status = ConsoleControl->LockStdIn (ConsoleControl, Password); return Status; } /** Use Console Control to turn off UGA based Simple Text Out consoles from going to the UGA device. Put up LogoFile on every UGA device that is a console @param[in] LogoFile File name of logo to display on the center of the screen. @retval EFI_SUCCESS ConsoleControl has been flipped to graphics and logo displayed. @retval EFI_UNSUPPORTED Logo not found **/ EFI_STATUS EFIAPI EnableQuietBoot ( IN EFI_GUID *LogoFile ) { EFI_STATUS Status; EFI_CONSOLE_CONTROL_PROTOCOL *ConsoleControl; EFI_OEM_BADGING_PROTOCOL *Badging; UINT32 SizeOfX; UINT32 SizeOfY; INTN DestX; INTN DestY; UINT8 *ImageData; UINTN ImageSize; UINTN BltSize; UINT32 Instance; EFI_BADGING_FORMAT Format; EFI_BADGING_DISPLAY_ATTRIBUTE Attribute; UINTN CoordinateX; UINTN CoordinateY; UINTN Height; UINTN Width; EFI_GRAPHICS_OUTPUT_BLT_PIXEL *Blt; EFI_UGA_DRAW_PROTOCOL *UgaDraw; UINT32 ColorDepth; UINT32 RefreshRate; EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput; Status = gBS->LocateProtocol (&gEfiConsoleControlProtocolGuid, NULL, (VOID **) &ConsoleControl); if (EFI_ERROR (Status)) { return EFI_UNSUPPORTED; } UgaDraw = NULL; // // Try to open GOP first // Status = gBS->HandleProtocol (gST->ConsoleOutHandle, &gEfiGraphicsOutputProtocolGuid, (VOID **) &GraphicsOutput); if (EFI_ERROR (Status) && FeaturePcdGet (PcdUgaConsumeSupport)) { GraphicsOutput = NULL; // // Open GOP failed, try to open UGA // Status = gBS->HandleProtocol (gST->ConsoleOutHandle, &gEfiUgaDrawProtocolGuid, (VOID **) &UgaDraw); } if (EFI_ERROR (Status)) { return EFI_UNSUPPORTED; } Badging = NULL; Status = gBS->LocateProtocol (&gEfiOEMBadgingProtocolGuid, NULL, (VOID **) &Badging); // // Set console control to graphics mode. // Status = ConsoleControl->SetMode (ConsoleControl, EfiConsoleControlScreenGraphics); if (EFI_ERROR (Status)) { return EFI_UNSUPPORTED; } if (GraphicsOutput != NULL) { SizeOfX = GraphicsOutput->Mode->Info->HorizontalResolution; SizeOfY = GraphicsOutput->Mode->Info->VerticalResolution; } else if (FeaturePcdGet (PcdUgaConsumeSupport)) { Status = UgaDraw->GetMode (UgaDraw, &SizeOfX, &SizeOfY, &ColorDepth, &RefreshRate); if (EFI_ERROR (Status)) { return EFI_UNSUPPORTED; } } else { return EFI_UNSUPPORTED; } Instance = 0; while (1) { ImageData = NULL; ImageSize = 0; if (Badging != NULL) { // // Get image from OEMBadging protocol. // Status = Badging->GetImage ( Badging, &Instance, &Format, &ImageData, &ImageSize, &Attribute, &CoordinateX, &CoordinateY ); if (EFI_ERROR (Status)) { return Status; } // // Currently only support BMP format. // if (Format != EfiBadgingFormatBMP) { if (ImageData != NULL) { FreePool (ImageData); } continue; } } else { // // Get the specified image from FV. // Status = GetSectionFromAnyFv (LogoFile, EFI_SECTION_RAW, 0, (VOID **) &ImageData, &ImageSize); if (EFI_ERROR (Status)) { return EFI_UNSUPPORTED; } CoordinateX = 0; CoordinateY = 0; Attribute = EfiBadgingDisplayAttributeCenter; } Blt = NULL; Status = ConvertBmpToGopBlt ( ImageData, ImageSize, (VOID **) &Blt, &BltSize, &Height, &Width ); if (EFI_ERROR (Status)) { if (ImageData != NULL) { FreePool (ImageData); } if (Badging == NULL) { return Status; } else { continue; } } // // Caculate the display position according to Attribute. // switch (Attribute) { case EfiBadgingDisplayAttributeLeftTop: DestX = CoordinateX; DestY = CoordinateY; break; case EfiBadgingDisplayAttributeCenterTop: DestX = (SizeOfX - Width) / 2; DestY = CoordinateY; break; case EfiBadgingDisplayAttributeRightTop: DestX = (SizeOfX - Width - CoordinateX); DestY = CoordinateY;; break; case EfiBadgingDisplayAttributeCenterRight: DestX = (SizeOfX - Width - CoordinateX); DestY = (SizeOfY - Height) / 2; break; case EfiBadgingDisplayAttributeRightBottom: DestX = (SizeOfX - Width - CoordinateX); DestY = (SizeOfY - Height - CoordinateY); break; case EfiBadgingDisplayAttributeCenterBottom: DestX = (SizeOfX - Width) / 2; DestY = (SizeOfY - Height - CoordinateY); break; case EfiBadgingDisplayAttributeLeftBottom: DestX = CoordinateX; DestY = (SizeOfY - Height - CoordinateY); break; case EfiBadgingDisplayAttributeCenterLeft: DestX = CoordinateX; DestY = (SizeOfY - Height) / 2; break; case EfiBadgingDisplayAttributeCenter: DestX = (SizeOfX - Width) / 2; DestY = (SizeOfY - Height) / 2; break; default: DestX = CoordinateX; DestY = CoordinateY; break; } if ((DestX >= 0) && (DestY >= 0)) { if (GraphicsOutput != NULL) { Status = GraphicsOutput->Blt ( GraphicsOutput, Blt, EfiBltBufferToVideo, 0, 0, (UINTN) DestX, (UINTN) DestY, Width, Height, Width * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL) ); } else if (FeaturePcdGet (PcdUgaConsumeSupport)) { Status = UgaDraw->Blt ( UgaDraw, (EFI_UGA_PIXEL *) Blt, EfiUgaBltBufferToVideo, 0, 0, (UINTN) DestX, (UINTN) DestY, Width, Height, Width * sizeof (EFI_UGA_PIXEL) ); } else { Status = EFI_UNSUPPORTED; } } if (ImageData != NULL) { FreePool (ImageData); } if (Blt != NULL) { FreePool (Blt); } if (Badging == NULL) { break; } } return Status; } /** Use Console Control to turn on UGA based Simple Text Out consoles. The UGA Simple Text Out screens will now be synced up with all non UGA output devices @retval EFI_SUCCESS UGA devices are back in text mode and synced up. **/ EFI_STATUS EFIAPI DisableQuietBoot ( VOID ) { EFI_STATUS Status; EFI_CONSOLE_CONTROL_PROTOCOL *ConsoleControl; Status = gBS->LocateProtocol (&gEfiConsoleControlProtocolGuid, NULL, (VOID **) &ConsoleControl); if (EFI_ERROR (Status)) { return EFI_UNSUPPORTED; } // // Set console control to text mode. // return ConsoleControl->SetMode (ConsoleControl, EfiConsoleControlScreenText); }