Receive samplerate via metadata(), not start()
[libsigrokdecode.git] / decoders / usb_signalling / pd.py
1 ##
2 ## This file is part of the libsigrokdecode project.
3 ##
4 ## Copyright (C) 2011 Gareth McMullin <gareth@blacksphere.co.nz>
5 ## Copyright (C) 2012-2013 Uwe Hermann <uwe@hermann-uwe.de>
6 ##
7 ## This program is free software; you can redistribute it and/or modify
8 ## it under the terms of the GNU General Public License as published by
9 ## the Free Software Foundation; either version 2 of the License, or
10 ## (at your option) any later version.
11 ##
12 ## This program is distributed in the hope that it will be useful,
13 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
14 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 ## GNU General Public License for more details.
16 ##
17 ## You should have received a copy of the GNU General Public License
18 ## along with this program; if not, write to the Free Software
19 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
20 ##
21
22 # USB signalling (low-speed and full-speed) protocol decoder
23
24 import sigrokdecode as srd
25
26 '''
27 Protocol output format:
28
29 Packet:
30 [<ptype>, <pdata>]
31
32 <ptype>, <pdata>:
33  - 'SOP', None
34  - 'SYM', <sym>
35  - 'BIT', <bit>
36  - 'STUFF BIT', None
37  - 'EOP', None
38
39 <sym>:
40  - 'J', 'K', 'SE0', or 'SE1'
41
42 <bit>:
43  - 0 or 1
44  - Note: Symbols like SE0, SE1, and the J that's part of EOP don't yield 'BIT'.
45 '''
46
47 # Low-/full-speed symbols.
48 # Note: Low-speed J and K are inverted compared to the full-speed J and K!
49 symbols = {
50     'low-speed': {
51         # (<dp>, <dm>): <symbol/state>
52         (0, 0): 'SE0',
53         (1, 0): 'K',
54         (0, 1): 'J',
55         (1, 1): 'SE1',
56     },
57     'full-speed': {
58         # (<dp>, <dm>): <symbol/state>
59         (0, 0): 'SE0',
60         (1, 0): 'J',
61         (0, 1): 'K',
62         (1, 1): 'SE1',
63     },
64 }
65
66 bitrates = {
67     'low-speed': 1500000,   # 1.5Mb/s (+/- 1.5%)
68     'full-speed': 12000000, # 12Mb/s (+/- 0.25%)
69 }
70
71 class Decoder(srd.Decoder):
72     api_version = 1
73     id = 'usb_signalling'
74     name = 'USB signalling'
75     longname = 'Universal Serial Bus (LS/FS) signalling'
76     desc = 'USB (low-speed and full-speed) signalling protocol.'
77     license = 'gplv2+'
78     inputs = ['logic']
79     outputs = ['usb_signalling']
80     probes = [
81         {'id': 'dp', 'name': 'D+', 'desc': 'USB D+ signal'},
82         {'id': 'dm', 'name': 'D-', 'desc': 'USB D- signal'},
83     ]
84     optional_probes = []
85     options = {
86         'signalling': ['Signalling', 'full-speed'],
87     }
88     annotations = [
89         ['sym', 'Symbol'],
90         ['sop', 'Start of packet (SOP)'],
91         ['eop', 'End of packet (EOP)'],
92         ['bit', 'Bit'],
93         ['stuffbit', 'Stuff bit'],
94     ]
95
96     def __init__(self):
97         self.samplerate = None
98         self.oldsym = 'J' # The "idle" state is J.
99         self.ss_sop = None
100         self.ss_block = None
101         self.samplenum = 0
102         self.syms = []
103         self.bitrate = None
104         self.bitwidth = None
105         self.bitnum = 0
106         self.samplenum_target = None
107         self.oldpins = None
108         self.consecutive_ones = 0
109         self.state = 'IDLE'
110
111     def start(self):
112         self.out_proto = self.add(srd.OUTPUT_PROTO, 'usb_signalling')
113         self.out_ann = self.add(srd.OUTPUT_ANN, 'usb_signalling')
114
115     def metadata(self, key, value):
116         if key == srd.SRD_CONF_SAMPLERATE:
117             self.samplerate = value
118             self.bitrate = bitrates[self.options['signalling']]
119             self.bitwidth = float(self.samplerate) / float(self.bitrate)
120             self.halfbit = int(self.bitwidth / 2)
121
122     def report(self):
123         pass
124
125     def putpx(self, data):
126         self.put(self.samplenum, self.samplenum, self.out_proto, data)
127
128     def putx(self, data):
129         self.put(self.samplenum, self.samplenum, self.out_ann, data)
130
131     def putpm(self, data):
132         s, h = self.samplenum, self.halfbit
133         self.put(self.ss_block - h, s + h, self.out_proto, data)
134
135     def putm(self, data):
136         s, h = self.samplenum, self.halfbit
137         self.put(self.ss_block - h, s + h, self.out_ann, data)
138
139     def putpb(self, data):
140         s, h = self.samplenum, self.halfbit
141         self.put(s - h, s + h, self.out_proto, data)
142
143     def putb(self, data):
144         s, h = self.samplenum, self.halfbit
145         self.put(s - h, s + h, self.out_ann, data)
146
147     def set_new_target_samplenum(self):
148         bitpos = self.ss_sop + (self.bitwidth / 2)
149         bitpos += self.bitnum * self.bitwidth
150         self.samplenum_target = int(bitpos)
151
152     def wait_for_sop(self, sym):
153         # Wait for a Start of Packet (SOP), i.e. a J->K symbol change.
154         if sym != 'K':
155             self.oldsym = sym
156             return
157         self.ss_sop = self.samplenum
158         self.set_new_target_samplenum()
159         self.putpx(['SOP', None])
160         self.putx([1, ['SOP']])
161         self.state = 'GET BIT'
162
163     def handle_bit(self, sym, b):
164         if self.consecutive_ones == 6 and b == '0':
165             # Stuff bit.
166             self.putpb(['STUFF BIT', None])
167             self.putb([4, ['SB: %s/%s' % (sym, b)]])
168             self.consecutive_ones = 0
169         else:
170             # Normal bit (not a stuff bit).
171             self.putpb(['BIT', b])
172             self.putb([3, ['%s/%s' % (sym, b)]])
173             if b == '1':
174                 self.consecutive_ones += 1
175             else:
176                 self.consecutive_ones = 0
177
178     def get_eop(self, sym):
179         # EOP: SE0 for >= 1 bittime (usually 2 bittimes), then J.
180         self.syms.append(sym)
181         self.putpb(['SYM', sym])
182         self.putb([0, ['%s' % sym]])
183         self.bitnum += 1
184         self.set_new_target_samplenum()
185         self.oldsym = sym
186         if self.syms[-2:] == ['SE0', 'J']:
187             # Got an EOP.
188             self.putpm(['EOP', None])
189             self.putm([2, ['EOP']])
190             self.bitnum, self.syms, self.state = 0, [], 'IDLE'
191             self.consecutive_ones = 0
192
193     def get_bit(self, sym):
194         if sym == 'SE0':
195             # Start of an EOP. Change state, run get_eop() for this bit.
196             self.state = 'GET EOP'
197             self.ss_block = self.samplenum
198             self.get_eop(sym)
199             return
200         self.syms.append(sym)
201         self.putpb(['SYM', sym])
202         b = '0' if self.oldsym != sym else '1'
203         self.handle_bit(sym, b)
204         self.bitnum += 1
205         self.set_new_target_samplenum()
206         self.oldsym = sym
207
208     def decode(self, ss, es, data):
209         if self.samplerate is None:
210             raise Exception("Cannot decode without samplerate.")
211         for (self.samplenum, pins) in data:
212             # State machine.
213             if self.state == 'IDLE':
214                 # Ignore identical samples early on (for performance reasons).
215                 if self.oldpins == pins:
216                     continue
217                 self.oldpins = pins
218                 sym = symbols[self.options['signalling']][tuple(pins)]
219                 self.wait_for_sop(sym)
220             elif self.state in ('GET BIT', 'GET EOP'):
221                 # Wait until we're in the middle of the desired bit.
222                 if self.samplenum < self.samplenum_target:
223                     continue
224                 sym = symbols[self.options['signalling']][tuple(pins)]
225                 if self.state == 'GET BIT':
226                     self.get_bit(sym)
227                 elif self.state == 'GET EOP':
228                     self.get_eop(sym)
229             else:
230                 raise Exception('Invalid state: %s' % self.state)
231