Rename usb_protocol to usb_packet.
authorUwe Hermann <uwe@hermann-uwe.de>
Wed, 2 Oct 2013 17:29:54 +0000 (19:29 +0200)
committerUwe Hermann <uwe@hermann-uwe.de>
Thu, 10 Oct 2013 22:46:11 +0000 (00:46 +0200)
There will be further PDs that are stacked on top of usb_packet.

configure.ac
decoders/Makefile.am
decoders/usb_packet/Makefile.am [new file with mode: 0644]
decoders/usb_packet/__init__.py [new file with mode: 0644]
decoders/usb_packet/pd.py [new file with mode: 0644]
decoders/usb_protocol/Makefile.am [deleted file]
decoders/usb_protocol/__init__.py [deleted file]
decoders/usb_protocol/pd.py [deleted file]

index 0fd8918658698f2806c7bd82dcb8e61fe757de08..ca856485ad0ff43296a65d78b6f66170cc258b02 100644 (file)
@@ -181,7 +181,7 @@ AC_CONFIG_FILES([Makefile
                 decoders/transitioncounter/Makefile
                 decoders/uart/Makefile
                 decoders/uart_dump/Makefile
-                decoders/usb_protocol/Makefile
+                decoders/usb_packet/Makefile
                 decoders/usb_signalling/Makefile
                 decoders/xfp/Makefile
                ])
index ea8091fec8de93e23cef87658a9bfb5445236961..34843f2b2463f68821c8562f0bcc65922e865190 100644 (file)
@@ -49,7 +49,7 @@ SUBDIRS = \
        transitioncounter \
        uart \
        uart_dump \
-       usb_protocol \
+       usb_packet \
        usb_signalling \
        xfp
 
