oep-client-python 0.0.1__py3-none-any.whl → 0.0.2__py3-none-any.whl

oep_client/__init__.py

@@ -1,5 +1,5 @@
-"""Open Embedded Probe (OEP) host client. `oep_client.v1` speaks the v1 protocol (oep-spec docs/oep-core.ja.md)."""
+"""Open Embedded Probe (OEP) host client. `oep_client` speaks the v1 protocol (oep-spec docs/oep-core.ja.md)."""
 
 __all__ = ["__version__"]
 
-__version__ = "0.0.1"
+__version__ = "0.0.2"

oep_client/{v1/__main__.py → __main__.py}

@@ -1,9 +1,9 @@
 """Draft OEP capability discovery by name, on an in-process fake or a v1 draft probe.
 
-  uv run python -m oep_client.v1 dump --port /run/board-identify/by-id/<probe>
-  uv run python -m oep_client.v1 dump --fake p4-x035
-  uv run python -m oep_client.v1 dump --fake esp32-v003 --prefix oep.fixture
-  uv run python -m oep_client.v1 dump --fake p4-x035 --prefix oep.target --json
+  uv run python -m oep_client dump --port /run/board-identify/by-id/<probe>
+  uv run python -m oep_client dump --fake p4-x035
+  uv run python -m oep_client dump --fake esp32-v003 --prefix oep.fixture
+  uv run python -m oep_client dump --fake p4-x035 --prefix oep.target --json
 """
 
 from __future__ import annotations

oep_client/{v1/fake_serve.py → fake_serve.py}

