2 ## This file is part of the libsigrokdecode project.
4 ## Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
20 # EDID protocol decoder
24 # - add short annotations
25 # - Signal level standard field in basic display parameters block
26 # - Additional color point descriptors
27 # - Additional standard timing descriptors
30 import sigrokdecode as srd
33 EDID_HEADER = [0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x00]
44 # Pre-EDID established timing modes
65 # X:Y display aspect ratios, as used in standard timing modes
77 class Decoder(srd.Decoder):
81 longname = 'Extended Display Identification Data'
82 desc = 'Data structure describing display device capabilities.'
90 ['EDID fields', 'EDID structure fields'],
91 ['EDID sections', 'EDID structure sections'],
94 def __init__(self, **kwargs):
96 # Received data items, used as an index into samplenum/data
98 # Start/end sample numbers per data item
104 self.out_ann = self.add(srd.OUTPUT_ANN, 'edid')
109 def decode(self, ss, es, data):
112 # We only care about actual data bytes that are read (for now).
113 if cmd != 'DATA READ':
117 self.sn.append([ss, es])
118 self.cache.append(data)
120 # self.put(ss, es, self.out_ann, [0, ['%d: [%.2x]' % (self.cnt, data)]])
122 if self.state is None:
123 # Wait for the EDID header
124 if self.cnt >= OFF_VENDOR:
125 if self.cache[-8:] == EDID_HEADER:
126 # Throw away any garbage before the header
127 self.sn = self.sn[-8:]
128 self.cache = self.cache[-8:]
131 self.put(ss, es, self.out_ann, [0, ['EDID header']])
132 elif self.state == 'edid':
133 if self.cnt == OFF_VERSION:
136 self.decode_serial(-6)
137 self.decode_mfrdate(-2)
138 elif self.cnt == OFF_BASIC:
139 version = 'EDID version: %d.%d' % (self.cache[-2], self.cache[-1])
140 self.put(ss, es, self.out_ann, [0, [version]])
141 elif self.cnt == OFF_CHROM:
142 self.decode_basicdisplay(-5)
143 elif self.cnt == OFF_EST_TIMING:
144 self.decode_chromaticity(-10)
145 elif self.cnt == OFF_STD_TIMING:
146 self.decode_est_timing(-3)
147 elif self.cnt == OFF_DET_TIMING:
148 self.decode_std_timing(-16)
149 elif self.cnt == OFF_NUM_EXT:
150 self.decode_descriptors(-72)
151 elif self.cnt == OFF_CHECKSUM:
152 self.put(ss, es, self.out_ann,
153 [0, ['Extensions present: %d' % self.cache[self.cnt-1]]])
154 elif self.cnt == OFF_CHECKSUM+1:
157 checksum += self.cache[i]
158 if checksum % 256 == 0:
162 self.put(ss, es, self.out_ann, [0, ['Checksum: %d (%s)' % (
163 self.cache[self.cnt-1], csstr)]])
164 self.state = 'extensions'
165 elif self.state == 'extensions':
168 def ann_field(self, start, end, annotation):
169 self.put(self.sn[start][0], self.sn[end][1],
170 self.out_ann, [ANN_FIELDS, [annotation]])
172 def lookup_pnpid(self, pnpid):
173 pnpid_file = os.path.join(os.path.dirname(__file__), 'pnpids.txt')
174 if os.path.exists(pnpid_file):
175 for line in open(pnpid_file).readlines():
176 if line.find(pnpid + ';') == 0:
177 return line[4:].strip()
180 def decode_vid(self, offset):
181 pnpid = chr(64 + ((self.cache[offset] & 0x7c) >> 2))
182 pnpid += chr(64 + (((self.cache[offset] & 0x03) << 3)
183 | ((self.cache[offset+1] & 0xe0) >> 5)))
184 pnpid += chr(64 + (self.cache[offset+1] & 0x1f))
185 vendor = self.lookup_pnpid(pnpid)
187 pnpid += ' (%s)' % vendor
188 self.ann_field(offset, offset+1, pnpid)
190 def decode_pid(self, offset):
191 pidstr = 'Product 0x%.2x%.2x' % (self.cache[offset+1], self.cache[offset])
192 self.ann_field(offset, offset+1, pidstr)
194 def decode_serial(self, offset):
195 serialnum = (self.cache[offset+3] << 24) \
196 + (self.cache[offset+2] << 16) \
197 + (self.cache[offset+1] << 8) \
202 if not chr(self.cache[offset+3-i]).isalnum():
205 serialstr += chr(self.cache[offset+3-i])
206 serial = serialstr if is_alnum else str(serialnum)
207 self.ann_field(offset, offset+3, 'Serial ' + serial)
209 def decode_mfrdate(self, offset):
211 if self.cache[offset]:
212 datestr += 'week %d, ' % self.cache[offset]
213 datestr += str(1990 + self.cache[offset+1])
215 self.ann_field(offset, offset+1, 'Manufactured ' + datestr)
217 def decode_basicdisplay(self, offset):
218 # Video input definition
219 vid = self.cache[offset]
222 self.ann_field(offset, offset, 'Video input: VESA DFP 1.')
225 sls = (vid & 60) >> 5
226 self.ann_field(offset, offset, 'Signal level standard: %.2x' % sls)
228 self.ann_field(offset, offset, 'Blank-to-black setup expected')
231 syncs += 'separate syncs, '
233 syncs += 'composite syncs, '
235 syncs += 'sync on green, '
237 syncs += 'Vsync serration required, '
239 self.ann_field(offset, offset, 'Supported syncs: %s' % syncs[:-2])
240 # Max horizontal/vertical image size
241 if self.cache[offset+1] != 0 and self.cache[offset+2] != 0:
242 # Projectors have this set to 0
243 sizestr = '%dx%dcm' % (self.cache[offset+1], self.cache[offset+2])
244 self.ann_field(offset+1, offset+2, 'Physical size: ' + sizestr)
245 # Display transfer characteristic (gamma)
246 if self.cache[offset+3] != 0xff:
247 gamma = (self.cache[offset+3] + 100) / 100
248 self.ann_field(offset+3, offset+3, 'Gamma: %1.2f' % gamma)
250 fs = self.cache[offset+4]
257 dpms += 'active off, '
259 self.ann_field(offset+4, offset+4, 'DPMS support: %s' % dpms[:-2])
260 dt = (fs & 0x18) >> 3
267 dtstr = 'non-RGB multicolor'
269 self.ann_field(offset+4, offset+4, 'Display type: %s' % dtstr)
271 self.ann_field(offset+4, offset+4, 'Color space: standard sRGB')
272 # Save this for when we decode the first detailed timing descriptor
273 self.have_preferred_timing = (fs & 0x02) == 0x02
278 self.ann_field(offset+4, offset+4,
279 'Generalized timing formula: %ssupported' % gft)
281 def convert_color(self, value):
282 # Convert from 10-bit packet format to float
286 outval += 2 ** -(10-i)
290 def decode_chromaticity(self, offset):
291 redx = (self.cache[offset+2] << 2) + ((self.cache[offset] & 0xc0) >> 6)
292 redy = (self.cache[offset+3] << 2) + ((self.cache[offset] & 0x30) >> 4)
293 self.ann_field(offset, offset+9, 'Chromacity red: X %1.3f, Y %1.3f' % (
294 self.convert_color(redx), self.convert_color(redy)))
296 greenx = (self.cache[offset+4] << 2) + ((self.cache[offset] & 0x0c) >> 6)
297 greeny = (self.cache[offset+5] << 2) + ((self.cache[offset] & 0x03) >> 4)
298 self.ann_field(offset, offset+9, 'Chromacity green: X %1.3f, Y %1.3f' % (
299 self.convert_color(greenx), self.convert_color(greeny)))
301 bluex = (self.cache[offset+6] << 2) + ((self.cache[offset+1] & 0xc0) >> 6)
302 bluey = (self.cache[offset+7] << 2) + ((self.cache[offset+1] & 0x30) >> 4)
303 self.ann_field(offset, offset+9, 'Chromacity blue: X %1.3f, Y %1.3f' % (
304 self.convert_color(bluex), self.convert_color(bluey)))
306 whitex = (self.cache[offset+8] << 2) + ((self.cache[offset+1] & 0x0c) >> 6)
307 whitey = (self.cache[offset+9] << 2) + ((self.cache[offset+1] & 0x03) >> 4)
308 self.ann_field(offset, offset+9, 'Chromacity white: X %1.3f, Y %1.3f' % (
309 self.convert_color(whitex), self.convert_color(whitey)))
311 def decode_est_timing(self, offset):
313 bitmap = (self.cache[offset] << 9) \
314 + (self.cache[offset+1] << 1) \
315 + ((self.cache[offset+2] & 0x80) >> 7)
318 if bitmap & (1 << (16-i)):
319 modestr += est_modes[i] + ', '
321 self.ann_field(offset, offset+2,
322 'Supported establised modes: %s' % modestr[:-2])
324 def decode_std_timing(self, offset):
326 for i in range(0, 16, 2):
327 if self.cache[offset+i] == 0x01 and self.cache[offset+i+1] == 0x01:
330 x = (self.cache[offset+i] + 31) * 8
331 ratio = (self.cache[offset+i+1] & 0xc0) >> 6
332 ratio_x, ratio_y = xy_ratio[ratio]
333 y = x / ratio_x * ratio_y
334 refresh = (self.cache[offset+i+1] & 0x3f) + 60
335 modestr += '%dx%d@%dHz, ' % (x, y, refresh)
337 self.ann_field(offset, offset+2,
338 'Supported standard modes: %s' % modestr[:-2])
340 def decode_detailed_timing(self, offset):
341 if offset == -72 and self.have_preferred_timing:
342 # Only on first detailed timing descriptor
343 section = 'Preferred'
346 section += ' timing descriptor'
347 self.put(self.sn[offset][0], self.sn[offset+18][1],
348 self.out_ann, [ANN_SECTIONS, [section]])
350 pixclock = float((self.cache[offset+1] << 8) + self.cache[offset]) / 100
351 self.ann_field(offset, offset+1, 'Pixel clock: %.2f MHz' % pixclock)
353 horiz_active = ((self.cache[offset+4] & 0xf0) << 4) + self.cache[offset+2]
354 self.ann_field(offset+2, offset+4, 'Horizontal active: %d' % horiz_active)
356 horiz_blank = ((self.cache[offset+4] & 0x0f) << 8) + self.cache[offset+3]
357 self.ann_field(offset+3, offset+4, 'Horizontal blanking: %d' % horiz_blank)
359 vert_active = ((self.cache[offset+7] & 0xf0) << 4) + self.cache[offset+5]
360 self.ann_field(offset+5, offset+7, 'Vertical active: %d' % vert_active)
362 vert_blank = ((self.cache[offset+7] & 0x0f) << 8) + self.cache[offset+6]
363 self.ann_field(offset+6, offset+7, 'Vertical blanking: %d' % vert_blank)
365 horiz_sync_off = ((self.cache[offset+11] & 0xc0) << 2) + self.cache[offset+8]
366 self.ann_field(offset+8, offset+11, 'Horizontal sync offset: %d' % horiz_sync_off)
368 horiz_sync_pw = ((self.cache[offset+11] & 0x30) << 4) + self.cache[offset+9]
369 self.ann_field(offset+9, offset+11, 'Horizontal sync pulse width: %d' % horiz_sync_pw)
371 vert_sync_off = ((self.cache[offset+11] & 0x0c) << 2) \
372 + ((self.cache[offset+10] & 0xf0) >> 4)
373 self.ann_field(offset+10, offset+11, 'Vertical sync offset: %d' % vert_sync_off)
375 vert_sync_pw = ((self.cache[offset+11] & 0x03) << 4) \
376 + (self.cache[offset+10] & 0x0f)
377 self.ann_field(offset+10, offset+11, 'Vertical sync pulse width: %d' % vert_sync_pw)
379 horiz_size = ((self.cache[offset+14] & 0xf0) << 4) + self.cache[offset+12]
380 vert_size = ((self.cache[offset+14] & 0x0f) << 8) + self.cache[offset+13]
381 self.ann_field(offset+12, offset+14, 'Physical size: %dx%dmm' % (horiz_size, vert_size))
383 horiz_border = self.cache[offset+15]
385 self.ann_field(offset+15, offset+15, 'Horizontal border: %d pixels' % horiz_border)
386 vert_border = self.cache[offset+16]
388 self.ann_field(offset+16, offset+16, 'Vertical border: %d lines' % vert_border)
391 if self.cache[offset+17] & 0x80:
392 features += 'interlaced, '
393 stereo = (self.cache[offset+17] & 0x60) >> 5
395 if self.cache[offset+17] & 0x01:
396 features += '2-way interleaved stereo ('
397 features += ['right image on even lines',
398 'left image on even lines',
399 'side-by-side'][stereo-1]
402 features += 'field sequential stereo ('
403 features += ['right image on sync=1', 'left image on sync=1',
404 '4-way interleaved'][stereo-1]
406 sync = (self.cache[offset+17] & 0x18) >> 3
407 sync2 = (self.cache[offset+17] & 0x06) >> 1
408 posneg = ['negative', 'positive']
409 features += 'sync type '
411 features += 'analog composite (serrate on RGB)'
413 features += 'bipolar analog composite (serrate on RGB)'
415 features += 'digital composite (serrate on composite polarity ' \
416 + (posneg[sync2 & 0x01]) + ')'
418 features += 'digital separate ('
419 features += 'Vsync polarity ' + (posneg[(sync2 & 0x02) >> 1])
420 features += ', Hsync polarity ' + (posneg[sync2 & 0x01])
423 self.ann_field(offset+17, offset+17, features[:-2])
425 def decode_descriptor(self, offset):
426 tag = self.cache[offset+3]
428 # Monitor serial number
429 text = bytes(self.cache[offset+5:][:13]).decode(encoding='cp437', errors='replace')
430 self.ann_field(offset, offset+17, 'Serial number: %s' % text.strip())
433 text = bytes(self.cache[offset+5:][:13]).decode(encoding='cp437', errors='replace')
434 self.ann_field(offset, offset+17, 'Info: %s' % text.strip())
437 text = bytes(self.cache[offset+5:][:13]).decode(encoding='cp437', errors='replace')
438 self.ann_field(offset, offset+17, 'Model name: %s' % text.strip())
440 # Monitor range limits
441 self.put(self.sn[offset][0], self.sn[offset+17][1], self.out_ann,
442 [ANN_SECTIONS, ['Monitor range limits']])
443 self.ann_field(offset+5, offset+5, 'Minimum vertical rate: %dHz' %
444 self.cache[offset+5])
445 self.ann_field(offset+6, offset+6, 'Maximum vertical rate: %dHz' %
446 self.cache[offset+6])
447 self.ann_field(offset+7, offset+7, 'Minimum horizontal rate: %dkHz' %
448 self.cache[offset+7])
449 self.ann_field(offset+8, offset+8, 'Maximum horizontal rate: %dkHz' %
450 self.cache[offset+8])
451 self.ann_field(offset+9, offset+9, 'Maximum pixel clock: %dMHz' %
452 (self.cache[offset+9] * 10))
453 if self.cache[offset+10] == 0x02:
454 # Secondary GTF curve supported
455 self.ann_field(offset+10, offset+17, 'Secondary timing formula supported')
457 # Additional color point data
458 self.put(self.sn[offset][0], self.sn[offset+17][1], self.out_ann,
459 [ANN_SECTIONS, ['Additional color point data']])
461 # Additional standard timing definitions
462 self.put(self.sn[offset][0], self.sn[offset+17][1], self.out_ann,
463 [ANN_SECTIONS, ['Additional standard timing definitions']])
465 self.put(self.sn[offset][0], self.sn[offset+17][1], self.out_ann,
466 [ANN_SECTIONS, ['Unknown descriptor']])
468 def decode_descriptors(self, offset):
469 # 4 consecutive 18-byte descriptor blocks
470 for i in range(offset, 0, 18):
471 if self.cache[i] != 0 and self.cache[i+1] != 0:
472 self.decode_detailed_timing(i)
474 if self.cache[i+2] == 0 or self.cache[i+4] == 0:
475 self.decode_descriptor(i)