blob: e01cc80c9c30bf954c4839778b0a704f05aa222d [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
Laurent Pinchart3b02ab82012-05-17 13:27:20 +020047/**
48 * drm_crtc_helper_funcs - helper operations for CRTCs
49 * @mode_fixup: try to fixup proposed mode for this connector
50 * @mode_set: set this mode
51 *
52 * The helper operations are called by the mid-layer CRTC helper.
53 */
Dave Airlief453ba02008-11-07 14:05:41 -080054struct drm_crtc_helper_funcs {
55 /*
56 * Control power levels on the CRTC. If the mode passed in is
57 * unsupported, the provider must use the next lowest power level.
58 */
59 void (*dpms)(struct drm_crtc *crtc, int mode);
60 void (*prepare)(struct drm_crtc *crtc);
61 void (*commit)(struct drm_crtc *crtc);
62
63 /* Provider can fixup or change mode timings before modeset occurs */
64 bool (*mode_fixup)(struct drm_crtc *crtc,
Laurent Pincharte811f5a2012-07-17 17:56:50 +020065 const struct drm_display_mode *mode,
Dave Airlief453ba02008-11-07 14:05:41 -080066 struct drm_display_mode *adjusted_mode);
67 /* Actually set the mode */
Chris Wilson5c3b82e2009-02-11 13:25:09 +000068 int (*mode_set)(struct drm_crtc *crtc, struct drm_display_mode *mode,
69 struct drm_display_mode *adjusted_mode, int x, int y,
70 struct drm_framebuffer *old_fb);
Dave Airlief453ba02008-11-07 14:05:41 -080071
72 /* Move the crtc on the current fb to the given position *optional* */
Chris Wilson5c3b82e2009-02-11 13:25:09 +000073 int (*mode_set_base)(struct drm_crtc *crtc, int x, int y,
74 struct drm_framebuffer *old_fb);
Jesse Barnes1a7aba72010-08-05 09:22:31 -050075 int (*mode_set_base_atomic)(struct drm_crtc *crtc,
Jason Wessel413d45d2010-09-26 06:47:25 -050076 struct drm_framebuffer *fb, int x, int y,
Jason Wessel21c74a82010-10-13 14:09:44 -050077 enum mode_set_atomic);
Dave Airlie068143d2009-10-05 09:58:02 +100078
79 /* reload the current crtc LUT */
80 void (*load_lut)(struct drm_crtc *crtc);
Alex Deucher5c8d7172010-06-11 17:04:35 -040081
82 /* disable crtc when not in use - more explicit than dpms off */
83 void (*disable)(struct drm_crtc *crtc);
Dave Airlief453ba02008-11-07 14:05:41 -080084};
85
Laurent Pinchart3b02ab82012-05-17 13:27:20 +020086/**
87 * drm_encoder_helper_funcs - helper operations for encoders
88 * @mode_fixup: try to fixup proposed mode for this connector
89 * @mode_set: set this mode
90 *
91 * The helper operations are called by the mid-layer CRTC helper.
92 */
Dave Airlief453ba02008-11-07 14:05:41 -080093struct drm_encoder_helper_funcs {
94 void (*dpms)(struct drm_encoder *encoder, int mode);
95 void (*save)(struct drm_encoder *encoder);
96 void (*restore)(struct drm_encoder *encoder);
97
98 bool (*mode_fixup)(struct drm_encoder *encoder,
Laurent Pincharte811f5a2012-07-17 17:56:50 +020099 const struct drm_display_mode *mode,
Dave Airlief453ba02008-11-07 14:05:41 -0800100 struct drm_display_mode *adjusted_mode);
101 void (*prepare)(struct drm_encoder *encoder);
102 void (*commit)(struct drm_encoder *encoder);
103 void (*mode_set)(struct drm_encoder *encoder,
104 struct drm_display_mode *mode,
105 struct drm_display_mode *adjusted_mode);
Jesse Barnes7bec7562009-02-23 16:09:34 -0800106 struct drm_crtc *(*get_crtc)(struct drm_encoder *encoder);
Dave Airlief453ba02008-11-07 14:05:41 -0800107 /* detect for DAC style encoders */
108 enum drm_connector_status (*detect)(struct drm_encoder *encoder,
109 struct drm_connector *connector);
Dave Airliea3a05442009-08-31 15:16:30 +1000110 /* disable encoder when not in use - more explicit than dpms off */
111 void (*disable)(struct drm_encoder *encoder);
Dave Airlief453ba02008-11-07 14:05:41 -0800112};
113
Laurent Pinchart3b02ab82012-05-17 13:27:20 +0200114/**
115 * drm_connector_helper_funcs - helper operations for connectors
116 * @get_modes: get mode list for this connector
117 * @mode_valid: is this mode valid on the given connector?
118 *
119 * The helper operations are called by the mid-layer CRTC helper.
120 */
Dave Airlief453ba02008-11-07 14:05:41 -0800121struct drm_connector_helper_funcs {
122 int (*get_modes)(struct drm_connector *connector);
123 int (*mode_valid)(struct drm_connector *connector,
124 struct drm_display_mode *mode);
125 struct drm_encoder *(*best_encoder)(struct drm_connector *connector);
126};
127
Jesse Barnes40a518d2009-01-12 12:05:32 -0800128extern int drm_helper_probe_single_connector_modes(struct drm_connector *connector, uint32_t maxX, uint32_t maxY);
Dave Airlief453ba02008-11-07 14:05:41 -0800129extern void drm_helper_disable_unused_functions(struct drm_device *dev);
Dave Airlief453ba02008-11-07 14:05:41 -0800130extern int drm_crtc_helper_set_config(struct drm_mode_set *set);
131extern bool drm_crtc_helper_set_mode(struct drm_crtc *crtc,
132 struct drm_display_mode *mode,
Kristian Høgsberg3c4fdcf2008-12-17 22:14:46 -0500133 int x, int y,
134 struct drm_framebuffer *old_fb);
Dave Airlief453ba02008-11-07 14:05:41 -0800135extern bool drm_helper_crtc_in_use(struct drm_crtc *crtc);
Maarten Maathuisf380ef82009-08-19 00:56:44 +0200136extern bool drm_helper_encoder_in_use(struct drm_encoder *encoder);
Dave Airlief453ba02008-11-07 14:05:41 -0800137
Keith Packardc9fb15f2009-05-30 20:42:28 -0700138extern void drm_helper_connector_dpms(struct drm_connector *connector, int mode);
139
Dave Airlief453ba02008-11-07 14:05:41 -0800140extern int drm_helper_mode_fill_fb_struct(struct drm_framebuffer *fb,
Jesse Barnes308e5bc2011-11-14 14:51:28 -0800141 struct drm_mode_fb_cmd2 *mode_cmd);
Dave Airlief453ba02008-11-07 14:05:41 -0800142
143static inline void drm_crtc_helper_add(struct drm_crtc *crtc,
144 const struct drm_crtc_helper_funcs *funcs)
145{
146 crtc->helper_private = (void *)funcs;
147}
148
149static inline void drm_encoder_helper_add(struct drm_encoder *encoder,
150 const struct drm_encoder_helper_funcs *funcs)
151{
152 encoder->helper_private = (void *)funcs;
153}
154
Dave Airlie0b4c0f32010-03-30 05:34:15 +0000155static inline void drm_connector_helper_add(struct drm_connector *connector,
Dave Airlief453ba02008-11-07 14:05:41 -0800156 const struct drm_connector_helper_funcs *funcs)
157{
158 connector->helper_private = (void *)funcs;
Dave Airlief453ba02008-11-07 14:05:41 -0800159}
160
161extern int drm_helper_resume_force_mode(struct drm_device *dev);
Dave Airlieeb1f8e42010-05-07 06:42:51 +0000162extern void drm_kms_helper_poll_init(struct drm_device *dev);
163extern void drm_kms_helper_poll_fini(struct drm_device *dev);
164extern void drm_helper_hpd_irq_event(struct drm_device *dev);
Dave Airliefbf81762010-06-01 09:09:06 +1000165
166extern void drm_kms_helper_poll_disable(struct drm_device *dev);
167extern void drm_kms_helper_poll_enable(struct drm_device *dev);
Ville Syrjäläd0d110e2011-12-20 00:33:24 +0200168
Dave Airlief453ba02008-11-07 14:05:41 -0800169#endif