virtio: move ioeventfd_started flag to VirtioBusState
[qemu/ar7.git] / include / hw / virtio / virtio-bus.h
blobf74ef1efd94eaca027902f5275fff26feeab7782
1 /*
2 * VirtioBus
4 * Copyright (C) 2012 : GreenSocs Ltd
5 * http://www.greensocs.com/ , email: info@greensocs.com
7 * Developed by :
8 * Frederic Konrad <fred.konrad@greensocs.com>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation, either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, see <http://www.gnu.org/licenses/>.
25 #ifndef VIRTIO_BUS_H
26 #define VIRTIO_BUS_H
28 #include "hw/qdev.h"
29 #include "sysemu/sysemu.h"
30 #include "hw/virtio/virtio.h"
32 #define TYPE_VIRTIO_BUS "virtio-bus"
33 #define VIRTIO_BUS_GET_CLASS(obj) \
34 OBJECT_GET_CLASS(VirtioBusClass, obj, TYPE_VIRTIO_BUS)
35 #define VIRTIO_BUS_CLASS(klass) \
36 OBJECT_CLASS_CHECK(VirtioBusClass, klass, TYPE_VIRTIO_BUS)
37 #define VIRTIO_BUS(obj) OBJECT_CHECK(VirtioBusState, (obj), TYPE_VIRTIO_BUS)
39 typedef struct VirtioBusState VirtioBusState;
41 typedef struct VirtioBusClass {
42 /* This is what a VirtioBus must implement */
43 BusClass parent;
44 void (*notify)(DeviceState *d, uint16_t vector);
45 void (*save_config)(DeviceState *d, QEMUFile *f);
46 void (*save_queue)(DeviceState *d, int n, QEMUFile *f);
47 void (*save_extra_state)(DeviceState *d, QEMUFile *f);
48 int (*load_config)(DeviceState *d, QEMUFile *f);
49 int (*load_queue)(DeviceState *d, int n, QEMUFile *f);
50 int (*load_done)(DeviceState *d, QEMUFile *f);
51 int (*load_extra_state)(DeviceState *d, QEMUFile *f);
52 bool (*has_extra_state)(DeviceState *d);
53 bool (*query_guest_notifiers)(DeviceState *d);
54 int (*set_guest_notifiers)(DeviceState *d, int nvqs, bool assign);
55 void (*vmstate_change)(DeviceState *d, bool running);
57 * Expose the features the transport layer supports before
58 * the negotiation takes place.
60 void (*pre_plugged)(DeviceState *d, Error **errp);
62 * transport independent init function.
63 * This is called by virtio-bus just after the device is plugged.
65 void (*device_plugged)(DeviceState *d, Error **errp);
67 * transport independent exit function.
68 * This is called by virtio-bus just before the device is unplugged.
70 void (*device_unplugged)(DeviceState *d);
71 int (*query_nvectors)(DeviceState *d);
73 * ioeventfd handling: if the transport implements ioeventfd_assign,
74 * it must implement ioeventfd_disabled as well.
76 /* Returns true if the ioeventfd has been disabled for the device. */
77 bool (*ioeventfd_disabled)(DeviceState *d);
79 * Assigns/deassigns the ioeventfd backing for the transport on
80 * the device for queue number n. Returns an error value on
81 * failure.
83 int (*ioeventfd_assign)(DeviceState *d, EventNotifier *notifier,
84 int n, bool assign);
86 * Does the transport have variable vring alignment?
87 * (ie can it ever call virtio_queue_set_align()?)
88 * Note that changing this will break migration for this transport.
90 bool has_variable_vring_alignment;
91 } VirtioBusClass;
93 struct VirtioBusState {
94 BusState parent_obj;
97 * Set if the default ioeventfd handlers are disabled by vhost
98 * or dataplane.
100 bool ioeventfd_disabled;
103 * Set if ioeventfd has been started.
105 bool ioeventfd_started;
108 void virtio_bus_device_plugged(VirtIODevice *vdev, Error **errp);
109 void virtio_bus_reset(VirtioBusState *bus);
110 void virtio_bus_device_unplugged(VirtIODevice *bus);
111 /* Get the device id of the plugged device. */
112 uint16_t virtio_bus_get_vdev_id(VirtioBusState *bus);
113 /* Get the config_len field of the plugged device. */
114 size_t virtio_bus_get_vdev_config_len(VirtioBusState *bus);
115 /* Get bad features of the plugged device. */
116 uint32_t virtio_bus_get_vdev_bad_features(VirtioBusState *bus);
117 /* Get config of the plugged device. */
118 void virtio_bus_get_vdev_config(VirtioBusState *bus, uint8_t *config);
119 /* Set config of the plugged device. */
120 void virtio_bus_set_vdev_config(VirtioBusState *bus, uint8_t *config);
122 static inline VirtIODevice *virtio_bus_get_device(VirtioBusState *bus)
124 BusState *qbus = &bus->parent_obj;
125 BusChild *kid = QTAILQ_FIRST(&qbus->children);
126 DeviceState *qdev = kid ? kid->child : NULL;
128 /* This is used on the data path, the cast is guaranteed
129 * to succeed by the qdev machinery.
131 return (VirtIODevice *)qdev;
134 /* Start the ioeventfd. */
135 void virtio_bus_start_ioeventfd(VirtioBusState *bus);
136 /* Stop the ioeventfd. */
137 void virtio_bus_stop_ioeventfd(VirtioBusState *bus);
138 /* Switch from/to the generic ioeventfd handler */
139 int virtio_bus_set_host_notifier(VirtioBusState *bus, int n, bool assign);
141 #endif /* VIRTIO_BUS_H */