oep-client-python 0.0.51__tar.gz → 0.0.53__tar.gz

{oep_client_python-0.0.51 → oep_client_python-0.0.53}/CHANGELOG.md

@@ -2,6 +2,76 @@
 
 ## Unreleased
 
+## 0.0.53
+- (EN) An RP2040 board as a test's peer over an OEP probe's SWD alone (`oep_client.rp2040_peer`), for a peer whose USB goes to
+  the device under test: `python -m oep_client.rp2040_peer flash oep://<probe>/<port> <elf|bin>` (the port's labels
+  `<port>.swdio` / `<port>.swclk`; through ch32rv's broker sharing its lock when it runs, found with `$CH32RV`; the old
+  image's SEGGER RTT IDs left in RAM are wiped before the reboot, so the console finds the new one's), the console as
+  SEGGER RTT through the MEM-AP (`console`, and pyserial's `oep://` handler in `oep_client.pyserial`), and
+  `pytest_plugins = ["oep_client.pytest_rp2040_peer"]` for pytest-embedded-arduino-cli: arduino-pico's OpenOCD upload
+  (`uploadmethod=picoprobe_cmsis_dap`) handed to the writer through generated hook files, the peer's own device lock,
+  the DUT's ch32rv passed on.
+- (JA) RP2040 の基板を、OEP のプローブの SWD だけで試験の相手（peer）にする（`oep_client.rp2040_peer`）。USB を DUT に
+  つなぐ相手のため。`python -m oep_client.rp2040_peer flash oep://<probe>/<port> <elf|bin>`（口のラベル `<port>.swdio` /
+  `<port>.swclk`。ch32rv の broker が動いていれば、そのロックに相乗りする。broker は `$CH32RV` で探す。RAM に残った前の
+  イメージの SEGGER RTT の ID は起動し直す前に消し、コンソールが新しいものを見つけるようにする）、コンソールは
+  MEM-AP の上の SEGGER RTT（`console`、pyserial の `oep://` の handler は `oep_client.pyserial`）。pytest-embedded-arduino-cli
+  には `pytest_plugins = ["oep_client.pytest_rp2040_peer"]`: arduino-pico の OpenOCD の書き込み（`uploadmethod=picoprobe_cmsis_dap`）
+  を、書き出した hook のファイルで書き込みの道具に渡す。peer のロックは自分のもの。DUT の ch32rv を引き渡す。
+- (EN) `rp2040`: the RP2040's flash written over SWD through its boot ROM (`rom_table_lookup` at 0x18 on the function
+  table at 0x14), the sequence shared with `rp2350.Flash` (which now takes another chip's ROM lookup and spare RAM), and
+  a reboot by the watchdog the pico-sdk's way (PSM WDSEL all but the oscillators, SCRATCH4 0: left as it comes, the
+  trigger restarted nothing). `arm.CortexM.reset_halt()`: reset the core and stop on its first instruction (a core
+  locked up in a fault handler is no place to call the ROM from).
+- (JA) `rp2040`: RP2040 の flash を SWD でブート ROM から書く（関数表は 0x14、`rom_table_lookup` は 0x18）。手順は `rp2350.Flash` と
+  共通にし、Flash はほかのチップの ROM の引き方と空いている RAM を受け取れるようにした。起動し直しは pico-sdk と同じウォッチドッグの
+  手順（PSM の WDSEL を発振器以外すべて、SCRATCH4 を 0。そのままではトリガしても何も起動し直さなかった）。`arm.CortexM.reset_halt()`:
+  コアをリセットして最初の命令で止める（fault の処理の途中で lockup したコアからは ROM を呼べない）。
+
+## 0.0.52
+- (EN) Capture format 1 is per-channel reductions (oep-spec 165a278, capture §1.3): `LogicCapture.configure(...,
+  carriage={role: (carriage, D)})` with capture_blocks.SAMPLE / ANY_HIGH / ANY_LOW / CHANGE_LATCH (the `events`
+  argument is gone), and `blocks()` / `columns()` give raw bits and the reductions' interval values
+  (`capture_blocks.ReducedColumn`; a change_latch block start that does not follow its interval before is a
+  ProtocolError). `acquire.Request(resolution={name: (mode, D)})`: a sampled line comes as `Bits` at step D, any other
+  reduction as the new `Reduced` (kind, values packed, start level); `Changes` is gone. The configure answer's
+  `data_rate` (streaming) is read into `Config.data_rate` and goes to `meta.probe.data_rate`; `tolerable_delay_s()`
+  uses it. `Part.samples` (and `Result.samples` for one part) says a part's ticks: a part of reduced lines only ends
+  inside its last interval.
+- (JA) キャプチャの形式 1 を、線ごとの縮約に替えた（oep-spec 165a278、capture §1.3）。`LogicCapture.configure(...,
+  carriage={役割: (運び方, D)})` で、運び方は capture_blocks.SAMPLE / ANY_HIGH / ANY_LOW / CHANGE_LATCH（`events` の引数は
+  無くした）。`blocks()` / `columns()` は raw のビットと、縮約の区間の値（`capture_blocks.ReducedColumn`）を返す。change_latch の
+  ブロックの start が前の区間の終わりと合わなければ ProtocolError。`acquire.Request(resolution={名前: (モード, D)})`: sample の線は
+  step D の `Bits`、ほかの縮約は新しい `Reduced`（運び方、詰めた値、始まりのレベル）で返す。`Changes` は無くした。configure の
+  応答の `data_rate`（流し続け）を `Config.data_rate` に読み、`meta.probe.data_rate` に入れる。`tolerable_delay_s()` もそれを使う。
+  `Part.samples`（1 区間なら `Result.samples`）は区間の tick の数を示す（縮約の線だけの区間は、最後の区間の途中で終わる）。
+- (EN) `acquire`: a stream's `wait` has `wait.beside(fn, *args)`: fn runs in another thread - something that does not
+  use the session, such as another process (a ch32rv flash) - while the stream is collected, and its value comes back
+  (its exception raised). A blocking call made from `during` itself collects nothing until it returns, so the stream
+  overflows meanwhile.
+- (JA) `acquire`: 流し続けの `wait` に `wait.beside(fn, *args)` を足した。セッションを使わない処理（別プロセスの ch32rv の書き込み
+  など）を別のスレッドで走らせ、その間も取り込みを読み続け、fn の値を返す（例外はそのまま上げる）。`during` の中で直接待つと、
+  終わるまで読まないので、その間に溜められる分を超える。
+- (EN) `Host.end()` with no session (never opened, ended, or lost to a no_session) sends nothing. It used to send the
+  end with session_id 0, which a probe or broker refuses session_required (core §4.3): a tool that closed after its
+  session lapsed saw that refusal instead of the no_session that told what happened.
+- (JA) セッションが無いとき（開いていない、終えた、no_session で失った）の `Host.end()` は何も送らない。これまでは session_id 0 の
+  end を送り、probe や broker に session_required で断られていた（core §4.3）。lease が切れた後に閉じる道具は、何が起きたかを示す
+  no_session ではなく、その断りを見ていた。
+- (EN) `oep_client.decode` (`decode_i2c`) is gone: decoding what a capture holds is WireSkein's (`wireskein analyze` /
+  `decode`, `wireskein.runlog.i2c`), which also keeps what is known about each bus. Hand it the capture
+  (`wireskein.sources.oep.capture_of`).
+- (JA) `oep_client.decode`（`decode_i2c`）を無くした。キャプチャの中身の解読は WireSkein の役目で（`wireskein analyze` /
+  `decode`、`wireskein.runlog.i2c`）、バスごとの知見もそこにまとめる。キャプチャは `wireskein.sources.oep.capture_of` で渡す。
+- (EN) `oep pins`: the CH32V002 / V004 / V005 / V006 / V007 are a family of their own (`ch32v006`), apart from the
+  CH32V003 (`ch32v00x`): their map reads ports A-D (port B was never read), and their reset pin is not named - it is
+  the package's (CH32V006DS0 note 5: PA7 on the K8U7, PC5 on the E8R / V005E6R6, PD7 on the rest), which the ID does
+  not tell; the option bytes read as "NRST on the package's reset pin" (it said PD7).
+- (JA) `oep pins`: CH32V002 / V004 / V005 / V006 / V007 を CH32V003（`ch32v00x`）から分けたファミリー（`ch32v006`）にした。map は
+  ポート A〜D を読む（B を読んでいなかった）。リセットの端子は名指ししない。パッケージで決まり（CH32V006DS0 の注 5: K8U7 は PA7、
+  E8R / V005E6R6 は PC5、ほかは PD7）、ID からは分からないため。option bytes の表示は「NRST on the package's reset pin」
+  （PD7 と出していた）。
+
 ## 0.0.51
 - (EN) No user-facing changes recorded.
 - (JA) ユーザー向け変更の記録はありません。

