decoders/spi/spi.py

   1 ##
   2 ## This file is part of the sigrok project.
   3 ##
   4 ## Copyright (C) 2011 Gareth McMullin <gareth@blacksphere.co.nz>
   5 ## Copyright (C) 2012 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 # Key: (CPOL, CPHA). Value: SPI mode.
  25 # Clock polarity (CPOL) = 0/1: Clock is low/high when inactive.
  26 # Clock phase (CPHA) = 0/1: Data is valid on the leading/trailing clock edge.
  27 spi_mode = {
  28     (0, 0): 0, # Mode 0
  29     (0, 1): 1, # Mode 1
  30     (1, 0): 2, # Mode 2
  31     (1, 1): 3, # Mode 3
  32 }
  33
  34 # Annotation formats
  35 ANN_HEX = 0
  36
  37 class Decoder(srd.Decoder):
  38     api_version = 1
  39     id = 'spi'
  40     name = 'SPI'
  41     longname = 'Serial Peripheral Interface'
  42     desc = '...desc...'
  43     longdesc = '...longdesc...'
  44     license = 'gplv2+'
  45     inputs = ['logic']
  46     outputs = ['spi']
  47     probes = [
  48         {'id': 'miso', 'name': 'MISO',
  49          'desc': 'SPI MISO line (Master in, slave out)'},
  50         {'id': 'mosi', 'name': 'MOSI',
  51          'desc': 'SPI MOSI line (Master out, slave in)'},
  52         {'id': 'sck', 'name': 'CLK', 'desc': 'SPI clock line'},
  53         {'id': 'cs', 'name': 'CS#', 'desc': 'SPI CS (chip select) line'},
  54     ]
  55     optional_probes = [] # TODO
  56     options = {
  57         'cs_polarity': ['CS# polarity', 'active-low'],
  58         'cpol': ['Clock polarity', 0],
  59         'cpha': ['Clock phase', 0],
  60         'bitorder': ['Bit order within the SPI data', 'msb-first'],
  61         'wordsize': ['Word size of SPI data', 8], # 1-64?
  62     }
  63     annotations = [
  64         ['Hex', 'SPI data bytes in hex format'],
  65     ]
  66
  67     def __init__(self):
  68         self.oldsck = 1
  69         self.bitcount = 0
  70         self.mosidata = 0
  71         self.misodata = 0
  72         self.bytesreceived = 0
  73         self.samplenum = -1
  74         self.cs_was_deasserted_during_data_word = 0
  75
  76     def start(self, metadata):
  77         self.out_proto = self.add(srd.OUTPUT_PROTO, 'spi')
  78         self.out_ann = self.add(srd.OUTPUT_ANN, 'spi')
  79
  80     def report(self):
  81         return 'SPI: %d bytes received' % self.bytesreceived
  82
  83     def decode(self, ss, es, data):
  84         # TODO: Either MISO or MOSI could be optional. CS# is optional.
  85         for (samplenum, (miso, mosi, sck, cs)) in data:
  86
  87             self.samplenum += 1 # FIXME
  88
  89             # Ignore sample if the clock pin hasn't changed.
  90             if sck == self.oldsck:
  91                 continue
  92
  93             self.oldsck = sck
  94
  95             # Sample data on rising/falling clock edge (depends on mode).
  96             mode = spi_mode[self.options['cpol'], self.options['cpha']]
  97             if mode == 0 and sck == 0:   # Sample on rising clock edge
  98                     continue
  99             elif mode == 1 and sck == 1: # Sample on falling clock edge
 100                     continue
 101             elif mode == 2 and sck == 1: # Sample on falling clock edge
 102                     continue
 103             elif mode == 3 and sck == 0: # Sample on rising clock edge
 104                     continue
 105
 106             # If this is the first bit, save its sample number.
 107             if self.bitcount == 0:
 108                 self.start_sample = samplenum
 109                 active_low = (self.options['cs_polarity'] == 'active-low')
 110                 deasserted = cs if active_low else not cs
 111                 if deasserted:
 112                     self.cs_was_deasserted_during_data_word = 1
 113
 114             ws = self.options['wordsize']
 115
 116             # Receive MOSI bit into our shift register.
 117             if self.options['bitorder'] == 'msb-first':
 118                 self.mosidata |= mosi << (ws - 1 - self.bitcount)
 119             else:
 120                 self.mosidata |= mosi << self.bitcount
 121
 122             # Receive MISO bit into our shift register.
 123             if self.options['bitorder'] == 'msb-first':
 124                 self.misodata |= miso << (ws - 1 - self.bitcount)
 125             else:
 126                 self.misodata |= miso << self.bitcount
 127
 128             self.bitcount += 1
 129
 130             # Continue to receive if not enough bits were received, yet.
 131             if self.bitcount != ws:
 132                 continue
 133
 134             self.put(self.start_sample, self.samplenum, self.out_proto,
 135                      ['data', self.mosidata, self.misodata])
 136             self.put(self.start_sample, self.samplenum, self.out_ann,
 137                      [ANN_HEX, ['MOSI: 0x%02x, MISO: 0x%02x' % (self.mosidata,
 138                      self.misodata)]])
 139
 140             if self.cs_was_deasserted_during_data_word:
 141                 self.put(self.start_sample, self.samplenum, self.out_ann,
 142                          [ANN_HEX, ['WARNING: CS# was deasserted during this '
 143                          'SPI data byte!']])
 144
 145             # Reset decoder state.
 146             self.mosidata = 0
 147             self.misodata = 0
 148             self.bitcount = 0
 149
 150             # Keep stats for summary.
 151             self.bytesreceived += 1
 152