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 # USB Full-speed protocol decoder
  22
  23 # Full-speed usb singalling consists of two signal lines, both driven at 3.3V
  24 # logic levels.  The signals are DP and DM, and normally operate in
  25 # differential mode.
  26 # The state where DP=1,DM=0 is J, the state DP=0,DM=1 is K.
  27 # A state SE0 is defined where DP=DM=0.  This common mode signal is used to
  28 # signal a reset or end of packet.
  29
  30 # Data transmitted on the USB is encoded with NRZI.  A transision from J to K
  31 # or vice-versa indicates a logic 0, while no transision indicates a logic 1.
  32 # If 6 ones are transmitted consecutively, a zero is inserted to force a
  33 # transition.  This is known as bit stuffing.  Data is transferred at a rate
  34 # of 12Mbit/s.  The SE0 transmitted to signal an end-of-packet is two bit
  35 # intervals long.
  36
  37 import sigrok
  38
  39 class Sample():
  40     def __init__(self, data):
  41         self.data = data
  42     def probe(self, probe):
  43         s = ord(self.data[probe / 8]) & (1 << (probe % 8))
  44         return True if s else False
  45
  46 def sampleiter(data, unitsize):
  47     for i in range(0, len(data), unitsize):
  48         yield(Sample(data[i:i+unitsize]))
  49
  50 SE0, J, K, SE1 = 0, 1, 2, 3
  51 syms = {
  52         (False, False): SE0,
  53         (True, False): J,
  54         (False, True): K,
  55         (True, True): SE1,
  56 }
  57
  58 def bitstr_to_num(bitstr):
  59     if not bitstr: return 0
  60     l = list(bitstr)
  61     l.reverse()
  62     return int(''.join(l), 2)
  63
  64 def packet_decode(packet):
  65     pids = {'10000111':'OUT',  #Tokens
  66         '10010110':'IN',
  67         '10100101':'SOF',
  68         '10110100':'SETUP',
  69         '11000011':'DATA0',    #Data
  70         '11010010':'DATA1',
  71         '01001011':'ACK',      #Handshake
  72         '01011010':'NAK',
  73         '01111000':'STALL',
  74         '01101001':'NYET',
  75     }
  76
  77     sync = packet[:8]
  78     pid = packet[8:16]
  79     pid = pids.get(pid, pid)
  80     #Remove CRC
  81     if pid in ('OUT', 'IN', 'SOF', 'SETUP'):
  82         data = packet[16:-5]
  83         if pid == 'SOF':
  84             data = str(bitstr_to_num(data))
  85         else:
  86             dev = bitstr_to_num(data[:7])
  87             ep = bitstr_to_num(data[7:])
  88             data = "DEV %d EP %d" % (dev, ep)
  89
  90     elif pid in ('DATA0', 'DATA1'):
  91         data = packet[16:-16]
  92         tmp = ""
  93         while data:
  94             tmp += "%02X " % bitstr_to_num(data[:8])
  95             data = data[8:]
  96         data = tmp
  97     else:
  98         data = packet[16:]
  99
 100     if sync != "00000001":
 101         return "SYNC INVALID!"
 102
 103     return pid + ' ' + data
 104
 105 class Decoder():
 106     name = 'USB'
 107     desc = 'Universal Serial Bus'
 108     longname = '...longname...'
 109     longdesc = '...longdesc...'
 110     author = 'Gareth McMullin'
 111     email = 'gareth@blacksphere.co.nz'
 112     license = 'gplv2+'
 113     inputs = ['logic']
 114     outputs = ['usb']
 115     # Probe names with a set of defaults
 116     probes = {'dp':0, 'dm':1}
 117     options = {}
 118
 119     def __init__(self):
 120         self.probes = Decoder.probes.copy()
 121
 122     def start(self, metadata):
 123         self.unitsize = metadata['unitsize']
 124         self.rate = metadata['samplerate']
 125         if self.rate < 48000000:
 126             raise Exception("Sample rate not sufficient for USB decoding")
 127         # initialise decoder state
 128         self.sym = J
 129         self.scount = 0
 130         self.packet = ''
 131
 132     def decode(self, data):
 133         for sample in sampleiter(data['data'], self.unitsize):
 134
 135             self.scount += 1
 136
 137             sym = syms[sample.probe(self.probes['dp']),
 138                         sample.probe(self.probes['dm'])]
 139             if sym == self.sym:
 140                 continue
 141
 142             if self.scount == 1:
 143                 # We ignore single sample width pulses.
 144                 # I sometimes get these with the OLS
 145                 self.sym = sym
 146                 self.scount = 0
 147                 continue
 148
 149             # how many bits since the last transition?
 150             if self.packet or self.sym != J:
 151                 bitcount = (self.scount - 1) * 12000000 / self.rate
 152             else:
 153                 bitcount = 0
 154
 155             if self.sym == SE0:
 156                 if bitcount == 1:
 157                     # End-Of-Packet
 158                     sigrok.put({"type":"usb", "data":self.packet,
 159                                 "display":packet_decode(self.packet)})
 160                 else:
 161                      # Longer than EOP, assume reset
 162                     sigrok.put({"type":"usb", "display":"RESET"})
 163                 self.scount = 0
 164                 self.sym = sym
 165                 self.packet = ''
 166                 continue
 167
 168             # Add bits to the packet string.
 169             self.packet += '1' * bitcount
 170             # Handle bit stuffing
 171             if bitcount < 6 and sym != SE0:
 172                 self.packet += '0'
 173             elif bitcount > 6:
 174                 sigrok.put({"type":"usb", "display":"BIT STUFF ERROR"})
 175
 176             self.scount = 0
 177             self.sym = sym
 178