Rename the scripts/ directory to decoders/.
authorUwe Hermann <uwe@hermann-uwe.de>
Mon, 10 Jan 2011 22:27:15 +0000 (23:27 +0100)
committerUwe Hermann <uwe@hermann-uwe.de>
Mon, 10 Jan 2011 22:27:15 +0000 (23:27 +0100)
Makefile.am
decode.c
decoders/Makefile.am [new file with mode: 0644]
decoders/i2c.py [new file with mode: 0644]
decoders/nunchuk.py [new file with mode: 0644]
decoders/transitioncounter.py [new file with mode: 0644]
scripts/Makefile.am [deleted file]
scripts/i2c.py [deleted file]
scripts/nunchuk.py [deleted file]
scripts/transitioncounter.py [deleted file]

index e47170cba50e5739b05c73eab655ad402cf36709..c76c5c472c17e2b02ccc89b4d4de05d12a0d079e 100644 (file)
@@ -18,7 +18,7 @@
 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 ##
 
-SUBDIRS = scripts
+SUBDIRS = decoders
 
 lib_LTLIBRARIES = libsigrokdecode.la
 
index a7458731b4288a3bddf73fe77184923c26d212b4..337979dee0e1bc411e73fbb1198af65dfab57cb2 100644 (file)
--- a/decode.c
+++ b/decode.c
@@ -44,8 +44,8 @@ int sigrokdecode_init(void)
        /* FIXME: What happens if this function is called multiple times? */
        PyRun_SimpleString(
                "import sys;"
-               "sys.path.append('libsigrokdecode/scripts');"
-               "sys.path.append('../libsigrokdecode/scripts');"
+               "sys.path.append('libsigrokdecode/decoders');"
+               "sys.path.append('../libsigrokdecode/decoders');"
                "sys.path.append('/usr/local/share/sigrok');"
                );
 
