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 enum mode_set_atomic {
  43         LEAVE_ATOMIC_MODE_SET,
  44         ENTER_ATOMIC_MODE_SET,
  45 };
  46
  47 /**
  48  * drm_crtc_helper_funcs - helper operations for CRTCs
  49  * @mode_fixup: try to fixup proposed mode for this connector
  50  * @mode_set: set this mode
  51  *
  52  * The helper operations are called by the mid-layer CRTC helper.
  53  */
  54 struct drm_crtc_helper_funcs {
  55         /*
  56          * Control power levels on the CRTC.  If the mode passed in is
  57          * unsupported, the provider must use the next lowest power level.
  58          */
  59         void (*dpms)(struct drm_crtc *crtc, int mode);
  60         void (*prepare)(struct drm_crtc *crtc);
  61         void (*commit)(struct drm_crtc *crtc);
  62
  63         /* Provider can fixup or change mode timings before modeset occurs */
  64         bool (*mode_fixup)(struct drm_crtc *crtc,
  65                            const struct drm_display_mode *mode,
  66                            struct drm_display_mode *adjusted_mode);
  67         /* Actually set the mode */
  68         int (*mode_set)(struct drm_crtc *crtc, struct drm_display_mode *mode,
  69                         struct drm_display_mode *adjusted_mode, int x, int y,
  70                         struct drm_framebuffer *old_fb);
  71
  72         /* Move the crtc on the current fb to the given position *optional* */
  73         int (*mode_set_base)(struct drm_crtc *crtc, int x, int y,
  74                              struct drm_framebuffer *old_fb);
  75         int (*mode_set_base_atomic)(struct drm_crtc *crtc,
  76                                     struct drm_framebuffer *fb, int x, int y,
  77                                     enum mode_set_atomic);
  78
  79         /* reload the current crtc LUT */
  80         void (*load_lut)(struct drm_crtc *crtc);
  81
  82         /* disable crtc when not in use - more explicit than dpms off */
  83         void (*disable)(struct drm_crtc *crtc);
  84 };
  85
  86 /**
  87  * drm_encoder_helper_funcs - helper operations for encoders
  88  * @mode_fixup: try to fixup proposed mode for this connector
  89  * @mode_set: set this mode
  90  *
  91  * The helper operations are called by the mid-layer CRTC helper.
  92  */
  93 struct drm_encoder_helper_funcs {
  94         void (*dpms)(struct drm_encoder *encoder, int mode);
  95         void (*save)(struct drm_encoder *encoder);
  96         void (*restore)(struct drm_encoder *encoder);
  97
  98         bool (*mode_fixup)(struct drm_encoder *encoder,
  99                            const struct drm_display_mode *mode,
 100                            struct drm_display_mode *adjusted_mode);
 101         void (*prepare)(struct drm_encoder *encoder);
 102         void (*commit)(struct drm_encoder *encoder);
 103         void (*mode_set)(struct drm_encoder *encoder,
 104                          struct drm_display_mode *mode,
 105                          struct drm_display_mode *adjusted_mode);
 106         struct drm_crtc *(*get_crtc)(struct drm_encoder *encoder);
 107         /* detect for DAC style encoders */
 108         enum drm_connector_status (*detect)(struct drm_encoder *encoder,
 109                                             struct drm_connector *connector);
 110         /* disable encoder when not in use - more explicit than dpms off */
 111         void (*disable)(struct drm_encoder *encoder);
 112 };
 113
 114 /**
 115  * drm_connector_helper_funcs - helper operations for connectors
 116  * @get_modes: get mode list for this connector
 117  * @mode_valid: is this mode valid on the given connector?
 118  *
 119  * The helper operations are called by the mid-layer CRTC helper.
 120  */
 121 struct drm_connector_helper_funcs {
 122         int (*get_modes)(struct drm_connector *connector);
 123         int (*mode_valid)(struct drm_connector *connector,
 124                           struct drm_display_mode *mode);
 125         struct drm_encoder *(*best_encoder)(struct drm_connector *connector);
 126 };
 127
 128 extern int drm_helper_probe_single_connector_modes(struct drm_connector *connector, uint32_t maxX, uint32_t maxY);
 129 extern void drm_helper_disable_unused_functions(struct drm_device *dev);
 130 extern int drm_crtc_helper_set_config(struct drm_mode_set *set);
 131 extern bool drm_crtc_helper_set_mode(struct drm_crtc *crtc,
 132                                      struct drm_display_mode *mode,
 133                                      int x, int y,
 134                                      struct drm_framebuffer *old_fb);
 135 extern bool drm_helper_crtc_in_use(struct drm_crtc *crtc);
 136 extern bool drm_helper_encoder_in_use(struct drm_encoder *encoder);
 137
 138 extern void drm_helper_connector_dpms(struct drm_connector *connector, int mode);
 139
 140 extern int drm_helper_mode_fill_fb_struct(struct drm_framebuffer *fb,
 141                                           struct drm_mode_fb_cmd2 *mode_cmd);
 142
 143 static inline void drm_crtc_helper_add(struct drm_crtc *crtc,
 144                                        const struct drm_crtc_helper_funcs *funcs)
 145 {
 146         crtc->helper_private = (void *)funcs;
 147 }
 148
 149 static inline void drm_encoder_helper_add(struct drm_encoder *encoder,
 150                                           const struct drm_encoder_helper_funcs *funcs)
 151 {
 152         encoder->helper_private = (void *)funcs;
 153 }
 154
 155 static inline void drm_connector_helper_add(struct drm_connector *connector,
 156                                             const struct drm_connector_helper_funcs *funcs)
 157 {
 158         connector->helper_private = (void *)funcs;
 159 }
 160
 161 extern int drm_helper_resume_force_mode(struct drm_device *dev);
 162 extern void drm_kms_helper_poll_init(struct drm_device *dev);
 163 extern void drm_kms_helper_poll_fini(struct drm_device *dev);
 164 extern void drm_helper_hpd_irq_event(struct drm_device *dev);
 165
 166 extern void drm_kms_helper_poll_disable(struct drm_device *dev);
 167 extern void drm_kms_helper_poll_enable(struct drm_device *dev);
 168
 169 #endif