OSDN Git Service

drm: document DRM_IOCTL_MODE_GETFB2
authorSimon Ser <contact@emersion.fr>
Tue, 23 Nov 2021 11:24:04 +0000 (11:24 +0000)
committerSimon Ser <contact@emersion.fr>
Tue, 14 Dec 2021 11:03:32 +0000 (12:03 +0100)
commit43d5ac7d07023cd133b978de473b3400edad941f
tree9545b5ee45e22de74af27bfa97776b1844a870a4
parent1c66496b1391699040d0ddda21fe1979865f6eba
drm: document DRM_IOCTL_MODE_GETFB2

There are a few details specific to the GETFB2 IOCTL.

It's not immediately clear how user-space should check for the
number of planes. Suggest using the handles field or the pitches
field.

The modifier array is filled with zeroes, ie. DRM_FORMAT_MOD_LINEAR.
So explicitly tell user-space to not look at it unless the flag is
set.

Changes in v2 (Daniel):
- Mention that handles should be used to compute the number of planes,
  and only refer to pitches as a fallback.
- Reword bit about undefined modifier.

Signed-off-by: Simon Ser <contact@emersion.fr>
Acked-by: Daniel Vetter <daniel@ffwll.ch>
Acked-by: Pekka Paalanen <pekka.paalanen@collabora.com>
Acked-by: Daniel Stone <daniels@collabora.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20211123112400.22245-1-contact@emersion.fr
include/uapi/drm/drm.h