blob: 37515d1afab31bb4ccca0e2391eac06fe8d2b553 [file] [log] [blame]
Dave Airlief453ba02008-11-07 14:05:41 -08001/*
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
Dave Airlief453ba02008-11-07 14:05:41 -080036#include <linux/spinlock.h>
37#include <linux/types.h>
38#include <linux/idr.h>
39
40#include <linux/fb.h>
41
Jason Wessel21c74a82010-10-13 14:09:44 -050042enum mode_set_atomic {
43 LEAVE_ATOMIC_MODE_SET,
44 ENTER_ATOMIC_MODE_SET,
45};
46
Dave Airlief453ba02008-11-07 14:05:41 -080047struct 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 */
Chris Wilson5c3b82e2009-02-11 13:25:09 +000061 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);
Dave Airlief453ba02008-11-07 14:05:41 -080064
65 /* Move the crtc on the current fb to the given position *optional* */
Chris Wilson5c3b82e2009-02-11 13:25:09 +000066 int (*mode_set_base)(struct drm_crtc *crtc, int x, int y,
67 struct drm_framebuffer *old_fb);
Jesse Barnes1a7aba72010-08-05 09:22:31 -050068 int (*mode_set_base_atomic)(struct drm_crtc *crtc,
Jason Wessel413d45d2010-09-26 06:47:25 -050069 struct drm_framebuffer *fb, int x, int y,
Jason Wessel21c74a82010-10-13 14:09:44 -050070 enum mode_set_atomic);
Dave Airlie068143d2009-10-05 09:58:02 +100071
72 /* reload the current crtc LUT */
73 void (*load_lut)(struct drm_crtc *crtc);
Alex Deucher5c8d7172010-06-11 17:04:35 -040074
75 /* disable crtc when not in use - more explicit than dpms off */
76 void (*disable)(struct drm_crtc *crtc);
Dave Airlief453ba02008-11-07 14:05:41 -080077};
78
79struct 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);
Jesse Barnes7bec7562009-02-23 16:09:34 -080092 struct drm_crtc *(*get_crtc)(struct drm_encoder *encoder);
Dave Airlief453ba02008-11-07 14:05:41 -080093 /* detect for DAC style encoders */
94 enum drm_connector_status (*detect)(struct drm_encoder *encoder,
95 struct drm_connector *connector);
Dave Airliea3a05442009-08-31 15:16:30 +100096 /* disable encoder when not in use - more explicit than dpms off */
97 void (*disable)(struct drm_encoder *encoder);
Dave Airlief453ba02008-11-07 14:05:41 -080098};
99
100struct 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
Jesse Barnes40a518d2009-01-12 12:05:32 -0800107extern int drm_helper_probe_single_connector_modes(struct drm_connector *connector, uint32_t maxX, uint32_t maxY);
Dave Airlief453ba02008-11-07 14:05:41 -0800108extern void drm_helper_disable_unused_functions(struct drm_device *dev);
Dave Airlief453ba02008-11-07 14:05:41 -0800109extern int drm_crtc_helper_set_config(struct drm_mode_set *set);
110extern bool drm_crtc_helper_set_mode(struct drm_crtc *crtc,
111 struct drm_display_mode *mode,
Kristian Høgsberg3c4fdcf2008-12-17 22:14:46 -0500112 int x, int y,
113 struct drm_framebuffer *old_fb);
Dave Airlief453ba02008-11-07 14:05:41 -0800114extern bool drm_helper_crtc_in_use(struct drm_crtc *crtc);
Maarten Maathuisf380ef82009-08-19 00:56:44 +0200115extern bool drm_helper_encoder_in_use(struct drm_encoder *encoder);
Dave Airlief453ba02008-11-07 14:05:41 -0800116
Keith Packardc9fb15f2009-05-30 20:42:28 -0700117extern void drm_helper_connector_dpms(struct drm_connector *connector, int mode);
118
Dave Airlief453ba02008-11-07 14:05:41 -0800119extern int drm_helper_mode_fill_fb_struct(struct drm_framebuffer *fb,
Jesse Barnes308e5bc2011-11-14 14:51:28 -0800120 struct drm_mode_fb_cmd2 *mode_cmd);
Dave Airlief453ba02008-11-07 14:05:41 -0800121
122static 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
128static 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
Dave Airlie0b4c0f32010-03-30 05:34:15 +0000134static inline void drm_connector_helper_add(struct drm_connector *connector,
Dave Airlief453ba02008-11-07 14:05:41 -0800135 const struct drm_connector_helper_funcs *funcs)
136{
137 connector->helper_private = (void *)funcs;
Dave Airlief453ba02008-11-07 14:05:41 -0800138}
139
140extern int drm_helper_resume_force_mode(struct drm_device *dev);
Dave Airlieeb1f8e42010-05-07 06:42:51 +0000141extern void drm_kms_helper_poll_init(struct drm_device *dev);
142extern void drm_kms_helper_poll_fini(struct drm_device *dev);
143extern void drm_helper_hpd_irq_event(struct drm_device *dev);
Dave Airliefbf81762010-06-01 09:09:06 +1000144
145extern void drm_kms_helper_poll_disable(struct drm_device *dev);
146extern void drm_kms_helper_poll_enable(struct drm_device *dev);
Ville Syrjäläd0d110e2011-12-20 00:33:24 +0200147
148extern int drm_format_num_planes(uint32_t format);
149
Dave Airlief453ba02008-11-07 14:05:41 -0800150#endif