oep-client-python 0.0.3__py3-none-any.whl → 0.0.5__py3-none-any.whl

oep_client/__init__.py

@@ -2,4 +2,4 @@
 
 __all__ = ["__version__"]
 
-__version__ = "0.0.3"
+__version__ = "0.0.5"

oep_client/__main__.py

@@ -4,6 +4,7 @@
   oep config show <probe>
   oep config slot <probe> --name x035 --wire rvswd --pins 2,54 --attach at-boot --retry 1 --mechanism dmseq
   oep config bind <probe> --port 1 --mode last-reset --stream slot:x035
+  oep config plan <probe> oep.fixture.uart#2 rx=48 tx=49       (the fn's whole plan; fn number or name#instance)
   oep config remove <probe> bind 1        oep config save <probe>        oep config erase <probe>
 
 <probe>: a serial port, tcp://HOST:PORT or usb[:VID:PID[:SERIAL]]. A change takes the lock (owner "oep config") and
@@ -58,7 +59,7 @@ def _config_parser(sub) -> None:
     slot.add_argument("probe")
     slot.add_argument("--slot", type=int, default=0, help="the slot number (default 0)")
     slot.add_argument("--name", required=True, help="1-32 of a-z 0-9 - _ (the oep://<probe>/<name> address)")
-    slot.add_argument("--wire", default="rvswd", help="rvswd or swio (or an fn)")
+    slot.add_argument("--wire", help="rvswd or swio (or an fn); default: the probe's only wire")
     slot.add_argument("--pins", help="swdio,swclk (one pin on swio); default: the wire's only pin set")
     slot.add_argument("--attach", choices=sorted(config.ATTACH), default="host")
     slot.add_argument("--retry", type=int, default=0, help="at-boot: try again every N s while absent (0: never)")
@@ -72,6 +73,21 @@ def _config_parser(sub) -> None:
     bind.add_argument("--stream", action="append", required=True, help="slot:NAME, slot:N or uart:FN (repeatable)")
     bind.add_argument("--select", type=int, default=0, help="manual: the stream it carries (index in --stream)")
     bind.add_argument("--save", action="store_true")
+    plan = cs.add_parser("plan", help="the pins an interface keeps (its whole plan, kept as a setting)")
+    plan.add_argument("probe")
+    plan.add_argument("fn", help="an fn, or an interface name with #k for its k-th instance (1 = the first)")
+    plan.add_argument("roles", nargs="+", help="ROLE=CHANNEL, ROLE a number or the interface's role name (rx, tx, line...)")
+    plan.add_argument("--save", action="store_true")
+    label = cs.add_parser("label", help="name a channel (shown in oep.core's describe)")
+    label.add_argument("probe")
+    label.add_argument("channel", type=int)
+    label.add_argument("text")
+    label.add_argument("--save", action="store_true")
+    idle = cs.add_parser("idle", help="the state of a free pin")
+    idle.add_argument("probe")
+    idle.add_argument("channel", type=int)
+    idle.add_argument("mode", choices=sorted(config.IDLE))
+    idle.add_argument("--save", action="store_true")
     rm = cs.add_parser("remove", help="remove one item: slot N, bind PORT, plan FN, label CH, idle CH")
     rm.add_argument("probe")
     rm.add_argument("kind", choices=["slot", "bind", "plan", "label", "idle"])
@@ -95,8 +111,40 @@ def _pins(hst, fn: int, text: str | None, wire: str) -> tuple[int, int]:
     return groups[0]
 
 
