OvmfPkg: Apply uncrustify changes

[mirror_edk2.git] / OvmfPkg / XenIoPciDxe / XenIoPciDxe.c

/** @file\r
\r
  Driver for the virtual Xen PCI device\r
\r
  Copyright (C) 2012, Red Hat, Inc.\r
  Copyright (c) 2012 - 2016, Intel Corporation. All rights reserved.<BR>\r
  Copyright (C) 2013, ARM Ltd.\r
  Copyright (C) 2015, Linaro Ltd.\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <IndustryStandard/Acpi.h>\r
#include <IndustryStandard/Pci.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiLib.h>\r
\r
#include <Protocol/PciIo.h>\r
#include <Protocol/XenIo.h>\r
\r
#define PCI_VENDOR_ID_XEN           0x5853\r
#define PCI_DEVICE_ID_XEN_PLATFORM  0x0001\r
\r
/**\r
\r
  Device probe function for this driver.\r
\r
  The DXE core calls this function for any given device in order to see if the\r
  driver can drive the device.\r
\r
  @param[in]  This                The EFI_DRIVER_BINDING_PROTOCOL object\r
                                  incorporating this driver (independently of\r
                                  any device).\r
\r
  @param[in] DeviceHandle         The device to probe.\r
\r
  @param[in] RemainingDevicePath  Relevant only for bus drivers, ignored.\r
\r
\r
  @retval EFI_SUCCESS      The driver supports the device being probed.\r
\r
  @retval EFI_UNSUPPORTED  The driver does not support the device being probed.\r
\r
  @return                  Error codes from the OpenProtocol() boot service or\r
                           the PciIo protocol.\r
\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
XenIoPciDeviceBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   DeviceHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
  )\r
{\r
  EFI_STATUS           Status;\r
  EFI_PCI_IO_PROTOCOL  *PciIo;\r
  PCI_TYPE00           Pci;\r
\r
  //\r
  // Attempt to open the device with the PciIo set of interfaces. On success,\r
  // the protocol is "instantiated" for the PCI device. Covers duplicate open\r
  // attempts (EFI_ALREADY_STARTED).\r
  //\r
  Status = gBS->OpenProtocol (\r
                  DeviceHandle,               // candidate device\r
                  &gEfiPciIoProtocolGuid,     // for generic PCI access\r
                  (VOID **)&PciIo,            // handle to instantiate\r
                  This->DriverBindingHandle,  // requestor driver identity\r
                  DeviceHandle,               // ControllerHandle, according to\r
                                              // the UEFI Driver Model\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER // get exclusive PciIo access to\r
                                              // the device; to be released\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Read entire PCI configuration header for more extensive check ahead.\r
  //\r
  Status = PciIo->Pci.Read (\r
                        PciIo,                        // (protocol, device)\r
                                                      // handle\r
                        EfiPciIoWidthUint32,          // access width & copy\r
                                                      // mode\r
                        0,                            // Offset\r
                        sizeof Pci / sizeof (UINT32), // Count\r
                        &Pci                          // target buffer\r
                        );\r
\r
  if (Status == EFI_SUCCESS) {\r
    if ((Pci.Hdr.VendorId == PCI_VENDOR_ID_XEN) &&\r
        (Pci.Hdr.DeviceId == PCI_DEVICE_ID_XEN_PLATFORM))\r
    {\r
      Status = EFI_SUCCESS;\r
    } else {\r
      Status = EFI_UNSUPPORTED;\r
    }\r
  }\r
\r
  //\r
  // We needed PCI IO access only transitorily, to see whether we support the\r
  // device or not.\r
  //\r
  gBS->CloseProtocol (\r
         DeviceHandle,\r
         &gEfiPciIoProtocolGuid,\r
         This->DriverBindingHandle,\r
         DeviceHandle\r
         );\r
\r
  return Status;\r
}\r
\r
/**\r
\r
  After we've pronounced support for a specific device in\r
  DriverBindingSupported(), we start managing said device (passed in by the\r
  Driver Execution Environment) with the following service.\r
\r
  See DriverBindingSupported() for specification references.\r
\r
  @param[in]  This                The EFI_DRIVER_BINDING_PROTOCOL object\r
                                  incorporating this driver (independently of\r
                                  any device).\r
\r
  @param[in] DeviceHandle         The supported device to drive.\r
\r
  @param[in] RemainingDevicePath  Relevant only for bus drivers, ignored.\r
\r
\r
  @retval EFI_SUCCESS           The device was started.\r
\r
  @retval EFI_OUT_OF_RESOURCES  Memory allocation failed.\r
\r
  @return                       Error codes from the OpenProtocol() boot\r
                                service, the PciIo protocol or the\r
                                InstallProtocolInterface() boot service.\r
\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
XenIoPciDeviceBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   DeviceHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
  )\r
{\r
  EFI_STATUS                         Status;\r
  XENIO_PROTOCOL                     *XenIo;\r
  EFI_PCI_IO_PROTOCOL                *PciIo;\r
  EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR  *BarDesc;\r
\r
  XenIo = (XENIO_PROTOCOL *)AllocateZeroPool (sizeof *XenIo);\r
  if (XenIo == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                  DeviceHandle,\r
                  &gEfiPciIoProtocolGuid,\r
                  (VOID **)&PciIo,\r
                  This->DriverBindingHandle,\r
                  DeviceHandle,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto FreeXenIo;\r
  }\r
\r
  //\r
  // The BAR1 of this PCI device is used for shared memory and is supposed to\r
  // look like MMIO. The address space of the BAR1 will be used to map the\r
  // Grant Table.\r
  //\r
  Status = PciIo->GetBarAttributes (PciIo, PCI_BAR_IDX1, NULL, (VOID **)&BarDesc);\r
  ASSERT_EFI_ERROR (Status);\r
  ASSERT (BarDesc->ResType == ACPI_ADDRESS_SPACE_TYPE_MEM);\r
\r
  /* Get a Memory address for mapping the Grant Table. */\r
  DEBUG ((DEBUG_INFO, "XenIoPci: BAR at %LX\n", BarDesc->AddrRangeMin));\r
  XenIo->GrantTableAddress = BarDesc->AddrRangeMin;\r
  FreePool (BarDesc);\r
