kimdos 0.2.0__tar.gz

kimdos-0.2.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

kimdos-0.2.0/PKG-INFO

@@ -0,0 +1,98 @@
+Metadata-Version: 2.4
+Name: kimdos
+Version: 0.2.0
+Summary: Commodore serial bus disk library and shell for the KIM-1 and its replicas
+Author: anarkiwi
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/anarkiwi/kimdos
+Keywords: kim-1,6502,iec,1541,sd2iec,pal-ii,retrocomputing
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: kimtape>=0.1.1
+Requires-Dist: py65
+Requires-Dist: tqdm
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-xdist; extra == "dev"
+Dynamic: license-file
+
+# kimdos
+
+Commodore serial bus (IEC) disk access for the KIM-1, PAL-1/PAL-II and other
+replicas: a 6502 library, and a shell built on it, that load and save CBM DOS
+files on a 1541, an SD2IEC/uIEC or anything else that speaks the bus, with
+JiffyDOS for devices that have it. Written from the protocol, not from
+Commodore's code.
+
+The library uses no zero page, preserves the user port's spare bits, and links
+anywhere with ld65; an llvm-mos C version comes with a KIM-1 platform for that
+compiler. The shell runs over the monitor's TTY:
+
+```
+KIMDOS
+>S PROG,2000,290D
+00, OK,00,00
+>L PROG,4000
+$4000-$490D
+>$
+1 "                " 32 2A
+10   "PROG"             PRG
+65535 BLOCKS FREE.
+>S PROG,2000,2001
+63,FILE EXISTS,00,00
+```
+
+## Install
+
+```sh
+pip install kimdos
+kimtape load --port /dev/ttyUSB0 https://github.com/anarkiwi/kimdos/releases/latest/download/kimdos-2000.ptp --go 2000
+```
+
+Each release has the shell at $0400, $2000 and $C000 (`kimdos-<org>.ptp`,
+`.bin`, `.lbl`), also in the package (`kimdos.build.packaged`); it needs
+about 2.5K of RAM there. The package ships the llvm-mos C library:
+`python -m kimdos.clib` prints its directory.
+
+To build, with cc65: `make ORG=2000` writes `build/kimdos-2000.{bin,ptp,lbl,map}`
+and `build/kimdos.lib`; `make clib` builds `build/c/libkimdos.a` with llvm-mos
+in docker.
+
+## Shell
+
+| Command | |
+| --- | --- |
+| `$[pattern]` | directory, e.g. `$`, `$0:A*` |
+| `@` | drive status |
+| `@command` | DOS command, e.g. `@S:OLD`, `@R:NEW=OLD`, `@CD:GAMES` |
+| `L name[,addr]` | load, to the file's own address or to `addr` |
+| `V name[,addr]` | verify against memory |
+| `S name,start,end` | save `start`-`end` inclusive; `@0:name` replaces |
+| `#[device]` | show or set the device number (decimal, default 8) |
+| `J[0\|1]` | show, or turn off or on, JiffyDOS (default on) |
+| `Q` | return to the monitor; `G` then runs what was loaded |
+
+Names may be quoted. From the keypad, put the KIM tape ID in $17F9 and run
+`ORG+3` to load the file named by its two hex digits, or set $17F5-$17F8 as
+for a tape save and run `ORG+6` to save.
+
+## Simulator
+
+```sh
+kimdos sim --dir ./disk           # the shell against .prg files in ./disk
+kimdos sim --no-jiffy             # against a drive without JiffyDOS
+kimdos bench                      # cycles per byte and JiffyDOS margins
+kimdos board --port /dev/ttyUSB0 --install '$' '@'
+```
+
+## Documentation
+
+- [docs/hardware.md](docs/hardware.md) — the adapter and its wiring
+- [docs/library.md](docs/library.md) — linking the library into a program, the API
+- [docs/clibrary.md](docs/clibrary.md) — the llvm-mos C library and KIM-1 platform
+- [docs/protocol.md](docs/protocol.md) — the bus protocol as implemented
+- [docs/development.md](docs/development.md) — tests, the simulator, releases

kimdos-0.2.0/README.md

