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