-def _wire_fn(hst, wire: str) -> int:
-    return int(wire) if wire.isdigit() else core.find(hst, wire if wire.startswith("oep.") else f"oep.wire.{wire}")
+def _plan_fn(hst, spec: str) -> tuple[int, dict[str, int]]:
+    """fn and its role names (from the registry) for `spec`: an fn number, or name[#k] (k-th instance, 1-based)."""
+    from . import registry as reg
+    if spec.isdigit():
+        fn = int(spec)
+        name = next((e.name for e in core.list_entries(hst) if e.fn == fn), "")
+    else:
+        name, _, k = spec.partition("#")
+        fns = core.find_all(hst, name)
+        if not fns:
+            raise SystemExit(f"the probe offers no {name}")
+        index = int(k) - 1 if k else 0
+        if not 0 <= index < len(fns):
+            raise SystemExit(f"{name}: {len(fns)} instance(s), fns {fns}")
+        fn = fns[index]
+    iface = reg.INTERFACES.get(name)
+    roles = dict(iface.enum.get("role", {})) if iface else {}
+    return fn, roles
+
+
+def _wire_fn(hst, wire: str | None) -> int:
+    if wire is None:
+        wires = [e for e in core.list_entries(hst, "oep.wire") if e.name in ("oep.wire.rvswd", "oep.wire.swio")]
+        if len(wires) != 1:
+            raise SystemExit("this probe has " + (", ".join(f"{e.name} (fn {e.fn})" for e in wires) or "no RISC-V wire")
+                             + ": name one with --wire")
+        return wires[0].fn
+    name = wire if wire.startswith("oep.") else f"oep.wire.{wire}"
+    if wire.isdigit():
+        return int(wire)
+    try:
+        return core.find(hst, name)
+    except LookupError:
+        raise SystemExit(f"this probe does not offer {name}") from None
 
 
 def _stream(spec: str, slots: dict[str, int]) -> tuple[str, int]:
@@ -129,6 +177,7 @@ def _config(args) -> int:
             return _show(hst, cfg, args.json)
         if args.action == "slot":
             fn = _wire_fn(hst, args.wire)
+            args.wire = args.wire or str(fn)
             lock = None
             if args.lock:
                 mask, _, value = args.lock.partition(":")
@@ -140,6 +189,22 @@ def _config(args) -> int:
             slots = {it.name: it.slot for it in cfg.items() if isinstance(it, config.Slot)}
             it = config.Bind(args.port, args.mode, [_stream(s, slots) for s in args.stream], args.select)
             _change(hst, cfg, [it], args.save)
+        elif args.action == "plan":
+            fn, roles = _plan_fn(hst, args.fn)
+            items = []
+            for spec in args.roles:
+                role, _, ch = spec.partition("=")
+                if not ch:
+                    raise SystemExit(f"{spec}: want ROLE=CHANNEL")
+                number = int(role) if role.isdigit() else roles.get(role.lower())
+                if number is None:
+                    raise SystemExit(f"{role}: not a role of fn {fn} (roles: {', '.join(sorted(roles)) or 'numbers only'})")
+                items.append(config.Plan(fn, number, int(ch, 0)))
+            _change(hst, cfg, items, args.save)
+        elif args.action == "label":
+            _change(hst, cfg, [config.Label(args.channel, args.text)], args.save)
+        elif args.action == "idle":
+            _change(hst, cfg, [config.Idle(args.channel, args.mode)], args.save)
         elif args.action == "remove":
             _change(hst, cfg, [config.remove(args.kind, args.key)], args.save)
         else:

oep_client/core.py

@@ -109,7 +109,47 @@ def plan_apply(hst: h.Host, assignments: list[tuple[int, int, int]]) -> None:
     all interfaces accept their roles or nothing changes. The plan is the
     session's resource: kept over an explicit end, released at a lease lapse or a force takeover (oep-core §9)."""
     tlv = b"".join(bytes([TAG_ROLE_ASSIGNMENT, 5]) + struct.pack("<HBH", fn, role, ch) for fn, role, ch in assignments)
-    hst.call(m.CORE_FN, OP_PLAN_APPLY, tlv)
+    try:
+        hst.call(m.CORE_FN, OP_PLAN_APPLY, tlv)
+    except h.Rejected as e:
+        if e.result.detail != m.UNAVAILABLE:
+            raise
+        why = _pin_holders(hst, assignments)
+        if why:
+            raise PinsTaken(e.result, why) from None
+        raise
+
+
+class PinsTaken(h.Rejected):
+    """plan_apply refused (unavailable) and the probe's settings say why: a pin kept by another fn's saved plan or by a
+    slot (oep.probe.config). `holders`: (channel, what holds it)."""
+
+    def __init__(self, result, holders: list[tuple[int, str]]):
+        super().__init__(result)
+        self.holders = holders
+
+    def __str__(self) -> str:
+        return "pins taken: " + "; ".join(f"channel {ch} by {who}" for ch, who in self.holders) + \
+            " (oep config show; oep config remove <probe> plan <fn> frees a saved plan)"
+
+
+def _pin_holders(hst: h.Host, assignments: list[tuple[int, int, int]]) -> list[tuple[int, str]]:
+    """What the settings keep on the channels asked for (best effort: an empty list when there is no oep.probe.config
+    or it cannot be read)."""
+    from . import config
+    try:
+        items = config.ProbeConfig(hst).items()
+    except (LookupError, h.OepError):
+        return []
+    fns = {fn for fn, _, _ in assignments}
+    out = []
+    for fn, role, ch in assignments:
+        for it in items:
+            if isinstance(it, config.Plan) and it.channel == ch and it.fn not in fns:
+                out.append((ch, f"the saved plan of fn {it.fn} (role {it.role})"))
+            elif isinstance(it, config.Slot) and ch in it.pins:
+                out.append((ch, f"slot {it.slot} {it.name}"))
+    return out
 
 
 def plan_release(hst: h.Host, fns: list[int] | tuple[int, ...] = ()) -> None:

