Skip to content

Commit 655382b

Browse files
committed
Refresh SDK README for current release state
1 parent dbefbec commit 655382b

2 files changed

Lines changed: 46 additions & 6 deletions

File tree

README.md

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,31 @@ exposed to AmigaOS through `zz9k.library`, with public helper headers under
2323
fixed-address ARM launcher, standalone ARM examples, and their bare-metal
2424
support libraries have been removed from this branch.
2525

26+
## What This Fork Adds
27+
28+
Compared with the older MNT ARM SDK, this repository now centers on a
29+
stable AmigaOS-facing service runtime rather than standalone ARM sample
30+
programs:
31+
32+
- `zz9k.library` plus SDK v2 headers for async calls, shared buffers,
33+
surfaces, image decode/scale, audio, compression, and crypto.
34+
- End-user tools for service inspection, benchmarking, image viewing,
35+
MP3 playback, archive extraction, and release smoke checks.
36+
- `zz9k-picture.datatype` and JPEG/PNG descriptors for optional
37+
DataTypes integration.
38+
- `mpega.library` and audio-stream helpers used by the current MHI/MP3
39+
stack.
40+
- LHA/LZH archive decompression offload, including batch verification
41+
paths that fall back to software when firmware support is absent.
42+
- AmiSSL/OpenSSL 3 provider work for TLS acceleration: X25519, P-256
43+
ECDHE, P-256 ECDSA verify, RSA-2048 PKCS#1/SHA-256 verify, AES-GCM,
44+
and ChaCha20-Poly1305 where the board and firmware advertise support.
45+
- Zorro 2-aware allocation flags (`HOST_WINDOW` / `CARD_ONLY`) so small
46+
audio staging buffers can stay CPU-visible while card-only rings avoid
47+
the 4 MB aperture limit.
48+
- Docker packaging, host-side tests, ABI drift checks, and release smoke
49+
documentation.
50+
2651
Start new AmigaOS-side work with [`docs/zz9k-library.md`](docs/zz9k-library.md).
2752
Firmware-side service metadata is described in
2853
[`docs/zz9k-modules.md`](docs/zz9k-modules.md); conventions for third-party and
@@ -45,6 +70,13 @@ powershell -ExecutionPolicy Bypass -File scripts\build-m68k-amigaos.ps1
4570
powershell -ExecutionPolicy Bypass -File scripts\package-m68k-amigaos.ps1
4671
```
4772

73+
or from a POSIX shell:
74+
75+
```sh
76+
./scripts/build-m68k-amigaos.sh
77+
./scripts/package-m68k-amigaos.sh
78+
```
79+
4880
The package is written to `build/package/amigaos3`. It contains:
4981

5082
- `Libs/zz9k.library`
@@ -53,16 +85,20 @@ The package is written to `build/package/amigaos3`. It contains:
5385
- CLI tools such as `zz9k-info`, `zz9k-services`, `zz9k-bench`,
5486
`zz9k-surfaceops`, `zz9k-mp3`, `zz9k-mpega-smoke`, `zz9k-jpeg`, `zz9k-png`,
5587
`zz9k-view`, `zz9k-hash`, `zz9k-chacha`, `zz9k-aead`, and
56-
archive/decompression tools
88+
archive/decompression tools including `zz9k-archive`
5789
- `Classes/DataTypes/zz9k-picture.datatype` plus JPEG/PNG descriptors packaged
5890
inactive under `Storage/DataTypes` for explicit opt-in activation
5991
- developer headers under `Developer/Include`
6092
- public docs under `Docs`
6193
- examples under `Examples`
6294
- `MANIFEST.sha256` with SHA-256 checksums for every packaged file
6395

64-
SDK v2 requires the matching ZZ9000 SDK-service firmware (v2.2.0 or newer). After installing
65-
the SDK package and booting that firmware, run this hardware smoke check:
96+
SDK v2 requires matching ZZ9000 SDK-service firmware. Firmware v2.2.0 is the
97+
older baseline for the service ABI, but current matched firmware, SDK payloads,
98+
and drivers are expected for Zorro 2 host-window audio/MP3 allocation,
99+
`ZZ9000.CFG` query support, and the newest service capability flags. After
100+
installing the SDK package and booting that firmware, run this hardware smoke
101+
check:
66102

67103
```text
68104
zz9k-services --check-release

integration/amissl/README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,13 @@ installer; installing by hand, match the variant to your CPU.
9191

9292
Copy the matching `amissl.library` over the one in `LIBS:AmiSSL/` (keep a backup
9393
of the original), then run any TLS application. To confirm offload is active, use
94-
the self-test from the application-side docs, or watch a TLS handshake: anything
95-
negotiating X25519 or AES-GCM/ChaCha20-Poly1305 is accelerated; everything else —
96-
including certificate (ECDSA/RSA) verification — runs in AmiSSL's software.
94+
the self-test from the application-side docs, or watch a TLS handshake. Current
95+
firmware/provider builds accelerate X25519, P-256 ECDHE, P-256 ECDSA
96+
certificate verification, RSA-2048 PKCS#1/SHA-256 certificate verification,
97+
AES-GCM, and ChaCha20-Poly1305 when the board advertises the matching service
98+
flag. Non-P256 curves, RSA-PSS and other RSA modes, client-certificate signing,
99+
and algorithms outside the ZZ9000 surface delegate to AmiSSL's software
100+
provider.
97101

98102
`ENV:ZZ9K_DISABLE_OFFLOAD` is a diagnostic kill switch: set it (e.g.
99103
`setenv ZZ9K_DISABLE_OFFLOAD 1`) and the provider still loads but never touches

0 commit comments

Comments
 (0)