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

drm/bridge: Fix the bridge kernel doc

Browse Source 
Commit 751465913f04 ("drm/bridge: Add a drm_bridge_state object")
introduced new helpers and hooks but the kernel was slightly broken.
Fix that now.

v2:
* Fix the drm_atomic_add_encoder_bridges() doc

Fixes: 751465913f04 ("drm/bridge: Add a drm_bridge_state object")
Signed-off-by: Boris Brezillon <boris.brezillon@collabora.com>
Reviewed-by: Neil Armstrong <narmstrong@baylibre.com>
Signed-off-by: Neil Armstrong <narmstrong@baylibre.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20200218151503.595825-1-boris.brezillon@collabora.com
This commit is contained in:
Boris Brezillon 2020-02-18 16:15:03 +01:00 committed by Neil Armstrong
parent 97452907ec
commit 91ea83306b
3 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
drivers/gpu/drm/drm_atomic.c
View File

@ -1098,8 +1098,9 @@ EXPORT_SYMBOL(drm_atomic_get_new_bridge_state);
* *
* This function adds all bridges attached to @encoder. This is needed to add * This function adds all bridges attached to @encoder. This is needed to add
* bridge states to @state and make them available when * bridge states to @state and make them available when
* &bridge_funcs.atomic_{check,pre_enable,enable,disable_post_disable}() are * &drm_bridge_funcs.atomic_check(), &drm_bridge_funcs.atomic_pre_enable(),
* called * &drm_bridge_funcs.atomic_enable(),
* &drm_bridge_funcs.atomic_disable_post_disable() are called.
* *
* Returns: * Returns:
* 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK

2
include/drm/drm_atomic.h
View File

@ -1016,7 +1016,7 @@ struct drm_bus_cfg {
* @format: format used on this bus (one of the MEDIA_BUS_FMT_* format) * @format: format used on this bus (one of the MEDIA_BUS_FMT_* format)
* *
* This field should not be directly modified by drivers * This field should not be directly modified by drivers
* (&drm_atomic_bridge_chain_select_bus_fmts() takes care of the bus * (drm_atomic_bridge_chain_select_bus_fmts() takes care of the bus
* format negotiation). * format negotiation).
*/ */
u32 format; u32 format;

15
include/drm/drm_bridge.h
View File

@ -349,9 +349,9 @@ struct drm_bridge_funcs {
* Duplicate the current bridge state object (which is guaranteed to be * Duplicate the current bridge state object (which is guaranteed to be
* non-NULL). * non-NULL).
* *
* The atomic_duplicate_state() is optional. When not implemented the * The atomic_duplicate_state() hook is optional. When not implemented
* core allocates a drm_bridge_state object and calls * the core allocates a drm_bridge_state object and calls
* &__drm_atomic_helper_bridge_duplicate_state() to initialize it. * __drm_atomic_helper_bridge_duplicate_state() to initialize it.
* *
* RETURNS: * RETURNS:
* A valid drm_bridge_state object or NULL if the allocation fails. * A valid drm_bridge_state object or NULL if the allocation fails.
@ -407,11 +407,11 @@ struct drm_bridge_funcs {
* Formats listed in the returned array should be listed in decreasing * Formats listed in the returned array should be listed in decreasing
* preference order (the core will try all formats until it finds one * preference order (the core will try all formats until it finds one
* that works). When the format is not supported NULL should be * that works). When the format is not supported NULL should be
* returned and *num_output_fmts should be set to 0. * returned and num_output_fmts should be set to 0.
* *
* This method is called on all elements of the bridge chain as part of * This method is called on all elements of the bridge chain as part of
* the bus format negotiation process that happens in * the bus format negotiation process that happens in
* &drm_atomic_bridge_chain_select_bus_fmts(). * drm_atomic_bridge_chain_select_bus_fmts().
* This method is optional. When not implemented, the core will bypass * This method is optional. When not implemented, the core will bypass
* bus format negotiation on this element of the bridge without * bus format negotiation on this element of the bridge without
* failing, and the previous element in the chain will be passed * failing, and the previous element in the chain will be passed
@ -478,9 +478,10 @@ struct drm_bridge_funcs {
* *
* Note that the atomic_reset() semantics is not exactly matching the * Note that the atomic_reset() semantics is not exactly matching the
* reset() semantics found on other components (connector, plane, ...). * reset() semantics found on other components (connector, plane, ...).
* 1/ The reset operation happens when the bridge is attached, not when *
* 1. The reset operation happens when the bridge is attached, not when
* drm_mode_config_reset() is called * drm_mode_config_reset() is called
* 2/ It's meant to be used exclusively on bridges that have been * 2. It's meant to be used exclusively on bridges that have been
* converted to the ATOMIC API * converted to the ATOMIC API
* *
* RETURNS: * RETURNS: