LXR linux/include/drm/drm_crtc

   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
  44enum 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 * @enable: enable CRTC
  62 * @atomic_check: check for validity of an atomic state
  63 * @atomic_begin: begin atomic update
  64 * @atomic_flush: flush atomic update
  65 *
  66 * The helper operations are called by the mid-layer CRTC helper.
  67 *
  68 * Note that with atomic helpers @dpms, @prepare and @commit hooks are
  69 * deprecated. Used @enable and @disable instead exclusively.
  70 *
  71 * With legacy crtc helpers there's a big semantic difference between @disable
  72 * and the other hooks: @disable also needs to release any resources acquired in
  73 * @mode_set (like shared PLLs).
  74 */
  75struct drm_crtc_helper_funcs {
  76        /*
  77         * Control power levels on the CRTC.  If the mode passed in is
  78         * unsupported, the provider must use the next lowest power level.
  79         */
  80        void (*dpms)(struct drm_crtc *crtc, int mode);
  81        void (*prepare)(struct drm_crtc *crtc);
  82        void (*commit)(struct drm_crtc *crtc);
  83
  84        /* Provider can fixup or change mode timings before modeset occurs */
  85        bool (*mode_fixup)(struct drm_crtc *crtc,
  86                           const struct drm_display_mode *mode,
  87                           struct drm_display_mode *adjusted_mode);
  88        /* Actually set the mode */
  89        int (*mode_set)(struct drm_crtc *crtc, struct drm_display_mode *mode,
  90                        struct drm_display_mode *adjusted_mode, int x, int y,
  91                        struct drm_framebuffer *old_fb);
  92        void (*mode_set_nofb)(struct drm_crtc *crtc);
  93
  94        /* Move the crtc on the current fb to the given position *optional* */
  95        int (*mode_set_base)(struct drm_crtc *crtc, int x, int y,
  96                             struct drm_framebuffer *old_fb);
  97        int (*mode_set_base_atomic)(struct drm_crtc *crtc,
  98                                    struct drm_framebuffer *fb, int x, int y,
  99                                    enum mode_set_atomic);
 100
 101        /* reload the current crtc LUT */
 102        void (*load_lut)(struct drm_crtc *crtc);
 103
 104        void (*disable)(struct drm_crtc *crtc);
 105        void (*enable)(struct drm_crtc *crtc);
 106
 107        /* atomic helpers */
 108        int (*atomic_check)(struct drm_crtc *crtc,
 109                            struct drm_crtc_state *state);
 110        void (*atomic_begin)(struct drm_crtc *crtc);
 111        void (*atomic_flush)(struct drm_crtc *crtc);
 112};
 113
 114/**
 115 * struct drm_encoder_helper_funcs - helper operations for encoders
 116 * @dpms: set power state
 117 * @save: save connector state
 118 * @restore: restore connector state
 119 * @mode_fixup: try to fixup proposed mode for this connector
 120 * @prepare: part of the disable sequence, called before the CRTC modeset
 121 * @commit: called after the CRTC modeset
 122 * @mode_set: set this mode
 123 * @get_crtc: return CRTC that the encoder is currently attached to
 124 * @detect: connection status detection
 125 * @disable: disable encoder when not in use (overrides DPMS off)
 126 * @enable: enable encoder
 127 * @atomic_check: check for validity of an atomic update
 128 *
 129 * The helper operations are called by the mid-layer CRTC helper.
 130 *
 131 * Note that with atomic helpers @dpms, @prepare and @commit hooks are
 132 * deprecated. Used @enable and @disable instead exclusively.
 133 *
 134 * With legacy crtc helpers there's a big semantic difference between @disable
 135 * and the other hooks: @disable also needs to release any resources acquired in
 136 * @mode_set (like shared PLLs).
 137 */
 138struct drm_encoder_helper_funcs {
 139        void (*dpms)(struct drm_encoder *encoder, int mode);
 140        void (*save)(struct drm_encoder *encoder);
 141        void (*restore)(struct drm_encoder *encoder);
 142
 143        bool (*mode_fixup)(struct drm_encoder *encoder,
 144                           const struct drm_display_mode *mode,
 145                           struct drm_display_mode *adjusted_mode);
 146        void (*prepare)(struct drm_encoder *encoder);
 147        void (*commit)(struct drm_encoder *encoder);
 148        void (*mode_set)(struct drm_encoder *encoder,
 149                         struct drm_display_mode *mode,
 150                         struct drm_display_mode *adjusted_mode);
 151        struct drm_crtc *(*get_crtc)(struct drm_encoder *encoder);
 152        /* detect for DAC style encoders */
 153        enum drm_connector_status (*detect)(struct drm_encoder *encoder,
 154                                            struct drm_connector *connector);
 155        void (*disable)(struct drm_encoder *encoder);
 156
 157        void (*enable)(struct drm_encoder *encoder);
 158
 159        /* atomic helpers */
 160        int (*atomic_check)(struct drm_encoder *encoder,
 161                            struct drm_crtc_state *crtc_state,
 162                            struct drm_connector_state *conn_state);
 163};
 164
 165/**
 166 * struct drm_connector_helper_funcs - helper operations for connectors
 167 * @get_modes: get mode list for this connector
 168 * @mode_valid: is this mode valid on the given connector? (optional)
 169 * @best_encoder: return the preferred encoder for this connector
 170 *
 171 * The helper operations are called by the mid-layer CRTC helper.
 172 */
 173struct drm_connector_helper_funcs {
 174        int (*get_modes)(struct drm_connector *connector);
 175        enum drm_mode_status (*mode_valid)(struct drm_connector *connector,
 176                                           struct drm_display_mode *mode);
 177        struct drm_encoder *(*best_encoder)(struct drm_connector *connector);
 178};
 179
 180extern void drm_helper_disable_unused_functions(struct drm_device *dev);
 181extern int drm_crtc_helper_set_config(struct drm_mode_set *set);
 182extern bool drm_crtc_helper_set_mode(struct drm_crtc *crtc,
 183                                     struct drm_display_mode *mode,
 184                                     int x, int y,
 185                                     struct drm_framebuffer *old_fb);
 186extern bool drm_helper_crtc_in_use(struct drm_crtc *crtc);
 187extern bool drm_helper_encoder_in_use(struct drm_encoder *encoder);
 188
 189extern void drm_helper_connector_dpms(struct drm_connector *connector, int mode);
 190
 191extern void drm_helper_move_panel_connectors_to_head(struct drm_device *);
 192
 193extern void drm_helper_mode_fill_fb_struct(struct drm_framebuffer *fb,
 194                                           struct drm_mode_fb_cmd2 *mode_cmd);
 195
 196static inline void drm_crtc_helper_add(struct drm_crtc *crtc,
 197                                       const struct drm_crtc_helper_funcs *funcs)
 198{
 199        crtc->helper_private = (void *)funcs;
 200}
 201
 202static inline void drm_encoder_helper_add(struct drm_encoder *encoder,
 203                                          const struct drm_encoder_helper_funcs *funcs)
 204{
 205        encoder->helper_private = (void *)funcs;
 206}
 207
 208static inline void drm_connector_helper_add(struct drm_connector *connector,
 209                                            const struct drm_connector_helper_funcs *funcs)
 210{
 211        connector->helper_private = (void *)funcs;
 212}
 213
 214extern void drm_helper_resume_force_mode(struct drm_device *dev);
 215
 216int drm_helper_crtc_mode_set(struct drm_crtc *crtc, struct drm_display_mode *mode,
 217                             struct drm_display_mode *adjusted_mode, int x, int y,
 218                             struct drm_framebuffer *old_fb);
 219int drm_helper_crtc_mode_set_base(struct drm_crtc *crtc, int x, int y,
 220                                  struct drm_framebuffer *old_fb);
 221
 222/* drm_probe_helper.c */
 223extern int drm_helper_probe_single_connector_modes(struct drm_connector
 224                                                   *connector, uint32_t maxX,
 225                                                   uint32_t maxY);
 226extern int drm_helper_probe_single_connector_modes_nomerge(struct drm_connector
 227                                                           *connector,
 228                                                           uint32_t maxX,
 229                                                           uint32_t maxY);
 230extern void drm_kms_helper_poll_init(struct drm_device *dev);
 231extern void drm_kms_helper_poll_fini(struct drm_device *dev);
 232extern bool drm_helper_hpd_irq_event(struct drm_device *dev);
 233extern void drm_kms_helper_hotplug_event(struct drm_device *dev);
 234
 235extern void drm_kms_helper_poll_disable(struct drm_device *dev);
 236extern void drm_kms_helper_poll_enable(struct drm_device *dev);
 237
 238#endif
 239