#include <Uefi.h>
#include <Guid/MdeModuleHii.h>
#include <Guid/GlobalVariable.h>
#include <Protocol/HiiConfigAccess.h>
#include <Protocol/HiiString.h>
#include <Library/HiiLib.h>
#include <Library/DebugLib.h>
#include <Library/UefiLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/PcdLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/UefiHiiServicesLib.h>
#include <Library/DevicePathLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include "FrontPageCustomizedUiSupport.h"

Data Structures
struct	UI_HII_DRIVER_INSTANCE

Macros
#define	PRINTABLE_LANGUAGE_NAME_STRING_ID 0x0001

#define	UI_HII_DRIVER_LIST_SIZE 0x8

#define	FRONT_PAGE_KEY_CONTINUE 0x1000

#define	FRONT_PAGE_KEY_RESET 0x1001

#define	FRONT_PAGE_KEY_LANGUAGE 0x1002

#define	FRONT_PAGE_KEY_DRIVER 0x2000

Functions
VOID	GetNextLanguage (IN OUT CHAR8 *LangCode, OUT CHAR8 Lang)

EFI_STATUS	LanguageChangeHandler (IN EFI_IFR_TYPE_VALUE *Value)

BOOLEAN	UiSupportLibCallbackHandler (IN EFI_HII_HANDLE HiiHandle, IN EFI_BROWSER_ACTION Action, IN EFI_QUESTION_ID QuestionId, IN UINT8 Type, IN EFI_IFR_TYPE_VALUE Value, OUT EFI_BROWSER_ACTION_REQUEST ActionRequest, OUT EFI_STATUS *Status)

VOID	UiCreateLanguageMenu (IN EFI_HII_HANDLE HiiHandle, IN VOID *StartOpCodeHandle)

VOID	UiCreateContinueMenu (IN EFI_HII_HANDLE HiiHandle, IN VOID *StartOpCodeHandle)

VOID	UiCreateEmptyLine (IN EFI_HII_HANDLE HiiHandle, IN VOID *StartOpCodeHandle)

VOID	UiCreateResetMenu (IN EFI_HII_HANDLE HiiHandle, IN VOID *StartOpCodeHandle)

CHAR16 *	ExtractDevicePathFromHiiHandle (IN EFI_HII_HANDLE Handle)

BOOLEAN	RequiredDriver (IN EFI_HII_HANDLE HiiHandle, IN EFI_GUID Guid, OUT EFI_STRING_ID PromptId, OUT EFI_STRING_ID HelpId, OUT VOID FormsetGuid)

EFI_STATUS	UiListThirdPartyDrivers (IN EFI_HII_HANDLE HiiHandle, IN EFI_GUID ClassGuid, IN DRIVER_SPECIAL_HANDLER SpecialHandlerFn, IN VOID StartOpCodeHandle)

Variables
CHAR8 *	gLanguageString

EFI_STRING_ID *	gLanguageToken

UI_HII_DRIVER_INSTANCE *	gHiiDriverList

EFI_HII_HANDLE	gStringPackHandle

UINT8	gCurrentLanguageIndex

Detailed Description

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

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

Definition in file FrontPageCustomizedUiSupport.c.

Macro Definition Documentation

◆ FRONT_PAGE_KEY_CONTINUE

#define FRONT_PAGE_KEY_CONTINUE 0x1000

Definition at line 37 of file FrontPageCustomizedUiSupport.c.

◆ FRONT_PAGE_KEY_DRIVER

#define FRONT_PAGE_KEY_DRIVER 0x2000

Definition at line 40 of file FrontPageCustomizedUiSupport.c.

◆ FRONT_PAGE_KEY_LANGUAGE

#define FRONT_PAGE_KEY_LANGUAGE 0x1002

Definition at line 39 of file FrontPageCustomizedUiSupport.c.

◆ FRONT_PAGE_KEY_RESET

#define FRONT_PAGE_KEY_RESET 0x1001

Definition at line 38 of file FrontPageCustomizedUiSupport.c.

