2 ## This file is part of the libsigrokdecode project.
4 ## Copyright (C) 2011 Gareth McMullin <gareth@blacksphere.co.nz>
5 ## Copyright (C) 2012-2014 Uwe Hermann <uwe@hermann-uwe.de>
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 2 of the License, or
10 ## (at your option) any later version.
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.
17 ## You should have received a copy of the GNU General Public License
18 ## along with this program; if not, write to the Free Software
19 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 import sigrokdecode as srd
28 [<cmd>, <data1>, <data2>]
31 - 'DATA': <data1> contains the MISO data, <data2> contains the MOSI data.
32 The data is _usually_ 8 bits (but can also be fewer or more bits).
33 Both data items are Python numbers (not strings), or None if the respective
34 probe was not supplied.
35 - 'BITS': <data1>/<data2> contain a list of bit values in this MISO/MOSI data
36 item, and for each of those also their respective start-/endsample numbers.
37 - 'CS CHANGE': <data1> is the old CS# pin value, <data2> is the new value.
38 Both data items are Python numbers (0/1), not strings.
43 ['BITS', [[1, 80, 82], [1, 83, 84], [1, 85, 86], [1, 87, 88],
44 [1, 89, 90], [1, 91, 92], [1, 93, 94], [1, 95, 96]],
45 [[0, 80, 82], [0, 83, 84], [1, 85, 86], [1, 87, 88],
46 [1, 89, 90], [0, 91, 92], [1, 93, 94], [0, 95, 96]]]
53 # Key: (CPOL, CPHA). Value: SPI mode.
54 # Clock polarity (CPOL) = 0/1: Clock is low/high when inactive.
55 # Clock phase (CPHA) = 0/1: Data is valid on the leading/trailing clock edge.
63 class Decoder(srd.Decoder):
67 longname = 'Serial Peripheral Interface'
68 desc = 'Full-duplex, synchronous, serial bus.'
73 {'id': 'clk', 'name': 'CLK', 'desc': 'Clock'},
76 {'id': 'miso', 'name': 'MISO', 'desc': 'Master in, slave out'},
77 {'id': 'mosi', 'name': 'MOSI', 'desc': 'Master out, slave in'},
78 {'id': 'cs', 'name': 'CS#', 'desc': 'Chip-select'},
81 'cs_polarity': ['CS# polarity', 'active-low'],
82 'cpol': ['Clock polarity', 0],
83 'cpha': ['Clock phase', 0],
84 'bitorder': ['Bit order within the SPI data', 'msb-first'],
85 'wordsize': ['Word size of SPI data', 8], # 1-64?
86 'format': ['Data format', 'hex'],
89 ['miso-data', 'MISO data'],
90 ['mosi-data', 'MOSI data'],
91 ['miso-bits', 'MISO bits'],
92 ['mosi-bits', 'MOSI bits'],
93 ['warnings', 'Human-readable warnings'],
96 ('miso-data', 'MISO data', (0,)),
97 ('miso-bits', 'MISO bits', (2,)),
98 ('mosi-data', 'MOSI data', (1,)),
99 ('mosi-bits', 'MOSI bits', (3,)),
100 ('other', 'Other', (4,)),
104 self.samplerate = None
107 self.misodata = self.mosidata = 0
110 self.startsample = -1
112 self.cs_was_deasserted_during_data_word = 0
115 self.have_cs = self.have_miso = self.have_mosi = None
118 def metadata(self, key, value):
119 if key == srd.SRD_CONF_SAMPLERATE:
120 self.samplerate = value
123 self.out_python = self.register(srd.OUTPUT_PYTHON)
124 self.out_ann = self.register(srd.OUTPUT_ANN)
125 self.out_bitrate = self.register(srd.OUTPUT_META,
126 meta=(int, 'Bitrate', 'Bitrate during transfers'))
128 def putpw(self, data):
129 self.put(self.startsample, self.samplenum, self.out_python, data)
131 def putw(self, data):
132 self.put(self.startsample, self.samplenum, self.out_ann, data)
135 # Pass MISO and MOSI bits and then data to the next PD up the stack.
136 so = self.misodata if self.have_miso else None
137 si = self.mosidata if self.have_mosi else None
138 so_bits = self.misobits if self.have_miso else None
139 si_bits = self.mosibits if self.have_mosi else None
140 self.putpw(['BITS', si_bits, so_bits])
141 self.putpw(['DATA', si, so])
145 for bit in self.misobits:
146 self.put(bit[1], bit[2], self.out_ann, [2, ['%d' % bit[0]]])
148 for bit in self.mosibits:
149 self.put(bit[1], bit[2], self.out_ann, [3, ['%d' % bit[0]]])
151 # Dataword annotations.
153 ss, es = self.misobits[0][1], self.misobits[-1][2]
154 self.put(ss, es, self.out_ann, [0, ['%02X' % self.misodata]])
156 ss, es = self.mosibits[0][1], self.mosibits[-1][2]
157 self.put(ss, es, self.out_ann, [1, ['%02X' % self.mosidata]])
159 def reset_decoder_state(self):
160 self.misodata = 0 if self.have_miso else None
161 self.mosidata = 0 if self.have_mosi else None
162 self.misobits = [] if self.have_miso else None
163 self.mosibits = [] if self.have_mosi else None
166 def handle_bit(self, miso, mosi, clk, cs):
167 # If this is the first bit of a dataword, save its sample number.
168 if self.bitcount == 0:
169 self.startsample = self.samplenum
171 active_low = (self.options['cs_polarity'] == 'active-low')
172 deasserted = cs if active_low else not cs
174 self.cs_was_deasserted_during_data_word = 1
176 ws = self.options['wordsize']
178 # Receive MISO bit into our shift register.
180 if self.options['bitorder'] == 'msb-first':
181 self.misodata |= miso << (ws - 1 - self.bitcount)
183 self.misodata |= miso << self.bitcount
185 # Receive MOSI bit into our shift register.
187 if self.options['bitorder'] == 'msb-first':
188 self.mosidata |= mosi << (ws - 1 - self.bitcount)
190 self.mosidata |= mosi << self.bitcount
192 # Guesstimate the endsample for this bit (can be overridden below).
194 if self.bitcount > 0:
195 es += self.samplenum - self.misobits[self.bitcount - 1][1]
198 self.misobits.append([miso, self.samplenum, es])
200 self.mosibits.append([mosi, self.samplenum, es])
202 if self.bitcount > 0 and self.have_miso:
203 self.misobits[self.bitcount - 1][2] = self.samplenum
204 if self.bitcount > 0 and self.have_mosi:
205 self.mosibits[self.bitcount - 1][2] = self.samplenum
209 # Continue to receive if not enough bits were received, yet.
210 if self.bitcount != ws:
216 elapsed = 1 / float(self.samplerate)
217 elapsed *= (self.samplenum - self.startsample + 1)
218 bitrate = int(1 / elapsed * self.options['wordsize'])
219 self.put(self.startsample, self.samplenum, self.out_bitrate, bitrate)
221 if self.have_cs and self.cs_was_deasserted_during_data_word:
222 self.putw([4, ['CS# was deasserted during this data word!']])
224 self.reset_decoder_state()
226 def find_clk_edge(self, miso, mosi, clk, cs):
227 if self.have_cs and self.oldcs != cs:
228 # Send all CS# pin value changes.
229 self.put(self.samplenum, self.samplenum, self.out_python,
230 ['CS-CHANGE', self.oldcs, cs])
232 # Reset decoder state when CS# changes (and the CS# pin is used).
233 self.reset_decoder_state()
235 # Ignore sample if the clock pin hasn't changed.
236 if clk == self.oldclk:
241 # Sample data on rising/falling clock edge (depends on mode).
242 mode = spi_mode[self.options['cpol'], self.options['cpha']]
243 if mode == 0 and clk == 0: # Sample on rising clock edge
245 elif mode == 1 and clk == 1: # Sample on falling clock edge
247 elif mode == 2 and clk == 1: # Sample on falling clock edge
249 elif mode == 3 and clk == 0: # Sample on rising clock edge
252 # Found the correct clock edge, now get the SPI bit(s).
253 self.handle_bit(miso, mosi, clk, cs)
255 def decode(self, ss, es, data):
256 if self.samplerate is None:
257 raise Exception("Cannot decode without samplerate.")
258 # Either MISO or MOSI can be omitted (but not both). CS# is optional.
259 for (self.samplenum, pins) in data:
261 # Ignore identical samples early on (for performance reasons).
262 if self.oldpins == pins:
264 self.oldpins, (clk, miso, mosi, cs) = pins, pins
265 self.have_miso = (miso in (0, 1))
266 self.have_mosi = (mosi in (0, 1))
267 self.have_cs = (cs in (0, 1))
269 # Either MISO or MOSI (but not both) can be omitted.
270 if not (self.have_miso or self.have_mosi):
271 raise Exception('Either MISO or MOSI (or both) pins required.')
274 if self.state == 'IDLE':
275 self.find_clk_edge(miso, mosi, clk, cs)
277 raise Exception('Invalid state: %s' % self.state)