33d25b56ea0e4c67fc662c43234e5e147ca5b51d
[libsigrokdecode.git] / decoders / ssi32 / pd.py
1 ##
2 ## This file is part of the libsigrokdecode project.
3 ##
4 ## Copyright (C) 2016 Robert Bosch Car Multimedia GmbH
5 ## Authors: Oleksij Rempel
6 ##              <fixed-term.Oleksij.Rempel@de.bosch.com>
7 ##              <linux@rempel-privat.de>
8 ##
9 ## This program is free software; you can redistribute it and/or modify
10 ## it under the terms of the GNU General Public License as published by
11 ## the Free Software Foundation; either version 2 of the License, or
12 ## (at your option) any later version.
13 ##
14 ## This program is distributed in the hope that it will be useful,
15 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 ## GNU General Public License for more details.
18 ##
19 ## You should have received a copy of the GNU General Public License
20 ## along with this program; if not, see <http://www.gnu.org/licenses/>.
21 ##
22
23 import sigrokdecode as srd
24
25 class Decoder(srd.Decoder):
26     api_version = 3
27     id = 'ssi32'
28     name = 'SSI32'
29     longname = 'Synchronous Serial Interface (32bit)'
30     desc = 'Synchronous Serial Interface (32bit) protocol.'
31     license = 'gplv2+'
32     inputs = ['spi']
33     outputs = ['ssi32']
34     tags = ['Embedded/industrial']
35     options = (
36         {'id': 'msgsize', 'desc': 'Message size', 'default': 64},
37     )
38     annotations = (
39         ('ctrl-tx', 'CTRL TX'),
40         ('ack-tx', 'ACK TX'),
41         ('ctrl-rx', 'CTRL RX'),
42         ('ack-rx', 'ACK RX'),
43     )
44     annotation_rows = (
45         ('tx', 'TX', (0, 1)),
46         ('rx', 'RX', (2, 3)),
47     )
48
49     def __init__(self):
50         self.reset()
51
52     def reset(self):
53         self.ss_cmd, self.es_cmd = 0, 0
54         self.mosi_bytes = []
55         self.miso_bytes = []
56         self.es_array = []
57         self.rx_size = 0
58         self.tx_size = 0
59
60     def start(self):
61         self.out_ann = self.register(srd.OUTPUT_ANN)
62
63     def putx(self, data):
64         self.put(self.ss_cmd, self.es_cmd, self.out_ann, data)
65
66     def reset_data(self):
67         self.mosi_bytes = []
68         self.miso_bytes = []
69         self.es_array = []
70
71     def handle_ack(self):
72         # Only first byte should have ACK data, other 3 bytes are reserved.
73         self.es_cmd = self.es_array[0]
74         self.putx([1, ['> ACK:0x%02x' % (self.mosi_bytes[0])]])
75         self.putx([3, ['< ACK:0x%02x' % (self.miso_bytes[0])]])
76
77     def handle_ctrl(self):
78         mosi = miso = ''
79         self.tx_size = self.mosi_bytes[2]
80         self.rx_size = self.miso_bytes[2]
81
82         if self.tx_size > 0:
83             mosi = ', DATA:0x' + ''.join(format(x, '02x') for x in self.mosi_bytes[4:self.tx_size + 4])
84         if self.rx_size > 0:
85             miso = ', DATA:0x' + ''.join(format(x, '02x') for x in self.miso_bytes[4:self.rx_size + 4])
86
87         self.es_cmd = self.es_array[self.tx_size + 3]
88         self.putx([0, ['> CTRL:0x%02x, LUN:0x%02x, SIZE:0x%02x, CRC:0x%02x%s'
89                    % (self.mosi_bytes[0], self.mosi_bytes[1],
90                       self.mosi_bytes[2], self.mosi_bytes[3], mosi)]])
91
92         self.es_cmd = self.es_array[self.rx_size + 3]
93         self.putx([2, ['< CTRL:0x%02x, LUN:0x%02x, SIZE:0x%02x, CRC:0x%02x%s'
94                    % (self.miso_bytes[0], self.miso_bytes[1],
95                       self.miso_bytes[2], self.miso_bytes[3], miso)]])
96
97     def decode(self, ss, es, data):
98         ptype = data[0]
99         if ptype == 'CS-CHANGE':
100             self.reset_data()
101             return
102
103         # Don't care about anything else.
104         if ptype != 'DATA':
105             return
106         mosi, miso = data[1:]
107
108         self.ss, self.es = ss, es
109
110         if len(self.mosi_bytes) == 0:
111             self.ss_cmd = ss
112         self.mosi_bytes.append(mosi)
113         self.miso_bytes.append(miso)
114         self.es_array.append(es)
115
116         if self.mosi_bytes[0] & 0x80:
117             if len(self.mosi_bytes) < 4:
118                 return
119
120             self.handle_ack()
121             self.reset_data()
122         else:
123             if len(self.mosi_bytes) < self.options['msgsize']:
124                 return
125
126             self.handle_ctrl()
127             self.reset_data()