fix comments.

[mirror_edk2.git] / ShellPkg / Application / Shell / ConsoleLogger.c

/** @file\r
  Provides interface to shell console logger.\r
\r
  Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
**/\r
\r
#include "ConsoleLogger.h"\r
#include "Shell.h"\r
\r
STATIC CONST CHAR16                     mCrLfString[3] = { CHAR_CARRIAGE_RETURN, CHAR_LINEFEED, CHAR_NULL };\r
\r
/**\r
  Install our intermediate ConOut into the system table to\r
  keep a log of all the info that is displayed to the user.\r
\r
  @param[in] ScreensToSave  Sets how many screen-worths of data to save.\r
  @param[out] ConsoleInfo   The object to pass into later functions.\r
\r
  @retval EFI_SUCCESS       The operation was successful.\r
  @return other             The operation failed.\r
\r
  @sa ConsoleLoggerResetBuffers\r
  @sa InstallProtocolInterface\r
**/\r
EFI_STATUS\r
EFIAPI\r
ConsoleLoggerInstall(\r
  IN CONST UINTN ScreensToSave,\r
  OUT CONSOLE_LOGGER_PRIVATE_DATA **ConsoleInfo\r
  )\r
{\r
  EFI_STATUS Status;\r
  ASSERT(ConsoleInfo != NULL);\r
\r
  (*ConsoleInfo) = AllocatePool(sizeof(CONSOLE_LOGGER_PRIVATE_DATA));\r
  if ((*ConsoleInfo) == NULL) {\r
    return (EFI_OUT_OF_RESOURCES);\r
  }\r
\r
  (*ConsoleInfo)->Signature        = CONSOLE_LOGGER_PRIVATE_DATA_SIGNATURE;\r
  (*ConsoleInfo)->OldConOut        = NULL;\r
  (*ConsoleInfo)->OldConHandle     = NULL;\r
  (*ConsoleInfo)->Buffer           = NULL;\r
  (*ConsoleInfo)->BufferSize       = 0;\r
  (*ConsoleInfo)->OriginalStartRow = 0;\r
  (*ConsoleInfo)->CurrentStartRow  = 0;\r
  (*ConsoleInfo)->RowsPerScreen    = 0;\r
  (*ConsoleInfo)->ColsPerScreen    = 0;\r
  (*ConsoleInfo)->Attributes       = NULL;\r
  (*ConsoleInfo)->AttribSize       = 0;\r
  (*ConsoleInfo)->ScreenCount      = ScreensToSave;\r
  (*ConsoleInfo)->HistoryMode.MaxMode       = 1;\r
  (*ConsoleInfo)->HistoryMode.Mode          = 0;\r
  (*ConsoleInfo)->HistoryMode.Attribute     = 0;\r
  (*ConsoleInfo)->HistoryMode.CursorColumn  = 0;\r
  (*ConsoleInfo)->HistoryMode.CursorRow     = 0;\r
  (*ConsoleInfo)->HistoryMode.CursorVisible = FALSE;\r
  (*ConsoleInfo)->OurConOut.Reset           = ConsoleLoggerReset;\r
  (*ConsoleInfo)->OurConOut.OutputString    = ConsoleLoggerOutputString;\r
  (*ConsoleInfo)->OurConOut.TestString      = ConsoleLoggerTestString;\r
  (*ConsoleInfo)->OurConOut.QueryMode       = ConsoleLoggerQueryMode;\r
  (*ConsoleInfo)->OurConOut.SetMode         = ConsoleLoggerSetMode;\r
  (*ConsoleInfo)->OurConOut.SetAttribute    = ConsoleLoggerSetAttribute;\r
  (*ConsoleInfo)->OurConOut.ClearScreen     = ConsoleLoggerClearScreen;\r
  (*ConsoleInfo)->OurConOut.SetCursorPosition = ConsoleLoggerSetCursorPosition;\r
  (*ConsoleInfo)->OurConOut.EnableCursor    = ConsoleLoggerEnableCursor;\r
  (*ConsoleInfo)->OurConOut.Mode            = NULL;\r
  (*ConsoleInfo)->Enabled                   = TRUE;\r
\r
  Status = ConsoleLoggerResetBuffers(*ConsoleInfo);\r
  if (EFI_ERROR(Status)) {\r
    SHELL_FREE_NON_NULL((*ConsoleInfo));\r
    *ConsoleInfo = NULL;\r
    return (Status);\r
  }\r
\r
  Status = gBS->InstallProtocolInterface(&gImageHandle, &gEfiSimpleTextOutProtocolGuid, EFI_NATIVE_INTERFACE, (VOID*)&((*ConsoleInfo)->OurConOut));\r
  if (EFI_ERROR(Status)) {\r
    SHELL_FREE_NON_NULL((*ConsoleInfo)->Buffer);\r
    SHELL_FREE_NON_NULL((*ConsoleInfo)->Attributes);\r
    SHELL_FREE_NON_NULL((*ConsoleInfo));\r
    *ConsoleInfo = NULL;\r
    return (Status);\r
  }\r
\r
  (*ConsoleInfo)->OldConOut = gST->ConOut;\r
  (*ConsoleInfo)->OldConHandle = gST->ConsoleOutHandle;\r
\r
  gST->ConsoleOutHandle = gImageHandle;\r
  gST->ConOut = &(*ConsoleInfo)->OurConOut;\r
\r
  return (Status);\r
}\r
\r
/**\r
  Return the system to the state it was before InstallConsoleLogger\r
  was installed.\r
\r
  @param[in,out] ConsoleInfo   The object from the install function.\r
\r
  @retval EFI_SUCCESS     The operation was successful\r
  @return other           The operation failed.  This was from UninstallProtocolInterface.\r
**/\r
EFI_STATUS\r
EFIAPI\r
ConsoleLoggerUninstall(\r
  IN CONSOLE_LOGGER_PRIVATE_DATA *ConsoleInfo\r
  )\r
{\r
  ASSERT(ConsoleInfo != NULL);\r
  ASSERT(ConsoleInfo->OldConOut != NULL);\r
\r
  if (ConsoleInfo->Buffer != NULL) {\r
    FreePool(ConsoleInfo->Buffer);\r
    DEBUG_CODE(ConsoleInfo->Buffer     = NULL;);\r
    DEBUG_CODE(ConsoleInfo->BufferSize = 0;);\r
  }\r
  if (ConsoleInfo->Attributes != NULL) {\r
    FreePool(ConsoleInfo->Attributes);\r
    DEBUG_CODE(ConsoleInfo->Attributes = NULL;);\r
    DEBUG_CODE(ConsoleInfo->AttribSize = 0;);\r
  }\r
\r
  gST->ConsoleOutHandle = ConsoleInfo->OldConHandle;\r
  gST->ConOut = ConsoleInfo->OldConOut;\r
\r
  return (gBS->UninstallProtocolInterface(gImageHandle, &gEfiSimpleTextOutProtocolGuid, (VOID*)&ConsoleInfo->OurConOut));\r
}\r
\r
/**\r
  Displays previously logged output back to the screen.\r
\r
  This will scroll the screen forwards and backwards through the log of previous\r
  output.  If Rows is 0 then the size of 1/2 the screen will be scrolled.  If Rows\r
  is (UINTN)(-1) then the size of the screen will be scrolled.\r
\r
  @param[in] Forward      If TRUE then the log will be displayed forwards (scroll to newer).\r
                          If FALSE then the log will be displayed backwards (scroll to older).\r
  @param[in] Rows         Determines how many rows the log should scroll.\r
  @param[in] ConsoleInfo  The pointer to the instance of the console logger information.\r
**/\r
EFI_STATUS\r
EFIAPI\r
ConsoleLoggerDisplayHistory(\r
  IN CONST BOOLEAN  Forward,\r
  IN CONST UINTN    Rows,\r
  IN CONSOLE_LOGGER_PRIVATE_DATA *ConsoleInfo\r
  )\r
{\r
  UINTN   RowChange;\r
\r
  ASSERT(ConsoleInfo != NULL);\r
\r
  //\r
  // Calculate the row number change\r
  //\r
  switch (Rows) {\r
  case ((UINTN)(-1)):\r
    RowChange = ConsoleInfo->RowsPerScreen;\r
    break;\r
  case (0):\r
    RowChange = ConsoleInfo->RowsPerScreen / 2;\r
    break;\r
  default:\r
    RowChange = Rows;\r
    break;\r
  }\r
\r
  //\r
  // Do the math for direction\r
  //\r
  if (Forward) {\r
    if ((ConsoleInfo->OriginalStartRow - ConsoleInfo->CurrentStartRow) < RowChange) {\r
      RowChange = ConsoleInfo->OriginalStartRow - ConsoleInfo->CurrentStartRow;\r
    }\r
  } else {\r
    if (ConsoleInfo->CurrentStartRow < RowChange) {\r
      RowChange = ConsoleInfo->CurrentStartRow;\r
    }\r
  }\r
\r
  //\r
  // If we are already at one end or the other\r
  //\r
  if (RowChange == 0) {\r
    return (EFI_SUCCESS);\r
  }\r
\r
  //\r
  // Clear the screen\r
  //\r
  ConsoleInfo->OldConOut->ClearScreen(ConsoleInfo->OldConOut);\r
\r
  //\r
  // Set the new start row\r
  //\r
  if (Forward) {\r
    ConsoleInfo->CurrentStartRow += RowChange;\r
  } else {\r
    ConsoleInfo->CurrentStartRow -= RowChange;\r
  }\r
\r
  //\r
  // Change the screen\r
  //\r
  return (UpdateDisplayFromHistory(ConsoleInfo));\r
}\r
\r
/**\r
  Function to return to normal output whent he scrolling is complete.\r
  @param[in] ConsoleInfo  The pointer to the instance of the console logger information.\r
\r
  @retval EFI_SUCCESS   The operation was successful.\r
  @return other         The operation failed.  See UpdateDisplayFromHistory.\r
\r
  @sa UpdateDisplayFromHistory\r
**/\r
EFI_STATUS\r
EFIAPI\r
ConsoleLoggerStopHistory(\r
  IN CONSOLE_LOGGER_PRIVATE_DATA *ConsoleInfo\r
  )\r
{\r
  ASSERT(ConsoleInfo != NULL);\r
  if (ConsoleInfo->CurrentStartRow == ConsoleInfo->OriginalStartRow) {\r
    return (EFI_SUCCESS);\r
  }\r
  ConsoleInfo->CurrentStartRow = ConsoleInfo->OriginalStartRow;\r
  return (UpdateDisplayFromHistory(ConsoleInfo));\r
}\r
\r
/**\r
  Updates the hidden ConOut to be displaying the correct stuff.\r
  @param[in] ConsoleInfo  The pointer to the instance of the console logger information.\r
\r
  @retval EFI_SUCCESS     The operation was successful.\r
  @return other           The operation failed.\r
**/\r
EFI_STATUS\r
EFIAPI\r
UpdateDisplayFromHistory(\r
  IN CONSOLE_LOGGER_PRIVATE_DATA *ConsoleInfo\r
  )\r
{\r
  EFI_STATUS      Status;\r
  EFI_STATUS      RetVal;\r
  CHAR16          *Screen;\r
  INT32           *Attributes;\r
  UINTN           CurrentRow;\r
  CHAR16          TempCharHolder;\r
  UINTN           Column;\r
  INT32           CurrentAttrib;\r
  UINTN           CurrentColumn;\r
  CHAR16          *StringSegment;\r
  CHAR16          *StringSegmentEnd;\r
  CHAR16          StringSegmentEndChar;\r
\r
  ASSERT(ConsoleInfo != NULL);\r
  TempCharHolder = CHAR_NULL;\r
  RetVal = EFI_SUCCESS;\r
\r
  //\r
  // Disable cursor visibility and move it to the top left corner\r
  //\r
  ConsoleInfo->OldConOut->EnableCursor       (ConsoleInfo->OldConOut, FALSE);\r
  ConsoleInfo->OldConOut->SetCursorPosition  (ConsoleInfo->OldConOut, 0, 0);\r
\r
  Screen = &ConsoleInfo->Buffer[(ConsoleInfo->ColsPerScreen + 2) * ConsoleInfo->CurrentStartRow];\r
  Attributes = &ConsoleInfo->Attributes[ConsoleInfo->ColsPerScreen * ConsoleInfo->CurrentStartRow];\r
  for ( CurrentRow = 0\r
      ; CurrentRow < ConsoleInfo->RowsPerScreen\r
      ; CurrentRow++\r
      , Screen += (ConsoleInfo->ColsPerScreen + 2)\r
      , Attributes += ConsoleInfo->ColsPerScreen\r
     ){\r
    //\r
    // dont use the last char - prevents screen scroll\r
    //\r
    if (CurrentRow == (ConsoleInfo->RowsPerScreen-1)){\r
      TempCharHolder = Screen[ConsoleInfo->ColsPerScreen - 1];\r
      Screen[ConsoleInfo->ColsPerScreen - 1] = CHAR_NULL;\r
    }\r
\r
    for ( Column = 0\r
        ; Column < ConsoleInfo->ColsPerScreen\r
        ; Column++\r
       ){\r
      if (Screen[Column] != CHAR_NULL) {\r
        CurrentAttrib = Attributes[Column];\r
        CurrentColumn = Column;\r
        StringSegment = &Screen[Column];\r
\r
        //\r
        // Find the first char with a different arrribute and make that temporarily NULL\r
        // so we can do fewer printout statements.  (later) restore that one and we will\r
        // start at that collumn on the next loop.\r
        //\r
        StringSegmentEndChar = CHAR_NULL;\r
        for ( StringSegmentEnd = StringSegment\r
            ; StringSegmentEnd != CHAR_NULL\r
            ; StringSegmentEnd++\r
            , Column++\r
           ){\r
          if (Attributes[Column] != CurrentAttrib) {\r
            StringSegmentEndChar = *StringSegmentEnd;\r
            *StringSegmentEnd    = CHAR_NULL;\r
            break;\r
          }\r
        } // StringSegmentEnd loop\r
\r
        //\r
        // Now write out as much as had the same Attributes\r
        //\r
\r
        ConsoleInfo->OldConOut->SetAttribute(ConsoleInfo->OldConOut, CurrentAttrib);\r
        ConsoleInfo->OldConOut->SetCursorPosition(ConsoleInfo->OldConOut, CurrentColumn, CurrentRow);\r
        Status = ConsoleInfo->OldConOut->OutputString(ConsoleInfo->OldConOut, StringSegment);\r
\r
        if (EFI_ERROR(Status)) {\r
          ASSERT(FALSE);\r
          RetVal = Status;\r
        }\r
\r
        //\r
        // If we found a change in attribute put the character back and decrement the column\r
        // so when it increments it will point at that character and we will start printing\r
        // a segment with that new attribute\r
        //\r
        if (StringSegmentEndChar != CHAR_NULL) {\r
          *StringSegmentEnd = StringSegmentEndChar;\r
          StringSegmentEndChar = CHAR_NULL;\r
          Column--;\r
        }\r
      }\r
    } // column for loop\r
\r
    //\r
    // If we removed the last char and this was the last row put it back\r
    //\r
    if (TempCharHolder != CHAR_NULL) {\r
      Screen[ConsoleInfo->ColsPerScreen - 1] = TempCharHolder;\r
      TempCharHolder = CHAR_NULL;\r
    }\r
  } // row for loop\r
\r
  //\r
  // If we are setting the screen back to original turn on the cursor and make it visible\r
  // and set the attributes back to what they were\r
  //\r
  if (ConsoleInfo->CurrentStartRow == ConsoleInfo->OriginalStartRow) {\r
    ConsoleInfo->OldConOut->SetAttribute (\r
                                ConsoleInfo->OldConOut,\r
                                ConsoleInfo->HistoryMode.Attribute\r
                               );\r
    ConsoleInfo->OldConOut->SetCursorPosition (\r
                                ConsoleInfo->OldConOut,\r
                                ConsoleInfo->HistoryMode.CursorColumn,\r
                                ConsoleInfo->HistoryMode.CursorRow - ConsoleInfo->OriginalStartRow\r
                               );\r
\r
    Status = ConsoleInfo->OldConOut->EnableCursor (\r
                                ConsoleInfo->OldConOut,\r
                                ConsoleInfo->HistoryMode.CursorVisible\r
                               );\r
    if (EFI_ERROR (Status)) {\r
      RetVal = Status;\r
    }\r
  }\r
\r
  return (RetVal);\r
}\r
\r
/**\r
  Reset the text output device hardware and optionaly run diagnostics\r
\r
  @param  This                pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL\r
  @param ExtendedVerification Indicates that a more extensive test may be performed\r
\r
  @retval EFI_SUCCESS         The text output device was reset.\r
  @retval EFI_DEVICE_ERROR    The text output device is not functioning correctly and\r
                              could not be reset.\r
**/\r
EFI_STATUS\r
EFIAPI\r
ConsoleLoggerReset (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
  IN  BOOLEAN                         ExtendedVerification\r
  )\r
{\r
  EFI_STATUS                  Status;\r
  CONSOLE_LOGGER_PRIVATE_DATA *ConsoleInfo;\r
  ConsoleInfo = CONSOLE_LOGGER_PRIVATE_DATA_FROM_THIS(This);\r
\r
  //\r
  // Forward the request to the original ConOut\r
  //\r
  Status = ConsoleInfo->OldConOut->Reset (ConsoleInfo->OldConOut, ExtendedVerification);\r
\r
  //\r
  // Check that the buffers are still correct for logging\r
  //\r
  if (!EFI_ERROR (Status)) {\r
    ConsoleLoggerResetBuffers(ConsoleInfo);\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Appends a string to the history buffer.  If the buffer is full then the oldest\r
  information in the buffer will be dropped.  Information is added in a line by\r
  line manner such that an empty line takes up just as much space as a full line.\r
\r
  @param[in] String       String pointer to add.\r
  @param[in] ConsoleInfo  The pointer to the instance of the console logger information.\r
**/\r
EFI_STATUS\r
EFIAPI\r
AppendStringToHistory(\r
  IN CONST CHAR16 *String,\r
  IN CONSOLE_LOGGER_PRIVATE_DATA *ConsoleInfo\r
  )\r
{\r
  CONST CHAR16  *Walker;\r
  UINTN         CopySize;\r
  UINTN         PrintIndex;\r
  UINTN         Index;\r
\r
  ASSERT(ConsoleInfo != NULL);\r
\r
  for ( Walker = String\r
      ; Walker != NULL && *Walker != CHAR_NULL\r
      ; Walker++\r
     ){\r
    switch (*Walker) {\r
    case (CHAR_BACKSPACE):\r
      if (ConsoleInfo->HistoryMode.CursorColumn > 0) {\r
        ConsoleInfo->HistoryMode.CursorColumn--;\r
      }\r
      break;\r
    case (CHAR_LINEFEED):\r
      if (ConsoleInfo->HistoryMode.CursorRow >= (INT32)((ConsoleInfo->RowsPerScreen * ConsoleInfo->ScreenCount)-1)) {\r
        //\r
        // Should never be bigger\r
        //\r
        ASSERT(ConsoleInfo->HistoryMode.CursorRow == (INT32)((ConsoleInfo->RowsPerScreen * ConsoleInfo->ScreenCount)-1));\r
\r
        //\r
        // scroll history attributes 'up' 1 row and set the last row to default attribute\r
        //\r
        CopySize = ConsoleInfo->ColsPerScreen\r
                 * ((ConsoleInfo->RowsPerScreen * ConsoleInfo->ScreenCount) - 1)\r
                 * sizeof(ConsoleInfo->Attributes[0]);\r
        ASSERT(CopySize < ConsoleInfo->AttribSize);\r
        CopyMem(\r
          ConsoleInfo->Attributes,\r
          ConsoleInfo->Attributes + ConsoleInfo->ColsPerScreen,\r
          CopySize\r
         );\r
\r
        for ( Index = 0\r
            ; Index < ConsoleInfo->ColsPerScreen\r
            ; Index++\r
           ){\r
          *(ConsoleInfo->Attributes + (CopySize/sizeof(ConsoleInfo->Attributes)) + Index) = ConsoleInfo->HistoryMode.Attribute;\r
        }\r
\r
        //\r
        // scroll history buffer 'up' 1 row and set the last row to spaces (L' ')\r
        //\r
        CopySize = (ConsoleInfo->ColsPerScreen + 2)\r
                 * ((ConsoleInfo->RowsPerScreen * ConsoleInfo->ScreenCount) - 1)\r
                 * sizeof(ConsoleInfo->Buffer[0]);\r
        ASSERT(CopySize < ConsoleInfo->BufferSize);\r
        CopyMem(\r
          ConsoleInfo->Buffer,\r
          ConsoleInfo->Buffer + (ConsoleInfo->ColsPerScreen + 2),\r
          CopySize\r
         );\r
\r
        //\r
        // Set that last row of chars to spaces\r
        //\r
        SetMem16(((UINT8*)ConsoleInfo->Buffer)+CopySize, ConsoleInfo->ColsPerScreen*sizeof(CHAR16), L' ');\r
      } else {\r
        //\r
        // we are not on the last row\r
        //\r
\r
        //\r
        // We should not be scrolling history\r
        //\r
        ASSERT (ConsoleInfo->OriginalStartRow == ConsoleInfo->CurrentStartRow);\r
        //\r
        // are we at the end of a row?\r
        //\r
        if (ConsoleInfo->HistoryMode.CursorRow == (INT32) (ConsoleInfo->OriginalStartRow + ConsoleInfo->RowsPerScreen - 1)) {\r
          ConsoleInfo->OriginalStartRow++;\r
          ConsoleInfo->CurrentStartRow++;\r
        }\r
        ConsoleInfo->HistoryMode.CursorRow++;\r
      }\r
      break;\r
    case (CHAR_CARRIAGE_RETURN):\r
      //\r
      // Move the cursor to the beginning of the current row.\r
      //\r
      ConsoleInfo->HistoryMode.CursorColumn = 0;\r
      break;\r
    default:\r
      //\r
      // Acrtually print characters into the history buffer\r
      //\r
\r
      PrintIndex = ConsoleInfo->HistoryMode.CursorRow * ConsoleInfo->ColsPerScreen + ConsoleInfo->HistoryMode.CursorColumn;\r
\r
      for ( // no initializer needed\r
          ; ConsoleInfo->HistoryMode.CursorColumn < (INT32) ConsoleInfo->ColsPerScreen\r
          ; ConsoleInfo->HistoryMode.CursorColumn++\r
          , PrintIndex++\r
          , Walker++\r
         ){\r
        if (*Walker == CHAR_NULL\r
          ||*Walker == CHAR_BACKSPACE\r
          ||*Walker == CHAR_LINEFEED\r
          ||*Walker == CHAR_CARRIAGE_RETURN\r
         ){\r
            Walker--;\r
            break;\r
        }\r
        //\r
        // The buffer is 2*CursorRow more since it has that many \r\n characters at the end of each row.\r
        //\r
\r
        ASSERT(PrintIndex + ConsoleInfo->HistoryMode.CursorRow < ConsoleInfo->BufferSize);\r
        ConsoleInfo->Buffer[PrintIndex + (2*ConsoleInfo->HistoryMode.CursorRow)] = *Walker;\r
        ASSERT(PrintIndex < ConsoleInfo->AttribSize);\r
        ConsoleInfo->Attributes[PrintIndex] = ConsoleInfo->HistoryMode.Attribute;\r
      } // for loop\r
\r
      //\r
      // Add the carriage return and line feed at the end of the lines\r
      //\r
      if (ConsoleInfo->HistoryMode.CursorColumn >= (INT32)ConsoleInfo->ColsPerScreen) {\r
        AppendStringToHistory(L"\r\n", ConsoleInfo);\r
        Walker--;\r
      }\r
\r
      break;\r
    } // switch for character\r
  } // for loop\r
\r
  return (EFI_SUCCESS);\r
}\r
\r
/**\r
  Worker function to handle printing the output to the screen\r
  and the history buffer\r
\r
  @param[in] String               The string to output\r
  @param[in] ConsoleInfo          The pointer to the instance of the console logger information.\r
\r
  @retval EFI_SUCCESS             The string was printed\r
  @retval EFI_DEVICE_ERROR        The device reported an error while attempting to output\r
                                  the text.\r
  @retval EFI_UNSUPPORTED         The output device's mode is not currently in a\r
                                  defined text mode.\r
  @retval EFI_WARN_UNKNOWN_GLYPH  This warning code indicates that some of the\r
                                  characters in the Unicode string could not be\r
                                  rendered and were skipped.\r
**/\r
EFI_STATUS\r
EFIAPI\r
ConsoleLoggerOutputStringSplit(\r
  IN CONST CHAR16   *String,\r
  IN CONSOLE_LOGGER_PRIVATE_DATA *ConsoleInfo\r
  )\r
{\r
  EFI_STATUS    Status;\r
\r
  //\r
  // Forward the request to the original ConOut\r
  //\r
  Status = ConsoleInfo->OldConOut->OutputString (ConsoleInfo->OldConOut, (CHAR16*)String);\r
\r
  if (EFI_ERROR(Status)) {\r
    return (Status);\r
  }\r
\r
  return (AppendStringToHistory(String, ConsoleInfo));\r
}\r
\r
/**\r
  Function to handle page break mode.\r
\r
  This function will prompt for continue or break.\r
\r
  @retval EFI_SUCCESS   Continue was choosen\r
  @return other         Break was choosen\r
**/\r
EFI_STATUS\r
EFIAPI\r
ConsoleLoggerDoPageBreak(\r
  VOID\r
  )\r
{\r
  SHELL_PROMPT_RESPONSE *Resp;\r
  EFI_STATUS            Status;\r
\r
  Resp = NULL;\r
  ASSERT(ShellInfoObject.PageBreakEnabled);\r
  ShellInfoObject.PageBreakEnabled = FALSE;\r
  Status = ShellPromptForResponseHii(ShellPromptResponseTypeQuitContinue, STRING_TOKEN(STR_SHELL_QUIT_CONT), ShellInfoObject.HiiHandle, (VOID**)&Resp);\r
  ShellInfoObject.PageBreakEnabled = TRUE;\r
  ASSERT(Resp != NULL);\r
  if (Resp == NULL) {\r
    return (EFI_NOT_FOUND);\r
  }\r
  if (EFI_ERROR(Status)) {\r
    if (Resp != NULL) {\r
      FreePool(Resp);\r
    }\r
    return (Status);\r
  }\r
  if (*Resp == ShellPromptResponseContinue) {\r
    FreePool(Resp);\r
    ShellInfoObject.ConsoleInfo->RowCounter = 0;\r
    return (EFI_SUCCESS);\r
  } else if (*Resp == ShellPromptResponseQuit) {\r
    FreePool(Resp);\r
    ShellInfoObject.ConsoleInfo->Enabled = FALSE;\r
    return (EFI_DEVICE_ERROR);\r
  } else {\r
    ASSERT(FALSE);\r
  }\r
  return (EFI_SUCCESS);\r
}\r
/**\r
  Worker function to handle printing the output with page breaks.\r
\r
  @param[in] String               The string to output\r
  @param[in] ConsoleInfo          The pointer to the instance of the console logger information.\r
\r
  @retval EFI_SUCCESS             The string was printed\r
  @retval EFI_DEVICE_ERROR        The device reported an error while attempting to output\r
                                  the text.\r
  @retval EFI_UNSUPPORTED         The output device's mode is not currently in a\r
                                  defined text mode.\r
  @retval EFI_WARN_UNKNOWN_GLYPH  This warning code indicates that some of the\r
                                  characters in the Unicode string could not be\r
                                  rendered and were skipped.\r
**/\r
EFI_STATUS\r
EFIAPI\r
ConsoleLoggerPrintWithPageBreak(\r
  IN CHAR16   *String,\r
  IN CONSOLE_LOGGER_PRIVATE_DATA *ConsoleInfo\r
  )\r
{\r
  CONST CHAR16  *Walker;\r
  CONST CHAR16  *LineStart;\r
  CHAR16        TempChar;\r
\r
  for ( Walker = String\r
      , LineStart = String\r
      ; Walker != NULL && *Walker != CHAR_NULL\r
      ; Walker++\r
     ){\r
    switch (*Walker) {\r
    case (CHAR_BACKSPACE):\r
      if (ConsoleInfo->OurConOut.Mode->CursorColumn > 0) {\r
        ConsoleInfo->OurConOut.Mode->CursorColumn--;\r
      }\r
      break;\r
    case (CHAR_LINEFEED):\r
      //\r
      // add a temp NULL terminator\r
      //\r
      TempChar = *(Walker + 1);\r
      *((CHAR16*)(Walker+1)) = CHAR_NULL;\r
\r
      //\r
      // output the string\r
      //\r
      ConsoleLoggerOutputStringSplit (LineStart, ConsoleInfo);\r
\r
      //\r
      // restore the temp NULL terminator to it's original character\r
      //\r
      *((CHAR16*)(Walker+1)) = TempChar;\r
\r
      //\r
      // Update LineStart Variable\r
      //\r
      LineStart = Walker + 1;\r
\r
      //\r
      // increment row count\r
      //\r
      ShellInfoObject.ConsoleInfo->RowCounter++;\r
      ConsoleInfo->OurConOut.Mode->CursorRow++;\r
\r
      break;\r
    case (CHAR_CARRIAGE_RETURN):\r
      //\r
      // Move the cursor to the beginning of the current row.\r
      //\r
      ConsoleInfo->OurConOut.Mode->CursorColumn = 0;\r
      break;\r
    default:\r
      //\r
      // increment column count\r
      //\r
      ConsoleInfo->OurConOut.Mode->CursorColumn++;\r
      //\r
      // check if that is the last column\r
      //\r
      if ((INTN)ConsoleInfo->ColsPerScreen == ConsoleInfo->OurConOut.Mode->CursorColumn - 1) {\r
        //\r
        // output a line similar to the linefeed character.\r
        //\r
\r
        //\r
        // add a temp NULL terminator\r
        //\r
        TempChar = *(Walker + 1);\r
        *((CHAR16*)(Walker+1)) = CHAR_NULL;\r
\r
        //\r
        // output the string\r
        //\r
        ConsoleLoggerOutputStringSplit (LineStart, ConsoleInfo);\r
\r
        //\r
        // restore the temp NULL terminator to it's original character\r
        //\r
        *((CHAR16*)(Walker+1)) = TempChar;\r
\r
        //\r
        // Update LineStart Variable\r
        //\r
        LineStart = Walker;\r
\r
        //\r
        // increment row count and zero the column\r
        //\r
        ShellInfoObject.ConsoleInfo->RowCounter++;\r
        ConsoleInfo->OurConOut.Mode->CursorRow++;\r
        ConsoleInfo->OurConOut.Mode->CursorColumn = 0;\r
      } // last column on line\r
      break;\r
    } // switch for character\r
\r
    //\r
    // check if that was the last printable row.  If yes handle PageBreak mode\r
    //\r
    if ((ConsoleInfo->RowsPerScreen) -1 == ShellInfoObject.ConsoleInfo->RowCounter) {\r
      if (EFI_ERROR(ConsoleLoggerDoPageBreak())) {\r
        //\r
        // We got an error which means 'break' and halt the printing\r
        //\r
        return (EFI_DEVICE_ERROR);\r
      }\r
    }\r
  } // for loop\r
\r
  if (LineStart != NULL && *LineStart != CHAR_NULL) {\r
    ConsoleLoggerOutputStringSplit (LineStart, ConsoleInfo);\r
  }\r
\r
  return (EFI_SUCCESS);\r
}\r
\r
/**\r
  Write a Unicode string to the output device.\r
\r
  @param[in] This                 Protocol instance pointer.\r
  @param[in] WString              The NULL-terminated Unicode string to be displayed on the output\r
                                  device(s). All output devices must also support the Unicode\r
                                  drawing defined in this file.\r
  @retval EFI_SUCCESS             The string was output to the device.\r
  @retval EFI_DEVICE_ERROR        The device reported an error while attempting to output\r
                                  the text.\r
  @retval EFI_UNSUPPORTED         The output device's mode is not currently in a\r
                                  defined text mode.\r
  @retval EFI_WARN_UNKNOWN_GLYPH  This warning code indicates that some of the\r
                                  characters in the Unicode string could not be\r
                                  rendered and were skipped.\r
**/\r
EFI_STATUS\r
EFIAPI\r
ConsoleLoggerOutputString (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
  IN  CHAR16                          *WString\r
  )\r
{\r
  CONSOLE_LOGGER_PRIVATE_DATA *ConsoleInfo;\r
  ConsoleInfo = CONSOLE_LOGGER_PRIVATE_DATA_FROM_THIS(This);\r
  ASSERT(ShellInfoObject.ConsoleInfo == ConsoleInfo);\r
  if (!ShellInfoObject.ConsoleInfo->Enabled) {\r
    return (EFI_DEVICE_ERROR);\r
  } else if (ShellInfoObject.PageBreakEnabled) {\r
    return (ConsoleLoggerPrintWithPageBreak(WString, ConsoleInfo));\r
  } else {\r
    return (ConsoleLoggerOutputStringSplit(WString, ConsoleInfo));\r
  }\r
}\r
\r
/**\r
  Verifies that all characters in a Unicode string can be output to the\r
  target device.\r
\r
  @param[in] This     Protocol instance pointer.\r
  @param[in] WString  The NULL-terminated Unicode string to be examined for the output\r
                      device(s).\r
\r
  @retval EFI_SUCCESS           The device(s) are capable of rendering the output string.\r
  @retval EFI_UNSUPPORTED       Some of the characters in the Unicode string cannot be\r
                                rendered by one or more of the output devices mapped\r
                                by the EFI handle.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
ConsoleLoggerTestString (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  CHAR16                        *WString\r
  )\r
{\r
  CONSOLE_LOGGER_PRIVATE_DATA *ConsoleInfo;\r
  ConsoleInfo = CONSOLE_LOGGER_PRIVATE_DATA_FROM_THIS(This);\r
  //\r
  // Forward the request to the original ConOut\r
  //\r
  return (ConsoleInfo->OldConOut->TestString (ConsoleInfo->OldConOut, WString));\r
}\r
\r
/**\r
  Returns information for an available text mode that the output device(s)\r
  supports.\r
\r
  @param[in] This               Protocol instance pointer.\r
  @param[in] ModeNumber         The mode number to return information on.\r
  @param[out] Columns           Upon return, the number of columns in the selected geometry\r
  @param[out] Rows              Upon return, the number of rows in the selected geometry\r
\r
  @retval EFI_SUCCESS           The requested mode information was returned.\r
  @retval EFI_DEVICE_ERROR      The device had an error and could not\r
                                complete the request.\r
  @retval EFI_UNSUPPORTED       The mode number was not valid.\r
**/\r
EFI_STATUS\r
EFIAPI\r
ConsoleLoggerQueryMode (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  UINTN                         ModeNumber,\r
  OUT UINTN                         *Columns,\r
  OUT UINTN                         *Rows\r
  )\r
{\r
  CONSOLE_LOGGER_PRIVATE_DATA *ConsoleInfo;\r
  ConsoleInfo = CONSOLE_LOGGER_PRIVATE_DATA_FROM_THIS(This);\r
  //\r
  // Forward the request to the original ConOut\r
  //\r
  return (ConsoleInfo->OldConOut->QueryMode (\r
    ConsoleInfo->OldConOut,\r
    ModeNumber,\r
    Columns,\r
    Rows\r
   ));\r
}\r
\r
/**\r
  Sets the output device(s) to a specified mode.\r
\r
  @param[in] This               Protocol instance pointer.\r
  @param[in] ModeNumber         The mode number to set.\r
\r
\r
  @retval EFI_SUCCESS           The requested text mode was set.\r
  @retval EFI_DEVICE_ERROR      The device had an error and\r
                                could not complete the request.\r
  @retval EFI_UNSUPPORTED       The mode number was not valid.\r
**/\r
EFI_STATUS\r
EFIAPI\r
ConsoleLoggerSetMode (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  UINTN                         ModeNumber\r
  )\r
{\r
  EFI_STATUS                  Status;\r
\r
  CONSOLE_LOGGER_PRIVATE_DATA *ConsoleInfo;\r
  ConsoleInfo = CONSOLE_LOGGER_PRIVATE_DATA_FROM_THIS(This);\r
\r
  //\r
  // Forward the request to the original ConOut\r
  //\r
  Status = ConsoleInfo->OldConOut->SetMode (ConsoleInfo->OldConOut, ModeNumber);\r
\r
  //\r
  // Check that the buffers are still correct for logging\r
  //\r
  if (!EFI_ERROR (Status)) {\r
    ConsoleLoggerResetBuffers(ConsoleInfo);\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Sets the background and foreground colors for the OutputString () and\r
  ClearScreen () functions.\r
\r
  @param[in] This               Protocol instance pointer.\r
  @param[in] Attribute          The attribute to set. Bits 0..3 are the foreground color, and\r
                                bits 4..6 are the background color. All other bits are undefined\r
                                and must be zero. The valid Attributes are defined in this file.\r
\r
  @retval EFI_SUCCESS           The attribute was set.\r
  @retval EFI_DEVICE_ERROR      The device had an error and\r
                                could not complete the request.\r
  @retval EFI_UNSUPPORTED       The attribute requested is not defined.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
ConsoleLoggerSetAttribute (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
  IN  UINTN                           Attribute\r
  )\r
{\r
  EFI_STATUS                  Status;\r
\r
  CONSOLE_LOGGER_PRIVATE_DATA *ConsoleInfo;\r
  ConsoleInfo = CONSOLE_LOGGER_PRIVATE_DATA_FROM_THIS(This);\r
\r
  //\r
  // Forward the request to the original ConOut\r
  //\r
  Status = ConsoleInfo->OldConOut->SetAttribute (ConsoleInfo->OldConOut, Attribute);\r
\r
  //\r
  // Record console output history\r
  //\r
  if (!EFI_ERROR (Status)) {\r
    ConsoleInfo->HistoryMode.Attribute = (INT32) Attribute;\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Clears the output device(s) display to the currently selected background\r
  color.\r
\r
  @param[in] This               Protocol instance pointer.\r
\r
  @retval EFI_SUCCESS           The operation completed successfully.\r
  @retval EFI_DEVICE_ERROR      The device had an error and\r
                                could not complete the request.\r
  @retval EFI_UNSUPPORTED       The output device is not in a valid text mode.\r
**/\r
EFI_STATUS\r
EFIAPI\r
ConsoleLoggerClearScreen (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This\r
  )\r
{\r
  EFI_STATUS        Status;\r
  CHAR16            *Screen;\r
  INT32             *Attributes;\r
  UINTN             Row;\r
  UINTN             Column;\r
\r
\r
  CONSOLE_LOGGER_PRIVATE_DATA *ConsoleInfo;\r
  ConsoleInfo = CONSOLE_LOGGER_PRIVATE_DATA_FROM_THIS(This);\r
\r
  //\r
  // Forward the request to the original ConOut\r
  //\r
  Status = ConsoleInfo->OldConOut->ClearScreen (ConsoleInfo->OldConOut);\r
\r
  //\r
  // Record console output history\r
  //\r
  if (!EFI_ERROR (Status)) {\r
    Screen = &ConsoleInfo->Buffer[(ConsoleInfo->ColsPerScreen + 1) * ConsoleInfo->CurrentStartRow];\r
    Attributes = &ConsoleInfo->Attributes[ConsoleInfo->ColsPerScreen * ConsoleInfo->CurrentStartRow];\r
    for ( Row = ConsoleInfo->OriginalStartRow\r
        ; Row < (ConsoleInfo->RowsPerScreen * ConsoleInfo->ScreenCount)\r
        ; Row++\r
       ){\r
      for ( Column = 0\r
          ; Column < ConsoleInfo->ColsPerScreen\r
          ; Column++\r
          , Screen++\r
          , Attributes++\r
         ){\r
        *Screen = L' ';\r
        *Attributes = ConsoleInfo->OldConOut->Mode->Attribute;\r
      }\r
      //\r
      // Skip the NULL on each column end in text buffer only\r
      //\r
      Screen++;\r
    }\r
    ConsoleInfo->HistoryMode.CursorColumn = 0;\r
    ConsoleInfo->HistoryMode.CursorRow    = 0;\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Sets the current coordinates of the cursor position\r
\r
  @param[in] This               Protocol instance pointer.\r
  @param[in] Column             Column to put the cursor in.  Must be between zero and Column returned from QueryMode\r
  @param[in] Row                Row to put the cursor in.  Must be between zero and Row returned from QueryMode\r
\r
  @retval EFI_SUCCESS           The operation completed successfully.\r
  @retval EFI_DEVICE_ERROR      The device had an error and\r
                                could not complete the request.\r
  @retval EFI_UNSUPPORTED       The output device is not in a valid text mode, or the\r
                                cursor position is invalid for the current mode.\r
**/\r
EFI_STATUS\r
EFIAPI\r
ConsoleLoggerSetCursorPosition (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  UINTN                         Column,\r
  IN  UINTN                         Row\r
  )\r
{\r
  EFI_STATUS                  Status;\r
\r
  CONSOLE_LOGGER_PRIVATE_DATA *ConsoleInfo;\r
  ConsoleInfo = CONSOLE_LOGGER_PRIVATE_DATA_FROM_THIS(This);\r
  //\r
  // Forward the request to the original ConOut\r
  //\r
  Status = ConsoleInfo->OldConOut->SetCursorPosition (\r
    ConsoleInfo->OldConOut,\r
    Column,\r
    Row\r
   );\r
\r
  //\r
  // Record console output history\r
  //\r
  if (!EFI_ERROR (Status)) {\r
    ConsoleInfo->HistoryMode.CursorColumn = (INT32)Column;\r
    ConsoleInfo->HistoryMode.CursorRow    = (INT32)(ConsoleInfo->OriginalStartRow + Row);\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Makes the cursor visible or invisible\r
\r
  @param[in] This       Protocol instance pointer.\r
  @param[in] Visible    If TRUE, the cursor is set to be visible. If FALSE, the cursor is\r
                        set to be invisible.\r
\r
  @retval EFI_SUCCESS           The operation completed successfully.\r
  @retval EFI_DEVICE_ERROR      The device had an error and could not complete the\r
                                request, or the device does not support changing\r
                                the cursor mode.\r
  @retval EFI_UNSUPPORTED       The output device is not in a valid text mode.\r
**/\r
EFI_STATUS\r
EFIAPI\r
ConsoleLoggerEnableCursor (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
  IN  BOOLEAN                       Visible\r
  )\r
{\r
  EFI_STATUS                  Status;\r
\r
  CONSOLE_LOGGER_PRIVATE_DATA *ConsoleInfo;\r
  ConsoleInfo = CONSOLE_LOGGER_PRIVATE_DATA_FROM_THIS(This);\r
  //\r
  // Forward the request to the original ConOut\r
  //\r
  Status = ConsoleInfo->OldConOut->EnableCursor (ConsoleInfo->OldConOut, Visible);\r
\r
  //\r
  // Record console output history\r
  //\r
  if (!EFI_ERROR (Status)) {\r
    ConsoleInfo->HistoryMode.CursorVisible = Visible;\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Function to update and verify that the current buffers are correct.\r
\r
  @param[in] ConsoleInfo  The pointer to the instance of the console logger information.\r
\r
  This will be used when a mode has changed or a reset ocurred to verify all\r
  history buffers.\r
**/\r
EFI_STATUS\r
EFIAPI\r
ConsoleLoggerResetBuffers(\r
  IN CONSOLE_LOGGER_PRIVATE_DATA *ConsoleInfo\r
  )\r
{\r
  EFI_STATUS Status;\r
\r
  if (ConsoleInfo->Buffer != NULL) {\r
    FreePool(ConsoleInfo->Buffer);\r
    ConsoleInfo->Buffer     = NULL;\r
    ConsoleInfo->BufferSize = 0;\r
  }\r
  if (ConsoleInfo->Attributes != NULL) {\r
    FreePool(ConsoleInfo->Attributes);\r
    ConsoleInfo->Attributes = NULL;\r
    ConsoleInfo->AttribSize = 0;\r
  }\r
\r
  Status = gST->ConOut->QueryMode (gST->ConOut, gST->ConOut->Mode->Mode, &ConsoleInfo->ColsPerScreen, &ConsoleInfo->RowsPerScreen);\r
  if (EFI_ERROR(Status)){\r
    return (Status);\r
  }\r
\r
  ConsoleInfo->BufferSize = (ConsoleInfo->ColsPerScreen + 2) * ConsoleInfo->RowsPerScreen * ConsoleInfo->ScreenCount * sizeof(ConsoleInfo->Buffer[0]);\r
  ConsoleInfo->AttribSize = ConsoleInfo->ColsPerScreen * ConsoleInfo->RowsPerScreen * ConsoleInfo->ScreenCount * sizeof(ConsoleInfo->Attributes[0]);\r
\r
  ConsoleInfo->Buffer = (CHAR16*)AllocateZeroPool(ConsoleInfo->BufferSize);\r
\r
  if (ConsoleInfo->Buffer == NULL) {\r
    return (EFI_OUT_OF_RESOURCES);\r
  }\r
\r
  ConsoleInfo->Attributes = (INT32*)AllocateZeroPool(ConsoleInfo->AttribSize);\r
  if (ConsoleInfo->Attributes == NULL) {\r
    FreePool(ConsoleInfo->Buffer);\r
    ConsoleInfo->Buffer     = NULL;\r
    return (EFI_OUT_OF_RESOURCES);\r
  }\r
\r
  ConsoleInfo->OurConOut.Mode = gST->ConOut->Mode;\r
  ConsoleInfo->OldConOut = gST->ConOut;\r
  CopyMem (&ConsoleInfo->HistoryMode, ConsoleInfo->OldConOut->Mode, sizeof (EFI_SIMPLE_TEXT_OUTPUT_MODE));\r
\r
  return (EFI_SUCCESS);\r
}\r