MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Library / DisplayUpdateProgressLibText / DisplayUpdateProgressLibText.c

/** @file\r
  Provides services to display completion progress of a firmware update on a\r
  text console.\r
\r
  Copyright (c) 2016, Microsoft Corporation. All rights reserved.<BR>\r
  Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <PiDxe.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiLib.h>\r
\r
//\r
// Control Style.  Set to 100 so it is reset on first call.\r
//\r
UINTN  mPreviousProgress = 100;\r
\r
//\r
// Text foreground color of progress bar\r
//\r
UINTN  mProgressBarForegroundColor;\r
\r
/**\r
  Function indicates the current completion progress of a firmware update.\r
  Platform may override with its own specific function.\r
\r
  @param[in] Completion  A value between 0 and 100 indicating the current\r
                         completion progress of a firmware update.  This\r
                         value must the the same or higher than previous\r
                         calls to this service.  The first call of 0 or a\r
                         value of 0 after reaching a value of 100 resets\r
                         the progress indicator to 0.\r
  @param[in] Color       Color of the progress indicator.  Only used when\r
                         Completion is 0 to set the color of the progress\r
                         indicator.  If Color is NULL, then the default color\r
                         is used.\r
\r
  @retval EFI_SUCCESS            Progress displayed successfully.\r
  @retval EFI_INVALID_PARAMETER  Completion is not in range 0..100.\r
  @retval EFI_INVALID_PARAMETER  Completion is less than Completion value from\r
                                 a previous call to this service.\r
  @retval EFI_NOT_READY          The device used to indicate progress is not\r
                                 available.\r
**/\r
EFI_STATUS\r
EFIAPI\r
DisplayUpdateProgress (\r
  IN UINTN                                Completion,\r
  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION  *Color       OPTIONAL\r
  )\r
{\r
  UINTN  Index;\r
  UINTN  CurrentAttribute;\r
\r
  //\r
  // Check range\r
  //\r
  if (Completion > 100) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Check to see if this Completion percentage has already been displayed\r
  //\r
  if (Completion == mPreviousProgress) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  //\r
  // Do special init on first call of each progress session\r
  //\r
  if (mPreviousProgress == 100) {\r
    Print (L"\n");\r
\r
    //\r
    // Convert pixel color to text foreground color\r
    //\r
    if (Color == NULL) {\r
      mProgressBarForegroundColor = EFI_WHITE;\r
    } else {\r
      mProgressBarForegroundColor = EFI_BLACK;\r
      if (Color->Pixel.Blue >= 0x40) {\r
        mProgressBarForegroundColor |= EFI_BLUE;\r
      }\r
      if (Color->Pixel.Green >= 0x40) {\r
        mProgressBarForegroundColor |= EFI_GREEN;\r
      }\r
      if (Color->Pixel.Red >= 0x40) {\r
        mProgressBarForegroundColor |= EFI_RED;\r
      }\r
      if (Color->Pixel.Blue >= 0xC0 || Color->Pixel.Green >= 0xC0 || Color->Pixel.Red >= 0xC0) {\r
        mProgressBarForegroundColor |= EFI_BRIGHT;\r
      }\r
      if (mProgressBarForegroundColor == EFI_BLACK) {\r
        mProgressBarForegroundColor = EFI_WHITE;\r
      }\r
    }\r
\r
    //\r
    // Clear previous\r
    //\r
    mPreviousProgress = 0;\r
  }\r
\r
  //\r
  // Can not update progress bar if Completion is less than previous\r
  //\r
  if (Completion < mPreviousProgress) {\r
    DEBUG ((DEBUG_WARN, "WARNING: Completion (%d) should not be lesss than Previous (%d)!!!\n", Completion, mPreviousProgress));\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Save current text color\r
  //\r
  CurrentAttribute = (UINTN)gST->ConOut->Mode->Attribute;\r
\r
  //\r
  // Print progress percentage\r
  //\r
  Print (L"\rUpdate Progress - %3d%% ", Completion);\r
\r
  //\r
  // Set progress bar color\r
  //\r
  gST->ConOut->SetAttribute (\r
                 gST->ConOut,\r
                 EFI_TEXT_ATTR (mProgressBarForegroundColor, EFI_BLACK)\r
                 );\r
\r
  //\r
  // Print completed portion of progress bar\r
  //\r
  for (Index = 0; Index < Completion / 2; Index++) {\r
    Print (L"%c", BLOCKELEMENT_FULL_BLOCK);\r
  }\r
\r
  //\r
  // Restore text color\r
  //\r
  gST->ConOut->SetAttribute (gST->ConOut, CurrentAttribute);\r
\r
  //\r
  // Print remaining portion of progress bar\r
  //\r
  for (; Index < 50; Index++) {\r
    Print (L"%c", BLOCKELEMENT_LIGHT_SHADE);\r
  }\r
\r
  mPreviousProgress = Completion;\r
\r
  return EFI_SUCCESS;\r
}\r