[deliverable/linux.git] / include / drm / drm_modes.h

/*
 * Copyright © 2006 Keith Packard
 * Copyright © 2007-2008 Dave Airlie
 * Copyright © 2007-2008 Intel Corporation
 *   Jesse Barnes <jesse.barnes@intel.com>
 * Copyright © 2014 Intel Corporation
 *   Daniel Vetter <daniel.vetter@ffwll.ch>
 *
 * 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.
 */
#ifndef __DRM_MODES_H__
#define __DRM_MODES_H__

/*
 * Note on terminology:  here, for brevity and convenience, we refer to connector
 * control chips as 'CRTCs'.  They can control any type of connector, VGA, LVDS,
 * DVI, etc.  And 'screen' refers to the whole of the visible display, which
 * may span multiple monitors (and therefore multiple CRTC and connector
 * structures).
 */

enum drm_mode_status {
    MODE_OK	= 0,	/* Mode OK */
    MODE_HSYNC,		/* hsync out of range */
    MODE_VSYNC,		/* vsync out of range */
    MODE_H_ILLEGAL,	/* mode has illegal horizontal timings */
    MODE_V_ILLEGAL,	/* mode has illegal horizontal timings */
    MODE_BAD_WIDTH,	/* requires an unsupported linepitch */
    MODE_NOMODE,	/* no mode with a matching name */
    MODE_NO_INTERLACE,	/* interlaced mode not supported */
    MODE_NO_DBLESCAN,	/* doublescan mode not supported */
    MODE_NO_VSCAN,	/* multiscan mode not supported */
    MODE_MEM,		/* insufficient video memory */
    MODE_VIRTUAL_X,	/* mode width too large for specified virtual size */
    MODE_VIRTUAL_Y,	/* mode height too large for specified virtual size */
    MODE_MEM_VIRT,	/* insufficient video memory given virtual size */
    MODE_NOCLOCK,	/* no fixed clock available */
    MODE_CLOCK_HIGH,	/* clock required is too high */
    MODE_CLOCK_LOW,	/* clock required is too low */
    MODE_CLOCK_RANGE,	/* clock/mode isn't in a ClockRange */
    MODE_BAD_HVALUE,	/* horizontal timing was out of range */
    MODE_BAD_VVALUE,	/* vertical timing was out of range */
    MODE_BAD_VSCAN,	/* VScan value out of range */
    MODE_HSYNC_NARROW,	/* horizontal sync too narrow */
    MODE_HSYNC_WIDE,	/* horizontal sync too wide */
    MODE_HBLANK_NARROW,	/* horizontal blanking too narrow */
    MODE_HBLANK_WIDE,	/* horizontal blanking too wide */
    MODE_VSYNC_NARROW,	/* vertical sync too narrow */
    MODE_VSYNC_WIDE,	/* vertical sync too wide */
    MODE_VBLANK_NARROW,	/* vertical blanking too narrow */
    MODE_VBLANK_WIDE,	/* vertical blanking too wide */
    MODE_PANEL,         /* exceeds panel dimensions */
    MODE_INTERLACE_WIDTH, /* width too large for interlaced mode */
    MODE_ONE_WIDTH,     /* only one width is supported */
    MODE_ONE_HEIGHT,    /* only one height is supported */
    MODE_ONE_SIZE,      /* only one resolution is supported */
    MODE_NO_REDUCED,    /* monitor doesn't accept reduced blanking */
    MODE_NO_STEREO,	/* stereo modes not supported */
    MODE_UNVERIFIED = -3, /* mode needs to reverified */
    MODE_BAD = -2,	/* unspecified reason */
    MODE_ERROR	= -1	/* error condition */
};

#define DRM_MODE_TYPE_CLOCK_CRTC_C (DRM_MODE_TYPE_CLOCK_C | \
				    DRM_MODE_TYPE_CRTC_C)

