decoders/i2cfilter/pd.py

   1 ##
   2 ## This file is part of the libsigrokdecode project.
   3 ##
   4 ## Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
   5 ## Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
   6 ##
   7 ## This program is free software; you can redistribute it and/or modify
   8 ## it under the terms of the GNU General Public License as published by
   9 ## the Free Software Foundation; either version 3 of the License, or
  10 ## (at your option) any later version.
  11 ##
  12 ## This program is distributed in the hope that it will be useful,
  13 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 ## GNU General Public License for more details.
  16 ##
  17 ## You should have received a copy of the GNU General Public License
  18 ## along with this program; if not, see <http://www.gnu.org/licenses/>.
  19 ##
  20
  21 # TODO: Support for filtering out multiple slave/direction pairs?
  22
  23 import sigrokdecode as srd
  24
  25 class Decoder(srd.Decoder):
  26     api_version = 1
  27     id = 'i2cfilter'
  28     name = 'I²C filter'
  29     longname = 'I²C filter'
  30     desc = 'Filter out addresses/directions in an I²C stream.'
  31     license = 'gplv3+'
  32     inputs = ['i2c']
  33     outputs = ['i2c']
  34     options = (
  35         {'id': 'address', 'desc': 'Address to filter out of the I²C stream',
  36             'default': 0},
  37         {'id': 'direction', 'desc': 'Direction to filter', 'default': 'both',
  38             'values': ('read', 'write', 'both')}
  39     )
  40
  41     def __init__(self, **kwargs):
  42         self.state = None
  43         self.curslave = -1
  44         self.curdirection = None
  45         self.packets = [] # Local cache of I²C packets
  46
  47     def start(self):
  48         self.out_python = self.register(srd.OUTPUT_PYTHON, proto_id='i2c')
  49         if self.options['address'] not in range(0, 127 + 1):
  50             raise Exception('Invalid slave (must be 0..127).')
  51         if self.options['direction'] not in ('both', 'read', 'write'):
  52             raise Exception('Invalid direction (valid: read/write/both).')
  53
  54     # Grab I²C packets into a local cache, until an I²C STOP condition
  55     # packet comes along. At some point before that STOP condition, there
  56     # will have been an ADDRESS READ or ADDRESS WRITE which contains the
  57     # I²C address of the slave that the master wants to talk to.
  58     # If that slave shall be filtered, output the cache (all packets from
  59     # START to STOP) as proto 'i2c', otherwise drop it.
  60     def decode(self, ss, es, data):
  61
  62         cmd, databyte = data
  63
  64         # Add the I²C packet to our local cache.
  65         self.packets.append([ss, es, data])
  66
  67         if cmd in ('ADDRESS READ', 'ADDRESS WRITE'):
  68             self.curslave = databyte
  69             self.curdirection = cmd[8:].lower()
  70         elif cmd in ('STOP', 'START REPEAT'):
  71             # If this chunk was not for the correct slave, drop it.
  72             if self.options['address'] == 0:
  73                 pass
  74             elif self.curslave != self.options['address']:
  75                 self.packets = []
  76                 return
  77
  78             # If this chunk was not in the right direction, drop it.
  79             if self.options['direction'] == 'both':
  80                 pass
  81             elif self.options['direction'] != self.curdirection:
  82                 self.packets = []
  83                 return
  84
  85             # TODO: START->STOP chunks with both read and write (Repeat START)
  86             # Otherwise, send out the whole chunk of I²C packets.
  87             for p in self.packets:
  88                 self.put(p[0], p[1], self.out_python, p[2])
  89
  90             self.packets = []
  91         else:
  92             pass # Do nothing, only add the I²C packet to our cache.
  93