]>
Commit | Line | Data |
---|---|---|
6eb87578 | 1 | ## |
50bd5d25 | 2 | ## This file is part of the libsigrokdecode project. |
6eb87578 GM |
3 | ## |
4 | ## Copyright (C) 2011 Gareth McMullin <gareth@blacksphere.co.nz> | |
3eda7779 | 5 | ## Copyright (C) 2012-2013 Uwe Hermann <uwe@hermann-uwe.de> |
6eb87578 GM |
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 2 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, write to the Free Software | |
19 | ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |
20 | ## | |
ad2dc0de | 21 | |
156509ca UH |
22 | # SPI protocol decoder |
23 | ||
677d597b | 24 | import sigrokdecode as srd |
67e847fd | 25 | |
0702e0cf UH |
26 | ''' |
27 | Protocol output format: | |
28 | ||
29 | SPI packet: | |
30 | [<cmd>, <data1>, <data2>] | |
31 | ||
32 | Commands: | |
33 | - 'DATA': <data1> contains the MISO data, <data2> contains the MOSI data. | |
34 | The data is _usually_ 8 bits (but can also be fewer or more bits). | |
35 | Both data items are Python numbers, not strings. | |
36 | - 'CS CHANGE': <data1> is the old CS# pin value, <data2> is the new value. | |
37 | Both data items are Python numbers (0/1), not strings. | |
38 | ||
39 | Examples: | |
40 | ['CS-CHANGE', 1, 0] | |
41 | ['DATA', 0xff, 0x3a] | |
42 | ['DATA', 0x65, 0x00] | |
43 | ['CS-CHANGE', 0, 1] | |
44 | ''' | |
45 | ||
8a7ce2a3 | 46 | # Key: (CPOL, CPHA). Value: SPI mode. |
94bbdb9a UH |
47 | # Clock polarity (CPOL) = 0/1: Clock is low/high when inactive. |
48 | # Clock phase (CPHA) = 0/1: Data is valid on the leading/trailing clock edge. | |
c94c8c91 UH |
49 | spi_mode = { |
50 | (0, 0): 0, # Mode 0 | |
51 | (0, 1): 1, # Mode 1 | |
52 | (1, 0): 2, # Mode 2 | |
53 | (1, 1): 3, # Mode 3 | |
54 | } | |
55 | ||
677d597b | 56 | class Decoder(srd.Decoder): |
a2c2afd9 | 57 | api_version = 1 |
67e847fd | 58 | id = 'spi' |
2b7d0e2b | 59 | name = 'SPI' |
3d3da57d | 60 | longname = 'Serial Peripheral Interface' |
a465436e | 61 | desc = 'Full-duplex, synchronous, serial bus.' |
6eb87578 GM |
62 | license = 'gplv2+' |
63 | inputs = ['logic'] | |
64 | outputs = ['spi'] | |
6b5b91d2 | 65 | probes = [ |
4e570fa9 UH |
66 | {'id': 'miso', 'name': 'MISO', |
67 | 'desc': 'SPI MISO line (Master in, slave out)'}, | |
decde15e UH |
68 | {'id': 'mosi', 'name': 'MOSI', |
69 | 'desc': 'SPI MOSI line (Master out, slave in)'}, | |
6b5b91d2 UH |
70 | {'id': 'sck', 'name': 'CLK', 'desc': 'SPI clock line'}, |
71 | ] | |
efa64173 UH |
72 | optional_probes = [ |
73 | {'id': 'cs', 'name': 'CS#', 'desc': 'SPI chip-select line'}, | |
74 | ] | |
238b4080 | 75 | options = { |
94bbdb9a UH |
76 | 'cs_polarity': ['CS# polarity', 'active-low'], |
77 | 'cpol': ['Clock polarity', 0], | |
78 | 'cpha': ['Clock phase', 0], | |
79 | 'bitorder': ['Bit order within the SPI data', 'msb-first'], | |
c94c8c91 | 80 | 'wordsize': ['Word size of SPI data', 8], # 1-64? |
3eda7779 | 81 | 'format': ['Data format', 'hex'], |
238b4080 | 82 | } |
b1bb5eed | 83 | annotations = [ |
29f8bb7b UH |
84 | ['MISO/MOSI data', 'MISO/MOSI SPI data'], |
85 | ['MISO data', 'MISO SPI data'], | |
86 | ['MOSI data', 'MOSI SPI data'], | |
3eda7779 | 87 | ['Warnings', 'Human-readable warnings'], |
b1bb5eed | 88 | ] |
6eb87578 | 89 | |
3643fc3f | 90 | def __init__(self): |
c66baa8c | 91 | self.oldsck = 1 |
a10bfc48 | 92 | self.bitcount = 0 |
4917bb31 | 93 | self.mosidata = 0 |
d6bace96 | 94 | self.misodata = 0 |
6eb87578 | 95 | self.bytesreceived = 0 |
ec0afe27 | 96 | self.startsample = -1 |
d6bace96 | 97 | self.samplenum = -1 |
01329e88 | 98 | self.cs_was_deasserted_during_data_word = 0 |
3e3c0330 | 99 | self.oldcs = -1 |
2fcd7c22 | 100 | self.oldpins = None |
191ec8c5 | 101 | self.state = 'IDLE' |
6eb87578 | 102 | |
3643fc3f | 103 | def start(self, metadata): |
d6bace96 | 104 | self.out_proto = self.add(srd.OUTPUT_PROTO, 'spi') |
56202222 | 105 | self.out_ann = self.add(srd.OUTPUT_ANN, 'spi') |
3643fc3f | 106 | |
6eb87578 | 107 | def report(self): |
e100d51e | 108 | return 'SPI: %d bytes received' % self.bytesreceived |
6eb87578 | 109 | |
ec0afe27 UH |
110 | def putpw(self, data): |
111 | self.put(self.startsample, self.samplenum, self.out_proto, data) | |
112 | ||
113 | def putw(self, data): | |
114 | self.put(self.startsample, self.samplenum, self.out_ann, data) | |
115 | ||
191ec8c5 UH |
116 | def handle_bit(self, miso, mosi, sck, cs): |
117 | # If this is the first bit, save its sample number. | |
118 | if self.bitcount == 0: | |
119 | self.startsample = self.samplenum | |
efa64173 UH |
120 | if self.have_cs: |
121 | active_low = (self.options['cs_polarity'] == 'active-low') | |
122 | deasserted = cs if active_low else not cs | |
123 | if deasserted: | |
124 | self.cs_was_deasserted_during_data_word = 1 | |
2fcd7c22 | 125 | |
191ec8c5 | 126 | ws = self.options['wordsize'] |
d6bace96 | 127 | |
191ec8c5 UH |
128 | # Receive MOSI bit into our shift register. |
129 | if self.options['bitorder'] == 'msb-first': | |
130 | self.mosidata |= mosi << (ws - 1 - self.bitcount) | |
131 | else: | |
132 | self.mosidata |= mosi << self.bitcount | |
3e3c0330 | 133 | |
191ec8c5 UH |
134 | # Receive MISO bit into our shift register. |
135 | if self.options['bitorder'] == 'msb-first': | |
136 | self.misodata |= miso << (ws - 1 - self.bitcount) | |
137 | else: | |
138 | self.misodata |= miso << self.bitcount | |
c94c8c91 | 139 | |
191ec8c5 | 140 | self.bitcount += 1 |
1ea831e9 | 141 | |
191ec8c5 UH |
142 | # Continue to receive if not enough bits were received, yet. |
143 | if self.bitcount != ws: | |
144 | return | |
b1bb5eed | 145 | |
191ec8c5 UH |
146 | self.putpw(['DATA', self.mosidata, self.misodata]) |
147 | self.putw([0, ['%02X/%02X' % (self.mosidata, self.misodata)]]) | |
148 | self.putw([1, ['%02X' % self.misodata]]) | |
149 | self.putw([2, ['%02X' % self.mosidata]]) | |
b1bb5eed | 150 | |
191ec8c5 UH |
151 | if self.cs_was_deasserted_during_data_word: |
152 | self.putw([3, ['CS# was deasserted during this data word!']]) | |
153 | ||
154 | # Reset decoder state. | |
efa64173 | 155 | self.mosidata = self.misodata = self.bitcount = 0 |
191ec8c5 UH |
156 | |
157 | # Keep stats for summary. | |
158 | self.bytesreceived += 1 | |
159 | ||
160 | def find_clk_edge(self, miso, mosi, sck, cs): | |
efa64173 | 161 | if self.have_cs and self.oldcs != cs: |
191ec8c5 UH |
162 | # Send all CS# pin value changes. |
163 | self.put(self.samplenum, self.samplenum, self.out_proto, | |
164 | ['CS-CHANGE', self.oldcs, cs]) | |
165 | self.oldcs = cs | |
efa64173 UH |
166 | # Reset decoder state when CS# changes (and the CS# pin is used). |
167 | self.mosidata = self.misodata = self.bitcount= 0 | |
191ec8c5 UH |
168 | |
169 | # Ignore sample if the clock pin hasn't changed. | |
170 | if sck == self.oldsck: | |
171 | return | |
b1bb5eed | 172 | |
191ec8c5 | 173 | self.oldsck = sck |
b1bb5eed | 174 | |
191ec8c5 UH |
175 | # Sample data on rising/falling clock edge (depends on mode). |
176 | mode = spi_mode[self.options['cpol'], self.options['cpha']] | |
177 | if mode == 0 and sck == 0: # Sample on rising clock edge | |
178 | return | |
179 | elif mode == 1 and sck == 1: # Sample on falling clock edge | |
180 | return | |
181 | elif mode == 2 and sck == 1: # Sample on falling clock edge | |
182 | return | |
183 | elif mode == 3 and sck == 0: # Sample on rising clock edge | |
184 | return | |
185 | ||
186 | # Found the correct clock edge, now get the SPI bit(s). | |
187 | self.handle_bit(miso, mosi, sck, cs) | |
188 | ||
189 | def decode(self, ss, es, data): | |
190 | # TODO: Either MISO or MOSI could be optional. CS# is optional. | |
191 | for (self.samplenum, pins) in data: | |
01329e88 | 192 | |
191ec8c5 UH |
193 | # Ignore identical samples early on (for performance reasons). |
194 | if self.oldpins == pins: | |
195 | continue | |
196 | self.oldpins, (miso, mosi, sck, cs) = pins, pins | |
efa64173 | 197 | self.have_cs = (cs in (0, 1)) |
b1bb5eed | 198 | |
191ec8c5 UH |
199 | # State machine. |
200 | if self.state == 'IDLE': | |
201 | self.find_clk_edge(miso, mosi, sck, cs) | |
202 | else: | |
203 | raise Exception('Invalid state: %s' % self.state) | |
ad2dc0de | 204 |