#include "String.h"
#include "Ui.h"
#include <Protocol/BootLogo.h>

Data Structures
struct	FRONT_PAGE_CALLBACK_DATA

Macros
#define	SMBIOS_TYPE4_CPU_SOCKET_POPULATED BIT6

#define	PRINTABLE_LANGUAGE_NAME_STRING_ID 0x0001

#define	FRONT_PAGE_FORM_ID 0x1000

#define	LABEL_FRONTPAGE_INFORMATION 0x1000

#define	LABEL_END 0xffff

#define	FRONT_PAGE_FORMSET_GUID

#define	FRONT_PAGE_CALLBACK_DATA_SIGNATURE SIGNATURE_32 ('F', 'P', 'C', 'B')

#define	EFI_FP_CALLBACK_DATA_FROM_THIS(a)

Functions
EFI_STATUS EFIAPI	FakeExtractConfig (IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL This, IN CONST EFI_STRING Request, OUT EFI_STRING Progress, OUT EFI_STRING *Results)

EFI_STATUS EFIAPI	FakeRouteConfig (IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL This, IN CONST EFI_STRING Configuration, OUT EFI_STRING Progress)

EFI_STATUS EFIAPI	FrontPageCallback (IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL This, 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)

EFI_STATUS	InitializeFrontPage (VOID)

EFI_STATUS	GetProducerString (IN EFI_GUID ProducerGuid, IN EFI_STRING_ID Token, OUT CHAR16 *String)

VOID EFIAPI	UiEntry (IN BOOLEAN ConnectAllHappened)

CHAR16 *	ExtractDevicePathFromHiiHandle (IN EFI_HII_HANDLE Handle)

Variables
UINT8	FrontPageVfrBin []

EFI_FORM_BROWSER2_PROTOCOL *	gFormBrowser2

Detailed Description

Head file for front page.

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

Definition in file FrontPage.h.

Macro Definition Documentation

◆ EFI_FP_CALLBACK_DATA_FROM_THIS

#define EFI_FP_CALLBACK_DATA_FROM_THIS ( a )

Value:

  CR (a, \
      FRONT_PAGE_CALLBACK_DATA, \
      ConfigAccess, \
      FRONT_PAGE_CALLBACK_DATA_SIGNATURE \
      )

Definition at line 62 of file FrontPage.h.

◆ FRONT_PAGE_CALLBACK_DATA_SIGNATURE

#define FRONT_PAGE_CALLBACK_DATA_SIGNATURE SIGNATURE_32 ('F', 'P', 'C', 'B')

Definition at line 44 of file FrontPage.h.

◆ FRONT_PAGE_FORM_ID

#define FRONT_PAGE_FORM_ID 0x1000

Definition at line 34 of file FrontPage.h.

◆ FRONT_PAGE_FORMSET_GUID

#define FRONT_PAGE_FORMSET_GUID

Value:

  { \
    0x9e0c30bc, 0x3f06, 0x4ba6, {0x82, 0x88, 0x9, 0x17, 0x9b, 0x85, 0x5d, 0xbe} \
  }

Definition at line 39 of file FrontPage.h.

◆ LABEL_END

#define LABEL_END 0xffff

Definition at line 37 of file FrontPage.h.

◆ LABEL_FRONTPAGE_INFORMATION

#define LABEL_FRONTPAGE_INFORMATION 0x1000

Definition at line 36 of file FrontPage.h.

◆ PRINTABLE_LANGUAGE_NAME_STRING_ID

#define PRINTABLE_LANGUAGE_NAME_STRING_ID 0x0001

Definition at line 29 of file FrontPage.h.

◆ SMBIOS_TYPE4_CPU_SOCKET_POPULATED

#define SMBIOS_TYPE4_CPU_SOCKET_POPULATED BIT6

Definition at line 23 of file FrontPage.h.

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.

◆ FakeExtractConfig()

EFI_STATUS EFIAPI FakeExtractConfig	(	IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *	This,
		IN CONST EFI_STRING	Request,
		OUT EFI_STRING *	Progress,
		OUT EFI_STRING *	Results
	)

This function allows a caller to extract the current configuration for one or more named elements from the target driver.

Parameters

This	- Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
Request	- A null-terminated Unicode string in <ConfigRequest> format.
Progress	- On return, points to a character in the Request string. Points to the string's null terminator if request was successful. Points to the most recent '&' before the first failing name/value pair (or the beginning of the string if the failure is in the first name/value pair) if the request was not successful.
Results	- A null-terminated Unicode string in <ConfigAltResp> format which has all values filled in for the names in the Request string. String to be allocated by the called function.

Return values

EFI_SUCCESS	The Results is filled with the requested values.
EFI_OUT_OF_RESOURCES	Not enough memory to store the results.
EFI_INVALID_PARAMETER	Request is NULL, illegal syntax, or unknown name.
EFI_NOT_FOUND	Routing data doesn't match any storage in this driver.

This function allows a caller to extract the current configuration for one or more named elements from the target driver.

Parameters

