include/hw/xen/xen-bus.h

   1 /*
   2  * Copyright (c) 2018  Citrix Systems Inc.
   3  *
   4  * This work is licensed under the terms of the GNU GPL, version 2 or later.
   5  * See the COPYING file in the top-level directory.
   6  */
   7
   8 #ifndef HW_XEN_BUS_H
   9 #define HW_XEN_BUS_H
  10
  11 #include "hw/xen/xen_common.h"
  12 #include "hw/sysbus.h"
  13 #include "qemu/notify.h"
  14 #include "qom/object.h"
  15
  16 typedef void (*XenWatchHandler)(void *opaque);
  17
  18 typedef struct XenWatchList XenWatchList;
  19 typedef struct XenWatch XenWatch;
  20 typedef struct XenEventChannel XenEventChannel;
  21
  22 struct XenDevice {
  23     DeviceState qdev;
  24     domid_t frontend_id;
  25     char *name;
  26     struct xs_handle *xsh;
  27     XenWatchList *watch_list;
  28     char *backend_path, *frontend_path;
  29     enum xenbus_state backend_state, frontend_state;
  30     Notifier exit;
  31     XenWatch *backend_state_watch, *frontend_state_watch;
  32     bool backend_online;
  33     XenWatch *backend_online_watch;
  34     xengnttab_handle *xgth;
  35     bool feature_grant_copy;
  36     bool inactive;
  37     QLIST_HEAD(, XenEventChannel) event_channels;
  38     QLIST_ENTRY(XenDevice) list;
  39 };
  40 typedef struct XenDevice XenDevice;
  41
  42 typedef char *(*XenDeviceGetName)(XenDevice *xendev, Error **errp);
  43 typedef void (*XenDeviceRealize)(XenDevice *xendev, Error **errp);
  44 typedef void (*XenDeviceFrontendChanged)(XenDevice *xendev,
  45                                          enum xenbus_state frontend_state,
  46                                          Error **errp);
  47 typedef void (*XenDeviceUnrealize)(XenDevice *xendev);
  48
  49 struct XenDeviceClass {
  50     /*< private >*/
  51     DeviceClass parent_class;
  52     /*< public >*/
  53     const char *backend;
  54     const char *device;
  55     XenDeviceGetName get_name;
  56     XenDeviceRealize realize;
  57     XenDeviceFrontendChanged frontend_changed;
  58     XenDeviceUnrealize unrealize;
  59 };
  60
  61 #define TYPE_XEN_DEVICE "xen-device"
  62 OBJECT_DECLARE_TYPE(XenDevice, XenDeviceClass, XEN_DEVICE)
  63
  64 struct XenBus {
  65     BusState qbus;
  66     domid_t backend_id;
  67     struct xs_handle *xsh;
  68     XenWatchList *watch_list;
  69     XenWatch *backend_watch;
  70     QLIST_HEAD(, XenDevice) inactive_devices;
  71 };
  72
  73 struct XenBusClass {
  74     /*< private >*/
  75     BusClass parent_class;
  76 };
  77
  78 #define TYPE_XEN_BUS "xen-bus"
  79 OBJECT_DECLARE_TYPE(XenBus, XenBusClass,
  80                     XEN_BUS)
  81
  82 void xen_bus_init(void);
  83
  84 void xen_device_backend_set_state(XenDevice *xendev,
  85                                   enum xenbus_state state);
  86 enum xenbus_state xen_device_backend_get_state(XenDevice *xendev);
  87
  88 void xen_device_backend_printf(XenDevice *xendev, const char *key,
  89                                const char *fmt, ...)
  90     GCC_FMT_ATTR(3, 4);
  91 void xen_device_frontend_printf(XenDevice *xendev, const char *key,
  92                                 const char *fmt, ...)
  93     GCC_FMT_ATTR(3, 4);
  94
  95 int xen_device_frontend_scanf(XenDevice *xendev, const char *key,
  96                               const char *fmt, ...);
  97
  98 void xen_device_set_max_grant_refs(XenDevice *xendev, unsigned int nr_refs,
  99                                    Error **errp);
 100 void *xen_device_map_grant_refs(XenDevice *xendev, uint32_t *refs,
 101                                 unsigned int nr_refs, int prot,
 102                                 Error **errp);
 103 void xen_device_unmap_grant_refs(XenDevice *xendev, void *map,
 104                                  unsigned int nr_refs, Error **errp);
 105
 106 typedef struct XenDeviceGrantCopySegment {
 107     union {
 108         void *virt;
 109         struct {
 110             uint32_t ref;
 111             off_t offset;
 112         } foreign;
 113     } source, dest;
 114     size_t len;
 115 } XenDeviceGrantCopySegment;
 116
 117 void xen_device_copy_grant_refs(XenDevice *xendev, bool to_domain,
 118                                 XenDeviceGrantCopySegment segs[],
 119                                 unsigned int nr_segs, Error **errp);
 120
 121 typedef bool (*XenEventHandler)(void *opaque);
 122
 123 XenEventChannel *xen_device_bind_event_channel(XenDevice *xendev,
 124                                                unsigned int port,
 125                                                XenEventHandler handler,
 126                                                void *opaque, Error **errp);
 127 void xen_device_set_event_channel_context(XenDevice *xendev,
 128                                           XenEventChannel *channel,
 129                                           AioContext *ctx,
 130                                           Error **errp);
 131 void xen_device_notify_event_channel(XenDevice *xendev,
 132                                      XenEventChannel *channel,
 133                                      Error **errp);
 134 void xen_device_unbind_event_channel(XenDevice *xendev,
 135                                      XenEventChannel *channel,
 136                                      Error **errp);
 137
 138 #endif /* HW_XEN_BUS_H */