#include "HiiDatabase.h"

Macros
#define	BASE_NUMBER 10

Functions
EFI_STATUS	GenerateHiiDatabaseRecord (IN HII_DATABASE_PRIVATE_DATA Private, OUT HII_DATABASE_RECORD *DatabaseNode)

BOOLEAN	IsHiiHandleValid (EFI_HII_HANDLE Handle)

EFI_STATUS	InvokeRegisteredFunction (IN HII_DATABASE_PRIVATE_DATA Private, IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType, IN VOID PackageInstance, IN UINT8 PackageType, IN EFI_HII_HANDLE Handle)

EFI_STATUS	InsertGuidPackage (IN VOID PackageHdr, IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType, IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE PackageList, OUT HII_GUID_PACKAGE_INSTANCE **Package)

EFI_STATUS	ExportGuidPackages (IN HII_DATABASE_PRIVATE_DATA Private, IN EFI_HII_HANDLE Handle, IN HII_DATABASE_PACKAGE_LIST_INSTANCE PackageList, IN UINTN UsedSize, IN UINTN BufferSize, IN OUT VOID Buffer, IN OUT UINTN ResultSize)

EFI_STATUS	RemoveGuidPackages (IN HII_DATABASE_PRIVATE_DATA Private, IN EFI_HII_HANDLE Handle, IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE PackageList)

UINTN	IsEfiVarStoreQuestion (EFI_IFR_QUESTION_HEADER IfrQuestionHdr, EFI_IFR_VARSTORE_EFI *EfiVarStoreList, UINTN EfiVarStoreNumber)

VARIABLE_HEADER *	FindVariableData (IN VARIABLE_STORE_HEADER VariableStorage, IN EFI_GUID VarGuid, IN UINT32 VarAttribute, IN CHAR16 *VarName)

EFI_STATUS	FindQuestionDefaultSetting (IN UINT16 DefaultId, IN EFI_IFR_VARSTORE_EFI EfiVarStore, IN EFI_IFR_QUESTION_HEADER IfrQuestionHdr, OUT VOID *ValueBuffer, IN UINTN Width, IN BOOLEAN BitFieldQuestion)

VOID	UpdateDefaultSettingInFormPackage (HII_IFR_PACKAGE_INSTANCE *FormPackage)

EFI_STATUS	InsertFormPackage (IN VOID PackageHdr, IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType, IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE PackageList, OUT HII_IFR_PACKAGE_INSTANCE **Package)

EFI_STATUS	ExportFormPackages (IN HII_DATABASE_PRIVATE_DATA Private, IN EFI_HII_HANDLE Handle, IN HII_DATABASE_PACKAGE_LIST_INSTANCE PackageList, IN UINTN UsedSize, IN UINTN BufferSize, IN OUT VOID Buffer, IN OUT UINTN ResultSize)

EFI_STATUS	RemoveFormPackages (IN HII_DATABASE_PRIVATE_DATA Private, IN EFI_HII_HANDLE Handle, IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE PackageList)

EFI_STATUS	InsertStringPackage (IN HII_DATABASE_PRIVATE_DATA Private, IN VOID PackageHdr, IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType, IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE PackageList, OUT HII_STRING_PACKAGE_INSTANCE *Package)

EFI_STATUS	AdjustStringPackage (IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE *PackageList)

EFI_STATUS	ExportStringPackages (IN HII_DATABASE_PRIVATE_DATA Private, IN EFI_HII_HANDLE Handle, IN HII_DATABASE_PACKAGE_LIST_INSTANCE PackageList, IN UINTN UsedSize, IN UINTN BufferSize, IN OUT VOID Buffer, IN OUT UINTN ResultSize)

EFI_STATUS	RemoveStringPackages (IN HII_DATABASE_PRIVATE_DATA Private, IN EFI_HII_HANDLE Handle, IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE PackageList)

EFI_STATUS	InsertFontPackage (IN HII_DATABASE_PRIVATE_DATA Private, IN VOID PackageHdr, IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType, IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE PackageList, OUT HII_FONT_PACKAGE_INSTANCE *Package)

EFI_STATUS	ExportFontPackages (IN HII_DATABASE_PRIVATE_DATA Private, IN EFI_HII_HANDLE Handle, IN HII_DATABASE_PACKAGE_LIST_INSTANCE PackageList, IN UINTN UsedSize, IN UINTN BufferSize, IN OUT VOID Buffer, IN OUT UINTN ResultSize)

EFI_STATUS	RemoveFontPackages (IN HII_DATABASE_PRIVATE_DATA Private, IN EFI_HII_HANDLE Handle, IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE PackageList)

EFI_STATUS	InsertImagePackage (IN VOID PackageHdr, IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType, IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE PackageList, OUT HII_IMAGE_PACKAGE_INSTANCE **Package)

EFI_STATUS	ExportImagePackages (IN HII_DATABASE_PRIVATE_DATA Private, IN EFI_HII_HANDLE Handle, IN HII_DATABASE_PACKAGE_LIST_INSTANCE PackageList, IN UINTN UsedSize, IN UINTN BufferSize, IN OUT VOID Buffer, IN OUT UINTN ResultSize)

EFI_STATUS	RemoveImagePackages (IN HII_DATABASE_PRIVATE_DATA Private, IN EFI_HII_HANDLE Handle, IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE PackageList)

EFI_STATUS	InsertSimpleFontPackage (IN VOID PackageHdr, IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType, IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE PackageList, OUT HII_SIMPLE_FONT_PACKAGE_INSTANCE **Package)

EFI_STATUS	ExportSimpleFontPackages (IN HII_DATABASE_PRIVATE_DATA Private, IN EFI_HII_HANDLE Handle, IN HII_DATABASE_PACKAGE_LIST_INSTANCE PackageList, IN UINTN UsedSize, IN UINTN BufferSize, IN OUT VOID Buffer, IN OUT UINTN ResultSize)

EFI_STATUS	RemoveSimpleFontPackages (IN HII_DATABASE_PRIVATE_DATA Private, IN EFI_HII_HANDLE Handle, IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE PackageList)

EFI_STATUS	InsertDevicePathPackage (IN EFI_DEVICE_PATH_PROTOCOL DevicePath, IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType, IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE PackageList)

EFI_STATUS	ExportDevicePathPackage (IN HII_DATABASE_PRIVATE_DATA Private, IN EFI_HII_HANDLE Handle, IN HII_DATABASE_PACKAGE_LIST_INSTANCE PackageList, IN UINTN UsedSize, IN UINTN BufferSize, IN OUT VOID Buffer, IN OUT UINTN ResultSize)

EFI_STATUS	RemoveDevicePathPackage (IN HII_DATABASE_PRIVATE_DATA Private, IN EFI_HII_HANDLE Handle, IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE PackageList)

EFI_STATUS	AddDevicePathPackage (IN HII_DATABASE_PRIVATE_DATA Private, IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType, IN EFI_DEVICE_PATH_PROTOCOL DevicePath, IN OUT HII_DATABASE_RECORD *DatabaseRecord)

EFI_STATUS	InsertKeyboardLayoutPackage (IN VOID PackageHdr, IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType, IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE PackageList, OUT HII_KEYBOARD_LAYOUT_PACKAGE_INSTANCE **Package)

EFI_STATUS	ExportKeyboardLayoutPackages (IN HII_DATABASE_PRIVATE_DATA Private, IN EFI_HII_HANDLE Handle, IN HII_DATABASE_PACKAGE_LIST_INSTANCE PackageList, IN UINTN UsedSize, IN UINTN BufferSize, IN OUT VOID Buffer, IN OUT UINTN ResultSize)

