CustomizedDisplayLibInternal.h File Reference

#include <PiDxe.h>
#include <Protocol/SimpleTextOut.h>
#include <Protocol/SimpleTextIn.h>
#include <Protocol/FormBrowser2.h>
#include <Protocol/FormBrowserEx2.h>
#include <Protocol/DisplayProtocol.h>
#include <Protocol/DevicePath.h>
#include <Protocol/UnicodeCollation.h>
#include <Protocol/HiiConfigAccess.h>
#include <Protocol/HiiConfigRouting.h>
#include <Protocol/HiiDatabase.h>
#include <Protocol/HiiString.h>
#include <Protocol/UserManager.h>
#include <Protocol/DevicePathFromText.h>
#include <Guid/MdeModuleHii.h>
#include <Guid/HiiPlatformSetupFormset.h>
#include <Guid/HiiFormMapMethodGuid.h>
#include <Library/PrintLib.h>
#include <Library/DebugLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/BaseLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/HiiLib.h>
#include <Library/PcdLib.h>
#include <Library/DevicePathLib.h>
#include <Library/CustomizedDisplayLib.h>
#include "Colors.h"

Go to the source code of this file.

Data Structures
struct	BANNER_DATA

Macros
#define	FORMSET_CLASS_PLATFORM_SETUP   0x0001
#define	FORMSET_CLASS_FRONT_PAGE   0x0002
#define	FRONT_PAGE_HEADER_HEIGHT   6
#define	NONE_FRONT_PAGE_HEADER_HEIGHT   3
#define	FOOTER_HEIGHT   4
#define	STATUS_BAR_HEIGHT   1
#define	BANNER_HEIGHT   6
#define	BANNER_COLUMNS   3
#define	BANNER_LEFT_COLUMN_INDENT   1
#define	UPPER_LOWER_CASE_OFFSET   0x20
#define	INPUT_ERROR   1
#define	NV_UPDATE_REQUIRED   2

Functions
VOID	PrintBannerInfo (IN FORM_DISPLAY_ENGINE_FORM *FormData)
VOID	PrintFramework (IN FORM_DISPLAY_ENGINE_FORM *FormData)
EFI_STATUS	ScreenDiemensionInfoValidate (IN FORM_DISPLAY_ENGINE_FORM *FormData)
CHAR16 *	LibGetToken (IN EFI_STRING_ID Token, IN EFI_HII_HANDLE HiiHandle)
UINTN	LibGetStringWidth (IN CHAR16 *String)
VOID	PrintHotKeyHelpString (IN FORM_DISPLAY_ENGINE_FORM *FormData, IN BOOLEAN SetState)
UINT64	LibGetFieldFromNum (IN EFI_IFR_OP_HEADER *OpCode)
VOID	InitializeLibStrings (VOID)
VOID	FreeLibStrings (VOID)
EFI_STATUS	WaitForKeyStroke (OUT EFI_INPUT_KEY *Key)
VOID	LibSetUnicodeMem (IN VOID *Buffer, IN UINTN Size, IN CHAR16 Value)
UINTN EFIAPI	PrintAt (IN UINTN Width, IN UINTN Column, IN UINTN Row, IN CHAR16 *Fmt,...)
VOID	ProcessExternedOpcode (IN FORM_DISPLAY_ENGINE_FORM *FormData)

Variables
UINT16	gClassOfVfr
BANNER_DATA *	gBannerData
EFI_SCREEN_DESCRIPTOR	gScreenDimensions
UINTN	gFooterHeight
CHAR16 *	gEnterString
CHAR16 *	gEnterCommitString
CHAR16 *	gEnterEscapeString
CHAR16 *	gEscapeString
CHAR16 *	gMoveHighlight
CHAR16 *	gDecNumericInput
CHAR16 *	gHexNumericInput
CHAR16 *	gToggleCheckBox
CHAR16 *	gLibEmptyString
CHAR16 *	gAreYouSure
CHAR16 *	gYesResponse
CHAR16 *	gNoResponse
CHAR16 *	gPlusString
CHAR16 *	gMinusString
CHAR16 *	gAdjustNumber
CHAR16 *	gSaveChanges
CHAR16 *	gNvUpdateMessage
CHAR16 *	gInputErrorMessage

Detailed Description

This library class defines a set of interfaces to customize Display module

Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file CustomizedDisplayLibInternal.h.

Macro Definition Documentation

BANNER_COLUMNS

#define BANNER_COLUMNS   3

Definition at line 60 of file CustomizedDisplayLibInternal.h.

BANNER_HEIGHT

#define BANNER_HEIGHT   6

Definition at line 59 of file CustomizedDisplayLibInternal.h.

BANNER_LEFT_COLUMN_INDENT

#define BANNER_LEFT_COLUMN_INDENT   1

