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 = 'Data structure describing display device capabilities.'
  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 report(self):
 105         pass
 106
 107     def decode(self, ss, es, data):
 108         if type(data) != int:
 109             raise Exception('malformed ddc2 input: expected 1 byte')
 110         self.cnt += 1
 111         self.sn.append([ss, es])
 112         self.cache.append(data)
 113         # debug
 114 #        self.put(ss, es, self.out_ann, [0, ['%d: [%.2x]' % (self.cnt, data)]])
 115
 116         if self.state is None:
 117             # Wait for the EDID header
 118             if self.cnt >= OFF_VENDOR:
 119                 if self.cache[-8:] == EDID_HEADER:
 120                     # Throw away any garbage before the header
 121                     self.sn = self.sn[-8:]
 122                     self.cache = self.cache[-8:]
 123                     self.cnt = 8
 124                     self.state = 'edid'
 125                     self.put(ss, es, self.out_ann, [0, ['EDID header']])
 126         elif self.state == 'edid':
 127             if self.cnt == OFF_VERSION:
 128                 self.decode_vid(-10)
 129                 self.decode_pid(-8)
 130                 self.decode_serial(-6)
 131                 self.decode_mfrdate(-2)
 132             elif self.cnt == OFF_BASIC:
 133                 version = 'EDID version: %d.%d' % (self.cache[-2], self.cache[-1])
 134                 self.put(ss, es, self.out_ann, [0, [version]])
 135             elif self.cnt == OFF_CHROM:
 136                 self.decode_basicdisplay(-5)
 137             elif self.cnt == OFF_EST_TIMING:
 138                 self.decode_chromaticity(-10)
 139             elif self.cnt == OFF_STD_TIMING:
 140                 self.decode_est_timing(-3)
 141             elif self.cnt == OFF_DET_TIMING:
 142                 self.decode_std_timing(-16)
 143             elif self.cnt == OFF_NUM_EXT:
 144                 self.decode_descriptors(-72)
 145             elif self.cnt == OFF_CHECKSUM:
 146                 self.put(ss, es, self.out_ann,
 147                     [0, ['Extensions present: %d' % self.cache[self.cnt-1]]])
 148             elif self.cnt == OFF_CHECKSUM+1:
 149                 checksum = 0
 150                 for i in range(128):
 151                     checksum += self.cache[i]
 152                 if checksum % 256 == 0:
 153                     csstr = 'OK'
 154                 else:
 155                     csstr = 'WRONG!'
 156                 self.put(ss, es, self.out_ann, [0, ['Checksum: %d (%s)' % (
 157                          self.cache[self.cnt-1], csstr)]])
 158                 self.state = 'extensions'
 159         elif self.state == 'extensions':
 160             pass
 161
 162     def ann_field(self, start, end, annotation):
 163         self.put(self.sn[start][0], self.sn[end][1],
 164                  self.out_ann, [ANN_FIELDS, [annotation]])
 165
 166     def lookup_pnpid(self, pnpid):
 167         pnpid_file = os.path.join(os.path.dirname(__file__), 'pnpids.txt')
 168         if os.path.exists(pnpid_file):
 169             for line in open(pnpid_file).readlines():
 170                 if line.find(pnpid + ';') == 0:
 171                     return line[4:].strip()
 172         return ''
 173
 174     def decode_vid(self, offset):
 175         pnpid = chr(64 + ((self.cache[offset] & 0x7c) >> 2))
 176         pnpid += chr(64 + (((self.cache[offset] & 0x03) << 3)
 177                            | ((self.cache[offset+1] & 0xe0) >> 5)))
 178         pnpid += chr(64 + (self.cache[offset+1] & 0x1f))
 179         vendor = self.lookup_pnpid(pnpid)
 180         if vendor:
 181             pnpid += ' (%s)' % vendor
 182         self.ann_field(offset, offset+1, pnpid)
 183
 184     def decode_pid(self, offset):
 185         pidstr = 'Product 0x%.2x%.2x' % (self.cache[offset+1], self.cache[offset])
 186         self.ann_field(offset, offset+1, pidstr)
 187
 188     def decode_serial(self, offset):
 189         serialnum = (self.cache[offset+3] << 24) \
 190                 + (self.cache[offset+2] << 16) \
 191                 + (self.cache[offset+1] << 8) \
 192                 + self.cache[offset]
 193         serialstr = ''
 194         is_alnum = True
 195         for i in range(4):
 196             if not chr(self.cache[offset+3-i]).isalnum():
 197                 is_alnum = False
 198                 break
 199             serialstr += chr(self.cache[offset+3-i])
 200         serial = serialstr if is_alnum else str(serialnum)
 201         self.ann_field(offset, offset+3, 'Serial ' + serial)
 202
 203     def decode_mfrdate(self, offset):
 204         datestr = ''
 205         if self.cache[offset]:
 206             datestr += 'week %d, ' % self.cache[offset]
 207         datestr += str(1990 + self.cache[offset+1])
 208         if datestr:
 209             self.ann_field(offset, offset+1, 'Manufactured ' + datestr)
 210
 211     def decode_basicdisplay(self, offset):
 212         # Video input definition
 213         vid = self.cache[offset]
 214         if vid & 0x80:
 215             # Digital
 216             self.ann_field(offset, offset, 'Video input: VESA DFP 1.')
 217         else:
 218             # Analog
 219             sls = (vid & 60) >> 5
 220             self.ann_field(offset, offset, 'Signal level standard: %.2x' % sls)
 221             if vid & 0x10:
 222                 self.ann_field(offset, offset, 'Blank-to-black setup expected')
 223             syncs = ''
 224             if vid & 0x08:
 225                 syncs += 'separate syncs, '
 226             if vid & 0x04:
 227                 syncs += 'composite syncs, '
 228             if vid & 0x02:
 229                 syncs += 'sync on green, '
 230             if vid & 0x01:
 231                 syncs += 'Vsync serration required, '
 232             if syncs:
 233                 self.ann_field(offset, offset, 'Supported syncs: %s' % syncs[:-2])
 234         # Max horizontal/vertical image size
 235         if self.cache[offset+1] != 0 and self.cache[offset+2] != 0:
 236             # Projectors have this set to 0
 237             sizestr = '%dx%dcm' % (self.cache[offset+1], self.cache[offset+2])
 238             self.ann_field(offset+1, offset+2, 'Physical size: ' + sizestr)
 239         # Display transfer characteristic (gamma)
 240         if self.cache[offset+3] != 0xff:
 241             gamma = (self.cache[offset+3] + 100) / 100
 242             self.ann_field(offset+3, offset+3, 'Gamma: %1.2f' % gamma)
 243         # Feature support
 244         fs = self.cache[offset+4]
 245         dpms = ''
 246         if fs & 0x80:
 247             dpms += 'standby, '
 248         if fs & 0x40:
 249             dpms += 'suspend, '
 250         if fs & 0x20:
 251             dpms += 'active off, '
 252         if dpms:
 253             self.ann_field(offset+4, offset+4, 'DPMS support: %s' % dpms[:-2])
 254         dt = (fs & 0x18) >> 3
 255         dtstr = ''
 256         if dt == 0:
 257             dtstr = 'Monochrome'
 258         elif dt == 1:
 259             dtstr = 'RGB color'
 260         elif dt == 2:
 261             dtstr = 'non-RGB multicolor'
 262         if dtstr:
 263             self.ann_field(offset+4, offset+4, 'Display type: %s' % dtstr)
 264         if fs & 0x04:
 265             self.ann_field(offset+4, offset+4, 'Color space: standard sRGB')
 266         # Save this for when we decode the first detailed timing descriptor
 267         self.have_preferred_timing = (fs & 0x02) == 0x02
 268         if fs & 0x01:
 269             gft = ''
 270         else:
 271             gft = 'not '
 272         self.ann_field(offset+4, offset+4,
 273                        'Generalized timing formula: %ssupported' % gft)
 274
 275     def convert_color(self, value):
 276         # Convert from 10-bit packet format to float
 277         outval = 0.0
 278         for i in range(10):
 279             if value & 0x01:
 280                 outval += 2 ** -(10-i)
 281             value >>= 1
 282         return outval
 283
 284     def decode_chromaticity(self, offset):
 285         redx = (self.cache[offset+2] << 2) + ((self.cache[offset] & 0xc0) >> 6)
 286         redy = (self.cache[offset+3] << 2) + ((self.cache[offset] & 0x30) >> 4)
 287         self.ann_field(offset, offset+9, 'Chromacity red: X %1.3f, Y %1.3f' % (
 288                        self.convert_color(redx), self.convert_color(redy)))
 289
 290         greenx = (self.cache[offset+4] << 2) + ((self.cache[offset] & 0x0c) >> 6)
 291         greeny = (self.cache[offset+5] << 2) + ((self.cache[offset] & 0x03) >> 4)
 292         self.ann_field(offset, offset+9, 'Chromacity green: X %1.3f, Y %1.3f' % (
 293                        self.convert_color(greenx), self.convert_color(greeny)))
 294
 295         bluex = (self.cache[offset+6] << 2) + ((self.cache[offset+1] & 0xc0) >> 6)
 296         bluey = (self.cache[offset+7] << 2) + ((self.cache[offset+1] & 0x30) >> 4)
 297         self.ann_field(offset, offset+9, 'Chromacity blue: X %1.3f, Y %1.3f' % (
 298                        self.convert_color(bluex), self.convert_color(bluey)))
 299
 300         whitex = (self.cache[offset+8] << 2) + ((self.cache[offset+1] & 0x0c) >> 6)
 301         whitey = (self.cache[offset+9] << 2) + ((self.cache[offset+1] & 0x03) >> 4)
 302         self.ann_field(offset, offset+9, 'Chromacity white: X %1.3f, Y %1.3f' % (
 303                        self.convert_color(whitex), self.convert_color(whitey)))
 304
 305     def decode_est_timing(self, offset):
 306         # Pre-EDID modes
 307         bitmap = (self.cache[offset] << 9) \
 308             + (self.cache[offset+1] << 1) \
 309             + ((self.cache[offset+2] & 0x80) >> 7)
 310         modestr = ''
 311         for i in range(17):
 312                 if bitmap & (1 << (16-i)):
 313                     modestr += est_modes[i] + ', '
 314         if modestr:
 315             self.ann_field(offset, offset+2,
 316                            'Supported establised modes: %s' % modestr[:-2])
 317
 318     def decode_std_timing(self, offset):
 319         modestr = ''
 320         for i in range(0, 16, 2):
 321             if self.cache[offset+i] == 0x01 and self.cache[offset+i+1] == 0x01:
 322                 # Unused field
 323                 continue
 324             x = (self.cache[offset+i] + 31) * 8
 325             ratio = (self.cache[offset+i+1] & 0xc0) >> 6
 326             ratio_x, ratio_y = xy_ratio[ratio]
 327             y = x / ratio_x * ratio_y
 328             refresh = (self.cache[offset+i+1] & 0x3f) + 60
 329             modestr += '%dx%d@%dHz, ' % (x, y, refresh)
 330         if modestr:
 331             self.ann_field(offset, offset+2,
 332                            'Supported standard modes: %s' % modestr[:-2])
 333
 334     def decode_detailed_timing(self, offset):
 335         if offset == -72 and self.have_preferred_timing:
 336             # Only on first detailed timing descriptor
 337             section = 'Preferred'
 338         else:
 339             section = 'Detailed'
 340         section += ' timing descriptor'
 341         self.put(self.sn[offset][0], self.sn[offset+18][1],
 342              self.out_ann, [ANN_SECTIONS, [section]])
 343
 344         pixclock = float((self.cache[offset+1] << 8) + self.cache[offset]) / 100
 345         self.ann_field(offset, offset+1, 'Pixel clock: %.2f MHz' % pixclock)
 346
 347         horiz_active = ((self.cache[offset+4] & 0xf0) << 4) + self.cache[offset+2]
 348         self.ann_field(offset+2, offset+4, 'Horizontal active: %d' % horiz_active)
 349
 350         horiz_blank = ((self.cache[offset+4] & 0x0f) << 8) + self.cache[offset+3]
 351         self.ann_field(offset+3, offset+4, 'Horizontal blanking: %d' % horiz_blank)
 352
 353         vert_active = ((self.cache[offset+7] & 0xf0) << 4) + self.cache[offset+5]
 354         self.ann_field(offset+5, offset+7, 'Vertical active: %d' % vert_active)
 355
 356         vert_blank = ((self.cache[offset+7] & 0x0f) << 8) + self.cache[offset+6]
 357         self.ann_field(offset+6, offset+7, 'Vertical blanking: %d' % vert_blank)
 358
 359         horiz_sync_off = ((self.cache[offset+11] & 0xc0) << 2) + self.cache[offset+8]
 360         self.ann_field(offset+8, offset+11, 'Horizontal sync offset: %d' % horiz_sync_off)
 361
 362         horiz_sync_pw = ((self.cache[offset+11] & 0x30) << 4) + self.cache[offset+9]
 363         self.ann_field(offset+9, offset+11, 'Horizontal sync pulse width: %d' % horiz_sync_pw)
 364
 365         vert_sync_off = ((self.cache[offset+11] & 0x0c) << 2) \
 366                     + ((self.cache[offset+10] & 0xf0) >> 4)
 367         self.ann_field(offset+10, offset+11, 'Vertical sync offset: %d' % vert_sync_off)
 368
 369         vert_sync_pw = ((self.cache[offset+11] & 0x03) << 4) \
 370                     + (self.cache[offset+10] & 0x0f)
 371         self.ann_field(offset+10, offset+11, 'Vertical sync pulse width: %d' % vert_sync_pw)
 372
 373         horiz_size = ((self.cache[offset+14] & 0xf0) << 4) + self.cache[offset+12]
 374         vert_size = ((self.cache[offset+14] & 0x0f) << 8) + self.cache[offset+13]
 375         self.ann_field(offset+12, offset+14, 'Physical size: %dx%dmm' % (horiz_size, vert_size))
 376
 377         horiz_border = self.cache[offset+15]
 378         if horiz_border:
 379             self.ann_field(offset+15, offset+15, 'Horizontal border: %d pixels' % horiz_border)
 380         vert_border = self.cache[offset+16]
 381         if vert_border:
 382             self.ann_field(offset+16, offset+16, 'Vertical border: %d lines' % vert_border)
 383
 384         features = 'Flags: '
 385         if self.cache[offset+17] & 0x80:
 386             features += 'interlaced, '
 387         stereo = (self.cache[offset+17] & 0x60) >> 5
 388         if stereo:
 389             if self.cache[offset+17] & 0x01:
 390                 features += '2-way interleaved stereo ('
 391                 features += ['right image on even lines',
 392                              'left image on even lines',
 393                              'side-by-side'][stereo-1]
 394                 features += '), '
 395             else:
 396                 features += 'field sequential stereo ('
 397                 features += ['right image on sync=1', 'left image on sync=1',
 398                              '4-way interleaved'][stereo-1]
 399                 features += '), '
 400         sync = (self.cache[offset+17] & 0x18) >> 3
 401         sync2 = (self.cache[offset+17] & 0x06) >> 1
 402         posneg = ['negative', 'positive']
 403         features += 'sync type '
 404         if sync == 0x00:
 405             features += 'analog composite (serrate on RGB)'
 406         elif sync == 0x01:
 407             features += 'bipolar analog composite (serrate on RGB)'
 408         elif sync == 0x02:
 409             features += 'digital composite (serrate on composite polarity ' \
 410                         + (posneg[sync2 & 0x01]) + ')'
 411         elif sync == 0x03:
 412             features += 'digital separate ('
 413             features += 'Vsync polarity ' + (posneg[(sync2 & 0x02) >> 1])
 414             features += ', Hsync polarity ' + (posneg[sync2 & 0x01])
 415             features += ')'
 416         features += ', '
 417         self.ann_field(offset+17, offset+17, features[:-2])
 418
 419     def decode_descriptor(self, offset):
 420         tag = self.cache[offset+3]
 421         if tag == 0xff:
 422             # Monitor serial number
 423             text = bytes(self.cache[offset+5:][:13]).decode(encoding='cp437', errors='replace')
 424             self.ann_field(offset, offset+17, 'Serial number: %s' % text.strip())
 425         elif tag == 0xfe:
 426             # Text
 427             text = bytes(self.cache[offset+5:][:13]).decode(encoding='cp437', errors='replace')
 428             self.ann_field(offset, offset+17, 'Info: %s' % text.strip())
 429         elif tag == 0xfc:
 430             # Monitor name
 431             text = bytes(self.cache[offset+5:][:13]).decode(encoding='cp437', errors='replace')
 432             self.ann_field(offset, offset+17, 'Model name: %s' % text.strip())
 433         elif tag == 0xfd:
 434             # Monitor range limits
 435             self.put(self.sn[offset][0], self.sn[offset+17][1], self.out_ann,
 436                      [ANN_SECTIONS, ['Monitor range limits']])
 437             self.ann_field(offset+5, offset+5, 'Minimum vertical rate: %dHz' %
 438                            self.cache[offset+5])
 439             self.ann_field(offset+6, offset+6, 'Maximum vertical rate: %dHz' %
 440                            self.cache[offset+6])
 441             self.ann_field(offset+7, offset+7, 'Minimum horizontal rate: %dkHz' %
 442                            self.cache[offset+7])
 443             self.ann_field(offset+8, offset+8, 'Maximum horizontal rate: %dkHz' %
 444                            self.cache[offset+8])
 445             self.ann_field(offset+9, offset+9, 'Maximum pixel clock: %dMHz' %
 446                            (self.cache[offset+9] * 10))
 447             if self.cache[offset+10] == 0x02:
 448                 # Secondary GTF curve supported
 449                 self.ann_field(offset+10, offset+17, 'Secondary timing formula supported')
 450         elif tag == 0xfb:
 451             # Additional color point data
 452             self.put(self.sn[offset][0], self.sn[offset+17][1], self.out_ann,
 453                      [ANN_SECTIONS, ['Additional color point data']])
 454         elif tag == 0xfa:
 455             # Additional standard timing definitions
 456             self.put(self.sn[offset][0], self.sn[offset+17][1], self.out_ann,
 457                      [ANN_SECTIONS, ['Additional standard timing definitions']])
 458         else:
 459             self.put(self.sn[offset][0], self.sn[offset+17][1], self.out_ann,
 460                      [ANN_SECTIONS, ['Unknown descriptor']])
 461
 462     def decode_descriptors(self, offset):
 463         # 4 consecutive 18-byte descriptor blocks
 464         for i in range(offset, 0, 18):
 465             if self.cache[i] != 0 and self.cache[i+1] != 0:
 466                 self.decode_detailed_timing(i)
 467             else:
 468                 if self.cache[i+2] == 0 or self.cache[i+4] == 0:
 469                     self.decode_descriptor(i)
 470