include/drm/drm_edid.h

   1 /*
   2  * Copyright © 2007-2008 Intel Corporation
   3  *   Jesse Barnes <jesse.barnes@intel.com>
   4  *
   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:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  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.
  22  */
  23 #ifndef __DRM_EDID_H__
  24 #define __DRM_EDID_H__
  25
  26 #include <linux/types.h>
  27
  28 #define EDID_LENGTH 128
  29 #define DDC_ADDR 0x50
  30 #define DDC_ADDR2 0x52 /* E-DDC 1.2 - where DisplayID can hide */
  31
  32 #define CEA_EXT     0x02
  33 #define VTB_EXT     0x10
  34 #define DI_EXT      0x40
  35 #define LS_EXT      0x50
  36 #define MI_EXT      0x60
  37 #define DISPLAYID_EXT 0x70
  38
  39 struct est_timings {
  40         u8 t1;
  41         u8 t2;
  42         u8 mfg_rsvd;
  43 } __attribute__((packed));
  44
  45 /* 00=16:10, 01=4:3, 10=5:4, 11=16:9 */
  46 #define EDID_TIMING_ASPECT_SHIFT 6
  47 #define EDID_TIMING_ASPECT_MASK  (0x3 << EDID_TIMING_ASPECT_SHIFT)
  48
  49 /* need to add 60 */
  50 #define EDID_TIMING_VFREQ_SHIFT  0
  51 #define EDID_TIMING_VFREQ_MASK   (0x3f << EDID_TIMING_VFREQ_SHIFT)
  52
  53 struct std_timing {
  54         u8 hsize; /* need to multiply by 8 then add 248 */
  55         u8 vfreq_aspect;
  56 } __attribute__((packed));
  57
  58 #define DRM_EDID_PT_HSYNC_POSITIVE (1 << 1)
  59 #define DRM_EDID_PT_VSYNC_POSITIVE (1 << 2)
  60 #define DRM_EDID_PT_SEPARATE_SYNC  (3 << 3)
  61 #define DRM_EDID_PT_STEREO         (1 << 5)
  62 #define DRM_EDID_PT_INTERLACED     (1 << 7)
  63
  64 /* If detailed data is pixel timing */
  65 struct detailed_pixel_timing {
  66         u8 hactive_lo;
  67         u8 hblank_lo;
  68         u8 hactive_hblank_hi;
  69         u8 vactive_lo;
  70         u8 vblank_lo;
  71         u8 vactive_vblank_hi;
  72         u8 hsync_offset_lo;
  73         u8 hsync_pulse_width_lo;
  74         u8 vsync_offset_pulse_width_lo;
  75         u8 hsync_vsync_offset_pulse_width_hi;
  76         u8 width_mm_lo;
  77         u8 height_mm_lo;
  78         u8 width_height_mm_hi;
  79         u8 hborder;
  80         u8 vborder;
  81         u8 misc;
  82 } __attribute__((packed));
  83
  84 /* If it's not pixel timing, it'll be one of the below */
  85 struct detailed_data_string {
  86         u8 str[13];
  87 } __attribute__((packed));
  88
  89 struct detailed_data_monitor_range {
  90         u8 min_vfreq;
  91         u8 max_vfreq;
  92         u8 min_hfreq_khz;
  93         u8 max_hfreq_khz;
  94         u8 pixel_clock_mhz; /* need to multiply by 10 */
  95         u8 flags;
  96         union {
  97                 struct {
  98                         u8 reserved;
  99                         u8 hfreq_start_khz; /* need to multiply by 2 */
 100                         u8 c; /* need to divide by 2 */
 101                         __le16 m;
 102                         u8 k;
 103                         u8 j; /* need to divide by 2 */
 104                 } __attribute__((packed)) gtf2;
 105                 struct {
 106                         u8 version;
 107                         u8 data1; /* high 6 bits: extra clock resolution */
 108                         u8 data2; /* plus low 2 of above: max hactive */
 109                         u8 supported_aspects;
 110                         u8 flags; /* preferred aspect and blanking support */
 111                         u8 supported_scalings;
 112                         u8 preferred_refresh;
 113                 } __attribute__((packed)) cvt;
 114         } formula;
 115 } __attribute__((packed));
 116
 117 struct detailed_data_wpindex {
 118         u8 white_yx_lo; /* Lower 2 bits each */
 119         u8 white_x_hi;
 120         u8 white_y_hi;
 121         u8 gamma; /* need to divide by 100 then add 1 */
 122 } __attribute__((packed));
 123
 124 struct detailed_data_color_point {
 125         u8 windex1;
 126         u8 wpindex1[3];
 127         u8 windex2;
 128         u8 wpindex2[3];
 129 } __attribute__((packed));
 130
 131 struct cvt_timing {
 132         u8 code[3];
 133 } __attribute__((packed));
 134
 135 struct detailed_non_pixel {
 136         u8 pad1;
 137         u8 type; /* ff=serial, fe=string, fd=monitor range, fc=monitor name
 138                     fb=color point data, fa=standard timing data,
 139                     f9=undefined, f8=mfg. reserved */
 140         u8 pad2;
 141         union {
 142                 struct detailed_data_string str;
 143                 struct detailed_data_monitor_range range;
 144                 struct detailed_data_wpindex color;
 145                 struct std_timing timings[6];
 146                 struct cvt_timing cvt[4];
 147         } data;
 148 } __attribute__((packed));
 149
 150 #define EDID_DETAIL_EST_TIMINGS 0xf7
 151 #define EDID_DETAIL_CVT_3BYTE 0xf8
 152 #define EDID_DETAIL_COLOR_MGMT_DATA 0xf9
 153 #define EDID_DETAIL_STD_MODES 0xfa
 154 #define EDID_DETAIL_MONITOR_CPDATA 0xfb
 155 #define EDID_DETAIL_MONITOR_NAME 0xfc
 156 #define EDID_DETAIL_MONITOR_RANGE 0xfd
 157 #define EDID_DETAIL_MONITOR_STRING 0xfe
 158 #define EDID_DETAIL_MONITOR_SERIAL 0xff
 159
 160 struct detailed_timing {
 161         __le16 pixel_clock; /* need to multiply by 10 KHz */
 162         union {
 163                 struct detailed_pixel_timing pixel_data;
 164                 struct detailed_non_pixel other_data;
 165         } data;
 166 } __attribute__((packed));
 167
 168 #define DRM_EDID_INPUT_SERRATION_VSYNC (1 << 0)
 169 #define DRM_EDID_INPUT_SYNC_ON_GREEN   (1 << 1)
 170 #define DRM_EDID_INPUT_COMPOSITE_SYNC  (1 << 2)
 171 #define DRM_EDID_INPUT_SEPARATE_SYNCS  (1 << 3)
 172 #define DRM_EDID_INPUT_BLANK_TO_BLACK  (1 << 4)
 173 #define DRM_EDID_INPUT_VIDEO_LEVEL     (3 << 5)
 174 #define DRM_EDID_INPUT_DIGITAL         (1 << 7)
 175 #define DRM_EDID_DIGITAL_DEPTH_MASK    (7 << 4)
 176 #define DRM_EDID_DIGITAL_DEPTH_UNDEF   (0 << 4)
 177 #define DRM_EDID_DIGITAL_DEPTH_6       (1 << 4)
 178 #define DRM_EDID_DIGITAL_DEPTH_8       (2 << 4)
 179 #define DRM_EDID_DIGITAL_DEPTH_10      (3 << 4)
 180 #define DRM_EDID_DIGITAL_DEPTH_12      (4 << 4)
 181 #define DRM_EDID_DIGITAL_DEPTH_14      (5 << 4)
 182 #define DRM_EDID_DIGITAL_DEPTH_16      (6 << 4)
 183 #define DRM_EDID_DIGITAL_DEPTH_RSVD    (7 << 4)
 184 #define DRM_EDID_DIGITAL_TYPE_UNDEF    (0)
 185 #define DRM_EDID_DIGITAL_TYPE_DVI      (1)
 186 #define DRM_EDID_DIGITAL_TYPE_HDMI_A   (2)
 187 #define DRM_EDID_DIGITAL_TYPE_HDMI_B   (3)
 188 #define DRM_EDID_DIGITAL_TYPE_MDDI     (4)
 189 #define DRM_EDID_DIGITAL_TYPE_DP       (5)
 190
 191 #define DRM_EDID_FEATURE_DEFAULT_GTF      (1 << 0)
 192 #define DRM_EDID_FEATURE_PREFERRED_TIMING (1 << 1)
 193 #define DRM_EDID_FEATURE_STANDARD_COLOR   (1 << 2)
 194 /* If analog */
 195 #define DRM_EDID_FEATURE_DISPLAY_TYPE     (3 << 3) /* 00=mono, 01=rgb, 10=non-rgb, 11=unknown */
 196 /* If digital */
 197 #define DRM_EDID_FEATURE_COLOR_MASK       (3 << 3)
 198 #define DRM_EDID_FEATURE_RGB              (0 << 3)
 199 #define DRM_EDID_FEATURE_RGB_YCRCB444     (1 << 3)
 200 #define DRM_EDID_FEATURE_RGB_YCRCB422     (2 << 3)
 201 #define DRM_EDID_FEATURE_RGB_YCRCB        (3 << 3) /* both 4:4:4 and 4:2:2 */
 202
 203 #define DRM_EDID_FEATURE_PM_ACTIVE_OFF    (1 << 5)
 204 #define DRM_EDID_FEATURE_PM_SUSPEND       (1 << 6)
 205 #define DRM_EDID_FEATURE_PM_STANDBY       (1 << 7)
 206
 207 #define DRM_EDID_HDMI_DC_48               (1 << 6)
 208 #define DRM_EDID_HDMI_DC_36               (1 << 5)
 209 #define DRM_EDID_HDMI_DC_30               (1 << 4)
 210 #define DRM_EDID_HDMI_DC_Y444             (1 << 3)
 211
 212 /* ELD Header Block */
 213 #define DRM_ELD_HEADER_BLOCK_SIZE       4
 214
 215 #define DRM_ELD_VER                     0
 216 # define DRM_ELD_VER_SHIFT              3
 217 # define DRM_ELD_VER_MASK               (0x1f << 3)
 218
 219 #define DRM_ELD_BASELINE_ELD_LEN        2       /* in dwords! */
 220
 221 /* ELD Baseline Block for ELD_Ver == 2 */
 222 #define DRM_ELD_CEA_EDID_VER_MNL        4
 223 # define DRM_ELD_CEA_EDID_VER_SHIFT     5
 224 # define DRM_ELD_CEA_EDID_VER_MASK      (7 << 5)
 225 # define DRM_ELD_CEA_EDID_VER_NONE      (0 << 5)
 226 # define DRM_ELD_CEA_EDID_VER_CEA861    (1 << 5)
 227 # define DRM_ELD_CEA_EDID_VER_CEA861A   (2 << 5)
 228 # define DRM_ELD_CEA_EDID_VER_CEA861BCD (3 << 5)
 229 # define DRM_ELD_MNL_SHIFT              0
 230 # define DRM_ELD_MNL_MASK               (0x1f << 0)
 231
 232 #define DRM_ELD_SAD_COUNT_CONN_TYPE     5
 233 # define DRM_ELD_SAD_COUNT_SHIFT        4
 234 # define DRM_ELD_SAD_COUNT_MASK         (0xf << 4)
 235 # define DRM_ELD_CONN_TYPE_SHIFT        2
 236 # define DRM_ELD_CONN_TYPE_MASK         (3 << 2)
 237 # define DRM_ELD_CONN_TYPE_HDMI         (0 << 2)
 238 # define DRM_ELD_CONN_TYPE_DP           (1 << 2)
 239 # define DRM_ELD_SUPPORTS_AI            (1 << 1)
 240 # define DRM_ELD_SUPPORTS_HDCP          (1 << 0)
 241
 242 #define DRM_ELD_AUD_SYNCH_DELAY         6       /* in units of 2 ms */
 243 # define DRM_ELD_AUD_SYNCH_DELAY_MAX    0xfa    /* 500 ms */
 244
 245 #define DRM_ELD_SPEAKER                 7
 246 # define DRM_ELD_SPEAKER_RLRC           (1 << 6)
 247 # define DRM_ELD_SPEAKER_FLRC           (1 << 5)
 248 # define DRM_ELD_SPEAKER_RC             (1 << 4)
 249 # define DRM_ELD_SPEAKER_RLR            (1 << 3)
 250 # define DRM_ELD_SPEAKER_FC             (1 << 2)
 251 # define DRM_ELD_SPEAKER_LFE            (1 << 1)
 252 # define DRM_ELD_SPEAKER_FLR            (1 << 0)
 253
 254 #define DRM_ELD_PORT_ID                 8       /* offsets 8..15 inclusive */
 255 # define DRM_ELD_PORT_ID_LEN            8
 256
 257 #define DRM_ELD_MANUFACTURER_NAME0      16
 258 #define DRM_ELD_MANUFACTURER_NAME1      17
 259
 260 #define DRM_ELD_PRODUCT_CODE0           18
 261 #define DRM_ELD_PRODUCT_CODE1           19
 262
 263 #define DRM_ELD_MONITOR_NAME_STRING     20      /* offsets 20..(20+mnl-1) inclusive */
 264
 265 #define DRM_ELD_CEA_SAD(mnl, sad)       (20 + (mnl) + 3 * (sad))
 266
 267 struct edid {
 268         u8 header[8];
 269         /* Vendor & product info */
 270         u8 mfg_id[2];
 271         u8 prod_code[2];
 272         u32 serial; /* FIXME: byte order */
 273         u8 mfg_week;
 274         u8 mfg_year;
 275         /* EDID version */
 276         u8 version;
 277         u8 revision;
 278         /* Display info: */
 279         u8 input;
 280         u8 width_cm;
 281         u8 height_cm;
 282         u8 gamma;
 283         u8 features;
 284         /* Color characteristics */
 285         u8 red_green_lo;
 286         u8 black_white_lo;
 287         u8 red_x;
 288         u8 red_y;
 289         u8 green_x;
 290         u8 green_y;
 291         u8 blue_x;
 292         u8 blue_y;
 293         u8 white_x;
 294         u8 white_y;
 295         /* Est. timings and mfg rsvd timings*/
 296         struct est_timings established_timings;
 297         /* Standard timings 1-8*/
 298         struct std_timing standard_timings[8];
 299         /* Detailing timings 1-4 */
 300         struct detailed_timing detailed_timings[4];
 301         /* Number of 128 byte ext. blocks */
 302         u8 extensions;
 303         /* Checksum */
 304         u8 checksum;
 305 } __attribute__((packed));
 306
 307 #define EDID_PRODUCT_ID(e) ((e)->prod_code[0] | ((e)->prod_code[1] << 8))
 308
 309 /* Short Audio Descriptor */
 310 struct cea_sad {
 311         u8 format;
 312         u8 channels; /* max number of channels - 1 */
 313         u8 freq;
 314         u8 byte2; /* meaning depends on format */
 315 };
 316
 317 struct drm_encoder;
 318 struct drm_connector;
 319 struct drm_display_mode;
 320 struct hdmi_avi_infoframe;
 321 struct hdmi_vendor_infoframe;
 322
 323 void drm_edid_to_eld(struct drm_connector *connector, struct edid *edid);
 324 int drm_edid_to_sad(struct edid *edid, struct cea_sad **sads);
 325 int drm_edid_to_speaker_allocation(struct edid *edid, u8 **sadb);
 326 int drm_av_sync_delay(struct drm_connector *connector,
 327                       struct drm_display_mode *mode);
 328 struct drm_connector *drm_select_eld(struct drm_encoder *encoder,
 329                                      struct drm_display_mode *mode);
 330 int drm_load_edid_firmware(struct drm_connector *connector);
 331
 332 int
 333 drm_hdmi_avi_infoframe_from_display_mode(struct hdmi_avi_infoframe *frame,
 334                                          const struct drm_display_mode *mode);
 335 int
 336 drm_hdmi_vendor_infoframe_from_display_mode(struct hdmi_vendor_infoframe *frame,
 337                                             const struct drm_display_mode *mode);
 338
 339 /**
 340  * drm_eld_mnl - Get ELD monitor name length in bytes.
 341  * @eld: pointer to an eld memory structure with mnl set
 342  */
 343 static inline int drm_eld_mnl(const uint8_t *eld)
 344 {
 345         return (eld[DRM_ELD_CEA_EDID_VER_MNL] & DRM_ELD_MNL_MASK) >> DRM_ELD_MNL_SHIFT;
 346 }
 347
 348 /**
 349  * drm_eld_sad_count - Get ELD SAD count.
 350  * @eld: pointer to an eld memory structure with sad_count set
 351  */
 352 static inline int drm_eld_sad_count(const uint8_t *eld)
 353 {
 354         return (eld[DRM_ELD_SAD_COUNT_CONN_TYPE] & DRM_ELD_SAD_COUNT_MASK) >>
 355                 DRM_ELD_SAD_COUNT_SHIFT;
 356 }
 357
 358 /**
 359  * drm_eld_calc_baseline_block_size - Calculate baseline block size in bytes
 360  * @eld: pointer to an eld memory structure with mnl and sad_count set
 361  *
 362  * This is a helper for determining the payload size of the baseline block, in
 363  * bytes, for e.g. setting the Baseline_ELD_Len field in the ELD header block.
 364  */
 365 static inline int drm_eld_calc_baseline_block_size(const uint8_t *eld)
 366 {
 367         return DRM_ELD_MONITOR_NAME_STRING - DRM_ELD_HEADER_BLOCK_SIZE +
 368                 drm_eld_mnl(eld) + drm_eld_sad_count(eld) * 3;
 369 }
 370
 371 /**
 372  * drm_eld_size - Get ELD size in bytes
 373  * @eld: pointer to a complete eld memory structure
 374  *
 375  * The returned value does not include the vendor block. It's vendor specific,
 376  * and comprises of the remaining bytes in the ELD memory buffer after
 377  * drm_eld_size() bytes of header and baseline block.
 378  *
 379  * The returned value is guaranteed to be a multiple of 4.
 380  */
 381 static inline int drm_eld_size(const uint8_t *eld)
 382 {
 383         return DRM_ELD_HEADER_BLOCK_SIZE + eld[DRM_ELD_BASELINE_ELD_LEN] * 4;
 384 }
 385
 386 struct edid *drm_do_get_edid(struct drm_connector *connector,
 387         int (*get_edid_block)(void *data, u8 *buf, unsigned int block,
 388                               size_t len),
 389         void *data);
 390
 391 #endif /* __DRM_EDID_H__ */