cosmetic: switch to consistent four-spaces indent (using autopep8)

This commit is contained in:
Vadim Yanitskiy 2022-03-27 22:09:38 +03:00 committed by Vadim Yanitskiy
parent 79c2124e0c
commit 45788b2783
3 changed files with 257 additions and 256 deletions

77
peer.py
View File

@ -22,53 +22,54 @@ from typing import Any
from construct import Container, Int16ul from construct import Container, Int16ul
from proto import DbgMuxFrame from proto import DbgMuxFrame
class DbgMuxPeer: class DbgMuxPeer:
def __init__(self, sl): def __init__(self, sl):
self.tx_count: int = 0 self.tx_count: int = 0
self.rx_count: int = 0 self.rx_count: int = 0
self._sl = sl self._sl = sl
def send(self, msg_type: DbgMuxFrame.MsgType, msg: Any = b'') -> None: def send(self, msg_type: DbgMuxFrame.MsgType, msg: Any = b'') -> None:
# Encode the inner message first # Encode the inner message first
msg_data = DbgMuxFrame.Msg.build(msg, MsgType=msg_type) msg_data = DbgMuxFrame.Msg.build(msg, MsgType=msg_type)
c = Container({ c = Container({
'TxCount' : (self.tx_count + 1) % 256, 'TxCount': (self.tx_count + 1) % 256,
'RxCount' : self.rx_count % 256, 'RxCount': self.rx_count % 256,
'MsgType' : msg_type, 'MsgType': msg_type,
'MsgData' : msg_data, 'MsgData': msg_data,
'FCS' : 0 # Calculated below 'FCS': 0 # Calculated below
}) })
# ACK is a bit special # ACK is a bit special
if msg_type == DbgMuxFrame.MsgType.Ack: if msg_type == DbgMuxFrame.MsgType.Ack:
c['TxCount'] = 0xf1 c['TxCount'] = 0xf1
# There is a Checksum construct, but it requires all checksummed fields # There is a Checksum construct, but it requires all checksummed fields
# to be wrapped into an additional RawCopy construct. This is ugly and # to be wrapped into an additional RawCopy construct. This is ugly and
# inconvinient from the API point of view, so we calculate the FCS manually: # inconvinient from the API point of view, so we calculate the FCS manually:
frame = DbgMuxFrame.Frame.build(c)[:-2] # strip b'\x00\x00' frame = DbgMuxFrame.Frame.build(c)[:-2] # strip b'\x00\x00'
c['FCS'] = DbgMuxFrame.fcs_func(frame) c['FCS'] = DbgMuxFrame.fcs_func(frame)
log.debug('Tx frame (Ns=%d, Nr=%d, fcs=0x%04x) %s %s', log.debug('Tx frame (Ns=%d, Nr=%d, fcs=0x%04x) %s %s',
c['TxCount'], c['RxCount'], c['FCS'], c['TxCount'], c['RxCount'], c['FCS'],
c['MsgType'], c['MsgData'].hex()) c['MsgType'], c['MsgData'].hex())
self._sl.write(frame + Int16ul.build(c['FCS'])) self._sl.write(frame + Int16ul.build(c['FCS']))
# ACK is not getting accounted # ACK is not getting accounted
if msg_type != DbgMuxFrame.MsgType.Ack: if msg_type != DbgMuxFrame.MsgType.Ack:
self.tx_count += 1 self.tx_count += 1
def recv(self) -> Container: def recv(self) -> Container:
c = DbgMuxFrame.Frame.parse_stream(self._sl) c = DbgMuxFrame.Frame.parse_stream(self._sl)
log.debug('Rx frame (Ns=%d, Nr=%d, fcs=0x%04x) %s %s', log.debug('Rx frame (Ns=%d, Nr=%d, fcs=0x%04x) %s %s',
c['TxCount'], c['RxCount'], c['FCS'], c['TxCount'], c['RxCount'], c['FCS'],
c['MsgType'], c['MsgData'].hex()) c['MsgType'], c['MsgData'].hex())
# Parse the inner message # Parse the inner message
c['Msg'] = DbgMuxFrame.Msg.parse(c['MsgData'], MsgType=c['MsgType']) c['Msg'] = DbgMuxFrame.Msg.parse(c['MsgData'], MsgType=c['MsgType'])
self.rx_count += 1 self.rx_count += 1
return c return c

