]>
Commit | Line | Data |
---|---|---|
bd0e7d2e SB |
1 | ## |
2 | ## This file is part of the libsigrokdecode project. | |
3 | ## | |
4 | ## Copyright (C) 2015 Stefan Brüns <stefan.bruens@rwth-aachen.de> | |
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 | |
4539e9ca | 17 | ## along with this program; if not, see <http://www.gnu.org/licenses/>. |
bd0e7d2e SB |
18 | ## |
19 | ||
20 | import sigrokdecode as srd | |
21 | import struct | |
22 | ||
23 | class SamplerateError(Exception): | |
24 | pass | |
25 | ||
26 | class pcap_usb_pkt(): | |
27 | # Linux usbmon format, see Documentation/usb/usbmon.txt | |
28 | h = b'\x00\x00\x00\x00' # ID part 1 | |
29 | h += b'\x00\x00\x00\x00' # ID part 2 | |
30 | h += b'C' # 'S'ubmit / 'C'omplete / 'E'rror | |
31 | h += b'\x03' # ISO (0), Intr, Control, Bulk (3) | |
32 | h += b'\x00' # Endpoint | |
33 | h += b'\x00' # Device address | |
34 | h += b'\x00\x00' # Bus number | |
35 | h += b'-' # Setup tag - 0: Setup present, '-' otherwise | |
36 | h += b'<' # Data tag - '<' no data, 0 otherwise | |
37 | # Timestamp | |
38 | h += b'\x00\x00\x00\x00' # TS seconds part 1 | |
39 | h += b'\x00\x00\x00\x00' # TS seconds part 2 | |
40 | h += b'\x00\x00\x00\x00' # TS useconds | |
41 | # | |
42 | h += b'\x00\x00\x00\x00' # Status 0: OK | |
43 | h += b'\x00\x00\x00\x00' # URB length | |
44 | h += b'\x00\x00\x00\x00' # Data length | |
45 | # Setup packet data, valid if setup tag == 0 | |
46 | h += b'\x00' # bmRequestType | |
47 | h += b'\x00' # bRequest | |
48 | h += b'\x00\x00' # wValue | |
49 | h += b'\x00\x00' # wIndex | |
50 | h += b'\x00\x00' # wLength | |
51 | # | |
52 | h += b'\x00\x00\x00\x00' # ISO/interrupt interval | |
53 | h += b'\x00\x00\x00\x00' # ISO start frame | |
54 | h += b'\x00\x00\x00\x00' # URB flags | |
55 | h += b'\x00\x00\x00\x00' # Number of ISO descriptors | |
56 | ||
57 | def __init__(self, req, ts, is_submit): | |
58 | self.header = bytearray(pcap_usb_pkt.h) | |
59 | self.data = b'' | |
60 | self.set_urbid(req['id']) | |
61 | self.set_urbtype('S' if is_submit else 'C') | |
62 | self.set_timestamp(ts) | |
63 | self.set_addr_ep(req['addr'], req['ep']) | |
64 | if req['type'] in ('SETUP IN', 'SETUP OUT'): | |
65 | self.set_transfertype(2) # Control | |
66 | self.set_setup(req['setup_data']) | |
67 | if req['type'] in ('BULK IN'): | |
68 | self.set_addr_ep(req['addr'], 0x80 | req['ep']) | |
69 | self.set_data(req['data']) | |
70 | ||
71 | def set_urbid(self, urbid): | |
72 | self.header[4:8] = struct.pack('>I', urbid) | |
73 | ||
74 | def set_urbtype(self, urbtype): | |
75 | self.header[8] = ord(urbtype) | |
76 | ||
77 | def set_transfertype(self, transfertype): | |
78 | self.header[9] = transfertype | |
79 | ||
80 | def set_addr_ep(self, addr, ep): | |
81 | self.header[11] = addr | |
82 | self.header[10] = ep | |
83 | ||
84 | def set_timestamp(self, ts): | |
85 | self.timestamp = ts | |
86 | self.header[20:24] = struct.pack('>I', ts[0]) # seconds | |
87 | self.header[24:28] = struct.pack('>I', ts[1]) # microseconds | |
88 | ||
89 | def set_data(self, data): | |
90 | self.data = data | |
91 | self.header[15] = 0 | |
92 | self.header[36:40] = struct.pack('>I', len(data)) | |
93 | ||
94 | def set_setup(self, data): | |
95 | self.header[14] = 0 | |
96 | self.header[40:48] = data | |
97 | ||
98 | def packet(self): | |
99 | return bytes(self.header) + bytes(self.data) | |
100 | ||
101 | def record_header(self): | |
102 | # See https://wiki.wireshark.org/Development/LibpcapFileFormat. | |
103 | (secs, usecs) = self.timestamp | |
104 | h = struct.pack('>I', secs) # TS seconds | |
105 | h += struct.pack('>I', usecs) # TS microseconds | |
106 | # No truncation, so both lengths are the same. | |
107 | h += struct.pack('>I', len(self)) # Captured len (usb hdr + data) | |
108 | h += struct.pack('>I', len(self)) # Original len | |
109 | return h | |
110 | ||
111 | def __len__(self): | |
112 | return 64 + len(self.data) | |
113 | ||
114 | class Decoder(srd.Decoder): | |
b197383c | 115 | api_version = 3 |
bd0e7d2e SB |
116 | id = 'usb_request' |
117 | name = 'USB request' | |
118 | longname = 'Universal Serial Bus (LS/FS) transaction/request' | |
2787cf2a | 119 | desc = 'USB (low-speed/full-speed) transaction/request protocol.' |
bd0e7d2e SB |
120 | license = 'gplv2+' |
121 | inputs = ['usb_packet'] | |
122 | outputs = ['usb_request'] | |
d6d8a8a4 | 123 | tags = ['PC'] |
bd0e7d2e SB |
124 | annotations = ( |
125 | ('request-setup-read', 'Setup: Device-to-host'), | |
126 | ('request-setup-write', 'Setup: Host-to-device'), | |
127 | ('request-bulk-read', 'Bulk: Device-to-host'), | |
128 | ('request-bulk-write', 'Bulk: Host-to-device'), | |
129 | ('errors', 'Unexpected packets'), | |
130 | ) | |
131 | annotation_rows = ( | |
37c120b9 SB |
132 | ('request-setup', 'USB SETUP', (0, 1)), |
133 | ('request-in', 'USB BULK IN', (2,)), | |
134 | ('request-out', 'USB BULK OUT', (3,)), | |
bd0e7d2e SB |
135 | ('errors', 'Errors', (4,)), |
136 | ) | |
137 | binary = ( | |
138 | ('pcap', 'PCAP format'), | |
139 | ) | |
140 | ||
141 | def __init__(self): | |
10aeb8ea GS |
142 | self.reset() |
143 | ||
144 | def reset(self): | |
4045d684 | 145 | self.samplerate = None |
bd0e7d2e SB |
146 | self.request = {} |
147 | self.request_id = 0 | |
148 | self.transaction_state = 'IDLE' | |
5b0b88ce UH |
149 | self.ss_transaction = None |
150 | self.es_transaction = None | |
bd0e7d2e SB |
151 | self.transaction_ep = None |
152 | self.transaction_addr = None | |
153 | self.wrote_pcap_header = False | |
154 | ||
155 | def putr(self, ss, es, data): | |
156 | self.put(ss, es, self.out_ann, data) | |
157 | ||
158 | def putb(self, ts, data): | |
2f370328 | 159 | self.put(ts, ts, self.out_binary, data) |
bd0e7d2e SB |
160 | |
161 | def pcap_global_header(self): | |
162 | # See https://wiki.wireshark.org/Development/LibpcapFileFormat. | |
163 | h = b'\xa1\xb2\xc3\xd4' # Magic, indicate microsecond ts resolution | |
164 | h += b'\x00\x02' # Major version 2 | |
165 | h += b'\x00\x04' # Minor version 4 | |
166 | h += b'\x00\x00\x00\x00' # Correction vs. UTC, seconds | |
167 | h += b'\x00\x00\x00\x00' # Timestamp accuracy | |
168 | h += b'\xff\xff\xff\xff' # Max packet len | |
169 | # LINKTYPE_USB_LINUX_MMAPPED 220 | |
170 | # Linux usbmon format, see Documentation/usb/usbmon.txt. | |
171 | h += b'\x00\x00\x00\xdc' # Link layer | |
172 | return h | |
173 | ||
174 | def metadata(self, key, value): | |
175 | if key == srd.SRD_CONF_SAMPLERATE: | |
176 | self.samplerate = value | |
15a8a055 GS |
177 | if self.samplerate: |
178 | self.secs_per_sample = float(1) / float(self.samplerate) | |
bd0e7d2e SB |
179 | |
180 | def start(self): | |
2f370328 | 181 | self.out_binary = self.register(srd.OUTPUT_BINARY) |
bd0e7d2e SB |
182 | self.out_ann = self.register(srd.OUTPUT_ANN) |
183 | ||
184 | def handle_transfer(self): | |
185 | request_started = 0 | |
72b2a50c | 186 | request_end = self.handshake in ('ACK', 'STALL', 'timeout') |
bd0e7d2e SB |
187 | ep = self.transaction_ep |
188 | addr = self.transaction_addr | |
fc9d619c SB |
189 | |
190 | # Handle protocol STALLs, condition lasts until next SETUP transfer (8.5.3.4) | |
191 | if self.transaction_type == 'SETUP' and (addr, ep) in self.request: | |
192 | request = self.request[(addr,ep)] | |
193 | if request['type'] in ('SETUP IN', 'SETUP OUT'): | |
194 | request['es'] = self.ss_transaction | |
195 | self.handle_request(0, 1) | |
196 | ||
bd0e7d2e SB |
197 | if not (addr, ep) in self.request: |
198 | self.request[(addr, ep)] = {'setup_data': [], 'data': [], | |
5b0b88ce | 199 | 'type': None, 'ss': self.ss_transaction, 'es': None, |
bd0e7d2e SB |
200 | 'id': self.request_id, 'addr': addr, 'ep': ep} |
201 | self.request_id += 1 | |
202 | request_started = 1 | |
203 | request = self.request[(addr,ep)] | |
204 | ||
fc9d619c | 205 | if request_end: |
b677e536 | 206 | request['es'] = self.es_transaction |
fc9d619c SB |
207 | request['handshake'] = self.handshake |
208 | ||
bd0e7d2e SB |
209 | # BULK or INTERRUPT transfer |
210 | if request['type'] in (None, 'BULK IN') and self.transaction_type == 'IN': | |
211 | request['type'] = 'BULK IN' | |
212 | request['data'] += self.transaction_data | |
bd0e7d2e SB |
213 | self.handle_request(request_started, request_end) |
214 | elif request['type'] in (None, 'BULK OUT') and self.transaction_type == 'OUT': | |
215 | request['type'] = 'BULK OUT' | |
7c402941 SB |
216 | if self.handshake == 'ACK': |
217 | request['data'] += self.transaction_data | |
bd0e7d2e SB |
218 | self.handle_request(request_started, request_end) |
219 | ||
220 | # CONTROL, SETUP stage | |
8657abb6 | 221 | elif request['type'] is None and self.transaction_type == 'SETUP': |
bd0e7d2e SB |
222 | request['setup_data'] = self.transaction_data |
223 | request['wLength'] = struct.unpack('<H', | |
224 | bytes(self.transaction_data[6:8]))[0] | |
225 | if self.transaction_data[0] & 0x80: | |
226 | request['type'] = 'SETUP IN' | |
227 | self.handle_request(1, 0) | |
228 | else: | |
229 | request['type'] = 'SETUP OUT' | |
230 | self.handle_request(request['wLength'] == 0, 0) | |
231 | ||
232 | # CONTROL, DATA stage | |
233 | elif request['type'] == 'SETUP IN' and self.transaction_type == 'IN': | |
234 | request['data'] += self.transaction_data | |
235 | ||
236 | elif request['type'] == 'SETUP OUT' and self.transaction_type == 'OUT': | |
7c402941 SB |
237 | if self.handshake == 'ACK': |
238 | request['data'] += self.transaction_data | |
bd0e7d2e SB |
239 | if request['wLength'] == len(request['data']): |
240 | self.handle_request(1, 0) | |
241 | ||
242 | # CONTROL, STATUS stage | |
243 | elif request['type'] == 'SETUP IN' and self.transaction_type == 'OUT': | |
bd0e7d2e SB |
244 | self.handle_request(0, request_end) |
245 | ||
246 | elif request['type'] == 'SETUP OUT' and self.transaction_type == 'IN': | |
bd0e7d2e SB |
247 | self.handle_request(0, request_end) |
248 | ||
249 | else: | |
250 | return | |
251 | ||
252 | return | |
253 | ||
254 | def ts_from_samplenum(self, sample): | |
255 | ts = float(sample) * self.secs_per_sample | |
256 | return (int(ts), int((ts % 1.0) * 1e6)) | |
257 | ||
258 | def write_pcap_header(self): | |
259 | if not self.wrote_pcap_header: | |
2f370328 | 260 | self.put(0, 0, self.out_binary, [0, self.pcap_global_header()]) |
bd0e7d2e SB |
261 | self.wrote_pcap_header = True |
262 | ||
263 | def request_summary(self, request): | |
264 | s = '[' | |
265 | if request['type'] in ('SETUP IN', 'SETUP OUT'): | |
266 | for b in request['setup_data']: | |
267 | s += ' %02X' % b | |
268 | s += ' ][' | |
269 | for b in request['data']: | |
270 | s += ' %02X' % b | |
fc9d619c | 271 | s += ' ] : %s' % request['handshake'] |
bd0e7d2e SB |
272 | return s |
273 | ||
274 | def handle_request(self, request_start, request_end): | |
275 | if request_start != 1 and request_end != 1: | |
276 | return | |
277 | self.write_pcap_header() | |
278 | ep = self.transaction_ep | |
279 | addr = self.transaction_addr | |
280 | request = self.request[(addr, ep)] | |
281 | ||
282 | ss, es = request['ss'], request['es'] | |
283 | ||
284 | if request_start == 1: | |
285 | # Issue PCAP 'SUBMIT' packet. | |
286 | ts = self.ts_from_samplenum(ss) | |
287 | pkt = pcap_usb_pkt(request, ts, True) | |
502acfc2 UH |
288 | self.putb(ss, [0, pkt.record_header()]) |
289 | self.putb(ss, [0, pkt.packet()]) | |
bd0e7d2e SB |
290 | |
291 | if request_end == 1: | |
292 | # Write annotation. | |
293 | summary = self.request_summary(request) | |
294 | if request['type'] == 'SETUP IN': | |
295 | self.putr(ss, es, [0, ['SETUP in: %s' % summary]]) | |
296 | elif request['type'] == 'SETUP OUT': | |
297 | self.putr(ss, es, [1, ['SETUP out: %s' % summary]]) | |
298 | elif request['type'] == 'BULK IN': | |
299 | self.putr(ss, es, [2, ['BULK in: %s' % summary]]) | |
300 | elif request['type'] == 'BULK OUT': | |
301 | self.putr(ss, es, [3, ['BULK out: %s' % summary]]) | |
302 | ||
303 | # Issue PCAP 'COMPLETE' packet. | |
304 | ts = self.ts_from_samplenum(es) | |
305 | pkt = pcap_usb_pkt(request, ts, False) | |
502acfc2 UH |
306 | self.putb(ss, [0, pkt.record_header()]) |
307 | self.putb(ss, [0, pkt.packet()]) | |
bd0e7d2e SB |
308 | del self.request[(addr, ep)] |
309 | ||
310 | def decode(self, ss, es, data): | |
311 | if not self.samplerate: | |
312 | raise SamplerateError('Cannot decode without samplerate.') | |
313 | ptype, pdata = data | |
314 | ||
315 | # We only care about certain packet types for now. | |
316 | if ptype not in ('PACKET'): | |
317 | return | |
318 | ||
319 | pcategory, pname, pinfo = pdata | |
320 | ||
321 | if pcategory == 'TOKEN': | |
322 | if pname == 'SOF': | |
323 | return | |
72b2a50c | 324 | if self.transaction_state == 'TOKEN RECEIVED': |
5b0b88ce | 325 | transaction_timeout = self.es_transaction |
502acfc2 UH |
326 | # Token length is 35 bits, timeout is 16..18 bit times |
327 | # (USB 2.0 7.1.19.1). | |
5b0b88ce | 328 | transaction_timeout += int((self.es_transaction - self.ss_transaction) / 2) |
502acfc2 | 329 | if ss > transaction_timeout: |
5b0b88ce | 330 | self.es_transaction = transaction_timeout |
72b2a50c SB |
331 | self.handshake = 'timeout' |
332 | self.handle_transfer() | |
333 | self.transaction_state = 'IDLE' | |
334 | ||
bd0e7d2e SB |
335 | if self.transaction_state != 'IDLE': |
336 | self.putr(ss, es, [4, ['ERR: received %s token in state %s' % | |
337 | (pname, self.transaction_state)]]) | |
338 | return | |
339 | ||
340 | sync, pid, addr, ep, crc5 = pinfo | |
341 | self.transaction_data = [] | |
5b0b88ce UH |
342 | self.ss_transaction = ss |
343 | self.es_transaction = es | |
bd0e7d2e SB |
344 | self.transaction_state = 'TOKEN RECEIVED' |
345 | self.transaction_ep = ep | |
7c402941 SB |
346 | if ep > 0 and pname == 'IN': |
347 | self.transaction_ep = ep + 0x80 | |
bd0e7d2e SB |
348 | self.transaction_addr = addr |
349 | self.transaction_type = pname # IN OUT SETUP | |
350 | ||
351 | elif pcategory == 'DATA': | |
352 | if self.transaction_state != 'TOKEN RECEIVED': | |
353 | self.putr(ss, es, [4, ['ERR: received %s token in state %s' % | |
354 | (pname, self.transaction_state)]]) | |
355 | return | |
356 | ||
357 | self.transaction_data = pinfo[2] | |
358 | self.transaction_state = 'DATA RECEIVED' | |
359 | ||
360 | elif pcategory == 'HANDSHAKE': | |
361 | if self.transaction_state not in ('TOKEN RECEIVED', 'DATA RECEIVED'): | |
362 | self.putr(ss, es, [4, ['ERR: received %s token in state %s' % | |
363 | (pname, self.transaction_state)]]) | |
364 | return | |
365 | ||
366 | self.handshake = pname | |
367 | self.transaction_state = 'IDLE' | |
5b0b88ce | 368 | self.es_transaction = es |
bd0e7d2e SB |
369 | self.handle_transfer() |
370 | ||
be0f8fee SB |
371 | elif pname == 'PRE': |
372 | return | |
373 | ||
bd0e7d2e SB |
374 | else: |
375 | self.putr(ss, es, [4, ['ERR: received unhandled %s token in state %s' % | |
376 | (pname, self.transaction_state)]]) | |
377 | return |