@@ -1,6 +1,6 @@
 """Serve a fake probe (`endpoint.Endpoint`) on a pty or a TCP port, for other programs' tests.
 
-    python -m oep_client.v1.fake_serve [--pty | --tcp PORT] [options]
+    python -m oep_client.fake_serve [--pty | --tcp PORT] [options]
 
 --pty (the default) opens a pseudo terminal that is the probe's serial port (oep-core §3.4): COBS frames
 0x00 <COBS> 0x00 and the raw bytes of the port's bind on one line. The host opens the printed path itself (and
@@ -25,6 +25,9 @@ Options:
   --bind MODE           bind the serial port to every --slot: last-reset, manual or mixed
   --target-id HEX       the target_id every target's attach reports (wch_dmi_7f)
   --absent N            the N-th pin pair of the first wire has no target (repeatable)
+  --uart-plan           the first oep.fixture.uart gets its RX / TX plan at boot, as if saved (the jig's "DUT TX" /
+                        "DUT RX" labels when the profile has them, else the first free channels); configure then works
+  --uart-rx TEXT        what arrives on that UART's RX every --every ms once it is configured (%d = a counter)
   --run-hook SPEC       what riscv-dm run does on every target: SPEC is module:function or path/file.py:function,
                         called as function(target, pc, regs) -> (stopped, dpc, elapsed_us). `target` is the
                         endpoint.FakeTarget (mem = word address -> value, regs = regno -> value, halted, dpc), so a
@@ -45,7 +48,7 @@ import sys
 import time
 import tty
 
-from . import endpoint, fake, fake_serial, registry as reg
+from . import catalog, endpoint, fake, fake_serial, registry as reg
 
 _ITEM = reg.PROBE_CONFIG.tlv["item"]
 _MODES = reg.PROBE_CONFIG.enum["bind_mode"]
@@ -82,11 +85,40 @@ def build(a: argparse.Namespace) -> endpoint.Endpoint:
                            for n in range(len(a.slot)))
         value = struct.pack("<BBBB", a.port_index, _MODES[a.bind.replace("-", "_")], 0, len(a.slot)) + streams
         items.append(bytes([_ITEM["bind"], len(value)]) + value)
+    if a.uart_plan:
+        fn = uart_fn(ep)
+        rx, tx = _uart_channels(ep, fn)
+        for role, ch in ((1, rx), (2, tx)):
+            items.append(bytes([_ITEM["plan"], 5]) + struct.pack("<HBH", fn, role, ch))
     if items:
         ep.load_config(items, saved=True)
     return ep
 
 
+def uart_fn(ep: endpoint.Endpoint) -> int:
+    fn = ep.fns.get("oep.fixture.uart")
+    if fn is None:
+        raise SystemExit("this profile offers no oep.fixture.uart")
+    return fn
+
+
+def _uart_channels(ep: endpoint.Endpoint, fn: int) -> tuple[int, int]:
+    """RX, TX for the UART's plan: the jig's DUT TX (probe RX) / DUT RX (probe TX) labels, else the first two free."""
+    labels = {name: ch for ch, name in ep.static_labels.items()}
+    if "DUT TX" in labels and "DUT RX" in labels:
+        return labels["DUT TX"], labels["DUT RX"]
+    allowed = []
+    for t in ep.static[fn]:
+        if t[0] == catalog.ROLE_CHANNELS and t[2] == 1:
+            base = struct.unpack_from("<H", t, 3)[0]
+            allowed = catalog.bitmap_to_channels(base, t[5:2 + t[1]])
+    taken = {p for s in ep.slots.values() for p in s.pair} | {a[2] for a in ep.plan}
+    free = [ch for ch in allowed if ch not in taken]
+    if len(free) < 2:
+        raise SystemExit("no two free channels for the UART's plan")
+    return free[0], free[1]
+
+
 def _load_hook(spec: str):
     where, _, name = spec.rpartition(":")
     if not where or not name:
@@ -118,20 +150,28 @@ def _filter(a: argparse.Namespace):
     return answer
 
 
+def _text(fmt: str, count: int) -> bytes:
+    text = fmt.replace("%d", str(count)) if "%d" in fmt else fmt
+    return text.encode().decode("unicode_escape").encode("latin-1")
+
+
 class Console:
-    def __init__(self, ep: endpoint.Endpoint, fmt: str | None, every_ms: int):
-        self.ep, self.fmt, self.every = ep, fmt, every_ms
+    """Every `every_ms`: the targets write `fmt` to their consoles, and `uart_rx` arrives on the UART's RX (fn
+    `uart`) while it runs (configured)."""
+
+    def __init__(self, ep: endpoint.Endpoint, fmt: str | None, every_ms: int, uart_rx: str | None = None,
+                 uart: int | None = None):
+        self.ep, self.fmt, self.every, self.uart_rx, self.uart = ep, fmt, every_ms, uart_rx, uart
         self.next_ms, self.count = 0, 0
 
     def tick(self) -> None:
-        if not self.fmt or self.ep.now() < self.next_ms:
+        if not (self.fmt or self.uart_rx) or self.ep.now() < self.next_ms:
             return
         self.next_ms = self.ep.now() + self.every
-        for i, tg in enumerate(self.ep.targets.values()):
-            text = self.fmt.replace("{t}", str(i))
-            if "%d" in text:
-                text = text.replace("%d", str(self.count))
-            self.ep.target_says(text.encode().decode("unicode_escape").encode("latin-1"), tg)
+        for i, tg in enumerate(self.ep.targets.values()) if self.fmt else ():
+            self.ep.target_says(_text(self.fmt.replace("{t}", str(i)), self.count), tg)
+        if self.uart_rx and self.uart in self.ep.uarts:
+            self.ep.uart_rx(self.uart, _text(self.uart_rx, self.count))
         self.count += 1
 
 
@@ -257,7 +297,7 @@ def _serve_conn(a, ep, console, conn, watch_stdin) -> bool:
 
 
 def main(argv: list[str] | None = None) -> None:
-    ap = argparse.ArgumentParser(prog="python -m oep_client.v1.fake_serve", description=__doc__.split("\n\n")[0])
+    ap = argparse.ArgumentParser(prog="python -m oep_client.fake_serve", description=__doc__.split("\n\n")[0])
     where = ap.add_mutually_exclusive_group()
     where.add_argument("--pty", action="store_true")
     where.add_argument("--tcp", type=int, metavar="PORT")
@@ -273,6 +313,8 @@ def main(argv: list[str] | None = None) -> None:
     ap.add_argument("--bind", choices=["last-reset", "manual", "mixed"])
     ap.add_argument("--target-id")
     ap.add_argument("--absent", type=int, action="append", default=[])
+    ap.add_argument("--uart-plan", action="store_true")
+    ap.add_argument("--uart-rx")
     ap.add_argument("--run-hook")
     ap.add_argument("--once", action="store_true")
     a = ap.parse_args(argv)
@@ -285,7 +327,7 @@ def main(argv: list[str] | None = None) -> None:
         probe_ep = endpoint.Endpoint(profile(), lambda: 0)
         a.port_index = min(probe_ep.serial_ports) if probe_ep.serial_ports else 0
     ep = build(a)
-    console = Console(ep, a.console, _ms(a.every))
+    console = Console(ep, a.console, _ms(a.every), a.uart_rx, uart_fn(ep) if a.uart_rx else None)
     try:
         if a.tcp is None:
             serve_pty(a, ep, console)

{oep_client_python-0.0.1.dist-info → oep_client_python-0.0.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: oep-client-python
-Version: 0.0.1
+Version: 0.0.2
 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
@@ -23,7 +23,7 @@ Description-Content-Type: text/markdown
 # OEP Python client
 
 Open Embedded Probe の host 側。v1（oep-spec の `docs/oep-core.ja.md` と `docs/oep-if-*.ja.md`、固める候補の形）を話す。番号は oep-spec の
-`generated/oep-v1/oep_v1_registry.py` をそのまま写した `oep_client.v1.registry` から取る。破壊的変更を前提とする
+`generated/oep-v1/oep_v1_registry.py` をそのまま写した `oep_client.registry` から取る。破壊的変更を前提とする
 実験段階で、互換 API は約束しない。OEP を初めて読む人は oep-spec の `docs/review-guide.ja.md`（どこに何が書いてあるか）から。
 
 target の知識は host にある、という OEP の分担に従う。probe は線と DMI / DP・AP の転送しか知らず、CH32 の flash
@@ -34,14 +34,14 @@ pip install oep-client-python     # PyPI (import oep_client); a checkout: pip in
 uv run pytest                                                            # in a checkout
 ```
 
-`import oep_client.v1` だけで使える（`sys.path` に `src/` を足す使い方は不要になった）。番号の表は `tools/sync_registry.sh` で
+`import oep_client` だけで使える（`sys.path` に `src/` を足す使い方は不要になった）。番号の表は `tools/sync_registry.sh` で
 oep-spec から写す。PyPI の `oep-client` は別のプロジェクトなので、配布名は `oep-client-python`。
 
 リリースは GitHub Actions の Release（workflow_dispatch、version = X.Y.Z か X.Y.ZbN）: `tools/prepare_release.py` が
 pyproject.toml と `oep_client.__version__` を書き換え、CHANGELOG.md の Unreleased をその版にし、試験と build の後に commit と tag、
 GitHub Release、PyPI（Trusted Publishing）へ出す。変更は CHANGELOG.md の Unreleased に (EN) / (JA) で書き足しておく。
 
-## モジュール（`oep_client.v1`）
+## モジュール（`oep_client`）
 
 | モジュール | 中身 |
 |---|---|
@@ -66,7 +66,7 @@ GitHub Release、PyPI（Trusted Publishing）へ出す。変更は CHANGELOG.md
 ## 使い方の例
 
 ```python
-from oep_client.v1 import core, link, riscv, ch32_flash
+from oep_client import core, link, riscv, ch32_flash
 
 hst = link.open_host("/run/board-identify/by-id/esp32-series-30eda0e31108")   # pipelining つき
 # a serial port (always COBS), "tcp://127.0.0.1:PORT" (a broker), "usb" / "usb:303a:0002[:SERIAL]" (vendor, then HID)
@@ -81,7 +81,7 @@ wire.detach(conn)
 hst.end()
 ```
 
-能力の一覧は `uv run python -m oep_client.v1 dump --port <probe>`（`--fake p4-x035` でハードウェアなし）。
+能力の一覧は `uv run python -m oep_client dump --port <probe>`（`--fake p4-x035` でハードウェアなし）。
 実機での一通りの確認は ArduinoCore-CH32 の `tests/manual/oep_smoke/`（`oep_smoke.py`、`oep_probe_checks.py`）。
 
 ## 偽の probe（動く spec）
@@ -94,7 +94,7 @@ hst.end()
 外のプログラムの試験には `fake_serve` を子プロセスで使う:
 
 ```sh
-uv run python -m oep_client.v1.fake_serve --pty --profile p4-bench --slot x035 --bind last-reset \
+uv run python -m oep_client.fake_serve --pty --profile p4-bench --slot x035 --bind last-reset \
     --console 'uptime %d\r\n' --every 100
 # 最初の行: PTY /dev/pts/N（--tcp 0 なら PORT n）。stdin を閉じると終わる
 ```

oep_client_python-0.0.2.dist-info/RECORD

@@ -0,0 +1,35 @@
+oep_client/__init__.py,sha256=HPhV-26_OX0St4P3ftYE7PmaaGRAKN8qRUJvNMjHElc,163
+oep_client/__main__.py,sha256=5pyY1hn03-bWMuMuo9iMf_KkyAeYc7EEn5KVNYLGTa4,1735
+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
+oep_client/ch32_flash.py,sha256=Fc-6jEj15cQtMSKmfC5dmDetMXJ8hAdAuJ9d9odwrsA,12651
+oep_client/cobs.py,sha256=hqddQI_X7rsBvBvcP_MBE3bXPyB13-Azjqp_9JfdQ1g,2288
+oep_client/console.py,sha256=YYcuc9Qxe3kihla8wynYbDaLVr7wBLEvswrM-cMK3Tk,6859
+oep_client/core.py,sha256=z0-mplQVLOmPyXj1lHc-U7HYl3Gd6o-b5YJhpQTvqKU,8789
+oep_client/decode.py,sha256=M-bRARrA2qGZLoJn0BdXeTb4WjL_2Hb2nk_g1IGXIw4,2382
+oep_client/dump.py,sha256=GAnmu2abuDmGmbWcbbEfC3EUuPp5Hady9vQVNcQ-724,6743
+oep_client/endpoint.py,sha256=ay767evyw0QgM6oXOUcl94b_wxTHtXHxsc8sAUMi6u0,72014
+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_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
+oep_client/hid_stream.py,sha256=99Dsm4Io1keukuETG_UNqjBGiVYZZeb__Pv4ytaKg9k,10695
+oep_client/host.py,sha256=Y5oqE-pw5Ja9cG1dzdy8svIEgR4Kqhki0wuyrpP_xH8,15563
+oep_client/interfaces.py,sha256=P4ehrIj4j-9eg4NjaVdV15pawI2vOqucJwVklSdR-As,5472
+oep_client/link.py,sha256=J9VtBWfTgNoIgUQuj8SsH9hHesQM2uEN545IoxKVS8E,19406
+oep_client/message.py,sha256=MEM1UT6KFM7AsT56jvBLt_FJK_6SJ7O_nGAiipW0_zo,9912
+oep_client/names.py,sha256=ztCZFWs__aR-a5G14TnJP-Q4YfLhbyrzvOVOMJuG93k,3653
+oep_client/registry.py,sha256=nRM-sQiAMs1OzuSZIajdsBfdFckYo3OfwgmcLkHzxqw,9867
+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.2.dist-info/METADATA,sha256=-b91PthTivaMG_-Cyy-XdhMlPl1gDIx6cjVb4aMu4cs,7294
+oep_client_python-0.0.2.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+oep_client_python-0.0.2.dist-info/entry_points.txt,sha256=h6_8QX89Ww1ogALEGG5g4kspT3IOV6O51lwKqf5BWco,49
+oep_client_python-0.0.2.dist-info/licenses/LICENSE,sha256=ntlalztb3L1OaNAxmQdHlubu5fVhjMc9oRZi3PeQhXg,1076
+oep_client_python-0.0.2.dist-info/RECORD,,

oep_client_python-0.0.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+oep = oep_client.__main__:main

oep_client/v1/__init__.py

@@ -1 +0,0 @@
-"""Draft: capability discovery by name (oep-spec capability-*.ja.md). No hardware yet."""

oep_client_python-0.0.1.dist-info/RECORD

@@ -1,36 +0,0 @@
-oep_client/__init__.py,sha256=f5QEx-7qtfSSRnMCtAflZ2y0GvfX6lXa_AVjdc4SQfg,166
-oep_client/v1/__init__.py,sha256=Aghb5g5wouqnDIUFv9S4dkimnzs5YZcWx9gzgxi7GPM,90
-oep_client/v1/__main__.py,sha256=CytzDl1qI-sqXPS5ZqtvV07Riz2agQ7uK-Hlwmyz8fw,1747
-oep_client/v1/arm.py,sha256=JLyUhLSPcmsk73schZcaJYoOKuHzrvnU8kPmfrEvVuo,12331
-oep_client/v1/capture.py,sha256=RZgDnWqr8Aqy49U7PqQpnKIQEL18djVuDJFydxrmv-c,17996
-oep_client/v1/catalog.py,sha256=EqAQnSgHFxGbCO2GQ_Ee-uheJKbBBUUpL1-0qHfNMXU,6574
-oep_client/v1/ch32_flash.py,sha256=Fc-6jEj15cQtMSKmfC5dmDetMXJ8hAdAuJ9d9odwrsA,12651
-oep_client/v1/cobs.py,sha256=hqddQI_X7rsBvBvcP_MBE3bXPyB13-Azjqp_9JfdQ1g,2288
-oep_client/v1/console.py,sha256=YYcuc9Qxe3kihla8wynYbDaLVr7wBLEvswrM-cMK3Tk,6859
-oep_client/v1/core.py,sha256=z0-mplQVLOmPyXj1lHc-U7HYl3Gd6o-b5YJhpQTvqKU,8789
-oep_client/v1/decode.py,sha256=M-bRARrA2qGZLoJn0BdXeTb4WjL_2Hb2nk_g1IGXIw4,2382
-oep_client/v1/dump.py,sha256=GAnmu2abuDmGmbWcbbEfC3EUuPp5Hady9vQVNcQ-724,6743
-oep_client/v1/endpoint.py,sha256=ay767evyw0QgM6oXOUcl94b_wxTHtXHxsc8sAUMi6u0,72014
-oep_client/v1/esp32_targets.py,sha256=b8tNH-nb2KC-XgNfWg5l3TO0cyhZOF-gJajaVxNVSGQ,4988
-oep_client/v1/fake.py,sha256=UzpB-A42Ma2QqJj0l-JmwCJkMn6DPVHHN77fcemT59U,13104
-oep_client/v1/fake_serial.py,sha256=6fhtrit9kWix-D83yYfUKFLHJ11pEiMDrlKNeJKvCfU,4314
-oep_client/v1/fake_serve.py,sha256=B93k_fV0j0KpO8Qtyx8dQfffxn2EeRsURsdX_ScKEP0,12423
-oep_client/v1/fixture.py,sha256=653hCD-Iz0Lfs8dT4Hdg3QyubbbOGs1_xjq_3nb8foU,5564
-oep_client/v1/frames.py,sha256=xjgjnXmXUqNJZ5m0h91r4Cy48WoVK1mEMW4gRg-mlMI,3991
-oep_client/v1/hid_stream.py,sha256=99Dsm4Io1keukuETG_UNqjBGiVYZZeb__Pv4ytaKg9k,10695
-oep_client/v1/host.py,sha256=Y5oqE-pw5Ja9cG1dzdy8svIEgR4Kqhki0wuyrpP_xH8,15563
-oep_client/v1/interfaces.py,sha256=P4ehrIj4j-9eg4NjaVdV15pawI2vOqucJwVklSdR-As,5472
-oep_client/v1/link.py,sha256=J9VtBWfTgNoIgUQuj8SsH9hHesQM2uEN545IoxKVS8E,19406
-oep_client/v1/message.py,sha256=MEM1UT6KFM7AsT56jvBLt_FJK_6SJ7O_nGAiipW0_zo,9912
-oep_client/v1/names.py,sha256=ztCZFWs__aR-a5G14TnJP-Q4YfLhbyrzvOVOMJuG93k,3653
-oep_client/v1/registry.py,sha256=nRM-sQiAMs1OzuSZIajdsBfdFckYo3OfwgmcLkHzxqw,9867
-oep_client/v1/riscv.py,sha256=E0_C-4mBsrp9FUoZpMiqSH9e8sC8Q4EO5HRjFKE6_pc,21392
-oep_client/v1/rp2350.py,sha256=7OMyj270k3AY1e3-ljicPwOjf9jOlokbT6QNkA0b0yY,4227
-oep_client/v1/target.py,sha256=R8BvYfFfYNhZF0MysJkNb8b69YgBlmeGXNX8ReZIe5k,1068
-oep_client/v1/uiapduino.py,sha256=IEPG3LbZPksi8g3wmAf6T0CRWSfYKW1_qrH_GBVQdxY,6090
-oep_client/v1/usb_stream.py,sha256=1nvuRNLQkpp8054eG-JutBKh9y0F_8PHGDAfG0ZSbaY,8819
-oep_client_python-0.0.1.dist-info/METADATA,sha256=PdTZlP4XrPcU_zZZZYofEqST_flj7AeoXHWF9iC06LQ,7312
-oep_client_python-0.0.1.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
-oep_client_python-0.0.1.dist-info/entry_points.txt,sha256=F9_WK-5S92fBuWSeCR0GXzmA5OXY6y0xvYpHseqY2R8,52
-oep_client_python-0.0.1.dist-info/licenses/LICENSE,sha256=ntlalztb3L1OaNAxmQdHlubu5fVhjMc9oRZi3PeQhXg,1076
-oep_client_python-0.0.1.dist-info/RECORD,,

oep_client_python-0.0.1.dist-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-oep = oep_client.v1.__main__:main