]> asedeno.scripts.mit.edu Git - linux.git/blobdiff - include/drm/drm_bridge.h
Revert "drm/bridge: Add an ->atomic_check() hook"
[linux.git] / include / drm / drm_bridge.h
index c0a2286a81e986565e9cd0271bfa0e5db1bda4d7..52d3ed15061854d9edee456255bb7bb5ae81c922 100644 (file)
@@ -25,6 +25,9 @@
 
 #include <linux/list.h>
 #include <linux/ctype.h>
+
+#include <drm/drm_atomic.h>
+#include <drm/drm_encoder.h>
 #include <drm/drm_mode_object.h>
 #include <drm/drm_modes.h>
 
@@ -32,6 +35,23 @@ struct drm_bridge;
 struct drm_bridge_timings;
 struct drm_panel;
 
+/**
+ * struct drm_bridge_state - Atomic bridge state object
+ * @base: inherit from &drm_private_state
+ * @bridge: the bridge this state refers to
+ */
+struct drm_bridge_state {
+       struct drm_private_state base;
+
+       struct drm_bridge *bridge;
+};
+
+static inline struct drm_bridge_state *
+drm_priv_to_bridge_state(struct drm_private_state *priv)
+{
+       return container_of(priv, struct drm_bridge_state, base);
+}
+
 /**
  * struct drm_bridge_funcs - drm_bridge control functions
  */
@@ -254,14 +274,15 @@ struct drm_bridge_funcs {
         * there is one) when this callback is called.
         *
         * Note that this function will only be invoked in the context of an
