MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Library / CustomizedDisplayLib / CustomizedDisplayLibInternal.h

/** @file\r
\r
  This library class defines a set of interfaces to customize Display module\r
\r
Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __CUSTOMIZED_DISPLAY_LIB_INTERNAL_H__\r
#define __CUSTOMIZED_DISPLAY_LIB_INTERNAL_H__\r
\r
\r
\r
#include <PiDxe.h>\r
\r
#include <Protocol/SimpleTextOut.h>\r
#include <Protocol/SimpleTextIn.h>\r
#include <Protocol/FormBrowser2.h>\r
#include <Protocol/FormBrowserEx2.h>\r
#include <Protocol/DisplayProtocol.h>\r
#include <Protocol/DevicePath.h>\r
#include <Protocol/UnicodeCollation.h>\r
#include <Protocol/HiiConfigAccess.h>\r
#include <Protocol/HiiConfigRouting.h>\r
#include <Protocol/HiiDatabase.h>\r
#include <Protocol/HiiString.h>\r
#include <Protocol/UserManager.h>\r
#include <Protocol/DevicePathFromText.h>\r
\r
#include <Guid/MdeModuleHii.h>\r
#include <Guid/HiiPlatformSetupFormset.h>\r
#include <Guid/HiiFormMapMethodGuid.h>\r
\r
#include <Library/PrintLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/HiiLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/CustomizedDisplayLib.h>\r
\r
#include "Colors.h"\r
\r
\r
\r
#define FORMSET_CLASS_PLATFORM_SETUP         0x0001\r
#define FORMSET_CLASS_FRONT_PAGE             0x0002\r
\r
\r
#define FRONT_PAGE_HEADER_HEIGHT      6\r
#define NONE_FRONT_PAGE_HEADER_HEIGHT 3\r
#define FOOTER_HEIGHT                 4\r
#define STATUS_BAR_HEIGHT             1\r
\r
//\r
// Screen definitions\r
//\r
#define BANNER_HEIGHT                 6\r
#define BANNER_COLUMNS                3\r
#define BANNER_LEFT_COLUMN_INDENT     1\r
\r
//\r
// Character definitions\r
//\r
#define UPPER_LOWER_CASE_OFFSET 0x20\r
\r
//\r
// This is the Input Error Message\r
//\r
#define INPUT_ERROR 1\r
\r
//\r
// This is the NV RAM update required Message\r
//\r
#define NV_UPDATE_REQUIRED  2\r
\r
typedef struct {\r
  EFI_STRING_ID  Banner[BANNER_HEIGHT][BANNER_COLUMNS];\r
} BANNER_DATA;\r
\r
extern  UINT16                        gClassOfVfr;                 // Formset class information\r
extern  BANNER_DATA                   *gBannerData;\r
extern  EFI_SCREEN_DESCRIPTOR         gScreenDimensions;\r
extern  UINTN                         gFooterHeight;\r
\r
//\r
// Browser Global Strings\r
//\r
extern CHAR16            *gEnterString;\r
extern CHAR16            *gEnterCommitString;\r
extern CHAR16            *gEnterEscapeString;\r
extern CHAR16            *gEscapeString;\r
extern CHAR16            *gMoveHighlight;\r
extern CHAR16            *gDecNumericInput;\r
extern CHAR16            *gHexNumericInput;\r
extern CHAR16            *gToggleCheckBox;\r
extern CHAR16            *gLibEmptyString;\r
extern CHAR16            *gAreYouSure;\r
extern CHAR16            *gYesResponse;\r
extern CHAR16            *gNoResponse;\r
extern CHAR16            *gPlusString;\r
extern CHAR16            *gMinusString;\r
extern CHAR16            *gAdjustNumber;\r
extern CHAR16            *gSaveChanges;\r
extern CHAR16            *gNvUpdateMessage;\r
extern CHAR16            *gInputErrorMessage;\r
/**\r
\r
  Print banner info for front page.\r
\r
  @param[in]  FormData             Form Data to be shown in Page\r
\r
**/\r
VOID\r
PrintBannerInfo (\r
  IN FORM_DISPLAY_ENGINE_FORM       *FormData\r
  );\r
\r
/**\r
  Print framework and form title for a page.\r
\r
  @param[in]  FormData             Form Data to be shown in Page\r
**/\r
VOID\r
PrintFramework (\r
  IN FORM_DISPLAY_ENGINE_FORM       *FormData\r
  );\r
