350 lines
11 KiB
C
350 lines
11 KiB
C
/** @file
|
|
This file is SampleCode for a DXE driver to allow for caching of HSTI
|
|
test results to eliminate the need for testing on every boot.
|
|
|
|
;******************************************************************************
|
|
;* Copyright (c) 2018 , Insyde Software Corporation. 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.
|
|
;*
|
|
;******************************************************************************
|
|
|
|
@copyright
|
|
INTEL CONFIDENTIAL
|
|
Copyright 2015 - 2017 Intel Corporation.
|
|
|
|
The source code contained or described herein and all documents related to the
|
|
source code ("Material") are owned by Intel Corporation or its suppliers or
|
|
licensors. Title to the Material remains with Intel Corporation or its suppliers
|
|
and licensors. The Material may contain trade secrets and proprietary and
|
|
confidential information of Intel Corporation and its suppliers and licensors,
|
|
and is protected by worldwide copyright and trade secret laws and treaty
|
|
provisions. No part of the Material may be used, copied, reproduced, modified,
|
|
published, uploaded, posted, transmitted, distributed, or disclosed in any way
|
|
without Intel's prior express written permission.
|
|
|
|
No license under any patent, copyright, trade secret or other intellectual
|
|
property right is granted to or conferred upon you by disclosure or delivery
|
|
of the Materials, either expressly, by implication, inducement, estoppel or
|
|
otherwise. Any license under such intellectual property rights must be
|
|
express and approved by Intel in writing.
|
|
|
|
Unless otherwise agreed by Intel in writing, you may not remove or alter
|
|
this notice or any other notice embedded in Materials by Intel or
|
|
Intel's suppliers or licensors in any way.
|
|
|
|
This file contains a 'Sample Driver' and is licensed as such under the terms
|
|
of your license agreement with Intel or your vendor. This file may be modified
|
|
by the user, subject to the additional terms of the license agreement.
|
|
|
|
@par Specification
|
|
**/
|
|
|
|
#include "HstiResultDxe.h"
|
|
|
|
DXE_SI_POLICY_PROTOCOL *mSiPolicyData;
|
|
CONFIGURATION_CHANGE mConfigChanged;
|
|
|
|
/**
|
|
Handler to Save HSTI results for publishing on subsequent boots
|
|
|
|
@param[in] Event Event whose notification function is being invoked
|
|
@param[in] Context Pointer to the notification function's context
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
SaveConfigurationChange (
|
|
EFI_EVENT Event,
|
|
VOID *Context
|
|
)
|
|
{
|
|
UINT32 VarAttributes;
|
|
UINTN VarSize;
|
|
CONFIGURATION_CHANGE ConfigChanged;
|
|
VOID *Interface;
|
|
EFI_STATUS Status;
|
|
|
|
//
|
|
// Check whether we are running for first time or actually when signaled
|
|
//
|
|
Status = gBS->LocateProtocol (&gPlatformConfigChangeProtocolGuid, NULL, &Interface);
|
|
if (EFI_ERROR (Status)) {
|
|
return;
|
|
}
|
|
|
|
ConfigChanged.ConfigChangeType = SETUP_OPTION_CHANGE;
|
|
VarSize = sizeof(CONFIGURATION_CHANGE);
|
|
VarAttributes = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS;
|
|
|
|
gRT->SetVariable (
|
|
PLATFORM_CONFIGURATION_CHANGE,
|
|
&gPlatformConfigChangeGuid,
|
|
VarAttributes,
|
|
VarSize,
|
|
&ConfigChanged
|
|
);
|
|
if (Event != NULL) {
|
|
gBS->CloseEvent (Event);
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
Handler to Save HSTI results for publishing on subsequent boots
|
|
|
|
@param[in] Event Event whose notification function is being invoked
|
|
@param[in] Context Pointer to the notification function's context
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
SaveResults (
|
|
EFI_EVENT Event,
|
|
VOID *Context
|
|
)
|
|
{
|
|
|
|
UINT32 VarAttributes;
|
|
UINTN VarSize;
|
|
EFI_STATUS Status;
|
|
VOID *Interface;
|
|
|
|
Status = EFI_SUCCESS;
|
|
|
|
//
|
|
// Check whether we are running for first time or actually when signaled
|
|
//
|
|
Status = gBS->LocateProtocol (&gHstiPublishCompleteProtocolGuid, NULL, &Interface);
|
|
if (EFI_ERROR (Status)) {
|
|
return;
|
|
}
|
|
|
|
if (mSiPolicyData->Hsti == NULL) {
|
|
return;
|
|
}
|
|
if(( mConfigChanged.ConfigChangeType != NO_CONFIG_CHANGE)){
|
|
|
|
VarAttributes = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS;
|
|
VarSize = mSiPolicyData->HstiSize;
|
|
|
|
gRT->SetVariable (
|
|
HSTI_STORAGE_NAME,
|
|
&gHstiStoredResultsGuid,
|
|
VarAttributes,
|
|
VarSize,
|
|
mSiPolicyData->Hsti
|
|
);
|
|
//
|
|
// Need to clear out the previous change so we can use cached results again
|
|
//
|
|
mConfigChanged.ConfigChangeType = NO_CONFIG_CHANGE;
|
|
VarSize = sizeof(CONFIGURATION_CHANGE);
|
|
VarAttributes = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS;
|
|
|
|
Status = gRT->SetVariable (
|
|
PLATFORM_CONFIGURATION_CHANGE,
|
|
&gPlatformConfigChangeGuid,
|
|
VarAttributes,
|
|
VarSize,
|
|
&mConfigChanged
|
|
);
|
|
}
|
|
if (Event != NULL) {
|
|
gBS->CloseEvent (Event);
|
|
}
|
|
}
|
|
|
|
//[-start-180724-IB11790262-add]//
|
|
/**
|
|
Handler to trigger HSTI result update when user attempt to enter SCU
|
|
|
|
@param[in] Event Event whose notification function is being invoked
|
|
@param[in] Context Pointer to the notification function's context
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
EnteringSetupUtility (
|
|
EFI_EVENT Event,
|
|
VOID *Context
|
|
)
|
|
{
|
|
EFI_STATUS Status;
|
|
EFI_SETUP_UTILITY_APPLICATION_PROTOCOL *SetupUtilityApp;
|
|
EFI_HANDLE Handle;
|
|
|
|
Status = EFI_SUCCESS;
|
|
Handle = NULL;
|
|
|
|
//
|
|
// Check whether we are running for first time or actually when signaled
|
|
//
|
|
Status = gBS->LocateProtocol (&gEfiSetupUtilityApplicationProtocolGuid, NULL, &SetupUtilityApp);
|
|
if (EFI_ERROR (Status)) {
|
|
return;
|
|
}
|
|
if (SetupUtilityApp->VfrDriverState == InitializeSetupUtility) {
|
|
gBS->InstallProtocolInterface (&Handle, &gPlatformConfigChangeProtocolGuid, EFI_NATIVE_INTERFACE, NULL);
|
|
|
|
if (Event != NULL) {
|
|
gBS->CloseEvent (Event);
|
|
}
|
|
}
|
|
}
|
|
//[-end-180724-IB11790262-add]//
|
|
|
|
/**
|
|
The driver's entry point.
|
|
|
|
@param[in] ImageHandle The firmware allocated handle for the EFI image.
|
|
@param[in] SystemTable A pointer to the EFI System Table.
|
|
|
|
@retval EFI_SUCCESS The entry point is executed successfully.
|
|
@retval other Some error occurs when executing this entry point.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
DriverEntryPoint (
|
|
IN EFI_HANDLE ImageHandle,
|
|
IN EFI_SYSTEM_TABLE *SystemTable
|
|
)
|
|
{
|
|
VOID *Registration;
|
|
EFI_STATUS Status;
|
|
UINT32 VarAttributes;
|
|
ADAPTER_INFO_PLATFORM_SECURITY *Hsti;
|
|
UINTN VarSize;
|
|
EDKII_VARIABLE_LOCK_PROTOCOL *VariableLockProtocol;
|
|
MEMORY_PLATFORM_DATA_HOB *MemoryPlatformData;
|
|
EFI_HOB_GUID_TYPE *GuidHob;
|
|
|
|
MemoryPlatformData = NULL;
|
|
Hsti = NULL;
|
|
ZeroMem(&mConfigChanged,sizeof(CONFIGURATION_CHANGE));
|
|
|
|
//
|
|
// Locate DxeSiPolicyProtocolGuid protocol instance and assign it to a global variable
|
|
//
|
|
Status = gBS->LocateProtocol (&gDxeSiPolicyProtocolGuid, NULL, (VOID **) &mSiPolicyData);
|
|
if (EFI_ERROR (Status)) {
|
|
DEBUG((EFI_D_ERROR,"Failed to locate DxeSiPolicyProtocolGuid Protocol\n"));
|
|
ASSERT_EFI_ERROR (Status);
|
|
return Status;
|
|
}
|
|
|
|
//
|
|
// Register protocol notification function for saving results
|
|
//
|
|
EfiCreateProtocolNotifyEvent (
|
|
&gHstiPublishCompleteProtocolGuid,
|
|
TPL_NOTIFY,
|
|
SaveResults,
|
|
NULL,
|
|
&Registration
|
|
);
|
|
|
|
//
|
|
// Register protocol notification function for saving configuration change
|
|
//
|
|
EfiCreateProtocolNotifyEvent (
|
|
&gPlatformConfigChangeProtocolGuid,
|
|
TPL_NOTIFY,
|
|
SaveConfigurationChange,
|
|
NULL,
|
|
&Registration
|
|
);
|
|
|
|
//[-start-180724-IB11790262-add]//
|
|
//
|
|
// Register protocol notification function to trigger SETUP_OPTION_CHANGE when user entering SCU
|
|
//
|
|
EfiCreateProtocolNotifyEvent (
|
|
&gEfiSetupUtilityApplicationProtocolGuid,
|
|
TPL_NOTIFY,
|
|
EnteringSetupUtility,
|
|
NULL,
|
|
&Registration
|
|
);
|
|
//[-end-180724-IB11790262-add]//
|
|
|
|
VarAttributes = 0;
|
|
VarSize = sizeof(CONFIGURATION_CHANGE);
|
|
Status = gRT->GetVariable (
|
|
PLATFORM_CONFIGURATION_CHANGE,
|
|
&gPlatformConfigChangeGuid,
|
|
&VarAttributes,
|
|
&VarSize,
|
|
&mConfigChanged
|
|
);
|
|
if (EFI_ERROR(Status)) {
|
|
mConfigChanged.ConfigChangeType = FIRST_BOOT;
|
|
}
|
|
|
|
VarAttributes = 0;
|
|
VarSize = 0;
|
|
Status = gRT->GetVariable (
|
|
HSTI_STORAGE_NAME,
|
|
&gHstiStoredResultsGuid,
|
|
&VarAttributes,
|
|
&VarSize,
|
|
Hsti
|
|
);
|
|
if (EFI_ERROR(Status)) {
|
|
Hsti = (ADAPTER_INFO_PLATFORM_SECURITY *) AllocatePool(VarSize + 1);
|
|
if (((UINTN) Hsti & BIT0) == 0){
|
|
Hsti = (ADAPTER_INFO_PLATFORM_SECURITY*)((UINT8 *) Hsti + 1);
|
|
}
|
|
|
|
Status = gRT->GetVariable (
|
|
HSTI_STORAGE_NAME,
|
|
&gHstiStoredResultsGuid,
|
|
&VarAttributes,
|
|
&VarSize,
|
|
Hsti
|
|
);
|
|
}
|
|
|
|
GuidHob = NULL;
|
|
MemoryPlatformData = NULL;
|
|
GuidHob = GetFirstGuidHob (&gSiMemoryPlatformDataGuid);
|
|
ASSERT (GuidHob != NULL);
|
|
if (GuidHob != NULL) {
|
|
MemoryPlatformData = (MEMORY_PLATFORM_DATA_HOB *) GET_GUID_HOB_DATA (GuidHob);
|
|
}
|
|
if (MemoryPlatformData != NULL) {
|
|
DEBUG ((EFI_D_INFO, "Hsti MrcBootMode = %x\n", MemoryPlatformData->Data.BootMode));
|
|
} else {
|
|
DEBUG ((EFI_D_ERROR, "Hsti get gSiMemoryPlatformDataGuid HOB fails\n"));
|
|
}
|
|
|
|
//
|
|
// Need to not use cached results if any setup option changed on previous boot or any major
|
|
// HW change happened that is significant enough to trigger MRC retraining
|
|
//
|
|
if(!EFI_ERROR (Status) &&
|
|
(mConfigChanged.ConfigChangeType == NO_CONFIG_CHANGE) &&
|
|
((MemoryPlatformData != NULL) && (MemoryPlatformData->Data.BootMode != bmCold))) {
|
|
mSiPolicyData->Hsti = Hsti;
|
|
mSiPolicyData->HstiSize = VarSize;
|
|
|
|
//
|
|
// Need to lock this variable to prevent changing cached results by some malicious software
|
|
//
|
|
Status = gBS->LocateProtocol (&gEdkiiVariableLockProtocolGuid, NULL, (VOID **)&VariableLockProtocol);
|
|
if (!EFI_ERROR (Status)) {
|
|
Status = VariableLockProtocol->RequestToLock (
|
|
VariableLockProtocol,
|
|
HSTI_STORAGE_NAME,
|
|
&gHstiStoredResultsGuid
|
|
);
|
|
if (EFI_ERROR (Status)) {
|
|
DEBUG ((EFI_D_ERROR, "HSTI cached results were unable to be locked: Status = %r\n", Status));
|
|
return Status;
|
|
}
|
|
}
|
|
}
|
|
return EFI_SUCCESS;
|
|
}
|