mirror of
https://github.com/lowobservable/coax.git
synced 2026-01-27 20:57:26 +00:00
304 lines
8.9 KiB
Python
304 lines
8.9 KiB
Python
"""
|
|
coax.protocol
|
|
~~~~~~~~~~~~~
|
|
"""
|
|
|
|
from enum import Enum
|
|
|
|
from .exceptions import ProtocolError
|
|
from .parity import odd_parity
|
|
|
|
class Command(Enum):
|
|
"""Terminal command."""
|
|
|
|
# Read Commands
|
|
POLL = 0x01
|
|
POLL_ACK = 0x11
|
|
READ_STATUS = 0x0d
|
|
READ_TERMINAL_ID = 0x09
|
|
READ_EXTENDED_ID = 0x07
|
|
READ_ADDRESS_COUNTER_HI = 0x05
|
|
READ_ADDRESS_COUNTER_LO = 0x15
|
|
READ_DATA = 0x03
|
|
READ_MULTIPLE = 0x0b
|
|
|
|
# Write Commands
|
|
RESET = 0x02
|
|
LOAD_CONTROL_REGISTER = 0x0a
|
|
LOAD_SECONDARY_CONTROL = 0x1a
|
|
LOAD_MASK = 0x16
|
|
LOAD_ADDRESS_COUNTER_HI = 0x04
|
|
LOAD_ADDRESS_COUNTER_LO = 0x14
|
|
WRITE_DATA = 0x0c
|
|
CLEAR = 0x06
|
|
SEARCH_FORWARD = 0x10
|
|
SEARCH_BACKWARD = 0x12
|
|
INSERT_BYTE = 0x0e
|
|
START_OPERATION = 0x08
|
|
DIAGNOSTIC_RESET = 0x1c
|
|
|
|
class PollResponse:
|
|
"""Terminal POLL response."""
|
|
|
|
@staticmethod
|
|
def is_power_on_reset_complete(value):
|
|
"""Is the response word a power on reset complete response?"""
|
|
return value == 0xa
|
|
|
|
@staticmethod
|
|
def is_keystroke(value):
|
|
"""Is the response word a keystroke response?"""
|
|
return ((value & 0x2) == 0x2) and ((value & 0x1) == 0)
|
|
|
|
def __init__(self, value):
|
|
self.value = value
|
|
|
|
class PowerOnResetCompletePollResponse(PollResponse):
|
|
"""Terminal power-on-reset complete poll response."""
|
|
|
|
def __init__(self, value):
|
|
if not PollResponse.is_power_on_reset_complete(value):
|
|
raise ValueError('Invalid POR poll response')
|
|
|
|
super().__init__(value)
|
|
|
|
class KeystrokePollResponse(PollResponse):
|
|
"""Terminal keystroke poll response."""
|
|
|
|
def __init__(self, value):
|
|
if not PollResponse.is_keystroke(value):
|
|
raise ValueError('Invalid keystroke poll response')
|
|
|
|
super().__init__(value)
|
|
|
|
self.scan_code = (value >> 2) & 0xff
|
|
|
|
class Status:
|
|
"""Terminal status."""
|
|
|
|
def __init__(self, value):
|
|
self.value = value
|
|
|
|
self.monocase = bool(value & 0x80)
|
|
self.busy = not bool(value & 0x20)
|
|
self.feature_error = bool(value & 0x04)
|
|
self.operation_complete = bool(value & 0x02)
|
|
|
|
def __repr__(self):
|
|
return (f'<Status monocase={self.monocase}, busy={self.busy}, '
|
|
f'feature_error={self.feature_error}, '
|
|
f'operation_complete={self.operation_complete}>')
|
|
|
|
class TerminalId:
|
|
"""Terminal model and keyboard."""
|
|
|
|
_MODEL_MAP = {
|
|
0b010: 2,
|
|
0b011: 3,
|
|
0b111: 4,
|
|
0b110: 5
|
|
}
|
|
|
|
def __init__(self, value):
|
|
if (value & 0x1) != 0:
|
|
raise ValueError('Invalid terminal identifier')
|
|
|
|
self.value = value
|
|
|
|
model = (value & 0x0e) >> 1
|
|
|
|
if model not in TerminalId._MODEL_MAP:
|
|
raise ValueError('Invalid model')
|
|
|
|
self.model = TerminalId._MODEL_MAP[model]
|
|
self.keyboard = (value & 0xf0) >> 4
|
|
|
|
def __repr__(self):
|
|
return f'<TerminalId model={self.model}, keyboard={self.keyboard}>'
|
|
|
|
def poll(interface, **kwargs):
|
|
"""Execute a POLL command."""
|
|
command_word = _pack_command_word(Command.POLL)
|
|
|
|
response = _execute_read_command(interface, command_word, allow_trta_response=True,
|
|
unpack_data_words=False, **kwargs)
|
|
|
|
if response is None:
|
|
return None
|
|
|
|
word = response[0]
|
|
|
|
if PollResponse.is_power_on_reset_complete(word):
|
|
return PowerOnResetCompletePollResponse(word)
|
|
|
|
if PollResponse.is_keystroke(word):
|
|
return KeystrokePollResponse(word)
|
|
|
|
return PollResponse(word)
|
|
|
|
def poll_ack(interface, **kwargs):
|
|
"""Execute a POLL_ACK command."""
|
|
command_word = _pack_command_word(Command.POLL_ACK)
|
|
|
|
_execute_write_command(interface, command_word, **kwargs)
|
|
|
|
def read_status(interface, **kwargs):
|
|
"""Execute a READ_STATUS command."""
|
|
command_word = _pack_command_word(Command.READ_STATUS)
|
|
|
|
response = _execute_read_command(interface, command_word, **kwargs)
|
|
|
|
return Status(response[0])
|
|
|
|
def read_terminal_id(interface, **kwargs):
|
|
"""Execute a READ_TERMINAL_ID command."""
|
|
command_word = _pack_command_word(Command.READ_TERMINAL_ID)
|
|
|
|
response = _execute_read_command(interface, command_word, **kwargs)
|
|
|
|
return TerminalId(response[0])
|
|
|
|
def read_extended_id(interface, **kwargs):
|
|
"""Execute a READ_EXTENDED_ID command."""
|
|
command_word = _pack_command_word(Command.READ_EXTENDED_ID)
|
|
|
|
return _execute_read_command(interface, command_word, 4, allow_trta_response=True,
|
|
**kwargs)
|
|
|
|
def read_address_counter_hi(interface, **kwargs):
|
|
"""Execute a READ_ADDRESS_COUNTER_HI command."""
|
|
command_word = _pack_command_word(Command.READ_ADDRESS_COUNTER_HI)
|
|
|
|
return _execute_read_command(interface, command_word, **kwargs)[0]
|
|
|
|
def read_address_counter_lo(interface, **kwargs):
|
|
"""Execute a READ_ADDRESS_COUTER_LO command."""
|
|
command_word = _pack_command_word(Command.READ_ADDRESS_COUNTER_LO)
|
|
|
|
return _execute_read_command(interface, command_word, **kwargs)[0]
|
|
|
|
def read_data(interface):
|
|
"""Execute a READ_DATA command."""
|
|
raise NotImplementedError
|
|
|
|
def read_multiple(interface):
|
|
"""Execute a READ_MULTIPLE command."""
|
|
raise NotImplementedError
|
|
|
|
def reset(interface):
|
|
"""Execute a RESET command."""
|
|
raise NotImplementedError
|
|
|
|
def load_control_register(interface):
|
|
"""Execute a LOAD_CONTROL_REGISTER command."""
|
|
raise NotImplementedError
|
|
|
|
def load_secondary_control(interface):
|
|
"""Execute a LOAD_SECONDARY_CONTROL command."""
|
|
raise NotImplementedError
|
|
|
|
def load_mask(interface):
|
|
"""Execute a LOAD_MASK command."""
|
|
raise NotImplementedError
|
|
|
|
def load_address_counter_hi(interface, address, **kwargs):
|
|
"""Execute a LOAD_ADDRESS_COUNTER_HI command."""
|
|
command_word = _pack_command_word(Command.LOAD_ADDRESS_COUNTER_HI)
|
|
|
|
_execute_write_command(interface, command_word, bytes([address]), **kwargs)
|
|
|
|
def load_address_counter_lo(interface, address, **kwargs):
|
|
"""Execute a LOAD_ADDRESS_COUNTER_LO command."""
|
|
command_word = _pack_command_word(Command.LOAD_ADDRESS_COUNTER_LO)
|
|
|
|
_execute_write_command(interface, command_word, bytes([address]), **kwargs)
|
|
|
|
def write_data(interface, data, **kwargs):
|
|
"""Execute a WRITE_DATA command."""
|
|
command_word = _pack_command_word(Command.WRITE_DATA)
|
|
|
|
_execute_write_command(interface, command_word, data, **kwargs)
|
|
|
|
def clear(interface):
|
|
"""Execute a CLEAR command."""
|
|
raise NotImplementedError
|
|
|
|
def search_forward(interface):
|
|
"""Execute a SEARCH_FORWARD command."""
|
|
raise NotImplementedError
|
|
|
|
def search_backward(interface):
|
|
"""Execute a SEARCH_BACKWARD command."""
|
|
raise NotImplementedError
|
|
|
|
def insert_byte(interface):
|
|
"""Execute a INSERT_BYTE command."""
|
|
raise NotImplementedError
|
|
|
|
def start_operation(interface):
|
|
"""Execute a START_OPERATION command."""
|
|
raise NotImplementedError
|
|
|
|
def diagnostic_reset(interface):
|
|
"""Execute a DIAGNOSTIC_RESET command."""
|
|
raise NotImplementedError
|
|
|
|
def _execute_read_command(interface, command_word, response_length=1,
|
|
allow_trta_response=False, trta_value=None,
|
|
unpack_data_words=True, **kwargs):
|
|
"""Execute a standard read command."""
|
|
response = interface.execute(command_word, response_length=response_length, **kwargs)
|
|
|
|
if allow_trta_response and len(response) == 1 and response[0] == 0:
|
|
return trta_value
|
|
|
|
if len(response) != response_length:
|
|
(_, command) = _unpack_command_word(command_word)
|
|
|
|
raise ProtocolError(f'Expected {response_length} word {command.name} response')
|
|
|
|
return _unpack_data_words(response) if unpack_data_words else response
|
|
|
|
def _execute_write_command(interface, command_word, data=None, **kwargs):
|
|
"""Execute a standard write command."""
|
|
response = interface.execute(command_word, data, **kwargs)
|
|
|
|
if len(response) != 1:
|
|
(_, command) = _unpack_command_word(command_word)
|
|
|
|
raise ProtocolError(f'Expected 1 word {command.name} response')
|
|
|
|
if response[0] != 0:
|
|
raise ProtocolError('Expected TR/TA response')
|
|
|
|
def _pack_command_word(command, address=0):
|
|
"""Pack a command and address into a 10-bit command word."""
|
|
return (address << 7) | (command.value << 2) | 0x1
|
|
|
|
def _unpack_command_word(word):
|
|
"""Unpack a 10-bit command word."""
|
|
if (word & 0x1) != 1:
|
|
raise ProtocolError('Word does not have command bit set')
|
|
|
|
address = (word >> 7) & 0x7
|
|
command = (word >> 2) & 0x1f
|
|
|
|
return (address, Command(command))
|
|
|
|
def _unpack_data_words(words, check_parity=False):
|
|
"""Unpack the data bytes from 10-bit data words."""
|
|
return bytes([_unpack_data_word(word, check_parity=check_parity) for word in words])
|
|
|
|
def _unpack_data_word(word, check_parity=False):
|
|
"""Unpack the data byte from a 10-bit data word."""
|
|
if (word & 0x1) != 0:
|
|
raise ProtocolError('Word does not have data bit set')
|
|
|
|
byte = (word >> 2) & 0xff
|
|
parity = (word >> 1) & 0x1
|
|
|
|
if check_parity and parity != odd_parity(byte):
|
|
raise ProtocolError('Parity error')
|
|
|
|
return byte
|