a0d74d006d
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@12932 6f19259b-4bc3-4df7-8a09-765794883524
544 lines
16 KiB
C
544 lines
16 KiB
C
/** @file
|
|
|
|
Copyright (c) 2010 - 2012, Intel Corporation. All rights reserved.<BR>
|
|
|
|
This program and the accompanying materials
|
|
are licensed and made available under the terms and conditions
|
|
of the BSD License which accompanies this distribution. The
|
|
full text of the license may be found at
|
|
http://opensource.org/licenses/bsd-license.php
|
|
|
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|
|
|
**/
|
|
|
|
#include <PiSmm.h>
|
|
#include <Library/SmmServicesTableLib.h>
|
|
#include <Library/BaseLib.h>
|
|
#include <Library/BaseMemoryLib.h>
|
|
#include <Library/LockBoxLib.h>
|
|
#include <Library/DebugLib.h>
|
|
#include <Guid/SmmLockBox.h>
|
|
|
|
#include "SmmLockBoxLibPrivate.h"
|
|
|
|
/**
|
|
We need handle this library carefully. Only one library instance will construct the environment.
|
|
Below 2 global variable can only be used in constructor. They should NOT be used in any other library functions.
|
|
**/
|
|
SMM_LOCK_BOX_CONTEXT mSmmLockBoxContext;
|
|
LIST_ENTRY mLockBoxQueue = INITIALIZE_LIST_HEAD_VARIABLE (mLockBoxQueue);
|
|
|
|
/**
|
|
This function return SmmLockBox context from SMST.
|
|
|
|
@return SmmLockBox context from SMST.
|
|
**/
|
|
SMM_LOCK_BOX_CONTEXT *
|
|
InternalGetSmmLockBoxContext (
|
|
VOID
|
|
)
|
|
{
|
|
UINTN Index;
|
|
|
|
//
|
|
// Check if gEfiSmmLockBoxCommunicationGuid is installed by someone
|
|
//
|
|
for (Index = 0; Index < gSmst->NumberOfTableEntries; Index++) {
|
|
if (CompareGuid (&gSmst->SmmConfigurationTable[Index].VendorGuid, &gEfiSmmLockBoxCommunicationGuid)) {
|
|
//
|
|
// Found. That means some other library instance is already run.
|
|
// No need to install again, just return.
|
|
//
|
|
return (SMM_LOCK_BOX_CONTEXT *)gSmst->SmmConfigurationTable[Index].VendorTable;
|
|
}
|
|
}
|
|
|
|
//
|
|
// Not found.
|
|
//
|
|
return NULL;
|
|
}
|
|
|
|
/**
|
|
Constructor for SmmLockBox library.
|
|
This is used to set SmmLockBox context, which will be used in PEI phase in S3 boot path later.
|
|
|
|
@param[in] ImageHandle Image handle of this driver.
|
|
@param[in] SystemTable A Pointer to the EFI System Table.
|
|
|
|
@retval EFI_SUCEESS
|
|
@return Others Some error occurs.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
SmmLockBoxSmmConstructuor (
|
|
IN EFI_HANDLE ImageHandle,
|
|
IN EFI_SYSTEM_TABLE *SystemTable
|
|
)
|
|
{
|
|
EFI_STATUS Status;
|
|
SMM_LOCK_BOX_CONTEXT *SmmLockBoxContext;
|
|
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SmmLockBoxSmmConstructuor - Enter\n"));
|
|
|
|
//
|
|
// Check if gEfiSmmLockBoxCommunicationGuid is installed by someone
|
|
//
|
|
SmmLockBoxContext = InternalGetSmmLockBoxContext ();
|
|
if (SmmLockBoxContext != NULL) {
|
|
//
|
|
// Find it. That means some other library instance is already run.
|
|
// No need to install again, just return.
|
|
//
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SmmLockBoxContext - already installed\n"));
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SmmLockBoxSmmConstructuor - Exit\n"));
|
|
return EFI_SUCCESS;
|
|
}
|
|
|
|
//
|
|
// If no one install this, it means this is first instance. Install it.
|
|
//
|
|
if (sizeof(UINTN) == sizeof(UINT64)) {
|
|
mSmmLockBoxContext.Signature = SMM_LOCK_BOX_SIGNATURE_64;
|
|
} else {
|
|
mSmmLockBoxContext.Signature = SMM_LOCK_BOX_SIGNATURE_32;
|
|
}
|
|
mSmmLockBoxContext.LockBoxDataAddress = (EFI_PHYSICAL_ADDRESS)(UINTN)&mLockBoxQueue;
|
|
|
|
Status = gSmst->SmmInstallConfigurationTable (
|
|
gSmst,
|
|
&gEfiSmmLockBoxCommunicationGuid,
|
|
&mSmmLockBoxContext,
|
|
sizeof(mSmmLockBoxContext)
|
|
);
|
|
ASSERT_EFI_ERROR (Status);
|
|
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SmmLockBoxContext - %x\n", (UINTN)&mSmmLockBoxContext));
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib LockBoxDataAddress - %x\n", (UINTN)&mLockBoxQueue));
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SmmLockBoxSmmConstructuor - Exit\n"));
|
|
|
|
return Status;
|
|
}
|
|
|
|
/**
|
|
This function return SmmLockBox queue address.
|
|
|
|
@return SmmLockBox queue address.
|
|
**/
|
|
LIST_ENTRY *
|
|
InternalGetLockBoxQueue (
|
|
VOID
|
|
)
|
|
{
|
|
SMM_LOCK_BOX_CONTEXT *SmmLockBoxContext;
|
|
|
|
SmmLockBoxContext = InternalGetSmmLockBoxContext ();
|
|
ASSERT (SmmLockBoxContext != NULL);
|
|
if (SmmLockBoxContext == NULL) {
|
|
return NULL;
|
|
}
|
|
return (LIST_ENTRY *)(UINTN)SmmLockBoxContext->LockBoxDataAddress;
|
|
}
|
|
|
|
/**
|
|
This function find LockBox by GUID.
|
|
|
|
@param Guid The guid to indentify the LockBox
|
|
|
|
@return LockBoxData
|
|
**/
|
|
SMM_LOCK_BOX_DATA *
|
|
InternalFindLockBoxByGuid (
|
|
IN EFI_GUID *Guid
|
|
)
|
|
{
|
|
LIST_ENTRY *Link;
|
|
SMM_LOCK_BOX_DATA *LockBox;
|
|
LIST_ENTRY *LockBoxQueue;
|
|
|
|
LockBoxQueue = InternalGetLockBoxQueue ();
|
|
ASSERT (LockBoxQueue != NULL);
|
|
|
|
for (Link = LockBoxQueue->ForwardLink;
|
|
Link != LockBoxQueue;
|
|
Link = Link->ForwardLink) {
|
|
LockBox = BASE_CR (
|
|
Link,
|
|
SMM_LOCK_BOX_DATA,
|
|
Link
|
|
);
|
|
if (CompareGuid (&LockBox->Guid, Guid)) {
|
|
return LockBox;
|
|
}
|
|
}
|
|
return NULL;
|
|
}
|
|
|
|
/**
|
|
This function will save confidential information to lockbox.
|
|
|
|
@param Guid the guid to identify the confidential information
|
|
@param Buffer the address of the confidential information
|
|
@param Length the length of the confidential information
|
|
|
|
@retval RETURN_SUCCESS the information is saved successfully.
|
|
@retval RETURN_INVALID_PARAMETER the Guid is NULL, or Buffer is NULL, or Length is 0
|
|
@retval RETURN_ALREADY_STARTED the requested GUID already exist.
|
|
@retval RETURN_OUT_OF_RESOURCES no enough resource to save the information.
|
|
@retval RETURN_ACCESS_DENIED it is too late to invoke this interface
|
|
@retval RETURN_NOT_STARTED it is too early to invoke this interface
|
|
@retval RETURN_UNSUPPORTED the service is not supported by implementaion.
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
SaveLockBox (
|
|
IN GUID *Guid,
|
|
IN VOID *Buffer,
|
|
IN UINTN Length
|
|
)
|
|
{
|
|
SMM_LOCK_BOX_DATA *LockBox;
|
|
EFI_PHYSICAL_ADDRESS SmramBuffer;
|
|
EFI_STATUS Status;
|
|
LIST_ENTRY *LockBoxQueue;
|
|
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SaveLockBox - Enter\n"));
|
|
|
|
//
|
|
// Basic check
|
|
//
|
|
if ((Guid == NULL) || (Buffer == NULL) || (Length == 0)) {
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SaveLockBox - Exit (%r)\n", EFI_INVALID_PARAMETER));
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
//
|
|
// Find LockBox
|
|
//
|
|
LockBox = InternalFindLockBoxByGuid (Guid);
|
|
if (LockBox != NULL) {
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SaveLockBox - Exit (%r)\n", EFI_ALREADY_STARTED));
|
|
return EFI_ALREADY_STARTED;
|
|
}
|
|
|
|
//
|
|
// Allocate SMRAM buffer
|
|
//
|
|
Status = gSmst->SmmAllocatePages (
|
|
AllocateAnyPages,
|
|
EfiRuntimeServicesData,
|
|
EFI_SIZE_TO_PAGES (Length),
|
|
&SmramBuffer
|
|
);
|
|
ASSERT_EFI_ERROR (Status);
|
|
if (EFI_ERROR (Status)) {
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SaveLockBox - Exit (%r)\n", EFI_OUT_OF_RESOURCES));
|
|
return EFI_OUT_OF_RESOURCES;
|
|
}
|
|
|
|
//
|
|
// Allocate LockBox
|
|
//
|
|
Status = gSmst->SmmAllocatePool (
|
|
EfiRuntimeServicesData,
|
|
sizeof(*LockBox),
|
|
(VOID **)&LockBox
|
|
);
|
|
ASSERT_EFI_ERROR (Status);
|
|
if (EFI_ERROR (Status)) {
|
|
gSmst->SmmFreePages (SmramBuffer, EFI_SIZE_TO_PAGES (Length));
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SaveLockBox - Exit (%r)\n", EFI_OUT_OF_RESOURCES));
|
|
return EFI_OUT_OF_RESOURCES;
|
|
}
|
|
|
|
//
|
|
// Save data
|
|
//
|
|
CopyMem ((VOID *)(UINTN)SmramBuffer, (VOID *)(UINTN)Buffer, Length);
|
|
|
|
//
|
|
// Insert LockBox to queue
|
|
//
|
|
LockBox->Signature = SMM_LOCK_BOX_DATA_SIGNATURE;
|
|
CopyMem (&LockBox->Guid, Guid, sizeof(EFI_GUID));
|
|
LockBox->Buffer = (EFI_PHYSICAL_ADDRESS)(UINTN)Buffer;
|
|
LockBox->Length = (UINT64)Length;
|
|
LockBox->Attributes = 0;
|
|
LockBox->SmramBuffer = SmramBuffer;
|
|
|
|
LockBoxQueue = InternalGetLockBoxQueue ();
|
|
ASSERT (LockBoxQueue != NULL);
|
|
InsertTailList (LockBoxQueue, &LockBox->Link);
|
|
|
|
//
|
|
// Done
|
|
//
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SaveLockBox - Exit (%r)\n", EFI_SUCCESS));
|
|
return EFI_SUCCESS;
|
|
}
|
|
|
|
/**
|
|
This function will set lockbox attributes.
|
|
|
|
@param Guid the guid to identify the confidential information
|
|
@param Attributes the attributes of the lockbox
|
|
|
|
@retval RETURN_SUCCESS the information is saved successfully.
|
|
@retval RETURN_INVALID_PARAMETER attributes is invalid.
|
|
@retval RETURN_NOT_FOUND the requested GUID not found.
|
|
@retval RETURN_ACCESS_DENIED it is too late to invoke this interface
|
|
@retval RETURN_NOT_STARTED it is too early to invoke this interface
|
|
@retval RETURN_UNSUPPORTED the service is not supported by implementaion.
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
SetLockBoxAttributes (
|
|
IN GUID *Guid,
|
|
IN UINT64 Attributes
|
|
)
|
|
{
|
|
SMM_LOCK_BOX_DATA *LockBox;
|
|
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SetLockBoxAttributes - Enter\n"));
|
|
|
|
//
|
|
// Basic check
|
|
//
|
|
if ((Guid == NULL) ||
|
|
((Attributes & ~LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE) != 0)) {
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SetLockBoxAttributes - Exit (%r)\n", EFI_INVALID_PARAMETER));
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
//
|
|
// Find LockBox
|
|
//
|
|
LockBox = InternalFindLockBoxByGuid (Guid);
|
|
if (LockBox == NULL) {
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SetLockBoxAttributes - Exit (%r)\n", EFI_NOT_FOUND));
|
|
return EFI_NOT_FOUND;
|
|
}
|
|
|
|
//
|
|
// Update data
|
|
//
|
|
LockBox->Attributes = Attributes;
|
|
|
|
//
|
|
// Done
|
|
//
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SetLockBoxAttributes - Exit (%r)\n", EFI_SUCCESS));
|
|
return EFI_SUCCESS;
|
|
}
|
|
|
|
/**
|
|
This function will update confidential information to lockbox.
|
|
|
|
@param Guid the guid to identify the original confidential information
|
|
@param Offset the offset of the original confidential information
|
|
@param Buffer the address of the updated confidential information
|
|
@param Length the length of the updated confidential information
|
|
|
|
@retval RETURN_SUCCESS the information is saved successfully.
|
|
@retval RETURN_INVALID_PARAMETER the Guid is NULL, or Buffer is NULL, or Length is 0.
|
|
@retval RETURN_NOT_FOUND the requested GUID not found.
|
|
@retval RETURN_BUFFER_TOO_SMALL the original buffer to too small to hold new information.
|
|
@retval RETURN_ACCESS_DENIED it is too late to invoke this interface
|
|
@retval RETURN_NOT_STARTED it is too early to invoke this interface
|
|
@retval RETURN_UNSUPPORTED the service is not supported by implementaion.
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
UpdateLockBox (
|
|
IN GUID *Guid,
|
|
IN UINTN Offset,
|
|
IN VOID *Buffer,
|
|
IN UINTN Length
|
|
)
|
|
{
|
|
SMM_LOCK_BOX_DATA *LockBox;
|
|
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib UpdateLockBox - Enter\n"));
|
|
|
|
//
|
|
// Basic check
|
|
//
|
|
if ((Guid == NULL) || (Buffer == NULL) || (Length == 0)) {
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib UpdateLockBox - Exit (%r)\n", EFI_INVALID_PARAMETER));
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
//
|
|
// Find LockBox
|
|
//
|
|
LockBox = InternalFindLockBoxByGuid (Guid);
|
|
if (LockBox == NULL) {
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib UpdateLockBox - Exit (%r)\n", EFI_NOT_FOUND));
|
|
return EFI_NOT_FOUND;
|
|
}
|
|
|
|
//
|
|
// Update data
|
|
//
|
|
if (LockBox->Length < Offset + Length) {
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib UpdateLockBox - Exit (%r)\n", EFI_BUFFER_TOO_SMALL));
|
|
return EFI_BUFFER_TOO_SMALL;
|
|
}
|
|
CopyMem ((VOID *)((UINTN)LockBox->SmramBuffer + Offset), Buffer, Length);
|
|
|
|
//
|
|
// Done
|
|
//
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib UpdateLockBox - Exit (%r)\n", EFI_SUCCESS));
|
|
return EFI_SUCCESS;
|
|
}
|
|
|
|
/**
|
|
This function will restore confidential information from lockbox.
|
|
|
|
@param Guid the guid to identify the confidential information
|
|
@param Buffer the address of the restored confidential information
|
|
NULL means restored to original address, Length MUST be NULL at same time.
|
|
@param Length the length of the restored confidential information
|
|
|
|
@retval RETURN_SUCCESS the information is restored successfully.
|
|
@retval RETURN_INVALID_PARAMETER the Guid is NULL, or one of Buffer and Length is NULL.
|
|
@retval RETURN_WRITE_PROTECTED Buffer and Length are NULL, but the LockBox has no
|
|
LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE attribute.
|
|
@retval RETURN_BUFFER_TOO_SMALL the Length is too small to hold the confidential information.
|
|
@retval RETURN_NOT_FOUND the requested GUID not found.
|
|
@retval RETURN_NOT_STARTED it is too early to invoke this interface
|
|
@retval RETURN_ACCESS_DENIED not allow to restore to the address
|
|
@retval RETURN_UNSUPPORTED the service is not supported by implementaion.
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
RestoreLockBox (
|
|
IN GUID *Guid,
|
|
IN VOID *Buffer, OPTIONAL
|
|
IN OUT UINTN *Length OPTIONAL
|
|
)
|
|
{
|
|
SMM_LOCK_BOX_DATA *LockBox;
|
|
VOID *RestoreBuffer;
|
|
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib RestoreLockBox - Enter\n"));
|
|
|
|
//
|
|
// Restore this, Buffer and Length MUST be both NULL or both non-NULL
|
|
//
|
|
if ((Guid == NULL) ||
|
|
((Buffer == NULL) && (Length != NULL)) ||
|
|
((Buffer != NULL) && (Length == NULL))) {
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib RestoreLockBox - Exit (%r)\n", EFI_INVALID_PARAMETER));
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
//
|
|
// Find LockBox
|
|
//
|
|
LockBox = InternalFindLockBoxByGuid (Guid);
|
|
if (LockBox == NULL) {
|
|
//
|
|
// Not found
|
|
//
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib RestoreLockBox - Exit (%r)\n", EFI_NOT_FOUND));
|
|
return EFI_NOT_FOUND;
|
|
}
|
|
|
|
//
|
|
// Set RestoreBuffer
|
|
//
|
|
if (Buffer != NULL) {
|
|
//
|
|
// restore to new buffer
|
|
//
|
|
RestoreBuffer = Buffer;
|
|
} else {
|
|
//
|
|
// restore to original buffer
|
|
//
|
|
if ((LockBox->Attributes & LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE) == 0) {
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib RestoreLockBox - Exit (%r)\n", EFI_WRITE_PROTECTED));
|
|
return EFI_WRITE_PROTECTED;
|
|
}
|
|
RestoreBuffer = (VOID *)(UINTN)LockBox->Buffer;
|
|
}
|
|
|
|
//
|
|
// Set RestoreLength
|
|
//
|
|
if (Length != NULL) {
|
|
if (*Length < (UINTN)LockBox->Length) {
|
|
//
|
|
// Input buffer is too small to hold all data.
|
|
//
|
|
*Length = (UINTN)LockBox->Length;
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib RestoreLockBox - Exit (%r)\n", EFI_BUFFER_TOO_SMALL));
|
|
return EFI_BUFFER_TOO_SMALL;
|
|
}
|
|
*Length = (UINTN)LockBox->Length;
|
|
}
|
|
|
|
//
|
|
// Restore data
|
|
//
|
|
CopyMem (RestoreBuffer, (VOID *)(UINTN)LockBox->SmramBuffer, (UINTN)LockBox->Length);
|
|
|
|
//
|
|
// Done
|
|
//
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib RestoreLockBox - Exit (%r)\n", EFI_SUCCESS));
|
|
return EFI_SUCCESS;
|
|
}
|
|
|
|
/**
|
|
This function will restore confidential information from all lockbox which have RestoreInPlace attribute.
|
|
|
|
@retval RETURN_SUCCESS the information is restored successfully.
|
|
@retval RETURN_NOT_STARTED it is too early to invoke this interface
|
|
@retval RETURN_UNSUPPORTED the service is not supported by implementaion.
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
RestoreAllLockBoxInPlace (
|
|
VOID
|
|
)
|
|
{
|
|
SMM_LOCK_BOX_DATA *LockBox;
|
|
LIST_ENTRY *Link;
|
|
LIST_ENTRY *LockBoxQueue;
|
|
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib RestoreAllLockBoxInPlace - Enter\n"));
|
|
|
|
LockBoxQueue = InternalGetLockBoxQueue ();
|
|
ASSERT (LockBoxQueue != NULL);
|
|
|
|
//
|
|
// Restore all, Buffer and Length MUST be NULL
|
|
//
|
|
for (Link = LockBoxQueue->ForwardLink;
|
|
Link != LockBoxQueue;
|
|
Link = Link->ForwardLink) {
|
|
LockBox = BASE_CR (
|
|
Link,
|
|
SMM_LOCK_BOX_DATA,
|
|
Link
|
|
);
|
|
if ((LockBox->Attributes & LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE) != 0) {
|
|
//
|
|
// Restore data
|
|
//
|
|
CopyMem ((VOID *)(UINTN)LockBox->Buffer, (VOID *)(UINTN)LockBox->SmramBuffer, (UINTN)LockBox->Length);
|
|
}
|
|
}
|
|
//
|
|
// Done
|
|
//
|
|
DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib RestoreAllLockBoxInPlace - Exit (%r)\n", EFI_SUCCESS));
|
|
return EFI_SUCCESS;
|
|
}
|
|
|