X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoders%2Fspi%2Fpd.py;h=78b167abb45d81082905d818fbcd464e761bb3fb;hp=88487bb77f6ef0772403330fe1f27a0c12138bad;hb=bb08f4b3608b7ed4c932ed2041b1f41a5c9a7fed;hpb=12549f1161748215072541ed9a9c8625da041131 diff --git a/decoders/spi/pd.py b/decoders/spi/pd.py index 88487bb..78b167a 100644 --- a/decoders/spi/pd.py +++ b/decoders/spi/pd.py @@ -22,7 +22,7 @@ import sigrokdecode as srd ''' -Protocol output format: +OUTPUT_PYTHON format: SPI packet: [, , ] @@ -32,12 +32,18 @@ Commands: The data is _usually_ 8 bits (but can also be fewer or more bits). Both data items are Python numbers (not strings), or None if the respective probe was not supplied. + - 'BITS': / contain a list of bit values in this MISO/MOSI data + item, and for each of those also their respective start-/endsample numbers. - 'CS CHANGE': is the old CS# pin value, is the new value. Both data items are Python numbers (0/1), not strings. Examples: ['CS-CHANGE', 1, 0] ['DATA', 0xff, 0x3a] + ['BITS', [[1, 80, 82], [1, 83, 84], [1, 85, 86], [1, 87, 88], + [1, 89, 90], [1, 91, 92], [1, 93, 94], [1, 95, 96]], + [[0, 80, 82], [0, 83, 84], [1, 85, 86], [1, 87, 88], + [1, 89, 90], [0, 91, 92], [1, 93, 94], [0, 95, 96]]] ['DATA', 0x65, 0x00] ['DATA', 0xa8, None] ['DATA', None, 0x55] @@ -64,14 +70,12 @@ class Decoder(srd.Decoder): inputs = ['logic'] outputs = ['spi'] probes = [ - {'id': 'sck', 'name': 'CLK', 'desc': 'SPI clock line'}, + {'id': 'clk', 'name': 'CLK', 'desc': 'Clock'}, ] optional_probes = [ - {'id': 'miso', 'name': 'MISO', - 'desc': 'SPI MISO line (master in, slave out)'}, - {'id': 'mosi', 'name': 'MOSI', - 'desc': 'SPI MOSI line (master out, slave in)'}, - {'id': 'cs', 'name': 'CS#', 'desc': 'SPI chip-select line'}, + {'id': 'miso', 'name': 'MISO', 'desc': 'Master in, slave out'}, + {'id': 'mosi', 'name': 'MOSI', 'desc': 'Master out, slave in'}, + {'id': 'cs', 'name': 'CS#', 'desc': 'Chip-select'}, ] options = { 'cs_polarity': ['CS# polarity', 'active-low'], @@ -82,25 +86,33 @@ class Decoder(srd.Decoder): 'format': ['Data format', 'hex'], } annotations = [ - ['miso-data', 'MISO SPI data'], - ['mosi-data', 'MOSI SPI data'], + ['miso-data', 'MISO data'], + ['mosi-data', 'MOSI data'], + ['miso-bits', 'MISO bits'], + ['mosi-bits', 'MOSI bits'], ['warnings', 'Human-readable warnings'], ] + annotation_rows = ( + ('miso-data', 'MISO data', (0,)), + ('miso-bits', 'MISO bits', (2,)), + ('mosi-data', 'MOSI data', (1,)), + ('mosi-bits', 'MOSI bits', (3,)), + ('other', 'Other', (4,)), + ) def __init__(self): self.samplerate = None - self.oldsck = 1 + self.oldclk = 1 self.bitcount = 0 - self.mosidata = 0 - self.misodata = 0 + self.misodata = self.mosidata = 0 + self.misobits = [] + self.mosibits = [] self.startsample = -1 self.samplenum = -1 - self.cs_was_deasserted_during_data_word = 0 + self.cs_was_deasserted = False self.oldcs = -1 self.oldpins = None - self.have_cs = None - self.have_miso = None - self.have_mosi = None + self.have_cs = self.have_miso = self.have_mosi = None self.state = 'IDLE' def metadata(self, key, value): @@ -108,29 +120,69 @@ class Decoder(srd.Decoder): self.samplerate = value def start(self): - self.out_proto = self.register(srd.OUTPUT_PYTHON) + self.out_python = self.register(srd.OUTPUT_PYTHON) self.out_ann = self.register(srd.OUTPUT_ANN) self.out_bitrate = self.register(srd.OUTPUT_META, meta=(int, 'Bitrate', 'Bitrate during transfers')) def putpw(self, data): - self.put(self.startsample, self.samplenum, self.out_proto, data) + self.put(self.startsample, self.samplenum, self.out_python, data) def putw(self, data): self.put(self.startsample, self.samplenum, self.out_ann, data) - def handle_bit(self, miso, mosi, sck, cs): - # If this is the first bit, save its sample number. + def putdata(self): + # Pass MISO and MOSI bits and then data to the next PD up the stack. + so = self.misodata if self.have_miso else None + si = self.mosidata if self.have_mosi else None + so_bits = self.misobits if self.have_miso else None + si_bits = self.mosibits if self.have_mosi else None + self.putpw(['BITS', si_bits, so_bits]) + self.putpw(['DATA', si, so]) + + # Bit annotations. + if self.have_miso: + for bit in self.misobits: + self.put(bit[1], bit[2], self.out_ann, [2, ['%d' % bit[0]]]) + if self.have_mosi: + for bit in self.mosibits: + self.put(bit[1], bit[2], self.out_ann, [3, ['%d' % bit[0]]]) + + # Dataword annotations. + if self.have_miso: + ss, es = self.misobits[0][1], self.misobits[-1][2] + self.put(ss, es, self.out_ann, [0, ['%02X' % self.misodata]]) + if self.have_mosi: + ss, es = self.mosibits[0][1], self.mosibits[-1][2] + self.put(ss, es, self.out_ann, [1, ['%02X' % self.mosidata]]) + + def reset_decoder_state(self): + self.misodata = 0 if self.have_miso else None + self.mosidata = 0 if self.have_mosi else None + self.misobits = [] if self.have_miso else None + self.mosibits = [] if self.have_mosi else None + self.bitcount = 0 + + def handle_bit(self, miso, mosi, clk, cs): + # If this is the first bit of a dataword, save its sample number. if self.bitcount == 0: self.startsample = self.samplenum + self.cs_was_deasserted = False if self.have_cs: active_low = (self.options['cs_polarity'] == 'active-low') - deasserted = cs if active_low else not cs + deasserted = (cs == 1) if active_low else (cs == 0) if deasserted: - self.cs_was_deasserted_during_data_word = 1 + self.cs_was_deasserted = True ws = self.options['wordsize'] + # Receive MISO bit into our shift register. + if self.have_miso: + if self.options['bitorder'] == 'msb-first': + self.misodata |= miso << (ws - 1 - self.bitcount) + else: + self.misodata |= miso << self.bitcount + # Receive MOSI bit into our shift register. if self.have_mosi: if self.options['bitorder'] == 'msb-first': @@ -138,12 +190,20 @@ class Decoder(srd.Decoder): else: self.mosidata |= mosi << self.bitcount - # Receive MISO bit into our shift register. + # Guesstimate the endsample for this bit (can be overridden below). + es = self.samplenum + if self.bitcount > 0: + es += self.samplenum - self.misobits[self.bitcount - 1][1] + if self.have_miso: - if self.options['bitorder'] == 'msb-first': - self.misodata |= miso << (ws - 1 - self.bitcount) - else: - self.misodata |= miso << self.bitcount + self.misobits.append([miso, self.samplenum, es]) + if self.have_mosi: + self.mosibits.append([mosi, self.samplenum, es]) + + if self.bitcount > 0 and self.have_miso: + self.misobits[self.bitcount - 1][2] = self.samplenum + if self.bitcount > 0 and self.have_mosi: + self.mosibits[self.bitcount - 1][2] = self.samplenum self.bitcount += 1 @@ -151,61 +211,47 @@ class Decoder(srd.Decoder): if self.bitcount != ws: return - si = self.mosidata if self.have_mosi else None - so = self.misodata if self.have_miso else None - - # Pass MOSI and MISO to the next PD up the stack. - self.putpw(['DATA', si, so]) - - # Annotations. - if self.have_miso: - self.putw([0, ['%02X' % self.misodata]]) - if self.have_mosi: - self.putw([1, ['%02X' % self.mosidata]]) + self.putdata() # Meta bitrate. - elapsed = 1 / float(self.samplerate) * (self.samplenum - self.startsample + 1) + elapsed = 1 / float(self.samplerate) + elapsed *= (self.samplenum - self.startsample + 1) bitrate = int(1 / elapsed * self.options['wordsize']) self.put(self.startsample, self.samplenum, self.out_bitrate, bitrate) - if self.have_cs and self.cs_was_deasserted_during_data_word: - self.putw([2, ['CS# was deasserted during this data word!']]) + if self.have_cs and self.cs_was_deasserted: + self.putw([4, ['CS# was deasserted during this data word!']]) - # Reset decoder state. - self.misodata = 0 if self.have_miso else None - self.mosidata = 0 if self.have_mosi else None - self.bitcount = 0 + self.reset_decoder_state() - def find_clk_edge(self, miso, mosi, sck, cs): + def find_clk_edge(self, miso, mosi, clk, cs): if self.have_cs and self.oldcs != cs: # Send all CS# pin value changes. - self.put(self.samplenum, self.samplenum, self.out_proto, + self.put(self.samplenum, self.samplenum, self.out_python, ['CS-CHANGE', self.oldcs, cs]) self.oldcs = cs # Reset decoder state when CS# changes (and the CS# pin is used). - self.misodata = 0 if self.have_miso else None - self.mosidata = 0 if self.have_mosi else None - self.bitcount = 0 + self.reset_decoder_state() # Ignore sample if the clock pin hasn't changed. - if sck == self.oldsck: + if clk == self.oldclk: return - self.oldsck = sck + self.oldclk = clk # Sample data on rising/falling clock edge (depends on mode). mode = spi_mode[self.options['cpol'], self.options['cpha']] - if mode == 0 and sck == 0: # Sample on rising clock edge + if mode == 0 and clk == 0: # Sample on rising clock edge return - elif mode == 1 and sck == 1: # Sample on falling clock edge + elif mode == 1 and clk == 1: # Sample on falling clock edge return - elif mode == 2 and sck == 1: # Sample on falling clock edge + elif mode == 2 and clk == 1: # Sample on falling clock edge return - elif mode == 3 and sck == 0: # Sample on rising clock edge + elif mode == 3 and clk == 0: # Sample on rising clock edge return # Found the correct clock edge, now get the SPI bit(s). - self.handle_bit(miso, mosi, sck, cs) + self.handle_bit(miso, mosi, clk, cs) def decode(self, ss, es, data): if self.samplerate is None: @@ -216,14 +262,18 @@ class Decoder(srd.Decoder): # Ignore identical samples early on (for performance reasons). if self.oldpins == pins: continue - self.oldpins, (sck, miso, mosi, cs) = pins, pins + self.oldpins, (clk, miso, mosi, cs) = pins, pins self.have_miso = (miso in (0, 1)) self.have_mosi = (mosi in (0, 1)) self.have_cs = (cs in (0, 1)) + # Either MISO or MOSI (but not both) can be omitted. + if not (self.have_miso or self.have_mosi): + raise Exception('Either MISO or MOSI (or both) pins required.') + # State machine. if self.state == 'IDLE': - self.find_clk_edge(miso, mosi, sck, cs) + self.find_clk_edge(miso, mosi, clk, cs) else: raise Exception('Invalid state: %s' % self.state)