Definition at line 61 of file CustomizedDisplayLibInternal.h.

FOOTER_HEIGHT

#define FOOTER_HEIGHT   4

Definition at line 53 of file CustomizedDisplayLibInternal.h.

FORMSET_CLASS_FRONT_PAGE

#define FORMSET_CLASS_FRONT_PAGE   0x0002

Definition at line 49 of file CustomizedDisplayLibInternal.h.

FORMSET_CLASS_PLATFORM_SETUP

#define FORMSET_CLASS_PLATFORM_SETUP   0x0001

Definition at line 48 of file CustomizedDisplayLibInternal.h.

FRONT_PAGE_HEADER_HEIGHT

#define FRONT_PAGE_HEADER_HEIGHT   6

Definition at line 51 of file CustomizedDisplayLibInternal.h.

INPUT_ERROR

#define INPUT_ERROR   1

Definition at line 71 of file CustomizedDisplayLibInternal.h.

NONE_FRONT_PAGE_HEADER_HEIGHT

#define NONE_FRONT_PAGE_HEADER_HEIGHT   3

Definition at line 52 of file CustomizedDisplayLibInternal.h.

NV_UPDATE_REQUIRED

#define NV_UPDATE_REQUIRED   2

Definition at line 76 of file CustomizedDisplayLibInternal.h.

STATUS_BAR_HEIGHT

#define STATUS_BAR_HEIGHT   1

Definition at line 54 of file CustomizedDisplayLibInternal.h.

UPPER_LOWER_CASE_OFFSET

#define UPPER_LOWER_CASE_OFFSET   0x20

Definition at line 66 of file CustomizedDisplayLibInternal.h.

Function Documentation

FreeLibStrings()

VOID FreeLibStrings

(

VOID

)

Free the HII String.

Definition at line 753 of file CustomizedDisplayLibInternal.c.

InitializeLibStrings()

VOID InitializeLibStrings

(

VOID

)

Initialize the HII String Token to the correct values.

Definition at line 711 of file CustomizedDisplayLibInternal.c.

LibGetFieldFromNum()

UINT64 LibGetFieldFromNum

(

IN EFI_IFR_OP_HEADER *

OpCode

)

Get step info from numeric opcode.

Parameters

[in]

OpCode

The input numeric op code.

Returns

step info for this opcode.

Definition at line 672 of file CustomizedDisplayLibInternal.c.

LibGetStringWidth()

UINTN LibGetStringWidth

(

IN CHAR16 *

String

)

Count the storage space of a Unicode string.

This function handles the Unicode string with NARROW_CHAR and WIDE_CHAR control characters. NARROW_HCAR and WIDE_CHAR does not count in the resultant output. If a WIDE_CHAR is hit, then 2 Unicode character will consume an output storage space with size of CHAR16 till a NARROW_CHAR is hit.

If String is NULL, then ASSERT ().

Parameters

String

The input string to be counted.

Returns

Storage space for the input string.

Definition at line 495 of file CustomizedDisplayLibInternal.c.

LibGetToken()

CHAR16 * LibGetToken	(	IN EFI_STRING_ID	Token,
		IN EFI_HII_HANDLE	HiiHandle
	)

Get the string based on the StringId and HII Package List Handle.

Parameters

Token	The String's ID.
HiiHandle	The package list in the HII database to search for the specified string.

Returns

The output string.

Definition at line 462 of file CustomizedDisplayLibInternal.c.

LibSetUnicodeMem()

VOID LibSetUnicodeMem	(	IN VOID *	Buffer,
		IN UINTN	Size,
		IN CHAR16	Value
	)

Set Buffer to Value for Size bytes.

Parameters

Buffer	Memory to set.
Size	Number of bytes to set
Value	Value of the set operation.

Definition at line 823 of file CustomizedDisplayLibInternal.c.

PrintAt()

UINTN EFIAPI PrintAt	(	IN UINTN	Width,
		IN UINTN	Column,
		IN UINTN	Row,
		IN CHAR16 *	Fmt,
			...
	)

Prints a formatted unicode string to the default console, at the supplied cursor position.

Parameters

Width	Width of String to be printed.
Column	The cursor position to print the string at.
Row	The cursor position to print the string at.
Fmt	Format string.
...	Variable argument list for format string.

Returns

Length of string printed to the console

Definition at line 972 of file CustomizedDisplayLibInternal.c.

PrintBannerInfo()

VOID PrintBannerInfo

(

IN FORM_DISPLAY_ENGINE_FORM *

FormData

)

Print banner info for front page.

Parameters

[in]

FormData

Form Data to be shown in Page

Definition at line 47 of file CustomizedDisplayLibInternal.c.

PrintFramework()

VOID PrintFramework

(

IN FORM_DISPLAY_ENGINE_FORM *

FormData

)

Print framework and form title for a page.

Parameters

