decoders/spi.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 class Sample():
  22     def __init__(self, data):
  23         self.data = data
  24     def probe(self, probe):
  25         s = ord(self.data[probe / 8]) & (1 << (probe % 8))
  26         return True if s else False
  27
  28 def sampleiter(data, unitsize):
  29     for i in range(0, len(data), unitsize):
  30         yield(Sample(data[i:i+unitsize]))
  31
  32 class Decoder():
  33     name = 'SPI Decoder'
  34     desc = '...desc...'
  35     longname = '...longname...'
  36     longdesc = '...longdesc...'
  37     author = 'Gareth McMullin'
  38     email = 'gareth@blacksphere.co.nz'
  39     license = 'gplv2+'
  40     inputs = ['logic']
  41     outputs = ['spi']
  42     # Probe names with a set of defaults
  43     probes = {'sdata':0, 'sck':1}
  44     options = {}
  45
  46     def __init__(self, unitsize, **kwargs):
  47         # Metadata comes in here, we don't care for now
  48         #print kwargs
  49         self.unitsize = unitsize
  50
  51         self.probes = Decoder.probes.copy()
  52         self.oldsck = True
  53         self.rxcount = 0
  54         self.rxdata = 0
  55         self.bytesreceived = 0
  56
  57     def report(self):
  58         return "SPI: %d bytes received" % self.bytesreceived
  59
  60     def decode(self, data):
  61         # We should accept a list of samples and iterate...
  62         for sample in sampleiter(data["data"], self.unitsize):
  63
  64             sck = sample.probe(self.probes["sck"])
  65             # Sample SDATA on rising SCK
  66             if sck == self.oldsck:
  67                 continue
  68             self.oldsck = sck
  69             if not sck:
  70                 continue
  71
  72             # If this is first bit, save timestamp
  73             if self.rxcount == 0:
  74                 self.time = data["time"]
  75             # Receive bit into our shift register
  76             sdata = sample.probe(self.probes["sdata"])
  77             if sdata:
  78                 self.rxdata |= 1 << (7 - self.rxcount)
  79             self.rxcount += 1
  80             # Continue to receive if not a byte yet
  81             if self.rxcount != 8:
  82                 continue
  83             # Received a byte, pass up to sigrok
  84             outdata = {"time":self.time,
  85                 "duration":data["time"] + data["duration"] - self.time,
  86                 "data":self.rxdata,
  87                 "display":("%02X" % self.rxdata),
  88                 "type":"spi",
  89             }
  90             sigrok.put(outdata)
  91             # Reset decoder state
  92             self.rxdata = 0
  93             self.rxcount = 0
  94             # Keep stats for summary
  95             self.bytesreceived += 1
  96
  97 if __name__ == "__main__":
  98     data = open("spi_dump.bin").read()
  99
 100     # dummy class to keep Decoder happy for test
 101     class Sigrok():
 102         def put(self, data):
 103             print "\t", data
 104     sigrok = Sigrok()
 105
 106     dec = Decoder(driver='ols', unitsize=1, starttime=0)
 107     dec.decode({"time":0, "duration":len(data), "data":data, "type":"logic"})
 108
 109     print dec.summary()
 110 else:
 111     import sigrok
 112
 113 #Tested with:
 114 #  sigrok-cli -d 0:samplerate=1000000:rle=on --time=1s -p 1,2 -a spidec
 115