xref: /freebsd/sys/dev/videomode/edidreg.h (revision 0b3105a37d7adcadcb720112fed4dc4e8040be99)
1 /*	$NetBSD: edidreg.h,v 1.3 2011/03/30 18:49:56 jdc Exp $	*/
2 /*	$FreeBSD$	*/
3 
4 /*-
5  * Copyright (c) 2006 Itronix Inc.
6  * All rights reserved.
7  *
8  * Written by Garrett D'Amore for Itronix Inc.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. The name of Itronix Inc. may not be used to endorse
19  *    or promote products derived from this software without specific
20  *    prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY ITRONIX INC. ``AS IS'' AND ANY EXPRESS
23  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
24  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL ITRONIX INC. BE LIABLE FOR ANY
26  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
28  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
30  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #ifndef _DEV_VIDEOMODE_EDIDREG_H
36 #define _DEV_VIDEOMODE_EDIDREG_H
37 
38 #define	EDID_OFFSET_SIGNATURE		0x00
39 #define	EDID_OFFSET_MANUFACTURER_ID	0x08
40 #define	EDID_OFFSET_PRODUCT_ID		0x0a
41 #define	EDID_OFFSET_SERIAL_NUMBER	0x0c
42 #define	EDID_OFFSET_MANUFACTURE_WEEK	0x10
43 #define	EDID_OFFSET_MANUFACTURE_YEAR	0x11
44 #define	EDID_OFFSET_VERSION		0x12
45 #define	EDID_OFFSET_REVISION		0x13
46 #define	EDID_OFFSET_VIDEO_INPUT		0x14
47 #define	EDID_OFFSET_MAX_HSIZE		0x15	/* in cm */
48 #define	EDID_OFFSET_MAX_VSIZE		0x16
49 #define	EDID_OFFSET_GAMMA		0x17
50 #define	EDID_OFFSET_FEATURE		0x18
51 #define	EDID_OFFSET_CHROMA		0x19
52 #define	EDID_OFFSET_EST_TIMING_1	0x23
53 #define	EDID_OFFSET_EST_TIMING_2	0x24
54 #define EDID_OFFSET_MFG_TIMING		0x25
55 #define	EDID_OFFSET_STD_TIMING		0x26
56 #define	EDID_OFFSET_DESC_BLOCK		0x36
57 
58 #define	EDID_SIGNATURE		{ 0, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0 }
59 
60 /* assume x is 16-bit value */
61 #define	EDID_VENDOR_ID(ptr)		((((ptr)[8]) << 8) + ptr[9])
62 #define	EDID_MANFID_0(x)		((((x) >> 10) & 0x1f) + '@')
63 #define	EDID_MANFID_1(x)		((((x) >> 5) & 0x1f) + '@')
64 #define	EDID_MANFID_2(x)		((((x) >> 0) & 0x1f) + '@')
65 
66 /* relative to edid block */
67 #define	EDID_PRODUCT_ID(ptr)		(((ptr)[10]) | (((ptr)[11]) << 8))
68 #define	EDID_SERIAL_NUMBER(ptr)		(((ptr)[12] << 24) + \
69 					((ptr)[13] << 16) + \
70 					((ptr)[14] << 8) + \
71 					(ptr)[15])
72 
73 /* relative to edid block */
74 #define	EDID_WEEK(ptr)			((ptr)[16])
75 #define	EDID_YEAR(ptr)			(((ptr)[17]) + 1990)
76 
77 #define	EDID_VERSION(ptr)		((ptr)[18])
78 #define	EDID_REVISION(ptr)		((ptr)[19])
79 
80 #define	EDID_VIDEO_INPUT(ptr)		((ptr)[20])
81 #define	EDID_VIDEO_INPUT_DIGITAL	0x80
82 /* if INPUT_BIT_DIGITAL set */
83 #define	EDID_VIDEO_INPUT_DFP1_COMPAT	0x01
84 /* if INPUT_BIT_DIGITAL not set */
85 #define	EDID_VIDEO_INPUT_BLANK_TO_BLACK	0x10
86 #define	EDID_VIDEO_INPUT_SEPARATE_SYNCS	0x08
87 #define	EDID_VIDEO_INPUT_COMPOSITE_SYNC	0x04
88 #define	EDID_VIDEO_INPUT_SYNC_ON_GRN	0x02
89 #define	EDID_VIDEO_INPUT_SERRATION	0x01
90 #define	EDID_VIDEO_INPUT_LEVEL(x)	(((x) & 0x60) >> 5)
91 /* meanings of level bits are as follows, I don't know names */
92 /* 0 = 0.7,0.3,  1 = 0.714,0.286, 2 = 1.0,0.4, 3 = 0.7,0.0 */
93 
94 /* relative to edid block */
95 #define	EDID_MAX_HSIZE(ptr)		((ptr)[21])	/* cm */
96 #define	EDID_MAX_VSIZE(ptr)		((ptr)[22])	/* cm */
97 /* gamma is scaled by 100 (avoid fp), e.g. 213 == 2.13 */
98 #define	_GAMMA(x)			((x) == 0xff ? 100 : ((x) + 100))
99 #define	EDID_GAMMA(ptr)			_GAMMA(ptr[23])
100 
101 #define	EDID_FEATURES(ptr)		((ptr)[24])
102 #define	EDID_FEATURES_STANDBY			0x80
103 #define	EDID_FEATURES_SUSPEND			0x40
104 #define	EDID_FEATURES_ACTIVE_OFF		0x20
105 #define	EDID_FEATURES_DISP_TYPE(x)		(((x) & 0x18) >> 3)
106 #define	EDID_FEATURES_DISP_TYPE_MONO		0
107 #define	EDID_FEATURES_DISP_TYPE_RGB		1
108 #define	EDID_FEATURES_DISP_TYPE_NON_RGB		2
109 #define	EDID_FEATURES_DISP_TYPE_UNDEFINED	3
110 #define	EDID_FEATURES_STD_COLOR			0x04
111 #define	EDID_FEATURES_PREFERRED_TIMING		0x02
112 #define	EDID_FEATURES_DEFAULT_GTF		0x01
113 
114 /* chroma values 0.0 - 0.999 scaled as 0-999 */
115 #define	_CHLO(byt, shft)	(((byt) >> (shft)) & 0x3)
116 #define	_CHHI(byt)		((byt) << 2)
117 #define	_CHHILO(ptr, l, s, h)	(_CHLO((ptr)[l], s) | _CHHI((ptr)[h]))
118 #define	_CHROMA(ptr, l, s, h)	((_CHHILO(ptr, l, s, h) * 1000) / 1024)
119 
120 #define	EDID_CHROMA_REDX(ptr)	(_CHROMA(ptr, 25, 6, 27))
121 #define	EDID_CHROMA_REDY(ptr)	(_CHROMA(ptr, 25, 4, 28))
122 #define	EDID_CHROMA_GREENX(ptr)	(_CHROMA(ptr, 25, 2, 29))
123 #define	EDID_CHROMA_GREENY(ptr)	(_CHROMA(ptr, 25, 0, 30))
124 #define	EDID_CHROMA_BLUEX(ptr)	(_CHROMA(ptr, 26, 6, 31))
125 #define	EDID_CHROMA_BLUEY(ptr)	(_CHROMA(ptr, 26, 4, 32))
126 #define	EDID_CHROMA_WHITEX(ptr)	(_CHROMA(ptr, 26, 2, 33))
127 #define	EDID_CHROMA_WHITEY(ptr)	(_CHROMA(ptr, 26, 0, 34))
128 
129 /* relative to edid block */
130 #define	EDID_EST_TIMING(ptr)		(((ptr)[35] << 8) | (ptr)[36])
131 #define	EDID_EST_TIMING_720_400_70	0x8000	/* 720x400 @ 70Hz */
132 #define	EDID_EST_TIMING_720_400_88	0x4000	/* 720x400 @ 88Hz */
133 #define	EDID_EST_TIMING_640_480_60	0x2000	/* 640x480 @ 60Hz */
134 #define	EDID_EST_TIMING_640_480_67	0x1000	/* 640x480 @ 67Hz */
135 #define	EDID_EST_TIMING_640_480_72	0x0800	/* 640x480 @ 72Hz */
136 #define	EDID_EST_TIMING_640_480_75	0x0400	/* 640x480 @ 75Hz */
137 #define	EDID_EST_TIMING_800_600_56	0x0200	/* 800x600 @ 56Hz */
138 #define	EDID_EST_TIMING_800_600_60	0x0100	/* 800x600 @ 60Hz */
139 #define	EDID_EST_TIMING_800_600_72	0x0080	/* 800x600 @ 72Hz */
140 #define	EDID_EST_TIMING_800_600_75	0x0040	/* 800x600 @ 75Hz */
141 #define	EDID_EST_TIMING_832_624_75	0x0020	/* 832x624 @ 75Hz */
142 #define	EDID_EST_TIMING_1024_768_87I	0x0010	/* 1024x768i @ 87Hz */
143 #define	EDID_EST_TIMING_1024_768_60	0x0008	/* 1024x768 @ 60Hz */
144 #define	EDID_EST_TIMING_1024_768_70	0x0004	/* 1024x768 @ 70Hz */
145 #define	EDID_EST_TIMING_1024_768_75	0x0002	/* 1024x768 @ 75Hz */
146 #define	EDID_EST_TIMING_1280_1024_75	0x0001	/* 1280x1024 @ 75Hz */
147 
148 /*
149  * N.B.: ptr is relative to standard timing block - used for standard timing
150  * descriptors as well as standard timings section of edid!
151  */
152 #define	EDID_STD_TIMING_HRES(ptr)	((((ptr)[0]) * 8) + 248)
153 #define	EDID_STD_TIMING_VFREQ(ptr)	((((ptr)[1]) & 0x3f) + 60)
154 #define	EDID_STD_TIMING_RATIO(ptr)	((ptr)[1] & 0xc0)
155 #define	EDID_STD_TIMING_RATIO_16_10	0x00
156 #define	EDID_STD_TIMING_RATIO_4_3	0x40
157 #define	EDID_STD_TIMING_RATIO_5_4	0x80
158 #define	EDID_STD_TIMING_RATIO_16_9	0xc0
159 
160 #define	EDID_STD_TIMING_SIZE		16
161 #define	EDID_STD_TIMING_COUNT		8
162 
163 /*
164  * N.B.: ptr is relative to descriptor block start
165  */
166 #define	EDID_BLOCK_SIZE			18
167 #define	EDID_BLOCK_COUNT		4
168 
169 /* detailed timing block.... what a mess */
170 #define	EDID_BLOCK_IS_DET_TIMING(ptr)		((ptr)[0] | (ptr)[1])
171 
172 #define	EDID_DET_TIMING_DOT_CLOCK(ptr)	(((ptr)[0] | ((ptr)[1] << 8)) * 10000)
173 #define	_HACT_LO(ptr)			((ptr)[2])
174 #define	_HBLK_LO(ptr)			((ptr)[3])
175 #define	_HACT_HI(ptr)			(((ptr)[4] & 0xf0) << 4)
176 #define	_HBLK_HI(ptr)			(((ptr)[4] & 0x0f) << 8)
177 #define	EDID_DET_TIMING_HACTIVE(ptr)		(_HACT_LO(ptr) | _HACT_HI(ptr))
178 #define	EDID_DET_TIMING_HBLANK(ptr)		(_HBLK_LO(ptr) | _HBLK_HI(ptr))
179 #define	_VACT_LO(ptr)			((ptr)[5])
180 #define	_VBLK_LO(ptr)			((ptr)[6])
181 #define	_VACT_HI(ptr)			(((ptr)[7] & 0xf0) << 4)
182 #define	_VBLK_HI(ptr)			(((ptr)[7] & 0x0f) << 8)
183 #define	EDID_DET_TIMING_VACTIVE(ptr)		(_VACT_LO(ptr) | _VACT_HI(ptr))
184 #define	EDID_DET_TIMING_VBLANK(ptr)		(_VBLK_LO(ptr) | _VBLK_HI(ptr))
185 #define	_HOFF_LO(ptr)			((ptr)[8])
186 #define	_HWID_LO(ptr)			((ptr)[9])
187 #define	_VOFF_LO(ptr)			((ptr)[10] >> 4)
188 #define	_VWID_LO(ptr)			((ptr)[10] & 0xf)
189 #define	_HOFF_HI(ptr)			(((ptr)[11] & 0xc0) << 2)
190 #define	_HWID_HI(ptr)			(((ptr)[11] & 0x30) << 4)
191 #define	_VOFF_HI(ptr)			(((ptr)[11] & 0x0c) << 2)
192 #define	_VWID_HI(ptr)			(((ptr)[11] & 0x03) << 4)
193 #define	EDID_DET_TIMING_HSYNC_OFFSET(ptr)	(_HOFF_LO(ptr) | _HOFF_HI(ptr))
194 #define	EDID_DET_TIMING_HSYNC_WIDTH(ptr)	(_HWID_LO(ptr) | _HWID_HI(ptr))
195 #define	EDID_DET_TIMING_VSYNC_OFFSET(ptr)	(_VOFF_LO(ptr) | _VOFF_HI(ptr))
196 #define	EDID_DET_TIMING_VSYNC_WIDTH(ptr)	(_VWID_LO(ptr) | _VWID_HI(ptr))
197 #define	_HSZ_LO(ptr)			((ptr)[12])
198 #define	_VSZ_LO(ptr)			((ptr)[13])
199 #define	_HSZ_HI(ptr)			(((ptr)[14] & 0xf0) << 4)
200 #define	_VSZ_HI(ptr)			(((ptr)[14] & 0x0f) << 8)
201 #define	EDID_DET_TIMING_HSIZE(ptr)		(_HSZ_LO(ptr) | _HSZ_HI(ptr))
202 #define	EDID_DET_TIMING_VSIZE(ptr)		(_VSZ_LO(ptr) | _VSZ_HI(ptr))
203 #define	EDID_DET_TIMING_HBORDER(ptr)	((ptr)[15])
204 #define	EDID_DET_TIMING_VBORDER(ptr)	((ptr)[16])
205 #define	EDID_DET_TIMING_FLAGS(ptr)	((ptr)[17])
206 #define	EDID_DET_TIMING_FLAG_INTERLACE		0x80
207 #define	EDID_DET_TIMING_FLAG_STEREO		0x60	/* stereo or not */
208 #define	EDID_DET_TIMING_FLAG_SYNC_SEPARATE	0x18
209 #define	EDID_DET_TIMING_FLAG_VSYNC_POSITIVE	0x04
210 #define	EDID_DET_TIMING_FLAG_HSYNC_POSITIVE	0x02
211 #define	EDID_DET_TIMING_FLAG_STEREO_MODE	0x01	/* stereo mode */
212 
213 
214 /* N.B.: these tests assume that we already checked for detailed timing! */
215 #define	EDID_BLOCK_TYPE(ptr)			((ptr)[3])
216 
217 #define	EDID_DESC_BLOCK_SIZE			18
218 #define	EDID_DESC_BLOCK_TYPE_SERIAL		0xFF
219 #define	EDID_DESC_BLOCK_TYPE_ASCII		0xFE
220 #define	EDID_DESC_BLOCK_TYPE_RANGE		0xFD
221 #define	EDID_DESC_BLOCK_TYPE_NAME		0xFC
222 #define	EDID_DESC_BLOCK_TYPE_COLOR_POINT	0xFB
223 #define	EDID_DESC_BLOCK_TYPE_STD_TIMING		0xFA
224 
225 /* used for descriptors 0xFF, 0xFE, and 0xFC */
226 #define	EDID_DESC_ASCII_DATA_OFFSET		5
227 #define	EDID_DESC_ASCII_DATA_LEN		13
228 
229 #define	EDID_DESC_RANGE_MIN_VFREQ(ptr)		((ptr)[5])	/* Hz */
230 #define	EDID_DESC_RANGE_MAX_VFREQ(ptr)		((ptr)[6])	/* Hz */
231 #define	EDID_DESC_RANGE_MIN_HFREQ(ptr)		((ptr)[7])	/* kHz */
232 #define	EDID_DESC_RANGE_MAX_HFREQ(ptr)		((ptr)[8])	/* kHz */
233 #define	EDID_DESC_RANGE_MAX_CLOCK(ptr)		(((ptr)[9]) * 10) /* MHz */
234 #define	EDID_DESC_RANGE_HAVE_GTF2(ptr)		(((ptr)[10]) == 0x02)
235 #define	EDID_DESC_RANGE_GTF2_HFREQ(ptr)		(((ptr)[12]) * 2)
236 #define	EDID_DESC_RANGE_GTF2_C(ptr)		(((ptr)[13]) / 2)
237 #define	EDID_DESC_RANGE_GTF2_M(ptr)		((ptr)[14] + ((ptr)[15] << 8))
238 #define	EDID_DESC_RANGE_GTF2_K(ptr)		((ptr)[16])
239 #define	EDID_DESC_RANGE_GTF2_J(ptr)		((ptr)[17] / 2)
240 
241 #define	EDID_DESC_COLOR_WHITEX(ptr)
242 #define	EDID_DESC_COLOR_WHITE_INDEX_1(ptr)	((ptr)[5])
243 #define	EDID_DESC_COLOR_WHITEX_1(ptr)		_CHROMA(ptr, 6, 2, 7)
244 #define	EDID_DESC_COLOR_WHITEY_1(ptr)		_CHROMA(ptr, 6, 0, 8)
245 #define	EDID_DESC_COLOR_GAMMA_1(ptr)		_GAMMA(ptr[9])
246 #define	EDID_DESC_COLOR_WHITE_INDEX_2(ptr)	((ptr)[10])
247 #define	EDID_DESC_COLOR_WHITEX_2(ptr)		_CHROMA(ptr, 11, 2, 12)
248 #define	EDID_DESC_COLOR_WHITEY_2(ptr)		_CHROMA(ptr, 11, 0, 13)
249 #define	EDID_DESC_COLOR_GAMMA_2(ptr)		_GAMMA(ptr[14])
250 
251 #define	EDID_DESC_STD_TIMING_START		5
252 #define	EDID_DESC_STD_TIMING_COUNT		6
253 
254 #define	EDID_EXT_BLOCK_COUNT(ptr)		((ptr)[126])
255 
256 #endif /* _DEV_VIDEOMODE_EDIDREG_H */
257