Skip to main content

dau-driver

Host I/O for DAU devices: discovery, registers, DMA, and job execution over XDMA

Build Status codecov License PyPI

dau-driver is the host side of a DAU device. It discovers DAU-compatible XDMA endpoints, reads the canonical register block, decodes the device's capability advertisement, moves data over H2C/C2H DMA, allocates device storage, and runs the register-contract jobs the shells expose. All device semantics (register offsets, stream framing, capability words, record layouts) come from dau-core; this package owns transport and execution only.

  • Linux hosts use the Xilinx XDMA character devices under /dev.
  • macOS hosts use a DriverKit-based XDMA system extension through IOKit user-client calls, for register access and full H2C/C2H DMA.
from pathlib import Path

from dau_driver import discover_devices
from dau_driver.testing import FakeTransport, fake_device

devices = discover_devices()                       # the XDMA devices under /dev, when a board is installed
device = devices[0] if devices else fake_device(Path("."), FakeTransport())
device.check_bar_health()                          # all-ones reads fail here, not later
print(device.name, device.backend)                 # xdma0 linux-xdma
print(device.capabilities.dma)                     # alignment / max-transfer constraints
print(device.read_register_block_snapshot())       # the whole identity block
print(device.read_status())                        # the status word and last error

The Python execution paths (discovery, registers, transfers, storage, the scan, pipeline and fleet runners) also run against the in-memory fake transport above, and that is how the test suite exercises them. The kernel driver, the DriverKit extension and the native extension are tested on hardware.

Documentation

The full documentation is at dau-dev.github.io/dau-driver.

The examples directory holds end-to-end host flows (record-batch round trip, stream aggregation, the OHLCV pipeline job) that run against real hardware.

Installation

Requires Python 3.12 or newer.

pip install dau-driver

Wheels are published for CPython 3.12 and 3.13 on Linux (x86_64 and aarch64) and macOS (arm64). Elsewhere pip builds the small native extension from source, which needs a C++ toolchain.

On a host with a board, load the Linux XDMA module from kernel/linux-xdma/ or the macOS DriverKit extension from kernel/macos-xdma/; each has its own build and load instructions. Without one, the package still imports and runs against its fake transport. Whoever can open the character devices (Linux) or the user client (macOS) can read and write the card's memory and registers, so the operating system's device permissions are the access control.

License

Apache-2.0, except kernel/linux-xdma/, which is Xilinx's XDMA reference driver under its own Dual BSD/GPL terms. See kernel/README.md.

Metadata

Release files for dau-driver 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for dau-driver 0.2.0
File Size Uploaded Provenance Actions
dau_driver-0.2.0.tar.gz 251.4 kB Without provenance Details for dau_driver-0.2.0.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for dau-driver 0.2.0
File Actions
dau_driver-0.2.0-cp313-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl CPython 3.13 abi3 Linux glibc 2.28+ x86-64, Linux glibc 2.27+ x86-64 Details for dau_driver-0.2.0-cp313-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
dau_driver-0.2.0-cp313-abi3-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl CPython 3.13 abi3 Linux glibc 2.26+ ARM64, Linux glibc 2.28+ ARM64 Details for dau_driver-0.2.0-cp313-abi3-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl
dau_driver-0.2.0-cp313-abi3-macosx_11_0_arm64.whl CPython 3.13 abi3 macOS 11.0+ ARM64 Details for dau_driver-0.2.0-cp313-abi3-macosx_11_0_arm64.whl
dau_driver-0.2.0-cp312-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl CPython 3.12 abi3 Linux glibc 2.28+ x86-64, Linux glibc 2.27+ x86-64 Details for dau_driver-0.2.0-cp312-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
dau_driver-0.2.0-cp312-abi3-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl CPython 3.12 abi3 Linux glibc 2.26+ ARM64, Linux glibc 2.28+ ARM64 Details for dau_driver-0.2.0-cp312-abi3-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl
dau_driver-0.2.0-cp312-abi3-macosx_11_0_arm64.whl CPython 3.12 abi3 macOS 11.0+ ARM64 Details for dau_driver-0.2.0-cp312-abi3-macosx_11_0_arm64.whl

