2 * Copyright © 2007-2008 Intel Corporation
3 * Jesse Barnes <jesse.barnes@intel.com>
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
19 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
20 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
21 * OTHER DEALINGS IN THE SOFTWARE.
23 #ifndef __DRM_EDID_H__
24 #define __DRM_EDID_H__
26 #include <linux/types.h>
27 #include <linux/hdmi.h>
28 #include <drm/drm_mode.h>
33 #define EDID_LENGTH 128
35 #define DDC_ADDR2 0x52 /* E-DDC 1.2 - where DisplayID can hide */
42 #define DISPLAYID_EXT 0x70
48 } __attribute__((packed
));
50 /* 00=16:10, 01=4:3, 10=5:4, 11=16:9 */
51 #define EDID_TIMING_ASPECT_SHIFT 6
52 #define EDID_TIMING_ASPECT_MASK (0x3 << EDID_TIMING_ASPECT_SHIFT)
55 #define EDID_TIMING_VFREQ_SHIFT 0
56 #define EDID_TIMING_VFREQ_MASK (0x3f << EDID_TIMING_VFREQ_SHIFT)
59 u8 hsize
; /* need to multiply by 8 then add 248 */
61 } __attribute__((packed
));
63 #define DRM_EDID_PT_HSYNC_POSITIVE (1 << 1)
64 #define DRM_EDID_PT_VSYNC_POSITIVE (1 << 2)
65 #define DRM_EDID_PT_SEPARATE_SYNC (3 << 3)
66 #define DRM_EDID_PT_STEREO (1 << 5)
67 #define DRM_EDID_PT_INTERLACED (1 << 7)
69 /* If detailed data is pixel timing */
70 struct detailed_pixel_timing
{
78 u8 hsync_pulse_width_lo
;
79 u8 vsync_offset_pulse_width_lo
;
80 u8 hsync_vsync_offset_pulse_width_hi
;
83 u8 width_height_mm_hi
;
87 } __attribute__((packed
));
89 /* If it's not pixel timing, it'll be one of the below */
90 struct detailed_data_string
{
92 } __attribute__((packed
));
94 #define DRM_EDID_DEFAULT_GTF_SUPPORT_FLAG 0x00
95 #define DRM_EDID_RANGE_LIMITS_ONLY_FLAG 0x01
96 #define DRM_EDID_SECONDARY_GTF_SUPPORT_FLAG 0x02
97 #define DRM_EDID_CVT_SUPPORT_FLAG 0x04
99 struct detailed_data_monitor_range
{
104 u8 pixel_clock_mhz
; /* need to multiply by 10 */
109 u8 hfreq_start_khz
; /* need to multiply by 2 */
110 u8 c
; /* need to divide by 2 */
113 u8 j
; /* need to divide by 2 */
114 } __attribute__((packed
)) gtf2
;
117 u8 data1
; /* high 6 bits: extra clock resolution */
118 u8 data2
; /* plus low 2 of above: max hactive */
119 u8 supported_aspects
;
120 u8 flags
; /* preferred aspect and blanking support */
121 u8 supported_scalings
;
122 u8 preferred_refresh
;
123 } __attribute__((packed
)) cvt
;
125 } __attribute__((packed
));
127 struct detailed_data_wpindex
{
128 u8 white_yx_lo
; /* Lower 2 bits each */
131 u8 gamma
; /* need to divide by 100 then add 1 */
132 } __attribute__((packed
));
134 struct detailed_data_color_point
{
139 } __attribute__((packed
));
143 } __attribute__((packed
));
145 struct detailed_non_pixel
{
147 u8 type
; /* ff=serial, fe=string, fd=monitor range, fc=monitor name
148 fb=color point data, fa=standard timing data,
149 f9=undefined, f8=mfg. reserved */
152 struct detailed_data_string str
;
153 struct detailed_data_monitor_range range
;
154 struct detailed_data_wpindex color
;
155 struct std_timing timings
[6];
156 struct cvt_timing cvt
[4];
158 } __attribute__((packed
));
160 #define EDID_DETAIL_EST_TIMINGS 0xf7
161 #define EDID_DETAIL_CVT_3BYTE 0xf8
162 #define EDID_DETAIL_COLOR_MGMT_DATA 0xf9
163 #define EDID_DETAIL_STD_MODES 0xfa
164 #define EDID_DETAIL_MONITOR_CPDATA 0xfb
165 #define EDID_DETAIL_MONITOR_NAME 0xfc
166 #define EDID_DETAIL_MONITOR_RANGE 0xfd
167 #define EDID_DETAIL_MONITOR_STRING 0xfe
168 #define EDID_DETAIL_MONITOR_SERIAL 0xff
170 struct detailed_timing
{
171 __le16 pixel_clock
; /* need to multiply by 10 KHz */
173 struct detailed_pixel_timing pixel_data
;
174 struct detailed_non_pixel other_data
;
176 } __attribute__((packed
));
178 #define DRM_EDID_INPUT_SERRATION_VSYNC (1 << 0)
179 #define DRM_EDID_INPUT_SYNC_ON_GREEN (1 << 1)
180 #define DRM_EDID_INPUT_COMPOSITE_SYNC (1 << 2)
181 #define DRM_EDID_INPUT_SEPARATE_SYNCS (1 << 3)
182 #define DRM_EDID_INPUT_BLANK_TO_BLACK (1 << 4)
183 #define DRM_EDID_INPUT_VIDEO_LEVEL (3 << 5)
184 #define DRM_EDID_INPUT_DIGITAL (1 << 7)
185 #define DRM_EDID_DIGITAL_DEPTH_MASK (7 << 4) /* 1.4 */
186 #define DRM_EDID_DIGITAL_DEPTH_UNDEF (0 << 4) /* 1.4 */
187 #define DRM_EDID_DIGITAL_DEPTH_6 (1 << 4) /* 1.4 */
188 #define DRM_EDID_DIGITAL_DEPTH_8 (2 << 4) /* 1.4 */
189 #define DRM_EDID_DIGITAL_DEPTH_10 (3 << 4) /* 1.4 */
190 #define DRM_EDID_DIGITAL_DEPTH_12 (4 << 4) /* 1.4 */
191 #define DRM_EDID_DIGITAL_DEPTH_14 (5 << 4) /* 1.4 */
192 #define DRM_EDID_DIGITAL_DEPTH_16 (6 << 4) /* 1.4 */
193 #define DRM_EDID_DIGITAL_DEPTH_RSVD (7 << 4) /* 1.4 */
194 #define DRM_EDID_DIGITAL_TYPE_MASK (7 << 0) /* 1.4 */
195 #define DRM_EDID_DIGITAL_TYPE_UNDEF (0 << 0) /* 1.4 */
196 #define DRM_EDID_DIGITAL_TYPE_DVI (1 << 0) /* 1.4 */
197 #define DRM_EDID_DIGITAL_TYPE_HDMI_A (2 << 0) /* 1.4 */
198 #define DRM_EDID_DIGITAL_TYPE_HDMI_B (3 << 0) /* 1.4 */
199 #define DRM_EDID_DIGITAL_TYPE_MDDI (4 << 0) /* 1.4 */
200 #define DRM_EDID_DIGITAL_TYPE_DP (5 << 0) /* 1.4 */
201 #define DRM_EDID_DIGITAL_DFP_1_X (1 << 0) /* 1.3 */
203 #define DRM_EDID_FEATURE_DEFAULT_GTF (1 << 0)
204 #define DRM_EDID_FEATURE_PREFERRED_TIMING (1 << 1)
205 #define DRM_EDID_FEATURE_STANDARD_COLOR (1 << 2)
207 #define DRM_EDID_FEATURE_DISPLAY_TYPE (3 << 3) /* 00=mono, 01=rgb, 10=non-rgb, 11=unknown */
209 #define DRM_EDID_FEATURE_COLOR_MASK (3 << 3)
210 #define DRM_EDID_FEATURE_RGB (0 << 3)
211 #define DRM_EDID_FEATURE_RGB_YCRCB444 (1 << 3)
212 #define DRM_EDID_FEATURE_RGB_YCRCB422 (2 << 3)
213 #define DRM_EDID_FEATURE_RGB_YCRCB (3 << 3) /* both 4:4:4 and 4:2:2 */
215 #define DRM_EDID_FEATURE_PM_ACTIVE_OFF (1 << 5)
216 #define DRM_EDID_FEATURE_PM_SUSPEND (1 << 6)
217 #define DRM_EDID_FEATURE_PM_STANDBY (1 << 7)
219 #define DRM_EDID_HDMI_DC_48 (1 << 6)
220 #define DRM_EDID_HDMI_DC_36 (1 << 5)
221 #define DRM_EDID_HDMI_DC_30 (1 << 4)
222 #define DRM_EDID_HDMI_DC_Y444 (1 << 3)
224 /* YCBCR 420 deep color modes */
225 #define DRM_EDID_YCBCR420_DC_48 (1 << 2)
226 #define DRM_EDID_YCBCR420_DC_36 (1 << 1)
227 #define DRM_EDID_YCBCR420_DC_30 (1 << 0)
228 #define DRM_EDID_YCBCR420_DC_MASK (DRM_EDID_YCBCR420_DC_48 | \
229 DRM_EDID_YCBCR420_DC_36 | \
230 DRM_EDID_YCBCR420_DC_30)
232 /* ELD Header Block */
233 #define DRM_ELD_HEADER_BLOCK_SIZE 4
235 #define DRM_ELD_VER 0
236 # define DRM_ELD_VER_SHIFT 3
237 # define DRM_ELD_VER_MASK (0x1f << 3)
238 # define DRM_ELD_VER_CEA861D (2 << 3) /* supports 861D or below */
239 # define DRM_ELD_VER_CANNED (0x1f << 3)
241 #define DRM_ELD_BASELINE_ELD_LEN 2 /* in dwords! */
243 /* ELD Baseline Block for ELD_Ver == 2 */
244 #define DRM_ELD_CEA_EDID_VER_MNL 4
245 # define DRM_ELD_CEA_EDID_VER_SHIFT 5
246 # define DRM_ELD_CEA_EDID_VER_MASK (7 << 5)
247 # define DRM_ELD_CEA_EDID_VER_NONE (0 << 5)
248 # define DRM_ELD_CEA_EDID_VER_CEA861 (1 << 5)
249 # define DRM_ELD_CEA_EDID_VER_CEA861A (2 << 5)
250 # define DRM_ELD_CEA_EDID_VER_CEA861BCD (3 << 5)
251 # define DRM_ELD_MNL_SHIFT 0
252 # define DRM_ELD_MNL_MASK (0x1f << 0)
254 #define DRM_ELD_SAD_COUNT_CONN_TYPE 5
255 # define DRM_ELD_SAD_COUNT_SHIFT 4
256 # define DRM_ELD_SAD_COUNT_MASK (0xf << 4)
257 # define DRM_ELD_CONN_TYPE_SHIFT 2
258 # define DRM_ELD_CONN_TYPE_MASK (3 << 2)
259 # define DRM_ELD_CONN_TYPE_HDMI (0 << 2)
260 # define DRM_ELD_CONN_TYPE_DP (1 << 2)
261 # define DRM_ELD_SUPPORTS_AI (1 << 1)
262 # define DRM_ELD_SUPPORTS_HDCP (1 << 0)
264 #define DRM_ELD_AUD_SYNCH_DELAY 6 /* in units of 2 ms */
265 # define DRM_ELD_AUD_SYNCH_DELAY_MAX 0xfa /* 500 ms */
267 #define DRM_ELD_SPEAKER 7
268 # define DRM_ELD_SPEAKER_MASK 0x7f
269 # define DRM_ELD_SPEAKER_RLRC (1 << 6)
270 # define DRM_ELD_SPEAKER_FLRC (1 << 5)
271 # define DRM_ELD_SPEAKER_RC (1 << 4)
272 # define DRM_ELD_SPEAKER_RLR (1 << 3)
273 # define DRM_ELD_SPEAKER_FC (1 << 2)
274 # define DRM_ELD_SPEAKER_LFE (1 << 1)
275 # define DRM_ELD_SPEAKER_FLR (1 << 0)
277 #define DRM_ELD_PORT_ID 8 /* offsets 8..15 inclusive */
278 # define DRM_ELD_PORT_ID_LEN 8
280 #define DRM_ELD_MANUFACTURER_NAME0 16
281 #define DRM_ELD_MANUFACTURER_NAME1 17
283 #define DRM_ELD_PRODUCT_CODE0 18
284 #define DRM_ELD_PRODUCT_CODE1 19
286 #define DRM_ELD_MONITOR_NAME_STRING 20 /* offsets 20..(20+mnl-1) inclusive */
288 #define DRM_ELD_CEA_SAD(mnl, sad) (20 + (mnl) + 3 * (sad))
292 /* Vendor & product info */
295 u32 serial
; /* FIXME: byte order */
307 /* Color characteristics */
318 /* Est. timings and mfg rsvd timings*/
319 struct est_timings established_timings
;
320 /* Standard timings 1-8*/
321 struct std_timing standard_timings
[8];
322 /* Detailing timings 1-4 */
323 struct detailed_timing detailed_timings
[4];
324 /* Number of 128 byte ext. blocks */
328 } __attribute__((packed
));
330 #define EDID_PRODUCT_ID(e) ((e)->prod_code[0] | ((e)->prod_code[1] << 8))
332 /* Short Audio Descriptor */
335 u8 channels
; /* max number of channels - 1 */
337 u8 byte2
; /* meaning depends on format */
341 struct drm_connector
;
342 struct drm_connector_state
;
343 struct drm_display_mode
;
345 int drm_edid_to_sad(struct edid
*edid
, struct cea_sad
**sads
);
346 int drm_edid_to_speaker_allocation(struct edid
*edid
, u8
**sadb
);
347 int drm_av_sync_delay(struct drm_connector
*connector
,
348 const struct drm_display_mode
*mode
);
350 #ifdef CONFIG_DRM_LOAD_EDID_FIRMWARE
351 struct edid
*drm_load_edid_firmware(struct drm_connector
*connector
);
352 int __drm_set_edid_firmware_path(const char *path
);
353 int __drm_get_edid_firmware_path(char *buf
, size_t bufsize
);
355 static inline struct edid
*
356 drm_load_edid_firmware(struct drm_connector
*connector
)
358 return ERR_PTR(-ENOENT
);
363 drm_hdmi_avi_infoframe_from_display_mode(struct hdmi_avi_infoframe
*frame
,
364 struct drm_connector
*connector
,
365 const struct drm_display_mode
*mode
);
367 drm_hdmi_vendor_infoframe_from_display_mode(struct hdmi_vendor_infoframe
*frame
,
368 struct drm_connector
*connector
,
369 const struct drm_display_mode
*mode
);
372 drm_hdmi_avi_infoframe_colorspace(struct hdmi_avi_infoframe
*frame
,
373 const struct drm_connector_state
*conn_state
);
376 drm_hdmi_avi_infoframe_bars(struct hdmi_avi_infoframe
*frame
,
377 const struct drm_connector_state
*conn_state
);
380 drm_hdmi_avi_infoframe_quant_range(struct hdmi_avi_infoframe
*frame
,
381 struct drm_connector
*connector
,
382 const struct drm_display_mode
*mode
,
383 enum hdmi_quantization_range rgb_quant_range
);
386 drm_hdmi_infoframe_set_hdr_metadata(struct hdmi_drm_infoframe
*frame
,
387 const struct drm_connector_state
*conn_state
);
390 * drm_eld_mnl - Get ELD monitor name length in bytes.
391 * @eld: pointer to an eld memory structure with mnl set
393 static inline int drm_eld_mnl(const uint8_t *eld
)
395 return (eld
[DRM_ELD_CEA_EDID_VER_MNL
] & DRM_ELD_MNL_MASK
) >> DRM_ELD_MNL_SHIFT
;
399 * drm_eld_sad - Get ELD SAD structures.
400 * @eld: pointer to an eld memory structure with sad_count set
402 static inline const uint8_t *drm_eld_sad(const uint8_t *eld
)
404 unsigned int ver
, mnl
;
406 ver
= (eld
[DRM_ELD_VER
] & DRM_ELD_VER_MASK
) >> DRM_ELD_VER_SHIFT
;
407 if (ver
!= 2 && ver
!= 31)
410 mnl
= drm_eld_mnl(eld
);
414 return eld
+ DRM_ELD_CEA_SAD(mnl
, 0);
418 * drm_eld_sad_count - Get ELD SAD count.
419 * @eld: pointer to an eld memory structure with sad_count set
421 static inline int drm_eld_sad_count(const uint8_t *eld
)
423 return (eld
[DRM_ELD_SAD_COUNT_CONN_TYPE
] & DRM_ELD_SAD_COUNT_MASK
) >>
424 DRM_ELD_SAD_COUNT_SHIFT
;
428 * drm_eld_calc_baseline_block_size - Calculate baseline block size in bytes
429 * @eld: pointer to an eld memory structure with mnl and sad_count set
431 * This is a helper for determining the payload size of the baseline block, in
432 * bytes, for e.g. setting the Baseline_ELD_Len field in the ELD header block.
434 static inline int drm_eld_calc_baseline_block_size(const uint8_t *eld
)
436 return DRM_ELD_MONITOR_NAME_STRING
- DRM_ELD_HEADER_BLOCK_SIZE
+
437 drm_eld_mnl(eld
) + drm_eld_sad_count(eld
) * 3;
441 * drm_eld_size - Get ELD size in bytes
442 * @eld: pointer to a complete eld memory structure
444 * The returned value does not include the vendor block. It's vendor specific,
445 * and comprises of the remaining bytes in the ELD memory buffer after
446 * drm_eld_size() bytes of header and baseline block.
448 * The returned value is guaranteed to be a multiple of 4.
450 static inline int drm_eld_size(const uint8_t *eld
)
452 return DRM_ELD_HEADER_BLOCK_SIZE
+ eld
[DRM_ELD_BASELINE_ELD_LEN
] * 4;
456 * drm_eld_get_spk_alloc - Get speaker allocation
457 * @eld: pointer to an ELD memory structure
459 * The returned value is the speakers mask. User has to use %DRM_ELD_SPEAKER
460 * field definitions to identify speakers.
462 static inline u8
drm_eld_get_spk_alloc(const uint8_t *eld
)
464 return eld
[DRM_ELD_SPEAKER
] & DRM_ELD_SPEAKER_MASK
;
468 * drm_eld_get_conn_type - Get device type hdmi/dp connected
469 * @eld: pointer to an ELD memory structure
471 * The caller need to use %DRM_ELD_CONN_TYPE_HDMI or %DRM_ELD_CONN_TYPE_DP to
472 * identify the display type connected.
474 static inline u8
drm_eld_get_conn_type(const uint8_t *eld
)
476 return eld
[DRM_ELD_SAD_COUNT_CONN_TYPE
] & DRM_ELD_CONN_TYPE_MASK
;
479 bool drm_probe_ddc(struct i2c_adapter
*adapter
);
480 struct edid
*drm_do_get_edid(struct drm_connector
*connector
,
481 int (*get_edid_block
)(void *data
, u8
*buf
, unsigned int block
,
484 struct edid
*drm_get_edid(struct drm_connector
*connector
,
485 struct i2c_adapter
*adapter
);
486 struct edid
*drm_get_edid_switcheroo(struct drm_connector
*connector
,
487 struct i2c_adapter
*adapter
);
488 struct edid
*drm_edid_duplicate(const struct edid
*edid
);
489 int drm_add_edid_modes(struct drm_connector
*connector
, struct edid
*edid
);
490 int drm_add_override_edid_modes(struct drm_connector
*connector
);
492 u8
drm_match_cea_mode(const struct drm_display_mode
*to_match
);
493 bool drm_detect_hdmi_monitor(struct edid
*edid
);
494 bool drm_detect_monitor_audio(struct edid
*edid
);
495 enum hdmi_quantization_range
496 drm_default_rgb_quant_range(const struct drm_display_mode
*mode
);
497 int drm_add_modes_noedid(struct drm_connector
*connector
,
498 int hdisplay
, int vdisplay
);
499 void drm_set_preferred_mode(struct drm_connector
*connector
,
500 int hpref
, int vpref
);
502 int drm_edid_header_is_valid(const u8
*raw_edid
);
503 bool drm_edid_block_valid(u8
*raw_edid
, int block
, bool print_bad_edid
,
505 bool drm_edid_is_valid(struct edid
*edid
);
506 void drm_edid_get_monitor_name(struct edid
*edid
, char *name
,
508 struct drm_display_mode
*drm_mode_find_dmt(struct drm_device
*dev
,
509 int hsize
, int vsize
, int fresh
,
511 #endif /* __DRM_EDID_H__ */