OvmfPkg: Add basic skeleton for the XenBus bus driver.

This includes Component Name and Driver Binding.

Change in V4:
- Replace the license by the commonly used file header text.
- Add brief description for the driver.

Change in V3:
- enable compilation for Ia32 and Ia32X64
- fix version (driver binding)

Change in V2:
- Simple support of controller name.
- Cleaning up comments, files header.
- Add Licenses
- Rename XenbusDxe to XenBusDxe.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Anthony PERARD <anthony.perard@citrix.com>
Reviewed-by: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
Reviewed-by: Jordan Justen <jordan.l.justen@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@16258 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 301 insertions, 0 deletions

diff --git a/OvmfPkg/XenBusDxe/XenBusDxe.c b/OvmfPkg/XenBusDxe/XenBusDxe.c
new file mode 100644
index 0000000000..7f297bdeae
--- /dev/null
+++ b/OvmfPkg/XenBusDxe/XenBusDxe.c
@@ -0,0 +1,301 @@
+/** @file

+  This driver produces XenBus Protocol instances for each Xen PV devices.

+

+  This XenBus bus driver will first initialize differente services in order to

+  enumerate the ParaVirtualized devices available.

+

+  Those services are:

+    - HyperCall

+    - Event Channel

+    - Grant Table

+    - XenStore

+    - XenBus

+

+  Copyright (C) 2014, Citrix Ltd.

+

+  This program and the accompanying materials

+  are licensed and made available under the terms and conditions of the BSD License

+  which accompanies this distribution.  The full text of the license may be found at

+  http://opensource.org/licenses/bsd-license.php

+

+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+

+**/

+

+#include <IndustryStandard/Pci.h>

+#include <IndustryStandard/Acpi.h>

+#include <Library/DebugLib.h>

+

+#include "XenBusDxe.h"

+

+

+///

+/// Driver Binding Protocol instance

+///

+EFI_DRIVER_BINDING_PROTOCOL gXenBusDxeDriverBinding = {

+  XenBusDxeDriverBindingSupported,

+  XenBusDxeDriverBindingStart,

+  XenBusDxeDriverBindingStop,

+  XENBUS_DXE_VERSION,

+  NULL,

+  NULL

+};

+

+

+/**

+  Unloads an image.

+

+  @param  ImageHandle           Handle that identifies the image to be unloaded.

+

+  @retval EFI_SUCCESS           The image has been unloaded.

+  @retval EFI_INVALID_PARAMETER ImageHandle is not a valid image handle.

+

+**/

+EFI_STATUS

+EFIAPI

+XenBusDxeUnload (

+  IN EFI_HANDLE  ImageHandle

+  )

+{

+  EFI_STATUS  Status;

+

+  EFI_HANDLE  *HandleBuffer;

+  UINTN       HandleCount;

+  UINTN       Index;

+

+  //

+  // Retrieve array of all handles in the handle database

+  //

+  Status = gBS->LocateHandleBuffer (

+                  AllHandles,

+                  NULL,

+                  NULL,

+                  &HandleCount,

+                  &HandleBuffer

+                  );

+  if (EFI_ERROR (Status)) {

+    return Status;

+  }

+

+  //

+  // Disconnect the current driver from handles in the handle database

+  //

+  for (Index = 0; Index < HandleCount; Index++) {

+    gBS->DisconnectController (HandleBuffer[Index], gImageHandle, NULL);

+  }

+

+  //

+  // Free the array of handles

+  //

+  FreePool (HandleBuffer);

+

+

+  //

+  // Uninstall protocols installed in the driver entry point

+  //

+  Status = gBS->UninstallMultipleProtocolInterfaces (

+                  ImageHandle,

+                  &gEfiDriverBindingProtocolGuid, &gXenBusDxeDriverBinding,

+                  &gEfiComponentNameProtocolGuid,  &gXenBusDxeComponentName,

+                  &gEfiComponentName2ProtocolGuid, &gXenBusDxeComponentName2,

+                  NULL

+                  );

+  if (EFI_ERROR (Status)) {

+    return Status;

+  }

+

+  return EFI_SUCCESS;

+}

