decoders/usb_signalling/pd.py

   1 ##
   2 ## This file is part of the libsigrokdecode project.
   3 ##
   4 ## Copyright (C) 2011 Gareth McMullin <gareth@blacksphere.co.nz>
   5 ## Copyright (C) 2012-2013 Uwe Hermann <uwe@hermann-uwe.de>
   6 ##
   7 ## This program is free software; you can redistribute it and/or modify
   8 ## it under the terms of the GNU General Public License as published by
   9 ## the Free Software Foundation; either version 2 of the License, or
  10 ## (at your option) any later version.
  11 ##
  12 ## This program is distributed in the hope that it will be useful,
  13 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 ## GNU General Public License for more details.
  16 ##
  17 ## You should have received a copy of the GNU General Public License
  18 ## along with this program; if not, write to the Free Software
  19 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  20 ##
  21
  22 import sigrokdecode as srd
  23
  24 '''
  25 OUTPUT_PYTHON format:
  26
  27 Packet:
  28 [<ptype>, <pdata>]
  29
  30 <ptype>, <pdata>:
  31  - 'SOP', None
  32  - 'SYM', <sym>
  33  - 'BIT', <bit>
  34  - 'STUFF BIT', None
  35  - 'EOP', None
  36
  37 <sym>:
  38  - 'J', 'K', 'SE0', or 'SE1'
  39
  40 <bit>:
  41  - 0 or 1
  42  - Note: Symbols like SE0, SE1, and the J that's part of EOP don't yield 'BIT'.
  43 '''
  44
  45 # Low-/full-speed symbols.
  46 # Note: Low-speed J and K are inverted compared to the full-speed J and K!
  47 symbols = {
  48     'low-speed': {
  49         # (<dp>, <dm>): <symbol/state>
  50         (0, 0): 'SE0',
  51         (1, 0): 'K',
  52         (0, 1): 'J',
  53         (1, 1): 'SE1',
  54     },
  55     'full-speed': {
  56         # (<dp>, <dm>): <symbol/state>
  57         (0, 0): 'SE0',
  58         (1, 0): 'J',
  59         (0, 1): 'K',
  60         (1, 1): 'SE1',
  61     },
  62 }
  63
  64 bitrates = {
  65     'low-speed': 1500000,   # 1.5Mb/s (+/- 1.5%)
  66     'full-speed': 12000000, # 12Mb/s (+/- 0.25%)
  67 }
  68
  69 sym_annotation = {
  70     'J': [0, ['J']],
  71     'K': [1, ['K']],
  72     'SE0': [2, ['SE0', '0']],
  73     'SE1': [3, ['SE1', '1']],
  74 }
  75
  76 class SamplerateError(Exception):
  77     pass
  78
  79 class Decoder(srd.Decoder):
  80     api_version = 2
  81     id = 'usb_signalling'
  82     name = 'USB signalling'
  83     longname = 'Universal Serial Bus (LS/FS) signalling'
  84     desc = 'USB (low-speed and full-speed) signalling protocol.'
  85     license = 'gplv2+'
  86     inputs = ['logic']
  87     outputs = ['usb_signalling']
  88     channels = (
  89         {'id': 'dp', 'name': 'D+', 'desc': 'USB D+ signal'},
  90         {'id': 'dm', 'name': 'D-', 'desc': 'USB D- signal'},
  91     )
  92     options = (
  93         {'id': 'signalling', 'desc': 'Signalling',
  94             'default': 'full-speed', 'values': ('full-speed', 'low-speed')},
  95     )
  96     annotations = (
  97         ('sym-j', 'J symbol'),
  98         ('sym-k', 'K symbol'),
  99         ('sym-se0', 'SE0 symbol'),
 100         ('sym-se1', 'SE1 symbol'),
 101         ('sop', 'Start of packet (SOP)'),
 102         ('eop', 'End of packet (EOP)'),
 103         ('bit', 'Bit'),
 104         ('stuffbit', 'Stuff bit'),
 105     )
 106     annotation_rows = (
 107         ('bits', 'Bits', (4, 5, 6, 7)),
 108         ('symbols', 'Symbols', (0, 1, 2, 3)),
 109     )
 110
 111     def __init__(self):
 112         self.samplerate = None
 113         self.oldsym = 'J' # The "idle" state is J.
 114         self.ss_sop = None
 115         self.ss_block = None
 116         self.samplenum = 0
 117         self.syms = []
 118         self.bitrate = None
 119         self.bitwidth = None
 120         self.samplepos = None
 121         self.samplenum_target = None
 122         self.samplenum_edge = None
 123         self.oldpins = None
 124         self.edgepins = None
 125         self.consecutive_ones = 0
 126         self.state = 'IDLE'
 127
 128     def start(self):
 129         self.out_python = self.register(srd.OUTPUT_PYTHON)
 130         self.out_ann = self.register(srd.OUTPUT_ANN)
 131
 132     def metadata(self, key, value):
 133         if key == srd.SRD_CONF_SAMPLERATE:
 134             self.samplerate = value
 135             self.bitrate = bitrates[self.options['signalling']]
 136             self.bitwidth = float(self.samplerate) / float(self.bitrate)
 137             self.halfbit = int(self.bitwidth / 2)
 138
 139     def putpx(self, data):
 140         self.put(self.samplenum, self.samplenum, self.out_python, data)
 141
 142     def putx(self, data):
 143         self.put(self.samplenum, self.samplenum, self.out_ann, data)
 144
 145     def putpm(self, data):
 146         s, h = self.samplenum, self.halfbit
 147         self.put(self.ss_block - h, s + h, self.out_python, data)
 148
 149     def putm(self, data):
 150         s, h = self.samplenum, self.halfbit
 151         self.put(self.ss_block - h, s + h, self.out_ann, data)
 152
 153     def putpb(self, data):
 154         s, h = self.samplenum, self.halfbit
 155         self.put(self.samplenum_edge, s + h, self.out_python, data)
 156
 157     def putb(self, data):
 158         s, h = self.samplenum, self.halfbit
 159         self.put(self.samplenum_edge, s + h, self.out_ann, data)
 160
 161     def set_new_target_samplenum(self):
 162         self.samplepos += self.bitwidth;
 163         self.samplenum_target = int(self.samplepos)
 164         self.samplenum_edge = int(self.samplepos - (self.bitwidth / 2))
 165
 166     def wait_for_sop(self, sym):
 167         # Wait for a Start of Packet (SOP), i.e. a J->K symbol change.
 168         if sym != 'K':
 169             self.oldsym = sym
 170             return
 171         self.ss_sop = self.samplenum
 172         self.samplepos = self.ss_sop - (self.bitwidth / 2) + 0.5
 173         self.set_new_target_samplenum()
 174         self.putpx(['SOP', None])
 175         self.putx([4, ['SOP', 'S']])
 176         self.state = 'GET BIT'
 177
 178     def handle_bit(self, sym, b):
 179         if self.consecutive_ones == 6 and b == '0':
 180             # Stuff bit.
 181             self.putpb(['STUFF BIT', None])
 182             self.putb([7, ['Stuff bit: %s' % b, 'SB: %s' % b, '%s' % b]])
 183             self.consecutive_ones = 0
 184         else:
 185             # Normal bit (not a stuff bit).
 186             self.putpb(['BIT', b])
 187             self.putb([6, ['%s' % b]])
 188             if b == '1':
 189                 self.consecutive_ones += 1
 190             else:
 191                 self.consecutive_ones = 0
 192
 193     def get_eop(self, sym):
 194         # EOP: SE0 for >= 1 bittime (usually 2 bittimes), then J.
 195         self.syms.append(sym)
 196         self.putpb(['SYM', sym])
 197         self.putb(sym_annotation[sym])
 198         self.set_new_target_samplenum()
 199         self.oldsym = sym
 200         if self.syms[-2:] == ['SE0', 'J']:
 201             # Got an EOP.
 202             self.putpm(['EOP', None])
 203             self.putm([5, ['EOP', 'E']])
 204             self.syms, self.state = [], 'IDLE'
 205             self.consecutive_ones = 0
 206             self.bitwidth = float(self.samplerate) / float(self.bitrate)
 207
 208     def get_bit(self, sym):
 209         if sym == 'SE0':
 210             # Start of an EOP. Change state, run get_eop() for this bit.
 211             self.state = 'GET EOP'
 212             self.ss_block = self.samplenum
 213             self.get_eop(sym)
 214             return
 215         self.syms.append(sym)
 216         self.putpb(['SYM', sym])
 217         b = '0' if self.oldsym != sym else '1'
 218         self.putb(sym_annotation[sym])
 219         if self.oldsym != sym:
 220             edgesym = symbols[self.options['signalling']][tuple(self.edgepins)]
 221             if edgesym not in ('SE0', 'SE1'):
 222                 if edgesym == sym:
 223                     self.bitwidth = self.bitwidth - (0.001 * self.bitwidth)
 224                     self.samplepos = self.samplepos - (0.01 * self.bitwidth)
 225                 else:
 226                     self.bitwidth = self.bitwidth + (0.001 * self.bitwidth)
 227                     self.samplepos = self.samplepos + (0.01 * self.bitwidth)
 228         self.handle_bit(sym, b)
 229         self.set_new_target_samplenum()
 230         self.oldsym = sym
 231
 232     def decode(self, ss, es, data):
 233         if not self.samplerate:
 234             raise SamplerateError('Cannot decode without samplerate.')
 235         for (self.samplenum, pins) in data:
 236             # State machine.
 237             if self.state == 'IDLE':
 238                 # Ignore identical samples early on (for performance reasons).
 239                 if self.oldpins == pins:
 240                     continue
 241                 self.oldpins = pins
 242                 sym = symbols[self.options['signalling']][tuple(pins)]
 243                 self.wait_for_sop(sym)
 244                 self.edgepins = pins
 245             elif self.state in ('GET BIT', 'GET EOP'):
 246                 # Wait until we're in the middle of the desired bit.
 247                 if self.samplenum == self.samplenum_edge:
 248                     self.edgepins = pins
 249                 if self.samplenum < self.samplenum_target:
 250                     continue
 251                 sym = symbols[self.options['signalling']][tuple(pins)]
 252                 if self.state == 'GET BIT':
 253                     self.get_bit(sym)
 254                 elif self.state == 'GET EOP':
 255                     self.get_eop(sym)