srd: handle missing module docstrings better

[libsigrokdecode.git] / decoders / srd_usb.py

diff --git a/decoders/srd_usb.py b/decoders/srd_usb.py
index ce1bd68339e04d087ba12c48220ed11c5b11b876..6cf8c2d77a48193fc5cfca08586051099b70b3df 100644 (file)
--- a/decoders/srd_usb.py
+++ b/decoders/srd_usb.py
@@ -40,10 +40,12 @@
 # http://www.usb.org/developers/docs/
 #
 
-import sigrokdecode
+import sigrokdecode as srd
 
 # States
 SE0, J, K, SE1 = 0, 1, 2, 3
+
+# ...
 syms = {
         (0, 0): SE0,
         (1, 0): J,
@@ -51,29 +53,32 @@ syms = {
         (1, 1): SE1,
 }
 
+# ...
+pids = {
+    '10000111': 'OUT',      # Tokens
+    '10010110': 'IN',
+    '10100101': 'SOF',
+    '10110100': 'SETUP',
+    '11000011': 'DATA0',    # Data
+    '11010010': 'DATA1',
+    '01001011': 'ACK',      # Handshake
+    '01011010': 'NAK',
+    '01111000': 'STALL',
+    '01101001': 'NYET',
+}
+
 def bitstr_to_num(bitstr):
-    if not bitstr: return 0
+    if not bitstr:
+        return 0
     l = list(bitstr)
     l.reverse()
     return int(''.join(l), 2)
 
 def packet_decode(packet):
-    pids = {
-        '10000111':'OUT',      # Tokens
-        '10010110':'IN',
-        '10100101':'SOF',
-        '10110100':'SETUP',
-        '11000011':'DATA0',    # Data
-        '11010010':'DATA1',
-        '01001011':'ACK',      # Handshake
-        '01011010':'NAK',
-        '01111000':'STALL',
-        '01101001':'NYET',
-    }
-
     sync = packet[:8]
     pid = packet[8:16]
     pid = pids.get(pid, pid)
+
     # Remove CRC.
     if pid in ('OUT', 'IN', 'SOF', 'SETUP'):
         data = packet[16:-5]
@@ -82,65 +87,71 @@ def packet_decode(packet):
         else:
             dev = bitstr_to_num(data[:7])
             ep = bitstr_to_num(data[7:])
-            data = "DEV %d EP %d" % (dev, ep)
+            data = 'DEV %d EP %d' % (dev, ep)
 
     elif pid in ('DATA0', 'DATA1'):
         data = packet[16:-16]
-        tmp = ""
+        tmp = ''
         while data:
-            tmp += "%02X " % bitstr_to_num(data[:8])
+            tmp += '%02x ' % bitstr_to_num(data[:8])
             data = data[8:]
         data = tmp
     else:
         data = packet[16:]
 
-    if sync != "00000001":
-        return "SYNC INVALID!"
+    if sync != '00000001':
+        return 'SYNC INVALID!'
 
     return pid + ' ' + data
 
-class Decoder(sigrokdecode.Decoder):
+class Decoder(srd.Decoder):
     id = 'usb'
     name = 'USB'
+    longname = 'Universal Serial Bus'
     desc = 'Universal Serial Bus'
-    longname = '...longname...'
     longdesc = '...longdesc...'
     author = 'Gareth McMullin'
     email = 'gareth@blacksphere.co.nz'
     license = 'gplv2+'
     inputs = ['logic']
     outputs = ['usb']
-    # Probe names with a set of defaults
     probes = [
         {'id': 'dp', 'name': 'D+', 'desc': 'USB D+ signal'},
         {'id': 'dm', 'name': 'D-', 'desc': 'USB D- signal'},
     ]
     options = {}
+    annotations = [
+        ['TODO', 'TODO']
+    ]
 
     def __init__(self):
-        self.output_protocol = None
-        self.output_annotation = None
+        pass
 
     def start(self, metadata):
         self.rate = metadata['samplerate']
-        # self.output_protocol = self.add(2)
-        self.output_annotation = self.add(1)
+
+        # self.out_proto = self.add(srd.OUTPUT_PROTO, 'usb')
+        self.out_ann = self.add(srd.OUTPUT_ANN, 'usb')
+
         if self.rate < 48000000:
-            raise Exception("Sample rate not sufficient for USB decoding")
+            raise Exception('Sample rate not sufficient for USB decoding')
+
         # Initialise decoder state.
         self.sym = J
         self.scount = 0
         self.packet = ''
 
-    def decode(self, timeoffset, duration, data):
-        out = []
+    def decode(self, ss, es, data):
 
         # FIXME
-        for (samplenum, (dp, dm, x, y, z, a)) in data:
+        # for (samplenum, (dp, dm, x, y, z, a)) in data:
+        for (samplenum, (dm, dp)) in data:
 
             self.scount += 1
 
             sym = syms[dp, dm]
+
+            # ...
             if sym == self.sym:
                 continue
 
@@ -152,7 +163,7 @@ class Decoder(sigrokdecode.Decoder):
                 continue
 
             # How many bits since the last transition?
-            if self.packet or self.sym != J:
+            if self.packet != '' or self.sym != J:
                 bitcount = int((self.scount - 1) * 12000000 / self.rate)
             else:
                 bitcount = 0
@@ -160,11 +171,11 @@ class Decoder(sigrokdecode.Decoder):
             if self.sym == SE0:
                 if bitcount == 1:
                     # End-Of-Packet (EOP)
-                    out += [{"type":"usb", "data":self.packet,
-                              "display":packet_decode(self.packet)}]
+                    self.put(0, 0, self.out_ann,
+                             [0, [packet_decode(self.packet), self.packet]])
                 else:
                     # Longer than EOP, assume reset.
-                    out += [{"type":"usb", "display":"RESET"}]
+                    self.put(0, 0, self.out_ann, [0, ['RESET']])
                 self.scount = 0
                 self.sym = sym
                 self.packet = ''
@@ -172,16 +183,13 @@ class Decoder(sigrokdecode.Decoder):
 
             # Add bits to the packet string.
             self.packet += '1' * bitcount
+
             # Handle bit stuffing.
             if bitcount < 6 and sym != SE0:
                 self.packet += '0'
             elif bitcount > 6:
-                out += [{"type":"usb", "display":"BIT STUFF ERROR"}]
+                self.put(0, 0, self.out_ann, [0, ['BIT STUFF ERROR']])
 
             self.scount = 0
             self.sym = sym
 
-        if out != []:
-            # self.put(0, 0, self.output_protocol, out_proto)
-            self.put(0, 0, self.output_annotation, out)
-