@@ -0,0 +1,76 @@
+# kimdos
+
+Commodore serial bus (IEC) disk access for the KIM-1, PAL-1/PAL-II and other
+replicas: a 6502 library, and a shell built on it, that load and save CBM DOS
+files on a 1541, an SD2IEC/uIEC or anything else that speaks the bus, with
+JiffyDOS for devices that have it. Written from the protocol, not from
+Commodore's code.
+
+The library uses no zero page, preserves the user port's spare bits, and links
+anywhere with ld65; an llvm-mos C version comes with a KIM-1 platform for that
+compiler. The shell runs over the monitor's TTY:
+
+```
+KIMDOS
+>S PROG,2000,290D
+00, OK,00,00
+>L PROG,4000
+$4000-$490D
+>$
+1 "                " 32 2A
+10   "PROG"             PRG
+65535 BLOCKS FREE.
+>S PROG,2000,2001
+63,FILE EXISTS,00,00
+```
+
+## Install
+
+```sh
+pip install kimdos
+kimtape load --port /dev/ttyUSB0 https://github.com/anarkiwi/kimdos/releases/latest/download/kimdos-2000.ptp --go 2000
+```
+
+Each release has the shell at $0400, $2000 and $C000 (`kimdos-<org>.ptp`,
+`.bin`, `.lbl`), also in the package (`kimdos.build.packaged`); it needs
+about 2.5K of RAM there. The package ships the llvm-mos C library:
+`python -m kimdos.clib` prints its directory.
+
+To build, with cc65: `make ORG=2000` writes `build/kimdos-2000.{bin,ptp,lbl,map}`
+and `build/kimdos.lib`; `make clib` builds `build/c/libkimdos.a` with llvm-mos
+in docker.
+
+## Shell
+
+| Command | |
+| --- | --- |
+| `$[pattern]` | directory, e.g. `$`, `$0:A*` |
+| `@` | drive status |
+| `@command` | DOS command, e.g. `@S:OLD`, `@R:NEW=OLD`, `@CD:GAMES` |
+| `L name[,addr]` | load, to the file's own address or to `addr` |
+| `V name[,addr]` | verify against memory |
+| `S name,start,end` | save `start`-`end` inclusive; `@0:name` replaces |
+| `#[device]` | show or set the device number (decimal, default 8) |
+| `J[0\|1]` | show, or turn off or on, JiffyDOS (default on) |
+| `Q` | return to the monitor; `G` then runs what was loaded |
+
+Names may be quoted. From the keypad, put the KIM tape ID in $17F9 and run
+`ORG+3` to load the file named by its two hex digits, or set $17F5-$17F8 as
+for a tape save and run `ORG+6` to save.
+
+## Simulator
+
+```sh
+kimdos sim --dir ./disk           # the shell against .prg files in ./disk
+kimdos sim --no-jiffy             # against a drive without JiffyDOS
+kimdos bench                      # cycles per byte and JiffyDOS margins
+kimdos board --port /dev/ttyUSB0 --install '$' '@'
+```
+
+## Documentation
+
+- [docs/hardware.md](docs/hardware.md) — the adapter and its wiring
+- [docs/library.md](docs/library.md) — linking the library into a program, the API
+- [docs/clibrary.md](docs/clibrary.md) — the llvm-mos C library and KIM-1 platform
+- [docs/protocol.md](docs/protocol.md) — the bus protocol as implemented
+- [docs/development.md](docs/development.md) — tests, the simulator, releases

kimdos-0.2.0/pyproject.toml

@@ -0,0 +1,57 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "kimdos"
+version = "0.2.0"
+description = "Commodore serial bus disk library and shell for the KIM-1 and its replicas"
+readme = "README.md"
+license = "Apache-2.0"
+requires-python = ">=3.11"
+authors = [{ name = "anarkiwi" }]
+keywords = ["kim-1", "6502", "iec", "1541", "sd2iec", "pal-ii", "retrocomputing"]
+dependencies = [
+    "kimtape>=0.1.1",
+    "py65",
+    "tqdm",
+]
+
+[project.urls]
+Homepage = "https://github.com/anarkiwi/kimdos"
+
+[project.scripts]
+kimdos = "kimdos.cli:main"
+
+[project.optional-dependencies]
+dev = ["black", "pylint", "pytest", "pytest-cov", "pytest-xdist"]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+kimdos = ["c/Dockerfile", "c/include/*.h", "c/src/*", "c/kim1/*", "images/*"]
+
+[tool.pytest.ini_options]
+addopts = "-n auto --cov=kimdos --cov-report=term-missing --cov-fail-under=85"
+testpaths = ["tests"]
+
+[tool.coverage.run]
+# needs a board on a serial line
+omit = ["*/board.py"]
+
+[tool.black]
+line-length = 88
+target-version = ["py311"]
+
+[tool.pylint.main]
+source-roots = ["src"]
+
+[tool.pylint.format]
+max-line-length = 88
+
+[tool.pylint."messages control"]
+disable = ["consider-using-f-string"]
+
+[tool.pylint.basic]
+no-docstring-rgx = "^(test_|_)"

kimdos-0.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

kimdos-0.2.0/src/kimdos/__init__.py

@@ -0,0 +1 @@
+"""KIM-1 DOS test oracle: serial bus drive model and KIM-1 machine simulator."""

kimdos-0.2.0/src/kimdos/bench.py

@@ -0,0 +1,97 @@
+"""Throughput and JiffyDOS timing margins of the 6502 library, simulated."""
+
+from tqdm import tqdm
+
+from .iec import JIFFY_AVR_EARLY, JIFFY_AVR_LATE, JIFFY_LPC, Drive
+from .sim import RETURN, Kim
+
+TIMINGS = {"lpc": JIFFY_LPC, "avr-early": JIFFY_AVR_EARLY, "avr-late": JIFFY_AVR_LATE}
+BUF = 0x4000
+NAME = 0x3F00
+SIZES = (1016, 2032)
+OPS = ("read", "write", "load")
+
+
+def _kim(image, files, **kw):
+    kim = Kim(image.binary, image.org, drives=Drive(files=files, **kw))
+    return kim, kim.drive
+
+
+def _call(kim, image, name, **kw):
+    r = kim.call(image[name], max_cycles=100_000_000, **kw)
+    assert r.reason == RETURN, name
+    return r
+
+
+def _setnam(kim, image, name):
+    kim.write(NAME, name)
+    _call(kim, image, "dos_setnam", a=len(name), x=NAME & 0xFF, y=NAME >> 8)
+
+
+def _range(kim, image, beg, end):
+    kim.write(image["dos_beg"], beg.to_bytes(2, "little") + end.to_bytes(2, "little"))
+
+
+def op_cycles(image, op, n, **kw):
+    """CPU cycles for one library operation moving n bytes: dos_read of an
+    open file, dos_write to one, or a whole dos_load (open, transfer, close)."""
+    data = bytes(i * 7 & 0xFF for i in range(n))
+    kim, drive = _kim(image, {b"F": b"\x00\x40" + data}, **kw)
+    if op == "load":
+        _setnam(kim, image, b"F")
+        c = _call(kim, image, "dos_load").cycles
+        assert kim.read(BUF, n) == data
+    else:
+        _setnam(kim, image, b"F" if op == "read" else b"G,S,W")
+        _call(kim, image, "dos_open", a=2)
+        if op == "write":
+            kim.write(BUF, data)
+        _range(kim, image, BUF, BUF + n + 2 if op == "read" else BUF + n)
+        c = _call(kim, image, "dos_" + op, a=2).cycles
+        _call(kim, image, "dos_close", a=2)
+        got = kim.read(BUF, n + 2)[2:] if op == "read" else drive.files[b"G"]
+        assert got == data, op
+    assert not drive.errors, drive.errors
+    return c
+
+
+def per_byte(image, op, **kw):
+    """Cycles per byte of op, fixed costs cancelled over two sizes."""
+    lo, hi = (op_cycles(image, op, n, **kw) for n in SIZES)
+    return (hi - lo) / (SIZES[1] - SIZES[0])
+
+
+def margin_ok(image, margin, **kw):
+    """Whether a load, a save and a status read stay margin us clear of
+    every device edge and sample point."""
+    data = bytes(range(256)) * 2
+    kim, drive = _kim(image, {b"F": b"\x00\x40" + data}, margin=margin, **kw)
+    _setnam(kim, image, b"F")
+    _call(kim, image, "dos_load")
+    _setnam(kim, image, b"G")
+    _range(kim, image, BUF, BUF + len(data))
+    _call(kim, image, "dos_save")
+    _call(kim, image, "dos_status")
+    return not drive.errors and drive.files.get(b"G", b"")[2:] == data
+
+
+def max_margin(image, step=0.25, **kw):
+    """Largest margin, in steps of step us, at which margin_ok holds."""
+    m = 0
+    while margin_ok(image, m + step, **kw):
+        m += step
+    return m
+
+
+def report(image, latencies=(0, 1, 2)):
+    """Throughput rows (op, standard, Jiffy) and margin rows (timing,
+    latency, margin), with progress bars."""
+    rows = []
+    for op in tqdm(OPS, desc="throughput"):
+        rows.append((op, per_byte(image, op, jiffy=None), per_byte(image, op)))
+    cases = [(t, lat) for t in TIMINGS for lat in latencies]
+    margins = [
+        (t, lat, max_margin(image, jiffy=TIMINGS[t], latency=lat))
+        for t, lat in tqdm(cases, desc="margins")
+    ]
+    return rows, margins

kimdos-0.2.0/src/kimdos/board.py

