EmbeddedPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / EmbeddedPkg / Drivers / DtPlatformDxe / DtPlatformDxe.c

/** @file\r
*\r
*  Copyright (c) 2017, Linaro, Ltd. All rights reserved.\r
*\r
*  SPDX-License-Identifier: BSD-2-Clause-Patent\r
*\r
**/\r
\r
#include <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/DtPlatformDtbLoaderLib.h>\r
#include <Library/HiiLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
\r
#include "DtPlatformDxe.h"\r
\r
extern  UINT8                     DtPlatformHiiBin[];\r
extern  UINT8                     DtPlatformDxeStrings[];\r
\r
typedef struct {\r
  VENDOR_DEVICE_PATH              VendorDevicePath;\r
  EFI_DEVICE_PATH_PROTOCOL        End;\r
} HII_VENDOR_DEVICE_PATH;\r
\r
STATIC HII_VENDOR_DEVICE_PATH     mDtPlatformDxeVendorDevicePath = {\r
  {\r
    {\r
      HARDWARE_DEVICE_PATH,\r
      HW_VENDOR_DP,\r
      {\r
        (UINT8) (sizeof (VENDOR_DEVICE_PATH)),\r
        (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)\r
      }\r
    },\r
    DT_PLATFORM_FORMSET_GUID\r
  },\r
  {\r
    END_DEVICE_PATH_TYPE,\r
    END_ENTIRE_DEVICE_PATH_SUBTYPE,\r
    {\r
      (UINT8) (END_DEVICE_PATH_LENGTH),\r
      (UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)\r
    }\r
  }\r
};\r
\r
STATIC\r
EFI_STATUS\r
InstallHiiPages (\r
  VOID\r
  )\r
{\r
  EFI_STATUS                      Status;\r
  EFI_HII_HANDLE                  HiiHandle;\r
  EFI_HANDLE                      DriverHandle;\r
\r
  DriverHandle = NULL;\r
  Status = gBS->InstallMultipleProtocolInterfaces (&DriverHandle,\r
                  &gEfiDevicePathProtocolGuid,\r
                  &mDtPlatformDxeVendorDevicePath,\r
                  NULL);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  HiiHandle = HiiAddPackages (&gDtPlatformFormSetGuid,\r
                              DriverHandle,\r
                              DtPlatformDxeStrings,\r
                              DtPlatformHiiBin,\r
                              NULL);\r
\r
  if (HiiHandle == NULL) {\r
    gBS->UninstallMultipleProtocolInterfaces (DriverHandle,\r
                  &gEfiDevicePathProtocolGuid,\r
                  &mDtPlatformDxeVendorDevicePath,\r
                  NULL);\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  The entry point for DtPlatformDxe 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
DtPlatformDxeEntryPoint (\r
  IN EFI_HANDLE                   ImageHandle,\r
  IN EFI_SYSTEM_TABLE             *SystemTable\r
  )\r
{\r
  EFI_STATUS                      Status;\r
  DT_ACPI_VARSTORE_DATA           DtAcpiPref;\r
  UINTN                           BufferSize;\r
  VOID                            *Dtb;\r
  UINTN                           DtbSize;\r
\r
  Dtb = NULL;\r
  Status = DtPlatformLoadDtb (&Dtb, &DtbSize);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_WARN,\r
      "%a: no DTB blob could be loaded, defaulting to ACPI (Status == %r)\n",\r
      __FUNCTION__, Status));\r
    DtAcpiPref.Pref = DT_ACPI_SELECT_ACPI;\r
  } else {\r
    //\r
    // Get the current DT/ACPI preference from the DtAcpiPref variable.\r
    //\r
    BufferSize = sizeof (DtAcpiPref);\r
    Status = gRT->GetVariable(DT_ACPI_VARIABLE_NAME, &gDtPlatformFormSetGuid,\r
                    NULL, &BufferSize, &DtAcpiPref);\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((DEBUG_WARN, "%a: no DT/ACPI preference found, defaulting to DT\n",\r
        __FUNCTION__));\r
      DtAcpiPref.Pref = DT_ACPI_SELECT_DT;\r
    }\r
  }\r
\r
  if (!EFI_ERROR (Status) &&\r
      DtAcpiPref.Pref != DT_ACPI_SELECT_ACPI &&\r
      DtAcpiPref.Pref != DT_ACPI_SELECT_DT) {\r
    DEBUG ((DEBUG_WARN, "%a: invalid value for %s, defaulting to DT\n",\r
      __FUNCTION__, DT_ACPI_VARIABLE_NAME));\r
    DtAcpiPref.Pref = DT_ACPI_SELECT_DT;\r
    Status = EFI_INVALID_PARAMETER; // trigger setvar below\r
  }\r
\r
  //\r
  // Write the newly selected default value back to the variable store.\r
  //\r
  if (EFI_ERROR (Status)) {\r
    Status = gRT->SetVariable(DT_ACPI_VARIABLE_NAME, &gDtPlatformFormSetGuid,\r
                    EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
                    sizeof (DtAcpiPref), &DtAcpiPref);\r
    if (EFI_ERROR (Status)) {\r
      goto FreeDtb;\r
    }\r
  }\r
\r
  if (DtAcpiPref.Pref == DT_ACPI_SELECT_ACPI) {\r
    //\r
    // ACPI was selected: install the gEdkiiPlatformHasAcpiGuid GUID as a\r
    // NULL protocol to unlock dispatch of ACPI related drivers.\r
    //\r
    Status = gBS->InstallMultipleProtocolInterfaces (&ImageHandle,\r
                    &gEdkiiPlatformHasAcpiGuid, NULL, NULL);\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((DEBUG_ERROR,\r
        "%a: failed to install gEdkiiPlatformHasAcpiGuid as a protocol\n",\r
        __FUNCTION__));\r
      goto FreeDtb;\r
    }\r
  } else if (DtAcpiPref.Pref == DT_ACPI_SELECT_DT) {\r
    //\r
    // DT was selected: copy the blob into newly allocated memory and install\r
    // a reference to it as the FDT configuration table.\r
    //\r
    Status = gBS->InstallConfigurationTable (&gFdtTableGuid, Dtb);\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((DEBUG_ERROR, "%a: failed to install FDT configuration table\n",\r
        __FUNCTION__));\r
      goto FreeDtb;\r
    }\r
  } else {\r
    ASSERT (FALSE);\r
  }\r
\r
  //\r
  // No point in installing the HII pages if ACPI is the only description\r
  // we have\r
  //\r
  if (Dtb == NULL) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  //\r
  // Note that we don't uninstall the gEdkiiPlatformHasAcpiGuid protocol nor\r
  // the FDT configuration table if the following call fails. While that will\r
  // cause loading of this driver to fail, proceeding with ACPI and DT both\r
  // disabled will guarantee a failed boot, and so it is better to leave them\r
  // installed in that case.\r
  //\r
  return InstallHiiPages ();\r
\r
FreeDtb:\r
  if (Dtb != NULL) {\r
    FreePool (Dtb);\r
  }\r
\r
  return Status;\r
}\r