[deliverable/linux.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>

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,
			   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);

	/* 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);
};

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,
			   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);
};

struct drm_connector_helper_funcs {
	int (*get_modes)(struct drm_connector *connector);
	int (*mode_valid)(struct drm_connector *connector,
			  struct drm_display_mode *mode);
	struct drm_encoder *(*best_encoder)(struct drm_connector *connector);
};

extern int drm_helper_probe_single_connector_modes(struct drm_connector *connector, uint32_t maxX, uint32_t maxY);
extern void drm_helper_disable_unused_functions(struct drm_device *dev);
extern int drm_helper_hotplug_stage_two(struct drm_device *dev);
extern bool drm_helper_initial_config(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 void drm_helper_connector_dpms(struct drm_connector *connector, int mode);

extern int drm_helper_mode_fill_fb_struct(struct drm_framebuffer *fb,
					  struct drm_mode_fb_cmd *mode_cmd);

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

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

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

extern int drm_helper_resume_force_mode(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
	42	struct drm_crtc_helper_funcs {
	43	/*
	44	* Control power levels on the CRTC. If the mode passed in is
	45	* unsupported, the provider must use the next lowest power level.
	46	*/
	47	void (dpms)(struct drm_crtc crtc, int mode);
	48	void (prepare)(struct drm_crtc crtc);
	49	void (commit)(struct drm_crtc crtc);
	50
	51	/* Provider can fixup or change mode timings before modeset occurs */
	52	bool (mode_fixup)(struct drm_crtc crtc,
	53	struct drm_display_mode *mode,
	54	struct drm_display_mode *adjusted_mode);
	55	/* Actually set the mode */
5c3b82e2 CW	56	int (mode_set)(struct drm_crtc crtc, struct drm_display_mode *mode,
	57	struct drm_display_mode *adjusted_mode, int x, int y,
	58	struct drm_framebuffer *old_fb);
f453ba04 DA	59
f453ba04 DA	60	/* Move the crtc on the current fb to the given position optional */
5c3b82e2 CW	61	int (mode_set_base)(struct drm_crtc crtc, int x, int y,
5c3b82e2 CW	62	struct drm_framebuffer *old_fb);
f453ba04 DA	63	};
	64
	65	struct drm_encoder_helper_funcs {
	66	void (dpms)(struct drm_encoder encoder, int mode);
	67	void (save)(struct drm_encoder encoder);
	68	void (restore)(struct drm_encoder encoder);
	69
	70	bool (mode_fixup)(struct drm_encoder encoder,
	71	struct drm_display_mode *mode,
	72	struct drm_display_mode *adjusted_mode);
	73	void (prepare)(struct drm_encoder encoder);
	74	void (commit)(struct drm_encoder encoder);
	75	void (mode_set)(struct drm_encoder encoder,
	76	struct drm_display_mode *mode,
	77	struct drm_display_mode *adjusted_mode);
7bec756c	78	struct drm_crtc (get_crtc)(struct drm_encoder *encoder);
f453ba04 DA	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
40a518d9	91	extern int drm_helper_probe_single_connector_modes(struct drm_connector *connector, uint32_t maxX, uint32_t maxY);
f453ba04 DA	92	extern void drm_helper_disable_unused_functions(struct drm_device *dev);
f453ba04 DA	93	extern int drm_helper_hotplug_stage_two(struct drm_device *dev);
7a1fb5d0	94	extern bool drm_helper_initial_config(struct drm_device *dev);
f453ba04 DA	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,
3c4fdcfb KH	98	int x, int y,
3c4fdcfb KH	99	struct drm_framebuffer *old_fb);
f453ba04 DA	100	extern bool drm_helper_crtc_in_use(struct drm_crtc *crtc);
f453ba04 DA	101
c9fb15f6 KP	102	extern void drm_helper_connector_dpms(struct drm_connector *connector, int mode);
c9fb15f6 KP	103
f453ba04 DA	104	extern int drm_helper_mode_fill_fb_struct(struct drm_framebuffer *fb,
	105	struct drm_mode_fb_cmd *mode_cmd);
	106
	107	static inline void drm_crtc_helper_add(struct drm_crtc *crtc,
	108	const struct drm_crtc_helper_funcs *funcs)
	109	{
	110	crtc->helper_private = (void *)funcs;
	111	}
	112
	113	static inline void drm_encoder_helper_add(struct drm_encoder *encoder,
	114	const struct drm_encoder_helper_funcs *funcs)
	115	{
	116	encoder->helper_private = (void *)funcs;
	117	}
	118
	119	static inline void drm_connector_helper_add(struct drm_connector *connector,
	120	const struct drm_connector_helper_funcs *funcs)
	121	{
	122	connector->helper_private = (void *)funcs;
	123	}
	124
	125	extern int drm_helper_resume_force_mode(struct drm_device *dev);
	126	#endif