LXR qemu/include/hw/sysbus.h

   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#define SYS_BUS_DEVICE_PARENT_CLASS \
  25     object_class_get_parent(object_class_by_name(TYPE_SYS_BUS_DEVICE))
  26
  27/**
  28 * SysBusDeviceClass:
  29 *
  30 * SysBusDeviceClass is not overriding #DeviceClass.realize, so derived
  31 * classes overriding it are not required to invoke its implementation.
  32 */
  33
  34#define SYSBUS_DEVICE_GPIO_IRQ "sysbus-irq"
  35
  36typedef struct SysBusDeviceClass {
  37    /*< private >*/
  38    DeviceClass parent_class;
  39
  40    /*
  41     * Let the sysbus device format its own non-PIO, non-MMIO unit address.
  42     *
  43     * Sometimes a class of SysBusDevices has neither MMIO nor PIO resources,
  44     * yet instances of it would like to distinguish themselves, in
  45     * OpenFirmware device paths, from other instances of the same class on the
  46     * sysbus. For that end we expose this callback.
  47     *
  48     * The implementation is not supposed to change *@dev, or incur other
  49     * observable change.
  50     *
  51     * The function returns a dynamically allocated string. On error, NULL
  52     * should be returned; the unit address portion of the OFW node will be
  53     * omitted then. (This is not considered a fatal error.)
  54     */
  55    char *(*explicit_ofw_unit_address)(const SysBusDevice *dev);
  56    void (*connect_irq_notifier)(SysBusDevice *dev, qemu_irq irq);
  57} SysBusDeviceClass;
  58
  59struct SysBusDevice {
  60    /*< private >*/
  61    DeviceState parent_obj;
  62    /*< public >*/
  63
  64    int num_mmio;
  65    struct {
  66        hwaddr addr;
  67        MemoryRegion *memory;
  68    } mmio[QDEV_MAX_MMIO];
  69    int num_pio;
  70    uint32_t pio[QDEV_MAX_PIO];
  71};
  72
  73typedef void FindSysbusDeviceFunc(SysBusDevice *sbdev, void *opaque);
  74
  75void sysbus_init_mmio(SysBusDevice *dev, MemoryRegion *memory);
  76void sysbus_init_mmio_n(SysBusDevice *dev, MemoryRegion *memory, int n);
  77MemoryRegion *sysbus_mmio_get_region(SysBusDevice *dev, int n);
  78void sysbus_init_irq(SysBusDevice *dev, qemu_irq *p);
  79void sysbus_pass_irq(SysBusDevice *dev, SysBusDevice *target);
  80void sysbus_init_ioports(SysBusDevice *dev, uint32_t ioport, uint32_t size);
  81
  82
  83bool sysbus_has_irq(SysBusDevice *dev, int n);
  84bool sysbus_has_mmio(SysBusDevice *dev, unsigned int n);
  85void sysbus_connect_irq(SysBusDevice *dev, int n, qemu_irq irq);
  86bool sysbus_is_irq_connected(SysBusDevice *dev, int n);
  87qemu_irq sysbus_get_connected_irq(SysBusDevice *dev, int n);
  88void sysbus_mmio_map(SysBusDevice *dev, int n, hwaddr addr);
  89void sysbus_mmio_map_overlap(SysBusDevice *dev, int n, hwaddr addr,
  90                             int priority);
  91void sysbus_mmio_unmap(SysBusDevice *dev, int n);
  92void sysbus_add_io(SysBusDevice *dev, hwaddr addr,
  93                   MemoryRegion *mem);
  94MemoryRegion *sysbus_address_space(SysBusDevice *dev);
  95
  96bool sysbus_realize(SysBusDevice *dev, Error **errp);
  97bool sysbus_realize_and_unref(SysBusDevice *dev, Error **errp);
  98
  99/* Call func for every dynamically created sysbus device in the system */
 100void foreach_dynamic_sysbus_device(FindSysbusDeviceFunc *func, void *opaque);
 101
 102/* Legacy helper function for creating devices.  */
 103DeviceState *sysbus_create_varargs(const char *name,
 104                                 hwaddr addr, ...);
 105
 106static inline DeviceState *sysbus_create_simple(const char *name,
 107                                              hwaddr addr,
 108                                              qemu_irq irq)
 109{
 110    return sysbus_create_varargs(name, addr, irq, NULL);
 111}
 112
 113#endif /* HW_SYSBUS_H */
 114