summaryrefslogtreecommitdiff
path: root/decoders/ssi32/pd.py
blob: 8c68e0df2ade40df5c051e034dca19109696abe5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
##
## This file is part of the libsigrokdecode project.
##
## Copyright (C) 2016 Robert Bosch Car Multimedia GmbH
## Authors: Oleksij Rempel
##              <fixed-term.Oleksij.Rempel@de.bosch.com>
##              <linux@rempel-privat.de>
##
## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 2 of the License, or
## (at your option) any later version.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with this program; if not, write to the Free Software
## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
##

import sigrokdecode as srd

class Decoder(srd.Decoder):
    api_version = 2
    id = 'ssi32'
    name = 'SSI32'
    longname = 'Synchronous Serial Interface (32bit)'
    desc = 'Synchronous Serial Interface (32bit) protocol.'
    license = 'gplv2+'
    inputs = ['spi']
    outputs = ['ssi32']
    options = (
        {'id': 'msgsize', 'desc': 'Message size', 'default': 64},
    )
    annotations = (
        ('ctrl-tx', 'CTRL TX'),
        ('ack-tx', 'ACK TX'),
        ('ctrl-rx', 'CTRL RX'),
        ('ack-rx', 'ACK RX'),
    )
    annotation_rows = (
        ('tx', 'TX', (0, 1)),
        ('rx', 'RX', (2, 3)),
    )

    def __init__(self):
        self.ss_cmd, self.es_cmd = 0, 0
        self.mosi_bytes = []
        self.miso_bytes = []
        self.es_array = []
        self.rx_size = 0
        self.tx_size = 0

    def start(self):
        self.out_ann = self.register(srd.OUTPUT_ANN)

    def putx(self, data):
        self.put(self.ss_cmd, self.es_cmd, self.out_ann, data)

    def reset(self):
        self.mosi_bytes = []
        self.miso_bytes = []
        self.es_array = []

    def handle_ack(self):
        # Only first byte should have ACK data, other 3 bytes are reserved.
        self.es_cmd = self.es_array[0]
        self.putx([1, ['> ACK:0x%02x' % (self.mosi_bytes[0])]])
        self.putx([3, ['< ACK:0x%02x' % (self.miso_bytes[0])]])

    def handle_ctrl(self):
        mosi = miso = ''
        self.tx_size = self.mosi_bytes[2]
        self.rx_size = self.miso_bytes[2]

        if self.tx_size > 0:
            mosi = ', DATA:0x' + ''.join(format(x, '02x') for x in self.mosi_bytes[4:self.tx_size + 4])
        if self.rx_size > 0:
            miso = ', DATA:0x' + ''.join(format(x, '02x') for x in self.miso_bytes[4:self.rx_size + 4])

        self.es_cmd = self.es_array[self.tx_size + 3]
        self.putx([0, ['> CTRL:0x%02x, LUN:0x%02x, SIZE:0x%02x, CRC:0x%02x%s'
                   % (self.mosi_bytes[0], self.mosi_bytes[1],
                      self.mosi_bytes[2], self.mosi_bytes[3], mosi)]])

        self.es_cmd = self.es_array[self.rx_size + 3]
        self.putx([2, ['< CTRL:0x%02x, LUN:0x%02x, SIZE:0x%02x, CRC:0x%02x%s'
                   % (self.miso_bytes[0], self.miso_bytes[1],
                      self.miso_bytes[2], self.miso_bytes[3], miso)]])

    def decode(self, ss, es, data):
        ptype = data[0]
        if ptype == 'CS-CHANGE':
            self.reset()
            return

        # Don't care about anything else.
        if ptype != 'DATA':
            return
        mosi, miso = data[1:]

        self.ss, self.es = ss, es

        if len(self.mosi_bytes) == 0:
            self.ss_cmd = ss
        self.mosi_bytes.append(mosi)
        self.miso_bytes.append(miso)
        self.es_array.append(es)

        if self.mosi_bytes[0] & 0x80:
            if len(self.mosi_bytes) < 4:
                return

            self.handle_ack()
            self.reset()
        else:
            if len(self.mosi_bytes) < self.options['msgsize']:
                return

            self.handle_ctrl()
            self.reset()