s/out_proto/out_python/.
[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 import sigrokdecode as srd
23
24 '''
25 OUTPUT_PYTHON format:
26
27 Packet:
28 [<ptype>, <pdata>]
29
30 <ptype>, <pdata>:
31  - 'SOP', None
32  - 'SYM', <sym>
33  - 'BIT', <bit>
34  - 'STUFF BIT', None
35  - 'EOP', None
36
37 <sym>:
38  - 'J', 'K', 'SE0', or 'SE1'
39
40 <bit>:
41  - 0 or 1
42  - Note: Symbols like SE0, SE1, and the J that's part of EOP don't yield 'BIT'.
43 '''
44
45 # Low-/full-speed symbols.
46 # Note: Low-speed J and K are inverted compared to the full-speed J and K!
47 symbols = {
48     'low-speed': {
49         # (<dp>, <dm>): <symbol/state>
50         (0, 0): 'SE0',
51         (1, 0): 'K',
52         (0, 1): 'J',
53         (1, 1): 'SE1',
54     },
55     'full-speed': {
56         # (<dp>, <dm>): <symbol/state>
57         (0, 0): 'SE0',
58         (1, 0): 'J',
59         (0, 1): 'K',
60         (1, 1): 'SE1',
61     },
62 }
63
64 bitrates = {
65     'low-speed': 1500000,   # 1.5Mb/s (+/- 1.5%)
66     'full-speed': 12000000, # 12Mb/s (+/- 0.25%)
67 }
68
69 class Decoder(srd.Decoder):
70     api_version = 1
71     id = 'usb_signalling'
72     name = 'USB signalling'
73     longname = 'Universal Serial Bus (LS/FS) signalling'
74     desc = 'USB (low-speed and full-speed) signalling protocol.'
75     license = 'gplv2+'
76     inputs = ['logic']
77     outputs = ['usb_signalling']
78     probes = [
79         {'id': 'dp', 'name': 'D+', 'desc': 'USB D+ signal'},
80         {'id': 'dm', 'name': 'D-', 'desc': 'USB D- signal'},
81     ]
82     optional_probes = []
83     options = {
84         'signalling': ['Signalling', 'full-speed'],
85     }
86     annotations = [
87         ['sym', 'Symbol'],
88         ['sop', 'Start of packet (SOP)'],
89         ['eop', 'End of packet (EOP)'],
90         ['bit', 'Bit'],
91         ['stuffbit', 'Stuff bit'],
92     ]
93
94     def __init__(self):
95         self.samplerate = None
96         self.oldsym = 'J' # The "idle" state is J.
97         self.ss_sop = None
98         self.ss_block = None
99         self.samplenum = 0
100         self.syms = []
101         self.bitrate = None
102         self.bitwidth = None
103         self.bitnum = 0
104         self.samplenum_target = None
105         self.oldpins = None
106         self.consecutive_ones = 0
107         self.state = 'IDLE'
108
109     def start(self):
110         self.out_python = self.register(srd.OUTPUT_PYTHON)
111         self.out_ann = self.register(srd.OUTPUT_ANN)
112
113     def metadata(self, key, value):
114         if key == srd.SRD_CONF_SAMPLERATE:
115             self.samplerate = value
116             self.bitrate = bitrates[self.options['signalling']]
117             self.bitwidth = float(self.samplerate) / float(self.bitrate)
118             self.halfbit = int(self.bitwidth / 2)
119
120     def putpx(self, data):
121         self.put(self.samplenum, self.samplenum, self.out_python, data)
122
123     def putx(self, data):
124         self.put(self.samplenum, self.samplenum, self.out_ann, data)
125
126     def putpm(self, data):
127         s, h = self.samplenum, self.halfbit
128         self.put(self.ss_block - h, s + h, self.out_python, data)
129
130     def putm(self, data):
131         s, h = self.samplenum, self.halfbit
132         self.put(self.ss_block - h, s + h, self.out_ann, data)
133
134     def putpb(self, data):
135         s, h = self.samplenum, self.halfbit
136         self.put(s - h, s + h, self.out_python, data)
137
138     def putb(self, data):
139         s, h = self.samplenum, self.halfbit
140         self.put(s - h, s + h, self.out_ann, data)
141
142     def set_new_target_samplenum(self):
143         bitpos = self.ss_sop + (self.bitwidth / 2)
144         bitpos += self.bitnum * self.bitwidth
145         self.samplenum_target = int(bitpos)
146
147     def wait_for_sop(self, sym):
148         # Wait for a Start of Packet (SOP), i.e. a J->K symbol change.
149         if sym != 'K':
150             self.oldsym = sym
151             return
152         self.ss_sop = self.samplenum
153         self.set_new_target_samplenum()
154         self.putpx(['SOP', None])
155         self.putx([1, ['SOP']])
156         self.state = 'GET BIT'
157
158     def handle_bit(self, sym, b):
159         if self.consecutive_ones == 6 and b == '0':
160             # Stuff bit.
161             self.putpb(['STUFF BIT', None])
162             self.putb([4, ['SB: %s/%s' % (sym, b)]])
163             self.consecutive_ones = 0
164         else:
165             # Normal bit (not a stuff bit).
166             self.putpb(['BIT', b])
167             self.putb([3, ['%s/%s' % (sym, b)]])
168             if b == '1':
169                 self.consecutive_ones += 1
170             else:
171                 self.consecutive_ones = 0
172
173     def get_eop(self, sym):
174         # EOP: SE0 for >= 1 bittime (usually 2 bittimes), then J.
175         self.syms.append(sym)
176         self.putpb(['SYM', sym])
177         self.putb([0, ['%s' % sym]])
178         self.bitnum += 1
179         self.set_new_target_samplenum()
180         self.oldsym = sym
181         if self.syms[-2:] == ['SE0', 'J']:
182             # Got an EOP.
183             self.putpm(['EOP', None])
184             self.putm([2, ['EOP']])
185             self.bitnum, self.syms, self.state = 0, [], 'IDLE'
186             self.consecutive_ones = 0
187
188     def get_bit(self, sym):
189         if sym == 'SE0':
190             # Start of an EOP. Change state, run get_eop() for this bit.
191             self.state = 'GET EOP'
192             self.ss_block = self.samplenum
193             self.get_eop(sym)
194             return
195         self.syms.append(sym)
196         self.putpb(['SYM', sym])
197         b = '0' if self.oldsym != sym else '1'
198         self.handle_bit(sym, b)
199         self.bitnum += 1
200         self.set_new_target_samplenum()
201         self.oldsym = sym
202
203     def decode(self, ss, es, data):
204         if self.samplerate is None:
205             raise Exception("Cannot decode without samplerate.")
206         for (self.samplenum, pins) in data:
207             # State machine.
208             if self.state == 'IDLE':
209                 # Ignore identical samples early on (for performance reasons).
210                 if self.oldpins == pins:
211                     continue
212                 self.oldpins = pins
213                 sym = symbols[self.options['signalling']][tuple(pins)]
214                 self.wait_for_sop(sym)
215             elif self.state in ('GET BIT', 'GET EOP'):
216                 # Wait until we're in the middle of the desired bit.
217                 if self.samplenum < self.samplenum_target:
218                     continue
219                 sym = symbols[self.options['signalling']][tuple(pins)]
220                 if self.state == 'GET BIT':
221                     self.get_bit(sym)
222                 elif self.state == 'GET EOP':
223                     self.get_eop(sym)
224             else:
225                 raise Exception('Invalid state: %s' % self.state)
226