fb9ad00d7dfab3421bf510aca73d75fed78ac914
[libsigrokdecode.git] / decoders / gpib / pd.py
1 ##
2 ## This file is part of the libsigrokdecode project.
3 ##
4 ## Copyright (C) 2016 Rudolf Reuter <reuterru@arcor.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 import sigrokdecode as srd
21
22 class Decoder(srd.Decoder):
23     api_version = 3
24     id = 'gpib'
25     name = 'GPIB'
26     longname = 'General Purpose Interface Bus'
27     desc = 'IEEE-488 General Purpose Interface Bus (GPIB / HPIB).'
28     license = 'gplv2+'
29     inputs = ['logic']
30     outputs = ['gpib']
31     tags = ['PC']
32     channels = (
33         {'id': 'dio1' , 'name': 'DIO1', 'desc': 'Data I/O bit 1'},
34         {'id': 'dio2' , 'name': 'DIO2', 'desc': 'Data I/O bit 2'},
35         {'id': 'dio3' , 'name': 'DIO3', 'desc': 'Data I/O bit 3'},
36         {'id': 'dio4' , 'name': 'DIO4', 'desc': 'Data I/O bit 4'},
37         {'id': 'dio5' , 'name': 'DIO5', 'desc': 'Data I/O bit 5'},
38         {'id': 'dio6' , 'name': 'DIO6', 'desc': 'Data I/O bit 6'},
39         {'id': 'dio7' , 'name': 'DIO7', 'desc': 'Data I/O bit 7'},
40         {'id': 'dio8' , 'name': 'DIO8', 'desc': 'Data I/O bit 8'},
41         {'id': 'eoi', 'name': 'EOI', 'desc': 'End or identify'},
42         {'id': 'dav', 'name': 'DAV', 'desc': 'Data valid'},
43         {'id': 'nrfd', 'name': 'NRFD', 'desc': 'Not ready for data'},
44         {'id': 'ndac', 'name': 'NDAC', 'desc': 'Not data accepted'},
45         {'id': 'ifc', 'name': 'IFC', 'desc': 'Interface clear'},
46         {'id': 'srq', 'name': 'SRQ', 'desc': 'Service request'},
47         {'id': 'atn', 'name': 'ATN', 'desc': 'Attention'},
48         {'id': 'ren', 'name': 'REN', 'desc': 'Remote enable'},
49     )
50     options = (
51         {'id': 'sample_total', 'desc': 'Total number of samples', 'default': 0},
52     )
53     annotations = (
54         ('items', 'Items'),
55         ('gpib', 'DAT/CMD'),
56         ('eoi', 'EOI'),
57     )
58     annotation_rows = (
59         ('bytes', 'Bytes', (0,)),
60         ('gpib', 'DAT/CMD', (1,)),
61         ('eoi', 'EOI', (2,)),
62     )
63
64     def __init__(self):
65         self.reset()
66
67     def reset(self):
68         self.items = []
69         self.itemcount = 0
70         self.saved_item = None
71         self.saved_ATN = False
72         self.saved_EOI = False
73         self.samplenum = 0
74         self.ss_item = self.es_item = None
75         self.first = True
76
77     def start(self):
78         self.out_ann = self.register(srd.OUTPUT_ANN)
79
80     def putb(self, data):
81         self.put(self.ss_item, self.es_item, self.out_ann, data)
82
83     def handle_bits(self, datapins):
84         dbyte = 0x20
85         dATN = False
86         item2 = False
87         dEOI = False
88         item3 = False
89         # If this is the first item in a word, save its sample number.
90         if self.itemcount == 0:
91             self.ss_word = self.samplenum
92
93         # Get the bits for this item.
94         item = 0
95         for i in range(8):
96             item |= datapins[i] << i
97
98         item = item ^ 0xff # Invert data byte.
99         self.items.append(item)
100         self.itemcount += 1
101
102         if datapins[14] == 0:
103             item2 = True
104         if datapins[8] == 0:
105             item3 = True
106
107         if self.first:
108             # Save the start sample and item for later (no output yet).
109             self.ss_item = self.samplenum
110             self.first = False
111             self.saved_item = item
112             self.saved_ATN = item2
113             self.saved_EOI = item3
114         else:
115             # Output the saved item.
116             dbyte = self.saved_item
117             dATN = self.saved_ATN
118             dEOI = self.saved_EOI
119             self.es_item = self.samplenum
120             self.putb([0, ['%02X' % self.saved_item]])
121
122             # Encode item byte to GPIB convention.
123             self.strgpib = ' '
124             if dATN: # ATN, decode commands.
125                 if dbyte == 0x01: self.strgpib = 'GTL'
126                 if dbyte == 0x04: self.strgpib = 'SDC'
127                 if dbyte == 0x05: self.strgpib = 'PPC'
128                 if dbyte == 0x08: self.strgpib = 'GET'
129                 if dbyte == 0x09: self.strgpib = 'TCT'
130                 if dbyte == 0x11: self.strgpib = 'LLO'
131                 if dbyte == 0x14: self.strgpib = 'DCL'
132                 if dbyte == 0x15: self.strgpib = 'PPU'
133                 if dbyte == 0x18: self.strgpib = 'SPE'
134                 if dbyte == 0x19: self.strgpib = 'SPD'
135                 if dbyte == 0x3f: self.strgpib = 'UNL'
136                 if dbyte == 0x5f: self.strgpib = 'UNT'
137                 if dbyte > 0x1f and dbyte < 0x3f: # Address Listener.
138                     self.strgpib = 'L' + chr(dbyte + 0x10)
139                 if dbyte > 0x3f and dbyte < 0x5f: # Address Talker
140                     self.strgpib = 'T' + chr(dbyte - 0x10)
141             else:
142                 if dbyte > 0x1f and dbyte < 0x7f:
143                     self.strgpib = chr(dbyte)
144                 if dbyte == 0x0a:
145                     self.strgpib = 'LF'
146                 if dbyte == 0x0d:
147                     self.strgpib = 'CR'
148
149             self.putb([1, [self.strgpib]])
150             self.strEOI = ' '
151             if dEOI:
152                 self.strEOI = 'EOI'
153             self.putb([2, [self.strEOI]])
154
155             self.ss_item = self.samplenum
156             self.saved_item = item
157             self.saved_ATN = item2
158             self.saved_EOI = item3
159
160         if self.itemcount < 16:
161             return
162
163         self.itemcount, self.items = 0, []
164
165     def decode(self):
166
167         # Inspect samples at falling edge of DAV. But make sure to also
168         # start inspection when the capture happens to start with low
169         # DAV level. Optionally enforce processing when a user specified
170         # sample number was reached.
171         waitcond = [{9: 'l'}]
172         lsn = self.options['sample_total']
173         if lsn:
174             waitcond.append({'skip': lsn})
175         while True:
176             if lsn:
177                 waitcond[1]['skip'] = lsn - self.samplenum - 1
178             pins = self.wait(waitcond)
179             self.handle_bits(pins)
180             waitcond[0][9] = 'f'