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