Change PD options to be a tuple of dictionaries.
[libsigrokdecode.git] / 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     probes = []
35     optional_probes = []
36     options = (
37         {'id': 'address', 'desc': 'Address to filter out of the I²C stream',
38             'default': 0},
39         {'id': 'direction', 'desc': 'Direction to filter', 'default': 'both',
40             'values': ('read', 'write', 'both')}
41     )
42     annotations = []
43
44     def __init__(self, **kwargs):
45         self.state = None
46         self.curslave = -1
47         self.curdirection = None
48         self.packets = [] # Local cache of I²C packets
49
50     def start(self):
51         self.out_python = self.register(srd.OUTPUT_PYTHON, proto_id='i2c')
52         if self.options['address'] not in range(0, 127 + 1):
53             raise Exception('Invalid slave (must be 0..127).')
54         if self.options['direction'] not in ('both', 'read', 'write'):
55             raise Exception('Invalid direction (valid: read/write/both).')
56
57     # Grab I²C packets into a local cache, until an I²C STOP condition
58     # packet comes along. At some point before that STOP condition, there
59     # will have been an ADDRESS READ or ADDRESS WRITE which contains the
60     # I²C address of the slave that the master wants to talk to.
61     # If that slave shall be filtered, output the cache (all packets from
62     # START to STOP) as proto 'i2c', otherwise drop it.
63     def decode(self, ss, es, data):
64
65         cmd, databyte = data
66
67         # Add the I²C packet to our local cache.
68         self.packets.append([ss, es, data])
69
70         if cmd in ('ADDRESS READ', 'ADDRESS WRITE'):
71             self.curslave = databyte
72             self.curdirection = cmd[8:].lower()
73         elif cmd in ('STOP', 'START REPEAT'):
74             # If this chunk was not for the correct slave, drop it.
75             if self.options['address'] == 0:
76                 pass
77             elif self.curslave != self.options['address']:
78                 self.packets = []
79                 return
80
81             # If this chunk was not in the right direction, drop it.
82             if self.options['direction'] == 'both':
83                 pass
84             elif self.options['direction'] != self.curdirection:
85                 self.packets = []
86                 return
87
88             # TODO: START->STOP chunks with both read and write (Repeat START)
89             # Otherwise, send out the whole chunk of I²C packets.
90             for p in self.packets:
91                 self.put(p[0], p[1], self.out_python, p[2])
92
93             self.packets = []
94         else:
95             pass # Do nothing, only add the I²C packet to our cache.
96