scripts/i2c.py

   1 ##
   2 ## This file is part of the sigrok project.
   3 ##
   4 ## Copyright (C) 2010 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 # STOP condition (P): SDA = rising, SCL = high
  43 #
  44 # All data bytes on SDA are exactly 8 bits long (transmitted MSB-first).
  45 # Each byte has to be followed by a 9th ACK/NACK bit. If that bit is low,
  46 # that indicates an ACK, if it's high that indicates a NACK.
  47 #
  48 # After the first START condition, a master sends the device address of the
  49 # slave it wants to talk to. Slave addresses are 7 bits long (MSB-first).
  50 # After those 7 bits, a data direction bit is sent. If the bit is low that
  51 # indicates a WRITE operation, if it's high that indicates a READ operation.
  52 #
  53 # Later an optional 10bit slave addressing scheme was added.
  54 #
  55 # Documentation:
  56 # http://www.nxp.com/acrobat/literature/9398/39340011.pdf (v2.1 spec)
  57 # http://www.nxp.com/acrobat/usermanuals/UM10204_3.pdf (v3 spec)
  58 # http://en.wikipedia.org/wiki/I2C
  59 #
  60
  61 # TODO: Look into arbitration, collision detection, clock synchronisation, etc.
  62 # TODO: Handle clock stretching.
  63 # TODO: Handle combined messages / repeated START.
  64 # TODO: Implement support for 7bit and 10bit slave addresses.
  65 # TODO: Implement support for inverting SDA/SCL levels (0->1 and 1->0).
  66 # TODO: Implement support for detecting various bus errors.
  67
  68 # TODO: Return two buffers, one with structured data for the GUI to parse
  69 #       and display, and one with human-readable ASCII output.
  70
  71 def decode(inbuf):
  72         """I2C protocol decoder"""
  73
  74         # FIXME: This should be passed in as metadata, not hardcoded here.
  75         signals = (2, 5)
  76         channels = 8
  77
  78         o = wr = ack = d = ''
  79         bitcount = data = 0
  80         IDLE, START, ADDRESS, DATA = range(4)
  81         state = IDLE
  82
  83         # Get the bit number (and thus probe index) of the SCL/SDA signals.
  84         scl_bit, sda_bit = signals
  85
  86         # Get SCL/SDA bit values (0/1 for low/high) of the first sample.
  87         s = ord(inbuf[0])
  88         oldscl = (s & (1 << scl_bit)) >> scl_bit
  89         oldsda = (s & (1 << sda_bit)) >> sda_bit
  90
  91         # Loop over all samples.
  92         # TODO: Handle LAs with more/less than 8 channels.
  93         for samplenum, s in enumerate(inbuf[1:]): # We skip the first byte...
  94
  95                 s = ord(s) # FIXME
  96
  97                 # Get SCL/SDA bit values (0/1 for low/high).
  98                 scl = (s & (1 << scl_bit)) >> scl_bit
  99                 sda = (s & (1 << sda_bit)) >> sda_bit
 100
 101                 # TODO: Wait until the bus is idle (SDA = SCL = 1) first?
 102
 103                 # START condition (S): SDA = falling, SCL = high
 104                 if (oldsda == 1 and sda == 0) and scl == 1:
 105                         o += "%d\t\tSTART\n" % samplenum
 106                         state = ADDRESS
 107                         bitcount = data = 0
 108
 109                 # Data latching by transmitter: SCL = low
 110                 elif (scl == 0):
 111                         pass # TODO
 112
 113                 # Data sampling of receiver: SCL = rising
 114                 elif (oldscl == 0 and scl == 1):
 115                         bitcount += 1
 116
 117                         # o += "%d\t\tRECEIVED BIT %d:  %d\n" % \
 118                         #       (samplenum, 8 - bitcount, sda)
 119
 120                         # Address and data are transmitted MSB-first.
 121                         data <<= 1
 122                         data |= sda
 123
 124                         if bitcount != 9:
 125                                 continue
 126
 127                         # We received 8 address/data bits and the ACK/NACK bit.
 128                         data >>= 1 # Shift out unwanted ACK/NACK bit here.
 129                         # o += "%d\t\t%s: " % (samplenum, state)
 130                         o += "%d\t\tTODO:STATE: " % samplenum
 131                         ack = (sda == 1) and 'NACK' or 'ACK'
 132                         d = (state == ADDRESS) and (data & 0xfe) or data
 133                         wr = ''
 134                         if state == ADDRESS:
 135                                 wr = (data & 1) and ' (W)' or ' (R)'
 136                                 state = DATA
 137                         o += "0x%02x%s (%s)\n" % (d, wr, ack)
 138                         bitcount = data = 0
 139
 140                 # STOP condition (P): SDA = rising, SCL = high
 141                 elif (oldsda == 0 and sda == 1) and scl == 1:
 142                         o += "%d\t\tSTOP\n" % samplenum
 143                         state = IDLE
 144
 145                 # Save current SDA/SCL values for the next round.
 146                 oldscl = scl
 147                 oldsda = sda
 148
 149         return o
 150
 151 # This is just a draft.
 152 def register():
 153         return {
 154                 'id': 'i2c',
 155                 'name': 'I2C',
 156                 'desc': 'Inter-Integrated Circuit (I2C) bus',
 157                 'func': 'decode',
 158                 'inputformats': ['raw'],
 159                 'signalnames':  {
 160                                 'SCL': 'Serial clock line',
 161                                 'SDA': 'Serial data line',
 162                                 },
 163                 'outputformats': ['i2c', 'ascii'],
 164         }
 165
 166 # Use psyco (if available) as it results in huge performance improvements.
 167 try:
 168         import psyco
 169         psyco.bind(decode)
 170 except ImportError:
 171         pass
 172