oep_client/endpoint.py

@@ -923,7 +923,7 @@ class Endpoint:
                 pos = s.end
             elif frm == 3:
                 hits = [mk for mk in s.marks if arg == 0 or mk[2] == arg]
-                pos = hits[-1][1] if hits else s.base
+                pos = hits[-1][1] if hits else s.end                 # no such mark: from now (common §1.2)
             else:
                 raise Reject(m.UNSUPPORTED)
             flags = 0

oep_client/fake_serial.py

@@ -5,7 +5,8 @@
 
 - a candidate runs from a 0x00 to the next 0x00; if it decodes and its CRC matches it is a request, otherwise it
   (with its leading 0x00) is raw bytes, and the closing 0x00 starts the next candidate; bytes outside a candidate
-  are raw at once; a candidate that stops for 200 ms (`tick`) is raw; an empty candidate (0x00 0x00) is nothing
+  are raw at once; a candidate that stops for 200 ms (`tick`) is raw; a candidate that is only its 0x00 (0x00 0x00,
+  or the closing 0x00 of a frame when nothing follows) is nothing
 - raw bytes go to the endpoint's bind for this port (`Endpoint.port_input`)
 - answers go out as 0x00 <COBS> 0x00, ahead of raw chunks (`Endpoint.port_output`); one writer, never a raw byte
   inside a frame
@@ -80,7 +81,8 @@ class FakeSerialPort:
     def _gap(self, now: int) -> None:
         if self.cand is not None and now - self.last_ms >= GAP_MS:
             raw, self.cand = bytes(self.cand), None
-            self._raw(bytearray(raw))
+            if len(raw) > 1:                         # only its 0x00: a delimiter (a frame's closing 0x00), not raw
+                self._raw(bytearray(raw))
 
     def _raw(self, raw: bytearray) -> None:
         if raw:

oep_client/usb_stream.py

@@ -10,6 +10,7 @@ transfer; if its timeout hits first, pyusb raises and the bytes already received
 
 from __future__ import annotations
 
+import atexit
 import threading
 import time
 
@@ -114,15 +115,21 @@ class UsbAsyncStream:
         self.timeout = 0.05
         self._buffer = bytearray()
         self._cond = threading.Condition()
-        self._closed = False
+        self._closed = False           # no more resubmits (close() started)
+        self._stop = False             # the event thread ends (every transfer is back)
         self._transfers = []
+        self._active = 0               # transfers submitted and not yet back for good
         for _ in range(self.DEPTH):
             t = handle.getTransfer()
             t.setBulk(endpoint_in, self.URB_SIZE, callback=self._done, timeout=0)
             t.submit()
             self._transfers.append(t)
+            self._active += 1
         self._events = threading.Thread(target=self._run, daemon=True)
         self._events.start()
+        # Closed at exit too: left to usb1's own finalizers, the context went while the event thread was inside
+        # handleEventsTimeout with transfers out - the process hung at exit or libusb aborted (usbi_mutex_destroy).
+        atexit.register(self.close)
 
     @classmethod
     def open(cls, vid: int, pid: int, serial: str | None = None) -> "UsbAsyncStream":
@@ -158,14 +165,23 @@ class UsbAsyncStream:
                     self._buffer += data
                     self._cond.notify_all()
         if not self._closed and status in (usb1.TRANSFER_COMPLETED, usb1.TRANSFER_TIMED_OUT):
-            transfer.submit()
+            try:
+                transfer.submit()
+                return
+            except usb1.USBError:
+                pass
+        with self._cond:
+            self._active -= 1          # back for good (cancelled, failed, or closing)
+            self._cond.notify_all()
 
     def _run(self) -> None:
-        while not self._closed:
+        while not self._stop:
             try:
                 self.context.handleEventsTimeout(0.1)
             except self._usb1.USBErrorInterrupted:
                 continue
+            except self._usb1.USBError:
+                break
 
     @property
     def in_waiting(self) -> int:
@@ -195,15 +211,27 @@ class UsbAsyncStream:
             self._buffer.clear()
 
     def close(self) -> None:
+        """Cancel the IN transfers and let the event thread take them back before the handle and the context go
+        (closing with transfers still out hung the process or aborted libusb). Safe to call twice (atexit)."""
+        if self._closed:
+            return
         self._closed = True
+        atexit.unregister(self.close)
         for t in self._transfers:
             try:
                 t.cancel()
             except self._usb1.USBError:
                 pass
-        self._events.join(timeout=0.5)
+        deadline = time.monotonic() + 1.0
+        with self._cond:
+            while self._active > 0 and self._events.is_alive() and time.monotonic() < deadline:
+                self._cond.wait(0.05)
+        self._stop = True
+        self._events.join(timeout=1.0)
         try:
             self.handle.releaseInterface(self.interface)
+        except self._usb1.USBError:
+            pass
         finally:
             self.handle.close()
             self.context.close()

{oep_client_python-0.0.3.dist-info → oep_client_python-0.0.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: oep-client-python
-Version: 0.0.3
+Version: 0.0.5
 Summary: Open Embedded Probe (OEP) v1 host: serial / USB / TCP transports, the session rules, the standard interfaces, and a fake probe
 Project-URL: Homepage, https://github.com/Open-Embedded-Probe/oep-client-python
 Project-URL: Repository, https://github.com/Open-Embedded-Probe/oep-client-python
@@ -43,7 +43,7 @@ uv run pytest                     # in a checkout
 `oep-client` is another project, so the distribution is named `oep-client-python`.
 
 Releases: run the GitHub Actions workflow Release (workflow_dispatch, version X.Y.Z or X.Y.ZbN). `tools/prepare_release.py`
-sets the version in pyproject.toml and `oep_client.__version__` and turns CHANGELOG.md's Unreleased into that version; after
+sets the version in pyproject.toml, uv.lock and `oep_client.__version__` and turns CHANGELOG.md's Unreleased into that version; after
 the tests and the build it commits, tags, makes the GitHub Release and publishes to PyPI (Trusted Publishing). Record changes
 under Unreleased in CHANGELOG.md, (EN) and (JA).
 

{oep_client_python-0.0.3.dist-info → oep_client_python-0.0.5.dist-info}/RECORD

@@ -1,5 +1,5 @@
-oep_client/__init__.py,sha256=3ghnlprMZ1C37XShRP-aKKubXhCXuoHsf8alRiJXv54,163
-oep_client/__main__.py,sha256=5uaqPAP6hcv74-7O4cyk0monyu1b8yuU3yISBYXDq5w,10849
+oep_client/__init__.py,sha256=arvOlIBZyy_QgLJjeCKna1018c1f7GeNCDiwrNIscWc,163
+oep_client/__main__.py,sha256=Ta7D7jhtg5IhFWuI3KTikbDNYazh9QKCH3FtMMnDMjg,14143
 oep_client/arm.py,sha256=JLyUhLSPcmsk73schZcaJYoOKuHzrvnU8kPmfrEvVuo,12331
 oep_client/capture.py,sha256=RZgDnWqr8Aqy49U7PqQpnKIQEL18djVuDJFydxrmv-c,17996
 oep_client/catalog.py,sha256=EqAQnSgHFxGbCO2GQ_Ee-uheJKbBBUUpL1-0qHfNMXU,6574
@@ -7,13 +7,13 @@ oep_client/ch32_flash.py,sha256=Fc-6jEj15cQtMSKmfC5dmDetMXJ8hAdAuJ9d9odwrsA,1265
 oep_client/cobs.py,sha256=hqddQI_X7rsBvBvcP_MBE3bXPyB13-Azjqp_9JfdQ1g,2288
 oep_client/config.py,sha256=JhEmQKU-4KjSAoIovgeEwueKEiMLPUIiGVhZcR5ZlVc,9271
 oep_client/console.py,sha256=YYcuc9Qxe3kihla8wynYbDaLVr7wBLEvswrM-cMK3Tk,6859
-oep_client/core.py,sha256=z0-mplQVLOmPyXj1lHc-U7HYl3Gd6o-b5YJhpQTvqKU,8789
+oep_client/core.py,sha256=Cyyaknjipkg6tS76dZe5GMqjmOoQjlfeP0WFtMHkJNs,10403
 oep_client/decode.py,sha256=M-bRARrA2qGZLoJn0BdXeTb4WjL_2Hb2nk_g1IGXIw4,2382
 oep_client/dump.py,sha256=GAnmu2abuDmGmbWcbbEfC3EUuPp5Hady9vQVNcQ-724,6743
-oep_client/endpoint.py,sha256=70eFSDQuu-UffiuooF74e9kS33dhE4DyJeC7yllRR7Y,72248
+oep_client/endpoint.py,sha256=K6FWTojqKqKIQEPpuOQLmfbaDWLvspXed-ipzFNuKHY,72303
 oep_client/esp32_targets.py,sha256=b8tNH-nb2KC-XgNfWg5l3TO0cyhZOF-gJajaVxNVSGQ,4988
 oep_client/fake.py,sha256=UzpB-A42Ma2QqJj0l-JmwCJkMn6DPVHHN77fcemT59U,13104
-oep_client/fake_serial.py,sha256=6fhtrit9kWix-D83yYfUKFLHJ11pEiMDrlKNeJKvCfU,4314
+oep_client/fake_serial.py,sha256=uKl0UNcifhdeykQtm8gnRRhqV7TT4vPwBFuBhbf-9BI,4504
 oep_client/fake_serve.py,sha256=dIuYxhlAixSb8_OQ4b4UXTkWqW5Tpf_F9uuqMNWn0F4,14612
 oep_client/fixture.py,sha256=653hCD-Iz0Lfs8dT4Hdg3QyubbbOGs1_xjq_3nb8foU,5564
 oep_client/frames.py,sha256=xjgjnXmXUqNJZ5m0h91r4Cy48WoVK1mEMW4gRg-mlMI,3991
@@ -28,9 +28,9 @@ oep_client/riscv.py,sha256=E0_C-4mBsrp9FUoZpMiqSH9e8sC8Q4EO5HRjFKE6_pc,21392
 oep_client/rp2350.py,sha256=7OMyj270k3AY1e3-ljicPwOjf9jOlokbT6QNkA0b0yY,4227
 oep_client/target.py,sha256=R8BvYfFfYNhZF0MysJkNb8b69YgBlmeGXNX8ReZIe5k,1068
 oep_client/uiapduino.py,sha256=IEPG3LbZPksi8g3wmAf6T0CRWSfYKW1_qrH_GBVQdxY,6090
-oep_client/usb_stream.py,sha256=1nvuRNLQkpp8054eG-JutBKh9y0F_8PHGDAfG0ZSbaY,8819
-oep_client_python-0.0.3.dist-info/METADATA,sha256=GdLtSyD2YzfeWvDBKGNI_40MyqUD4ygzDccoNXYaCF0,7359
-oep_client_python-0.0.3.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
-oep_client_python-0.0.3.dist-info/entry_points.txt,sha256=h6_8QX89Ww1ogALEGG5g4kspT3IOV6O51lwKqf5BWco,49
-oep_client_python-0.0.3.dist-info/licenses/LICENSE,sha256=ntlalztb3L1OaNAxmQdHlubu5fVhjMc9oRZi3PeQhXg,1076
-oep_client_python-0.0.3.dist-info/RECORD,,
+oep_client/usb_stream.py,sha256=VJMCxsOlQCk005FcS92pqTh33fRSFBizoL__L0VbUMA,10242
+oep_client_python-0.0.5.dist-info/METADATA,sha256=42SpXvaLTywLE9L3yPq1mRj4UNTamkB7Vb0dbZegO24,7368
+oep_client_python-0.0.5.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+oep_client_python-0.0.5.dist-info/entry_points.txt,sha256=h6_8QX89Ww1ogALEGG5g4kspT3IOV6O51lwKqf5BWco,49
+oep_client_python-0.0.5.dist-info/licenses/LICENSE,sha256=ntlalztb3L1OaNAxmQdHlubu5fVhjMc9oRZi3PeQhXg,1076
+oep_client_python-0.0.5.dist-info/RECORD,,