]> sigrok.org Git - libsigrokdecode.git/blame - decoders/onewire_link/pd.py
onewire_link: Add/use annotation helpers.
[libsigrokdecode.git] / decoders / onewire_link / pd.py
CommitLineData
9cfb16e8 1##
50bd5d25 2## This file is part of the libsigrokdecode project.
9cfb16e8
IJ
3##
4## Copyright (C) 2012 Iztok Jeras <iztok.jeras@gmail.com>
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
e7720d6c 21# 1-Wire protocol decoder (link layer)
9cfb16e8
IJ
22
23import sigrokdecode as srd
24
25class Decoder(srd.Decoder):
26 api_version = 1
27 id = 'onewire_link'
28 name = '1-Wire link layer'
e7720d6c 29 longname = '1-Wire serial communication bus (link layer)'
9cfb16e8
IJ
30 desc = 'Bidirectional, half-duplex, asynchronous serial bus.'
31 license = 'gplv2+'
32 inputs = ['logic']
33 outputs = ['onewire_link']
34 probes = [
3f302d51 35 {'id': 'owr', 'name': 'OWR', 'desc': '1-Wire signal line'},
9cfb16e8
IJ
36 ]
37 optional_probes = [
3f302d51 38 {'id': 'pwr', 'name': 'PWR', 'desc': '1-Wire power supply pin'},
9cfb16e8
IJ
39 ]
40 options = {
e7720d6c
UH
41 'overdrive': ['Overdrive', 1],
42 # Time options (specified in number of samplerate periods):
43 'cnt_normal_bit': ['Normal mode sample bit time', 0],
44 'cnt_normal_slot': ['Normal mode data slot time', 0],
45 'cnt_normal_presence': ['Normal mode sample presence time', 0],
46 'cnt_normal_reset': ['Normal mode reset time', 0],
47 'cnt_overdrive_bit': ['Overdrive mode sample bit time', 0],
48 'cnt_overdrive_slot': ['Overdrive mode data slot time', 0],
49 'cnt_overdrive_presence': ['Overdrive mode sample presence time', 0],
50 'cnt_overdrive_reset': ['Overdrive mode reset time', 0],
9cfb16e8
IJ
51 }
52 annotations = [
3f302d51
UH
53 ['Text', 'Human-readable text'],
54 ['Warnings', 'Human-readable warnings'],
9cfb16e8
IJ
55 ]
56
ddeb9b32
UH
57 def putm(self, data):
58 self.put(0, 0, self.out_ann, data)
59
60 def putpb(self, data):
61 self.put(self.fall, self.samplenum, self.out_proto, data)
62
63 def putb(self, data):
64 self.put(self.fall, self.samplenum, self.out_ann, data)
65
66 def putx(self, data):
67 self.put(self.fall, self.cnt_bit[self.overdrive], self.out_ann, data)
68
9cfb16e8 69 def __init__(self, **kwargs):
9cfb16e8 70 self.samplenum = 0
e7720d6c 71 self.state = 'WAIT FOR FALLING EDGE'
9cfb16e8 72 self.present = 0
e7720d6c 73 self.bit = 0
99f5f3b5
IJ
74 self.bit_cnt = 0
75 self.command = 0
9cfb16e8 76 self.overdrive = 0
e7720d6c
UH
77 self.fall = 0
78 self.rise = 0
9cfb16e8
IJ
79
80 def start(self, metadata):
81 self.out_proto = self.add(srd.OUTPUT_PROTO, 'onewire_link')
e7720d6c 82 self.out_ann = self.add(srd.OUTPUT_ANN, 'onewire_link')
9cfb16e8 83
9cfb16e8 84 self.samplerate = metadata['samplerate']
e7720d6c
UH
85
86 # Check if samplerate is appropriate.
87 if self.options['overdrive']:
e7720d6c 88 if self.samplerate < 2000000:
ddeb9b32
UH
89 self.putm([1, ['Sampling rate is too low. Must be above ' +
90 '2MHz for proper overdrive mode decoding.']])
e7720d6c 91 elif self.samplerate < 5000000:
ddeb9b32
UH
92 self.putm([1, ['Sampling rate is suggested to be above 5MHz ' +
93 'for proper overdrive mode decoding.']])
9cfb16e8 94 else:
e7720d6c 95 if self.samplerate < 400000:
ddeb9b32
UH
96 self.putm([1, ['Sampling rate is too low. Must be above ' +
97 '400kHz for proper normal mode decoding.']])
9cfb16e8 98 elif (self.samplerate < 1000000):
ddeb9b32
UH
99 self.putm([1, ['Sampling rate is suggested to be above ' +
100 '1MHz for proper normal mode decoding.']])
9cfb16e8 101
e7720d6c
UH
102 # The default 1-Wire time base is 30us. This is used to calculate
103 # sampling times.
104 samplerate = float(self.samplerate)
105 if self.options['cnt_normal_bit']:
9cfb16e8
IJ
106 self.cnt_normal_bit = self.options['cnt_normal_bit']
107 else:
e7720d6c
UH
108 self.cnt_normal_bit = int(samplerate * 0.000015) - 1 # 15ns
109 if self.options['cnt_normal_slot']:
671cc300
IJ
110 self.cnt_normal_slot = self.options['cnt_normal_slot']
111 else:
e7720d6c
UH
112 self.cnt_normal_slot = int(samplerate * 0.000060) - 1 # 60ns
113 if self.options['cnt_normal_presence']:
9cfb16e8
IJ
114 self.cnt_normal_presence = self.options['cnt_normal_presence']
115 else:
e7720d6c
UH
116 self.cnt_normal_presence = int(samplerate * 0.000075) - 1 # 75ns
117 if self.options['cnt_normal_reset']:
9cfb16e8
IJ
118 self.cnt_normal_reset = self.options['cnt_normal_reset']
119 else:
e7720d6c
UH
120 self.cnt_normal_reset = int(samplerate * 0.000480) - 1 # 480ns
121 if self.options['cnt_overdrive_bit']:
9cfb16e8
IJ
122 self.cnt_overdrive_bit = self.options['cnt_overdrive_bit']
123 else:
e7720d6c
UH
124 self.cnt_overdrive_bit = int(samplerate * 0.000002) - 1 # 2ns
125 if self.options['cnt_overdrive_slot']:
671cc300
IJ
126 self.cnt_overdrive_slot = self.options['cnt_overdrive_slot']
127 else:
e7720d6c
UH
128 self.cnt_overdrive_slot = int(samplerate * 0.0000073) - 1 # 6ns+1.3ns
129 if self.options['cnt_overdrive_presence']:
9cfb16e8
IJ
130 self.cnt_overdrive_presence = self.options['cnt_overdrive_presence']
131 else:
e7720d6c
UH
132 self.cnt_overdrive_presence = int(samplerate * 0.000010) - 1 # 10ns
133 if self.options['cnt_overdrive_reset']:
9cfb16e8
IJ
134 self.cnt_overdrive_reset = self.options['cnt_overdrive_reset']
135 else:
e7720d6c 136 self.cnt_overdrive_reset = int(samplerate * 0.000048) - 1 # 48ns
9cfb16e8 137
e7720d6c
UH
138 # Organize values into lists.
139 self.cnt_bit = [self.cnt_normal_bit, self.cnt_overdrive_bit]
9cfb16e8 140 self.cnt_presence = [self.cnt_normal_presence, self.cnt_overdrive_presence]
e7720d6c
UH
141 self.cnt_reset = [self.cnt_normal_reset, self.cnt_overdrive_reset]
142 self.cnt_slot = [self.cnt_normal_slot, self.cnt_overdrive_slot]
143
144 # Check if sample times are in the allowed range.
145
146 time_min = float(self.cnt_normal_bit) / self.samplerate
147 time_max = float(self.cnt_normal_bit + 1) / self.samplerate
148 if (time_min < 0.000005) or (time_max > 0.000015):
ddeb9b32 149 self.putm([1, ['The normal mode data sample time interval ' +
e7720d6c
UH
150 '(%2.1fus-%2.1fus) should be inside (5.0us, 15.0us).'
151 % (time_min * 1000000, time_max * 1000000)]])
152
153 time_min = float(self.cnt_normal_presence) / self.samplerate
154 time_max = float(self.cnt_normal_presence + 1) / self.samplerate
155 if (time_min < 0.0000681) or (time_max > 0.000075):
ddeb9b32 156 self.putm([1, ['The normal mode presence sample time interval ' +
e7720d6c
UH
157 '(%2.1fus-%2.1fus) should be inside (68.1us, 75.0us).'
158 % (time_min * 1000000, time_max * 1000000)]])
159
160 time_min = float(self.cnt_overdrive_bit) / self.samplerate
161 time_max = float(self.cnt_overdrive_bit + 1) / self.samplerate
162 if (time_min < 0.000001) or (time_max > 0.000002):
ddeb9b32 163 self.putm([1, ['The overdrive mode data sample time interval ' +
e7720d6c
UH
164 '(%2.1fus-%2.1fus) should be inside (1.0us, 2.0us).'
165 % (time_min * 1000000, time_max * 1000000)]])
166
167 time_min = float(self.cnt_overdrive_presence) / self.samplerate
168 time_max = float(self.cnt_overdrive_presence + 1) / self.samplerate
169 if (time_min < 0.0000073) or (time_max > 0.000010):
ddeb9b32 170 self.putm([1, ['The overdrive mode presence sample time interval ' +
e7720d6c
UH
171 '(%2.1fus-%2.1fus) should be inside (7.3us, 10.0us).'
172 % (time_min*1000000, time_max*1000000)]])
9cfb16e8
IJ
173
174 def report(self):
175 pass
176
177 def decode(self, ss, es, data):
178 for (self.samplenum, (owr, pwr)) in data:
9cfb16e8
IJ
179 # State machine.
180 if self.state == 'WAIT FOR FALLING EDGE':
181 # The start of a cycle is a falling edge.
48b59746
UH
182 if owr != 0:
183 continue
184 # Save the sample number for the falling edge.
185 self.fall = self.samplenum
186 # Go to waiting for sample time.
187 self.state = 'WAIT FOR DATA SAMPLE'
9cfb16e8 188 elif self.state == 'WAIT FOR DATA SAMPLE':
e7720d6c
UH
189 # Sample data bit.
190 t = self.samplenum - self.fall
191 if t == self.cnt_bit[self.overdrive]:
192 self.bit = owr
671cc300
IJ
193 self.state = 'WAIT FOR DATA SLOT END'
194 elif self.state == 'WAIT FOR DATA SLOT END':
e7720d6c
UH
195 # A data slot ends in a recovery period, otherwise, this is
196 # probably a reset.
197 t = self.samplenum - self.fall
48b59746
UH
198 if t != self.cnt_slot[self.overdrive]:
199 continue
200
201 if owr == 0:
202 # This seems to be a reset slot, wait for its end.
203 self.state = 'WAIT FOR RISING EDGE'
204 continue
205
ddeb9b32
UH
206 self.putb([0, ['Bit: %d' % self.bit]])
207 self.putpb(['BIT', self.bit])
e7720d6c 208
48b59746
UH
209 # Checking the first command to see if overdrive mode
210 # should be entered.
211 if self.bit_cnt <= 8:
212 self.command |= (self.bit << self.bit_cnt)
213 elif self.bit_cnt == 8 and self.command in [0x3c, 0x69]:
ddeb9b32 214 self.putx([0, ['Entering overdrive mode']])
48b59746
UH
215 # Increment the bit counter.
216 self.bit_cnt += 1
217 # Wait for next slot.
218 self.state = 'WAIT FOR FALLING EDGE'
9cfb16e8
IJ
219 elif self.state == 'WAIT FOR RISING EDGE':
220 # The end of a cycle is a rising edge.
48b59746
UH
221 if owr != 1:
222 continue
223
224 # Check if this was a reset cycle.
225 t = self.samplenum - self.fall
226 if t > self.cnt_normal_reset:
227 # Save the sample number for the falling edge.
228 self.rise = self.samplenum
229 self.state = 'WAIT FOR PRESENCE DETECT'
230 # Exit overdrive mode.
231 if self.overdrive:
ddeb9b32 232 self.putx([0, ['Exiting overdrive mode']])
48b59746
UH
233 self.overdrive = 0
234 # Clear command bit counter and data register.
235 self.bit_cnt = 0
236 self.command = 0
237 elif (t > self.cnt_overdrive_reset) and self.overdrive:
238 # Save the sample number for the falling edge.
239 self.rise = self.samplenum
240 self.state = "WAIT FOR PRESENCE DETECT"
241 # Otherwise this is assumed to be a data bit.
242 else:
243 self.state = "WAIT FOR FALLING EDGE"
9cfb16e8 244 elif self.state == 'WAIT FOR PRESENCE DETECT':
e7720d6c
UH
245 # Sample presence status.
246 t = self.samplenum - self.rise
247 if t == self.cnt_presence[self.overdrive]:
671cc300
IJ
248 self.present = owr
249 self.state = 'WAIT FOR RESET SLOT END'
250 elif self.state == 'WAIT FOR RESET SLOT END':
48b59746 251 # A reset slot ends in a long recovery period.
e7720d6c 252 t = self.samplenum - self.rise
48b59746
UH
253 if t != self.cnt_reset[self.overdrive]:
254 continue
255
256 if owr == 0:
257 # This seems to be a reset slot, wait for its end.
258 self.state = 'WAIT FOR RISING EDGE'
259 continue
260
ddeb9b32
UH
261 p = 'false' if self.present else 'true'
262 self.putb([0, ['Reset/presence: %s' % p]])
263 self.putpb(['RESET/PRESENCE', not self.present])
264
48b59746
UH
265 # Wait for next slot.
266 self.state = 'WAIT FOR FALLING EDGE'
9cfb16e8 267 else:
e7720d6c 268 raise Exception('Invalid state: %s' % self.state)