1199e4e96SDaniel Vetter /*
2199e4e96SDaniel Vetter * Copyright (c) 2016 Intel Corporation
3199e4e96SDaniel Vetter *
4199e4e96SDaniel Vetter * Permission to use, copy, modify, distribute, and sell this software and its
5199e4e96SDaniel Vetter * documentation for any purpose is hereby granted without fee, provided that
6199e4e96SDaniel Vetter * the above copyright notice appear in all copies and that both that copyright
7199e4e96SDaniel Vetter * notice and this permission notice appear in supporting documentation, and
8199e4e96SDaniel Vetter * that the name of the copyright holders not be used in advertising or
9199e4e96SDaniel Vetter * publicity pertaining to distribution of the software without specific,
10199e4e96SDaniel Vetter * written prior permission. The copyright holders make no representations
11199e4e96SDaniel Vetter * about the suitability of this software for any purpose. It is provided "as
12199e4e96SDaniel Vetter * is" without express or implied warranty.
13199e4e96SDaniel Vetter *
14199e4e96SDaniel Vetter * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
15199e4e96SDaniel Vetter * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
16199e4e96SDaniel Vetter * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
17199e4e96SDaniel Vetter * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
18199e4e96SDaniel Vetter * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
19199e4e96SDaniel Vetter * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
20199e4e96SDaniel Vetter * OF THIS SOFTWARE.
21199e4e96SDaniel Vetter */
22199e4e96SDaniel Vetter
23199e4e96SDaniel Vetter #ifndef __DRM_BRIDGE_H__
24199e4e96SDaniel Vetter #define __DRM_BRIDGE_H__
25199e4e96SDaniel Vetter
26199e4e96SDaniel Vetter #include <linux/ctype.h>
2711f6c4b1SLaurent Pinchart #include <linux/list.h>
2811f6c4b1SLaurent Pinchart #include <linux/mutex.h>
2975146591SBoris Brezillon
3075146591SBoris Brezillon #include <drm/drm_atomic.h>
3135a61fe9SBoris Brezillon #include <drm/drm_encoder.h>
32199e4e96SDaniel Vetter #include <drm/drm_mode_object.h>
33199e4e96SDaniel Vetter #include <drm/drm_modes.h>
34199e4e96SDaniel Vetter
35199e4e96SDaniel Vetter struct drm_bridge;
3636a776dfSLinus Walleij struct drm_bridge_timings;
3711f6c4b1SLaurent Pinchart struct drm_connector;
3812c683e1SLaurent Pinchart struct drm_display_info;
398e4bb53cSTomi Valkeinen struct drm_minor;
4013dfc054SEric Anholt struct drm_panel;
4111f6c4b1SLaurent Pinchart struct edid;
4211f6c4b1SLaurent Pinchart struct i2c_adapter;
43199e4e96SDaniel Vetter
44199e4e96SDaniel Vetter /**
45a25b988fSLaurent Pinchart * enum drm_bridge_attach_flags - Flags for &drm_bridge_funcs.attach
46a25b988fSLaurent Pinchart */
47a25b988fSLaurent Pinchart enum drm_bridge_attach_flags {
48a25b988fSLaurent Pinchart /**
49a25b988fSLaurent Pinchart * @DRM_BRIDGE_ATTACH_NO_CONNECTOR: When this flag is set the bridge
50a25b988fSLaurent Pinchart * shall not create a drm_connector.
51a25b988fSLaurent Pinchart */
52a25b988fSLaurent Pinchart DRM_BRIDGE_ATTACH_NO_CONNECTOR = BIT(0),
53a25b988fSLaurent Pinchart };
54a25b988fSLaurent Pinchart
55a25b988fSLaurent Pinchart /**
56199e4e96SDaniel Vetter * struct drm_bridge_funcs - drm_bridge control functions
57199e4e96SDaniel Vetter */
58199e4e96SDaniel Vetter struct drm_bridge_funcs {
59199e4e96SDaniel Vetter /**
60199e4e96SDaniel Vetter * @attach:
61199e4e96SDaniel Vetter *
62199e4e96SDaniel Vetter * This callback is invoked whenever our bridge is being attached to a
63a25b988fSLaurent Pinchart * &drm_encoder. The flags argument tunes the behaviour of the attach
64a25b988fSLaurent Pinchart * operation (see DRM_BRIDGE_ATTACH_*).
65199e4e96SDaniel Vetter *
66fe9e557dSLaurent Pinchart * The @attach callback is optional.
67199e4e96SDaniel Vetter *
68199e4e96SDaniel Vetter * RETURNS:
69199e4e96SDaniel Vetter *
70199e4e96SDaniel Vetter * Zero on success, error code on failure.
71199e4e96SDaniel Vetter */
72a25b988fSLaurent Pinchart int (*attach)(struct drm_bridge *bridge,
73a25b988fSLaurent Pinchart enum drm_bridge_attach_flags flags);
74199e4e96SDaniel Vetter
75199e4e96SDaniel Vetter /**
76199e4e96SDaniel Vetter * @detach:
77199e4e96SDaniel Vetter *
78199e4e96SDaniel Vetter * This callback is invoked whenever our bridge is being detached from a
79199e4e96SDaniel Vetter * &drm_encoder.
80199e4e96SDaniel Vetter *
81fe9e557dSLaurent Pinchart * The @detach callback is optional.
82199e4e96SDaniel Vetter */
83199e4e96SDaniel Vetter void (*detach)(struct drm_bridge *bridge);
84199e4e96SDaniel Vetter
85199e4e96SDaniel Vetter /**
863eb220a5SJose Abreu * @mode_valid:
873eb220a5SJose Abreu *
883eb220a5SJose Abreu * This callback is used to check if a specific mode is valid in this
893eb220a5SJose Abreu * bridge. This should be implemented if the bridge has some sort of
903eb220a5SJose Abreu * restriction in the modes it can display. For example, a given bridge
913eb220a5SJose Abreu * may be responsible to set a clock value. If the clock can not
923eb220a5SJose Abreu * produce all the values for the available modes then this callback
933eb220a5SJose Abreu * can be used to restrict the number of modes to only the ones that
943eb220a5SJose Abreu * can be displayed.
953eb220a5SJose Abreu *
963eb220a5SJose Abreu * This hook is used by the probe helpers to filter the mode list in
973eb220a5SJose Abreu * drm_helper_probe_single_connector_modes(), and it is used by the
983eb220a5SJose Abreu * atomic helpers to validate modes supplied by userspace in
993eb220a5SJose Abreu * drm_atomic_helper_check_modeset().
1003eb220a5SJose Abreu *
101fe9e557dSLaurent Pinchart * The @mode_valid callback is optional.
1023eb220a5SJose Abreu *
1033eb220a5SJose Abreu * NOTE:
1043eb220a5SJose Abreu *
1053eb220a5SJose Abreu * Since this function is both called from the check phase of an atomic
1063eb220a5SJose Abreu * commit, and the mode validation in the probe paths it is not allowed
1073eb220a5SJose Abreu * to look at anything else but the passed-in mode, and validate it
1083eb220a5SJose Abreu * against configuration-invariant hardward constraints. Any further
1093eb220a5SJose Abreu * limits which depend upon the configuration can only be checked in
1103eb220a5SJose Abreu * @mode_fixup.
1113eb220a5SJose Abreu *
1123eb220a5SJose Abreu * RETURNS:
1133eb220a5SJose Abreu *
1143eb220a5SJose Abreu * drm_mode_status Enum
1153eb220a5SJose Abreu */
116312924d3SLinus Walleij enum drm_mode_status (*mode_valid)(struct drm_bridge *bridge,
11712c683e1SLaurent Pinchart const struct drm_display_info *info,
1183eb220a5SJose Abreu const struct drm_display_mode *mode);
1193eb220a5SJose Abreu
1203eb220a5SJose Abreu /**
121199e4e96SDaniel Vetter * @mode_fixup:
122199e4e96SDaniel Vetter *
1235d435b46SPhilippe Cornu * This callback is used to validate and adjust a mode. The parameter
124199e4e96SDaniel Vetter * mode is the display mode that should be fed to the next element in
125199e4e96SDaniel Vetter * the display chain, either the final &drm_connector or the next
126199e4e96SDaniel Vetter * &drm_bridge. The parameter adjusted_mode is the input mode the bridge
127199e4e96SDaniel Vetter * requires. It can be modified by this callback and does not need to
1289de5d4a6SDaniel Vetter * match mode. See also &drm_crtc_state.adjusted_mode for more details.
129199e4e96SDaniel Vetter *
130199e4e96SDaniel Vetter * This is the only hook that allows a bridge to reject a modeset. If
131199e4e96SDaniel Vetter * this function passes all other callbacks must succeed for this
132199e4e96SDaniel Vetter * configuration.
133199e4e96SDaniel Vetter *
1345061b8a9SBoris Brezillon * The mode_fixup callback is optional. &drm_bridge_funcs.mode_fixup()
1355061b8a9SBoris Brezillon * is not called when &drm_bridge_funcs.atomic_check() is implemented,
1365061b8a9SBoris Brezillon * so only one of them should be provided.
137199e4e96SDaniel Vetter *
138199e4e96SDaniel Vetter * NOTE:
139199e4e96SDaniel Vetter *
140199e4e96SDaniel Vetter * This function is called in the check phase of atomic modesets, which
141199e4e96SDaniel Vetter * can be aborted for any reason (including on userspace's request to
142199e4e96SDaniel Vetter * just check whether a configuration would be possible). Drivers MUST
143199e4e96SDaniel Vetter * NOT touch any persistent state (hardware or software) or data
144199e4e96SDaniel Vetter * structures except the passed in @state parameter.
145199e4e96SDaniel Vetter *
1463eb220a5SJose Abreu * Also beware that userspace can request its own custom modes, neither
1473eb220a5SJose Abreu * core nor helpers filter modes to the list of probe modes reported by
1483eb220a5SJose Abreu * the GETCONNECTOR IOCTL and stored in &drm_connector.modes. To ensure
1493eb220a5SJose Abreu * that modes are filtered consistently put any bridge constraints and
1503eb220a5SJose Abreu * limits checks into @mode_valid.
1513eb220a5SJose Abreu *
152199e4e96SDaniel Vetter * RETURNS:
153199e4e96SDaniel Vetter *
154199e4e96SDaniel Vetter * True if an acceptable configuration is possible, false if the modeset
155199e4e96SDaniel Vetter * operation should be rejected.
156199e4e96SDaniel Vetter */
157199e4e96SDaniel Vetter bool (*mode_fixup)(struct drm_bridge *bridge,
158199e4e96SDaniel Vetter const struct drm_display_mode *mode,
159199e4e96SDaniel Vetter struct drm_display_mode *adjusted_mode);
160199e4e96SDaniel Vetter /**
161199e4e96SDaniel Vetter * @disable:
162199e4e96SDaniel Vetter *
163199e4e96SDaniel Vetter * This callback should disable the bridge. It is called right before
164199e4e96SDaniel Vetter * the preceding element in the display pipe is disabled. If the
165199e4e96SDaniel Vetter * preceding element is a bridge this means it's called before that
1664541d31eSDaniel Vetter * bridge's @disable vfunc. If the preceding element is a &drm_encoder
1674541d31eSDaniel Vetter * it's called right before the &drm_encoder_helper_funcs.disable,
1684541d31eSDaniel Vetter * &drm_encoder_helper_funcs.prepare or &drm_encoder_helper_funcs.dpms
1694541d31eSDaniel Vetter * hook.
170199e4e96SDaniel Vetter *
171199e4e96SDaniel Vetter * The bridge can assume that the display pipe (i.e. clocks and timing
172199e4e96SDaniel Vetter * signals) feeding it is still running when this callback is called.
173199e4e96SDaniel Vetter *
174fe9e557dSLaurent Pinchart * The @disable callback is optional.
1753667bbd7SSam Ravnborg *
1763667bbd7SSam Ravnborg * NOTE:
1773667bbd7SSam Ravnborg *
1783667bbd7SSam Ravnborg * This is deprecated, do not use!
1793667bbd7SSam Ravnborg * New drivers shall use &drm_bridge_funcs.atomic_disable.
180199e4e96SDaniel Vetter */
181199e4e96SDaniel Vetter void (*disable)(struct drm_bridge *bridge);
182199e4e96SDaniel Vetter
183199e4e96SDaniel Vetter /**
184199e4e96SDaniel Vetter * @post_disable:
185199e4e96SDaniel Vetter *
1864541d31eSDaniel Vetter * This callback should disable the bridge. It is called right after the
1874541d31eSDaniel Vetter * preceding element in the display pipe is disabled. If the preceding
1884541d31eSDaniel Vetter * element is a bridge this means it's called after that bridge's
1894541d31eSDaniel Vetter * @post_disable function. If the preceding element is a &drm_encoder
1904541d31eSDaniel Vetter * it's called right after the encoder's
1914541d31eSDaniel Vetter * &drm_encoder_helper_funcs.disable, &drm_encoder_helper_funcs.prepare
1924541d31eSDaniel Vetter * or &drm_encoder_helper_funcs.dpms hook.
193199e4e96SDaniel Vetter *
194199e4e96SDaniel Vetter * The bridge must assume that the display pipe (i.e. clocks and timing
195c111350dSDario Binacchi * signals) feeding it is no longer running when this callback is
196199e4e96SDaniel Vetter * called.
197199e4e96SDaniel Vetter *
198fe9e557dSLaurent Pinchart * The @post_disable callback is optional.
1993667bbd7SSam Ravnborg *
2003667bbd7SSam Ravnborg * NOTE:
2013667bbd7SSam Ravnborg *
2023667bbd7SSam Ravnborg * This is deprecated, do not use!
2033667bbd7SSam Ravnborg * New drivers shall use &drm_bridge_funcs.atomic_post_disable.
204199e4e96SDaniel Vetter */
205199e4e96SDaniel Vetter void (*post_disable)(struct drm_bridge *bridge);
206199e4e96SDaniel Vetter
207199e4e96SDaniel Vetter /**
208199e4e96SDaniel Vetter * @mode_set:
209199e4e96SDaniel Vetter *
210199e4e96SDaniel Vetter * This callback should set the given mode on the bridge. It is called
2114541d31eSDaniel Vetter * after the @mode_set callback for the preceding element in the display
2124541d31eSDaniel Vetter * pipeline has been called already. If the bridge is the first element
2134541d31eSDaniel Vetter * then this would be &drm_encoder_helper_funcs.mode_set. The display
2144541d31eSDaniel Vetter * pipe (i.e. clocks and timing signals) is off when this function is
2154541d31eSDaniel Vetter * called.
216584a0146SPhilippe Cornu *
217584a0146SPhilippe Cornu * The adjusted_mode parameter is the mode output by the CRTC for the
218584a0146SPhilippe Cornu * first bridge in the chain. It can be different from the mode
219584a0146SPhilippe Cornu * parameter that contains the desired mode for the connector at the end
220584a0146SPhilippe Cornu * of the bridges chain, for instance when the first bridge in the chain
221584a0146SPhilippe Cornu * performs scaling. The adjusted mode is mostly useful for the first
222584a0146SPhilippe Cornu * bridge in the chain and is likely irrelevant for the other bridges.
223584a0146SPhilippe Cornu *
224584a0146SPhilippe Cornu * For atomic drivers the adjusted_mode is the mode stored in
225584a0146SPhilippe Cornu * &drm_crtc_state.adjusted_mode.
226584a0146SPhilippe Cornu *
227584a0146SPhilippe Cornu * NOTE:
228584a0146SPhilippe Cornu *
2293667bbd7SSam Ravnborg * This is deprecated, do not use!
2303667bbd7SSam Ravnborg * New drivers shall set their mode in the
2313667bbd7SSam Ravnborg * &drm_bridge_funcs.atomic_enable operation.
232199e4e96SDaniel Vetter */
233199e4e96SDaniel Vetter void (*mode_set)(struct drm_bridge *bridge,
23463f8f3baSLaurent Pinchart const struct drm_display_mode *mode,
23563f8f3baSLaurent Pinchart const struct drm_display_mode *adjusted_mode);
236199e4e96SDaniel Vetter /**
237199e4e96SDaniel Vetter * @pre_enable:
238199e4e96SDaniel Vetter *
239199e4e96SDaniel Vetter * This callback should enable the bridge. It is called right before
240199e4e96SDaniel Vetter * the preceding element in the display pipe is enabled. If the
241199e4e96SDaniel Vetter * preceding element is a bridge this means it's called before that
2424541d31eSDaniel Vetter * bridge's @pre_enable function. If the preceding element is a
2434541d31eSDaniel Vetter * &drm_encoder it's called right before the encoder's
2444541d31eSDaniel Vetter * &drm_encoder_helper_funcs.enable, &drm_encoder_helper_funcs.commit or
2454541d31eSDaniel Vetter * &drm_encoder_helper_funcs.dpms hook.
246199e4e96SDaniel Vetter *
247199e4e96SDaniel Vetter * The display pipe (i.e. clocks and timing signals) feeding this bridge
248199e4e96SDaniel Vetter * will not yet be running when this callback is called. The bridge must
249199e4e96SDaniel Vetter * not enable the display link feeding the next bridge in the chain (if
250199e4e96SDaniel Vetter * there is one) when this callback is called.
251199e4e96SDaniel Vetter *
252fe9e557dSLaurent Pinchart * The @pre_enable callback is optional.
2533667bbd7SSam Ravnborg *
2543667bbd7SSam Ravnborg * NOTE:
2553667bbd7SSam Ravnborg *
2563667bbd7SSam Ravnborg * This is deprecated, do not use!
2573667bbd7SSam Ravnborg * New drivers shall use &drm_bridge_funcs.atomic_pre_enable.
258199e4e96SDaniel Vetter */
259199e4e96SDaniel Vetter void (*pre_enable)(struct drm_bridge *bridge);
260199e4e96SDaniel Vetter
261199e4e96SDaniel Vetter /**
262199e4e96SDaniel Vetter * @enable:
263199e4e96SDaniel Vetter *
264199e4e96SDaniel Vetter * This callback should enable the bridge. It is called right after
265199e4e96SDaniel Vetter * the preceding element in the display pipe is enabled. If the
266199e4e96SDaniel Vetter * preceding element is a bridge this means it's called after that
2674541d31eSDaniel Vetter * bridge's @enable function. If the preceding element is a
2684541d31eSDaniel Vetter * &drm_encoder it's called right after the encoder's
2694541d31eSDaniel Vetter * &drm_encoder_helper_funcs.enable, &drm_encoder_helper_funcs.commit or
2704541d31eSDaniel Vetter * &drm_encoder_helper_funcs.dpms hook.
271199e4e96SDaniel Vetter *
272199e4e96SDaniel Vetter * The bridge can assume that the display pipe (i.e. clocks and timing
273199e4e96SDaniel Vetter * signals) feeding it is running when this callback is called. This
274199e4e96SDaniel Vetter * callback must enable the display link feeding the next bridge in the
275199e4e96SDaniel Vetter * chain if there is one.
276199e4e96SDaniel Vetter *
277fe9e557dSLaurent Pinchart * The @enable callback is optional.
2783667bbd7SSam Ravnborg *
2793667bbd7SSam Ravnborg * NOTE:
2803667bbd7SSam Ravnborg *
2813667bbd7SSam Ravnborg * This is deprecated, do not use!
2823667bbd7SSam Ravnborg * New drivers shall use &drm_bridge_funcs.atomic_enable.
283199e4e96SDaniel Vetter */
284199e4e96SDaniel Vetter void (*enable)(struct drm_bridge *bridge);
2855ade071bSSean Paul
2865ade071bSSean Paul /**
2875ade071bSSean Paul * @atomic_pre_enable:
2885ade071bSSean Paul *
2895ade071bSSean Paul * This callback should enable the bridge. It is called right before
2905ade071bSSean Paul * the preceding element in the display pipe is enabled. If the
2915ade071bSSean Paul * preceding element is a bridge this means it's called before that
2925ade071bSSean Paul * bridge's @atomic_pre_enable or @pre_enable function. If the preceding
2935ade071bSSean Paul * element is a &drm_encoder it's called right before the encoder's
2945ade071bSSean Paul * &drm_encoder_helper_funcs.atomic_enable hook.
2955ade071bSSean Paul *
2965ade071bSSean Paul * The display pipe (i.e. clocks and timing signals) feeding this bridge
2975ade071bSSean Paul * will not yet be running when this callback is called. The bridge must
2985ade071bSSean Paul * not enable the display link feeding the next bridge in the chain (if
2995ade071bSSean Paul * there is one) when this callback is called.
3005ade071bSSean Paul *
3015ade071bSSean Paul * The @atomic_pre_enable callback is optional.
3025ade071bSSean Paul */
3035ade071bSSean Paul void (*atomic_pre_enable)(struct drm_bridge *bridge,
30441cf5712SBoris Brezillon struct drm_bridge_state *old_bridge_state);
3055ade071bSSean Paul
3065ade071bSSean Paul /**
3075ade071bSSean Paul * @atomic_enable:
3085ade071bSSean Paul *
3095ade071bSSean Paul * This callback should enable the bridge. It is called right after
3105ade071bSSean Paul * the preceding element in the display pipe is enabled. If the
3115ade071bSSean Paul * preceding element is a bridge this means it's called after that
3125ade071bSSean Paul * bridge's @atomic_enable or @enable function. If the preceding element
3135ade071bSSean Paul * is a &drm_encoder it's called right after the encoder's
3145ade071bSSean Paul * &drm_encoder_helper_funcs.atomic_enable hook.
3155ade071bSSean Paul *
3165ade071bSSean Paul * The bridge can assume that the display pipe (i.e. clocks and timing
3175ade071bSSean Paul * signals) feeding it is running when this callback is called. This
3185ade071bSSean Paul * callback must enable the display link feeding the next bridge in the
3195ade071bSSean Paul * chain if there is one.
3205ade071bSSean Paul *
321fe9e557dSLaurent Pinchart * The @atomic_enable callback is optional.
3225ade071bSSean Paul */
3235ade071bSSean Paul void (*atomic_enable)(struct drm_bridge *bridge,
32441cf5712SBoris Brezillon struct drm_bridge_state *old_bridge_state);
3255ade071bSSean Paul /**
3265ade071bSSean Paul * @atomic_disable:
3275ade071bSSean Paul *
3285ade071bSSean Paul * This callback should disable the bridge. It is called right before
3295ade071bSSean Paul * the preceding element in the display pipe is disabled. If the
3305ade071bSSean Paul * preceding element is a bridge this means it's called before that
3315ade071bSSean Paul * bridge's @atomic_disable or @disable vfunc. If the preceding element
3325ade071bSSean Paul * is a &drm_encoder it's called right before the
3335ade071bSSean Paul * &drm_encoder_helper_funcs.atomic_disable hook.
3345ade071bSSean Paul *
3355ade071bSSean Paul * The bridge can assume that the display pipe (i.e. clocks and timing
3365ade071bSSean Paul * signals) feeding it is still running when this callback is called.
3375ade071bSSean Paul *
338fe9e557dSLaurent Pinchart * The @atomic_disable callback is optional.
3395ade071bSSean Paul */
3405ade071bSSean Paul void (*atomic_disable)(struct drm_bridge *bridge,
34141cf5712SBoris Brezillon struct drm_bridge_state *old_bridge_state);
3425ade071bSSean Paul
3435ade071bSSean Paul /**
3445ade071bSSean Paul * @atomic_post_disable:
3455ade071bSSean Paul *
3465ade071bSSean Paul * This callback should disable the bridge. It is called right after the
3475ade071bSSean Paul * preceding element in the display pipe is disabled. If the preceding
3485ade071bSSean Paul * element is a bridge this means it's called after that bridge's
3495ade071bSSean Paul * @atomic_post_disable or @post_disable function. If the preceding
3505ade071bSSean Paul * element is a &drm_encoder it's called right after the encoder's
3515ade071bSSean Paul * &drm_encoder_helper_funcs.atomic_disable hook.
3525ade071bSSean Paul *
3535ade071bSSean Paul * The bridge must assume that the display pipe (i.e. clocks and timing
3545ade071bSSean Paul * signals) feeding it is no longer running when this callback is
3555ade071bSSean Paul * called.
3565ade071bSSean Paul *
357fe9e557dSLaurent Pinchart * The @atomic_post_disable callback is optional.
3585ade071bSSean Paul */
3595ade071bSSean Paul void (*atomic_post_disable)(struct drm_bridge *bridge,
36041cf5712SBoris Brezillon struct drm_bridge_state *old_bridge_state);
36175146591SBoris Brezillon
36275146591SBoris Brezillon /**
36375146591SBoris Brezillon * @atomic_duplicate_state:
36475146591SBoris Brezillon *
36575146591SBoris Brezillon * Duplicate the current bridge state object (which is guaranteed to be
36675146591SBoris Brezillon * non-NULL).
36775146591SBoris Brezillon *
368282f713cSLaurent Pinchart * The atomic_duplicate_state hook is mandatory if the bridge
369282f713cSLaurent Pinchart * implements any of the atomic hooks, and should be left unassigned
370282f713cSLaurent Pinchart * otherwise. For bridges that don't subclass &drm_bridge_state, the
371282f713cSLaurent Pinchart * drm_atomic_helper_bridge_duplicate_state() helper function shall be
372282f713cSLaurent Pinchart * used to implement this hook.
37375146591SBoris Brezillon *
37475146591SBoris Brezillon * RETURNS:
37575146591SBoris Brezillon * A valid drm_bridge_state object or NULL if the allocation fails.
37675146591SBoris Brezillon */
37775146591SBoris Brezillon struct drm_bridge_state *(*atomic_duplicate_state)(struct drm_bridge *bridge);
37875146591SBoris Brezillon
37975146591SBoris Brezillon /**
38075146591SBoris Brezillon * @atomic_destroy_state:
38175146591SBoris Brezillon *
38275146591SBoris Brezillon * Destroy a bridge state object previously allocated by
38375146591SBoris Brezillon * &drm_bridge_funcs.atomic_duplicate_state().
38475146591SBoris Brezillon *
385282f713cSLaurent Pinchart * The atomic_destroy_state hook is mandatory if the bridge implements
386282f713cSLaurent Pinchart * any of the atomic hooks, and should be left unassigned otherwise.
387282f713cSLaurent Pinchart * For bridges that don't subclass &drm_bridge_state, the
388282f713cSLaurent Pinchart * drm_atomic_helper_bridge_destroy_state() helper function shall be
389282f713cSLaurent Pinchart * used to implement this hook.
39075146591SBoris Brezillon */
39175146591SBoris Brezillon void (*atomic_destroy_state)(struct drm_bridge *bridge,
39275146591SBoris Brezillon struct drm_bridge_state *state);
39375146591SBoris Brezillon
39475146591SBoris Brezillon /**
395f32df58aSBoris Brezillon * @atomic_get_output_bus_fmts:
396f32df58aSBoris Brezillon *
397f32df58aSBoris Brezillon * Return the supported bus formats on the output end of a bridge.
398f32df58aSBoris Brezillon * The returned array must be allocated with kmalloc() and will be
399f32df58aSBoris Brezillon * freed by the caller. If the allocation fails, NULL should be
400f32df58aSBoris Brezillon * returned. num_output_fmts must be set to the returned array size.
401f32df58aSBoris Brezillon * Formats listed in the returned array should be listed in decreasing
402f32df58aSBoris Brezillon * preference order (the core will try all formats until it finds one
403f32df58aSBoris Brezillon * that works).
404f32df58aSBoris Brezillon *
405f32df58aSBoris Brezillon * This method is only called on the last element of the bridge chain
406f32df58aSBoris Brezillon * as part of the bus format negotiation process that happens in
407f32df58aSBoris Brezillon * &drm_atomic_bridge_chain_select_bus_fmts().
408f32df58aSBoris Brezillon * This method is optional. When not implemented, the core will
409f32df58aSBoris Brezillon * fall back to &drm_connector.display_info.bus_formats[0] if
410f32df58aSBoris Brezillon * &drm_connector.display_info.num_bus_formats > 0,
411f32df58aSBoris Brezillon * or to MEDIA_BUS_FMT_FIXED otherwise.
412f32df58aSBoris Brezillon */
413f32df58aSBoris Brezillon u32 *(*atomic_get_output_bus_fmts)(struct drm_bridge *bridge,
414f32df58aSBoris Brezillon struct drm_bridge_state *bridge_state,
415f32df58aSBoris Brezillon struct drm_crtc_state *crtc_state,
416f32df58aSBoris Brezillon struct drm_connector_state *conn_state,
417f32df58aSBoris Brezillon unsigned int *num_output_fmts);
418f32df58aSBoris Brezillon
419f32df58aSBoris Brezillon /**
420f32df58aSBoris Brezillon * @atomic_get_input_bus_fmts:
421f32df58aSBoris Brezillon *
422f32df58aSBoris Brezillon * Return the supported bus formats on the input end of a bridge for
423f32df58aSBoris Brezillon * a specific output bus format.
424f32df58aSBoris Brezillon *
425f32df58aSBoris Brezillon * The returned array must be allocated with kmalloc() and will be
426f32df58aSBoris Brezillon * freed by the caller. If the allocation fails, NULL should be
4270d3c9333SLiu Ying * returned. num_input_fmts must be set to the returned array size.
428f32df58aSBoris Brezillon * Formats listed in the returned array should be listed in decreasing
429f32df58aSBoris Brezillon * preference order (the core will try all formats until it finds one
430f32df58aSBoris Brezillon * that works). When the format is not supported NULL should be
4310d3c9333SLiu Ying * returned and num_input_fmts should be set to 0.
432f32df58aSBoris Brezillon *
433f32df58aSBoris Brezillon * This method is called on all elements of the bridge chain as part of
434f32df58aSBoris Brezillon * the bus format negotiation process that happens in
43591ea8330SBoris Brezillon * drm_atomic_bridge_chain_select_bus_fmts().
436f32df58aSBoris Brezillon * This method is optional. When not implemented, the core will bypass
437f32df58aSBoris Brezillon * bus format negotiation on this element of the bridge without
438f32df58aSBoris Brezillon * failing, and the previous element in the chain will be passed
439f32df58aSBoris Brezillon * MEDIA_BUS_FMT_FIXED as its output bus format.
440f32df58aSBoris Brezillon *
441f32df58aSBoris Brezillon * Bridge drivers that need to support being linked to bridges that are
442f32df58aSBoris Brezillon * not supporting bus format negotiation should handle the
443f32df58aSBoris Brezillon * output_fmt == MEDIA_BUS_FMT_FIXED case appropriately, by selecting a
444f32df58aSBoris Brezillon * sensible default value or extracting this information from somewhere
445f32df58aSBoris Brezillon * else (FW property, &drm_display_mode, &drm_display_info, ...)
446f32df58aSBoris Brezillon *
447f32df58aSBoris Brezillon * Note: Even if input format selection on the first bridge has no
448f32df58aSBoris Brezillon * impact on the negotiation process (bus format negotiation stops once
449f32df58aSBoris Brezillon * we reach the first element of the chain), drivers are expected to
450f32df58aSBoris Brezillon * return accurate input formats as the input format may be used to
451f32df58aSBoris Brezillon * configure the CRTC output appropriately.
452f32df58aSBoris Brezillon */
453f32df58aSBoris Brezillon u32 *(*atomic_get_input_bus_fmts)(struct drm_bridge *bridge,
454f32df58aSBoris Brezillon struct drm_bridge_state *bridge_state,
455f32df58aSBoris Brezillon struct drm_crtc_state *crtc_state,
456f32df58aSBoris Brezillon struct drm_connector_state *conn_state,
457f32df58aSBoris Brezillon u32 output_fmt,
458f32df58aSBoris Brezillon unsigned int *num_input_fmts);
459f32df58aSBoris Brezillon
460f32df58aSBoris Brezillon /**
4615061b8a9SBoris Brezillon * @atomic_check:
4625061b8a9SBoris Brezillon *
4635061b8a9SBoris Brezillon * This method is responsible for checking bridge state correctness.
4645061b8a9SBoris Brezillon * It can also check the state of the surrounding components in chain
4655061b8a9SBoris Brezillon * to make sure the whole pipeline can work properly.
4665061b8a9SBoris Brezillon *
4675061b8a9SBoris Brezillon * &drm_bridge_funcs.atomic_check() hooks are called in reverse
4685061b8a9SBoris Brezillon * order (from the last to the first bridge).
4695061b8a9SBoris Brezillon *
4705061b8a9SBoris Brezillon * This method is optional. &drm_bridge_funcs.mode_fixup() is not
4715061b8a9SBoris Brezillon * called when &drm_bridge_funcs.atomic_check() is implemented, so only
4725061b8a9SBoris Brezillon * one of them should be provided.
4735061b8a9SBoris Brezillon *
474f32df58aSBoris Brezillon * If drivers need to tweak &drm_bridge_state.input_bus_cfg.flags or
47519d97fd6SRandy Dunlap * &drm_bridge_state.output_bus_cfg.flags it should happen in
476f32df58aSBoris Brezillon * this function. By default the &drm_bridge_state.output_bus_cfg.flags
477f32df58aSBoris Brezillon * field is set to the next bridge
478f32df58aSBoris Brezillon * &drm_bridge_state.input_bus_cfg.flags value or
479f32df58aSBoris Brezillon * &drm_connector.display_info.bus_flags if the bridge is the last
480f32df58aSBoris Brezillon * element in the chain.
481f32df58aSBoris Brezillon *
4825061b8a9SBoris Brezillon * RETURNS:
4835061b8a9SBoris Brezillon * zero if the check passed, a negative error code otherwise.
4845061b8a9SBoris Brezillon */
4855061b8a9SBoris Brezillon int (*atomic_check)(struct drm_bridge *bridge,
4865061b8a9SBoris Brezillon struct drm_bridge_state *bridge_state,
4875061b8a9SBoris Brezillon struct drm_crtc_state *crtc_state,
4885061b8a9SBoris Brezillon struct drm_connector_state *conn_state);
4895061b8a9SBoris Brezillon
4905061b8a9SBoris Brezillon /**
49175146591SBoris Brezillon * @atomic_reset:
49275146591SBoris Brezillon *
49375146591SBoris Brezillon * Reset the bridge to a predefined state (or retrieve its current
49475146591SBoris Brezillon * state) and return a &drm_bridge_state object matching this state.
49575146591SBoris Brezillon * This function is called at attach time.
49675146591SBoris Brezillon *
49775146591SBoris Brezillon * The atomic_reset hook is mandatory if the bridge implements any of
498282f713cSLaurent Pinchart * the atomic hooks, and should be left unassigned otherwise. For
499282f713cSLaurent Pinchart * bridges that don't subclass &drm_bridge_state, the
500282f713cSLaurent Pinchart * drm_atomic_helper_bridge_reset() helper function shall be used to
501282f713cSLaurent Pinchart * implement this hook.
50275146591SBoris Brezillon *
50375146591SBoris Brezillon * Note that the atomic_reset() semantics is not exactly matching the
50475146591SBoris Brezillon * reset() semantics found on other components (connector, plane, ...).
50591ea8330SBoris Brezillon *
50691ea8330SBoris Brezillon * 1. The reset operation happens when the bridge is attached, not when
50775146591SBoris Brezillon * drm_mode_config_reset() is called
50891ea8330SBoris Brezillon * 2. It's meant to be used exclusively on bridges that have been
50975146591SBoris Brezillon * converted to the ATOMIC API
51075146591SBoris Brezillon *
51175146591SBoris Brezillon * RETURNS:
51275146591SBoris Brezillon * A valid drm_bridge_state object in case of success, an ERR_PTR()
51375146591SBoris Brezillon * giving the reason of the failure otherwise.
51475146591SBoris Brezillon */
51575146591SBoris Brezillon struct drm_bridge_state *(*atomic_reset)(struct drm_bridge *bridge);
51611f6c4b1SLaurent Pinchart
51711f6c4b1SLaurent Pinchart /**
51811f6c4b1SLaurent Pinchart * @detect:
51911f6c4b1SLaurent Pinchart *
52011f6c4b1SLaurent Pinchart * Check if anything is attached to the bridge output.
52111f6c4b1SLaurent Pinchart *
52211f6c4b1SLaurent Pinchart * This callback is optional, if not implemented the bridge will be
52311f6c4b1SLaurent Pinchart * considered as always having a component attached to its output.
52411f6c4b1SLaurent Pinchart * Bridges that implement this callback shall set the
52511f6c4b1SLaurent Pinchart * DRM_BRIDGE_OP_DETECT flag in their &drm_bridge->ops.
52611f6c4b1SLaurent Pinchart *
52711f6c4b1SLaurent Pinchart * RETURNS:
52811f6c4b1SLaurent Pinchart *
52911f6c4b1SLaurent Pinchart * drm_connector_status indicating the bridge output status.
53011f6c4b1SLaurent Pinchart */
53111f6c4b1SLaurent Pinchart enum drm_connector_status (*detect)(struct drm_bridge *bridge);
53211f6c4b1SLaurent Pinchart
53311f6c4b1SLaurent Pinchart /**
53411f6c4b1SLaurent Pinchart * @get_modes:
53511f6c4b1SLaurent Pinchart *
53611f6c4b1SLaurent Pinchart * Fill all modes currently valid for the sink into the &drm_connector
53711f6c4b1SLaurent Pinchart * with drm_mode_probed_add().
53811f6c4b1SLaurent Pinchart *
53911f6c4b1SLaurent Pinchart * The @get_modes callback is mostly intended to support non-probeable
54011f6c4b1SLaurent Pinchart * displays such as many fixed panels. Bridges that support reading
54111f6c4b1SLaurent Pinchart * EDID shall leave @get_modes unimplemented and implement the
54211f6c4b1SLaurent Pinchart * &drm_bridge_funcs->get_edid callback instead.
54311f6c4b1SLaurent Pinchart *
54411f6c4b1SLaurent Pinchart * This callback is optional. Bridges that implement it shall set the
54511f6c4b1SLaurent Pinchart * DRM_BRIDGE_OP_MODES flag in their &drm_bridge->ops.
54611f6c4b1SLaurent Pinchart *
54711f6c4b1SLaurent Pinchart * The connector parameter shall be used for the sole purpose of
54811f6c4b1SLaurent Pinchart * filling modes, and shall not be stored internally by bridge drivers
54911f6c4b1SLaurent Pinchart * for future usage.
55011f6c4b1SLaurent Pinchart *
55111f6c4b1SLaurent Pinchart * RETURNS:
55211f6c4b1SLaurent Pinchart *
55311f6c4b1SLaurent Pinchart * The number of modes added by calling drm_mode_probed_add().
55411f6c4b1SLaurent Pinchart */
55511f6c4b1SLaurent Pinchart int (*get_modes)(struct drm_bridge *bridge,
55611f6c4b1SLaurent Pinchart struct drm_connector *connector);
55711f6c4b1SLaurent Pinchart
55811f6c4b1SLaurent Pinchart /**
5592b6aaf7bSJani Nikula * @edid_read:
5602b6aaf7bSJani Nikula *
5612b6aaf7bSJani Nikula * Read the EDID data of the connected display.
5622b6aaf7bSJani Nikula *
5632b6aaf7bSJani Nikula * The @edid_read callback is the preferred way of reporting mode
5642b6aaf7bSJani Nikula * information for a display connected to the bridge output. Bridges
5652b6aaf7bSJani Nikula * that support reading EDID shall implement this callback and leave
5662b6aaf7bSJani Nikula * the @get_modes callback unimplemented.
5672b6aaf7bSJani Nikula *
5682b6aaf7bSJani Nikula * The caller of this operation shall first verify the output
5692b6aaf7bSJani Nikula * connection status and refrain from reading EDID from a disconnected
5702b6aaf7bSJani Nikula * output.
5712b6aaf7bSJani Nikula *
5722b6aaf7bSJani Nikula * This callback is optional. Bridges that implement it shall set the
5732b6aaf7bSJani Nikula * DRM_BRIDGE_OP_EDID flag in their &drm_bridge->ops.
5742b6aaf7bSJani Nikula *
5752b6aaf7bSJani Nikula * The connector parameter shall be used for the sole purpose of EDID
5762b6aaf7bSJani Nikula * retrieval, and shall not be stored internally by bridge drivers for
5772b6aaf7bSJani Nikula * future usage.
5782b6aaf7bSJani Nikula *
5792b6aaf7bSJani Nikula * RETURNS:
5802b6aaf7bSJani Nikula *
5812b6aaf7bSJani Nikula * An edid structure newly allocated with drm_edid_alloc() or returned
5822b6aaf7bSJani Nikula * from drm_edid_read() family of functions on success, or NULL
5832b6aaf7bSJani Nikula * otherwise. The caller is responsible for freeing the returned edid
5842b6aaf7bSJani Nikula * structure with drm_edid_free().
5852b6aaf7bSJani Nikula */
5862b6aaf7bSJani Nikula const struct drm_edid *(*edid_read)(struct drm_bridge *bridge,
5872b6aaf7bSJani Nikula struct drm_connector *connector);
5882b6aaf7bSJani Nikula
5892b6aaf7bSJani Nikula /**
59011f6c4b1SLaurent Pinchart * @get_edid:
59111f6c4b1SLaurent Pinchart *
59211f6c4b1SLaurent Pinchart * Read and parse the EDID data of the connected display.
59311f6c4b1SLaurent Pinchart *
59411f6c4b1SLaurent Pinchart * The @get_edid callback is the preferred way of reporting mode
59511f6c4b1SLaurent Pinchart * information for a display connected to the bridge output. Bridges
59611f6c4b1SLaurent Pinchart * that support reading EDID shall implement this callback and leave
59711f6c4b1SLaurent Pinchart * the @get_modes callback unimplemented.
59811f6c4b1SLaurent Pinchart *
59911f6c4b1SLaurent Pinchart * The caller of this operation shall first verify the output
60011f6c4b1SLaurent Pinchart * connection status and refrain from reading EDID from a disconnected
60111f6c4b1SLaurent Pinchart * output.
60211f6c4b1SLaurent Pinchart *
60311f6c4b1SLaurent Pinchart * This callback is optional. Bridges that implement it shall set the
60411f6c4b1SLaurent Pinchart * DRM_BRIDGE_OP_EDID flag in their &drm_bridge->ops.
60511f6c4b1SLaurent Pinchart *
60611f6c4b1SLaurent Pinchart * The connector parameter shall be used for the sole purpose of EDID
60711f6c4b1SLaurent Pinchart * retrieval and parsing, and shall not be stored internally by bridge
60811f6c4b1SLaurent Pinchart * drivers for future usage.
60911f6c4b1SLaurent Pinchart *
61011f6c4b1SLaurent Pinchart * RETURNS:
61111f6c4b1SLaurent Pinchart *
61211f6c4b1SLaurent Pinchart * An edid structure newly allocated with kmalloc() (or similar) on
61311f6c4b1SLaurent Pinchart * success, or NULL otherwise. The caller is responsible for freeing
61411f6c4b1SLaurent Pinchart * the returned edid structure with kfree().
61511f6c4b1SLaurent Pinchart */
61611f6c4b1SLaurent Pinchart struct edid *(*get_edid)(struct drm_bridge *bridge,
61711f6c4b1SLaurent Pinchart struct drm_connector *connector);
61811f6c4b1SLaurent Pinchart
61911f6c4b1SLaurent Pinchart /**
62011f6c4b1SLaurent Pinchart * @hpd_notify:
62111f6c4b1SLaurent Pinchart *
62211f6c4b1SLaurent Pinchart * Notify the bridge of hot plug detection.
62311f6c4b1SLaurent Pinchart *
62411f6c4b1SLaurent Pinchart * This callback is optional, it may be implemented by bridges that
62511f6c4b1SLaurent Pinchart * need to be notified of display connection or disconnection for
62611f6c4b1SLaurent Pinchart * internal reasons. One use case is to reset the internal state of CEC
62711f6c4b1SLaurent Pinchart * controllers for HDMI bridges.
62811f6c4b1SLaurent Pinchart */
62911f6c4b1SLaurent Pinchart void (*hpd_notify)(struct drm_bridge *bridge,
63011f6c4b1SLaurent Pinchart enum drm_connector_status status);
63111f6c4b1SLaurent Pinchart
63211f6c4b1SLaurent Pinchart /**
63311f6c4b1SLaurent Pinchart * @hpd_enable:
63411f6c4b1SLaurent Pinchart *
63511f6c4b1SLaurent Pinchart * Enable hot plug detection. From now on the bridge shall call
63611f6c4b1SLaurent Pinchart * drm_bridge_hpd_notify() each time a change is detected in the output
63711f6c4b1SLaurent Pinchart * connection status, until hot plug detection gets disabled with
63811f6c4b1SLaurent Pinchart * @hpd_disable.
63911f6c4b1SLaurent Pinchart *
64011f6c4b1SLaurent Pinchart * This callback is optional and shall only be implemented by bridges
64111f6c4b1SLaurent Pinchart * that support hot-plug notification without polling. Bridges that
64211f6c4b1SLaurent Pinchart * implement it shall also implement the @hpd_disable callback and set
64311f6c4b1SLaurent Pinchart * the DRM_BRIDGE_OP_HPD flag in their &drm_bridge->ops.
64411f6c4b1SLaurent Pinchart */
64511f6c4b1SLaurent Pinchart void (*hpd_enable)(struct drm_bridge *bridge);
64611f6c4b1SLaurent Pinchart
64711f6c4b1SLaurent Pinchart /**
64811f6c4b1SLaurent Pinchart * @hpd_disable:
64911f6c4b1SLaurent Pinchart *
65011f6c4b1SLaurent Pinchart * Disable hot plug detection. Once this function returns the bridge
65111f6c4b1SLaurent Pinchart * shall not call drm_bridge_hpd_notify() when a change in the output
65211f6c4b1SLaurent Pinchart * connection status occurs.
65311f6c4b1SLaurent Pinchart *
65411f6c4b1SLaurent Pinchart * This callback is optional and shall only be implemented by bridges
65511f6c4b1SLaurent Pinchart * that support hot-plug notification without polling. Bridges that
65611f6c4b1SLaurent Pinchart * implement it shall also implement the @hpd_enable callback and set
65711f6c4b1SLaurent Pinchart * the DRM_BRIDGE_OP_HPD flag in their &drm_bridge->ops.
65811f6c4b1SLaurent Pinchart */
65911f6c4b1SLaurent Pinchart void (*hpd_disable)(struct drm_bridge *bridge);
6602509969aSDouglas Anderson
6612509969aSDouglas Anderson /**
6622509969aSDouglas Anderson * @debugfs_init:
6632509969aSDouglas Anderson *
6642509969aSDouglas Anderson * Allows bridges to create bridge-specific debugfs files.
6652509969aSDouglas Anderson */
6662509969aSDouglas Anderson void (*debugfs_init)(struct drm_bridge *bridge, struct dentry *root);
667199e4e96SDaniel Vetter };
668199e4e96SDaniel Vetter
669199e4e96SDaniel Vetter /**
67036a776dfSLinus Walleij * struct drm_bridge_timings - timing information for the bridge
67136a776dfSLinus Walleij */
67236a776dfSLinus Walleij struct drm_bridge_timings {
67336a776dfSLinus Walleij /**
674d23286ffSStefan Agner * @input_bus_flags:
67536a776dfSLinus Walleij *
676d23286ffSStefan Agner * Tells what additional settings for the pixel data on the bus
677d23286ffSStefan Agner * this bridge requires (like pixel signal polarity). See also
678d23286ffSStefan Agner * &drm_display_info->bus_flags.
67936a776dfSLinus Walleij */
680d23286ffSStefan Agner u32 input_bus_flags;
68136a776dfSLinus Walleij /**
68236a776dfSLinus Walleij * @setup_time_ps:
68336a776dfSLinus Walleij *
68436a776dfSLinus Walleij * Defines the time in picoseconds the input data lines must be
68536a776dfSLinus Walleij * stable before the clock edge.
68636a776dfSLinus Walleij */
68736a776dfSLinus Walleij u32 setup_time_ps;
68836a776dfSLinus Walleij /**
68936a776dfSLinus Walleij * @hold_time_ps:
69036a776dfSLinus Walleij *
69136a776dfSLinus Walleij * Defines the time in picoseconds taken for the bridge to sample the
69236a776dfSLinus Walleij * input signal after the clock edge.
69336a776dfSLinus Walleij */
69436a776dfSLinus Walleij u32 hold_time_ps;
695b0a6b940SLaurent Pinchart /**
696b0a6b940SLaurent Pinchart * @dual_link:
697b0a6b940SLaurent Pinchart *
698b0a6b940SLaurent Pinchart * True if the bus operates in dual-link mode. The exact meaning is
699b0a6b940SLaurent Pinchart * dependent on the bus type. For LVDS buses, this indicates that even-
700b0a6b940SLaurent Pinchart * and odd-numbered pixels are received on separate links.
701b0a6b940SLaurent Pinchart */
702b0a6b940SLaurent Pinchart bool dual_link;
70336a776dfSLinus Walleij };
70436a776dfSLinus Walleij
70536a776dfSLinus Walleij /**
70611f6c4b1SLaurent Pinchart * enum drm_bridge_ops - Bitmask of operations supported by the bridge
70711f6c4b1SLaurent Pinchart */
70811f6c4b1SLaurent Pinchart enum drm_bridge_ops {
70911f6c4b1SLaurent Pinchart /**
71011f6c4b1SLaurent Pinchart * @DRM_BRIDGE_OP_DETECT: The bridge can detect displays connected to
71111f6c4b1SLaurent Pinchart * its output. Bridges that set this flag shall implement the
71211f6c4b1SLaurent Pinchart * &drm_bridge_funcs->detect callback.
71311f6c4b1SLaurent Pinchart */
71411f6c4b1SLaurent Pinchart DRM_BRIDGE_OP_DETECT = BIT(0),
71511f6c4b1SLaurent Pinchart /**
71611f6c4b1SLaurent Pinchart * @DRM_BRIDGE_OP_EDID: The bridge can retrieve the EDID of the display
71711f6c4b1SLaurent Pinchart * connected to its output. Bridges that set this flag shall implement
71811f6c4b1SLaurent Pinchart * the &drm_bridge_funcs->get_edid callback.
71911f6c4b1SLaurent Pinchart */
72011f6c4b1SLaurent Pinchart DRM_BRIDGE_OP_EDID = BIT(1),
72111f6c4b1SLaurent Pinchart /**
72211f6c4b1SLaurent Pinchart * @DRM_BRIDGE_OP_HPD: The bridge can detect hot-plug and hot-unplug
72311f6c4b1SLaurent Pinchart * without requiring polling. Bridges that set this flag shall
72411f6c4b1SLaurent Pinchart * implement the &drm_bridge_funcs->hpd_enable and
72511f6c4b1SLaurent Pinchart * &drm_bridge_funcs->hpd_disable callbacks if they support enabling
72611f6c4b1SLaurent Pinchart * and disabling hot-plug detection dynamically.
72711f6c4b1SLaurent Pinchart */
72811f6c4b1SLaurent Pinchart DRM_BRIDGE_OP_HPD = BIT(2),
72911f6c4b1SLaurent Pinchart /**
73011f6c4b1SLaurent Pinchart * @DRM_BRIDGE_OP_MODES: The bridge can retrieve the modes supported
73111f6c4b1SLaurent Pinchart * by the display at its output. This does not include reading EDID
73211f6c4b1SLaurent Pinchart * which is separately covered by @DRM_BRIDGE_OP_EDID. Bridges that set
73311f6c4b1SLaurent Pinchart * this flag shall implement the &drm_bridge_funcs->get_modes callback.
73411f6c4b1SLaurent Pinchart */
73511f6c4b1SLaurent Pinchart DRM_BRIDGE_OP_MODES = BIT(3),
73611f6c4b1SLaurent Pinchart };
73711f6c4b1SLaurent Pinchart
73811f6c4b1SLaurent Pinchart /**
739199e4e96SDaniel Vetter * struct drm_bridge - central DRM bridge control structure
740199e4e96SDaniel Vetter */
741199e4e96SDaniel Vetter struct drm_bridge {
74275146591SBoris Brezillon /** @base: inherit from &drm_private_object */
74375146591SBoris Brezillon struct drm_private_obj base;
7446aa13402SEric Anholt /** @dev: DRM device this bridge belongs to */
745199e4e96SDaniel Vetter struct drm_device *dev;
7466aa13402SEric Anholt /** @encoder: encoder to which this bridge is connected */
747199e4e96SDaniel Vetter struct drm_encoder *encoder;
74805193dc3SBoris Brezillon /** @chain_node: used to form a bridge chain */
74905193dc3SBoris Brezillon struct list_head chain_node;
750199e4e96SDaniel Vetter #ifdef CONFIG_OF
7516aa13402SEric Anholt /** @of_node: device node pointer to the bridge */
752199e4e96SDaniel Vetter struct device_node *of_node;
753199e4e96SDaniel Vetter #endif
7546aa13402SEric Anholt /** @list: to keep track of all added bridges */
755199e4e96SDaniel Vetter struct list_head list;
7566aa13402SEric Anholt /**
7576aa13402SEric Anholt * @timings:
7586aa13402SEric Anholt *
7596aa13402SEric Anholt * the timing specification for the bridge, if any (may be NULL)
7606aa13402SEric Anholt */
76136a776dfSLinus Walleij const struct drm_bridge_timings *timings;
7626aa13402SEric Anholt /** @funcs: control functions */
763199e4e96SDaniel Vetter const struct drm_bridge_funcs *funcs;
7646aa13402SEric Anholt /** @driver_private: pointer to the bridge driver's internal context */
765199e4e96SDaniel Vetter void *driver_private;
76611f6c4b1SLaurent Pinchart /** @ops: bitmask of operations supported by the bridge */
76711f6c4b1SLaurent Pinchart enum drm_bridge_ops ops;
76811f6c4b1SLaurent Pinchart /**
76911f6c4b1SLaurent Pinchart * @type: Type of the connection at the bridge output
77011f6c4b1SLaurent Pinchart * (DRM_MODE_CONNECTOR_*). For bridges at the end of this chain this
77111f6c4b1SLaurent Pinchart * identifies the type of connected display.
77211f6c4b1SLaurent Pinchart */
77311f6c4b1SLaurent Pinchart int type;
77411f6c4b1SLaurent Pinchart /**
77564d05ff7SLaurent Pinchart * @interlace_allowed: Indicate that the bridge can handle interlaced
77664d05ff7SLaurent Pinchart * modes.
77764d05ff7SLaurent Pinchart */
77864d05ff7SLaurent Pinchart bool interlace_allowed;
77964d05ff7SLaurent Pinchart /**
7804fb912e5SDave Stevenson * @pre_enable_prev_first: The bridge requires that the prev
7814fb912e5SDave Stevenson * bridge @pre_enable function is called before its @pre_enable,
7824fb912e5SDave Stevenson * and conversely for post_disable. This is most frequently a
7834fb912e5SDave Stevenson * requirement for DSI devices which need the host to be initialised
7844fb912e5SDave Stevenson * before the peripheral.
7854fb912e5SDave Stevenson */
7864fb912e5SDave Stevenson bool pre_enable_prev_first;
7874fb912e5SDave Stevenson /**
78811f6c4b1SLaurent Pinchart * @ddc: Associated I2C adapter for DDC access, if any.
78911f6c4b1SLaurent Pinchart */
79011f6c4b1SLaurent Pinchart struct i2c_adapter *ddc;
79111f6c4b1SLaurent Pinchart /** private: */
79211f6c4b1SLaurent Pinchart /**
79311f6c4b1SLaurent Pinchart * @hpd_mutex: Protects the @hpd_cb and @hpd_data fields.
79411f6c4b1SLaurent Pinchart */
79511f6c4b1SLaurent Pinchart struct mutex hpd_mutex;
79611f6c4b1SLaurent Pinchart /**
79711f6c4b1SLaurent Pinchart * @hpd_cb: Hot plug detection callback, registered with
79811f6c4b1SLaurent Pinchart * drm_bridge_hpd_enable().
79911f6c4b1SLaurent Pinchart */
80011f6c4b1SLaurent Pinchart void (*hpd_cb)(void *data, enum drm_connector_status status);
80111f6c4b1SLaurent Pinchart /**
80211f6c4b1SLaurent Pinchart * @hpd_data: Private data passed to the Hot plug detection callback
80311f6c4b1SLaurent Pinchart * @hpd_cb.
80411f6c4b1SLaurent Pinchart */
80511f6c4b1SLaurent Pinchart void *hpd_data;
806199e4e96SDaniel Vetter };
807199e4e96SDaniel Vetter
80875146591SBoris Brezillon static inline struct drm_bridge *
drm_priv_to_bridge(struct drm_private_obj * priv)80975146591SBoris Brezillon drm_priv_to_bridge(struct drm_private_obj *priv)
81075146591SBoris Brezillon {
81175146591SBoris Brezillon return container_of(priv, struct drm_bridge, base);
81275146591SBoris Brezillon }
81375146591SBoris Brezillon
81499286884SInki Dae void drm_bridge_add(struct drm_bridge *bridge);
81550e156bdSDouglas Anderson int devm_drm_bridge_add(struct device *dev, struct drm_bridge *bridge);
816199e4e96SDaniel Vetter void drm_bridge_remove(struct drm_bridge *bridge);
8173bb80f24SLaurent Pinchart int drm_bridge_attach(struct drm_encoder *encoder, struct drm_bridge *bridge,
818a25b988fSLaurent Pinchart struct drm_bridge *previous,
819a25b988fSLaurent Pinchart enum drm_bridge_attach_flags flags);
820199e4e96SDaniel Vetter
821b3ed524fSChristian König #ifdef CONFIG_OF
822b3ed524fSChristian König struct drm_bridge *of_drm_find_bridge(struct device_node *np);
823b3ed524fSChristian König #else
of_drm_find_bridge(struct device_node * np)824b3ed524fSChristian König static inline struct drm_bridge *of_drm_find_bridge(struct device_node *np)
825b3ed524fSChristian König {
826b3ed524fSChristian König return NULL;
827b3ed524fSChristian König }
828b3ed524fSChristian König #endif
829b3ed524fSChristian König
830fadf872dSBoris Brezillon /**
831fadf872dSBoris Brezillon * drm_bridge_get_next_bridge() - Get the next bridge in the chain
832fadf872dSBoris Brezillon * @bridge: bridge object
833fadf872dSBoris Brezillon *
834fadf872dSBoris Brezillon * RETURNS:
835fadf872dSBoris Brezillon * the next bridge in the chain after @bridge, or NULL if @bridge is the last.
836fadf872dSBoris Brezillon */
837fadf872dSBoris Brezillon static inline struct drm_bridge *
drm_bridge_get_next_bridge(struct drm_bridge * bridge)838fadf872dSBoris Brezillon drm_bridge_get_next_bridge(struct drm_bridge *bridge)
839fadf872dSBoris Brezillon {
84005193dc3SBoris Brezillon if (list_is_last(&bridge->chain_node, &bridge->encoder->bridge_chain))
84105193dc3SBoris Brezillon return NULL;
84205193dc3SBoris Brezillon
84305193dc3SBoris Brezillon return list_next_entry(bridge, chain_node);
844fadf872dSBoris Brezillon }
845fadf872dSBoris Brezillon
84635a61fe9SBoris Brezillon /**
847ac877c64SBoris Brezillon * drm_bridge_get_prev_bridge() - Get the previous bridge in the chain
848ac877c64SBoris Brezillon * @bridge: bridge object
849ac877c64SBoris Brezillon *
850ac877c64SBoris Brezillon * RETURNS:
851ac877c64SBoris Brezillon * the previous bridge in the chain, or NULL if @bridge is the first.
852ac877c64SBoris Brezillon */
853ac877c64SBoris Brezillon static inline struct drm_bridge *
drm_bridge_get_prev_bridge(struct drm_bridge * bridge)854ac877c64SBoris Brezillon drm_bridge_get_prev_bridge(struct drm_bridge *bridge)
855ac877c64SBoris Brezillon {
856ac877c64SBoris Brezillon if (list_is_first(&bridge->chain_node, &bridge->encoder->bridge_chain))
857ac877c64SBoris Brezillon return NULL;
858ac877c64SBoris Brezillon
859ac877c64SBoris Brezillon return list_prev_entry(bridge, chain_node);
860ac877c64SBoris Brezillon }
861ac877c64SBoris Brezillon
862ac877c64SBoris Brezillon /**
86335a61fe9SBoris Brezillon * drm_bridge_chain_get_first_bridge() - Get the first bridge in the chain
86435a61fe9SBoris Brezillon * @encoder: encoder object
86535a61fe9SBoris Brezillon *
86635a61fe9SBoris Brezillon * RETURNS:
86735a61fe9SBoris Brezillon * the first bridge in the chain, or NULL if @encoder has no bridge attached
86835a61fe9SBoris Brezillon * to it.
86935a61fe9SBoris Brezillon */
87035a61fe9SBoris Brezillon static inline struct drm_bridge *
drm_bridge_chain_get_first_bridge(struct drm_encoder * encoder)87135a61fe9SBoris Brezillon drm_bridge_chain_get_first_bridge(struct drm_encoder *encoder)
87235a61fe9SBoris Brezillon {
87305193dc3SBoris Brezillon return list_first_entry_or_null(&encoder->bridge_chain,
87405193dc3SBoris Brezillon struct drm_bridge, chain_node);
87535a61fe9SBoris Brezillon }
87635a61fe9SBoris Brezillon
8774ec5c905SBoris Brezillon /**
8784ec5c905SBoris Brezillon * drm_for_each_bridge_in_chain() - Iterate over all bridges present in a chain
8794ec5c905SBoris Brezillon * @encoder: the encoder to iterate bridges on
8804ec5c905SBoris Brezillon * @bridge: a bridge pointer updated to point to the current bridge at each
8814ec5c905SBoris Brezillon * iteration
8824ec5c905SBoris Brezillon *
8834ec5c905SBoris Brezillon * Iterate over all bridges present in the bridge chain attached to @encoder.
8844ec5c905SBoris Brezillon */
8854ec5c905SBoris Brezillon #define drm_for_each_bridge_in_chain(encoder, bridge) \
8864ec5c905SBoris Brezillon list_for_each_entry(bridge, &(encoder)->bridge_chain, chain_node)
8874ec5c905SBoris Brezillon
888ea099adfSBoris Brezillon bool drm_bridge_chain_mode_fixup(struct drm_bridge *bridge,
889199e4e96SDaniel Vetter const struct drm_display_mode *mode,
890199e4e96SDaniel Vetter struct drm_display_mode *adjusted_mode);
891ea099adfSBoris Brezillon enum drm_mode_status
892ea099adfSBoris Brezillon drm_bridge_chain_mode_valid(struct drm_bridge *bridge,
89312c683e1SLaurent Pinchart const struct drm_display_info *info,
894b1240f81SJose Abreu const struct drm_display_mode *mode);
895ea099adfSBoris Brezillon void drm_bridge_chain_mode_set(struct drm_bridge *bridge,
89663f8f3baSLaurent Pinchart const struct drm_display_mode *mode,
89763f8f3baSLaurent Pinchart const struct drm_display_mode *adjusted_mode);
898199e4e96SDaniel Vetter
8995061b8a9SBoris Brezillon int drm_atomic_bridge_chain_check(struct drm_bridge *bridge,
9005061b8a9SBoris Brezillon struct drm_crtc_state *crtc_state,
9015061b8a9SBoris Brezillon struct drm_connector_state *conn_state);
902ea099adfSBoris Brezillon void drm_atomic_bridge_chain_disable(struct drm_bridge *bridge,
9035ade071bSSean Paul struct drm_atomic_state *state);
904ea099adfSBoris Brezillon void drm_atomic_bridge_chain_post_disable(struct drm_bridge *bridge,
9055ade071bSSean Paul struct drm_atomic_state *state);
906ea099adfSBoris Brezillon void drm_atomic_bridge_chain_pre_enable(struct drm_bridge *bridge,
9075ade071bSSean Paul struct drm_atomic_state *state);
908ea099adfSBoris Brezillon void drm_atomic_bridge_chain_enable(struct drm_bridge *bridge,
9095ade071bSSean Paul struct drm_atomic_state *state);
9105ade071bSSean Paul
911f32df58aSBoris Brezillon u32 *
912f32df58aSBoris Brezillon drm_atomic_helper_bridge_propagate_bus_fmt(struct drm_bridge *bridge,
913f32df58aSBoris Brezillon struct drm_bridge_state *bridge_state,
914f32df58aSBoris Brezillon struct drm_crtc_state *crtc_state,
915f32df58aSBoris Brezillon struct drm_connector_state *conn_state,
916f32df58aSBoris Brezillon u32 output_fmt,
917f32df58aSBoris Brezillon unsigned int *num_input_fmts);
918f32df58aSBoris Brezillon
91911f6c4b1SLaurent Pinchart enum drm_connector_status drm_bridge_detect(struct drm_bridge *bridge);
92011f6c4b1SLaurent Pinchart int drm_bridge_get_modes(struct drm_bridge *bridge,
92111f6c4b1SLaurent Pinchart struct drm_connector *connector);
9222b6aaf7bSJani Nikula const struct drm_edid *drm_bridge_edid_read(struct drm_bridge *bridge,
9232b6aaf7bSJani Nikula struct drm_connector *connector);
92411f6c4b1SLaurent Pinchart struct edid *drm_bridge_get_edid(struct drm_bridge *bridge,
92511f6c4b1SLaurent Pinchart struct drm_connector *connector);
92611f6c4b1SLaurent Pinchart void drm_bridge_hpd_enable(struct drm_bridge *bridge,
92711f6c4b1SLaurent Pinchart void (*cb)(void *data,
92811f6c4b1SLaurent Pinchart enum drm_connector_status status),
92911f6c4b1SLaurent Pinchart void *data);
93011f6c4b1SLaurent Pinchart void drm_bridge_hpd_disable(struct drm_bridge *bridge);
93111f6c4b1SLaurent Pinchart void drm_bridge_hpd_notify(struct drm_bridge *bridge,
93211f6c4b1SLaurent Pinchart enum drm_connector_status status);
93311f6c4b1SLaurent Pinchart
93413dfc054SEric Anholt #ifdef CONFIG_DRM_PANEL_BRIDGE
93515b9ca16SHsin-Yi Wang bool drm_bridge_is_panel(const struct drm_bridge *bridge);
93689958b7cSLaurent Pinchart struct drm_bridge *drm_panel_bridge_add(struct drm_panel *panel);
93789958b7cSLaurent Pinchart struct drm_bridge *drm_panel_bridge_add_typed(struct drm_panel *panel,
93813dfc054SEric Anholt u32 connector_type);
93913dfc054SEric Anholt void drm_panel_bridge_remove(struct drm_bridge *bridge);
94015b9ca16SHsin-Yi Wang int drm_panel_bridge_set_orientation(struct drm_connector *connector,
94115b9ca16SHsin-Yi Wang struct drm_bridge *bridge);
94267022227SEric Anholt struct drm_bridge *devm_drm_panel_bridge_add(struct device *dev,
94389958b7cSLaurent Pinchart struct drm_panel *panel);
94489958b7cSLaurent Pinchart struct drm_bridge *devm_drm_panel_bridge_add_typed(struct device *dev,
94567022227SEric Anholt struct drm_panel *panel,
94667022227SEric Anholt u32 connector_type);
947abea75e9SMaxime Ripard struct drm_bridge *drmm_panel_bridge_add(struct drm_device *drm,
948abea75e9SMaxime Ripard struct drm_panel *panel);
94959050d78SMaxime Ripard struct drm_connector *drm_panel_bridge_connector(struct drm_bridge *bridge);
95015b9ca16SHsin-Yi Wang #else
drm_bridge_is_panel(const struct drm_bridge * bridge)95115b9ca16SHsin-Yi Wang static inline bool drm_bridge_is_panel(const struct drm_bridge *bridge)
95215b9ca16SHsin-Yi Wang {
95315b9ca16SHsin-Yi Wang return false;
95415b9ca16SHsin-Yi Wang }
95515b9ca16SHsin-Yi Wang
drm_panel_bridge_set_orientation(struct drm_connector * connector,struct drm_bridge * bridge)95615b9ca16SHsin-Yi Wang static inline int drm_panel_bridge_set_orientation(struct drm_connector *connector,
95715b9ca16SHsin-Yi Wang struct drm_bridge *bridge)
95815b9ca16SHsin-Yi Wang {
95915b9ca16SHsin-Yi Wang return -EINVAL;
96015b9ca16SHsin-Yi Wang }
96159050d78SMaxime Ripard #endif
96259050d78SMaxime Ripard
96359050d78SMaxime Ripard #if defined(CONFIG_OF) && defined(CONFIG_DRM_PANEL_BRIDGE)
96487ea9580SMaxime Ripard struct drm_bridge *devm_drm_of_get_bridge(struct device *dev, struct device_node *node,
96587ea9580SMaxime Ripard u32 port, u32 endpoint);
966ae9f1f2cSMaxime Ripard struct drm_bridge *drmm_of_get_bridge(struct drm_device *drm, struct device_node *node,
967ae9f1f2cSMaxime Ripard u32 port, u32 endpoint);
96859050d78SMaxime Ripard #else
devm_drm_of_get_bridge(struct device * dev,struct device_node * node,u32 port,u32 endpoint)96959050d78SMaxime Ripard static inline struct drm_bridge *devm_drm_of_get_bridge(struct device *dev,
97059050d78SMaxime Ripard struct device_node *node,
97159050d78SMaxime Ripard u32 port,
97259050d78SMaxime Ripard u32 endpoint)
97359050d78SMaxime Ripard {
97459050d78SMaxime Ripard return ERR_PTR(-ENODEV);
97559050d78SMaxime Ripard }
976ac991b87SWang Jingjin
drmm_of_get_bridge(struct drm_device * drm,struct device_node * node,u32 port,u32 endpoint)977ac991b87SWang Jingjin static inline struct drm_bridge *drmm_of_get_bridge(struct drm_device *drm,
978ac991b87SWang Jingjin struct device_node *node,
979ac991b87SWang Jingjin u32 port,
980ac991b87SWang Jingjin u32 endpoint)
981ac991b87SWang Jingjin {
982ac991b87SWang Jingjin return ERR_PTR(-ENODEV);
983ac991b87SWang Jingjin }
98413dfc054SEric Anholt #endif
98513dfc054SEric Anholt
9868e4bb53cSTomi Valkeinen void drm_bridge_debugfs_init(struct drm_minor *minor);
9878e4bb53cSTomi Valkeinen
988199e4e96SDaniel Vetter #endif
989