hw/pci/shpc.c

   1 #include "qemu/osdep.h"
   2 #include "qapi/error.h"
   3 #include "qemu/host-utils.h"
   4 #include "qemu/range.h"
   5 #include "qemu/error-report.h"
   6 #include "hw/pci/shpc.h"
   7 #include "hw/pci/pci.h"
   8 #include "hw/pci/pci_bus.h"
   9 #include "hw/pci/msi.h"
  10
  11 /* TODO: model power only and disabled slot states. */
  12 /* TODO: handle SERR and wakeups */
  13 /* TODO: consider enabling 66MHz support */
  14
  15 /* TODO: remove fully only on state DISABLED and LED off.
  16  * track state to properly record this. */
  17
  18 /* SHPC Working Register Set */
  19 #define SHPC_BASE_OFFSET  0x00 /* 4 bytes */
  20 #define SHPC_SLOTS_33     0x04 /* 4 bytes. Also encodes PCI-X slots. */
  21 #define SHPC_SLOTS_66     0x08 /* 4 bytes. */
  22 #define SHPC_NSLOTS       0x0C /* 1 byte */
  23 #define SHPC_FIRST_DEV    0x0D /* 1 byte */
  24 #define SHPC_PHYS_SLOT    0x0E /* 2 byte */
  25 #define SHPC_PHYS_NUM_MAX 0x7ff
  26 #define SHPC_PHYS_NUM_UP  0x2000
  27 #define SHPC_PHYS_MRL     0x4000
  28 #define SHPC_PHYS_BUTTON  0x8000
  29 #define SHPC_SEC_BUS      0x10 /* 2 bytes */
  30 #define SHPC_SEC_BUS_33   0x0
  31 #define SHPC_SEC_BUS_66   0x1 /* Unused */
  32 #define SHPC_SEC_BUS_MASK 0x7
  33 #define SHPC_MSI_CTL      0x12 /* 1 byte */
  34 #define SHPC_PROG_IFC     0x13 /* 1 byte */
  35 #define SHPC_PROG_IFC_1_0 0x1
  36 #define SHPC_CMD_CODE     0x14 /* 1 byte */
  37 #define SHPC_CMD_TRGT     0x15 /* 1 byte */
  38 #define SHPC_CMD_TRGT_MIN 0x1
  39 #define SHPC_CMD_TRGT_MAX 0x1f
  40 #define SHPC_CMD_STATUS   0x16 /* 2 bytes */
  41 #define SHPC_CMD_STATUS_BUSY          0x1
  42 #define SHPC_CMD_STATUS_MRL_OPEN      0x2
  43 #define SHPC_CMD_STATUS_INVALID_CMD   0x4
  44 #define SHPC_CMD_STATUS_INVALID_MODE  0x8
  45 #define SHPC_INT_LOCATOR  0x18 /* 4 bytes */
  46 #define SHPC_INT_COMMAND  0x1
  47 #define SHPC_SERR_LOCATOR 0x1C /* 4 bytes */
  48 #define SHPC_SERR_INT     0x20 /* 4 bytes */
  49 #define SHPC_INT_DIS      0x1
  50 #define SHPC_SERR_DIS     0x2
  51 #define SHPC_CMD_INT_DIS  0x4
  52 #define SHPC_ARB_SERR_DIS 0x8
  53 #define SHPC_CMD_DETECTED 0x10000
  54 #define SHPC_ARB_DETECTED 0x20000
  55  /* 4 bytes * slot # (start from 0) */
  56 #define SHPC_SLOT_REG(s)         (0x24 + (s) * 4)
  57  /* 2 bytes */
  58 #define SHPC_SLOT_STATUS(s)       (0x0 + SHPC_SLOT_REG(s))
  59
  60 /* Same slot state masks are used for command and status registers */
  61 #define SHPC_SLOT_STATE_MASK     0x03
  62 #define SHPC_SLOT_STATE_SHIFT \
  63     ctz32(SHPC_SLOT_STATE_MASK)
  64
  65 #define SHPC_STATE_NO       0x0
  66 #define SHPC_STATE_PWRONLY  0x1
  67 #define SHPC_STATE_ENABLED  0x2
  68 #define SHPC_STATE_DISABLED 0x3
  69
  70 #define SHPC_SLOT_PWR_LED_MASK   0xC
  71 #define SHPC_SLOT_PWR_LED_SHIFT \
  72     ctz32(SHPC_SLOT_PWR_LED_MASK)
  73 #define SHPC_SLOT_ATTN_LED_MASK  0x30
  74 #define SHPC_SLOT_ATTN_LED_SHIFT \
  75     ctz32(SHPC_SLOT_ATTN_LED_MASK)
  76
  77 #define SHPC_LED_NO     0x0
  78 #define SHPC_LED_ON     0x1
  79 #define SHPC_LED_BLINK  0x2
  80 #define SHPC_LED_OFF    0x3
  81
  82 #define SHPC_SLOT_STATUS_PWR_FAULT      0x40
  83 #define SHPC_SLOT_STATUS_BUTTON         0x80
  84 #define SHPC_SLOT_STATUS_MRL_OPEN       0x100
  85 #define SHPC_SLOT_STATUS_66             0x200
  86 #define SHPC_SLOT_STATUS_PRSNT_MASK     0xC00
  87 #define SHPC_SLOT_STATUS_PRSNT_EMPTY    0x3
  88 #define SHPC_SLOT_STATUS_PRSNT_25W      0x1
  89 #define SHPC_SLOT_STATUS_PRSNT_15W      0x2
  90 #define SHPC_SLOT_STATUS_PRSNT_7_5W     0x0
  91
  92 #define SHPC_SLOT_STATUS_PRSNT_PCIX     0x3000
  93
  94
  95  /* 1 byte */
  96 #define SHPC_SLOT_EVENT_LATCH(s)        (0x2 + SHPC_SLOT_REG(s))
  97  /* 1 byte */
  98 #define SHPC_SLOT_EVENT_SERR_INT_DIS(d, s) (0x3 + SHPC_SLOT_REG(s))
  99 #define SHPC_SLOT_EVENT_PRESENCE        0x01
 100 #define SHPC_SLOT_EVENT_ISOLATED_FAULT  0x02
 101 #define SHPC_SLOT_EVENT_BUTTON          0x04
 102 #define SHPC_SLOT_EVENT_MRL             0x08
 103 #define SHPC_SLOT_EVENT_CONNECTED_FAULT 0x10
 104 /* Bits below are used for Serr/Int disable only */
 105 #define SHPC_SLOT_EVENT_MRL_SERR_DIS    0x20
 106 #define SHPC_SLOT_EVENT_CONNECTED_FAULT_SERR_DIS 0x40
 107
 108 #define SHPC_MIN_SLOTS        1
 109 #define SHPC_MAX_SLOTS        31
 110 #define SHPC_SIZEOF(d)    SHPC_SLOT_REG((d)->shpc->nslots)
 111
 112 /* SHPC Slot identifiers */
 113
 114 /* Hotplug supported at 31 slots out of the total 32.  We reserve slot 0,
 115    and give the rest of them physical *and* pci numbers starting from 1, so
 116    they match logical numbers.  Note: this means that multiple slots must have
 117    different chassis number values, to make chassis+physical slot unique.
 118    TODO: make this configurable? */
 119 #define SHPC_IDX_TO_LOGICAL(slot) ((slot) + 1)
 120 #define SHPC_LOGICAL_TO_IDX(target) ((target) - 1)
 121 #define SHPC_IDX_TO_PCI(slot) ((slot) + 1)
 122 #define SHPC_PCI_TO_IDX(pci_slot) ((pci_slot) - 1)
 123 #define SHPC_IDX_TO_PHYSICAL(slot) ((slot) + 1)
 124
 125 static uint16_t shpc_get_status(SHPCDevice *shpc, int slot, uint16_t msk)
 126 {
 127     uint8_t *status = shpc->config + SHPC_SLOT_STATUS(slot);
 128     return (pci_get_word(status) & msk) >> ctz32(msk);
 129 }
 130
 131 static void shpc_set_status(SHPCDevice *shpc,
 132                             int slot, uint8_t value, uint16_t msk)
 133 {
 134     uint8_t *status = shpc->config + SHPC_SLOT_STATUS(slot);
 135     pci_word_test_and_clear_mask(status, msk);
 136     pci_word_test_and_set_mask(status, value << ctz32(msk));
 137 }
 138
 139 static void shpc_interrupt_update(PCIDevice *d)
 140 {
 141     SHPCDevice *shpc = d->shpc;
 142     int slot;
 143     int level = 0;
 144     uint32_t serr_int;
 145     uint32_t int_locator = 0;
 146
 147     /* Update interrupt locator register */
 148     for (slot = 0; slot < shpc->nslots; ++slot) {
 149         uint8_t event = shpc->config[SHPC_SLOT_EVENT_LATCH(slot)];
 150         uint8_t disable = shpc->config[SHPC_SLOT_EVENT_SERR_INT_DIS(d, slot)];
 151         uint32_t mask = 1U << SHPC_IDX_TO_LOGICAL(slot);
 152         if (event & ~disable) {
 153             int_locator |= mask;
 154         }
 155     }
 156     serr_int = pci_get_long(shpc->config + SHPC_SERR_INT);
 157     if ((serr_int & SHPC_CMD_DETECTED) && !(serr_int & SHPC_CMD_INT_DIS)) {
 158         int_locator |= SHPC_INT_COMMAND;
 159     }
 160     pci_set_long(shpc->config + SHPC_INT_LOCATOR, int_locator);
 161     level = (!(serr_int & SHPC_INT_DIS) && int_locator) ? 1 : 0;
 162     if (msi_enabled(d) && shpc->msi_requested != level)
 163         msi_notify(d, 0);
 164     else
 165         pci_set_irq(d, level);
 166     shpc->msi_requested = level;
 167 }
 168
 169 static void shpc_set_sec_bus_speed(SHPCDevice *shpc, uint8_t speed)
 170 {
 171     switch (speed) {
 172     case SHPC_SEC_BUS_33:
 173         shpc->config[SHPC_SEC_BUS] &= ~SHPC_SEC_BUS_MASK;
 174         shpc->config[SHPC_SEC_BUS] |= speed;
 175         break;
 176     default:
 177         pci_word_test_and_set_mask(shpc->config + SHPC_CMD_STATUS,
 178                                    SHPC_CMD_STATUS_INVALID_MODE);
 179     }
 180 }
 181
 182 void shpc_reset(PCIDevice *d)
 183 {
 184     SHPCDevice *shpc = d->shpc;
 185     int nslots = shpc->nslots;
 186     int i;
 187     memset(shpc->config, 0, SHPC_SIZEOF(d));
 188     pci_set_byte(shpc->config + SHPC_NSLOTS, nslots);
 189     pci_set_long(shpc->config + SHPC_SLOTS_33, nslots);
 190     pci_set_long(shpc->config + SHPC_SLOTS_66, 0);
 191     pci_set_byte(shpc->config + SHPC_FIRST_DEV, SHPC_IDX_TO_PCI(0));
 192     pci_set_word(shpc->config + SHPC_PHYS_SLOT,
 193                  SHPC_IDX_TO_PHYSICAL(0) |
 194                  SHPC_PHYS_NUM_UP |
 195                  SHPC_PHYS_MRL |
 196                  SHPC_PHYS_BUTTON);
 197     pci_set_long(shpc->config + SHPC_SERR_INT, SHPC_INT_DIS |
 198                  SHPC_SERR_DIS |
 199                  SHPC_CMD_INT_DIS |
 200                  SHPC_ARB_SERR_DIS);
 201     pci_set_byte(shpc->config + SHPC_PROG_IFC, SHPC_PROG_IFC_1_0);
 202     pci_set_word(shpc->config + SHPC_SEC_BUS, SHPC_SEC_BUS_33);
 203     for (i = 0; i < shpc->nslots; ++i) {
 204         pci_set_byte(shpc->config + SHPC_SLOT_EVENT_SERR_INT_DIS(d, i),
 205                      SHPC_SLOT_EVENT_PRESENCE |
 206                      SHPC_SLOT_EVENT_ISOLATED_FAULT |
 207                      SHPC_SLOT_EVENT_BUTTON |
 208                      SHPC_SLOT_EVENT_MRL |
 209                      SHPC_SLOT_EVENT_CONNECTED_FAULT |
 210                      SHPC_SLOT_EVENT_MRL_SERR_DIS |
 211                      SHPC_SLOT_EVENT_CONNECTED_FAULT_SERR_DIS);
 212         if (shpc->sec_bus->devices[PCI_DEVFN(SHPC_IDX_TO_PCI(i), 0)]) {
 213             shpc_set_status(shpc, i, SHPC_STATE_ENABLED, SHPC_SLOT_STATE_MASK);
 214             shpc_set_status(shpc, i, 0, SHPC_SLOT_STATUS_MRL_OPEN);
 215             shpc_set_status(shpc, i, SHPC_SLOT_STATUS_PRSNT_7_5W,
 216                             SHPC_SLOT_STATUS_PRSNT_MASK);
 217             shpc_set_status(shpc, i, SHPC_LED_ON, SHPC_SLOT_PWR_LED_MASK);
 218         } else {
 219             shpc_set_status(shpc, i, SHPC_STATE_DISABLED, SHPC_SLOT_STATE_MASK);
 220             shpc_set_status(shpc, i, 1, SHPC_SLOT_STATUS_MRL_OPEN);
 221             shpc_set_status(shpc, i, SHPC_SLOT_STATUS_PRSNT_EMPTY,
 222                             SHPC_SLOT_STATUS_PRSNT_MASK);
 223             shpc_set_status(shpc, i, SHPC_LED_OFF, SHPC_SLOT_PWR_LED_MASK);
 224         }
 225         shpc_set_status(shpc, i, 0, SHPC_SLOT_STATUS_66);
 226     }
 227     shpc_set_sec_bus_speed(shpc, SHPC_SEC_BUS_33);
 228     shpc->msi_requested = 0;
 229     shpc_interrupt_update(d);
 230 }
 231
 232 static void shpc_invalid_command(SHPCDevice *shpc)
 233 {
 234     pci_word_test_and_set_mask(shpc->config + SHPC_CMD_STATUS,
 235                                SHPC_CMD_STATUS_INVALID_CMD);
 236 }
 237
 238 static void shpc_free_devices_in_slot(SHPCDevice *shpc, int slot)
 239 {
 240     HotplugHandler *hotplug_ctrl;
 241     int devfn;
 242     int pci_slot = SHPC_IDX_TO_PCI(slot);
 243     for (devfn = PCI_DEVFN(pci_slot, 0);
 244          devfn <= PCI_DEVFN(pci_slot, PCI_FUNC_MAX - 1);
 245          ++devfn) {
 246         PCIDevice *affected_dev = shpc->sec_bus->devices[devfn];
 247         if (affected_dev) {
 248             hotplug_ctrl = qdev_get_hotplug_handler(DEVICE(affected_dev));
 249             hotplug_handler_unplug(hotplug_ctrl, DEVICE(affected_dev),
 250                                    &error_abort);
 251             object_unparent(OBJECT(affected_dev));
 252         }
 253     }
 254 }
 255
 256 static void shpc_slot_command(SHPCDevice *shpc, uint8_t target,
 257                               uint8_t state, uint8_t power, uint8_t attn)
 258 {
 259     uint8_t current_state;
 260     int slot = SHPC_LOGICAL_TO_IDX(target);
 261     if (target < SHPC_CMD_TRGT_MIN || slot >= shpc->nslots) {
 262         shpc_invalid_command(shpc);
 263         return;
 264     }
 265     current_state = shpc_get_status(shpc, slot, SHPC_SLOT_STATE_MASK);
 266     if (current_state == SHPC_STATE_ENABLED && state == SHPC_STATE_PWRONLY) {
 267         shpc_invalid_command(shpc);
 268         return;
 269     }
 270
 271     switch (power) {
 272     case SHPC_LED_NO:
 273         break;
 274     default:
 275         /* TODO: send event to monitor */
 276         shpc_set_status(shpc, slot, power, SHPC_SLOT_PWR_LED_MASK);
 277     }
 278     switch (attn) {
 279     case SHPC_LED_NO:
 280         break;
 281     default:
 282         /* TODO: send event to monitor */
 283         shpc_set_status(shpc, slot, attn, SHPC_SLOT_ATTN_LED_MASK);
 284     }
 285
 286     if ((current_state == SHPC_STATE_DISABLED && state == SHPC_STATE_PWRONLY) ||
 287         (current_state == SHPC_STATE_DISABLED && state == SHPC_STATE_ENABLED)) {
 288         shpc_set_status(shpc, slot, state, SHPC_SLOT_STATE_MASK);
 289     } else if ((current_state == SHPC_STATE_ENABLED ||
 290                 current_state == SHPC_STATE_PWRONLY) &&
 291                state == SHPC_STATE_DISABLED) {
 292         shpc_set_status(shpc, slot, state, SHPC_SLOT_STATE_MASK);
 293         power = shpc_get_status(shpc, slot, SHPC_SLOT_PWR_LED_MASK);
 294         /* TODO: track what monitor requested. */
 295         /* Look at LED to figure out whether it's ok to remove the device. */
 296         if (power == SHPC_LED_OFF) {
 297             shpc_free_devices_in_slot(shpc, slot);
 298             shpc_set_status(shpc, slot, 1, SHPC_SLOT_STATUS_MRL_OPEN);
 299             shpc_set_status(shpc, slot, SHPC_SLOT_STATUS_PRSNT_EMPTY,
 300                             SHPC_SLOT_STATUS_PRSNT_MASK);
 301             shpc->config[SHPC_SLOT_EVENT_LATCH(slot)] |=
 302                 SHPC_SLOT_EVENT_BUTTON |
 303                 SHPC_SLOT_EVENT_MRL |
 304                 SHPC_SLOT_EVENT_PRESENCE;
 305         }
 306     }
 307 }
 308
 309 static void shpc_command(SHPCDevice *shpc)
 310 {
 311     uint8_t code = pci_get_byte(shpc->config + SHPC_CMD_CODE);
 312     uint8_t speed;
 313     uint8_t target;
 314     uint8_t attn;
 315     uint8_t power;
 316     uint8_t state;
 317     int i;
 318
 319     /* Clear status from the previous command. */
 320     pci_word_test_and_clear_mask(shpc->config + SHPC_CMD_STATUS,
 321                                  SHPC_CMD_STATUS_BUSY |
 322                                  SHPC_CMD_STATUS_MRL_OPEN |
 323                                  SHPC_CMD_STATUS_INVALID_CMD |
 324                                  SHPC_CMD_STATUS_INVALID_MODE);
 325     switch (code) {
 326     case 0x00 ... 0x3f:
 327         target = shpc->config[SHPC_CMD_TRGT] & SHPC_CMD_TRGT_MAX;
 328         state = (code & SHPC_SLOT_STATE_MASK) >> SHPC_SLOT_STATE_SHIFT;
 329         power = (code & SHPC_SLOT_PWR_LED_MASK) >> SHPC_SLOT_PWR_LED_SHIFT;
 330         attn = (code & SHPC_SLOT_ATTN_LED_MASK) >> SHPC_SLOT_ATTN_LED_SHIFT;
 331         shpc_slot_command(shpc, target, state, power, attn);
 332         break;
 333     case 0x40 ... 0x47:
 334         speed = code & SHPC_SEC_BUS_MASK;
 335         shpc_set_sec_bus_speed(shpc, speed);
 336         break;
 337     case 0x48:
 338         /* Power only all slots */
 339         /* first verify no slots are enabled */
 340         for (i = 0; i < shpc->nslots; ++i) {
 341             state = shpc_get_status(shpc, i, SHPC_SLOT_STATE_MASK);
 342             if (state == SHPC_STATE_ENABLED) {
 343                 shpc_invalid_command(shpc);
 344                 goto done;
 345             }
 346         }
 347         for (i = 0; i < shpc->nslots; ++i) {
 348             if (!(shpc_get_status(shpc, i, SHPC_SLOT_STATUS_MRL_OPEN))) {
 349                 shpc_slot_command(shpc, i + SHPC_CMD_TRGT_MIN,
 350                                   SHPC_STATE_PWRONLY, SHPC_LED_ON, SHPC_LED_NO);
 351             } else {
 352                 shpc_slot_command(shpc, i + SHPC_CMD_TRGT_MIN,
 353                                   SHPC_STATE_NO, SHPC_LED_OFF, SHPC_LED_NO);
 354             }
 355         }
 356         break;
 357     case 0x49:
 358         /* Enable all slots */
 359         /* TODO: Spec says this shall fail if some are already enabled.
 360          * This doesn't make sense - why not? a spec bug? */
 361         for (i = 0; i < shpc->nslots; ++i) {
 362             state = shpc_get_status(shpc, i, SHPC_SLOT_STATE_MASK);
 363             if (state == SHPC_STATE_ENABLED) {
 364                 shpc_invalid_command(shpc);
 365                 goto done;
 366             }
 367         }
 368         for (i = 0; i < shpc->nslots; ++i) {
 369             if (!(shpc_get_status(shpc, i, SHPC_SLOT_STATUS_MRL_OPEN))) {
 370                 shpc_slot_command(shpc, i + SHPC_CMD_TRGT_MIN,
 371                                   SHPC_STATE_ENABLED, SHPC_LED_ON, SHPC_LED_NO);
 372             } else {
 373                 shpc_slot_command(shpc, i + SHPC_CMD_TRGT_MIN,
 374                                   SHPC_STATE_NO, SHPC_LED_OFF, SHPC_LED_NO);
 375             }
 376         }
 377         break;
 378     default:
 379         shpc_invalid_command(shpc);
 380         break;
 381     }
 382 done:
 383     pci_long_test_and_set_mask(shpc->config + SHPC_SERR_INT, SHPC_CMD_DETECTED);
 384 }
 385
 386 static void shpc_write(PCIDevice *d, unsigned addr, uint64_t val, int l)
 387 {
 388     SHPCDevice *shpc = d->shpc;
 389     int i;
 390     if (addr >= SHPC_SIZEOF(d)) {
 391         return;
 392     }
 393     l = MIN(l, SHPC_SIZEOF(d) - addr);
 394
 395     /* TODO: code duplicated from pci.c */
 396     for (i = 0; i < l; val >>= 8, ++i) {
 397         unsigned a = addr + i;
 398         uint8_t wmask = shpc->wmask[a];
 399         uint8_t w1cmask = shpc->w1cmask[a];
 400         assert(!(wmask & w1cmask));
 401         shpc->config[a] = (shpc->config[a] & ~wmask) | (val & wmask);
 402         shpc->config[a] &= ~(val & w1cmask); /* W1C: Write 1 to Clear */
 403     }
 404     if (ranges_overlap(addr, l, SHPC_CMD_CODE, 2)) {
 405         shpc_command(shpc);
 406     }
 407     shpc_interrupt_update(d);
 408 }
 409
 410 static uint64_t shpc_read(PCIDevice *d, unsigned addr, int l)
 411 {
 412     uint64_t val = 0x0;
 413     if (addr >= SHPC_SIZEOF(d)) {
 414         return val;
 415     }
 416     l = MIN(l, SHPC_SIZEOF(d) - addr);
 417     memcpy(&val, d->shpc->config + addr, l);
 418     return val;
 419 }
 420
 421 /* SHPC Bridge Capability */
 422 #define SHPC_CAP_LENGTH 0x08
 423 #define SHPC_CAP_DWORD_SELECT 0x2 /* 1 byte */
 424 #define SHPC_CAP_CxP 0x3 /* 1 byte: CSP, CIP */
 425 #define SHPC_CAP_DWORD_DATA 0x4 /* 4 bytes */
 426 #define SHPC_CAP_CSP_MASK 0x4
 427 #define SHPC_CAP_CIP_MASK 0x8
 428
 429 static uint8_t shpc_cap_dword(PCIDevice *d)
 430 {
 431     return pci_get_byte(d->config + d->shpc->cap + SHPC_CAP_DWORD_SELECT);
 432 }
 433
 434 /* Update dword data capability register */
 435 static void shpc_cap_update_dword(PCIDevice *d)
 436 {
 437     unsigned data;
 438     data = shpc_read(d, shpc_cap_dword(d) * 4, 4);
 439     pci_set_long(d->config  + d->shpc->cap + SHPC_CAP_DWORD_DATA, data);
 440 }
 441
 442 /* Add SHPC capability to the config space for the device. */
 443 static int shpc_cap_add_config(PCIDevice *d, Error **errp)
 444 {
 445     uint8_t *config;
 446     int config_offset;
 447     config_offset = pci_add_capability(d, PCI_CAP_ID_SHPC,
 448                                        0, SHPC_CAP_LENGTH,
 449                                        errp);
 450     if (config_offset < 0) {
 451         return config_offset;
 452     }
 453     config = d->config + config_offset;
 454
 455     pci_set_byte(config + SHPC_CAP_DWORD_SELECT, 0);
 456     pci_set_byte(config + SHPC_CAP_CxP, 0);
 457     pci_set_long(config + SHPC_CAP_DWORD_DATA, 0);
 458     d->shpc->cap = config_offset;
 459     /* Make dword select and data writeable. */
 460     pci_set_byte(d->wmask + config_offset + SHPC_CAP_DWORD_SELECT, 0xff);
 461     pci_set_long(d->wmask + config_offset + SHPC_CAP_DWORD_DATA, 0xffffffff);
 462     return 0;
 463 }
 464
 465 static uint64_t shpc_mmio_read(void *opaque, hwaddr addr,
 466                                unsigned size)
 467 {
 468     return shpc_read(opaque, addr, size);
 469 }
 470
 471 static void shpc_mmio_write(void *opaque, hwaddr addr,
 472                             uint64_t val, unsigned size)
 473 {
 474     shpc_write(opaque, addr, val, size);
 475 }
 476
 477 static const MemoryRegionOps shpc_mmio_ops = {
 478     .read = shpc_mmio_read,
 479     .write = shpc_mmio_write,
 480     .endianness = DEVICE_LITTLE_ENDIAN,
 481     .valid = {
 482         /* SHPC ECN requires dword accesses, but the original 1.0 spec doesn't.
 483          * It's easier to suppport all sizes than worry about it. */
 484         .min_access_size = 1,
 485         .max_access_size = 4,
 486     },
 487 };
 488 static void shpc_device_plug_common(PCIDevice *affected_dev, int *slot,
 489                                     SHPCDevice *shpc, Error **errp)
 490 {
 491     int pci_slot = PCI_SLOT(affected_dev->devfn);
 492     *slot = SHPC_PCI_TO_IDX(pci_slot);
 493
 494     if (pci_slot < SHPC_IDX_TO_PCI(0) || *slot >= shpc->nslots) {
 495         error_setg(errp, "Unsupported PCI slot %d for standard hotplug "
 496                    "controller. Valid slots are between %d and %d.",
 497                    pci_slot, SHPC_IDX_TO_PCI(0),
 498                    SHPC_IDX_TO_PCI(shpc->nslots) - 1);
 499         return;
 500     }
 501 }
 502
 503 void shpc_device_plug_cb(HotplugHandler *hotplug_dev, DeviceState *dev,
 504                             Error **errp)
 505 {
 506     Error *local_err = NULL;
 507     PCIDevice *pci_hotplug_dev = PCI_DEVICE(hotplug_dev);
 508     SHPCDevice *shpc = pci_hotplug_dev->shpc;
 509     int slot;
 510
 511     shpc_device_plug_common(PCI_DEVICE(dev), &slot, shpc, &local_err);
 512     if (local_err) {
 513         error_propagate(errp, local_err);
 514         return;
 515     }
 516
 517     /* Don't send event when device is enabled during qemu machine creation:
 518      * it is present on boot, no hotplug event is necessary. We do send an
 519      * event when the device is disabled later. */
 520     if (!dev->hotplugged) {
 521         shpc_set_status(shpc, slot, 0, SHPC_SLOT_STATUS_MRL_OPEN);
 522         shpc_set_status(shpc, slot, SHPC_SLOT_STATUS_PRSNT_7_5W,
 523                         SHPC_SLOT_STATUS_PRSNT_MASK);
 524         return;
 525     }
 526
 527     /* This could be a cancellation of the previous removal.
 528      * We check MRL state to figure out. */
 529     if (shpc_get_status(shpc, slot, SHPC_SLOT_STATUS_MRL_OPEN)) {
 530         shpc_set_status(shpc, slot, 0, SHPC_SLOT_STATUS_MRL_OPEN);
 531         shpc_set_status(shpc, slot, SHPC_SLOT_STATUS_PRSNT_7_5W,
 532                         SHPC_SLOT_STATUS_PRSNT_MASK);
 533         shpc->config[SHPC_SLOT_EVENT_LATCH(slot)] |=
 534             SHPC_SLOT_EVENT_BUTTON |
 535             SHPC_SLOT_EVENT_MRL |
 536             SHPC_SLOT_EVENT_PRESENCE;
 537     } else {
 538         /* Press attention button to cancel removal */
 539         shpc->config[SHPC_SLOT_EVENT_LATCH(slot)] |=
 540             SHPC_SLOT_EVENT_BUTTON;
 541     }
 542     shpc_set_status(shpc, slot, 0, SHPC_SLOT_STATUS_66);
 543     shpc_interrupt_update(pci_hotplug_dev);
 544 }
 545
 546 void shpc_device_unplug_cb(HotplugHandler *hotplug_dev, DeviceState *dev,
 547                            Error **errp)
 548 {
 549     object_property_set_bool(OBJECT(dev), false, "realized", NULL);
 550 }
 551
 552 void shpc_device_unplug_request_cb(HotplugHandler *hotplug_dev,
 553                                    DeviceState *dev, Error **errp)
 554 {
 555     Error *local_err = NULL;
 556     PCIDevice *pci_hotplug_dev = PCI_DEVICE(hotplug_dev);
 557     SHPCDevice *shpc = pci_hotplug_dev->shpc;
 558     uint8_t state;
 559     uint8_t led;
 560     int slot;
 561
 562     shpc_device_plug_common(PCI_DEVICE(dev), &slot, shpc, &local_err);
 563     if (local_err) {
 564         error_propagate(errp, local_err);
 565         return;
 566     }
 567
 568     shpc->config[SHPC_SLOT_EVENT_LATCH(slot)] |= SHPC_SLOT_EVENT_BUTTON;
 569     state = shpc_get_status(shpc, slot, SHPC_SLOT_STATE_MASK);
 570     led = shpc_get_status(shpc, slot, SHPC_SLOT_PWR_LED_MASK);
 571     if (state == SHPC_STATE_DISABLED && led == SHPC_LED_OFF) {
 572         shpc_free_devices_in_slot(shpc, slot);
 573         shpc_set_status(shpc, slot, 1, SHPC_SLOT_STATUS_MRL_OPEN);
 574         shpc_set_status(shpc, slot, SHPC_SLOT_STATUS_PRSNT_EMPTY,
 575                         SHPC_SLOT_STATUS_PRSNT_MASK);
 576         shpc->config[SHPC_SLOT_EVENT_LATCH(slot)] |=
 577             SHPC_SLOT_EVENT_MRL |
 578             SHPC_SLOT_EVENT_PRESENCE;
 579     }
 580     shpc_set_status(shpc, slot, 0, SHPC_SLOT_STATUS_66);
 581     shpc_interrupt_update(pci_hotplug_dev);
 582 }
 583
 584 /* Initialize the SHPC structure in bridge's BAR. */
 585 int shpc_init(PCIDevice *d, PCIBus *sec_bus, MemoryRegion *bar,
 586               unsigned offset, Error **errp)
 587 {
 588     int i, ret;
 589     int nslots = SHPC_MAX_SLOTS; /* TODO: qdev property? */
 590     SHPCDevice *shpc = d->shpc = g_malloc0(sizeof(*d->shpc));
 591     shpc->sec_bus = sec_bus;
 592     ret = shpc_cap_add_config(d, errp);
 593     if (ret) {
 594         g_free(d->shpc);
 595         return ret;
 596     }
 597     if (nslots < SHPC_MIN_SLOTS) {
 598         return 0;
 599     }
 600     if (nslots > SHPC_MAX_SLOTS ||
 601         SHPC_IDX_TO_PCI(nslots) > PCI_SLOT_MAX) {
 602         /* TODO: report an error mesage that makes sense. */
 603         return -EINVAL;
 604     }
 605     shpc->nslots = nslots;
 606     shpc->config = g_malloc0(SHPC_SIZEOF(d));
 607     shpc->cmask = g_malloc0(SHPC_SIZEOF(d));
 608     shpc->wmask = g_malloc0(SHPC_SIZEOF(d));
 609     shpc->w1cmask = g_malloc0(SHPC_SIZEOF(d));
 610
 611     shpc_reset(d);
 612
 613     pci_set_long(shpc->config + SHPC_BASE_OFFSET, offset);
 614
 615     pci_set_byte(shpc->wmask + SHPC_CMD_CODE, 0xff);
 616     pci_set_byte(shpc->wmask + SHPC_CMD_TRGT, SHPC_CMD_TRGT_MAX);
 617     pci_set_byte(shpc->wmask + SHPC_CMD_TRGT, SHPC_CMD_TRGT_MAX);
 618     pci_set_long(shpc->wmask + SHPC_SERR_INT,
 619                  SHPC_INT_DIS |
 620                  SHPC_SERR_DIS |
 621                  SHPC_CMD_INT_DIS |
 622                  SHPC_ARB_SERR_DIS);
 623     pci_set_long(shpc->w1cmask + SHPC_SERR_INT,
 624                  SHPC_CMD_DETECTED |
 625                  SHPC_ARB_DETECTED);
 626     for (i = 0; i < nslots; ++i) {
 627         pci_set_byte(shpc->wmask +
 628                      SHPC_SLOT_EVENT_SERR_INT_DIS(d, i),
 629                      SHPC_SLOT_EVENT_PRESENCE |
 630                      SHPC_SLOT_EVENT_ISOLATED_FAULT |
 631                      SHPC_SLOT_EVENT_BUTTON |
 632                      SHPC_SLOT_EVENT_MRL |
 633                      SHPC_SLOT_EVENT_CONNECTED_FAULT |
 634                      SHPC_SLOT_EVENT_MRL_SERR_DIS |
 635                      SHPC_SLOT_EVENT_CONNECTED_FAULT_SERR_DIS);
 636         pci_set_byte(shpc->w1cmask +
 637                      SHPC_SLOT_EVENT_LATCH(i),
 638                      SHPC_SLOT_EVENT_PRESENCE |
 639                      SHPC_SLOT_EVENT_ISOLATED_FAULT |
 640                      SHPC_SLOT_EVENT_BUTTON |
 641                      SHPC_SLOT_EVENT_MRL |
 642                      SHPC_SLOT_EVENT_CONNECTED_FAULT);
 643     }
 644
 645     /* TODO: init cmask */
 646     memory_region_init_io(&shpc->mmio, OBJECT(d), &shpc_mmio_ops,
 647                           d, "shpc-mmio", SHPC_SIZEOF(d));
 648     shpc_cap_update_dword(d);
 649     memory_region_add_subregion(bar, offset, &shpc->mmio);
 650
 651     qbus_set_hotplug_handler(BUS(sec_bus), OBJECT(d), NULL);
 652
 653     d->cap_present |= QEMU_PCI_CAP_SHPC;
 654     return 0;
 655 }
 656
 657 int shpc_bar_size(PCIDevice *d)
 658 {
 659     return pow2roundup32(SHPC_SLOT_REG(SHPC_MAX_SLOTS));
 660 }
 661
 662 void shpc_cleanup(PCIDevice *d, MemoryRegion *bar)
 663 {
 664     SHPCDevice *shpc = d->shpc;
 665     d->cap_present &= ~QEMU_PCI_CAP_SHPC;
 666     memory_region_del_subregion(bar, &shpc->mmio);
 667     /* TODO: cleanup config space changes? */
 668 }
 669
 670 void shpc_free(PCIDevice *d)
 671 {
 672     SHPCDevice *shpc = d->shpc;
 673     if (!shpc) {
 674         return;
 675     }
 676     object_unparent(OBJECT(&shpc->mmio));
 677     g_free(shpc->config);
 678     g_free(shpc->cmask);
 679     g_free(shpc->wmask);
 680     g_free(shpc->w1cmask);
 681     g_free(shpc);
 682     d->shpc = NULL;
 683 }
 684
 685 void shpc_cap_write_config(PCIDevice *d, uint32_t addr, uint32_t val, int l)
 686 {
 687     if (!ranges_overlap(addr, l, d->shpc->cap, SHPC_CAP_LENGTH)) {
 688         return;
 689     }
 690     if (ranges_overlap(addr, l, d->shpc->cap + SHPC_CAP_DWORD_DATA, 4)) {
 691         unsigned dword_data;
 692         dword_data = pci_get_long(d->shpc->config + d->shpc->cap
 693                                   + SHPC_CAP_DWORD_DATA);
 694         shpc_write(d, shpc_cap_dword(d) * 4, dword_data, 4);
 695     }
 696     /* Update cap dword data in case guest is going to read it. */
 697     shpc_cap_update_dword(d);
 698 }
 699
 700 static int shpc_save(QEMUFile *f, void *pv, size_t size,
 701                      const VMStateField *field, QJSON *vmdesc)
 702 {
 703     PCIDevice *d = container_of(pv, PCIDevice, shpc);
 704     qemu_put_buffer(f, d->shpc->config, SHPC_SIZEOF(d));
 705
 706     return 0;
 707 }
 708
 709 static int shpc_load(QEMUFile *f, void *pv, size_t size,
 710                      const VMStateField *field)
 711 {
 712     PCIDevice *d = container_of(pv, PCIDevice, shpc);
 713     int ret = qemu_get_buffer(f, d->shpc->config, SHPC_SIZEOF(d));
 714     if (ret != SHPC_SIZEOF(d)) {
 715         return -EINVAL;
 716     }
 717     /* Make sure we don't lose notifications. An extra interrupt is harmless. */
 718     d->shpc->msi_requested = 0;
 719     shpc_interrupt_update(d);
 720     return 0;
 721 }
 722
 723 VMStateInfo shpc_vmstate_info = {
 724     .name = "shpc",
 725     .get  = shpc_load,
 726     .put  = shpc_save,
 727 };