EFI_STATUS	RemoveKeyboardLayoutPackages (IN HII_DATABASE_PRIVATE_DATA Private, IN EFI_HII_HANDLE Handle, IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE PackageList)

EFI_STATUS	AddPackages (IN HII_DATABASE_PRIVATE_DATA Private, IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType, IN CONST EFI_HII_PACKAGE_LIST_HEADER PackageList, IN OUT HII_DATABASE_RECORD *DatabaseRecord)

EFI_STATUS	ExportPackageList (IN HII_DATABASE_PRIVATE_DATA Private, IN EFI_HII_HANDLE Handle, IN HII_DATABASE_PACKAGE_LIST_INSTANCE PackageList, IN OUT UINTN UsedSize, IN UINTN BufferSize, OUT EFI_HII_PACKAGE_LIST_HEADER Buffer)

EFI_STATUS	HiiGetConfigRespInfo (IN CONST EFI_HII_DATABASE_PROTOCOL *This)

EFI_STATUS	HiiGetDatabaseInfo (IN CONST EFI_HII_DATABASE_PROTOCOL *This)

EFI_STATUS EFIAPI	HiiNewPackageList (IN CONST EFI_HII_DATABASE_PROTOCOL This, IN CONST EFI_HII_PACKAGE_LIST_HEADER PackageList, IN CONST EFI_HANDLE DriverHandle, OPTIONAL OUT EFI_HII_HANDLE *Handle)

EFI_STATUS EFIAPI	HiiRemovePackageList (IN CONST EFI_HII_DATABASE_PROTOCOL *This, IN EFI_HII_HANDLE Handle)

EFI_STATUS EFIAPI	HiiUpdatePackageList (IN CONST EFI_HII_DATABASE_PROTOCOL This, IN EFI_HII_HANDLE Handle, IN CONST EFI_HII_PACKAGE_LIST_HEADER PackageList)

EFI_STATUS EFIAPI	HiiListPackageLists (IN CONST EFI_HII_DATABASE_PROTOCOL This, IN UINT8 PackageType, IN CONST EFI_GUID PackageGuid, IN OUT UINTN HandleBufferLength, OUT EFI_HII_HANDLE Handle)

EFI_STATUS EFIAPI	HiiExportPackageLists (IN CONST EFI_HII_DATABASE_PROTOCOL This, IN EFI_HII_HANDLE Handle, IN OUT UINTN BufferSize, OUT EFI_HII_PACKAGE_LIST_HEADER *Buffer)

EFI_STATUS EFIAPI	HiiRegisterPackageNotify (IN CONST EFI_HII_DATABASE_PROTOCOL This, IN UINT8 PackageType, IN CONST EFI_GUID PackageGuid, IN CONST EFI_HII_DATABASE_NOTIFY PackageNotifyFn, IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType, OUT EFI_HANDLE *NotifyHandle)

EFI_STATUS EFIAPI	HiiUnregisterPackageNotify (IN CONST EFI_HII_DATABASE_PROTOCOL *This, IN EFI_HANDLE NotificationHandle)

EFI_STATUS EFIAPI	HiiFindKeyboardLayouts (IN CONST EFI_HII_DATABASE_PROTOCOL This, IN OUT UINT16 KeyGuidBufferLength, OUT EFI_GUID *KeyGuidBuffer)

EFI_STATUS EFIAPI	HiiGetKeyboardLayout (IN CONST EFI_HII_DATABASE_PROTOCOL This, IN CONST EFI_GUID KeyGuid, IN OUT UINT16 KeyboardLayoutLength, OUT EFI_HII_KEYBOARD_LAYOUT KeyboardLayout)

EFI_STATUS EFIAPI	HiiSetKeyboardLayout (IN CONST EFI_HII_DATABASE_PROTOCOL This, IN CONST EFI_GUID KeyGuid)

EFI_STATUS EFIAPI	HiiGetPackageListHandle (IN CONST EFI_HII_DATABASE_PROTOCOL This, IN EFI_HII_HANDLE PackageListHandle, OUT EFI_HANDLE DriverHandle)

Variables
EFI_HII_PACKAGE_LIST_HEADER *	gRTDatabaseInfoBuffer = NULL

EFI_STRING	gRTConfigRespBuffer = NULL

UINTN	gDatabaseInfoSize = 0

UINTN	gConfigRespSize = 0

BOOLEAN	gExportConfigResp = FALSE

UINTN	gNvDefaultStoreSize = 0

SKU_ID	gSkuId = 0xFFFFFFFFFFFFFFFF

LIST_ENTRY	gVarStorageList = INITIALIZE_LIST_HEAD_VARIABLE (gVarStorageList)

EFI_LOCK	mHiiDatabaseLock = EFI_INITIALIZE_LOCK_VARIABLE (TPL_NOTIFY)

Detailed Description

Implementation for EFI_HII_DATABASE_PROTOCOL.

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

Definition in file Database.c.

Macro Definition Documentation

◆ BASE_NUMBER

#define BASE_NUMBER 10

Definition at line 11 of file Database.c.

Function Documentation

◆ AddDevicePathPackage()

EFI_STATUS AddDevicePathPackage	(	IN HII_DATABASE_PRIVATE_DATA *	Private,
		IN EFI_HII_DATABASE_NOTIFY_TYPE	NotifyType,
		IN EFI_DEVICE_PATH_PROTOCOL *	DevicePath,
		IN OUT HII_DATABASE_RECORD *	DatabaseRecord )

This function will insert a device path package to package list firstly then invoke notification functions if any. This is a internal function.

Parameters

Private	Hii database private structure.
NotifyType	The type of change concerning the database.
DevicePath	Pointer to a EFI_DEVICE_PATH_PROTOCOL protocol instance
DatabaseRecord	Pointer to a database record contains a package list which will be inserted to.

Return values

EFI_SUCCESS	Device path Package is inserted successfully.
EFI_OUT_OF_RESOURCES	Unable to allocate necessary resources for the new Device path package.
EFI_INVALID_PARAMETER	DevicePath is NULL or PackageList is NULL.

Definition at line 2719 of file Database.c.

◆ AddPackages()

EFI_STATUS AddPackages	(	IN HII_DATABASE_PRIVATE_DATA *	Private,
		IN EFI_HII_DATABASE_NOTIFY_TYPE	NotifyType,
		IN CONST EFI_HII_PACKAGE_LIST_HEADER *	PackageList,
		IN OUT HII_DATABASE_RECORD *	DatabaseRecord )

This function will insert a package list to hii database firstly then invoke notification functions if any. It is the worker function of HiiNewPackageList and HiiUpdatePackageList.

This is a internal function.

Parameters

Private	Hii database private structure.
NotifyType	The type of change concerning the database.
PackageList	Pointer to a package list.
DatabaseRecord	Pointer to a database record contains a package list instance which will be inserted to.

Return values

EFI_SUCCESS	All incoming packages are inserted to current database.
EFI_OUT_OF_RESOURCES	Unable to allocate necessary resources for the new Device path package.
EFI_INVALID_PARAMETER	Any input parameter is invalid.

Definition at line 2985 of file Database.c.

◆ AdjustStringPackage()

EFI_STATUS AdjustStringPackage ( IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE * PackageList )

Adjust all string packages in a single package list to have the same max string ID.

Parameters

PackageList Pointer to a package list which will be adjusted.

Return values

EFI_SUCCESS	Adjust all string packages successfully.
others	Can't adjust string packages.

