[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH v2] QMP: Introduce the documentation for query-qdm
From: |
Miguel Di Ciurcio Filho |
Subject: |
[Qemu-devel] [PATCH v2] QMP: Introduce the documentation for query-qdm |
Date: |
Fri, 9 Jul 2010 15:13:48 -0300 |
Changelog from v1
-----------------
- renamed "props" to "properties"
- updated the examples
- reworded the explanations of "name" and "description"
- split "type" into a json-object, adding "qmp" and "qdev"
- list all possible values for "bus"
- list all possible values for "qdev" on "type"
- list all possible values for "qmp" on "type"
---
qemu-monitor.hx | 88 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 files changed, 88 insertions(+), 0 deletions(-)
diff --git a/qemu-monitor.hx b/qemu-monitor.hx
index 2af3de6..0055d0a 100644
--- a/qemu-monitor.hx
+++ b/qemu-monitor.hx
@@ -2490,6 +2490,94 @@ STEXI
show device tree
@item info qdm
show qdev device model list
+ETEXI
+SQMP
+query-qdm
+---------
+
+Describe the capabilities of all devices registered with qdev.
+
+The returned output is a json-array, each element is a json-object describing
+a single device type.
+
+Each json-object contains the following:
+
+- "name": name of the device (json-string)
+- "bus": the name of the bus type for the device (json-string)
+ - Possible values: PCI, SCSI, I2C, ISA, SSI, USB, virtio-serial-bus, System
+- "alias": an alias by which the device is also known (json-string, optional)
+- "description": description of the device (json-string, optional)
+- "creatable": whether this device can be created on command line
(json-boolean)
+- "properties": a list where each element is an json-object that describes a
+ property of the device. Each json-object contains the following:
+ - "name": the name of the property (json-string)
+ - "type": a json-object that contains the following:
+ - "qdev": the internal name of the type of the property (json-string)
+ - Possible values: uint8, uint16, uint32, uint64, int32, macaddr,
+ drive, chr, string, netdev, bit, taddr
+ - "qmp": the json equivalent type of the internal type (json-string)
+ - Possible values: integer, string, boolean
+
+Example:
+
+-> { "execute": "query-qdm" }
+<- {
+ "return": [
+ {
+ "name": "virtio-blk-pci",
+ "creatable": true,
+ "bus": "PCI",
+ "properties": [
+ {
+ "name": "indirect_desc",
+ "type": {
+ "qdev": "bit",
+ "qmp": "boolean"
+ }
+ },
+ {
+ "name": "logical_block_size",
+ "type": {
+ "qdev": "uint16",
+ "qmp": "integer"
+ }
+ },
+ {
+ "name": "opt_io_size",
+ "type": {
+ "qdev": "uint32",
+ "qmp": "integer"
+ }
+ }
+ {
+ "name": "drive",
+ "type": {
+ "qdev": "drive",
+ "qmp": "string"
+ }
+ }
+ ]
+ },
+ {
+ "name": "virtio-balloon-pci",
+ "creatable": true,
+ "bus": "PCI",
+ "properties": [
+ {
+ "name": "indirect_desc",
+ "type": {
+ "qdev": "bit",
+ "qmp": "boolean"
+ }
+ }
+ ]
+ },
+ ....
+ ]
+
+EQMP
+
+STEXI
@item info roms
show roms
@end table
--
1.7.1
- [Qemu-devel] [PATCH v2] QMP: Introduce the documentation for query-qdm,
Miguel Di Ciurcio Filho <=