OvmfPkg/XenBusDxe: Add Event Channel into XenBus protocol.

This patch adds three event channel related functions:
- EventChannelAllocate: Allocate an event channel port that can be bind
  from a specified domain.
- EventChannelNotify: Send an event to the remote end of a channel.
- EventChannelClose: Close a local event channel port.

Change in V3:
- eventchannel, update protocol to return error code.
- expand patch description
- Add comments in the XenBus Protocol header.

Change in V2:
- coding style
- adding comment to functions
- Rename Xenbus to XenBus.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Anthony PERARD <anthony.perard@citrix.com>
Reviewed-by: Jordan Justen <jordan.l.justen@intel.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@16271 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/OvmfPkg/Include/Protocol/XenBus.h b/OvmfPkg/Include/Protocol/XenBus.h
index 8d1fb52c22a908fd08812008985280a21363ce1e..4c1247bc9386d4bdfbc9a15bd21bb152dfd7a250 100644 (file)
--- a/OvmfPkg/Include/Protocol/XenBus.h
+++ b/OvmfPkg/Include/Protocol/XenBus.h
@@ -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
@@ -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
@@ -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

diff --git a/OvmfPkg/XenBusDxe/EventChannel.c b/OvmfPkg/XenBusDxe/EventChannel.c
index c4076c49eaea38054d590e2bbc12c58c6c331cd2..547c111aae499fc515b0f1bf9f8975d95fe6d68b 100644 (file)
--- a/OvmfPkg/XenBusDxe/EventChannel.c
+++ b/OvmfPkg/XenBusDxe/EventChannel.c
@@ -31,3 +31,58 @@ XenEventChannelNotify (
   ReturnCode = XenHypercallEventChannelOp (Dev, EVTCHNOP_send, &Send);\r
   return ReturnCode;\r
 }\r
+\r
+UINT32\r
+EFIAPI\r
+XenBusEventChannelAllocate (\r
+  IN  XENBUS_PROTOCOL *This,\r
+  IN  domid_t         DomainId,\r
+  OUT evtchn_port_t   *Port\r
+  )\r
+{\r
+  XENBUS_PRIVATE_DATA *Private;\r
+  evtchn_alloc_unbound_t Parameter;\r
+  UINT32 ReturnCode;\r
+\r
+  Private = XENBUS_PRIVATE_DATA_FROM_THIS (This);\r
+\r
+  Parameter.dom = DOMID_SELF;\r
+  Parameter.remote_dom = DomainId;\r
+  ReturnCode = XenHypercallEventChannelOp (Private->Dev,\r
+                                   EVTCHNOP_alloc_unbound,\r
+                                   &Parameter);\r
+  if (ReturnCode != 0) {\r
+    DEBUG ((EFI_D_ERROR, "ERROR: alloc_unbound failed with rc=%d", ReturnCode));\r
+    return ReturnCode;\r
+  }\r
+  *Port = Parameter.port;\r
+  return ReturnCode;\r
+}\r
+\r
+UINT32\r
+EFIAPI\r
+XenBusEventChannelNotify (\r
+  IN XENBUS_PROTOCOL *This,\r
+  IN evtchn_port_t   Port\r
+  )\r
+{\r
+  XENBUS_PRIVATE_DATA *Private;\r
+\r
+  Private = XENBUS_PRIVATE_DATA_FROM_THIS(This);\r
+  return XenEventChannelNotify (Private->Dev, Port);\r
+}\r
+\r
+UINT32\r
+EFIAPI\r
+XenBusEventChannelClose (\r
+  IN XENBUS_PROTOCOL *This,\r
+  IN evtchn_port_t   Port\r
+  )\r
+{\r
+  XENBUS_PRIVATE_DATA *Private;\r
+  evtchn_close_t Close;\r
+\r
+  Private = XENBUS_PRIVATE_DATA_FROM_THIS (This);\r
+  Close.port = Port;\r
+  return XenHypercallEventChannelOp (Private->Dev, EVTCHNOP_close, &Close);\r
+}\r

diff --git a/OvmfPkg/XenBusDxe/EventChannel.h b/OvmfPkg/XenBusDxe/EventChannel.h
index 5f3171d7ca289b36ec47e41f4c375ecb62be71c7..4dcc20f73bfc9989159eae70112fd83c11b229fe 100644 (file)
--- a/OvmfPkg/XenBusDxe/EventChannel.h
+++ b/OvmfPkg/XenBusDxe/EventChannel.h
@@ -33,4 +33,56 @@ XenEventChannelNotify (
   IN evtchn_port_t Port\r
   );\r
 \r
+/*\r
+ * XenBus protocol\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
+UINT32\r
+EFIAPI\r
+XenBusEventChannelAllocate (\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
+UINT32\r
+EFIAPI\r
+XenBusEventChannelNotify (\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
+UINT32\r
+EFIAPI\r
+XenBusEventChannelClose (\r
+  IN XENBUS_PROTOCOL *This,\r
+  IN evtchn_port_t   Port\r
+  );\r
+\r
 #endif\r

diff --git a/OvmfPkg/XenBusDxe/XenBus.c b/OvmfPkg/XenBusDxe/XenBus.c
index edd2d95217aa0e77d5393dbbae1cf8368e364d76..896a6607b73fce0d21225dbb7c585337721034b9 100644 (file)
--- a/OvmfPkg/XenBusDxe/XenBus.c
+++ b/OvmfPkg/XenBusDxe/XenBus.c
@@ -359,6 +359,9 @@ STATIC XENBUS_PRIVATE_DATA gXenBusPrivateData = {
   .XenBusIo.SetState = XenBusSetState,\r
   .XenBusIo.GrantAccess = XenBusGrantAccess,\r
   .XenBusIo.GrantEndAccess = XenBusGrantEndAccess,\r
+  .XenBusIo.EventChannelAllocate = XenBusEventChannelAllocate,\r
+  .XenBusIo.EventChannelNotify = XenBusEventChannelNotify,\r
+  .XenBusIo.EventChannelClose = XenBusEventChannelClose,\r
   .XenBusIo.RegisterWatch = XenBusRegisterWatch,\r
   .XenBusIo.RegisterWatchBackend = XenBusRegisterWatchBackend,\r
   .XenBusIo.UnregisterWatch = XenBusUnregisterWatch,\r