blob: 6dc9dcbd0a2c442e305fc01bc719f32baf165130 [file] [log] [blame]
David 'Digit' Turner5d8f37a2009-09-14 14:32:27 -07001#ifndef QDEV_H
2#define QDEV_H
3
4#include "hw.h"
David 'Digit' Turnera5d41202010-05-10 18:37:10 -07005#include "qemu-queue.h"
David 'Digit' Turner5d8f37a2009-09-14 14:32:27 -07006
7typedef struct DeviceType DeviceType;
8
9typedef struct DeviceProperty DeviceProperty;
10
11typedef struct BusState BusState;
12
13/* This structure should not be accessed directly. We declare it here
14 so that it can be embedded in individual device state structures. */
15struct DeviceState {
16 DeviceType *type;
17 BusState *parent_bus;
18 DeviceProperty *props;
19 int num_gpio_out;
20 qemu_irq *gpio_out;
21 int num_gpio_in;
22 qemu_irq *gpio_in;
David 'Digit' Turnera5d41202010-05-10 18:37:10 -070023 QLIST_HEAD(, BusState) child_bus;
David 'Digit' Turner5d8f37a2009-09-14 14:32:27 -070024 NICInfo *nd;
David 'Digit' Turnera5d41202010-05-10 18:37:10 -070025 QLIST_ENTRY(DeviceState) sibling;
David 'Digit' Turner5d8f37a2009-09-14 14:32:27 -070026};
27
28typedef enum {
29 BUS_TYPE_SYSTEM,
30 BUS_TYPE_PCI,
31 BUS_TYPE_SCSI,
32 BUS_TYPE_I2C,
33 BUS_TYPE_SSI
34} BusType;
35
36struct BusState {
37 DeviceState *parent;
38 const char *name;
39 BusType type;
David 'Digit' Turnera5d41202010-05-10 18:37:10 -070040 QLIST_HEAD(, DeviceState) children;
41 QLIST_ENTRY(BusState) sibling;
David 'Digit' Turner5d8f37a2009-09-14 14:32:27 -070042};
43
44/*** Board API. This should go away once we have a machine config file. ***/
45
46DeviceState *qdev_create(BusState *bus, const char *name);
47void qdev_init(DeviceState *dev);
48void qdev_free(DeviceState *dev);
49
50/* Set properties between creation and init. */
51void qdev_set_prop_int(DeviceState *dev, const char *name, uint64_t value);
52void qdev_set_prop_dev(DeviceState *dev, const char *name, DeviceState *value);
53void qdev_set_prop_ptr(DeviceState *dev, const char *name, void *value);
54void qdev_set_netdev(DeviceState *dev, NICInfo *nd);
55
56qemu_irq qdev_get_gpio_in(DeviceState *dev, int n);
57void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
58
59BusState *qdev_get_child_bus(DeviceState *dev, const char *name);
60
61/*** Device API. ***/
62
63typedef enum {
64 PROP_TYPE_INT,
65 PROP_TYPE_PTR,
66 PROP_TYPE_DEV
67} DevicePropType;
68
69typedef struct {
70 const char *name;
71 DevicePropType type;
72} DevicePropList;
73
74typedef struct DeviceInfo DeviceInfo;
75
76typedef void (*qdev_initfn)(DeviceState *dev, DeviceInfo *info);
77typedef void (*SCSIAttachFn)(DeviceState *host, BlockDriverState *bdrv,
78 int unit);
79
80struct DeviceInfo {
81 const char *name;
82 size_t size;
83 DevicePropList *props;
84
85 /* Private to qdev / bus. */
86 qdev_initfn init;
87 BusType bus_type;
88};
89
90void qdev_register(DeviceInfo *info);
91
92/* Register device properties. */
93/* GPIO inputs also double as IRQ sinks. */
94void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n);
95void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n);
96
97void scsi_bus_new(DeviceState *host, SCSIAttachFn attach);
98
99CharDriverState *qdev_init_chardev(DeviceState *dev);
100
101BusState *qdev_get_parent_bus(DeviceState *dev);
102uint64_t qdev_get_prop_int(DeviceState *dev, const char *name, uint64_t def);
103DeviceState *qdev_get_prop_dev(DeviceState *dev, const char *name);
104/* FIXME: Remove opaque pointer properties. */
105void *qdev_get_prop_ptr(DeviceState *dev, const char *name);
106
107/* Convery from a base type to a parent type, with compile time checking. */
108#ifdef __GNUC__
109#define DO_UPCAST(type, field, dev) ( __extension__ ( { \
110 char __attribute__((unused)) offset_must_be_zero[ \
111 -offsetof(type, field)]; \
112 container_of(dev, type, field);}))
113#else
114#define DO_UPCAST(type, field, dev) container_of(dev, type, field)
115#endif
116
117/*** BUS API. ***/
118
119BusState *qbus_create(BusType type, size_t size,
120 DeviceState *parent, const char *name);
121
122#define FROM_QBUS(type, dev) DO_UPCAST(type, qbus, dev)
123
124/*** monitor commands ***/
125
126void do_info_qtree(Monitor *mon);
127void sysbus_dev_print(Monitor *mon, DeviceState *dev, int indent);
128
129#endif