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 = 'Serial bus for connecting digital audio devices.'
38 {'id': 'sck', 'name': 'SCK', 'desc': 'Bit clock line'},
39 {'id': 'ws', 'name': 'WS', 'desc': 'Word select line'},
40 {'id': 'sd', 'name': 'SD', 'desc': 'Serial data line'},
45 ['Hex', 'Annotations in hex format'],
48 def __init__(self, **kwargs):
53 self.samplesreceived = 0
54 self.first_sample = None
55 self.start_sample = None
59 def start(self, metadata):
60 self.samplerate = metadata['samplerate']
61 self.out_proto = self.add(srd.OUTPUT_PROTO, 'i2s')
62 self.out_ann = self.add(srd.OUTPUT_ANN, 'i2s')
66 # Calculate the sample rate.
68 if self.start_sample != None and \
69 self.first_sample != None and \
70 self.start_sample > self.first_sample:
71 samplerate = '%d' % (self.samplesreceived *
72 self.samplerate / (self.start_sample -
75 return 'I2S: %d %d-bit samples received at %sHz' % \
76 (self.samplesreceived, self.wordlength, samplerate)
78 def decode(self, ss, es, data):
79 for samplenum, (sck, ws, sd) in data:
81 # Ignore sample if the bit clock hasn't changed.
82 if sck == self.oldsck:
86 if sck == 0: # Ignore the falling clock edge.
89 self.data = (self.data << 1) | sd
92 # This was not the LSB unless WS has flipped.
96 # Only submit the sample, if we received the beginning of it.
97 if self.start_sample != None:
98 self.samplesreceived += 1
99 self.put(self.start_sample, self.samplenum, self.out_proto,
101 self.put(self.start_sample, self.samplenum, self.out_ann,
102 [ANN_HEX, ['%s: 0x%08x' % ('L' if self.oldws else 'R',
105 # Check that the data word was the correct length.
106 if self.wordlength != -1 and self.wordlength != self.bitcount:
107 self.put(self.start_sample, self.samplenum, self.out_ann,
108 [ANN_HEX, ['WARNING: Received a %d-bit word, when a '
109 '%d-bit word was expected' % (self.bitcount,
112 self.wordlength = self.bitcount
114 # Reset decoder state.
117 self.start_sample = self.samplenum
119 # Save the first sample position.
120 if self.first_sample == None:
121 self.first_sample = self.samplenum