decoders/edid/edid.py

   1 ##
   2 ## This file is part of the sigrok project.
   3 ##
   4 ## Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
   5 ##
   6 ## This program is free software; you can redistribute it and/or modify
   7 ## it under the terms of the GNU General Public License as published by
   8 ## the Free Software Foundation; either version 3 of the License, or
   9 ## (at your option) any later version.
  10 ##
  11 ## This program is distributed in the hope that it will be useful,
  12 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 ## GNU General Public License for more details.
  15 ##
  16 ## You should have received a copy of the GNU General Public License
  17 ## along with this program; if not, see <http://www.gnu.org/licenses/>.
  18 ##
  19
  20 # EDID protocol decoder
  21
  22 # TODO:
  23 #    - EDID < 1.3
  24 #    - add short annotations
  25 #    - Signal level standard field in basic display parameters block
  26 #    - Additional color point descriptors
  27 #    - Additional standard timing descriptors
  28 #    - Extensions
  29
  30 import sigrokdecode as srd
  31 import os
  32
  33 EDID_HEADER = [0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x00]
  34 OFF_VENDOR = 8
  35 OFF_VERSION = 18
  36 OFF_BASIC = 20
  37 OFF_CHROM = 25
  38 OFF_EST_TIMING = 35
  39 OFF_STD_TIMING = 38
  40 OFF_DET_TIMING = 54
  41 OFF_NUM_EXT = 126
  42 OFF_CHECKSUM = 127
  43
  44 # Pre-EDID established timing modes
  45 est_modes = [
  46     "720x400@70Hz",
  47     "720x400@88Hz",
  48     "640x480@60Hz",
  49     "640x480@67Hz",
  50     "640x480@72Hz",
  51     "640x480@75Hz",
  52     "800x600@56Hz",
  53     "800x600@60Hz",
  54     "800x600@72Hz",
  55     "800x600@75Hz",
  56     "832x624@75Hz",
  57     "1024x768@87Hz(i)",
  58     "1024x768@60Hz",
  59     "1024x768@70Hz",
  60     "1024x768@75Hz",
  61     "1280x1024@75Hz",
  62     "1152x870@75Hz",
  63 ]
  64
  65 # X:Y display aspect ratios, as used in standard timing modes
  66 xy_ratio = [
  67     (16, 10),
  68     (4, 3),
  69     (5, 4),
  70     (16, 9),
  71 ]
  72
  73 # Annotation types
  74 ANN_FIELDS = 0
  75 ANN_SECTIONS = 1
  76
  77 class Decoder(srd.Decoder):
  78     api_version = 1
  79     id = 'edid'
  80     name = 'EDID'
  81     longname = 'Extended display identification data'
  82     desc = 'A data structure describing the capabilities of a display device.'
  83     license = 'gplv3+'
  84     inputs = ['ddc2']
  85     outputs = ['edid']
  86     options = {}
  87     annotations = [
  88         ['EDID fields', 'EDID structure fields'],
  89         ['EDID sections', 'EDID structure sections'],
  90     ]
  91
  92     def __init__(self, **kwargs):
  93         self.state = None
  94         # Received data items, used as an index into samplenum/data
  95         self.cnt = 0
  96         # Start/end sample numbers per data item
  97         self.sn = []
  98         # Received data
  99         self.cache = []
 100
 101     def start(self, metadata):
 102         self.out_ann = self.add(srd.OUTPUT_ANN, 'edid')
 103
 104     def decode(self, ss, es, data):
 105         if type(data) != int:
 106             raise Exception('malformed ddc2 input: expected 1 byte')
 107         self.cnt += 1
 108         self.sn.append([ss, es])
 109         self.cache.append(data)
 110         # debug
 111 #        self.put(ss, es, self.out_ann, [0, ["%d: [%.2x]" % (self.cnt, data)]])
 112
 113         if self.state is None:
 114             # Wait for the EDID header
 115             if self.cnt >= OFF_VENDOR:
 116                 if self.cache[-8:] == EDID_HEADER:
 117                     # Throw away any garbage before the header
 118                     self.sn = self.sn[-8:]
 119                     self.cache = self.cache[-8:]
 120                     self.cnt = 8
 121                     self.state = 'edid'
 122                     self.put(ss, es, self.out_ann, [0, ["EDID header"]])
 123         elif self.state == 'edid':
 124             if self.cnt == OFF_VERSION:
 125                 self.decode_vid(-10)
 126                 self.decode_pid(-8)
 127                 self.decode_serial(-6)
 128                 self.decode_mfrdate(-2)
 129             elif self.cnt == OFF_BASIC:
 130                 version = "EDID version: %d.%d" % (self.cache[-2], self.cache[-1])
 131                 self.put(ss, es, self.out_ann, [0, [version]])
 132             elif self.cnt == OFF_CHROM:
 133                 self.decode_basicdisplay(-5)
 134             elif self.cnt == OFF_EST_TIMING:
 135                 self.decode_chromaticity(-10)
 136             elif self.cnt == OFF_STD_TIMING:
 137                 self.decode_est_timing(-3)
 138             elif self.cnt == OFF_DET_TIMING:
 139                 self.decode_std_timing(-16)
 140             elif self.cnt == OFF_NUM_EXT:
 141                 self.decode_descriptors(-72)
 142             elif self.cnt == OFF_CHECKSUM:
 143                 self.put(ss, es, self.out_ann, [0, ["Extensions present: %d" % self.cache[self.cnt-1]]])
 144             elif self.cnt == OFF_CHECKSUM+1:
 145                 checksum = 0
 146                 for i in range(128):
 147                     checksum += self.cache[i]
 148                 if checksum % 256 == 0:
 149                     csstr = "OK"
 150                 else:
 151                     csstr = "WRONG!"
 152                 self.put(ss, es, self.out_ann, [0, ["Checksum: %d (%s)" % (
 153                                 self.cache[self.cnt-1], csstr)]])
 154                 self.state = 'extensions'
 155         elif self.state == 'extensions':
 156             pass
 157
 158     def ann_field(self, start, end, annotation):
 159         self.put(self.sn[start][0], self.sn[end][1], self.out_ann, [ANN_FIELDS, [annotation]])
 160
 161     def lookup_pnpid(self, pnpid):
 162         pnpid_file = os.path.join(os.path.dirname(__file__), 'pnpids.txt')
 163         if os.path.exists(pnpid_file):
 164             for line in open(pnpid_file).readlines():
 165                 if line.find(pnpid + ';') == 0:
 166                     return line[4:].strip()
 167         return ''
 168
 169     def decode_vid(self, offset):
 170         pnpid = chr(64 + ((self.cache[offset] & 0x7c) >> 2))
 171         pnpid += chr(64 + (((self.cache[offset] & 0x03) << 3)
 172                            | ((self.cache[offset+1] & 0xe0) >> 5)))
 173         pnpid += chr(64 + (self.cache[offset+1] & 0x1f))
 174         vendor = self.lookup_pnpid(pnpid)
 175         if vendor:
 176             pnpid += " (%s)" % vendor
 177         self.ann_field(offset, offset+1, pnpid)
 178
 179     def decode_pid(self, offset):
 180         pidstr = "Product 0x%.2x%.2x" % (self.cache[offset+1], self.cache[offset])
 181         self.ann_field(offset, offset+1, pidstr)
 182
 183     def decode_serial(self, offset):
 184         serialnum = (self.cache[offset+3] << 24) \
 185                 + (self.cache[offset+2] << 16) \
 186                 + (self.cache[offset+1] << 8) \
 187                 + self.cache[offset]
 188         serialstr = ''
 189         is_alnum = True
 190         for i in range(4):
 191             if not chr(self.cache[offset+3-i]).isalnum():
 192                 is_alnum = False
 193                 break
 194             serialstr += chr(self.cache[offset+3-i])
 195         if is_alnum:
 196             serial = serialstr
 197         else:
 198             serial = str(serialnum)
 199         self.ann_field(offset, offset+3, "Serial " + serial)
 200
 201     def decode_mfrdate(self, offset):
 202         datestr = ''
 203         if self.cache[offset]:
 204             datestr += "week %d, " % self.cache[offset]
 205         datestr += str(1990 + self.cache[offset+1])
 206         if datestr:
 207             self.ann_field(offset, offset+1, "Manufactured " + datestr)
 208
 209     def decode_basicdisplay(self, offset):
 210         # Video input definition
 211         vid = self.cache[offset]
 212         if vid & 0x80:
 213             # Digital
 214             self.ann_field(offset, offset, "Video input: VESA DFP 1.")
 215         else:
 216             # Analog
 217             sls = (vid & 60) >> 5
 218             self.ann_field(offset, offset, "Signal level standard: %.2x" % sls)
 219             if vid & 0x10:
 220                 self.ann_field(offset, offset, "Blank-to-black setup expected")
 221             syncs = ''
 222             if vid & 0x08:
 223                 syncs += 'separate syncs, '
 224             if vid & 0x04:
 225                 syncs += 'composite syncs, '
 226             if vid & 0x02:
 227                 syncs += 'sync on green, '
 228             if vid & 0x01:
 229                 syncs += 'Vsync serration required, '
 230             if syncs:
 231                 self.ann_field(offset, offset, "Supported syncs: %s" % syncs[:-2])
 232         # Max horizontal/vertical image size
 233         if self.cache[offset+1] != 0 and self.cache[offset+2] != 0:
 234             # Projectors have this set to 0
 235             sizestr = "%dx%dcm" % (self.cache[offset+1], self.cache[offset+2])
 236             self.ann_field(offset+1, offset+2, "Physical size: " + sizestr)
 237         # Display transfer characteristic (gamma)
 238         if self.cache[offset+3] != 0xff:
 239             gamma = (self.cache[offset+3] + 100) / 100
 240             self.ann_field(offset+3, offset+3, "Gamma: %1.2f" % gamma)
 241         # Feature support
 242         fs = self.cache[offset+4]
 243         dpms = ''
 244         if fs & 0x80:
 245             dpms += 'standby, '
 246         if fs & 0x40:
 247             dpms += 'suspend, '
 248         if fs & 0x20:
 249             dpms += 'active off, '
 250         if dpms:
 251             self.ann_field(offset+4, offset+4, "DPMS support: %s" % dpms[:-2])
 252         dt = (fs & 0x18) >> 3
 253         dtstr = ''
 254         if dt == 0:
 255             dtstr = 'Monochrome'
 256         elif dt == 1:
 257             dtstr = 'RGB color'
 258         elif dt == 2:
 259             dtstr = 'non-RGB multicolor'
 260         if dtstr:
 261             self.ann_field(offset+4, offset+4, "Display type: %s" % dtstr)
 262         if fs & 0x04:
 263             self.ann_field(offset+4, offset+4, "Color space: standard sRGB")
 264         # Save this for when we decode the first detailed timing descriptor
 265         self.have_preferred_timing = (fs & 0x02) == 0x02
 266         if fs & 0x01:
 267             gft = ''
 268         else:
 269             gft = 'not '
 270         self.ann_field(offset+4, offset+4, "Generalized timing formula: %ssupported" % gft)
 271
 272     def convert_color(self, value):
 273         # Convert from 10-bit packet format to float
 274         outval = 0.0
 275         for i in range(10):
 276             if value & 0x01:
 277                 outval += 2 ** -(10-i)
 278             value >>= 1
 279         return outval
 280
 281     def decode_chromaticity(self, offset):
 282         redx = (self.cache[offset+2] << 2) + ((self.cache[offset] & 0xc0) >> 6)
 283         redy = (self.cache[offset+3] << 2) + ((self.cache[offset] & 0x30) >> 4)
 284         self.ann_field(offset, offset+9, "Chromacity red: X %1.3f, Y %1.3f" % (
 285                         self.convert_color(redx), self.convert_color(redy)))
 286
 287         greenx = (self.cache[offset+4] << 2) + ((self.cache[offset] & 0x0c) >> 6)
 288         greeny = (self.cache[offset+5] << 2) + ((self.cache[offset] & 0x03) >> 4)
 289         self.ann_field(offset, offset+9, "Chromacity green: X %1.3f, Y %1.3f" % (
 290                         self.convert_color(greenx), self.convert_color(greeny)))
 291
 292         bluex = (self.cache[offset+6] << 2) + ((self.cache[offset+1] & 0xc0) >> 6)
 293         bluey = (self.cache[offset+7] << 2) + ((self.cache[offset+1] & 0x30) >> 4)
 294         self.ann_field(offset, offset+9, "Chromacity blue: X %1.3f, Y %1.3f" % (
 295                         self.convert_color(bluex), self.convert_color(bluey)))
 296
 297         whitex = (self.cache[offset+8] << 2) + ((self.cache[offset+1] & 0x0c) >> 6)
 298         whitey = (self.cache[offset+9] << 2) + ((self.cache[offset+1] & 0x03) >> 4)
 299         self.ann_field(offset, offset+9, "Chromacity white: X %1.3f, Y %1.3f" % (
 300                         self.convert_color(whitex), self.convert_color(whitey)))
 301
 302     def decode_est_timing(self, offset):
 303         # Pre-EDID modes
 304         bitmap = (self.cache[offset] << 9) \
 305             + (self.cache[offset+1] << 1) \
 306             + ((self.cache[offset+2] & 0x80) >> 7)
 307         modestr = ''
 308         for i in range(17):
 309                 if bitmap & (1 << (16-i)):
 310                     modestr += est_modes[i] + ', '
 311         if modestr:
 312             self.ann_field(offset, offset+2, "Supported establised modes: %s" % modestr[:-2])
 313
 314     def decode_std_timing(self, offset):
 315         modestr = ''
 316         for i in range(0, 16, 2):
 317             if self.cache[offset+i] == 0x01 and self.cache[offset+i+1] == 0x01:
 318                 # Unused field
 319                 continue
 320             x = (self.cache[offset+i] + 31) * 8
 321             ratio = (self.cache[offset+i+1] & 0xc0) >> 6
 322             ratio_x, ratio_y = xy_ratio[ratio]
 323             y = x / ratio_x * ratio_y
 324             refresh = (self.cache[offset+i+1] & 0x3f) + 60
 325             modestr += "%dx%d@%dHz, " % (x, y, refresh)
 326         if modestr:
 327             self.ann_field(offset, offset+2, "Supported standard modes: %s" % modestr[:-2])
 328
 329     def decode_detailed_timing(self, offset):
 330         if offset == -72 and self.have_preferred_timing:
 331             # Only on first detailed timing descriptor
 332             section = 'Preferred'
 333         else:
 334             section = 'Detailed'
 335         section += ' timing descriptor'
 336         self.put(self.sn[offset][0], self.sn[offset+18][1],
 337              self.out_ann, [ANN_SECTIONS, [section]])
 338
 339         pixclock = float((self.cache[offset+1] << 8) + self.cache[offset]) / 100
 340         self.ann_field(offset, offset+1, "Pixel clock: %.2f MHz" % pixclock)
 341
 342         horiz_active = ((self.cache[offset+4] & 0xf0) << 4) + self.cache[offset+2]
 343         self.ann_field(offset+2, offset+4, "Horizontal active: %d" % horiz_active)
 344
 345         horiz_blank = ((self.cache[offset+4] & 0x0f) << 8) + self.cache[offset+3]
 346         self.ann_field(offset+3, offset+4, "Horizontal blanking: %d" % horiz_blank)
 347
 348         vert_active = ((self.cache[offset+7] & 0xf0) << 4) + self.cache[offset+5]
 349         self.ann_field(offset+5, offset+7, "Vertical active: %d" % vert_active)
 350
 351         vert_blank = ((self.cache[offset+7] & 0x0f) << 8) + self.cache[offset+6]
 352         self.ann_field(offset+6, offset+7, "Vertical blanking: %d" % vert_blank)
 353
 354         horiz_sync_off = ((self.cache[offset+11] & 0xc0) << 2) + self.cache[offset+8]
 355         self.ann_field(offset+8, offset+11, "Horizontal sync offset: %d" % horiz_sync_off)
 356
 357         horiz_sync_pw = ((self.cache[offset+11] & 0x30) << 4) + self.cache[offset+9]
 358         self.ann_field(offset+9, offset+11, "Horizontal sync pulse width: %d" % horiz_sync_pw)
 359
 360         vert_sync_off = ((self.cache[offset+11] & 0x0c) << 2) \
 361                     + ((self.cache[offset+10] & 0xf0) >> 4)
 362         self.ann_field(offset+10, offset+11, "Vertical sync offset: %d" % vert_sync_off)
 363
 364         vert_sync_pw = ((self.cache[offset+11] & 0x03) << 4) \
 365                     + (self.cache[offset+10] & 0x0f)
 366         self.ann_field(offset+10, offset+11, "Vertical sync pulse width: %d" % vert_sync_pw)
 367
 368         horiz_size = ((self.cache[offset+14] & 0xf0) << 4) + self.cache[offset+12]
 369         vert_size = ((self.cache[offset+14] & 0x0f) << 8) + self.cache[offset+13]
 370         self.ann_field(offset+12, offset+14, "Physical size: %dx%dmm" % (horiz_size, vert_size))
 371
 372         horiz_border = self.cache[offset+15]
 373         if horiz_border:
 374             self.ann_field(offset+15, offset+15, "Horizontal border: %d pixels" % horiz_border)
 375         vert_border = self.cache[offset+16]
 376         if vert_border:
 377             self.ann_field(offset+16, offset+16, "Vertical border: %d lines" % vert_border)
 378
 379         features = 'Flags: '
 380         if self.cache[offset+17] & 0x80:
 381             features += 'interlaced, '
 382         stereo = (self.cache[offset+17] & 0x60) >> 5
 383         if stereo:
 384             if self.cache[offset+17] & 0x01:
 385                 features += '2-way interleaved stereo ('
 386                 features += ['right image on even lines', 'left image on even lines',
 387                              'side-by-side'][stereo-1]
 388                 features += '), '
 389             else:
 390                 features += 'field sequential stereo ('
 391                 features += ['right image on sync=1', 'left image on sync=1',
 392                              '4-way interleaved'][stereo-1]
 393                 features += '), '
 394         sync = (self.cache[offset+17] & 0x18) >> 3
 395         sync2 = (self.cache[offset+17] & 0x06) >> 1
 396         posneg = ['negative', 'positive']
 397         features += 'sync type '
 398         if sync == 0x00:
 399             features += 'analog composite (serrate on RGB)'
 400         elif sync == 0x01:
 401             features += 'bipolar analog composite (serrate on RGB)'
 402         elif sync == 0x02:
 403             features += 'digital composite (serrate on composite polarity ' \
 404                     + (posneg[sync2 & 0x01]) + ')'
 405         elif sync == 0x03:
 406             features += 'digital separate ('
 407             features += 'Vsync polarity ' + (posneg[(sync2 & 0x02) >> 1])
 408             features += ', Hsync polarity ' + (posneg[sync2 & 0x01])
 409             features += ')'
 410         features += ', '
 411         self.ann_field(offset+17, offset+17, features[:-2])
 412
 413     def decode_descriptor(self, offset):
 414         tag = self.cache[offset+3]
 415         if tag == 0xff:
 416             # Monitor serial number
 417             text = bytes(self.cache[offset+5:][:13]).decode(encoding='cp437', errors='replace')
 418             self.ann_field(offset, offset+17, "Serial number: %s" % text.strip())
 419         elif tag == 0xfe:
 420             # Text
 421             text = bytes(self.cache[offset+5:][:13]).decode(encoding='cp437', errors='replace')
 422             self.ann_field(offset, offset+17, "Info: %s" % text.strip())
 423         elif tag == 0xfc:
 424             # Monitor name
 425             text = bytes(self.cache[offset+5:][:13]).decode(encoding='cp437', errors='replace')
 426             self.ann_field(offset, offset+17, "Model name: %s" % text.strip())
 427         elif tag == 0xfd:
 428             # Monitor range limits
 429             self.put(self.sn[offset][0], self.sn[offset+17][1], self.out_ann,
 430                      [ANN_SECTIONS, ["Monitor range limits"]])
 431             self.ann_field(offset+5, offset+5, "Minimum vertical rate: %dHz" %
 432                            self.cache[offset+5])
 433             self.ann_field(offset+6, offset+6, "Maximum vertical rate: %dHz" %
 434                            self.cache[offset+6])
 435             self.ann_field(offset+7, offset+7, "Minimum horizontal rate: %dkHz" %
 436                            self.cache[offset+7])
 437             self.ann_field(offset+8, offset+8, "Maximum horizontal rate: %dkHz" %
 438                            self.cache[offset+8])
 439             self.ann_field(offset+9, offset+9, "Maximum pixel clock: %dMHz" %
 440                            (self.cache[offset+9] * 10))
 441             if self.cache[offset+10] == 0x02:
 442                 # Secondary GTF curve supported
 443                 self.ann_field(offset+10, offset+17, "Secondary timing formula supported")
 444         elif tag == 0xfb:
 445             # Additional color point data
 446             self.put(self.sn[offset][0], self.sn[offset+17][1], self.out_ann,
 447                      [ANN_SECTIONS, ["Additional color point data"]])
 448         elif tag == 0xfa:
 449             # Additional standard timing definitions
 450             self.put(self.sn[offset][0], self.sn[offset+17][1], self.out_ann,
 451                      [ANN_SECTIONS, ["Additional standard timing definitions"]])
 452         else:
 453             self.put(self.sn[offset][0], self.sn[offset+17][1], self.out_ann,
 454                      [ANN_SECTIONS, ["Unknown descriptor"]])
 455
 456     def decode_descriptors(self, offset):
 457         # 4 consecutive 18-byte descriptor blocks
 458         for i in range(offset, 0, 18):
 459             if self.cache[i] != 0 and self.cache[i+1] != 0:
 460                 self.decode_detailed_timing(i)
 461             else:
 462                 if self.cache[i+2] == 0 or self.cache[i+4] == 0:
 463                     self.decode_descriptor(i)
 464