Skip to content

Commit 91ea833

Browse files
bbrezillonsuperna9999
authored andcommitted
drm/bridge: Fix the bridge kernel doc
Commit 7514659 ("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: 7514659 ("drm/bridge: Add a drm_bridge_state object") Signed-off-by: Boris Brezillon <[email protected]> Reviewed-by: Neil Armstrong <[email protected]> Signed-off-by: Neil Armstrong <[email protected]> Link: https://patchwork.freedesktop.org/patch/msgid/[email protected]
1 parent 9745290 commit 91ea833

File tree

3 files changed

+12
-10
lines changed

3 files changed

+12
-10
lines changed

drivers/gpu/drm/drm_atomic.c

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1098,8 +1098,9 @@ EXPORT_SYMBOL(drm_atomic_get_new_bridge_state);
10981098
*
10991099
* This function adds all bridges attached to @encoder. This is needed to add
11001100
* bridge states to @state and make them available when
1101-
* &bridge_funcs.atomic_{check,pre_enable,enable,disable_post_disable}() are
1102-
* called
1101+
* &drm_bridge_funcs.atomic_check(), &drm_bridge_funcs.atomic_pre_enable(),
1102+
* &drm_bridge_funcs.atomic_enable(),
1103+
* &drm_bridge_funcs.atomic_disable_post_disable() are called.
11031104
*
11041105
* Returns:
11051106
* 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK

include/drm/drm_atomic.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1016,7 +1016,7 @@ struct drm_bus_cfg {
10161016
* @format: format used on this bus (one of the MEDIA_BUS_FMT_* format)
10171017
*
10181018
* This field should not be directly modified by drivers
1019-
* (&drm_atomic_bridge_chain_select_bus_fmts() takes care of the bus
1019+
* (drm_atomic_bridge_chain_select_bus_fmts() takes care of the bus
10201020
* format negotiation).
10211021
*/
10221022
u32 format;

include/drm/drm_bridge.h

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -349,9 +349,9 @@ struct drm_bridge_funcs {
349349
* Duplicate the current bridge state object (which is guaranteed to be
350350
* non-NULL).
351351
*
352-
* The atomic_duplicate_state() is optional. When not implemented the
353-
* core allocates a drm_bridge_state object and calls
354-
* &__drm_atomic_helper_bridge_duplicate_state() to initialize it.
352+
* The atomic_duplicate_state() hook is optional. When not implemented
353+
* the core allocates a drm_bridge_state object and calls
354+
* __drm_atomic_helper_bridge_duplicate_state() to initialize it.
355355
*
356356
* RETURNS:
357357
* A valid drm_bridge_state object or NULL if the allocation fails.
@@ -407,11 +407,11 @@ struct drm_bridge_funcs {
407407
* Formats listed in the returned array should be listed in decreasing
408408
* preference order (the core will try all formats until it finds one
409409
* that works). When the format is not supported NULL should be
410-
* returned and *num_output_fmts should be set to 0.
410+
* returned and num_output_fmts should be set to 0.
411411
*
412412
* This method is called on all elements of the bridge chain as part of
413413
* the bus format negotiation process that happens in
414-
* &drm_atomic_bridge_chain_select_bus_fmts().
414+
* drm_atomic_bridge_chain_select_bus_fmts().
415415
* This method is optional. When not implemented, the core will bypass
416416
* bus format negotiation on this element of the bridge without
417417
* failing, and the previous element in the chain will be passed
@@ -478,9 +478,10 @@ struct drm_bridge_funcs {
478478
*
479479
* Note that the atomic_reset() semantics is not exactly matching the
480480
* reset() semantics found on other components (connector, plane, ...).
481-
* 1/ The reset operation happens when the bridge is attached, not when
481+
*
482+
* 1. The reset operation happens when the bridge is attached, not when
482483
* drm_mode_config_reset() is called
483-
* 2/ It's meant to be used exclusively on bridges that have been
484+
* 2. It's meant to be used exclusively on bridges that have been
484485
* converted to the ATOMIC API
485486
*
486487
* RETURNS:

0 commit comments

Comments
 (0)