xref: /qemu/include/monitor/qdev.h (revision 4a1d9377)
1 #ifndef MONITOR_QDEV_H
2 #define MONITOR_QDEV_H
3 
4 /*** monitor commands ***/
5 
6 void hmp_info_qtree(Monitor *mon, const QDict *qdict);
7 void hmp_info_qdm(Monitor *mon, const QDict *qdict);
8 void qmp_device_add(QDict *qdict, QObject **ret_data, Error **errp);
9 
10 int qdev_device_help(QemuOpts *opts);
11 DeviceState *qdev_device_add(QemuOpts *opts, Error **errp);
12 
13 /**
14  * qdev_set_id: parent the device and set its id if provided.
15  * @dev: device to handle
16  * @id: id to be given to the device, or NULL.
17  *
18  * Returns: the id of the device in case of success; otherwise NULL.
19  *
20  * @dev must be unrealized, unparented and must not have an id.
21  *
22  * If @id is non-NULL, this function tries to setup @dev qom path as
23  * "/peripheral/id". If @id is already taken, it fails. If it succeeds,
24  * the id field of @dev is set to @id (@dev now owns the given @id
25  * parameter).
26  *
27  * If @id is NULL, this function generates a unique name and setups @dev
28  * qom path as "/peripheral-anon/name". This name is not set as the id
29  * of @dev.
30  *
31  * Upon success, it returns the id/name (generated or provided). The
32  * returned string is owned by the corresponding child property and must
33  * not be freed by the caller.
34  */
35 const char *qdev_set_id(DeviceState *dev, char *id, Error **errp);
36 
37 #endif
38