xref: /openbmc/qemu/include/monitor/qdev.h (revision f0984d40)
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 DeviceState *qdev_device_add_from_qdict(const QDict *opts,
13                                         bool from_json, Error **errp);
14 
15 /**
16  * qdev_set_id: parent the device and set its id if provided.
17  * @dev: device to handle
18  * @id: id to be given to the device, or NULL.
19  *
20  * Returns: the id of the device in case of success; otherwise NULL.
21  *
22  * @dev must be unrealized, unparented and must not have an id.
23  *
24  * If @id is non-NULL, this function tries to setup @dev qom path as
25  * "/peripheral/id". If @id is already taken, it fails. If it succeeds,
26  * the id field of @dev is set to @id (@dev now owns the given @id
27  * parameter).
28  *
29  * If @id is NULL, this function generates a unique name and setups @dev
30  * qom path as "/peripheral-anon/name". This name is not set as the id
31  * of @dev.
32  *
33  * Upon success, it returns the id/name (generated or provided). The
34  * returned string is owned by the corresponding child property and must
35  * not be freed by the caller.
36  */
37 const char *qdev_set_id(DeviceState *dev, char *id, Error **errp);
38 
39 #endif
40