decoders/usb/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 import sigrokdecode as srd
  24
  25 # Symbols (used as states of our state machine, too)
  26 syms = {
  27         # (<dp>, <dm>): <state>
  28         (0, 0): 'SE0',
  29         (1, 0): 'J',
  30         (0, 1): 'K',
  31         (1, 1): 'SE1',
  32 }
  33
  34 # ...
  35 pids = {
  36     '10000111': 'OUT',      # Tokens
  37     '10010110': 'IN',
  38     '10100101': 'SOF',
  39     '10110100': 'SETUP',
  40     '11000011': 'DATA0',    # Data
  41     '11010010': 'DATA1',
  42     '01001011': 'ACK',      # Handshake
  43     '01011010': 'NAK',
  44     '01111000': 'STALL',
  45     '01101001': 'NYET',
  46 }
  47
  48 def bitstr_to_num(bitstr):
  49     if not bitstr:
  50         return 0
  51     l = list(bitstr)
  52     l.reverse()
  53     return int(''.join(l), 2)
  54
  55 def packet_decode(packet):
  56     sync = packet[:8]
  57     pid = packet[8:16]
  58     pid = pids.get(pid, pid)
  59
  60     # Remove CRC.
  61     if pid in ('OUT', 'IN', 'SOF', 'SETUP'):
  62         data = packet[16:-5]
  63         if pid == 'SOF':
  64             data = str(bitstr_to_num(data))
  65         else:
  66             dev = bitstr_to_num(data[:7])
  67             ep = bitstr_to_num(data[7:])
  68             data = 'DEV %d EP %d' % (dev, ep)
  69     elif pid in ('DATA0', 'DATA1'):
  70         data = packet[16:-16]
  71         tmp = ''
  72         while data:
  73             tmp += '%02x ' % bitstr_to_num(data[:8])
  74             data = data[8:]
  75         data = tmp
  76     else:
  77         data = packet[16:]
  78
  79     if sync != '00000001':
  80         return 'SYNC INVALID!'
  81
  82     return pid + ' ' + data
  83
  84 class Decoder(srd.Decoder):
  85     api_version = 1
  86     id = 'usb'
  87     name = 'USB'
  88     longname = 'Universal Serial Bus'
  89     desc = 'USB 1.x (full-speed) serial protocol.'
  90     license = 'gplv2+'
  91     inputs = ['logic']
  92     outputs = ['usb']
  93     probes = [
  94         {'id': 'dp', 'name': 'D+', 'desc': 'USB D+ signal'},
  95         {'id': 'dm', 'name': 'D-', 'desc': 'USB D- signal'},
  96     ]
  97     optional_probes = []
  98     options = {}
  99     annotations = [
 100         ['Text', 'Human-readable text']
 101     ]
 102
 103     def __init__(self):
 104         self.sym = 'J'
 105         self.samplenum = 0
 106         self.scount = 0
 107         self.packet = ''
 108
 109     def start(self, metadata):
 110         self.samplerate = metadata['samplerate']
 111
 112         if self.samplerate < 48000000:
 113             raise Exception('Samplerate (%d) not sufficient for USB '
 114                             'decoding, need at least 48MHz' % self.samplerate)
 115
 116         # self.out_proto = self.add(srd.OUTPUT_PROTO, 'usb')
 117         self.out_ann = self.add(srd.OUTPUT_ANN, 'usb')
 118
 119     def report(self):
 120         pass
 121
 122     def decode(self, ss, es, data):
 123         for (self.samplenum, (dp, dm)) in data:
 124
 125             # Note: self.samplenum is the absolute sample number, whereas
 126             # self.scount only counts the number of samples since the
 127             # last change in the D+/D- lines.
 128             self.scount += 1
 129
 130             sym = syms[dp, dm]
 131
 132             # Wait for a symbol change (i.e., change in D+/D- lines).
 133             if sym == self.sym:
 134                 continue
 135
 136             if self.scount == 1:
 137                 # We ignore single sample width "pulses", i.e., symbol changes
 138                 # (D+/D- line changes). I sometimes get these with the OLS.
 139                 self.sym = sym
 140                 self.scount = 0
 141                 continue
 142
 143             # How many bits since the last transition?
 144             if self.packet != '' or self.sym != 'J':
 145                 bitcount = int((self.scount - 1) * 12000000 / self.samplerate)
 146             else:
 147                 bitcount = 0
 148
 149             if self.sym == 'SE0':
 150                 if bitcount == 1:
 151                     # End-Of-Packet (EOP)
 152                     self.put(0, 0, self.out_ann,
 153                              [0, [packet_decode(self.packet), self.packet]])
 154                 else:
 155                     # Longer than EOP, assume reset.
 156                     self.put(0, 0, self.out_ann, [0, ['RESET']])
 157                 self.scount = 0
 158                 self.sym = sym
 159                 self.packet = ''
 160                 continue
 161
 162             # Add bits to the packet string.
 163             self.packet += '1' * bitcount
 164
 165             # Handle bit stuffing.
 166             if bitcount < 6 and sym != 'SE0':
 167                 self.packet += '0'
 168             elif bitcount > 6:
 169                 self.put(0, 0, self.out_ann, [0, ['BIT STUFF ERROR']])
 170
 171             self.scount = 0
 172             self.sym = sym
 173