[mirror_ubuntu-zesty-kernel.git] / include / drm / drm_crtc_helper.h

/*
 * Copyright © 2006 Keith Packard
 * Copyright © 2007-2008 Dave Airlie
 * Copyright © 2007-2008 Intel Corporation
 *   Jesse Barnes <jesse.barnes@intel.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */

/*
 * The DRM mode setting helper functions are common code for drivers to use if
 * they wish.  Drivers are not forced to use this code in their
 * implementations but it would be useful if they code they do use at least
 * provides a consistent interface and operation to userspace
 */

#ifndef __DRM_CRTC_HELPER_H__
#define __DRM_CRTC_HELPER_H__

#include <linux/spinlock.h>
#include <linux/types.h>
#include <linux/idr.h>

#include <linux/fb.h>

#include <drm/drm_crtc.h>

enum mode_set_atomic {
	LEAVE_ATOMIC_MODE_SET,
	ENTER_ATOMIC_MODE_SET,
};

/**
 * struct drm_crtc_helper_funcs - helper operations for CRTCs
 * @dpms: set power state
 * @prepare: prepare the CRTC, called before @mode_set
 * @commit: commit changes to CRTC, called after @mode_set
 * @mode_fixup: try to fixup proposed mode for this CRTC
 * @mode_set: set this mode
 * @mode_set_nofb: set mode only (no scanout buffer attached)
 * @mode_set_base: update the scanout buffer
 * @mode_set_base_atomic: non-blocking mode set (used for kgdb support)
 * @load_lut: load color palette
 * @disable: disable CRTC when no longer in use
 * @enable: enable CRTC
 * @atomic_check: check for validity of an atomic state
 * @atomic_begin: begin atomic update
 * @atomic_flush: flush atomic update
 *
 * The helper operations are called by the mid-layer CRTC helper.
 *
 * Note that with atomic helpers @dpms, @prepare and @commit hooks are
 * deprecated. Used @enable and @disable instead exclusively.
 *
 * With legacy crtc helpers there's a big semantic difference between @disable
 * and the other hooks: @disable also needs to release any resources acquired in
 * @mode_set (like shared PLLs).
 */
struct drm_crtc_helper_funcs {
	/*
	 * Control power levels on the CRTC.  If the mode passed in is
	 * unsupported, the provider must use the next lowest power level.
	 */
	void (*dpms)(struct drm_crtc *crtc, int mode);
	void (*prepare)(struct drm_crtc *crtc);
	void (*commit)(struct drm_crtc *crtc);

	/* Provider can fixup or change mode timings before modeset occurs */
	bool (*mode_fixup)(struct drm_crtc *crtc,
			   const struct drm_display_mode *mode,
			   struct drm_display_mode *adjusted_mode);
	/* Actually set the mode */
	int (*mode_set)(struct drm_crtc *crtc, struct drm_display_mode *mode,
			struct drm_display_mode *adjusted_mode, int x, int y,
			struct drm_framebuffer *old_fb);
	/* Actually set the mode for atomic helpers, optional */
	void (*mode_set_nofb)(struct drm_crtc *crtc);

	/* Move the crtc on the current fb to the given position *optional* */
	int (*mode_set_base)(struct drm_crtc *crtc, int x, int y,
			     struct drm_framebuffer *old_fb);
	int (*mode_set_base_atomic)(struct drm_crtc *crtc,
				    struct drm_framebuffer *fb, int x, int y,
				    enum mode_set_atomic);

	/* reload the current crtc LUT */
	void (*load_lut)(struct drm_crtc *crtc);

	void (*disable)(struct drm_crtc *crtc);
	void (*enable)(struct drm_crtc *crtc);

	/* atomic helpers */
	int (*atomic_check)(struct drm_crtc *crtc,
			    struct drm_crtc_state *state);
	void (*atomic_begin)(struct drm_crtc *crtc,
			     struct drm_crtc_state *old_crtc_state);
	void (*atomic_flush)(struct drm_crtc *crtc,
			     struct drm_crtc_state *old_crtc_state);
};

