9ff89c9755993c797fc54ee9e34f475c92a525e0
[libsigrokdecode.git] / decoders / i2c.py
1 ##
2 ## This file is part of the sigrok project.
3 ##
4 ## Copyright (C) 2010-2011 Uwe Hermann <uwe@hermann-uwe.de>
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 #
22 # I2C protocol decoder
23 #
24
25 #
26 # The Inter-Integrated Circuit (I2C) bus is a bidirectional, multi-master
27 # bus using two signals (SCL = serial clock line, SDA = serial data line).
28 #
29 # There can be many devices on the same bus. Each device can potentially be
30 # master or slave (and that can change during runtime). Both slave and master
31 # can potentially play the transmitter or receiver role (this can also
32 # change at runtime).
33 #
34 # Possible maximum data rates:
35 #  - Standard mode: 100 kbit/s
36 #  - Fast mode: 400 kbit/s
37 #  - Fast-mode Plus: 1 Mbit/s
38 #  - High-speed mode: 3.4 Mbit/s
39 #
40 # START condition (S): SDA = falling, SCL = high
41 # Repeated START condition (Sr): same as S
42 # Data bit sampling: SCL = rising
43 # STOP condition (P): SDA = rising, SCL = high
44 #
45 # All data bytes on SDA are exactly 8 bits long (transmitted MSB-first).
46 # Each byte has to be followed by a 9th ACK/NACK bit. If that bit is low,
47 # that indicates an ACK, if it's high that indicates a NACK.
48 #
49 # After the first START condition, a master sends the device address of the
50 # slave it wants to talk to. Slave addresses are 7 bits long (MSB-first).
51 # After those 7 bits, a data direction bit is sent. If the bit is low that
52 # indicates a WRITE operation, if it's high that indicates a READ operation.
53 #
54 # Later an optional 10bit slave addressing scheme was added.
55 #
56 # Documentation:
57 # http://www.nxp.com/acrobat/literature/9398/39340011.pdf (v2.1 spec)
58 # http://www.nxp.com/acrobat/usermanuals/UM10204_3.pdf (v3 spec)
59 # http://en.wikipedia.org/wiki/I2C
60 #
61
62 # TODO: Look into arbitration, collision detection, clock synchronisation, etc.
63 # TODO: Handle clock stretching.
64 # TODO: Handle combined messages / repeated START.
65 # TODO: Implement support for 7bit and 10bit slave addresses.
66 # TODO: Implement support for inverting SDA/SCL levels (0->1 and 1->0).
67 # TODO: Implement support for detecting various bus errors.
68
69 #
70 # I2C output format:
71 #
72 # The output consists of a (Python) list of I2C "packets", each of which
73 # has an (implicit) index number (its index in the list).
74 # Each packet consists of a Python dict with certain key/value pairs.
75 #
76 # TODO: Make this a list later instead of a dict?
77 #
78 # 'type': (string)
79 #   - 'S' (START condition)
80 #   - 'Sr' (Repeated START)
81 #   - 'AR' (Address, read)
82 #   - 'AW' (Address, write)
83 #   - 'DR' (Data, read)
84 #   - 'DW' (Data, write)
85 #   - 'P' (STOP condition)
86 # 'range': (tuple of 2 integers, the min/max samplenumber of this range)
87 #   - (min, max)
88 #   - min/max can also be identical.
89 # 'data': (actual data as integer ???) TODO: This can be very variable...
90 # 'ann': (string; additional annotations / comments)
91 #
92 # Example output:
93 # [{'type': 'S',  'range': (150, 160), 'data': None, 'ann': 'Foobar'},
94 #  {'type': 'AW', 'range': (200, 300), 'data': 0x50, 'ann': 'Slave 4'},
95 #  {'type': 'DW', 'range': (310, 370), 'data': 0x00, 'ann': 'Init cmd'},
96 #  {'type': 'AR', 'range': (500, 560), 'data': 0x50, 'ann': 'Get stat'},
97 #  {'type': 'DR', 'range': (580, 640), 'data': 0xfe, 'ann': 'OK'},
98 #  {'type': 'P',  'range': (650, 660), 'data': None, 'ann': None}]
99 #
100 # Possible other events:
101 #   - Error event in case protocol looks broken:
102 #     [{'type': 'ERROR', 'range': (min, max),
103 #      'data': TODO, 'ann': 'This is not a Microchip 24XX64 EEPROM'},
104 #     [{'type': 'ERROR', 'range': (min, max),
105 #      'data': TODO, 'ann': 'TODO'},
106 #   - TODO: Make list of possible errors accessible as metadata?
107 #
108 # TODO: I2C address of slaves.
109 # TODO: Handle multiple different I2C devices on same bus
110 #       -> we need to decode multiple protocols at the same time.
111 # TODO: range: Always contiguous? Splitted ranges? Multiple per event?
112 #
113
114 #
115 # I2C input format:
116 #
117 # signals:
118 # [[id, channel, description], ...] # TODO
119 #
120 # Example:
121 # {'id': 'SCL', 'ch': 5, 'desc': 'Serial clock line'}
122 # {'id': 'SDA', 'ch': 7, 'desc': 'Serial data line'}
123 # ...
124 #
125 # {'inbuf': [...],
126 #  'signals': [{'SCL': }]}
127 #
128
129 import sigrok
130
131 # symbols for i2c decoders up the stack
132 START           = 1
133 START_REPEAT    = 2
134 STOP            = 3
135 ACK             = 4
136 NACK            = 5
137 ADDRESS_READ    = 6
138 ADDRESS_WRITE   = 7
139 DATA_READ       = 8
140 DATA_WRITE      = 9
141
142 # States
143 FIND_START = 0
144 FIND_ADDRESS = 1
145 FIND_DATA = 2
146
147 class Sample():
148     def __init__(self, data):
149         self.data = data
150     def probe(self, probe):
151         s = ord(self.data[probe / 8]) & (1 << (probe % 8))
152         return True if s else False
153
154 def sampleiter(data, unitsize):
155     for i in range(0, len(data), unitsize):
156         yield(Sample(data[i:i+unitsize]))
157
158 class Decoder(sigrok.Decoder):
159     id = 'i2c'
160     name = 'I2C'
161     longname = 'Inter-Integrated Circuit (I2C) bus'
162     desc = 'I2C is a two-wire, multi-master, serial bus.'
163     longdesc = '...'
164     author = 'Uwe Hermann'
165     email = 'uwe@hermann-uwe.de'
166     license = 'gplv2+'
167     inputs = ['logic']
168     outputs = ['i2c']
169     probes = {
170         'scl': {'ch': 0, 'name': 'SCL', 'desc': 'Serial clock line'},
171         'sda': {'ch': 1, 'name': 'SDA', 'desc': 'Serial data line'},
172     }
173     options = {
174         'address-space': ['Address space (in bits)', 7],
175     }
176
177     def __init__(self, **kwargs):
178         self.probes = Decoder.probes.copy()
179         self.output_protocol = None
180         self.output_annotation = None
181
182         # TODO: Don't hardcode the number of channels.
183         self.channels = 8
184
185         self.samplenum = 0
186         self.bitcount = 0
187         self.databyte = 0
188         self.wr = -1
189         self.startsample = -1
190         self.is_repeat_start = 0
191
192         self.state = FIND_START
193
194         # Get the channel/probe number of the SCL/SDA signals.
195         self.scl_bit = self.probes['scl']['ch']
196         self.sda_bit = self.probes['sda']['ch']
197
198         self.oldscl = None
199         self.oldsda = None
200
201     def start(self, metadata):
202         self.unitsize = metadata["unitsize"]
203         self.output_protocol = self.output_new(2)
204         self.output_annotation = self.output_new(1)
205
206     def report(self):
207         pass
208
209     def is_start_condition(self, scl, sda):
210         """START condition (S): SDA = falling, SCL = high"""
211         if (self.oldsda == 1 and sda == 0) and scl == 1:
212             return True
213         return False
214
215     def is_data_bit(self, scl, sda):
216         """Data sampling of receiver: SCL = rising"""
217         if self.oldscl == 0 and scl == 1:
218             return True
219         return False
220
221     def is_stop_condition(self, scl, sda):
222         """STOP condition (P): SDA = rising, SCL = high"""
223         if (self.oldsda == 0 and sda == 1) and scl == 1:
224             return True
225         return False
226
227     def found_start(self, scl, sda):
228         if self.is_repeat_start == 1:
229             out_proto = [ START_REPEAT ]
230             out_ann = [ "START REPEAT" ]
231         else:
232             out_proto = [ START ]
233             out_ann = [ "START" ]
234         self.put(self.output_protocol, out_proto)
235         self.put(self.output_annotation, out_ann)
236
237         self.state = FIND_ADDRESS
238         self.bitcount = self.databyte = 0
239         self.is_repeat_start = 1
240         self.wr = -1
241
242     def found_address_or_data(self, scl, sda):
243         """Gather 8 bits of data plus the ACK/NACK bit."""
244
245         if self.startsample == -1:
246             self.startsample = self.samplenum
247         self.bitcount += 1
248
249         # Address and data are transmitted MSB-first.
250         self.databyte <<= 1
251         self.databyte |= sda
252
253         # Return if we haven't collected all 8 + 1 bits, yet.
254         if self.bitcount != 9:
255             return []
256
257         # We received 8 address/data bits and the ACK/NACK bit.
258         self.databyte >>= 1 # Shift out unwanted ACK/NACK bit here.
259
260         if self.state == FIND_ADDRESS:
261             d = self.databyte & 0xfe
262             # The READ/WRITE bit is only in address bytes, not data bytes.
263             self.wr = 1 if (self.databyte & 1) else 0
264         elif self.state == FIND_DATA:
265             d = self.databyte
266         else:
267             # TODO: Error?
268             pass
269
270         out_proto = []
271         out_ann = []
272         # TODO: Simplify.
273         if self.state == FIND_ADDRESS and self.wr == 1:
274             cmd = ADDRESS_WRITE
275             ann = 'ADDRESS WRITE'
276         elif self.state == FIND_ADDRESS and self.wr == 0:
277             cmd = ADDRESS_READ
278             ann = 'ADDRESS READ'
279         elif self.state == FIND_DATA and self.wr == 1:
280             cmd = DATA_WRITE
281             ann = 'DATA WRITE'
282         elif self.state == FIND_DATA and self.wr == 0:
283             cmd = DATA_READ
284             ann = 'DATA READ'
285         out_proto.append( [cmd, d] )
286         out_ann.append( ["%s" % ann, "0x%02x" % d] )
287
288         if sda == 1:
289             out_proto.append( [NACK] )
290             out_ann.append( ["NACK"] )
291         else:
292             out_proto.append( [ACK] )
293             out_ann.append( ["ACK"] )
294
295         self.put(self.output_protocol, out_proto)
296         self.put(self.output_annotation, out_ann)
297
298         self.bitcount = self.databyte = 0
299         self.startsample = -1
300
301         if self.state == FIND_ADDRESS:
302             self.state = FIND_DATA
303         elif self.state == FIND_DATA:
304             # There could be multiple data bytes in a row.
305             # So, either find a STOP condition or another data byte next.
306             pass
307
308     def found_stop(self, scl, sda):
309         self.put(self.output_protocol, [ STOP ])
310         self.put(self.output_annotation, [ "STOP" ])
311
312         self.state = FIND_START
313         self.is_repeat_start = 0
314         self.wr = -1
315
316     def decode(self, data):
317         """I2C protocol decoder"""
318
319         # We should accept a list of samples and iterate...
320         for sample in sampleiter(data['data'], self.unitsize):
321
322             # TODO: Eliminate the need for ord().
323             s = ord(sample.data)
324
325             # TODO: Start counting at 0 or 1?
326             self.samplenum += 1
327
328             # First sample: Save SCL/SDA value.
329             if self.oldscl == None:
330                 # Get SCL/SDA bit values (0/1 for low/high) of the first sample.
331                 self.oldscl = (s & (1 << self.scl_bit)) >> self.scl_bit
332                 self.oldsda = (s & (1 << self.sda_bit)) >> self.sda_bit
333                 continue
334
335             # Get SCL/SDA bit values (0/1 for low/high).
336             scl = (s & (1 << self.scl_bit)) >> self.scl_bit
337             sda = (s & (1 << self.sda_bit)) >> self.sda_bit
338
339             # TODO: Wait until the bus is idle (SDA = SCL = 1) first?
340
341             # State machine.
342             if self.state == FIND_START:
343                 if self.is_start_condition(scl, sda):
344                     self.found_start(scl, sda)
345             elif self.state == FIND_ADDRESS:
346                 if self.is_data_bit(scl, sda):
347                     self.found_address_or_data(scl, sda)
348             elif self.state == FIND_DATA:
349                 if self.is_data_bit(scl, sda):
350                     self.found_address_or_data(scl, sda)
351                 elif self.is_start_condition(scl, sda):
352                     self.found_start(scl, sda)
353                 elif self.is_stop_condition(scl, sda):
354                     self.found_stop(scl, sda)
355             else:
356                 # TODO: Error?
357                 pass
358
359             # Save current SDA/SCL values for the next round.
360             self.oldscl = scl
361             self.oldsda = sda
362
363