Skip to content

MsvmPkg: unify UEFI parameter configuration handoff #93

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Jiong Wang (Arm Ltd) (jiong-microsoft) wants to merge 1 commit into
base: main
Choose a base branch
from
Open

MsvmPkg: unify UEFI parameter configuration handoff #93

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions MsvmPkg/Include/Ppi/ParameterConfig.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
/** @file
SEC parameter configuration PPI definition.

This PPI carries the optional parameter configuration header supplied in
the initial VP context from SEC to PEI.

Copyright (c) Microsoft Corporation.
SPDX-License-Identifier: BSD-2-Clause-Patent

**/

#ifndef PARAMETER_CONFIG_H_
#define PARAMETER_CONFIG_H_

///
/// PPI carrying an optional parameter configuration header from SEC to PEI.
/// A NULL header means that the legacy UEFI configuration blob is in use.
///
typedef struct {
VOID *ParameterConfigHeader;
} MSVM_PARAMETER_CONFIG_PPI;

extern EFI_GUID gMsvmParameterConfigPpiGuid;

#endif // PARAMETER_CONFIG_H_
1 change: 1 addition & 0 deletions MsvmPkg/MsvmPkg.dec
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@

[Ppis]
gMsvmSecPlatformTypePpiGuid = {0x7a3b9e2c, 0x4d15, 0x4f8a, {0xb1, 0x0e, 0x3c, 0x5d, 0x8f, 0x2a, 0x6b, 0x47}}
gMsvmParameterConfigPpiGuid = {0x81b465f3, 0xa0f3, 0x46d2, {0x9e, 0xeb, 0x3b, 0x5b, 0x94, 0x6b, 0x95, 0x52}}

[Protocols]
gMsvmAziHsmProtocolGuid = {0x38976D4E, 0x7454, 0x40CF, {0x9E, 0x12, 0x95, 0xCE, 0x61, 0xA4, 0xCD, 0x6C}}
Expand Down
46 changes: 36 additions & 10 deletions MsvmPkg/PlatformPei/Config.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
#include <Library/IoLib.h>
#include <Library/PeiServicesLib.h>
#include <Library/ResourcePublicationLib.h>
#include <Ppi/ParameterConfig.h>
#include <IsolationTypes.h>
#include "Hv.h"
#include "Config.h"
Expand Down Expand Up @@ -1706,17 +1707,42 @@ Return Value:
n/a

