xref: /openbmc/qemu/hw/isa/vt82c686.c (revision 02e5d7d7)
1 /*
2  * VT82C686B south bridge support
3  *
4  * Copyright (c) 2008 yajin (yajin@vm-kernel.org)
5  * Copyright (c) 2009 chenming (chenming@rdc.faw.com.cn)
6  * Copyright (c) 2010 Huacai Chen (zltjiangshi@gmail.com)
7  * This code is licensed under the GNU GPL v2.
8  *
9  * Contributions after 2012-01-13 are licensed under the terms of the
10  * GNU GPL, version 2 or (at your option) any later version.
11  */
12 
13 #include "qemu/osdep.h"
14 #include "hw/isa/vt82c686.h"
15 #include "hw/i2c/i2c.h"
16 #include "hw/pci/pci.h"
17 #include "hw/qdev-properties.h"
18 #include "hw/isa/isa.h"
19 #include "hw/isa/superio.h"
20 #include "hw/sysbus.h"
21 #include "migration/vmstate.h"
22 #include "hw/mips/mips.h"
23 #include "hw/isa/apm.h"
24 #include "hw/acpi/acpi.h"
25 #include "hw/i2c/pm_smbus.h"
26 #include "qapi/error.h"
27 #include "qemu/module.h"
28 #include "qemu/timer.h"
29 #include "exec/address-spaces.h"
30 
31 /* #define DEBUG_VT82C686B */
32 
33 #ifdef DEBUG_VT82C686B
34 #define DPRINTF(fmt, ...) fprintf(stderr, "%s: " fmt, __func__, ##__VA_ARGS__)
35 #else
36 #define DPRINTF(fmt, ...)
37 #endif
38 
39 typedef struct SuperIOConfig {
40     uint8_t config[0x100];
41     uint8_t index;
42     uint8_t data;
43 } SuperIOConfig;
44 
45 typedef struct VT82C686BState {
46     PCIDevice dev;
47     MemoryRegion superio;
48     SuperIOConfig superio_conf;
49 } VT82C686BState;
50 
51 #define TYPE_VT82C686B_DEVICE "VT82C686B"
52 #define VT82C686B_DEVICE(obj) \
53     OBJECT_CHECK(VT82C686BState, (obj), TYPE_VT82C686B_DEVICE)
54 
55 static void superio_ioport_writeb(void *opaque, hwaddr addr, uint64_t data,
56                                   unsigned size)
57 {
58     SuperIOConfig *superio_conf = opaque;
59 
60     DPRINTF("superio_ioport_writeb  address 0x%x  val 0x%x\n", addr, data);
61     if (addr == 0x3f0) {
62         superio_conf->index = data & 0xff;
63     } else {
64         bool can_write = true;
65         /* 0x3f1 */
66         switch (superio_conf->index) {
67         case 0x00 ... 0xdf:
68         case 0xe4:
69         case 0xe5:
70         case 0xe9 ... 0xed:
71         case 0xf3:
72         case 0xf5:
73         case 0xf7:
74         case 0xf9 ... 0xfb:
75         case 0xfd ... 0xff:
76             can_write = false;
77             break;
78         case 0xe7:
79             if ((data & 0xff) != 0xfe) {
80                 DPRINTF("change uart 1 base. unsupported yet\n");
81                 can_write = false;
82             }
83             break;
84         case 0xe8:
85             if ((data & 0xff) != 0xbe) {
86                 DPRINTF("change uart 2 base. unsupported yet\n");
87                 can_write = false;
88             }
89             break;
90         default:
91             break;
92 
93         }
94         if (can_write) {
95             superio_conf->config[superio_conf->index] = data & 0xff;
96         }
97     }
98 }
99 
100 static uint64_t superio_ioport_readb(void *opaque, hwaddr addr, unsigned size)
101 {
102     SuperIOConfig *superio_conf = opaque;
103 
104     DPRINTF("superio_ioport_readb  address 0x%x\n", addr);
105     return superio_conf->config[superio_conf->index];
106 }
107 
108 static const MemoryRegionOps superio_ops = {
109     .read = superio_ioport_readb,
110     .write = superio_ioport_writeb,
111     .endianness = DEVICE_NATIVE_ENDIAN,
112     .impl = {
113         .min_access_size = 1,
114         .max_access_size = 1,
115     },
116 };
117 
118 static void vt82c686b_isa_reset(DeviceState *dev)
119 {
120     VT82C686BState *vt82c = VT82C686B_DEVICE(dev);
121     uint8_t *pci_conf = vt82c->dev.config;
122 
123     pci_set_long(pci_conf + PCI_CAPABILITY_LIST, 0x000000c0);
124     pci_set_word(pci_conf + PCI_COMMAND, PCI_COMMAND_IO | PCI_COMMAND_MEMORY |
125                  PCI_COMMAND_MASTER | PCI_COMMAND_SPECIAL);
126     pci_set_word(pci_conf + PCI_STATUS, PCI_STATUS_DEVSEL_MEDIUM);
127 
128     pci_conf[0x48] = 0x01; /* Miscellaneous Control 3 */
129     pci_conf[0x4a] = 0x04; /* IDE interrupt Routing */
130     pci_conf[0x4f] = 0x03; /* DMA/Master Mem Access Control 3 */
131     pci_conf[0x50] = 0x2d; /* PnP DMA Request Control */
132     pci_conf[0x59] = 0x04;
133     pci_conf[0x5a] = 0x04; /* KBC/RTC Control*/
134     pci_conf[0x5f] = 0x04;
135     pci_conf[0x77] = 0x10; /* GPIO Control 1/2/3/4 */
136 
137     vt82c->superio_conf.config[0xe0] = 0x3c;
138     vt82c->superio_conf.config[0xe2] = 0x03;
139     vt82c->superio_conf.config[0xe3] = 0xfc;
140     vt82c->superio_conf.config[0xe6] = 0xde;
141     vt82c->superio_conf.config[0xe7] = 0xfe;
142     vt82c->superio_conf.config[0xe8] = 0xbe;
143 }
144 
145 /* write config pci function0 registers. PCI-ISA bridge */
146 static void vt82c686b_write_config(PCIDevice *d, uint32_t address,
147                                    uint32_t val, int len)
148 {
149     VT82C686BState *vt686 = VT82C686B_DEVICE(d);
150 
151     DPRINTF("vt82c686b_write_config  address 0x%x  val 0x%x len 0x%x\n",
152            address, val, len);
153 
154     pci_default_write_config(d, address, val, len);
155     if (address == 0x85) {  /* enable or disable super IO configure */
156         memory_region_set_enabled(&vt686->superio, val & 0x2);
157     }
158 }
159 
160 #define ACPI_DBG_IO_ADDR  0xb044
161 
162 typedef struct VT686PMState {
163     PCIDevice dev;
164     MemoryRegion io;
165     ACPIREGS ar;
166     APMState apm;
167     PMSMBus smb;
168     uint32_t smb_io_base;
169 } VT686PMState;
170 
171 typedef struct VT686AC97State {
172     PCIDevice dev;
173 } VT686AC97State;
174 
175 typedef struct VT686MC97State {
176     PCIDevice dev;
177 } VT686MC97State;
178 
179 #define TYPE_VT82C686B_PM_DEVICE "VT82C686B_PM"
180 #define VT82C686B_PM_DEVICE(obj) \
181     OBJECT_CHECK(VT686PMState, (obj), TYPE_VT82C686B_PM_DEVICE)
182 
183 #define TYPE_VT82C686B_MC97_DEVICE "VT82C686B_MC97"
184 #define VT82C686B_MC97_DEVICE(obj) \
185     OBJECT_CHECK(VT686MC97State, (obj), TYPE_VT82C686B_MC97_DEVICE)
186 
187 #define TYPE_VT82C686B_AC97_DEVICE "VT82C686B_AC97"
188 #define VT82C686B_AC97_DEVICE(obj) \
189     OBJECT_CHECK(VT686AC97State, (obj), TYPE_VT82C686B_AC97_DEVICE)
190 
191 static void pm_update_sci(VT686PMState *s)
192 {
193     int sci_level, pmsts;
194 
195     pmsts = acpi_pm1_evt_get_sts(&s->ar);
196     sci_level = (((pmsts & s->ar.pm1.evt.en) &
197                   (ACPI_BITMASK_RT_CLOCK_ENABLE |
198                    ACPI_BITMASK_POWER_BUTTON_ENABLE |
199                    ACPI_BITMASK_GLOBAL_LOCK_ENABLE |
200                    ACPI_BITMASK_TIMER_ENABLE)) != 0);
201     pci_set_irq(&s->dev, sci_level);
202     /* schedule a timer interruption if needed */
203     acpi_pm_tmr_update(&s->ar, (s->ar.pm1.evt.en & ACPI_BITMASK_TIMER_ENABLE) &&
204                        !(pmsts & ACPI_BITMASK_TIMER_STATUS));
205 }
206 
207 static void pm_tmr_timer(ACPIREGS *ar)
208 {
209     VT686PMState *s = container_of(ar, VT686PMState, ar);
210     pm_update_sci(s);
211 }
212 
213 static void pm_io_space_update(VT686PMState *s)
214 {
215     uint32_t pm_io_base;
216 
217     pm_io_base = pci_get_long(s->dev.config + 0x40);
218     pm_io_base &= 0xffc0;
219 
220     memory_region_transaction_begin();
221     memory_region_set_enabled(&s->io, s->dev.config[0x80] & 1);
222     memory_region_set_address(&s->io, pm_io_base);
223     memory_region_transaction_commit();
224 }
225 
226 static void pm_write_config(PCIDevice *d,
227                             uint32_t address, uint32_t val, int len)
228 {
229     DPRINTF("pm_write_config  address 0x%x  val 0x%x len 0x%x\n",
230            address, val, len);
231     pci_default_write_config(d, address, val, len);
232 }
233 
234 static int vmstate_acpi_post_load(void *opaque, int version_id)
235 {
236     VT686PMState *s = opaque;
237 
238     pm_io_space_update(s);
239     return 0;
240 }
241 
242 static const VMStateDescription vmstate_acpi = {
243     .name = "vt82c686b_pm",
244     .version_id = 1,
245     .minimum_version_id = 1,
246     .post_load = vmstate_acpi_post_load,
247     .fields = (VMStateField[]) {
248         VMSTATE_PCI_DEVICE(dev, VT686PMState),
249         VMSTATE_UINT16(ar.pm1.evt.sts, VT686PMState),
250         VMSTATE_UINT16(ar.pm1.evt.en, VT686PMState),
251         VMSTATE_UINT16(ar.pm1.cnt.cnt, VT686PMState),
252         VMSTATE_STRUCT(apm, VT686PMState, 0, vmstate_apm, APMState),
253         VMSTATE_TIMER_PTR(ar.tmr.timer, VT686PMState),
254         VMSTATE_INT64(ar.tmr.overflow_time, VT686PMState),
255         VMSTATE_END_OF_LIST()
256     }
257 };
258 
259 /*
260  * TODO: vt82c686b_ac97_init() and vt82c686b_mc97_init()
261  * just register a PCI device now, functionalities will be implemented later.
262  */
263 
264 static void vt82c686b_ac97_realize(PCIDevice *dev, Error **errp)
265 {
266     VT686AC97State *s = VT82C686B_AC97_DEVICE(dev);
267     uint8_t *pci_conf = s->dev.config;
268 
269     pci_set_word(pci_conf + PCI_COMMAND, PCI_COMMAND_INVALIDATE |
270                  PCI_COMMAND_PARITY);
271     pci_set_word(pci_conf + PCI_STATUS, PCI_STATUS_CAP_LIST |
272                  PCI_STATUS_DEVSEL_MEDIUM);
273     pci_set_long(pci_conf + PCI_INTERRUPT_PIN, 0x03);
274 }
275 
276 void vt82c686b_ac97_init(PCIBus *bus, int devfn)
277 {
278     PCIDevice *dev;
279 
280     dev = pci_new(devfn, TYPE_VT82C686B_AC97_DEVICE);
281     pci_realize_and_unref(dev, bus, &error_fatal);
282 }
283 
284 static void via_ac97_class_init(ObjectClass *klass, void *data)
285 {
286     DeviceClass *dc = DEVICE_CLASS(klass);
287     PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
288 
289     k->realize = vt82c686b_ac97_realize;
290     k->vendor_id = PCI_VENDOR_ID_VIA;
291     k->device_id = PCI_DEVICE_ID_VIA_AC97;
292     k->revision = 0x50;
293     k->class_id = PCI_CLASS_MULTIMEDIA_AUDIO;
294     set_bit(DEVICE_CATEGORY_SOUND, dc->categories);
295     dc->desc = "AC97";
296 }
297 
298 static const TypeInfo via_ac97_info = {
299     .name          = TYPE_VT82C686B_AC97_DEVICE,
300     .parent        = TYPE_PCI_DEVICE,
301     .instance_size = sizeof(VT686AC97State),
302     .class_init    = via_ac97_class_init,
303     .interfaces = (InterfaceInfo[]) {
304         { INTERFACE_CONVENTIONAL_PCI_DEVICE },
305         { },
306     },
307 };
308 
309 static void vt82c686b_mc97_realize(PCIDevice *dev, Error **errp)
310 {
311     VT686MC97State *s = VT82C686B_MC97_DEVICE(dev);
312     uint8_t *pci_conf = s->dev.config;
313 
314     pci_set_word(pci_conf + PCI_COMMAND, PCI_COMMAND_INVALIDATE |
315                  PCI_COMMAND_VGA_PALETTE);
316     pci_set_word(pci_conf + PCI_STATUS, PCI_STATUS_DEVSEL_MEDIUM);
317     pci_set_long(pci_conf + PCI_INTERRUPT_PIN, 0x03);
318 }
319 
320 void vt82c686b_mc97_init(PCIBus *bus, int devfn)
321 {
322     PCIDevice *dev;
323 
324     dev = pci_new(devfn, TYPE_VT82C686B_MC97_DEVICE);
325     pci_realize_and_unref(dev, bus, &error_fatal);
326 }
327 
328 static void via_mc97_class_init(ObjectClass *klass, void *data)
329 {
330     DeviceClass *dc = DEVICE_CLASS(klass);
331     PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
332 
333     k->realize = vt82c686b_mc97_realize;
334     k->vendor_id = PCI_VENDOR_ID_VIA;
335     k->device_id = PCI_DEVICE_ID_VIA_MC97;
336     k->class_id = PCI_CLASS_COMMUNICATION_OTHER;
337     k->revision = 0x30;
338     set_bit(DEVICE_CATEGORY_NETWORK, dc->categories);
339     dc->desc = "MC97";
340 }
341 
342 static const TypeInfo via_mc97_info = {
343     .name          = TYPE_VT82C686B_MC97_DEVICE,
344     .parent        = TYPE_PCI_DEVICE,
345     .instance_size = sizeof(VT686MC97State),
346     .class_init    = via_mc97_class_init,
347     .interfaces = (InterfaceInfo[]) {
348         { INTERFACE_CONVENTIONAL_PCI_DEVICE },
349         { },
350     },
351 };
352 
353 /* vt82c686 pm init */
354 static void vt82c686b_pm_realize(PCIDevice *dev, Error **errp)
355 {
356     VT686PMState *s = VT82C686B_PM_DEVICE(dev);
357     uint8_t *pci_conf;
358 
359     pci_conf = s->dev.config;
360     pci_set_word(pci_conf + PCI_COMMAND, 0);
361     pci_set_word(pci_conf + PCI_STATUS, PCI_STATUS_FAST_BACK |
362                  PCI_STATUS_DEVSEL_MEDIUM);
363 
364     /* 0x48-0x4B is Power Management I/O Base */
365     pci_set_long(pci_conf + 0x48, 0x00000001);
366 
367     /* SMB ports:0xeee0~0xeeef */
368     s->smb_io_base = ((s->smb_io_base & 0xfff0) + 0x0);
369     pci_conf[0x90] = s->smb_io_base | 1;
370     pci_conf[0x91] = s->smb_io_base >> 8;
371     pci_conf[0xd2] = 0x90;
372     pm_smbus_init(DEVICE(s), &s->smb, false);
373     memory_region_add_subregion(get_system_io(), s->smb_io_base, &s->smb.io);
374 
375     apm_init(dev, &s->apm, NULL, s);
376 
377     memory_region_init(&s->io, OBJECT(dev), "vt82c686-pm", 64);
378     memory_region_set_enabled(&s->io, false);
379     memory_region_add_subregion(get_system_io(), 0, &s->io);
380 
381     acpi_pm_tmr_init(&s->ar, pm_tmr_timer, &s->io);
382     acpi_pm1_evt_init(&s->ar, pm_tmr_timer, &s->io);
383     acpi_pm1_cnt_init(&s->ar, &s->io, false, false, 2);
384 }
385 
386 I2CBus *vt82c686b_pm_init(PCIBus *bus, int devfn, uint32_t smb_io_base,
387                           qemu_irq sci_irq)
388 {
389     PCIDevice *dev;
390     VT686PMState *s;
391 
392     dev = pci_new(devfn, TYPE_VT82C686B_PM_DEVICE);
393     qdev_prop_set_uint32(&dev->qdev, "smb_io_base", smb_io_base);
394 
395     s = VT82C686B_PM_DEVICE(dev);
396 
397     pci_realize_and_unref(dev, bus, &error_fatal);
398 
399     return s->smb.smbus;
400 }
401 
402 static Property via_pm_properties[] = {
403     DEFINE_PROP_UINT32("smb_io_base", VT686PMState, smb_io_base, 0),
404     DEFINE_PROP_END_OF_LIST(),
405 };
406 
407 static void via_pm_class_init(ObjectClass *klass, void *data)
408 {
409     DeviceClass *dc = DEVICE_CLASS(klass);
410     PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
411 
412     k->realize = vt82c686b_pm_realize;
413     k->config_write = pm_write_config;
414     k->vendor_id = PCI_VENDOR_ID_VIA;
415     k->device_id = PCI_DEVICE_ID_VIA_ACPI;
416     k->class_id = PCI_CLASS_BRIDGE_OTHER;
417     k->revision = 0x40;
418     dc->desc = "PM";
419     dc->vmsd = &vmstate_acpi;
420     set_bit(DEVICE_CATEGORY_BRIDGE, dc->categories);
421     device_class_set_props(dc, via_pm_properties);
422 }
423 
424 static const TypeInfo via_pm_info = {
425     .name          = TYPE_VT82C686B_PM_DEVICE,
426     .parent        = TYPE_PCI_DEVICE,
427     .instance_size = sizeof(VT686PMState),
428     .class_init    = via_pm_class_init,
429     .interfaces = (InterfaceInfo[]) {
430         { INTERFACE_CONVENTIONAL_PCI_DEVICE },
431         { },
432     },
433 };
434 
435 static const VMStateDescription vmstate_via = {
436     .name = "vt82c686b",
437     .version_id = 1,
438     .minimum_version_id = 1,
439     .fields = (VMStateField[]) {
440         VMSTATE_PCI_DEVICE(dev, VT82C686BState),
441         VMSTATE_END_OF_LIST()
442     }
443 };
444 
445 /* init the PCI-to-ISA bridge */
446 static void vt82c686b_realize(PCIDevice *d, Error **errp)
447 {
448     VT82C686BState *vt82c = VT82C686B_DEVICE(d);
449     uint8_t *pci_conf;
450     ISABus *isa_bus;
451     uint8_t *wmask;
452     int i;
453 
454     isa_bus = isa_bus_new(DEVICE(d), get_system_memory(),
455                           pci_address_space_io(d), errp);
456     if (!isa_bus) {
457         return;
458     }
459 
460     pci_conf = d->config;
461     pci_config_set_prog_interface(pci_conf, 0x0);
462 
463     wmask = d->wmask;
464     for (i = 0x00; i < 0xff; i++) {
465         if (i <= 0x03 || (i >= 0x08 && i <= 0x3f)) {
466             wmask[i] = 0x00;
467         }
468     }
469 
470     memory_region_init_io(&vt82c->superio, OBJECT(d), &superio_ops,
471                           &vt82c->superio_conf, "superio", 2);
472     memory_region_set_enabled(&vt82c->superio, false);
473     /*
474      * The floppy also uses 0x3f0 and 0x3f1.
475      * But we do not emulate a floppy, so just set it here.
476      */
477     memory_region_add_subregion(isa_bus->address_space_io, 0x3f0,
478                                 &vt82c->superio);
479 }
480 
481 ISABus *vt82c686b_isa_init(PCIBus *bus, int devfn)
482 {
483     PCIDevice *d;
484 
485     d = pci_create_simple_multifunction(bus, devfn, true,
486                                         TYPE_VT82C686B_DEVICE);
487 
488     return ISA_BUS(qdev_get_child_bus(DEVICE(d), "isa.0"));
489 }
490 
491 static void via_class_init(ObjectClass *klass, void *data)
492 {
493     DeviceClass *dc = DEVICE_CLASS(klass);
494     PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
495 
496     k->realize = vt82c686b_realize;
497     k->config_write = vt82c686b_write_config;
498     k->vendor_id = PCI_VENDOR_ID_VIA;
499     k->device_id = PCI_DEVICE_ID_VIA_ISA_BRIDGE;
500     k->class_id = PCI_CLASS_BRIDGE_ISA;
501     k->revision = 0x40;
502     dc->reset = vt82c686b_isa_reset;
503     dc->desc = "ISA bridge";
504     dc->vmsd = &vmstate_via;
505     /*
506      * Reason: part of VIA VT82C686 southbridge, needs to be wired up,
507      * e.g. by mips_fuloong2e_init()
508      */
509     dc->user_creatable = false;
510 }
511 
512 static const TypeInfo via_info = {
513     .name          = TYPE_VT82C686B_DEVICE,
514     .parent        = TYPE_PCI_DEVICE,
515     .instance_size = sizeof(VT82C686BState),
516     .class_init    = via_class_init,
517     .interfaces = (InterfaceInfo[]) {
518         { INTERFACE_CONVENTIONAL_PCI_DEVICE },
519         { },
520     },
521 };
522 
523 static void vt82c686b_superio_class_init(ObjectClass *klass, void *data)
524 {
525     ISASuperIOClass *sc = ISA_SUPERIO_CLASS(klass);
526 
527     sc->serial.count = 2;
528     sc->parallel.count = 1;
529     sc->ide.count = 0;
530     sc->floppy.count = 1;
531 }
532 
533 static const TypeInfo via_superio_info = {
534     .name          = TYPE_VT82C686B_SUPERIO,
535     .parent        = TYPE_ISA_SUPERIO,
536     .instance_size = sizeof(ISASuperIODevice),
537     .class_size    = sizeof(ISASuperIOClass),
538     .class_init    = vt82c686b_superio_class_init,
539 };
540 
541 static void vt82c686b_register_types(void)
542 {
543     type_register_static(&via_ac97_info);
544     type_register_static(&via_mc97_info);
545     type_register_static(&via_pm_info);
546     type_register_static(&via_superio_info);
547     type_register_static(&via_info);
548 }
549 
550 type_init(vt82c686b_register_types)
551