Definition at line 1479 of file Database.c.

◆ ExportDevicePathPackage()

EFI_STATUS ExportDevicePathPackage	(	IN HII_DATABASE_PRIVATE_DATA *	Private,
		IN EFI_HII_HANDLE	Handle,
		IN HII_DATABASE_PACKAGE_LIST_INSTANCE *	PackageList,
		IN UINTN	UsedSize,
		IN UINTN	BufferSize,
		IN OUT VOID *	Buffer,
		IN OUT UINTN *	ResultSize )

This function exports device path package to a buffer. This is a internal function.

Parameters

Private	Hii database private structure.
Handle	Identification of a package list.
PackageList	Pointer to a package list which will be exported.
UsedSize	The length of buffer be used.
BufferSize	Length of the Buffer.
Buffer	Allocated space for storing exported data.
ResultSize	The size of the already exported content of this package list.

Return values

EFI_SUCCESS	Device path Package is exported successfully.
EFI_INVALID_PARAMETER	Any input parameter is invalid.

Definition at line 2593 of file Database.c.

◆ ExportFontPackages()

EFI_STATUS ExportFontPackages	(	IN HII_DATABASE_PRIVATE_DATA *	Private,
		IN EFI_HII_HANDLE	Handle,
		IN HII_DATABASE_PACKAGE_LIST_INSTANCE *	PackageList,
		IN UINTN	UsedSize,
		IN UINTN	BufferSize,
		IN OUT VOID *	Buffer,
		IN OUT UINTN *	ResultSize )

This function exports Font packages to a buffer. This is a internal function.

Parameters

Private	Hii database private structure.
Handle	Identification of a package list.
PackageList	Pointer to a package list which will be exported.
UsedSize	The length of buffer be used.
BufferSize	Length of the Buffer.
Buffer	Allocated space for storing exported data.
ResultSize	The size of the already exported content of this package list.

Return values

EFI_SUCCESS	Font Packages are exported successfully.
EFI_INVALID_PARAMETER	Any input parameter is invalid.

Definition at line 1879 of file Database.c.

◆ ExportFormPackages()

EFI_STATUS ExportFormPackages	(	IN HII_DATABASE_PRIVATE_DATA *	Private,
		IN EFI_HII_HANDLE	Handle,
		IN HII_DATABASE_PACKAGE_LIST_INSTANCE *	PackageList,
		IN UINTN	UsedSize,
		IN UINTN	BufferSize,
		IN OUT VOID *	Buffer,
		IN OUT UINTN *	ResultSize )

This function exports Form packages to a buffer. This is a internal function.

Parameters

Private	Hii database private structure.
Handle	Identification of a package list.
PackageList	Pointer to a package list which will be exported.
UsedSize	The length of buffer be used.
BufferSize	Length of the Buffer.
Buffer	Allocated space for storing exported data.
ResultSize	The size of the already exported content of this package list.

Return values

EFI_SUCCESS	Form Packages are exported successfully.
EFI_INVALID_PARAMETER	Any input parameter is invalid.

Definition at line 1197 of file Database.c.

◆ ExportGuidPackages()

EFI_STATUS ExportGuidPackages	(	IN HII_DATABASE_PRIVATE_DATA *	Private,
		IN EFI_HII_HANDLE	Handle,
		IN HII_DATABASE_PACKAGE_LIST_INSTANCE *	PackageList,
		IN UINTN	UsedSize,
		IN UINTN	BufferSize,
		IN OUT VOID *	Buffer,
		IN OUT UINTN *	ResultSize )

This function exports GUID packages to a buffer. This is a internal function.

Parameters

Private	Hii database private structure.
Handle	Identification of a package list.
PackageList	Pointer to a package list which will be exported.
UsedSize	The length of buffer be used.
BufferSize	Length of the Buffer.
Buffer	Allocated space for storing exported data.
ResultSize	The size of the already exported content of this package list.

Return values

EFI_SUCCESS	Guid Packages are exported successfully.
EFI_INVALID_PARAMETER	Any input parameter is invalid.

Definition at line 434 of file Database.c.

◆ ExportImagePackages()

EFI_STATUS ExportImagePackages	(	IN HII_DATABASE_PRIVATE_DATA *	Private,
		IN EFI_HII_HANDLE	Handle,
		IN HII_DATABASE_PACKAGE_LIST_INSTANCE *	PackageList,
		IN UINTN	UsedSize,
		IN UINTN	BufferSize,
		IN OUT VOID *	Buffer,
		IN OUT UINTN *	ResultSize )

This function exports Image packages to a buffer. This is a internal function.

Parameters

Private	Hii database private structure.
Handle	Identification of a package list.
PackageList	Pointer to a package list which will be exported.
UsedSize	The length of buffer be used.
BufferSize	Length of the Buffer.
Buffer	Allocated space for storing exported data.
ResultSize	The size of the already exported content of this package list.

Return values

EFI_SUCCESS	Image Packages are exported successfully.
EFI_INVALID_PARAMETER	Any input parameter is invalid.

Definition at line 2175 of file Database.c.

◆ ExportKeyboardLayoutPackages()

EFI_STATUS ExportKeyboardLayoutPackages	(	IN HII_DATABASE_PRIVATE_DATA *	Private,
		IN EFI_HII_HANDLE	Handle,
		IN HII_DATABASE_PACKAGE_LIST_INSTANCE *	PackageList,
		IN UINTN	UsedSize,
		IN UINTN	BufferSize,
		IN OUT VOID *	Buffer,
		IN OUT UINTN *	ResultSize )

This function exports Keyboard Layout packages to a buffer. This is a internal function.

Parameters

Private	Hii database private structure.
Handle	Identification of a package list.
PackageList	Pointer to a package list which will be exported.
UsedSize	The length of buffer be used.
BufferSize	Length of the Buffer.
Buffer	Allocated space for storing exported data.
ResultSize	The size of the already exported content of this package list.

Return values

EFI_SUCCESS	Keyboard Layout Packages are exported successfully.
EFI_INVALID_PARAMETER	Any input parameter is invalid.

Definition at line 2851 of file Database.c.

◆ ExportPackageList()

EFI_STATUS ExportPackageList	(	IN HII_DATABASE_PRIVATE_DATA *	Private,
		IN EFI_HII_HANDLE	Handle,
		IN HII_DATABASE_PACKAGE_LIST_INSTANCE *	PackageList,
		IN OUT UINTN *	UsedSize,
		IN UINTN	BufferSize,
		OUT EFI_HII_PACKAGE_LIST_HEADER *	Buffer )

This function exports a package list to a buffer. It is the worker function of HiiExportPackageList.

This is a internal function.

Parameters

Private	Hii database private structure.
Handle	Identification of a package list.
PackageList	Pointer to a package list which will be exported.
UsedSize	The length of buffer has been used by exporting package lists when Handle is NULL.
BufferSize	Length of the Buffer.
Buffer	Allocated space for storing exported data.

Return values

EFI_SUCCESS	Keyboard Layout Packages are exported successfully.
EFI_INVALID_PARAMETER	Any input parameter is invalid.

Definition at line 3238 of file Database.c.

◆ ExportSimpleFontPackages()

EFI_STATUS ExportSimpleFontPackages	(	IN HII_DATABASE_PRIVATE_DATA *	Private,
		IN EFI_HII_HANDLE	Handle,
		IN HII_DATABASE_PACKAGE_LIST_INSTANCE *	PackageList,
		IN UINTN	UsedSize,
		IN UINTN	BufferSize,
		IN OUT VOID *	Buffer,
		IN OUT UINTN *	ResultSize )

