decoders/guess_bitrate/pd.py

   1 ##
   2 ## This file is part of the libsigrokdecode project.
   3 ##
   4 ## Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de>
   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 # Bitrate / baudrate guessing protocol decoder
  22
  23 import sigrokdecode as srd
  24
  25 class Decoder(srd.Decoder):
  26     api_version = 1
  27     id = 'guess_bitrate'
  28     name = 'Guess bitrate'
  29     longname = 'Guess bitrate/baudrate'
  30     desc = 'Guess the bitrate/baudrate of a UART (or other) protocol.'
  31     license = 'gplv2+'
  32     inputs = ['logic']
  33     outputs = ['guess_bitrate']
  34     probes = [
  35         {'id': 'data', 'name': 'Data', 'desc': 'Data line'},
  36     ]
  37     optional_probes = []
  38     options = {}
  39     annotations = [
  40         ['bitrate', 'Bitrate / baudrate'],
  41     ]
  42
  43     def putx(self, data):
  44         self.put(self.ss_edge, self.samplenum, self.out_ann, data)
  45
  46     def __init__(self, **kwargs):
  47         self.olddata = None
  48         self.ss_edge = None
  49         self.first_transition = True
  50         self.bitwidth = None
  51
  52     def start(self, metadata):
  53         self.samplerate = metadata['samplerate']
  54         # self.out_proto = self.register(srd.OUTPUT_PYTHON)
  55         self.out_ann = self.register(srd.OUTPUT_ANN)
  56
  57     def decode(self, ss, es, data):
  58         for (self.samplenum, pins) in data:
  59
  60             data = pins[0]
  61
  62             # Wait for any transition on the data line.
  63             if data == self.olddata:
  64                 continue
  65
  66             # Initialize first self.olddata with the first sample value.
  67             if self.olddata == None:
  68                 self.olddata = data
  69                 continue
  70
  71             # Get the smallest distance between two transitions
  72             # and use that to calculate the bitrate/baudrate.
  73             if self.first_transition == True:
  74                 self.ss_edge = self.samplenum
  75                 self.first_transition = False
  76             else:
  77                 b = self.samplenum - self.ss_edge
  78                 if self.bitwidth == None or b < self.bitwidth:
  79                     self.bitwidth = b
  80                     bitrate = int(float(self.samplerate) / float(b))
  81                     self.putx([0, ['%d' % bitrate]])
  82                 self.ss_edge = self.samplenum
  83
  84             self.olddata = data
  85