decoders/ieee488/pd.py

   1 ##
   2 ## This file is part of the libsigrokdecode project.
   3 ##
   4 ## Copyright (C) 2016 Rudolf Reuter <reuterru@arcor.de>
   5 ## Copyright (C) 2017 Marcus Comstedt <marcus@mc.pp.se>
   6 ## Copyright (C) 2019 Gerhard Sittig <gerhard.sittig@gmx.net>
   7 ##
   8 ## This program is free software; you can redistribute it and/or modify
   9 ## it under the terms of the GNU General Public License as published by
  10 ## the Free Software Foundation; either version 2 of the License, or
  11 ## (at your option) any later version.
  12 ##
  13 ## This program is distributed in the hope that it will be useful,
  14 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 ## GNU General Public License for more details.
  17 ##
  18 ## You should have received a copy of the GNU General Public License
  19 ## along with this program; if not, see <http://www.gnu.org/licenses/>.
  20 ##
  21
  22 # This file was created from earlier implementations of the 'gpib' and
  23 # the 'iec' protocol decoders. It combines the parallel and the serial
  24 # transmission variants in a single instance with optional inputs for
  25 # maximum code re-use.
  26
  27 # TODO
  28 # - Extend annotations for improved usability.
  29 #   - Keep talkers' data streams on separate annotation rows? Is this useful
  30 #     here at the GPIB level, or shall stacked decoders dispatch these? May
  31 #     depend on how often captures get inspected which involve multiple peers.
  32 #   - Make serial bit annotations optional? Could slow down interactive
  33 #     exploration for long captures (see USB).
  34 # - Move the inlined Commodore IEC peripherals support to a stacked decoder
  35 #   when more peripherals get added.
  36 # - SCPI over GPIB may "represent somewhat naturally" here already when
  37 #   text lines are a single run of data at the GPIB layer (each line between
  38 #   the address spec and either EOI or ATN). So a stacked SCPI decoder may
  39 #   only become necessary when the text lines' content shall get inspected.
  40
  41 import sigrokdecode as srd
  42 from common.srdhelper import bitpack
  43
  44 '''
  45 OUTPUT_PYTHON format for stacked decoders:
  46
  47 General packet format:
  48 [<ptype>, <addr>, <pdata>]
  49
  50 This is the list of <ptype>s and their respective <pdata> values:
  51
  52 Raw bits and bytes at the physical transport level:
  53  - 'IEC_BIT': <addr> is not applicable, <pdata> is the transport's bit value.
  54  - 'GPIB_RAW': <addr> is not applicable, <pdata> is the transport's
  55    byte value. Data bytes are in the 0x00-0xff range, command/address
  56    bytes are in the 0x100-0x1ff range.
  57
  58 GPIB level byte fields (commands, addresses, pieces of data):
  59  - 'COMMAND': <addr> is not applicable, <pdata> is the command's byte value.
  60  - 'LISTEN': <addr> is the listener address (0-30), <pdata> is the raw
  61    byte value (including the 0x20 offset).
  62  - 'TALK': <addr> is the talker address (0-30), <pdata> is the raw byte
  63    value (including the 0x40 offset).
  64  - 'SECONDARY': <addr> is the secondary address (0-31), <pdata> is the
  65    raw byte value (including the 0x60 offset).
  66  - 'MSB_SET': <addr> as well as <pdata> are the raw byte value (including
  67    the 0x80 offset). This usually does not happen for GPIB bytes with ATN
  68    active, but was observed with the IEC bus and Commodore floppy drives,
  69    when addressing channels within the device.
  70  - 'DATA_BYTE': <addr> is the talker address (when available), <pdata>
  71    is the raw data byte (transport layer, ATN inactive).
  72
  73 Extracted payload information (peers and their communicated data):
  74  - 'TALK_LISTEN': <addr> is the current talker, <pdata> is the list of
  75    current listeners. These updates for the current "connected peers"
  76    are sent when the set of peers changes, i.e. after talkers/listeners
  77    got selected or deselected. Of course the data only covers what could
  78    be gathered from the input data. Some controllers may not explicitly
  79    address themselves, or captures may not include an early setup phase.
  80  - 'TALKER_BYTES': <addr> is the talker address (when available), <pdata>
  81    is the accumulated byte sequence between addressing a talker and EOI,
  82    or the next command/address.
  83  - 'TALKER_TEXT': <addr> is the talker address (when available), <pdata>
  84    is the accumulated text sequence between addressing a talker and EOI,
  85    or the next command/address.
  86 '''
  87
  88 class ChannelError(Exception):
  89     pass
  90
  91 def _format_ann_texts(fmts, **args):
  92     if not fmts:
  93         return None
  94     return [fmt.format(**args) for fmt in fmts]
  95
  96 _cmd_table = {
  97     # Command codes in the 0x00-0x1f range.
  98     0x01: ['Go To Local', 'GTL'],
  99     0x04: ['Selected Device Clear', 'SDC'],
 100     0x05: ['Parallel Poll Configure', 'PPC'],
 101     0x08: ['Global Execute Trigger', 'GET'],
 102     0x09: ['Take Control', 'TCT'],
 103     0x11: ['Local Lock Out', 'LLO'],
 104     0x14: ['Device Clear', 'DCL'],
 105     0x15: ['Parallel Poll Unconfigure', 'PPU'],
 106     0x18: ['Serial Poll Enable', 'SPE'],
 107     0x19: ['Serial Poll Disable', 'SPD'],
 108     # Unknown type of command.
 109     None: ['Unknown command 0x{cmd:02x}', 'command 0x{cmd:02x}', 'cmd {cmd:02x}', 'C{cmd_ord:c}'],
 110     # Special listener/talker "addresses" (deselecting previous peers).
 111     0x3f: ['Unlisten', 'UNL'],
 112     0x5f: ['Untalk', 'UNT'],
 113 }
 114
 115 def _is_command(b):
 116     # Returns a tuple of booleans (or None when not applicable) whether
 117     # the raw GPIB byte is: a command, an un-listen, an un-talk command.
 118     if b in range(0x00, 0x20):
 119         return True, None, None
 120     if b in range(0x20, 0x40) and (b & 0x1f) == 31:
 121         return True, True, False
 122     if b in range(0x40, 0x60) and (b & 0x1f) == 31:
 123         return True, False, True
 124     return False, None, None
 125
 126 def _is_listen_addr(b):
 127     if b in range(0x20, 0x40):
 128         return b & 0x1f
 129     return None
 130
 131 def _is_talk_addr(b):
 132     if b in range(0x40, 0x60):
 133         return b & 0x1f
 134     return None
 135
 136 def _is_secondary_addr(b):
 137     if b in range(0x60, 0x80):
 138         return b & 0x1f
 139     return None
 140
 141 def _is_msb_set(b):
 142     if b & 0x80:
 143         return b
 144     return None
 145
 146 def _get_raw_byte(b, atn):
 147     # "Decorate" raw byte values for stacked decoders.
 148     return b | 0x100 if atn else b
 149
 150 def _get_raw_text(b, atn):
 151     return ['{leader}{data:02x}'.format(leader = '/' if atn else '', data = b)]
 152
 153 def _get_command_texts(b):
 154     fmts = _cmd_table.get(b, None)
 155     known = fmts is not None
 156     if not fmts:
 157         fmts = _cmd_table.get(None, None)
 158     if not fmts:
 159         return known, None
 160     return known, _format_ann_texts(fmts, cmd = b, cmd_ord = ord('0') + b)
 161
 162 def _get_address_texts(b):
 163     laddr = _is_listen_addr(b)
 164     taddr = _is_talk_addr(b)
 165     saddr = _is_secondary_addr(b)
 166     msb = _is_msb_set(b)
 167     fmts = None
 168     if laddr is not None:
 169         fmts = ['Listen {addr:d}', 'L {addr:d}', 'L{addr_ord:c}']
 170         addr = laddr
 171     elif taddr is not None:
 172         fmts = ['Talk {addr:d}', 'T {addr:d}', 'T{addr_ord:c}']
 173         addr = taddr
 174     elif saddr is not None:
 175         fmts = ['Secondary {addr:d}', 'S {addr:d}', 'S{addr_ord:c}']
 176         addr = saddr
 177     elif msb is not None: # For IEC bus compat.
 178         fmts = ['Secondary {addr:d}', 'S {addr:d}', 'S{addr_ord:c}']
 179         addr = msb
 180     return _format_ann_texts(fmts, addr = addr, addr_ord = ord('0') + addr)
 181
 182 def _get_data_text(b):
 183     # TODO Move the table of ASCII control characters to a common location?
 184     # TODO Move the "printable with escapes" logic to a common helper?
 185     _control_codes = {
 186         0x00: 'NUL',
 187         0x01: 'SOH',
 188         0x02: 'STX',
 189         0x03: 'ETX',
 190         0x04: 'EOT',
 191         0x05: 'ENQ',
 192         0x06: 'ACK',
 193         0x07: 'BEL',
 194         0x08: 'BS',
 195         0x09: 'TAB',
 196         0x0a: 'LF',
 197         0x0b: 'VT',
 198         0x0c: 'FF',
 199         0x0d: 'CR',
 200         0x0e: 'SO',
 201         0x0f: 'SI',
 202         0x10: 'DLE',
 203         0x11: 'DC1',
 204         0x12: 'DC2',
 205         0x13: 'DC3',
 206         0x14: 'DC4',
 207         0x15: 'NAK',
 208         0x16: 'SYN',
 209         0x17: 'ETB',
 210         0x18: 'CAN',
 211         0x19: 'EM',
 212         0x1a: 'SUB',
 213         0x1b: 'ESC',
 214         0x1c: 'FS',
 215         0x1d: 'GS',
 216         0x1e: 'RS',
 217         0x1f: 'US',
 218     }
 219     # Yes, exclude 0x7f (DEL) here. It's considered non-printable.
 220     if b in range(0x20, 0x7f) and b not in ('[', ']'):
 221         return '{:s}'.format(chr(b))
 222     elif b in _control_codes:
 223         return '[{:s}]'.format(_control_codes[b])
 224     # Use a compact yet readable and unambigous presentation for bytes
 225     # which contain non-printables. The format that is used here is
 226     # compatible with 93xx EEPROM and UART decoders.
 227     return '[{:02x}]'.format(b)
 228
 229 (
 230     PIN_DIO1, PIN_DIO2, PIN_DIO3, PIN_DIO4,
 231     PIN_DIO5, PIN_DIO6, PIN_DIO7, PIN_DIO8,
 232     PIN_EOI, PIN_DAV, PIN_NRFD, PIN_NDAC,
 233     PIN_IFC, PIN_SRQ, PIN_ATN, PIN_REN,
 234     PIN_CLK,
 235 ) = range(17)
 236 PIN_DATA = PIN_DIO1
 237
 238 (
 239     ANN_RAW_BIT, ANN_RAW_BYTE,
 240     ANN_CMD, ANN_LADDR, ANN_TADDR, ANN_SADDR, ANN_DATA,
 241     ANN_EOI,
 242     ANN_TEXT,
 243     # TODO Want to provide one annotation class per talker address (0-30)?
 244     ANN_IEC_PERIPH,
 245     ANN_WARN,
 246 ) = range(11)
 247
 248 (
 249     BIN_RAW,
 250     BIN_DATA,
 251     # TODO Want to provide one binary annotation class per talker address (0-30)?
 252 ) = range(2)
 253
 254 class Decoder(srd.Decoder):
 255     api_version = 3
 256     id = 'ieee488'
 257     name = 'IEEE-488'
 258     longname = 'IEEE-488 GPIB/HPIB/IEC'
 259     desc = 'IEEE-488 General Purpose Interface Bus (GPIB/HPIB or IEC).'
 260     license = 'gplv2+'
 261     inputs = ['logic']
 262     outputs = ['ieee488']
 263     tags = ['PC', 'Retro computing']
 264     channels = (
 265         {'id': 'dio1' , 'name': 'DIO1/DATA',
 266             'desc': 'Data I/O bit 1, or serial data'},
 267     )
 268     optional_channels = (
 269         {'id': 'dio2' , 'name': 'DIO2', 'desc': 'Data I/O bit 2'},
 270         {'id': 'dio3' , 'name': 'DIO3', 'desc': 'Data I/O bit 3'},
 271         {'id': 'dio4' , 'name': 'DIO4', 'desc': 'Data I/O bit 4'},
 272         {'id': 'dio5' , 'name': 'DIO5', 'desc': 'Data I/O bit 5'},
 273         {'id': 'dio6' , 'name': 'DIO6', 'desc': 'Data I/O bit 6'},
 274         {'id': 'dio7' , 'name': 'DIO7', 'desc': 'Data I/O bit 7'},
 275         {'id': 'dio8' , 'name': 'DIO8', 'desc': 'Data I/O bit 8'},
 276         {'id': 'eoi', 'name': 'EOI', 'desc': 'End or identify'},
 277         {'id': 'dav', 'name': 'DAV', 'desc': 'Data valid'},
 278         {'id': 'nrfd', 'name': 'NRFD', 'desc': 'Not ready for data'},
 279         {'id': 'ndac', 'name': 'NDAC', 'desc': 'Not data accepted'},
 280         {'id': 'ifc', 'name': 'IFC', 'desc': 'Interface clear'},
 281         {'id': 'srq', 'name': 'SRQ', 'desc': 'Service request'},
 282         {'id': 'atn', 'name': 'ATN', 'desc': 'Attention'},
 283         {'id': 'ren', 'name': 'REN', 'desc': 'Remote enable'},
 284         {'id': 'clk', 'name': 'CLK', 'desc': 'Serial clock'},
 285     )
 286     options = (
 287         {'id': 'iec_periph', 'desc': 'Decode Commodore IEC bus peripherals details',
 288             'default': 'no', 'values': ('no', 'yes')},
 289     )
 290     annotations = (
 291         ('bit', 'IEC bit'),
 292         ('raw', 'Raw byte'),
 293         ('cmd', 'Command'),
 294         ('laddr', 'Listener address'),
 295         ('taddr', 'Talker address'),
 296         ('saddr', 'Secondary address'),
 297         ('data', 'Data byte'),
 298         ('eoi', 'EOI'),
 299         ('text', 'Talker text'),
 300         ('periph', 'IEC bus peripherals'),
 301         ('warn', 'Warning'),
 302     )
 303     annotation_rows = (
 304         ('bits', 'IEC bits', (ANN_RAW_BIT,)),
 305         ('raws', 'Raw bytes', (ANN_RAW_BYTE,)),
 306         ('gpib', 'Commands/data', (ANN_CMD, ANN_LADDR, ANN_TADDR, ANN_SADDR, ANN_DATA,)),
 307         ('eois', 'EOI', (ANN_EOI,)),
 308         ('texts', 'Talker texts', (ANN_TEXT,)),
 309         ('periphs', 'IEC peripherals', (ANN_IEC_PERIPH,)),
 310         ('warns', 'Warnings', (ANN_WARN,)),
 311     )
 312     binary = (
 313         ('raw', 'Raw bytes'),
 314         ('data', 'Talker bytes'),
 315     )
 316
 317     def __init__(self):
 318         self.reset()
 319
 320     def reset(self):
 321         self.curr_raw = None
 322         self.curr_atn = None
 323         self.curr_eoi = None
 324         self.latch_atn = None
 325         self.latch_eoi = None
 326         self.accu_bytes = []
 327         self.accu_text = []
 328         self.ss_raw = None
 329         self.es_raw = None
 330         self.ss_eoi = None
 331         self.es_eoi = None
 332         self.ss_text = None
 333         self.es_text = None
 334         self.last_talker = None
 335         self.last_listener = []
 336         self.last_iec_addr = None
 337         self.last_iec_sec = None
 338
 339     def start(self):
 340         self.out_ann = self.register(srd.OUTPUT_ANN)
 341         self.out_bin = self.register(srd.OUTPUT_BINARY)
 342         self.out_python = self.register(srd.OUTPUT_PYTHON)
 343
 344     def putg(self, ss, es, data):
 345         self.put(ss, es, self.out_ann, data)
 346
 347     def putbin(self, ss, es, data):
 348         self.put(ss, es, self.out_bin, data)
 349
 350     def putpy(self, ss, es, ptype, addr, pdata):
 351         self.put(ss, es, self.out_python, [ptype, addr, pdata])
 352
 353     def emit_eoi_ann(self, ss, es):
 354         self.putg(ss, es, [ANN_EOI, ['EOI']])
 355
 356     def emit_bin_ann(self, ss, es, ann_cls, data):
 357         self.putbin(ss, es, [ann_cls, bytes(data)])
 358
 359     def emit_data_ann(self, ss, es, ann_cls, data):
 360         self.putg(ss, es, [ann_cls, data])
 361
 362     def emit_warn_ann(self, ss, es, data):
 363         self.putg(ss, es, [ANN_WARN, data])
 364
 365     def flush_bytes_text_accu(self):
 366         if self.accu_bytes and self.ss_text is not None and self.es_text is not None:
 367             self.emit_bin_ann(self.ss_text, self.es_text, BIN_DATA, bytearray(self.accu_bytes))
 368             self.putpy(self.ss_text, self.es_text, 'TALKER_BYTES', self.last_talker, bytearray(self.accu_bytes))
 369             self.accu_bytes = []
 370         if self.accu_text and self.ss_text is not None and self.es_text is not None:
 371             text = ''.join(self.accu_text)
 372             self.emit_data_ann(self.ss_text, self.es_text, ANN_TEXT, [text])
 373             self.putpy(self.ss_text, self.es_text, 'TALKER_TEXT', self.last_talker, text)
 374             self.accu_text = []
 375         self.ss_text = self.es_text = None
 376
 377     def handle_ifc_change(self, ifc):
 378         # Track IFC line for parallel input.
 379         # Assertion of IFC de-selects all talkers and listeners.
 380         if ifc:
 381             self.last_talker = None
 382             self.last_listener = []
 383
 384     def handle_eoi_change(self, eoi):
 385         # Track EOI line for parallel and serial input.
 386         if eoi:
 387             self.ss_eoi = self.samplenum
 388             self.curr_eoi = eoi
 389         else:
 390             self.es_eoi = self.samplenum
 391             if self.ss_eoi and self.latch_eoi:
 392                self.emit_eoi_ann(self.ss_eoi, self.es_eoi)
 393             self.es_text = self.es_eoi
 394             self.flush_bytes_text_accu()
 395             self.ss_eoi = self.es_eoi = None
 396             self.curr_eoi = None
 397
 398     def handle_atn_change(self, atn):
 399         # Track ATN line for parallel and serial input.
 400         self.curr_atn = atn
 401         if atn:
 402             self.flush_bytes_text_accu()
 403
 404     def handle_iec_periph(self, ss, es, addr, sec, data):
 405         # The annotation is optional.
 406         if self.options['iec_periph'] != 'yes':
 407             return
 408         # Void internal state.
 409         if addr is None and sec is None and data is None:
 410             self.last_iec_addr = None
 411             self.last_iec_sec = None
 412             return
 413         # Grab and evaluate new input.
 414         _iec_addr_names = {
 415             # TODO Add more items here. See the "Device numbering" section
 416             # of the https://en.wikipedia.org/wiki/Commodore_bus page.
 417             8: 'Disk 0',
 418             9: 'Disk 1',
 419         }
 420         _iec_disk_range = range(8, 16)
 421         if addr is not None:
 422             self.last_iec_addr = addr
 423             name = _iec_addr_names.get(addr, None)
 424             if name:
 425                 self.emit_data_ann(ss, es, ANN_IEC_PERIPH, [name])
 426         addr = self.last_iec_addr # Simplify subsequent logic.
 427         if sec is not None:
 428             # BEWARE! The secondary address is a full byte and includes
 429             # the 0x60 offset, to also work when the MSB was set.
 430             self.last_iec_sec = sec
 431             subcmd, channel = sec & 0xf0, sec & 0x0f
 432             channel_ord = ord('0') + channel
 433             if addr is not None and addr in _iec_disk_range:
 434                 subcmd_fmts = {
 435                     0x60: ['Reopen {ch:d}', 'Re {ch:d}', 'R{ch_ord:c}'],
 436                     0xe0: ['Close {ch:d}', 'Cl {ch:d}', 'C{ch_ord:c}'],
 437                     0xf0: ['Open {ch:d}', 'Op {ch:d}', 'O{ch_ord:c}'],
 438                 }.get(subcmd, None)
 439                 if subcmd_fmts:
 440                     texts = _format_ann_texts(subcmd_fmts, ch = channel, ch_ord = channel_ord)
 441                     self.emit_data_ann(ss, es, ANN_IEC_PERIPH, texts)
 442         sec = self.last_iec_sec # Simplify subsequent logic.
 443         if data is not None:
 444             if addr is None or sec is None:
 445                 return
 446             # TODO Process data depending on peripheral type and channel?
 447
 448     def handle_data_byte(self):
 449         b = self.curr_raw
 450         texts = _get_raw_text(b, self.curr_atn)
 451         self.emit_data_ann(self.ss_raw, self.es_raw, ANN_RAW_BYTE, texts)
 452         self.emit_bin_ann(self.ss_raw, self.es_raw, BIN_RAW, b.to_bytes(1, byteorder='big'))
 453         self.putpy(self.ss_raw, self.es_raw, 'GPIB_RAW', None, _get_raw_byte(b, self.curr_atn))
 454         if self.curr_atn:
 455             ann_cls = None
 456             upd_iec = False,
 457             py_type = None
 458             py_peers = False
 459             is_cmd, is_unl, is_unt = _is_command(b)
 460             laddr = _is_listen_addr(b)
 461             taddr = _is_talk_addr(b)
 462             saddr = _is_secondary_addr(b)
 463             msb = _is_msb_set(b)
 464             if is_cmd:
 465                 known, texts = _get_command_texts(b)
 466                 if not known:
 467                     warn_texts = ['Unknown GPIB command', 'unknown', 'UNK']
 468                     self.emit_warn_ann(self.ss_raw, self.es_raw, warn_texts)
 469                 ann_cls = ANN_CMD
 470                 py_type, py_addr = 'COMMAND', None
 471                 if is_unl:
 472                     self.last_listener = []
 473                     py_peers = True
 474                 if is_unt:
 475                     self.last_talker = None
 476                     py_peers = True
 477                 if is_unl or is_unt:
 478                     upd_iec = True, None, None, None
 479             elif laddr is not None:
 480                 addr = laddr
 481                 texts = _get_address_texts(b)
 482                 ann_cls = ANN_LADDR
 483                 py_type, py_addr = 'LISTEN', addr
 484                 if addr == self.last_talker:
 485                     self.last_talker = None
 486                 self.last_listener.append(addr)
 487                 upd_iec = True, addr, None, None
 488                 py_peers = True
 489             elif taddr is not None:
 490                 addr = taddr
 491                 texts = _get_address_texts(b)
 492                 ann_cls = ANN_TADDR
 493                 py_type, py_addr = 'TALK', addr
 494                 if addr in self.last_listener:
 495                     self.last_listener.remove(addr)
 496                 self.last_talker = addr
 497                 upd_iec = True, addr, None, None
 498                 py_peers = True
 499             elif saddr is not None:
 500                 addr = saddr
 501                 texts = _get_address_texts(b)
 502                 ann_cls = ANN_SADDR
 503                 upd_iec = True, None, b, None
 504                 py_type, py_addr = 'SECONDARY', addr
 505             elif msb is not None:
 506                 # These are not really "secondary addresses", but they
 507                 # are used by the Commodore IEC bus (floppy channels).
 508                 texts = _get_address_texts(b)
 509                 ann_cls = ANN_SADDR
 510                 upd_iec = True, None, b, None
 511                 py_type, py_addr = 'MSB_SET', b
 512             if ann_cls is not None and texts is not None:
 513                 self.emit_data_ann(self.ss_raw, self.es_raw, ann_cls, texts)
 514             if upd_iec[0]:
 515                 self.handle_iec_periph(self.ss_raw, self.es_raw, upd_iec[1], upd_iec[2], upd_iec[3])
 516             if py_type:
 517                 self.putpy(self.ss_raw, self.es_raw, py_type, py_addr, b)
 518             if py_peers:
 519                 self.last_listener.sort()
 520                 self.putpy(self.ss_raw, self.es_raw, 'TALK_LISTEN', self.last_talker, self.last_listener)
 521         else:
 522             self.accu_bytes.append(b)
 523             text = _get_data_text(b)
 524             if not self.accu_text:
 525                 self.ss_text = self.ss_raw
 526             self.accu_text.append(text)
 527             self.es_text = self.es_raw
 528             self.emit_data_ann(self.ss_raw, self.es_raw, ANN_DATA, [text])
 529             self.handle_iec_periph(self.ss_raw, self.es_raw, None, None, b)
 530             self.putpy(self.ss_raw, self.es_raw, 'DATA_BYTE', self.last_talker, b)
 531
 532     def handle_dav_change(self, dav, data):
 533         if dav:
 534             # Data availability starts when the flag goes active.
 535             self.ss_raw = self.samplenum
 536             self.curr_raw = bitpack(data)
 537             self.latch_atn = self.curr_atn
 538             self.latch_eoi = self.curr_eoi
 539             return
 540         # Data availability ends when the flag goes inactive. Handle the
 541         # previously captured data byte according to associated flags.
 542         self.es_raw = self.samplenum
 543         self.handle_data_byte()
 544         self.ss_raw = self.es_raw = None
 545         self.curr_raw = None
 546
 547     def inject_dav_phase(self, ss, es, data):
 548         # Inspection of serial input has resulted in one raw byte which
 549         # spans a given period of time. Pretend we had seen a DAV active
 550         # phase, to re-use code for the parallel transmission.
 551         self.ss_raw = ss
 552         self.curr_raw = bitpack(data)
 553         self.latch_atn = self.curr_atn
 554         self.latch_eoi = self.curr_eoi
 555         self.es_raw = es
 556         self.handle_data_byte()
 557         self.ss_raw = self.es_raw = None
 558         self.curr_raw = None
 559
 560     def invert_pins(self, pins):
 561         # All lines (including data bits!) are low active and thus need
 562         # to get inverted to receive their logical state (high active,
 563         # regular data bit values). Cope with inputs being optional.
 564         return [1 - p if p in (0, 1) else p for p in pins]
 565
 566     def decode_serial(self, has_clk, has_data_1, has_atn, has_srq):
 567         if not has_clk or not has_data_1 or not has_atn:
 568             raise ChannelError('IEC bus needs at least ATN and serial CLK and DATA.')
 569
 570         # This is a rephrased version of decoders/iec/pd.py:decode().
 571         # SRQ was not used there either. Magic numbers were eliminated.
 572         (
 573             STEP_WAIT_READY_TO_SEND,
 574             STEP_WAIT_READY_FOR_DATA,
 575             STEP_PREP_DATA_TEST_EOI,
 576             STEP_CLOCK_DATA_BITS,
 577         ) = range(4)
 578         step_wait_conds = (
 579             [{PIN_ATN: 'f'}, {PIN_DATA: 'l', PIN_CLK: 'h'}],
 580             [{PIN_ATN: 'f'}, {PIN_DATA: 'h', PIN_CLK: 'h'}, {PIN_CLK: 'l'}],
 581             [{PIN_ATN: 'f'}, {PIN_DATA: 'f'}, {PIN_CLK: 'l'}],
 582             [{PIN_ATN: 'f'}, {PIN_CLK: 'e'}],
 583         )
 584         step = STEP_WAIT_READY_TO_SEND
 585         bits = []
 586
 587         while True:
 588
 589             # Sample input pin values. Keep DATA/CLK in verbatim form to
 590             # re-use 'iec' decoder logic. Turn ATN to positive logic for
 591             # easier processing. The data bits get handled during byte
 592             # accumulation.
 593             pins = self.wait(step_wait_conds[step])
 594             data, clk = pins[PIN_DATA], pins[PIN_CLK]
 595             atn, = self.invert_pins([pins[PIN_ATN]])
 596
 597             if self.matched[0]:
 598                 # Falling edge on ATN, reset step.
 599                 step = STEP_WAIT_READY_TO_SEND
 600
 601             if step == STEP_WAIT_READY_TO_SEND:
 602                 # Don't use self.matched[1] here since we might come from
 603                 # a step with different conds due to the code above.
 604                 if data == 0 and clk == 1:
 605                     # Rising edge on CLK while DATA is low: Ready to send.
 606                     step = STEP_WAIT_READY_FOR_DATA
 607             elif step == STEP_WAIT_READY_FOR_DATA:
 608                 if data == 1 and clk == 1:
 609                     # Rising edge on DATA while CLK is high: Ready for data.
 610                     ss_byte = self.samplenum
 611                     self.handle_atn_change(atn)
 612                     if self.curr_eoi:
 613                         self.handle_eoi_change(False)
 614                     bits = []
 615                     step = STEP_PREP_DATA_TEST_EOI
 616                 elif clk == 0:
 617                     # CLK low again, transfer aborted.
 618                     step = STEP_WAIT_READY_TO_SEND
 619             elif step == STEP_PREP_DATA_TEST_EOI:
 620                 if data == 0 and clk == 1:
 621                     # DATA goes low while CLK is still high, EOI confirmed.
 622                     self.handle_eoi_change(True)
 623                 elif clk == 0:
 624                     step = STEP_CLOCK_DATA_BITS
 625                     ss_bit = self.samplenum
 626             elif step == STEP_CLOCK_DATA_BITS:
 627                 if self.matched[1]:
 628                     if clk == 1:
 629                         # Rising edge on CLK; latch DATA.
 630                         bits.append(data)
 631                     elif clk == 0:
 632                         # Falling edge on CLK; end of bit.
 633                         es_bit = self.samplenum
 634                         self.emit_data_ann(ss_bit, es_bit, ANN_RAW_BIT, ['{:d}'.format(bits[-1])])
 635                         self.putpy(ss_bit, es_bit, 'IEC_BIT', None, bits[-1])
 636                         ss_bit = self.samplenum
 637                         if len(bits) == 8:
 638                             es_byte = self.samplenum
 639                             self.inject_dav_phase(ss_byte, es_byte, bits)
 640                             if self.curr_eoi:
 641                                 self.handle_eoi_change(False)
 642                             step = STEP_WAIT_READY_TO_SEND
 643
 644     def decode_parallel(self, has_data_n, has_dav, has_atn, has_eoi, has_srq):
 645
 646         if False in has_data_n or not has_dav or not has_atn:
 647             raise ChannelError('IEEE-488 needs at least ATN and DAV and eight DIO lines.')
 648         has_ifc = self.has_channel(PIN_IFC)
 649
 650         # Capture data lines at the falling edge of DAV, process their
 651         # values at rising DAV edge (when data validity ends). Also make
 652         # sure to start inspection when the capture happens to start with
 653         # low signal levels, i.e. won't include the initial falling edge.
 654         # Scan for ATN/EOI edges as well (including the trick which works
 655         # around initial pin state).
 656         # Map low-active physical transport lines to positive logic here,
 657         # to simplify logical inspection/decoding of communicated data,
 658         # and to avoid redundancy and inconsistency in later code paths.
 659         waitcond = []
 660         idx_dav = len(waitcond)
 661         waitcond.append({PIN_DAV: 'l'})
 662         idx_atn = len(waitcond)
 663         waitcond.append({PIN_ATN: 'l'})
 664         idx_eoi = None
 665         if has_eoi:
 666             idx_eoi = len(waitcond)
 667             waitcond.append({PIN_EOI: 'l'})
 668         idx_ifc = None
 669         if has_ifc:
 670             idx_ifc = len(waitcond)
 671             waitcond.append({PIN_IFC: 'l'})
 672         while True:
 673             pins = self.wait(waitcond)
 674             pins = self.invert_pins(pins)
 675
 676             # BEWARE! Order of evaluation does matter. For low samplerate
 677             # captures, many edges fall onto the same sample number. So
 678             # we process active edges of flags early (before processing
 679             # data bits), and inactive edges late (after data got processed).
 680             if idx_ifc is not None and self.matched[idx_ifc] and pins[PIN_IFC] == 1:
 681                 self.handle_ifc_change(pins[PIN_IFC])
 682             if idx_eoi is not None and self.matched[idx_eoi] and pins[PIN_EOI] == 1:
 683                 self.handle_eoi_change(pins[PIN_EOI])
 684             if self.matched[idx_atn] and pins[PIN_ATN] == 1:
 685                 self.handle_atn_change(pins[PIN_ATN])
 686             if self.matched[idx_dav]:
 687                 self.handle_dav_change(pins[PIN_DAV], pins[PIN_DIO1:PIN_DIO8 + 1])
 688             if self.matched[idx_atn] and pins[PIN_ATN] == 0:
 689                 self.handle_atn_change(pins[PIN_ATN])
 690             if idx_eoi is not None and self.matched[idx_eoi] and pins[PIN_EOI] == 0:
 691                 self.handle_eoi_change(pins[PIN_EOI])
 692             if idx_ifc is not None and self.matched[idx_ifc] and pins[PIN_IFC] == 0:
 693                 self.handle_ifc_change(pins[PIN_IFC])
 694
 695             waitcond[idx_dav][PIN_DAV] = 'e'
 696             waitcond[idx_atn][PIN_ATN] = 'e'
 697             if has_eoi:
 698                 waitcond[idx_eoi][PIN_EOI] = 'e'
 699             if has_ifc:
 700                 waitcond[idx_ifc][PIN_IFC] = 'e'
 701
 702     def decode(self):
 703         # The decoder's boilerplate declares some of the input signals as
 704         # optional, but only to support both serial and parallel variants.
 705         # The CLK signal discriminates the two. For either variant some
 706         # of the "optional" signals are not really optional for proper
 707         # operation of the decoder. Check these conditions here.
 708         has_clk = self.has_channel(PIN_CLK)
 709         has_data_1 = self.has_channel(PIN_DIO1)
 710         has_data_n = [bool(self.has_channel(pin) for pin in range(PIN_DIO1, PIN_DIO8 + 1))]
 711         has_dav = self.has_channel(PIN_DAV)
 712         has_atn = self.has_channel(PIN_ATN)
 713         has_eoi = self.has_channel(PIN_EOI)
 714         has_srq = self.has_channel(PIN_SRQ)
 715         if has_clk:
 716             self.decode_serial(has_clk, has_data_1, has_atn, has_srq)
 717         else:
 718             self.decode_parallel(has_data_n, has_dav, has_atn, has_eoi, has_srq)