Add a CFP decoder.
[libsigrokdecode.git] / decoders / parallel / __init__.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, see <http://www.gnu.org/licenses/>.
18 ##
19
20 '''
21 This protocol decoder can decode synchronous parallel buses with various
22 number of data bits/channels and one (optional) clock line.
23
24 If no clock line is supplied, the decoder works slightly differently in
25 that it interprets every transition on any of the supplied data channels
26 like there had been a clock transition.
27
28 It is required to use the lowest data channels, and use consecutive ones.
29 For example, for a 4-bit sync parallel bus, channels D0/D1/D2/D3 (and CLK)
30 should be used. Using combinations like D7/D12/D3/D15 is not supported.
31 For an 8-bit bus you should use D0-D7, for a 16-bit bus use D0-D15 and so on.
32 '''
33
34 from .pd import Decoder