aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJag Raman <jag.raman@oracle.com>2022-05-23 08:15:47 -0400
committerGitHub <noreply@github.com>2022-05-23 13:15:47 +0100
commitb52bff72d4eb646a453d19e19ddbd13ed6111a09 (patch)
tree493045e75edc44a0696dfaffd84896a8e0cdaf7f /docs
parentb427c6084311f0c620bf4afe7746739e8c887977 (diff)
downloadlibvfio-user-b52bff72d4eb646a453d19e19ddbd13ed6111a09.zip
libvfio-user-b52bff72d4eb646a453d19e19ddbd13ed6111a09.tar.gz
libvfio-user-b52bff72d4eb646a453d19e19ddbd13ed6111a09.tar.bz2
libvfio-user.h: sync VFIO_DEVICE_STATE_XXXX definitions with upstream (#690)
Rename VFIO_DEVICE_STATE_XXXX defines as VFIO_DEVICE_STATE_V1_XXXX. Upstream renamed these variable to be of the XXXX_V1_XXXX format and switched an enum for VFIO_DEVICE_STATE_XXXX. Signed-off-by: Jagannathan Raman <jag.raman@oracle.com> Reviewed-by: John Levon <john.levon@nutanix.com> Reviewed-by: Thanos Makatos <thanos.makatos@nutanix.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/vfio-user.rst50
1 files changed, 25 insertions, 25 deletions
diff --git a/docs/vfio-user.rst b/docs/vfio-user.rst
index 9d03f4d..9e1314e 100644
--- a/docs/vfio-user.rst
+++ b/docs/vfio-user.rst
@@ -1598,29 +1598,29 @@ A device may contain a migration region (of type
subregion is accessed like any other part of a standard vfio-user region
using ``VFIO_USER_REGION_READ``/``VFIO_USER_REGION_WRITE``.
-+---------------+--------+-----------------------------+
-| Name | Offset | Size |
-+===============+========+=============================+
-| device_state | 0 | 4 |
-+---------------+--------+-----------------------------+
-| | +-----+----------------------------+ |
-| | | Bit | Definition | |
-| | +=====+============================+ |
-| | | 0 | VFIO_DEVICE_STATE_RUNNING | |
-| | +-----+----------------------------+ |
-| | | 1 | VFIO_DEVICE_STATE_SAVING | |
-| | +-----+----------------------------+ |
-| | | 2 | VFIO_DEVICE_STATE_RESUMING | |
-| | +-----+----------------------------+ |
-+---------------+--------+-----------------------------+
-| reserved | 4 | 4 |
-+---------------+--------+-----------------------------+
-| pending_bytes | 8 | 8 |
-+---------------+--------+-----------------------------+
-| data_offset | 16 | 8 |
-+---------------+--------+-----------------------------+
-| data_size | 24 | 8 |
-+---------------+--------+-----------------------------+
++---------------+--------+--------------------------------+
+| Name | Offset | Size |
++===============+========+================================+
+| device_state | 0 | 4 |
++---------------+--------+--------------------------------+
+| | +-----+-------------------------------+ |
+| | | Bit | Definition | |
+| | +=====+===============================+ |
+| | | 0 | VFIO_DEVICE_STATE_V1_RUNNING | |
+| | +-----+-------------------------------+ |
+| | | 1 | VFIO_DEVICE_STATE_V1_SAVING | |
+| | +-----+-------------------------------+ |
+| | | 2 | VFIO_DEVICE_STATE_V1_RESUMING | |
+| | +-----+-------------------------------+ |
++---------------+--------+--------------------------------+
+| reserved | 4 | 4 |
++---------------+--------+--------------------------------+
+| pending_bytes | 8 | 8 |
++---------------+--------+--------------------------------+
+| data_offset | 16 | 8 |
++---------------+--------+--------------------------------+
+| data_size | 24 | 8 |
++---------------+--------+--------------------------------+
* *device_state* defines the state of the device:
@@ -1630,8 +1630,8 @@ using ``VFIO_USER_REGION_READ``/``VFIO_USER_REGION_WRITE``.
``VFIO_USER_REGION_WRITE`` operation with the Error field set accordingly and
must remain at the previous state, or in case of internal error it must
transition to the error state, defined as
- ``VFIO_DEVICE_STATE_RESUMING | VFIO_DEVICE_STATE_SAVING``. The client must
- re-read the device state in order to determine it afresh.
+ ``VFIO_DEVICE_STATE_V1_RESUMING | VFIO_DEVICE_STATE_V1_SAVING``. The client
+ must re-read the device state in order to determine it afresh.
The following device states are defined: