1#ifndef HW_SYSBUS_H
2#define HW_SYSBUS_H
3
4/* Devices attached directly to the main system bus. */
5
6#include "hw/qdev-core.h"
7#include "exec/memory.h"
8
9#define QDEV_MAX_MMIO 32
10#define QDEV_MAX_PIO 32
11
12#define TYPE_SYSTEM_BUS "System"
13#define SYSTEM_BUS(obj) OBJECT_CHECK(BusState, (obj), TYPE_SYSTEM_BUS)
14
15typedef struct SysBusDevice SysBusDevice;
16
17#define TYPE_SYS_BUS_DEVICE "sys-bus-device"
18#define SYS_BUS_DEVICE(obj) \
19 OBJECT_CHECK(SysBusDevice, (obj), TYPE_SYS_BUS_DEVICE)
20#define SYS_BUS_DEVICE_CLASS(klass) \
21 OBJECT_CLASS_CHECK(SysBusDeviceClass, (klass), TYPE_SYS_BUS_DEVICE)
22#define SYS_BUS_DEVICE_GET_CLASS(obj) \
23 OBJECT_GET_CLASS(SysBusDeviceClass, (obj), TYPE_SYS_BUS_DEVICE)
24
25/**
26 * SysBusDeviceClass:
27 * @init: Callback function invoked when the #DeviceState.realized property
28 * is changed to %true. Deprecated, new types inheriting directly from
29 * TYPE_SYS_BUS_DEVICE should use #DeviceClass.realize instead, new leaf
30 * types should consult their respective parent type.
31 *
32 * SysBusDeviceClass is not overriding #DeviceClass.realize, so derived
33 * classes overriding it are not required to invoke its implementation.
34 */
35
36#define SYSBUS_DEVICE_GPIO_IRQ "sysbus-irq"
37
38typedef struct SysBusDeviceClass {
39 /*< private >*/
40 DeviceClass parent_class;
41
42 /*
43 * Let the sysbus device format its own non-PIO, non-MMIO unit address.
44 *
45 * Sometimes a class of SysBusDevices has neither MMIO nor PIO resources,
46 * yet instances of it would like to distinguish themselves, in
47 * OpenFirmware device paths, from other instances of the same class on the
48 * sysbus. For that end we expose this callback.
49 *
50 * The implementation is not supposed to change *@dev, or incur other
51 * observable change.
52 *
53 * The function returns a dynamically allocated string. On error, NULL
54 * should be returned; the unit address portion of the OFW node will be
55 * omitted then. (This is not considered a fatal error.)
56 */
57 char *(*explicit_ofw_unit_address)(const SysBusDevice *dev);
58 void (*connect_irq_notifier)(SysBusDevice *dev, qemu_irq irq);
59} SysBusDeviceClass;
60
61struct SysBusDevice {
62 /*< private >*/
63 DeviceState parent_obj;
64 /*< public >*/
65
66 int num_mmio;
67 struct {
68 hwaddr addr;
69 MemoryRegion *memory;
70 } mmio[QDEV_MAX_MMIO];
71 int num_pio;
72 uint32_t pio[QDEV_MAX_PIO];
73};
74
75typedef void FindSysbusDeviceFunc(SysBusDevice *sbdev, void *opaque);
76
77void sysbus_init_mmio(SysBusDevice *dev, MemoryRegion *memory);
78MemoryRegion *sysbus_mmio_get_region(SysBusDevice *dev, int n);
79void sysbus_init_irq(SysBusDevice *dev, qemu_irq *p);
80void sysbus_pass_irq(SysBusDevice *dev, SysBusDevice *target);
81void sysbus_init_ioports(SysBusDevice *dev, uint32_t ioport, uint32_t size);
82
83
84bool sysbus_has_irq(SysBusDevice *dev, int n);
85bool sysbus_has_mmio(SysBusDevice *dev, unsigned int n);
86void sysbus_connect_irq(SysBusDevice *dev, int n, qemu_irq irq);
87bool sysbus_is_irq_connected(SysBusDevice *dev, int n);
88qemu_irq sysbus_get_connected_irq(SysBusDevice *dev, int n);
89void sysbus_mmio_map(SysBusDevice *dev, int n, hwaddr addr);
90void sysbus_mmio_map_overlap(SysBusDevice *dev, int n, hwaddr addr,
91 int priority);
92void sysbus_mmio_unmap(SysBusDevice *dev, int n);
93void sysbus_add_io(SysBusDevice *dev, hwaddr addr,
94 MemoryRegion *mem);
95MemoryRegion *sysbus_address_space(SysBusDevice *dev);
96
97/**
98 * sysbus_init_child_obj:
99 * @parent: The parent object
100 * @childname: Used as name of the "child<>" property in the parent
101 * @child: A pointer to the memory to be used for the object.
102 * @childsize: The maximum size available at @child for the object.
103 * @childtype: The name of the type of the object to instantiate.
104 *
105 * This function will initialize an object and attach it to the main system
106 * bus. The memory for the object should have already been allocated. The
107 * object will then be added as child to the given parent. The returned object
108 * has a reference count of 1 (for the "child<...>" property from the parent),
109 * so the object will be finalized automatically when the parent gets removed.
110 */
111void sysbus_init_child_obj(Object *parent, const char *childname, void *child,
112 size_t childsize, const char *childtype);
113
114/* Call func for every dynamically created sysbus device in the system */
115void foreach_dynamic_sysbus_device(FindSysbusDeviceFunc *func, void *opaque);
116
117/* Legacy helper function for creating devices. */
118DeviceState *sysbus_create_varargs(const char *name,
119 hwaddr addr, ...);
120DeviceState *sysbus_try_create_varargs(const char *name,
121 hwaddr addr, ...);
122static inline DeviceState *sysbus_create_simple(const char *name,
123 hwaddr addr,
124 qemu_irq irq)
125{
126 return sysbus_create_varargs(name, addr, irq, NULL);
127}
128
129static inline DeviceState *sysbus_try_create_simple(const char *name,
130 hwaddr addr,
131 qemu_irq irq)
132{
133 return sysbus_try_create_varargs(name, addr, irq, NULL);
134}
135
136#endif /* HW_SYSBUS_H */
137