[libsigrokdecode.git] / decoders / i2cdemux / pd.py

##
## This file is part of the libsigrokdecode project.
##
## Copyright (C) 2012 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
##

import sigrokdecode as srd

class Decoder(srd.Decoder):
    api_version = 1
    id = 'i2cdemux'
    name = 'I²C demux'
    longname = 'I²C demultiplexer'
    desc = 'Demux I²C packets into per-slave-address streams.'
    license = 'gplv2+'
    inputs = ['i2c']
    outputs = [] # TODO: Only known at run-time.
    probes = []
    optional_probes = []
    options = {}
    annotations = []

    def __init__(self, **kwargs):
        self.packets = [] # Local cache of I²C packets
        self.slaves = [] # List of known slave addresses
        self.stream = -1 # Current output stream
        self.streamcount = 0 # Number of created output streams

    def start(self):
        self.out_python = []

    # Grab I²C packets into a local cache, until an I²C STOP condition
    # packet comes along. At some point before that STOP condition, there
    # will have been an ADDRESS READ or ADDRESS WRITE which contains the
    # I²C address of the slave that the master wants to talk to.
    # We use this slave address to figure out which output stream should
    # get the whole chunk of packets (from START to STOP).
    def decode(self, ss, es, data):

        cmd, databyte = data

        # Add the I²C packet to our local cache.
        self.packets.append([ss, es, data])

        if cmd in ('ADDRESS READ', 'ADDRESS WRITE'):
            if databyte in self.slaves:
                self.stream = self.slaves.index(databyte)
                return

            # We're never seen this slave, add a new stream.
            self.slaves.append(databyte)
            self.out_python.append(self.register(srd.OUTPUT_PYTHON,
                                   proto_id='i2c-%s' % hex(databyte)))
            self.stream = self.streamcount
            self.streamcount += 1
        elif cmd == 'STOP':
            if self.stream == -1:
                raise Exception('Invalid stream!') # FIXME?

            # Send the whole chunk of I²C packets to the correct stream.
            for p in self.packets:
                self.put(p[0], p[1], self.out_python[self.stream], p[2])

            self.packets = []
            self.stream = -1
        else:
            pass # Do nothing, only add the I²C packet to our cache.
Commit	Line	Data
	1	##
	2	## This file is part of the libsigrokdecode project.
	3	##
	4	## Copyright (C) 2012 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	import sigrokdecode as srd
	22
	23	class Decoder(srd.Decoder):
	24	api_version = 1
	25	id = 'i2cdemux'
	26	name = 'I²C demux'
	27	longname = 'I²C demultiplexer'
	28	desc = 'Demux I²C packets into per-slave-address streams.'
	29	license = 'gplv2+'
	30	inputs = ['i2c']
	31	outputs = [] # TODO: Only known at run-time.
	32	probes = []
	33	optional_probes = []
	34	options = {}
	35	annotations = []
	36
	37	def __init__(self, **kwargs):
	38	self.packets = [] # Local cache of I²C packets
	39	self.slaves = [] # List of known slave addresses
	40	self.stream = -1 # Current output stream
	41	self.streamcount = 0 # Number of created output streams
	42
	43	def start(self):
	44	self.out_python = []
	45
	46	# Grab I²C packets into a local cache, until an I²C STOP condition
	47	# packet comes along. At some point before that STOP condition, there
	48	# will have been an ADDRESS READ or ADDRESS WRITE which contains the
	49	# I²C address of the slave that the master wants to talk to.
	50	# We use this slave address to figure out which output stream should
	51	# get the whole chunk of packets (from START to STOP).
	52	def decode(self, ss, es, data):
	53
	54	cmd, databyte = data
	55
	56	# Add the I²C packet to our local cache.
	57	self.packets.append([ss, es, data])
	58
	59	if cmd in ('ADDRESS READ', 'ADDRESS WRITE'):
	60	if databyte in self.slaves:
	61	self.stream = self.slaves.index(databyte)
	62	return
	63
	64	# We're never seen this slave, add a new stream.
	65	self.slaves.append(databyte)
	66	self.out_python.append(self.register(srd.OUTPUT_PYTHON,
	67	proto_id='i2c-%s' % hex(databyte)))
	68	self.stream = self.streamcount
	69	self.streamcount += 1
	70	elif cmd == 'STOP':
	71	if self.stream == -1:
	72	raise Exception('Invalid stream!') # FIXME?
	73
	74	# Send the whole chunk of I²C packets to the correct stream.
	75	for p in self.packets:
	76	self.put(p[0], p[1], self.out_python[self.stream], p[2])
	77
	78	self.packets = []
	79	self.stream = -1
	80	else:
	81	pass # Do nothing, only add the I²C packet to our cache.
	82