UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / EditInputBar.h

/** @file\r
  Declares imputbar interface functions.\r
\r
  Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved. <BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _LIB_INPUT_BAR_H_\r
#define _LIB_INPUT_BAR_H_\r
\r
/**\r
  Initialize the input bar.\r
\r
  @param[in] TextInEx  Pointer to SimpleTextInEx instance in System Table.\r
**/\r
VOID\r
InputBarInit (\r
  IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *TextInEx\r
  );\r
\r
/**\r
  Cleanup function for input bar.\r
**/\r
VOID\r
InputBarCleanup (\r
  VOID\r
  );\r
\r
/**\r
  The refresh function for InputBar, it will wait for user input\r
\r
  @param[in] LastRow            The last printable row.\r
  @param[in] LastColumn         The last printable column.\r
\r
  @retval EFI_SUCCESS           The operation was successful.\r
**/\r
EFI_STATUS\r
InputBarRefresh (\r
  UINTN  LastRow,\r
  UINTN  LastColumn\r
  );\r
\r
/**\r
  SetPrompt and wait for input.\r
\r
  @param[in] Str                The prompt string.\r
\r
  @retval EFI_SUCCESS           The operation was successful.\r
  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.\r
**/\r
EFI_STATUS\r
InputBarSetPrompt (\r
  IN CONST CHAR16  *Str\r
  );\r
\r
/**\r
  Set the size of the string in characters.\r
\r
  @param[in] Size               The max number of characters to accept.\r
\r
  @retval EFI_SUCCESS           The operation was successful.\r
  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.\r
**/\r
EFI_STATUS\r
InputBarSetStringSize (\r
  UINTN  Size\r
  );\r
\r
/**\r
  Function to retrieve the input from the user.\r
\r
  @retval NULL                  No input has been received.\r
  @return The string that was input.\r
**/\r
CONST CHAR16 *\r
InputBarGetString (\r
  VOID\r
  );\r
\r
#endif\r