drm/bridge: Document the drm_encoder.bridge_chain field as private

The drm_encoder.bridge_chain is not meant to be touched manually by
drivers. Make this clear in the documentation.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Boris Brezillon <boris.brezillon@collabora.com>
Signed-off-by: Tomi Valkeinen <tomi.valkeinen@ti.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20200226112514.12455-5-laurent.pinchart@ideasonboard.com

diff --git a/include/drm/drm_encoder.h b/include/drm/drm_encoder.h
index 5623994b6e9ed87a9bd57e45ddd58dadeecf9853..4370e039c015a7501a073297c0e51e75761b278a 100644 (file)
--- a/include/drm/drm_encoder.h
+++ b/include/drm/drm_encoder.h
@@ -174,7 +174,8 @@ struct drm_encoder {
        struct drm_crtc *crtc;
 
        /**
-        * @bridge_chain: Bridges attached to this encoder.
+        * @bridge_chain: Bridges attached to this encoder. Drivers shall not
+        * access this field directly.
         */
        struct list_head bridge_chain;