[mirror_ubuntu-zesty-kernel.git] / drivers / gpu / drm / i915 / dvo.h

/*
 * Copyright © 2006 Eric Anholt
 *
 * Permission to use, copy, modify, distribute, and sell this software and its
 * documentation for any purpose is hereby granted without fee, provided that
 * the above copyright notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting documentation, and
 * that the name of the copyright holders not be used in advertising or
 * publicity pertaining to distribution of the software without specific,
 * written prior permission.  The copyright holders make no representations
 * about the suitability of this software for any purpose.  It is provided "as
 * is" without express or implied warranty.
 *
 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
 * OF THIS SOFTWARE.
 */

#ifndef _INTEL_DVO_H
#define _INTEL_DVO_H

#include <linux/i2c.h>
#include "drmP.h"
#include "drm.h"
#include "drm_crtc.h"
#include "intel_drv.h"

struct intel_dvo_device {
	char *name;
	int type;
	/* DVOA/B/C output register */
	u32 dvo_reg;
	/* GPIO register used for i2c bus to control this device */
	u32 gpio;
	int slave_addr;
	struct i2c_adapter *i2c_bus;

	const struct intel_dvo_dev_ops *dev_ops;
	void *dev_priv;

	struct drm_display_mode *panel_fixed_mode;
	bool panel_wants_dither;
};

struct intel_dvo_dev_ops {
	/*
	 * Initialize the device at startup time.
	 * Returns NULL if the device does not exist.
	 */
	bool (*init)(struct intel_dvo_device *dvo,
		     struct i2c_adapter *i2cbus);

	/*
	 * Called to allow the output a chance to create properties after the
	 * RandR objects have been created.
	 */
	void (*create_resources)(struct intel_dvo_device *dvo);

	/*
	 * Turn on/off output or set intermediate power levels if available.
	 *
	 * Unsupported intermediate modes drop to the lower power setting.
	 * If the  mode is DPMSModeOff, the output must be disabled,
	 * as the DPLL may be disabled afterwards.
	 */
	void (*dpms)(struct intel_dvo_device *dvo, int mode);

	/*
	 * Saves the output's state for restoration on VT switch.
	 */
	void (*save)(struct intel_dvo_device *dvo);

	/*
	 * Restore's the output's state at VT switch.
	 */
	void (*restore)(struct intel_dvo_device *dvo);

	/*
	 * Callback for testing a video mode for a given output.
	 *
	 * This function should only check for cases where a mode can't
	 * be supported on the output specifically, and not represent
	 * generic CRTC limitations.
	 *
	 * \return MODE_OK if the mode is valid, or another MODE_* otherwise.
	 */
	int (*mode_valid)(struct intel_dvo_device *dvo,
			  struct drm_display_mode *mode);

	/*
	 * Callback to adjust the mode to be set in the CRTC.
	 *
	 * This allows an output to adjust the clock or even the entire set of
	 * timings, which is used for panels with fixed timings or for
	 * buses with clock limitations.
	 */
	bool (*mode_fixup)(struct intel_dvo_device *dvo,
			   struct drm_display_mode *mode,
			   struct drm_display_mode *adjusted_mode);

	/*
	 * Callback for preparing mode changes on an output
	 */
	void (*prepare)(struct intel_dvo_device *dvo);

	/*
	 * Callback for committing mode changes on an output
	 */
	void (*commit)(struct intel_dvo_device *dvo);

	/*
	 * Callback for setting up a video mode after fixups have been made.
	 *
	 * This is only called while the output is disabled.  The dpms callback
	 * must be all that's necessary for the output, to turn the output on
	 * after this function is called.
	 */
	void (*mode_set)(struct intel_dvo_device *dvo,
			 struct drm_display_mode *mode,
			 struct drm_display_mode *adjusted_mode);

	/*
	 * Probe for a connected output, and return detect_status.
	 */
	enum drm_connector_status (*detect)(struct intel_dvo_device *dvo);

	/**
	 * Query the device for the modes it provides.
	 *
	 * This function may also update MonInfo, mm_width, and mm_height.
	 *
	 * \return singly-linked list of modes or NULL if no modes found.
	 */
	struct drm_display_mode *(*get_modes)(struct intel_dvo_device *dvo);

	/**
	 * Clean up driver-specific bits of the output
	 */
	void (*destroy) (struct intel_dvo_device *dvo);

	/**
	 * Debugging hook to dump device registers to log file
	 */
	void (*dump_regs)(struct intel_dvo_device *dvo);
};

extern struct intel_dvo_dev_ops sil164_ops;
extern struct intel_dvo_dev_ops ch7xxx_ops;
extern struct intel_dvo_dev_ops ivch_ops;
extern struct intel_dvo_dev_ops tfp410_ops;
extern struct intel_dvo_dev_ops ch7017_ops;

