tyler.durden/audk
1
0
Fork 0
mirror of https://github.com/acidanthera/audk.git synced 2025-04-07 19:45:07 +02:00
Code Issues Packages Projects Releases Wiki Activity

MdeModulePkg: Add BootDiscoveryPolicyUiLib.

Browse Source 
This library extends Boot Maintenance Menu and allows to select
Boot Discovery Policy. When choice is made BootDiscoveryPolicy
variable is set. Platform code can use this variable to decide
which class of device shall be connected.

Signed-off-by: Grzegorz Bernacki <gjb@semihalf.com>
Reviewed-by: Zhichao Gao <zhichao.gao@intel.com>
Reviewed-by: Sunny Wang <sunny.wang@arm.com>
This commit is contained in:
Grzegorz Bernacki 2021-08-02 20:18:35 +08:00 committed by mergify[bot]
parent 03e77558d4
commit 2b47aaecef
8 changed files with 336 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
MdeModulePkg/Include/Guid/BootDiscoveryPolicy.h Normal file
View File

@ -0,0 +1,22 @@
/** @file
Definition for structure & defines exported by Boot Discovery Policy UI
Copyright (c) 2021, ARM Ltd. All rights reserved.<BR>
Copyright (c) 2021, Semihalf All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef BOOT_DISCOVERY_POLICY_UI_LIB_H_
#define BOOT_DISCOVERY_POLICY_UI_LIB_H_
#define BDP_CONNECT_MINIMAL 0 /* Do not connect any additional devices */
#define BDP_CONNECT_NET 1
#define BDP_CONNECT_ALL 2
#define BOOT_DISCOVERY_POLICY_MGR_FORMSET_GUID { 0x5b6f7107, 0xbb3c, 0x4660, { 0x92, 0xcd, 0x54, 0x26, 0x90, 0x28, 0x0b, 0xbd } }
#define BOOT_DISCOVERY_POLICY_VAR L"BootDiscoveryPolicy"
#endif

160
MdeModulePkg/Library/BootDiscoveryPolicyUiLib/BootDiscoveryPolicyUiLib.c Normal file
View File