This function exports SimpleFont packages to a buffer. This is a internal function.

Parameters

Private	Hii database private structure.
Handle	Identification of a package list.
PackageList	Pointer to a package list which will be exported.
UsedSize	The length of buffer be used.
BufferSize	Length of the Buffer.
Buffer	Allocated space for storing exported data.
ResultSize	The size of the already exported content of this package list.

Return values

EFI_SUCCESS	SimpleFont Packages are exported successfully.
EFI_INVALID_PARAMETER	Any input parameter is invalid.

Definition at line 2407 of file Database.c.

◆ ExportStringPackages()

EFI_STATUS ExportStringPackages	(	IN HII_DATABASE_PRIVATE_DATA *	Private,
		IN EFI_HII_HANDLE	Handle,
		IN HII_DATABASE_PACKAGE_LIST_INSTANCE *	PackageList,
		IN UINTN	UsedSize,
		IN UINTN	BufferSize,
		IN OUT VOID *	Buffer,
		IN OUT UINTN *	ResultSize )

This function exports String packages to a buffer. This is a internal function.

Parameters

Private	Hii database private structure.
Handle	Identification of a package list.
PackageList	Pointer to a package list which will be exported.
UsedSize	The length of buffer be used.
BufferSize	Length of the Buffer.
Buffer	Allocated space for storing exported data.
ResultSize	The size of the already exported content of this package list.

Return values

EFI_SUCCESS	String Packages are exported successfully.
EFI_INVALID_PARAMETER	Any input parameter is invalid.

Definition at line 1568 of file Database.c.

◆ FindQuestionDefaultSetting()

EFI_STATUS FindQuestionDefaultSetting	(	IN UINT16	DefaultId,
		IN EFI_IFR_VARSTORE_EFI *	EfiVarStore,
		IN EFI_IFR_QUESTION_HEADER *	IfrQuestionHdr,
		OUT VOID *	ValueBuffer,
		IN UINTN	Width,
		IN BOOLEAN	BitFieldQuestion )

Find question default value from PcdNvStoreDefaultValueBuffer

Parameters

DefaultId	Default store ID
EfiVarStore	Point to EFI VarStore header
IfrQuestionHdr	Point to Question header
ValueBuffer	Point to Buffer includes the found default setting
Width	Width of the default value
BitFieldQuestion	Whether the Question is stored in Bit field.

Return values

EFI_SUCCESS	Question default value is found.
EFI_NOT_FOUND	Question default value is not found.

Definition at line 620 of file Database.c.

◆ FindVariableData()

VARIABLE_HEADER * FindVariableData	(	IN VARIABLE_STORE_HEADER *	VariableStorage,
		IN EFI_GUID *	VarGuid,
		IN UINT32	VarAttribute,
		IN CHAR16 *	VarName )

Find the matched variable from the input variable storage.

Parameters

[in]	VariableStorage	Point to the variable storage header.
[in]	VarGuid	A unique identifier for the variable.
[in]	VarAttribute	The attributes bitmask for the variable.
[in]	VarName	A Null-terminated ascii string that is the name of the variable.

Returns: Pointer to the matched variable header or NULL if not found.

Definition at line 578 of file Database.c.

◆ GenerateHiiDatabaseRecord()

EFI_STATUS GenerateHiiDatabaseRecord	(	IN HII_DATABASE_PRIVATE_DATA *	Private,
		OUT HII_DATABASE_RECORD **	DatabaseNode )

This function generates a HII_DATABASE_RECORD node and adds into hii database. This is a internal function.

Parameters

Private	hii database private structure
DatabaseNode	HII_DATABASE_RECORD node which is used to store a package list

Return values

EFI_SUCCESS	A database record is generated successfully.
EFI_OUT_OF_RESOURCES	Unable to allocate necessary resources for the new database contents.
EFI_INVALID_PARAMETER	Private is NULL or DatabaseRecord is NULL.

Definition at line 42 of file Database.c.

◆ HiiExportPackageLists()

EFI_STATUS EFIAPI HiiExportPackageLists	(	IN CONST EFI_HII_DATABASE_PROTOCOL *	This,
		IN EFI_HII_HANDLE	Handle,
		IN OUT UINTN *	BufferSize,
		OUT EFI_HII_PACKAGE_LIST_HEADER *	Buffer )

This function will export one or all package lists in the database to a buffer. For each package list exported, this function will call functions registered with EXPORT_PACK and then copy the package list to the buffer.

Parameters

This	A pointer to the EFI_HII_DATABASE_PROTOCOL instance.
Handle	An EFI_HII_HANDLE that corresponds to the desired package list in the HII database to export or NULL to indicate all package lists should be exported.
BufferSize	On input, a pointer to the length of the buffer. On output, the length of the buffer that is required for the exported data.
Buffer	A pointer to a buffer that will contain the results of the export function.

Return values

EFI_SUCCESS	Package exported.
EFI_BUFFER_TO_SMALL	The HandleBufferLength parameter indicates that Handle is too small to support the number of handles. HandleBufferLength is updated with a value that will enable the data to fit.
EFI_NOT_FOUND	The specified Handle could not be found in the current database.
EFI_INVALID_PARAMETER	BufferSize was NULL.
EFI_INVALID_PARAMETER	The value referenced by BufferSize was not zero and Buffer was NULL.

Definition at line 4137 of file Database.c.

◆ HiiFindKeyboardLayouts()

EFI_STATUS EFIAPI HiiFindKeyboardLayouts	(	IN CONST EFI_HII_DATABASE_PROTOCOL *	This,
		IN OUT UINT16 *	KeyGuidBufferLength,
		OUT EFI_GUID *	KeyGuidBuffer )

This routine retrieves an array of GUID values for each keyboard layout that was previously registered in the system.

Parameters

This	A pointer to the EFI_HII_DATABASE_PROTOCOL instance.
KeyGuidBufferLength	On input, a pointer to the length of the keyboard GUID buffer. On output, the length of the handle buffer that is required for the handles found.
KeyGuidBuffer	An array of keyboard layout GUID instances returned.

Return values

EFI_SUCCESS	KeyGuidBuffer was updated successfully.
EFI_BUFFER_TOO_SMALL	The KeyGuidBufferLength parameter indicates that KeyGuidBuffer is too small to support the number of GUIDs. KeyGuidBufferLength is updated with a value that will enable the data to fit.
EFI_INVALID_PARAMETER	The KeyGuidBufferLength is NULL.
EFI_INVALID_PARAMETER	The value referenced by KeyGuidBufferLength is not zero and KeyGuidBuffer is NULL.
EFI_NOT_FOUND	There was no keyboard layout.

Definition at line 4405 of file Database.c.

◆ HiiGetConfigRespInfo()

EFI_STATUS HiiGetConfigRespInfo ( IN CONST EFI_HII_DATABASE_PROTOCOL * This )

This function mainly use to get and update ConfigResp string.

Parameters

This	A pointer to the EFI_HII_DATABASE_PROTOCOL instance.

Return values

EFI_SUCCESS	Get the information successfully.
EFI_OUT_OF_RESOURCES	Not enough memory to store the Configuration Setting data.

Definition at line 3403 of file Database.c.

◆ HiiGetDatabaseInfo()

EFI_STATUS HiiGetDatabaseInfo ( IN CONST EFI_HII_DATABASE_PROTOCOL * This )

This is an internal function,mainly use to get HiiDatabase information.

Parameters

This	A pointer to the EFI_HII_DATABASE_PROTOCOL instance.

Return values

