0b512c8d80a1e6496aa25e064e8bdbb3ff423950
[libsigrokdecode.git] / decoders / parallel / pd.py
1 ##
2 ## This file is part of the libsigrokdecode project.
3 ##
4 ## Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de>
5 ##
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.
10 ##
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.
15 ##
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
19 ##
20
21 import sigrokdecode as srd
22
23 '''
24 OUTPUT_PYTHON format:
25
26 Packet:
27 [<ptype>, <pdata>]
28
29 <ptype>, <pdata>
30  - 'ITEM', [<item>, <itembitsize>]
31  - 'WORD', [<word>, <wordbitsize>, <worditemcount>]
32
33 <item>:
34  - A single item (a number). It can be of arbitrary size. The max. number
35    of bits in this item is specified in <itembitsize>.
36
37 <itembitsize>:
38  - The size of an item (in bits). For a 4-bit parallel bus this is 4,
39    for a 16-bit parallel bus this is 16, and so on.
40
41 <word>:
42  - A single word (a number). It can be of arbitrary size. The max. number
43    of bits in this word is specified in <wordbitsize>. The (exact) number
44    of items in this word is specified in <worditemcount>.
45
46 <wordbitsize>:
47  - The size of a word (in bits). For a 2-item word with 8-bit items
48    <wordbitsize> is 16, for a 3-item word with 4-bit items <wordbitsize>
49    is 12, and so on.
50
51 <worditemcount>:
52  - The size of a word (in number of items). For a 4-item word (no matter
53    how many bits each item consists of) <worditemcount> is 4, for a 7-item
54    word <worditemcount> is 7, and so on.
55 '''
56
57 def channel_list(num_channels):
58     l = [{'id': 'clk', 'name': 'CLK', 'desc': 'Clock line'}]
59     for i in range(num_channels):
60         d = {'id': 'd%d' % i, 'name': 'D%d' % i, 'desc': 'Data line %d' % i}
61         l.append(d)
62     return tuple(l)
63
64 class Decoder(srd.Decoder):
65     api_version = 2
66     id = 'parallel'
67     name = 'Parallel'
68     longname = 'Parallel sync bus'
69     desc = 'Generic parallel synchronous bus.'
70     license = 'gplv2+'
71     inputs = ['logic']
72     outputs = ['parallel']
73     optional_channels = channel_list(8)
74     options = (
75         {'id': 'clock_edge', 'desc': 'Clock edge to sample on',
76             'default': 'rising', 'values': ('rising', 'falling')},
77         {'id': 'wordsize', 'desc': 'Data wordsize', 'default': 1},
78         {'id': 'endianness', 'desc': 'Data endianness',
79             'default': 'little', 'values': ('little', 'big')},
80     )
81     annotations = (
82         ('items', 'Items'),
83         ('words', 'Words'),
84     )
85
86     def __init__(self):
87         self.oldclk = None
88         self.items = []
89         self.itemcount = 0
90         self.saved_item = None
91         self.samplenum = 0
92         self.oldpins = None
93         self.ss_item = self.es_item = None
94         self.first = True
95
96     def start(self):
97         self.out_python = self.register(srd.OUTPUT_PYTHON)
98         self.out_ann = self.register(srd.OUTPUT_ANN)
99
100     def putpb(self, data):
101         self.put(self.ss_item, self.es_item, self.out_python, data)
102
103     def putb(self, data):
104         self.put(self.ss_item, self.es_item, self.out_ann, data)
105
106     def putpw(self, data):
107         self.put(self.ss_word, self.es_word, self.out_python, data)
108
109     def putw(self, data):
110         self.put(self.ss_word, self.es_word, self.out_ann, data)
111
112     def handle_bits(self, datapins):
113         # If this is the first item in a word, save its sample number.
114         if self.itemcount == 0:
115             self.ss_word = self.samplenum
116
117         # Get the bits for this item.
118         item, used_pins = 0, datapins.count(b'\x01') + datapins.count(b'\x00')
119         for i in range(used_pins):
120             item |= datapins[i] << i
121
122         self.items.append(item)
123         self.itemcount += 1
124
125         if self.first == True:
126             # Save the start sample and item for later (no output yet).
127             self.ss_item = self.samplenum
128             self.first = False
129             self.saved_item = item
130         else:
131             # Output the saved item (from the last CLK edge to the current).
132             self.es_item = self.samplenum
133             self.putpb(['ITEM', self.saved_item])
134             self.putb([0, ['%X' % self.saved_item]])
135             self.ss_item = self.samplenum
136             self.saved_item = item
137
138         endian, ws = self.options['endianness'], self.options['wordsize']
139
140         # Get as many items as the configured wordsize says.
141         if self.itemcount < ws:
142             return
143
144         # Output annotations/python for a word (a collection of items).
145         word = 0
146         for i in range(ws):
147             if endian == 'little':
148                 word |= self.items[i] << ((ws - 1 - i) * used_pins)
149             elif endian == 'big':
150                 word |= self.items[i] << (i * used_pins)
151
152         self.es_word = self.samplenum
153         # self.putpw(['WORD', word])
154         # self.putw([1, ['%X' % word]])
155         self.ss_word = self.samplenum
156
157         self.itemcount, self.items = 0, []
158
159     def find_clk_edge(self, clk, datapins):
160         # Ignore sample if the clock pin hasn't changed.
161         if clk == self.oldclk:
162             return
163         self.oldclk = clk
164
165         # Sample data on rising/falling clock edge (depends on config).
166         c = self.options['clock_edge']
167         if c == 'rising' and clk == 0: # Sample on rising clock edge.
168             return
169         elif c == 'falling' and clk == 1: # Sample on falling clock edge.
170             return
171
172         # Found the correct clock edge, now get the bits.
173         self.handle_bits(datapins)
174
175     def decode(self, ss, es, data):
176         for (self.samplenum, pins) in data:
177
178             # Ignore identical samples early on (for performance reasons).
179             if self.oldpins == pins:
180                 continue
181             self.oldpins = pins
182
183             if pins[0] not in (0, 1):
184                 self.handle_bits(pins[1:])
185             else:
186                 self.find_clk_edge(pins[0], pins[1:])
187