srd: Use 'import sigrokdecode as srd' for brevity.
[sigrok:sigrok.git] / libsigrokdecode / 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 # TODO: I2C address of slaves.
69 # TODO: Handle multiple different I2C devices on same bus
70 #       -> we need to decode multiple protocols at the same time.
71
72 #
73 # I2C protocol output format:
74 #
75 # The protocol output consists of a (Python) list of I2C "packets", each of
76 # which is of the form
77 #
78 #        [ _i2c_command_, _data_, _ack_bit_ ]
79 #
80 # _i2c_command_ is one of:
81 #   - 'START' (START condition)
82 #   - 'START_REPEAT' (Repeated START)
83 #   - 'ADDRESS_READ' (Address, read)
84 #   - 'ADDRESS_WRITE' (Address, write)
85 #   - 'DATA_READ' (Data, read)
86 #   - 'DATA_WRITE' (Data, write)
87 #   - 'STOP' (STOP condition)
88 #
89 # _data_ is the data or address byte associated with the ADDRESS_* and DATA_*
90 # command. For START, START_REPEAT and STOP, this is None.
91 #
92 # _ack_bit_ is either 'ACK' or 'NACK', but may also be None.
93 #
94 #
95
96 import sigrokdecode as srd
97
98 # annotation feed formats
99 ANN_SHIFTED       = 0
100 ANN_SHIFTED_SHORT = 1
101 ANN_RAW           = 2
102
103 # values are verbose and short annotation, respectively
104 protocol = {
105     'START':           ['START',        'S'],
106     'START_REPEAT':    ['START REPEAT', 'Sr'],
107     'STOP':            ['STOP',         'P'],
108     'ACK':             ['ACK',          'A'],
109     'NACK':            ['NACK',         'N'],
110     'ADDRESS_READ':    ['ADDRESS READ', 'AR'],
111     'ADDRESS_WRITE':   ['ADDRESS WRITE','AW'],
112     'DATA_READ':       ['DATA READ',    'DR'],
113     'DATA_WRITE':      ['DATA WRITE',   'DW'],
114 }
115
116 # States
117 FIND_START = 0
118 FIND_ADDRESS = 1
119 FIND_DATA = 2
120
121
122 class Decoder(srd.Decoder):
123     id = 'i2c'
124     name = 'I2C'
125     longname = 'Inter-Integrated Circuit (I2C) bus'
126     desc = 'I2C is a two-wire, multi-master, serial bus.'
127     longdesc = '...'
128     author = 'Uwe Hermann'
129     email = 'uwe@hermann-uwe.de'
130     license = 'gplv2+'
131     inputs = ['logic']
132     outputs = ['i2c']
133     probes = [
134         {'id': 'scl', 'name': 'SCL', 'desc': 'Serial clock line'},
135         {'id': 'sda', 'name': 'SDA', 'desc': 'Serial data line'},
136     ]
137     options = {
138         'address-space': ['Address space (in bits)', 7],
139     }
140     annotations = [
141         # ANN_SHIFTED
142         ["7-bit shifted hex",
143          "Read/Write bit shifted out from the 8-bit i2c slave address"],
144         # ANN_SHIFTED_SHORT
145         ["7-bit shifted hex (short)",
146          "Read/Write bit shifted out from the 8-bit i2c slave address"],
147         # ANN_RAW
148         ["Raw hex", "Unaltered raw data"]
149     ]
150
151     def __init__(self, **kwargs):
152         self.out_proto = None
153         self.out_ann = None
154         self.samplecnt = 0
155         self.bitcount = 0
156         self.databyte = 0
157         self.wr = -1
158         self.startsample = -1
159         self.is_repeat_start = 0
160         self.state = FIND_START
161         self.oldscl = None
162         self.oldsda = None
163
164     def start(self, metadata):
165         self.out_proto = self.add(srd.SRD_OUTPUT_PROTO, 'i2c')
166         self.out_ann = self.add(srd.SRD_OUTPUT_ANN, 'i2c')
167
168     def report(self):
169         pass
170
171     def is_start_condition(self, scl, sda):
172         """START condition (S): SDA = falling, SCL = high"""
173         if (self.oldsda == 1 and sda == 0) and scl == 1:
174             return True
175         return False
176
177     def is_data_bit(self, scl, sda):
178         """Data sampling of receiver: SCL = rising"""
179         if self.oldscl == 0 and scl == 1:
180             return True
181         return False
182
183     def is_stop_condition(self, scl, sda):
184         """STOP condition (P): SDA = rising, SCL = high"""
185         if (self.oldsda == 0 and sda == 1) and scl == 1:
186             return True
187         return False
188
189     def found_start(self, scl, sda):
190         if self.is_repeat_start == 1:
191             cmd = 'START_REPEAT'
192         else:
193             cmd = 'START'
194         self.put(self.out_proto, [ cmd, None, None ])
195         self.put(self.out_ann, [ ANN_SHIFTED, [protocol[cmd][0]] ])
196         self.put(self.out_ann, [ ANN_SHIFTED_SHORT, [protocol[cmd][1]] ])
197
198         self.state = FIND_ADDRESS
199         self.bitcount = self.databyte = 0
200         self.is_repeat_start = 1
201         self.wr = -1
202
203     def found_address_or_data(self, scl, sda):
204         """Gather 8 bits of data plus the ACK/NACK bit."""
205
206         if self.startsample == -1:
207             # TODO: should be samplenum, as received from the feed
208             self.startsample = self.samplecnt
209         self.bitcount += 1
210
211         # Address and data are transmitted MSB-first.
212         self.databyte <<= 1
213         self.databyte |= sda
214
215         # Return if we haven't collected all 8 + 1 bits, yet.
216         if self.bitcount != 9:
217             return []
218
219         # send raw output annotation before we start shifting out
220         # read/write and ack/nack bits
221         self.put(self.out_ann, [ANN_RAW, ["0x%.2x" % self.databyte]])
222
223         # We received 8 address/data bits and the ACK/NACK bit.
224         self.databyte >>= 1 # Shift out unwanted ACK/NACK bit here.
225
226         if self.state == FIND_ADDRESS:
227             # The READ/WRITE bit is only in address bytes, not data bytes.
228             if self.databyte & 1:
229                 self.wr = 0
230             else:
231                 self.wr = 1
232             d = self.databyte >> 1
233         elif self.state == FIND_DATA:
234             d = self.databyte
235         else:
236             # TODO: Error?
237             pass
238
239         # last bit that came in was the ACK/NACK bit (1 = NACK)
240         if sda == 1:
241             ack_bit = 'NACK'
242         else:
243             ack_bit = 'ACK'
244
245         # TODO: Simplify.
246         if self.state == FIND_ADDRESS and self.wr == 1:
247             cmd = 'ADDRESS_WRITE'
248         elif self.state == FIND_ADDRESS and self.wr == 0:
249             cmd = 'ADDRESS_READ'
250         elif self.state == FIND_DATA and self.wr == 1:
251             cmd = 'DATA_WRITE'
252         elif self.state == FIND_DATA and self.wr == 0:
253             cmd = 'DATA_READ'
254         self.put(self.out_proto, [ cmd, d, ack_bit ] )
255         self.put(self.out_ann, [ANN_SHIFTED, [
256                 "%s" % protocol[cmd][0],
257                 "0x%02x" % d,
258                 "%s" % protocol[ack_bit][0]]
259             ] )
260         self.put(self.out_ann, [ANN_SHIFTED_SHORT, [
261                 "%s" % protocol[cmd][1],
262                 "0x%02x" % d,
263                 "%s" % protocol[ack_bit][1]]
264             ] )
265
266         self.bitcount = self.databyte = 0
267         self.startsample = -1
268
269         if self.state == FIND_ADDRESS:
270             self.state = FIND_DATA
271         elif self.state == FIND_DATA:
272             # There could be multiple data bytes in a row.
273             # So, either find a STOP condition or another data byte next.
274             pass
275
276     def found_stop(self, scl, sda):
277         self.put(self.out_proto, [ 'STOP', None, None ])
278         self.put(self.out_ann, [ ANN_SHIFTED, [protocol['STOP'][0]] ])
279         self.put(self.out_ann, [ ANN_SHIFTED_SHORT, [protocol['STOP'][1]] ])
280
281         self.state = FIND_START
282         self.is_repeat_start = 0
283         self.wr = -1
284
285     def put(self, output_id, data):
286         # inject sample range into the call up to sigrok
287         # TODO: 0-0 sample range for now
288         super(Decoder, self).put(0, 0, output_id, data)
289
290     def decode(self, timeoffset, duration, data):
291         for samplenum, (scl, sda) in data:
292             self.samplecnt += 1
293
294             # First sample: Save SCL/SDA value.
295             if self.oldscl == None:
296                 self.oldscl = scl
297                 self.oldsda = sda
298                 continue
299
300             # TODO: Wait until the bus is idle (SDA = SCL = 1) first?
301
302             # State machine.
303             if self.state == FIND_START:
304                 if self.is_start_condition(scl, sda):
305                     self.found_start(scl, sda)
306             elif self.state == FIND_ADDRESS:
307                 if self.is_data_bit(scl, sda):
308                     self.found_address_or_data(scl, sda)
309             elif self.state == FIND_DATA:
310                 if self.is_data_bit(scl, sda):
311                     self.found_address_or_data(scl, sda)
312                 elif self.is_start_condition(scl, sda):
313                     self.found_start(scl, sda)
314                 elif self.is_stop_condition(scl, sda):
315                     self.found_stop(scl, sda)
316             else:
317                 # TODO: Error?
318                 pass
319
320             # Save current SDA/SCL values for the next round.
321             self.oldscl = scl
322             self.oldsda = sda
323