diff options
| author | Boris Brezillon <boris.brezillon@collabora.com> | 2020-02-18 18:15:03 +0300 |
|---|---|---|
| committer | Neil Armstrong <narmstrong@baylibre.com> | 2020-02-18 18:50:45 +0300 |
| commit | 91ea83306bfa1fb0784ca09e55886a58345e0323 (patch) | |
| tree | b3cc0c85a0df749f0d1bf93df2b1ba93fcf1c630 /include | |
| parent | 97452907ec60cbaa2d1eea87f6d2d85e34f371a1 (diff) | |
| download | linux-91ea83306bfa1fb0784ca09e55886a58345e0323.tar.xz | |
drm/bridge: Fix the bridge kernel doc
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
Diffstat (limited to 'include')
| -rw-r--r-- | include/drm/drm_atomic.h | 2 | ||||
| -rw-r--r-- | include/drm/drm_bridge.h | 15 |
2 files changed, 9 insertions, 8 deletions
diff --git a/include/drm/drm_atomic.h b/include/drm/drm_atomic.h index 52d65a055491..7b6cb4774e7d 100644 --- a/include/drm/drm_atomic.h +++ b/include/drm/drm_atomic.h @@ -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; diff --git a/include/drm/drm_bridge.h b/include/drm/drm_bridge.h index 45626ecf20f8..999faaaab9a1 100644 --- a/include/drm/drm_bridge.h +++ b/include/drm/drm_bridge.h @@ -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: |