drm/dp: Clarify DP AUX registration time
authorLyude Paul <lyude@redhat.com>
Fri, 23 Apr 2021 18:42:56 +0000 (14:42 -0400)
committerLyude Paul <lyude@redhat.com>
Tue, 27 Apr 2021 22:43:42 +0000 (18:43 -0400)
commit3f3a6524f6065fd3d130515e012f63eac74d96da
treeb542b2fc9de133c5b4feb4ac3ed252a7ecda04dc
parent6cba3fe433415b2549c909ce72601902c8254a83
drm/dp: Clarify DP AUX registration time

The docs we had for drm_dp_aux_init() and drm_dp_aux_register() were mostly
correct, except for the fact that they made the assumption that all AUX
devices were grandchildren of their respective DRM devices. This is the
case for most normal GPUs, but is almost never the case with SoCs and
display bridges. So, let's fix this documentation to clarify when the right
time to use drm_dp_aux_init() or drm_dp_aux_register() is.

Signed-off-by: Lyude Paul <lyude@redhat.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20210423184309.207645-5-lyude@redhat.com
Reviewed-by: Dave Airlie <airlied@redhat.com>
drivers/gpu/drm/drm_dp_helper.c