xref: /openbmc/qemu/include/hw/isa/isa.h (revision 87c9b5e0)
1 #ifndef HW_ISA_H
2 #define HW_ISA_H
3 
4 /* ISA bus */
5 
6 #include "exec/ioport.h"
7 #include "exec/memory.h"
8 #include "hw/qdev.h"
9 
10 #define ISA_NUM_IRQS 16
11 
12 #define TYPE_ISA_DEVICE "isa-device"
13 #define ISA_DEVICE(obj) \
14      OBJECT_CHECK(ISADevice, (obj), TYPE_ISA_DEVICE)
15 #define ISA_DEVICE_CLASS(klass) \
16      OBJECT_CLASS_CHECK(ISADeviceClass, (klass), TYPE_ISA_DEVICE)
17 #define ISA_DEVICE_GET_CLASS(obj) \
18      OBJECT_GET_CLASS(ISADeviceClass, (obj), TYPE_ISA_DEVICE)
19 
20 #define TYPE_ISA_BUS "ISA"
21 #define ISA_BUS(obj) OBJECT_CHECK(ISABus, (obj), TYPE_ISA_BUS)
22 
23 #define TYPE_APPLE_SMC "isa-applesmc"
24 #define APPLESMC_MAX_DATA_LENGTH       32
25 #define APPLESMC_PROP_IO_BASE "iobase"
26 
27 static inline uint16_t applesmc_port(void)
28 {
29     Object *obj = object_resolve_path_type("", TYPE_APPLE_SMC, NULL);
30 
31     if (obj) {
32         return object_property_get_int(obj, APPLESMC_PROP_IO_BASE, NULL);
33     }
34     return 0;
35 }
36 
37 #define TYPE_ISADMA "isa-dma"
38 
39 #define ISADMA_CLASS(klass) \
40     OBJECT_CLASS_CHECK(IsaDmaClass, (klass), TYPE_ISADMA)
41 #define ISADMA_GET_CLASS(obj) \
42     OBJECT_GET_CLASS(IsaDmaClass, (obj), TYPE_ISADMA)
43 #define ISADMA(obj) \
44     INTERFACE_CHECK(IsaDma, (obj), TYPE_ISADMA)
45 
46 struct IsaDma {
47     Object parent;
48 };
49 
50 typedef enum {
51     ISADMA_TRANSFER_VERIFY,
52     ISADMA_TRANSFER_READ,
53     ISADMA_TRANSFER_WRITE,
54     ISADMA_TRANSFER_ILLEGAL,
55 } IsaDmaTransferMode;
56 
57 typedef struct IsaDmaClass {
58     InterfaceClass parent;
59 
60     IsaDmaTransferMode (*get_transfer_mode)(IsaDma *obj, int nchan);
61     bool (*has_autoinitialization)(IsaDma *obj, int nchan);
62     int (*read_memory)(IsaDma *obj, int nchan, void *buf, int pos, int len);
63     int (*write_memory)(IsaDma *obj, int nchan, void *buf, int pos, int len);
64     void (*hold_DREQ)(IsaDma *obj, int nchan);
65     void (*release_DREQ)(IsaDma *obj, int nchan);
66     void (*schedule)(IsaDma *obj);
67     void (*register_channel)(IsaDma *obj, int nchan,
68                              DMA_transfer_handler transfer_handler,
69                              void *opaque);
70 } IsaDmaClass;
71 
72 typedef struct ISADeviceClass {
73     DeviceClass parent_class;
74 } ISADeviceClass;
75 
76 struct ISABus {
77     /*< private >*/
78     BusState parent_obj;
79     /*< public >*/
80 
81     MemoryRegion *address_space;
82     MemoryRegion *address_space_io;
83     qemu_irq *irqs;
84     IsaDma *dma[2];
85 };
86 
87 struct ISADevice {
88     /*< private >*/
89     DeviceState parent_obj;
90     /*< public >*/
91 
92     uint32_t isairq[2];
93     int nirqs;
94     int ioport_id;
95 };
96 
97 ISABus *isa_bus_new(DeviceState *dev, MemoryRegion *address_space,
98                     MemoryRegion *address_space_io, Error **errp);
99 void isa_bus_irqs(ISABus *bus, qemu_irq *irqs);
100 qemu_irq isa_get_irq(ISADevice *dev, int isairq);
101 void isa_init_irq(ISADevice *dev, qemu_irq *p, int isairq);
102 void isa_bus_dma(ISABus *bus, IsaDma *dma8, IsaDma *dma16);
103 IsaDma *isa_get_dma(ISABus *bus, int nchan);
104 MemoryRegion *isa_address_space(ISADevice *dev);
105 MemoryRegion *isa_address_space_io(ISADevice *dev);
106 ISADevice *isa_create(ISABus *bus, const char *name);
107 ISADevice *isa_try_create(ISABus *bus, const char *name);
108 ISADevice *isa_create_simple(ISABus *bus, const char *name);
109 
110 ISADevice *isa_vga_init(ISABus *bus);
111 
112 /**
113  * isa_register_ioport: Install an I/O port region on the ISA bus.
114  *
115  * Register an I/O port region via memory_region_add_subregion
116  * inside the ISA I/O address space.
117  *
118  * @dev: the ISADevice against which these are registered; may be NULL.
119  * @io: the #MemoryRegion being registered.
120  * @start: the base I/O port.
121  */
122 void isa_register_ioport(ISADevice *dev, MemoryRegion *io, uint16_t start);
123 
124 /**
125  * isa_register_portio_list: Initialize a set of ISA io ports
126  *
127  * Several ISA devices have many dis-joint I/O ports.  Worse, these I/O
128  * ports can be interleaved with I/O ports from other devices.  This
129  * function makes it easy to create multiple MemoryRegions for a single
130  * device and use the legacy portio routines.
131  *
132  * @dev: the ISADevice against which these are registered; may be NULL.
133  * @start: the base I/O port against which the portio->offset is applied.
134  * @portio: the ports, sorted by offset.
135  * @opaque: passed into the portio callbacks.
136  * @name: passed into memory_region_init_io.
137  */
138 void isa_register_portio_list(ISADevice *dev, uint16_t start,
139                               const MemoryRegionPortio *portio,
140                               void *opaque, const char *name);
141 
142 static inline ISABus *isa_bus_from_device(ISADevice *d)
143 {
144     return ISA_BUS(qdev_get_parent_bus(DEVICE(d)));
145 }
146 
147 /* i8257.c */
148 void DMA_init(ISABus *bus, int high_page_enable);
149 #endif
150