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.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    /*< public >*/
  42
  43    int (*init)(SysBusDevice *dev);
  44
  45    /*
  46     * Let the sysbus device format its own non-PIO, non-MMIO unit address.
  47     *
  48     * Sometimes a class of SysBusDevices has neither MMIO nor PIO resources,
  49     * yet instances of it would like to distinguish themselves, in
  50     * OpenFirmware device paths, from other instances of the same class on the
  51     * sysbus. For that end we expose this callback.
  52     *
  53     * The implementation is not supposed to change *@dev, or incur other
  54     * observable change.
  55     *
  56     * The function returns a dynamically allocated string. On error, NULL
  57     * should be returned; the unit address portion of the OFW node will be
  58     * omitted then. (This is not considered a fatal error.)
  59     */
  60    char *(*explicit_ofw_unit_address)(const SysBusDevice *dev);
  61    void (*connect_irq_notifier)(SysBusDevice *dev, qemu_irq irq);
  62} SysBusDeviceClass;
  63
  64struct SysBusDevice {
  65    /*< private >*/
  66    DeviceState parent_obj;
  67    /*< public >*/
  68
  69    int num_mmio;
  70    struct {
  71        hwaddr addr;
  72        MemoryRegion *memory;
  73    } mmio[QDEV_MAX_MMIO];
  74    int num_pio;
  75    uint32_t pio[QDEV_MAX_PIO];
  76};
  77
  78typedef void FindSysbusDeviceFunc(SysBusDevice *sbdev, void *opaque);
  79
  80void sysbus_init_mmio(SysBusDevice *dev, MemoryRegion *memory);
  81MemoryRegion *sysbus_mmio_get_region(SysBusDevice *dev, int n);
  82void sysbus_init_irq(SysBusDevice *dev, qemu_irq *p);
  83void sysbus_pass_irq(SysBusDevice *dev, SysBusDevice *target);
  84void sysbus_init_ioports(SysBusDevice *dev, uint32_t ioport, uint32_t size);
  85
  86
  87bool sysbus_has_irq(SysBusDevice *dev, int n);
  88bool sysbus_has_mmio(SysBusDevice *dev, unsigned int n);
  89void sysbus_connect_irq(SysBusDevice *dev, int n, qemu_irq irq);
  90bool sysbus_is_irq_connected(SysBusDevice *dev, int n);
  91qemu_irq sysbus_get_connected_irq(SysBusDevice *dev, int n);
  92void sysbus_mmio_map(SysBusDevice *dev, int n, hwaddr addr);
  93void sysbus_mmio_map_overlap(SysBusDevice *dev, int n, hwaddr addr,
  94                             int priority);
  95void sysbus_add_io(SysBusDevice *dev, hwaddr addr,
  96                   MemoryRegion *mem);
  97MemoryRegion *sysbus_address_space(SysBusDevice *dev);
  98
  99/**
 100 * sysbus_init_child_obj:
 101 * @parent: The parent object
 102 * @childname: Used as name of the "child<>" property in the parent
 103 * @child: A pointer to the memory to be used for the object.
 104 * @childsize: The maximum size available at @child for the object.
 105 * @childtype: The name of the type of the object to instantiate.
 106 *
 107 * This function will initialize an object and attach it to the main system
 108 * bus. The memory for the object should have already been allocated. The
 109 * object will then be added as child to the given parent. The returned object
 110 * has a reference count of 1 (for the "child<...>" property from the parent),
 111 * so the object will be finalized automatically when the parent gets removed.
 112 */
 113void sysbus_init_child_obj(Object *parent, const char *childname, void *child,
 114                           size_t childsize, const char *childtype);
 115
 116/* Call func for every dynamically created sysbus device in the system */
 117void foreach_dynamic_sysbus_device(FindSysbusDeviceFunc *func, void *opaque);
 118
 119/* Legacy helper function for creating devices.  */
 120DeviceState *sysbus_create_varargs(const char *name,
 121                                 hwaddr addr, ...);
 122DeviceState *sysbus_try_create_varargs(const char *name,
 123                                       hwaddr addr, ...);
 124static inline DeviceState *sysbus_create_simple(const char *name,
 125                                              hwaddr addr,
 126                                              qemu_irq irq)
 127{
 128    return sysbus_create_varargs(name, addr, irq, NULL);
 129}
 130
 131static inline DeviceState *sysbus_try_create_simple(const char *name,
 132                                                    hwaddr addr,
 133                                                    qemu_irq irq)
 134{
 135    return sysbus_try_create_varargs(name, addr, irq, NULL);
 136}
 137
 138#endif /* HW_SYSBUS_H */
 139