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