iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

drm/bridge: Add documentation sections

Browse Source 
The bridge documentation overview is quite packed already, and we'll add
some more documentation that isn't part of an overview at all.

Let's add some sections to the documentation to separate each bits.

Reviewed-by: Andrzej Hajda <a.hajda@samsung.com>
Reviewed-by: Sam Ravnborg <sam@ravnborg.org>
Signed-off-by: Maxime Ripard <maxime@cerno.tech>
Link: https://patchwork.freedesktop.org/patch/msgid/20210910101218.1632297-2-maxime@cerno.tech
This commit is contained in:
Maxime Ripard 2021-09-10 12:11:55 +02:00
parent 13afcdd727
commit 8886815f4c
No known key found for this signature in database
GPG Key ID: E3EF0D6F671851C5
2 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Documentation/gpu/drm-kms-helpers.rst
View File

@ -151,6 +151,12 @@ Overview
.. kernel-doc:: drivers/gpu/drm/drm_bridge.c .. kernel-doc:: drivers/gpu/drm/drm_bridge.c
:doc: overview :doc: overview
Display Driver Integration
--------------------------
.. kernel-doc:: drivers/gpu/drm/drm_bridge.c
:doc: display driver integration
Bridge Operations Bridge Operations
----------------- -----------------

14
drivers/gpu/drm/drm_bridge.c
View File

@ -50,6 +50,15 @@
* Chaining multiple bridges to the output of a bridge, or the same bridge to * Chaining multiple bridges to the output of a bridge, or the same bridge to
* the output of different bridges, is not supported. * the output of different bridges, is not supported.
* *
* &drm_bridge, like &drm_panel, aren't &drm_mode_object entities like planes,
* CRTCs, encoders or connectors and hence are not visible to userspace. They
* just provide additional hooks to get the desired output at the end of the
* encoder chain.
*/
/**
* DOC: display driver integration
*
* Display drivers are responsible for linking encoders with the first bridge * Display drivers are responsible for linking encoders with the first bridge
* in the chains. This is done by acquiring the appropriate bridge with * in the chains. This is done by acquiring the appropriate bridge with
* devm_drm_of_get_bridge(). Once acquired, the bridge shall be attached to the * devm_drm_of_get_bridge(). Once acquired, the bridge shall be attached to the
@ -84,11 +93,6 @@
* helper to create the &drm_connector, or implement it manually on top of the * helper to create the &drm_connector, or implement it manually on top of the
* connector-related operations exposed by the bridge (see the overview * connector-related operations exposed by the bridge (see the overview
* documentation of bridge operations for more details). * documentation of bridge operations for more details).
*
* &drm_bridge, like &drm_panel, aren't &drm_mode_object entities like planes,
* CRTCs, encoders or connectors and hence are not visible to userspace. They
* just provide additional hooks to get the desired output at the end of the
* encoder chain.
*/ */
static DEFINE_MUTEX(bridge_lock); static DEFINE_MUTEX(bridge_lock);