[in]

FormData

Form Data to be shown in Page

Definition at line 133 of file CustomizedDisplayLibInternal.c.

PrintHotKeyHelpString()

VOID PrintHotKeyHelpString	(	IN FORM_DISPLAY_ENGINE_FORM *	FormData,
		IN BOOLEAN	SetState
	)

Show all registered HotKey help strings on bottom Rows.

Parameters

FormData	The curent input form data info.
SetState	Set HotKey or Clear HotKey

Definition at line 565 of file CustomizedDisplayLibInternal.c.

ProcessExternedOpcode()

VOID ProcessExternedOpcode

(

IN FORM_DISPLAY_ENGINE_FORM *

FormData

)

Process some op codes which is out side of current form.

Parameters

FormData

Pointer to the form data.

Process some op codes which is out side of current form.

Parameters

FormData

Pointer to the form data.

Returns

EFI_SUCCESS Pass the statement success.

Definition at line 346 of file CustomizedDisplayLibInternal.c.

ScreenDiemensionInfoValidate()

EFI_STATUS ScreenDiemensionInfoValidate

(

IN FORM_DISPLAY_ENGINE_FORM *

FormData

)

Validate the input screen diemenstion info.

Parameters

FormData

The input form data info.

Returns

EFI_SUCCESS The input screen info is acceptable.

EFI_INVALID_PARAMETER The input screen info is not acceptable.

Definition at line 390 of file CustomizedDisplayLibInternal.c.

WaitForKeyStroke()

EFI_STATUS WaitForKeyStroke

(

OUT EFI_INPUT_KEY *

Key

)

Wait for a key to be pressed by user.

Parameters

Key	The key which is pressed by user.

Return values

EFI_SUCCESS

The function always completed successfully.

Definition at line 791 of file CustomizedDisplayLibInternal.c.

Variable Documentation

gAdjustNumber

CHAR16* gAdjustNumber

extern

Definition at line 34 of file CustomizedDisplayLibInternal.c.

gAreYouSure

CHAR16* gAreYouSure

extern

Definition at line 29 of file CustomizedDisplayLibInternal.c.

gBannerData

BANNER_DATA* gBannerData

extern

Definition at line 18 of file CustomizedDisplayLib.c.

gClassOfVfr

UINT16 gClassOfVfr

extern

Definition at line 16 of file CustomizedDisplayLib.c.

gDecNumericInput

CHAR16* gDecNumericInput

extern

Definition at line 25 of file CustomizedDisplayLibInternal.c.

gEnterCommitString

CHAR16* gEnterCommitString

extern

Definition at line 21 of file CustomizedDisplayLibInternal.c.

gEnterEscapeString

CHAR16* gEnterEscapeString

extern

Definition at line 22 of file CustomizedDisplayLibInternal.c.

gEnterString

CHAR16* gEnterString

extern

Definition at line 20 of file CustomizedDisplayLibInternal.c.

gEscapeString

CHAR16* gEscapeString

extern

Definition at line 23 of file CustomizedDisplayLibInternal.c.

gFooterHeight

UINTN gFooterHeight

extern

Definition at line 20 of file CustomizedDisplayLib.c.

gHexNumericInput

CHAR16* gHexNumericInput

extern

Definition at line 26 of file CustomizedDisplayLibInternal.c.

gInputErrorMessage

CHAR16* gInputErrorMessage

extern

Definition at line 37 of file CustomizedDisplayLibInternal.c.

gLibEmptyString

CHAR16* gLibEmptyString

extern

Definition at line 28 of file CustomizedDisplayLibInternal.c.

gMinusString

CHAR16* gMinusString

extern

Definition at line 33 of file CustomizedDisplayLibInternal.c.

gMoveHighlight

CHAR16* gMoveHighlight

extern

Definition at line 24 of file CustomizedDisplayLibInternal.c.

gNoResponse

CHAR16* gNoResponse

extern

Definition at line 31 of file CustomizedDisplayLibInternal.c.

gNvUpdateMessage

CHAR16* gNvUpdateMessage

extern

Definition at line 36 of file CustomizedDisplayLibInternal.c.

gPlusString

CHAR16* gPlusString

extern

Definition at line 32 of file CustomizedDisplayLibInternal.c.

gSaveChanges

CHAR16* gSaveChanges

extern

Definition at line 35 of file CustomizedDisplayLibInternal.c.

gScreenDimensions

EFI_SCREEN_DESCRIPTOR gScreenDimensions

extern

Definition at line 11 of file CustomizedDisplayLibInternal.c.

gToggleCheckBox

CHAR16* gToggleCheckBox

extern

Definition at line 27 of file CustomizedDisplayLibInternal.c.

gYesResponse

CHAR16* gYesResponse

extern

Definition at line 30 of file CustomizedDisplayLibInternal.c.