OvmfPkg: Introduce XenBus Protocol.

[mirror_edk2.git] / OvmfPkg / Include / Protocol / XenBus.h

diff --git a/OvmfPkg/Include/Protocol/XenBus.h b/OvmfPkg/Include/Protocol/XenBus.h
new file mode 100644 (file)
index 0000000..89bf74f
--- /dev/null
+++ b/OvmfPkg/Include/Protocol/XenBus.h
@@ -0,0 +1,92 @@
+\r
+/** @file\r
+  XenBus protocol to be used between the XenBus bus driver and Xen PV devices.\r
+\r
+  DISCLAIMER: the XENBUS_PROTOCOL introduced here is a work in progress, and\r
+  should not be used outside of the EDK II tree.\r
+\r
+  This protocol provide the necessary for a Xen PV driver frontend to\r
+  communicate with the bus driver, and perform several task to\r
+  initialize/shutdown a PV device and perform IO with a PV backend.\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
+\r
+**/\r
+\r
+#ifndef __PROTOCOL_XENBUS_H__\r
+#define __PROTOCOL_XENBUS_H__\r
+\r
+#define XENBUS_PROTOCOL_GUID \\r
+  {0x3d3ca290, 0xb9a5, 0x11e3, {0xb7, 0x5d, 0xb8, 0xac, 0x6f, 0x7d, 0x65, 0xe6}}\r
+\r
+///\r
+/// Forward declaration\r
+///\r
+typedef struct _XENBUS_PROTOCOL XENBUS_PROTOCOL;\r
+\r
+\r
+#include <IndustryStandard/Xen/grant_table.h>\r
+\r
+///\r
+/// Function prototypes\r
+///\r
+\r
+/**\r
+  Grant access to the page Frame to the domain DomainId.\r
+\r
+  @param This       A pointer to XENBUS_PROTOCOL instance.\r
+  @param DomainId   ID of the domain to grant acces to.\r
+  @param Frame      Frame Number of the page to grant access to.\r
+  @param ReadOnly   Provide read-only or read-write access.\r
+  @param RefPtr     Reference number of the grant will be writen to this pointer.\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *XENBUS_GRANT_ACCESS)(\r
+  IN  XENBUS_PROTOCOL *This,\r
+  IN  domid_t         DomainId,\r
+  IN  UINTN           Frame,\r
+  IN  BOOLEAN         ReadOnly,\r
+  OUT grant_ref_t     *refp\r
+  );\r
+\r
+/**\r
+  End access to grant Ref, previously return by XenBusGrantAccess.\r
+\r
+  @param This       A pointer to XENBUS_PROTOCOL instance.\r
+  @param Ref        Reference numeber of a grant previously returned by\r
+                    XenBusGrantAccess.\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *XENBUS_GRANT_END_ACCESS)(\r
+  IN XENBUS_PROTOCOL  *This,\r
+  IN grant_ref_t      Ref\r
+  );\r
+\r
+\r
+///\r
+/// Protocol structure\r
+///\r
+/// DISCLAIMER: the XENBUS_PROTOCOL introduced here is a work in progress, and\r
+/// should not be used outside of the EDK II tree.\r
+///\r
+struct _XENBUS_PROTOCOL {\r
+  XENBUS_GRANT_ACCESS           GrantAccess;\r
+  XENBUS_GRANT_END_ACCESS       GrantEndAccess;\r
+  //\r
+  // Protocol data fields\r
+  //\r
+};\r
+\r
+extern EFI_GUID gXenBusProtocolGuid;\r
+\r
+#endif\r