Commit 91ea8330 authored by Boris Brezillon's avatar Boris Brezillon Committed by Neil Armstrong
Browse files

drm/bridge: Fix the bridge kernel doc



Commit 75146591 ("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: 75146591 ("drm/bridge: Add a drm_bridge_state object")
Signed-off-by: default avatarBoris Brezillon <boris.brezillon@collabora.com>
Reviewed-by: default avatarNeil Armstrong <narmstrong@baylibre.com>
Signed-off-by: default avatarNeil Armstrong <narmstrong@baylibre.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20200218151503.595825-1-boris.brezillon@collabora.com
parent 97452907
Loading
Loading
Loading
Loading
+3 −2
Original line number Diff line number Diff line
@@ -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
 * bridge states to @state and make them available when
 * &bridge_funcs.atomic_{check,pre_enable,enable,disable_post_disable}() are
 * called
 * &drm_bridge_funcs.atomic_check(), &drm_bridge_funcs.atomic_pre_enable(),
 * &drm_bridge_funcs.atomic_enable(),
 * &drm_bridge_funcs.atomic_disable_post_disable() are called.
 *
 * Returns:
 * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
+1 −1
Original line number Diff line number Diff line
@@ -1016,7 +1016,7 @@ struct drm_bus_cfg {
	 * @format: format used on this bus (one of the MEDIA_BUS_FMT_* format)
	 *
	 * 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).
	 */
	u32 format;
+8 −7
Original line number Diff line number Diff line
@@ -349,9 +349,9 @@ struct drm_bridge_funcs {
	 * Duplicate the current bridge state object (which is guaranteed to be
	 * non-NULL).
	 *
	 * The atomic_duplicate_state() is optional. When not implemented the
	 * core allocates a drm_bridge_state object and calls
	 * &__drm_atomic_helper_bridge_duplicate_state() to initialize it.
	 * The atomic_duplicate_state() hook is optional. When not implemented
	 * the core allocates a drm_bridge_state object and calls
	 * __drm_atomic_helper_bridge_duplicate_state() to initialize it.
	 *
	 * RETURNS:
	 * 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
	 * preference order (the core will try all formats until it finds one
	 * 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
	 * 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
	 * bus format negotiation on this element of the bridge without
	 * 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
	 * 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
	 * 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
	 *
	 * RETURNS: