Briefly document protocol

Signed-off-by: Andrew Worsley <amworsley@gmail.com>
This commit is contained in:
Andrew Worsley 2021-05-22 13:18:59 +10:00 committed by Hector Martin
parent fd16d03322
commit 2ea43e6ff1
3 changed files with 26 additions and 1 deletions

View file

@ -80,6 +80,20 @@ ExcInfo = Struct(
"sp_phys" / Int64ul,
"data" / Int64ul,
)
# Sends 56+ byte Commands and Expects 36 Byte Responses
# Commands are format <I48sI
# 4 byte command, 48 byte null padded data + 4 byte checksum
# Responses are of the format: struct format <Ii24sI
# 4byte Response , 4 byte status, 24 byte string, 4 byte Checksum
# Response must start 0xff55aaXX where XX distiguishes between them
# In little endian mode these numbers as listed as REQ_* constants
# defined under UartInterface
#
# Event Response REQ_EVENT passed to registered Event Handler
# Boot Response REQ_BOOT passed to handle_boot() which may
# pass to a matching registered handler based on reason, code values
# If the status is ST_OK returns the data field to caller
# Otherwise reports a remote Error
class UartInterface(Reloadable):
REQ_NOP = 0x00AA55FF
@ -426,6 +440,8 @@ REGION_RWX_EL0 = 0x8000000000
REGION_RW_EL0 = 0x9000000000
REGION_RX_EL1 = 0xa000000000
# Uses UartInterface.proxyreq() to send requests to M1N1 and process
# reponses sent back.
class M1N1Proxy(Reloadable):
S_OK = 0
S_BADCMD = -1

View file

@ -8,11 +8,18 @@ from .sysreg import *
from .tgtypes import *
from .utils import *
# Create serial connection
iface = UartInterface()
# Construct m1n1 proxy layer over serial connection
p = M1N1Proxy(iface, debug=False)
# Customise parameters of proxy and serial port
# based on information sent over the connection
bootstrap_port(iface, p)
# Initialise the Proxy interface from values fetched from
# the remote end
u = ProxyUtils(p)
# Build a Register Monitoring object on Proxy Interface
mon = RegMonitor(u)
hv = HV(iface, p, u)

View file

@ -46,7 +46,9 @@ class HistoryConsole(code.InteractiveConsole):
class ExitConsole(SystemExit):
pass
# locals is a dictionary for constructing the
# InteractiveConsole with. It adds in the callables
# in proxy utils iface and sysreg into locals
def run_shell(locals, msg=None, exitmsg=None):
saved_display = sys.displayhook
try: