decoders/spi/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-2014 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, see <http://www.gnu.org/licenses/>.
  19 ##
  20
  21 import sigrokdecode as srd
  22 from collections import namedtuple
  23
  24 Data = namedtuple('Data', ['ss', 'es', 'val'])
  25
  26 '''
  27 OUTPUT_PYTHON format:
  28
  29 Packet:
  30 [<ptype>, <data1>, <data2>]
  31
  32 <ptype>:
  33  - 'DATA': <data1> contains the MOSI data, <data2> contains the MISO data.
  34    The data is _usually_ 8 bits (but can also be fewer or more bits).
  35    Both data items are Python numbers (not strings), or None if the respective
  36    channel was not supplied.
  37  - 'BITS': <data1>/<data2> contain a list of bit values in this MOSI/MISO data
  38    item, and for each of those also their respective start-/endsample numbers.
  39  - 'CS-CHANGE': <data1> is the old CS# pin value, <data2> is the new value.
  40    Both data items are Python numbers (0/1), not strings. At the beginning of
  41    the decoding a packet is generated with <data1> = None and <data2> being the
  42    initial state of the CS# pin or None if the chip select pin is not supplied.
  43  - 'TRANSFER': <data1>/<data2> contain a list of Data() namedtuples for each
  44    byte transferred during this block of CS# asserted time. Each Data() has
  45    fields ss, es, and val.
  46
  47 Examples:
  48  ['CS-CHANGE', None, 1]
  49  ['CS-CHANGE', 1, 0]
  50  ['DATA', 0xff, 0x3a]
  51  ['BITS', [[1, 80, 82], [1, 83, 84], [1, 85, 86], [1, 87, 88],
  52            [1, 89, 90], [1, 91, 92], [1, 93, 94], [1, 95, 96]],
  53           [[0, 80, 82], [1, 83, 84], [0, 85, 86], [1, 87, 88],
  54            [1, 89, 90], [1, 91, 92], [0, 93, 94], [0, 95, 96]]]
  55  ['DATA', 0x65, 0x00]
  56  ['DATA', 0xa8, None]
  57  ['DATA', None, 0x55]
  58  ['CS-CHANGE', 0, 1]
  59  ['TRANSFER', [Data(ss=80, es=96, val=0xff), ...],
  60               [Data(ss=80, es=96, val=0x3a), ...]]
  61 '''
  62
  63 # Key: (CPOL, CPHA). Value: SPI mode.
  64 # Clock polarity (CPOL) = 0/1: Clock is low/high when inactive.
  65 # Clock phase (CPHA) = 0/1: Data is valid on the leading/trailing clock edge.
  66 spi_mode = {
  67     (0, 0): 0, # Mode 0
  68     (0, 1): 1, # Mode 1
  69     (1, 0): 2, # Mode 2
  70     (1, 1): 3, # Mode 3
  71 }
  72
  73 class SamplerateError(Exception):
  74     pass
  75
  76 class ChannelError(Exception):
  77     pass
  78
  79 class Decoder(srd.Decoder):
  80     api_version = 3
  81     id = 'spi'
  82     name = 'SPI'
  83     longname = 'Serial Peripheral Interface'
  84     desc = 'Full-duplex, synchronous, serial bus.'
  85     license = 'gplv2+'
  86     inputs = ['logic']
  87     outputs = ['spi']
  88     channels = (
  89         {'id': 'clk', 'name': 'CLK', 'desc': 'Clock'},
  90     )
  91     optional_channels = (
  92         {'id': 'miso', 'name': 'MISO', 'desc': 'Master in, slave out'},
  93         {'id': 'mosi', 'name': 'MOSI', 'desc': 'Master out, slave in'},
  94         {'id': 'cs', 'name': 'CS#', 'desc': 'Chip-select'},
  95     )
  96     options = (
  97         {'id': 'cs_polarity', 'desc': 'CS# polarity', 'default': 'active-low',
  98             'values': ('active-low', 'active-high')},
  99         {'id': 'cpol', 'desc': 'Clock polarity', 'default': 0,
 100             'values': (0, 1)},
 101         {'id': 'cpha', 'desc': 'Clock phase', 'default': 0,
 102             'values': (0, 1)},
 103         {'id': 'bitorder', 'desc': 'Bit order',
 104             'default': 'msb-first', 'values': ('msb-first', 'lsb-first')},
 105         {'id': 'wordsize', 'desc': 'Word size', 'default': 8},
 106     )
 107     annotations = (
 108         ('miso-data', 'MISO data'),
 109         ('mosi-data', 'MOSI data'),
 110         ('miso-bits', 'MISO bits'),
 111         ('mosi-bits', 'MOSI bits'),
 112         ('warnings', 'Human-readable warnings'),
 113     )
 114     annotation_rows = (
 115         ('miso-data', 'MISO data', (0,)),
 116         ('miso-bits', 'MISO bits', (2,)),
 117         ('mosi-data', 'MOSI data', (1,)),
 118         ('mosi-bits', 'MOSI bits', (3,)),
 119         ('other', 'Other', (4,)),
 120     )
 121     binary = (
 122         ('miso', 'MISO'),
 123         ('mosi', 'MOSI'),
 124     )
 125
 126     def __init__(self):
 127         self.samplerate = None
 128         self.oldclk = 1
 129         self.bitcount = 0
 130         self.misodata = self.mosidata = 0
 131         self.misobits = []
 132         self.mosibits = []
 133         self.misobytes = []
 134         self.mosibytes = []
 135         self.ss_block = -1
 136         self.samplenum = -1
 137         self.ss_transfer = -1
 138         self.cs_was_deasserted = False
 139         self.oldcs = None
 140         self.have_cs = self.have_miso = self.have_mosi = None
 141
 142     def metadata(self, key, value):
 143         if key == srd.SRD_CONF_SAMPLERATE:
 144             self.samplerate = value
 145
 146     def start(self):
 147         self.out_python = self.register(srd.OUTPUT_PYTHON)
 148         self.out_ann = self.register(srd.OUTPUT_ANN)
 149         self.out_binary = self.register(srd.OUTPUT_BINARY)
 150         self.out_bitrate = self.register(srd.OUTPUT_META,
 151                 meta=(int, 'Bitrate', 'Bitrate during transfers'))
 152         self.bw = (self.options['wordsize'] + 7) // 8
 153
 154     def putw(self, data):
 155         self.put(self.ss_block, self.samplenum, self.out_ann, data)
 156
 157     def putdata(self):
 158         # Pass MISO and MOSI bits and then data to the next PD up the stack.
 159         so = self.misodata if self.have_miso else None
 160         si = self.mosidata if self.have_mosi else None
 161         so_bits = self.misobits if self.have_miso else None
 162         si_bits = self.mosibits if self.have_mosi else None
 163
 164         if self.have_miso:
 165             ss, es = self.misobits[-1][1], self.misobits[0][2]
 166             bdata = so.to_bytes(self.bw, byteorder='big')
 167             self.put(ss, es, self.out_binary, [0, bdata])
 168         if self.have_mosi:
 169             ss, es = self.mosibits[-1][1], self.mosibits[0][2]
 170             bdata = si.to_bytes(self.bw, byteorder='big')
 171             self.put(ss, es, self.out_binary, [1, bdata])
 172
 173         self.put(ss, es, self.out_python, ['BITS', si_bits, so_bits])
 174         self.put(ss, es, self.out_python, ['DATA', si, so])
 175
 176         if self.have_miso:
 177             self.misobytes.append(Data(ss=ss, es=es, val=so))
 178         if self.have_mosi:
 179             self.mosibytes.append(Data(ss=ss, es=es, val=si))
 180
 181         # Bit annotations.
 182         if self.have_miso:
 183             for bit in self.misobits:
 184                 self.put(bit[1], bit[2], self.out_ann, [2, ['%d' % bit[0]]])
 185         if self.have_mosi:
 186             for bit in self.mosibits:
 187                 self.put(bit[1], bit[2], self.out_ann, [3, ['%d' % bit[0]]])
 188
 189         # Dataword annotations.
 190         if self.have_miso:
 191             self.put(ss, es, self.out_ann, [0, ['%02X' % self.misodata]])
 192         if self.have_mosi:
 193             self.put(ss, es, self.out_ann, [1, ['%02X' % self.mosidata]])
 194
 195     def reset_decoder_state(self):
 196         self.misodata = 0 if self.have_miso else None
 197         self.mosidata = 0 if self.have_mosi else None
 198         self.misobits = [] if self.have_miso else None
 199         self.mosibits = [] if self.have_mosi else None
 200         self.bitcount = 0
 201
 202     def cs_asserted(self, cs):
 203         active_low = (self.options['cs_polarity'] == 'active-low')
 204         return (cs == 0) if active_low else (cs == 1)
 205
 206     def handle_bit(self, miso, mosi, clk, cs):
 207         # If this is the first bit of a dataword, save its sample number.
 208         if self.bitcount == 0:
 209             self.ss_block = self.samplenum
 210             self.cs_was_deasserted = \
 211                 not self.cs_asserted(cs) if self.have_cs else False
 212
 213         ws = self.options['wordsize']
 214
 215         # Receive MISO bit into our shift register.
 216         if self.have_miso:
 217             if self.options['bitorder'] == 'msb-first':
 218                 self.misodata |= miso << (ws - 1 - self.bitcount)
 219             else:
 220                 self.misodata |= miso << self.bitcount
 221
 222         # Receive MOSI bit into our shift register.
 223         if self.have_mosi:
 224             if self.options['bitorder'] == 'msb-first':
 225                 self.mosidata |= mosi << (ws - 1 - self.bitcount)
 226             else:
 227                 self.mosidata |= mosi << self.bitcount
 228
 229         # Guesstimate the endsample for this bit (can be overridden below).
 230         es = self.samplenum
 231         if self.bitcount > 0:
 232             if self.have_miso:
 233                 es += self.samplenum - self.misobits[0][1]
 234             elif self.have_mosi:
 235                 es += self.samplenum - self.mosibits[0][1]
 236
 237         if self.have_miso:
 238             self.misobits.insert(0, [miso, self.samplenum, es])
 239         if self.have_mosi:
 240             self.mosibits.insert(0, [mosi, self.samplenum, es])
 241
 242         if self.bitcount > 0 and self.have_miso:
 243             self.misobits[1][2] = self.samplenum
 244         if self.bitcount > 0 and self.have_mosi:
 245             self.mosibits[1][2] = self.samplenum
 246
 247         self.bitcount += 1
 248
 249         # Continue to receive if not enough bits were received, yet.
 250         if self.bitcount != ws:
 251             return
 252
 253         self.putdata()
 254
 255         # Meta bitrate.
 256         elapsed = 1 / float(self.samplerate)
 257         elapsed *= (self.samplenum - self.ss_block + 1)
 258         bitrate = int(1 / elapsed * self.options['wordsize'])
 259         self.put(self.ss_block, self.samplenum, self.out_bitrate, bitrate)
 260
 261         if self.have_cs and self.cs_was_deasserted:
 262             self.putw([4, ['CS# was deasserted during this data word!']])
 263
 264         self.reset_decoder_state()
 265
 266     def find_clk_edge(self, miso, mosi, clk, cs):
 267         if self.have_cs and self.oldcs != cs:
 268             # Send all CS# pin value changes.
 269             self.put(self.samplenum, self.samplenum, self.out_python,
 270                      ['CS-CHANGE', self.oldcs, cs])
 271             self.oldcs = cs
 272
 273             if self.cs_asserted(cs):
 274                 self.ss_transfer = self.samplenum
 275                 self.misobytes = []
 276                 self.mosibytes = []
 277             else:
 278                 self.put(self.ss_transfer, self.samplenum, self.out_python,
 279                     ['TRANSFER', self.mosibytes, self.misobytes])
 280
 281             # Reset decoder state when CS# changes (and the CS# pin is used).
 282             self.reset_decoder_state()
 283
 284         # We only care about samples if CS# is asserted.
 285         if self.have_cs and not self.cs_asserted(cs):
 286             return
 287
 288         # Ignore sample if the clock pin hasn't changed.
 289         if clk == self.oldclk:
 290             return
 291
 292         self.oldclk = clk
 293
 294         # Sample data on rising/falling clock edge (depends on mode).
 295         mode = spi_mode[self.options['cpol'], self.options['cpha']]
 296         if mode == 0 and clk == 0:   # Sample on rising clock edge
 297             return
 298         elif mode == 1 and clk == 1: # Sample on falling clock edge
 299             return
 300         elif mode == 2 and clk == 1: # Sample on falling clock edge
 301             return
 302         elif mode == 3 and clk == 0: # Sample on rising clock edge
 303             return
 304
 305         # Found the correct clock edge, now get the SPI bit(s).
 306         self.handle_bit(miso, mosi, clk, cs)
 307
 308     def decode(self):
 309         if not self.samplerate:
 310             raise SamplerateError('Cannot decode without samplerate.')
 311
 312         # Either MISO or MOSI can be omitted (but not both). CS# is optional.
 313         self.have_miso = self.has_channel(1)
 314         self.have_mosi = self.has_channel(2)
 315         self.have_cs = self.has_channel(3)
 316         if not self.have_miso and not self.have_mosi:
 317             raise ChannelError('Either MISO or MOSI (or both) pins required.')
 318
 319         # Tell stacked decoders that we don't have a CS# signal.
 320         if not self.have_cs:
 321             self.put(0, 0, self.out_python, ['CS-CHANGE', None, None])
 322
 323         # "Pixel compatibility" with the v2 implementation. Grab and
 324         # process the very first sample before checking for edges. The
 325         # previous implementation did this by seeding old values with None,
 326         # which led to an immediate "change" in comparison.
 327         pins = self.wait({})
 328         (clk, miso, mosi, cs) = pins
 329         self.find_clk_edge(miso, mosi, clk, cs)
 330
 331         while True:
 332             # Ignore identical samples early on (for performance reasons).
 333             pins = self.wait([{0: 'e'}, {1: 'e'}, {2: 'e'}, {3: 'e'}])
 334             (clk, miso, mosi, cs) = pins
 335             self.find_clk_edge(miso, mosi, clk, cs)