#define DRM_MODE(nm, t, c, hd, hss, hse, ht, hsk, vd, vss, vse, vt, vs, f) \
	.name = nm, .status = 0, .type = (t), .clock = (c), \
	.hdisplay = (hd), .hsync_start = (hss), .hsync_end = (hse), \
	.htotal = (ht), .hskew = (hsk), .vdisplay = (vd), \
	.vsync_start = (vss), .vsync_end = (vse), .vtotal = (vt), \
	.vscan = (vs), .flags = (f), \
	.base.type = DRM_MODE_OBJECT_MODE

#define CRTC_INTERLACE_HALVE_V	(1 << 0) /* halve V values for interlacing */
#define CRTC_STEREO_DOUBLE	(1 << 1) /* adjust timings for stereo modes */

#define DRM_MODE_FLAG_3D_MAX	DRM_MODE_FLAG_3D_SIDE_BY_SIDE_HALF

struct drm_display_mode {
	/* Header */
	struct list_head head;
	struct drm_mode_object base;

	char name[DRM_DISPLAY_MODE_LEN];

	enum drm_mode_status status;
	unsigned int type;

	/* Proposed mode values */
	int clock;		/* in kHz */
	int hdisplay;
	int hsync_start;
	int hsync_end;
	int htotal;
	int hskew;
	int vdisplay;
	int vsync_start;
	int vsync_end;
	int vtotal;
	int vscan;
	unsigned int flags;

	/* Addressable image size (may be 0 for projectors, etc.) */
	int width_mm;
	int height_mm;

	/* Actual mode we give to hw */
	int crtc_clock;		/* in KHz */
	int crtc_hdisplay;
	int crtc_hblank_start;
	int crtc_hblank_end;
	int crtc_hsync_start;
	int crtc_hsync_end;
	int crtc_htotal;
	int crtc_hskew;
	int crtc_vdisplay;
	int crtc_vblank_start;
	int crtc_vblank_end;
	int crtc_vsync_start;
	int crtc_vsync_end;
	int crtc_vtotal;

	/* Driver private mode info */
	int private_size;
	int *private;
	int private_flags;

	int vrefresh;		/* in Hz */
	int hsync;		/* in kHz */
	enum hdmi_picture_aspect picture_aspect_ratio;
};

/* mode specified on the command line */
struct drm_cmdline_mode {
	bool specified;
	bool refresh_specified;
	bool bpp_specified;
	int xres, yres;
	int bpp;
	int refresh;
	bool rb;
	bool interlace;
	bool cvt;
	bool margins;
	enum drm_connector_force force;
};

static inline bool drm_mode_is_stereo(const struct drm_display_mode *mode)
{
	return mode->flags & DRM_MODE_FLAG_3D_MASK;
}

struct drm_connector;
struct drm_cmdline_mode;

struct drm_display_mode *drm_mode_create(struct drm_device *dev);
void drm_mode_destroy(struct drm_device *dev, struct drm_display_mode *mode);
void drm_mode_probed_add(struct drm_connector *connector, struct drm_display_mode *mode);
void drm_mode_debug_printmodeline(const struct drm_display_mode *mode);

struct drm_display_mode *drm_cvt_mode(struct drm_device *dev,
				      int hdisplay, int vdisplay, int vrefresh,
				      bool reduced, bool interlaced,
				      bool margins);
struct drm_display_mode *drm_gtf_mode(struct drm_device *dev,
				      int hdisplay, int vdisplay, int vrefresh,
				      bool interlaced, int margins);
struct drm_display_mode *drm_gtf_mode_complex(struct drm_device *dev,
					      int hdisplay, int vdisplay,
					      int vrefresh, bool interlaced,
					      int margins,
					      int GTF_M, int GTF_2C,
					      int GTF_K, int GTF_2J);
void drm_display_mode_from_videomode(const struct videomode *vm,
				     struct drm_display_mode *dmode);
int of_get_drm_display_mode(struct device_node *np,
			    struct drm_display_mode *dmode,
			    int index);

void drm_mode_set_name(struct drm_display_mode *mode);
int drm_mode_hsync(const struct drm_display_mode *mode);
int drm_mode_vrefresh(const struct drm_display_mode *mode);