This	Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
Request	A null-terminated Unicode string in <ConfigRequest> format.
Progress	On return, points to a character in the Request string. Points to the string's null terminator if request was successful. Points to the most recent '&' before the first failing name/value pair (or the beginning of the string if the failure is in the first name/value pair) if the request was not successful.
Results	A null-terminated Unicode string in <ConfigAltResp> format which has all values filled in for the names in the Request string. String to be allocated by the called function.

Return values

EFI_SUCCESS	The Results is filled with the requested values.
EFI_OUT_OF_RESOURCES	Not enough memory to store the results.
EFI_INVALID_PARAMETER	Request is illegal syntax, or unknown name.
EFI_NOT_FOUND	Routing data doesn't match any storage in this driver.

Definition at line 108 of file FrontPage.c.

◆ FakeRouteConfig()

EFI_STATUS EFIAPI FakeRouteConfig	(	IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *	This,
		IN CONST EFI_STRING	Configuration,
		OUT EFI_STRING *	Progress
	)

This function processes the results of changes in configuration.

Parameters

This	- Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
Configuration	- A null-terminated Unicode string in <ConfigResp> format.
Progress	- A pointer to a string filled in with the offset of the most recent '&' before the first failing name/value pair (or the beginning of the string if the failure is in the first name/value pair) or the terminating NULL if all was successful.

Return values

EFI_SUCCESS	The Results is processed successfully.
EFI_INVALID_PARAMETER	Configuration is NULL.
EFI_NOT_FOUND	Routing data doesn't match any storage in this driver.

This function processes the results of changes in configuration.

Parameters

This	Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
Configuration	A null-terminated Unicode string in <ConfigResp> format.
Progress	A pointer to a string filled in with the offset of the most recent '&' before the first failing name/value pair (or the beginning of the string if the failure is in the first name/value pair) or the terminating NULL if all was successful.

Return values

EFI_SUCCESS	The Results is processed successfully.
EFI_INVALID_PARAMETER	Configuration is NULL.
EFI_NOT_FOUND	Routing data doesn't match any storage in this driver.

Definition at line 141 of file FrontPage.c.

◆ FrontPageCallback()

EFI_STATUS EFIAPI FrontPageCallback	(	IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *	This,
		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
	)

This function processes the results of changes in configuration.

Parameters

This	- Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
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.

Return values

EFI_SUCCESS	The callback successfully handled the action.
EFI_OUT_OF_RESOURCES	Not enough storage is available to hold the variable and its data.
EFI_DEVICE_ERROR	The variable could not be saved.
EFI_UNSUPPORTED	The specified Action is not supported by the callback.

This function processes the results of changes in configuration.

Parameters

This	Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
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.

Return values

EFI_SUCCESS	The callback successfully handled the action.
EFI_OUT_OF_RESOURCES	Not enough storage is available to hold the variable and its data.
EFI_DEVICE_ERROR	The variable could not be saved.
EFI_UNSUPPORTED	The specified Action is not supported by the callback.

Definition at line 176 of file FrontPage.c.

◆ GetProducerString()

EFI_STATUS GetProducerString	(	IN EFI_GUID *	ProducerGuid,
		IN EFI_STRING_ID	Token,
		OUT CHAR16 **	String
	)

Acquire the string associated with the ProducerGuid and return it.

Parameters

ProducerGuid	- The Guid to search the HII database for
Token	- The token value of the string to extract
String	- The string that is extracted

Return values

EFI_SUCCESS The function returns EFI_SUCCESS always.

◆ InitializeFrontPage()

EFI_STATUS InitializeFrontPage ( VOID )

Initialize HII information for the FrontPage

Return values

EFI_SUCCESS	The operation is successful.
EFI_DEVICE_ERROR	If the dynamic opcode creation failed.

Definition at line 253 of file FrontPage.c.

◆ UiEntry()

VOID EFIAPI UiEntry ( IN BOOLEAN ConnectAllHappened )

This function is the main entry of the UI entry. The function will present the main menu of the system UI.

Parameters

ConnectAllHappened Caller passes the value to UI to avoid unnecessary connect-all.

Definition at line 993 of file FrontPage.c.

Variable Documentation

◆ gFormBrowser2

EFI_FORM_BROWSER2_PROTOCOL* gFormBrowser2

extern

Definition at line 19 of file FrontPage.c.

Data Structures

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ EFI_FP_CALLBACK_DATA_FROM_THIS

◆ FRONT_PAGE_CALLBACK_DATA_SIGNATURE

◆ FRONT_PAGE_FORM_ID

◆ FRONT_PAGE_FORMSET_GUID

◆ LABEL_END

◆ LABEL_FRONTPAGE_INFORMATION

◆ PRINTABLE_LANGUAGE_NAME_STRING_ID

◆ SMBIOS_TYPE4_CPU_SOCKET_POPULATED

Function Documentation

◆ ExtractDevicePathFromHiiHandle()

◆ FakeExtractConfig()

◆ FakeRouteConfig()

◆ FrontPageCallback()

◆ GetProducerString()

◆ InitializeFrontPage()

◆ UiEntry()

Variable Documentation

◆ gFormBrowser2