-        * atomic commit. It will not be invoked from &drm_bridge_pre_enable. It
-        * would be prudent to also provide an implementation of @pre_enable if
-        * you are expecting driver calls into &drm_bridge_pre_enable.
+        * atomic commit. It will not be invoked from
+        * &drm_bridge_chain_pre_enable. It would be prudent to also provide an
+        * implementation of @pre_enable if you are expecting driver calls into
+        * &drm_bridge_chain_pre_enable.
         *
         * The @atomic_pre_enable callback is optional.
         */
        void (*atomic_pre_enable)(struct drm_bridge *bridge,
-                                 struct drm_atomic_state *state);
+                                 struct drm_bridge_state *old_bridge_state);
 
        /**
         * @atomic_enable:
@@ -279,14 +300,14 @@ struct drm_bridge_funcs {
         * chain if there is one.
         *
         * Note that this function will only be invoked in the context of an
-        * atomic commit. It will not be invoked from &drm_bridge_enable. It
-        * would be prudent to also provide an implementation of @enable if
-        * you are expecting driver calls into &drm_bridge_enable.
+        * atomic commit. It will not be invoked from &drm_bridge_chain_enable.
+        * It would be prudent to also provide an implementation of @enable if
+        * you are expecting driver calls into &drm_bridge_chain_enable.
         *
         * The @atomic_enable callback is optional.
         */
        void (*atomic_enable)(struct drm_bridge *bridge,
-                             struct drm_atomic_state *state);
+                             struct drm_bridge_state *old_bridge_state);
        /**
         * @atomic_disable:
         *
@@ -301,14 +322,15 @@ struct drm_bridge_funcs {
         * signals) feeding it is still running when this callback is called.
         *
         * Note that this function will only be invoked in the context of an
-        * atomic commit. It will not be invoked from &drm_bridge_disable. It
-        * would be prudent to also provide an implementation of @disable if
-        * you are expecting driver calls into &drm_bridge_disable.
+        * atomic commit. It will not be invoked from
+        * &drm_bridge_chain_disable. It would be prudent to also provide an
+        * implementation of @disable if you are expecting driver calls into
+        * &drm_bridge_chain_disable.
         *
         * The @atomic_disable callback is optional.
         */
        void (*atomic_disable)(struct drm_bridge *bridge,
-                              struct drm_atomic_state *state);
+                              struct drm_bridge_state *old_bridge_state);
 
        /**
         * @atomic_post_disable:
@@ -325,15 +347,59 @@ struct drm_bridge_funcs {
         * called.
         *
         * Note that this function will only be invoked in the context of an
-        * atomic commit. It will not be invoked from &drm_bridge_post_disable.
+        * atomic commit. It will not be invoked from
+        * &drm_bridge_chain_post_disable.
         * It would be prudent to also provide an implementation of
         * @post_disable if you are expecting driver calls into
-        * &drm_bridge_post_disable.
+        * &drm_bridge_chain_post_disable.
         *
         * The @atomic_post_disable callback is optional.
         */
        void (*atomic_post_disable)(struct drm_bridge *bridge,
-                                   struct drm_atomic_state *state);
+                                   struct drm_bridge_state *old_bridge_state);
+
+       /**
+        * @atomic_duplicate_state:
+        *
+        * 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.
+        *
+        * RETURNS:
+        * A valid drm_bridge_state object or NULL if the allocation fails.
+        */
+       struct drm_bridge_state *(*atomic_duplicate_state)(struct drm_bridge *bridge);
+
+       /**
+        * @atomic_destroy_state:
+        *
+        * Destroy a bridge state object previously allocated by
+        * &drm_bridge_funcs.atomic_duplicate_state().
+        *
+        * The atomic_destroy_state hook is optional. When not implemented the
+        * core calls kfree() on the state.
+        */
+       void (*atomic_destroy_state)(struct drm_bridge *bridge,
+                                    struct drm_bridge_state *state);
+
+       /**
+        * @atomic_reset:
+        *
+        * Reset the bridge to a predefined state (or retrieve its current
+        * state) and return a &drm_bridge_state object matching this state.
+        * This function is called at attach time.
+        *
+        * The atomic_reset hook is optional. When not implemented the core
+        * allocates a new state and calls &__drm_atomic_helper_bridge_reset().
+        *
+        * RETURNS:
+        * A valid drm_bridge_state object in case of success, an ERR_PTR()
+        * giving the reason of the failure otherwise.
+        */
+       struct drm_bridge_state *(*atomic_reset)(struct drm_bridge *bridge);
 };
 
 /**
@@ -376,12 +442,14 @@ struct drm_bridge_timings {
  * struct drm_bridge - central DRM bridge control structure
  */
 struct drm_bridge {
+       /** @base: inherit from &drm_private_object */
+       struct drm_private_obj base;
        /** @dev: DRM device this bridge belongs to */
        struct drm_device *dev;
        /** @encoder: encoder to which this bridge is connected */
        struct drm_encoder *encoder;
-       /** @next: the next bridge in the encoder chain */
-       struct drm_bridge *next;
+       /** @chain_node: used to form a bridge chain */
+       struct list_head chain_node;
 #ifdef CONFIG_OF
        /** @of_node: device node pointer to the bridge */
        struct device_node *of_node;
@@ -400,33 +468,142 @@ struct drm_bridge {
        void *driver_private;
 };
 
+static inline struct drm_bridge *
+drm_priv_to_bridge(struct drm_private_obj *priv)
+{
+       return container_of(priv, struct drm_bridge, base);
+}
+
 void drm_bridge_add(struct drm_bridge *bridge);
 void drm_bridge_remove(struct drm_bridge *bridge);
 struct drm_bridge *of_drm_find_bridge(struct device_node *np);
 int drm_bridge_attach(struct drm_encoder *encoder, struct drm_bridge *bridge,
                      struct drm_bridge *previous);
 
-bool drm_bridge_mode_fixup(struct drm_bridge *bridge,
-                          const struct drm_display_mode *mode,
-                          struct drm_display_mode *adjusted_mode);
-enum drm_mode_status drm_bridge_mode_valid(struct drm_bridge *bridge,
-                                          const struct drm_display_mode *mode);
-void drm_bridge_disable(struct drm_bridge *bridge);
-void drm_bridge_post_disable(struct drm_bridge *bridge);
-void drm_bridge_mode_set(struct drm_bridge *bridge,
-                        const struct drm_display_mode *mode,
-                        const struct drm_display_mode *adjusted_mode);
-void drm_bridge_pre_enable(struct drm_bridge *bridge);
-void drm_bridge_enable(struct drm_bridge *bridge);
+/**
+ * drm_bridge_get_next_bridge() - Get the next bridge in the chain
+ * @bridge: bridge object
+ *
+ * RETURNS:
+ * the next bridge in the chain after @bridge, or NULL if @bridge is the last.
+ */
+static inline struct drm_bridge *
+drm_bridge_get_next_bridge(struct drm_bridge *bridge)
+{
+       if (list_is_last(&bridge->chain_node, &bridge->encoder->bridge_chain))
+               return NULL;
+
+       return list_next_entry(bridge, chain_node);
+}
+
+/**
+ * drm_bridge_get_prev_bridge() - Get the previous bridge in the chain
+ * @bridge: bridge object
+ *
+ * RETURNS:
+ * the previous bridge in the chain, or NULL if @bridge is the first.
+ */
+static inline struct drm_bridge *
+drm_bridge_get_prev_bridge(struct drm_bridge *bridge)
+{
+       if (list_is_first(&bridge->chain_node, &bridge->encoder->bridge_chain))
+               return NULL;
+
+       return list_prev_entry(bridge, chain_node);
+}
+
+/**
+ * drm_bridge_chain_get_first_bridge() - Get the first bridge in the chain
+ * @encoder: encoder object
+ *
+ * RETURNS:
+ * the first bridge in the chain, or NULL if @encoder has no bridge attached
+ * to it.
+ */
+static inline struct drm_bridge *
+drm_bridge_chain_get_first_bridge(struct drm_encoder *encoder)
+{
+       return list_first_entry_or_null(&encoder->bridge_chain,
+                                       struct drm_bridge, chain_node);
+}
 
-void drm_atomic_bridge_disable(struct drm_bridge *bridge,
-                              struct drm_atomic_state *state);
-void drm_atomic_bridge_post_disable(struct drm_bridge *bridge,
+/**
+ * drm_for_each_bridge_in_chain() - Iterate over all bridges present in a chain
+ * @encoder: the encoder to iterate bridges on
+ * @bridge: a bridge pointer updated to point to the current bridge at each
+ *         iteration
+ *
+ * Iterate over all bridges present in the bridge chain attached to @encoder.
+ */
+#define drm_for_each_bridge_in_chain(encoder, bridge)                  \
+       list_for_each_entry(bridge, &(encoder)->bridge_chain, chain_node)
+
+bool drm_bridge_chain_mode_fixup(struct drm_bridge *bridge,
+                                const struct drm_display_mode *mode,
+                                struct drm_display_mode *adjusted_mode);
+enum drm_mode_status
+drm_bridge_chain_mode_valid(struct drm_bridge *bridge,
+                           const struct drm_display_mode *mode);
+void drm_bridge_chain_disable(struct drm_bridge *bridge);
+void drm_bridge_chain_post_disable(struct drm_bridge *bridge);
+void drm_bridge_chain_mode_set(struct drm_bridge *bridge,
+                              const struct drm_display_mode *mode,
+                              const struct drm_display_mode *adjusted_mode);
+void drm_bridge_chain_pre_enable(struct drm_bridge *bridge);
+void drm_bridge_chain_enable(struct drm_bridge *bridge);
+
+void drm_atomic_bridge_chain_disable(struct drm_bridge *bridge,
+                                    struct drm_atomic_state *state);
+void drm_atomic_bridge_chain_post_disable(struct drm_bridge *bridge,
+                                         struct drm_atomic_state *state);
+void drm_atomic_bridge_chain_pre_enable(struct drm_bridge *bridge,
+                                       struct drm_atomic_state *state);
+void drm_atomic_bridge_chain_enable(struct drm_bridge *bridge,
                                    struct drm_atomic_state *state);
-void drm_atomic_bridge_pre_enable(struct drm_bridge *bridge,
-                                 struct drm_atomic_state *state);
-void drm_atomic_bridge_enable(struct drm_bridge *bridge,
-                             struct drm_atomic_state *state);
+
+void __drm_atomic_helper_bridge_reset(struct drm_bridge *bridge,
+                                     struct drm_bridge_state *state);
+void __drm_atomic_helper_bridge_duplicate_state(struct drm_bridge *bridge,
+                                               struct drm_bridge_state *new);
+
+static inline struct drm_bridge_state *
+drm_atomic_get_bridge_state(struct drm_atomic_state *state,
+                           struct drm_bridge *bridge)
+{
+       struct drm_private_state *obj_state;
+
+       obj_state = drm_atomic_get_private_obj_state(state, &bridge->base);
+       if (IS_ERR(obj_state))
+               return ERR_CAST(obj_state);
+
+       return drm_priv_to_bridge_state(obj_state);
+}
+
+static inline struct drm_bridge_state *
+drm_atomic_get_old_bridge_state(struct drm_atomic_state *state,
+                               struct drm_bridge *bridge)
+{
+       struct drm_private_state *obj_state;
+
+       obj_state = drm_atomic_get_old_private_obj_state(state, &bridge->base);
+       if (!obj_state)
+               return NULL;
+
+       return drm_priv_to_bridge_state(obj_state);
+}
+
+static inline struct drm_bridge_state *
+drm_atomic_get_new_bridge_state(struct drm_atomic_state *state,
+                               struct drm_bridge *bridge)
+{
+       struct drm_private_state *obj_state;
+
+       obj_state = drm_atomic_get_new_private_obj_state(state, &bridge->base);
+       if (!obj_state)
+               return NULL;
+
+       return drm_priv_to_bridge_state(obj_state);
+}
 
 #ifdef CONFIG_DRM_PANEL_BRIDGE
 struct drm_bridge *drm_panel_bridge_add(struct drm_panel *panel);
@@ -438,6 +615,7 @@ struct drm_bridge *devm_drm_panel_bridge_add(struct device *dev,
 struct drm_bridge *devm_drm_panel_bridge_add_typed(struct device *dev,
                                                   struct drm_panel *panel,
                                                   u32 connector_type);
+struct drm_connector *drm_panel_bridge_connector(struct drm_bridge *bridge);
 #endif
 
 #endif