drm: document struct drm_mode_fb_cmd2
authorSimon Ser <contact@emersion.fr>
Thu, 3 Feb 2022 13:38:06 +0000 (13:38 +0000)
committerSimon Ser <contact@emersion.fr>
Sun, 6 Feb 2022 20:38:46 +0000 (21:38 +0100)
commita3574119826d9a4ef807fb973cf5150c3b90da43
tree831d5540d090171e00557079d84aad547e50f75c
parenteea89dff4c39a106f98d1cb5e4d626f8c63908b9
drm: document struct drm_mode_fb_cmd2

Follow-up for the DRM_IOCTL_MODE_GETFB2 docs.

v2: (Daniel Stone)
- Replace fourcc.org with drm_fourcc.h because this is the
  authoritative source and the website may have mismatches.
- Drop assumption that offsets will generally be 0.
- Mention that unused entries must be zero'ed out.

v3: (Pekka)
- Mention that a handle can be re-used
- Add unit for pitches/offsets

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