## 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, write to the Free Software
-## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+## along with this program; if not, see <http://www.gnu.org/licenses/>.
##
import sigrokdecode as srd
return 64 + len(self.data)
class Decoder(srd.Decoder):
- api_version = 2
+ 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.'
+ desc = 'USB (low-speed/full-speed) transaction/request protocol.'
license = 'gplv2+'
inputs = ['usb_packet']
outputs = ['usb_request']
+ options = (
+ {'id': 'in_request_start', 'desc': 'Start IN requests on',
+ 'default': 'submit', 'values': ('submit', 'first-ack')},
+ )
+ tags = ['PC']
annotations = (
('request-setup-read', 'Setup: Device-to-host'),
('request-setup-write', 'Setup: Host-to-device'),
('errors', 'Unexpected packets'),
)
annotation_rows = (
- ('request', 'USB requests', tuple(range(4))),
+ ('request-setup', 'USB SETUP', (0, 1)),
+ ('request-in', 'USB BULK IN', (2,)),
+ ('request-out', 'USB BULK OUT', (3,)),
('errors', 'Errors', (4,)),
)
binary = (
)
def __init__(self):
- self.samplerate = 8e6 # None
- self.secs_per_sample = float(1) / float(self.samplerate)
+ self.reset()
+
+ def reset(self):
+ self.samplerate = None
self.request = {}
self.request_id = 0
self.transaction_state = 'IDLE'
- self.transaction_ss = None
- self.transaction_es = None
+ self.ss_transaction = None
+ self.es_transaction = None
self.transaction_ep = None
self.transaction_addr = None
self.wrote_pcap_header = False
self.put(ss, es, self.out_ann, data)
def putb(self, ts, data):
- self.put(ts, ts, self.out_bin, data)
+ self.put(ts, ts, self.out_binary, data)
def pcap_global_header(self):
# See https://wiki.wireshark.org/Development/LibpcapFileFormat.
def metadata(self, key, value):
if key == srd.SRD_CONF_SAMPLERATE:
self.samplerate = value
- self.secs_per_sample = float(1) / float(self.samplerate)
+ if self.samplerate:
+ self.secs_per_sample = float(1) / float(self.samplerate)
def start(self):
- self.out_bin = self.register(srd.OUTPUT_BINARY)
+ self.out_binary = self.register(srd.OUTPUT_BINARY)
self.out_ann = self.register(srd.OUTPUT_ANN)
+ self.in_request_start = self.options['in_request_start']
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.transaction_ss, 'es': None,
- 'id': self.request_id, 'addr': addr, 'ep': ep}
+ 'type': None, 'ss': self.ss_transaction, 'es': None,
+ 'ss_data': 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'
+ if len(request['data']) == 0 and len(self.transaction_data) > 0:
+ request['ss_data'] = self.ss_transaction
request['data'] += self.transaction_data
- request['es'] = self.transaction_es
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
- request['es'] = self.transaction_es
+ if self.handshake == 'ACK':
+ request['data'] += self.transaction_data
self.handle_request(request_started, request_end)
# CONTROL, SETUP stage
- elif request['type'] == None and self.transaction_type == 'SETUP':
+ 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]
request['data'] += self.transaction_data
elif request['type'] == 'SETUP OUT' and self.transaction_type == 'OUT':
- request['data'] += self.transaction_data
+ if self.handshake == 'ACK':
+ 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':
- request['es'] = self.transaction_es
self.handle_request(0, request_end)
elif request['type'] == 'SETUP OUT' and self.transaction_type == 'IN':
- request['es'] = self.transaction_es
self.handle_request(0, request_end)
else:
def write_pcap_header(self):
if not self.wrote_pcap_header:
- self.put(0, 0, self.out_bin, (0, self.pcap_global_header()))
+ self.put(0, 0, self.out_binary, [0, self.pcap_global_header()])
self.wrote_pcap_header = True
def request_summary(self, request):
s += ' ]['
for b in request['data']:
s += ' %02X' % b
- s += ' ] : %s' % self.handshake
+ s += ' ] : %s' % request['handshake']
return s
def handle_request(self, request_start, request_end):
addr = self.transaction_addr
request = self.request[(addr, ep)]
- ss, es = request['ss'], request['es']
+ ss, es, ss_data = request['ss'], request['es'], request['ss_data']
+ if self.in_request_start == 'submit':
+ ss_data = ss
if request_start == 1:
# Issue PCAP 'SUBMIT' packet.
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]])
+ self.putr(ss_data, es, [2, ['BULK in: %s' % summary]])
elif request['type'] == 'BULK OUT':
self.putr(ss, es, [3, ['BULK out: %s' % summary]])
if pname == 'SOF':
return
if self.transaction_state == 'TOKEN RECEIVED':
- transaction_timeout = self.transaction_es
+ 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.transaction_es - self.transaction_ss) / 2)
+ transaction_timeout += int((self.es_transaction - self.ss_transaction) / 2)
if ss > transaction_timeout:
- self.transaction_es = transaction_timeout
+ self.es_transaction = transaction_timeout
self.handshake = 'timeout'
self.handle_transfer()
self.transaction_state = 'IDLE'
sync, pid, addr, ep, crc5 = pinfo
self.transaction_data = []
- self.transaction_ss = ss
- self.transaction_es = es
+ self.ss_transaction = ss
+ self.es_transaction = es
self.transaction_state = 'TOKEN RECEIVED'
self.transaction_ep = ep
+ if ep > 0 and pname == 'IN':
+ self.transaction_ep = ep + 0x80
self.transaction_addr = addr
self.transaction_type = pname # IN OUT SETUP
self.handshake = pname
self.transaction_state = 'IDLE'
- self.transaction_es = es
+ self.es_transaction = es
self.handle_transfer()
elif pname == 'PRE':