/**
 * struct drm_encoder_helper_funcs - helper operations for encoders
 * @dpms: set power state
 * @save: save connector state
 * @restore: restore connector state
 * @mode_fixup: try to fixup proposed mode for this connector
 * @prepare: part of the disable sequence, called before the CRTC modeset
 * @commit: called after the CRTC modeset
 * @mode_set: set this mode, optional for atomic helpers
 * @get_crtc: return CRTC that the encoder is currently attached to
 * @detect: connection status detection
 * @disable: disable encoder when not in use (overrides DPMS off)
 * @enable: enable encoder
 * @atomic_check: check for validity of an atomic update
 *
 * The helper operations are called by the mid-layer CRTC helper.
 *
 * Note that with atomic helpers @dpms, @prepare and @commit hooks are
 * deprecated. Used @enable and @disable instead exclusively.
 *
 * With legacy crtc helpers there's a big semantic difference between @disable
 * and the other hooks: @disable also needs to release any resources acquired in
 * @mode_set (like shared PLLs).
 */
struct drm_encoder_helper_funcs {
	void (*dpms)(struct drm_encoder *encoder, int mode);
	void (*save)(struct drm_encoder *encoder);
	void (*restore)(struct drm_encoder *encoder);

	bool (*mode_fixup)(struct drm_encoder *encoder,
			   const struct drm_display_mode *mode,
			   struct drm_display_mode *adjusted_mode);
	void (*prepare)(struct drm_encoder *encoder);
	void (*commit)(struct drm_encoder *encoder);
	void (*mode_set)(struct drm_encoder *encoder,
			 struct drm_display_mode *mode,
			 struct drm_display_mode *adjusted_mode);
	struct drm_crtc *(*get_crtc)(struct drm_encoder *encoder);
	/* detect for DAC style encoders */
	enum drm_connector_status (*detect)(struct drm_encoder *encoder,
					    struct drm_connector *connector);
	void (*disable)(struct drm_encoder *encoder);

	void (*enable)(struct drm_encoder *encoder);

	/* atomic helpers */
	int (*atomic_check)(struct drm_encoder *encoder,
			    struct drm_crtc_state *crtc_state,
			    struct drm_connector_state *conn_state);
};

/**
 * struct drm_connector_helper_funcs - helper operations for connectors
 * @get_modes: get mode list for this connector
 * @mode_valid: is this mode valid on the given connector? (optional)
 * @best_encoder: return the preferred encoder for this connector
 * @atomic_best_encoder: atomic version of @best_encoder
 *
 * The helper operations are called by the mid-layer CRTC helper.
 */
struct drm_connector_helper_funcs {
	int (*get_modes)(struct drm_connector *connector);
	enum drm_mode_status (*mode_valid)(struct drm_connector *connector,
					   struct drm_display_mode *mode);
	struct drm_encoder *(*best_encoder)(struct drm_connector *connector);
	struct drm_encoder *(*atomic_best_encoder)(struct drm_connector *connector,
						   struct drm_connector_state *connector_state);
};

extern void drm_helper_disable_unused_functions(struct drm_device *dev);
extern int drm_crtc_helper_set_config(struct drm_mode_set *set);
extern bool drm_crtc_helper_set_mode(struct drm_crtc *crtc,
				     struct drm_display_mode *mode,
				     int x, int y,
				     struct drm_framebuffer *old_fb);
extern bool drm_helper_crtc_in_use(struct drm_crtc *crtc);
extern bool drm_helper_encoder_in_use(struct drm_encoder *encoder);

extern int drm_helper_connector_dpms(struct drm_connector *connector, int mode);

extern void drm_helper_move_panel_connectors_to_head(struct drm_device *);

extern void drm_helper_mode_fill_fb_struct(struct drm_framebuffer *fb,
					   struct drm_mode_fb_cmd2 *mode_cmd);

static inline void drm_crtc_helper_add(struct drm_crtc *crtc,
				       const struct drm_crtc_helper_funcs *funcs)
{
	crtc->helper_private = funcs;
}

static inline void drm_encoder_helper_add(struct drm_encoder *encoder,
					  const struct drm_encoder_helper_funcs *funcs)
{
	encoder->helper_private = funcs;
}

static inline void drm_connector_helper_add(struct drm_connector *connector,
					    const struct drm_connector_helper_funcs *funcs)
{
	connector->helper_private = funcs;
}

extern void drm_helper_resume_force_mode(struct drm_device *dev);

int drm_helper_crtc_mode_set(struct drm_crtc *crtc, struct drm_display_mode *mode,
			     struct drm_display_mode *adjusted_mode, int x, int y,
			     struct drm_framebuffer *old_fb);
