14b48aaab9
Use the no-option form of ".. qmp-example::" to convert any Examples
that do not have any form of caption or explanation whatsoever. Note
that in a few cases, example sections are split into two or more
separate example blocks. This is only done stylistically to create a
delineation between two or more logically independent examples.
See commit-3: "docs/qapidoc: create qmp-example directive", for a
detailed explanation of this custom directive syntax.
See commit+3: "qapi: remove "Example" doc section" for a detailed
explanation of why.
Note: an empty "TODO" line was added to announce-self to keep the
example from floating up into the body; this will be addressed more
rigorously in the new qapidoc generator.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20240717021312.606116-7-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Markup fixed in one place]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
68 lines
1.6 KiB
Python
68 lines
1.6 KiB
Python
# -*- Mode: Python -*-
|
|
# vim: filetype=python
|
|
#
|
|
|
|
##
|
|
# = VFIO devices
|
|
##
|
|
|
|
##
|
|
# @VfioMigrationState:
|
|
#
|
|
# An enumeration of the VFIO device migration states.
|
|
#
|
|
# @stop: The device is stopped.
|
|
#
|
|
# @running: The device is running.
|
|
#
|
|
# @stop-copy: The device is stopped and its internal state is available
|
|
# for reading.
|
|
#
|
|
# @resuming: The device is stopped and its internal state is available
|
|
# for writing.
|
|
#
|
|
# @running-p2p: The device is running in the P2P quiescent state.
|
|
#
|
|
# @pre-copy: The device is running, tracking its internal state and its
|
|
# internal state is available for reading.
|
|
#
|
|
# @pre-copy-p2p: The device is running in the P2P quiescent state,
|
|
# tracking its internal state and its internal state is available
|
|
# for reading.
|
|
#
|
|
# Since: 9.1
|
|
##
|
|
{ 'enum': 'VfioMigrationState',
|
|
'data': [ 'stop', 'running', 'stop-copy', 'resuming', 'running-p2p',
|
|
'pre-copy', 'pre-copy-p2p' ],
|
|
'prefix': 'QAPI_VFIO_MIGRATION_STATE' }
|
|
|
|
##
|
|
# @VFIO_MIGRATION:
|
|
#
|
|
# This event is emitted when a VFIO device migration state is changed.
|
|
#
|
|
# @device-id: The device's id, if it has one.
|
|
#
|
|
# @qom-path: The device's QOM path.
|
|
#
|
|
# @device-state: The new changed device migration state.
|
|
#
|
|
# Since: 9.1
|
|
#
|
|
# .. qmp-example::
|
|
#
|
|
# <- { "timestamp": { "seconds": 1713771323, "microseconds": 212268 },
|
|
# "event": "VFIO_MIGRATION",
|
|
# "data": {
|
|
# "device-id": "vfio_dev1",
|
|
# "qom-path": "/machine/peripheral/vfio_dev1",
|
|
# "device-state": "stop" } }
|
|
##
|
|
{ 'event': 'VFIO_MIGRATION',
|
|
'data': {
|
|
'device-id': 'str',
|
|
'qom-path': 'str',
|
|
'device-state': 'VfioMigrationState'
|
|
} }
|