chris/comodore-iec-emu
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases 4 Wiki Activity

docs(kernel): document frontend output modes

Browse Source 
Added a 'Frontend output modes' section explaining plain text (default),
--debug (annotated trace), and --raw (hex), with launch.sh examples for
each.

Generated by Clanker
This commit is contained in:
Christian Werner 2026-06-20 18:20:15 +02:00
parent affdcdda6b
commit 565b58480a
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
kernel/README.md
View File

@ -43,6 +43,24 @@ actually capture and decode C64 traffic, use **`launch.sh`**, which installs the
frontend, loads the matching module, runs `iecpoc`, and unloads on exit — see the frontend, loads the matching module, runs `iecpoc`, and unloads on exit — see the
[top-level README](../README.md#running-the-frontend-on-the-pi). [top-level README](../README.md#running-the-frontend-on-the-pi).
### Frontend output modes
`iecpoc` has three output modes, selected by flags passed after `--` to `launch.sh`
(or directly on the command line when running `iecpoc` standalone):
| Mode | Flag | Output |
|---|---|---|
| Plain text (default) | *(none)* | Received characters only; LISTEN/UNLISTEN print a divider; CR/LF become real newlines |
| Debug / annotated trace | `--debug` | Full `[CMD]` / `[DATA]` / `[ATN]` / `[IDLE]` tag-per-record trace |
| Raw hex | `--raw` | Bare uppercase hex bytes of command and data records, no annotations |
```bash
sudo ./launch.sh # plain text — what the C64 is printing
sudo ./launch.sh -- --debug # full annotated trace
sudo ./launch.sh -- --raw # bare hex stream
sudo ./launch.sh -- --logfile trace.txt # also write output to a file
```
You don't pick the file yourself: the script reads `uname -r`, then scans You don't pick the file yourself: the script reads `uname -r`, then scans
`modules/` (and a few fallback locations) and selects the `.ko` whose **vermagic** `modules/` (and a few fallback locations) and selects the `.ko` whose **vermagic**
matches the running kernel. Matching is by vermagic rather than filename because matches the running kernel. Matching is by vermagic rather than filename because