int drm_helper_crtc_mode_set_base(struct drm_crtc *crtc, int x, int y,
				  struct drm_framebuffer *old_fb);

/* drm_probe_helper.c */
extern int drm_helper_probe_single_connector_modes(struct drm_connector
						   *connector, uint32_t maxX,
						   uint32_t maxY);
extern int drm_helper_probe_single_connector_modes_nomerge(struct drm_connector
							   *connector,
							   uint32_t maxX,
							   uint32_t maxY);
extern void drm_kms_helper_poll_init(struct drm_device *dev);
extern void drm_kms_helper_poll_fini(struct drm_device *dev);
extern bool drm_helper_hpd_irq_event(struct drm_device *dev);
extern void drm_kms_helper_hotplug_event(struct drm_device *dev);

extern void drm_kms_helper_poll_disable(struct drm_device *dev);
extern void drm_kms_helper_poll_enable(struct drm_device *dev);
extern void drm_kms_helper_poll_enable_locked(struct drm_device *dev);

#endif
Commit	Line	Data
f453ba04 DA	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
f453ba04 DA	36	#include <linux/spinlock.h>
	37	#include <linux/types.h>
	38	#include <linux/idr.h>
	39
	40	#include <linux/fb.h>
	41
6d11a2f0 TR	42	#include <drm/drm_crtc.h>
6d11a2f0 TR	43
21c74a8e JW	44	enum mode_set_atomic {
	45	LEAVE_ATOMIC_MODE_SET,
	46	ENTER_ATOMIC_MODE_SET,
	47	};
	48