\r
  Status = gBS->InstallProtocolInterface (\r
                  &DeviceHandle,\r
                  &gXenIoProtocolGuid,\r
                  EFI_NATIVE_INTERFACE,\r
                  XenIo\r
                  );\r
\r
  if (!EFI_ERROR (Status)) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  gBS->CloseProtocol (\r
         DeviceHandle,\r
         &gEfiPciIoProtocolGuid,\r
         This->DriverBindingHandle,\r
         DeviceHandle\r
         );\r
\r
FreeXenIo:\r
  FreePool (XenIo);\r
\r
  return Status;\r
}\r
\r
/**\r
\r
  Stop driving the XenIo PCI device\r
\r
  @param[in] This               The EFI_DRIVER_BINDING_PROTOCOL object\r
                                incorporating this driver (independently of any\r
                                device).\r
\r
  @param[in] DeviceHandle       Stop driving this device.\r
\r
  @param[in] NumberOfChildren   Since this function belongs to a device driver\r
                                only (as opposed to a bus driver), the caller\r
                                environment sets NumberOfChildren to zero, and\r
                                we ignore it.\r
\r
  @param[in] ChildHandleBuffer  Ignored (corresponding to NumberOfChildren).\r
\r
  @retval EFI_SUCCESS           Driver instance has been stopped and the PCI\r
                                configuration attributes have been restored.\r
\r
  @return                       Error codes from the OpenProtocol() or\r
                                CloseProtocol(), UninstallProtocolInterface()\r
                                boot services.\r
\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
XenIoPciDeviceBindingStop (\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
  XENIO_PROTOCOL  *XenIo;\r
\r
  Status = gBS->OpenProtocol (\r
                  DeviceHandle,                  // candidate device\r
                  &gXenIoProtocolGuid,           // retrieve the XenIo iface\r
                  (VOID **)&XenIo,               // target pointer\r
                  This->DriverBindingHandle,     // requestor driver identity\r
                  DeviceHandle,                  // requesting lookup for dev.\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL // lookup only, no ref. added\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Handle Stop() requests for in-use driver instances gracefully.\r
  //\r
  Status = gBS->UninstallProtocolInterface (\r
                  DeviceHandle,\r
                  &gXenIoProtocolGuid,\r
                  XenIo\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = gBS->CloseProtocol (\r
                  DeviceHandle,\r
                  &gEfiPciIoProtocolGuid,\r
                  This->DriverBindingHandle,\r
                  DeviceHandle\r
                  );\r
\r
  FreePool (XenIo);\r
\r
  return Status;\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
  &XenIoPciDeviceBindingSupported,\r
  &XenIoPciDeviceBindingStart,\r
  &XenIoPciDeviceBindingStop,\r
  0x10, // Version, must be in [0x10 .. 0xFFFFFFEF] for IHV-developed drivers\r
  NULL, // ImageHandle, to be overwritten by\r
        // EfiLibInstallDriverBindingComponentName2() in XenIoPciDeviceEntryPoint()\r
  NULL  // DriverBindingHandle, ditto\r
};\r
\r
//\r
// The purpose of the following scaffolding (EFI_COMPONENT_NAME_PROTOCOL and\r
// EFI_COMPONENT_NAME2_PROTOCOL implementation) is to format the driver's name\r
// in English, for display on standard console devices. This is recommended for\r
// UEFI drivers that follow the UEFI Driver Model. Refer to the Driver Writer's\r
// Guide for UEFI 2.3.1 v1.01, 11 UEFI Driver and Controller Names.\r
//\r
STATIC\r
EFI_UNICODE_STRING_TABLE  mDriverNameTable[] = {\r
  { "eng;en", L"XenIo PCI Driver" },\r
  { NULL,     NULL                }\r
};\r
\r
STATIC\r
EFI_COMPONENT_NAME_PROTOCOL  gComponentName;\r
\r
EFI_STATUS\r
EFIAPI\r
XenIoPciGetDriverName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
  IN  CHAR8                        *Language,\r
  OUT CHAR16                       **DriverName\r
  )\r
{\r
  return LookupUnicodeString2 (\r
           Language,\r
           This->SupportedLanguages,\r
           mDriverNameTable,\r
           DriverName,\r
           (BOOLEAN)(This == &gComponentName) // Iso639Language\r
           );\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
XenIoPciGetDeviceName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
  IN  EFI_HANDLE                   DeviceHandle,\r
  IN  EFI_HANDLE                   ChildHandle,\r
  IN  CHAR8                        *Language,\r
  OUT CHAR16                       **ControllerName\r
  )\r
{\r
  return EFI_UNSUPPORTED;\r
}\r
\r
STATIC\r
EFI_COMPONENT_NAME_PROTOCOL  gComponentName = {\r
  &XenIoPciGetDriverName,\r
  &XenIoPciGetDeviceName,\r
  "eng" // SupportedLanguages, ISO 639-2 language codes\r
};\r
\r
STATIC\r
EFI_COMPONENT_NAME2_PROTOCOL  gComponentName2 = {\r
  (EFI_COMPONENT_NAME2_GET_DRIVER_NAME)&XenIoPciGetDriverName,\r
  (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME)&XenIoPciGetDeviceName,\r
  "en" // SupportedLanguages, RFC 4646 language codes\r
};\r
\r
//\r
// Entry point of this driver.\r
//\r
EFI_STATUS\r
EFIAPI\r
XenIoPciDeviceEntryPoint (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  return EfiLibInstallDriverBindingComponentName2 (\r
           ImageHandle,\r
           SystemTable,\r
           &gDriverBinding,\r
           ImageHandle,\r
           &gComponentName,\r
           &gComponentName2\r
           );\r
}\r