decoders/i2c/i2c.py

   1 ##
   2 ## This file is part of the sigrok project.
   3 ##
   4 ## Copyright (C) 2010-2011 Uwe Hermann <uwe@hermann-uwe.de>
   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 2 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, write to the Free Software
  18 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19 ##
  20
  21 #
  22 # I2C protocol decoder
  23 #
  24
  25 #
  26 # The Inter-Integrated Circuit (I2C) bus is a bidirectional, multi-master
  27 # bus using two signals (SCL = serial clock line, SDA = serial data line).
  28 #
  29 # There can be many devices on the same bus. Each device can potentially be
  30 # master or slave (and that can change during runtime). Both slave and master
  31 # can potentially play the transmitter or receiver role (this can also
  32 # change at runtime).
  33 #
  34 # Possible maximum data rates:
  35 #  - Standard mode: 100 kbit/s
  36 #  - Fast mode: 400 kbit/s
  37 #  - Fast-mode Plus: 1 Mbit/s
  38 #  - High-speed mode: 3.4 Mbit/s
  39 #
  40 # START condition (S): SDA = falling, SCL = high
  41 # Repeated START condition (Sr): same as S
  42 # Data bit sampling: SCL = rising
  43 # STOP condition (P): SDA = rising, SCL = high
  44 #
  45 # All data bytes on SDA are exactly 8 bits long (transmitted MSB-first).
  46 # Each byte has to be followed by a 9th ACK/NACK bit. If that bit is low,
  47 # that indicates an ACK, if it's high that indicates a NACK.
  48 #
  49 # After the first START condition, a master sends the device address of the
  50 # slave it wants to talk to. Slave addresses are 7 bits long (MSB-first).
  51 # After those 7 bits, a data direction bit is sent. If the bit is low that
  52 # indicates a WRITE operation, if it's high that indicates a READ operation.
  53 #
  54 # Later an optional 10bit slave addressing scheme was added.
  55 #
  56 # Documentation:
  57 # http://www.nxp.com/acrobat/literature/9398/39340011.pdf (v2.1 spec)
  58 # http://www.nxp.com/acrobat/usermanuals/UM10204_3.pdf (v3 spec)
  59 # http://en.wikipedia.org/wiki/I2C
  60 #
  61
  62 # TODO: Look into arbitration, collision detection, clock synchronisation, etc.
  63 # TODO: Handle clock stretching.
  64 # TODO: Handle combined messages / repeated START.
  65 # TODO: Implement support for 7bit and 10bit slave addresses.
  66 # TODO: Implement support for inverting SDA/SCL levels (0->1 and 1->0).
  67 # TODO: Implement support for detecting various bus errors.
  68 # TODO: I2C address of slaves.
  69 # TODO: Handle multiple different I2C devices on same bus
  70 #       -> we need to decode multiple protocols at the same time.
  71
  72 '''
  73 Protocol output format:
  74
  75 I2C packet:
  76 [<i2c_command>, <data>, <ack_bit>]
  77
  78 <i2c_command> is one of:
  79   - 'START' (START condition)
  80   - 'START REPEAT' (Repeated START)
  81   - 'ADDRESS READ' (Address, read)
  82   - 'ADDRESS WRITE' (Address, write)
  83   - 'DATA READ' (Data, read)
  84   - 'DATA WRITE' (Data, write)
  85   - 'STOP' (STOP condition)
  86
  87 <data> is the data or address byte associated with the 'ADDRESS*' and 'DATA*'
  88 command. For 'START', 'START REPEAT' and 'STOP', this is None.
  89
  90 <ack_bit> is either 'ACK' or 'NACK', but may also be None.
  91 '''
  92
  93 import sigrokdecode as srd
  94
  95 # Annotation feed formats
  96 ANN_SHIFTED       = 0
  97 ANN_SHIFTED_SHORT = 1
  98 ANN_RAW           = 2
  99
 100 # Values are verbose and short annotation, respectively.
 101 protocol = {
 102     'START':           ['START',         'S'],
 103     'START REPEAT':    ['START REPEAT',  'Sr'],
 104     'STOP':            ['STOP',          'P'],
 105     'ACK':             ['ACK',           'A'],
 106     'NACK':            ['NACK',          'N'],
 107     'ADDRESS READ':    ['ADDRESS READ',  'AR'],
 108     'ADDRESS WRITE':   ['ADDRESS WRITE', 'AW'],
 109     'DATA READ':       ['DATA READ',     'DR'],
 110     'DATA WRITE':      ['DATA WRITE',    'DW'],
 111 }
 112
 113 # States
 114 FIND_START = 0
 115 FIND_ADDRESS = 1
 116 FIND_DATA = 2
 117
 118 class Decoder(srd.Decoder):
 119     api_version = 1
 120     id = 'i2c'
 121     name = 'I2C'
 122     longname = 'Inter-Integrated Circuit'
 123     desc = 'I2C is a two-wire, multi-master, serial bus.'
 124     longdesc = '...'
 125     license = 'gplv2+'
 126     inputs = ['logic']
 127     outputs = ['i2c']
 128     probes = [
 129         {'id': 'scl', 'name': 'SCL', 'desc': 'Serial clock line'},
 130         {'id': 'sda', 'name': 'SDA', 'desc': 'Serial data line'},
 131     ]
 132     options = {
 133         'addressing': ['Slave addressing (in bits)', 7], # 7 or 10
 134     }
 135     annotations = [
 136         # ANN_SHIFTED
 137         ['7-bit shifted hex',
 138          'Read/write bit shifted out from the 8-bit I2C slave address'],
 139         # ANN_SHIFTED_SHORT
 140         ['7-bit shifted hex (short)',
 141          'Read/write bit shifted out from the 8-bit I2C slave address'],
 142         # ANN_RAW
 143         ['Raw hex', 'Unaltered raw data'],
 144     ]
 145
 146     def __init__(self, **kwargs):
 147         self.startsample = -1
 148         self.samplenum = None
 149         self.bitcount = 0
 150         self.databyte = 0
 151         self.wr = -1
 152         self.is_repeat_start = 0
 153         self.state = FIND_START
 154         self.oldscl = None
 155         self.oldsda = None
 156
 157         # Set protocol decoder option defaults.
 158         self.addressing = Decoder.options['addressing'][1]
 159
 160     def start(self, metadata):
 161         self.out_proto = self.add(srd.OUTPUT_PROTO, 'i2c')
 162         self.out_ann = self.add(srd.OUTPUT_ANN, 'i2c')
 163
 164     def is_start_condition(self, scl, sda):
 165         # START condition (S): SDA = falling, SCL = high
 166         if (self.oldsda == 1 and sda == 0) and scl == 1:
 167             return True
 168         return False
 169
 170     def is_data_bit(self, scl, sda):
 171         # Data sampling of receiver: SCL = rising
 172         if self.oldscl == 0 and scl == 1:
 173             return True
 174         return False
 175
 176     def is_stop_condition(self, scl, sda):
 177         # STOP condition (P): SDA = rising, SCL = high
 178         if (self.oldsda == 0 and sda == 1) and scl == 1:
 179             return True
 180         return False
 181
 182     def found_start(self, scl, sda):
 183         self.startsample = self.samplenum
 184
 185         cmd = 'START REPEAT' if (self.is_repeat_start == 1) else 'START'
 186         self.put(self.out_proto, [cmd, None, None])
 187         self.put(self.out_ann, [ANN_SHIFTED, [protocol[cmd][0]]])
 188         self.put(self.out_ann, [ANN_SHIFTED_SHORT, [protocol[cmd][1]]])
 189
 190         self.state = FIND_ADDRESS
 191         self.bitcount = self.databyte = 0
 192         self.is_repeat_start = 1
 193         self.wr = -1
 194
 195     # Gather 8 bits of data plus the ACK/NACK bit.
 196     def found_address_or_data(self, scl, sda):
 197         # Address and data are transmitted MSB-first.
 198         self.databyte <<= 1
 199         self.databyte |= sda
 200
 201         if self.bitcount == 0:
 202             self.startsample = self.samplenum
 203
 204         # Return if we haven't collected all 8 + 1 bits, yet.
 205         self.bitcount += 1
 206         if self.bitcount != 9:
 207             return
 208
 209         # Send raw output annotation before we start shifting out
 210         # read/write and ack/nack bits.
 211         self.put(self.out_ann, [ANN_RAW, ['0x%.2x' % self.databyte]])
 212
 213         # We received 8 address/data bits and the ACK/NACK bit.
 214         self.databyte >>= 1 # Shift out unwanted ACK/NACK bit here.
 215
 216         if self.state == FIND_ADDRESS:
 217             # The READ/WRITE bit is only in address bytes, not data bytes.
 218             self.wr = 0 if (self.databyte & 1) else 1
 219             d = self.databyte >> 1
 220         elif self.state == FIND_DATA:
 221             d = self.databyte
 222         else:
 223             # TODO: Error?
 224             pass
 225
 226         # Last bit that came in was the ACK/NACK bit (1 = NACK).
 227         ack_bit = 'NACK' if (sda == 1) else 'ACK'
 228
 229         if self.state == FIND_ADDRESS and self.wr == 1:
 230             cmd = 'ADDRESS WRITE'
 231         elif self.state == FIND_ADDRESS and self.wr == 0:
 232             cmd = 'ADDRESS READ'
 233         elif self.state == FIND_DATA and self.wr == 1:
 234             cmd = 'DATA WRITE'
 235         elif self.state == FIND_DATA and self.wr == 0:
 236             cmd = 'DATA READ'
 237
 238         self.put(self.out_proto, [cmd, d, ack_bit])
 239         self.put(self.out_ann, [ANN_SHIFTED,
 240                  [protocol[cmd][0], '0x%02x' % d, protocol[ack_bit][0]]])
 241         self.put(self.out_ann, [ANN_SHIFTED_SHORT,
 242                  [protocol[cmd][1], '0x%02x' % d, protocol[ack_bit][1]]])
 243
 244         self.bitcount = self.databyte = 0
 245         self.startsample = -1
 246
 247         if self.state == FIND_ADDRESS:
 248             self.state = FIND_DATA
 249         elif self.state == FIND_DATA:
 250             # There could be multiple data bytes in a row.
 251             # So, either find a STOP condition or another data byte next.
 252             pass
 253
 254     def found_stop(self, scl, sda):
 255         self.startsample = self.samplenum
 256
 257         self.put(self.out_proto, ['STOP', None, None])
 258         self.put(self.out_ann, [ANN_SHIFTED, [protocol['STOP'][0]]])
 259         self.put(self.out_ann, [ANN_SHIFTED_SHORT, [protocol['STOP'][1]]])
 260
 261         self.state = FIND_START
 262         self.is_repeat_start = 0
 263         self.wr = -1
 264
 265     def put(self, output_id, data):
 266         # Inject sample range into the call up to sigrok.
 267         super(Decoder, self).put(self.startsample, self.samplenum, output_id, data)
 268
 269     def decode(self, ss, es, data):
 270         for samplenum, (scl, sda) in data:
 271             self.samplenum = samplenum
 272
 273             # First sample: Save SCL/SDA value.
 274             if self.oldscl == None:
 275                 self.oldscl = scl
 276                 self.oldsda = sda
 277                 continue
 278
 279             # TODO: Wait until the bus is idle (SDA = SCL = 1) first?
 280
 281             # State machine.
 282             if self.state == FIND_START:
 283                 if self.is_start_condition(scl, sda):
 284                     self.found_start(scl, sda)
 285             elif self.state == FIND_ADDRESS:
 286                 if self.is_data_bit(scl, sda):
 287                     self.found_address_or_data(scl, sda)
 288             elif self.state == FIND_DATA:
 289                 if self.is_data_bit(scl, sda):
 290                     self.found_address_or_data(scl, sda)
 291                 elif self.is_start_condition(scl, sda):
 292                     self.found_start(scl, sda)
 293                 elif self.is_stop_condition(scl, sda):
 294                     self.found_stop(scl, sda)
 295             else:
 296                 # Shouldn't happen.
 297                 raise Exception("unknown state %d" % self.STATE)
 298
 299             # Save current SDA/SCL values for the next round.
 300             self.oldscl = scl
 301             self.oldsda = sda
 302