Total release size: 1.9 MB

Release files / dau_driver-0.2.0.tar.gz

Download URL dau_driver-0.2.0.tar.gz
Size 251.4 kB
Tags Source
SHA-256 checksum
How to use checksums
6d58804bd819a7e873d354e2d01dcb0a70bbda2463674120014a5e453497d8d7
BLAKE2b-256 checksum
How to use checksums
0fcb74ed3dd9fff9c1b65cbcfbddaf02b7766bda238cfe0cc7f5c0f7ce32c246
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.15

Release files / dau_driver-0.2.0-cp313-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

Download URL dau_driver-0.2.0-cp313-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Size 270.3 kB
Tags CPython 3.13 Linux glibc 2.27+ x86-64 Linux glibc 2.28+ x86-64 abi3
SHA-256 checksum
How to use checksums
03412411ecc4b49ff718c13c7358a1c8c2e753befb046416cff79787691e0028
BLAKE2b-256 checksum
How to use checksums
f460b0abee1a1250c1ba964d5d37b7ab3e4c0bf4d26934437234660128a63bcb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.15

Release files / dau_driver-0.2.0-cp313-abi3-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl

Download URL dau_driver-0.2.0-cp313-abi3-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl
Size 269.2 kB
Tags CPython 3.13 Linux glibc 2.26+ ARM64 Linux glibc 2.28+ ARM64 abi3
SHA-256 checksum
How to use checksums
c4ad847f656d38dc4c522628a831557f66db994ad497030e3f8ade9aa89e4c5e
BLAKE2b-256 checksum
How to use checksums
cfc793d506c00aa89e624baa3d3b05bcf47730d7da29ed9c67b5e32a18649c12
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.15

Release files / dau_driver-0.2.0-cp313-abi3-macosx_11_0_arm64.whl

Download URL dau_driver-0.2.0-cp313-abi3-macosx_11_0_arm64.whl
Size 263.9 kB
Tags CPython 3.13 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
671b75ca5880f162fc1c13e41c441cccf357658a1e0babc71a8815cee350fcf0
BLAKE2b-256 checksum
How to use checksums
0948033f52f8a7979cf1b9a998cc83e6d66d7f171dd72a4b68c12a971c7e9016
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.15

Release files / dau_driver-0.2.0-cp312-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

Download URL dau_driver-0.2.0-cp312-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Size 270.3 kB
Tags CPython 3.12 Linux glibc 2.27+ x86-64 Linux glibc 2.28+ x86-64 abi3
SHA-256 checksum
How to use checksums
e00dbd7c335af08bcfa2e8f3465725190e4ca9546e898d1c228dbcbe6fc3fcb5
BLAKE2b-256 checksum
How to use checksums
ba1f69221fcf59727b7e9c1020a224c83dbaeaf27fc5ef78dde04854d84cad26
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.15

Release files / dau_driver-0.2.0-cp312-abi3-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl

Download URL dau_driver-0.2.0-cp312-abi3-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl
Size 269.2 kB
Tags CPython 3.12 Linux glibc 2.26+ ARM64 Linux glibc 2.28+ ARM64 abi3
SHA-256 checksum
How to use checksums
4f1e0eaa4e2020d492f2cb06041a6ad75a8dd9b2589affcb650b3cb482049a27
BLAKE2b-256 checksum
How to use checksums
5a037561421bc904ce6431944345da57c7a4134034f8f4e7ce16cae538b1bb06
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.15

Release files / dau_driver-0.2.0-cp312-abi3-macosx_11_0_arm64.whl

Download URL dau_driver-0.2.0-cp312-abi3-macosx_11_0_arm64.whl
Size 264.0 kB
Tags CPython 3.12 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
21b6bf74eebb98e207b6f482a21976b469f225eaa877c78d34c397c784571386
BLAKE2b-256 checksum
How to use checksums
64f4ef5a4e1c9789f1985a265eb0d6901a4df8b61c633b7bd79820444f04e820
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.15

Security for dau-driver 0.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page