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