diff --git a/decoders/Makefile.am b/decoders/Makefile.am
new file mode 100644 (file)
index 0000000..7ac94dc
--- /dev/null
@@ -0,0 +1,24 @@
+##
+## This file is part of the sigrok project.
+##
+## Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
+##
+## This program is free software; you can redistribute it and/or modify
+## it under the terms of the GNU General Public License as published by
+## the Free Software Foundation; either version 2 of the License, or
+## (at your option) any later version.
+##
+## This program is distributed in the hope that it will be useful,
+## but WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+## GNU General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with this program; if not, write to the Free Software
+## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+##
+
+dist_pkgdata_SCRIPTS = i2c.py nunchuk.py transitioncounter.py
+
+CLEANFILES = *.pyc
+
diff --git a/decoders/i2c.py b/decoders/i2c.py
new file mode 100644 (file)
index 0000000..bbf6925
--- /dev/null
@@ -0,0 +1,255 @@
+##
+## This file is part of the sigrok project.
+##
+## Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
+##
+## This program is free software; you can redistribute it and/or modify
+## it under the terms of the GNU General Public License as published by
+## the Free Software Foundation; either version 2 of the License, or
+## (at your option) any later version.
+##
+## This program is distributed in the hope that it will be useful,
+## but WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+## GNU General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with this program; if not, write to the Free Software
+## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+##
+
+#
+# I2C protocol decoder
+#
+
+#
+# The Inter-Integrated Circuit (I2C) bus is a bidirectional, multi-master
+# bus using two signals (SCL = serial clock line, SDA = serial data line).
+#
+# There can be many devices on the same bus. Each device can potentially be
+# master or slave (and that can change during runtime). Both slave and master
+# can potentially play the transmitter or receiver role (this can also
+# change at runtime).
+#
+# Possible maximum data rates:
+#  - Standard mode: 100 kbit/s
+#  - Fast mode: 400 kbit/s
+#  - Fast-mode Plus: 1 Mbit/s
+#  - High-speed mode: 3.4 Mbit/s
+#
+# START condition (S): SDA = falling, SCL = high
+# Repeated START condition (Sr): same as S
+# STOP condition (P): SDA = rising, SCL = high
+#
+# 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
+# indicates a WRITE operation, if it's high that indicates a READ operation.
+#
+# Later an optional 10bit slave addressing scheme was added.
+#
+# Documentation:
+# http://www.nxp.com/acrobat/literature/9398/39340011.pdf (v2.1 spec)
+# http://www.nxp.com/acrobat/usermanuals/UM10204_3.pdf (v3 spec)
+# http://en.wikipedia.org/wiki/I2C
+#
+
+# TODO: Look into arbitration, collision detection, clock synchronisation, etc.
+# TODO: Handle clock stretching.
+# TODO: Handle combined messages / repeated START.
+# TODO: Implement support for 7bit and 10bit slave addresses.
+# TODO: Implement support for inverting SDA/SCL levels (0->1 and 1->0).
+# TODO: Implement support for detecting various bus errors.
+
+#
+# I2C output format:
+#
+# The output consists of a (Python) list of I2C "packets", each of which
+# has an (implicit) index number (its index in the list).
+# Each packet consists of a Python dict with certain key/value pairs.
+#
+# TODO: Make this a list later instead of a dict?
+#
+# 'type': (string)
+#   - 'S' (START condition)
+#   - 'Sr' (Repeated START)
+#   - 'AR' (Address, read)
+#   - 'AW' (Address, write)
+#   - 'DR' (Data, read)
+#   - 'DW' (Data, write)
+#   - 'P' (STOP condition)
+# 'range': (tuple of 2 integers, the min/max samplenumber of this range)
+#   - (min, max)
+#   - min/max can also be identical.
+# 'data': (actual data as integer ???) TODO: This can be very variable...
+# 'ann': (string; additional annotations / comments)
+#
+# Example output:
+# [{'type': 'S',  'range': (150, 160), 'data': None, 'ann': 'Foobar'},
+#  {'type': 'AW', 'range': (200, 300), 'data': 0x50, 'ann': 'Slave 4'},
+#  {'type': 'DW', 'range': (310, 370), 'data': 0x00, 'ann': 'Init cmd'},
+#  {'type': 'AR', 'range': (500, 560), 'data': 0x50, 'ann': 'Get stat'},
+#  {'type': 'DR', 'range': (580, 640), 'data': 0xfe, 'ann': 'OK'},
+#  {'type': 'P',  'range': (650, 660), 'data': None, 'ann': None}]
+#
+# Possible other events:
+#   - Error event in case protocol looks broken:
+#     [{'type': 'ERROR', 'range': (min, max),
+#      'data': TODO, 'ann': 'This is not a Microchip 24XX64 EEPROM'},
+#     [{'type': 'ERROR', 'range': (min, max),
+#      'data': TODO, 'ann': 'TODO'},
+#   - TODO: Make list of possible errors accessible as metadata?
+#
+# TODO: I2C address of slaves.
+# TODO: Handle multiple different I2C devices on same bus
+#       -> we need to decode multiple protocols at the same time.
+# TODO: range: Always contiguous? Splitted ranges? Multiple per event?
+#
+
+#
+# I2C input format:
+#
+# signals:
+# [[id, channel, description], ...] # TODO
+#
+# Example:
+# {'id': 'SCL', 'ch': 5, 'desc': 'Serial clock line'}
+# {'id': 'SDA', 'ch': 7, 'desc': 'Serial data line'}
+# ...
+#
+# {'inbuf': [...],
+#  'signals': [{'SCL': }]}
+#
+
+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.
+       metadata = {
+         'numchannels': 8,
+         'signals': {
+             'scl': {'ch': 5, 'name': 'SCL', 'desc': 'Serial clock line'},
+             'sda': {'ch': 7, 'name': 'SDA', 'desc': 'Serial data line'},
+           },
+       }
+
+       out = []
+       o = ack = d = ''
+       bitcount = data = 0
+       wr = startsample = -1
+       IDLE, START, ADDRESS, DATA = range(4)
+       state = IDLE
+
+       # Get the channel/probe number of the SCL/SDA signals.
+       scl_bit = metadata['signals']['scl']['ch']
+       sda_bit = metadata['signals']['sda']['ch']
+
+       # Get SCL/SDA bit values (0/1 for low/high) of the first sample.
+       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...
+               # Get SCL/SDA bit values (0/1 for low/high).
+               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 = {'type': 'S', 'range': (samplenum, samplenum),
+                            'data': None, 'ann': None},
+                       out.append(o)
+                       state = ADDRESS
+                       bitcount = data = 0
+
+               # Data latching by transmitter: SCL = low
+               elif (scl == 0):
+                       pass # TODO
+
+               # Data sampling of receiver: SCL = rising
+               elif (oldscl == 0 and scl == 1):
+                       if startsample == -1:
+                               startsample = samplenum
+                       bitcount += 1
+
+                       # out.append("%d\t\tRECEIVED BIT %d:  %d\n" % \
+                       #       (samplenum, 8 - bitcount, sda))
+
+                       # Address and data are transmitted MSB-first.
+                       data <<= 1
+                       data |= sda
+
+                       if bitcount != 9:
+                               continue
+
+                       # We received 8 address/data bits and the ACK/NACK bit.
+                       data >>= 1 # Shift out unwanted ACK/NACK bit here.
+                       ack = (sda == 1) and 'N' or 'A'
+                       d = (state == ADDRESS) and (data & 0xfe) or data
+                       if state == ADDRESS:
+                               wr = (data & 1) and 1 or 0
+                               state = DATA
+                       o = {'type': state,
+                            'range': (startsample, samplenum - 1),
+                            'data': d, 'ann': None}
+                       if state == ADDRESS and wr == 1:
+                               o['type'] = 'AW'
+                       elif state == ADDRESS and wr == 0:
+                               o['type'] = 'AR'
+                       elif state == DATA and wr == 1:
+                               o['type'] = 'DW'
+                       elif state == DATA and wr == 0:
+                               o['type'] = 'DR'
+                       out.append(o)
+                       o = {'type': ack, 'range': (samplenum, samplenum),
+                            'data': None, 'ann': None}
+                       out.append(o)
+                       bitcount = data = startsample = 0
+                       startsample = -1
+
+               # STOP condition (P): SDA = rising, SCL = high
+               elif (oldsda == 0 and sda == 1) and scl == 1:
+                       o = {'type': 'P', 'range': (samplenum, samplenum),
+                            'data': None, 'ann': None},
+                       out.append(o)
+                       state = IDLE
+                       wr = -1
+
+               # Save current SDA/SCL values for the next round.
+               oldscl = scl
+               oldsda = sda
+
+       # FIXME: Just for testing...
+       return str(out)
+
+def register():
+       return {
+               'id': 'i2c',
+               'name': 'I2C',
+               'desc': 'Inter-Integrated Circuit (I2C) bus',
+               'inputformats': ['raw'],
+               'signalnames':  {
+                               'SCL': 'Serial clock line',
+                               'SDA': 'Serial data line',
+                               },
+               'outputformats': ['i2c'],
+       }
+
+# Use psyco (if available) as it results in huge performance improvements.
+try:
+       import psyco
+       psyco.bind(decode)
+except ImportError:
+       pass
+
diff --git a/decoders/nunchuk.py b/decoders/nunchuk.py
new file mode 100644 (file)
index 0000000..409e120
--- /dev/null
@@ -0,0 +1,157 @@
+##
+## This file is part of the sigrok project.
+##
+## Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
+##
+## This program is free software; you can redistribute it and/or modify
+## it under the terms of the GNU General Public License as published by
+## the Free Software Foundation; either version 2 of the License, or
+## (at your option) any later version.
+##
+## This program is distributed in the hope that it will be useful,
+## but WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+## GNU General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with this program; if not, write to the Free Software
+## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+##
+
+#
+# Nintendo Wii Nunchuk decoder
+#
+
+# TODO: Description
+
+# FIXME: This is just some example input for testing purposes...
+example_packets = [
+       # START condition.
+       {'type': 'S',  'range': (10, 11), 'data': None, 'ann': ''},
+
+       # Nunchuk init: Write 0x40,0x00 to slave address 0x54.
+       {'type': 'AW', 'range': (12, 13), 'data': 0x54, 'ann': ''},
+       {'type': 'DW', 'range': (14, 15), 'data': 0x40, 'ann': ''},
+       {'type': 'AW', 'range': (16, 17), 'data': 0x54, 'ann': ''},
+       {'type': 'DW', 'range': (18, 19), 'data': 0x00, 'ann': ''},
+
+       # Get data: Read 6 bytes of data.
+       {'type': 'DR', 'range': (20, 21), 'data': 0x11, 'ann': ''},
+       {'type': 'DR', 'range': (22, 23), 'data': 0x22, 'ann': ''},
+       {'type': 'DR', 'range': (24, 25), 'data': 0x33, 'ann': ''},
+       {'type': 'DR', 'range': (26, 27), 'data': 0x44, 'ann': ''},
+       {'type': 'DR', 'range': (28, 29), 'data': 0x55, 'ann': ''},
+       {'type': 'DR', 'range': (30, 31), 'data': 0x66, 'ann': ''},
+
+       # STOP condition.
+       {'type': 'P',  'range': (32, 33), 'data': None, 'ann': ''},
+]
+
+def decode(inbuf):
+       """Nintendo Wii Nunchuk decoder"""
+
+       # FIXME: Get the data in the correct format in the first place.
+       inbuf = [ord(x) for x in inbuf]
+       out = []
+       o = {}
+
+       # TODO: Pass in metadata.
+
+       # States
+       IDLE, START, NUNCHUK_SLAVE, INIT, INITIALIZED = range(5)
+       state = IDLE # TODO: Can we assume a certain initial state?
+
+       sx = sy = ax = ay = az = bz = bc = 0
+
+       databytecount = 0
+
+       # Loop over all I2C packets.
+       for p in example_packets:
+               if p['type'] == 'S': # TODO: Handle 'Sr' here, too?
+                       state = START
+
+               elif p['type'] == 'Sr':
+                       pass # FIXME
+
+               elif p['type'] == 'AR':
+                       # TODO: Error/Warning, not supported, I think.
+                       pass
+
+               elif p['type'] == 'AW':
+                       # The Wii Nunchuk always has slave address 0x54.
+                       # TODO: Handle this stuff more correctly.
+                       if p['data'] == 0x54:
+                               pass # TODO
+                       else:
+                               pass # TODO: What to do here? Ignore? Error?
+
+               elif p['type'] == 'DR' and state == INITIALIZED:
+                       if databytecount == 0:
+                               sx = p['data']
+                       elif databytecount == 1:
+                               sy = p['data']
+                       elif databytecount == 2:
+                               ax = p['data'] << 2
+                       elif databytecount == 3:
+                               ay = p['data'] << 2
+                       elif databytecount == 4:
+                               az = p['data'] << 2
+                       elif databytecount == 5:
+                               bz =  (p['data'] & (1 << 0)) >> 0
+                               bc =  (p['data'] & (1 << 1)) >> 1
+                               ax |= (p['data'] & (3 << 2)) >> 2
+                               ay |= (p['data'] & (3 << 4)) >> 4
+                               az |= (p['data'] & (3 << 6)) >> 6
+                               # del o
+                               o = {'type': 'D', 'range': (0, 0), 'data': []}
+                               o['data'] = [sx, sy, ax, ay, az, bz, bc]
+                               # sx = sy = ax = ay = az = bz = bc = 0
+                       else:
+                               pass # TODO
+
+                       if 0 <= databytecount <= 5:
+                               databytecount += 1
+
+                       # TODO: If 6 bytes read -> save and reset
+
+               # TODO
+               elif p['type'] == 'DR' and state != INITIALIZED:
+                       pass
+
+               elif p['type'] == 'DW':
+                       if p['data'] == 0x40 and state == START:
+                               state = INIT
+                       elif p['data'] == 0x00 and state == INIT:
+                               o = {'type': 'I', 'range': (0, 0), 'data': []}
+                               o['data'] = [0x40, 0x00]
+                               out.append(o)
+                               state = INITIALIZED
+                       else:
+                               pass # TODO
+
+               elif p['type'] == 'P':
+                       out.append(o)
+                       state = INITIALIZED
+                       databytecount = 0
+
+       print out
+
+       # FIXME
+       return ''
+
+def register():
+       return {
+               'id': 'nunchuk',
+               'name': 'Nunchuk',
+               'desc': 'Nintendo Wii Nunchuk decoder',
+               'inputformats': ['i2c'],
+               'ouputformats': ['nunchuk'],
+       }
+
+# Use psyco (if available) as it results in huge performance improvements.
+try:
+       import psyco
+       psyco.bind(decode)
+except ImportError:
+       pass
+
diff --git a/decoders/transitioncounter.py b/decoders/transitioncounter.py
new file mode 100644 (file)
index 0000000..a6d331e
--- /dev/null
@@ -0,0 +1,94 @@
+##
+## This file is part of the sigrok project.
+##
+## Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
+##
+## This program is free software; you can redistribute it and/or modify
+## it under the terms of the GNU General Public License as published by
+## the Free Software Foundation; either version 2 of the License, or
+## (at your option) any later version.
+##
+## This program is distributed in the hope that it will be useful,
+## but WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+## GNU General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with this program; if not, write to the Free Software
+## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+##
+
+def decode(inbuf):
+       """Counts the low->high and high->low transitions in the specified
+          channel(s) of the signal."""
+
+       outbuf = ''
+
+       # FIXME: Get the data in the correct format in the first place.
+       inbuf = [ord(x) for x in inbuf]
+
+       # TODO: Don't hardcode the number of channels.
+       channels = 8
+
+       oldbit = [0] * channels
+       transitions = [0] * channels
+       rising = [0] * channels
+       falling = [0] * channels
+
+       # Initial values.
+       oldbyte = inbuf[0]
+       for i in range(channels):
+               oldbit[i] = (oldbyte & (1 << i)) >> i
+
+       # Loop over all samples.
+       # TODO: Handle LAs with more/less than 8 channels.
+       for s in inbuf:
+               # Optimization: Skip identical bytes (no transitions).
+               if oldbyte == s:
+                       continue
+               for i in range(channels):
+                       curbit = (s & (1 << i)) >> i
+                       # Optimization: Skip identical bits (no transitions).
+                       if oldbit[i] == curbit:
+                               continue
+                       elif (oldbit[i] == 0 and curbit == 1):
+                               rising[i] += 1
+                       elif (oldbit[i] == 1 and curbit == 0):
+                               falling[i] += 1
+                       oldbit[i] = curbit
+               oldbyte = s
+
+       # Total number of transitions is the sum of rising and falling edges.
+       for i in range(channels):
+               transitions[i] = rising[i] + falling[i]
+
+       outbuf += "Rising edges:  "
+       for i in range(channels):
+               outbuf += str(rising[i]) + " "
+       outbuf += "\nFalling edges: "
+       for i in range(channels):
+               outbuf += str(falling[i]) + " "
+       outbuf += "\nTransitions:   "
+       for i in range(channels):
+               outbuf += str(transitions[i]) + " "
+       outbuf += "\n"
+
+       return outbuf
+
+def register():
+       return {
+               'id': 'transitioncounter',
+               'name': 'Transition counter',
+               'desc': 'Count rising/falling edges',
+               'inputformats': ['raw'],
+               'signalnames': {}, # FIXME
+               'outputformats': ['transitioncounts'],
+       }
+
+# Use psyco (if available) as it results in huge performance improvements.
+try:
+       import psyco
+       psyco.bind(decode)
+except ImportError:
+       pass
+
diff --git a/scripts/Makefile.am b/scripts/Makefile.am
deleted file mode 100644 (file)
index 7ac94dc..0000000
+++ /dev/null
@@ -1,24 +0,0 @@
-##
-## This file is part of the sigrok project.
-##
-## Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
-##
-## This program is free software; you can redistribute it and/or modify
-## it under the terms of the GNU General Public License as published by
-## the Free Software Foundation; either version 2 of the License, or
-## (at your option) any later version.
-##
-## This program is distributed in the hope that it will be useful,
-## but WITHOUT ANY WARRANTY; without even the implied warranty of
-## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-## GNU General Public License for more details.
-##
-## You should have received a copy of the GNU General Public License
-## along with this program; if not, write to the Free Software
-## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
-##
-
-dist_pkgdata_SCRIPTS = i2c.py nunchuk.py transitioncounter.py
-
-CLEANFILES = *.pyc
-
diff --git a/scripts/i2c.py b/scripts/i2c.py
deleted file mode 100644 (file)
index bbf6925..0000000
+++ /dev/null
@@ -1,255 +0,0 @@
-##
-## This file is part of the sigrok project.
-##
-## Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
-##
-## This program is free software; you can redistribute it and/or modify
-## it under the terms of the GNU General Public License as published by
-## the Free Software Foundation; either version 2 of the License, or
-## (at your option) any later version.
-##
-## This program is distributed in the hope that it will be useful,
-## but WITHOUT ANY WARRANTY; without even the implied warranty of
-## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-## GNU General Public License for more details.
-##
-## You should have received a copy of the GNU General Public License
-## along with this program; if not, write to the Free Software
-## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
-##
-
-#
-# I2C protocol decoder
-#
-
-#
-# The Inter-Integrated Circuit (I2C) bus is a bidirectional, multi-master
-# bus using two signals (SCL = serial clock line, SDA = serial data line).
-#
-# There can be many devices on the same bus. Each device can potentially be
-# master or slave (and that can change during runtime). Both slave and master
-# can potentially play the transmitter or receiver role (this can also
-# change at runtime).
-#
-# Possible maximum data rates:
-#  - Standard mode: 100 kbit/s
-#  - Fast mode: 400 kbit/s
-#  - Fast-mode Plus: 1 Mbit/s
-#  - High-speed mode: 3.4 Mbit/s
-#
-# START condition (S): SDA = falling, SCL = high
-# Repeated START condition (Sr): same as S
-# STOP condition (P): SDA = rising, SCL = high
-#
-# 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
-# indicates a WRITE operation, if it's high that indicates a READ operation.
-#
-# Later an optional 10bit slave addressing scheme was added.
-#
-# Documentation:
-# http://www.nxp.com/acrobat/literature/9398/39340011.pdf (v2.1 spec)
-# http://www.nxp.com/acrobat/usermanuals/UM10204_3.pdf (v3 spec)
-# http://en.wikipedia.org/wiki/I2C
-#
-
-# TODO: Look into arbitration, collision detection, clock synchronisation, etc.
-# TODO: Handle clock stretching.
-# TODO: Handle combined messages / repeated START.
-# TODO: Implement support for 7bit and 10bit slave addresses.
-# TODO: Implement support for inverting SDA/SCL levels (0->1 and 1->0).
-# TODO: Implement support for detecting various bus errors.
-
-#
-# I2C output format:
-#
-# The output consists of a (Python) list of I2C "packets", each of which
-# has an (implicit) index number (its index in the list).
-# Each packet consists of a Python dict with certain key/value pairs.
-#
-# TODO: Make this a list later instead of a dict?
-#
-# 'type': (string)
-#   - 'S' (START condition)
-#   - 'Sr' (Repeated START)
-#   - 'AR' (Address, read)
-#   - 'AW' (Address, write)
-#   - 'DR' (Data, read)
-#   - 'DW' (Data, write)
-#   - 'P' (STOP condition)
-# 'range': (tuple of 2 integers, the min/max samplenumber of this range)
-#   - (min, max)
-#   - min/max can also be identical.
-# 'data': (actual data as integer ???) TODO: This can be very variable...
-# 'ann': (string; additional annotations / comments)
-#
-# Example output:
-# [{'type': 'S',  'range': (150, 160), 'data': None, 'ann': 'Foobar'},
-#  {'type': 'AW', 'range': (200, 300), 'data': 0x50, 'ann': 'Slave 4'},
-#  {'type': 'DW', 'range': (310, 370), 'data': 0x00, 'ann': 'Init cmd'},
-#  {'type': 'AR', 'range': (500, 560), 'data': 0x50, 'ann': 'Get stat'},
-#  {'type': 'DR', 'range': (580, 640), 'data': 0xfe, 'ann': 'OK'},
-#  {'type': 'P',  'range': (650, 660), 'data': None, 'ann': None}]
-#
-# Possible other events:
-#   - Error event in case protocol looks broken:
-#     [{'type': 'ERROR', 'range': (min, max),
-#      'data': TODO, 'ann': 'This is not a Microchip 24XX64 EEPROM'},
-#     [{'type': 'ERROR', 'range': (min, max),
-#      'data': TODO, 'ann': 'TODO'},
-#   - TODO: Make list of possible errors accessible as metadata?
-#
-# TODO: I2C address of slaves.
-# TODO: Handle multiple different I2C devices on same bus
-#       -> we need to decode multiple protocols at the same time.
-# TODO: range: Always contiguous? Splitted ranges? Multiple per event?
-#
-
-#
-# I2C input format:
-#
-# signals:
-# [[id, channel, description], ...] # TODO
-#
-# Example:
-# {'id': 'SCL', 'ch': 5, 'desc': 'Serial clock line'}
-# {'id': 'SDA', 'ch': 7, 'desc': 'Serial data line'}
-# ...
-#
-# {'inbuf': [...],
-#  'signals': [{'SCL': }]}
-#
-
-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.
-       metadata = {
-         'numchannels': 8,
-         'signals': {
-             'scl': {'ch': 5, 'name': 'SCL', 'desc': 'Serial clock line'},
-             'sda': {'ch': 7, 'name': 'SDA', 'desc': 'Serial data line'},
-           },
-       }
-
-       out = []
-       o = ack = d = ''
-       bitcount = data = 0
-       wr = startsample = -1
-       IDLE, START, ADDRESS, DATA = range(4)
-       state = IDLE
-
-       # Get the channel/probe number of the SCL/SDA signals.
-       scl_bit = metadata['signals']['scl']['ch']
-       sda_bit = metadata['signals']['sda']['ch']
-
-       # Get SCL/SDA bit values (0/1 for low/high) of the first sample.
-       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...
-               # Get SCL/SDA bit values (0/1 for low/high).
-               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 = {'type': 'S', 'range': (samplenum, samplenum),
-                            'data': None, 'ann': None},
-                       out.append(o)
-                       state = ADDRESS
-                       bitcount = data = 0
-
-               # Data latching by transmitter: SCL = low
-               elif (scl == 0):
-                       pass # TODO
-
-               # Data sampling of receiver: SCL = rising
-               elif (oldscl == 0 and scl == 1):
-                       if startsample == -1:
-                               startsample = samplenum
-                       bitcount += 1
-
-                       # out.append("%d\t\tRECEIVED BIT %d:  %d\n" % \
-                       #       (samplenum, 8 - bitcount, sda))
-
-                       # Address and data are transmitted MSB-first.
-                       data <<= 1
-                       data |= sda
-
-                       if bitcount != 9:
-                               continue
-
-                       # We received 8 address/data bits and the ACK/NACK bit.
-                       data >>= 1 # Shift out unwanted ACK/NACK bit here.
-                       ack = (sda == 1) and 'N' or 'A'
-                       d = (state == ADDRESS) and (data & 0xfe) or data
-                       if state == ADDRESS:
-                               wr = (data & 1) and 1 or 0
-                               state = DATA
-                       o = {'type': state,
-                            'range': (startsample, samplenum - 1),
-                            'data': d, 'ann': None}
-                       if state == ADDRESS and wr == 1:
-                               o['type'] = 'AW'
-                       elif state == ADDRESS and wr == 0:
-                               o['type'] = 'AR'
-                       elif state == DATA and wr == 1:
-                               o['type'] = 'DW'
-                       elif state == DATA and wr == 0:
-                               o['type'] = 'DR'
-                       out.append(o)
-                       o = {'type': ack, 'range': (samplenum, samplenum),
-                            'data': None, 'ann': None}
-                       out.append(o)
-                       bitcount = data = startsample = 0
-                       startsample = -1
-
-               # STOP condition (P): SDA = rising, SCL = high
-               elif (oldsda == 0 and sda == 1) and scl == 1:
-                       o = {'type': 'P', 'range': (samplenum, samplenum),
-                            'data': None, 'ann': None},
-                       out.append(o)
-                       state = IDLE
-                       wr = -1
-
-               # Save current SDA/SCL values for the next round.
-               oldscl = scl
-               oldsda = sda
-
-       # FIXME: Just for testing...
-       return str(out)
-
-def register():
-       return {
-               'id': 'i2c',
-               'name': 'I2C',
-               'desc': 'Inter-Integrated Circuit (I2C) bus',
-               'inputformats': ['raw'],
-               'signalnames':  {
-                               'SCL': 'Serial clock line',
-                               'SDA': 'Serial data line',
-                               },
-               'outputformats': ['i2c'],
-       }
-
-# Use psyco (if available) as it results in huge performance improvements.
-try:
-       import psyco
-       psyco.bind(decode)
-except ImportError:
-       pass
-
diff --git a/scripts/nunchuk.py b/scripts/nunchuk.py
deleted file mode 100644 (file)
index 409e120..0000000
+++ /dev/null
@@ -1,157 +0,0 @@
-##
-## This file is part of the sigrok project.
-##
-## Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
-##
-## This program is free software; you can redistribute it and/or modify
-## it under the terms of the GNU General Public License as published by
-## the Free Software Foundation; either version 2 of the License, or
-## (at your option) any later version.
-##
-## This program is distributed in the hope that it will be useful,
-## but WITHOUT ANY WARRANTY; without even the implied warranty of
-## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-## GNU General Public License for more details.
-##
-## You should have received a copy of the GNU General Public License
-## along with this program; if not, write to the Free Software
-## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
-##
-
-#
-# Nintendo Wii Nunchuk decoder
-#
-
-# TODO: Description
-
-# FIXME: This is just some example input for testing purposes...
-example_packets = [
-       # START condition.
-       {'type': 'S',  'range': (10, 11), 'data': None, 'ann': ''},
-
-       # Nunchuk init: Write 0x40,0x00 to slave address 0x54.
-       {'type': 'AW', 'range': (12, 13), 'data': 0x54, 'ann': ''},
-       {'type': 'DW', 'range': (14, 15), 'data': 0x40, 'ann': ''},
-       {'type': 'AW', 'range': (16, 17), 'data': 0x54, 'ann': ''},
-       {'type': 'DW', 'range': (18, 19), 'data': 0x00, 'ann': ''},
-
-       # Get data: Read 6 bytes of data.
-       {'type': 'DR', 'range': (20, 21), 'data': 0x11, 'ann': ''},
-       {'type': 'DR', 'range': (22, 23), 'data': 0x22, 'ann': ''},
-       {'type': 'DR', 'range': (24, 25), 'data': 0x33, 'ann': ''},
-       {'type': 'DR', 'range': (26, 27), 'data': 0x44, 'ann': ''},
-       {'type': 'DR', 'range': (28, 29), 'data': 0x55, 'ann': ''},
-       {'type': 'DR', 'range': (30, 31), 'data': 0x66, 'ann': ''},
-
-       # STOP condition.
-       {'type': 'P',  'range': (32, 33), 'data': None, 'ann': ''},
-]
-
-def decode(inbuf):
-       """Nintendo Wii Nunchuk decoder"""
-
-       # FIXME: Get the data in the correct format in the first place.
-       inbuf = [ord(x) for x in inbuf]
-       out = []
-       o = {}
-
-       # TODO: Pass in metadata.
-
-       # States
-       IDLE, START, NUNCHUK_SLAVE, INIT, INITIALIZED = range(5)
-       state = IDLE # TODO: Can we assume a certain initial state?
-
-       sx = sy = ax = ay = az = bz = bc = 0
-
-       databytecount = 0
-
-       # Loop over all I2C packets.
-       for p in example_packets:
-               if p['type'] == 'S': # TODO: Handle 'Sr' here, too?
-                       state = START
-
-               elif p['type'] == 'Sr':
-                       pass # FIXME
-
-               elif p['type'] == 'AR':
-                       # TODO: Error/Warning, not supported, I think.
-                       pass
-
-               elif p['type'] == 'AW':
-                       # The Wii Nunchuk always has slave address 0x54.
-                       # TODO: Handle this stuff more correctly.
-                       if p['data'] == 0x54:
-                               pass # TODO
-                       else:
-                               pass # TODO: What to do here? Ignore? Error?
-
-               elif p['type'] == 'DR' and state == INITIALIZED:
-                       if databytecount == 0:
-                               sx = p['data']
-                       elif databytecount == 1:
-                               sy = p['data']
-                       elif databytecount == 2:
-                               ax = p['data'] << 2
-                       elif databytecount == 3:
-                               ay = p['data'] << 2
-                       elif databytecount == 4:
-                               az = p['data'] << 2
-                       elif databytecount == 5:
-                               bz =  (p['data'] & (1 << 0)) >> 0
-                               bc =  (p['data'] & (1 << 1)) >> 1
-                               ax |= (p['data'] & (3 << 2)) >> 2
-                               ay |= (p['data'] & (3 << 4)) >> 4
-                               az |= (p['data'] & (3 << 6)) >> 6
-                               # del o
-                               o = {'type': 'D', 'range': (0, 0), 'data': []}
-                               o['data'] = [sx, sy, ax, ay, az, bz, bc]
-                               # sx = sy = ax = ay = az = bz = bc = 0
-                       else:
-                               pass # TODO
-
-                       if 0 <= databytecount <= 5:
-                               databytecount += 1
-
-                       # TODO: If 6 bytes read -> save and reset
-
-               # TODO
-               elif p['type'] == 'DR' and state != INITIALIZED:
-                       pass
-
-               elif p['type'] == 'DW':
-                       if p['data'] == 0x40 and state == START:
-                               state = INIT
-                       elif p['data'] == 0x00 and state == INIT:
-                               o = {'type': 'I', 'range': (0, 0), 'data': []}
-                               o['data'] = [0x40, 0x00]
-                               out.append(o)
-                               state = INITIALIZED
-                       else:
-                               pass # TODO
-
-               elif p['type'] == 'P':
-                       out.append(o)
-                       state = INITIALIZED
-                       databytecount = 0
-
-       print out
-
-       # FIXME
-       return ''
-
-def register():
-       return {
-               'id': 'nunchuk',
-               'name': 'Nunchuk',
-               'desc': 'Nintendo Wii Nunchuk decoder',
-               'inputformats': ['i2c'],
-               'ouputformats': ['nunchuk'],
-       }
-
-# Use psyco (if available) as it results in huge performance improvements.
-try:
-       import psyco
-       psyco.bind(decode)
-except ImportError:
-       pass
-
diff --git a/scripts/transitioncounter.py b/scripts/transitioncounter.py
deleted file mode 100644 (file)
index a6d331e..0000000
+++ /dev/null
@@ -1,94 +0,0 @@
-##
-## This file is part of the sigrok project.
-##
-## Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
-##
-## This program is free software; you can redistribute it and/or modify
-## it under the terms of the GNU General Public License as published by
-## the Free Software Foundation; either version 2 of the License, or
-## (at your option) any later version.
-##
-## This program is distributed in the hope that it will be useful,
-## but WITHOUT ANY WARRANTY; without even the implied warranty of
-## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-## GNU General Public License for more details.
-##
-## You should have received a copy of the GNU General Public License
-## along with this program; if not, write to the Free Software
-## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
-##
-
-def decode(inbuf):
-       """Counts the low->high and high->low transitions in the specified
-          channel(s) of the signal."""
-
-       outbuf = ''
-
-       # FIXME: Get the data in the correct format in the first place.
-       inbuf = [ord(x) for x in inbuf]
-
-       # TODO: Don't hardcode the number of channels.
-       channels = 8
-
-       oldbit = [0] * channels
-       transitions = [0] * channels
-       rising = [0] * channels
-       falling = [0] * channels
-
-       # Initial values.
-       oldbyte = inbuf[0]
-       for i in range(channels):
-               oldbit[i] = (oldbyte & (1 << i)) >> i
-
-       # Loop over all samples.
-       # TODO: Handle LAs with more/less than 8 channels.
-       for s in inbuf:
-               # Optimization: Skip identical bytes (no transitions).
-               if oldbyte == s:
-                       continue
-               for i in range(channels):
-                       curbit = (s & (1 << i)) >> i
-                       # Optimization: Skip identical bits (no transitions).
-                       if oldbit[i] == curbit:
-                               continue
-                       elif (oldbit[i] == 0 and curbit == 1):
-                               rising[i] += 1
-                       elif (oldbit[i] == 1 and curbit == 0):
-                               falling[i] += 1
-                       oldbit[i] = curbit
-               oldbyte = s
-
-       # Total number of transitions is the sum of rising and falling edges.
-       for i in range(channels):
-               transitions[i] = rising[i] + falling[i]
-
-       outbuf += "Rising edges:  "
-       for i in range(channels):
-               outbuf += str(rising[i]) + " "
-       outbuf += "\nFalling edges: "
-       for i in range(channels):
-               outbuf += str(falling[i]) + " "
-       outbuf += "\nTransitions:   "
-       for i in range(channels):
-               outbuf += str(transitions[i]) + " "
-       outbuf += "\n"
-
-       return outbuf
-
-def register():
-       return {
-               'id': 'transitioncounter',
-               'name': 'Transition counter',
-               'desc': 'Count rising/falling edges',
-               'inputformats': ['raw'],
-               'signalnames': {}, # FIXME
-               'outputformats': ['transitioncounts'],
-       }
-
-# Use psyco (if available) as it results in huge performance improvements.
-try:
-       import psyco
-       psyco.bind(decode)
-except ImportError:
-       pass
-