xref: /openbmc/qemu/qapi/vfio.json (revision cad9aa6fbdccd95e56e10cfa57c354a20a333717)
1# -*- Mode: Python -*-
2# vim: filetype=python
3#
4
5##
6# ************
7# VFIO devices
8# ************
9##
10
11##
12# @QapiVfioMigrationState:
13#
14# An enumeration of the VFIO device migration states.
15#
16# @stop: The device is stopped.
17#
18# @running: The device is running.
19#
20# @stop-copy: The device is stopped and its internal state is
21#     available for reading.
22#
23# @resuming: The device is stopped and its internal state is available
24#     for writing.
25#
26# @running-p2p: The device is running in the P2P quiescent state.
27#
28# @pre-copy: The device is running, tracking its internal state and
29#     its internal state is available for reading.
30#
31# @pre-copy-p2p: The device is running in the P2P quiescent state,
32#     tracking its internal state and its internal state is available
33#     for reading.
34#
35# Since: 9.1
36##
37{ 'enum': 'QapiVfioMigrationState',
38  'data': [ 'stop', 'running', 'stop-copy', 'resuming', 'running-p2p',
39            'pre-copy', 'pre-copy-p2p' ] }
40
41##
42# @VFIO_MIGRATION:
43#
44# This event is emitted when a VFIO device migration state is changed.
45#
46# @device-id: The device's id, if it has one.
47#
48# @qom-path: The device's QOM path.
49#
50# @device-state: The new changed device migration state.
51#
52# Since: 9.1
53#
54# .. qmp-example::
55#
56#     <- { "timestamp": { "seconds": 1713771323, "microseconds": 212268 },
57#          "event": "VFIO_MIGRATION",
58#          "data": {
59#              "device-id": "vfio_dev1",
60#              "qom-path": "/machine/peripheral/vfio_dev1",
61#              "device-state": "stop" } }
62##
63{ 'event': 'VFIO_MIGRATION',
64  'data': {
65      'device-id': 'str',
66      'qom-path': 'str',
67      'device-state': 'QapiVfioMigrationState'
68  } }
69