void drm_mode_set_crtcinfo(struct drm_display_mode *p,
			   int adjust_flags);
void drm_mode_copy(struct drm_display_mode *dst,
		   const struct drm_display_mode *src);
struct drm_display_mode *drm_mode_duplicate(struct drm_device *dev,
					    const struct drm_display_mode *mode);
bool drm_mode_equal(const struct drm_display_mode *mode1,
		    const struct drm_display_mode *mode2);
bool drm_mode_equal_no_clocks_no_stereo(const struct drm_display_mode *mode1,
					const struct drm_display_mode *mode2);

/* for use by the crtc helper probe functions */
void drm_mode_validate_size(struct drm_device *dev,
			    struct list_head *mode_list,
			    int maxX, int maxY, int maxPitch);
void drm_mode_prune_invalid(struct drm_device *dev,
			    struct list_head *mode_list, bool verbose);
void drm_mode_sort(struct list_head *mode_list);
void drm_mode_connector_list_update(struct drm_connector *connector);

/* parsing cmdline modes */
bool
drm_mode_parse_command_line_for_connector(const char *mode_option,
					  struct drm_connector *connector,
					  struct drm_cmdline_mode *mode);
struct drm_display_mode *
drm_mode_create_from_cmdline_mode(struct drm_device *dev,
				  struct drm_cmdline_mode *cmd);

