qdev.h 4.37 KB
Newer Older
Paul Brook's avatar
Paul Brook committed
1
2
3
4
#ifndef QDEV_H
#define QDEV_H

#include "hw.h"
Paul Brook's avatar
Paul Brook committed
5
#include "sys-queue.h"
Paul Brook's avatar
Paul Brook committed
6

7
8
9
typedef struct Property Property;

typedef struct PropertyInfo PropertyInfo;
Paul Brook's avatar
Paul Brook committed
10

11
12
typedef struct CompatProperty CompatProperty;

13
typedef struct DeviceInfo DeviceInfo;
Paul Brook's avatar
Paul Brook committed
14

Paul Brook's avatar
Paul Brook committed
15
typedef struct BusState BusState;
Paul Brook's avatar
Paul Brook committed
16

17
18
typedef struct BusInfo BusInfo;

Paul Brook's avatar
Paul Brook committed
19
20
/* This structure should not be accessed directly.  We declare it here
   so that it can be embedded in individual device state structures.  */
Paul Brook's avatar
Paul Brook committed
21
struct DeviceState {
22
    char *id;
Gerd Hoffmann's avatar
Gerd Hoffmann committed
23
    DeviceInfo *info;
Paul Brook's avatar
Paul Brook committed
24
    BusState *parent_bus;
Paul Brook's avatar
Paul Brook committed
25
26
27
28
    int num_gpio_out;
    qemu_irq *gpio_out;
    int num_gpio_in;
    qemu_irq *gpio_in;
Paul Brook's avatar
Paul Brook committed
29
    LIST_HEAD(, BusState) child_bus;
Paul Brook's avatar
Paul Brook committed
30
    NICInfo *nd;
Paul Brook's avatar
Paul Brook committed
31
32
33
    LIST_ENTRY(DeviceState) sibling;
};

34
35
36
37
38
typedef void (*bus_dev_printfn)(Monitor *mon, DeviceState *dev, int indent);
struct BusInfo {
    const char *name;
    size_t size;
    bus_dev_printfn print_dev;
39
    Property *props;
40
};
Paul Brook's avatar
Paul Brook committed
41
42
43

struct BusState {
    DeviceState *parent;
44
    BusInfo *info;
Paul Brook's avatar
Paul Brook committed
45
46
47
    const char *name;
    LIST_HEAD(, DeviceState) children;
    LIST_ENTRY(BusState) sibling;
Paul Brook's avatar
Paul Brook committed
48
49
};

50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
struct Property {
    const char   *name;
    PropertyInfo *info;
    int          offset;
    void         *defval;
};

enum PropertyType {
    PROP_TYPE_UNSPEC = 0,
    PROP_TYPE_UINT16,
    PROP_TYPE_UINT32,
    PROP_TYPE_TADDR,
    PROP_TYPE_MACADDR,
    PROP_TYPE_PTR,
};

struct PropertyInfo {
    const char *name;
    size_t size;
    enum PropertyType type;
    int (*parse)(DeviceState *dev, Property *prop, const char *str);
    int (*print)(DeviceState *dev, Property *prop, char *dest, size_t len);
};

74
75
76
77
78
79
struct CompatProperty {
    const char *driver;
    const char *property;
    const char *value;
};

Paul Brook's avatar
Paul Brook committed
80
81
/*** Board API.  This should go away once we have a machine config file.  ***/

Paul Brook's avatar
Paul Brook committed
82
DeviceState *qdev_create(BusState *bus, const char *name);
Paul Brook's avatar
Paul Brook committed
83
void qdev_init(DeviceState *dev);
Paul Brook's avatar
Paul Brook committed
84
void qdev_free(DeviceState *dev);
Paul Brook's avatar
Paul Brook committed
85
86
87
88

qemu_irq qdev_get_gpio_in(DeviceState *dev, int n);
void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);

Paul Brook's avatar
Paul Brook committed
89
BusState *qdev_get_child_bus(DeviceState *dev, const char *name);
Paul Brook's avatar
Paul Brook committed
90

