1108f7bbaSPaul Durrant /* 2108f7bbaSPaul Durrant * Copyright (c) 2018 Citrix Systems Inc. 3108f7bbaSPaul Durrant * 4108f7bbaSPaul Durrant * This work is licensed under the terms of the GNU GPL, version 2 or later. 5108f7bbaSPaul Durrant * See the COPYING file in the top-level directory. 6108f7bbaSPaul Durrant */ 7108f7bbaSPaul Durrant 8108f7bbaSPaul Durrant #ifndef HW_XEN_BUS_H 9108f7bbaSPaul Durrant #define HW_XEN_BUS_H 10108f7bbaSPaul Durrant 11094a2239SPaul Durrant #include "hw/xen/xen_common.h" 12108f7bbaSPaul Durrant #include "hw/sysbus.h" 1382a29e30SPaul Durrant #include "qemu/notify.h" 1482a29e30SPaul Durrant 1582a29e30SPaul Durrant typedef void (*XenWatchHandler)(void *opaque); 1682a29e30SPaul Durrant 1782a29e30SPaul Durrant typedef struct XenWatch XenWatch; 18108f7bbaSPaul Durrant 19108f7bbaSPaul Durrant typedef struct XenDevice { 20108f7bbaSPaul Durrant DeviceState qdev; 21094a2239SPaul Durrant domid_t frontend_id; 22094a2239SPaul Durrant char *name; 23094a2239SPaul Durrant char *backend_path, *frontend_path; 24094a2239SPaul Durrant enum xenbus_state backend_state, frontend_state; 25094a2239SPaul Durrant Notifier exit; 26*b6af8926SPaul Durrant XenWatch *backend_state_watch, *frontend_state_watch; 27*b6af8926SPaul Durrant bool backend_online; 28*b6af8926SPaul Durrant XenWatch *backend_online_watch; 294b34b5b1SPaul Durrant xengnttab_handle *xgth; 304b34b5b1SPaul Durrant bool feature_grant_copy; 31a3d669c8SPaul Durrant xenevtchn_handle *xeh; 32a3d669c8SPaul Durrant NotifierList event_notifiers; 33108f7bbaSPaul Durrant } XenDevice; 34108f7bbaSPaul Durrant 35094a2239SPaul Durrant typedef char *(*XenDeviceGetName)(XenDevice *xendev, Error **errp); 36108f7bbaSPaul Durrant typedef void (*XenDeviceRealize)(XenDevice *xendev, Error **errp); 3782a29e30SPaul Durrant typedef void (*XenDeviceFrontendChanged)(XenDevice *xendev, 3882a29e30SPaul Durrant enum xenbus_state frontend_state, 3982a29e30SPaul Durrant Error **errp); 40108f7bbaSPaul Durrant typedef void (*XenDeviceUnrealize)(XenDevice *xendev, Error **errp); 41108f7bbaSPaul Durrant 42108f7bbaSPaul Durrant typedef struct XenDeviceClass { 43108f7bbaSPaul Durrant /*< private >*/ 44108f7bbaSPaul Durrant DeviceClass parent_class; 45108f7bbaSPaul Durrant /*< public >*/ 46094a2239SPaul Durrant const char *backend; 47094a2239SPaul Durrant const char *device; 48094a2239SPaul Durrant XenDeviceGetName get_name; 49108f7bbaSPaul Durrant XenDeviceRealize realize; 5082a29e30SPaul Durrant XenDeviceFrontendChanged frontend_changed; 51108f7bbaSPaul Durrant XenDeviceUnrealize unrealize; 52108f7bbaSPaul Durrant } XenDeviceClass; 53108f7bbaSPaul Durrant 54108f7bbaSPaul Durrant #define TYPE_XEN_DEVICE "xen-device" 55108f7bbaSPaul Durrant #define XEN_DEVICE(obj) \ 56108f7bbaSPaul Durrant OBJECT_CHECK(XenDevice, (obj), TYPE_XEN_DEVICE) 57108f7bbaSPaul Durrant #define XEN_DEVICE_CLASS(class) \ 58108f7bbaSPaul Durrant OBJECT_CLASS_CHECK(XenDeviceClass, (class), TYPE_XEN_DEVICE) 59108f7bbaSPaul Durrant #define XEN_DEVICE_GET_CLASS(obj) \ 60108f7bbaSPaul Durrant OBJECT_GET_CLASS(XenDeviceClass, (obj), TYPE_XEN_DEVICE) 61108f7bbaSPaul Durrant 62108f7bbaSPaul Durrant typedef struct XenBus { 63108f7bbaSPaul Durrant BusState qbus; 64094a2239SPaul Durrant domid_t backend_id; 65094a2239SPaul Durrant struct xs_handle *xsh; 6682a29e30SPaul Durrant NotifierList watch_notifiers; 67108f7bbaSPaul Durrant } XenBus; 68108f7bbaSPaul Durrant 69108f7bbaSPaul Durrant typedef struct XenBusClass { 70108f7bbaSPaul Durrant /*< private >*/ 71108f7bbaSPaul Durrant BusClass parent_class; 72108f7bbaSPaul Durrant } XenBusClass; 73108f7bbaSPaul Durrant 74108f7bbaSPaul Durrant #define TYPE_XEN_BUS "xen-bus" 75108f7bbaSPaul Durrant #define XEN_BUS(obj) \ 76108f7bbaSPaul Durrant OBJECT_CHECK(XenBus, (obj), TYPE_XEN_BUS) 77108f7bbaSPaul Durrant #define XEN_BUS_CLASS(class) \ 78108f7bbaSPaul Durrant OBJECT_CLASS_CHECK(XenBusClass, (class), TYPE_XEN_BUS) 79108f7bbaSPaul Durrant #define XEN_BUS_GET_CLASS(obj) \ 80108f7bbaSPaul Durrant OBJECT_GET_CLASS(XenBusClass, (obj), TYPE_XEN_BUS) 81108f7bbaSPaul Durrant 82108f7bbaSPaul Durrant void xen_bus_init(void); 83108f7bbaSPaul Durrant 8482a29e30SPaul Durrant void xen_device_backend_set_state(XenDevice *xendev, 8582a29e30SPaul Durrant enum xenbus_state state); 8682a29e30SPaul Durrant enum xenbus_state xen_device_backend_get_state(XenDevice *xendev); 8782a29e30SPaul Durrant 88*b6af8926SPaul Durrant void xen_device_backend_printf(XenDevice *xendev, const char *key, 89*b6af8926SPaul Durrant const char *fmt, ...) 90*b6af8926SPaul Durrant GCC_FMT_ATTR(3, 4); 91*b6af8926SPaul Durrant void xen_device_frontend_printf(XenDevice *xendev, const char *key, 92*b6af8926SPaul Durrant const char *fmt, ...) 93*b6af8926SPaul Durrant GCC_FMT_ATTR(3, 4); 94*b6af8926SPaul Durrant 95*b6af8926SPaul Durrant int xen_device_frontend_scanf(XenDevice *xendev, const char *key, 96*b6af8926SPaul Durrant const char *fmt, ...); 97*b6af8926SPaul Durrant 984b34b5b1SPaul Durrant void xen_device_set_max_grant_refs(XenDevice *xendev, unsigned int nr_refs, 994b34b5b1SPaul Durrant Error **errp); 1004b34b5b1SPaul Durrant void *xen_device_map_grant_refs(XenDevice *xendev, uint32_t *refs, 1014b34b5b1SPaul Durrant unsigned int nr_refs, int prot, 1024b34b5b1SPaul Durrant Error **errp); 1034b34b5b1SPaul Durrant void xen_device_unmap_grant_refs(XenDevice *xendev, void *map, 1044b34b5b1SPaul Durrant unsigned int nr_refs, Error **errp); 1054b34b5b1SPaul Durrant 1064b34b5b1SPaul Durrant typedef struct XenDeviceGrantCopySegment { 1074b34b5b1SPaul Durrant union { 1084b34b5b1SPaul Durrant void *virt; 1094b34b5b1SPaul Durrant struct { 1104b34b5b1SPaul Durrant uint32_t ref; 1114b34b5b1SPaul Durrant off_t offset; 1124b34b5b1SPaul Durrant } foreign; 1134b34b5b1SPaul Durrant } source, dest; 1144b34b5b1SPaul Durrant size_t len; 1154b34b5b1SPaul Durrant } XenDeviceGrantCopySegment; 1164b34b5b1SPaul Durrant 1174b34b5b1SPaul Durrant void xen_device_copy_grant_refs(XenDevice *xendev, bool to_domain, 1184b34b5b1SPaul Durrant XenDeviceGrantCopySegment segs[], 1194b34b5b1SPaul Durrant unsigned int nr_segs, Error **errp); 1204b34b5b1SPaul Durrant 121a3d669c8SPaul Durrant typedef struct XenEventChannel XenEventChannel; 122a3d669c8SPaul Durrant 123a3d669c8SPaul Durrant typedef void (*XenEventHandler)(void *opaque); 124a3d669c8SPaul Durrant 125a3d669c8SPaul Durrant XenEventChannel *xen_device_bind_event_channel(XenDevice *xendev, 126a3d669c8SPaul Durrant unsigned int port, 127a3d669c8SPaul Durrant XenEventHandler handler, 128a3d669c8SPaul Durrant void *opaque, Error **errp); 129a3d669c8SPaul Durrant void xen_device_notify_event_channel(XenDevice *xendev, 130a3d669c8SPaul Durrant XenEventChannel *channel, 131a3d669c8SPaul Durrant Error **errp); 132a3d669c8SPaul Durrant void xen_device_unbind_event_channel(XenDevice *xendev, 133a3d669c8SPaul Durrant XenEventChannel *channel, 134a3d669c8SPaul Durrant Error **errp); 135a3d669c8SPaul Durrant 136108f7bbaSPaul Durrant #endif /* HW_XEN_BUS_H */ 137