@ -0,0 +1,160 @@
/** @file
Boot Discovery Policy UI for Boot Maintenance menu.
Copyright (c) 2021, ARM Ltd. All rights reserved.<BR>
Copyright (c) 2021, Semihalf All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include <Guid/BootDiscoveryPolicy.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/BaseLib.h>
#include <Library/DevicePathLib.h>
#include <Library/DebugLib.h>
#include <Library/HiiLib.h>
#include <Library/UefiLib.h>
#include <Library/BaseMemoryLib.h>
#include <Include/Library/PcdLib.h>
///
/// HII specific Vendor Device Path definition.
///
typedef struct {
VENDOR_DEVICE_PATH VendorDevicePath;
EFI_DEVICE_PATH_PROTOCOL End;
} HII_VENDOR_DEVICE_PATH;
extern UINT8 BootDiscoveryPolicyUiLibVfrBin[];
EFI_HII_HANDLE mBPHiiHandle = NULL;
EFI_HANDLE mBPDriverHandle = NULL;
STATIC HII_VENDOR_DEVICE_PATH mVendorDevicePath = {
{
{
HARDWARE_DEVICE_PATH,
HW_VENDOR_DP,
{
(UINT8)(sizeof (VENDOR_DEVICE_PATH)),
(UINT8)((sizeof (VENDOR_DEVICE_PATH)) >> 8)
}
},
BOOT_DISCOVERY_POLICY_MGR_FORMSET_GUID
},
{
END_DEVICE_PATH_TYPE,
END_ENTIRE_DEVICE_PATH_SUBTYPE,
{
(UINT8)(END_DEVICE_PATH_LENGTH),
(UINT8)((END_DEVICE_PATH_LENGTH) >> 8)
}
}
};
/**
Initialize Boot Maintenance Menu library.
@param ImageHandle The image handle.
@param SystemTable The system table.
@retval EFI_SUCCESS Install Boot manager menu success.
@retval Other Return error status.gBPDisplayLibGuid
**/
EFI_STATUS
EFIAPI
BootDiscoveryPolicyUiLibConstructor (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
{
EFI_STATUS Status;
UINTN Size;
UINT32 BootDiscoveryPolicy;
Size = sizeof (UINT32);
Status = gRT->GetVariable (
BOOT_DISCOVERY_POLICY_VAR,
&gBootDiscoveryPolicyMgrFormsetGuid,
NULL,
&Size,
&BootDiscoveryPolicy
);
if (EFI_ERROR (Status)) {
Status = PcdSet32S (PcdBootDiscoveryPolicy, PcdGet32 (PcdBootDiscoveryPolicy));
ASSERT_EFI_ERROR (Status);
}
Status = gBS->InstallMultipleProtocolInterfaces (
&mBPDriverHandle,
&gEfiDevicePathProtocolGuid,
&mVendorDevicePath,
NULL
);
if (EFI_ERROR (Status)) {
return Status;
}
//
// Publish our HII data
//
mBPHiiHandle = HiiAddPackages (
&gBootDiscoveryPolicyMgrFormsetGuid,
mBPDriverHandle,
BootDiscoveryPolicyUiLibVfrBin,
BootDiscoveryPolicyUiLibStrings,
NULL
);
if (mBPHiiHandle == NULL) {
gBS->UninstallMultipleProtocolInterfaces (
mBPDriverHandle,
&gEfiDevicePathProtocolGuid,
&mVendorDevicePath,
NULL
);
return EFI_OUT_OF_RESOURCES;
}
return EFI_SUCCESS;
}
/**
Destructor of Boot Maintenance menu library.
@param ImageHandle The firmware allocated handle for the EFI image.
@param SystemTable A pointer to the EFI System Table.
@retval EFI_SUCCESS The destructor completed successfully.
@retval Other value The destructor did not complete successfully.
**/
EFI_STATUS
EFIAPI
BootDiscoveryPolicyUiLibDestructor (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
{
if (mBPDriverHandle != NULL) {
gBS->UninstallProtocolInterface (
mBPDriverHandle,
&gEfiDevicePathProtocolGuid,
&mVendorDevicePath
);
mBPDriverHandle = NULL;
}
if (mBPHiiHandle != NULL) {
HiiRemovePackages (mBPHiiHandle);
mBPHiiHandle = NULL;
}
return EFI_SUCCESS;
}

52
MdeModulePkg/Library/BootDiscoveryPolicyUiLib/BootDiscoveryPolicyUiLib.inf Normal file
View File

@ -0,0 +1,52 @@
## @file
# Library for BDS phase to use Boot Discovery Policy
#
# Copyright (c) 2021, ARM Ltd. All rights reserved.<BR>
# Copyright (c) 2021, Semihalf All rights reserved.<BR>
# SPDX-License-Identifier: BSD-2-Clause-Patent
#
##
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = BootDiscoveryPolicyUiLib
MODULE_UNI_FILE = BootDiscoveryPolicyUiLib.uni
FILE_GUID = BE73105A-B13D-4B57-A41A-463DBD15FE10
MODULE_TYPE = DXE_DRIVER
VERSION_STRING = 1.0
LIBRARY_CLASS = NULL|DXE_DRIVER UEFI_APPLICATION
CONSTRUCTOR = BootDiscoveryPolicyUiLibConstructor
DESTRUCTOR = BootDiscoveryPolicyUiLibDestructor
#
# The following information is for reference only and not required by the build tools.
#
# VALID_ARCHITECTURES = IA32 X64 AARCH64
#
[Sources]
BootDiscoveryPolicyUiLib.c
BootDiscoveryPolicyUiLibStrings.uni
BootDiscoveryPolicyUiLibVfr.Vfr
[Packages]
MdePkg/MdePkg.dec
MdeModulePkg/MdeModulePkg.dec
[LibraryClasses]
DevicePathLib
BaseLib
UefiRuntimeServicesTableLib
UefiBootServicesTableLib
DebugLib
HiiLib
UefiLib
BaseMemoryLib
[Guids]
gBootDiscoveryPolicyMgrFormsetGuid
[Pcd]
gEfiMdeModulePkgTokenSpaceGuid.PcdBootDiscoveryPolicy ## PRODUCES
[Depex]
gEfiHiiDatabaseProtocolGuid AND gPcdProtocolGuid

18
MdeModulePkg/Library/BootDiscoveryPolicyUiLib/BootDiscoveryPolicyUiLib.uni Normal file
View File

@ -0,0 +1,18 @@
// /** @file
// Boot Discovery Policy UI module.
//
// Copyright (c) 2021, ARM Ltd. All rights reserved.<BR>
// Copyright (c) 2021, Semihalf All rights reserved.<BR>
//
// SPDX-License-Identifier: BSD-2-Clause-Patent
//
// **/
#string STR_MODULE_ABSTRACT
#language en-US "Boot Discovery Policy UI module."
#string STR_MODULE_DESCRIPTION
#language en-US "Boot Discovery Policy UI module."

29
MdeModulePkg/Library/BootDiscoveryPolicyUiLib/BootDiscoveryPolicyUiLibStrings.uni Normal file
View File

@ -0,0 +1,29 @@
// *++
//
// Copyright (c) 2021, ARM Ltd. All rights reserved.<BR>
// Copyright (c) 2021, Semihalf All rights reserved.<BR>
// SPDX-License-Identifier: BSD-2-Clause-Patent
//
// Module Name:
//
// BootDiscoveryPolicyUiLibStrings.uni
//
// Abstract:
//
// String definitions for Boot Discovery Policy UI.
//
// --*/
/=#
#langdef en-US "English"
#string STR_FORM_BDP_MAIN_TITLE #language en-US "Boot Discovery Policy"
#string STR_FORM_BDP_CONN_MIN #language en-US "Minimal"
#string STR_FORM_BDP_CONN_NET #language en-US "Connect Network Devices"
#string STR_FORM_BDP_CONN_ALL #language en-US "Connect All Devices"

44
MdeModulePkg/Library/BootDiscoveryPolicyUiLib/BootDiscoveryPolicyUiLibVfr.Vfr Normal file
View File

@ -0,0 +1,44 @@
///** @file
//
// Formset for Boot Discovery Policy UI
//
// Copyright (c) 2021, ARM Ltd. All rights reserved.<BR>
// Copyright (c) 2021, Semihalf All rights reserved.<BR>
//
// SPDX-License-Identifier: BSD-2-Clause-Patent
//
//**/
#include <Uefi/UefiMultiPhase.h>
#include "Guid/BootDiscoveryPolicy.h"
#include <Guid/HiiBootMaintenanceFormset.h>
typedef struct {
UINT32 BootDiscoveryPolicy;
} BOOT_DISCOVERY_POLICY_VARSTORE_DATA;
formset
guid = BOOT_DISCOVERY_POLICY_MGR_FORMSET_GUID,
title = STRING_TOKEN(STR_FORM_BDP_MAIN_TITLE),
help = STRING_TOKEN(STR_FORM_BDP_MAIN_TITLE),
classguid = EFI_IFR_BOOT_MAINTENANCE_GUID,
efivarstore BOOT_DISCOVERY_POLICY_VARSTORE_DATA,
attribute = EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,
name = BootDiscoveryPolicy,
guid = BOOT_DISCOVERY_POLICY_MGR_FORMSET_GUID;
form formid = 0x0001,
title = STRING_TOKEN(STR_FORM_BDP_MAIN_TITLE);
oneof varid = BootDiscoveryPolicy.BootDiscoveryPolicy,
prompt = STRING_TOKEN(STR_FORM_BDP_MAIN_TITLE),
help = STRING_TOKEN(STR_FORM_BDP_MAIN_TITLE),
flags = NUMERIC_SIZE_4 | INTERACTIVE | RESET_REQUIRED,
option text = STRING_TOKEN(STR_FORM_BDP_CONN_MIN), value = BDP_CONNECT_MINIMAL, flags = DEFAULT;
option text = STRING_TOKEN(STR_FORM_BDP_CONN_NET), value = BDP_CONNECT_NET, flags = 0;
option text = STRING_TOKEN(STR_FORM_BDP_CONN_ALL), value = BDP_CONNECT_ALL, flags = 0;
endoneof;
endform;
endformset;

9
MdeModulePkg/MdeModulePkg.dec
View File

@ -425,6 +425,9 @@
## Include/UniversalPayload/SerialPortInfo.h
gUniversalPayloadSerialPortInfoGuid = { 0xaa7e190d, 0xbe21, 0x4409, { 0x8e, 0x67, 0xa2, 0xcd, 0xf, 0x61, 0xe1, 0x70 } }
## GUID used for Boot Discovery Policy FormSet guid and related variables.
gBootDiscoveryPolicyMgrFormsetGuid = { 0x5b6f7107, 0xbb3c, 0x4660, { 0x92, 0xcd, 0x54, 0x26, 0x90, 0x28, 0x0b, 0xbd } }
[Ppis]
## Include/Ppi/AtaController.h
gPeiAtaControllerPpiGuid = { 0xa45e60d1, 0xc719, 0x44aa, { 0xb0, 0x7a, 0xaa, 0x77, 0x7f, 0x85, 0x90, 0x6d }}
@ -1600,6 +1603,12 @@
# @Prompt Console Output Row of Text Setup
gEfiMdeModulePkgTokenSpaceGuid.PcdSetupConOutRow|25|UINT32|0x4000000e
## Specify the Boot Discovery Policy settings
# To support configuring from setup page, this PCD should be overridden in DynamicHii type in its platform .dsc:
# gEfiMdeModulePkgTokenSpaceGuid.PcdBootDiscoveryPolicy|L"BootDiscoveryPolicy"|gBootDiscoveryPolicyMgrFormsetGuid|0
# @Prompt Boot Discovery Policy
gEfiMdeModulePkgTokenSpaceGuid.PcdBootDiscoveryPolicy|2|UINT32|0x4000000f
[PcdsFixedAtBuild.AARCH64, PcdsPatchableInModule.AARCH64]
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiExposedTableVersions|0x20|UINT32|0x0001004c

2
MdeModulePkg/MdeModulePkg.dsc
View File

@ -220,6 +220,7 @@
MdeModulePkg/Logo/Logo.inf
MdeModulePkg/Logo/LogoDxe.inf
MdeModulePkg/Library/BaseSortLib/BaseSortLib.inf
MdeModulePkg/Library/BootDiscoveryPolicyUiLib/BootDiscoveryPolicyUiLib.inf
MdeModulePkg/Library/BootMaintenanceManagerUiLib/BootMaintenanceManagerUiLib.inf
MdeModulePkg/Library/BootManagerUiLib/BootManagerUiLib.inf
MdeModulePkg/Library/CustomizedDisplayLib/CustomizedDisplayLib.inf
@ -341,6 +342,7 @@
MdeModulePkg/Application/UiApp/UiApp.inf{
<LibraryClasses>
NULL|MdeModulePkg/Library/DeviceManagerUiLib/DeviceManagerUiLib.inf
NULL|MdeModulePkg/Library/BootDiscoveryPolicyUiLib/BootDiscoveryPolicyUiLib.inf
NULL|MdeModulePkg/Library/BootManagerUiLib/BootManagerUiLib.inf
NULL|MdeModulePkg/Library/BootMaintenanceManagerUiLib/BootMaintenanceManagerUiLib.inf
}