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