{oep_client_python-0.0.51 → oep_client_python-0.0.53}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: oep-client-python
-Version: 0.0.51
+Version: 0.0.53
 Summary: Open Embedded Probe (OEP) v1 host: serial / USB / TCP transports, the session rules, the standard interfaces, and a virtual bench
 Project-URL: Homepage, https://github.com/Open-Embedded-Probe/oep-client-python
 Project-URL: Repository, https://github.com/Open-Embedded-Probe/oep-client-python
@@ -86,7 +86,6 @@ names starting with `_`, may change. Check probe/client compatibility using the
 | `fixture` | `oep.fixture.gpio` (`set([(ch, mode)])` applied in order in one request, `read(channels)` the levels; the output strength is the probe's own - there is no drive selection) / `uart` (its stream is the plan's; nothing is received until `configure(baud, fmt)`; `status()` = `UartStatus(baud, format)` in force, baud 0 and format 0 while not configured; a configure the probe could not bring up raises `Failed` and leaves it not configured) / `i2c-target` (one form: `configure(address)` - the target made anew -, every controller write with data one frame for `read_rx`, reads answered from `preload_tx(data)` slots or 0xFF, `status()` = `I2cStatus(state, queued, rx_frames, tx_slots, errors)`, `stretch` when the ops offer it, `internal_pullups`: whether it enables pull-ups of its own; the reserved addresses 0x00-0x07 / 0x78-0x7F refused before sending) / `spi-target` (no reset: configure again; `cs_setup_ns`: how long after CS the first bit is sure; `oep dump` shows it) |
 | `settings` | the core's settings (oep-spec core §13): fn 0's get / set / unset / save / state / network. `Settings(hst)`: `catalog()` = the names of this boot (each fn's category `core` / `name/instance`, items, choices, channel / route / netif names), `show()` = every value as (category, flat name, value) (no origin: the firmware's initial values are values like any other, core §13.4), `changeable()` (set / unset offered), `set_named(category, {flat: value})` / `unset_named` / `unset_all`, raw `set` / `unset` by (fn, number, key), `save()`, `state()`, `network()`; `export()` / `plan_import(doc)` / `apply_import(plan)` = the settings file (oep-spec docs/oep-settings-file.ja.md; secrets never read); `find_line(source, "nrst", port=None)` = host guide §5.3's line lookup: port S's line N is the label `S.N` (ignoring ASCII case; without a port the one port named), `ports_named(labels)` the ports as written |
 | `capture` | `oep.fixture.logic` / `analog` / `capture-group` (revision 1, oep-spec oep-if-capture). configure's TLVs follow core §2.3: a value the probe cannot honour is refused unsupported with the tag as sent (the table's TLVs go without the critical bit); the answer holds the actual values, its samples among them (analog: a scale for every role, a skew left out read as 0). Every `start()` returns a new generation (`LogicCapture.generation`, never re-used within a boot: past 0xFFFFFFFF a start is refused until a reboot) that read and release name - `read_segment(segment)` passes the segment's own - and every event carries (`events()` drops an earlier start's); streaming data frames carry their generation and their segment (segment_info, never crossing a segment: `Received.segments`); `status()` returns a `Status`. A capture-group binds configured tracks with an immediate trigger, all in one mode, and starts them at once (`CaptureGroup.start` -> the group's start_ns; the group's and each track's generation). Every segment read goes to the `Host.on_capture` callbacks as a `CaptureRecord` (the hook for run recorders; no wireskein dependency) |
-| `decode` | decoding capture channels (I2C) |
 | `registry` | generated from oep-spec's number table (never edited; copied again from oep-spec). The public way to reach an interface by name is `registry.INTERFACES[name]` (`.revision`, `.op`, `.tlv`, `.enum`, e.g. `INTERFACES["oep.fixture.uart"].enum["role"]`); the module-level names (`FIXTURE_UART`, ...) are the same objects |
 | `arm` | `oep.wire.swd`, `oep.target.arm-adi`, MEM-AP, halting and calling functions on a Cortex-M |
 | `ch32_flash` | writing a CH32 (a RAM loader, page by page) |

{oep_client_python-0.0.51 → oep_client_python-0.0.53}/README.ja.md

@@ -53,7 +53,6 @@ GitHub Release、PyPI（Trusted Publishing）へ出す。変更は CHANGELOG.md
 | `fixture` | `oep.fixture.gpio`（`set([(ch, mode)])` は 1 つの要求で順に当て、`read(channels)` は level を返す。出力の強さは probe 自身のもので、選ぶ手段は無い）/ `uart`（ストリームは plan が作る。`configure(baud, fmt)` までは何も受けない。`status()` = いま効いている `UartStatus(baud, format)` で、configure していなければ baud 0、format 0。probe が立ち上げられなかった configure は `Failed` を上げ、configure していない状態に戻る）/ `i2c-target`（1 つの形: `configure(address)` - target を作り直す -、データのある controller の書き込み 1 回が `read_rx` の 1 フレーム、読み出しには `preload_tx(data)` の置き場か 0xFF で答える、`status()` = `I2cStatus(state, queued, rx_frames, tx_slots, errors)`、ops にあれば `stretch`、`internal_pullups`: 自分の pull-up を入れるか。予約のアドレス 0x00〜0x07 / 0x78〜0x7F は送る前に断る）/ `spi-target`（reset は無く、configure し直す。`cs_setup_ns`: CS の後、最初のビットが確かになるまでの時間。`oep dump` が出す） |
 | `settings` | core の設定（oep-spec core §13）: fn 0 の get / set / unset / save / state / network。`Settings(hst)`: `catalog()` = その起動の名前（各 fn のカテゴリ `core` / `name/instance`、項目、選択肢、channel・経路・netif の名前）、`show()` = 全部の値を（カテゴリ、平らな名前、値）で（出どころは無い。firmware の初期値もほかの値と同じ、core §13.4）、`changeable()`（set / unset があるか）、`set_named(category, {平らな名前: 値})` / `unset_named` / `unset_all`、番号での `set` / `unset`、`save()`、`state()`、`network()`。`export()` / `plan_import(doc)` / `apply_import(plan)` = 設定のファイル（oep-spec docs/oep-settings-file.ja.md。secret は読まない）。`find_line(source, "nrst", port=None)` = host ガイド §5.3 の線の探し方（口 S の線 N は label `S.N`、ASCII の大小文字を区別しない。口を省くと名付けられた口が 1 つのときだけそれ）、`ports_named(labels)` は口の名前を書いたとおりに |
 | `capture` | `oep.fixture.logic` / `analog` / `capture-group`（revision 1、oep-spec の oep-if-capture）。configure の TLV は core §2.3 に従う: probe が守れない値は送ったままの tag で unsupported で断られる（表の TLV は critical を付けずに送る）。応答が実際の値で、samples もそれが正しい（アナログ: scale は役割ごとに必ずあり、省かれた skew は 0 と読む）。`start()` はそのたびに新しい世代を返す（`LogicCapture.generation`。同じ起動の間は使い回さず、0xFFFFFFFF の後の start は再起動まで断られる）。read と release はその世代を付け（`read_segment(segment)` は区画自身の世代を付ける）、どの出来事も世代を持つ（`events()` は前の start のものを捨てる）。ストリーミングのデータフレームは世代と自分の区画を持ち、区画をまたがない（segment_info、`Received.segments`）。`status()` は `Status` を返す。capture-group は configure 済みで即時のトリガの、同じ mode のトラックを束ね、一度に始める（`CaptureGroup.start` -> group の start_ns。group と各トラックの世代）。読んだ区画は `Host.on_capture` の callback に `CaptureRecord` で渡る（記録の受け口。wireskein には依存しない） |
-| `decode` | キャプチャのチャネルの復号（I2C） |
 | `registry` | oep-spec の番号の表から生成したモジュール（編集しない。oep-spec から写し直す）。名前からインターフェースの番号を引く公開の入口は `registry.INTERFACES[name]`（`.revision`、`.op`、`.tlv`、`.enum`。例 `INTERFACES["oep.fixture.uart"].enum["role"]`）。`FIXTURE_UART` などのモジュールの名前は同じもの |
 | `arm` | `oep.wire.swd`、`oep.target.arm-adi`、MEM-AP、Cortex-M の停止と関数呼び出し |
 | `ch32_flash` | CH32 の書き込み（RAM ローダー、ページ単位の書き直し） |

{oep_client_python-0.0.51 → oep_client_python-0.0.53}/README.md

@@ -59,7 +59,6 @@ names starting with `_`, may change. Check probe/client compatibility using the
 | `fixture` | `oep.fixture.gpio` (`set([(ch, mode)])` applied in order in one request, `read(channels)` the levels; the output strength is the probe's own - there is no drive selection) / `uart` (its stream is the plan's; nothing is received until `configure(baud, fmt)`; `status()` = `UartStatus(baud, format)` in force, baud 0 and format 0 while not configured; a configure the probe could not bring up raises `Failed` and leaves it not configured) / `i2c-target` (one form: `configure(address)` - the target made anew -, every controller write with data one frame for `read_rx`, reads answered from `preload_tx(data)` slots or 0xFF, `status()` = `I2cStatus(state, queued, rx_frames, tx_slots, errors)`, `stretch` when the ops offer it, `internal_pullups`: whether it enables pull-ups of its own; the reserved addresses 0x00-0x07 / 0x78-0x7F refused before sending) / `spi-target` (no reset: configure again; `cs_setup_ns`: how long after CS the first bit is sure; `oep dump` shows it) |
 | `settings` | the core's settings (oep-spec core §13): fn 0's get / set / unset / save / state / network. `Settings(hst)`: `catalog()` = the names of this boot (each fn's category `core` / `name/instance`, items, choices, channel / route / netif names), `show()` = every value as (category, flat name, value) (no origin: the firmware's initial values are values like any other, core §13.4), `changeable()` (set / unset offered), `set_named(category, {flat: value})` / `unset_named` / `unset_all`, raw `set` / `unset` by (fn, number, key), `save()`, `state()`, `network()`; `export()` / `plan_import(doc)` / `apply_import(plan)` = the settings file (oep-spec docs/oep-settings-file.ja.md; secrets never read); `find_line(source, "nrst", port=None)` = host guide §5.3's line lookup: port S's line N is the label `S.N` (ignoring ASCII case; without a port the one port named), `ports_named(labels)` the ports as written |
 | `capture` | `oep.fixture.logic` / `analog` / `capture-group` (revision 1, oep-spec oep-if-capture). configure's TLVs follow core §2.3: a value the probe cannot honour is refused unsupported with the tag as sent (the table's TLVs go without the critical bit); the answer holds the actual values, its samples among them (analog: a scale for every role, a skew left out read as 0). Every `start()` returns a new generation (`LogicCapture.generation`, never re-used within a boot: past 0xFFFFFFFF a start is refused until a reboot) that read and release name - `read_segment(segment)` passes the segment's own - and every event carries (`events()` drops an earlier start's); streaming data frames carry their generation and their segment (segment_info, never crossing a segment: `Received.segments`); `status()` returns a `Status`. A capture-group binds configured tracks with an immediate trigger, all in one mode, and starts them at once (`CaptureGroup.start` -> the group's start_ns; the group's and each track's generation). Every segment read goes to the `Host.on_capture` callbacks as a `CaptureRecord` (the hook for run recorders; no wireskein dependency) |
-| `decode` | decoding capture channels (I2C) |
 | `registry` | generated from oep-spec's number table (never edited; copied again from oep-spec). The public way to reach an interface by name is `registry.INTERFACES[name]` (`.revision`, `.op`, `.tlv`, `.enum`, e.g. `INTERFACES["oep.fixture.uart"].enum["role"]`); the module-level names (`FIXTURE_UART`, ...) are the same objects |
 | `arm` | `oep.wire.swd`, `oep.target.arm-adi`, MEM-AP, halting and calling functions on a Cortex-M |
 | `ch32_flash` | writing a CH32 (a RAM loader, page by page) |

{oep_client_python-0.0.51 → oep_client_python-0.0.53}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "oep-client-python"
-version = "0.0.51"
+version = "0.0.53"
 description = "Open Embedded Probe (OEP) v1 host: serial / USB / TCP transports, the session rules, the standard interfaces, and a virtual bench"
 readme = "README.md"
 license = "MIT"

{oep_client_python-0.0.51 → oep_client_python-0.0.53}/src/oep_client/__init__.py

@@ -2,4 +2,4 @@
 
 __all__ = ["__version__"]
 
-__version__ = "0.0.51"
+__version__ = "0.0.53"