Change PD options to be a tuple of dictionaries.
[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 probe_list(num_probes):
58     l = [{'id': 'clk', 'name': 'CLK', 'desc': 'Clock line'}]
59     for i in range(num_probes):
60         d = {'id': 'd%d' % i, 'name': 'D%d' % i, 'desc': 'Data line %d' % i}
61         l.append(d)
62     return l
63
64 class Decoder(srd.Decoder):
65     api_version = 1
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     probes = []
74     optional_probes = probe_list(8)
75     options = (
76         {'id': 'clock_edge', 'desc': 'Clock edge to sample on',
77             'default': 'rising', 'values': ('rising', 'falling')},
78         {'id': 'wordsize', 'desc': 'Word size of the data',
79             'default': 1},
80         {'id': 'endianness', 'desc': 'Endianness of the data',
81             'default': 'little', 'values': ('little', 'big')},
82     )
83     annotations = [
84         ['items', 'Items'],
85         ['words', 'Words'],
86     ]
87
88     def __init__(self):
89         self.oldclk = None
90         self.items = []
91         self.itemcount = 0
92         self.saved_item = None
93         self.samplenum = 0
94         self.oldpins = None
95         self.ss_item = self.es_item = None
96         self.first = True
97         self.state = 'IDLE'
98
99     def start(self):
100         self.out_python = self.register(srd.OUTPUT_PYTHON)
101         self.out_ann = self.register(srd.OUTPUT_ANN)
102
103     def putpb(self, data):
104         self.put(self.ss_item, self.es_item, self.out_python, data)
105
106     def putb(self, data):
107         self.put(self.ss_item, self.es_item, self.out_ann, data)
108
109     def putpw(self, data):
110         self.put(self.ss_word, self.es_word, self.out_python, data)
111
112     def putw(self, data):
113         self.put(self.ss_word, self.es_word, self.out_ann, data)
114
115     def handle_bits(self, datapins):
116         # If this is the first item in a word, save its sample number.
117         if self.itemcount == 0:
118             self.ss_word = self.samplenum
119
120         # Get the bits for this item.
121         item, used_pins = 0, datapins.count(b'\x01') + datapins.count(b'\x00')
122         for i in range(used_pins):
123             item |= datapins[i] << i
124
125         self.items.append(item)
126         self.itemcount += 1
127
128         if self.first == True:
129             # Save the start sample and item for later (no output yet).
130             self.ss_item = self.samplenum
131             self.first = False
132             self.saved_item = item
133         else:
134             # Output the saved item (from the last CLK edge to the current).
135             self.es_item = self.samplenum
136             self.putpb(['ITEM', self.saved_item])
137             self.putb([0, ['%X' % self.saved_item]])
138             self.ss_item = self.samplenum
139             self.saved_item = item
140
141         endian, ws = self.options['endianness'], self.options['wordsize']
142
143         # Get as many items as the configured wordsize says.
144         if self.itemcount < ws:
145             return
146
147         # Output annotations/python for a word (a collection of items).
148         word = 0
149         for i in range(ws):
150             if endian == 'little':
151                 word |= self.items[i] << ((ws - 1 - i) * used_pins)
152             elif endian == 'big':
153                 word |= self.items[i] << (i * used_pins)
154
155         self.es_word = self.samplenum
156         # self.putpw(['WORD', word])
157         # self.putw([1, ['%X' % word]])
158         self.ss_word = self.samplenum
159
160         self.itemcount, self.items = 0, []
161
162     def find_clk_edge(self, clk, datapins):
163         # Ignore sample if the clock pin hasn't changed.
164         if clk == self.oldclk:
165             return
166         self.oldclk = clk
167
168         # Sample data on rising/falling clock edge (depends on config).
169         c = self.options['clock_edge']
170         if c == 'rising' and clk == 0: # Sample on rising clock edge.
171             return
172         elif c == 'falling' and clk == 1: # Sample on falling clock edge.
173             return
174
175         # Found the correct clock edge, now get the bits.
176         self.handle_bits(datapins)
177
178     def decode(self, ss, es, data):
179         for (self.samplenum, pins) in data:
180
181             # Ignore identical samples early on (for performance reasons).
182             if self.oldpins == pins:
183                 continue
184             self.oldpins = pins
185
186             # State machine.
187             if self.state == 'IDLE':
188                 if pins[0] not in (0, 1):
189                     self.handle_bits(pins[1:])
190                 else:
191                     self.find_clk_edge(pins[0], pins[1:])
192             else:
193                 raise Exception('Invalid state: %s' % self.state)
194