EFI_SUCCESS	Get the information successfully.
EFI_OUT_OF_RESOURCES	Not enough memory to store the Hiidatabase data.

Definition at line 3467 of file Database.c.

◆ HiiGetKeyboardLayout()

EFI_STATUS EFIAPI HiiGetKeyboardLayout	(	IN CONST EFI_HII_DATABASE_PROTOCOL *	This,
		IN CONST EFI_GUID *	KeyGuid,
		IN OUT UINT16 *	KeyboardLayoutLength,
		OUT EFI_HII_KEYBOARD_LAYOUT *	KeyboardLayout )

This routine retrieves the requested keyboard layout. The layout is a physical description of the keys on a keyboard and the character(s) that are associated with a particular set of key strokes.

Parameters

This	A pointer to the EFI_HII_DATABASE_PROTOCOL instance.
KeyGuid	A pointer to the unique ID associated with a given keyboard layout. If KeyGuid is NULL then the current layout will be retrieved.
KeyboardLayoutLength	On input, a pointer to the length of the KeyboardLayout buffer. On output, the length of the data placed into KeyboardLayout.
KeyboardLayout	A pointer to a buffer containing the retrieved keyboard layout.

Return values

EFI_SUCCESS	The keyboard layout was retrieved successfully.
EFI_NOT_FOUND	The requested keyboard layout was not found.
EFI_INVALID_PARAMETER	The KeyboardLayout or KeyboardLayoutLength was NULL.
EFI_BUFFER_TOO_SMALL	The KeyboardLayoutLength parameter indicates that KeyboardLayout is too small to support the requested keyboard layout. KeyboardLayoutLength is updated with a value that will enable the data to fit.

Definition at line 4512 of file Database.c.

◆ HiiGetPackageListHandle()

EFI_STATUS EFIAPI HiiGetPackageListHandle	(	IN CONST EFI_HII_DATABASE_PROTOCOL *	This,
		IN EFI_HII_HANDLE	PackageListHandle,
		OUT EFI_HANDLE *	DriverHandle )

Return the EFI handle associated with a package list.

Parameters

This	A pointer to the EFI_HII_DATABASE_PROTOCOL instance.
PackageListHandle	An EFI_HII_HANDLE that corresponds to the desired package list in the HIIdatabase.
DriverHandle	On return, contains the EFI_HANDLE which was registered with the package list in NewPackageList().

Return values

EFI_SUCCESS	The DriverHandle was returned successfully.
EFI_INVALID_PARAMETER	The PackageListHandle was not valid or DriverHandle was NULL.
EFI_NOT_FOUND	This PackageList handle can not be found in current database.

Definition at line 4695 of file Database.c.

◆ HiiListPackageLists()

EFI_STATUS EFIAPI HiiListPackageLists	(	IN CONST EFI_HII_DATABASE_PROTOCOL *	This,
		IN UINT8	PackageType,
		IN CONST EFI_GUID *	PackageGuid,
		IN OUT UINTN *	HandleBufferLength,
		OUT EFI_HII_HANDLE *	Handle )

This function returns a list of the package handles of the specified type that are currently active in the database. The pseudo-type EFI_HII_PACKAGE_TYPE_ALL will cause all package handles to be listed.

Parameters

This	A pointer to the EFI_HII_DATABASE_PROTOCOL instance.
PackageType	Specifies the package type of the packages to list or EFI_HII_PACKAGE_TYPE_ALL for all packages to be listed.
PackageGuid	If PackageType is EFI_HII_PACKAGE_TYPE_GUID, then this is the pointer to the GUID which must match the Guid field of EFI_HII_GUID_PACKAGE_GUID_HDR. Otherwise, it must be NULL.
HandleBufferLength	On input, a pointer to the length of the handle buffer. On output, the length of the handle buffer that is required for the handles found.
Handle	An array of EFI_HII_HANDLE instances returned.

Return values

EFI_SUCCESS	The matching handles are outputted successfully. HandleBufferLength is updated with the actual length.
EFI_BUFFER_TO_SMALL	The HandleBufferLength parameter indicates that Handle is too small to support the number of handles. HandleBufferLength is updated with a value that will enable the data to fit.
EFI_NOT_FOUND	No matching handle could not be found in database.
EFI_INVALID_PARAMETER	HandleBufferLength was NULL.
EFI_INVALID_PARAMETER	The value referenced by HandleBufferLength was not zero and Handle was NULL.
EFI_INVALID_PARAMETER	PackageType is not a EFI_HII_PACKAGE_TYPE_GUID but PackageGuid is not NULL, PackageType is a EFI_HII_ PACKAGE_TYPE_GUID but PackageGuid is NULL.

Definition at line 3970 of file Database.c.

◆ HiiNewPackageList()

EFI_STATUS EFIAPI HiiNewPackageList	(	IN CONST EFI_HII_DATABASE_PROTOCOL *	This,
		IN CONST EFI_HII_PACKAGE_LIST_HEADER *	PackageList,
		IN CONST EFI_HANDLE	DriverHandle,
		OPTIONAL OUT EFI_HII_HANDLE *	Handle )

This function adds the packages in the package list to the database and returns a handle. If there is a EFI_DEVICE_PATH_PROTOCOL associated with the DriverHandle, then this function will create a package of type EFI_PACKAGE_TYPE_DEVICE_PATH and add it to the package list.

Parameters

This	A pointer to the EFI_HII_DATABASE_PROTOCOL instance.
PackageList	A pointer to an EFI_HII_PACKAGE_LIST_HEADER structure.
DriverHandle	Associate the package list with this EFI handle. If a NULL is specified, this data will not be associate with any drivers and cannot have a callback induced.
Handle	A pointer to the EFI_HII_HANDLE instance.

Return values

EFI_SUCCESS	The package list associated with the Handle was added to the HII database.
EFI_OUT_OF_RESOURCES	Unable to allocate necessary resources for the new database contents.
EFI_INVALID_PARAMETER	PackageList is NULL or Handle is NULL.
EFI_INVALID_PARAMETER	PackageListGuid already exists in database.

Definition at line 3540 of file Database.c.

◆ HiiRegisterPackageNotify()

EFI_STATUS EFIAPI HiiRegisterPackageNotify	(	IN CONST EFI_HII_DATABASE_PROTOCOL *	This,
		IN UINT8	PackageType,
		IN CONST EFI_GUID *	PackageGuid,
		IN CONST EFI_HII_DATABASE_NOTIFY	PackageNotifyFn,
		IN EFI_HII_DATABASE_NOTIFY_TYPE	NotifyType,
		OUT EFI_HANDLE *	NotifyHandle )

This function registers a function which will be called when specified actions related to packages of the specified type occur in the HII database. By registering a function, other HII-related drivers are notified when specific package types are added, removed or updated in the HII database. Each driver or application which registers a notification should use EFI_HII_DATABASE_PROTOCOL.UnregisterPackageNotify() before exiting.

Parameters

This	A pointer to the EFI_HII_DATABASE_PROTOCOL instance.
PackageType	Specifies the package type of the packages to list or EFI_HII_PACKAGE_TYPE_ALL for all packages to be listed.
PackageGuid	If PackageType is EFI_HII_PACKAGE_TYPE_GUID, then this is the pointer to the GUID which must match the Guid field of EFI_HII_GUID_PACKAGE_GUID_HDR. Otherwise, it must be NULL.
PackageNotifyFn	Points to the function to be called when the event specified by NotificationType occurs.
NotifyType	Describes the types of notification which this function will be receiving.
NotifyHandle	Points to the unique handle assigned to the registered notification. Can be used in EFI_HII_DATABASE_PROTOCOL.UnregisterPackageNotify() to stop notifications.

