]> git.proxmox.com Git - mirror_edk2.git/blobdiff - OvmfPkg/XenBusDxe/XenBusDxe.c
MpInitLib: Move the Above1Mb vector allocation to MpInitLibInitialize
[mirror_edk2.git] / OvmfPkg / XenBusDxe / XenBusDxe.c
index edeb20ef381766383dc015fba2ee17323e193791..132f43a72b5a13001e6a05c51064f40263e0b1d5 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   This driver produces XenBus Protocol instances for each Xen PV devices.\r
 \r
-  This XenBus bus driver will first initialize differente services in order to\r
+  This XenBus bus driver will first initialize different services in order to\r
   enumerate the ParaVirtualized devices available.\r
 \r
   Those services are:\r
 \r
   Copyright (C) 2014, Citrix Ltd.\r
 \r
-  This program and the accompanying materials\r
-  are licensed and made available under the terms and conditions of the BSD License\r
-  which accompanies this distribution.  The full text of the license may be found at\r
-  http://opensource.org/licenses/bsd-license.php\r
-\r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
-#include <IndustryStandard/Pci.h>\r
-#include <IndustryStandard/Acpi.h>\r
 #include <Library/DebugLib.h>\r
+#include <Library/XenHypercallLib.h>\r
 \r
 #include "XenBusDxe.h"\r
 \r
-#include "XenHypercall.h"\r
 #include "GrantTable.h"\r
+#include "XenStore.h"\r
+#include "XenBus.h"\r
 \r
+#include <IndustryStandard/Xen/hvm/params.h>\r
+#include <IndustryStandard/Xen/memory.h>\r
 \r
 ///\r
 /// Driver Binding Protocol instance\r
 ///\r
