2 ## This file is part of the libsigrokdecode project.
4 ## Copyright (C) 2016 Rudolf Reuter <reuterru@arcor.de>
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.
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.
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/>.
20 import sigrokdecode as srd
22 class Decoder(srd.Decoder):
26 longname = 'General Purpose Interface Bus'
27 desc = 'IEEE-488 GPIB / HPIB protocol.'
32 {'id': 'dio1' , 'name': 'DIO1', 'desc': 'Data I/O bit 1'},
33 {'id': 'dio2' , 'name': 'DIO2', 'desc': 'Data I/O bit 2'},
34 {'id': 'dio3' , 'name': 'DIO3', 'desc': 'Data I/O bit 3'},
35 {'id': 'dio4' , 'name': 'DIO4', 'desc': 'Data I/O bit 4'},
36 {'id': 'dio5' , 'name': 'DIO5', 'desc': 'Data I/O bit 5'},
37 {'id': 'dio6' , 'name': 'DIO6', 'desc': 'Data I/O bit 6'},
38 {'id': 'dio7' , 'name': 'DIO7', 'desc': 'Data I/O bit 7'},
39 {'id': 'dio8' , 'name': 'DIO8', 'desc': 'Data I/O bit 8'},
40 {'id': 'eoi', 'name': 'EOI', 'desc': 'End or identify'},
41 {'id': 'dav', 'name': 'DAV', 'desc': 'Data valid'},
42 {'id': 'nrfd', 'name': 'NRFD', 'desc': 'Not ready for data'},
43 {'id': 'ndac', 'name': 'NDAC', 'desc': 'Not data accepted'},
44 {'id': 'ifc', 'name': 'IFC', 'desc': 'Interface clear'},
45 {'id': 'srq', 'name': 'SRQ', 'desc': 'Service request'},
46 {'id': 'atn', 'name': 'ATN', 'desc': 'Attention'},
47 {'id': 'ren', 'name': 'REN', 'desc': 'Remote enable'},
50 {'id': 'sample_total', 'desc': 'Total number of samples', 'default': 0},
58 ('bytes', 'Bytes', (0,)),
59 ('gpib', 'DAT/CMD', (1,)),
69 self.saved_item = None
70 self.saved_ATN = False
71 self.saved_EOI = False
73 self.ss_item = self.es_item = None
77 self.out_ann = self.register(srd.OUTPUT_ANN)
80 self.put(self.ss_item, self.es_item, self.out_ann, data)
82 def handle_bits(self, datapins):
88 # If this is the first item in a word, save its sample number.
89 if self.itemcount == 0:
90 self.ss_word = self.samplenum
92 # Get the bits for this item.
95 item |= datapins[i] << i
97 item = item ^ 0xff # Invert data byte.
98 self.items.append(item)
101 if datapins[14] == 0:
107 # Save the start sample and item for later (no output yet).
108 self.ss_item = self.samplenum
110 self.saved_item = item
111 self.saved_ATN = item2
112 self.saved_EOI = item3
114 # Output the saved item.
115 dbyte = self.saved_item
116 dATN = self.saved_ATN
117 dEOI = self.saved_EOI
118 self.es_item = self.samplenum
119 self.putb([0, ['%02X' % self.saved_item]])
121 # Encode item byte to GPIB convention.
123 if dATN: # ATN, decode commands.
124 if dbyte == 0x01: self.strgpib = 'GTL'
125 if dbyte == 0x04: self.strgpib = 'SDC'
126 if dbyte == 0x05: self.strgpib = 'PPC'
127 if dbyte == 0x08: self.strgpib = 'GET'
128 if dbyte == 0x09: self.strgpib = 'TCT'
129 if dbyte == 0x11: self.strgpib = 'LLO'
130 if dbyte == 0x14: self.strgpib = 'DCL'
131 if dbyte == 0x15: self.strgpib = 'PPU'
132 if dbyte == 0x18: self.strgpib = 'SPE'
133 if dbyte == 0x19: self.strgpib = 'SPD'
134 if dbyte == 0x3f: self.strgpib = 'UNL'
135 if dbyte == 0x5f: self.strgpib = 'UNT'
136 if dbyte > 0x1f and dbyte < 0x3f: # Address Listener.
137 self.strgpib = 'L' + chr(dbyte + 0x10)
138 if dbyte > 0x3f and dbyte < 0x5f: # Address Talker
139 self.strgpib = 'T' + chr(dbyte - 0x10)
141 if dbyte > 0x1f and dbyte < 0x7f:
142 self.strgpib = chr(dbyte)
148 self.putb([1, [self.strgpib]])
152 self.putb([2, [self.strEOI]])
154 self.ss_item = self.samplenum
155 self.saved_item = item
156 self.saved_ATN = item2
157 self.saved_EOI = item3
159 if self.itemcount < 16:
162 self.itemcount, self.items = 0, []
166 # Inspect samples at falling edge of DAV. But make sure to also
167 # start inspection when the capture happens to start with low
168 # DAV level. Optionally enforce processing when a user specified
169 # sample number was reached.
170 waitcond = [{9: 'l'}]
171 lsn = self.options['sample_total']
173 waitcond.append({'skip': lsn})
176 waitcond[1]['skip'] = lsn - self.samplenum - 1
177 pins = self.wait(waitcond)
178 self.handle_bits(pins)