--*/
{
EFI_STATUS status;

//
// If this is a hardware-isolated VM running without a paravisor, then no
// config blob is present. Instead, the parameters were inserted in IGVM
// format and must be parsed as such.
{
BOOLEAN hardwareIsolatedNoParavisor;
VOID *parameterConfigHeader;
MSVM_PARAMETER_CONFIG_PPI *parameterConfigPpi;
EFI_STATUS status;

hardwareIsolatedNoParavisor = IsHardwareIsolatedNoParavisor();

//
// Older isolated images use the parameter format at the historical fixed
// address without providing an explicit pointer in their initial context.
//
parameterConfigHeader = hardwareIsolatedNoParavisor
? GetStartOfConfigBlob()
: NULL;

//
// SEC receives the parameter configuration address in the architecture's
// initial VP context and publishes it through this PPI.
//
if (IsHardwareIsolatedNoParavisor())
{
status = GetIgvmConfigInfo();
status = PeiServicesLocatePpi(
&gMsvmParameterConfigPpiGuid,
0,
NULL,
(VOID **)&parameterConfigPpi);
if (!EFI_ERROR(status) &&
(parameterConfigPpi->ParameterConfigHeader != NULL))
{
parameterConfigHeader = parameterConfigPpi->ParameterConfigHeader;
}

if (parameterConfigHeader != NULL)
{
status = GetIgvmConfigInfo(
parameterConfigHeader,
hardwareIsolatedNoParavisor);
}
else
{
Expand Down
3 changes: 2 additions & 1 deletion MsvmPkg/PlatformPei/Config.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ GetConfiguration(

EFI_STATUS
GetIgvmConfigInfo(
VOID
IN VOID *ParameterConfigHeader,
IN BOOLEAN HardwareIsolatedNoParavisor
);

VOID
Expand Down
43 changes: 34 additions & 9 deletions MsvmPkg/PlatformPei/IgvmConfig.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,9 +365,10 @@ Return Value:
}


EFI_STATUS
GetIgvmConfigInfo(
VOID
EFI_STATUS
GetIgvmConfigInfo(
IN VOID *ParameterConfigHeader,
IN BOOLEAN HardwareIsolatedNoParavisor
)
/*++

Expand All @@ -377,7 +378,10 @@ Routine Description:

Arguments:

None.
ParameterConfigHeader - Supplies the parameter area base.

HardwareIsolatedNoParavisor - Supplies whether the VM is hardware
isolated without a paravisor.

Return Value:

Expand All @@ -398,7 +402,12 @@ Return Value:
// area.
//

parameterInfo = (UEFI_IGVM_PARAMETER_INFO *)GetStartOfConfigBlob();
if (ParameterConfigHeader == NULL)
{
return EFI_INVALID_PARAMETER;
}

parameterInfo = (UEFI_IGVM_PARAMETER_INFO *)ParameterConfigHeader;

//
// Capture the total size of config information.
Expand Down Expand Up @@ -515,10 +524,26 @@ Return Value:
//

ZeroMem(&configFlags, sizeof(configFlags));
configFlags.Flags.MeasureAdditionalPcrs = 1;
configFlags.Flags.DefaultBootAlwaysAttempt = 1;
configFlags.Flags.VpciBootEnabled = 1;
configFlags.Flags.MemoryProtectionMode = ConfigLibMemoryProtectionModeDefault;
if (HardwareIsolatedNoParavisor)
{
configFlags.Flags.MeasureAdditionalPcrs = 1;
configFlags.Flags.DefaultBootAlwaysAttempt = 1;
configFlags.Flags.VpciBootEnabled = 1;
configFlags.Flags.MemoryProtectionMode = ConfigLibMemoryProtectionModeDefault;
}
else
{
//
// Match the legacy OpenVMM defaults for a directly launched UEFI VM.
// Isolated guests retain the existing IGVM defaults above.
//
configFlags.Flags.SerialControllersEnabled = 1;
configFlags.Flags.HibernateEnabled = 1;

@mebersol Mike Ebersol (mebersol) Jul 21, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

configFlags.Flags.HibernateEnabled = 1;

we should reason through these

@jiong-microsoft Jiong Wang (Arm Ltd) (jiong-microsoft) Jul 24, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I used Codex to analyze and generate the default setting here. Codex derived them from the legacy direct-UEFI blob builder plus the Petri test configuration

@mebersol Mike Ebersol (mebersol) Aug 25, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if we can have these hardcoded and expect to support some generic scenario. If we want to support this more generically, shouldn't want find and parse the config page?

configFlags.Flags.ConsoleMode = ConfigLibConsoleModeCOM1;
configFlags.Flags.MemoryProtectionMode = ConfigLibMemoryProtectionModeDisabled;
configFlags.Flags.MtrrsInitializedAtLoad = 1;
configFlags.Flags.PciResourcesPreAssigned = 1;
}

ConfigSetUefiConfigFlags(&configFlags);

Expand Down
1 change: 1 addition & 0 deletions MsvmPkg/PlatformPei/PlatformPei.inf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,7 @@

[Ppis]
gEfiPeiMasterBootModePpiGuid
gMsvmParameterConfigPpiGuid ## CONSUMES

[Ppis.AARCH64]
gMsvmSecPlatformTypePpiGuid ## CONSUMES
Expand Down
3 changes: 2 additions & 1 deletion MsvmPkg/Sec/AArch64/SecEntry.S
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,13 @@ ASM_FUNC(_ModuleEntryPoint)
// x0 - Firmware Volume Base Address
// x1 - Stack Base Address
// x2 - Platform Type (MSVM_SEC_PLATFORM_TYPE; 0 = HyperV, 1 = Generic)
// x3 - Optional parameter configuration header

// bl SerialWriteBanner // print banner to COM2

mov sp, x1 // Establish stack - leave x1 as second arg to C code

bl SecStartupWithStack // jump to C code with 3 args (x0,x1,x2)
bl SecStartupWithStack // jump to C code with 4 args (x0,x1,x2,x3)

ASM_FUNC(HvInvokeDebugger)

Expand Down
22 changes: 18 additions & 4 deletions MsvmPkg/Sec/AArch64/SecMain.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
#include <Library/BaseMemoryLib.h>
#include <Library/ArmLib.h>
#include <Library/DebugAgentLib.h>
#include <Ppi/ParameterConfig.h>
#include <Ppi/TemporaryRamSupport.h>
#include <Ppi/SecPlatformType.h>

Expand Down Expand Up @@ -43,6 +44,8 @@ MSVM_SEC_PLATFORM_TYPE_PPI mSecPlatformTypePpi =
MsvmSecPlatformHyperV
};

MSVM_PARAMETER_CONFIG_PPI mParameterConfigPpi;

EFI_PEI_PPI_DESCRIPTOR mPrivateDispatchTable[] =
{
{
Expand All @@ -51,10 +54,15 @@ EFI_PEI_PPI_DESCRIPTOR mPrivateDispatchTable[] =
&mTemporaryRamSupportPpi
},
{
(EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
EFI_PEI_PPI_DESCRIPTOR_PPI,
&gMsvmSecPlatformTypePpiGuid,
&mSecPlatformTypePpi
},
{
(EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
&gMsvmParameterConfigPpiGuid,
&mParameterConfigPpi
},
};


Expand Down Expand Up @@ -121,7 +129,8 @@ EFIAPI
SecStartupWithStack (
IN EFI_FIRMWARE_VOLUME_HEADER *BootFv,
IN VOID *TopOfCurrentStack,
IN UINT64 PlatformType
IN UINT64 PlatformType,
IN OPTIONAL VOID *ParameterConfigHeader
)
/*++

Expand All @@ -139,6 +148,9 @@ Routine Description:
PlatformType - Platform type from the loader (MSVM_SEC_PLATFORM_TYPE).
0 = HyperV (default), 1 = Generic.

ParameterConfigHeader - Supplies the optional parameter configuration
header provided by the loader.

Return Value:

None.
Expand All @@ -152,11 +164,12 @@ Return Value:
DEBUG((DEBUG_VERBOSE, sequence));

DEBUG((DEBUG_VERBOSE,
">>> SecStartupWithStack @ %p (%p, %p, 0x%llx)\n",
">>> SecStartupWithStack @ %p (%p, %p, 0x%llx, %p)\n",
SecStartupWithStack,
BootFv,
TopOfCurrentStack,
PlatformType
PlatformType,
ParameterConfigHeader
));

//
Expand All @@ -171,6 +184,7 @@ Return Value:
CpuDeadLoop();
}
mSecPlatformTypePpi.PlatformType = (MSVM_SEC_PLATFORM_TYPE)PlatformType;
mParameterConfigPpi.ParameterConfigHeader = ParameterConfigHeader;

//
// Initialize floating point operating environment
Expand Down
1 change: 1 addition & 0 deletions MsvmPkg/Sec/SecMain.inf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@

[Ppis]
gEfiTemporaryRamSupportPpiGuid # PPI ALWAYS_PRODUCED
gMsvmParameterConfigPpiGuid # PPI ALWAYS_PRODUCED

[Ppis.AARCH64]
gMsvmSecPlatformTypePpiGuid # PPI ALWAYS_PRODUCED
Expand Down
15 changes: 14 additions & 1 deletion MsvmPkg/Sec/X64/SecMain.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
#include <Library/PeCoffGetEntryPointLib.h>
#include <Library/PeCoffExtraActionLib.h>
#include <Ppi/TemporaryRamSupport.h>
#include <Ppi/ParameterConfig.h>
#include <BiosInterface.h>
#include <IsolationTypes.h>
#include "SecP.h"
Expand Down Expand Up @@ -48,13 +49,21 @@ EFI_PEI_TEMPORARY_RAM_SUPPORT_PPI mTemporaryRamSupportPpi =
};


MSVM_PARAMETER_CONFIG_PPI mParameterConfigPpi;


EFI_PEI_PPI_DESCRIPTOR mPrivateDispatchTable[] =
{
{
(EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
EFI_PEI_PPI_DESCRIPTOR_PPI,
&gEfiTemporaryRamSupportPpiGuid,
&mTemporaryRamSupportPpi
},
{
(EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
&gMsvmParameterConfigPpiGuid,
&mParameterConfigPpi
},
};

HV_HYPERVISOR_ISOLATION_CONFIGURATION mIsolationConfiguration;
Expand Down Expand Up @@ -1079,6 +1088,9 @@ Routine Description:
IsolationConfiguration - Supplies the isolation configuration of the
current partition.

UefiIgvmConfigHeader - Supplies the optional IGVM parameter configuration
header provided by the loader.

Return Value:

None.
Expand Down Expand Up @@ -1124,6 +1136,7 @@ Return Value:
//

mIsolationConfiguration = *IsolationConfiguration;
mParameterConfigPpi.ParameterConfigHeader = UefiIgvmConfigHeader;

Handler = 0;
Vector = 0;
Expand Down
Loading