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, 128 insertions, 0 deletions

diff --git a/OvmfPkg/XenBusDxe/DriverBinding.h b/OvmfPkg/XenBusDxe/DriverBinding.h
new file mode 100644
index 0000000000..693b5c0f50
--- /dev/null
+++ b/OvmfPkg/XenBusDxe/DriverBinding.h
@@ -0,0 +1,128 @@
+/** @file

+  Driver Binding functions declaration for XenBus Bus driver.

+

+  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.

+

+**/

+

+/**

+  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

+  );

+

+/**

+  Starts a device controller or 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

+  );

+

+/**

+  Stops a device controller or 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

+  );