◆ PRINTABLE_LANGUAGE_NAME_STRING_ID

#define PRINTABLE_LANGUAGE_NAME_STRING_ID 0x0001

Definition at line 33 of file FrontPageCustomizedUiSupport.c.

◆ UI_HII_DRIVER_LIST_SIZE

#define UI_HII_DRIVER_LIST_SIZE 0x8

Definition at line 35 of file FrontPageCustomizedUiSupport.c.

Function Documentation

◆ ExtractDevicePathFromHiiHandle()

CHAR16 * ExtractDevicePathFromHiiHandle ( IN EFI_HII_HANDLE Handle )

Extract device path for given HII handle and class guid.

Parameters

Handle The HII handle.

Return values

NULL	Fail to get the device path string.

Returns: PathString Get the device path string.

Definition at line 469 of file FrontPageCustomizedUiSupport.c.

◆ GetNextLanguage()

VOID GetNextLanguage	(	IN OUT CHAR8 **	LangCode,
		OUT CHAR8 *	Lang
	)

Get next language from language code list (with separator ';').

If LangCode is NULL, then ASSERT. If Lang is NULL, then ASSERT.

Parameters

LangCode	On input: point to first language in the list. On output: point to next language in the list, or NULL if no more language in the list.
Lang	The first language in the list.

Definition at line 69 of file FrontPageCustomizedUiSupport.c.

◆ LanguageChangeHandler()

EFI_STATUS LanguageChangeHandler ( IN EFI_IFR_TYPE_VALUE * Value )

This function processes the language changes in configuration.

Parameters

Value A pointer to the data being sent to the original exporting driver.

Return values

TRUE	The callback successfully handled the action.
FALSE	The callback not supported in this handler.

Definition at line 108 of file FrontPageCustomizedUiSupport.c.

◆ RequiredDriver()

BOOLEAN RequiredDriver	(	IN EFI_HII_HANDLE	HiiHandle,
		IN EFI_GUID *	Guid,
		OUT EFI_STRING_ID *	PromptId,
		OUT EFI_STRING_ID *	HelpId,
		OUT VOID *	FormsetGuid
	)

Check whether this driver need to be shown in the front page.

Parameters

HiiHandle	The hii handle for the driver.
Guid	The special guid for the driver which is the target.
PromptId	Return the prompt string id.
HelpId	Return the help string id.
FormsetGuid	Return the formset guid info.

Return values

EFI_SUCCESS Search the driver success

Definition at line 503 of file FrontPageCustomizedUiSupport.c.

◆ UiCreateContinueMenu()

VOID UiCreateContinueMenu	(	IN EFI_HII_HANDLE	HiiHandle,
		IN VOID *	StartOpCodeHandle
	)

Create continue menu in the front page.

Parameters

[in]	HiiHandle	The hii handle for the Uiapp driver.
[in]	StartOpCodeHandle	The opcode handle to save the new opcode.

Definition at line 405 of file FrontPageCustomizedUiSupport.c.

◆ UiCreateEmptyLine()

VOID UiCreateEmptyLine	(	IN EFI_HII_HANDLE	HiiHandle,
		IN VOID *	StartOpCodeHandle
	)

Create empty line menu in the front page.

Parameters

HiiHandle	The hii handle for the Uiapp driver.
StartOpCodeHandle	The opcode handle to save the new opcode.

Definition at line 428 of file FrontPageCustomizedUiSupport.c.

◆ UiCreateLanguageMenu()

VOID UiCreateLanguageMenu	(	IN EFI_HII_HANDLE	HiiHandle,
		IN VOID *	StartOpCodeHandle
	)

Create Select language menu in the front page with oneof opcode.

Parameters

[in]	HiiHandle	The hii handle for the Uiapp driver.
[in]	StartOpCodeHandle	The opcode handle to save the new opcode.

Definition at line 253 of file FrontPageCustomizedUiSupport.c.

◆ UiCreateResetMenu()

VOID UiCreateResetMenu	(	IN EFI_HII_HANDLE	HiiHandle,
		IN VOID *	StartOpCodeHandle
	)

