]>
Commit | Line | Data |
---|---|---|
03325c23 GM |
1 | ## |
2 | ## This file is part of the sigrok project. | |
3 | ## | |
4 | ## Copyright (C) 2011 Gareth McMullin <gareth@blacksphere.co.nz> | |
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 | ||
9611dc5f | 21 | # |
03325c23 | 22 | # USB Full-speed protocol decoder |
9611dc5f UH |
23 | # |
24 | # Full-speed USB signalling consists of two signal lines, both driven at 3.3V | |
25 | # logic levels. The signals are DP (D+) and DM (D-), and normally operate in | |
26 | # differential mode. | |
03325c23 | 27 | # The state where DP=1,DM=0 is J, the state DP=0,DM=1 is K. |
9611dc5f | 28 | # A state SE0 is defined where DP=DM=0. This common mode signal is used to |
03325c23 | 29 | # signal a reset or end of packet. |
9611dc5f UH |
30 | # |
31 | # Data transmitted on the USB is encoded with NRZI. A transition from J to K | |
32 | # or vice-versa indicates a logic 0, while no transition indicates a logic 1. | |
33 | # If 6 ones are transmitted consecutively, a zero is inserted to force a | |
34 | # transition. This is known as bit stuffing. Data is transferred at a rate | |
35 | # of 12Mbit/s. The SE0 transmitted to signal an end-of-packet is two bit | |
03325c23 | 36 | # intervals long. |
9611dc5f UH |
37 | # |
38 | # Details: | |
39 | # https://en.wikipedia.org/wiki/USB | |
40 | # http://www.usb.org/developers/docs/ | |
41 | # | |
03325c23 GM |
42 | |
43 | import sigrok | |
44 | ||
45 | class Sample(): | |
46 | def __init__(self, data): | |
47 | self.data = data | |
48 | def probe(self, probe): | |
49 | s = ord(self.data[probe / 8]) & (1 << (probe % 8)) | |
50 | return True if s else False | |
51 | ||
52 | def sampleiter(data, unitsize): | |
53 | for i in range(0, len(data), unitsize): | |
54 | yield(Sample(data[i:i+unitsize])) | |
55 | ||
9611dc5f | 56 | # States |
03325c23 GM |
57 | SE0, J, K, SE1 = 0, 1, 2, 3 |
58 | syms = { | |
59 | (False, False): SE0, | |
60 | (True, False): J, | |
61 | (False, True): K, | |
62 | (True, True): SE1, | |
63 | } | |
64 | ||
65 | def bitstr_to_num(bitstr): | |
66 | if not bitstr: return 0 | |
67 | l = list(bitstr) | |
68 | l.reverse() | |
69 | return int(''.join(l), 2) | |
70 | ||
71 | def packet_decode(packet): | |
9611dc5f UH |
72 | pids = { |
73 | '10000111':'OUT', # Tokens | |
03325c23 GM |
74 | '10010110':'IN', |
75 | '10100101':'SOF', | |
76 | '10110100':'SETUP', | |
9611dc5f | 77 | '11000011':'DATA0', # Data |
03325c23 | 78 | '11010010':'DATA1', |
9611dc5f | 79 | '01001011':'ACK', # Handshake |
03325c23 GM |
80 | '01011010':'NAK', |
81 | '01111000':'STALL', | |
82 | '01101001':'NYET', | |
83 | } | |
84 | ||
85 | sync = packet[:8] | |
86 | pid = packet[8:16] | |
87 | pid = pids.get(pid, pid) | |
9611dc5f | 88 | # Remove CRC. |
03325c23 GM |
89 | if pid in ('OUT', 'IN', 'SOF', 'SETUP'): |
90 | data = packet[16:-5] | |
91 | if pid == 'SOF': | |
92 | data = str(bitstr_to_num(data)) | |
93 | else: | |
94 | dev = bitstr_to_num(data[:7]) | |
95 | ep = bitstr_to_num(data[7:]) | |
96 | data = "DEV %d EP %d" % (dev, ep) | |
97 | ||
98 | elif pid in ('DATA0', 'DATA1'): | |
99 | data = packet[16:-16] | |
100 | tmp = "" | |
101 | while data: | |
102 | tmp += "%02X " % bitstr_to_num(data[:8]) | |
103 | data = data[8:] | |
104 | data = tmp | |
105 | else: | |
106 | data = packet[16:] | |
107 | ||
108 | if sync != "00000001": | |
109 | return "SYNC INVALID!" | |
9611dc5f | 110 | |
03325c23 GM |
111 | return pid + ' ' + data |
112 | ||
113 | class Decoder(): | |
114 | name = 'USB' | |
115 | desc = 'Universal Serial Bus' | |
116 | longname = '...longname...' | |
117 | longdesc = '...longdesc...' | |
118 | author = 'Gareth McMullin' | |
119 | email = 'gareth@blacksphere.co.nz' | |
120 | license = 'gplv2+' | |
121 | inputs = ['logic'] | |
122 | outputs = ['usb'] | |
123 | # Probe names with a set of defaults | |
124 | probes = {'dp':0, 'dm':1} | |
125 | options = {} | |
126 | ||
127 | def __init__(self): | |
128 | self.probes = Decoder.probes.copy() | |
129 | ||
130 | def start(self, metadata): | |
131 | self.unitsize = metadata['unitsize'] | |
132 | self.rate = metadata['samplerate'] | |
133 | if self.rate < 48000000: | |
134 | raise Exception("Sample rate not sufficient for USB decoding") | |
9611dc5f | 135 | # Initialise decoder state. |
03325c23 GM |
136 | self.sym = J |
137 | self.scount = 0 | |
138 | self.packet = '' | |
139 | ||
140 | def decode(self, data): | |
141 | for sample in sampleiter(data['data'], self.unitsize): | |
142 | ||
143 | self.scount += 1 | |
144 | ||
9611dc5f UH |
145 | sym = syms[sample.probe(self.probes['dp']), |
146 | sample.probe(self.probes['dm'])] | |
03325c23 GM |
147 | if sym == self.sym: |
148 | continue | |
149 | ||
150 | if self.scount == 1: | |
9611dc5f UH |
151 | # We ignore single sample width pulses. |
152 | # I sometimes get these with the OLS. | |
03325c23 GM |
153 | self.sym = sym |
154 | self.scount = 0 | |
155 | continue | |
156 | ||
9611dc5f | 157 | # How many bits since the last transition? |
03325c23 GM |
158 | if self.packet or self.sym != J: |
159 | bitcount = (self.scount - 1) * 12000000 / self.rate | |
160 | else: | |
161 | bitcount = 0 | |
162 | ||
163 | if self.sym == SE0: | |
164 | if bitcount == 1: | |
9611dc5f UH |
165 | # End-Of-Packet (EOP) |
166 | sigrok.put({"type":"usb", "data":self.packet, | |
03325c23 GM |
167 | "display":packet_decode(self.packet)}) |
168 | else: | |
9611dc5f | 169 | # Longer than EOP, assume reset. |
03325c23 GM |
170 | sigrok.put({"type":"usb", "display":"RESET"}) |
171 | self.scount = 0 | |
172 | self.sym = sym | |
173 | self.packet = '' | |
174 | continue | |
175 | ||
176 | # Add bits to the packet string. | |
177 | self.packet += '1' * bitcount | |
9611dc5f | 178 | # Handle bit stuffing. |
03325c23 GM |
179 | if bitcount < 6 and sym != SE0: |
180 | self.packet += '0' | |
181 | elif bitcount > 6: | |
182 | sigrok.put({"type":"usb", "display":"BIT STUFF ERROR"}) | |
9611dc5f | 183 | |
03325c23 GM |
184 | self.scount = 0 |
185 | self.sym = sym | |
186 |