hw/ppc/spapr_drc.c

   1 /*
   2  * QEMU SPAPR Dynamic Reconfiguration Connector Implementation
   3  *
   4  * Copyright IBM Corp. 2014
   5  *
   6  * Authors:
   7  *  Michael Roth      <[email protected]>
   8  *
   9  * This work is licensed under the terms of the GNU GPL, version 2 or later.
  10  * See the COPYING file in the top-level directory.
  11  */
  12
  13 #include "hw/ppc/spapr_drc.h"
  14 #include "qom/object.h"
  15 #include "hw/qdev.h"
  16 #include "qapi/visitor.h"
  17 #include "qemu/error-report.h"
  18 #include "hw/ppc/spapr.h" /* for RTAS return codes */
  19
  20 /* #define DEBUG_SPAPR_DRC */
  21
  22 #ifdef DEBUG_SPAPR_DRC
  23 #define DPRINTF(fmt, ...) \
  24     do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
  25 #define DPRINTFN(fmt, ...) \
  26     do { DPRINTF(fmt, ## __VA_ARGS__); fprintf(stderr, "\n"); } while (0)
  27 #else
  28 #define DPRINTF(fmt, ...) \
  29     do { } while (0)
  30 #define DPRINTFN(fmt, ...) \
  31     do { } while (0)
  32 #endif
  33
  34 #define DRC_CONTAINER_PATH "/dr-connector"
  35 #define DRC_INDEX_TYPE_SHIFT 28
  36 #define DRC_INDEX_ID_MASK ((1ULL << DRC_INDEX_TYPE_SHIFT) - 1)
  37
  38 static sPAPRDRConnectorTypeShift get_type_shift(sPAPRDRConnectorType type)
  39 {
  40     uint32_t shift = 0;
  41
  42     /* make sure this isn't SPAPR_DR_CONNECTOR_TYPE_ANY, or some
  43      * other wonky value.
  44      */
  45     g_assert(is_power_of_2(type));
  46
  47     while (type != (1 << shift)) {
  48         shift++;
  49     }
  50     return shift;
  51 }
  52
  53 static uint32_t get_index(sPAPRDRConnector *drc)
  54 {
  55     /* no set format for a drc index: it only needs to be globally
  56      * unique. this is how we encode the DRC type on bare-metal
  57      * however, so might as well do that here
  58      */
  59     return (get_type_shift(drc->type) << DRC_INDEX_TYPE_SHIFT) |
  60             (drc->id & DRC_INDEX_ID_MASK);
  61 }
  62
  63 static uint32_t set_isolation_state(sPAPRDRConnector *drc,
  64                                     sPAPRDRIsolationState state)
  65 {
  66     sPAPRDRConnectorClass *drck = SPAPR_DR_CONNECTOR_GET_CLASS(drc);
  67
  68     DPRINTFN("drc: %x, set_isolation_state: %x", get_index(drc), state);
  69
  70     if (state == SPAPR_DR_ISOLATION_STATE_UNISOLATED) {
  71         /* cannot unisolate a non-existant resource, and, or resources
  72          * which are in an 'UNUSABLE' allocation state. (PAPR 2.7, 13.5.3.5)
  73          */
  74         if (!drc->dev ||
  75             drc->allocation_state == SPAPR_DR_ALLOCATION_STATE_UNUSABLE) {
  76             return RTAS_OUT_NO_SUCH_INDICATOR;
  77         }
  78     }
  79
  80     drc->isolation_state = state;
  81
  82     if (drc->isolation_state == SPAPR_DR_ISOLATION_STATE_ISOLATED) {
  83         /* if we're awaiting release, but still in an unconfigured state,
  84          * it's likely the guest is still in the process of configuring
  85          * the device and is transitioning the devices to an ISOLATED
  86          * state as a part of that process. so we only complete the
  87          * removal when this transition happens for a device in a
  88          * configured state, as suggested by the state diagram from
  89          * PAPR+ 2.7, 13.4
  90          */
  91         if (drc->awaiting_release) {
  92             if (drc->configured) {
  93                 DPRINTFN("finalizing device removal");
  94                 drck->detach(drc, DEVICE(drc->dev), drc->detach_cb,
  95                              drc->detach_cb_opaque, NULL);
  96             } else {
  97                 DPRINTFN("deferring device removal on unconfigured device\n");
  98             }
  99         }
 100         drc->configured = false;
 101     }
 102
 103     return RTAS_OUT_SUCCESS;
 104 }
 105
 106 static uint32_t set_indicator_state(sPAPRDRConnector *drc,
 107                                     sPAPRDRIndicatorState state)
 108 {
 109     DPRINTFN("drc: %x, set_indicator_state: %x", get_index(drc), state);
 110     drc->indicator_state = state;
 111     return RTAS_OUT_SUCCESS;
 112 }
 113
 114 static uint32_t set_allocation_state(sPAPRDRConnector *drc,
 115                                      sPAPRDRAllocationState state)
 116 {
 117     sPAPRDRConnectorClass *drck = SPAPR_DR_CONNECTOR_GET_CLASS(drc);
 118
 119     DPRINTFN("drc: %x, set_allocation_state: %x", get_index(drc), state);
 120
 121     if (state == SPAPR_DR_ALLOCATION_STATE_USABLE) {
 122         /* if there's no resource/device associated with the DRC, there's
 123          * no way for us to put it in an allocation state consistent with
 124          * being 'USABLE'. PAPR 2.7, 13.5.3.4 documents that this should
 125          * result in an RTAS return code of -3 / "no such indicator"
 126          */
 127         if (!drc->dev) {
 128             return RTAS_OUT_NO_SUCH_INDICATOR;
 129         }
 130     }
 131
 132     if (drc->type != SPAPR_DR_CONNECTOR_TYPE_PCI) {
 133         drc->allocation_state = state;
 134         if (drc->awaiting_release &&
 135             drc->allocation_state == SPAPR_DR_ALLOCATION_STATE_UNUSABLE) {
 136             DPRINTFN("finalizing device removal");
 137             drck->detach(drc, DEVICE(drc->dev), drc->detach_cb,
 138                          drc->detach_cb_opaque, NULL);
 139         }
 140     }
 141     return RTAS_OUT_SUCCESS;
 142 }
 143
 144 static uint32_t get_type(sPAPRDRConnector *drc)
 145 {
 146     return drc->type;
 147 }
 148
 149 static const char *get_name(sPAPRDRConnector *drc)
 150 {
 151     return drc->name;
 152 }
 153
 154 static const void *get_fdt(sPAPRDRConnector *drc, int *fdt_start_offset)
 155 {
 156     if (fdt_start_offset) {
 157         *fdt_start_offset = drc->fdt_start_offset;
 158     }
 159     return drc->fdt;
 160 }
 161
 162 static void set_configured(sPAPRDRConnector *drc)
 163 {
 164     DPRINTFN("drc: %x, set_configured", get_index(drc));
 165
 166     if (drc->isolation_state != SPAPR_DR_ISOLATION_STATE_UNISOLATED) {
 167         /* guest should be not configuring an isolated device */
 168         DPRINTFN("drc: %x, set_configured: skipping isolated device",
 169                  get_index(drc));
 170         return;
 171     }
 172     drc->configured = true;
 173 }
 174
 175 /*
 176  * dr-entity-sense sensor value
 177  * returned via get-sensor-state RTAS calls
 178  * as expected by state diagram in PAPR+ 2.7, 13.4
 179  * based on the current allocation/indicator/power states
 180  * for the DR connector.
 181  */
 182 static uint32_t entity_sense(sPAPRDRConnector *drc, sPAPRDREntitySense *state)
 183 {
 184     if (drc->dev) {
 185         if (drc->type != SPAPR_DR_CONNECTOR_TYPE_PCI &&
 186             drc->allocation_state == SPAPR_DR_ALLOCATION_STATE_UNUSABLE) {
 187             /* for logical DR, we return a state of UNUSABLE
 188              * iff the allocation state UNUSABLE.
 189              * Otherwise, report the state as USABLE/PRESENT,
 190              * as we would for PCI.
 191              */
 192             *state = SPAPR_DR_ENTITY_SENSE_UNUSABLE;
 193         } else {
 194             /* this assumes all PCI devices are assigned to
 195              * a 'live insertion' power domain, where QEMU
 196              * manages power state automatically as opposed
 197              * to the guest. present, non-PCI resources are
 198              * unaffected by power state.
 199              */
 200             *state = SPAPR_DR_ENTITY_SENSE_PRESENT;
 201         }
 202     } else {
 203         if (drc->type == SPAPR_DR_CONNECTOR_TYPE_PCI) {
 204             /* PCI devices, and only PCI devices, use EMPTY
 205              * in cases where we'd otherwise use UNUSABLE
 206              */
 207             *state = SPAPR_DR_ENTITY_SENSE_EMPTY;
 208         } else {
 209             *state = SPAPR_DR_ENTITY_SENSE_UNUSABLE;
 210         }
 211     }
 212
 213     DPRINTFN("drc: %x, entity_sense: %x", get_index(drc), state);
 214     return RTAS_OUT_SUCCESS;
 215 }
 216
 217 static void prop_get_index(Object *obj, Visitor *v, void *opaque,
 218                                   const char *name, Error **errp)
 219 {
 220     sPAPRDRConnector *drc = SPAPR_DR_CONNECTOR(obj);
 221     sPAPRDRConnectorClass *drck = SPAPR_DR_CONNECTOR_GET_CLASS(drc);
 222     uint32_t value = (uint32_t)drck->get_index(drc);
 223     visit_type_uint32(v, &value, name, errp);
 224 }
 225
 226 static void prop_get_type(Object *obj, Visitor *v, void *opaque,
 227                           const char *name, Error **errp)
 228 {
 229     sPAPRDRConnector *drc = SPAPR_DR_CONNECTOR(obj);
 230     sPAPRDRConnectorClass *drck = SPAPR_DR_CONNECTOR_GET_CLASS(drc);
 231     uint32_t value = (uint32_t)drck->get_type(drc);
 232     visit_type_uint32(v, &value, name, errp);
 233 }
 234
 235 static char *prop_get_name(Object *obj, Error **errp)
 236 {
 237     sPAPRDRConnector *drc = SPAPR_DR_CONNECTOR(obj);
 238     sPAPRDRConnectorClass *drck = SPAPR_DR_CONNECTOR_GET_CLASS(drc);
 239     return g_strdup(drck->get_name(drc));
 240 }
 241
 242 static void prop_get_entity_sense(Object *obj, Visitor *v, void *opaque,
 243                                   const char *name, Error **errp)
 244 {
 245     sPAPRDRConnector *drc = SPAPR_DR_CONNECTOR(obj);
 246     sPAPRDRConnectorClass *drck = SPAPR_DR_CONNECTOR_GET_CLASS(drc);
 247     uint32_t value;
 248
 249     drck->entity_sense(drc, &value);
 250     visit_type_uint32(v, &value, name, errp);
 251 }
 252
 253 static void prop_get_fdt(Object *obj, Visitor *v, void *opaque,
 254                         const char *name, Error **errp)
 255 {
 256     sPAPRDRConnector *drc = SPAPR_DR_CONNECTOR(obj);
 257     Error *err = NULL;
 258     int fdt_offset_next, fdt_offset, fdt_depth;
 259     void *fdt;
 260
 261     if (!drc->fdt) {
 262         return;
 263     }
 264
 265     fdt = drc->fdt;
 266     fdt_offset = drc->fdt_start_offset;
 267     fdt_depth = 0;
 268
 269     do {
 270         const char *name = NULL;
 271         const struct fdt_property *prop = NULL;
 272         int prop_len = 0, name_len = 0;
 273         uint32_t tag;
 274
 275         tag = fdt_next_tag(fdt, fdt_offset, &fdt_offset_next);
 276         switch (tag) {
 277         case FDT_BEGIN_NODE:
 278             fdt_depth++;
 279             name = fdt_get_name(fdt, fdt_offset, &name_len);
 280             visit_start_struct(v, NULL, NULL, name, 0, &err);
 281             if (err) {
 282                 error_propagate(errp, err);
 283                 return;
 284             }
 285             break;
 286         case FDT_END_NODE:
 287             /* shouldn't ever see an FDT_END_NODE before FDT_BEGIN_NODE */
 288             g_assert(fdt_depth > 0);
 289             visit_end_struct(v, &err);
 290             if (err) {
 291                 error_propagate(errp, err);
 292                 return;
 293             }
 294             fdt_depth--;
 295             break;
 296         case FDT_PROP: {
 297             int i;
 298             prop = fdt_get_property_by_offset(fdt, fdt_offset, &prop_len);
 299             name = fdt_string(fdt, fdt32_to_cpu(prop->nameoff));
 300             visit_start_list(v, name, &err);
 301             if (err) {
 302                 error_propagate(errp, err);
 303                 return;
 304             }
 305             for (i = 0; i < prop_len; i++) {
 306                 visit_type_uint8(v, (uint8_t *)&prop->data[i], NULL, &err);
 307                 if (err) {
 308                     error_propagate(errp, err);
 309                     return;
 310                 }
 311             }
 312             visit_end_list(v, &err);
 313             if (err) {
 314                 error_propagate(errp, err);
 315                 return;
 316             }
 317             break;
 318         }
 319         default:
 320             error_setg(&error_abort, "device FDT in unexpected state: %d", tag);
 321         }
 322         fdt_offset = fdt_offset_next;
 323     } while (fdt_depth != 0);
 324 }
 325
 326 static void attach(sPAPRDRConnector *drc, DeviceState *d, void *fdt,
 327                    int fdt_start_offset, bool coldplug, Error **errp)
 328 {
 329     DPRINTFN("drc: %x, attach", get_index(drc));
 330
 331     if (drc->isolation_state != SPAPR_DR_ISOLATION_STATE_ISOLATED) {
 332         error_setg(errp, "an attached device is still awaiting release");
 333         return;
 334     }
 335     if (drc->type == SPAPR_DR_CONNECTOR_TYPE_PCI) {
 336         g_assert(drc->allocation_state == SPAPR_DR_ALLOCATION_STATE_USABLE);
 337     }
 338     g_assert(fdt || coldplug);
 339
 340     /* NOTE: setting initial isolation state to UNISOLATED means we can't
 341      * detach unless guest has a userspace/kernel that moves this state
 342      * back to ISOLATED in response to an unplug event, or this is done
 343      * manually by the admin prior. if we force things while the guest
 344      * may be accessing the device, we can easily crash the guest, so we
 345      * we defer completion of removal in such cases to the reset() hook.
 346      */
 347     if (drc->type == SPAPR_DR_CONNECTOR_TYPE_PCI) {
 348         drc->isolation_state = SPAPR_DR_ISOLATION_STATE_UNISOLATED;
 349     }
 350     drc->indicator_state = SPAPR_DR_INDICATOR_STATE_ACTIVE;
 351
 352     drc->dev = d;
 353     drc->fdt = fdt;
 354     drc->fdt_start_offset = fdt_start_offset;
 355     drc->configured = coldplug;
 356
 357     object_property_add_link(OBJECT(drc), "device",
 358                              object_get_typename(OBJECT(drc->dev)),
 359                              (Object **)(&drc->dev),
 360                              NULL, 0, NULL);
 361 }
 362
 363 static void detach(sPAPRDRConnector *drc, DeviceState *d,
 364                    spapr_drc_detach_cb *detach_cb,
 365                    void *detach_cb_opaque, Error **errp)
 366 {
 367     DPRINTFN("drc: %x, detach", get_index(drc));
 368
 369     drc->detach_cb = detach_cb;
 370     drc->detach_cb_opaque = detach_cb_opaque;
 371
 372     if (drc->isolation_state != SPAPR_DR_ISOLATION_STATE_ISOLATED) {
 373         DPRINTFN("awaiting transition to isolated state before removal");
 374         drc->awaiting_release = true;
 375         return;
 376     }
 377
 378     if (drc->type != SPAPR_DR_CONNECTOR_TYPE_PCI &&
 379         drc->allocation_state != SPAPR_DR_ALLOCATION_STATE_UNUSABLE) {
 380         DPRINTFN("awaiting transition to unusable state before removal");
 381         drc->awaiting_release = true;
 382         return;
 383     }
 384
 385     drc->indicator_state = SPAPR_DR_INDICATOR_STATE_INACTIVE;
 386
 387     if (drc->detach_cb) {
 388         drc->detach_cb(drc->dev, drc->detach_cb_opaque);
 389     }
 390
 391     drc->awaiting_release = false;
 392     g_free(drc->fdt);
 393     drc->fdt = NULL;
 394     drc->fdt_start_offset = 0;
 395     object_property_del(OBJECT(drc), "device", NULL);
 396     drc->dev = NULL;
 397     drc->detach_cb = NULL;
 398     drc->detach_cb_opaque = NULL;
 399 }
 400
 401 static bool release_pending(sPAPRDRConnector *drc)
 402 {
 403     return drc->awaiting_release;
 404 }
 405
 406 static void reset(DeviceState *d)
 407 {
 408     sPAPRDRConnector *drc = SPAPR_DR_CONNECTOR(d);
 409     sPAPRDRConnectorClass *drck = SPAPR_DR_CONNECTOR_GET_CLASS(drc);
 410
 411     DPRINTFN("drc reset: %x", drck->get_index(drc));
 412     /* immediately upon reset we can safely assume DRCs whose devices
 413      * are pending removal can be safely removed, and that they will
 414      * subsequently be left in an ISOLATED state. move the DRC to this
 415      * state in these cases (which will in turn complete any pending
 416      * device removals)
 417      */
 418     if (drc->awaiting_release) {
 419         drck->set_isolation_state(drc, SPAPR_DR_ISOLATION_STATE_ISOLATED);
 420         /* generally this should also finalize the removal, but if the device
 421          * hasn't yet been configured we normally defer removal under the
 422          * assumption that this transition is taking place as part of device
 423          * configuration. so check if we're still waiting after this, and
 424          * force removal if we are
 425          */
 426         if (drc->awaiting_release) {
 427             drck->detach(drc, DEVICE(drc->dev), drc->detach_cb,
 428                          drc->detach_cb_opaque, NULL);
 429         }
 430
 431         /* non-PCI devices may be awaiting a transition to UNUSABLE */
 432         if (drc->type != SPAPR_DR_CONNECTOR_TYPE_PCI &&
 433             drc->awaiting_release) {
 434             drck->set_allocation_state(drc, SPAPR_DR_ALLOCATION_STATE_UNUSABLE);
 435         }
 436     }
 437 }
 438
 439 static void realize(DeviceState *d, Error **errp)
 440 {
 441     sPAPRDRConnector *drc = SPAPR_DR_CONNECTOR(d);
 442     sPAPRDRConnectorClass *drck = SPAPR_DR_CONNECTOR_GET_CLASS(drc);
 443     Object *root_container;
 444     char link_name[256];
 445     gchar *child_name;
 446     Error *err = NULL;
 447
 448     DPRINTFN("drc realize: %x", drck->get_index(drc));
 449     /* NOTE: we do this as part of realize/unrealize due to the fact
 450      * that the guest will communicate with the DRC via RTAS calls
 451      * referencing the global DRC index. By unlinking the DRC
 452      * from DRC_CONTAINER_PATH/<drc_index> we effectively make it
 453      * inaccessible by the guest, since lookups rely on this path
 454      * existing in the composition tree
 455      */
 456     root_container = container_get(object_get_root(), DRC_CONTAINER_PATH);
 457     snprintf(link_name, sizeof(link_name), "%x", drck->get_index(drc));
 458     child_name = object_get_canonical_path_component(OBJECT(drc));
 459     DPRINTFN("drc child name: %s", child_name);
 460     object_property_add_alias(root_container, link_name,
 461                               drc->owner, child_name, &err);
 462     if (err) {
 463         error_report("%s", error_get_pretty(err));
 464         error_free(err);
 465         object_unref(OBJECT(drc));
 466     }
 467     g_free(child_name);
 468     DPRINTFN("drc realize complete");
 469 }
 470
 471 static void unrealize(DeviceState *d, Error **errp)
 472 {
 473     sPAPRDRConnector *drc = SPAPR_DR_CONNECTOR(d);
 474     sPAPRDRConnectorClass *drck = SPAPR_DR_CONNECTOR_GET_CLASS(drc);
 475     Object *root_container;
 476     char name[256];
 477     Error *err = NULL;
 478
 479     DPRINTFN("drc unrealize: %x", drck->get_index(drc));
 480     root_container = container_get(object_get_root(), DRC_CONTAINER_PATH);
 481     snprintf(name, sizeof(name), "%x", drck->get_index(drc));
 482     object_property_del(root_container, name, &err);
 483     if (err) {
 484         error_report("%s", error_get_pretty(err));
 485         error_free(err);
 486         object_unref(OBJECT(drc));
 487     }
 488 }
 489
 490 sPAPRDRConnector *spapr_dr_connector_new(Object *owner,
 491                                          sPAPRDRConnectorType type,
 492                                          uint32_t id)
 493 {
 494     sPAPRDRConnector *drc =
 495         SPAPR_DR_CONNECTOR(object_new(TYPE_SPAPR_DR_CONNECTOR));
 496     char *prop_name;
 497
 498     g_assert(type);
 499
 500     drc->type = type;
 501     drc->id = id;
 502     drc->owner = owner;
 503     prop_name = g_strdup_printf("dr-connector[%"PRIu32"]", get_index(drc));
 504     object_property_add_child(owner, prop_name, OBJECT(drc), NULL);
 505     object_property_set_bool(OBJECT(drc), true, "realized", NULL);
 506     g_free(prop_name);
 507
 508     /* human-readable name for a DRC to encode into the DT
 509      * description. this is mainly only used within a guest in place
 510      * of the unique DRC index.
 511      *
 512      * in the case of VIO/PCI devices, it corresponds to a
 513      * "location code" that maps a logical device/function (DRC index)
 514      * to a physical (or virtual in the case of VIO) location in the
 515      * system by chaining together the "location label" for each
 516      * encapsulating component.
 517      *
 518      * since this is more to do with diagnosing physical hardware
 519      * issues than guest compatibility, we choose location codes/DRC
 520      * names that adhere to the documented format, but avoid encoding
 521      * the entire topology information into the label/code, instead
 522      * just using the location codes based on the labels for the
 523      * endpoints (VIO/PCI adaptor connectors), which is basically
 524      * just "C" followed by an integer ID.
 525      *
 526      * DRC names as documented by PAPR+ v2.7, 13.5.2.4
 527      * location codes as documented by PAPR+ v2.7, 12.3.1.5
 528      */
 529     switch (drc->type) {
 530     case SPAPR_DR_CONNECTOR_TYPE_CPU:
 531         drc->name = g_strdup_printf("CPU %d", id);
 532         break;
 533     case SPAPR_DR_CONNECTOR_TYPE_PHB:
 534         drc->name = g_strdup_printf("PHB %d", id);
 535         break;
 536     case SPAPR_DR_CONNECTOR_TYPE_VIO:
 537     case SPAPR_DR_CONNECTOR_TYPE_PCI:
 538         drc->name = g_strdup_printf("C%d", id);
 539         break;
 540     case SPAPR_DR_CONNECTOR_TYPE_LMB:
 541         drc->name = g_strdup_printf("LMB %d", id);
 542         break;
 543     default:
 544         g_assert(false);
 545     }
 546
 547     /* PCI slot always start in a USABLE state, and stay there */
 548     if (drc->type == SPAPR_DR_CONNECTOR_TYPE_PCI) {
 549         drc->allocation_state = SPAPR_DR_ALLOCATION_STATE_USABLE;
 550     }
 551
 552     return drc;
 553 }
 554
 555 static void spapr_dr_connector_instance_init(Object *obj)
 556 {
 557     sPAPRDRConnector *drc = SPAPR_DR_CONNECTOR(obj);
 558
 559     object_property_add_uint32_ptr(obj, "isolation-state",
 560                                    &drc->isolation_state, NULL);
 561     object_property_add_uint32_ptr(obj, "indicator-state",
 562                                    &drc->indicator_state, NULL);
 563     object_property_add_uint32_ptr(obj, "allocation-state",
 564                                    &drc->allocation_state, NULL);
 565     object_property_add_uint32_ptr(obj, "id", &drc->id, NULL);
 566     object_property_add(obj, "index", "uint32", prop_get_index,
 567                         NULL, NULL, NULL, NULL);
 568     object_property_add(obj, "connector_type", "uint32", prop_get_type,
 569                         NULL, NULL, NULL, NULL);
 570     object_property_add_str(obj, "name", prop_get_name, NULL, NULL);
 571     object_property_add(obj, "entity-sense", "uint32", prop_get_entity_sense,
 572                         NULL, NULL, NULL, NULL);
 573     object_property_add(obj, "fdt", "struct", prop_get_fdt,
 574                         NULL, NULL, NULL, NULL);
 575 }
 576
 577 static void spapr_dr_connector_class_init(ObjectClass *k, void *data)
 578 {
 579     DeviceClass *dk = DEVICE_CLASS(k);
 580     sPAPRDRConnectorClass *drck = SPAPR_DR_CONNECTOR_CLASS(k);
 581
 582     dk->reset = reset;
 583     dk->realize = realize;
 584     dk->unrealize = unrealize;
 585     drck->set_isolation_state = set_isolation_state;
 586     drck->set_indicator_state = set_indicator_state;
 587     drck->set_allocation_state = set_allocation_state;
 588     drck->get_index = get_index;
 589     drck->get_type = get_type;
 590     drck->get_name = get_name;
 591     drck->get_fdt = get_fdt;
 592     drck->set_configured = set_configured;
 593     drck->entity_sense = entity_sense;
 594     drck->attach = attach;
 595     drck->detach = detach;
 596     drck->release_pending = release_pending;
 597 }
 598
 599 static const TypeInfo spapr_dr_connector_info = {
 600     .name          = TYPE_SPAPR_DR_CONNECTOR,
 601     .parent        = TYPE_DEVICE,
 602     .instance_size = sizeof(sPAPRDRConnector),
 603     .instance_init = spapr_dr_connector_instance_init,
 604     .class_size    = sizeof(sPAPRDRConnectorClass),
 605     .class_init    = spapr_dr_connector_class_init,
 606 };
 607
 608 static void spapr_drc_register_types(void)
 609 {
 610     type_register_static(&spapr_dr_connector_info);
 611 }
 612
 613 type_init(spapr_drc_register_types)
 614
 615 /* helper functions for external users */
 616
 617 sPAPRDRConnector *spapr_dr_connector_by_index(uint32_t index)
 618 {
 619     Object *obj;
 620     char name[256];
 621
 622     snprintf(name, sizeof(name), "%s/%x", DRC_CONTAINER_PATH, index);
 623     obj = object_resolve_path(name, NULL);
 624
 625     return !obj ? NULL : SPAPR_DR_CONNECTOR(obj);
 626 }
 627
 628 sPAPRDRConnector *spapr_dr_connector_by_id(sPAPRDRConnectorType type,
 629                                            uint32_t id)
 630 {
 631     return spapr_dr_connector_by_index(
 632             (get_type_shift(type) << DRC_INDEX_TYPE_SHIFT) |
 633             (id & DRC_INDEX_ID_MASK));
 634 }
 635
 636 /* generate a string the describes the DRC to encode into the
 637  * device tree.
 638  *
 639  * as documented by PAPR+ v2.7, 13.5.2.6 and C.6.1
 640  */
 641 static const char *spapr_drc_get_type_str(sPAPRDRConnectorType type)
 642 {
 643     switch (type) {
 644     case SPAPR_DR_CONNECTOR_TYPE_CPU:
 645         return "CPU";
 646     case SPAPR_DR_CONNECTOR_TYPE_PHB:
 647         return "PHB";
 648     case SPAPR_DR_CONNECTOR_TYPE_VIO:
 649         return "SLOT";
 650     case SPAPR_DR_CONNECTOR_TYPE_PCI:
 651         return "28";
 652     case SPAPR_DR_CONNECTOR_TYPE_LMB:
 653         return "MEM";
 654     default:
 655         g_assert(false);
 656     }
 657
 658     return NULL;
 659 }
 660
 661 /**
 662  * spapr_drc_populate_dt
 663  *
 664  * @fdt: libfdt device tree
 665  * @path: path in the DT to generate properties
 666  * @owner: parent Object/DeviceState for which to generate DRC
 667  *         descriptions for
 668  * @drc_type_mask: mask of sPAPRDRConnectorType values corresponding
 669  *   to the types of DRCs to generate entries for
 670  *
 671  * generate OF properties to describe DRC topology/indices to guests
 672  *
 673  * as documented in PAPR+ v2.1, 13.5.2
 674  */
 675 int spapr_drc_populate_dt(void *fdt, int fdt_offset, Object *owner,
 676                           uint32_t drc_type_mask)
 677 {
 678     Object *root_container;
 679     ObjectProperty *prop;
 680     ObjectPropertyIterator *iter;
 681     uint32_t drc_count = 0;
 682     GArray *drc_indexes, *drc_power_domains;
 683     GString *drc_names, *drc_types;
 684     int ret;
 685
 686     /* the first entry of each properties is a 32-bit integer encoding
 687      * the number of elements in the array. we won't know this until
 688      * we complete the iteration through all the matching DRCs, but
 689      * reserve the space now and set the offsets accordingly so we
 690      * can fill them in later.
 691      */
 692     drc_indexes = g_array_new(false, true, sizeof(uint32_t));
 693     drc_indexes = g_array_set_size(drc_indexes, 1);
 694     drc_power_domains = g_array_new(false, true, sizeof(uint32_t));
 695     drc_power_domains = g_array_set_size(drc_power_domains, 1);
 696     drc_names = g_string_set_size(g_string_new(NULL), sizeof(uint32_t));
 697     drc_types = g_string_set_size(g_string_new(NULL), sizeof(uint32_t));
 698
 699     /* aliases for all DRConnector objects will be rooted in QOM
 700      * composition tree at DRC_CONTAINER_PATH
 701      */
 702     root_container = container_get(object_get_root(), DRC_CONTAINER_PATH);
 703
 704     iter = object_property_iter_init(root_container);
 705     while ((prop = object_property_iter_next(iter))) {
 706         Object *obj;
 707         sPAPRDRConnector *drc;
 708         sPAPRDRConnectorClass *drck;
 709         uint32_t drc_index, drc_power_domain;
 710
 711         if (!strstart(prop->type, "link<", NULL)) {
 712             continue;
 713         }
 714
 715         obj = object_property_get_link(root_container, prop->name, NULL);
 716         drc = SPAPR_DR_CONNECTOR(obj);
 717         drck = SPAPR_DR_CONNECTOR_GET_CLASS(drc);
 718
 719         if (owner && (drc->owner != owner)) {
 720             continue;
 721         }
 722
 723         if ((drc->type & drc_type_mask) == 0) {
 724             continue;
 725         }
 726
 727         drc_count++;
 728
 729         /* ibm,drc-indexes */
 730         drc_index = cpu_to_be32(drck->get_index(drc));
 731         g_array_append_val(drc_indexes, drc_index);
 732
 733         /* ibm,drc-power-domains */
 734         drc_power_domain = cpu_to_be32(-1);
 735         g_array_append_val(drc_power_domains, drc_power_domain);
 736
 737         /* ibm,drc-names */
 738         drc_names = g_string_append(drc_names, drck->get_name(drc));
 739         drc_names = g_string_insert_len(drc_names, -1, "\0", 1);
 740
 741         /* ibm,drc-types */
 742         drc_types = g_string_append(drc_types,
 743                                     spapr_drc_get_type_str(drc->type));
 744         drc_types = g_string_insert_len(drc_types, -1, "\0", 1);
 745     }
 746     object_property_iter_free(iter);
 747
 748     /* now write the drc count into the space we reserved at the
 749      * beginning of the arrays previously
 750      */
 751     *(uint32_t *)drc_indexes->data = cpu_to_be32(drc_count);
 752     *(uint32_t *)drc_power_domains->data = cpu_to_be32(drc_count);
 753     *(uint32_t *)drc_names->str = cpu_to_be32(drc_count);
 754     *(uint32_t *)drc_types->str = cpu_to_be32(drc_count);
 755
 756     ret = fdt_setprop(fdt, fdt_offset, "ibm,drc-indexes",
 757                       drc_indexes->data,
 758                       drc_indexes->len * sizeof(uint32_t));
 759     if (ret) {
 760         fprintf(stderr, "Couldn't create ibm,drc-indexes property\n");
 761         goto out;
 762     }
 763
 764     ret = fdt_setprop(fdt, fdt_offset, "ibm,drc-power-domains",
 765                       drc_power_domains->data,
 766                       drc_power_domains->len * sizeof(uint32_t));
 767     if (ret) {
 768         fprintf(stderr, "Couldn't finalize ibm,drc-power-domains property\n");
 769         goto out;
 770     }
 771
 772     ret = fdt_setprop(fdt, fdt_offset, "ibm,drc-names",
 773                       drc_names->str, drc_names->len);
 774     if (ret) {
 775         fprintf(stderr, "Couldn't finalize ibm,drc-names property\n");
 776         goto out;
 777     }
 778
 779     ret = fdt_setprop(fdt, fdt_offset, "ibm,drc-types",
 780                       drc_types->str, drc_types->len);
 781     if (ret) {
 782         fprintf(stderr, "Couldn't finalize ibm,drc-types property\n");
 783         goto out;
 784     }
 785
 786 out:
 787     g_array_free(drc_indexes, true);
 788     g_array_free(drc_power_domains, true);
 789     g_string_free(drc_names, true);
 790     g_string_free(drc_types, true);
 791
 792     return ret;
 793 }