]>
Commit | Line | Data |
---|---|---|
ff8eca55 FK |
1 | /* |
2 | * VirtioBus | |
3 | * | |
4 | * Copyright (C) 2012 : GreenSocs Ltd | |
5 | * http://www.greensocs.com/ , email: info@greensocs.com | |
6 | * | |
7 | * Developed by : | |
8 | * Frederic Konrad <fred.konrad@greensocs.com> | |
9 | * | |
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. | |
14 | * | |
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. | |
19 | * | |
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/>. | |
22 | * | |
23 | */ | |
24 | ||
25 | #ifndef VIRTIO_BUS_H | |
26 | #define VIRTIO_BUS_H | |
27 | ||
83c9f4ca | 28 | #include "hw/qdev.h" |
ff8eca55 | 29 | #include "sysemu/sysemu.h" |
0d09e41a | 30 | #include "hw/virtio/virtio.h" |
ff8eca55 FK |
31 | |
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) | |
38 | ||
39 | typedef struct VirtioBusState VirtioBusState; | |
40 | ||
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); | |
a6df8adf | 47 | void (*save_extra_state)(DeviceState *d, QEMUFile *f); |
ff8eca55 FK |
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); | |
a6df8adf JW |
51 | int (*load_extra_state)(DeviceState *d, QEMUFile *f); |
52 | bool (*has_extra_state)(DeviceState *d); | |
ff8eca55 FK |
53 | bool (*query_guest_notifiers)(DeviceState *d); |
54 | int (*set_guest_notifiers)(DeviceState *d, int nvqs, bool assign); | |
55 | int (*set_host_notifier)(DeviceState *d, int n, bool assigned); | |
56 | void (*vmstate_change)(DeviceState *d, bool running); | |
57 | /* | |
58 | * transport independent init function. | |
59 | * This is called by virtio-bus just after the device is plugged. | |
60 | */ | |
e8398045 | 61 | void (*device_plugged)(DeviceState *d, Error **errp); |
11380b36 CH |
62 | /* |
63 | * Re-evaluate setup after feature bits have been validated | |
64 | * by the device backend. | |
65 | */ | |
66 | void (*post_plugged)(DeviceState *d, Error **errp); | |
ff8eca55 FK |
67 | /* |
68 | * transport independent exit function. | |
69 | * This is called by virtio-bus just before the device is unplugged. | |
70 | */ | |
5e96f5d2 | 71 | void (*device_unplugged)(DeviceState *d); |
e0d686bf | 72 | int (*query_nvectors)(DeviceState *d); |
6798e245 CH |
73 | /* |
74 | * ioeventfd handling: if the transport implements ioeventfd_started, | |
75 | * it must implement the other ioeventfd callbacks as well | |
76 | */ | |
77 | /* Returns true if the ioeventfd has been started for the device. */ | |
78 | bool (*ioeventfd_started)(DeviceState *d); | |
79 | /* | |
80 | * Sets the 'ioeventfd started' state after the ioeventfd has been | |
81 | * started/stopped for the device. err signifies whether an error | |
82 | * had occurred. | |
83 | */ | |
84 | void (*ioeventfd_set_started)(DeviceState *d, bool started, bool err); | |
85 | /* Returns true if the ioeventfd has been disabled for the device. */ | |
86 | bool (*ioeventfd_disabled)(DeviceState *d); | |
87 | /* Sets the 'ioeventfd disabled' state for the device. */ | |
88 | void (*ioeventfd_set_disabled)(DeviceState *d, bool disabled); | |
89 | /* | |
90 | * Assigns/deassigns the ioeventfd backing for the transport on | |
91 | * the device for queue number n. Returns an error value on | |
92 | * failure. | |
93 | */ | |
94 | int (*ioeventfd_assign)(DeviceState *d, EventNotifier *notifier, | |
95 | int n, bool assign); | |
6ce69d1c PM |
96 | /* |
97 | * Does the transport have variable vring alignment? | |
98 | * (ie can it ever call virtio_queue_set_align()?) | |
99 | * Note that changing this will break migration for this transport. | |
100 | */ | |
101 | bool has_variable_vring_alignment; | |
ff8eca55 FK |
102 | } VirtioBusClass; |
103 | ||
104 | struct VirtioBusState { | |
105 | BusState parent_obj; | |
ff8eca55 FK |
106 | }; |
107 | ||
e8398045 | 108 | void virtio_bus_device_plugged(VirtIODevice *vdev, Error **errp); |
ff8eca55 | 109 | void virtio_bus_reset(VirtioBusState *bus); |
5e96f5d2 | 110 | void virtio_bus_device_unplugged(VirtIODevice *bus); |
ff8eca55 FK |
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); | |
8e05db92 FK |
115 | /* Get the features of the plugged device. */ |
116 | uint32_t virtio_bus_get_vdev_features(VirtioBusState *bus, | |
117 | uint32_t requested_features); | |
118 | /* Get bad features of the plugged device. */ | |
119 | uint32_t virtio_bus_get_vdev_bad_features(VirtioBusState *bus); | |
120 | /* Get config of the plugged device. */ | |
121 | void virtio_bus_get_vdev_config(VirtioBusState *bus, uint8_t *config); | |
5d448f9d FK |
122 | /* Set config of the plugged device. */ |
123 | void virtio_bus_set_vdev_config(VirtioBusState *bus, uint8_t *config); | |
ff8eca55 | 124 | |
06d3dff0 PB |
125 | static inline VirtIODevice *virtio_bus_get_device(VirtioBusState *bus) |
126 | { | |
127 | BusState *qbus = &bus->parent_obj; | |
128 | BusChild *kid = QTAILQ_FIRST(&qbus->children); | |
129 | DeviceState *qdev = kid ? kid->child : NULL; | |
130 | ||
131 | /* This is used on the data path, the cast is guaranteed | |
132 | * to succeed by the qdev machinery. | |
133 | */ | |
134 | return (VirtIODevice *)qdev; | |
135 | } | |
136 | ||
6798e245 CH |
137 | /* Start the ioeventfd. */ |
138 | void virtio_bus_start_ioeventfd(VirtioBusState *bus); | |
139 | /* Stop the ioeventfd. */ | |
140 | void virtio_bus_stop_ioeventfd(VirtioBusState *bus); | |
141 | /* Switch from/to the generic ioeventfd handler */ | |
142 | int virtio_bus_set_host_notifier(VirtioBusState *bus, int n, bool assign); | |
143 | ||
ff8eca55 | 144 | #endif /* VIRTIO_BUS_H */ |