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