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.3.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.3.0
File Size Uploaded Provenance Actions
dau_driver-0.3.0.tar.gz 252.2 kB Without provenance Details for dau_driver-0.3.0.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for dau-driver 0.3.0
File Actions
dau_driver-0.3.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.3.0-cp313-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
dau_driver-0.3.0-cp313-abi3-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl CPython 3.13 abi3 Linux glibc 2.28+ ARM64, Linux glibc 2.26+ ARM64 Details for dau_driver-0.3.0-cp313-abi3-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl
dau_driver-0.3.0-cp313-abi3-macosx_11_0_arm64.whl CPython 3.13 abi3 macOS 11.0+ ARM64 Details for dau_driver-0.3.0-cp313-abi3-macosx_11_0_arm64.whl
dau_driver-0.3.0-cp312-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl CPython 3.12 abi3 Linux glibc 2.27+ x86-64, Linux glibc 2.28+ x86-64 Details for dau_driver-0.3.0-cp312-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
dau_driver-0.3.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.3.0-cp312-abi3-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl
dau_driver-0.3.0-cp312-abi3-macosx_11_0_arm64.whl CPython 3.12 abi3 macOS 11.0+ ARM64 Details for dau_driver-0.3.0-cp312-abi3-macosx_11_0_arm64.whl

Total release size: 1.9 MB

Release files / dau_driver-0.3.0.tar.gz

Download URL dau_driver-0.3.0.tar.gz
Size 252.2 kB
Tags Source
SHA-256 checksum
How to use checksums
e2e09e0f296c1058e4906dfccb9b4889ac4787c020df8b809577775735d42407
BLAKE2b-256 checksum
How to use checksums
1c45af6bf821860059f217f5045e3f994d7d92f68ba2f6499e9ebf0b70a12c3d
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.3.0-cp313-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

Download URL dau_driver-0.3.0-cp313-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Size 271.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
e25df0ffe000a61c02a62cd10b58d27e95204c999c68666d427960bc2fa2db14
BLAKE2b-256 checksum
How to use checksums
90f06f66404c148d68f01eaae82bc22a73d2614b8d96d829697b283f23e72db6
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.3.0-cp313-abi3-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl

Download URL dau_driver-0.3.0-cp313-abi3-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl
Size 270.2 kB
Tags CPython 3.13 Linux glibc 2.26+ ARM64 Linux glibc 2.28+ ARM64 abi3
SHA-256 checksum
How to use checksums
fd0f18e105b068338ceae6b10cb51140b86fed28bec7e9b889c3c49a81a2e4f7
BLAKE2b-256 checksum
How to use checksums
d348d639acb186f0c45bb51486c6569744f6bd6ba9c0d109798649571651d432
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.3.0-cp313-abi3-macosx_11_0_arm64.whl

Download URL dau_driver-0.3.0-cp313-abi3-macosx_11_0_arm64.whl
Size 264.9 kB
Tags CPython 3.13 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
8adced4b26cac0c9981038533397f1b296366d67e3143389ba8d95fb73d404f9
BLAKE2b-256 checksum
How to use checksums
5555942ae8a4db6af80e9b4f2c0900cac569708e17c26c50170d0b0960151d41
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.3.0-cp312-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

Download URL dau_driver-0.3.0-cp312-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Size 271.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
0ec69090d7da09d532acfe4fbb847ce1939521c8de72c257956f245c414456cc
BLAKE2b-256 checksum
How to use checksums
4b40f1f7fff7da59d8b9efcfc4721d1812a8c4ab01a7e4e4440bcf2ecc8e7cf8
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.3.0-cp312-abi3-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl

Download URL dau_driver-0.3.0-cp312-abi3-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl
Size 270.2 kB
Tags CPython 3.12 Linux glibc 2.26+ ARM64 Linux glibc 2.28+ ARM64 abi3
SHA-256 checksum
How to use checksums
4090d7bbe16101b5b809bc4c5c9c67460094ea128702f0f11744c4ff1049acaa
BLAKE2b-256 checksum
How to use checksums
d18d2d23055e7a503db045ba69cd7aaab5a5888767b721c5dad5f866f61a7d98
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.3.0-cp312-abi3-macosx_11_0_arm64.whl

Download URL dau_driver-0.3.0-cp312-abi3-macosx_11_0_arm64.whl
Size 264.9 kB
Tags CPython 3.12 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
db7ab5617fd383a5d9ae0cbec784b06cd0db4cc2569dac25a00e6d0297282e89
BLAKE2b-256 checksum
How to use checksums
8283f8720d42d4aa37c8faed0587b877f2033e64c7682f8f7b17fec3e929821b
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.3.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