3b02ab88	49	/**
7552e7dd TR	50	* struct drm_crtc_helper_funcs - helper operations for CRTCs
	51	* @dpms: set power state
	52	* @prepare: prepare the CRTC, called before @mode_set
	53	* @commit: commit changes to CRTC, called after @mode_set
	54	* @mode_fixup: try to fixup proposed mode for this CRTC
3b02ab88	55	* @mode_set: set this mode
7552e7dd TR	56	* @mode_set_nofb: set mode only (no scanout buffer attached)
	57	* @mode_set_base: update the scanout buffer
	58	* @mode_set_base_atomic: non-blocking mode set (used for kgdb support)
	59	* @load_lut: load color palette
	60	* @disable: disable CRTC when no longer in use
ee0a89cf	61	* @enable: enable CRTC
7552e7dd TR	62	* @atomic_check: check for validity of an atomic state
	63	* @atomic_begin: begin atomic update
	64	* @atomic_flush: flush atomic update
3b02ab88 LP	65	*
3b02ab88 LP	66	* The helper operations are called by the mid-layer CRTC helper.
ee0a89cf DV	67	*
	68	* Note that with atomic helpers @dpms, @prepare and @commit hooks are
	69	* deprecated. Used @enable and @disable instead exclusively.
	70	*
	71	* With legacy crtc helpers there's a big semantic difference between @disable
	72	* and the other hooks: @disable also needs to release any resources acquired in
	73	* @mode_set (like shared PLLs).
3b02ab88	74	*/
f453ba04 DA	75	struct drm_crtc_helper_funcs {
	76	/*
	77	* Control power levels on the CRTC. If the mode passed in is
	78	* unsupported, the provider must use the next lowest power level.
	79	*/
	80	void (dpms)(struct drm_crtc crtc, int mode);
	81	void (prepare)(struct drm_crtc crtc);
	82	void (commit)(struct drm_crtc crtc);
	83
	84	/* Provider can fixup or change mode timings before modeset occurs */
	85	bool (mode_fixup)(struct drm_crtc crtc,
e811f5ae	86	const struct drm_display_mode *mode,
f453ba04 DA	87	struct drm_display_mode *adjusted_mode);
f453ba04 DA	88	/* Actually set the mode */
5c3b82e2 CW	89	int (mode_set)(struct drm_crtc crtc, struct drm_display_mode *mode,
	90	struct drm_display_mode *adjusted_mode, int x, int y,
	91	struct drm_framebuffer *old_fb);
c982bd90	92	/* Actually set the mode for atomic helpers, optional */
2f324b42	93	void (mode_set_nofb)(struct drm_crtc crtc);
f453ba04 DA	94
f453ba04 DA	95	/* Move the crtc on the current fb to the given position optional */
5c3b82e2 CW	96	int (mode_set_base)(struct drm_crtc crtc, int x, int y,
5c3b82e2 CW	97	struct drm_framebuffer *old_fb);
1a7aba7f	98	int (mode_set_base_atomic)(struct drm_crtc crtc,
413d45d3	99	struct drm_framebuffer *fb, int x, int y,
21c74a8e	100	enum mode_set_atomic);
068143d3 DA	101
	102	/* reload the current crtc LUT */
	103	void (load_lut)(struct drm_crtc crtc);
5c8d7171	104
5c8d7171	105	void (disable)(struct drm_crtc crtc);
ee0a89cf	106	void (enable)(struct drm_crtc crtc);
c2fcd274 DV	107
	108	/* atomic helpers */
	109	int (atomic_check)(struct drm_crtc crtc,
	110	struct drm_crtc_state *state);
613d2b27 ML	111	void (atomic_begin)(struct drm_crtc crtc,
	112	struct drm_crtc_state *old_crtc_state);
	113	void (atomic_flush)(struct drm_crtc crtc,
	114	struct drm_crtc_state *old_crtc_state);
f453ba04 DA	115	};
f453ba04 DA	116
3b02ab88	117	/**
7552e7dd TR	118	* struct drm_encoder_helper_funcs - helper operations for encoders
	119	* @dpms: set power state
	120	* @save: save connector state
	121	* @restore: restore connector state
3b02ab88	122	* @mode_fixup: try to fixup proposed mode for this connector
7552e7dd TR	123	* @prepare: part of the disable sequence, called before the CRTC modeset
7552e7dd TR	124	* @commit: called after the CRTC modeset
c982bd90	125	* @mode_set: set this mode, optional for atomic helpers
7552e7dd TR	126	* @get_crtc: return CRTC that the encoder is currently attached to
	127	* @detect: connection status detection
	128	* @disable: disable encoder when not in use (overrides DPMS off)
ee0a89cf	129	* @enable: enable encoder
4cd4df80	130	* @atomic_check: check for validity of an atomic update
3b02ab88 LP	131	*
3b02ab88 LP	132	* The helper operations are called by the mid-layer CRTC helper.
ee0a89cf DV	133	*
	134	* Note that with atomic helpers @dpms, @prepare and @commit hooks are
	135	* deprecated. Used @enable and @disable instead exclusively.
	136	*
	137	* With legacy crtc helpers there's a big semantic difference between @disable
	138	* and the other hooks: @disable also needs to release any resources acquired in
	139	* @mode_set (like shared PLLs).
3b02ab88	140	*/
f453ba04 DA	141	struct drm_encoder_helper_funcs {
	142	void (dpms)(struct drm_encoder encoder, int mode);
	143	void (save)(struct drm_encoder encoder);
	144	void (restore)(struct drm_encoder encoder);
	145
	146	bool (mode_fixup)(struct drm_encoder encoder,
e811f5ae	147	const struct drm_display_mode *mode,
f453ba04 DA	148	struct drm_display_mode *adjusted_mode);
	149	void (prepare)(struct drm_encoder encoder);
	150	void (commit)(struct drm_encoder encoder);
	151	void (mode_set)(struct drm_encoder encoder,
	152	struct drm_display_mode *mode,
	153	struct drm_display_mode *adjusted_mode);
7bec756c	154	struct drm_crtc (get_crtc)(struct drm_encoder *encoder);
f453ba04 DA	155	/* detect for DAC style encoders */
	156	enum drm_connector_status (detect)(struct drm_encoder encoder,
	157	struct drm_connector *connector);
a3a0544b	158	void (disable)(struct drm_encoder encoder);
21773f16	159
ee0a89cf	160	void (enable)(struct drm_encoder encoder);
4cd4df80 TR	161
	162	/* atomic helpers */
	163	int (atomic_check)(struct drm_encoder encoder,
	164	struct drm_crtc_state *crtc_state,
	165	struct drm_connector_state *conn_state);
f453ba04 DA	166	};
f453ba04 DA	167
3b02ab88	168	/**
7552e7dd	169	* struct drm_connector_helper_funcs - helper operations for connectors
3b02ab88	170	* @get_modes: get mode list for this connector
7552e7dd TR	171	* @mode_valid: is this mode valid on the given connector? (optional)
7552e7dd TR	172	* @best_encoder: return the preferred encoder for this connector
3b8a684b	173	* @atomic_best_encoder: atomic version of @best_encoder
3b02ab88 LP	174	*
	175	* The helper operations are called by the mid-layer CRTC helper.
	176	*/
