OvmfPkg: PlatformDxe: add an empty HII form

... which opens from the Device Manager window.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
Reviewed-by: Jordan Justen <jordan.l.justen@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15367 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
Laszlo Ersek
2014-03-22 07:13:18 +00:00
committed by jljusten
parent bdaf30e4e6
commit 877a4dbb02
5 changed files with 236 additions and 0 deletions

View File

@@ -15,10 +15,128 @@
**/
#include <Library/DebugLib.h>
#include <Library/DevicePathLib.h>
#include <Library/HiiLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Protocol/DevicePath.h>
#include <Protocol/HiiConfigAccess.h>
#include "PlatformConfig.h"
//
// The HiiAddPackages() library function requires that any controller (or
// image) handle, to be associated with the HII packages under installation, be
// "decorated" with a device path. The tradition seems to be a vendor device
// path.
//
// We'd like to associate our HII packages with the driver's image handle. The
// first idea is to use the driver image's device path. Unfortunately, loaded
// images only come with an EFI_LOADED_IMAGE_DEVICE_PATH_PROTOCOL (not the
// usual EFI_DEVICE_PATH_PROTOCOL), ie. a different GUID. In addition, even the
// EFI_LOADED_IMAGE_DEVICE_PATH_PROTOCOL interface may be NULL, if the image
// has been loaded from an "unnamed" memory source buffer.
//
// Hence let's just stick with the tradition -- use a dedicated vendor device
// path, with the driver's FILE_GUID.
//
#pragma pack(1)
typedef struct {
VENDOR_DEVICE_PATH VendorDevicePath;
EFI_DEVICE_PATH_PROTOCOL End;
} PKG_DEVICE_PATH;
#pragma pack()
STATIC PKG_DEVICE_PATH mPkgDevicePath = {
{
{
HARDWARE_DEVICE_PATH,
HW_VENDOR_DP,
{
(UINT8) (sizeof (VENDOR_DEVICE_PATH) ),
(UINT8) (sizeof (VENDOR_DEVICE_PATH) >> 8)
}
},
EFI_CALLER_ID_GUID
},
{
END_DEVICE_PATH_TYPE,
END_ENTIRE_DEVICE_PATH_SUBTYPE,
{
(UINT8) (END_DEVICE_PATH_LENGTH ),
(UINT8) (END_DEVICE_PATH_LENGTH >> 8)
}
}
};
//
// The configuration interface between the HII engine (form display etc) and
// this driver.
//
STATIC EFI_HII_CONFIG_ACCESS_PROTOCOL mConfigAccess;
//
// The handle representing our list of packages after installation.
//
STATIC EFI_HII_HANDLE mInstalledPackages;
//
// The arrays below constitute our HII package list. They are auto-generated by
// the VFR compiler and linked into the driver image during the build.
//
// - The strings package receives its C identifier from the driver's BASE_NAME,
// plus "Strings".
//
// - The forms package receives its C identifier from the VFR file's basename,
// plus "Bin".
//
//
extern UINT8 PlatformDxeStrings[];
extern UINT8 PlatformFormsBin[];
STATIC
EFI_STATUS
EFIAPI
ExtractConfig (
IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,
IN CONST EFI_STRING Request,
OUT EFI_STRING *Progress,
OUT EFI_STRING *Results
)
{
return EFI_SUCCESS;
}
STATIC
EFI_STATUS
EFIAPI
RouteConfig (
IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,
IN CONST EFI_STRING Configuration,
OUT EFI_STRING *Progress
)
{
return EFI_SUCCESS;
}
STATIC
EFI_STATUS
EFIAPI
Callback (
IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,
IN EFI_BROWSER_ACTION Action,
IN EFI_QUESTION_ID QuestionId,
IN UINT8 Type,
IN OUT EFI_IFR_TYPE_VALUE *Value,
OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest
)
{
return EFI_SUCCESS;
}
/**
Load and execute the platform configuration.
@@ -64,6 +182,8 @@ ExecutePlatformConfig (
@param[in] SystemTable Pointer to SystemTable.
@retval EFI_SUCESS Driver has loaded successfully.
@retval EFI_OUT_OF_RESOURCES Failed to install HII packages.
@return Error codes from lower level functions.
**/
EFI_STATUS
@@ -73,8 +193,48 @@ PlatformInit (
IN EFI_SYSTEM_TABLE *SystemTable
)
{
EFI_STATUS Status;
ExecutePlatformConfig ();
mConfigAccess.ExtractConfig = &ExtractConfig;
mConfigAccess.RouteConfig = &RouteConfig;
mConfigAccess.Callback = &Callback;
//
// Declare ourselves suitable for HII communication.
//
Status = gBS->InstallMultipleProtocolInterfaces (&ImageHandle,
&gEfiDevicePathProtocolGuid, &mPkgDevicePath,
&gEfiHiiConfigAccessProtocolGuid, &mConfigAccess,
NULL);
if (EFI_ERROR (Status)) {
return Status;
}
//
// Publish the HII package list to HII Database.
//
mInstalledPackages = HiiAddPackages (
&gEfiCallerIdGuid, // PackageListGuid
ImageHandle, // associated DeviceHandle
PlatformDxeStrings, // 1st package
PlatformFormsBin, // 2nd package
NULL // terminator
);
if (mInstalledPackages == NULL) {
Status = EFI_OUT_OF_RESOURCES;
goto UninstallProtocols;
}
return EFI_SUCCESS;
UninstallProtocols:
gBS->UninstallMultipleProtocolInterfaces (ImageHandle,
&gEfiDevicePathProtocolGuid, &mPkgDevicePath,
&gEfiHiiConfigAccessProtocolGuid, &mConfigAccess,
NULL);
return Status;
}
/**
@@ -90,5 +250,10 @@ PlatformUnload (
IN EFI_HANDLE ImageHandle
)
{
HiiRemovePackages (mInstalledPackages);
gBS->UninstallMultipleProtocolInterfaces (ImageHandle,
&gEfiDevicePathProtocolGuid, &mPkgDevicePath,
&gEfiHiiConfigAccessProtocolGuid, &mConfigAccess,
NULL);
return EFI_SUCCESS;
}