Commit 46ea1be1 authored by Peter Maydell's avatar Peter Maydell
Browse files

qdev: Document qdev_unrealize() 



Add a doc comment for qdev_unrealize(), to go with the new
documentation for the realize part of the qdev lifecycle.

Signed-off-by: default avatarPeter Maydell <peter.maydell@linaro.org>
Reviewed-by: default avatarRichard Henderson <richard.henderson@linaro.org>
Message-id: 20200711142425.16283-3-peter.maydell@linaro.org
parent b51238e2

include/hw/qdev-core.h

+19 −0
Original line number Diff line number Diff line
@@ -381,6 +381,25 @@ bool qdev_realize(DeviceState *dev, BusState *bus, Error **errp); 
 * would be incorrect. For that use case you want qdev_realize().

 */

bool qdev_realize_and_unref(DeviceState *dev, BusState *bus, Error **errp);

/**

 * qdev_unrealize: Unrealize a device

 * @dev: device to unrealize

 *

 * This function will "unrealize" a device, which is the first phase

 * of correctly destroying a device that has been realized. It will:

 *

 *  - unrealize any child buses by calling qbus_unrealize()

 *    (this will recursively unrealize any devices on those buses)

 *  - call the the unrealize method of @dev

 *

 * The device can then be freed by causing its reference count to go

 * to zero.

 *

 * Warning: most devices in QEMU do not expect to be unrealized.  Only

 * devices which are hot-unpluggable should be unrealized (as part of

 * the unplugging process); all other devices are expected to last for

 * the life of the simulation and should not be unrealized and freed.

 */

void qdev_unrealize(DeviceState *dev);

void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id,

                                 int required_for_version);