[v8,04/54] drm/bridge: Document the drm_encoder.bridge_chain field as private
diff mbox series

Message ID 20200226112514.12455-5-laurent.pinchart@ideasonboard.com
State New
Headers show
Series
  • drm/omap: Replace custom display drivers with drm_bridge and drm_panel
Related show

Commit Message

Laurent Pinchart Feb. 26, 2020, 11:24 a.m. UTC
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>
---
 include/drm/drm_encoder.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Patch
diff mbox series

diff --git a/include/drm/drm_encoder.h b/include/drm/drm_encoder.h
index 5623994b6e9e..4370e039c015 100644
--- 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;