-EFI_DRIVER_BINDING_PROTOCOL gXenBusDxeDriverBinding = {\r
+EFI_DRIVER_BINDING_PROTOCOL  gXenBusDxeDriverBinding = {\r
   XenBusDxeDriverBindingSupported,\r
   XenBusDxeDriverBindingStart,\r
   XenBusDxeDriverBindingStop,\r
@@ -45,9 +41,48 @@ EFI_DRIVER_BINDING_PROTOCOL gXenBusDxeDriverBinding = {
   NULL\r
 };\r
 \r
-\r
 STATIC EFI_LOCK       mMyDeviceLock = EFI_INITIALIZE_LOCK_VARIABLE (TPL_CALLBACK);\r
-STATIC XENBUS_DEVICE *mMyDevice = NULL;\r
+STATIC XENBUS_DEVICE  *mMyDevice    = NULL;\r
+\r
+/**\r
+  Map the shared_info_t page into memory.\r
+\r
+  @param Dev    A XENBUS_DEVICE instance.\r
+\r
+  @retval EFI_SUCCESS     Dev->SharedInfo whill contain a pointer to\r
+                          the shared info page\r
+  @retval EFI_LOAD_ERROR  The shared info page could not be mapped. The\r
+                          hypercall returned an error.\r
+**/\r
+STATIC\r
+EFI_STATUS\r
+XenGetSharedInfoPage (\r
+  IN OUT XENBUS_DEVICE  *Dev\r
+  )\r
+{\r
+  xen_add_to_physmap_t  Parameter;\r
+\r
+  ASSERT (Dev->SharedInfo == NULL);\r
+\r
+  Parameter.domid = DOMID_SELF;\r
+  Parameter.space = XENMAPSPACE_shared_info;\r
+  Parameter.idx   = 0;\r
+\r
+  //\r
+  // using reserved page because the page is not released when Linux is\r
+  // starting because of the add_to_physmap. QEMU might try to access the\r
+  // page, and fail because it have no right to do so (segv).\r
+  //\r
+  Dev->SharedInfo = AllocateReservedPages (1);\r
+  Parameter.gpfn  = (UINTN)Dev->SharedInfo >> EFI_PAGE_SHIFT;\r
+  if (XenHypercallMemoryOp (XENMEM_add_to_physmap, &Parameter) != 0) {\r
+    FreePages (Dev->SharedInfo, 1);\r
+    Dev->SharedInfo = NULL;\r
+    return EFI_LOAD_ERROR;\r
+  }\r
+\r
+  return EFI_SUCCESS;\r
+}\r
 \r
 /**\r
   Unloads an image.\r
@@ -96,15 +131,17 @@ XenBusDxeUnload (
   //\r
   FreePool (HandleBuffer);\r
 \r
-\r
   //\r
   // Uninstall protocols installed in the driver entry point\r
   //\r
   Status = gBS->UninstallMultipleProtocolInterfaces (\r
                   ImageHandle,\r
-                  &gEfiDriverBindingProtocolGuid, &gXenBusDxeDriverBinding,\r
-                  &gEfiComponentNameProtocolGuid,  &gXenBusDxeComponentName,\r
-                  &gEfiComponentName2ProtocolGuid, &gXenBusDxeComponentName2,\r
+                  &gEfiDriverBindingProtocolGuid,\r
+                  &gXenBusDxeDriverBinding,\r
+                  &gEfiComponentNameProtocolGuid,\r
+                  &gXenBusDxeComponentName,\r
+                  &gEfiComponentName2ProtocolGuid,\r
+                  &gXenBusDxeComponentName2,\r
                   NULL\r
                   );\r
   if (EFI_ERROR (Status)) {\r
@@ -123,6 +160,7 @@ XenBusDxeUnload (
   @param  SystemTable           A pointer to the EFI System Table.\r
 \r
   @retval EFI_SUCCESS           The operation completed successfully.\r
+  @retval EFI_ABORTED           Xen hypercalls are not available.\r
   @retval Others                An unexpected error occurred.\r
 **/\r
 EFI_STATUS\r
@@ -134,6 +172,10 @@ XenBusDxeDriverEntryPoint (
 {\r
   EFI_STATUS  Status;\r
 \r
+  if (!XenHypercallIsAvailable ()) {\r
+    return EFI_ABORTED;\r
+  }\r
+\r
   //\r
   // Install UEFI Driver Model protocol(s).\r
   //\r
@@ -147,11 +189,9 @@ XenBusDxeDriverEntryPoint (
              );\r
   ASSERT_EFI_ERROR (Status);\r
 \r
-\r
   return Status;\r
 }\r
 \r
-\r
 /**\r
   Tests to see if this driver supports a given controller. If a child device is provided,\r
   it further tests to see if this driver supports creating a handle for the specified child device.\r
@@ -188,36 +228,28 @@ XenBusDxeDriverBindingSupported (
   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
   )\r
 {\r
-  EFI_STATUS          Status;\r
-  EFI_PCI_IO_PROTOCOL *PciIo;\r
-  PCI_TYPE00          Pci;\r
+  EFI_STATUS      Status;\r
+  XENIO_PROTOCOL  *XenIo;\r
 \r
   Status = gBS->OpenProtocol (\r
-                     ControllerHandle,\r
-                     &gEfiPciIoProtocolGuid,\r
-                     (VOID **)&PciIo,\r
-                     This->DriverBindingHandle,\r
-                     ControllerHandle,\r
-                     EFI_OPEN_PROTOCOL_BY_DRIVER\r
-                     );\r
+                  ControllerHandle,\r
+                  &gXenIoProtocolGuid,\r
+                  (VOID **)&XenIo,\r
+                  This->DriverBindingHandle,\r
+                  ControllerHandle,\r
+                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
+                  );\r
+\r
   if (EFI_ERROR (Status)) {\r
     return Status;\r
   }\r
 \r
-  Status = PciIo->Pci.Read (PciIo, EfiPciIoWidthUint32, 0,\r
-                            sizeof Pci / sizeof (UINT32), &Pci);\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
-      Status = EFI_SUCCESS;\r
-    } else {\r
-      Status = EFI_UNSUPPORTED;\r
-    }\r
-  }\r
-\r
-  gBS->CloseProtocol (ControllerHandle, &gEfiPciIoProtocolGuid,\r
-         This->DriverBindingHandle, ControllerHandle);\r
+  gBS->CloseProtocol (\r
+         ControllerHandle,\r
+         &gXenIoProtocolGuid,\r
+         This->DriverBindingHandle,\r
+         ControllerHandle\r
+         );\r
 \r
   return Status;\r
 }\r
@@ -225,14 +257,17 @@ XenBusDxeDriverBindingSupported (
 VOID\r
 EFIAPI\r
 NotifyExitBoot (\r
-  IN EFI_EVENT Event,\r
-  IN VOID *Context\r
+  IN EFI_EVENT  Event,\r
+  IN VOID       *Context\r
   )\r
 {\r
-  XENBUS_DEVICE *Dev = Context;\r
+  XENBUS_DEVICE  *Dev = Context;\r
 \r
-  gBS->DisconnectController(Dev->ControllerHandle,\r
-                            Dev->This->DriverBindingHandle, NULL);\r
+  gBS->DisconnectController (\r
+         Dev->ControllerHandle,\r
+         Dev->This->DriverBindingHandle,\r
+         NULL\r
+         );\r
 }\r
 \r
 /**\r
@@ -268,8 +303,8 @@ NotifyExitBoot (
   @retval EFI_DEVICE_ERROR         The device could not be started due to a device error.Currently not implemented.\r
   @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of resources.\r
   @retval EFI_UNSUPPORTED          Something is missing on the system that\r
-                                   prevent to start the edvice.\r
-  @retval Others                   The driver failded to start the device.\r
+                                   prevent to start the device.\r
+  @retval Others                   The driver failed to start the device.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -280,29 +315,44 @@ XenBusDxeDriverBindingStart (
   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
   )\r
 {\r
-  EFI_STATUS Status;\r
-  XENBUS_DEVICE *Dev;\r
-  EFI_PCI_IO_PROTOCOL *PciIo;\r
-  EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *BarDesc;\r
-  UINT64 MmioAddr;\r
+  EFI_STATUS                Status;\r
+  XENBUS_DEVICE             *Dev;\r
+  XENIO_PROTOCOL            *XenIo;\r
+  EFI_DEVICE_PATH_PROTOCOL  *DevicePath;\r
 \r
   Status = gBS->OpenProtocol (\r
-                     ControllerHandle,\r
-                     &gEfiPciIoProtocolGuid,\r
-                     (VOID **) &PciIo,\r
-                     This->DriverBindingHandle,\r
-                     ControllerHandle,\r
-                     EFI_OPEN_PROTOCOL_BY_DRIVER\r
-                     );\r
+                  ControllerHandle,\r
+                  &gXenIoProtocolGuid,\r
+                  (VOID **)&XenIo,\r
+                  This->DriverBindingHandle,\r
+                  ControllerHandle,\r
+                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
+                  );\r
+\r
   if (EFI_ERROR (Status)) {\r
     return Status;\r
   }\r
 \r
-  Dev = AllocateZeroPool (sizeof (*Dev));\r
-  Dev->Signature = XENBUS_DEVICE_SIGNATURE;\r
-  Dev->This = This;\r
+  Status = gBS->OpenProtocol (\r
+                  ControllerHandle,\r
+                  &gEfiDevicePathProtocolGuid,\r
+                  (VOID **)&DevicePath,\r
+                  This->DriverBindingHandle,\r
+                  ControllerHandle,\r
+                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
+                  );\r
+\r
+  if (EFI_ERROR (Status)) {\r
+    goto ErrorOpenningProtocol;\r
+  }\r
+\r
+  Dev                   = AllocateZeroPool (sizeof (*Dev));\r
+  Dev->Signature        = XENBUS_DEVICE_SIGNATURE;\r
+  Dev->This             = This;\r
   Dev->ControllerHandle = ControllerHandle;\r
-  Dev->PciIo = PciIo;\r
+  Dev->XenIo            = XenIo;\r
+  Dev->DevicePath       = DevicePath;\r
+  InitializeListHead (&Dev->ChildList);\r
 \r
   EfiAcquireLock (&mMyDeviceLock);\r
   if (mMyDevice != NULL) {\r
@@ -313,51 +363,50 @@ XenBusDxeDriverBindingStart (
     Status = EFI_ALREADY_STARTED;\r
     goto ErrorAllocated;\r
   }\r
+\r
   mMyDevice = Dev;\r
   EfiReleaseLock (&mMyDeviceLock);\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 ((EFI_D_INFO, "XenBus: BAR at %LX\n", BarDesc->AddrRangeMin));\r
-  MmioAddr = BarDesc->AddrRangeMin;\r
-  FreePool (BarDesc);\r
-\r
-  Status = XenHyperpageInit (Dev);\r
-  if (EFI_ERROR (Status)) {\r
-    DEBUG ((EFI_D_ERROR, "XenBus: Unable to retrieve the hyperpage.\n"));\r
-    Status = EFI_UNSUPPORTED;\r
-    goto ErrorAllocated;\r
-  }\r
-\r
   Status = XenGetSharedInfoPage (Dev);\r
   if (EFI_ERROR (Status)) {\r
-    DEBUG ((EFI_D_ERROR, "XenBus: Unable to get the shared info page.\n"));\r
+    DEBUG ((DEBUG_ERROR, "XenBus: Unable to get the shared info page.\n"));\r
     Status = EFI_UNSUPPORTED;\r
     goto ErrorAllocated;\r
   }\r
 \r
-  XenGrantTableInit (Dev, MmioAddr);\r
+  XenGrantTableInit (Dev);\r
+\r
+  Status = XenStoreInit (Dev);\r
+  ASSERT_EFI_ERROR (Status);\r
+\r
+  XenBusEnumerateBus (Dev);\r
 \r
-  Status = gBS->CreateEvent (EVT_SIGNAL_EXIT_BOOT_SERVICES, TPL_CALLBACK,\r
-                             NotifyExitBoot,\r
-                             (VOID*) Dev,\r
-                             &Dev->ExitBootEvent);\r
+  Status = gBS->CreateEvent (\r
+                  EVT_SIGNAL_EXIT_BOOT_SERVICES,\r
+                  TPL_CALLBACK,\r
+                  NotifyExitBoot,\r
+                  (VOID *)Dev,\r
+                  &Dev->ExitBootEvent\r
+                  );\r
   ASSERT_EFI_ERROR (Status);\r
 \r
   return EFI_SUCCESS;\r
 \r
 ErrorAllocated:\r
   FreePool (Dev);\r
-  gBS->CloseProtocol (ControllerHandle, &gEfiPciIoProtocolGuid,\r
-                      This->DriverBindingHandle, ControllerHandle);\r
+  gBS->CloseProtocol (\r
+         ControllerHandle,\r
+         &gEfiDevicePathProtocolGuid,\r
+         This->DriverBindingHandle,\r
+         ControllerHandle\r
+         );\r
+ErrorOpenningProtocol:\r
+  gBS->CloseProtocol (\r
+         ControllerHandle,\r
+         &gXenIoProtocolGuid,\r
+         This->DriverBindingHandle,\r
+         ControllerHandle\r
+         );\r
   return Status;\r
 }\r
 \r
@@ -396,13 +445,74 @@ XenBusDxeDriverBindingStop (
   IN EFI_HANDLE                   *ChildHandleBuffer OPTIONAL\r
   )\r
 {\r
-  XENBUS_DEVICE *Dev = mMyDevice;\r
+  UINTN                Index;\r
+  XENBUS_PROTOCOL      *XenBusIo;\r
+  XENBUS_PRIVATE_DATA  *ChildData;\r
+  EFI_STATUS           Status;\r
+  XENBUS_DEVICE        *Dev = mMyDevice;\r
+\r
+  for (Index = 0; Index < NumberOfChildren; Index++) {\r
+    Status = gBS->OpenProtocol (\r
+                    ChildHandleBuffer[Index],\r
+                    &gXenBusProtocolGuid,\r
+                    (VOID **)&XenBusIo,\r
+                    This->DriverBindingHandle,\r
+                    ControllerHandle,\r
+                    EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
+                    );\r
+    if (EFI_ERROR (Status)) {\r
+      DEBUG ((DEBUG_ERROR, "XenBusDxe: get children protocol failed: %r\n", Status));\r
+      continue;\r
+    }\r
+\r
+    ChildData = XENBUS_PRIVATE_DATA_FROM_THIS (XenBusIo);\r
+\r
+    Status = gBS->CloseProtocol (\r
+                    Dev->ControllerHandle,\r
+                    &gXenIoProtocolGuid,\r
+                    Dev->This->DriverBindingHandle,\r
+                    ChildData->Handle\r
+                    );\r
+    ASSERT_EFI_ERROR (Status);\r
+\r
+    Status = gBS->UninstallMultipleProtocolInterfaces (\r
+                    ChildData->Handle,\r
+                    &gEfiDevicePathProtocolGuid,\r
+                    ChildData->DevicePath,\r
+                    &gXenBusProtocolGuid,\r
+                    &ChildData->XenBusIo,\r
+                    NULL\r
+                    );\r
+    ASSERT_EFI_ERROR (Status);\r
+\r
+    FreePool ((VOID *)ChildData->XenBusIo.Type);\r
+    FreePool ((VOID *)ChildData->XenBusIo.Node);\r
+    FreePool ((VOID *)ChildData->XenBusIo.Backend);\r
+    FreePool (ChildData->DevicePath);\r
+    RemoveEntryList (&ChildData->Link);\r
+    FreePool (ChildData);\r
+  }\r
+\r
+  if (NumberOfChildren > 0) {\r
+    return EFI_SUCCESS;\r
+  }\r
 \r
   gBS->CloseEvent (Dev->ExitBootEvent);\r
+  XenStoreDeinit (Dev);\r
   XenGrantTableDeinit (Dev);\r
 \r
-  gBS->CloseProtocol (ControllerHandle, &gEfiPciIoProtocolGuid,\r
-         This->DriverBindingHandle, ControllerHandle);\r
+  gBS->CloseProtocol (\r
+         ControllerHandle,\r
+         &gEfiDevicePathProtocolGuid,\r
+         This->DriverBindingHandle,\r
+         ControllerHandle\r
+         );\r
+  gBS->CloseProtocol (\r
+         ControllerHandle,\r
+         &gXenIoProtocolGuid,\r
+         This->DriverBindingHandle,\r
+         ControllerHandle\r
+         );\r
 \r
   mMyDevice = NULL;\r
   FreePool (Dev);\r