sys/dev/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  * $FreeBSD: src/sys/dev/drm2/drm_crtc_helper.h,v 1.1 2012/05/22 11:07:44 kib Exp $
  26  */
  27
  28 /*
  29  * The DRM mode setting helper functions are common code for drivers to use if
  30  * they wish.  Drivers are not forced to use this code in their
  31  * implementations but it would be useful if they code they do use at least
  32  * provides a consistent interface and operation to userspace
  33  */
  34
  35 #ifndef __DRM_CRTC_HELPER_H__
  36 #define __DRM_CRTC_HELPER_H__
  37
  38 enum mode_set_atomic {
  39         LEAVE_ATOMIC_MODE_SET,
  40         ENTER_ATOMIC_MODE_SET,
  41 };
  42
  43 struct drm_crtc_helper_funcs {
  44         /*
  45          * Control power levels on the CRTC.  If the mode passed in is
  46          * unsupported, the provider must use the next lowest power level.
  47          */
  48         void (*dpms)(struct drm_crtc *crtc, int mode);
  49         void (*prepare)(struct drm_crtc *crtc);
  50         void (*commit)(struct drm_crtc *crtc);
  51
  52         /* Provider can fixup or change mode timings before modeset occurs */
  53         bool (*mode_fixup)(struct drm_crtc *crtc,
  54                            struct drm_display_mode *mode,
  55                            struct drm_display_mode *adjusted_mode);
  56         /* Actually set the mode */
  57         int (*mode_set)(struct drm_crtc *crtc, struct drm_display_mode *mode,
  58                         struct drm_display_mode *adjusted_mode, int x, int y,
  59                         struct drm_framebuffer *old_fb);
  60
  61         /* Move the crtc on the current fb to the given position *optional* */
  62         int (*mode_set_base)(struct drm_crtc *crtc, int x, int y,
  63                              struct drm_framebuffer *old_fb);
  64         int (*mode_set_base_atomic)(struct drm_crtc *crtc,
  65                                     struct drm_framebuffer *fb, int x, int y,
  66                                     enum mode_set_atomic);
  67
  68         /* reload the current crtc LUT */
  69         void (*load_lut)(struct drm_crtc *crtc);
  70
  71         /* disable crtc when not in use - more explicit than dpms off */
  72         void (*disable)(struct drm_crtc *crtc);
  73 };
  74
  75 struct drm_encoder_helper_funcs {
  76         void (*dpms)(struct drm_encoder *encoder, int mode);
  77         void (*save)(struct drm_encoder *encoder);
  78         void (*restore)(struct drm_encoder *encoder);
  79
  80         bool (*mode_fixup)(struct drm_encoder *encoder,
  81                            struct drm_display_mode *mode,
  82                            struct drm_display_mode *adjusted_mode);
  83         void (*prepare)(struct drm_encoder *encoder);
  84         void (*commit)(struct drm_encoder *encoder);
  85         void (*mode_set)(struct drm_encoder *encoder,
  86                          struct drm_display_mode *mode,
  87                          struct drm_display_mode *adjusted_mode);
  88         struct drm_crtc *(*get_crtc)(struct drm_encoder *encoder);
  89         /* detect for DAC style encoders */
  90         enum drm_connector_status (*detect)(struct drm_encoder *encoder,
  91                                             struct drm_connector *connector);
  92         /* disable encoder when not in use - more explicit than dpms off */
  93         void (*disable)(struct drm_encoder *encoder);
  94 };
  95
  96 struct drm_connector_helper_funcs {
  97         int (*get_modes)(struct drm_connector *connector);
  98         int (*mode_valid)(struct drm_connector *connector,
  99                           struct drm_display_mode *mode);
 100         struct drm_encoder *(*best_encoder)(struct drm_connector *connector);
 101 };
 102
 103 extern int drm_helper_probe_single_connector_modes(struct drm_connector *connector, uint32_t maxX, uint32_t maxY);
 104 extern void drm_helper_disable_unused_functions(struct drm_device *dev);
 105 extern int drm_crtc_helper_set_config(struct drm_mode_set *set);
 106 extern bool drm_crtc_helper_set_mode(struct drm_crtc *crtc,
 107                                      struct drm_display_mode *mode,
 108                                      int x, int y,
 109                                      struct drm_framebuffer *old_fb);
 110 extern bool drm_helper_crtc_in_use(struct drm_crtc *crtc);
 111 extern bool drm_helper_encoder_in_use(struct drm_encoder *encoder);
 112
 113 extern void drm_helper_connector_dpms(struct drm_connector *connector, int mode);
 114
 115 extern int drm_helper_mode_fill_fb_struct(struct drm_framebuffer *fb,
 116                                           struct drm_mode_fb_cmd2 *mode_cmd);
 117
 118 static inline void drm_crtc_helper_add(struct drm_crtc *crtc,
 119                                        const struct drm_crtc_helper_funcs *funcs)
 120 {
 121         crtc->helper_private = __DECONST(void *, funcs);
 122 }
 123
 124 static inline void drm_encoder_helper_add(struct drm_encoder *encoder,
 125                                           const struct drm_encoder_helper_funcs *funcs)
 126 {
 127         encoder->helper_private = __DECONST(void *, funcs);
 128 }
 129
 130 static inline void drm_connector_helper_add(struct drm_connector *connector,
 131                                             const struct drm_connector_helper_funcs *funcs)
 132 {
 133         connector->helper_private = __DECONST(void *, funcs);
 134 }
 135
 136 extern int drm_helper_resume_force_mode(struct drm_device *dev);
 137 extern void drm_kms_helper_poll_init(struct drm_device *dev);
 138 extern void drm_kms_helper_poll_fini(struct drm_device *dev);
 139 extern void drm_helper_hpd_irq_event(struct drm_device *dev);
 140
 141 extern void drm_kms_helper_poll_disable(struct drm_device *dev);
 142 extern void drm_kms_helper_poll_enable(struct drm_device *dev);
 143
 144 extern bool drm_fetch_cmdline_mode_from_kenv(struct drm_connector *connector,
 145     struct drm_cmdline_mode *cmdline_mode);
 146 #endif