+

+/**

+  This is the declaration of an EFI image entry point. This entry point is

+  the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including

+  both device drivers and bus drivers.

+

+  @param  ImageHandle           The firmware allocated handle for the UEFI image.

+  @param  SystemTable           A pointer to the EFI System Table.

+

+  @retval EFI_SUCCESS           The operation completed successfully.

+  @retval Others                An unexpected error occurred.

+**/

+EFI_STATUS

+EFIAPI

+XenBusDxeDriverEntryPoint (

+  IN EFI_HANDLE        ImageHandle,

+  IN EFI_SYSTEM_TABLE  *SystemTable

+  )

+{

+  EFI_STATUS  Status;

+

+  //

+  // Install UEFI Driver Model protocol(s).

+  //

+  Status = EfiLibInstallDriverBindingComponentName2 (

+             ImageHandle,

+             SystemTable,

+             &gXenBusDxeDriverBinding,

+             ImageHandle,

+             &gXenBusDxeComponentName,

+             &gXenBusDxeComponentName2

+             );

+  ASSERT_EFI_ERROR (Status);

+

+

+  return Status;

+}

+

+

+/**

+  Tests to see if this driver supports a given controller. If a child device is provided,

+  it further tests to see if this driver supports creating a handle for the specified child device.

+

+  @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.

+  @param[in]  ControllerHandle     The handle of the controller to test. This handle

+                                   must support a protocol interface that supplies

+                                   an I/O abstraction to the driver.

+  @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path.  This

+                                   parameter is ignored by device drivers, and is optional for bus

+                                   drivers. For bus drivers, if this parameter is not NULL, then

+                                   the bus driver must determine if the bus controller specified

+                                   by ControllerHandle and the child controller specified

+                                   by RemainingDevicePath are both supported by this

+                                   bus driver.

+

+  @retval EFI_SUCCESS              The device specified by ControllerHandle and

+                                   RemainingDevicePath is supported by the driver specified by This.

+  @retval EFI_ALREADY_STARTED      The device specified by ControllerHandle and

+                                   RemainingDevicePath is already being managed by the driver

+                                   specified by This.

+  @retval EFI_ACCESS_DENIED        The device specified by ControllerHandle and

+                                   RemainingDevicePath is already being managed by a different

+                                   driver or an application that requires exclusive access.

+                                   Currently not implemented.

+  @retval EFI_UNSUPPORTED          The device specified by ControllerHandle and

+                                   RemainingDevicePath is not supported by the driver specified by This.

+**/

+EFI_STATUS

+EFIAPI

+XenBusDxeDriverBindingSupported (

+  IN EFI_DRIVER_BINDING_PROTOCOL  *This,

+  IN EFI_HANDLE                   ControllerHandle,

+  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL

+  )

+{

+  EFI_STATUS          Status;

+  EFI_PCI_IO_PROTOCOL *PciIo;

+  PCI_TYPE00          Pci;

+

+  Status = gBS->OpenProtocol (

+                     ControllerHandle,

+                     &gEfiPciIoProtocolGuid,

+                     (VOID **)&PciIo,

+                     This->DriverBindingHandle,

+                     ControllerHandle,

+                     EFI_OPEN_PROTOCOL_BY_DRIVER

+                     );

+  if (EFI_ERROR (Status)) {

+    return Status;

+  }

+

+  Status = PciIo->Pci.Read (PciIo, EfiPciIoWidthUint32, 0,

+                            sizeof Pci / sizeof (UINT32), &Pci);

+

+  if (Status == EFI_SUCCESS) {

+    if (Pci.Hdr.VendorId == PCI_VENDOR_ID_XEN &&

+        Pci.Hdr.DeviceId == PCI_DEVICE_ID_XEN_PLATFORM) {

+      Status = EFI_SUCCESS;

+    } else {

+      Status = EFI_UNSUPPORTED;

+    }

+  }

+

+  gBS->CloseProtocol (ControllerHandle, &gEfiPciIoProtocolGuid,

+         This->DriverBindingHandle, ControllerHandle);

+

+  return Status;

+}

