KVM: document locking for kvm_io_device_ops
[linux-2.6.git] / virt / kvm / iodev.h
1 /*
2  * This program is free software; you can redistribute it and/or modify
3  * it under the terms of the GNU General Public License as published by
4  * the Free Software Foundation; either version 2 of the License.
5  *
6  * This program is distributed in the hope that it will be useful,
7  * but WITHOUT ANY WARRANTY; without even the implied warranty of
8  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
9  * GNU General Public License for more details.
10  *
11  * You should have received a copy of the GNU General Public License
12  * along with this program; if not, write to the Free Software
13  * Foundation, 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
14  */
15
16 #ifndef __KVM_IODEV_H__
17 #define __KVM_IODEV_H__
18
19 #include <linux/kvm_types.h>
20
21 struct kvm_io_device;
22
23 /**
24  * kvm_io_device_ops are called under kvm slots_lock.
25  **/
26 struct kvm_io_device_ops {
27         void (*read)(struct kvm_io_device *this,
28                      gpa_t addr,
29                      int len,
30                      void *val);
31         void (*write)(struct kvm_io_device *this,
32                       gpa_t addr,
33                       int len,
34                       const void *val);
35         int (*in_range)(struct kvm_io_device *this, gpa_t addr, int len,
36                         int is_write);
37         void (*destructor)(struct kvm_io_device *this);
38 };
39
40
41 struct kvm_io_device {
42         const struct kvm_io_device_ops *ops;
43 };
44
45 static inline void kvm_iodevice_init(struct kvm_io_device *dev,
46                                      const struct kvm_io_device_ops *ops)
47 {
48         dev->ops = ops;
49 }
50
51 static inline void kvm_iodevice_read(struct kvm_io_device *dev,
52                                      gpa_t addr,
53                                      int len,
54                                      void *val)
55 {
56         dev->ops->read(dev, addr, len, val);
57 }
58
59 static inline void kvm_iodevice_write(struct kvm_io_device *dev,
60                                       gpa_t addr,
61                                       int len,
62                                       const void *val)
63 {
64         dev->ops->write(dev, addr, len, val);
65 }
66
67 static inline int kvm_iodevice_in_range(struct kvm_io_device *dev,
68                                         gpa_t addr, int len, int is_write)
69 {
70         return dev->ops->in_range(dev, addr, len, is_write);
71 }
72
73 static inline void kvm_iodevice_destructor(struct kvm_io_device *dev)
74 {
75         if (dev->ops->destructor)
76                 dev->ops->destructor(dev);
77 }
78
79 #endif /* __KVM_IODEV_H__ */