2 ## This file is part of the sigrok project.
4 ## Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
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.
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.
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
21 # I2S protocol decoder
23 import sigrokdecode as srd
28 class Decoder(srd.Decoder):
32 longname = 'Integrated Interchip Sound'
33 desc = 'I2S is an electrical serial bus interface standard used ' \
34 'for connecting digital audio devices together.'
39 {'id': 'sck', 'name': 'SCK', 'desc': 'Bit clock line'},
40 {'id': 'ws', 'name': 'WS', 'desc': 'Word select line'},
41 {'id': 'sd', 'name': 'SD', 'desc': 'Serial Data line'},
44 ['ASCII', 'Annotations in ASCII format'],
47 def __init__(self, **kwargs):
52 self.samplesreceived = 0
53 self.start_sample = None
57 def start(self, metadata):
58 self.out_proto = self.add(srd.OUTPUT_PROTO, 'i2s')
59 self.out_ann = self.add(srd.OUTPUT_ANN, 'i2s')
62 return 'I2S: %d samples received' % self.samplesreceived
64 def decode(self, ss, es, data):
65 for samplenum, (sck, ws, sd) in data:
67 # Ignore sample if the bit clock hasn't changed.
68 if sck == self.oldsck:
72 if sck == 0: # Ignore the falling clock edge
75 self.data = (self.data << 1) | sd
78 # This was not the LSB unless WS has flipped
82 # Only submit the sample, if we received the beginning of it
83 if self.start_sample != None:
84 self.samplesreceived += 1
85 self.put(self.start_sample, self.samplenum, self.out_proto,
87 self.put(self.start_sample, self.samplenum, self.out_ann,
88 [ANN_HEX, ['%s: 0x%08x' % ('L' if self.oldws else 'R',
91 # Check that the data word was the correct length
92 if self.wordlength != -1 and self.wordlength != self.bitcount:
93 self.put(self.start_sample, self.samplenum, self.out_ann,
94 [ANN_HEX, ['WARNING: Received a %d-bit word, when a '
95 '%d-bit word was expected' % (self.bitcount,
98 self.wordlength = self.bitcount
100 # Reset decoder state.
103 self.start_sample = self.samplenum