MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Universal / Disk / RamDiskDxe / RamDiskDriver.c

/** @file\r
  The driver entry point for RamDiskDxe driver.\r
\r
  Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "RamDiskImpl.h"\r
\r
//\r
// Handle for the EFI_RAM_DISK_PROTOCOL instance\r
//\r
EFI_HANDLE  mRamDiskHandle = NULL;\r
\r
//\r
// The EFI_RAM_DISK_PROTOCOL instances that is installed onto the driver\r
// handle\r
//\r
EFI_RAM_DISK_PROTOCOL  mRamDiskProtocol = {\r
  RamDiskRegister,\r
  RamDiskUnregister\r
};\r
\r
//\r
// RamDiskDxe driver maintains a list of registered RAM disks.\r
//\r
LIST_ENTRY  RegisteredRamDisks;\r
\r
//\r
// Pointers to the EFI_ACPI_TABLE_PROTOCOL and EFI_ACPI_SDT_PROTOCOL.\r
//\r
EFI_ACPI_TABLE_PROTOCOL  *mAcpiTableProtocol = NULL;\r
EFI_ACPI_SDT_PROTOCOL    *mAcpiSdtProtocol   = NULL;\r
\r
\r
/**\r
  Check whether EFI_ACPI_TABLE_PROTOCOL and EFI_ACPI_SDT_PROTOCOL are produced.\r
  If both protocols are produced, publish all the reserved memory type RAM\r
  disks to the NVDIMM Firmware Interface Table (NFIT).\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
RamDiskAcpiCheck (\r
  IN EFI_EVENT    Event,\r
  IN VOID         *Context\r
  )\r
{\r
  EFI_STATUS                 Status;\r
  LIST_ENTRY                 *Entry;\r
  RAM_DISK_PRIVATE_DATA      *PrivateData;\r
\r
  gBS->CloseEvent (Event);\r
\r
  //\r
  // Locate the EFI_ACPI_TABLE_PROTOCOL.\r
  //\r
  Status = gBS->LocateProtocol (\r
                  &gEfiAcpiTableProtocolGuid,\r
                  NULL,\r
                  (VOID **)&mAcpiTableProtocol\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((\r
      EFI_D_INFO,\r
      "RamDiskAcpiCheck: Cannot locate the EFI ACPI Table Protocol, "\r
      "unable to publish RAM disks to NFIT.\n"\r
      ));\r
    return;\r
  }\r
\r
  //\r
  // Locate the EFI_ACPI_SDT_PROTOCOL.\r
  //\r
  Status = gBS->LocateProtocol (\r
                  &gEfiAcpiSdtProtocolGuid,\r
                  NULL,\r
                  (VOID **)&mAcpiSdtProtocol\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((\r
      EFI_D_INFO,\r
      "RamDiskAcpiCheck: Cannot locate the EFI ACPI Sdt Protocol, "\r
      "unable to publish RAM disks to NFIT.\n"\r
      ));\r
    mAcpiTableProtocol = NULL;\r
    return;\r
  }\r
\r
  EFI_LIST_FOR_EACH (Entry, &RegisteredRamDisks) {\r
    PrivateData = RAM_DISK_PRIVATE_FROM_THIS (Entry);\r
    RamDiskPublishNfit (PrivateData);\r
  }\r
}\r
\r
\r
/**\r
  The entry point for RamDiskDxe driver.\r
\r
  @param[in] ImageHandle     The image handle of the driver.\r
  @param[in] SystemTable     The system table.\r
\r
  @retval EFI_ALREADY_STARTED     The driver already exists in system.\r
  @retval EFI_OUT_OF_RESOURCES    Fail to execute entry point due to lack of\r
                                  resources.\r
  @retval EFI_SUCCES              All the related protocols are installed on\r
                                  the driver.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RamDiskDxeEntryPoint (\r
  IN EFI_HANDLE                   ImageHandle,\r
  IN EFI_SYSTEM_TABLE             *SystemTable\r
  )\r
{\r
  EFI_STATUS                      Status;\r
  RAM_DISK_CONFIG_PRIVATE_DATA    *ConfigPrivate;\r
  VOID                            *DummyInterface;\r
  EFI_EVENT                       Event;\r
\r
  //\r
  // If already started, return.\r
  //\r
  Status = gBS->LocateProtocol (\r
                  &gEfiRamDiskProtocolGuid,\r
                  NULL,\r
                  &DummyInterface\r
                  );\r
  if (!EFI_ERROR (Status)) {\r
    DEBUG ((EFI_D_INFO, "Driver already started!\n"));\r
    return EFI_ALREADY_STARTED;\r
  }\r
\r
  //\r
  // Create a private data structure.\r
  //\r
  ConfigPrivate = AllocateCopyPool (sizeof (RAM_DISK_CONFIG_PRIVATE_DATA), &mRamDiskConfigPrivateDataTemplate);\r
  if (ConfigPrivate == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  //\r
  // Install RAM disk configuration form\r
  //\r
  Status = InstallRamDiskConfigForm (ConfigPrivate);\r
  if (EFI_ERROR (Status)) {\r
    goto ErrorExit;\r
  }\r
\r
  //\r
  // Install the EFI_RAM_DISK_PROTOCOL and RAM disk private data onto a\r
  // new handle\r
  //\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &mRamDiskHandle,\r
                  &gEfiRamDiskProtocolGuid,\r
                  &mRamDiskProtocol,\r
                  &gEfiCallerIdGuid,\r
                  ConfigPrivate,\r
                  NULL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ErrorExit;\r
  }\r
\r
  //\r
  // Initialize the list of registered RAM disks maintained by the driver\r
  //\r
  InitializeListHead (&RegisteredRamDisks);\r
\r
  Status = EfiCreateEventReadyToBootEx (\r
             TPL_CALLBACK,\r
             RamDiskAcpiCheck,\r
             NULL,\r
             &Event\r
             );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return EFI_SUCCESS;\r
\r
ErrorExit:\r
  if (ConfigPrivate != NULL) {\r
    UninstallRamDiskConfigForm (ConfigPrivate);\r
  }\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  Unload the RamDiskDxe driver and its configuration form.\r
\r
  @param[in] ImageHandle     The driver's image handle.\r
\r
  @retval EFI_SUCCESS             The RamDiskDxe driver and its configuration\r
                                  form is unloaded.\r
  @retval Others                  Failed to unload the form.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RamDiskDxeUnload (\r
  IN EFI_HANDLE                   ImageHandle\r
  )\r
{\r
  EFI_STATUS                      Status;\r
  RAM_DISK_CONFIG_PRIVATE_DATA    *ConfigPrivate;\r
\r
  Status = gBS->HandleProtocol (\r
                  mRamDiskHandle,\r
                  &gEfiCallerIdGuid,\r
                  (VOID **) &ConfigPrivate\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  ASSERT (ConfigPrivate->Signature == RAM_DISK_CONFIG_PRIVATE_DATA_SIGNATURE);\r
\r
  //\r
  // Unregister all registered RAM disks\r
  //\r
  UnregisterAllRamDisks ();\r
\r
  gBS->UninstallMultipleProtocolInterfaces (\r
         mRamDiskHandle,\r
         &gEfiRamDiskProtocolGuid,\r
         &mRamDiskProtocol,\r
         &gEfiCallerIdGuid,\r
         ConfigPrivate,\r
         NULL\r
         );\r
\r
  UninstallRamDiskConfigForm (ConfigPrivate);\r
\r
  return EFI_SUCCESS;\r
}\r