diff options
| author | Daniel Vetter | 2019-05-06 16:46:29 +0200 |
|---|---|---|
| committer | Daniel Vetter | 2019-05-07 12:04:12 +0200 |
| commit | 27edadf6df811bcad0f7fa2f89321b4590a425bc (patch) | |
| tree | f6bf6942b6c7bb828e30b1f8be8562ede24c6753 | |
| parent | 7a00b45af3e723ff51d015ed72dc97487bb034b5 (diff) | |
drm/doc: Improve docs for conn_state->best_encoder
It's mandatory and considered core state since ioctls rely on this
working.
Thanks to Laurent for pointing out this gap.
v2: Clarify to "atomic drivers" only.
Cc: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Cc: Sean Paul <sean@poorly.run>
Acked-by: Sean Paul <sean@poorly.run>
Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20190506144629.5976-1-daniel.vetter@ffwll.ch
| -rw-r--r-- | include/drm/drm_connector.h | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/include/drm/drm_connector.h b/include/drm/drm_connector.h index 02a131202add..f43f40d5888a 100644 --- a/include/drm/drm_connector.h +++ b/include/drm/drm_connector.h @@ -517,6 +517,10 @@ struct drm_connector_state { * Used by the atomic helpers to select the encoder, through the * &drm_connector_helper_funcs.atomic_best_encoder or * &drm_connector_helper_funcs.best_encoder callbacks. + * + * NOTE: Atomic drivers must fill this out (either themselves or through + * helpers), for otherwise the GETCONNECTOR and GETENCODER IOCTLs will + * not return correct data to userspace. */ struct drm_encoder *best_encoder; |