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 void (*mode_set_nofb)(struct drm_crtc *crtc); 72 73 /* Move the crtc on the current fb to the given position *optional* */ 74 int (*mode_set_base)(struct drm_crtc *crtc, int x, int y, 75 struct drm_framebuffer *old_fb); 76 int (*mode_set_base_atomic)(struct drm_crtc *crtc, 77 struct drm_framebuffer *fb, int x, int y, 78 enum mode_set_atomic); 79 80 /* reload the current crtc LUT */ 81 void (*load_lut)(struct drm_crtc *crtc); 82 83 /* disable crtc when not in use - more explicit than dpms off */ 84 void (*disable)(struct drm_crtc *crtc); 85 86 /* atomic helpers */ 87 int (*atomic_check)(struct drm_crtc *crtc, 88 struct drm_crtc_state *state); 89 void (*atomic_begin)(struct drm_crtc *crtc); 90 void (*atomic_flush)(struct drm_crtc *crtc); 91 }; 92 93 /** 94 * drm_encoder_helper_funcs - helper operations for encoders 95 * @mode_fixup: try to fixup proposed mode for this connector 96 * @mode_set: set this mode 97 * 98 * The helper operations are called by the mid-layer CRTC helper. 99 */ 100 struct drm_encoder_helper_funcs { 101 void (*dpms)(struct drm_encoder *encoder, int mode); 102 void (*save)(struct drm_encoder *encoder); 103 void (*restore)(struct drm_encoder *encoder); 104 105 bool (*mode_fixup)(struct drm_encoder *encoder, 106 const struct drm_display_mode *mode, 107 struct drm_display_mode *adjusted_mode); 108 void (*prepare)(struct drm_encoder *encoder); 109 void (*commit)(struct drm_encoder *encoder); 110 void (*mode_set)(struct drm_encoder *encoder, 111 struct drm_display_mode *mode, 112 struct drm_display_mode *adjusted_mode); 113 struct drm_crtc *(*get_crtc)(struct drm_encoder *encoder); 114 /* detect for DAC style encoders */ 115 enum drm_connector_status (*detect)(struct drm_encoder *encoder, 116 struct drm_connector *connector); 117 /* disable encoder when not in use - more explicit than dpms off */ 118 void (*disable)(struct drm_encoder *encoder); 119 }; 120 121 /** 122 * drm_connector_helper_funcs - helper operations for connectors 123 * @get_modes: get mode list for this connector 124 * @mode_valid (optional): is this mode valid on the given connector? 125 * 126 * The helper operations are called by the mid-layer CRTC helper. 127 */ 128 struct drm_connector_helper_funcs { 129 int (*get_modes)(struct drm_connector *connector); 130 enum drm_mode_status (*mode_valid)(struct drm_connector *connector, 131 struct drm_display_mode *mode); 132 struct drm_encoder *(*best_encoder)(struct drm_connector *connector); 133 }; 134 135 extern void drm_helper_disable_unused_functions(struct drm_device *dev); 136 extern int drm_crtc_helper_set_config(struct drm_mode_set *set); 137 extern bool drm_crtc_helper_set_mode(struct drm_crtc *crtc, 138 struct drm_display_mode *mode, 139 int x, int y, 140 struct drm_framebuffer *old_fb); 141 extern bool drm_helper_crtc_in_use(struct drm_crtc *crtc); 142 extern bool drm_helper_encoder_in_use(struct drm_encoder *encoder); 143 144 extern void drm_helper_connector_dpms(struct drm_connector *connector, int mode); 145 146 extern void drm_helper_move_panel_connectors_to_head(struct drm_device *); 147 148 extern void drm_helper_mode_fill_fb_struct(struct drm_framebuffer *fb, 149 struct drm_mode_fb_cmd2 *mode_cmd); 150 151 static inline void drm_crtc_helper_add(struct drm_crtc *crtc, 152 const struct drm_crtc_helper_funcs *funcs) 153 { 154 crtc->helper_private = (void *)funcs; 155 } 156 157 static inline void drm_encoder_helper_add(struct drm_encoder *encoder, 158 const struct drm_encoder_helper_funcs *funcs) 159 { 160 encoder->helper_private = (void *)funcs; 161 } 162 163 static inline void drm_connector_helper_add(struct drm_connector *connector, 164 const struct drm_connector_helper_funcs *funcs) 165 { 166 connector->helper_private = (void *)funcs; 167 } 168 169 extern void drm_helper_resume_force_mode(struct drm_device *dev); 170 171 int drm_helper_crtc_mode_set(struct drm_crtc *crtc, struct drm_display_mode *mode, 172 struct drm_display_mode *adjusted_mode, int x, int y, 173 struct drm_framebuffer *old_fb); 174 int drm_helper_crtc_mode_set_base(struct drm_crtc *crtc, int x, int y, 175 struct drm_framebuffer *old_fb); 176 177 /* drm_probe_helper.c */ 178 extern int drm_helper_probe_single_connector_modes(struct drm_connector 179 *connector, uint32_t maxX, 180 uint32_t maxY); 181 extern int drm_helper_probe_single_connector_modes_nomerge(struct drm_connector 182 *connector, 183 uint32_t maxX, 184 uint32_t maxY); 185 extern void drm_kms_helper_poll_init(struct drm_device *dev); 186 extern void drm_kms_helper_poll_fini(struct drm_device *dev); 187 extern bool drm_helper_hpd_irq_event(struct drm_device *dev); 188 extern void drm_kms_helper_hotplug_event(struct drm_device *dev); 189 190 extern void drm_kms_helper_poll_disable(struct drm_device *dev); 191 extern void drm_kms_helper_poll_enable(struct drm_device *dev); 192 193 #endif 194