aboutsummaryrefslogtreecommitdiff
path: root/qapi/block-core.json
diff options
context:
space:
mode:
authorDaniel P. Berrangé <berrange@redhat.com>2019-12-06 14:38:11 +0000
committerKevin Wolf <kwolf@redhat.com>2019-12-18 11:20:57 +0100
commitecaf647f300d69271c245a67adca9c3a89d9463a (patch)
tree0547a43e9238a648527116601bc46b078c2d1aa6 /qapi/block-core.json
parente28582fdb28b2e8b29a351c20b0c8f1af4120688 (diff)
qapi: better document NVMe blockdev @device parameter
Mention that this is a PCI device address & give the format it is expected in. Also mention that it must be first unbound from any host kernel driver. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com> Reviewed-by: Eric Blake <eblake@redhat.com> Signed-off-by: Kevin Wolf <kwolf@redhat.com>
Diffstat (limited to 'qapi/block-core.json')
-rw-r--r--qapi/block-core.json6
1 files changed, 5 insertions, 1 deletions
diff --git a/qapi/block-core.json b/qapi/block-core.json
index 0cf68fea14..fcb52ec24f 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -2963,9 +2963,13 @@
#
# Driver specific block device options for the NVMe backend.
#
-# @device: controller address of the NVMe device.
+# @device: PCI controller address of the NVMe device in
+# format hhhh:bb:ss.f (host:bus:slot.function)
# @namespace: namespace number of the device, starting from 1.
#
+# Note that the PCI @device must have been unbound from any host
+# kernel driver before instructing QEMU to add the blockdev.
+#
# Since: 2.12
##
{ 'struct': 'BlockdevOptionsNVMe',