OvmfPkg/Virtio: take RingBaseShift in SetQueueAddress()

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

diff --git a/OvmfPkg/Include/Protocol/XenBus.h b/OvmfPkg/Include/Protocol/XenBus.h
index 8d1fb52c22a908fd08812008985280a21363ce1e..f5b1cbc44bf0588861142e3923bb4d0b907015a3 100644 (file)
--- a/OvmfPkg/Include/Protocol/XenBus.h
+++ b/OvmfPkg/Include/Protocol/XenBus.h
@@ -39,7 +39,7 @@ typedef struct
   UINT32 Id;\r
 } XENSTORE_TRANSACTION;\r
 \r
-#define XST_NIL ((XENSTORE_TRANSACTION) { 0 })\r
+#define XST_NIL ((XENSTORE_TRANSACTION *) NULL)\r
 \r
 typedef enum {\r
   XENSTORE_STATUS_SUCCESS = 0,\r
@@ -63,6 +63,7 @@ typedef enum {
 \r
 \r
 #include <IndustryStandard/Xen/grant_table.h>\r
+#include <IndustryStandard/Xen/event_channel.h>\r
 \r
 ///\r
 /// Function prototypes\r
@@ -87,7 +88,7 @@ typedef
 XENSTORE_STATUS\r
 (EFIAPI *XENBUS_XS_READ)(\r
   IN  XENBUS_PROTOCOL       *This,\r
-  IN  XENSTORE_TRANSACTION  Transaction,\r
+  IN  CONST XENSTORE_TRANSACTION *Transaction,\r
   IN  CONST CHAR8           *Node,\r
   OUT VOID                  **Result\r
   );\r
@@ -111,7 +112,7 @@ typedef
 XENSTORE_STATUS\r
 (EFIAPI *XENBUS_XS_BACKEND_READ)(\r
   IN  XENBUS_PROTOCOL       *This,\r
-  IN  XENSTORE_TRANSACTION  Transaction,\r
+  IN  CONST XENSTORE_TRANSACTION *Transaction,\r
   IN  CONST CHAR8           *Node,\r
   OUT VOID                  **Result\r
   );\r
@@ -133,7 +134,7 @@ typedef
 XENSTORE_STATUS\r
 (EFIAPI *XENBUS_XS_PRINTF) (\r
   IN XENBUS_PROTOCOL        *This,\r
-  IN XENSTORE_TRANSACTION   Transaction,\r
+  IN CONST XENSTORE_TRANSACTION *Transaction,\r
   IN CONST CHAR8            *Directory,\r
   IN CONST CHAR8            *Node,\r
   IN CONST CHAR8            *Format,\r
@@ -155,7 +156,7 @@ typedef
 XENSTORE_STATUS\r
 (EFIAPI *XENBUS_XS_REMOVE) (\r
   IN XENBUS_PROTOCOL        *This,\r
-  IN XENSTORE_TRANSACTION   Transaction,\r
+  IN CONST XENSTORE_TRANSACTION *Transaction,\r
   IN CONST CHAR8            *Node\r
   );\r
 \r
@@ -194,7 +195,7 @@ typedef
 XENSTORE_STATUS\r
 (EFIAPI *XENBUS_XS_TRANSACTION_END) (\r
   IN XENBUS_PROTOCOL        *This,\r
-  IN XENSTORE_TRANSACTION   Transaction,\r
+  IN CONST XENSTORE_TRANSACTION *Transaction,\r
   IN BOOLEAN                Abort\r
   );\r
 \r
@@ -212,7 +213,7 @@ typedef
 XENSTORE_STATUS\r
 (EFIAPI *XENBUS_SET_STATE)(\r
   IN XENBUS_PROTOCOL        *This,\r
-  IN XENSTORE_TRANSACTION   Transaction,\r
+  IN CONST XENSTORE_TRANSACTION *Transaction,\r
   IN XenBusState            State\r
   );\r
 \r
@@ -223,7 +224,7 @@ XENSTORE_STATUS
   @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
+  @param RefPtr     Reference number of the grant will be written to this pointer.\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -249,6 +250,54 @@ EFI_STATUS
   IN grant_ref_t      Ref\r
   );\r
 \r
+/**\r
+  Allocate a port that can be bind from domain DomainId.\r
+\r
+  @param This       A pointer to the XENBUS_PROTOCOL.\r
+  @param DomainId   The domain ID that can bind the newly allocated port.\r
+  @param Port       A pointer to a evtchn_port_t that will contain the newly\r
+                    allocated port.\r
+\r
+  @retval UINT32    The return value from the hypercall, 0 if success.\r
+**/\r
+typedef\r
+UINT32\r
+(EFIAPI *XENBUS_EVENT_CHANNEL_ALLOCATE) (\r
+  IN  XENBUS_PROTOCOL *This,\r
+  IN  domid_t         DomainId,\r
+  OUT evtchn_port_t   *Port\r
+  );\r
+\r
+/**\r
+  Send an event to the remote end of the channel whose local endpoint is Port.\r
+\r
+  @param This       A pointer to the XENBUS_PROTOCOL.\r
+  @param Port       Local port to the the event from.\r
+\r
+  @retval UINT32    The return value from the hypercall, 0 if success.\r
+**/\r
+typedef\r
+UINT32\r
+(EFIAPI *XENBUS_EVENT_CHANNEL_NOTIFY) (\r
+  IN XENBUS_PROTOCOL  *This,\r
+  IN evtchn_port_t    Port\r
+  );\r
+\r
+/**\r
+  Close a local event channel Port.\r
+\r
+  @param This       A pointer to the XENBUS_PROTOCOL.\r
+  @param Port       The event channel to close.\r
+\r
+  @retval UINT32    The return value from the hypercall, 0 if success.\r
+**/\r
+typedef\r
+UINT32\r
+(EFIAPI *XENBUS_EVENT_CHANNEL_CLOSE) (\r
+  IN XENBUS_PROTOCOL  *This,\r
+  IN evtchn_port_t    Port\r
+  );\r
+\r
 /**\r
   Register a XenStore watch.\r
 \r
@@ -261,7 +310,7 @@ EFI_STATUS
 \r
   @return  On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
            indicating the type of write failure.  EEXIST errors from the\r
-           XenStore are supressed, allowing multiple, physically different,\r
+           XenStore are suppressed, allowing multiple, physically different,\r
            xenbus_watch objects, to watch the same path in the XenStore.\r
 **/\r
 typedef\r
@@ -284,7 +333,7 @@ XENSTORE_STATUS
 \r
   @return  On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
            indicating the type of write failure.  EEXIST errors from the\r
-           XenStore are supressed, allowing multiple, physically different,\r
+           XenStore are suppressed, allowing multiple, physically different,\r
            xenbus_watch objects, to watch the same path in the XenStore.\r
 **/\r
 typedef\r
@@ -345,6 +394,10 @@ struct _XENBUS_PROTOCOL {
   XENBUS_GRANT_ACCESS           GrantAccess;\r
   XENBUS_GRANT_END_ACCESS       GrantEndAccess;\r
 \r
+  XENBUS_EVENT_CHANNEL_ALLOCATE EventChannelAllocate;\r
+  XENBUS_EVENT_CHANNEL_NOTIFY   EventChannelNotify;\r
+  XENBUS_EVENT_CHANNEL_CLOSE    EventChannelClose;\r
+\r
   XENBUS_REGISTER_WATCH         RegisterWatch;\r
   XENBUS_REGISTER_WATCH_BACKEND RegisterWatchBackend;\r
   XENBUS_UNREGISTER_WATCH       UnregisterWatch;\r