@@ -0,0 +1,58 @@
+"""Drive the KIMDOS shell on a real board over its TTY line."""
+
+import re
+import sys
+import time
+
+from kimtape import Monitor, Port, Tape
+
+PROMPT = b"\r\n>"
+
+
+class Board:
+    """A KIM-1 running the KIMDOS shell, reached through the monitor."""
+
+    def __init__(self, dev, baud=1200, trace=False):
+        self.port = Port(dev, baud, trace=trace)
+        self.mon = Monitor(self.port, log=sys.stderr)
+
+    def install(self, ptp, org):
+        """Load a tape image with the monitor, verify it and start the shell."""
+        self.mon.sync()
+        tape = Tape("kimdos", ptp)
+        for _ in range(3):
+            self.mon.load(tape)
+            if self.mon.verify(tape):
+                break
+        else:
+            raise RuntimeError("image did not verify")
+        self.start(org)
+
+    def start(self, org):
+        """Run the shell at org and wait for its prompt."""
+        self.mon.sync()
+        self.port.take()
+        self.mon.go(org)
+        self.wait_prompt(10)
+
+    def wait_prompt(self, timeout):
+        """Collect output up to the next shell prompt."""
+        deadline = time.time() + timeout
+        while PROMPT not in self.port.rx and time.time() < deadline:
+            self.port.poll(0.1)
+        if PROMPT not in self.port.rx:
+            raise TimeoutError(Port.show(bytes(self.port.rx)))
+        out = bytes(self.port.rx)
+        self.port.take()
+        return out[: out.index(PROMPT)]
+
+    def command(self, line, timeout=60):
+        """Type a shell command and return its output without the echo."""
+        self.port.take()
+        self.port.write(line.encode() + b"\r")
+        out = self.wait_prompt(timeout).decode("ascii", "replace")
+        return re.sub(r"^.*?\r\n", "", out, count=1, flags=re.S).strip("\r\n")
+
+    def close(self):
+        """Release the serial line."""
+        self.port.close()

kimdos-0.2.0/src/kimdos/build.py

@@ -0,0 +1,75 @@
+"""Build the 6502 image with cc65 and read back its symbols."""
+
+import fcntl
+import subprocess
+from dataclasses import dataclass
+from pathlib import Path
+
+ROOT = Path(__file__).resolve().parents[2]
+IMAGES = Path(__file__).resolve().parent / "images"
+
+
+@dataclass(frozen=True)
+class Image:
+    """A linked KIMDOS image: binary, tape, load address and symbol table."""
+
+    binary: bytes
+    ptp: Path
+    labels: dict
+    org: int
+
+    @classmethod
+    def load(cls, stem):
+        """Read the .bin, .ptp and .lbl files an ld65 build left at stem."""
+        stem = Path(stem)
+        labels = read_labels(stem.with_suffix(".lbl"))
+        return cls(
+            stem.with_suffix(".bin").read_bytes(),
+            stem.with_suffix(".ptp"),
+            labels,
+            labels["__RAM_START__"],
+        )
+
+    def __getitem__(self, name):
+        return self.labels[name]
+
+
+def read_labels(path):
+    """Parse an ld65 -Ln (VICE) label file into {name: address}."""
+    labels = {}
+    for line in Path(path).read_text(encoding="ascii").splitlines():
+        _, addr, name = line.split()
+        labels[name.lstrip(".")] = int(addr, 16)
+    return labels
+
+
+def _make(build_dir, *args):
+    build_dir.mkdir(parents=True, exist_ok=True)
+    with open(build_dir / ".lock", "w", encoding="ascii") as lock:
+        fcntl.flock(lock, fcntl.LOCK_EX)
+        subprocess.run(
+            ["make", "-s", "-C", str(ROOT), "BUILD=%s" % build_dir, *args],
+            check=True,
+            stdout=subprocess.DEVNULL,
+        )
+
+
+def build_c():
+    """Build the C library and its test program (llvm-mos in docker) under the
+    repository's build directory, which docker can mount; return kdtest.bin."""
+    build_dir = ROOT / "build"
+    _make(build_dir, "clib")
+    return (build_dir / "c" / "kdtest.bin").read_bytes()
+
+
+def build(org=0x2000, build_dir=None):
+    """Run make for an image at org and return it."""
+    build_dir = Path(build_dir or ROOT / "build")
+    _make(build_dir, "ORG=%04X" % org)
+    return Image.load(build_dir / ("kimdos-%04X" % org))
+
+
+def packaged(org=0x2000):
+    """The prebuilt shell image at org shipped in the wheel ($0400, $2000,
+    $C000; `make images` in a checkout)."""
+    return Image.load(IMAGES / ("kimdos-%04X" % org))

kimdos-0.2.0/src/kimdos/c/Dockerfile

@@ -0,0 +1 @@
+FROM ghcr.io/anarkiwi/docker-mos-llvm-sdk:23.3.0