UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

[mirror_edk2.git] / MdeModulePkg / Bus / Pci / NonDiscoverablePciDeviceDxe / NonDiscoverablePciDeviceDxe.c

/** @file\r
\r
  Copyright (C) 2016, Linaro Ltd. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "NonDiscoverablePciDeviceIo.h"\r
\r
#include <Protocol/DriverBinding.h>\r
\r
#define MAX_NON_DISCOVERABLE_PCI_DEVICE_ID  (32 * 256)\r
\r
STATIC UINTN           mUniqueIdCounter = 0;\r
EFI_CPU_ARCH_PROTOCOL  *mCpu;\r
\r
//\r
// We only support the following device types\r
//\r
STATIC\r
CONST EFI_GUID *CONST\r
SupportedNonDiscoverableDevices[] = {\r
  &gEdkiiNonDiscoverableAhciDeviceGuid,\r
  &gEdkiiNonDiscoverableEhciDeviceGuid,\r
  &gEdkiiNonDiscoverableNvmeDeviceGuid,\r
  &gEdkiiNonDiscoverableOhciDeviceGuid,\r
  &gEdkiiNonDiscoverableSdhciDeviceGuid,\r
  &gEdkiiNonDiscoverableUfsDeviceGuid,\r
  &gEdkiiNonDiscoverableUhciDeviceGuid,\r
  &gEdkiiNonDiscoverableXhciDeviceGuid,\r
};\r
\r
//\r
// Probe, start and stop functions of this driver, called by the DXE core for\r
// specific devices.\r
//\r
// The following specifications document these interfaces:\r
// - Driver Writer's Guide for UEFI 2.3.1 v1.01, 9 Driver Binding Protocol\r
// - UEFI Spec 2.3.1 + Errata C, 10.1 EFI Driver Binding Protocol\r
//\r
// The implementation follows:\r
// - Driver Writer's Guide for UEFI 2.3.1 v1.01\r
//   - 5.1.3.4 OpenProtocol() and CloseProtocol()\r
// - UEFI Spec 2.3.1 + Errata C\r
//   -  6.3 Protocol Handler Services\r
//\r
\r
/**\r
  Supported function of Driver Binding protocol for this driver.\r
  Test to see if this driver supports ControllerHandle.\r
\r
  @param This                   Protocol instance pointer.\r
  @param DeviceHandle           Handle of device to test.\r
  @param RemainingDevicePath    A pointer to the device path.\r
                                it should be ignored by device driver.\r
\r
  @retval EFI_SUCCESS           This driver supports this device.\r
  @retval other                 This driver does not support this device.\r
\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
NonDiscoverablePciDeviceSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   DeviceHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
  )\r
{\r
  NON_DISCOVERABLE_DEVICE            *Device;\r
  EFI_STATUS                         Status;\r
  EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR  *Desc;\r
  INTN                               Idx;\r
\r
  Status = gBS->OpenProtocol (\r
                  DeviceHandle,\r
                  &gEdkiiNonDiscoverableDeviceProtocolGuid,\r
                  (VOID **)&Device,\r
                  This->DriverBindingHandle,\r
                  DeviceHandle,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = EFI_UNSUPPORTED;\r
  for (Idx = 0; Idx < ARRAY_SIZE (SupportedNonDiscoverableDevices); Idx++) {\r
    if (CompareGuid (Device->Type, SupportedNonDiscoverableDevices[Idx])) {\r
      Status = EFI_SUCCESS;\r
      break;\r
    }\r
  }\r
\r
  if (EFI_ERROR (Status)) {\r
    goto CloseProtocol;\r
  }\r
\r
  //\r
  // We only support MMIO devices, so iterate over the resources to ensure\r
  // that they only describe things that we can handle\r
  //\r
  for (Desc = Device->Resources; Desc->Desc != ACPI_END_TAG_DESCRIPTOR;\r
       Desc = (VOID *)((UINT8 *)Desc + Desc->Len + 3))\r
  {\r
    if ((Desc->Desc != ACPI_ADDRESS_SPACE_DESCRIPTOR) ||\r
        (Desc->ResType != ACPI_ADDRESS_SPACE_TYPE_MEM))\r
    {\r
      Status = EFI_UNSUPPORTED;\r
      break;\r
    }\r
  }\r
\r
CloseProtocol:\r
  gBS->CloseProtocol (\r
         DeviceHandle,\r
         &gEdkiiNonDiscoverableDeviceProtocolGuid,\r
         This->DriverBindingHandle,\r
         DeviceHandle\r
         );\r
\r
  return Status;\r
}\r
\r
/**\r
  This routine is called right after the .Supported() called and\r
  Start this driver on ControllerHandle.\r
\r
  @param This                   Protocol instance pointer.\r
  @param DeviceHandle           Handle of device to bind driver to.\r
  @param RemainingDevicePath    A pointer to the device path.\r
                                it should be ignored by device driver.\r
\r
  @retval EFI_SUCCESS           This driver is added to this device.\r
  @retval other                 Some error occurs when binding this driver to this device.\r
\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
NonDiscoverablePciDeviceStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   DeviceHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
  )\r
{\r
  NON_DISCOVERABLE_PCI_DEVICE  *Dev;\r
  EFI_STATUS                   Status;\r
\r
  ASSERT (mUniqueIdCounter < MAX_NON_DISCOVERABLE_PCI_DEVICE_ID);\r
  if (mUniqueIdCounter >= MAX_NON_DISCOVERABLE_PCI_DEVICE_ID) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  Dev = AllocateZeroPool (sizeof *Dev);\r
  if (Dev == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                  DeviceHandle,\r
                  &gEdkiiNonDiscoverableDeviceProtocolGuid,\r
                  (VOID **)&Dev->Device,\r
                  This->DriverBindingHandle,\r
                  DeviceHandle,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto FreeDev;\r
  }\r
\r
  InitializePciIoProtocol (Dev);\r
\r
  //\r
  // Setup complete, attempt to export the driver instance's\r
  // EFI_PCI_IO_PROTOCOL interface.\r
  //\r
  Dev->Signature = NON_DISCOVERABLE_PCI_DEVICE_SIG;\r
  Status         = gBS->InstallProtocolInterface (\r
                          &DeviceHandle,\r
                          &gEfiPciIoProtocolGuid,\r
                          EFI_NATIVE_INTERFACE,\r
                          &Dev->PciIo\r
                          );\r
  if (EFI_ERROR (Status)) {\r
    goto CloseProtocol;\r
  }\r
\r
  Dev->UniqueId = mUniqueIdCounter++;\r
\r
  return EFI_SUCCESS;\r
\r
CloseProtocol:\r
  gBS->CloseProtocol (\r
         DeviceHandle,\r
         &gEdkiiNonDiscoverableDeviceProtocolGuid,\r
         This->DriverBindingHandle,\r
         DeviceHandle\r
         );\r
\r
FreeDev:\r
  FreePool (Dev);\r
\r
  return Status;\r
}\r
\r
/**\r
  Stop this driver on ControllerHandle.\r
\r
  @param This               Protocol instance pointer.\r
  @param DeviceHandle       Handle of device to stop driver on.\r
  @param NumberOfChildren   Not used.\r
  @param ChildHandleBuffer  Not used.\r
\r
  @retval EFI_SUCCESS   This driver is removed from this device.\r
  @retval other         Some error occurs when removing this driver from this device.\r
\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
NonDiscoverablePciDeviceStop (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   DeviceHandle,\r
  IN UINTN                        NumberOfChildren,\r
  IN EFI_HANDLE                   *ChildHandleBuffer\r
  )\r
{\r
  EFI_STATUS                   Status;\r
  EFI_PCI_IO_PROTOCOL          *PciIo;\r
  NON_DISCOVERABLE_PCI_DEVICE  *Dev;\r
\r
  Status = gBS->OpenProtocol (\r
                  DeviceHandle,\r
                  &gEfiPciIoProtocolGuid,\r
                  (VOID **)&PciIo,\r
                  This->DriverBindingHandle,\r
                  DeviceHandle,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Dev = NON_DISCOVERABLE_PCI_DEVICE_FROM_PCI_IO (PciIo);\r
\r
  //\r
  // Handle Stop() requests for in-use driver instances gracefully.\r
  //\r
  Status = gBS->UninstallProtocolInterface (\r
                  DeviceHandle,\r
                  &gEfiPciIoProtocolGuid,\r
                  &Dev->PciIo\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  gBS->CloseProtocol (\r
         DeviceHandle,\r
         &gEdkiiNonDiscoverableDeviceProtocolGuid,\r
         This->DriverBindingHandle,\r
         DeviceHandle\r
         );\r
\r
  FreePool (Dev);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
//\r
// The static object that groups the Supported() (ie. probe), Start() and\r
// Stop() functions of the driver together. Refer to UEFI Spec 2.3.1 + Errata\r
// C, 10.1 EFI Driver Binding Protocol.\r
//\r
STATIC EFI_DRIVER_BINDING_PROTOCOL  gDriverBinding = {\r
  &NonDiscoverablePciDeviceSupported,\r
  &NonDiscoverablePciDeviceStart,\r
  &NonDiscoverablePciDeviceStop,\r
  0x10, // Version, must be in [0x10 .. 0xFFFFFFEF] for IHV-developed drivers\r
  NULL,\r
  NULL\r
};\r
\r
/**\r
  Entry point of this driver.\r
\r
  @param  ImageHandle     Image handle this driver.\r
  @param  SystemTable     Pointer to the System Table.\r
\r
  @retval EFI_SUCCESS     The entry point is executed successfully.\r
  @retval other           Some error occurred when executing this entry point.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
NonDiscoverablePciDeviceDxeEntryPoint (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  Status = gBS->LocateProtocol (&gEfiCpuArchProtocolGuid, NULL, (VOID **)&mCpu);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return EfiLibInstallDriverBindingComponentName2 (\r
           ImageHandle,\r
           SystemTable,\r
           &gDriverBinding,\r
           ImageHandle,\r
           &gComponentName,\r
           &gComponentName2\r
           );\r
}\r