144
proto.py
View File

@ -20,86 +20,86 @@ from construct import *
import crcmod import crcmod
# DebugMux frame definition
class DbgMuxFrame: class DbgMuxFrame:
# Kudos to Stefan @Sec Zehl for finding the CRC function parameters ''' DebugMux frame definition '''
fcs_func = crcmod.mkCrcFun(0x11021, rev=True, initCrc=0x0, xorOut=0xffff)
MsgType = Enum(subcon=Int8ul, # Kudos to Stefan @Sec Zehl for finding the CRC function parameters
Enquiry = 0x65, # 'e' fcs_func = crcmod.mkCrcFun(0x11021, rev=True, initCrc=0x0, xorOut=0xffff)
Ident = 0x66, # 'f'
Ping = 0x67, # 'g'
Pong = 0x68, # 'h'
DPAnnounce = 0x69, # 'i' MsgType = Enum(subcon=Int8ul,
# TODO: = 0x6a, # 'j' Enquiry = 0x65, # 'e'
ConnEstablish = 0x6b, # 'k' Ident = 0x66, # 'f'
ConnEstablished = 0x6c, # 'l' Ping = 0x67, # 'g'
ConnTerminate = 0x6d, # 'm' Pong = 0x68, # 'h'
ConnTerminated = 0x6e, # 'n' DPAnnounce = 0x69, # 'i'
ConnData = 0x6f, # 'o' # TODO: = 0x6a, # 'j'
ConnEstablish = 0x6b, # 'k'
ConnEstablished = 0x6c, # 'l'
ConnTerminate = 0x6d, # 'm'
ConnTerminated = 0x6e, # 'n'
ConnData = 0x6f, # 'o'
# TODO: = 0x70, # 'p'
Ack = 0x71, # 'q'
)
# TODO: = 0x70, # 'p' Frame = Struct(
Ack = 0x71, # 'q' 'Magic' / Const(b'\x42\x42'),
) 'Length' / Rebuild(Int16ul, lambda ctx: len(ctx.MsgData) + 5),
'TxCount' / Int8ul,
'RxCount' / Int8ul,
'MsgType' / MsgType,
'MsgData' / Bytes(lambda ctx: ctx.Length - 5),
'FCS' / Int16ul, # fcs_func() on all preceeding fields
)
Frame = Struct( # MsgType.Ident structure
'Magic' / Const(b'\x42\x42'), MsgIdent = Struct(
'Length' / Rebuild(Int16ul, lambda ctx: len(ctx.MsgData) + 5), 'Magic' / Bytes(4), # TODO
'TxCount' / Int8ul, 'Ident' / PascalString(Int8ul, 'ascii'),
'RxCount' / Int8ul, )
'MsgType' / MsgType,
'MsgData' / Bytes(lambda ctx: ctx.Length - 5),
'FCS' / Int16ul, # fcs_func() on all preceeding fields
)
# MsgType.Ident structure # MsgType.{Ping,Pong} structure
MsgIdent = Struct( MsgPingPong = PascalString(Int8ul, 'ascii')
'Magic' / Bytes(4), # TODO
'Ident' / PascalString(Int8ul, 'ascii'),
)
# MsgType.{Ping,Pong} structure # MsgType.DPAnnounce structure
MsgPingPong = PascalString(Int8ul, 'ascii') MsgDPAnnounce = Struct(
'DPRef' / Int16ul,
'Name' / PascalString(Int8ul, 'ascii'),
)
# MsgType.DPAnnounce structure # MsgType.ConnEstablish[ed] structure
MsgDPAnnounce = Struct( MsgConnEstablish = Struct('DPRef' / Int16ul)
'DPRef' / Int16ul, MsgConnEstablished = Struct(
'Name' / PascalString(Int8ul, 'ascii'), 'DPRef' / Int16ul,
) 'ConnRef' / Int16ul,
'DataBlockLimit' / Int16ul,
)
# MsgType.ConnEstablish[ed] structure # MsgType.ConnTerminate[ed] structure
MsgConnEstablish = Struct('DPRef' / Int16ul) MsgConnTerminate = Struct('ConnRef' / Int16ul)
MsgConnEstablished = Struct( MsgConnTerminated = Struct(
'DPRef' / Int16ul, 'DPRef' / Int16ul,
'ConnRef' / Int16ul, 'ConnRef' / Int16ul,
'DataBlockLimit' / Int16ul, )
)
# MsgType.ConnTerminate[ed] structure # MsgType.ConnData structure
MsgConnTerminate = Struct('ConnRef' / Int16ul) MsgConnData = Struct(
MsgConnTerminated = Struct( 'ConnRef' / Int16ul,
'DPRef' / Int16ul, 'Data' / GreedyBytes,
'ConnRef' / Int16ul, )
)
# MsgType.ConnData structure # Complete message definition
MsgConnData = Struct( Msg = Switch(this.MsgType, default=GreedyBytes, cases={
'ConnRef' / Int16ul, MsgType.Enquiry : Const(b''),
'Data' / GreedyBytes, MsgType.Ident : MsgIdent,
) MsgType.Ping : MsgPingPong,
MsgType.Pong : MsgPingPong,
# Complete message definition MsgType.DPAnnounce : MsgDPAnnounce,
Msg = Switch(this.MsgType, default=GreedyBytes, cases={ MsgType.ConnEstablish : MsgConnEstablish,
MsgType.Enquiry : Const(b''), MsgType.ConnEstablished : MsgConnEstablished,
MsgType.Ident : MsgIdent, MsgType.ConnTerminate : MsgConnTerminate,
MsgType.Ping : MsgPingPong, MsgType.ConnTerminated : MsgConnTerminated,
MsgType.Pong : MsgPingPong, MsgType.ConnData : MsgConnData,
MsgType.DPAnnounce : MsgDPAnnounce, MsgType.Ack : Const(b''),
MsgType.ConnEstablish : MsgConnEstablish, })
MsgType.ConnEstablished : MsgConnEstablished,
MsgType.ConnTerminate : MsgConnTerminate,
MsgType.ConnTerminated : MsgConnTerminated,
MsgType.ConnData : MsgConnData,
MsgType.Ack : Const(b''),
})

