[mirror_edk2.git] / MdeModulePkg / Universal / DisplayEngineDxe / FormDisplay.h

/** @file\r
  FormDiplay protocol to show Form\r
\r
Copyright (c) 2013 - 2014, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials are licensed and made available under \r
the terms and conditions of the BSD License that accompanies this distribution.  \r
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
\r
#ifndef __FORM_DISPLAY_H__\r
#define __FORM_DISPLAY_H__\r
\r
\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/HiiLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/PrintLib.h>\r
#include <Library/CustomizedDisplayLib.h>\r
\r
#include <Protocol/FormBrowserEx2.h>\r
#include <Protocol/SimpleTextIn.h>\r
#include <Protocol/DisplayProtocol.h>\r
\r
#include <Guid/MdeModuleHii.h>\r
\r
//\r
// This is the generated header file which includes whatever needs to be exported (strings + IFR)\r
//\r
extern UINT8  DisplayEngineStrings[];\r
extern EFI_SCREEN_DESCRIPTOR         gStatementDimensions;\r
extern USER_INPUT                    *gUserInput;\r
extern FORM_DISPLAY_ENGINE_FORM      *gFormData;\r
extern EFI_HII_HANDLE                gHiiHandle;\r
extern UINT16                        gDirection;\r
extern LIST_ENTRY                    gMenuOption;\r
\r
//\r
// Browser Global Strings\r
//\r
extern CHAR16            *gSaveFailed;\r
extern CHAR16            *gPromptForData;\r
extern CHAR16            *gPromptForPassword;\r
extern CHAR16            *gPromptForNewPassword;\r
extern CHAR16            *gConfirmPassword;\r
extern CHAR16            *gConfirmError;\r
extern CHAR16            *gPassowordInvalid;\r
extern CHAR16            *gPressEnter;\r
extern CHAR16            *gEmptyString;\r
extern CHAR16            *gMiniString;\r
extern CHAR16            *gOptionMismatch;\r
extern CHAR16            *gFormSuppress;\r
extern CHAR16            *gProtocolNotFound;\r
\r
extern CHAR16            gPromptBlockWidth;\r
extern CHAR16            gOptionBlockWidth;\r
extern CHAR16            gHelpBlockWidth;\r
extern CHAR16            *mUnknownString;\r
extern BOOLEAN           gMisMatch;\r
\r
//\r
// Screen definitions\r
//\r
\r
#define LEFT_SKIPPED_COLUMNS          3\r
#define SCROLL_ARROW_HEIGHT           1\r
#define POPUP_PAD_SPACE_COUNT         5\r
#define POPUP_FRAME_WIDTH             2\r
\r
#define UPPER_LOWER_CASE_OFFSET       0x20\r
\r
//\r
// Display definitions\r
//\r
#define LEFT_ONEOF_DELIMITER      L'<'\r
#define RIGHT_ONEOF_DELIMITER     L'>'\r
\r
#define LEFT_NUMERIC_DELIMITER    L'['\r
#define RIGHT_NUMERIC_DELIMITER   L']'\r
\r
#define LEFT_CHECKBOX_DELIMITER   L'['\r
#define RIGHT_CHECKBOX_DELIMITER  L']'\r
\r
#define CHECK_ON                  L'X'\r
#define CHECK_OFF                 L' '\r
\r
#define TIME_SEPARATOR            L':'\r
#define DATE_SEPARATOR            L'/'\r
\r
#define SUBTITLE_INDENT  2\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
// Time definitions\r
//\r
#define ONE_SECOND  10000000\r
\r
//\r
// It take 23 characters including the NULL to print a 64 bits number with "[" and "]".\r
// pow(2, 64) = [18446744073709551616]\r
//\r
#define MAX_NUMERIC_INPUT_WIDTH 23\r
\r
#define EFI_HII_EXPRESSION_INCONSISTENT_IF   0\r
#define EFI_HII_EXPRESSION_NO_SUBMIT_IF      1\r
#define EFI_HII_EXPRESSION_GRAY_OUT_IF       2\r
#define EFI_HII_EXPRESSION_SUPPRESS_IF       3\r
#define EFI_HII_EXPRESSION_DISABLE_IF        4\r
\r
//\r
// Character definitions\r
//\r
#define CHAR_SPACE              0x0020\r
\r
#define FORM_DISPLAY_DRIVER_SIGNATURE SIGNATURE_32 ('F', 'D', 'D', 'V')\r
typedef struct {\r
  UINT32                             Signature;\r
\r
  EFI_HANDLE                         Handle;\r
\r
  //\r
  // Produced protocol\r
  //\r
  EDKII_FORM_DISPLAY_ENGINE_PROTOCOL FromDisplayProt;\r
} FORM_DISPLAY_DRIVER_PRIVATE_DATA;\r
\r
\r
typedef enum {\r
  UiNoOperation,\r
  UiSelect,\r
  UiUp,\r
  UiDown,\r
  UiLeft,\r
  UiRight,\r
  UiReset,\r
  UiPrevious,\r
  UiPageUp,\r
  UiPageDown,\r
  UiHotKey,\r
  UiMaxOperation\r
} UI_SCREEN_OPERATION;\r
\r
typedef enum {\r
  CfInitialization,\r
  CfCheckSelection,\r
  CfRepaint,\r
  CfRefreshHighLight,\r
  CfUpdateHelpString,\r
  CfPrepareToReadKey,\r
  CfReadKey,\r
  CfScreenOperation,\r
  CfUiSelect,\r
  CfUiReset,\r
  CfUiLeft,\r
  CfUiRight,\r
  CfUiUp,\r
  CfUiPageUp,\r
  CfUiPageDown,\r
  CfUiDown,\r
  CfUiNoOperation,\r
  CfExit,\r
  CfUiHotKey,\r
  CfMaxControlFlag\r
} UI_CONTROL_FLAG;\r
\r
typedef enum {\r
  UIEventNone,\r
  UIEventKey,\r
  UIEventTimeOut,\r
  UIEventDriver\r
} UI_EVENT_TYPE;\r
\r
typedef struct {\r
  UINT16              ScanCode;\r
  UI_SCREEN_OPERATION ScreenOperation;\r
} SCAN_CODE_TO_SCREEN_OPERATION;\r
\r
typedef struct {\r
  UI_SCREEN_OPERATION ScreenOperation;\r
  UI_CONTROL_FLAG     ControlFlag;\r
} SCREEN_OPERATION_T0_CONTROL_FLAG;\r
\r
typedef struct {\r
  EFI_HII_HANDLE     HiiHandle;\r
  UINT16             FormId;\r
  \r
  //\r
  // Info for the highlight question.\r
  // HLT means highlight\r
  //\r
  // If one statement has questionid, save questionid info to find the question.\r
  // If one statement not has questionid info, save the opcode info to find the \r
  // statement. If more than one statement has same opcode in one form(just like\r
  // empty subtitle info may has more than one info one form), also use Index \r
  // info to find the statement.\r
  //\r
  EFI_QUESTION_ID    HLTQuestionId;\r
  EFI_IFR_OP_HEADER  *HLTOpCode;\r
  UINTN              HLTIndex;\r
  UINTN              HLTSequence;\r
  \r
  //\r
  // Info for the top of screen question.\r
  // TOS means Top Of Screen\r
  //\r
  EFI_QUESTION_ID    TOSQuestionId;\r
  EFI_IFR_OP_HEADER  *TOSOpCode;\r
  UINTN              TOSIndex;\r
\r
  UINT16             SkipValue;\r
} DISPLAY_HIGHLIGHT_MENU_INFO;\r
\r
typedef struct {\r
  EFI_EVENT   SyncEvent;\r
  UINT8       *TimeOut;\r
  CHAR16      *ErrorInfo;\r
} WARNING_IF_CONTEXT;\r
\r
#define UI_MENU_OPTION_SIGNATURE  SIGNATURE_32 ('u', 'i', 'm', 'm')\r
\r
typedef struct {\r
  UINTN                   Signature;\r
  LIST_ENTRY              Link;\r
\r
  EFI_HII_HANDLE          Handle;\r
  FORM_DISPLAY_ENGINE_STATEMENT  *ThisTag;\r
  UINT16                  EntryNumber;\r
\r
  UINTN                   Row;\r
  UINTN                   Col;\r
  UINTN                   OptCol;\r
  CHAR16                  *Description;\r
  UINTN                   Skip;           // Number of lines\r
\r
  //\r
  // Display item sequence for date/time\r
  //  Date:      Month/Day/Year\r
  //  Sequence:  0     1   2\r
  //\r
  //  Time:      Hour : Minute : Second\r
  //  Sequence:  0      1        2\r
  //\r
  //\r
  UINTN                   Sequence;\r
\r
  BOOLEAN                 GrayOut;\r
  BOOLEAN                 ReadOnly;\r
\r
  //\r
  // Whether user could change value of this item\r
  //\r
  BOOLEAN                 IsQuestion;\r
  BOOLEAN                 NestInStatement;\r
} UI_MENU_OPTION;\r
\r
#define MENU_OPTION_FROM_LINK(a)  CR (a, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE)\r
\r
/**\r
  Print Question Value according to it's storage width and display attributes.\r
\r
  @param  Question               The Question to be printed.\r
  @param  FormattedNumber        Buffer for output string.\r
  @param  BufferSize             The FormattedNumber buffer size in bytes.\r
\r
  @retval EFI_SUCCESS            Print success.\r
  @retval EFI_BUFFER_TOO_SMALL   Buffer size is not enough for formatted number.\r
\r
**/\r
EFI_STATUS\r
PrintFormattedNumber (\r
  IN FORM_DISPLAY_ENGINE_STATEMENT   *Question,\r
  IN OUT CHAR16               *FormattedNumber,\r
  IN UINTN                    BufferSize\r
  );\r
\r
/**\r
  Set value of a data element in an Array by its Index.\r
\r
  @param  Array                  The data array.\r
  @param  Type                   Type of the data in this array.\r
  @param  Index                  Zero based index for data in this array.\r
  @param  Value                  The value to be set.\r
\r
**/\r
VOID\r
SetArrayData (\r
  IN VOID                     *Array,\r
  IN UINT8                    Type,\r
  IN UINTN                    Index,\r
  IN UINT64                   Value\r
  );\r
\r
/**\r
  Return data element in an Array by its Index.\r
\r
  @param  Array                  The data array.\r
  @param  Type                   Type of the data in this array.\r
  @param  Index                  Zero based index for data in this array.\r
\r
  @retval Value                  The data to be returned\r
\r
**/\r
UINT64\r
GetArrayData (\r
  IN VOID                     *Array,\r
  IN UINT8                    Type,\r
  IN UINTN                    Index\r
  );\r
  \r
/**\r
  Search an Option of a Question by its value.\r
\r
  @param  Question               The Question\r
  @param  OptionValue            Value for Option to be searched.\r
\r
  @retval Pointer                Pointer to the found Option.\r
  @retval NULL                   Option not found.\r
\r
**/\r
DISPLAY_QUESTION_OPTION *\r
ValueToOption (\r
  IN FORM_DISPLAY_ENGINE_STATEMENT   *Question,\r
  IN EFI_HII_VALUE                   *OptionValue\r
  );\r
