# Repeated START condition (Sr): same as S
# STOP condition (P): SDA = rising, SCL = high
#
-# All data bytes on SDA are extactly 8 bits long (transmitted MSB-first).
+# All data bytes on SDA are exactly 8 bits long (transmitted MSB-first).
# Each byte has to be followed by a 9th ACK/NACK bit. If that bit is low,
# that indicates an ACK, if it's high that indicates a NACK.
#
# After the first START condition, a master sends the device address of the
# slave it wants to talk to. Slave addresses are 7 bits long (MSB-first).
-# After those 7 bits a data direction bit is sent. If the bit is low that
+# After those 7 bits, a data direction bit is sent. If the bit is low that
# indicates a WRITE operation, if it's high that indicates a READ operation.
#
# Later an optional 10bit slave addressing scheme was added.
# TODO: Implement support for inverting SDA/SCL levels (0->1 and 1->0).
# TODO: Implement support for detecting various bus errors.
-# TODO: Return two buffers, one with structured data for the GUI to parse
-# and display, and one with human-readable ASCII output.
-
-def sigrokdecode_i2c(inbuf):
+def decode(inbuf):
"""I2C protocol decoder"""
+ # FIXME: Get the data in the correct format in the first place.
+ inbuf = [ord(x) for x in inbuf]
+
# FIXME: This should be passed in as metadata, not hardcoded here.
signals = (2, 5)
channels = 8
o = wr = ack = d = ''
bitcount = data = 0
- state = 'IDLE'
+ IDLE, START, ADDRESS, DATA = range(4)
+ state = IDLE
# Get the bit number (and thus probe index) of the SCL/SDA signals.
scl_bit, sda_bit = signals
# Get SCL/SDA bit values (0/1 for low/high) of the first sample.
- s = ord(inbuf[0])
- oldscl = (s & (1 << scl_bit)) != 0
- oldsda = (s & (1 << sda_bit)) != 0
+ s = inbuf[0]
+ oldscl = (s & (1 << scl_bit)) >> scl_bit
+ oldsda = (s & (1 << sda_bit)) >> sda_bit
# Loop over all samples.
# TODO: Handle LAs with more/less than 8 channels.
for samplenum, s in enumerate(inbuf[1:]): # We skip the first byte...
-
- s = ord(s) # FIXME
-
# Get SCL/SDA bit values (0/1 for low/high).
- scl = (s & (1 << scl_bit)) != 0
- sda = (s & (1 << sda_bit)) != 0
+ scl = (s & (1 << scl_bit)) >> scl_bit
+ sda = (s & (1 << sda_bit)) >> sda_bit
# TODO: Wait until the bus is idle (SDA = SCL = 1) first?
# START condition (S): SDA = falling, SCL = high
if (oldsda == 1 and sda == 0) and scl == 1:
o += "%d\t\tSTART\n" % samplenum
- state = 'ADDRESS'
+ state = ADDRESS
bitcount = data = 0
# Data latching by transmitter: SCL = low
# We received 8 address/data bits and the ACK/NACK bit.
data >>= 1 # Shift out unwanted ACK/NACK bit here.
- o += "%d\t\t%s: " % (samplenum, state)
+ # o += "%d\t\t%s: " % (samplenum, state)
+ o += "%d\t\tTODO:STATE: " % samplenum
ack = (sda == 1) and 'NACK' or 'ACK'
- d = (state == 'ADDRESS') and (data & 0xfe) or data
+ d = (state == ADDRESS) and (data & 0xfe) or data
wr = ''
- if state == 'ADDRESS':
+ if state == ADDRESS:
wr = (data & 1) and ' (W)' or ' (R)'
- state = 'DATA'
+ state = DATA
o += "0x%02x%s (%s)\n" % (d, wr, ack)
bitcount = data = 0
# STOP condition (P): SDA = rising, SCL = high
elif (oldsda == 0 and sda == 1) and scl == 1:
o += "%d\t\tSTOP\n" % samplenum
- state = 'IDLE'
+ state = IDLE
# Save current SDA/SCL values for the next round.
oldscl = scl
return o
-# This is just a draft.
-def sigrokdecode_register_i2c():
- metadata = {
+def register():
+ return {
'id': 'i2c',
'name': 'I2C',
- 'description': 'Inter-Integrated Circuit (I2C) bus',
- 'function': 'sigrokdecode_i2c',
+ 'desc': 'Inter-Integrated Circuit (I2C) bus',
'inputformats': ['raw'],
'signalnames': {
'SCL': 'Serial clock line',
'SDA': 'Serial data line',
},
- 'ouputformats': ['i2c', 'ascii'],
+ 'outputformats': ['i2c'],
}
- return metadata
+
+# Use psyco (if available) as it results in huge performance improvements.
+try:
+ import psyco
+ psyco.bind(decode)
+except ImportError:
+ pass