f453ba04 DA	177	struct drm_connector_helper_funcs {
f453ba04 DA	178	int (get_modes)(struct drm_connector connector);
0993f1d0 DL	179	enum drm_mode_status (mode_valid)(struct drm_connector connector,
0993f1d0 DL	180	struct drm_display_mode *mode);
f453ba04	181	struct drm_encoder (best_encoder)(struct drm_connector *connector);
3b8a684b DV	182	struct drm_encoder (atomic_best_encoder)(struct drm_connector *connector,
3b8a684b DV	183	struct drm_connector_state *connector_state);
f453ba04 DA	184	};
f453ba04 DA	185
f453ba04	186	extern void drm_helper_disable_unused_functions(struct drm_device *dev);
f453ba04 DA	187	extern int drm_crtc_helper_set_config(struct drm_mode_set *set);
	188	extern bool drm_crtc_helper_set_mode(struct drm_crtc *crtc,
	189	struct drm_display_mode *mode,
3c4fdcfb KH	190	int x, int y,
3c4fdcfb KH	191	struct drm_framebuffer *old_fb);
f453ba04	192	extern bool drm_helper_crtc_in_use(struct drm_crtc *crtc);
f380ef86	193	extern bool drm_helper_encoder_in_use(struct drm_encoder *encoder);
f453ba04	194
9a69a9ac	195	extern int drm_helper_connector_dpms(struct drm_connector *connector, int mode);
c9fb15f6	196
cfc1a062 DV	197	extern void drm_helper_move_panel_connectors_to_head(struct drm_device *);
cfc1a062 DV	198
9fd93784 DV	199	extern void drm_helper_mode_fill_fb_struct(struct drm_framebuffer *fb,
9fd93784 DV	200	struct drm_mode_fb_cmd2 *mode_cmd);
f453ba04 DA	201
	202	static inline void drm_crtc_helper_add(struct drm_crtc *crtc,
	203	const struct drm_crtc_helper_funcs *funcs)
	204	{
9a436ee6	205	crtc->helper_private = funcs;
f453ba04 DA	206	}
	207
	208	static inline void drm_encoder_helper_add(struct drm_encoder *encoder,
	209	const struct drm_encoder_helper_funcs *funcs)
	210	{
9a436ee6	211	encoder->helper_private = funcs;
f453ba04 DA	212	}
f453ba04 DA	213
0b4c0f3f	214	static inline void drm_connector_helper_add(struct drm_connector *connector,
f453ba04 DA	215	const struct drm_connector_helper_funcs *funcs)
f453ba04 DA	216	{
9a436ee6	217	connector->helper_private = funcs;
f453ba04 DA	218	}
f453ba04 DA	219
00d762cb	220	extern void drm_helper_resume_force_mode(struct drm_device *dev);
8d754544	221
2f324b42 DV	222	int drm_helper_crtc_mode_set(struct drm_crtc crtc, struct drm_display_mode mode,
	223	struct drm_display_mode *adjusted_mode, int x, int y,
	224	struct drm_framebuffer *old_fb);
	225	int drm_helper_crtc_mode_set_base(struct drm_crtc *crtc, int x, int y,
	226	struct drm_framebuffer *old_fb);
	227
8d754544 DV	228	/* drm_probe_helper.c */
	229	extern int drm_helper_probe_single_connector_modes(struct drm_connector
	230	*connector, uint32_t maxX,
	231	uint32_t maxY);
b87577b7 DA	232	extern int drm_helper_probe_single_connector_modes_nomerge(struct drm_connector
	233	*connector,
	234	uint32_t maxX,
	235	uint32_t maxY);
eb1f8e4f DA	236	extern void drm_kms_helper_poll_init(struct drm_device *dev);
eb1f8e4f DA	237	extern void drm_kms_helper_poll_fini(struct drm_device *dev);
b8206d39	238	extern bool drm_helper_hpd_irq_event(struct drm_device *dev);
3d3683f0	239	extern void drm_kms_helper_hotplug_event(struct drm_device *dev);
fbf81762 DA	240
	241	extern void drm_kms_helper_poll_disable(struct drm_device *dev);
	242	extern void drm_kms_helper_poll_enable(struct drm_device *dev);
4ad640e9	243	extern void drm_kms_helper_poll_enable_locked(struct drm_device *dev);
d0d110e0	244
f453ba04	245	#endif