Return values

EFI_SUCCESS	Notification registered successfully.
EFI_OUT_OF_RESOURCES	Unable to allocate necessary data structures
EFI_INVALID_PARAMETER	NotifyHandle is NULL.
EFI_INVALID_PARAMETER	PackageGuid is not NULL when PackageType is not EFI_HII_PACKAGE_TYPE_GUID.
EFI_INVALID_PARAMETER	PackageGuid is NULL when PackageType is EFI_HII_PACKAGE_TYPE_GUID.

Definition at line 4249 of file Database.c.

◆ HiiRemovePackageList()

EFI_STATUS EFIAPI HiiRemovePackageList	(	IN CONST EFI_HII_DATABASE_PROTOCOL *	This,
		IN EFI_HII_HANDLE	Handle )

This function removes the package list that is associated with Handle from the HII database. Before removing the package, any registered functions with the notification type REMOVE_PACK and the same package type will be called.

Parameters

This	A pointer to the EFI_HII_DATABASE_PROTOCOL instance.
Handle	The handle that was registered to the data that is requested for removal.

Return values

EFI_SUCCESS	The data associated with the Handle was removed from the HII database.
EFI_NOT_FOUND	The specified handle is not in database.
EFI_INVALID_PARAMETER	The Handle was not valid.

Definition at line 3661 of file Database.c.

◆ HiiSetKeyboardLayout()

EFI_STATUS EFIAPI HiiSetKeyboardLayout	(	IN CONST EFI_HII_DATABASE_PROTOCOL *	This,
		IN CONST EFI_GUID *	KeyGuid )

This routine sets the default keyboard layout to the one referenced by KeyGuid. When this routine is called, an event will be signaled of the EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID group type. This is so that agents which are sensitive to the current keyboard layout being changed can be notified of this change.

Parameters

This	A pointer to the EFI_HII_DATABASE_PROTOCOL instance.
KeyGuid	A pointer to the unique ID associated with a given keyboard layout.

Return values

EFI_SUCCESS	The current keyboard layout was successfully set.
EFI_NOT_FOUND	The referenced keyboard layout was not found, so action was taken.
EFI_INVALID_PARAMETER	The KeyGuid was NULL.

Definition at line 4614 of file Database.c.

◆ HiiUnregisterPackageNotify()

EFI_STATUS EFIAPI HiiUnregisterPackageNotify	(	IN CONST EFI_HII_DATABASE_PROTOCOL *	This,
		IN EFI_HANDLE	NotificationHandle )

Removes the specified HII database package-related notification.

Parameters

This	A pointer to the EFI_HII_DATABASE_PROTOCOL instance.
NotificationHandle	The handle of the notification function being unregistered.

Return values

EFI_SUCCESS	Notification is unregistered successfully.
EFI_INVALID_PARAMETER	The Handle is invalid.
EFI_NOT_FOUND	The incoming notification handle does not exist in current hii database.

Definition at line 4324 of file Database.c.

◆ HiiUpdatePackageList()

EFI_STATUS EFIAPI HiiUpdatePackageList	(	IN CONST EFI_HII_DATABASE_PROTOCOL *	This,
		IN EFI_HII_HANDLE	Handle,
		IN CONST EFI_HII_PACKAGE_LIST_HEADER *	PackageList )

This function updates the existing package list (which has the specified Handle) in the HII databases, using the new package list specified by PackageList.

Parameters

This	A pointer to the EFI_HII_DATABASE_PROTOCOL instance.
Handle	The handle that was registered to the data that is requested to be updated.
PackageList	A pointer to an EFI_HII_PACKAGE_LIST_HEADER package.

Return values

EFI_SUCCESS	The HII database was successfully updated.
EFI_OUT_OF_RESOURCES	Unable to allocate enough memory for the updated database.
EFI_INVALID_PARAMETER	PackageList was NULL.
EFI_NOT_FOUND	The specified Handle is not in database.

Definition at line 3816 of file Database.c.

◆ InsertDevicePathPackage()

EFI_STATUS InsertDevicePathPackage	(	IN EFI_DEVICE_PATH_PROTOCOL *	DevicePath,
		IN EFI_HII_DATABASE_NOTIFY_TYPE	NotifyType,
		IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE *	PackageList )

This function insert a Device path package to a package list node. This is a internal function.

Parameters

DevicePath	Pointer to a EFI_DEVICE_PATH_PROTOCOL protocol instance
NotifyType	The type of change concerning the database.
PackageList	Pointer to a package list which will be inserted to.

Return values

EFI_SUCCESS	Device path Package is inserted successfully.
EFI_OUT_OF_RESOURCES	Unable to allocate necessary resources for the new Device path package.
EFI_INVALID_PARAMETER	DevicePath is NULL or PackageList is NULL.

Definition at line 2532 of file Database.c.

◆ InsertFontPackage()

EFI_STATUS InsertFontPackage	(	IN HII_DATABASE_PRIVATE_DATA *	Private,
		IN VOID *	PackageHdr,
		IN EFI_HII_DATABASE_NOTIFY_TYPE	NotifyType,
		IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE *	PackageList,
		OUT HII_FONT_PACKAGE_INSTANCE **	Package )

This function insert a Font package to a package list node. This is a internal function.

Parameters

Private	Hii database private structure.
PackageHdr	Pointer to a buffer stored with Font package information.
NotifyType	The type of change concerning the database.
PackageList	Pointer to a package list which will be inserted to.
Package	Created Font package

Return values

EFI_SUCCESS	Font Package is inserted successfully.
EFI_OUT_OF_RESOURCES	Unable to allocate necessary resources for the new Font package.
EFI_INVALID_PARAMETER	PackageHdr is NULL or PackageList is NULL.
EFI_UNSUPPORTED	A font package with same EFI_FONT_INFO already exists in current hii database.

Definition at line 1722 of file Database.c.

◆ InsertFormPackage()

EFI_STATUS InsertFormPackage	(	IN VOID *	PackageHdr,
		IN EFI_HII_DATABASE_NOTIFY_TYPE	NotifyType,
		IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE *	PackageList,
		OUT HII_IFR_PACKAGE_INSTANCE **	Package )

This function insert a Form package to a package list node. This is a internal function.

Parameters

PackageHdr	Pointer to a buffer stored with Form package information.
NotifyType	The type of change concerning the database.
PackageList	Pointer to a package list which will be inserted to.
Package	Created Form package

Return values

EFI_SUCCESS	Form Package is inserted successfully.
EFI_OUT_OF_RESOURCES	Unable to allocate necessary resources for the new Form package.
EFI_INVALID_PARAMETER	PackageHdr is NULL or PackageList is NULL.

Definition at line 1116 of file Database.c.

◆ InsertGuidPackage()

EFI_STATUS InsertGuidPackage	(	IN VOID *	PackageHdr,
		IN EFI_HII_DATABASE_NOTIFY_TYPE	NotifyType,
		IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE *	PackageList,
		OUT HII_GUID_PACKAGE_INSTANCE **	Package )

This function insert a GUID package to a package list node. This is a internal function.

Parameters

PackageHdr	Pointer to a buffer stored with GUID package information.
NotifyType	The type of change concerning the database.
PackageList	Pointer to a package list which will be inserted to.
Package	Created GUID package

Return values

EFI_SUCCESS	Guid Package is inserted successfully.
EFI_OUT_OF_RESOURCES	Unable to allocate necessary resources for the new Guid package.
EFI_INVALID_PARAMETER	PackageHdr is NULL or PackageList is NULL.

