303 lines
10 KiB
C
303 lines
10 KiB
C
/** @file
|
|
Header file for front page.
|
|
|
|
;******************************************************************************
|
|
;* Copyright (c) 2014 - 2019, Insyde Software Corp. All Rights Reserved.
|
|
;*
|
|
;* You may not reproduce, distribute, publish, display, perform, modify, adapt,
|
|
;* transmit, broadcast, present, recite, release, license or otherwise exploit
|
|
;* any part of this publication in any form, by any means, without the prior
|
|
;* written permission of Insyde Software Corporation.
|
|
;*
|
|
;******************************************************************************
|
|
*/
|
|
|
|
/**
|
|
FrontPage routines to handle the callbacks and browser calls
|
|
|
|
Copyright (c) 2004 - 2012, Intel Corporation. All rights reserved.<BR>
|
|
This program and the accompanying materials
|
|
are licensed and made available under the terms and conditions of the BSD License
|
|
which accompanies this distribution. The full text of the license may be found at
|
|
http://opensource.org/licenses/bsd-license.php
|
|
|
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|
|
|
**/
|
|
|
|
#ifndef _FRONT_PAGE_H_
|
|
#define _FRONT_PAGE_H_
|
|
|
|
#include <IndustryStandard/SmBios.h>
|
|
#include <InternalFormRepresentation.h>
|
|
|
|
#include <Protocol/DevicePath.h>
|
|
#include <Protocol/HiiConfigAccess.h>
|
|
#include <Protocol/FormBrowser2.h>
|
|
#include <Protocol/ConsoleControl.h>
|
|
#include <Protocol/SimpleTextInEx.h>
|
|
#include <Protocol/SimpleTextOut.h>
|
|
#include <Protocol/GraphicsOutput.h>
|
|
#include <Protocol/LoadFile.h>
|
|
#include <Protocol/Smbios.h>
|
|
#include <Protocol/BootLogo.h>
|
|
|
|
#include <Guid/GlobalVariable.h>
|
|
#include <Guid/MdeModuleHii.h>
|
|
#include <Guid/BdsHii.h>
|
|
#include <Guid/H2OBdsCheckPoint.h>
|
|
//[-start-190612-IB16990052-add]//
|
|
#include <Guid/HiiPlatformSetupFormset.h>
|
|
//[-end-190612-IB16990052-add]//
|
|
|
|
#include <Library/DebugLib.h>
|
|
#include <Library/BaseMemoryLib.h>
|
|
#include <Library/UefiBootServicesTableLib.h>
|
|
#include <Library/UefiRuntimeServicesTableLib.h>
|
|
#include <Library/MemoryAllocationLib.h>
|
|
#include <Library/BaseLib.h>
|
|
#include <Library/PcdLib.h>
|
|
#include <Library/HobLib.h>
|
|
#include <Library/UefiLib.h>
|
|
#include <Library/OemGraphicsLib.h>
|
|
#include <Library/PrintLib.h>
|
|
#include <Library/HiiLib.h>
|
|
#include <Library/ReportStatusCodeLib.h>
|
|
#include <Library/PerformanceLib.h>
|
|
#include <Library/GenericBdsLib.h>
|
|
#include <Library/GenericUtilityLib.h>
|
|
#include <Library/PlatformBdsLib.h>
|
|
#include <Library/H2OCpLib.h>
|
|
#include <ChipsetSetupConfig.h>
|
|
#include <Register/HeciRegs.h>
|
|
#include <Library/DxeMeLib.h>
|
|
//[-start-190612-IB16990052-add]//
|
|
#include <Library/UefiHiiServicesLib.h>
|
|
//[-end-190612-IB16990052-add]//
|
|
#include <Library/H2OLib.h>
|
|
|
|
//
|
|
// These are the VFR compiler generated data representing our VFR data.
|
|
//
|
|
extern UINT8 FrontPageVfrBin[];
|
|
extern EFI_FORM_BROWSER2_PROTOCOL *gFormBrowser2;
|
|
extern UINTN gCallbackKey;
|
|
|
|
//
|
|
// Boot video resolution and text mode.
|
|
//
|
|
extern UINT32 mBootHorizontalResolution;
|
|
extern UINT32 mBootVerticalResolution;
|
|
extern UINT32 mBootTextModeColumn;
|
|
extern UINT32 mBootTextModeRow;
|
|
//
|
|
// BIOS setup video resolution and text mode.
|
|
//
|
|
extern UINT32 mSetupTextModeColumn;
|
|
extern UINT32 mSetupTextModeRow;
|
|
extern UINT32 mSetupHorizontalResolution;
|
|
extern UINT32 mSetupVerticalResolution;
|
|
|
|
|
|
#define ONE_SECOND 10000000
|
|
|
|
///
|
|
/// The size of a 3 character ISO639 language code.
|
|
///
|
|
#define ISO_639_2_ENTRY_SIZE 3
|
|
|
|
//
|
|
// This is the VFR compiler generated header file which defines the
|
|
// string identifiers.
|
|
//
|
|
#define PRINTABLE_LANGUAGE_NAME_STRING_ID 0x0001
|
|
|
|
//
|
|
// These are defined as the same with vfr file
|
|
//
|
|
#define FRONT_PAGE_FORM_ID 0x1000
|
|
//[-start-190612-IB16990052-add]//
|
|
#define INVALID_FORM_ID 0x0FFF
|
|
|
|
#define FRONT_PAGE_KEY_SECTION 0x1000
|
|
#define FRONT_PAGE_KEY_OFFSET 0x4000
|
|
//[-end-190612-IB16990052-add]//
|
|
|
|
#define FRONT_PAGE_KEY_CONTINUE 0x1000
|
|
#define FRONT_PAGE_KEY_LANGUAGE 0x1234
|
|
#define FRONT_PAGE_KEY_BOOT_MANAGER 0x1064
|
|
#define FRONT_PAGE_KEY_DEVICE_MANAGER 0x8567
|
|
#define FRONT_PAGE_KEY_BOOT_MAINTAIN 0x9876
|
|
#define FRONT_PAGE_KEY_SECURE_BOOT 0x4367
|
|
#define FRONT_PAGE_KEY_SETUP_UTILITY 0x2000
|
|
#define FRONT_PAGE_KEY_MEBX 0x2101
|
|
|
|
#define LABEL_SELECT_LANGUAGE 0x1000
|
|
#define LABEL_END 0xffff
|
|
|
|
#define FRONT_PAGE_BOOT_FROM_FILE_ID 0x2001
|
|
#define FRONT_PAGE_BOOT_FROM_FILE_TAIL_ID 0x20FF
|
|
|
|
#define FRONT_PAGE_MEBX_ID 0x2200
|
|
#define FRONT_PAGE_MEBX_TAIL_ID 0x22FF
|
|
|
|
#define FRONT_PAGE_CALLBACK_DATA_SIGNATURE SIGNATURE_32 ('F', 'P', 'C', 'B')
|
|
|
|
typedef struct {
|
|
UINTN Signature;
|
|
|
|
//
|
|
// HII relative handles
|
|
//
|
|
EFI_HII_HANDLE HiiHandle;
|
|
EFI_HANDLE DriverHandle;
|
|
EFI_STRING_ID *LanguageToken;
|
|
|
|
//
|
|
// Produced protocols
|
|
//
|
|
EFI_HII_CONFIG_ACCESS_PROTOCOL ConfigAccess;
|
|
} FRONT_PAGE_CALLBACK_DATA;
|
|
|
|
#define EFI_FP_CALLBACK_DATA_FROM_THIS(a) \
|
|
CR (a, \
|
|
FRONT_PAGE_CALLBACK_DATA, \
|
|
ConfigAccess, \
|
|
FRONT_PAGE_CALLBACK_DATA_SIGNATURE \
|
|
)
|
|
|
|
/**
|
|
This function allows a caller to extract the current configuration for one
|
|
or more named elements from the target driver.
|
|
|
|
|
|
@param This - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
|
|
@param Request - A null-terminated Unicode string in <ConfigRequest> format.
|
|
@param 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.
|
|
@param 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.
|
|
|
|
@retval EFI_SUCCESS The Results is filled with the requested values.
|
|
@retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.
|
|
@retval EFI_INVALID_PARAMETER Request is NULL, illegal syntax, or unknown name.
|
|
@retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.
|
|
|
|
**/
|
|
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 processes the results of changes in configuration.
|
|
|
|
|
|
@param This - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
|
|
@param Configuration - A null-terminated Unicode string in <ConfigResp> format.
|
|
@param 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.
|
|
|
|
@retval EFI_SUCCESS The Results is processed successfully.
|
|
@retval EFI_INVALID_PARAMETER Configuration is NULL.
|
|
@retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.
|
|
|
|
**/
|
|
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.
|
|
|
|
|
|
@param This - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
|
|
@param Action - Specifies the type of action taken by the browser.
|
|
@param QuestionId - A unique value which is sent to the original exporting driver
|
|
so that it can identify the type of data to expect.
|
|
@param Type - The type of value for the question.
|
|
@param Value - A pointer to the data being sent to the original exporting driver.
|
|
@param ActionRequest - On return, points to the action requested by the callback function.
|
|
|
|
@retval EFI_SUCCESS The callback successfully handled the action.
|
|
@retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
|
|
@retval EFI_DEVICE_ERROR The variable could not be saved.
|
|
@retval EFI_UNSUPPORTED The specified Action is not supported by the callback.
|
|
|
|
**/
|
|
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
|
|
);
|
|
|
|
/**
|
|
Initialize HII information for the FrontPage
|
|
|
|
|
|
@param InitializeHiiData TRUE if HII elements need to be initialized.
|
|
|
|
@retval EFI_SUCCESS The operation is successful.
|
|
@retval EFI_DEVICE_ERROR If the dynamic opcode creation failed.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
InitializeFrontPage (
|
|
IN BOOLEAN InitializeHiiData
|
|
);
|
|
|
|
EFI_STATUS
|
|
EFIAPI
|
|
FrontPageLoadFile (
|
|
IN EFI_LOAD_FILE_PROTOCOL *This,
|
|
IN EFI_DEVICE_PATH_PROTOCOL *FilePath,
|
|
IN BOOLEAN BootPolicy,
|
|
IN OUT UINTN *BufferSize,
|
|
IN VOID *Buffer OPTIONAL
|
|
);
|
|
|
|
//[-start-190612-IB16990052-add]//
|
|
/**
|
|
Extract the displayed formset for given HII handle and class guid.
|
|
|
|
@param Handle The HII handle.
|
|
@param SetupClassGuid The class guid specifies which form set will be displayed.
|
|
@param FormSetTitle Formset title string.
|
|
@param FormSetHelp Formset help string.
|
|
|
|
@retval TRUE The formset for given HII handle will be displayed.
|
|
@return FALSE The formset for given HII handle will not be displayed.
|
|
|
|
**/
|
|
BOOLEAN
|
|
ExtractDisplayedHiiFormFromHiiHandle (
|
|
IN EFI_HII_HANDLE Handle,
|
|
IN EFI_GUID *SetupClassGuid,
|
|
OUT EFI_STRING_ID *FormSetTitle,
|
|
OUT EFI_STRING_ID *FormSetHelp
|
|
);
|
|
//[-end-190612-IB16990052-add]//
|
|
|
|
#endif // _FRONT_PAGE_H_
|
|
|