+

+/**

+  Starts a bus controller.

+

+  The Start() function is designed to be invoked from the EFI boot service ConnectController().

+  As a result, much of the error checking on the parameters to Start() has been moved into this

+  common boot service. It is legal to call Start() from other locations,

+  but the following calling restrictions must be followed, or the system behavior will not be deterministic.

+  1. ControllerHandle must be a valid EFI_HANDLE.

+  2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned

+     EFI_DEVICE_PATH_PROTOCOL.

+  3. Prior to calling Start(), the Supported() function for the driver specified by This must

+     have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.

+

+  @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.

+  @param[in]  ControllerHandle     The handle of the controller to start. This handle

+                                   must support a protocol interface that supplies

+                                   an I/O abstraction to the driver.

+  @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path.  This

+                                   parameter is ignored by device drivers, and is optional for bus

+                                   drivers. For a bus driver, if this parameter is NULL, then handles

+                                   for all the children of Controller are created by this driver.

+                                   If this parameter is not NULL and the first Device Path Node is

+                                   not the End of Device Path Node, then only the handle for the

+                                   child device specified by the first Device Path Node of

+                                   RemainingDevicePath is created by this driver.

+                                   If the first Device Path Node of RemainingDevicePath is

+                                   the End of Device Path Node, no child handle is created by this

+                                   driver.

+

+  @retval EFI_SUCCESS              The device was started.

+  @retval EFI_DEVICE_ERROR         The device could not be started due to a device error.Currently not implemented.

+  @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of resources.

+  @retval Others                   The driver failded to start the device.

+

+**/

+EFI_STATUS

+EFIAPI

+XenBusDxeDriverBindingStart (

+  IN EFI_DRIVER_BINDING_PROTOCOL  *This,

+  IN EFI_HANDLE                   ControllerHandle,

+  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL

+  )

+{

+  return EFI_UNSUPPORTED;

+}

+

+/**

+  Stops a bus controller.

+

+  The Stop() function is designed to be invoked from the EFI boot service DisconnectController().

+  As a result, much of the error checking on the parameters to Stop() has been moved

+  into this common boot service. It is legal to call Stop() from other locations,

+  but the following calling restrictions must be followed, or the system behavior will not be deterministic.

+  1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this

+     same driver's Start() function.

+  2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid

+     EFI_HANDLE. In addition, all of these handles must have been created in this driver's

+     Start() function, and the Start() function must have called OpenProtocol() on

+     ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.

+

+  @param[in]  This              A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.

+  @param[in]  ControllerHandle  A handle to the device being stopped. The handle must

+                                support a bus specific I/O protocol for the driver

+                                to use to stop the device.

+  @param[in]  NumberOfChildren  The number of child device handles in ChildHandleBuffer.

+  @param[in]  ChildHandleBuffer An array of child handles to be freed. May be NULL

+                                if NumberOfChildren is 0.

+

+  @retval EFI_SUCCESS           The device was stopped.

+  @retval EFI_DEVICE_ERROR      The device could not be stopped due to a device error.

+

+**/

+EFI_STATUS

+EFIAPI

+XenBusDxeDriverBindingStop (

+  IN EFI_DRIVER_BINDING_PROTOCOL  *This,

+  IN EFI_HANDLE                   ControllerHandle,

+  IN UINTN                        NumberOfChildren,

+  IN EFI_HANDLE                   *ChildHandleBuffer OPTIONAL

+  )

+{

+  return EFI_UNSUPPORTED;

+}