[PATCH v3 1/4] drm/uapi: add documentation for atomic flags
Boris Brezillon
boris.brezillon at collabora.com
Fri Apr 12 13:31:17 UTC 2019
Hello Helen,
On Fri, 12 Apr 2019 09:58:24 -0300
Helen Koike <helen.koike at collabora.com> wrote:
> add a brief description of the flags used in an atomic commit
>
> Signed-off-by: Helen Koike <helen.koike at collabora.com>
> ---
>
> Changes in v3: None
> Changes in v2: None
> Changes in v1: None
>
> include/uapi/drm/drm_mode.h | 18 +++++++++++++++++-
> 1 file changed, 17 insertions(+), 1 deletion(-)
>
> diff --git a/include/uapi/drm/drm_mode.h b/include/uapi/drm/drm_mode.h
> index 83cd1636b9be..88ef2cf04d13 100644
> --- a/include/uapi/drm/drm_mode.h
> +++ b/include/uapi/drm/drm_mode.h
> @@ -729,7 +729,23 @@ struct drm_mode_destroy_dumb {
> __u32 handle;
> };
>
> -/* page-flip flags are valid, plus: */
> +/*
You might want to use a standard kernel/sphynx doc header so that it
can be parsed by sphynx and included in the DRM doc.
> + * drm atomic flags
> + *
> + * page-flip flags are valid, plus:
> + *
> + * DRM_MODE_ATOMIC_TEST_ONLY
> + * Used with fences to check if the Sync File is a valid one.
I think it can be used for any kind of tests, like when you want to
know if a combination of property updates is supported. It's fine
having the fence example, but I think you should be clear that it's
just one use case.
> + *
> + * DRM_MODE_ATOMIC_NONBLOCK
> + * Perform a normal atomic update but do not block the ioctl until the request
> + * is finished, return the ioctl call immediately.
> + *
> + * DRM_MODE_ATOMIC_ALLOW_MODESET
> + * Indicates whether a full modeset is acceptable or not.
> + */
> +
> +/* */
> #define DRM_MODE_ATOMIC_TEST_ONLY 0x0100
> #define DRM_MODE_ATOMIC_NONBLOCK 0x0200
> #define DRM_MODE_ATOMIC_ALLOW_MODESET 0x0400
Regards,
Boris
More information about the dri-devel
mailing list