X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoders%2Fusb_packet%2Fpd.py;h=5dbbcdb2a1cd4956dcdaa6a8dc8a0486e5b931c9;hp=c651a7dade15903733bf9175351630c22fa42794;hb=b0918d40e285e7782f4e86356c41648dc748e477;hpb=0169f19c53e195df2f96c4df731ad3214c59e20a diff --git a/decoders/usb_packet/pd.py b/decoders/usb_packet/pd.py index c651a7d..5dbbcdb 100644 --- a/decoders/usb_packet/pd.py +++ b/decoders/usb_packet/pd.py @@ -2,7 +2,7 @@ ## This file is part of the libsigrokdecode project. ## ## Copyright (C) 2011 Gareth McMullin -## Copyright (C) 2012-2013 Uwe Hermann +## Copyright (C) 2012-2014 Uwe Hermann ## ## 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 @@ -19,12 +19,10 @@ ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA ## -# USB (low-speed and full-speed) packet protocol decoder - import sigrokdecode as srd ''' -Protocol output format: +OUTPUT_PYTHON format: Packet: [, ] @@ -57,7 +55,7 @@ Packet: - 'DATA', 'DATA2', [, , , , ] - 'DATA', 'MDATA', [, , , , ] - 'HANDSHAKE', 'ACK', [, , ] - - 'HANDSHAKE', 'NACK', [, , ] + - 'HANDSHAKE', 'NAK', [, , ] - 'HANDSHAKE', 'STALL', [, , ] - 'HANDSHAKE', 'NYET', [, , ] - 'SPECIAL', 'PRE', [, , , , , ] @@ -124,11 +122,19 @@ def get_category(pidname): return 'TOKEN' elif pidname in ('DATA0', 'DATA1', 'DATA2', 'MDATA'): return 'DATA' - elif pidname in ('ACK', 'NACK', 'STALL', 'NYET'): + elif pidname in ('ACK', 'NAK', 'STALL', 'NYET'): return 'HANDSHAKE' else: return 'SPECIAL' +def ann_index(pidname): + l = ['OUT', 'IN', 'SOF', 'SETUP', 'DATA0', 'DATA1', 'DATA2', 'MDATA', + 'ACK', 'NAK', 'STALL', 'NYET', 'PRE', 'ERR', 'SPLIT', 'PING', + 'Reserved'] + if pidname not in l: + return 28 + return l.index(pidname) + 11 + def bitstr_to_num(bitstr): if not bitstr: return 0 @@ -145,14 +151,45 @@ class Decoder(srd.Decoder): license = 'gplv2+' inputs = ['usb_signalling'] outputs = ['usb_packet'] - probes = [] - optional_probes = [] - options = { - 'signalling': ['Signalling', 'full-speed'], - } - annotations = [ - ['Text', 'Human-readable text'] - ] + options = ( + {'id': 'signalling', 'desc': 'Signalling', + 'default': 'full-speed', 'values': ('full-speed', 'low-speed')}, + ) + annotations = ( + ('sync-ok', 'SYNC'), + ('sync-err', 'SYNC (error)'), + ('pid', 'PID'), + ('framenum', 'FRAMENUM'), + ('addr', 'ADDR'), + ('ep', 'EP'), + ('crc5-ok', 'CRC5'), + ('crc5-err', 'CRC5 (error)'), + ('data', 'DATA'), + ('crc16-ok', 'CRC16'), + ('crc16-err', 'CRC16 (error)'), + ('packet-out', 'Packet: OUT'), + ('packet-in', 'Packet: IN'), + ('packet-sof', 'Packet: SOF'), + ('packet-setup', 'Packet: SETUP'), + ('packet-data0', 'Packet: DATA0'), + ('packet-data1', 'Packet: DATA1'), + ('packet-data2', 'Packet: DATA2'), + ('packet-mdata', 'Packet: MDATA'), + ('packet-ack', 'Packet: ACK'), + ('packet-nak', 'Packet: NAK'), + ('packet-stall', 'Packet: STALL'), + ('packet-nyet', 'Packet: NYET'), + ('packet-pre', 'Packet: PRE'), + ('packet-err', 'Packet: ERR'), + ('packet-split', 'Packet: SPLIT'), + ('packet-ping', 'Packet: PING'), + ('packet-reserved', 'Packet: Reserved'), + ('packet-invalid', 'Packet: Invalid'), + ) + annotation_rows = ( + ('fields', 'Packet fields', tuple(range(11 + 1))), + ('packet', 'Packets', tuple(range(12, 28 + 1))), + ) def __init__(self): self.samplenum = 0 @@ -164,19 +201,19 @@ class Decoder(srd.Decoder): self.state = 'WAIT FOR SOP' def putpb(self, data): - self.put(self.ss, self.es, self.out_proto, data) + self.put(self.ss, self.es, self.out_python, data) def putb(self, data): self.put(self.ss, self.es, self.out_ann, data) def putpp(self, data): - self.put(self.ss_packet, self.es_packet, self.out_proto, data) + self.put(self.ss_packet, self.es_packet, self.out_python, data) def putp(self, data): self.put(self.ss_packet, self.es_packet, self.out_ann, data) def start(self): - self.out_proto = self.register(srd.OUTPUT_PYTHON) + self.out_python = self.register(srd.OUTPUT_PYTHON) self.out_ann = self.register(srd.OUTPUT_ANN) def handle_packet(self): @@ -190,7 +227,7 @@ class Decoder(srd.Decoder): # The SYNC pattern for low-speed/full-speed is KJKJKJKK (00000001). if sync != '00000001': self.putpb(['SYNC ERROR', sync]) - self.putb([0, ['SYNC ERROR: %s' % sync]]) + self.putb([1, ['SYNC ERROR: %s' % sync]]) else: self.putpb(['SYNC', sync]) self.putb([0, ['SYNC: %s' % sync]]) @@ -201,7 +238,7 @@ class Decoder(srd.Decoder): pidname = pids.get(pid, (pid, ''))[0] self.ss, self.es = self.bits[8][1], self.bits[15][2] self.putpb(['PID', pidname]) - self.putb([0, ['PID: %s' % pidname]]) + self.putb([2, ['PID: %s' % pidname]]) self.packet.append(pid) self.packet_summary += pidname @@ -211,7 +248,7 @@ class Decoder(srd.Decoder): framenum = bitstr_to_num(packet[16:26 + 1]) self.ss, self.es = self.bits[16][1], self.bits[26][2] self.putpb(['FRAMENUM', framenum]) - self.putb([0, ['Frame: %d' % framenum]]) + self.putb([3, ['Frame: %d' % framenum]]) self.packet.append(framenum) self.packet_summary += ' %d' % framenum else: @@ -219,7 +256,7 @@ class Decoder(srd.Decoder): addr = bitstr_to_num(packet[16:22 + 1]) self.ss, self.es = self.bits[16][1], self.bits[22][2] self.putpb(['ADDR', addr]) - self.putb([0, ['Addr: %d' % addr]]) + self.putb([4, ['Addr: %d' % addr]]) self.packet.append(addr) self.packet_summary += ' ADDR %d' % addr @@ -227,7 +264,7 @@ class Decoder(srd.Decoder): ep = bitstr_to_num(packet[23:26 + 1]) self.ss, self.es = self.bits[23][1], self.bits[26][2] self.putpb(['EP', ep]) - self.putb([0, ['EP: %d' % ep]]) + self.putb([5, ['EP: %d' % ep]]) self.packet.append(ep) self.packet_summary += ' EP %d' % ep @@ -235,7 +272,7 @@ class Decoder(srd.Decoder): crc5 = bitstr_to_num(packet[27:31 + 1]) self.ss, self.es = self.bits[27][1], self.bits[31][2] self.putpb(['CRC5', crc5]) - self.putb([0, ['CRC5: 0x%02x' % crc5]]) + self.putb([6, ['CRC5: 0x%02x' % crc5]]) self.packet.append(crc5) elif pidname in ('DATA0', 'DATA1', 'DATA2', 'MDATA'): # Bits[16:packetlen-16]: Data @@ -247,13 +284,13 @@ class Decoder(srd.Decoder): db = bitstr_to_num(data[i:i + 8]) self.ss, self.es = self.bits[16 + i][1], self.bits[23 + i][2] self.putpb(['DATABYTE', db]) - self.putb([0, ['Databyte: %02x' % db]]) + self.putb([8, ['Databyte: %02x' % db]]) databytes.append(db) self.packet_summary += ' %02x' % db data = data[8:] self.packet_summary += ' ]' - # Convenience proto output (no annotation) for all bytes together. + # Convenience python output (no annotation) for all bytes together. self.ss, self.es = self.bits[16][1], self.bits[-16][2] self.putpb(['DATABYTES', databytes]) self.packet.append(databytes) @@ -262,7 +299,7 @@ class Decoder(srd.Decoder): crc16 = bitstr_to_num(packet[-16:]) self.ss, self.es = self.bits[-16][1], self.bits[-1][2] self.putpb(['CRC16', crc16]) - self.putb([0, ['CRC16: 0x%04x' % crc16]]) + self.putb([9, ['CRC16: 0x%04x' % crc16]]) self.packet.append(crc16) elif pidname in ('ACK', 'NAK', 'STALL', 'NYET', 'ERR'): pass # Nothing to do, these only have SYNC+PID+EOP fields. @@ -272,7 +309,7 @@ class Decoder(srd.Decoder): # Output a (summary of) the whole packet. pcategory, pname, pinfo = get_category(pidname), pidname, self.packet self.putpp(['PACKET', [pcategory, pname, pinfo]]) - self.putp([0, ['PACKET: %s' % self.packet_summary]]) + self.putp([ann_index(pidname), ['%s' % self.packet_summary]]) self.packet, self.packet_summary = [], ''