decoders/ddc.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, If not, see <http://www.gnu.org/licenses/>.
  18 ##
  19
  20 #
  21 # DDC protocol decoder
  22 #
  23 # This decoder extracts a DDC stream from an I2C session between a computer
  24 # and a display device. The stream is output as plain bytes.
  25 #
  26 # Details:
  27 # https://en.wikipedia.org/wiki/Display_Data_Channel
  28 #
  29
  30 import sigrokdecode as srd
  31
  32 class Decoder(srd.Decoder):
  33     id = 'ddc'
  34     name = 'DDC'
  35     longname = 'Display Data Channel'
  36     desc = 'A protocol for communication between computers and displays.'
  37     longdesc = ''
  38     author = 'Bert Vermeulen <bert@biot.com>'
  39     license = 'gplv3+'
  40     inputs = ['i2c']
  41     outputs = ['ddc']
  42     annotations = [
  43         ['Byte stream', 'DDC byte stream as read from display.'],
  44     ]
  45
  46     def __init__(self, **kwargs):
  47         self.state = None
  48
  49     def start(self, metadata):
  50         self.out_ann = self.add(srd.OUTPUT_ANN, 'ddc')
  51
  52     def decode(self, start_sample, end_sample, i2c_data):
  53         try:
  54             cmd, data, ack_bit = i2c_data
  55         except Exception as e:
  56             raise Exception('malformed I2C input: %s' % str(e)) from e
  57
  58         if self.state is None:
  59             # Wait for the DDC session to start.
  60             if cmd in ('START', 'START_REPEAT'):
  61                 self.state = 'start'
  62         elif self.state == 'start':
  63             if cmd == 'ADDRESS_READ' and data == 80:
  64                 # 80 is the I2C slave address of a connected display,
  65                 # so this marks the start of the DDC data transfer.
  66                 self.state = 'transfer'
  67             elif cmd == 'STOP':
  68                 # Got back to the idle state.
  69                 self.state = None
  70         elif self.state == 'transfer':
  71             if cmd == 'DATA_READ':
  72                 # There shouldn't be anything but data reads on this
  73                 # address, so ignore everything else.
  74                 self.put(start_sample, end_sample, self.out_ann,
  75                          [0, ['0x%.2x' % data]])
  76