\r
/**\r
  Validate the input screen diemenstion info.\r
\r
  @param  FormData               The input form data info.\r
\r
  @return EFI_SUCCESS            The input screen info is acceptable.\r
  @return EFI_INVALID_PARAMETER  The input screen info is not acceptable.\r
\r
**/\r
EFI_STATUS\r
ScreenDiemensionInfoValidate (\r
  IN FORM_DISPLAY_ENGINE_FORM       *FormData\r
  );\r
\r
/**\r
  Get the string based on the StringId and HII Package List Handle.\r
\r
  @param  Token                  The String's ID.\r
  @param  HiiHandle              The package list in the HII database to search for\r
                                 the specified string.\r
\r
  @return The output string.\r
\r
**/\r
CHAR16 *\r
LibGetToken (\r
  IN  EFI_STRING_ID                Token,\r
  IN  EFI_HII_HANDLE               HiiHandle\r
  );\r
\r
/**\r
  Count the storage space of a Unicode string.\r
\r
  This function handles the Unicode string with NARROW_CHAR\r
  and WIDE_CHAR control characters. NARROW_HCAR and WIDE_CHAR\r
  does not count in the resultant output. If a WIDE_CHAR is\r
  hit, then 2 Unicode character will consume an output storage\r
  space with size of CHAR16 till a NARROW_CHAR is hit.\r
\r
  If String is NULL, then ASSERT ().\r
\r
  @param String          The input string to be counted.\r
\r
  @return Storage space for the input string.\r
\r
**/\r
UINTN\r
LibGetStringWidth (\r
  IN CHAR16               *String\r
  );\r
\r
/**\r
  Show all registered HotKey help strings on bottom Rows.\r
\r
  @param FormData          The curent input form data info.\r
  @param SetState          Set HotKey or Clear HotKey\r
\r
**/\r
VOID\r
PrintHotKeyHelpString (\r
  IN FORM_DISPLAY_ENGINE_FORM      *FormData,\r
  IN BOOLEAN                       SetState\r
  );\r
\r
/**\r
  Get step info from numeric opcode.\r
\r
  @param[in] OpCode     The input numeric op code.\r
\r
  @return step info for this opcode.\r
**/\r
UINT64\r
LibGetFieldFromNum (\r
  IN  EFI_IFR_OP_HEADER     *OpCode\r
  );\r
\r
/**\r
  Initialize the HII String Token to the correct values.\r
\r
**/\r
VOID\r
InitializeLibStrings (\r
  VOID\r
  );\r
\r
/**\r
  Free the HII String.\r
\r
**/\r
VOID\r
FreeLibStrings (\r
  VOID\r
  );\r
\r
/**\r
  Wait for a key to be pressed by user.\r
\r
  @param Key         The key which is pressed by user.\r
\r
  @retval EFI_SUCCESS The function always completed successfully.\r
\r
**/\r
EFI_STATUS\r
WaitForKeyStroke (\r
  OUT  EFI_INPUT_KEY           *Key\r
  );\r
\r
/**\r
  Set Buffer to Value for Size bytes.\r
\r
  @param  Buffer                 Memory to set.\r
  @param  Size                   Number of bytes to set\r
  @param  Value                  Value of the set operation.\r
\r
**/\r
VOID\r
LibSetUnicodeMem (\r
  IN VOID   *Buffer,\r
  IN UINTN  Size,\r
  IN CHAR16 Value\r
  );\r
\r
/**\r
  Prints a formatted unicode string to the default console, at\r
  the supplied cursor position.\r
\r
  @param  Width      Width of String to be printed.\r
  @param  Column     The cursor position to print the string at.\r
  @param  Row        The cursor position to print the string at.\r
  @param  Fmt        Format string.\r
  @param  ...        Variable argument list for format string.\r
\r
  @return Length of string printed to the console\r
\r
**/\r
UINTN\r
EFIAPI\r
PrintAt (\r
  IN UINTN     Width,\r
  IN UINTN     Column,\r
  IN UINTN     Row,\r
  IN CHAR16    *Fmt,\r
  ...\r
  );\r
\r
/**\r
  Process some op codes which is out side of current form.\r
\r
  @param FormData                Pointer to the form data.\r
\r
**/\r
VOID\r
ProcessExternedOpcode (\r
  IN FORM_DISPLAY_ENGINE_FORM       *FormData\r
  );\r
\r
#endif\r