Paul Brook's avatar
Paul Brook committed
91
92
/*** Device API.  ***/

Paul Brook's avatar
Paul Brook committed
93
typedef void (*qdev_initfn)(DeviceState *dev, DeviceInfo *info);
Paul Brook's avatar
Paul Brook committed
94
95
typedef void (*SCSIAttachFn)(DeviceState *host, BlockDriverState *bdrv,
              int unit);
Paul Brook's avatar
Paul Brook committed
96

Paul Brook's avatar
Paul Brook committed
97
struct DeviceInfo {
98
    const char *name;
99
100
    const char *alias;
    const char *desc;
101
    size_t size;
102
    Property *props;
103
    int no_user;
104
105

    /* Private to qdev / bus.  */
Paul Brook's avatar
Paul Brook committed
106
    qdev_initfn init;
107
    BusInfo *bus_info;
Gerd Hoffmann's avatar
Gerd Hoffmann committed
108
    struct DeviceInfo *next;
Paul Brook's avatar
Paul Brook committed
109
110
};

111
void qdev_register(DeviceInfo *info);
Paul Brook's avatar
Paul Brook committed
112
113

/* Register device properties.  */
Paul Brook's avatar
Paul Brook committed
114
/* GPIO inputs also double as IRQ sinks.  */
Paul Brook's avatar
Paul Brook committed
115
116
117
void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n);
void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n);

Paul Brook's avatar
Paul Brook committed
118
119
void scsi_bus_new(DeviceState *host, SCSIAttachFn attach);

Paul Brook's avatar
Paul Brook committed
120
121
CharDriverState *qdev_init_chardev(DeviceState *dev);

Paul Brook's avatar
Paul Brook committed
122
BusState *qdev_get_parent_bus(DeviceState *dev);
Paul Brook's avatar
Paul Brook committed
123
124
125
126
127
128
129
130
131
132
133

/* Convery from a base type to a parent type, with compile time checking.  */
#ifdef __GNUC__
#define DO_UPCAST(type, field, dev) ( __extension__ ( { \
    char __attribute__((unused)) offset_must_be_zero[ \
        -offsetof(type, field)]; \
    container_of(dev, type, field);}))
#else
#define DO_UPCAST(type, field, dev) container_of(dev, type, field)
#endif

Paul Brook's avatar
Paul Brook committed
134
135
/*** BUS API. ***/

136
BusState *qbus_create(BusInfo *info, DeviceState *parent, const char *name);
Paul Brook's avatar
Paul Brook committed
137
138
139

#define FROM_QBUS(type, dev) DO_UPCAST(type, qbus, dev)

140
141
142
143
/*** monitor commands ***/

void do_info_qtree(Monitor *mon);

144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
/*** qdev-properties.c ***/

extern PropertyInfo qdev_prop_uint16;
extern PropertyInfo qdev_prop_uint32;
extern PropertyInfo qdev_prop_hex32;
extern PropertyInfo qdev_prop_ptr;
extern PropertyInfo qdev_prop_macaddr;

/* Set properties between creation and init.  */
void *qdev_get_prop_ptr(DeviceState *dev, Property *prop);
int qdev_prop_parse(DeviceState *dev, const char *name, const char *value);
void qdev_prop_set(DeviceState *dev, const char *name, void *src, enum PropertyType type);
void qdev_prop_set_uint16(DeviceState *dev, const char *name, uint16_t value);
void qdev_prop_set_uint32(DeviceState *dev, const char *name, uint32_t value);
/* FIXME: Remove opaque pointer properties.  */
void qdev_prop_set_ptr(DeviceState *dev, const char *name, void *value);
void qdev_prop_set_defaults(DeviceState *dev, Property *props);

162
163
164
void qdev_prop_register_compat(CompatProperty *props);
void qdev_prop_set_compat(DeviceState *dev);

Paul Brook's avatar
Paul Brook committed
165
#endif