xref: /openbmc/linux/include/drm/drm_crtc_helper.h (revision 3c4fdcfb)
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/i2c.h>
37 #include <linux/spinlock.h>
38 #include <linux/types.h>
39 #include <linux/idr.h>
40 
41 #include <linux/fb.h>
42 
43 struct drm_crtc_helper_funcs {
44 	/*
45 	 * Control power levels on the CRTC.  If the mode passed in is
46 	 * unsupported, the provider must use the next lowest power level.
47 	 */
48 	void (*dpms)(struct drm_crtc *crtc, int mode);
49 	void (*prepare)(struct drm_crtc *crtc);
50 	void (*commit)(struct drm_crtc *crtc);
51 
52 	/* Provider can fixup or change mode timings before modeset occurs */
53 	bool (*mode_fixup)(struct drm_crtc *crtc,
54 			   struct drm_display_mode *mode,
55 			   struct drm_display_mode *adjusted_mode);
56 	/* Actually set the mode */
57 	void (*mode_set)(struct drm_crtc *crtc, struct drm_display_mode *mode,
58 			 struct drm_display_mode *adjusted_mode, int x, int y,
59 			 struct drm_framebuffer *old_fb);
60 
61 	/* Move the crtc on the current fb to the given position *optional* */
62 	void (*mode_set_base)(struct drm_crtc *crtc, int x, int y,
63 			      struct drm_framebuffer *old_fb);
64 };
65 
66 struct drm_encoder_helper_funcs {
67 	void (*dpms)(struct drm_encoder *encoder, int mode);
68 	void (*save)(struct drm_encoder *encoder);
69 	void (*restore)(struct drm_encoder *encoder);
70 
71 	bool (*mode_fixup)(struct drm_encoder *encoder,
72 			   struct drm_display_mode *mode,
73 			   struct drm_display_mode *adjusted_mode);
74 	void (*prepare)(struct drm_encoder *encoder);
75 	void (*commit)(struct drm_encoder *encoder);
76 	void (*mode_set)(struct drm_encoder *encoder,
77 			 struct drm_display_mode *mode,
78 			 struct drm_display_mode *adjusted_mode);
79 	/* detect for DAC style encoders */
80 	enum drm_connector_status (*detect)(struct drm_encoder *encoder,
81 					    struct drm_connector *connector);
82 };
83 
84 struct drm_connector_helper_funcs {
85 	int (*get_modes)(struct drm_connector *connector);
86 	int (*mode_valid)(struct drm_connector *connector,
87 			  struct drm_display_mode *mode);
88 	struct drm_encoder *(*best_encoder)(struct drm_connector *connector);
89 };
90 
91 extern void drm_helper_probe_single_connector_modes(struct drm_connector *connector, uint32_t maxX, uint32_t maxY);
92 extern void drm_helper_disable_unused_functions(struct drm_device *dev);
93 extern int drm_helper_hotplug_stage_two(struct drm_device *dev);
94 extern bool drm_helper_initial_config(struct drm_device *dev, bool can_grow);
95 extern int drm_crtc_helper_set_config(struct drm_mode_set *set);
96 extern bool drm_crtc_helper_set_mode(struct drm_crtc *crtc,
97 				     struct drm_display_mode *mode,
98 				     int x, int y,
99 				     struct drm_framebuffer *old_fb);
100 extern bool drm_helper_crtc_in_use(struct drm_crtc *crtc);
101 
102 extern int drm_helper_mode_fill_fb_struct(struct drm_framebuffer *fb,
103 					  struct drm_mode_fb_cmd *mode_cmd);
104 
105 static inline void drm_crtc_helper_add(struct drm_crtc *crtc,
106 				       const struct drm_crtc_helper_funcs *funcs)
107 {
108 	crtc->helper_private = (void *)funcs;
109 }
110 
111 static inline void drm_encoder_helper_add(struct drm_encoder *encoder,
112 					  const struct drm_encoder_helper_funcs *funcs)
113 {
114 	encoder->helper_private = (void *)funcs;
115 }
116 
117 static inline void drm_connector_helper_add(struct drm_connector *connector,
118 					    const struct drm_connector_helper_funcs *funcs)
119 {
120 	connector->helper_private = (void *)funcs;
121 }
122 
123 extern int drm_helper_resume_force_mode(struct drm_device *dev);
124 #endif
125