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