Initial import.

[mirror_edk2.git] / EdkModulePkg / Universal / MonotonicCounter / RuntimeDxe / MonotonicCounter.c

/*++\r
\r
Copyright (c) 2006, Intel Corporation                                                         \r
All rights reserved. This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
Module Name:\r
\r
  MonotonicCounter.c\r
\r
Abstract:\r
\r
  Produced the Monotonic Counter Services as defined in the DXE CIS\r
\r
Revision History:\r
\r
--*/\r
\r
#include "MonotonicCounter.h"\r
\r
//\r
// The Monotonic Counter Handle\r
//\r
EFI_HANDLE  mMonotonicCounterHandle = NULL;\r
\r
//\r
// The current Monotonic count value\r
//\r
UINT64      mEfiMtc;\r
\r
\r
//\r
// Event to use to update the Mtc's high part when wrapping\r
//\r
EFI_EVENT   mEfiMtcEvent;\r
\r
//\r
// EfiMtcName - Variable name of the MTC value\r
//\r
CHAR16      *mEfiMtcName = (CHAR16 *) L"MTC";\r
\r
//\r
// EfiMtcGuid - Guid of the MTC value\r
//\r
EFI_GUID    mEfiMtcGuid = { 0xeb704011, 0x1402, 0x11d3, { 0x8e, 0x77, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } };\r
\r
//\r
// Worker functions\r
//\r
EFI_STATUS\r
EFIAPI\r
MonotonicCounterDriverGetNextMonotonicCount (\r
  OUT UINT64  *Count\r
  )\r
/*++\r
\r
Routine Description:\r
\r
Arguments:\r
\r
Returns:\r
\r
--*/\r
{\r
  EFI_TPL OldTpl;\r
\r
  //\r
  // Can not be called after ExitBootServices()\r
  //\r
  if (EfiAtRuntime ()) {\r
    return EFI_UNSUPPORTED;\r
  }\r
  //\r
  // Check input parameters\r
  //\r
  if (Count == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  //\r
  // Update the monotonic counter with a lock\r
  //\r
  OldTpl  = gBS->RaiseTPL (EFI_TPL_HIGH_LEVEL);\r
  *Count  = mEfiMtc;\r
  mEfiMtc++;\r
  gBS->RestoreTPL (OldTpl);\r
\r
  //\r
  // If the MSB bit of the low part toggled, then signal that the high\r
  // part needs updated now\r
  //\r
  if ((((UINT32) mEfiMtc) ^ ((UINT32) *Count)) & 0x80000000) {\r
    gBS->SignalEvent (mEfiMtcEvent);\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
MonotonicCounterDriverGetNextHighMonotonicCount (\r
  OUT UINT32  *HighCount\r
  )\r
/*++\r
\r
Routine Description:\r
\r
Arguments:\r
\r
Returns:\r
\r
--*/\r
{\r
  EFI_STATUS  Status;\r
  EFI_TPL     OldTpl;\r
\r
  //\r
  // Check input parameters\r
  //\r
  if (HighCount == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (!EfiAtRuntime ()) {\r
    //\r
    // Use a lock if called before ExitBootServices()\r
    //\r
    OldTpl      = gBS->RaiseTPL (EFI_TPL_HIGH_LEVEL);\r
    *HighCount  = (UINT32) RShiftU64 (mEfiMtc, 32) + 1;\r
    mEfiMtc     = LShiftU64 (*HighCount, 32);\r
    gBS->RestoreTPL (OldTpl);\r
  } else {\r
    *HighCount  = (UINT32) RShiftU64 (mEfiMtc, 32) + 1;\r
    mEfiMtc     = LShiftU64 (*HighCount, 32);\r
  }\r
  //\r
  // Update the NvRam store to match the new high part\r
  //\r
  Status = gRT->SetVariable (\r
                  mEfiMtcName,\r
                  &mEfiMtcGuid,\r
                  EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
                  sizeof (UINT32),\r
                  HighCount\r
                  );\r
\r
  return Status;\r
}\r
\r
VOID\r
EFIAPI\r
EfiMtcEventHandler (\r
  IN EFI_EVENT                Event,\r
  IN VOID                     *Context\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Monotonic count event handler.  This handler updates the high monotonic count.\r
\r
Arguments:\r
\r
  Event         The event to handle\r
  Context       The event context\r
\r
Returns:\r
\r
  EFI_SUCCESS       The event has been handled properly \r
  EFI_NOT_FOUND     An error occurred updating the variable.\r
\r
--*/\r
{\r
  UINT32  HighCount;\r
\r
  MonotonicCounterDriverGetNextHighMonotonicCount (&HighCount);\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
MonotonicCounterDriverInitialize (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
/*++\r
\r
Routine Description:\r
\r
Arguments:\r
  (Standard EFI Image entry - EFI_IMAGE_ENTRY_POINT)\r
\r
Returns:\r
\r
--*/\r
{\r
  EFI_STATUS  Status;\r
  UINT32      HighCount;\r
  UINTN       BufferSize;\r
\r
  //\r
  // Make sure the Monotonic Counter Architectural Protocol is not already installed in the system\r
  //\r
  ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL, &gEfiMonotonicCounterArchProtocolGuid);\r
\r
  //\r
  // Initialize event to handle overflows\r
  //\r
  Status = gBS->CreateEvent (\r
                  EFI_EVENT_NOTIFY_SIGNAL,\r
                  EFI_TPL_CALLBACK,\r
                  EfiMtcEventHandler,\r
                  NULL,\r
                  &mEfiMtcEvent\r
                  );\r
\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Read the last high part\r
  //\r
  BufferSize = sizeof (UINT32);\r
  Status = gRT->GetVariable (\r
                  mEfiMtcName,\r
                  &mEfiMtcGuid,\r
                  NULL,\r
                  &BufferSize,\r
                  &HighCount\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    HighCount = 0;\r
  }\r
  //\r
  // Set the current value\r
  //\r
  mEfiMtc = LShiftU64 (HighCount, 32);\r
\r
  //\r
  // Increment the upper 32 bits for this boot\r
  // Continue even if it fails.  It will only fail if the variable services are\r
  // not functional.\r
  //\r
  Status = MonotonicCounterDriverGetNextHighMonotonicCount (&HighCount);\r
\r
  //\r
  // Fill in the EFI Boot Services and EFI Runtime Services Monotonic Counter Fields\r
  //\r
  gBS->GetNextMonotonicCount      = MonotonicCounterDriverGetNextMonotonicCount;\r
  gRT->GetNextHighMonotonicCount  = MonotonicCounterDriverGetNextHighMonotonicCount;\r
\r
  //\r
  // Install the Monotonic Counter Architctural Protocol onto a new handle\r
  //\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &mMonotonicCounterHandle,\r
                  &gEfiMonotonicCounterArchProtocolGuid,\r
                  NULL,\r
                  NULL\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return EFI_SUCCESS;\r
}\r