PrmPkg: Enforce stricter types

[mirror_edk2.git] / PrmPkg / PrmConfigDxe / PrmConfigDxe.c

/** @file\r
\r
  This file contains the implementation for a Platform Runtime Mechanism (PRM) configuration driver.\r
\r
  Copyright (c) Microsoft Corporation\r
  Copyright (c) 2020, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/DxeServicesTableLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/UefiLib.h>\r
\r
#include <PiDxe.h>\r
#include <PrmContextBuffer.h>\r
#include <PrmDataBuffer.h>\r
#include <PrmMmio.h>\r
#include <Protocol/PrmConfig.h>\r
\r
#define _DBGMSGID_                "[PRMCONFIG]"\r
\r
STATIC  UINTN                     mMaxRuntimeMmioRangeCount;\r
\r
GLOBAL_REMOVE_IF_UNREFERENCED STATIC  PRM_RUNTIME_MMIO_RANGES   **mRuntimeMmioRanges;\r
\r
/**\r
  Converts the runtime memory range physical addresses to virtual addresses.\r
\r
  @param[in]  RuntimeMmioRanges   A pointer to a PRM_RUNTIME_MMIO_RANGES buffer.\r
\r
**/\r
VOID\r
ConvertRuntimeMemoryRangeAddresses (\r
  IN  PRM_RUNTIME_MMIO_RANGES     *RuntimeMmioRanges\r
  )\r
{\r
  UINTN   Index;\r
\r
  if (RuntimeMmioRanges == NULL || RuntimeMmioRanges->Count == 0) {\r
    return;\r
  }\r
\r
  for (Index = 0; Index < (UINTN) RuntimeMmioRanges->Count; Index++) {\r
    RuntimeMmioRanges->Range[Index].VirtualBaseAddress = RuntimeMmioRanges->Range[Index].PhysicalBaseAddress;\r
    gRT->ConvertPointer (0x0, (VOID **) &(RuntimeMmioRanges->Range[Index].VirtualBaseAddress));\r
  }\r
}\r
\r
/**\r
  Sets the runtime memory range attributes.\r
\r
  The EFI_MEMORY_RUNTIME attribute is set for each PRM_RUNTIME_MMIO_RANGE present\r
  in the buffer provided.\r
\r
  @param[in]  RuntimeMmioRanges     A pointer to a PRM_RUNTIME_MMIO_RANGES buffer.\r
\r
**/\r
VOID\r
SetRuntimeMemoryRangeAttributes (\r
  IN  PRM_RUNTIME_MMIO_RANGES       *RuntimeMmioRanges\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  EFI_STATUS                        Status2;\r
  UINTN                             Index;\r
  EFI_GCD_MEMORY_SPACE_DESCRIPTOR   Descriptor;\r
\r
  DEBUG ((DEBUG_INFO, "%a %a - Entry.\n", _DBGMSGID_, __FUNCTION__));\r
\r
  if (RuntimeMmioRanges == NULL || RuntimeMmioRanges->Count == 0) {\r
    return;\r
  }\r
\r
  for (Index = 0; Index < (UINTN) RuntimeMmioRanges->Count; Index++) {\r
    DEBUG ((\r
      DEBUG_INFO, "      %a %a: Runtime MMIO Range [%d].\n", _DBGMSGID_, __FUNCTION__, Index));\r
    DEBUG ((\r
      DEBUG_INFO,\r
      "      %a %a: Physical address = 0x%016x. Length = 0x%x.\n",\r
      _DBGMSGID_,\r
      __FUNCTION__,\r
      RuntimeMmioRanges->Range[Index].PhysicalBaseAddress,\r
      RuntimeMmioRanges->Range[Index].Length\r
      ));\r
\r
    // Runtime memory ranges should cover ranges on a page boundary\r
    ASSERT ((RuntimeMmioRanges->Range[Index].PhysicalBaseAddress & EFI_PAGE_MASK) == 0);\r
    ASSERT ((RuntimeMmioRanges->Range[Index].Length & EFI_PAGE_MASK) == 0);\r
\r
    Status2 = EFI_NOT_FOUND;\r
    Status = gDS->GetMemorySpaceDescriptor (RuntimeMmioRanges->Range[Index].PhysicalBaseAddress, &Descriptor);\r
    if (!EFI_ERROR (Status) &&\r
      (\r
        (Descriptor.GcdMemoryType != EfiGcdMemoryTypeMemoryMappedIo && Descriptor.GcdMemoryType != EfiGcdMemoryTypeReserved) ||\r
        ((Descriptor.Length & EFI_PAGE_MASK) != 0)\r
        )\r
      ) {\r
      Status2 =  gDS->RemoveMemorySpace (\r
                        RuntimeMmioRanges->Range[Index].PhysicalBaseAddress,\r
                        Descriptor.Length\r
                        );\r
    }\r
\r
    if (Status == EFI_NOT_FOUND || !EFI_ERROR (Status2)) {\r
      Status = gDS->AddMemorySpace (\r
                      EfiGcdMemoryTypeMemoryMappedIo,\r
                      RuntimeMmioRanges->Range[Index].PhysicalBaseAddress,\r
                      (UINT64) RuntimeMmioRanges->Range[Index].Length,\r
                      EFI_MEMORY_UC | EFI_MEMORY_RUNTIME\r
                      );\r
      ASSERT_EFI_ERROR (Status);\r
\r
      Status = gDS->AllocateMemorySpace (\r
                      EfiGcdAllocateAddress,\r
                      EfiGcdMemoryTypeMemoryMappedIo,\r
                      0,\r
                      (UINT64) RuntimeMmioRanges->Range[Index].Length,\r
                      &RuntimeMmioRanges->Range[Index].PhysicalBaseAddress,\r
                      gImageHandle,\r
                      NULL\r
                      );\r
      ASSERT_EFI_ERROR (Status);\r
    }\r
\r
    Status = gDS->GetMemorySpaceDescriptor (RuntimeMmioRanges->Range[Index].PhysicalBaseAddress, &Descriptor);\r
    ASSERT_EFI_ERROR (Status);\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((\r
        DEBUG_ERROR,\r
        "      %a %a: Error [%r] finding descriptor for runtime memory range 0x%016x.\n",\r
        _DBGMSGID_,\r
        __FUNCTION__,\r
        Status,\r
        RuntimeMmioRanges->Range[Index].PhysicalBaseAddress\r
        ));\r
      continue;\r
    }\r
    if ((Descriptor.Attributes & EFI_MEMORY_RUNTIME) != 0) {\r
      continue;\r
    }\r
\r
    Status = gDS->SetMemorySpaceAttributes (\r
                    RuntimeMmioRanges->Range[Index].PhysicalBaseAddress,\r
                    (UINT64) RuntimeMmioRanges->Range[Index].Length,\r
                    Descriptor.Attributes | EFI_MEMORY_RUNTIME\r
                    );\r
    ASSERT_EFI_ERROR (Status);\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((\r
        DEBUG_ERROR,\r
        "      %a %a: Error [%r] setting descriptor for runtime memory range 0x%016x.\n",\r
        _DBGMSGID_,\r
        __FUNCTION__,\r
        Status,\r
        RuntimeMmioRanges->Range[Index].PhysicalBaseAddress\r
        ));\r
    } else {\r
      DEBUG ((DEBUG_INFO, "      %a %a: Successfully set runtime attribute for the MMIO range.\n", _DBGMSGID_, __FUNCTION__));\r
    }\r
  }\r
}\r
\r
/**\r
  Stores pointers or pointer to resources that should be converted in the virtual address change event.\r
\r
**/\r
VOID\r
StoreVirtualMemoryAddressChangePointers (\r
  VOID\r
  )\r
{\r
  EFI_STATUS                  Status;\r
  UINTN                       HandleCount;\r
  UINTN                       HandleIndex;\r
  UINTN                       RangeIndex;\r
  EFI_HANDLE                  *HandleBuffer;\r
  PRM_CONFIG_PROTOCOL         *PrmConfigProtocol;\r
\r
  DEBUG ((DEBUG_INFO, "%a %a - Entry.\n", _DBGMSGID_, __FUNCTION__));\r
\r
  RangeIndex = 0;\r
\r
  mRuntimeMmioRanges = AllocateRuntimeZeroPool (sizeof (*mRuntimeMmioRanges) * mMaxRuntimeMmioRangeCount);\r
  if (mRuntimeMmioRanges == NULL && mMaxRuntimeMmioRangeCount > 0) {\r
    DEBUG ((\r
      DEBUG_ERROR,\r
      "  %a %a: Memory allocation for runtime MMIO pointer array failed.\n",\r
      _DBGMSGID_,\r
      __FUNCTION__\r
      ));\r
    ASSERT (FALSE);\r
    return;\r
  }\r
\r
  HandleBuffer = NULL;\r
  Status = gBS->LocateHandleBuffer (\r
                  ByProtocol,\r
                  &gPrmConfigProtocolGuid,\r
                  NULL,\r
                  &HandleCount,\r
                  &HandleBuffer\r
                  );\r
  if (!EFI_ERROR (Status)) {\r
    for (HandleIndex = 0; HandleIndex < HandleCount; HandleIndex++) {\r
      Status = gBS->HandleProtocol (\r
                      HandleBuffer[HandleIndex],\r
                      &gPrmConfigProtocolGuid,\r
                      (VOID **) &PrmConfigProtocol\r
                      );\r
      ASSERT_EFI_ERROR (Status);\r
      if (EFI_ERROR (Status) || PrmConfigProtocol == NULL) {\r
        continue;\r
      }\r
\r
      if (PrmConfigProtocol->ModuleContextBuffers.RuntimeMmioRanges != NULL) {\r
        if (RangeIndex >= mMaxRuntimeMmioRangeCount) {\r
          Status = EFI_BUFFER_TOO_SMALL;\r
          DEBUG ((\r
            DEBUG_ERROR,\r
            "  %a %a: Index out of bounds - Actual count (%d) of runtime MMIO ranges exceeds maximum count (%d).\n",\r
            _DBGMSGID_,\r
            __FUNCTION__,\r
            RangeIndex + 1,\r
            mMaxRuntimeMmioRangeCount\r
            ));\r
          ASSERT_EFI_ERROR (Status);\r
          return;\r
        }\r
        mRuntimeMmioRanges[RangeIndex++] = PrmConfigProtocol->ModuleContextBuffers.RuntimeMmioRanges;\r
      }\r
    }\r
    DEBUG ((\r
      DEBUG_INFO,\r
      "  %a %a: %d MMIO ranges buffers saved for future virtual memory conversion.\n",\r
      _DBGMSGID_,\r
      __FUNCTION__,\r
      RangeIndex\r
      ));\r
  }\r
}\r
\r
/**\r
  Validates a data buffer for a PRM module.\r
\r
  Verifies the buffer header signature is valid and the length meets the minimum size.\r
\r
  @param[in]  PrmDataBuffer         A pointer to the data buffer for this PRM module.\r
\r
  @retval EFI_SUCCESS               The data buffer was validated successfully.\r
  @retval EFI_INVALID_PARAMETER     The pointer given for PrmDataBuffer is NULL.\r
  @retval EFI_NOT_FOUND             The data buffer signature is not valid.\r
  @retval EFI_BUFFER_TOO_SMALL      The buffer size is too small.\r
\r
**/\r
EFI_STATUS\r
ValidatePrmDataBuffer (\r
  IN  CONST PRM_DATA_BUFFER         *PrmDataBuffer\r
  )\r
{\r
  if (PrmDataBuffer == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (PrmDataBuffer->Header.Signature != PRM_DATA_BUFFER_HEADER_SIGNATURE) {\r
    DEBUG ((DEBUG_ERROR, "  %a %a: The PRM data buffer signature is invalid. PRM module.\n", _DBGMSGID_, __FUNCTION__));\r
    return EFI_NOT_FOUND;\r
  }\r
  if (PrmDataBuffer->Header.Length < sizeof (PRM_DATA_BUFFER_HEADER)) {\r
    DEBUG ((DEBUG_ERROR, "  %a %a: The PRM data buffer length is invalid.\n", _DBGMSGID_, __FUNCTION__));\r
    return EFI_BUFFER_TOO_SMALL;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Validates a PRM context buffer.\r
\r
  Verifies the buffer header signature is valid and the GUID is set to a non-zero value.\r
\r
  @param[in]  PrmContextBuffer      A pointer to the context buffer for this PRM handler.\r
\r
  @retval EFI_SUCCESS               The context buffer was validated successfully.\r
  @retval EFI_INVALID_PARAMETER     The pointer given for ContextBuffer is NULL.\r
  @retval EFI_NOT_FOUND             The proper value for a field was not found.\r
\r
**/\r
EFI_STATUS\r
ValidatePrmContextBuffer (\r
  IN  CONST PRM_CONTEXT_BUFFER      *PrmContextBuffer\r
  )\r
{\r
  if (PrmContextBuffer == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (PrmContextBuffer->Signature != PRM_CONTEXT_BUFFER_SIGNATURE) {\r
    DEBUG ((DEBUG_ERROR, "  %a %a: The PRM context buffer signature is invalid.\n", _DBGMSGID_, __FUNCTION__));\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  if (IsZeroGuid (&PrmContextBuffer->HandlerGuid)) {\r
    DEBUG ((DEBUG_ERROR, "  %a %a: The PRM context buffer GUID is zero.\n", _DBGMSGID_, __FUNCTION__));\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  if (PrmContextBuffer->StaticDataBuffer != NULL && EFI_ERROR (ValidatePrmDataBuffer (PrmContextBuffer->StaticDataBuffer))) {\r
    DEBUG ((\r
      DEBUG_ERROR,\r
      "    %a %a: Error in static buffer for PRM handler %g.\n",\r
      _DBGMSGID_,\r
      __FUNCTION__,\r
      &PrmContextBuffer->HandlerGuid\r
      ));\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Notification function of EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.\r
\r
  This is notification function converts any registered PRM_RUNTIME_MMIO_RANGE\r
  addresses to a virtual address.\r
\r
  @param[in]  Event        Event whose notification function is being invoked.\r
  @param[in]  Context      Pointer to the notification function's context.\r
\r
**/\r
VOID\r
EFIAPI\r
PrmConfigVirtualAddressChangeEvent (\r
  IN EFI_EVENT                            Event,\r
  IN VOID                                 *Context\r
  )\r
{\r
  UINTN   Index;\r
\r
  //\r
  // Convert runtime MMIO ranges\r
  //\r
  for (Index = 0; Index < mMaxRuntimeMmioRangeCount; Index++) {\r
    ConvertRuntimeMemoryRangeAddresses (mRuntimeMmioRanges[Index]);\r
  }\r
}\r
\r
/**\r
  The PRM Config END_OF_DXE protocol notification event handler.\r
\r
  Finds all of the PRM_CONFIG_PROTOCOL instances installed at end of DXE and\r
  marks all PRM_RUNTIME_MMIO_RANGE entries as EFI_MEMORY_RUNTIME.\r
\r
  @param[in]  Event           Event whose notification function is being invoked.\r
  @param[in]  Context         The pointer to the notification function's context,\r
                              which is implementation-dependent.\r
\r
**/\r
VOID\r
EFIAPI\r
PrmConfigEndOfDxeNotification (\r
  IN  EFI_EVENT               Event,\r
  IN  VOID                    *Context\r
  )\r
{\r
  EFI_STATUS                  Status;\r
  UINTN                       HandleCount;\r
  UINTN                       BufferIndex;\r
  UINTN                       HandleIndex;\r
  EFI_HANDLE                  *HandleBuffer;\r
  PRM_CONTEXT_BUFFER          *CurrentContextBuffer;\r
  PRM_CONFIG_PROTOCOL         *PrmConfigProtocol;\r
\r
  DEBUG ((DEBUG_INFO, "%a %a - Entry.\n", _DBGMSGID_, __FUNCTION__));\r
\r
  HandleBuffer = NULL;\r
  Status = gBS->LocateHandleBuffer (\r
                  ByProtocol,\r
                  &gPrmConfigProtocolGuid,\r
                  NULL,\r
                  &HandleCount,\r
                  &HandleBuffer\r
                  );\r
  if (!EFI_ERROR (Status)) {\r
    for (HandleIndex = 0; HandleIndex < HandleCount; HandleIndex++) {\r
      Status = gBS->HandleProtocol (\r
                      HandleBuffer[HandleIndex],\r
                      &gPrmConfigProtocolGuid,\r
                      (VOID **) &PrmConfigProtocol\r
                      );\r
      ASSERT_EFI_ERROR (Status);\r
      if (EFI_ERROR (Status) || PrmConfigProtocol == NULL) {\r
        continue;\r
      }\r
\r
      DEBUG ((\r
        DEBUG_INFO,\r
        "  %a %a: Found PRM configuration protocol for PRM module %g.\n",\r
         _DBGMSGID_,\r
         __FUNCTION__,\r
         &PrmConfigProtocol->ModuleContextBuffers.ModuleGuid\r
         ));\r
\r
      DEBUG ((DEBUG_INFO, "      %a %a: Validating module context buffers...\n", _DBGMSGID_, __FUNCTION__));\r
      for (BufferIndex = 0; BufferIndex < PrmConfigProtocol->ModuleContextBuffers.BufferCount; BufferIndex++) {\r
        CurrentContextBuffer = &(PrmConfigProtocol->ModuleContextBuffers.Buffer[BufferIndex]);\r
\r
        Status =  ValidatePrmContextBuffer (CurrentContextBuffer);\r
        if (EFI_ERROR (Status)) {\r
          DEBUG ((\r
            DEBUG_ERROR,\r
            "        %a %a: Context buffer validation failed for PRM handler %g.\n",\r
            _DBGMSGID_,\r
            __FUNCTION__,\r
            CurrentContextBuffer->HandlerGuid\r
            ));\r
        }\r
      }\r
      DEBUG ((DEBUG_INFO, "      %a %a: Module context buffer validation complete.\n", _DBGMSGID_, __FUNCTION__));\r
\r
      if (PrmConfigProtocol->ModuleContextBuffers.RuntimeMmioRanges != NULL) {\r
        DEBUG ((\r
          DEBUG_INFO,\r
          "    %a %a: Found %d PRM runtime MMIO ranges.\n",\r
           _DBGMSGID_,\r
           __FUNCTION__,\r
           PrmConfigProtocol->ModuleContextBuffers.RuntimeMmioRanges->Count\r
           ));\r
        SetRuntimeMemoryRangeAttributes (PrmConfigProtocol->ModuleContextBuffers.RuntimeMmioRanges);\r
        mMaxRuntimeMmioRangeCount++;\r
      }\r
    }\r
\r
    StoreVirtualMemoryAddressChangePointers ();\r
  }\r
\r
  if (HandleBuffer != NULL) {\r
    gBS->FreePool (HandleBuffer);\r
  }\r
  gBS->CloseEvent(Event);\r
}\r
\r
/**\r
  The entry point for this module.\r
\r
  @param[in]  ImageHandle     The firmware allocated handle for the EFI image.\r
  @param[in]  SystemTable     A pointer to the EFI System Table.\r
\r
  @retval EFI_SUCCESS         The entry point is executed successfully.\r
  @retval Others              An error occurred when executing this entry point.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PrmConfigEntryPoint (\r
  IN EFI_HANDLE               ImageHandle,\r
  IN EFI_SYSTEM_TABLE         *SystemTable\r
  )\r
{\r
  EFI_STATUS                  Status;\r
  EFI_EVENT                   Event;\r
\r
  DEBUG ((DEBUG_INFO, "%a %a - Entry.\n", _DBGMSGID_, __FUNCTION__));\r
\r
  //\r
  // Register a notification function to change memory attributes at end of DXE\r
  //\r
  Event = NULL;\r
  Status = gBS->CreateEventEx (\r
                  EVT_NOTIFY_SIGNAL,\r
                  TPL_CALLBACK,\r
                  PrmConfigEndOfDxeNotification,\r
                  NULL,\r
                  &gEfiEndOfDxeEventGroupGuid,\r
                  &Event\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Register a notification function for virtual address change\r
  //\r
  Event = NULL;\r
  Status = gBS->CreateEventEx (\r
                  EVT_NOTIFY_SIGNAL,\r
                  TPL_NOTIFY,\r
                  PrmConfigVirtualAddressChangeEvent,\r
                  NULL,\r
                  &gEfiEventVirtualAddressChangeGuid,\r
                  &Event\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return EFI_SUCCESS;\r
}\r