X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoders%2Fusb_packet%2Fpd.py;h=aab0c956c11526aa708efb35abbee42604a57d02;hp=f79f2fc7eea420468af5f3b848b83b36cc211bbd;hb=4539e9ca58966ce3c9cad4801b16c315e86ace01;hpb=ef36224880135a05d2fbde8f048ea3fe3f425df9 diff --git a/decoders/usb_packet/pd.py b/decoders/usb_packet/pd.py index f79f2fc..aab0c95 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 @@ -15,14 +15,13 @@ ## 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 . ## import sigrokdecode as srd ''' -Protocol output format: +OUTPUT_PYTHON format: Packet: [, ] @@ -33,7 +32,9 @@ Packet: - 'ADDR', - 'EP', - 'CRC5', + - 'CRC5 ERROR', - 'CRC16', + - 'CRC16 ERROR', - 'EOP', - 'FRAMENUM', - 'DATABYTE', @@ -55,7 +56,7 @@ Packet: - 'DATA', 'DATA2', [, , , , ] - 'DATA', 'MDATA', [, , , , ] - 'HANDSHAKE', 'ACK', [, , ] - - 'HANDSHAKE', 'NACK', [, , ] + - 'HANDSHAKE', 'NAK', [, , ] - 'HANDSHAKE', 'STALL', [, , ] - 'HANDSHAKE', 'NYET', [, , ] - 'SPECIAL', 'PRE', [, , , , , ] @@ -111,7 +112,7 @@ pids = { # Special '00111100': ['PRE', 'Host-issued preamble; enables downstream bus traffic to low-speed devices'], - '00111100': ['ERR', 'Split transaction error handshake'], + #'00111100': ['ERR', 'Split transaction error handshake'], '00011110': ['SPLIT', 'HS split transaction token'], '00101101': ['PING', 'HS flow control probe for a bulk/control EP'], '00001111': ['Reserved', 'Reserved PID'], @@ -122,11 +123,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 @@ -134,8 +143,37 @@ def bitstr_to_num(bitstr): l.reverse() return int(''.join(l), 2) +def reverse_number(num, count): + out = list(count * '0') + for i in range(0, count): + if num >> i & 1: + out[i] = '1'; + return int(''.join(out), 2) + +def calc_crc5(bitstr): + poly5 = 0x25 + crc5 = 0x1f + for bit in bitstr: + crc5 <<= 1 + if int(bit) != (crc5 >> 5): + crc5 ^= poly5 + crc5 &= 0x1f + crc5 ^= 0x1f + return reverse_number(crc5, 5) + +def calc_crc16(bitstr): + poly16 = 0x18005 + crc16 = 0xffff + for bit in bitstr: + crc16 <<= 1 + if int(bit) != (crc16 >> 16): + crc16 ^= poly16 + crc16 &= 0xffff + crc16 ^= 0xffff + return reverse_number(crc16, 16) + class Decoder(srd.Decoder): - api_version = 1 + api_version = 2 id = 'usb_packet' name = 'USB packet' longname = 'Universal Serial Bus (LS/FS) packet' @@ -143,17 +181,47 @@ 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(10 + 1))), + ('packet', 'Packets', tuple(range(11, 28 + 1))), + ) def __init__(self): - self.samplenum = 0 self.bits = [] self.packet = [] self.packet_summary = '' @@ -162,19 +230,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): @@ -182,34 +250,47 @@ class Decoder(srd.Decoder): for (bit, ss, es) in self.bits: packet += bit + if len(packet) < 8: + self.putp([28, ['Invalid packet (shorter than 8 bits)']]) + return + # Bits[0:7]: SYNC sync = packet[:7 + 1] self.ss, self.es = self.bits[0][1], self.bits[7][2] # 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, 'SYNC ERR: %s' % sync, + 'SYNC ERR', 'SE', 'S']]) else: self.putpb(['SYNC', sync]) - self.putb([0, ['SYNC: %s' % sync]]) + self.putb([0, ['SYNC: %s' % sync, 'SYNC', 'S']]) self.packet.append(sync) + if len(packet) < 16: + self.putp([28, ['Invalid packet (shorter than 16 bits)']]) + return + # Bits[8:15]: PID pid = packet[8:15 + 1] - pidname = pids.get(pid, (pid, ''))[0] + pidname = pids.get(pid, ('UNKNOWN', 'Unknown 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, pidname, pidname[0]]]) self.packet.append(pid) self.packet_summary += pidname - if pidname in ('OUT', 'IN', 'SOF', 'SETUP', 'PRE', 'PING'): + if pidname in ('OUT', 'IN', 'SOF', 'SETUP', 'PING'): + if len(packet) < 32: + self.putp([28, ['Invalid packet (shorter than 32 bits)']]) + return + if pidname == 'SOF': # Bits[16:26]: Framenum 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, 'Frame', 'Fr', 'F']]) self.packet.append(framenum) self.packet_summary += ' %d' % framenum else: @@ -217,7 +298,8 @@ 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, ['Address: %d' % addr, 'Addr: %d' % addr, + 'Addr', 'A']]) self.packet.append(addr) self.packet_summary += ' ADDR %d' % addr @@ -225,15 +307,20 @@ 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, ['Endpoint: %d' % ep, 'EP: %d' % ep, 'EP', 'E']]) self.packet.append(ep) self.packet_summary += ' EP %d' % ep # Bits[27:31]: CRC5 crc5 = bitstr_to_num(packet[27:31 + 1]) + crc5_calc = calc_crc5(packet[16:27]) self.ss, self.es = self.bits[27][1], self.bits[31][2] - self.putpb(['CRC5', crc5]) - self.putb([0, ['CRC5: 0x%02x' % crc5]]) + if crc5 == crc5_calc: + self.putpb(['CRC5', crc5]) + self.putb([6, ['CRC5: 0x%02X' % crc5, 'CRC5', 'C']]) + else: + self.putpb(['CRC5 ERROR', crc5]) + self.putb([7, ['CRC5 ERROR: 0x%02X' % crc5, 'CRC5 ERR', 'CE', 'C']]) self.packet.append(crc5) elif pidname in ('DATA0', 'DATA1', 'DATA2', 'MDATA'): # Bits[16:packetlen-16]: Data @@ -245,32 +332,39 @@ 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, 'Data: %02X' % db, + 'DB: %02X' % db, '%02X' % db]]) databytes.append(db) - self.packet_summary += ' %02x' % db - data = data[8:] + self.packet_summary += ' %02X' % db 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) # Bits[packetlen-16:packetlen]: CRC16 crc16 = bitstr_to_num(packet[-16:]) + crc16_calc = calc_crc16(packet[16:-16]) self.ss, self.es = self.bits[-16][1], self.bits[-1][2] - self.putpb(['CRC16', crc16]) - self.putb([0, ['CRC16: 0x%04x' % crc16]]) + if crc16 == crc16_calc: + self.putpb(['CRC16', crc16]) + self.putb([9, ['CRC16: 0x%04X' % crc16, 'CRC16', 'C']]) + else: + self.putpb(['CRC16 ERROR', crc16]) + self.putb([10, ['CRC16 ERROR: 0x%04X' % crc16, 'CRC16 ERR', 'CE', 'C']]) self.packet.append(crc16) elif pidname in ('ACK', 'NAK', 'STALL', 'NYET', 'ERR'): pass # Nothing to do, these only have SYNC+PID+EOP fields. + elif pidname in ('PRE'): + pass # Nothing to do, PRE only has SYNC+PID fields. else: pass # TODO: Handle 'SPLIT' and possibly 'Reserved' packets. # 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 = [], '' @@ -278,7 +372,7 @@ class Decoder(srd.Decoder): (ptype, pdata) = data # We only care about certain packet types for now. - if ptype not in ('SOP', 'BIT', 'EOP'): + if ptype not in ('SOP', 'BIT', 'EOP', 'ERR'): return # State machine. @@ -290,12 +384,10 @@ class Decoder(srd.Decoder): elif self.state == 'GET BIT': if ptype == 'BIT': self.bits.append([pdata, ss, es]) - elif ptype == 'EOP': + elif ptype == 'EOP' or ptype == 'ERR': self.es_packet = es self.handle_packet() + self.packet, self.packet_summary = [], '' self.bits, self.state = [], 'WAIT FOR SOP' else: pass # TODO: Error - else: - raise Exception('Invalid state: %s' % self.state) -