xref: /openbmc/qemu/hw/misc/macio/macio.c (revision 9121d02c)
1 /*
2  * PowerMac MacIO device emulation
3  *
4  * Copyright (c) 2005-2007 Fabrice Bellard
5  * Copyright (c) 2007 Jocelyn Mayer
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining a copy
8  * of this software and associated documentation files (the "Software"), to deal
9  * in the Software without restriction, including without limitation the rights
10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11  * copies of the Software, and to permit persons to whom the Software is
12  * furnished to do so, subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be included in
15  * all copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23  * THE SOFTWARE.
24  */
25 #include "hw/hw.h"
26 #include "hw/ppc/mac.h"
27 #include "hw/pci/pci.h"
28 #include "hw/ppc/mac_dbdma.h"
29 #include "hw/char/escc.h"
30 
31 #define TYPE_MACIO "macio"
32 #define MACIO(obj) OBJECT_CHECK(MacIOState, (obj), TYPE_MACIO)
33 
34 typedef struct MacIOState
35 {
36     /*< private >*/
37     PCIDevice parent;
38     /*< public >*/
39 
40     MemoryRegion bar;
41     CUDAState cuda;
42     void *dbdma;
43     MemoryRegion *pic_mem;
44     MemoryRegion *escc_mem;
45 } MacIOState;
46 
47 #define OLDWORLD_MACIO(obj) \
48     OBJECT_CHECK(OldWorldMacIOState, (obj), TYPE_OLDWORLD_MACIO)
49 
50 typedef struct OldWorldMacIOState {
51     /*< private >*/
52     MacIOState parent_obj;
53     /*< public >*/
54 
55     qemu_irq irqs[5];
56 
57     MacIONVRAMState nvram;
58     MACIOIDEState ide[2];
59 } OldWorldMacIOState;
60 
61 #define NEWWORLD_MACIO(obj) \
62     OBJECT_CHECK(NewWorldMacIOState, (obj), TYPE_NEWWORLD_MACIO)
63 
64 typedef struct NewWorldMacIOState {
65     /*< private >*/
66     MacIOState parent_obj;
67     /*< public >*/
68     qemu_irq irqs[5];
69     MACIOIDEState ide[2];
70 } NewWorldMacIOState;
71 
72 /*
73  * The mac-io has two interfaces to the ESCC. One is called "escc-legacy",
74  * while the other one is the normal, current ESCC interface.
75  *
76  * The magic below creates memory aliases to spawn the escc-legacy device
77  * purely by rerouting the respective registers to our escc region. This
78  * works because the only difference between the two memory regions is the
79  * register layout, not their semantics.
80  *
81  * Reference: ftp://ftp.software.ibm.com/rs6000/technology/spec/chrp/inwork/CHRP_IORef_1.0.pdf
82  */
83 static void macio_escc_legacy_setup(MacIOState *macio_state)
84 {
85     MemoryRegion *escc_legacy = g_new(MemoryRegion, 1);
86     MemoryRegion *bar = &macio_state->bar;
87     int i;
88     static const int maps[] = {
89         0x00, 0x00,
90         0x02, 0x20,
91         0x04, 0x10,
92         0x06, 0x30,
93         0x08, 0x40,
94         0x0A, 0x50,
95         0x60, 0x60,
96         0x70, 0x70,
97         0x80, 0x70,
98         0x90, 0x80,
99         0xA0, 0x90,
100         0xB0, 0xA0,
101         0xC0, 0xB0,
102         0xD0, 0xC0,
103         0xE0, 0xD0,
104         0xF0, 0xE0,
105     };
106 
107     memory_region_init(escc_legacy, NULL, "escc-legacy", 256);
108     for (i = 0; i < ARRAY_SIZE(maps); i += 2) {
109         MemoryRegion *port = g_new(MemoryRegion, 1);
110         memory_region_init_alias(port, NULL, "escc-legacy-port",
111                                  macio_state->escc_mem, maps[i+1], 0x2);
112         memory_region_add_subregion(escc_legacy, maps[i], port);
113     }
114 
115     memory_region_add_subregion(bar, 0x12000, escc_legacy);
116 }
117 
118 static void macio_bar_setup(MacIOState *macio_state)
119 {
120     MemoryRegion *bar = &macio_state->bar;
121 
122     if (macio_state->escc_mem) {
123         memory_region_add_subregion(bar, 0x13000, macio_state->escc_mem);
124         macio_escc_legacy_setup(macio_state);
125     }
126 }
127 
128 static int macio_common_initfn(PCIDevice *d)
129 {
130     MacIOState *s = MACIO(d);
131     SysBusDevice *sysbus_dev;
132     int ret;
133 
134     d->config[0x3d] = 0x01; // interrupt on pin 1
135 
136     ret = qdev_init(DEVICE(&s->cuda));
137     if (ret < 0) {
138         return ret;
139     }
140     sysbus_dev = SYS_BUS_DEVICE(&s->cuda);
141     memory_region_add_subregion(&s->bar, 0x16000,
142                                 sysbus_mmio_get_region(sysbus_dev, 0));
143 
144     macio_bar_setup(s);
145     pci_register_bar(d, 0, PCI_BASE_ADDRESS_SPACE_MEMORY, &s->bar);
146 
147     return 0;
148 }
149 
150 static int macio_initfn_ide(MacIOState *s, MACIOIDEState *ide, qemu_irq irq0,
151                             qemu_irq irq1, int dmaid)
152 {
153     SysBusDevice *sysbus_dev;
154 
155     sysbus_dev = SYS_BUS_DEVICE(ide);
156     sysbus_connect_irq(sysbus_dev, 0, irq0);
157     sysbus_connect_irq(sysbus_dev, 1, irq1);
158     macio_ide_register_dma(ide, s->dbdma, dmaid);
159     return qdev_init(DEVICE(ide));
160 }
161 
162 static int macio_oldworld_initfn(PCIDevice *d)
163 {
164     MacIOState *s = MACIO(d);
165     OldWorldMacIOState *os = OLDWORLD_MACIO(d);
166     SysBusDevice *sysbus_dev;
167     int i;
168     int cur_irq = 0;
169     int ret = macio_common_initfn(d);
170     if (ret < 0) {
171         return ret;
172     }
173 
174     sysbus_dev = SYS_BUS_DEVICE(&s->cuda);
175     sysbus_connect_irq(sysbus_dev, 0, os->irqs[cur_irq++]);
176 
177     ret = qdev_init(DEVICE(&os->nvram));
178     if (ret < 0) {
179         return ret;
180     }
181     sysbus_dev = SYS_BUS_DEVICE(&os->nvram);
182     memory_region_add_subregion(&s->bar, 0x60000,
183                                 sysbus_mmio_get_region(sysbus_dev, 0));
184     pmac_format_nvram_partition(&os->nvram, os->nvram.size);
185 
186     if (s->pic_mem) {
187         /* Heathrow PIC */
188         memory_region_add_subregion(&s->bar, 0x00000, s->pic_mem);
189     }
190 
191     /* IDE buses */
192     for (i = 0; i < ARRAY_SIZE(os->ide); i++) {
193         qemu_irq irq0 = os->irqs[cur_irq++];
194         qemu_irq irq1 = os->irqs[cur_irq++];
195 
196         ret = macio_initfn_ide(s, &os->ide[i], irq0, irq1, 0x16 + (i * 4));
197         if (ret < 0) {
198             return ret;
199         }
200     }
201 
202     return 0;
203 }
204 
205 static void macio_init_ide(MacIOState *s, MACIOIDEState *ide, int index)
206 {
207     gchar *name;
208 
209     object_initialize(ide, TYPE_MACIO_IDE);
210     qdev_set_parent_bus(DEVICE(ide), sysbus_get_default());
211     memory_region_add_subregion(&s->bar, 0x1f000 + ((index + 1) * 0x1000),
212                                 &ide->mem);
213     name = g_strdup_printf("ide[%i]", index);
214     object_property_add_child(OBJECT(s), name, OBJECT(ide), NULL);
215     g_free(name);
216 }
217 
218 static void macio_oldworld_init(Object *obj)
219 {
220     MacIOState *s = MACIO(obj);
221     OldWorldMacIOState *os = OLDWORLD_MACIO(obj);
222     DeviceState *dev;
223     int i;
224 
225     qdev_init_gpio_out(DEVICE(obj), os->irqs, ARRAY_SIZE(os->irqs));
226 
227     object_initialize(&os->nvram, TYPE_MACIO_NVRAM);
228     dev = DEVICE(&os->nvram);
229     qdev_prop_set_uint32(dev, "size", 0x2000);
230     qdev_prop_set_uint32(dev, "it_shift", 4);
231 
232     for (i = 0; i < 2; i++) {
233         macio_init_ide(s, &os->ide[i], i);
234     }
235 }
236 
237 static void timer_write(void *opaque, hwaddr addr, uint64_t value,
238                        unsigned size)
239 {
240 }
241 
242 static uint64_t timer_read(void *opaque, hwaddr addr, unsigned size)
243 {
244     uint32_t value = 0;
245 
246     switch (addr) {
247     case 0x38:
248         value = qemu_get_clock_ns(vm_clock);
249         break;
250     case 0x3c:
251         value = qemu_get_clock_ns(vm_clock) >> 32;
252         break;
253     }
254 
255     return value;
256 }
257 
258 static const MemoryRegionOps timer_ops = {
259     .read = timer_read,
260     .write = timer_write,
261     .endianness = DEVICE_NATIVE_ENDIAN,
262 };
263 
264 static int macio_newworld_initfn(PCIDevice *d)
265 {
266     MacIOState *s = MACIO(d);
267     NewWorldMacIOState *ns = NEWWORLD_MACIO(d);
268     SysBusDevice *sysbus_dev;
269     MemoryRegion *timer_memory = g_new(MemoryRegion, 1);
270     int i;
271     int cur_irq = 0;
272     int ret = macio_common_initfn(d);
273     if (ret < 0) {
274         return ret;
275     }
276 
277     sysbus_dev = SYS_BUS_DEVICE(&s->cuda);
278     sysbus_connect_irq(sysbus_dev, 0, ns->irqs[cur_irq++]);
279 
280     if (s->pic_mem) {
281         /* OpenPIC */
282         memory_region_add_subregion(&s->bar, 0x40000, s->pic_mem);
283     }
284 
285     /* IDE buses */
286     for (i = 0; i < ARRAY_SIZE(ns->ide); i++) {
287         qemu_irq irq0 = ns->irqs[cur_irq++];
288         qemu_irq irq1 = ns->irqs[cur_irq++];
289 
290         ret = macio_initfn_ide(s, &ns->ide[i], irq0, irq1, 0x16 + (i * 4));
291         if (ret < 0) {
292             return ret;
293         }
294     }
295 
296     /* Timer */
297     memory_region_init_io(timer_memory, OBJECT(s), &timer_ops, NULL, "timer",
298                           0x1000);
299     memory_region_add_subregion(&s->bar, 0x15000, timer_memory);
300 
301     return 0;
302 }
303 
304 static void macio_newworld_init(Object *obj)
305 {
306     MacIOState *s = MACIO(obj);
307     NewWorldMacIOState *ns = NEWWORLD_MACIO(obj);
308     int i;
309 
310     qdev_init_gpio_out(DEVICE(obj), ns->irqs, ARRAY_SIZE(ns->irqs));
311 
312     for (i = 0; i < 2; i++) {
313         macio_init_ide(s, &ns->ide[i], i);
314     }
315 }
316 
317 static void macio_instance_init(Object *obj)
318 {
319     MacIOState *s = MACIO(obj);
320     MemoryRegion *dbdma_mem;
321 
322     memory_region_init(&s->bar, NULL, "macio", 0x80000);
323 
324     object_initialize(&s->cuda, TYPE_CUDA);
325     qdev_set_parent_bus(DEVICE(&s->cuda), sysbus_get_default());
326     object_property_add_child(obj, "cuda", OBJECT(&s->cuda), NULL);
327 
328     s->dbdma = DBDMA_init(&dbdma_mem);
329     memory_region_add_subregion(&s->bar, 0x08000, dbdma_mem);
330 }
331 
332 static void macio_oldworld_class_init(ObjectClass *oc, void *data)
333 {
334     PCIDeviceClass *pdc = PCI_DEVICE_CLASS(oc);
335 
336     pdc->init = macio_oldworld_initfn;
337     pdc->device_id = PCI_DEVICE_ID_APPLE_343S1201;
338 }
339 
340 static void macio_newworld_class_init(ObjectClass *oc, void *data)
341 {
342     PCIDeviceClass *pdc = PCI_DEVICE_CLASS(oc);
343 
344     pdc->init = macio_newworld_initfn;
345     pdc->device_id = PCI_DEVICE_ID_APPLE_UNI_N_KEYL;
346 }
347 
348 static void macio_class_init(ObjectClass *klass, void *data)
349 {
350     PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
351 
352     k->vendor_id = PCI_VENDOR_ID_APPLE;
353     k->class_id = PCI_CLASS_OTHERS << 8;
354 }
355 
356 static const TypeInfo macio_oldworld_type_info = {
357     .name          = TYPE_OLDWORLD_MACIO,
358     .parent        = TYPE_MACIO,
359     .instance_size = sizeof(OldWorldMacIOState),
360     .instance_init = macio_oldworld_init,
361     .class_init    = macio_oldworld_class_init,
362 };
363 
364 static const TypeInfo macio_newworld_type_info = {
365     .name          = TYPE_NEWWORLD_MACIO,
366     .parent        = TYPE_MACIO,
367     .instance_size = sizeof(NewWorldMacIOState),
368     .instance_init = macio_newworld_init,
369     .class_init    = macio_newworld_class_init,
370 };
371 
372 static const TypeInfo macio_type_info = {
373     .name          = TYPE_MACIO,
374     .parent        = TYPE_PCI_DEVICE,
375     .instance_size = sizeof(MacIOState),
376     .instance_init = macio_instance_init,
377     .abstract      = true,
378     .class_init    = macio_class_init,
379 };
380 
381 static void macio_register_types(void)
382 {
383     type_register_static(&macio_type_info);
384     type_register_static(&macio_oldworld_type_info);
385     type_register_static(&macio_newworld_type_info);
386 }
387 
388 type_init(macio_register_types)
389 
390 void macio_init(PCIDevice *d,
391                 MemoryRegion *pic_mem,
392                 MemoryRegion *escc_mem)
393 {
394     MacIOState *macio_state = MACIO(d);
395 
396     macio_state->pic_mem = pic_mem;
397     macio_state->escc_mem = escc_mem;
398     /* Note: this code is strongly inspirated from the corresponding code
399        in PearPC */
400 
401     qdev_init_nofail(DEVICE(d));
402 }
403