xref: /openbmc/qemu/include/hw/sysbus.h (revision 3ae59580)
1 #ifndef HW_SYSBUS_H
2 #define HW_SYSBUS_H 1
3 
4 /* Devices attached directly to the main system bus.  */
5 
6 #include "hw/qdev.h"
7 #include "exec/memory.h"
8 
9 #define QDEV_MAX_MMIO 32
10 #define QDEV_MAX_PIO 32
11 #define QDEV_MAX_IRQ 512
12 
13 #define TYPE_SYSTEM_BUS "System"
14 #define SYSTEM_BUS(obj) OBJECT_CHECK(IDEBus, (obj), TYPE_IDE_BUS)
15 
16 typedef struct SysBusDevice SysBusDevice;
17 
18 #define TYPE_SYS_BUS_DEVICE "sys-bus-device"
19 #define SYS_BUS_DEVICE(obj) \
20      OBJECT_CHECK(SysBusDevice, (obj), TYPE_SYS_BUS_DEVICE)
21 #define SYS_BUS_DEVICE_CLASS(klass) \
22      OBJECT_CLASS_CHECK(SysBusDeviceClass, (klass), TYPE_SYS_BUS_DEVICE)
23 #define SYS_BUS_DEVICE_GET_CLASS(obj) \
24      OBJECT_GET_CLASS(SysBusDeviceClass, (obj), TYPE_SYS_BUS_DEVICE)
25 
26 /**
27  * SysBusDeviceClass:
28  * @init: Callback function invoked when the #DeviceState.realized property
29  * is changed to %true. Deprecated, new types inheriting directly from
30  * TYPE_SYS_BUS_DEVICE should use #DeviceClass.realize instead, new leaf
31  * types should consult their respective parent type.
32  *
33  * SysBusDeviceClass is not overriding #DeviceClass.realize, so derived
34  * classes overriding it are not required to invoke its implementation.
35  */
36 typedef struct SysBusDeviceClass {
37     /*< private >*/
38     DeviceClass parent_class;
39     /*< public >*/
40 
41     int (*init)(SysBusDevice *dev);
42 } SysBusDeviceClass;
43 
44 struct SysBusDevice {
45     /*< private >*/
46     DeviceState parent_obj;
47     /*< public >*/
48 
49     int num_irq;
50     qemu_irq irqs[QDEV_MAX_IRQ];
51     qemu_irq *irqp[QDEV_MAX_IRQ];
52     int num_mmio;
53     struct {
54         hwaddr addr;
55         MemoryRegion *memory;
56     } mmio[QDEV_MAX_MMIO];
57     int num_pio;
58     pio_addr_t pio[QDEV_MAX_PIO];
59 };
60 
61 void sysbus_init_mmio(SysBusDevice *dev, MemoryRegion *memory);
62 MemoryRegion *sysbus_mmio_get_region(SysBusDevice *dev, int n);
63 void sysbus_init_irq(SysBusDevice *dev, qemu_irq *p);
64 void sysbus_pass_irq(SysBusDevice *dev, SysBusDevice *target);
65 void sysbus_init_ioports(SysBusDevice *dev, pio_addr_t ioport, pio_addr_t size);
66 
67 
68 void sysbus_connect_irq(SysBusDevice *dev, int n, qemu_irq irq);
69 void sysbus_mmio_map(SysBusDevice *dev, int n, hwaddr addr);
70 void sysbus_mmio_map_overlap(SysBusDevice *dev, int n, hwaddr addr,
71                              int priority);
72 void sysbus_add_io(SysBusDevice *dev, hwaddr addr,
73                    MemoryRegion *mem);
74 MemoryRegion *sysbus_address_space(SysBusDevice *dev);
75 
76 /* Legacy helper function for creating devices.  */
77 DeviceState *sysbus_create_varargs(const char *name,
78                                  hwaddr addr, ...);
79 DeviceState *sysbus_try_create_varargs(const char *name,
80                                        hwaddr addr, ...);
81 static inline DeviceState *sysbus_create_simple(const char *name,
82                                               hwaddr addr,
83                                               qemu_irq irq)
84 {
85     return sysbus_create_varargs(name, addr, irq, NULL);
86 }
87 
88 static inline DeviceState *sysbus_try_create_simple(const char *name,
89                                                     hwaddr addr,
90                                                     qemu_irq irq)
91 {
92     return sysbus_try_create_varargs(name, addr, irq, NULL);
93 }
94 
95 #endif /* !HW_SYSBUS_H */
96