Definition at line 374 of file Database.c.

◆ InsertImagePackage()

EFI_STATUS InsertImagePackage	(	IN VOID *	PackageHdr,
		IN EFI_HII_DATABASE_NOTIFY_TYPE	NotifyType,
		IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE *	PackageList,
		OUT HII_IMAGE_PACKAGE_INSTANCE **	Package )

This function insert a Image package to a package list node. This is a internal function.

Parameters

PackageHdr	Pointer to a buffer stored with Image package information.
NotifyType	The type of change concerning the database.
PackageList	Pointer to a package list which will be inserted to.
Package	Created Image package

Return values

EFI_SUCCESS	Image Package is inserted successfully.
EFI_OUT_OF_RESOURCES	Unable to allocate necessary resources for the new Image package.
EFI_INVALID_PARAMETER	PackageHdr is NULL or PackageList is NULL.

Definition at line 2049 of file Database.c.

◆ InsertKeyboardLayoutPackage()

EFI_STATUS InsertKeyboardLayoutPackage	(	IN VOID *	PackageHdr,
		IN EFI_HII_DATABASE_NOTIFY_TYPE	NotifyType,
		IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE *	PackageList,
		OUT HII_KEYBOARD_LAYOUT_PACKAGE_INSTANCE **	Package )

This function insert a Keyboard Layout package to a package list node. This is a internal function.

Parameters

PackageHdr	Pointer to a buffer stored with Keyboard Layout package information.
NotifyType	The type of change concerning the database.
PackageList	Pointer to a package list which will be inserted to.
Package	Created Keyboard Layout package

Return values

EFI_SUCCESS	Keyboard Layout Package is inserted successfully.
EFI_OUT_OF_RESOURCES	Unable to allocate necessary resources for the new Keyboard Layout package.
EFI_INVALID_PARAMETER	PackageHdr is NULL or PackageList is NULL.

Definition at line 2774 of file Database.c.

◆ InsertSimpleFontPackage()

EFI_STATUS InsertSimpleFontPackage	(	IN VOID *	PackageHdr,
		IN EFI_HII_DATABASE_NOTIFY_TYPE	NotifyType,
		IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE *	PackageList,
		OUT HII_SIMPLE_FONT_PACKAGE_INSTANCE **	Package )

This function insert a Simple Font package to a package list node. This is a internal function.

Parameters

PackageHdr	Pointer to a buffer stored with Simple Font package information.
NotifyType	The type of change concerning the database.
PackageList	Pointer to a package list which will be inserted to.
Package	Created Simple Font package

Return values

EFI_SUCCESS	Simple Font Package is inserted successfully.
EFI_OUT_OF_RESOURCES	Unable to allocate necessary resources for the new Simple Font package.
EFI_INVALID_PARAMETER	PackageHdr is NULL or PackageList is NULL.

Definition at line 2325 of file Database.c.

◆ InsertStringPackage()

EFI_STATUS InsertStringPackage	(	IN HII_DATABASE_PRIVATE_DATA *	Private,
		IN VOID *	PackageHdr,
		IN EFI_HII_DATABASE_NOTIFY_TYPE	NotifyType,
		IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE *	PackageList,
		OUT HII_STRING_PACKAGE_INSTANCE **	Package )

This function insert a String package to a package list node. This is a internal function.

Parameters

Private	Hii database private structure.
PackageHdr	Pointer to a buffer stored with String package information.
NotifyType	The type of change concerning the database.
PackageList	Pointer to a package list which will be inserted to.
Package	Created String package

Return values

EFI_SUCCESS	String Package is inserted successfully.
EFI_OUT_OF_RESOURCES	Unable to allocate necessary resources for the new String package.
EFI_INVALID_PARAMETER	PackageHdr is NULL or PackageList is NULL.
EFI_UNSUPPORTED	A string package with the same language already exists in current package list.

Definition at line 1345 of file Database.c.

◆ InvokeRegisteredFunction()

EFI_STATUS InvokeRegisteredFunction	(	IN HII_DATABASE_PRIVATE_DATA *	Private,
		IN EFI_HII_DATABASE_NOTIFY_TYPE	NotifyType,
		IN VOID *	PackageInstance,
		IN UINT8	PackageType,
		IN EFI_HII_HANDLE	Handle )

This function invokes the matching registered function. This is a internal function.

Parameters

Private	HII Database driver private structure.
NotifyType	The type of change concerning the database.
PackageInstance	Points to the package referred to by the notification.
PackageType	Package type
Handle	The handle of the package list which contains the specified package.

Return values

EFI_SUCCESS	Already checked all registered function and invoked if matched.
EFI_INVALID_PARAMETER	Any input parameter is not valid.

Definition at line 160 of file Database.c.

◆ IsEfiVarStoreQuestion()

UINTN IsEfiVarStoreQuestion	(	EFI_IFR_QUESTION_HEADER *	IfrQuestionHdr,
		EFI_IFR_VARSTORE_EFI **	EfiVarStoreList,
		UINTN	EfiVarStoreNumber )

Check the input question related to EFI variable

Parameters

IfrQuestionHdr	Point to Question header
EfiVarStoreList	Point to EFI VarStore List
EfiVarStoreNumber	The number of EFI VarStore

Return values

Index The index of the found EFI varstore in EFI varstore list EfiVarStoreNumber will return if no EFI varstore is found.

Definition at line 550 of file Database.c.

◆ IsHiiHandleValid()

BOOLEAN IsHiiHandleValid ( EFI_HII_HANDLE Handle )

This function checks whether a handle is a valid EFI_HII_HANDLE This is a internal function.

Parameters

Handle Pointer to a EFI_HII_HANDLE

Return values

TRUE	Valid
FALSE	Invalid

Definition at line 123 of file Database.c.

◆ RemoveDevicePathPackage()

EFI_STATUS RemoveDevicePathPackage	(	IN HII_DATABASE_PRIVATE_DATA *	Private,
		IN EFI_HII_HANDLE	Handle,
		IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE *	PackageList )

This function deletes Device Path package from a package list node. This is a internal function.

Parameters

Private	Hii database private data.
Handle	Handle of the package list.
PackageList	Package List which contains the to be removed Device Path package.

Return values

EFI_SUCCESS	Device Path Package is deleted successfully.
EFI_INVALID_PARAMETER	Any input parameter is not valid.

Definition at line 2660 of file Database.c.

◆ RemoveFontPackages()

EFI_STATUS RemoveFontPackages	(	IN HII_DATABASE_PRIVATE_DATA *	Private,
		IN EFI_HII_HANDLE	Handle,
		IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE *	PackageList )

This function deletes all Font packages from a package list node. This is a internal function.

Parameters

Private	Hii database private data.
Handle	Handle of the package list which contains the to be removed Font packages.
PackageList	Pointer to a package list that contains removing packages.

Return values

EFI_SUCCESS	Font Package(s) is deleted successfully.
EFI_INVALID_PARAMETER	Any input parameter is not valid.

Definition at line 1957 of file Database.c.

◆ RemoveFormPackages()

EFI_STATUS RemoveFormPackages	(	IN HII_DATABASE_PRIVATE_DATA *	Private,
		IN EFI_HII_HANDLE	Handle,
		IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE *	PackageList )

This function deletes all Form packages from a package list node. This is a internal function.

Parameters

Private	Hii database private data.
Handle	Handle of the package list which contains the to be removed Form packages.
PackageList	Pointer to a package list that contains removing packages.