#endif /* _INTEL_DVO_H */
Commit	Line	Data
79e53945 JB	1	/*
	2	* Copyright © 2006 Eric Anholt
	3	*
	4	* Permission to use, copy, modify, distribute, and sell this software and its
	5	* documentation for any purpose is hereby granted without fee, provided that
	6	* the above copyright notice appear in all copies and that both that copyright
	7	* notice and this permission notice appear in supporting documentation, and
	8	* that the name of the copyright holders not be used in advertising or
	9	* publicity pertaining to distribution of the software without specific,
	10	* written prior permission. The copyright holders make no representations
	11	* about the suitability of this software for any purpose. It is provided "as
	12	* is" without express or implied warranty.
	13	*
	14	* THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
	15	* INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
	16	* EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
	17	* CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
	18	* DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
	19	* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
	20	* OF THIS SOFTWARE.
	21	*/
	22
	23	#ifndef _INTEL_DVO_H
	24	#define _INTEL_DVO_H
	25
	26	#include <linux/i2c.h>
	27	#include "drmP.h"
	28	#include "drm.h"
	29	#include "drm_crtc.h"
	30	#include "intel_drv.h"
	31
	32	struct intel_dvo_device {
	33	char *name;
	34	int type;
	35	/* DVOA/B/C output register */
	36	u32 dvo_reg;
	37	/* GPIO register used for i2c bus to control this device */
	38	u32 gpio;
	39	int slave_addr;
f9c10a9b	40	struct i2c_adapter *i2c_bus;
79e53945 JB	41
	42	const struct intel_dvo_dev_ops *dev_ops;
	43	void *dev_priv;
	44
	45	struct drm_display_mode *panel_fixed_mode;
	46	bool panel_wants_dither;
	47	};
	48
	49	struct intel_dvo_dev_ops {
	50	/*
	51	* Initialize the device at startup time.
	52	* Returns NULL if the device does not exist.
	53	*/
	54	bool (init)(struct intel_dvo_device dvo,
f9c10a9b	55	struct i2c_adapter *i2cbus);
79e53945 JB	56
	57	/*
	58	* Called to allow the output a chance to create properties after the
	59	* RandR objects have been created.
	60	*/
	61	void (create_resources)(struct intel_dvo_device dvo);
	62
	63	/*
	64	* Turn on/off output or set intermediate power levels if available.
	65	*
	66	* Unsupported intermediate modes drop to the lower power setting.
	67	* If the mode is DPMSModeOff, the output must be disabled,
	68	* as the DPLL may be disabled afterwards.
	69	*/
	70	void (dpms)(struct intel_dvo_device dvo, int mode);
	71
	72	/*
	73	* Saves the output's state for restoration on VT switch.
	74	*/
	75	void (save)(struct intel_dvo_device dvo);
	76
	77	/*
	78	* Restore's the output's state at VT switch.
	79	*/
	80	void (restore)(struct intel_dvo_device dvo);
	81
	82	/*
	83	* Callback for testing a video mode for a given output.
	84	*
	85	* This function should only check for cases where a mode can't
	86	* be supported on the output specifically, and not represent
	87	* generic CRTC limitations.
	88	*
	89	* \return MODE_OK if the mode is valid, or another MODE_* otherwise.
	90	*/
	91	int (mode_valid)(struct intel_dvo_device dvo,
	92	struct drm_display_mode *mode);
	93
	94	/*
	95	* Callback to adjust the mode to be set in the CRTC.
	96	*
	97	* This allows an output to adjust the clock or even the entire set of
	98	* timings, which is used for panels with fixed timings or for
	99	* buses with clock limitations.
	100	*/
	101	bool (mode_fixup)(struct intel_dvo_device dvo,
	102	struct drm_display_mode *mode,
	103	struct drm_display_mode *adjusted_mode);
	104
	105	/*
	106	* Callback for preparing mode changes on an output
	107	*/
	108	void (prepare)(struct intel_dvo_device dvo);
	109
	110	/*
	111	* Callback for committing mode changes on an output
	112	*/
	113	void (commit)(struct intel_dvo_device dvo);
	114
	115	/*
	116	* Callback for setting up a video mode after fixups have been made.
	117	*
	118	* This is only called while the output is disabled. The dpms callback
	119	* must be all that's necessary for the output, to turn the output on
120	* after this function is called.
121	*/
122	void (mode_set)(struct intel_dvo_device dvo,
123	struct drm_display_mode *mode,
124	struct drm_display_mode *adjusted_mode);
125
126	/*
127	* Probe for a connected output, and return detect_status.
128	*/
129	enum drm_connector_status (detect)(struct intel_dvo_device dvo);
130
131	/**
132	* Query the device for the modes it provides.
133	*
134	* This function may also update MonInfo, mm_width, and mm_height.
135	*
136	* \return singly-linked list of modes or NULL if no modes found.
137	*/
138	struct drm_display_mode (get_modes)(struct intel_dvo_device *dvo);
139
140	/**
141	* Clean up driver-specific bits of the output
142	*/
143	void (destroy) (struct intel_dvo_device dvo);
144
145	/**
146	* Debugging hook to dump device registers to log file
147	*/
148	void (dump_regs)(struct intel_dvo_device dvo);
149	};
150
606df4e0 HE	151	extern struct intel_dvo_dev_ops sil164_ops;
	152	extern struct intel_dvo_dev_ops ch7xxx_ops;
	153	extern struct intel_dvo_dev_ops ivch_ops;
	154	extern struct intel_dvo_dev_ops tfp410_ops;
	155	extern struct intel_dvo_dev_ops ch7017_ops;
	156
79e53945	157	#endif /* _INTEL_DVO_H */