\r
/**\r
  Compare two Hii value.\r
\r
  @param  Value1                 Expression value to compare on left-hand.\r
  @param  Value2                 Expression value to compare on right-hand.\r
  @param  Result                 Return value after compare.\r
                                 retval 0                      Two operators equal.\r
                                 return Positive value if Value1 is greater than Value2.\r
                                 retval Negative value if Value1 is less than Value2.\r
  @param  HiiHandle              Only required for string compare.\r
\r
  @retval other                  Could not perform compare on two values.\r
  @retval EFI_SUCCESS            Compare the value success.\r
\r
**/\r
EFI_STATUS\r
CompareHiiValue (\r
  IN  EFI_HII_VALUE   *Value1,\r
  IN  EFI_HII_VALUE   *Value2,\r
  OUT INTN            *Result,\r
  IN  EFI_HII_HANDLE  HiiHandle OPTIONAL\r
  );\r
\r
/**\r
  Draw a pop up windows based on the dimension, number of lines and\r
  strings specified.\r
\r
  @param RequestedWidth  The width of the pop-up.\r
  @param NumberOfLines   The number of lines.\r
  @param ...             A series of text strings that displayed in the pop-up.\r
\r
**/\r
VOID\r
EFIAPI\r
CreateMultiStringPopUp (\r
  IN  UINTN                       RequestedWidth,\r
  IN  UINTN                       NumberOfLines,\r
  ...\r
  );\r
\r
/**\r
  Will copy LineWidth amount of a string in the OutputString buffer and return the\r
  number of CHAR16 characters that were copied into the OutputString buffer.\r
  The output string format is:\r
    Glyph Info + String info + '\0'.\r
\r
  In the code, it deals \r,\n,\r\n same as \n\r, also it not process the \r or \g.\r
\r
  @param  InputString            String description for this option.\r
  @param  LineWidth              Width of the desired string to extract in CHAR16\r
                                 characters\r
  @param  GlyphWidth             The glyph width of the begin of the char in the string.\r
  @param  Index                  Where in InputString to start the copy process\r
  @param  OutputString           Buffer to copy the string into\r
\r
  @return Returns the number of CHAR16 characters that were copied into the OutputString \r
  buffer, include extra glyph info and '\0' info.\r
\r
**/\r
UINT16\r
GetLineByWidth (\r
  IN      CHAR16                      *InputString,\r
  IN      UINT16                      LineWidth,\r
  IN OUT  UINT16                      *GlyphWidth,\r
  IN OUT  UINTN                       *Index,\r
  OUT     CHAR16                      **OutputString\r
  );\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 Hii handle for this string package.\r
\r
  @return The output string.\r
\r
**/\r
CHAR16 *\r
GetToken (\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
GetStringWidth (\r
  IN CHAR16               *String\r
  );\r
\r
/**\r
  This routine reads a numeric value from the user input.\r
\r
  @param  MenuOption        Pointer to the current input menu.\r
\r
  @retval EFI_SUCCESS       If numerical input is read successfully\r
  @retval EFI_DEVICE_ERROR  If operation fails\r
\r
**/\r
EFI_STATUS\r
GetNumericInput (\r
  IN  UI_MENU_OPTION              *MenuOption\r
  );\r
\r
/**\r
  Get string or password input from user.\r
\r
  @param  MenuOption        Pointer to the current input menu.\r
  @param  Prompt            The prompt string shown on popup window.\r
  @param  StringPtr         Old user input and destination for use input string.\r
\r
  @retval EFI_SUCCESS       If string input is read successfully\r
  @retval EFI_DEVICE_ERROR  If operation fails\r
\r
**/\r
EFI_STATUS\r
ReadString (\r
  IN     UI_MENU_OPTION              *MenuOption,\r
  IN     CHAR16                      *Prompt,\r
  IN OUT CHAR16                      *StringPtr\r
  );\r
\r
/**\r
  Draw a pop up windows based on the dimension, number of lines and\r
  strings specified.\r
\r
  @param RequestedWidth  The width of the pop-up.\r
  @param NumberOfLines   The number of lines.\r
  @param Marker          The variable argument list for the list of string to be printed.\r
\r
**/\r
VOID\r
CreateSharedPopUp (\r
  IN  UINTN                       RequestedWidth,\r
  IN  UINTN                       NumberOfLines,\r
  IN  VA_LIST                     Marker\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
  Get selection for OneOf and OrderedList (Left/Right will be ignored).\r
\r
  @param  MenuOption        Pointer to the current input menu.\r
\r
  @retval EFI_SUCCESS       If Option input is processed successfully\r
  @retval EFI_DEVICE_ERROR  If operation fails\r
\r
**/\r
EFI_STATUS\r
GetSelectionInputPopUp (\r
  IN  UI_MENU_OPTION              *MenuOption\r
  );\r
\r
/**\r
  Process the help string: Split StringPtr to several lines of strings stored in\r
  FormattedString and the glyph width of each line cannot exceed gHelpBlockWidth.\r
\r
  @param  StringPtr              The entire help string.\r
  @param  FormattedString        The oupput formatted string.\r
  @param  EachLineWidth          The max string length of each line in the formatted string.\r
  @param  RowCount               TRUE: if Question is selected.\r
\r
**/\r
UINTN\r
ProcessHelpString (\r
  IN  CHAR16  *StringPtr,\r
  OUT CHAR16  **FormattedString,\r
  OUT UINT16  *EachLineWidth,\r
  IN  UINTN   RowCount\r
  );\r
\r
/**\r
  Process a Question's Option (whether selected or un-selected).\r
\r
  @param  MenuOption             The MenuOption for this Question.\r
  @param  Selected               TRUE: if Question is selected.\r
  @param  OptionString           Pointer of the Option String to be displayed.\r
  @param  SkipErrorValue         Whether need to return when value without option for it.\r
\r
  @retval EFI_SUCCESS            Question Option process success.\r
  @retval Other                  Question Option process fail.\r
\r
**/\r
EFI_STATUS\r
ProcessOptions (\r
  IN  UI_MENU_OPTION              *MenuOption,\r
  IN  BOOLEAN                     Selected,\r
  OUT CHAR16                      **OptionString,\r
  IN  BOOLEAN                     SkipErrorValue\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
SetUnicodeMem (\r
  IN VOID   *Buffer,\r
  IN UINTN  Size,\r
  IN CHAR16 Value\r
  );\r
\r
/**\r
  Display one form, and return user input.\r
  \r
  @param FormData                Form Data to be shown.\r
  @param UserInputData           User input data.\r
  \r
  @retval EFI_SUCCESS            Form Data is shown, and user input is got.\r
**/\r
EFI_STATUS\r
EFIAPI \r
FormDisplay (\r
  IN  FORM_DISPLAY_ENGINE_FORM  *FormData,\r
  OUT USER_INPUT                *UserInputData\r
  );\r
\r
/**\r
  Clear Screen to the initial state.\r
**/\r
VOID\r
EFIAPI \r
DriverClearDisplayPage (\r
  VOID\r
  );\r
\r
/**\r
  Exit Display and Clear Screen to the original state.\r
\r
**/\r
VOID\r
EFIAPI \r
ExitDisplay (\r
  VOID\r
  );\r
\r
/**\r
  Process nothing.\r
\r
  @param Event    The Event need to be process\r
  @param Context  The context of the event.\r
\r
**/\r
VOID\r
EFIAPI\r
EmptyEventProcess (\r
  IN  EFI_EVENT    Event,\r
  IN  VOID         *Context\r
  );\r
\r
/**\r
  Process for the refresh interval statement.\r
\r
  @param Event    The Event need to be process\r
  @param Context  The context of the event.\r
\r
**/\r
VOID\r
EFIAPI\r
RefreshTimeOutProcess (\r
  IN  EFI_EVENT    Event,\r
  IN  VOID         *Context\r
  );\r
\r
#endif\r
Commit	Line	Data
7c6c064c ED	1	/** @file\r
	2	FormDiplay protocol to show Form\r
	3	\r
336c8e11	4	Copyright (c) 2013 - 2014, Intel Corporation. All rights reserved.<BR>\r
7c6c064c ED	5	This program and the accompanying materials are licensed and made available under \r
	6	the terms and conditions of the BSD License that accompanies this distribution. \r
	7	The full text of the license may be found at\r
	8	http://opensource.org/licenses/bsd-license.php. \r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	12	\r
	13	**/\r
	14	\r
	15	#ifndef __FORM_DISPLAY_H__\r
	16	#define __FORM_DISPLAY_H__\r
	17	\r
	18	\r
	19	#include <Library/UefiBootServicesTableLib.h>\r
	20	#include <Library/DebugLib.h>\r
	21	#include <Library/BaseMemoryLib.h>\r
	22	#include <Library/BaseLib.h>\r
	23	#include <Library/HiiLib.h>\r
	24	#include <Library/MemoryAllocationLib.h>\r
	25	#include <Library/PrintLib.h>\r
	26	#include <Library/CustomizedDisplayLib.h>\r
	27	\r
	28	#include <Protocol/FormBrowserEx2.h>\r
	29	#include <Protocol/SimpleTextIn.h>\r
	30	#include <Protocol/DisplayProtocol.h>\r
	31	\r
	32	#include <Guid/MdeModuleHii.h>\r
	33	\r
	34	//\r
	35	// This is the generated header file which includes whatever needs to be exported (strings + IFR)\r
	36	//\r
	37	extern UINT8 DisplayEngineStrings[];\r
	38	extern EFI_SCREEN_DESCRIPTOR gStatementDimensions;\r
	39	extern USER_INPUT *gUserInput;\r
	40	extern FORM_DISPLAY_ENGINE_FORM *gFormData;\r
	41	extern EFI_HII_HANDLE gHiiHandle;\r
	42	extern UINT16 gDirection;\r
	43	extern LIST_ENTRY gMenuOption;\r
	44	\r
	45	//\r
	46	// Browser Global Strings\r
	47	//\r
	48	extern CHAR16 *gSaveFailed;\r
	49	extern CHAR16 *gPromptForData;\r
	50	extern CHAR16 *gPromptForPassword;\r
	51	extern CHAR16 *gPromptForNewPassword;\r
	52	extern CHAR16 *gConfirmPassword;\r
	53	extern CHAR16 *gConfirmError;\r
	54	extern CHAR16 *gPassowordInvalid;\r
	55	extern CHAR16 *gPressEnter;\r
	56	extern CHAR16 *gEmptyString;\r
	57	extern CHAR16 *gMiniString;\r
	58	extern CHAR16 *gOptionMismatch;\r
	59	extern CHAR16 *gFormSuppress;\r
	60	extern CHAR16 *gProtocolNotFound;\r
	61	\r
	62	extern CHAR16 gPromptBlockWidth;\r
	63	extern CHAR16 gOptionBlockWidth;\r
	64	extern CHAR16 gHelpBlockWidth;\r
	65	extern CHAR16 *mUnknownString;\r
42645c3d	66	extern BOOLEAN gMisMatch;\r
7c6c064c ED	67	\r
	68	//\r
	69	// Screen definitions\r
	70	//\r
	71	\r
	72	#define LEFT_SKIPPED_COLUMNS 3\r
	73	#define SCROLL_ARROW_HEIGHT 1\r
	74	#define POPUP_PAD_SPACE_COUNT 5\r
	75	#define POPUP_FRAME_WIDTH 2\r
	76	\r
4d4deaac ED	77	#define UPPER_LOWER_CASE_OFFSET 0x20\r
4d4deaac ED	78	\r
7c6c064c ED	79	//\r
	80	// Display definitions\r
	81	//\r
	82	#define LEFT_ONEOF_DELIMITER L'<'\r
	83	#define RIGHT_ONEOF_DELIMITER L'>'\r
	84	\r
	85	#define LEFT_NUMERIC_DELIMITER L'['\r
	86	#define RIGHT_NUMERIC_DELIMITER L']'\r
	87	\r
	88	#define LEFT_CHECKBOX_DELIMITER L'['\r
	89	#define RIGHT_CHECKBOX_DELIMITER L']'\r
	90	\r
	91	#define CHECK_ON L'X'\r
	92	#define CHECK_OFF L' '\r
	93	\r
	94	#define TIME_SEPARATOR L':'\r
	95	#define DATE_SEPARATOR L'/'\r
	96	\r
	97	#define SUBTITLE_INDENT 2\r
	98	\r
	99	//\r
	100	// This is the Input Error Message\r
	101	//\r
	102	#define INPUT_ERROR 1\r
	103	\r
	104	//\r
	105	// This is the NV RAM update required Message\r
	106	//\r
	107	#define NV_UPDATE_REQUIRED 2\r
	108	//\r
	109	// Time definitions\r
	110	//\r
	111	#define ONE_SECOND 10000000\r
	112	\r
	113	//\r
	114	// It take 23 characters including the NULL to print a 64 bits number with "[" and "]".\r
	115	// pow(2, 64) = [18446744073709551616]\r
	116	//\r
	117	#define MAX_NUMERIC_INPUT_WIDTH 23\r
	118	\r
	119	#define EFI_HII_EXPRESSION_INCONSISTENT_IF 0\r
	120	#define EFI_HII_EXPRESSION_NO_SUBMIT_IF 1\r
	121	#define EFI_HII_EXPRESSION_GRAY_OUT_IF 2\r
	122	#define EFI_HII_EXPRESSION_SUPPRESS_IF 3\r
	123	#define EFI_HII_EXPRESSION_DISABLE_IF 4\r
	124	\r
	125	//\r
	126	// Character definitions\r
	127	//\r
	128	#define CHAR_SPACE 0x0020\r
	129	\r
	130	#define FORM_DISPLAY_DRIVER_SIGNATURE SIGNATURE_32 ('F', 'D', 'D', 'V')\r
	131	typedef struct {\r
	132	UINT32 Signature;\r
	133	\r
	134	EFI_HANDLE Handle;\r
	135	\r
	136	//\r
	137	// Produced protocol\r
	138	//\r
	139	EDKII_FORM_DISPLAY_ENGINE_PROTOCOL FromDisplayProt;\r
	140	} FORM_DISPLAY_DRIVER_PRIVATE_DATA;\r
	141	\r
	142	\r
143	typedef enum {\r
144	UiNoOperation,\r
145	UiSelect,\r
146	UiUp,\r
147	UiDown,\r
148	UiLeft,\r
149	UiRight,\r
150	UiReset,\r
151	UiPrevious,\r
152	UiPageUp,\r
153	UiPageDown,\r
154	UiHotKey,\r
155	UiMaxOperation\r
156	} UI_SCREEN_OPERATION;\r
157	\r
158	typedef enum {\r
159	CfInitialization,\r
160	CfCheckSelection,\r
161	CfRepaint,\r
162	CfRefreshHighLight,\r
163	CfUpdateHelpString,\r
164	CfPrepareToReadKey,\r
165	CfReadKey,\r
166	CfScreenOperation,\r
167	CfUiSelect,\r
168	CfUiReset,\r
169	CfUiLeft,\r
170	CfUiRight,\r
171	CfUiUp,\r
172	CfUiPageUp,\r
173	CfUiPageDown,\r
174	CfUiDown,\r
7c6c064c ED	175	CfUiNoOperation,\r
	176	CfExit,\r
	177	CfUiHotKey,\r
	178	CfMaxControlFlag\r
	179	} UI_CONTROL_FLAG;\r
	180	\r
	181	typedef enum {\r
	182	UIEventNone,\r
	183	UIEventKey,\r
	184	UIEventTimeOut,\r
	185	UIEventDriver\r
	186	} UI_EVENT_TYPE;\r
	187	\r
	188	typedef struct {\r
	189	UINT16 ScanCode;\r
	190	UI_SCREEN_OPERATION ScreenOperation;\r
	191	} SCAN_CODE_TO_SCREEN_OPERATION;\r
	192	\r
	193	typedef struct {\r
	194	UI_SCREEN_OPERATION ScreenOperation;\r
	195	UI_CONTROL_FLAG ControlFlag;\r
	196	} SCREEN_OPERATION_T0_CONTROL_FLAG;\r
	197	\r
	198	typedef struct {\r
336c8e11	199	EFI_HII_HANDLE HiiHandle;\r
42645c3d ED	200	UINT16 FormId;\r
	201	\r
	202	//\r
	203	// Info for the highlight question.\r
	204	// HLT means highlight\r
	205	//\r
	206	// If one statement has questionid, save questionid info to find the question.\r
	207	// If one statement not has questionid info, save the opcode info to find the \r
	208	// statement. If more than one statement has same opcode in one form(just like\r
	209	// empty subtitle info may has more than one info one form), also use Index \r
	210	// info to find the statement.\r
	211	//\r
	212	EFI_QUESTION_ID HLTQuestionId;\r
	213	EFI_IFR_OP_HEADER *HLTOpCode;\r
	214	UINTN HLTIndex;\r
	215	UINTN HLTSequence;\r
	216	\r
	217	//\r
	218	// Info for the top of screen question.\r
	219	// TOS means Top Of Screen\r
	220	//\r
	221	EFI_QUESTION_ID TOSQuestionId;\r
	222	EFI_IFR_OP_HEADER *TOSOpCode;\r
	223	UINTN TOSIndex;\r
	224	\r
336c8e11	225	UINT16 SkipValue;\r
7c6c064c ED	226	} DISPLAY_HIGHLIGHT_MENU_INFO;\r
7c6c064c ED	227	\r
bfae1330 ED	228	typedef struct {\r
	229	EFI_EVENT SyncEvent;\r
	230	UINT8 *TimeOut;\r
	231	CHAR16 *ErrorInfo;\r
	232	} WARNING_IF_CONTEXT;\r
	233	\r
7c6c064c ED	234	#define UI_MENU_OPTION_SIGNATURE SIGNATURE_32 ('u', 'i', 'm', 'm')\r
	235	\r
	236	typedef struct {\r
	237	UINTN Signature;\r
	238	LIST_ENTRY Link;\r
	239	\r
	240	EFI_HII_HANDLE Handle;\r
	241	FORM_DISPLAY_ENGINE_STATEMENT *ThisTag;\r
	242	UINT16 EntryNumber;\r
	243	\r
	244	UINTN Row;\r
	245	UINTN Col;\r
	246	UINTN OptCol;\r
	247	CHAR16 *Description;\r
	248	UINTN Skip; // Number of lines\r
	249	\r
	250	//\r
	251	// Display item sequence for date/time\r
	252	// Date: Month/Day/Year\r
	253	// Sequence: 0 1 2\r
	254	//\r
	255	// Time: Hour : Minute : Second\r
	256	// Sequence: 0 1 2\r
	257	//\r
	258	//\r
	259	UINTN Sequence;\r
	260	\r
	261	BOOLEAN GrayOut;\r
	262	BOOLEAN ReadOnly;\r
	263	\r
	264	//\r
	265	// Whether user could change value of this item\r
	266	//\r
	267	BOOLEAN IsQuestion;\r
	268	BOOLEAN NestInStatement;\r
	269	} UI_MENU_OPTION;\r
	270	\r
	271	#define MENU_OPTION_FROM_LINK(a) CR (a, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE)\r
	272	\r
	273	/**\r
	274	Print Question Value according to it's storage width and display attributes.\r
	275	\r
	276	@param Question The Question to be printed.\r
	277	@param FormattedNumber Buffer for output string.\r
	278	@param BufferSize The FormattedNumber buffer size in bytes.\r
	279	\r
	280	@retval EFI_SUCCESS Print success.\r
	281	@retval EFI_BUFFER_TOO_SMALL Buffer size is not enough for formatted number.\r
	282	\r
	283	**/\r
	284	EFI_STATUS\r
	285	PrintFormattedNumber (\r
	286	IN FORM_DISPLAY_ENGINE_STATEMENT *Question,\r
	287	IN OUT CHAR16 *FormattedNumber,\r
	288	IN UINTN BufferSize\r
	289	);\r
	290	\r
	291	/**\r
	292	Set value of a data element in an Array by its Index.\r
	293	\r
	294	@param Array The data array.\r
	295	@param Type Type of the data in this array.\r
	296	@param Index Zero based index for data in this array.\r
	297	@param Value The value to be set.\r
298	\r
299	**/\r
300	VOID\r
301	SetArrayData (\r
302	IN VOID *Array,\r
303	IN UINT8 Type,\r
304	IN UINTN Index,\r
305	IN UINT64 Value\r
306	);\r
307	\r
308	/**\r
309	Return data element in an Array by its Index.\r
310	\r
311	@param Array The data array.\r
312	@param Type Type of the data in this array.\r
313	@param Index Zero based index for data in this array.\r
314	\r
315	@retval Value The data to be returned\r
316	\r
317	**/\r
318	UINT64\r
319	GetArrayData (\r
320	IN VOID *Array,\r
321	IN UINT8 Type,\r
322	IN UINTN Index\r
323	);\r
324	\r
325	/**\r
326	Search an Option of a Question by its value.\r
327	\r
328	@param Question The Question\r
329	@param OptionValue Value for Option to be searched.\r
330	\r
331	@retval Pointer Pointer to the found Option.\r
332	@retval NULL Option not found.\r
333	\r
334	**/\r
335	DISPLAY_QUESTION_OPTION *\r
336	ValueToOption (\r
337	IN FORM_DISPLAY_ENGINE_STATEMENT *Question,\r
338	IN EFI_HII_VALUE *OptionValue\r
339	);\r
340	\r
341	/**\r
342	Compare two Hii value.\r
343	\r
344	@param Value1 Expression value to compare on left-hand.\r
345	@param Value2 Expression value to compare on right-hand.\r
346	@param Result Return value after compare.\r
347	retval 0 Two operators equal.\r
348	return Positive value if Value1 is greater than Value2.\r
349	retval Negative value if Value1 is less than Value2.\r
350	@param HiiHandle Only required for string compare.\r
351	\r
352	@retval other Could not perform compare on two values.\r
353	@retval EFI_SUCCESS Compare the value success.\r
354	\r
355	**/\r
356	EFI_STATUS\r
357	CompareHiiValue (\r
358	IN EFI_HII_VALUE *Value1,\r
359	IN EFI_HII_VALUE *Value2,\r
360	OUT INTN *Result,\r
361	IN EFI_HII_HANDLE HiiHandle OPTIONAL\r
362	);\r
363	\r
364	/**\r
365	Draw a pop up windows based on the dimension, number of lines and\r
366	strings specified.\r
367	\r
368	@param RequestedWidth The width of the pop-up.\r
369	@param NumberOfLines The number of lines.\r
370	@param ... A series of text strings that displayed in the pop-up.\r
371	\r
372	**/\r
373	VOID\r
374	EFIAPI\r
375	CreateMultiStringPopUp (\r
376	IN UINTN RequestedWidth,\r
377	IN UINTN NumberOfLines,\r
378	...\r
379	);\r
380	\r
381	/**\r
382	Will copy LineWidth amount of a string in the OutputString buffer and return the\r
383	number of CHAR16 characters that were copied into the OutputString buffer.\r
384	The output string format is:\r
385	Glyph Info + String info + '\0'.\r
386	\r
387	In the code, it deals \r,\n,\r\n same as \n\r, also it not process the \r or \g.\r
388	\r
389	@param InputString String description for this option.\r
390	@param LineWidth Width of the desired string to extract in CHAR16\r
391	characters\r
392	@param GlyphWidth The glyph width of the begin of the char in the string.\r
393	@param Index Where in InputString to start the copy process\r
394	@param OutputString Buffer to copy the string into\r
395	\r
396	@return Returns the number of CHAR16 characters that were copied into the OutputString \r
397	buffer, include extra glyph info and '\0' info.\r
398	\r
399	**/\r
400	UINT16\r
401	GetLineByWidth (\r
402	IN CHAR16 *InputString,\r
403	IN UINT16 LineWidth,\r
404	IN OUT UINT16 *GlyphWidth,\r
405	IN OUT UINTN *Index,\r
406	OUT CHAR16 **OutputString\r
407	);\r
408	\r
409	\r
410	/**\r
411	Get the string based on the StringId and HII Package List Handle.\r
412	\r
413	@param Token The String's ID.\r
414	@param HiiHandle The Hii handle for this string package.\r
415	\r
416	@return The output string.\r
417	\r
418	**/\r
419	CHAR16 *\r
420	GetToken (\r
421	IN EFI_STRING_ID Token,\r
422	IN EFI_HII_HANDLE HiiHandle\r
423	);\r
424	\r
425	/**\r
426	Count the storage space of a Unicode string.\r
427	\r
428	This function handles the Unicode string with NARROW_CHAR\r
429	and WIDE_CHAR control characters. NARROW_HCAR and WIDE_CHAR\r
430	does not count in the resultant output. If a WIDE_CHAR is\r
431	hit, then 2 Unicode character will consume an output storage\r
432	space with size of CHAR16 till a NARROW_CHAR is hit.\r
433	\r
434	If String is NULL, then ASSERT ().\r
435	\r
436	@param String The input string to be counted.\r
437	\r
438	@return Storage space for the input string.\r
439	\r
440	**/\r
441	UINTN\r
442	GetStringWidth (\r
443	IN CHAR16 *String\r
444	);\r
445	\r
446	/**\r
447	This routine reads a numeric value from the user input.\r
448	\r
449	@param MenuOption Pointer to the current input menu.\r
450	\r
451	@retval EFI_SUCCESS If numerical input is read successfully\r
452	@retval EFI_DEVICE_ERROR If operation fails\r
453	\r
454	**/\r
455	EFI_STATUS\r
456	GetNumericInput (\r
457	IN UI_MENU_OPTION *MenuOption\r
458	);\r
459	\r
460	/**\r
461	Get string or password input from user.\r
462	\r
463	@param MenuOption Pointer to the current input menu.\r
464	@param Prompt The prompt string shown on popup window.\r
465	@param StringPtr Old user input and destination for use input string.\r
466	\r
467	@retval EFI_SUCCESS If string input is read successfully\r
468	@retval EFI_DEVICE_ERROR If operation fails\r
469	\r
470	**/\r
471	EFI_STATUS\r
472	ReadString (\r
473	IN UI_MENU_OPTION *MenuOption,\r
474	IN CHAR16 *Prompt,\r
475	IN OUT CHAR16 *StringPtr\r
476	);\r
477	\r
478	/**\r
479	Draw a pop up windows based on the dimension, number of lines and\r
480	strings specified.\r
481	\r
482	@param RequestedWidth The width of the pop-up.\r
483	@param NumberOfLines The number of lines.\r
484	@param Marker The variable argument list for the list of string to be printed.\r
485	\r
486	**/\r
487	VOID\r
488	CreateSharedPopUp (\r
489	IN UINTN RequestedWidth,\r
490	IN UINTN NumberOfLines,\r
491	IN VA_LIST Marker\r
492	);\r
493	\r
494	/**\r
495	Wait for a key to be pressed by user.\r
496	\r
497	@param Key The key which is pressed by user.\r
498	\r
499	@retval EFI_SUCCESS The function always completed successfully.\r
500	\r
501	**/\r
502	EFI_STATUS\r
503	WaitForKeyStroke (\r
504	OUT EFI_INPUT_KEY *Key\r
505	);\r
506	\r
507	/**\r
508	Get selection for OneOf and OrderedList (Left/Right will be ignored).\r
509	\r
510	@param MenuOption Pointer to the current input menu.\r
511	\r
512	@retval EFI_SUCCESS If Option input is processed successfully\r
513	@retval EFI_DEVICE_ERROR If operation fails\r
514	\r
515	**/\r
516	EFI_STATUS\r
517	GetSelectionInputPopUp (\r
518	IN UI_MENU_OPTION *MenuOption\r
519	);\r
520	\r
521	/**\r
522	Process the help string: Split StringPtr to several lines of strings stored in\r
523	FormattedString and the glyph width of each line cannot exceed gHelpBlockWidth.\r
524	\r
525	@param StringPtr The entire help string.\r
526	@param FormattedString The oupput formatted string.\r
527	@param EachLineWidth The max string length of each line in the formatted string.\r
528	@param RowCount TRUE: if Question is selected.\r
529	\r
530	**/\r
531	UINTN\r
532	ProcessHelpString (\r
533	IN CHAR16 *StringPtr,\r
534	OUT CHAR16 **FormattedString,\r
535	OUT UINT16 *EachLineWidth,\r
536	IN UINTN RowCount\r
537	);\r
538	\r
539	/**\r
540	Process a Question's Option (whether selected or un-selected).\r
541	\r
542	@param MenuOption The MenuOption for this Question.\r
543	@param Selected TRUE: if Question is selected.\r
544	@param OptionString Pointer of the Option String to be displayed.\r
545	@param SkipErrorValue Whether need to return when value without option for it.\r
546	\r
547	@retval EFI_SUCCESS Question Option process success.\r
548	@retval Other Question Option process fail.\r
549	\r
550	**/\r
551	EFI_STATUS\r
552	ProcessOptions (\r
553	IN UI_MENU_OPTION *MenuOption,\r
554	IN BOOLEAN Selected,\r
555	OUT CHAR16 **OptionString,\r
556	IN BOOLEAN SkipErrorValue\r
557	);\r
558	\r
559	/**\r
560	Set Buffer to Value for Size bytes.\r
561	\r
562	@param Buffer Memory to set.\r
563	@param Size Number of bytes to set\r
564	@param Value Value of the set operation.\r
565	\r
566	**/\r
567	VOID\r
568	SetUnicodeMem (\r
569	IN VOID *Buffer,\r
570	IN UINTN Size,\r
571	IN CHAR16 Value\r
572	);\r
573	\r
574	/**\r
575	Display one form, and return user input.\r
576	\r
577	@param FormData Form Data to be shown.\r
578	@param UserInputData User input data.\r
579	\r
580	@retval EFI_SUCCESS Form Data is shown, and user input is got.\r
581	**/\r
582	EFI_STATUS\r
583	EFIAPI \r
584	FormDisplay (\r
585	IN FORM_DISPLAY_ENGINE_FORM *FormData,\r
586	OUT USER_INPUT *UserInputData\r
587	);\r
588	\r
5a9f73bf ED	589	/**\r
	590	Clear Screen to the initial state.\r
	591	**/\r
	592	VOID\r
	593	EFIAPI \r
	594	DriverClearDisplayPage (\r
	595	VOID\r
	596	);\r
	597	\r
7c6c064c ED	598	/**\r
	599	Exit Display and Clear Screen to the original state.\r
	600	\r
	601	**/\r
	602	VOID\r
	603	EFIAPI \r
	604	ExitDisplay (\r
	605	VOID\r
	606	);\r
	607	\r
	608	/**\r
bfae1330	609	Process nothing.\r
7c6c064c	610	\r
bfae1330 ED	611	@param Event The Event need to be process\r
bfae1330 ED	612	@param Context The context of the event.\r
7c6c064c	613	\r
bfae1330 ED	614	**/\r
	615	VOID\r
	616	EFIAPI\r
	617	EmptyEventProcess (\r
	618	IN EFI_EVENT Event,\r
	619	IN VOID *Context\r
	620	);\r
	621	\r
	622	/**\r
	623	Process for the refresh interval statement.\r
	624	\r
	625	@param Event The Event need to be process\r
	626	@param Context The context of the event.\r
7c6c064c ED	627	\r
7c6c064c ED	628	**/\r
bfae1330 ED	629	VOID\r
	630	EFIAPI\r
	631	RefreshTimeOutProcess (\r
	632	IN EFI_EVENT Event,\r
	633	IN VOID *Context\r
7c6c064c ED	634	);\r
	635	\r
	636	#endif\r