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 class Decoder(srd.Decoder):
  70     api_version = 1
  71     id = 'usb_signalling'
  72     name = 'USB signalling'
  73     longname = 'Universal Serial Bus (LS/FS) signalling'
  74     desc = 'USB (low-speed and full-speed) signalling protocol.'
  75     license = 'gplv2+'
  76     inputs = ['logic']
  77     outputs = ['usb_signalling']
  78     probes = [
  79         {'id': 'dp', 'name': 'D+', 'desc': 'USB D+ signal'},
  80         {'id': 'dm', 'name': 'D-', 'desc': 'USB D- signal'},
  81     ]
  82     optional_probes = []
  83     options = (
  84         {'id': 'signalling', 'desc': 'Signalling',
  85             'default': 'full-speed', 'values': ('full-speed', 'low-speed')},
  86     )
  87     annotations = [
  88         ['sym', 'Symbol'],
  89         ['sop', 'Start of packet (SOP)'],
  90         ['eop', 'End of packet (EOP)'],
  91         ['bit', 'Bit'],
  92         ['stuffbit', 'Stuff bit'],
  93     ]
  94     annotation_rows = (
  95         ('bits', 'Bits', (1, 2, 3, 4)),
  96         ('symbols', 'Symbols', (0,)),
  97     )
  98
  99     def __init__(self):
 100         self.samplerate = None
 101         self.oldsym = 'J' # The "idle" state is J.
 102         self.ss_sop = None
 103         self.ss_block = None
 104         self.samplenum = 0
 105         self.syms = []
 106         self.bitrate = None
 107         self.bitwidth = None
 108         self.bitnum = 0
 109         self.samplenum_target = None
 110         self.oldpins = None
 111         self.consecutive_ones = 0
 112         self.state = 'IDLE'
 113
 114     def start(self):
 115         self.out_python = self.register(srd.OUTPUT_PYTHON)
 116         self.out_ann = self.register(srd.OUTPUT_ANN)
 117
 118     def metadata(self, key, value):
 119         if key == srd.SRD_CONF_SAMPLERATE:
 120             self.samplerate = value
 121             self.bitrate = bitrates[self.options['signalling']]
 122             self.bitwidth = float(self.samplerate) / float(self.bitrate)
 123             self.halfbit = int(self.bitwidth / 2)
 124
 125     def putpx(self, data):
 126         self.put(self.samplenum, self.samplenum, self.out_python, data)
 127
 128     def putx(self, data):
 129         self.put(self.samplenum, self.samplenum, self.out_ann, data)
 130
 131     def putpm(self, data):
 132         s, h = self.samplenum, self.halfbit
 133         self.put(self.ss_block - h, s + h, self.out_python, data)
 134
 135     def putm(self, data):
 136         s, h = self.samplenum, self.halfbit
 137         self.put(self.ss_block - h, s + h, self.out_ann, data)
 138
 139     def putpb(self, data):
 140         s, h = self.samplenum, self.halfbit
 141         self.put(s - h, s + h, self.out_python, data)
 142
 143     def putb(self, data):
 144         s, h = self.samplenum, self.halfbit
 145         self.put(s - h, s + h, self.out_ann, data)
 146
 147     def set_new_target_samplenum(self):
 148         bitpos = self.ss_sop + (self.bitwidth / 2)
 149         bitpos += self.bitnum * self.bitwidth
 150         self.samplenum_target = int(bitpos)
 151
 152     def wait_for_sop(self, sym):
 153         # Wait for a Start of Packet (SOP), i.e. a J->K symbol change.
 154         if sym != 'K':
 155             self.oldsym = sym
 156             return
 157         self.ss_sop = self.samplenum
 158         self.set_new_target_samplenum()
 159         self.putpx(['SOP', None])
 160         self.putx([1, ['SOP']])
 161         self.state = 'GET BIT'
 162
 163     def handle_bit(self, sym, b):
 164         if self.consecutive_ones == 6 and b == '0':
 165             # Stuff bit.
 166             self.putpb(['STUFF BIT', None])
 167             self.putb([4, ['SB: %s' % b]])
 168             self.putb([0, ['%s' % sym]])
 169             self.consecutive_ones = 0
 170         else:
 171             # Normal bit (not a stuff bit).
 172             self.putpb(['BIT', b])
 173             self.putb([3, ['%s' % b]])
 174             self.putb([0, ['%s' % sym]])
 175             if b == '1':
 176                 self.consecutive_ones += 1
 177             else:
 178                 self.consecutive_ones = 0
 179
 180     def get_eop(self, sym):
 181         # EOP: SE0 for >= 1 bittime (usually 2 bittimes), then J.
 182         self.syms.append(sym)
 183         self.putpb(['SYM', sym])
 184         self.putb([0, ['%s' % sym]])
 185         self.bitnum += 1
 186         self.set_new_target_samplenum()
 187         self.oldsym = sym
 188         if self.syms[-2:] == ['SE0', 'J']:
 189             # Got an EOP.
 190             self.putpm(['EOP', None])
 191             self.putm([2, ['EOP']])
 192             self.bitnum, self.syms, self.state = 0, [], 'IDLE'
 193             self.consecutive_ones = 0
 194
 195     def get_bit(self, sym):
 196         if sym == 'SE0':
 197             # Start of an EOP. Change state, run get_eop() for this bit.
 198             self.state = 'GET EOP'
 199             self.ss_block = self.samplenum
 200             self.get_eop(sym)
 201             return
 202         self.syms.append(sym)
 203         self.putpb(['SYM', sym])
 204         b = '0' if self.oldsym != sym else '1'
 205         self.handle_bit(sym, b)
 206         self.bitnum += 1
 207         self.set_new_target_samplenum()
 208         self.oldsym = sym
 209
 210     def decode(self, ss, es, data):
 211         if self.samplerate is None:
 212             raise Exception("Cannot decode without samplerate.")
 213         for (self.samplenum, pins) in data:
 214             # State machine.
 215             if self.state == 'IDLE':
 216                 # Ignore identical samples early on (for performance reasons).
 217                 if self.oldpins == pins:
 218                     continue
 219                 self.oldpins = pins
 220                 sym = symbols[self.options['signalling']][tuple(pins)]
 221                 self.wait_for_sop(sym)
 222             elif self.state in ('GET BIT', 'GET EOP'):
 223                 # Wait until we're in the middle of the desired bit.
 224                 if self.samplenum < self.samplenum_target:
 225                     continue
 226                 sym = symbols[self.options['signalling']][tuple(pins)]
 227                 if self.state == 'GET BIT':
 228                     self.get_bit(sym)
 229                 elif self.state == 'GET EOP':
 230                     self.get_eop(sym)
 231             else:
 232                 raise Exception('Invalid state: %s' % self.state)
 233