diff --git a/decoders/usb_packet/Makefile.am b/decoders/usb_packet/Makefile.am
new file mode 100644 (file)
index 0000000..f095957
--- /dev/null
@@ -0,0 +1,26 @@
+##
+## This file is part of the libsigrokdecode project.
+##
+## Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.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, write to the Free Software
+## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+##
+
+pkgdatadir = $(DECODERS_DIR)/usb_packet
+
+dist_pkgdata_DATA = __init__.py pd.py
+
+CLEANFILES = *.pyc
+
diff --git a/decoders/usb_packet/__init__.py b/decoders/usb_packet/__init__.py
new file mode 100644 (file)
index 0000000..555dc7f
--- /dev/null
@@ -0,0 +1,47 @@
+##
+## This file is part of the libsigrokdecode project.
+##
+## Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.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, write to the Free Software
+## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+##
+
+'''
+USB (low-speed and full-speed) packet protocol decoder.
+
+Protocol layer (USB spec, chapter 8):
+
+Bit/byte ordering: Bits are sent onto the bus LSB-first. Multibyte fields
+are transmitted in little-endian order (i.e., LSB to MSB).
+
+SYNC field: All packets begin with a SYNC field (8 bits).
+
+Packet field format: Packets start with an SOP (Start Of Packet) delimiter
+that is part of the SYNC field, and end with an EOP (End Of Packet).
+
+PID: A PID (packet identifier) follows the SYNC field of every packet. A PID
+consists of a 4-bit packet type field, and a 4 bit check field.
+The check field is the one's complement of the packet type field.
+
+Protocol output format:
+TODO
+
+Details:
+https://en.wikipedia.org/wiki/USB
+http://www.usb.org/developers/docs/
+'''
+
+from .pd import *
+
diff --git a/decoders/usb_packet/pd.py b/decoders/usb_packet/pd.py
new file mode 100644 (file)
index 0000000..b8c668e
--- /dev/null
@@ -0,0 +1,137 @@
+##
+## This file is part of the libsigrokdecode project.
+##
+## Copyright (C) 2011 Gareth McMullin <gareth@blacksphere.co.nz>
+## Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.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, write to the Free Software
+## 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
+
+# Packet IDs (PIDs).
+# The first 4 bits are the 'packet type' field, the last 4 bits are the
+# 'check field' (each bit in the check field must be the inverse of the resp.
+# bit in the 'packet type' field; if not, that's a 'PID error').
+# For the 4-bit strings, the left-most '1' or '0' is the LSB, i.e. it's sent
+# to the bus first.
+pids = {
+    # Tokens
+    '10000111': ['OUT', 'Address & EP number in host-to-function transaction'],
+    '10010110': ['IN', 'Address & EP number in function-to-host transaction'],
+    '10100101': ['SOF', 'Start-Of-Frame marker & frame number'],
+    '10110100': ['SETUP', 'Address & EP number in host-to-function transaction for SETUP to a control pipe'],
+
+    # Data
+    # Note: DATA2 and MDATA are HS-only.
+    '11000011': ['DATA0', 'Data packet PID even'],
+    '11010010': ['DATA1', 'Data packet PID odd'],
+    '11100001': ['DATA2', 'Data packet PID HS, high bandwidth isosynchronous transaction in a microframe'],
+    '11110000': ['MDATA', 'Data packet PID HS for split and high-bandwidth isosynchronous transactions'],
+
+    # Handshake
+    '01001011': ['ACK', 'Receiver accepts error-free packet'],
+    '01011010': ['NAK', 'Receiver cannot accept or transmitter cannot send'],
+    '01111000': ['STALL', 'EP halted or control pipe request unsupported'],
+    '01101001': ['NYET', 'No response yet from receiver'],
+
+    # Special
+    '00111100': ['PRE', 'Host-issued preamble; enables downstream bus traffic to low-speed devices'],
+    '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'],
+}
+
+def bitstr_to_num(bitstr):
+    if not bitstr:
+        return 0
+    l = list(bitstr)
+    l.reverse()
+    return int(''.join(l), 2)
+
+def packet_decode(packet):
+    sync = packet[:8]
+    pid = packet[8:16]
+    pid = pids.get(pid, (pid, ''))[0]
+
+    # Remove CRC.
+    if pid in ('OUT', 'IN', 'SOF', 'SETUP'):
+        data = packet[16:-5]
+        if pid == 'SOF':
+            data = str(bitstr_to_num(data))
+        else:
+            dev = bitstr_to_num(data[:7])
+            ep = bitstr_to_num(data[7:])
+            data = 'DEV %d EP %d' % (dev, ep)
+    elif pid in ('DATA0', 'DATA1'):
+        data = packet[16:-16]
+        tmp = ''
+        while data:
+            tmp += '%02x ' % bitstr_to_num(data[:8])
+            data = data[8:]
+        data = tmp
+    else:
+        data = packet[16:]
+
+    # The SYNC pattern for low-speed/full-speed is KJKJKJKK (0001).
+    if sync != '00000001':
+        return 'SYNC INVALID: %s' % sync
+
+    return pid + ' ' + data
+
+class Decoder(srd.Decoder):
+    api_version = 1
+    id = 'usb_packet'
+    name = 'USB packet'
+    longname = 'Universal Serial Bus (LS/FS) packet'
+    desc = 'USB (low-speed and full-speed) packet protocol.'
+    license = 'gplv2+'
+    inputs = ['usb_signalling']
+    outputs = ['usb_packet']
+    probes = []
+    optional_probes = []
+    options = {
+        'signalling': ['Signalling', 'full-speed'],
+    }
+    annotations = [
+        ['Text', 'Human-readable text']
+    ]
+
+    def __init__(self):
+        self.sym = 'J'
+        self.samplenum = 0
+        self.scount = 0
+        self.packet = ''
+        self.state = 'IDLE'
+
+    def start(self, metadata):
+        self.samplerate = metadata['samplerate']
+        self.out_proto = self.add(srd.OUTPUT_PROTO, 'usb_packet')
+        self.out_ann = self.add(srd.OUTPUT_ANN, 'usb_packet')
+
+    def report(self):
+        pass
+
+    def decode(self, ss, es, data):
+        (ptype, pdata) = data
+
+        if ptype == 'PACKET':
+            self.put(0, 0, self.out_ann, [0, [packet_decode(pdata)]])
+
+        # TODO.
+
diff --git a/decoders/usb_protocol/Makefile.am b/decoders/usb_protocol/Makefile.am
deleted file mode 100644 (file)
index 7e1baa6..0000000
+++ /dev/null
@@ -1,26 +0,0 @@
-##
-## This file is part of the libsigrokdecode project.
-##
-## Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.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, write to the Free Software
-## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
-##
-
-pkgdatadir = $(DECODERS_DIR)/usb_protocol
-
-dist_pkgdata_DATA = __init__.py pd.py
-
-CLEANFILES = *.pyc
-
diff --git a/decoders/usb_protocol/__init__.py b/decoders/usb_protocol/__init__.py
deleted file mode 100644 (file)
index 5fa66f6..0000000
+++ /dev/null
@@ -1,47 +0,0 @@
-##
-## This file is part of the libsigrokdecode project.
-##
-## Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.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, write to the Free Software
-## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
-##
-
-'''
-USB (low-speed and full-speed) protocol decoder.
-
-Protocol layer (USB spec, chapter 8):
-
-Bit/byte ordering: Bits are sent onto the bus LSB-first. Multibyte fields
-are transmitted in little-endian order (i.e., LSB to MSB).
-
-SYNC field: All packets begin with a SYNC field (8 bits).
-
-Packet field format: Packets start with an SOP (Start Of Packet) delimiter
-that is part of the SYNC field, and end with an EOP (End Of Packet).
-
-PID: A PID (packet identifier) follows the SYNC field of every packet. A PID
-consists of a 4-bit packet type field, and a 4 bit check field.
-The check field is the one's complement of the packet type field.
-
-Protocol output format:
-TODO
-
-Details:
-https://en.wikipedia.org/wiki/USB
-http://www.usb.org/developers/docs/
-'''
-
-from .pd import *
-
diff --git a/decoders/usb_protocol/pd.py b/decoders/usb_protocol/pd.py
deleted file mode 100644 (file)
index 92ee77a..0000000
+++ /dev/null
@@ -1,137 +0,0 @@
-##
-## This file is part of the libsigrokdecode project.
-##
-## Copyright (C) 2011 Gareth McMullin <gareth@blacksphere.co.nz>
-## Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.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, write to the Free Software
-## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
-##
-
-# USB (low-speed and full-speed) protocol decoder
-
-import sigrokdecode as srd
-
-# Packet IDs (PIDs).
-# The first 4 bits are the 'packet type' field, the last 4 bits are the
-# 'check field' (each bit in the check field must be the inverse of the resp.
-# bit in the 'packet type' field; if not, that's a 'PID error').
-# For the 4-bit strings, the left-most '1' or '0' is the LSB, i.e. it's sent
-# to the bus first.
-pids = {
-    # Tokens
-    '10000111': ['OUT', 'Address & EP number in host-to-function transaction'],
-    '10010110': ['IN', 'Address & EP number in function-to-host transaction'],
-    '10100101': ['SOF', 'Start-Of-Frame marker & frame number'],
-    '10110100': ['SETUP', 'Address & EP number in host-to-function transaction for SETUP to a control pipe'],
-
-    # Data
-    # Note: DATA2 and MDATA are HS-only.
-    '11000011': ['DATA0', 'Data packet PID even'],
-    '11010010': ['DATA1', 'Data packet PID odd'],
-    '11100001': ['DATA2', 'Data packet PID HS, high bandwidth isosynchronous transaction in a microframe'],
-    '11110000': ['MDATA', 'Data packet PID HS for split and high-bandwidth isosynchronous transactions'],
-
-    # Handshake
-    '01001011': ['ACK', 'Receiver accepts error-free packet'],
-    '01011010': ['NAK', 'Receiver cannot accept or transmitter cannot send'],
-    '01111000': ['STALL', 'EP halted or control pipe request unsupported'],
-    '01101001': ['NYET', 'No response yet from receiver'],
-
-    # Special
-    '00111100': ['PRE', 'Host-issued preamble; enables downstream bus traffic to low-speed devices'],
-    '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'],
-}
-
-def bitstr_to_num(bitstr):
-    if not bitstr:
-        return 0
-    l = list(bitstr)
-    l.reverse()
-    return int(''.join(l), 2)
-
-def packet_decode(packet):
-    sync = packet[:8]
-    pid = packet[8:16]
-    pid = pids.get(pid, (pid, ''))[0]
-
-    # Remove CRC.
-    if pid in ('OUT', 'IN', 'SOF', 'SETUP'):
-        data = packet[16:-5]
-        if pid == 'SOF':
-            data = str(bitstr_to_num(data))
-        else:
-            dev = bitstr_to_num(data[:7])
-            ep = bitstr_to_num(data[7:])
-            data = 'DEV %d EP %d' % (dev, ep)
-    elif pid in ('DATA0', 'DATA1'):
-        data = packet[16:-16]
-        tmp = ''
-        while data:
-            tmp += '%02x ' % bitstr_to_num(data[:8])
-            data = data[8:]
-        data = tmp
-    else:
-        data = packet[16:]
-
-    # The SYNC pattern for low-speed/full-speed is KJKJKJKK (0001).
-    if sync != '00000001':
-        return 'SYNC INVALID: %s' % sync
-
-    return pid + ' ' + data
-
-class Decoder(srd.Decoder):
-    api_version = 1
-    id = 'usb_protocol'
-    name = 'USB protocol'
-    longname = 'Universal Serial Bus (LS/FS) protocol'
-    desc = 'USB (low-speed and full-speed) serial protocol.'
-    license = 'gplv2+'
-    inputs = ['usb_signalling']
-    outputs = ['usb_protocol']
-    probes = []
-    optional_probes = []
-    options = {
-        'signalling': ['Signalling', 'full-speed'],
-    }
-    annotations = [
-        ['Text', 'Human-readable text']
-    ]
-
-    def __init__(self):
-        self.sym = 'J'
-        self.samplenum = 0
-        self.scount = 0
-        self.packet = ''
-        self.state = 'IDLE'
-
-    def start(self, metadata):
-        self.samplerate = metadata['samplerate']
-        self.out_proto = self.add(srd.OUTPUT_PROTO, 'usb_protocol')
-        self.out_ann = self.add(srd.OUTPUT_ANN, 'usb_protocol')
-
-    def report(self):
-        pass
-
-    def decode(self, ss, es, data):
-        (ptype, pdata) = data
-
-        if ptype == 'PACKET':
-            self.put(0, 0, self.out_ann, [0, [packet_decode(pdata)]])
-
-        # TODO.
-