decoders/srd_usb.py

   1 ##
   2 ## This file is part of the sigrok project.
   3 ##
   4 ## Copyright (C) 2011 Gareth McMullin <gareth@blacksphere.co.nz>
   5 ##
   6 ## This program is free software; you can redistribute it and/or modify
   7 ## it under the terms of the GNU General Public License as published by
   8 ## the Free Software Foundation; either version 2 of the License, or
   9 ## (at your option) any later version.
  10 ##
  11 ## This program is distributed in the hope that it will be useful,
  12 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 ## GNU General Public License for more details.
  15 ##
  16 ## You should have received a copy of the GNU General Public License
  17 ## along with this program; if not, write to the Free Software
  18 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19 ##
  20
  21 #
  22 # USB Full-speed protocol decoder
  23 #
  24 # Full-speed USB signalling consists of two signal lines, both driven at 3.3V
  25 # logic levels. The signals are DP (D+) and DM (D-), and normally operate in
  26 # differential mode.
  27 # The state where DP=1,DM=0 is J, the state DP=0,DM=1 is K.
  28 # A state SE0 is defined where DP=DM=0. This common mode signal is used to
  29 # signal a reset or end of packet.
  30 #
  31 # Data transmitted on the USB is encoded with NRZI. A transition from J to K
  32 # or vice-versa indicates a logic 0, while no transition indicates a logic 1.
  33 # If 6 ones are transmitted consecutively, a zero is inserted to force a
  34 # transition. This is known as bit stuffing. Data is transferred at a rate
  35 # of 12Mbit/s. The SE0 transmitted to signal an end-of-packet is two bit
  36 # intervals long.
  37 #
  38 # Details:
  39 # https://en.wikipedia.org/wiki/USB
  40 # http://www.usb.org/developers/docs/
  41 #
  42
  43 import sigrok
  44
  45 class Sample():
  46     def __init__(self, data):
  47         self.data = data
  48     def probe(self, probe):
  49         s = self.data[int(probe / 8)] & (1 << (probe % 8))
  50         return True if s else False
  51
  52 def sampleiter(data, unitsize):
  53     for i in range(0, len(data), unitsize):
  54         yield(Sample(data[i:i+unitsize]))
  55
  56 # States
  57 SE0, J, K, SE1 = 0, 1, 2, 3
  58 syms = {
  59         (False, False): SE0,
  60         (True, False): J,
  61         (False, True): K,
  62         (True, True): SE1,
  63 }
  64
  65 def bitstr_to_num(bitstr):
  66     if not bitstr: return 0
  67     l = list(bitstr)
  68     l.reverse()
  69     return int(''.join(l), 2)
  70
  71 def packet_decode(packet):
  72     pids = {
  73         '10000111':'OUT',      # Tokens
  74         '10010110':'IN',
  75         '10100101':'SOF',
  76         '10110100':'SETUP',
  77         '11000011':'DATA0',    # Data
  78         '11010010':'DATA1',
  79         '01001011':'ACK',      # Handshake
  80         '01011010':'NAK',
  81         '01111000':'STALL',
  82         '01101001':'NYET',
  83     }
  84
  85     sync = packet[:8]
  86     pid = packet[8:16]
  87     pid = pids.get(pid, pid)
  88     # Remove CRC.
  89     if pid in ('OUT', 'IN', 'SOF', 'SETUP'):
  90         data = packet[16:-5]
  91         if pid == 'SOF':
  92             data = str(bitstr_to_num(data))
  93         else:
  94             dev = bitstr_to_num(data[:7])
  95             ep = bitstr_to_num(data[7:])
  96             data = "DEV %d EP %d" % (dev, ep)
  97
  98     elif pid in ('DATA0', 'DATA1'):
  99         data = packet[16:-16]
 100         tmp = ""
 101         while data:
 102             tmp += "%02X " % bitstr_to_num(data[:8])
 103             data = data[8:]
 104         data = tmp
 105     else:
 106         data = packet[16:]
 107
 108     if sync != "00000001":
 109         return "SYNC INVALID!"
 110
 111     return pid + ' ' + data
 112
 113 class Decoder(sigrok.Decoder):
 114     id = 'usb'
 115     name = 'USB'
 116     desc = 'Universal Serial Bus'
 117     longname = '...longname...'
 118     longdesc = '...longdesc...'
 119     author = 'Gareth McMullin'
 120     email = 'gareth@blacksphere.co.nz'
 121     license = 'gplv2+'
 122     inputs = ['logic']
 123     outputs = ['usb']
 124     # Probe names with a set of defaults
 125     probes = {'dp':0, 'dm':1}
 126     options = {}
 127
 128     def __init__(self):
 129         self.probes = Decoder.probes.copy()
 130         self.output_protocol = None
 131         self.output_annotation = None
 132
 133     def start(self, metadata):
 134         self.unitsize = metadata['unitsize']
 135         self.rate = metadata['samplerate']
 136         # self.output_protocol = self.output_new(2)
 137         self.output_annotation = self.output_new(1)
 138         if self.rate < 48000000:
 139             raise Exception("Sample rate not sufficient for USB decoding")
 140         # Initialise decoder state.
 141         self.sym = J
 142         self.scount = 0
 143         self.packet = ''
 144
 145     def decode(self, timeoffset, duration, data):
 146         out = []
 147
 148         for sample in sampleiter(data, self.unitsize):
 149
 150             self.scount += 1
 151
 152             sym = syms[sample.probe(self.probes['dp']),
 153                        sample.probe(self.probes['dm'])]
 154             if sym == self.sym:
 155                 continue
 156
 157             if self.scount == 1:
 158                 # We ignore single sample width pulses.
 159                 # I sometimes get these with the OLS.
 160                 self.sym = sym
 161                 self.scount = 0
 162                 continue
 163
 164             # How many bits since the last transition?
 165             if self.packet or self.sym != J:
 166                 bitcount = int((self.scount - 1) * 12000000 / self.rate)
 167             else:
 168                 bitcount = 0
 169
 170             if self.sym == SE0:
 171                 if bitcount == 1:
 172                     # End-Of-Packet (EOP)
 173                     out += [{"type":"usb", "data":self.packet,
 174                               "display":packet_decode(self.packet)}]
 175                 else:
 176                     # Longer than EOP, assume reset.
 177                     out += [{"type":"usb", "display":"RESET"}]
 178                 self.scount = 0
 179                 self.sym = sym
 180                 self.packet = ''
 181                 continue
 182
 183             # Add bits to the packet string.
 184             self.packet += '1' * bitcount
 185             # Handle bit stuffing.
 186             if bitcount < 6 and sym != SE0:
 187                 self.packet += '0'
 188             elif bitcount > 6:
 189                 out += [{"type":"usb", "display":"BIT STUFF ERROR"}]
 190
 191             self.scount = 0
 192             self.sym = sym
 193
 194         if out != []:
 195             # self.put(self.output_protocol, 0, 0, out_proto)
 196             self.put(self.output_annotation, 0, 0, out)
 197