include/drm/drm_crtc_helper.h

   1 /*
   2  * Copyright © 2006 Keith Packard
   3  * Copyright © 2007-2008 Dave Airlie
   4  * Copyright © 2007-2008 Intel Corporation
   5  *   Jesse Barnes <jesse.barnes@intel.com>
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the "Software"),
   9  * to deal in the Software without restriction, including without limitation
  10  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11  * and/or sell copies of the Software, and to permit persons to whom the
  12  * Software is furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
  21  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  22  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  23  * OTHER DEALINGS IN THE SOFTWARE.
  24  */
  25
  26 /*
  27  * The DRM mode setting helper functions are common code for drivers to use if
  28  * they wish.  Drivers are not forced to use this code in their
  29  * implementations but it would be useful if they code they do use at least
  30  * provides a consistent interface and operation to userspace
  31  */
  32
  33 #ifndef __DRM_CRTC_HELPER_H__
  34 #define __DRM_CRTC_HELPER_H__
  35
  36 #include <linux/spinlock.h>
  37 #include <linux/types.h>
  38 #include <linux/idr.h>
  39
  40 #include <linux/fb.h>
  41
  42 #include <drm/drm_crtc.h>
  43
  44 enum mode_set_atomic {
  45         LEAVE_ATOMIC_MODE_SET,
  46         ENTER_ATOMIC_MODE_SET,
  47 };
  48
  49 /**
  50  * struct drm_crtc_helper_funcs - helper operations for CRTCs
  51  * @dpms: set power state
  52  * @prepare: prepare the CRTC, called before @mode_set
  53  * @commit: commit changes to CRTC, called after @mode_set
  54  * @mode_fixup: try to fixup proposed mode for this CRTC
  55  * @mode_set: set this mode
  56  * @mode_set_nofb: set mode only (no scanout buffer attached)
  57  * @mode_set_base: update the scanout buffer
  58  * @mode_set_base_atomic: non-blocking mode set (used for kgdb support)
  59  * @load_lut: load color palette
  60  * @disable: disable CRTC when no longer in use
  61  * @atomic_check: check for validity of an atomic state
  62  * @atomic_begin: begin atomic update
  63  * @atomic_flush: flush atomic update
  64  *
  65  * The helper operations are called by the mid-layer CRTC helper.
  66  */
  67 struct drm_crtc_helper_funcs {
  68         /*
  69          * Control power levels on the CRTC.  If the mode passed in is
  70          * unsupported, the provider must use the next lowest power level.
  71          */
  72         void (*dpms)(struct drm_crtc *crtc, int mode);
  73         void (*prepare)(struct drm_crtc *crtc);
  74         void (*commit)(struct drm_crtc *crtc);
  75
  76         /* Provider can fixup or change mode timings before modeset occurs */
  77         bool (*mode_fixup)(struct drm_crtc *crtc,
  78                            const struct drm_display_mode *mode,
  79                            struct drm_display_mode *adjusted_mode);
  80         /* Actually set the mode */
  81         int (*mode_set)(struct drm_crtc *crtc, struct drm_display_mode *mode,
  82                         struct drm_display_mode *adjusted_mode, int x, int y,
  83                         struct drm_framebuffer *old_fb);
  84         void (*mode_set_nofb)(struct drm_crtc *crtc);
  85
  86         /* Move the crtc on the current fb to the given position *optional* */
  87         int (*mode_set_base)(struct drm_crtc *crtc, int x, int y,
  88                              struct drm_framebuffer *old_fb);
  89         int (*mode_set_base_atomic)(struct drm_crtc *crtc,
  90                                     struct drm_framebuffer *fb, int x, int y,
  91                                     enum mode_set_atomic);
  92
  93         /* reload the current crtc LUT */
  94         void (*load_lut)(struct drm_crtc *crtc);
  95
  96         /* disable crtc when not in use - more explicit than dpms off */
  97         void (*disable)(struct drm_crtc *crtc);
  98
  99         /* atomic helpers */
 100         int (*atomic_check)(struct drm_crtc *crtc,
 101                             struct drm_crtc_state *state);
 102         void (*atomic_begin)(struct drm_crtc *crtc);
 103         void (*atomic_flush)(struct drm_crtc *crtc);
 104 };
 105
 106 /**
 107  * struct drm_encoder_helper_funcs - helper operations for encoders
 108  * @dpms: set power state
 109  * @save: save connector state
 110  * @restore: restore connector state
 111  * @mode_fixup: try to fixup proposed mode for this connector
 112  * @prepare: part of the disable sequence, called before the CRTC modeset
 113  * @commit: called after the CRTC modeset
 114  * @mode_set: set this mode
 115  * @get_crtc: return CRTC that the encoder is currently attached to
 116  * @detect: connection status detection
 117  * @disable: disable encoder when not in use (overrides DPMS off)
 118  *
 119  * The helper operations are called by the mid-layer CRTC helper.
 120  */
 121 struct drm_encoder_helper_funcs {
 122         void (*dpms)(struct drm_encoder *encoder, int mode);
 123         void (*save)(struct drm_encoder *encoder);
 124         void (*restore)(struct drm_encoder *encoder);
 125
 126         bool (*mode_fixup)(struct drm_encoder *encoder,
 127                            const struct drm_display_mode *mode,
 128                            struct drm_display_mode *adjusted_mode);
 129         void (*prepare)(struct drm_encoder *encoder);
 130         void (*commit)(struct drm_encoder *encoder);
 131         void (*mode_set)(struct drm_encoder *encoder,
 132                          struct drm_display_mode *mode,
 133                          struct drm_display_mode *adjusted_mode);
 134         struct drm_crtc *(*get_crtc)(struct drm_encoder *encoder);
 135         /* detect for DAC style encoders */
 136         enum drm_connector_status (*detect)(struct drm_encoder *encoder,
 137                                             struct drm_connector *connector);
 138         /* disable encoder when not in use - more explicit than dpms off */
 139         void (*disable)(struct drm_encoder *encoder);
 140 };
 141
 142 /**
 143  * struct drm_connector_helper_funcs - helper operations for connectors
 144  * @get_modes: get mode list for this connector
 145  * @mode_valid: is this mode valid on the given connector? (optional)
 146  * @best_encoder: return the preferred encoder for this connector
 147  *
 148  * The helper operations are called by the mid-layer CRTC helper.
 149  */
 150 struct drm_connector_helper_funcs {
 151         int (*get_modes)(struct drm_connector *connector);
 152         enum drm_mode_status (*mode_valid)(struct drm_connector *connector,
 153                                            struct drm_display_mode *mode);
 154         struct drm_encoder *(*best_encoder)(struct drm_connector *connector);
 155 };
 156
 157 extern void drm_helper_disable_unused_functions(struct drm_device *dev);
 158 extern int drm_crtc_helper_set_config(struct drm_mode_set *set);
 159 extern bool drm_crtc_helper_set_mode(struct drm_crtc *crtc,
 160                                      struct drm_display_mode *mode,
 161                                      int x, int y,
 162                                      struct drm_framebuffer *old_fb);
 163 extern bool drm_helper_crtc_in_use(struct drm_crtc *crtc);
 164 extern bool drm_helper_encoder_in_use(struct drm_encoder *encoder);
 165
 166 extern void drm_helper_connector_dpms(struct drm_connector *connector, int mode);
 167
 168 extern void drm_helper_move_panel_connectors_to_head(struct drm_device *);
 169
 170 extern void drm_helper_mode_fill_fb_struct(struct drm_framebuffer *fb,
 171                                            struct drm_mode_fb_cmd2 *mode_cmd);
 172
 173 static inline void drm_crtc_helper_add(struct drm_crtc *crtc,
 174                                        const struct drm_crtc_helper_funcs *funcs)
 175 {
 176         crtc->helper_private = (void *)funcs;
 177 }
 178
 179 static inline void drm_encoder_helper_add(struct drm_encoder *encoder,
 180                                           const struct drm_encoder_helper_funcs *funcs)
 181 {
 182         encoder->helper_private = (void *)funcs;
 183 }
 184
 185 static inline void drm_connector_helper_add(struct drm_connector *connector,
 186                                             const struct drm_connector_helper_funcs *funcs)
 187 {
 188         connector->helper_private = (void *)funcs;
 189 }
 190
 191 extern void drm_helper_resume_force_mode(struct drm_device *dev);
 192
 193 int drm_helper_crtc_mode_set(struct drm_crtc *crtc, struct drm_display_mode *mode,
 194                              struct drm_display_mode *adjusted_mode, int x, int y,
 195                              struct drm_framebuffer *old_fb);
 196 int drm_helper_crtc_mode_set_base(struct drm_crtc *crtc, int x, int y,
 197                                   struct drm_framebuffer *old_fb);
 198
 199 /* drm_probe_helper.c */
 200 extern int drm_helper_probe_single_connector_modes(struct drm_connector
 201                                                    *connector, uint32_t maxX,
 202                                                    uint32_t maxY);
 203 extern int drm_helper_probe_single_connector_modes_nomerge(struct drm_connector
 204                                                            *connector,
 205                                                            uint32_t maxX,
 206                                                            uint32_t maxY);
 207 extern void drm_kms_helper_poll_init(struct drm_device *dev);
 208 extern void drm_kms_helper_poll_fini(struct drm_device *dev);
 209 extern bool drm_helper_hpd_irq_event(struct drm_device *dev);
 210 extern void drm_kms_helper_hotplug_event(struct drm_device *dev);
 211
 212 extern void drm_kms_helper_poll_disable(struct drm_device *dev);
 213 extern void drm_kms_helper_poll_enable(struct drm_device *dev);
 214
 215 #endif