#endif /* __DRM_MODES_H__ */
Commit	Line	Data
55310008 DV	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	* Copyright © 2014 Intel Corporation
	7	* Daniel Vetter <daniel.vetter@ffwll.ch>
	8	*
	9	* Permission is hereby granted, free of charge, to any person obtaining a
	10	* copy of this software and associated documentation files (the "Software"),
	11	* to deal in the Software without restriction, including without limitation
	12	* the rights to use, copy, modify, merge, publish, distribute, sublicense,
	13	* and/or sell copies of the Software, and to permit persons to whom the
	14	* Software is furnished to do so, subject to the following conditions:
	15	*
	16	* The above copyright notice and this permission notice shall be included in
	17	* all copies or substantial portions of the Software.
	18	*
	19	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	20	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	21	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
	22	* THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
	23	* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
	24	* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
	25	* OTHER DEALINGS IN THE SOFTWARE.
	26	*/
	27	#ifndef __DRM_MODES_H__
	28	#define __DRM_MODES_H__
	29
	30	/*
	31	* Note on terminology: here, for brevity and convenience, we refer to connector
	32	* control chips as 'CRTCs'. They can control any type of connector, VGA, LVDS,
	33	* DVI, etc. And 'screen' refers to the whole of the visible display, which
	34	* may span multiple monitors (and therefore multiple CRTC and connector
	35	* structures).
	36	*/
	37
	38	enum drm_mode_status {
	39	MODE_OK = 0, /* Mode OK */
	40	MODE_HSYNC, /* hsync out of range */
	41	MODE_VSYNC, /* vsync out of range */
	42	MODE_H_ILLEGAL, /* mode has illegal horizontal timings */
	43	MODE_V_ILLEGAL, /* mode has illegal horizontal timings */
	44	MODE_BAD_WIDTH, /* requires an unsupported linepitch */
	45	MODE_NOMODE, /* no mode with a matching name */
	46	MODE_NO_INTERLACE, /* interlaced mode not supported */
	47	MODE_NO_DBLESCAN, /* doublescan mode not supported */
	48	MODE_NO_VSCAN, /* multiscan mode not supported */
	49	MODE_MEM, /* insufficient video memory */
	50	MODE_VIRTUAL_X, /* mode width too large for specified virtual size */
	51	MODE_VIRTUAL_Y, /* mode height too large for specified virtual size */
	52	MODE_MEM_VIRT, /* insufficient video memory given virtual size */
	53	MODE_NOCLOCK, /* no fixed clock available */
	54	MODE_CLOCK_HIGH, /* clock required is too high */
	55	MODE_CLOCK_LOW, /* clock required is too low */
	56	MODE_CLOCK_RANGE, /* clock/mode isn't in a ClockRange */
	57	MODE_BAD_HVALUE, /* horizontal timing was out of range */
	58	MODE_BAD_VVALUE, /* vertical timing was out of range */
	59	MODE_BAD_VSCAN, /* VScan value out of range */
	60	MODE_HSYNC_NARROW, /* horizontal sync too narrow */
	61	MODE_HSYNC_WIDE, /* horizontal sync too wide */
	62	MODE_HBLANK_NARROW, /* horizontal blanking too narrow */
	63	MODE_HBLANK_WIDE, /* horizontal blanking too wide */
	64	MODE_VSYNC_NARROW, /* vertical sync too narrow */
65	MODE_VSYNC_WIDE, /* vertical sync too wide */
66	MODE_VBLANK_NARROW, /* vertical blanking too narrow */
67	MODE_VBLANK_WIDE, /* vertical blanking too wide */
68	MODE_PANEL, /* exceeds panel dimensions */
69	MODE_INTERLACE_WIDTH, /* width too large for interlaced mode */
70	MODE_ONE_WIDTH, /* only one width is supported */
71	MODE_ONE_HEIGHT, /* only one height is supported */
72	MODE_ONE_SIZE, /* only one resolution is supported */
73	MODE_NO_REDUCED, /* monitor doesn't accept reduced blanking */
74	MODE_NO_STEREO, /* stereo modes not supported */
75	MODE_UNVERIFIED = -3, /* mode needs to reverified */
76	MODE_BAD = -2, /* unspecified reason */
77	MODE_ERROR = -1 /* error condition */
78	};
79
80	#define DRM_MODE_TYPE_CLOCK_CRTC_C (DRM_MODE_TYPE_CLOCK_C \| \
81	DRM_MODE_TYPE_CRTC_C)
82
83	#define DRM_MODE(nm, t, c, hd, hss, hse, ht, hsk, vd, vss, vse, vt, vs, f) \
84	.name = nm, .status = 0, .type = (t), .clock = (c), \
85	.hdisplay = (hd), .hsync_start = (hss), .hsync_end = (hse), \
86	.htotal = (ht), .hskew = (hsk), .vdisplay = (vd), \
87	.vsync_start = (vss), .vsync_end = (vse), .vtotal = (vt), \
88	.vscan = (vs), .flags = (f), \
89	.base.type = DRM_MODE_OBJECT_MODE
90
91	#define CRTC_INTERLACE_HALVE_V (1 << 0) /* halve V values for interlacing */
92	#define CRTC_STEREO_DOUBLE (1 << 1) /* adjust timings for stereo modes */
93
94	#define DRM_MODE_FLAG_3D_MAX DRM_MODE_FLAG_3D_SIDE_BY_SIDE_HALF
95
96	struct drm_display_mode {
97	/* Header */
98	struct list_head head;
99	struct drm_mode_object base;
100
101	char name[DRM_DISPLAY_MODE_LEN];
102
103	enum drm_mode_status status;
104	unsigned int type;
105
106	/* Proposed mode values */
107	int clock; /* in kHz */
108	int hdisplay;
109	int hsync_start;
110	int hsync_end;
111	int htotal;
112	int hskew;
113	int vdisplay;
114	int vsync_start;
115	int vsync_end;
116	int vtotal;
117	int vscan;
118	unsigned int flags;
119
120	/* Addressable image size (may be 0 for projectors, etc.) */
121	int width_mm;
122	int height_mm;
123
124	/* Actual mode we give to hw */
125	int crtc_clock; /* in KHz */
126	int crtc_hdisplay;
127	int crtc_hblank_start;
128	int crtc_hblank_end;
129	int crtc_hsync_start;
130	int crtc_hsync_end;
131	int crtc_htotal;
132	int crtc_hskew;
133	int crtc_vdisplay;
134	int crtc_vblank_start;
135	int crtc_vblank_end;
136	int crtc_vsync_start;
137	int crtc_vsync_end;
138	int crtc_vtotal;
139
140	/* Driver private mode info */
141	int private_size;
142	int *private;
143	int private_flags;
144
145	int vrefresh; /* in Hz */
146	int hsync; /* in kHz */
147	enum hdmi_picture_aspect picture_aspect_ratio;
148	};
149
150	/* mode specified on the command line */
151	struct drm_cmdline_mode {
152	bool specified;
153	bool refresh_specified;
154	bool bpp_specified;
155	int xres, yres;
156	int bpp;
157	int refresh;
158	bool rb;
159	bool interlace;
160	bool cvt;
161	bool margins;
162	enum drm_connector_force force;
163	};
164
165	static inline bool drm_mode_is_stereo(const struct drm_display_mode *mode)
166	{
167	return mode->flags & DRM_MODE_FLAG_3D_MASK;
168	}
169
170	struct drm_connector;
171	struct drm_cmdline_mode;
172
173	struct drm_display_mode drm_mode_create(struct drm_device dev);
174	void drm_mode_destroy(struct drm_device dev, struct drm_display_mode mode);
175	void drm_mode_probed_add(struct drm_connector connector, struct drm_display_mode mode);
176	void drm_mode_debug_printmodeline(const struct drm_display_mode *mode);
177
178	struct drm_display_mode drm_cvt_mode(struct drm_device dev,
179	int hdisplay, int vdisplay, int vrefresh,
180	bool reduced, bool interlaced,
181	bool margins);
182	struct drm_display_mode drm_gtf_mode(struct drm_device dev,
183	int hdisplay, int vdisplay, int vrefresh,
184	bool interlaced, int margins);
185	struct drm_display_mode drm_gtf_mode_complex(struct drm_device dev,
186	int hdisplay, int vdisplay,
187	int vrefresh, bool interlaced,
188	int margins,
189	int GTF_M, int GTF_2C,
190	int GTF_K, int GTF_2J);
ba0c2422 DV	191	void drm_display_mode_from_videomode(const struct videomode *vm,
ba0c2422 DV	192	struct drm_display_mode *dmode);
55310008 DV	193	int of_get_drm_display_mode(struct device_node *np,
	194	struct drm_display_mode *dmode,
	195	int index);
	196
	197	void drm_mode_set_name(struct drm_display_mode *mode);
