[libsigrokdecode.git] / decoders / usb_request / pd.py

##
## This file is part of the libsigrokdecode project.
##
## Copyright (C) 2015 Stefan Brüns <stefan.bruens@rwth-aachen.de>
##
## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 2 of the License, or
## (at your option) any later version.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with this program; if not, see <http://www.gnu.org/licenses/>.
##

import sigrokdecode as srd
import struct

class SamplerateError(Exception):
    pass

class pcap_usb_pkt():
    # Linux usbmon format, see Documentation/usb/usbmon.txt
    h  = b'\x00\x00\x00\x00' # ID part 1
    h += b'\x00\x00\x00\x00' # ID part 2
    h += b'C'                # 'S'ubmit / 'C'omplete / 'E'rror
    h += b'\x03'             # ISO (0), Intr, Control, Bulk (3)
    h += b'\x00'             # Endpoint
    h += b'\x00'             # Device address
    h += b'\x00\x00'         # Bus number
    h += b'-'                # Setup tag - 0: Setup present, '-' otherwise
    h += b'<'                # Data tag - '<' no data, 0 otherwise
    # Timestamp
    h += b'\x00\x00\x00\x00' # TS seconds part 1
    h += b'\x00\x00\x00\x00' # TS seconds part 2
    h += b'\x00\x00\x00\x00' # TS useconds
    #
    h += b'\x00\x00\x00\x00' # Status 0: OK
    h += b'\x00\x00\x00\x00' # URB length
    h += b'\x00\x00\x00\x00' # Data length
    # Setup packet data, valid if setup tag == 0
    h += b'\x00'             # bmRequestType
    h += b'\x00'             # bRequest
    h += b'\x00\x00'         # wValue
    h += b'\x00\x00'         # wIndex
    h += b'\x00\x00'         # wLength
    #
    h += b'\x00\x00\x00\x00' # ISO/interrupt interval
    h += b'\x00\x00\x00\x00' # ISO start frame
    h += b'\x00\x00\x00\x00' # URB flags
    h += b'\x00\x00\x00\x00' # Number of ISO descriptors

    def __init__(self, req, ts, is_submit):
        self.header = bytearray(pcap_usb_pkt.h)
        self.data = b''
        self.set_urbid(req['id'])
        self.set_urbtype('S' if is_submit else 'C')
        self.set_timestamp(ts)
        self.set_addr_ep(req['addr'], req['ep'])
        if req['type'] in ('SETUP IN', 'SETUP OUT'):
            self.set_transfertype(2) # Control
            self.set_setup(req['setup_data'])
        if req['type'] in ('BULK IN'):
            self.set_addr_ep(req['addr'], 0x80 | req['ep'])
        self.set_data(req['data'])

    def set_urbid(self, urbid):
        self.header[4:8] = struct.pack('>I', urbid)

    def set_urbtype(self, urbtype):
        self.header[8] = ord(urbtype)

    def set_transfertype(self, transfertype):
        self.header[9] = transfertype

    def set_addr_ep(self, addr, ep):
        self.header[11] = addr
        self.header[10] = ep

    def set_timestamp(self, ts):
        self.timestamp = ts
        self.header[20:24] = struct.pack('>I', ts[0]) # seconds
        self.header[24:28] = struct.pack('>I', ts[1]) # microseconds

    def set_data(self, data):
        self.data = data
        self.header[15] = 0
        self.header[36:40] = struct.pack('>I', len(data))

    def set_setup(self, data):
        self.header[14] = 0
        self.header[40:48] = data

    def packet(self):
        return bytes(self.header) + bytes(self.data)

    def record_header(self):
        # See https://wiki.wireshark.org/Development/LibpcapFileFormat.
        (secs, usecs) = self.timestamp
        h  = struct.pack('>I', secs) # TS seconds
        h += struct.pack('>I', usecs) # TS microseconds
        # No truncation, so both lengths are the same.
        h += struct.pack('>I', len(self)) # Captured len (usb hdr + data)
        h += struct.pack('>I', len(self)) # Original len
        return h

    def __len__(self):
        return 64 + len(self.data)

class Decoder(srd.Decoder):
    api_version = 3
    id = 'usb_request'
    name = 'USB request'
    longname = 'Universal Serial Bus (LS/FS) transaction/request'
    desc = 'USB (low-speed and full-speed) transaction/request protocol.'
    license = 'gplv2+'
    inputs = ['usb_packet']
    outputs = ['usb_request']
    annotations = (
        ('request-setup-read', 'Setup: Device-to-host'),
        ('request-setup-write', 'Setup: Host-to-device'),
        ('request-bulk-read', 'Bulk: Device-to-host'),
        ('request-bulk-write', 'Bulk: Host-to-device'),
        ('errors', 'Unexpected packets'),
    )
    annotation_rows = (
        ('request', 'USB requests', tuple(range(4))),
        ('errors', 'Errors', (4,)),
    )
    binary = (
        ('pcap', 'PCAP format'),
    )

    def __init__(self):
        self.samplerate = None
        self.request = {}
        self.request_id = 0
        self.transaction_state = 'IDLE'
        self.ss_transaction = None
        self.es_transaction = None
        self.transaction_ep = None
        self.transaction_addr = None
        self.wrote_pcap_header = False

    def putr(self, ss, es, data):
        self.put(ss, es, self.out_ann, data)

    def putb(self, ts, data):
        self.put(ts, ts, self.out_binary, data)

    def pcap_global_header(self):
        # See https://wiki.wireshark.org/Development/LibpcapFileFormat.
        h  = b'\xa1\xb2\xc3\xd4' # Magic, indicate microsecond ts resolution
        h += b'\x00\x02'         # Major version 2
        h += b'\x00\x04'         # Minor version 4
        h += b'\x00\x00\x00\x00' # Correction vs. UTC, seconds
        h += b'\x00\x00\x00\x00' # Timestamp accuracy
        h += b'\xff\xff\xff\xff' # Max packet len
        # LINKTYPE_USB_LINUX_MMAPPED 220
        # Linux usbmon format, see Documentation/usb/usbmon.txt.
        h += b'\x00\x00\x00\xdc' # Link layer
        return h

    def metadata(self, key, value):
        if key == srd.SRD_CONF_SAMPLERATE:
            self.samplerate = value
            self.secs_per_sample = float(1) / float(self.samplerate)

    def start(self):
        self.out_binary = self.register(srd.OUTPUT_BINARY)
        self.out_ann = self.register(srd.OUTPUT_ANN)

    def handle_transfer(self):
        request_started = 0
        request_end = self.handshake in ('ACK', 'STALL', 'timeout')
        ep = self.transaction_ep
        addr = self.transaction_addr

        # Handle protocol STALLs, condition lasts until next SETUP transfer (8.5.3.4)
        if self.transaction_type == 'SETUP' and (addr, ep) in self.request:
            request = self.request[(addr,ep)]
            if request['type'] in ('SETUP IN', 'SETUP OUT'):
                request['es'] = self.ss_transaction
                self.handle_request(0, 1)

        if not (addr, ep) in self.request:
            self.request[(addr, ep)] = {'setup_data': [], 'data': [],
                'type': None, 'ss': self.ss_transaction, 'es': None,
                'id': self.request_id, 'addr': addr, 'ep': ep}
            self.request_id += 1
            request_started = 1
        request = self.request[(addr,ep)]

        if request_end:
            request['es'] = self.es_transaction
            request['handshake'] = self.handshake

        # BULK or INTERRUPT transfer
        if request['type'] in (None, 'BULK IN') and self.transaction_type == 'IN':
            request['type'] = 'BULK IN'
            request['data'] += self.transaction_data
            self.handle_request(request_started, request_end)
        elif request['type'] in (None, 'BULK OUT') and self.transaction_type == 'OUT':
            request['type'] = 'BULK OUT'
            request['data'] += self.transaction_data
            self.handle_request(request_started, request_end)

        # CONTROL, SETUP stage
        elif request['type'] is None and self.transaction_type == 'SETUP':
            request['setup_data'] = self.transaction_data
            request['wLength'] = struct.unpack('<H',
                bytes(self.transaction_data[6:8]))[0]
            if self.transaction_data[0] & 0x80:
                request['type'] = 'SETUP IN'
                self.handle_request(1, 0)
            else:
                request['type'] = 'SETUP OUT'
                self.handle_request(request['wLength'] == 0, 0)

        # CONTROL, DATA stage
        elif request['type'] == 'SETUP IN' and self.transaction_type == 'IN':
            request['data'] += self.transaction_data

        elif request['type'] == 'SETUP OUT' and self.transaction_type == 'OUT':
            request['data'] += self.transaction_data
            if request['wLength'] == len(request['data']):
                self.handle_request(1, 0)

        # CONTROL, STATUS stage
        elif request['type'] == 'SETUP IN' and self.transaction_type == 'OUT':
            self.handle_request(0, request_end)

        elif request['type'] == 'SETUP OUT' and self.transaction_type == 'IN':
            self.handle_request(0, request_end)

        else:
            return

        return

    def ts_from_samplenum(self, sample):
        ts = float(sample) * self.secs_per_sample
        return (int(ts), int((ts % 1.0) * 1e6))

    def write_pcap_header(self):
        if not self.wrote_pcap_header:
            self.put(0, 0, self.out_binary, [0, self.pcap_global_header()])
            self.wrote_pcap_header = True

    def request_summary(self, request):
        s = '['
        if request['type'] in ('SETUP IN', 'SETUP OUT'):
            for b in request['setup_data']:
                s += ' %02X' % b
            s += ' ]['
        for b in request['data']:
            s += ' %02X' % b
        s += ' ] : %s' % request['handshake']
        return s

    def handle_request(self, request_start, request_end):
        if request_start != 1 and request_end != 1:
            return
        self.write_pcap_header()
        ep = self.transaction_ep
        addr = self.transaction_addr
        request = self.request[(addr, ep)]

        ss, es = request['ss'], request['es']

        if request_start == 1:
            # Issue PCAP 'SUBMIT' packet.
            ts = self.ts_from_samplenum(ss)
            pkt = pcap_usb_pkt(request, ts, True)
            self.putb(ss, [0, pkt.record_header()])
            self.putb(ss, [0, pkt.packet()])

        if request_end == 1:
            # Write annotation.
            summary = self.request_summary(request)
            if request['type'] == 'SETUP IN':
                self.putr(ss, es, [0, ['SETUP in: %s' % summary]])
            elif request['type'] == 'SETUP OUT':
                self.putr(ss, es, [1, ['SETUP out: %s' % summary]])
            elif request['type'] == 'BULK IN':
                self.putr(ss, es, [2, ['BULK in: %s' % summary]])
            elif request['type'] == 'BULK OUT':
                self.putr(ss, es, [3, ['BULK out: %s' % summary]])

            # Issue PCAP 'COMPLETE' packet.
            ts = self.ts_from_samplenum(es)
            pkt = pcap_usb_pkt(request, ts, False)
            self.putb(ss, [0, pkt.record_header()])
            self.putb(ss, [0, pkt.packet()])
            del self.request[(addr, ep)]

    def decode(self, ss, es, data):
        if not self.samplerate:
            raise SamplerateError('Cannot decode without samplerate.')
        ptype, pdata = data

        # We only care about certain packet types for now.
        if ptype not in ('PACKET'):
            return

        pcategory, pname, pinfo = pdata

        if pcategory == 'TOKEN':
            if pname == 'SOF':
                return
            if self.transaction_state == 'TOKEN RECEIVED':
                transaction_timeout = self.es_transaction
                # Token length is 35 bits, timeout is 16..18 bit times
                # (USB 2.0 7.1.19.1).
                transaction_timeout += int((self.es_transaction - self.ss_transaction) / 2)
                if ss > transaction_timeout:
                    self.es_transaction = transaction_timeout
                    self.handshake = 'timeout'
                    self.handle_transfer()
                    self.transaction_state = 'IDLE'

            if self.transaction_state != 'IDLE':
                self.putr(ss, es, [4, ['ERR: received %s token in state %s' %
                    (pname, self.transaction_state)]])
                return

            sync, pid, addr, ep, crc5 = pinfo
            self.transaction_data = []
            self.ss_transaction = ss
            self.es_transaction = es
            self.transaction_state = 'TOKEN RECEIVED'
            self.transaction_ep = ep
            self.transaction_addr = addr
            self.transaction_type = pname # IN OUT SETUP

        elif pcategory == 'DATA':
            if self.transaction_state != 'TOKEN RECEIVED':
                self.putr(ss, es, [4, ['ERR: received %s token in state %s' %
                    (pname, self.transaction_state)]])
                return

            self.transaction_data = pinfo[2]
            self.transaction_state = 'DATA RECEIVED'

        elif pcategory == 'HANDSHAKE':
            if self.transaction_state not in ('TOKEN RECEIVED', 'DATA RECEIVED'):
                self.putr(ss, es, [4, ['ERR: received %s token in state %s' %
                    (pname, self.transaction_state)]])
                return

            self.handshake = pname
            self.transaction_state = 'IDLE'
            self.es_transaction = es
            self.handle_transfer()

        elif pname == 'PRE':
            return

        else:
            self.putr(ss, es, [4, ['ERR: received unhandled %s token in state %s' %
                (pname, self.transaction_state)]])
            return
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'
	119	desc = 'USB (low-speed and full-speed) transaction/request protocol.'
	120	license = 'gplv2+'
	121	inputs = ['usb_packet']
	122	outputs = ['usb_request']
	123	annotations = (
	124	('request-setup-read', 'Setup: Device-to-host'),
	125	('request-setup-write', 'Setup: Host-to-device'),
	126	('request-bulk-read', 'Bulk: Device-to-host'),
	127	('request-bulk-write', 'Bulk: Host-to-device'),
	128	('errors', 'Unexpected packets'),
	129	)
	130	annotation_rows = (
	131	('request', 'USB requests', tuple(range(4))),
	132	('errors', 'Errors', (4,)),
	133	)
	134	binary = (
	135	('pcap', 'PCAP format'),
	136	)
	137
	138	def __init__(self):
4045d684	139	self.samplerate = None
bd0e7d2e SB	140	self.request = {}
	141	self.request_id = 0
	142	self.transaction_state = 'IDLE'
5b0b88ce UH	143	self.ss_transaction = None
5b0b88ce UH	144	self.es_transaction = None
bd0e7d2e SB	145	self.transaction_ep = None
	146	self.transaction_addr = None
	147	self.wrote_pcap_header = False
	148
	149	def putr(self, ss, es, data):
	150	self.put(ss, es, self.out_ann, data)
	151
	152	def putb(self, ts, data):
2f370328	153	self.put(ts, ts, self.out_binary, data)
bd0e7d2e SB	154
	155	def pcap_global_header(self):
	156	# See https://wiki.wireshark.org/Development/LibpcapFileFormat.
	157	h = b'\xa1\xb2\xc3\xd4' # Magic, indicate microsecond ts resolution
	158	h += b'\x00\x02' # Major version 2
	159	h += b'\x00\x04' # Minor version 4
	160	h += b'\x00\x00\x00\x00' # Correction vs. UTC, seconds
	161	h += b'\x00\x00\x00\x00' # Timestamp accuracy
	162	h += b'\xff\xff\xff\xff' # Max packet len
	163	# LINKTYPE_USB_LINUX_MMAPPED 220
	164	# Linux usbmon format, see Documentation/usb/usbmon.txt.
	165	h += b'\x00\x00\x00\xdc' # Link layer
	166	return h
	167
	168	def metadata(self, key, value):
	169	if key == srd.SRD_CONF_SAMPLERATE:
	170	self.samplerate = value
	171	self.secs_per_sample = float(1) / float(self.samplerate)
	172
	173	def start(self):
2f370328	174	self.out_binary = self.register(srd.OUTPUT_BINARY)
bd0e7d2e SB	175	self.out_ann = self.register(srd.OUTPUT_ANN)
	176
	177	def handle_transfer(self):
	178	request_started = 0
72b2a50c	179	request_end = self.handshake in ('ACK', 'STALL', 'timeout')
bd0e7d2e SB	180	ep = self.transaction_ep
bd0e7d2e SB	181	addr = self.transaction_addr
fc9d619c SB	182
	183	# Handle protocol STALLs, condition lasts until next SETUP transfer (8.5.3.4)
	184	if self.transaction_type == 'SETUP' and (addr, ep) in self.request:
	185	request = self.request[(addr,ep)]
	186	if request['type'] in ('SETUP IN', 'SETUP OUT'):
	187	request['es'] = self.ss_transaction
	188	self.handle_request(0, 1)
	189
bd0e7d2e SB	190	if not (addr, ep) in self.request:
bd0e7d2e SB	191	self.request[(addr, ep)] = {'setup_data': [], 'data': [],
5b0b88ce	192	'type': None, 'ss': self.ss_transaction, 'es': None,
bd0e7d2e SB	193	'id': self.request_id, 'addr': addr, 'ep': ep}
	194	self.request_id += 1
	195	request_started = 1
	196	request = self.request[(addr,ep)]
	197
fc9d619c	198	if request_end:
b677e536	199	request['es'] = self.es_transaction
fc9d619c SB	200	request['handshake'] = self.handshake
fc9d619c SB	201
bd0e7d2e SB	202	# BULK or INTERRUPT transfer
	203	if request['type'] in (None, 'BULK IN') and self.transaction_type == 'IN':
	204	request['type'] = 'BULK IN'
	205	request['data'] += self.transaction_data
bd0e7d2e SB	206	self.handle_request(request_started, request_end)
	207	elif request['type'] in (None, 'BULK OUT') and self.transaction_type == 'OUT':
	208	request['type'] = 'BULK OUT'
	209	request['data'] += self.transaction_data
bd0e7d2e SB	210	self.handle_request(request_started, request_end)
	211
	212	# CONTROL, SETUP stage
8657abb6	213	elif request['type'] is None and self.transaction_type == 'SETUP':
bd0e7d2e SB	214	request['setup_data'] = self.transaction_data
	215	request['wLength'] = struct.unpack('<H',
	216	bytes(self.transaction_data[6:8]))[0]
	217	if self.transaction_data[0] & 0x80:
	218	request['type'] = 'SETUP IN'
	219	self.handle_request(1, 0)
	220	else:
	221	request['type'] = 'SETUP OUT'
	222	self.handle_request(request['wLength'] == 0, 0)
	223
	224	# CONTROL, DATA stage
	225	elif request['type'] == 'SETUP IN' and self.transaction_type == 'IN':
	226	request['data'] += self.transaction_data
	227
	228	elif request['type'] == 'SETUP OUT' and self.transaction_type == 'OUT':
	229	request['data'] += self.transaction_data
	230	if request['wLength'] == len(request['data']):
	231	self.handle_request(1, 0)
	232
	233	# CONTROL, STATUS stage
	234	elif request['type'] == 'SETUP IN' and self.transaction_type == 'OUT':
bd0e7d2e SB	235	self.handle_request(0, request_end)
	236
	237	elif request['type'] == 'SETUP OUT' and self.transaction_type == 'IN':
bd0e7d2e SB	238	self.handle_request(0, request_end)
	239
	240	else:
	241	return
	242
	243	return
	244
	245	def ts_from_samplenum(self, sample):
	246	ts = float(sample) * self.secs_per_sample
	247	return (int(ts), int((ts % 1.0) * 1e6))
	248
	249	def write_pcap_header(self):
	250	if not self.wrote_pcap_header:
2f370328	251	self.put(0, 0, self.out_binary, [0, self.pcap_global_header()])
bd0e7d2e SB	252	self.wrote_pcap_header = True
	253
	254	def request_summary(self, request):
	255	s = '['
	256	if request['type'] in ('SETUP IN', 'SETUP OUT'):
	257	for b in request['setup_data']:
	258	s += ' %02X' % b
	259	s += ' ]['
	260	for b in request['data']:
	261	s += ' %02X' % b
fc9d619c	262	s += ' ] : %s' % request['handshake']
bd0e7d2e SB	263	return s
	264
	265	def handle_request(self, request_start, request_end):
	266	if request_start != 1 and request_end != 1:
	267	return
	268	self.write_pcap_header()
	269	ep = self.transaction_ep
	270	addr = self.transaction_addr
	271	request = self.request[(addr, ep)]
	272
	273	ss, es = request['ss'], request['es']
	274
	275	if request_start == 1:
	276	# Issue PCAP 'SUBMIT' packet.
	277	ts = self.ts_from_samplenum(ss)
	278	pkt = pcap_usb_pkt(request, ts, True)
502acfc2 UH	279	self.putb(ss, [0, pkt.record_header()])
502acfc2 UH	280	self.putb(ss, [0, pkt.packet()])
bd0e7d2e SB	281
	282	if request_end == 1:
	283	# Write annotation.
	284	summary = self.request_summary(request)
	285	if request['type'] == 'SETUP IN':
	286	self.putr(ss, es, [0, ['SETUP in: %s' % summary]])
	287	elif request['type'] == 'SETUP OUT':
	288	self.putr(ss, es, [1, ['SETUP out: %s' % summary]])
	289	elif request['type'] == 'BULK IN':
	290	self.putr(ss, es, [2, ['BULK in: %s' % summary]])
	291	elif request['type'] == 'BULK OUT':
	292	self.putr(ss, es, [3, ['BULK out: %s' % summary]])
	293
	294	# Issue PCAP 'COMPLETE' packet.
	295	ts = self.ts_from_samplenum(es)
	296	pkt = pcap_usb_pkt(request, ts, False)
502acfc2 UH	297	self.putb(ss, [0, pkt.record_header()])
502acfc2 UH	298	self.putb(ss, [0, pkt.packet()])
bd0e7d2e SB	299	del self.request[(addr, ep)]
	300
	301	def decode(self, ss, es, data):
	302	if not self.samplerate:
	303	raise SamplerateError('Cannot decode without samplerate.')
	304	ptype, pdata = data
	305
	306	# We only care about certain packet types for now.
	307	if ptype not in ('PACKET'):
	308	return
	309
	310	pcategory, pname, pinfo = pdata
	311
	312	if pcategory == 'TOKEN':
	313	if pname == 'SOF':
	314	return
72b2a50c	315	if self.transaction_state == 'TOKEN RECEIVED':
5b0b88ce	316	transaction_timeout = self.es_transaction
502acfc2 UH	317	# Token length is 35 bits, timeout is 16..18 bit times
502acfc2 UH	318	# (USB 2.0 7.1.19.1).
5b0b88ce	319	transaction_timeout += int((self.es_transaction - self.ss_transaction) / 2)
502acfc2	320	if ss > transaction_timeout:
5b0b88ce	321	self.es_transaction = transaction_timeout
72b2a50c SB	322	self.handshake = 'timeout'
	323	self.handle_transfer()
	324	self.transaction_state = 'IDLE'
	325
bd0e7d2e SB	326	if self.transaction_state != 'IDLE':
	327	self.putr(ss, es, [4, ['ERR: received %s token in state %s' %
	328	(pname, self.transaction_state)]])
	329	return
	330
	331	sync, pid, addr, ep, crc5 = pinfo
	332	self.transaction_data = []
5b0b88ce UH	333	self.ss_transaction = ss
5b0b88ce UH	334	self.es_transaction = es
bd0e7d2e SB	335	self.transaction_state = 'TOKEN RECEIVED'
	336	self.transaction_ep = ep
	337	self.transaction_addr = addr
	338	self.transaction_type = pname # IN OUT SETUP
	339
	340	elif pcategory == 'DATA':
	341	if self.transaction_state != 'TOKEN RECEIVED':
	342	self.putr(ss, es, [4, ['ERR: received %s token in state %s' %
	343	(pname, self.transaction_state)]])
	344	return
	345
	346	self.transaction_data = pinfo[2]
	347	self.transaction_state = 'DATA RECEIVED'
	348
	349	elif pcategory == 'HANDSHAKE':
	350	if self.transaction_state not in ('TOKEN RECEIVED', 'DATA RECEIVED'):
	351	self.putr(ss, es, [4, ['ERR: received %s token in state %s' %
	352	(pname, self.transaction_state)]])
	353	return
	354
	355	self.handshake = pname
	356	self.transaction_state = 'IDLE'
5b0b88ce	357	self.es_transaction = es
bd0e7d2e SB	358	self.handle_transfer()
bd0e7d2e SB	359
be0f8fee SB	360	elif pname == 'PRE':
	361	return
	362
bd0e7d2e SB	363	else:
	364	self.putr(ss, es, [4, ['ERR: received unhandled %s token in state %s' %
	365	(pname, self.transaction_state)]])
	366	return