Ovmf/Xen: introduce XENIO_PROTOCOL

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

diff --git a/OvmfPkg/Include/Protocol/XenIo.h b/OvmfPkg/Include/Protocol/XenIo.h
new file mode 100644 (file)
index 0000000..510391f
--- /dev/null
+++ b/OvmfPkg/Include/Protocol/XenIo.h
@@ -0,0 +1,48 @@
+/** @file\r
+  XenIo protocol to abstract arch specific details\r
+\r
+  The Xen implementations for the Intel and ARM archictures differ in the way\r
+  the base address of the grant table is communicated to the guest. The former\r
+  uses a virtual PCI device, while the latter uses a device tree node.\r
+  In order to allow the XenBusDxe UEFI driver to be reused for the non-PCI\r
+  Xen implementation, this abstract protocol can be installed on a handle\r
+  with the appropriate base address.\r
+\r
+  Copyright (C) 2014, Linaro 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_XENIO_H__\r
+#define __PROTOCOL_XENIO_H__\r
+\r
+#include <IndustryStandard/Xen/xen.h>\r
+\r
+#define XENIO_PROTOCOL_GUID \\r
+  {0x6efac84f, 0x0ab0, 0x4747, {0x81, 0xbe, 0x85, 0x55, 0x62, 0x59, 0x04, 0x49}}\r
+\r
+///\r
+/// Forward declaration\r
+///\r
+typedef struct _XENIO_PROTOCOL XENIO_PROTOCOL;\r
+\r
+///\r
+/// Protocol structure\r
+///\r
+struct _XENIO_PROTOCOL {\r
+  //\r
+  // Protocol data fields\r
+  //\r
+  EFI_PHYSICAL_ADDRESS          GrantTableAddress;\r
+};\r
+\r
+extern EFI_GUID gXenIoProtocolGuid;\r
+\r
+#endif\r