From 572e3566eb6db088c6d320444027a98bf2a7c260 Mon Sep 17 00:00:00 2001
From: Virgil Dupras <hsoft@hardcoded.net>
Date: Sat, 30 Nov 2019 22:36:14 -0500
Subject: [PATCH] Add upload tooling for BASIC shell

---
 doc/load-run-code.md | 13 ++++++++++
 tools/uploadb.py     | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 80 insertions(+)
 create mode 100755 tools/uploadb.py

diff --git a/doc/load-run-code.md b/doc/load-run-code.md
index 9ea3abf..31fb45a 100644
--- a/doc/load-run-code.md
+++ b/doc/load-run-code.md
@@ -126,3 +126,16 @@ You can then include that file in your "user" code, like this:
 
 If you load that code at `0xa000` and call it, it will print "Hello World!" by
 using the `printstr` routine from `core.asm`.
+
+## Doing the same with the BASIC shell
+
+The BASIC shell also has the capacity to load code from serial console but its
+semantic is a bit different from the regular shell. Instead of peeking and
+poking, you use `getc` to send data and then `putc` to send the same data back
+for verification. Then, you can use `poke` to commit it to memory.
+
+There's an upload tool that use these commands and it's `uploadb.py`. It is
+invoked with the same arguments as `upload.py`.
+
+Once your code is uploaded, you will call it with BASIC's `usr` command. See
+BASIC's README for more details.
diff --git a/tools/uploadb.py b/tools/uploadb.py
new file mode 100755
index 0000000..e812378
--- /dev/null
+++ b/tools/uploadb.py
@@ -0,0 +1,67 @@
+#!/usr/bin/env python3
+
+# Push specified file to specified device **running the BASIC shell** and verify
+# that the sent contents is correct.
+
+import argparse
+import os
+import sys
+
+def sendcmd(fd, cmd):
+    # The serial link echoes back all typed characters and expects us to read
+    # them. We have to send each char one at a time.
+    if isinstance(cmd, str):
+        cmd = cmd.encode()
+    for c in cmd:
+        os.write(fd, bytes([c]))
+        os.read(fd, 1)
+    os.write(fd, b'\n')
+    os.read(fd, 2)  # sends back \r\n
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument('device')
+    parser.add_argument('memptr')
+    parser.add_argument('filename')
+    args = parser.parse_args()
+
+    try:
+        memptr = int('0x' + args.memptr, 0)
+    except ValueError:
+        print("memptr are has to be hexadecimal without prefix.")
+        return 1
+    if memptr >= 0x10000:
+        print("memptr out of range.")
+        return 1
+    maxsize = 0x10000 - memptr
+    st = os.stat(args.filename)
+    if st.st_size > maxsize:
+        print("File too big. 0x{:04x} bytes max".format(maxsize))
+        return 1
+    fd = os.open(args.device, os.O_RDWR)
+    with open(args.filename, 'rb') as fp:
+        fcontents = fp.read()
+    sendcmd(fd, f'm=0x{memptr:04x}')
+    os.read(fd, 2) # read prompt
+
+    for i, c in enumerate(fcontents):
+        c = bytes([c])
+        sendcmd(fd, 'getc')
+        os.write(fd, c)
+        os.read(fd, 2) # read prompt
+        sendcmd(fd, 'putc a')
+        r = os.read(fd, 1) # putc result
+        os.read(fd, 2) # read prompt
+        if r != c:
+            print(f"Mismatch at byte {i}! {c} != {r}")
+        sendcmd(fd, 'poke m a')
+        os.read(fd, 2) # read prompt
+        sendcmd(fd, 'm=m+1')
+        os.read(fd, 2) # read prompt
+    print("Done!")
+    os.close(fd)
+    return 0
+
+if __name__ == '__main__':
+    sys.exit(main())