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

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