View File

@ -28,187 +28,187 @@ import sys
from proto import DbgMuxFrame from proto import DbgMuxFrame
from peer import DbgMuxPeer from peer import DbgMuxPeer
class SEDbgMuxApp(cmd2.Cmd): class SEDbgMuxApp(cmd2.Cmd):
DESC = 'DebugMux client for [Sony] Ericsson phones and modems' DESC = 'DebugMux client for [Sony] Ericsson phones and modems'
# Command categories # Command categories
CATEGORY_CONN = 'Connection management commands' CATEGORY_CONN = 'Connection management commands'
CATEGORY_DBGMUX = 'DebugMux specific commands' CATEGORY_DBGMUX = 'DebugMux specific commands'
def __init__(self, argv): def __init__(self, argv):
super().__init__(allow_cli_args=False) super().__init__(allow_cli_args=False)
self.intro = cmd2.style('Welcome to %s!' % self.DESC, fg=cmd2.fg.red) self.intro = cmd2.style('Welcome to %s!' % self.DESC, fg=cmd2.fg.red)
self.prompt = 'DebugMux (\'%s\')> ' % argv.serial_port self.prompt = 'DebugMux (\'%s\')> ' % argv.serial_port
self.default_category = 'Built-in commands' self.default_category = 'Built-in commands'
self.argv = argv self.argv = argv
# Modem connection state # Modem connection state
self.set_connected(False) self.set_connected(False)
def set_connected(self, state: bool) -> None: def set_connected(self, state: bool) -> None:
self.connected: bool = state self.connected: bool = state
if self.connected: if self.connected:
self.enable_category(self.CATEGORY_DBGMUX) self.enable_category(self.CATEGORY_DBGMUX)
else: else:
msg = 'You must be connected to use this command' msg = 'You must be connected to use this command'
self.disable_category(self.CATEGORY_DBGMUX, msg) self.disable_category(self.CATEGORY_DBGMUX, msg)
@cmd2.with_category(CATEGORY_CONN) @cmd2.with_category(CATEGORY_CONN)
def do_connect(self, opts) -> None: def do_connect(self, opts) -> None:
''' Connect to the modem and switch it to DebugMux mode ''' ''' Connect to the modem and switch it to DebugMux mode '''
slp = { self.sl = serial.Serial(port=self.argv.serial_port,
'port' : self.argv.serial_port, baudrate=self.argv.serial_baudrate,
'baudrate' : self.argv.serial_baudrate, bytesize=8, parity='N', stopbits=1,
'bytesize' : 8, timeout=self.argv.serial_timeout,
'parity' : 'N', # xonoff=False,
'stopbits' : 1, rtscts=False,
'timeout' : self.argv.serial_timeout, dsrdtr=False)
# 'xonoff' : False,
'rtscts' : False,
'dsrdtr' : False,
}
self.sl = serial.Serial(**slp)
# Test the modem # Test the modem
self.transceive('AT', 'OK') self.transceive('AT', 'OK')
# Enable DebugMux mode # Enable DebugMux mode
self.transceive('AT*EDEBUGMUX', 'CONNECT') self.transceive('AT*EDEBUGMUX', 'CONNECT')
# Init DebugMux peer # Init DebugMux peer
self.peer = DbgMuxPeer(self.sl) self.peer = DbgMuxPeer(self.sl)
self.set_connected(True) self.set_connected(True)
@cmd2.with_category(CATEGORY_CONN) @cmd2.with_category(CATEGORY_CONN)
def do_disconnect(self, opts) -> None: def do_disconnect(self, opts) -> None:
''' Disconnect from the modem ''' ''' Disconnect from the modem '''
self.sl.close() self.sl.close()
self.sl = None self.sl = None
self.peer = None self.peer = None
self.set_connected(False) self.set_connected(False)
@cmd2.with_category(CATEGORY_CONN) @cmd2.with_category(CATEGORY_CONN)
def do_status(self, opts) -> None: def do_status(self, opts) -> None:
''' Print connection info and statistics ''' ''' Print connection info and statistics '''
if not self.connected: if not self.connected:
self.poutput('Not connected') self.poutput('Not connected')
return return
self.poutput('Connected to \'%s\'' % self.argv.serial_port) self.poutput('Connected to \'%s\'' % self.argv.serial_port)
self.poutput('Baudrate: %d' % self.argv.serial_baudrate) self.poutput('Baudrate: %d' % self.argv.serial_baudrate)
self.poutput('TxCount (Ns): %d' % self.peer.tx_count) self.poutput('TxCount (Ns): %d' % self.peer.tx_count)
self.poutput('RxCount (Nr): %d' % self.peer.rx_count) self.poutput('RxCount (Nr): %d' % self.peer.rx_count)
@cmd2.with_category(CATEGORY_DBGMUX) @cmd2.with_category(CATEGORY_DBGMUX)
def do_enquiry(self, opts) -> None: def do_enquiry(self, opts) -> None:
''' Enquiry target identifier and available Data Providers ''' ''' Enquiry target identifier and available Data Providers '''
self.peer.send(DbgMuxFrame.MsgType.Enquiry) self.peer.send(DbgMuxFrame.MsgType.Enquiry)
while True: while True:
f = self.peer.recv() f = self.peer.recv()
if f['MsgType'] == DbgMuxFrame.MsgType.Ident: if f['MsgType'] == DbgMuxFrame.MsgType.Ident:
log.info("Identified target: '%s', IMEI=%s", log.info("Identified target: '%s', IMEI=%s",
f['Msg']['Ident'][:-15], f['Msg']['Ident'][:-15],
f['Msg']['Ident'][-15:]) f['Msg']['Ident'][-15:])
elif f['MsgType'] == DbgMuxFrame.MsgType.DPAnnounce: elif f['MsgType'] == DbgMuxFrame.MsgType.DPAnnounce:
log.info("Data Provider available (DPRef=0x%04x): '%s'", log.info("Data Provider available (DPRef=0x%04x): '%s'",
f['Msg']['DPRef'], f['Msg']['Name']) f['Msg']['DPRef'], f['Msg']['Name'])
# No more data in the buffer # No more data in the buffer
if self.sl.in_waiting == 0: if self.sl.in_waiting == 0:
break break
# ACKnowledge reception of the info # ACKnowledge reception of the info
self.peer.send(DbgMuxFrame.MsgType.Ack) self.peer.send(DbgMuxFrame.MsgType.Ack)
ping_parser = cmd2.Cmd2ArgumentParser() ping_parser = cmd2.Cmd2ArgumentParser()
ping_parser.add_argument('-p', '--payload', ping_parser.add_argument('-p', '--payload',
type=str, default='Knock, knock!', type=str, default='Knock, knock!',
help='Ping payload') help='Ping payload')
@cmd2.with_argparser(ping_parser) @cmd2.with_argparser(ping_parser)
@cmd2.with_category(CATEGORY_DBGMUX) @cmd2.with_category(CATEGORY_DBGMUX)
def do_ping(self, opts) -> None: def do_ping(self, opts) -> None:
''' Send a Ping to the target, expect Pong ''' ''' Send a Ping to the target, expect Pong '''
log.info('Tx Ping with payload \'%s\'', opts.payload) log.info('Tx Ping with payload \'%s\'', opts.payload)
self.peer.send(DbgMuxFrame.MsgType.Ping, opts.payload) self.peer.send(DbgMuxFrame.MsgType.Ping, opts.payload)
f = self.peer.recv() f = self.peer.recv()
assert f['MsgType'] == DbgMuxFrame.MsgType.Pong assert f['MsgType'] == DbgMuxFrame.MsgType.Pong
log.info('Rx Pong with payload \'%s\'', f['Msg']) log.info('Rx Pong with payload \'%s\'', f['Msg'])
establish_parser = cmd2.Cmd2ArgumentParser() establish_parser = cmd2.Cmd2ArgumentParser()
establish_parser.add_argument('DPRef', establish_parser.add_argument('DPRef',
type=lambda v: int(v, 16), type=lambda v: int(v, 16),
help='DPRef of a Data Provider in hex') help='DPRef of a Data Provider in hex')
@cmd2.with_argparser(establish_parser) @cmd2.with_argparser(establish_parser)
@cmd2.with_category(CATEGORY_DBGMUX) @cmd2.with_category(CATEGORY_DBGMUX)
def do_establish(self, opts) -> None: def do_establish(self, opts) -> None:
''' Establish connection with a Data Provider ''' ''' Establish connection with a Data Provider '''
log.info("Establishing connection with DPRef=0x%04x", opts.DPRef) log.info("Establishing connection with DPRef=0x%04x", opts.DPRef)
self.peer.send(DbgMuxFrame.MsgType.ConnEstablish, dict(DPRef=opts.DPRef)) self.peer.send(DbgMuxFrame.MsgType.ConnEstablish,
dict(DPRef=opts.DPRef))
f = self.peer.recv() f = self.peer.recv()
assert f['MsgType'] == DbgMuxFrame.MsgType.ConnEstablished assert f['MsgType'] == DbgMuxFrame.MsgType.ConnEstablished
if f['Msg']['ConnRef'] == 0xffff: if f['Msg']['ConnRef'] == 0xffff:
log.warning("Connection failed: unknown DPRef=0x%04x?", opts.DPRef) log.warning("Connection failed: unknown DPRef=0x%04x?", opts.DPRef)
self.peer.send(DbgMuxFrame.MsgType.Ack) self.peer.send(DbgMuxFrame.MsgType.Ack)
return return
log.info("Connection established (ConnRef=0x%04x)", f['Msg']['ConnRef']) log.info("Connection established (ConnRef=0x%04x)",
f['Msg']['ConnRef'])
# Read the messages # Read the messages
while True: while True:
f = self.peer.recv() f = self.peer.recv()
if f['MsgType'] != DbgMuxFrame.MsgType.ConnData: if f['MsgType'] != DbgMuxFrame.MsgType.ConnData:
log.warning('Unexpected frame: %s', f) log.warning('Unexpected frame: %s', f)
self.peer.send(DbgMuxFrame.MsgType.Ack) self.peer.send(DbgMuxFrame.MsgType.Ack)
continue continue
try: # FIXME: there can be binary data try: # FIXME: there can be binary data
self.stdout.write(f['Msg']['Data'].decode()) self.stdout.write(f['Msg']['Data'].decode())
except: # ... ignore it for now except: # ... ignore it for now
continue continue
# ACKnowledge reception of a frame # ACKnowledge reception of a frame
self.peer.send(DbgMuxFrame.MsgType.Ack) self.peer.send(DbgMuxFrame.MsgType.Ack)
def send_data(self, data: bytes) -> None: def send_data(self, data: bytes) -> None:
log.debug("MODEM <- %s", str(data)) log.debug("MODEM <- %s", str(data))
self.sl.write(data) self.sl.write(data)
def send_at_cmd(self, cmd: str, handle_echo:bool = True) -> None: def send_at_cmd(self, cmd: str, handle_echo: bool = True) -> None:
self.send_data(cmd.encode() + b'\r') self.send_data(cmd.encode() + b'\r')
if handle_echo: if handle_echo:
self.sl.readline() self.sl.readline()
def read_at_rsp(self) -> str: def read_at_rsp(self) -> str:
rsp = self.sl.readline() rsp = self.sl.readline()
log.debug("MODEM -> %s", str(rsp)) log.debug("MODEM -> %s", str(rsp))
return rsp.rstrip().decode() return rsp.rstrip().decode()
def transceive(self, cmd: str, exp: str) -> None: def transceive(self, cmd: str, exp: str) -> None:
while True: while True:
self.send_at_cmd(cmd) self.send_at_cmd(cmd)
rsp = self.read_at_rsp() rsp = self.read_at_rsp()
if rsp[:7] == '*EMRDY:':
continue
assert rsp == exp
break
if rsp[:7] == '*EMRDY:':
continue
assert rsp == exp
break
ap = argparse.ArgumentParser(prog='sedbgmux', description=SEDbgMuxApp.DESC, ap = argparse.ArgumentParser(prog='sedbgmux', description=SEDbgMuxApp.DESC,
formatter_class=argparse.ArgumentDefaultsHelpFormatter) formatter_class=argparse.ArgumentDefaultsHelpFormatter)
group = ap.add_argument_group('Connection parameters') group = ap.add_argument_group('Connection parameters')
group.add_argument('-p', '--serial-port', metavar='PORT', type=str, default='/dev/ttyACM0', group.add_argument('-p', '--serial-port', metavar='PORT', type=str, default='/dev/ttyACM0',
help='Serial port path (default %(default)s)') help='Serial port path (default %(default)s)')
group.add_argument('--serial-baudrate', metavar='BAUDRATE', type=int, default=115200, group.add_argument('--serial-baudrate', metavar='BAUDRATE', type=int, default=115200,
help='Serial port speed (default %(default)s)') help='Serial port speed (default %(default)s)')
group.add_argument('--serial-timeout', metavar='TIMEOUT', type=int, group.add_argument('--serial-timeout', metavar='TIMEOUT', type=int,
help='Serial port timeout') help='Serial port timeout')
log.basicConfig(format='[%(levelname)s] %(filename)s:%(lineno)d %(message)s', level=log.INFO) log.basicConfig(
format='[%(levelname)s] %(filename)s:%(lineno)d %(message)s', level=log.INFO)
if __name__ == '__main__': if __name__ == '__main__':
argv = ap.parse_args() argv = ap.parse_args()
app = SEDbgMuxApp(argv) app = SEDbgMuxApp(argv)
sys.exit(app.cmdloop()) sys.exit(app.cmdloop())