55310008 DV	198	int drm_mode_hsync(const struct drm_display_mode *mode);
	199	int drm_mode_vrefresh(const struct drm_display_mode *mode);
	200
	201	void drm_mode_set_crtcinfo(struct drm_display_mode *p,
	202	int adjust_flags);
	203	void drm_mode_copy(struct drm_display_mode *dst,
	204	const struct drm_display_mode *src);
	205	struct drm_display_mode drm_mode_duplicate(struct drm_device dev,
	206	const struct drm_display_mode *mode);
	207	bool drm_mode_equal(const struct drm_display_mode *mode1,
	208	const struct drm_display_mode *mode2);
	209	bool drm_mode_equal_no_clocks_no_stereo(const struct drm_display_mode *mode1,
	210	const struct drm_display_mode *mode2);
	211
	212	/* for use by the crtc helper probe functions */
	213	void drm_mode_validate_size(struct drm_device *dev,
	214	struct list_head *mode_list,
	215	int maxX, int maxY, int maxPitch);
	216	void drm_mode_prune_invalid(struct drm_device *dev,
	217	struct list_head *mode_list, bool verbose);
	218	void drm_mode_sort(struct list_head *mode_list);
	219	void drm_mode_connector_list_update(struct drm_connector *connector);
	220
	221	/* parsing cmdline modes */
	222	bool
	223	drm_mode_parse_command_line_for_connector(const char *mode_option,
	224	struct drm_connector *connector,
	225	struct drm_cmdline_mode *mode);
	226	struct drm_display_mode *
	227	drm_mode_create_from_cmdline_mode(struct drm_device *dev,
	228	struct drm_cmdline_mode *cmd);
	229
	230	#endif /* __DRM_MODES_H__ */