Create Reset menu in the front page.

Parameters

[in]	HiiHandle	The hii handle for the Uiapp driver.
[in]	StartOpCodeHandle	The opcode handle to save the new opcode.

Definition at line 444 of file FrontPageCustomizedUiSupport.c.

◆ UiListThirdPartyDrivers()

EFI_STATUS UiListThirdPartyDrivers	(	IN EFI_HII_HANDLE	HiiHandle,
		IN EFI_GUID *	ClassGuid,
		IN DRIVER_SPECIAL_HANDLER	SpecialHandlerFn,
		IN VOID *	StartOpCodeHandle
	)

Search the drivers in the system which need to show in the front page and insert the menu to the front page.

Parameters

HiiHandle	The hii handle for the Uiapp driver.
ClassGuid	The class guid for the driver which is the target.
SpecialHandlerFn	The pointer to the special handler function, if any.
StartOpCodeHandle	The opcode handle to save the new opcode.

Return values

EFI_SUCCESS Search the driver success

Definition at line 569 of file FrontPageCustomizedUiSupport.c.

◆ UiSupportLibCallbackHandler()

BOOLEAN UiSupportLibCallbackHandler	(	IN EFI_HII_HANDLE	HiiHandle,
		IN EFI_BROWSER_ACTION	Action,
		IN EFI_QUESTION_ID	QuestionId,
		IN UINT8	Type,
		IN EFI_IFR_TYPE_VALUE *	Value,
		OUT EFI_BROWSER_ACTION_REQUEST *	ActionRequest,
		OUT EFI_STATUS *	Status
	)

This function processes the results of changes in configuration.

Parameters

HiiHandle	Points to the hii handle for this formset.
Action	Specifies the type of action taken by the browser.
QuestionId	A unique value which is sent to the original exporting driver so that it can identify the type of data to expect.
Type	The type of value for the question.
Value	A pointer to the data being sent to the original exporting driver.
ActionRequest	On return, points to the action requested by the callback function.
Status	Return the handle status.

Return values

TRUE	The callback successfully handled the action.
FALSE	The callback not supported in this handler.

Definition at line 175 of file FrontPageCustomizedUiSupport.c.

Variable Documentation

◆ gCurrentLanguageIndex

UINT8 gCurrentLanguageIndex

Definition at line 54 of file FrontPageCustomizedUiSupport.c.

◆ gHiiDriverList

UI_HII_DRIVER_INSTANCE* gHiiDriverList

Definition at line 52 of file FrontPageCustomizedUiSupport.c.

◆ gLanguageString

CHAR8* gLanguageString

Definition at line 50 of file FrontPageCustomizedUiSupport.c.

◆ gLanguageToken

EFI_STRING_ID* gLanguageToken

Definition at line 51 of file FrontPageCustomizedUiSupport.c.

◆ gStringPackHandle

EFI_HII_HANDLE gStringPackHandle

extern

Definition at line 11 of file BootManagerMenu.c.

Data Structures

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ FRONT_PAGE_KEY_CONTINUE

◆ FRONT_PAGE_KEY_DRIVER

◆ FRONT_PAGE_KEY_LANGUAGE

◆ FRONT_PAGE_KEY_RESET

◆ PRINTABLE_LANGUAGE_NAME_STRING_ID

◆ UI_HII_DRIVER_LIST_SIZE

Function Documentation

◆ ExtractDevicePathFromHiiHandle()

◆ GetNextLanguage()

◆ LanguageChangeHandler()

◆ RequiredDriver()

◆ UiCreateContinueMenu()

◆ UiCreateEmptyLine()

◆ UiCreateLanguageMenu()

◆ UiCreateResetMenu()

◆ UiListThirdPartyDrivers()

◆ UiSupportLibCallbackHandler()

Variable Documentation

◆ gCurrentLanguageIndex

◆ gHiiDriverList

◆ gLanguageString

◆ gLanguageToken

◆ gStringPackHandle