]>
Commit | Line | Data |
---|---|---|
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 | |
23 | import sigrokdecode as srd | |
24 | ||
25 | class 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 = { | |
01520fa9 | 41 | 'overdrive': ['Overdrive mode', 'no'], |
497f196d UH |
42 | # Time options (specified in microseconds): |
43 | 'cnt_normal_bit': ['Normal mode sample bit time (us)', 15], | |
44 | 'cnt_normal_slot': ['Normal mode data slot time (us)', 60], | |
45 | 'cnt_normal_presence': ['Normal mode sample presence time (us)', 75], | |
46 | 'cnt_normal_reset': ['Normal mode reset time (us)', 480], | |
47 | 'cnt_overdrive_bit': ['Overdrive mode sample bit time (us)', 2], | |
48 | # 'cnt_overdrive_slot': ['Overdrive mode data slot time (us)', 7.3], | |
49 | 'cnt_overdrive_slot': ['Overdrive mode data slot time (us)', 7], | |
50 | 'cnt_overdrive_presence': ['Overdrive mode sample presence time (us)', 10], | |
51 | 'cnt_overdrive_reset': ['Overdrive mode reset time (us)', 48], | |
9cfb16e8 IJ |
52 | } |
53 | annotations = [ | |
938aa7fb UH |
54 | ['bit', 'Bit'], |
55 | ['warnings', 'Warnings'], | |
6f507573 UH |
56 | ['reset', 'Reset'], |
57 | ['presence', 'Presence'], | |
938aa7fb | 58 | ['overdrive', 'Overdrive mode notifications'], |
9cfb16e8 IJ |
59 | ] |
60 | ||
ddeb9b32 UH |
61 | def putm(self, data): |
62 | self.put(0, 0, self.out_ann, data) | |
63 | ||
64 | def putpb(self, data): | |
65 | self.put(self.fall, self.samplenum, self.out_proto, data) | |
66 | ||
67 | def putb(self, data): | |
68 | self.put(self.fall, self.samplenum, self.out_ann, data) | |
69 | ||
70 | def putx(self, data): | |
71 | self.put(self.fall, self.cnt_bit[self.overdrive], self.out_ann, data) | |
72 | ||
6f507573 UH |
73 | def putfr(self, data): |
74 | self.put(self.fall, self.rise, self.out_ann, data) | |
75 | ||
76 | def putprs(self, data): | |
77 | self.put(self.rise, self.samplenum, self.out_proto, data) | |
78 | ||
79 | def putrs(self, data): | |
80 | self.put(self.rise, self.samplenum, self.out_ann, data) | |
81 | ||
9cfb16e8 | 82 | def __init__(self, **kwargs): |
9cfb16e8 | 83 | self.samplenum = 0 |
e7720d6c | 84 | self.state = 'WAIT FOR FALLING EDGE' |
9cfb16e8 | 85 | self.present = 0 |
e7720d6c | 86 | self.bit = 0 |
99f5f3b5 IJ |
87 | self.bit_cnt = 0 |
88 | self.command = 0 | |
9cfb16e8 | 89 | self.overdrive = 0 |
e7720d6c UH |
90 | self.fall = 0 |
91 | self.rise = 0 | |
9cfb16e8 IJ |
92 | |
93 | def start(self, metadata): | |
94 | self.out_proto = self.add(srd.OUTPUT_PROTO, 'onewire_link') | |
e7720d6c | 95 | self.out_ann = self.add(srd.OUTPUT_ANN, 'onewire_link') |
9cfb16e8 | 96 | |
9cfb16e8 | 97 | self.samplerate = metadata['samplerate'] |
e7720d6c UH |
98 | |
99 | # Check if samplerate is appropriate. | |
01520fa9 | 100 | if self.options['overdrive'] == 'yes': |
e7720d6c | 101 | if self.samplerate < 2000000: |
ddeb9b32 UH |
102 | self.putm([1, ['Sampling rate is too low. Must be above ' + |
103 | '2MHz for proper overdrive mode decoding.']]) | |
e7720d6c | 104 | elif self.samplerate < 5000000: |
ddeb9b32 UH |
105 | self.putm([1, ['Sampling rate is suggested to be above 5MHz ' + |
106 | 'for proper overdrive mode decoding.']]) | |
9cfb16e8 | 107 | else: |
e7720d6c | 108 | if self.samplerate < 400000: |
ddeb9b32 UH |
109 | self.putm([1, ['Sampling rate is too low. Must be above ' + |
110 | '400kHz for proper normal mode decoding.']]) | |
9cfb16e8 | 111 | elif (self.samplerate < 1000000): |
ddeb9b32 UH |
112 | self.putm([1, ['Sampling rate is suggested to be above ' + |
113 | '1MHz for proper normal mode decoding.']]) | |
9cfb16e8 | 114 | |
e7720d6c UH |
115 | # The default 1-Wire time base is 30us. This is used to calculate |
116 | # sampling times. | |
117 | samplerate = float(self.samplerate) | |
497f196d UH |
118 | |
119 | x = float(self.options['cnt_normal_bit']) / 1000000.0 | |
120 | self.cnt_normal_bit = int(samplerate * x) - 1 | |
121 | x = float(self.options['cnt_normal_slot']) / 1000000.0 | |
122 | self.cnt_normal_slot = int(samplerate * x) - 1 | |
123 | x = float(self.options['cnt_normal_presence']) / 1000000.0 | |
124 | self.cnt_normal_presence = int(samplerate * x) - 1 | |
125 | x = float(self.options['cnt_normal_reset']) / 1000000.0 | |
126 | self.cnt_normal_reset = int(samplerate * x) - 1 | |
127 | x = float(self.options['cnt_overdrive_bit']) / 1000000.0 | |
128 | self.cnt_overdrive_bit = int(samplerate * x) - 1 | |
129 | x = float(self.options['cnt_overdrive_slot']) / 1000000.0 | |
130 | self.cnt_overdrive_slot = int(samplerate * x) - 1 | |
131 | x = float(self.options['cnt_overdrive_presence']) / 1000000.0 | |
132 | self.cnt_overdrive_presence = int(samplerate * x) - 1 | |
133 | x = float(self.options['cnt_overdrive_reset']) / 1000000.0 | |
134 | self.cnt_overdrive_reset = int(samplerate * x) - 1 | |
9cfb16e8 | 135 | |
e7720d6c UH |
136 | # Organize values into lists. |
137 | self.cnt_bit = [self.cnt_normal_bit, self.cnt_overdrive_bit] | |
9cfb16e8 | 138 | self.cnt_presence = [self.cnt_normal_presence, self.cnt_overdrive_presence] |
e7720d6c UH |
139 | self.cnt_reset = [self.cnt_normal_reset, self.cnt_overdrive_reset] |
140 | self.cnt_slot = [self.cnt_normal_slot, self.cnt_overdrive_slot] | |
141 | ||
142 | # Check if sample times are in the allowed range. | |
143 | ||
144 | time_min = float(self.cnt_normal_bit) / self.samplerate | |
145 | time_max = float(self.cnt_normal_bit + 1) / self.samplerate | |
146 | if (time_min < 0.000005) or (time_max > 0.000015): | |
ddeb9b32 | 147 | self.putm([1, ['The normal mode data sample time interval ' + |
e7720d6c UH |
148 | '(%2.1fus-%2.1fus) should be inside (5.0us, 15.0us).' |
149 | % (time_min * 1000000, time_max * 1000000)]]) | |
150 | ||
151 | time_min = float(self.cnt_normal_presence) / self.samplerate | |
152 | time_max = float(self.cnt_normal_presence + 1) / self.samplerate | |
153 | if (time_min < 0.0000681) or (time_max > 0.000075): | |
ddeb9b32 | 154 | self.putm([1, ['The normal mode presence sample time interval ' + |
e7720d6c UH |
155 | '(%2.1fus-%2.1fus) should be inside (68.1us, 75.0us).' |
156 | % (time_min * 1000000, time_max * 1000000)]]) | |
157 | ||
158 | time_min = float(self.cnt_overdrive_bit) / self.samplerate | |
159 | time_max = float(self.cnt_overdrive_bit + 1) / self.samplerate | |
160 | if (time_min < 0.000001) or (time_max > 0.000002): | |
ddeb9b32 | 161 | self.putm([1, ['The overdrive mode data sample time interval ' + |
e7720d6c UH |
162 | '(%2.1fus-%2.1fus) should be inside (1.0us, 2.0us).' |
163 | % (time_min * 1000000, time_max * 1000000)]]) | |
164 | ||
165 | time_min = float(self.cnt_overdrive_presence) / self.samplerate | |
166 | time_max = float(self.cnt_overdrive_presence + 1) / self.samplerate | |
167 | if (time_min < 0.0000073) or (time_max > 0.000010): | |
ddeb9b32 | 168 | self.putm([1, ['The overdrive mode presence sample time interval ' + |
e7720d6c UH |
169 | '(%2.1fus-%2.1fus) should be inside (7.3us, 10.0us).' |
170 | % (time_min*1000000, time_max*1000000)]]) | |
9cfb16e8 IJ |
171 | |
172 | def report(self): | |
173 | pass | |
174 | ||
175 | def decode(self, ss, es, data): | |
176 | for (self.samplenum, (owr, pwr)) in data: | |
9cfb16e8 IJ |
177 | # State machine. |
178 | if self.state == 'WAIT FOR FALLING EDGE': | |
179 | # The start of a cycle is a falling edge. | |
48b59746 UH |
180 | if owr != 0: |
181 | continue | |
182 | # Save the sample number for the falling edge. | |
183 | self.fall = self.samplenum | |
184 | # Go to waiting for sample time. | |
185 | self.state = 'WAIT FOR DATA SAMPLE' | |
9cfb16e8 | 186 | elif self.state == 'WAIT FOR DATA SAMPLE': |
e7720d6c UH |
187 | # Sample data bit. |
188 | t = self.samplenum - self.fall | |
189 | if t == self.cnt_bit[self.overdrive]: | |
190 | self.bit = owr | |
671cc300 IJ |
191 | self.state = 'WAIT FOR DATA SLOT END' |
192 | elif self.state == 'WAIT FOR DATA SLOT END': | |
e7720d6c UH |
193 | # A data slot ends in a recovery period, otherwise, this is |
194 | # probably a reset. | |
195 | t = self.samplenum - self.fall | |
48b59746 UH |
196 | if t != self.cnt_slot[self.overdrive]: |
197 | continue | |
198 | ||
199 | if owr == 0: | |
200 | # This seems to be a reset slot, wait for its end. | |
201 | self.state = 'WAIT FOR RISING EDGE' | |
202 | continue | |
203 | ||
4e980c20 | 204 | self.putb([0, ['Bit: %d' % self.bit, '%d' % self.bit]]) |
ddeb9b32 | 205 | self.putpb(['BIT', self.bit]) |
e7720d6c | 206 | |
48b59746 UH |
207 | # Checking the first command to see if overdrive mode |
208 | # should be entered. | |
209 | if self.bit_cnt <= 8: | |
210 | self.command |= (self.bit << self.bit_cnt) | |
211 | elif self.bit_cnt == 8 and self.command in [0x3c, 0x69]: | |
4e980c20 | 212 | self.putx([4, ['Entering overdrive mode', 'Overdrive on']]) |
48b59746 UH |
213 | # Increment the bit counter. |
214 | self.bit_cnt += 1 | |
215 | # Wait for next slot. | |
216 | self.state = 'WAIT FOR FALLING EDGE' | |
9cfb16e8 IJ |
217 | elif self.state == 'WAIT FOR RISING EDGE': |
218 | # The end of a cycle is a rising edge. | |
48b59746 UH |
219 | if owr != 1: |
220 | continue | |
221 | ||
222 | # Check if this was a reset cycle. | |
223 | t = self.samplenum - self.fall | |
224 | if t > self.cnt_normal_reset: | |
015dc33a | 225 | # Save the sample number for the rising edge. |
48b59746 | 226 | self.rise = self.samplenum |
4e980c20 | 227 | self.putfr([2, ['Reset', 'Rst', 'R']]) |
48b59746 UH |
228 | self.state = 'WAIT FOR PRESENCE DETECT' |
229 | # Exit overdrive mode. | |
230 | if self.overdrive: | |
4e980c20 | 231 | self.putx([4, ['Exiting overdrive mode', 'Overdrive off']]) |
48b59746 UH |
232 | self.overdrive = 0 |
233 | # Clear command bit counter and data register. | |
234 | self.bit_cnt = 0 | |
235 | self.command = 0 | |
236 | elif (t > self.cnt_overdrive_reset) and self.overdrive: | |
015dc33a | 237 | # Save the sample number for the rising edge. |
48b59746 | 238 | self.rise = self.samplenum |
4e980c20 | 239 | self.putfr([2, ['Reset', 'Rst', 'R']]) |
48b59746 UH |
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 | 261 | p = 'false' if self.present else 'true' |
4e980c20 | 262 | self.putrs([3, ['Presence: %s' % p, 'Presence', 'Pres', 'P']]) |
6f507573 | 263 | self.putprs(['RESET/PRESENCE', not self.present]) |
ddeb9b32 | 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) |