hw/acpi_piix4.c

   1 /*
   2  * ACPI implementation
   3  *
   4  * Copyright (c) 2006 Fabrice Bellard
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License version 2 as published by the Free Software Foundation.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, see <http://www.gnu.org/licenses/>
  17  *
  18  * Contributions after 2012-01-13 are licensed under the terms of the
  19  * GNU GPL, version 2 or (at your option) any later version.
  20  */
  21 #include "hw.h"
  22 #include "pc.h"
  23 #include "apm.h"
  24 #include "pm_smbus.h"
  25 #include "pci.h"
  26 #include "acpi.h"
  27 #include "sysemu.h"
  28 #include "range.h"
  29 #include "ioport.h"
  30
  31 //#define DEBUG
  32
  33 #ifdef DEBUG
  34 # define PIIX4_DPRINTF(format, ...)     printf(format, ## __VA_ARGS__)
  35 #else
  36 # define PIIX4_DPRINTF(format, ...)     do { } while (0)
  37 #endif
  38
  39 #define ACPI_DBG_IO_ADDR  0xb044
  40
  41 #define GPE_BASE 0xafe0
  42 #define GPE_LEN 4
  43 #define PCI_UP_BASE 0xae00
  44 #define PCI_DOWN_BASE 0xae04
  45 #define PCI_EJ_BASE 0xae08
  46 #define PCI_RMV_BASE 0xae0c
  47
  48 #define PIIX4_PCI_HOTPLUG_STATUS 2
  49
  50 struct pci_status {
  51     uint32_t up; /* deprecated, maintained for migration compatibility */
  52     uint32_t down;
  53 };
  54
  55 typedef struct PIIX4PMState {
  56     PCIDevice dev;
  57     IORange ioport;
  58     ACPIREGS ar;
  59
  60     APMState apm;
  61
  62     PMSMBus smb;
  63     uint32_t smb_io_base;
  64
  65     qemu_irq irq;
  66     qemu_irq smi_irq;
  67     int kvm_enabled;
  68     Notifier machine_ready;
  69
  70     /* for pci hotplug */
  71     struct pci_status pci0_status;
  72     uint32_t pci0_hotplug_enable;
  73     uint32_t pci0_slot_device_present;
  74 } PIIX4PMState;
  75
  76 static void piix4_acpi_system_hot_add_init(PCIBus *bus, PIIX4PMState *s);
  77
  78 #define ACPI_ENABLE 0xf1
  79 #define ACPI_DISABLE 0xf0
  80
  81 static void pm_update_sci(PIIX4PMState *s)
  82 {
  83     int sci_level, pmsts;
  84
  85     pmsts = acpi_pm1_evt_get_sts(&s->ar);
  86     sci_level = (((pmsts & s->ar.pm1.evt.en) &
  87                   (ACPI_BITMASK_RT_CLOCK_ENABLE |
  88                    ACPI_BITMASK_POWER_BUTTON_ENABLE |
  89                    ACPI_BITMASK_GLOBAL_LOCK_ENABLE |
  90                    ACPI_BITMASK_TIMER_ENABLE)) != 0) ||
  91         (((s->ar.gpe.sts[0] & s->ar.gpe.en[0])
  92           & PIIX4_PCI_HOTPLUG_STATUS) != 0);
  93
  94     qemu_set_irq(s->irq, sci_level);
  95     /* schedule a timer interruption if needed */
  96     acpi_pm_tmr_update(&s->ar, (s->ar.pm1.evt.en & ACPI_BITMASK_TIMER_ENABLE) &&
  97                        !(pmsts & ACPI_BITMASK_TIMER_STATUS));
  98 }
  99
 100 static void pm_tmr_timer(ACPIREGS *ar)
 101 {
 102     PIIX4PMState *s = container_of(ar, PIIX4PMState, ar);
 103     pm_update_sci(s);
 104 }
 105
 106 static void pm_ioport_write(IORange *ioport, uint64_t addr, unsigned width,
 107                             uint64_t val)
 108 {
 109     PIIX4PMState *s = container_of(ioport, PIIX4PMState, ioport);
 110
 111     if (width != 2) {
 112         PIIX4_DPRINTF("PM write port=0x%04x width=%d val=0x%08x\n",
 113                       (unsigned)addr, width, (unsigned)val);
 114     }
 115
 116     switch(addr) {
 117     case 0x00:
 118         acpi_pm1_evt_write_sts(&s->ar, val);
 119         pm_update_sci(s);
 120         break;
 121     case 0x02:
 122         acpi_pm1_evt_write_en(&s->ar, val);
 123         pm_update_sci(s);
 124         break;
 125     case 0x04:
 126         acpi_pm1_cnt_write(&s->ar, val);
 127         break;
 128     default:
 129         break;
 130     }
 131     PIIX4_DPRINTF("PM writew port=0x%04x val=0x%04x\n", (unsigned int)addr,
 132                   (unsigned int)val);
 133 }
 134
 135 static void pm_ioport_read(IORange *ioport, uint64_t addr, unsigned width,
 136                             uint64_t *data)
 137 {
 138     PIIX4PMState *s = container_of(ioport, PIIX4PMState, ioport);
 139     uint32_t val;
 140
 141     switch(addr) {
 142     case 0x00:
 143         val = acpi_pm1_evt_get_sts(&s->ar);
 144         break;
 145     case 0x02:
 146         val = s->ar.pm1.evt.en;
 147         break;
 148     case 0x04:
 149         val = s->ar.pm1.cnt.cnt;
 150         break;
 151     case 0x08:
 152         val = acpi_pm_tmr_get(&s->ar);
 153         break;
 154     default:
 155         val = 0;
 156         break;
 157     }
 158     PIIX4_DPRINTF("PM readw port=0x%04x val=0x%04x\n", (unsigned int)addr, val);
 159     *data = val;
 160 }
 161
 162 static const IORangeOps pm_iorange_ops = {
 163     .read = pm_ioport_read,
 164     .write = pm_ioport_write,
 165 };
 166
 167 static void apm_ctrl_changed(uint32_t val, void *arg)
 168 {
 169     PIIX4PMState *s = arg;
 170
 171     /* ACPI specs 3.0, 4.7.2.5 */
 172     acpi_pm1_cnt_update(&s->ar, val == ACPI_ENABLE, val == ACPI_DISABLE);
 173
 174     if (s->dev.config[0x5b] & (1 << 1)) {
 175         if (s->smi_irq) {
 176             qemu_irq_raise(s->smi_irq);
 177         }
 178     }
 179 }
 180
 181 static void acpi_dbg_writel(void *opaque, uint32_t addr, uint32_t val)
 182 {
 183     PIIX4_DPRINTF("ACPI: DBG: 0x%08x\n", val);
 184 }
 185
 186 static void pm_io_space_update(PIIX4PMState *s)
 187 {
 188     uint32_t pm_io_base;
 189
 190     if (s->dev.config[0x80] & 1) {
 191         pm_io_base = le32_to_cpu(*(uint32_t *)(s->dev.config + 0x40));
 192         pm_io_base &= 0xffc0;
 193
 194         /* XXX: need to improve memory and ioport allocation */
 195         PIIX4_DPRINTF("PM: mapping to 0x%x\n", pm_io_base);
 196         iorange_init(&s->ioport, &pm_iorange_ops, pm_io_base, 64);
 197         ioport_register(&s->ioport);
 198     }
 199 }
 200
 201 static void pm_write_config(PCIDevice *d,
 202                             uint32_t address, uint32_t val, int len)
 203 {
 204     pci_default_write_config(d, address, val, len);
 205     if (range_covers_byte(address, len, 0x80))
 206         pm_io_space_update((PIIX4PMState *)d);
 207 }
 208
 209 static void vmstate_pci_status_pre_save(void *opaque)
 210 {
 211     struct pci_status *pci0_status = opaque;
 212     PIIX4PMState *s = container_of(pci0_status, PIIX4PMState, pci0_status);
 213
 214     /* We no longer track up, so build a safe value for migrating
 215      * to a version that still does... of course these might get lost
 216      * by an old buggy implementation, but we try. */
 217     pci0_status->up = s->pci0_slot_device_present & s->pci0_hotplug_enable;
 218 }
 219
 220 static int vmstate_acpi_post_load(void *opaque, int version_id)
 221 {
 222     PIIX4PMState *s = opaque;
 223
 224     pm_io_space_update(s);
 225     return 0;
 226 }
 227
 228 #define VMSTATE_GPE_ARRAY(_field, _state)                            \
 229  {                                                                   \
 230      .name       = (stringify(_field)),                              \
 231      .version_id = 0,                                                \
 232      .num        = GPE_LEN,                                          \
 233      .info       = &vmstate_info_uint16,                             \
 234      .size       = sizeof(uint16_t),                                 \
 235      .flags      = VMS_ARRAY | VMS_POINTER,                          \
 236      .offset     = vmstate_offset_pointer(_state, _field, uint8_t),  \
 237  }
 238
 239 static const VMStateDescription vmstate_gpe = {
 240     .name = "gpe",
 241     .version_id = 1,
 242     .minimum_version_id = 1,
 243     .minimum_version_id_old = 1,
 244     .fields      = (VMStateField []) {
 245         VMSTATE_GPE_ARRAY(sts, ACPIGPE),
 246         VMSTATE_GPE_ARRAY(en, ACPIGPE),
 247         VMSTATE_END_OF_LIST()
 248     }
 249 };
 250
 251 static const VMStateDescription vmstate_pci_status = {
 252     .name = "pci_status",
 253     .version_id = 1,
 254     .minimum_version_id = 1,
 255     .minimum_version_id_old = 1,
 256     .pre_save = vmstate_pci_status_pre_save,
 257     .fields      = (VMStateField []) {
 258         VMSTATE_UINT32(up, struct pci_status),
 259         VMSTATE_UINT32(down, struct pci_status),
 260         VMSTATE_END_OF_LIST()
 261     }
 262 };
 263
 264 static const VMStateDescription vmstate_acpi = {
 265     .name = "piix4_pm",
 266     .version_id = 2,
 267     .minimum_version_id = 1,
 268     .minimum_version_id_old = 1,
 269     .post_load = vmstate_acpi_post_load,
 270     .fields      = (VMStateField []) {
 271         VMSTATE_PCI_DEVICE(dev, PIIX4PMState),
 272         VMSTATE_UINT16(ar.pm1.evt.sts, PIIX4PMState),
 273         VMSTATE_UINT16(ar.pm1.evt.en, PIIX4PMState),
 274         VMSTATE_UINT16(ar.pm1.cnt.cnt, PIIX4PMState),
 275         VMSTATE_STRUCT(apm, PIIX4PMState, 0, vmstate_apm, APMState),
 276         VMSTATE_TIMER(ar.tmr.timer, PIIX4PMState),
 277         VMSTATE_INT64(ar.tmr.overflow_time, PIIX4PMState),
 278         VMSTATE_STRUCT(ar.gpe, PIIX4PMState, 2, vmstate_gpe, ACPIGPE),
 279         VMSTATE_STRUCT(pci0_status, PIIX4PMState, 2, vmstate_pci_status,
 280                        struct pci_status),
 281         VMSTATE_END_OF_LIST()
 282     }
 283 };
 284
 285 static void acpi_piix_eject_slot(PIIX4PMState *s, unsigned slots)
 286 {
 287     DeviceState *qdev, *next;
 288     BusState *bus = qdev_get_parent_bus(&s->dev.qdev);
 289     int slot = ffs(slots) - 1;
 290     bool slot_free = true;
 291
 292     /* Mark request as complete */
 293     s->pci0_status.down &= ~(1U << slot);
 294
 295     QTAILQ_FOREACH_SAFE(qdev, &bus->children, sibling, next) {
 296         PCIDevice *dev = PCI_DEVICE(qdev);
 297         PCIDeviceClass *pc = PCI_DEVICE_GET_CLASS(dev);
 298         if (PCI_SLOT(dev->devfn) == slot) {
 299             if (pc->no_hotplug) {
 300                 slot_free = false;
 301             } else {
 302                 qdev_free(qdev);
 303             }
 304         }
 305     }
 306     if (slot_free) {
 307         s->pci0_slot_device_present &= ~(1U << slot);
 308     }
 309 }
 310
 311 static void piix4_update_hotplug(PIIX4PMState *s)
 312 {
 313     PCIDevice *dev = &s->dev;
 314     BusState *bus = qdev_get_parent_bus(&dev->qdev);
 315     DeviceState *qdev, *next;
 316
 317     /* Execute any pending removes during reset */
 318     while (s->pci0_status.down) {
 319         acpi_piix_eject_slot(s, s->pci0_status.down);
 320     }
 321
 322     s->pci0_hotplug_enable = ~0;
 323     s->pci0_slot_device_present = 0;
 324
 325     QTAILQ_FOREACH_SAFE(qdev, &bus->children, sibling, next) {
 326         PCIDevice *pdev = PCI_DEVICE(qdev);
 327         PCIDeviceClass *pc = PCI_DEVICE_GET_CLASS(pdev);
 328         int slot = PCI_SLOT(pdev->devfn);
 329
 330         if (pc->no_hotplug) {
 331             s->pci0_hotplug_enable &= ~(1U << slot);
 332         }
 333
 334         s->pci0_slot_device_present |= (1U << slot);
 335     }
 336 }
 337
 338 static void piix4_reset(void *opaque)
 339 {
 340     PIIX4PMState *s = opaque;
 341     uint8_t *pci_conf = s->dev.config;
 342
 343     pci_conf[0x58] = 0;
 344     pci_conf[0x59] = 0;
 345     pci_conf[0x5a] = 0;
 346     pci_conf[0x5b] = 0;
 347
 348     if (s->kvm_enabled) {
 349         /* Mark SMM as already inited (until KVM supports SMM). */
 350         pci_conf[0x5B] = 0x02;
 351     }
 352     piix4_update_hotplug(s);
 353 }
 354
 355 static void piix4_powerdown(void *opaque, int irq, int power_failing)
 356 {
 357     PIIX4PMState *s = opaque;
 358
 359     assert(s != NULL);
 360     acpi_pm1_evt_power_down(&s->ar);
 361 }
 362
 363 static void piix4_pm_machine_ready(Notifier *n, void *opaque)
 364 {
 365     PIIX4PMState *s = container_of(n, PIIX4PMState, machine_ready);
 366     uint8_t *pci_conf;
 367
 368     pci_conf = s->dev.config;
 369     pci_conf[0x5f] = (isa_is_ioport_assigned(0x378) ? 0x80 : 0) | 0x10;
 370     pci_conf[0x63] = 0x60;
 371     pci_conf[0x67] = (isa_is_ioport_assigned(0x3f8) ? 0x08 : 0) |
 372         (isa_is_ioport_assigned(0x2f8) ? 0x90 : 0);
 373
 374 }
 375
 376 static int piix4_pm_initfn(PCIDevice *dev)
 377 {
 378     PIIX4PMState *s = DO_UPCAST(PIIX4PMState, dev, dev);
 379     uint8_t *pci_conf;
 380
 381     pci_conf = s->dev.config;
 382     pci_conf[0x06] = 0x80;
 383     pci_conf[0x07] = 0x02;
 384     pci_conf[0x09] = 0x00;
 385     pci_conf[0x3d] = 0x01; // interrupt pin 1
 386
 387     pci_conf[0x40] = 0x01; /* PM io base read only bit */
 388
 389     /* APM */
 390     apm_init(&s->apm, apm_ctrl_changed, s);
 391
 392     register_ioport_write(ACPI_DBG_IO_ADDR, 4, 4, acpi_dbg_writel, s);
 393
 394     if (s->kvm_enabled) {
 395         /* Mark SMM as already inited to prevent SMM from running.  KVM does not
 396          * support SMM mode. */
 397         pci_conf[0x5B] = 0x02;
 398     }
 399
 400     /* XXX: which specification is used ? The i82731AB has different
 401        mappings */
 402     pci_conf[0x90] = s->smb_io_base | 1;
 403     pci_conf[0x91] = s->smb_io_base >> 8;
 404     pci_conf[0xd2] = 0x09;
 405     register_ioport_write(s->smb_io_base, 64, 1, smb_ioport_writeb, &s->smb);
 406     register_ioport_read(s->smb_io_base, 64, 1, smb_ioport_readb, &s->smb);
 407
 408     acpi_pm_tmr_init(&s->ar, pm_tmr_timer);
 409     acpi_gpe_init(&s->ar, GPE_LEN);
 410
 411     qemu_system_powerdown = *qemu_allocate_irqs(piix4_powerdown, s, 1);
 412
 413     pm_smbus_init(&s->dev.qdev, &s->smb);
 414     s->machine_ready.notify = piix4_pm_machine_ready;
 415     qemu_add_machine_init_done_notifier(&s->machine_ready);
 416     qemu_register_reset(piix4_reset, s);
 417     piix4_acpi_system_hot_add_init(dev->bus, s);
 418
 419     return 0;
 420 }
 421
 422 i2c_bus *piix4_pm_init(PCIBus *bus, int devfn, uint32_t smb_io_base,
 423                        qemu_irq sci_irq, qemu_irq smi_irq,
 424                        int kvm_enabled)
 425 {
 426     PCIDevice *dev;
 427     PIIX4PMState *s;
 428
 429     dev = pci_create(bus, devfn, "PIIX4_PM");
 430     qdev_prop_set_uint32(&dev->qdev, "smb_io_base", smb_io_base);
 431
 432     s = DO_UPCAST(PIIX4PMState, dev, dev);
 433     s->irq = sci_irq;
 434     acpi_pm1_cnt_init(&s->ar);
 435     s->smi_irq = smi_irq;
 436     s->kvm_enabled = kvm_enabled;
 437
 438     qdev_init_nofail(&dev->qdev);
 439
 440     return s->smb.smbus;
 441 }
 442
 443 static Property piix4_pm_properties[] = {
 444     DEFINE_PROP_UINT32("smb_io_base", PIIX4PMState, smb_io_base, 0),
 445     DEFINE_PROP_END_OF_LIST(),
 446 };
 447
 448 static void piix4_pm_class_init(ObjectClass *klass, void *data)
 449 {
 450     DeviceClass *dc = DEVICE_CLASS(klass);
 451     PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
 452
 453     k->no_hotplug = 1;
 454     k->init = piix4_pm_initfn;
 455     k->config_write = pm_write_config;
 456     k->vendor_id = PCI_VENDOR_ID_INTEL;
 457     k->device_id = PCI_DEVICE_ID_INTEL_82371AB_3;
 458     k->revision = 0x03;
 459     k->class_id = PCI_CLASS_BRIDGE_OTHER;
 460     dc->desc = "PM";
 461     dc->no_user = 1;
 462     dc->vmsd = &vmstate_acpi;
 463     dc->props = piix4_pm_properties;
 464 }
 465
 466 static TypeInfo piix4_pm_info = {
 467     .name          = "PIIX4_PM",
 468     .parent        = TYPE_PCI_DEVICE,
 469     .instance_size = sizeof(PIIX4PMState),
 470     .class_init    = piix4_pm_class_init,
 471 };
 472
 473 static void piix4_pm_register_types(void)
 474 {
 475     type_register_static(&piix4_pm_info);
 476 }
 477
 478 type_init(piix4_pm_register_types)
 479
 480 static uint32_t gpe_readb(void *opaque, uint32_t addr)
 481 {
 482     PIIX4PMState *s = opaque;
 483     uint32_t val = acpi_gpe_ioport_readb(&s->ar, addr);
 484
 485     PIIX4_DPRINTF("gpe read %x == %x\n", addr, val);
 486     return val;
 487 }
 488
 489 static void gpe_writeb(void *opaque, uint32_t addr, uint32_t val)
 490 {
 491     PIIX4PMState *s = opaque;
 492
 493     acpi_gpe_ioport_writeb(&s->ar, addr, val);
 494     pm_update_sci(s);
 495
 496     PIIX4_DPRINTF("gpe write %x <== %d\n", addr, val);
 497 }
 498
 499 static uint32_t pci_up_read(void *opaque, uint32_t addr)
 500 {
 501     PIIX4PMState *s = opaque;
 502     uint32_t val;
 503
 504     /* Manufacture an "up" value to cause a device check on any hotplug
 505      * slot with a device.  Extra device checks are harmless. */
 506     val = s->pci0_slot_device_present & s->pci0_hotplug_enable;
 507
 508     PIIX4_DPRINTF("pci_up_read %x\n", val);
 509     return val;
 510 }
 511
 512 static uint32_t pci_down_read(void *opaque, uint32_t addr)
 513 {
 514     PIIX4PMState *s = opaque;
 515     uint32_t val = s->pci0_status.down;
 516
 517     PIIX4_DPRINTF("pci_down_read %x\n", val);
 518     return val;
 519 }
 520
 521 static uint32_t pci_features_read(void *opaque, uint32_t addr)
 522 {
 523     /* No feature defined yet */
 524     PIIX4_DPRINTF("pci_features_read %x\n", 0);
 525     return 0;
 526 }
 527
 528 static void pciej_write(void *opaque, uint32_t addr, uint32_t val)
 529 {
 530     acpi_piix_eject_slot(opaque, val);
 531
 532     PIIX4_DPRINTF("pciej write %x <== %d\n", addr, val);
 533 }
 534
 535 static uint32_t pcirmv_read(void *opaque, uint32_t addr)
 536 {
 537     PIIX4PMState *s = opaque;
 538
 539     return s->pci0_hotplug_enable;
 540 }
 541
 542 static int piix4_device_hotplug(DeviceState *qdev, PCIDevice *dev,
 543                                 PCIHotplugState state);
 544
 545 static void piix4_acpi_system_hot_add_init(PCIBus *bus, PIIX4PMState *s)
 546 {
 547
 548     register_ioport_write(GPE_BASE, GPE_LEN, 1, gpe_writeb, s);
 549     register_ioport_read(GPE_BASE, GPE_LEN, 1,  gpe_readb, s);
 550     acpi_gpe_blk(&s->ar, GPE_BASE);
 551
 552     register_ioport_read(PCI_UP_BASE, 4, 4, pci_up_read, s);
 553     register_ioport_read(PCI_DOWN_BASE, 4, 4, pci_down_read, s);
 554
 555     register_ioport_write(PCI_EJ_BASE, 4, 4, pciej_write, s);
 556     register_ioport_read(PCI_EJ_BASE, 4, 4,  pci_features_read, s);
 557
 558     register_ioport_read(PCI_RMV_BASE, 4, 4,  pcirmv_read, s);
 559
 560     pci_bus_hotplug(bus, piix4_device_hotplug, &s->dev.qdev);
 561 }
 562
 563 static void enable_device(PIIX4PMState *s, int slot)
 564 {
 565     s->ar.gpe.sts[0] |= PIIX4_PCI_HOTPLUG_STATUS;
 566     s->pci0_slot_device_present |= (1U << slot);
 567 }
 568
 569 static void disable_device(PIIX4PMState *s, int slot)
 570 {
 571     s->ar.gpe.sts[0] |= PIIX4_PCI_HOTPLUG_STATUS;
 572     s->pci0_status.down |= (1U << slot);
 573 }
 574
 575 static int piix4_device_hotplug(DeviceState *qdev, PCIDevice *dev,
 576                                 PCIHotplugState state)
 577 {
 578     int slot = PCI_SLOT(dev->devfn);
 579     PIIX4PMState *s = DO_UPCAST(PIIX4PMState, dev,
 580                                 PCI_DEVICE(qdev));
 581
 582     /* Don't send event when device is enabled during qemu machine creation:
 583      * it is present on boot, no hotplug event is necessary. We do send an
 584      * event when the device is disabled later. */
 585     if (state == PCI_COLDPLUG_ENABLED) {
 586         s->pci0_slot_device_present |= (1U << slot);
 587         return 0;
 588     }
 589
 590     if (state == PCI_HOTPLUG_ENABLED) {
 591         enable_device(s, slot);
 592     } else {
 593         disable_device(s, slot);
 594     }
 595
 596     pm_update_sci(s);
 597
 598     return 0;
 599 }