e226c24a41905ea55728b75bdc7d6278cc4be3d5
[libsigrokdecode.git] / decoders / i2c / pd.py
1 ##
2 ## This file is part of the libsigrokdecode project.
3 ##
4 ## Copyright (C) 2010-2016 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 # TODO: Look into arbitration, collision detection, clock synchronisation, etc.
22 # TODO: Implement support for 10bit slave addresses.
23 # TODO: Implement support for inverting SDA/SCL levels (0->1 and 1->0).
24 # TODO: Implement support for detecting various bus errors.
25
26 import sigrokdecode as srd
27
28 '''
29 OUTPUT_PYTHON format:
30
31 Packet:
32 [<ptype>, <pdata>]
33
34 <ptype>:
35  - 'START' (START condition)
36  - 'START REPEAT' (Repeated START condition)
37  - 'ADDRESS READ' (Slave address, read)
38  - 'ADDRESS WRITE' (Slave address, write)
39  - 'DATA READ' (Data, read)
40  - 'DATA WRITE' (Data, write)
41  - 'STOP' (STOP condition)
42  - 'ACK' (ACK bit)
43  - 'NACK' (NACK bit)
44  - 'BITS' (<pdata>: list of data/address bits and their ss/es numbers)
45
46 <pdata> is the data or address byte associated with the 'ADDRESS*' and 'DATA*'
47 command. Slave addresses do not include bit 0 (the READ/WRITE indication bit).
48 For example, a slave address field could be 0x51 (instead of 0xa2).
49 For 'START', 'START REPEAT', 'STOP', 'ACK', and 'NACK' <pdata> is None.
50 '''
51
52 # CMD: [annotation-type-index, long annotation, short annotation]
53 proto = {
54     'START':           [0, 'Start',         'S'],
55     'START REPEAT':    [1, 'Start repeat',  'Sr'],
56     'STOP':            [2, 'Stop',          'P'],
57     'ACK':             [3, 'ACK',           'A'],
58     'NACK':            [4, 'NACK',          'N'],
59     'BIT':             [5, 'Bit',           'B'],
60     'ADDRESS READ':    [6, 'Address read',  'AR'],
61     'ADDRESS WRITE':   [7, 'Address write', 'AW'],
62     'DATA READ':       [8, 'Data read',     'DR'],
63     'DATA WRITE':      [9, 'Data write',    'DW'],
64 }
65
66 class SamplerateError(Exception):
67     pass
68
69 class Decoder(srd.Decoder):
70     api_version = 3
71     id = 'i2c'
72     name = 'I²C'
73     longname = 'Inter-Integrated Circuit'
74     desc = 'Two-wire, multi-master, serial bus.'
75     license = 'gplv2+'
76     inputs = ['logic']
77     outputs = ['i2c']
78     channels = (
79         {'id': 'scl', 'name': 'SCL', 'desc': 'Serial clock line'},
80         {'id': 'sda', 'name': 'SDA', 'desc': 'Serial data line'},
81     )
82     options = (
83         {'id': 'address_format', 'desc': 'Displayed slave address format',
84             'default': 'shifted', 'values': ('shifted', 'unshifted')},
85     )
86     annotations = (
87         ('start', 'Start condition'),
88         ('repeat-start', 'Repeat start condition'),
89         ('stop', 'Stop condition'),
90         ('ack', 'ACK'),
91         ('nack', 'NACK'),
92         ('bit', 'Data/address bit'),
93         ('address-read', 'Address read'),
94         ('address-write', 'Address write'),
95         ('data-read', 'Data read'),
96         ('data-write', 'Data write'),
97         ('warnings', 'Human-readable warnings'),
98     )
99     annotation_rows = (
100         ('bits', 'Bits', (5,)),
101         ('addr-data', 'Address/Data', (0, 1, 2, 3, 4, 6, 7, 8, 9)),
102         ('warnings', 'Warnings', (10,)),
103     )
104     binary = (
105         ('address-read', 'Address read'),
106         ('address-write', 'Address write'),
107         ('data-read', 'Data read'),
108         ('data-write', 'Data write'),
109     )
110
111     def __init__(self):
112         self.samplerate = None
113         self.ss = self.es = self.ss_byte = -1
114         self.bitcount = 0
115         self.databyte = 0
116         self.wr = -1
117         self.is_repeat_start = 0
118         self.state = 'FIND START'
119         self.pdu_start = None
120         self.pdu_bits = 0
121         self.bits = []
122
123     def metadata(self, key, value):
124         if key == srd.SRD_CONF_SAMPLERATE:
125             self.samplerate = value
126
127     def start(self):
128         self.out_python = self.register(srd.OUTPUT_PYTHON)
129         self.out_ann = self.register(srd.OUTPUT_ANN)
130         self.out_binary = self.register(srd.OUTPUT_BINARY)
131         self.out_bitrate = self.register(srd.OUTPUT_META,
132                 meta=(int, 'Bitrate', 'Bitrate from Start bit to Stop bit'))
133
134         # Assume that the initial SCL/SDA pin state is high (logic 1).
135         # This is a good default, since both pins have pullups as per spec.
136         self.initial_pins = [1, 1]
137
138     def putx(self, data):
139         self.put(self.ss, self.es, self.out_ann, data)
140
141     def putp(self, data):
142         self.put(self.ss, self.es, self.out_python, data)
143
144     def putb(self, data):
145         self.put(self.ss, self.es, self.out_binary, data)
146
147     def handle_start(self, pins):
148         self.ss, self.es = self.samplenum, self.samplenum
149         self.pdu_start = self.samplenum
150         self.pdu_bits = 0
151         cmd = 'START REPEAT' if (self.is_repeat_start == 1) else 'START'
152         self.putp([cmd, None])
153         self.putx([proto[cmd][0], proto[cmd][1:]])
154         self.state = 'FIND ADDRESS'
155         self.bitcount = self.databyte = 0
156         self.is_repeat_start = 1
157         self.wr = -1
158         self.bits = []
159
160     # Gather 8 bits of data plus the ACK/NACK bit.
161     def handle_address_or_data(self, pins):
162         scl, sda = pins
163         self.pdu_bits += 1
164
165         # Address and data are transmitted MSB-first.
166         self.databyte <<= 1
167         self.databyte |= sda
168
169         # Remember the start of the first data/address bit.
170         if self.bitcount == 0:
171             self.ss_byte = self.samplenum
172
173         # Store individual bits and their start/end samplenumbers.
174         # In the list, index 0 represents the LSB (I²C transmits MSB-first).
175         self.bits.insert(0, [sda, self.samplenum, self.samplenum])
176         if self.bitcount > 0:
177             self.bits[1][2] = self.samplenum
178         if self.bitcount == 7:
179             self.bitwidth = self.bits[1][2] - self.bits[2][2]
180             self.bits[0][2] += self.bitwidth
181
182         # Return if we haven't collected all 8 + 1 bits, yet.
183         if self.bitcount < 7:
184             self.bitcount += 1
185             return
186
187         d = self.databyte
188         if self.state == 'FIND ADDRESS':
189             # The READ/WRITE bit is only in address bytes, not data bytes.
190             self.wr = 0 if (self.databyte & 1) else 1
191             if self.options['address_format'] == 'shifted':
192                 d = d >> 1
193
194         bin_class = -1
195         if self.state == 'FIND ADDRESS' and self.wr == 1:
196             cmd = 'ADDRESS WRITE'
197             bin_class = 1
198         elif self.state == 'FIND ADDRESS' and self.wr == 0:
199             cmd = 'ADDRESS READ'
200             bin_class = 0
201         elif self.state == 'FIND DATA' and self.wr == 1:
202             cmd = 'DATA WRITE'
203             bin_class = 3
204         elif self.state == 'FIND DATA' and self.wr == 0:
205             cmd = 'DATA READ'
206             bin_class = 2
207
208         self.ss, self.es = self.ss_byte, self.samplenum + self.bitwidth
209
210         self.putp(['BITS', self.bits])
211         self.putp([cmd, d])
212
213         self.putb([bin_class, bytes([d])])
214
215         for bit in self.bits:
216             self.put(bit[1], bit[2], self.out_ann, [5, ['%d' % bit[0]]])
217
218         if cmd.startswith('ADDRESS'):
219             self.ss, self.es = self.samplenum, self.samplenum + self.bitwidth
220             w = ['Write', 'Wr', 'W'] if self.wr else ['Read', 'Rd', 'R']
221             self.putx([proto[cmd][0], w])
222             self.ss, self.es = self.ss_byte, self.samplenum
223
224         self.putx([proto[cmd][0], ['%s: %02X' % (proto[cmd][1], d),
225                    '%s: %02X' % (proto[cmd][2], d), '%02X' % d]])
226
227         # Done with this packet.
228         self.bitcount = self.databyte = 0
229         self.bits = []
230         self.state = 'FIND ACK'
231
232     def get_ack(self, pins):
233         scl, sda = pins
234         self.ss, self.es = self.samplenum, self.samplenum + self.bitwidth
235         cmd = 'NACK' if (sda == 1) else 'ACK'
236         self.putp([cmd, None])
237         self.putx([proto[cmd][0], proto[cmd][1:]])
238         # There could be multiple data bytes in a row, so either find
239         # another data byte or a STOP condition next.
240         self.state = 'FIND DATA'
241
242     def handle_stop(self, pins):
243         # Meta bitrate
244         elapsed = 1 / float(self.samplerate) * (self.samplenum - self.pdu_start + 1)
245         bitrate = int(1 / elapsed * self.pdu_bits)
246         self.put(self.ss_byte, self.samplenum, self.out_bitrate, bitrate)
247
248         cmd = 'STOP'
249         self.ss, self.es = self.samplenum, self.samplenum
250         self.putp([cmd, None])
251         self.putx([proto[cmd][0], proto[cmd][1:]])
252         self.state = 'FIND START'
253         self.is_repeat_start = 0
254         self.wr = -1
255         self.bits = []
256
257     def decode(self):
258         if not self.samplerate:
259             raise SamplerateError('Cannot decode without samplerate.')
260
261         self.wait({})
262
263         while True:
264             # State machine.
265             if self.state == 'FIND START':
266                 # Wait for a START condition (S): SCL = high, SDA = falling.
267                 self.handle_start(self.wait({0: 'h', 1: 'f'}))
268             elif self.state == 'FIND ADDRESS':
269                 # Wait for a data bit: SCL = rising.
270                 self.handle_address_or_data(self.wait({0: 'r'}))
271             elif self.state == 'FIND DATA':
272                 # Wait for any of the following conditions (or combinations):
273                 #  a) Data sampling of receiver: SCL = rising, and/or
274                 #  b) START condition (S): SCL = high, SDA = falling, and/or
275                 #  c) STOP condition (P): SCL = high, SDA = rising
276                 conds = [{0: 'r'}, {0: 'h', 1: 'f'}, {0: 'h', 1: 'r'}]
277                 pins = self.wait(conds[:]) # TODO
278
279                 # Check which of the condition(s) matched and handle them.
280                 if self.matched[0]:
281                     self.handle_address_or_data(pins)
282                 elif self.matched[1]:
283                     self.handle_start(pins)
284                 elif self.matched[2]:
285                     self.handle_stop(pins)
286             elif self.state == 'FIND ACK':
287                 # Wait for a data/ack bit: SCL = rising.
288                 self.get_ack(self.wait({0: 'r'}))