new dynamic output stream registration code, not finished.
[libsigrokdecode.git] / decoders / spi.py
1 ##
2 ## This file is part of the sigrok project.
3 ##
4 ## Copyright (C) 2011 Gareth McMullin <gareth@blacksphere.co.nz>
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 sigrok
22
23 class Sample():
24     def __init__(self, data):
25         self.data = data
26     def probe(self, probe):
27         s = ord(self.data[probe / 8]) & (1 << (probe % 8))
28         return True if s else False
29
30 def sampleiter(data, unitsize):
31     for i in range(0, len(data), unitsize):
32         yield(Sample(data[i:i+unitsize]))
33
34 class Decoder(sigrok.Decoder):
35     id = 'spi'
36     name = 'SPI'
37     desc = '...desc...'
38     longname = 'Serial Peripheral Interface (SPI) bus'
39     longdesc = '...longdesc...'
40     author = 'Gareth McMullin'
41     email = 'gareth@blacksphere.co.nz'
42     license = 'gplv2+'
43     inputs = ['logic']
44     outputs = ['spi']
45     # Probe names with a set of defaults
46     probes = {'sdata':0, 'sck':1}
47     options = {}
48
49     def __init__(self):
50         self.probes = Decoder.probes.copy()
51         self.oldsck = True
52         self.rxcount = 0
53         self.rxdata = 0
54         self.bytesreceived = 0
55         self.output_protocol = None
56         self.output_annotation = None
57
58     def start(self, metadata):
59         self.unitsize = metadata['unitsize']
60         self.output_protocol = self.output_new(2)
61         self.output_annotation = self.output_new(1)
62
63     def report(self):
64         return 'SPI: %d bytes received' % self.bytesreceived
65
66     def decode(self, data):
67         # We should accept a list of samples and iterate...
68         for sample in sampleiter(data['data'], self.unitsize):
69
70             sck = sample.probe(self.probes['sck'])
71             # Sample SDATA on rising SCK
72             if sck == self.oldsck:
73                 continue
74             self.oldsck = sck
75             if not sck:
76                 continue
77
78             # If this is first bit, save timestamp
79             if self.rxcount == 0:
80                 self.time = data['time']
81             # Receive bit into our shift register
82             sdata = sample.probe(self.probes['sdata'])
83             if sdata:
84                 self.rxdata |= 1 << (7 - self.rxcount)
85             self.rxcount += 1
86             # Continue to receive if not a byte yet
87             if self.rxcount != 8:
88                 continue
89             # Received a byte, pass up to sigrok
90             outdata = {'time':self.time,
91                 'duration':data['time'] + data['duration'] - self.time,
92                 'data':self.rxdata,
93                 'display':('%02X' % self.rxdata),
94                 'type':'spi',
95             }
96             self.put(outdata)
97             # Reset decoder state
98             self.rxdata = 0
99             self.rxcount = 0
100             # Keep stats for summary
101             self.bytesreceived += 1
102