Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

drm/bridge: Add documentation sections

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

+15 -5
+6
Documentation/gpu/drm-kms-helpers.rst
··· 151 151 .. kernel-doc:: drivers/gpu/drm/drm_bridge.c 152 152 :doc: overview 153 153 154 + Display Driver Integration 155 + -------------------------- 156 + 157 + .. kernel-doc:: drivers/gpu/drm/drm_bridge.c 158 + :doc: display driver integration 159 + 154 160 Bridge Operations 155 161 ----------------- 156 162
+9 -5
drivers/gpu/drm/drm_bridge.c
··· 50 50 * Chaining multiple bridges to the output of a bridge, or the same bridge to 51 51 * the output of different bridges, is not supported. 52 52 * 53 + * &drm_bridge, like &drm_panel, aren't &drm_mode_object entities like planes, 54 + * CRTCs, encoders or connectors and hence are not visible to userspace. They 55 + * just provide additional hooks to get the desired output at the end of the 56 + * encoder chain. 57 + */ 58 + 59 + /** 60 + * DOC: display driver integration 61 + * 53 62 * Display drivers are responsible for linking encoders with the first bridge 54 63 * in the chains. This is done by acquiring the appropriate bridge with 55 64 * devm_drm_of_get_bridge(). Once acquired, the bridge shall be attached to the ··· 93 84 * helper to create the &drm_connector, or implement it manually on top of the 94 85 * connector-related operations exposed by the bridge (see the overview 95 86 * documentation of bridge operations for more details). 96 - * 97 - * &drm_bridge, like &drm_panel, aren't &drm_mode_object entities like planes, 98 - * CRTCs, encoders or connectors and hence are not visible to userspace. They 99 - * just provide additional hooks to get the desired output at the end of the 100 - * encoder chain. 101 87 */ 102 88 103 89 static DEFINE_MUTEX(bridge_lock);