Return values

EFI_SUCCESS	Form Package(s) is deleted successfully.
EFI_INVALID_PARAMETER	Any input parameter is not valid.

Definition at line 1275 of file Database.c.

◆ RemoveGuidPackages()

EFI_STATUS RemoveGuidPackages	(	IN HII_DATABASE_PRIVATE_DATA *	Private,
		IN EFI_HII_HANDLE	Handle,
		IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE *	PackageList )

This function deletes all GUID packages from a package list node. This is a internal function.

Parameters

Private	Hii database private data.
Handle	Handle of the package list which contains the to be removed GUID packages.
PackageList	Pointer to a package list that contains removing packages.

Return values

EFI_SUCCESS	GUID Package(s) is deleted successfully.
EFI_INVALID_PARAMETER	Any input parameter is not valid.

Definition at line 498 of file Database.c.

◆ RemoveImagePackages()

EFI_STATUS RemoveImagePackages	(	IN HII_DATABASE_PRIVATE_DATA *	Private,
		IN EFI_HII_HANDLE	Handle,
		IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE *	PackageList )

This function deletes Image package from a package list node. This is a internal function.

Parameters

Private	Hii database private data.
Handle	Handle of the package list which contains the to be removed Image packages.
PackageList	Package List which contains the to be removed Image package.

Return values

EFI_SUCCESS	Image Package(s) is deleted successfully.
EFI_INVALID_PARAMETER	Any input parameter is not valid.

Definition at line 2264 of file Database.c.

◆ RemoveKeyboardLayoutPackages()

EFI_STATUS RemoveKeyboardLayoutPackages	(	IN HII_DATABASE_PRIVATE_DATA *	Private,
		IN EFI_HII_HANDLE	Handle,
		IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE *	PackageList )

This function deletes all Keyboard Layout packages from a package list node. This is a internal function.

Parameters

Private	Hii database private data.
Handle	Handle of the package list which contains the to be removed Keyboard Layout packages.
PackageList	Pointer to a package list that contains removing packages.

Return values

EFI_SUCCESS	Keyboard Layout Package(s) is deleted successfully.
EFI_INVALID_PARAMETER	Any input parameter is not valid.

Definition at line 2923 of file Database.c.

◆ RemoveSimpleFontPackages()

EFI_STATUS RemoveSimpleFontPackages	(	IN HII_DATABASE_PRIVATE_DATA *	Private,
		IN EFI_HII_HANDLE	Handle,
		IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE *	PackageList )

This function deletes all Simple Font packages from a package list node. This is a internal function.

Parameters

Private	Hii database private data.
Handle	Handle of the package list which contains the to be removed Simple Font packages.
PackageList	Pointer to a package list that contains removing packages.

Return values

EFI_SUCCESS	Simple Font Package(s) is deleted successfully.
EFI_INVALID_PARAMETER	Any input parameter is not valid.

Definition at line 2476 of file Database.c.

◆ RemoveStringPackages()

EFI_STATUS RemoveStringPackages	(	IN HII_DATABASE_PRIVATE_DATA *	Private,
		IN EFI_HII_HANDLE	Handle,
		IN OUT HII_DATABASE_PACKAGE_LIST_INSTANCE *	PackageList )

This function deletes all String packages from a package list node. This is a internal function.

Parameters

Private	Hii database private data.
Handle	Handle of the package list which contains the to be removed String packages.
PackageList	Pointer to a package list that contains removing packages.

Return values

EFI_SUCCESS	String Package(s) is deleted successfully.
EFI_INVALID_PARAMETER	Any input parameter is not valid.

Definition at line 1646 of file Database.c.

◆ UpdateDefaultSettingInFormPackage()

VOID UpdateDefaultSettingInFormPackage ( HII_IFR_PACKAGE_INSTANCE * FormPackage )

Update IFR default setting in Form Package.

Parameters

FormPackage Form Package to be updated

Definition at line 800 of file Database.c.

Variable Documentation

◆ gConfigRespSize

UINTN gConfigRespSize = 0

Definition at line 16 of file Database.c.

◆ gDatabaseInfoSize

UINTN gDatabaseInfoSize = 0

Definition at line 15 of file Database.c.

◆ gExportConfigResp

BOOLEAN gExportConfigResp = FALSE

Definition at line 17 of file Database.c.

◆ gNvDefaultStoreSize

UINTN gNvDefaultStoreSize = 0

Definition at line 18 of file Database.c.

◆ gRTConfigRespBuffer

EFI_STRING gRTConfigRespBuffer = NULL

Definition at line 14 of file Database.c.

◆ gRTDatabaseInfoBuffer

EFI_HII_PACKAGE_LIST_HEADER* gRTDatabaseInfoBuffer = NULL

Definition at line 13 of file Database.c.

◆ gSkuId

SKU_ID gSkuId = 0xFFFFFFFFFFFFFFFF

Definition at line 19 of file Database.c.

◆ gVarStorageList

LIST_ENTRY gVarStorageList = INITIALIZE_LIST_HEAD_VARIABLE (gVarStorageList)

Definition at line 20 of file Database.c.

◆ mHiiDatabaseLock

EFI_LOCK mHiiDatabaseLock = EFI_INITIALIZE_LOCK_VARIABLE (TPL_NOTIFY)

Definition at line 25 of file Database.c.

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ BASE_NUMBER

Function Documentation

◆ AddDevicePathPackage()

◆ AddPackages()

◆ AdjustStringPackage()

◆ ExportDevicePathPackage()

◆ ExportFontPackages()

◆ ExportFormPackages()

◆ ExportGuidPackages()

◆ ExportImagePackages()

◆ ExportKeyboardLayoutPackages()

◆ ExportPackageList()

◆ ExportSimpleFontPackages()

◆ ExportStringPackages()

◆ FindQuestionDefaultSetting()

◆ FindVariableData()

◆ GenerateHiiDatabaseRecord()

◆ HiiExportPackageLists()

◆ HiiFindKeyboardLayouts()

◆ HiiGetConfigRespInfo()

◆ HiiGetDatabaseInfo()

◆ HiiGetKeyboardLayout()

◆ HiiGetPackageListHandle()

◆ HiiListPackageLists()

◆ HiiNewPackageList()

◆ HiiRegisterPackageNotify()

◆ HiiRemovePackageList()

◆ HiiSetKeyboardLayout()

◆ HiiUnregisterPackageNotify()

◆ HiiUpdatePackageList()

◆ InsertDevicePathPackage()

◆ InsertFontPackage()

◆ InsertFormPackage()

◆ InsertGuidPackage()

◆ InsertImagePackage()

◆ InsertKeyboardLayoutPackage()

◆ InsertSimpleFontPackage()

◆ InsertStringPackage()

◆ InvokeRegisteredFunction()

◆ IsEfiVarStoreQuestion()

◆ IsHiiHandleValid()

◆ RemoveDevicePathPackage()

◆ RemoveFontPackages()

◆ RemoveFormPackages()

◆ RemoveGuidPackages()

◆ RemoveImagePackages()

◆ RemoveKeyboardLayoutPackages()

◆ RemoveSimpleFontPackages()

◆ RemoveStringPackages()

◆ UpdateDefaultSettingInFormPackage()

Variable Documentation

◆ gConfigRespSize

◆ gDatabaseInfoSize

◆ gExportConfigResp

◆ gNvDefaultStoreSize

◆ gRTConfigRespBuffer

◆ gRTDatabaseInfoBuffer

◆ gSkuId

◆ gVarStorageList

◆ mHiiDatabaseLock