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
25 Protocol output format:
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 - 'CS CHANGE': <data1> is the old CS# pin value, <data2> is the new value.
36 Both data items are Python numbers (0/1), not strings.
47 # Key: (CPOL, CPHA). Value: SPI mode.
48 # Clock polarity (CPOL) = 0/1: Clock is low/high when inactive.
49 # Clock phase (CPHA) = 0/1: Data is valid on the leading/trailing clock edge.
57 class Decoder(srd.Decoder):
61 longname = 'Serial Peripheral Interface'
62 desc = 'Full-duplex, synchronous, serial bus.'
67 {'id': 'sck', 'name': 'CLK', 'desc': 'SPI clock line'},
70 {'id': 'miso', 'name': 'MISO',
71 'desc': 'SPI MISO line (master in, slave out)'},
72 {'id': 'mosi', 'name': 'MOSI',
73 'desc': 'SPI MOSI line (master out, slave in)'},
74 {'id': 'cs', 'name': 'CS#', 'desc': 'SPI chip-select line'},
77 'cs_polarity': ['CS# polarity', 'active-low'],
78 'cpol': ['Clock polarity', 0],
79 'cpha': ['Clock phase', 0],
80 'bitorder': ['Bit order within the SPI data', 'msb-first'],
81 'wordsize': ['Word size of SPI data', 8], # 1-64?
82 'format': ['Data format', 'hex'],
85 ['miso-data', 'MISO SPI data'],
86 ['mosi-data', 'MOSI SPI data'],
87 ['warnings', 'Human-readable warnings'],
91 self.samplerate = None
98 self.cs_was_deasserted_during_data_word = 0
102 self.have_miso = None
103 self.have_mosi = None
106 def metadata(self, key, value):
107 if key == srd.SRD_CONF_SAMPLERATE:
108 self.samplerate = value
111 self.out_proto = self.register(srd.OUTPUT_PYTHON)
112 self.out_ann = self.register(srd.OUTPUT_ANN)
113 self.out_bitrate = self.register(srd.OUTPUT_META,
114 meta=(int, 'Bitrate', 'Bitrate during transfers'))
116 def putpw(self, data):
117 self.put(self.startsample, self.samplenum, self.out_proto, data)
119 def putw(self, data):
120 self.put(self.startsample, self.samplenum, self.out_ann, data)
122 def handle_bit(self, miso, mosi, sck, cs):
123 # If this is the first bit, save its sample number.
124 if self.bitcount == 0:
125 self.startsample = self.samplenum
127 active_low = (self.options['cs_polarity'] == 'active-low')
128 deasserted = cs if active_low else not cs
130 self.cs_was_deasserted_during_data_word = 1
132 ws = self.options['wordsize']
134 # Receive MOSI bit into our shift register.
136 if self.options['bitorder'] == 'msb-first':
137 self.mosidata |= mosi << (ws - 1 - self.bitcount)
139 self.mosidata |= mosi << self.bitcount
141 # Receive MISO bit into our shift register.
143 if self.options['bitorder'] == 'msb-first':
144 self.misodata |= miso << (ws - 1 - self.bitcount)
146 self.misodata |= miso << self.bitcount
150 # Continue to receive if not enough bits were received, yet.
151 if self.bitcount != ws:
154 si = self.mosidata if self.have_mosi else None
155 so = self.misodata if self.have_miso else None
157 # Pass MOSI and MISO to the next PD up the stack.
158 self.putpw(['DATA', si, so])
162 self.putw([0, ['%02X' % self.misodata]])
164 self.putw([1, ['%02X' % self.mosidata]])
167 elapsed = 1 / float(self.samplerate) * (self.samplenum - self.startsample + 1)
168 bitrate = int(1 / elapsed * self.options['wordsize'])
169 self.put(self.startsample, self.samplenum, self.out_bitrate, bitrate)
171 if self.have_cs and self.cs_was_deasserted_during_data_word:
172 self.putw([2, ['CS# was deasserted during this data word!']])
174 # Reset decoder state.
175 self.misodata = 0 if self.have_miso else None
176 self.mosidata = 0 if self.have_mosi else None
179 def find_clk_edge(self, miso, mosi, sck, cs):
180 if self.have_cs and self.oldcs != cs:
181 # Send all CS# pin value changes.
182 self.put(self.samplenum, self.samplenum, self.out_proto,
183 ['CS-CHANGE', self.oldcs, cs])
185 # Reset decoder state when CS# changes (and the CS# pin is used).
186 self.misodata = 0 if self.have_miso else None
187 self.mosidata = 0 if self.have_mosi else None
190 # Ignore sample if the clock pin hasn't changed.
191 if sck == self.oldsck:
196 # Sample data on rising/falling clock edge (depends on mode).
197 mode = spi_mode[self.options['cpol'], self.options['cpha']]
198 if mode == 0 and sck == 0: # Sample on rising clock edge
200 elif mode == 1 and sck == 1: # Sample on falling clock edge
202 elif mode == 2 and sck == 1: # Sample on falling clock edge
204 elif mode == 3 and sck == 0: # Sample on rising clock edge
207 # Found the correct clock edge, now get the SPI bit(s).
208 self.handle_bit(miso, mosi, sck, cs)
210 def decode(self, ss, es, data):
211 if self.samplerate is None:
212 raise Exception("Cannot decode without samplerate.")
213 # Either MISO or MOSI can be omitted (but not both). CS# is optional.
214 for (self.samplenum, pins) in data:
216 # Ignore identical samples early on (for performance reasons).
217 if self.oldpins == pins:
219 self.oldpins, (sck, miso, mosi, cs) = pins, pins
220 self.have_miso = (miso in (0, 1))
221 self.have_mosi = (mosi in (0, 1))
222 self.have_cs = (cs in (0, 1))
225 if self.state == 'IDLE':
226 self.find_clk_edge(miso, mosi, sck, cs)
228 raise Exception('Invalid state: %s' % self.state)