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